|
| | CFN_HAL_VMT_CHECK (struct cfn_hal_rtc_api_s) |
| |
| | CFN_HAL_CREATE_DRIVER_TYPE (rtc, cfn_hal_rtc_config_t, cfn_hal_rtc_api_t, cfn_hal_rtc_phy_t, cfn_hal_rtc_callback_t) |
| |
| CFN_HAL_INLINE void | cfn_hal_rtc_populate (cfn_hal_rtc_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_rtc_api_t *api, const cfn_hal_rtc_phy_t *phy, const cfn_hal_rtc_config_t *config, cfn_hal_rtc_callback_t callback, void *user_arg) |
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_config_validate (const cfn_hal_rtc_t *driver, const cfn_hal_rtc_config_t *config) |
| | Validates the RTC configuration.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_init (cfn_hal_rtc_t *driver) |
| | Initializes the RTC driver.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_deinit (cfn_hal_rtc_t *driver) |
| | Deinitializes the RTC driver.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_config_set (cfn_hal_rtc_t *driver, const cfn_hal_rtc_config_t *config) |
| | Sets the RTC configuration.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_config_get (cfn_hal_rtc_t *driver, cfn_hal_rtc_config_t *config) |
| | Gets the current RTC configuration.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_callback_register (cfn_hal_rtc_t *driver, const cfn_hal_rtc_callback_t callback, void *user_arg) |
| | Registers a callback for RTC events and errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_power_state_set (cfn_hal_rtc_t *driver, cfn_hal_power_state_t state) |
| | Sets the RTC power state.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_event_enable (cfn_hal_rtc_t *driver, uint32_t event_mask) |
| | Enables one or more RTC nominal events.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_event_disable (cfn_hal_rtc_t *driver, uint32_t event_mask) |
| | Disables one or more RTC nominal events.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_event_get (cfn_hal_rtc_t *driver, uint32_t *event_mask) |
| | Retrieves the current RTC nominal event status.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_error_enable (cfn_hal_rtc_t *driver, uint32_t error_mask) |
| | Enables one or more RTC exception errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_error_disable (cfn_hal_rtc_t *driver, uint32_t error_mask) |
| | Disables one or more RTC exception errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_error_get (cfn_hal_rtc_t *driver, uint32_t *error_mask) |
| | Retrieves the current RTC exception error status.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_set_time (cfn_hal_rtc_t *driver, cfn_hal_rtc_time_t *time) |
| | Sets the RTC current wall-clock time.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_get_time (cfn_hal_rtc_t *driver, cfn_hal_rtc_time_t *time) |
| | Retrieves the current wall-clock time from the RTC.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_set_alarm (cfn_hal_rtc_t *driver, uint32_t id, cfn_hal_rtc_time_t *time) |
| | Configures an alarm event for a specific time.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_get_alarm (cfn_hal_rtc_t *driver, uint32_t id, bool *elapsed, cfn_hal_rtc_time_t *time) |
| | Retrieves configuration and status of a specific alarm.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_rtc_stop_alarm (cfn_hal_rtc_t *driver, uint32_t id) |
| | Disables a previously configured alarm.
|
| |
| cfn_hal_error_code_t | cfn_hal_rtc_construct (cfn_hal_rtc_t *driver, const cfn_hal_rtc_config_t *config, const cfn_hal_rtc_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_rtc_callback_t callback, void *user_arg) |
| |
| cfn_hal_error_code_t | cfn_hal_rtc_destruct (cfn_hal_rtc_t *driver) |
| |
Real-Time Clock (RTC) HAL API.
Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
