Hardware access layer for managing the Local Resource Controller Configuration (LRCCONF) peripheral. More...
Enumerations | |
enum | nrf_lrcconf_task_t { NRF_LRCCONF_TASK_CLKSTART_0 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[0]) , NRF_LRCCONF_TASK_CLKSTART_1 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[1]) , NRF_LRCCONF_TASK_CLKSTART_2 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[2]) , NRF_LRCCONF_TASK_CLKSTART_3 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[3]) , NRF_LRCCONF_TASK_CLKSTART_4 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[4]) , NRF_LRCCONF_TASK_CLKSTART_5 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[5]) , NRF_LRCCONF_TASK_CLKSTART_6 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[6]) , NRF_LRCCONF_TASK_CLKSTART_7 = offsetof(NRF_LRCCONF_Type, TASKS_REQCLKSRC[7]) , NRF_LRCCONF_TASK_CLKSTOP_0 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[0]) , NRF_LRCCONF_TASK_CLKSTOP_1 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[1]) , NRF_LRCCONF_TASK_CLKSTOP_2 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[2]) , NRF_LRCCONF_TASK_CLKSTOP_3 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[3]) , NRF_LRCCONF_TASK_CLKSTOP_4 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[4]) , NRF_LRCCONF_TASK_CLKSTOP_5 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[5]) , NRF_LRCCONF_TASK_CLKSTOP_6 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[6]) , NRF_LRCCONF_TASK_CLKSTOP_7 = offsetof(NRF_LRCCONF_Type, TASKS_STOPREQCLKSRC[7]) , NRF_LRCCONF_TASK_CONSTLAT_ENABLE = offsetof(NRF_LRCCONF_Type, TASKS_CONSTLAT.ENABLE) , NRF_LRCCONF_TASK_CONSTLAT_DISABLE = offsetof(NRF_LRCCONF_Type, TASKS_CONSTLAT.DISABLE) , NRF_LRCCONF_TASK_SYSTEMOFFNOTREADY = offsetof(NRF_LRCCONF_Type, TASKS_SYSTEMOFF.NOTREADY) , NRF_LRCCONF_TASK_SYSTEMOFFREADY = offsetof(NRF_LRCCONF_Type, TASKS_SYSTEMOFF.READY) } |
Tasks. More... | |
enum | nrf_lrcconf_event_t { NRF_LRCCONF_EVENT_CLKSTARTED_0 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[0]) , NRF_LRCCONF_EVENT_CLKSTARTED_1 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[1]) , NRF_LRCCONF_EVENT_CLKSTARTED_2 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[2]) , NRF_LRCCONF_EVENT_CLKSTARTED_3 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[3]) , NRF_LRCCONF_EVENT_CLKSTARTED_4 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[4]) , NRF_LRCCONF_EVENT_CLKSTARTED_5 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[5]) , NRF_LRCCONF_EVENT_CLKSTARTED_6 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[6]) , NRF_LRCCONF_EVENT_CLKSTARTED_7 = offsetof(NRF_LRCCONF_Type, EVENTS_CLKSRCSTARTED[7]) } |
Events. More... | |
enum | nrf_lrcconf_clk_src_t { NRF_LRCCONF_CLK_SRC_OPEN_LOOP = LRCCONF_CLKSTAT_SRC_SRC_OpenLoop , NRF_LRCCONF_CLK_SRC_CLOSED_LOOP = LRCCONF_CLKSTAT_SRC_SRC_ClosedLoop } |
Clock sources. More... | |
enum | nrf_lrcconf_power_domain_mask_t { NRF_LRCCONF_POWER_MAIN = LRCCONF_POWERON_MAIN_Msk , NRF_LRCCONF_POWER_DOMAIN_0 = LRCCONF_POWERON_ACTIVE0_Msk , NRF_LRCCONF_POWER_DOMAIN_1 = LRCCONF_POWERON_ACTIVE1_Msk , NRF_LRCCONF_POWER_DOMAIN_2 = LRCCONF_POWERON_ACTIVE2_Msk , NRF_LRCCONF_POWER_DOMAIN_3 = LRCCONF_POWERON_ACTIVE3_Msk , NRF_LRCCONF_POWER_DOMAIN_4 = LRCCONF_POWERON_ACTIVE4_Msk , NRF_LRCCONF_POWER_DOMAIN_5 = LRCCONF_POWERON_ACTIVE5_Msk , NRF_LRCCONF_POWER_DOMAIN_6 = LRCCONF_POWERON_ACTIVE6_Msk , NRF_LRCCONF_POWER_DOMAIN_7 = LRCCONF_POWERON_ACTIVE7_Msk } |
Power domain mask. More... | |
Functions | |
NRF_STATIC_INLINE void | nrf_lrcconf_task_trigger (NRF_LRCCONF_Type *p_reg, nrf_lrcconf_task_t task) |
Function for starting a task. | |
NRF_STATIC_INLINE uint32_t | nrf_lrcconf_task_address_get (NRF_LRCCONF_Type const *p_reg, nrf_lrcconf_task_t task) |
Function for returning the address of a task. | |
NRF_STATIC_INLINE uint32_t | nrf_lrcconf_event_address_get (NRF_LRCCONF_Type const *p_reg, nrf_lrcconf_event_t event) |
Function for returning the address of an event. | |
NRF_STATIC_INLINE void | nrf_lrcconf_event_clear (NRF_LRCCONF_Type *p_reg, nrf_lrcconf_event_t event) |
Function for clearing an event. | |
NRF_STATIC_INLINE bool | nrf_lrcconf_event_check (NRF_LRCCONF_Type const *p_reg, nrf_lrcconf_event_t event) |
Function for retrieving the state of the specified event. | |
NRF_STATIC_INLINE nrf_lrcconf_task_t | nrf_lrcconf_clkstart_task_get (uint8_t index) |
Function for getting CLKSTART task by its index. | |
NRF_STATIC_INLINE nrf_lrcconf_task_t | nrf_lrcconf_clkstop_task_get (uint8_t index) |
Function for getting CLKSTOP task by its index. | |
NRF_STATIC_INLINE nrf_lrcconf_event_t | nrf_lrcconf_clkstarted_event_get (uint8_t index) |
Function for getting CLKSTARTED event by its index. | |
NRF_STATIC_INLINE nrf_lrcconf_power_domain_mask_t | nrf_lrcconf_power_domain_on_get (uint8_t index) |
Function for getting power domain on mask by its index. | |
NRF_STATIC_INLINE bool | nrf_lrcconf_clock_run_status_check (NRF_LRCCONF_Type const *p_reg, uint8_t clock) |
Function for retrieving the status indicating whether TASK_CLKSTART task has been triggered. | |
NRF_STATIC_INLINE nrf_lrcconf_clk_src_t | nrf_lrcconf_clock_source_get (NRF_LRCCONF_Type const *p_reg, uint8_t clock) |
Function for retrieving the source of the specified clock. | |
NRF_STATIC_INLINE void | nrf_lrcconf_clock_always_run_force_set (NRF_LRCCONF_Type *p_reg, uint8_t clock, bool alwaysrun) |
Function for setting the specified clock to remain running. | |
NRF_STATIC_INLINE bool | nrf_lrcconf_clock_always_run_check (NRF_LRCCONF_Type const *p_reg, uint8_t clock) |
Function for checking if the specified clock is configured to remain running. | |
NRF_STATIC_INLINE void | nrf_lrcconf_clock_source_set (NRF_LRCCONF_Type *p_reg, uint8_t clock, nrf_lrcconf_clk_src_t source) |
Function for setting the source of the specified clock. | |
NRF_STATIC_INLINE bool | nrf_lrcconf_constlatstat_check (NRF_LRCCONF_Type const *p_reg) |
Function for checking the status of constant latency. | |
NRF_STATIC_INLINE void | nrf_lrcconf_poweron_force_set (NRF_LRCCONF_Type *p_reg, nrf_lrcconf_power_domain_mask_t domain_mask, bool alwayson) |
Function for setting the power domain to remain on. | |
NRF_STATIC_INLINE bool | nrf_lrcconf_poweron_force_check (NRF_LRCCONF_Type const *p_reg, nrf_lrcconf_power_domain_mask_t domain) |
Function for checking if the power domain is configured to remain on. | |
NRF_STATIC_INLINE void | nrf_lrcconf_retain_set (NRF_LRCCONF_Type *p_reg, nrf_lrcconf_power_domain_mask_t domain_mask, bool retain) |
Function for setting the power domain to be retained in System ON idle. | |
NRF_STATIC_INLINE bool | nrf_lrcconf_retain_check (NRF_LRCCONF_Type const *p_reg, nrf_lrcconf_power_domain_mask_t domain) |
Function for checking if the power domain is configured to be retained in System ON idle. | |
NRF_STATIC_INLINE void | nrf_lrcconf_axi_waitstates_set (NRF_LRCCONF_Type *p_reg, uint8_t domain, uint8_t waitstates_num) |
Function for setting the waitstates for the AXI bridge connection. | |
NRF_STATIC_INLINE uint8_t | nrf_lrcconf_axi_waitstates_get (NRF_LRCCONF_Type const *p_reg, uint8_t domain) |
Function for getting the waitstates for the AXI bridge connection. | |
Hardware access layer for managing the Local Resource Controller Configuration (LRCCONF) peripheral.
enum nrf_lrcconf_event_t |
Events.
Power domain mask.
enum nrf_lrcconf_task_t |
Tasks.
NRF_STATIC_INLINE uint8_t nrf_lrcconf_axi_waitstates_get | ( | NRF_LRCCONF_Type const * | p_reg, |
uint8_t | domain | ||
) |
Function for getting the waitstates for the AXI bridge connection.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | domain | Functional domain identifier. |
NRF_STATIC_INLINE void nrf_lrcconf_axi_waitstates_set | ( | NRF_LRCCONF_Type * | p_reg, |
uint8_t | domain, | ||
uint8_t | waitstates_num | ||
) |
Function for setting the waitstates for the AXI bridge connection.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | domain | Functional domain identifier. |
[in] | waitstates_num | Number of waitstates. |
NRF_STATIC_INLINE nrf_lrcconf_task_t nrf_lrcconf_clkstart_task_get | ( | uint8_t | index | ) |
Function for getting CLKSTART task by its index.
[in] | index | Index of the CLKSTART task. |
NRF_STATIC_INLINE nrf_lrcconf_event_t nrf_lrcconf_clkstarted_event_get | ( | uint8_t | index | ) |
Function for getting CLKSTARTED event by its index.
[in] | index | Index of the CLKSTARTED event. |
NRF_STATIC_INLINE nrf_lrcconf_task_t nrf_lrcconf_clkstop_task_get | ( | uint8_t | index | ) |
Function for getting CLKSTOP task by its index.
[in] | index | Index of the CLKSTOP task. |
NRF_STATIC_INLINE bool nrf_lrcconf_clock_always_run_check | ( | NRF_LRCCONF_Type const * | p_reg, |
uint8_t | clock | ||
) |
Function for checking if the specified clock is configured to remain running.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | clock | Clock index. |
true | The clock is configured to remain on. |
false | The clock is not configured to remain on. |
NRF_STATIC_INLINE void nrf_lrcconf_clock_always_run_force_set | ( | NRF_LRCCONF_Type * | p_reg, |
uint8_t | clock, | ||
bool | alwaysrun | ||
) |
Function for setting the specified clock to remain running.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | clock | Clock index. |
[in] | alwaysrun | True if forcing the clock to remain on is to be enabled, false otherwise. |
NRF_STATIC_INLINE bool nrf_lrcconf_clock_run_status_check | ( | NRF_LRCCONF_Type const * | p_reg, |
uint8_t | clock | ||
) |
Function for retrieving the status indicating whether TASK_CLKSTART task has been triggered.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | clock | Clock index. |
true | Clock start task has been triggered. |
false | Clock start task has not been triggered. |
NRF_STATIC_INLINE nrf_lrcconf_clk_src_t nrf_lrcconf_clock_source_get | ( | NRF_LRCCONF_Type const * | p_reg, |
uint8_t | clock | ||
) |
Function for retrieving the source of the specified clock.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | clock | Clock index. |
NRF_STATIC_INLINE void nrf_lrcconf_clock_source_set | ( | NRF_LRCCONF_Type * | p_reg, |
uint8_t | clock, | ||
nrf_lrcconf_clk_src_t | source | ||
) |
Function for setting the source of the specified clock.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | clock | Clock index. |
[in] | source | Clock source to be set. |
NRF_STATIC_INLINE bool nrf_lrcconf_constlatstat_check | ( | NRF_LRCCONF_Type const * | p_reg | ) |
Function for checking the status of constant latency.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
true | Constant latency enabled. |
false | Constant latency disabled, low power enabled. |
NRF_STATIC_INLINE uint32_t nrf_lrcconf_event_address_get | ( | NRF_LRCCONF_Type const * | p_reg, |
nrf_lrcconf_event_t | event | ||
) |
Function for returning the address of an event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Requested event. |
NRF_STATIC_INLINE bool nrf_lrcconf_event_check | ( | NRF_LRCCONF_Type const * | p_reg, |
nrf_lrcconf_event_t | event | ||
) |
Function for retrieving the state of the specified event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event to be checked. |
true | The event has been generated. |
false | The event has not been generated. |
NRF_STATIC_INLINE void nrf_lrcconf_event_clear | ( | NRF_LRCCONF_Type * | p_reg, |
nrf_lrcconf_event_t | event | ||
) |
Function for clearing an event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event to be cleared. |
NRF_STATIC_INLINE nrf_lrcconf_power_domain_mask_t nrf_lrcconf_power_domain_on_get | ( | uint8_t | index | ) |
Function for getting power domain on mask by its index.
[in] | index | Index of the domain. |
NRF_STATIC_INLINE bool nrf_lrcconf_poweron_force_check | ( | NRF_LRCCONF_Type const * | p_reg, |
nrf_lrcconf_power_domain_mask_t | domain | ||
) |
Function for checking if the power domain is configured to remain on.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | domain | Power domain to be checked. |
true | The domain is configured to remain on. |
false | The domain is not configured to remain on. |
NRF_STATIC_INLINE void nrf_lrcconf_poweron_force_set | ( | NRF_LRCCONF_Type * | p_reg, |
nrf_lrcconf_power_domain_mask_t | domain_mask, | ||
bool | alwayson | ||
) |
Function for setting the power domain to remain on.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | domain_mask | Mask of power domains to remain on. |
[in] | alwayson | True if forcing the power domain to remain on is to be enabled, false otherwise. |
NRF_STATIC_INLINE bool nrf_lrcconf_retain_check | ( | NRF_LRCCONF_Type const * | p_reg, |
nrf_lrcconf_power_domain_mask_t | domain | ||
) |
Function for checking if the power domain is configured to be retained in System ON idle.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | domain | Power domain to be checked. |
true | The domain is configured to be retained. |
false | The domain is not configured to be retained. |
NRF_STATIC_INLINE void nrf_lrcconf_retain_set | ( | NRF_LRCCONF_Type * | p_reg, |
nrf_lrcconf_power_domain_mask_t | domain_mask, | ||
bool | retain | ||
) |
Function for setting the power domain to be retained in System ON idle.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | domain_mask | Mask of power domains to be retained. |
[in] | retain | True if power domain retention is to be enabled, flase otherwise. |
NRF_STATIC_INLINE uint32_t nrf_lrcconf_task_address_get | ( | NRF_LRCCONF_Type const * | p_reg, |
nrf_lrcconf_task_t | task | ||
) |
Function for returning the address of a task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Requested task. |
NRF_STATIC_INLINE void nrf_lrcconf_task_trigger | ( | NRF_LRCCONF_Type * | p_reg, |
nrf_lrcconf_task_t | task | ||
) |
Function for starting a task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Requested task. |