![]() |
nrfx 4.5.0
|
Hardware access layer for managing the Auxiliary Phase Locked Loop (AUXPLL) peripheral. More...
Data Structures | |
| struct | nrf_auxpll_config_t |
| AUXPLL configuration. More... | |
Enumerations | |
| enum | nrf_auxpll_task_t { NRF_AUXPLL_TASK_START = offsetof(NRF_AUXPLL_Type, TASKS_START) , NRF_AUXPLL_TASK_STOP = offsetof(NRF_AUXPLL_Type, TASKS_STOP) , NRF_AUXPLL_TASK_FREQ_NEW_FINE = offsetof(NRF_AUXPLL_Type, TASKS_NEWFINEFREQ) , NRF_AUXPLL_TASK_FREQ_NEW_BASE = offsetof(NRF_AUXPLL_Type, TASKS_NEWBASEFREQ) , NRF_AUXPLL_TASK_FREQ_INC_START = offsetof(NRF_AUXPLL_Type, TASKS_FREQINCSTART) , NRF_AUXPLL_TASK_FREQ_INC_STOP = offsetof(NRF_AUXPLL_Type, TASKS_FREQINCSTOP) } |
| AUXPLL tasks. More... | |
| enum | nrf_auxpll_event_t { NRF_AUXPLL_EVENT_STARTED = offsetof(NRF_AUXPLL_Type, EVENTS_STARTED) , NRF_AUXPLL_EVENT_STOPPED = offsetof(NRF_AUXPLL_Type, EVENTS_STOPPED) , NRF_AUXPLL_EVENT_LOCKED = offsetof(NRF_AUXPLL_Type, EVENTS_LOCKED) } |
| AUXPLL events. More... | |
| enum | nrf_auxpll_int_mask_t { NRF_AUXPLL_INT_STARTED_MASK = AUXPLL_INTEN_STARTED_Msk , NRF_AUXPLL_INT_STOPPED_MASK = AUXPLL_INTEN_STOPPED_Msk , NRF_AUXPLL_INT_LOCKED_MASK = AUXPLL_INTEN_LOCKED_Msk } |
| AUXPLL interrupts. More... | |
| enum | nrf_auxpll_status_mask_t { NRF_AUXPLL_STATUS_MODE_MASK = AUXPLL_STATUS_MODE_Msk , NRF_AUXPLL_STATUS_PLL_RUNNING_MASK = AUXPLL_STATUS_PLLRUNNING_Msk , MRF_AUXPLL_STATUS_FREQUENCY_ACTUAL_MASK = AUXPLL_STATUS_FREQUENCYACTUAL_Msk } |
| AUXPLL STATUS register bit masks. More... | |
| enum | nrf_auxpll_ctrl_outsel_t { NRF_AUXPLL_CTRL_OUTSEL_DIV_DISABLED = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_DivDisabled , NRF_AUXPLL_CTRL_OUTSEL_DIV_1 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div1 , NRF_AUXPLL_CTRL_OUTSEL_DIV_2 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div2 , NRF_AUXPLL_CTRL_OUTSEL_DIV_3 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div3 , NRF_AUXPLL_CTRL_OUTSEL_DIV_4 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div4 , NRF_AUXPLL_CTRL_OUTSEL_DIV_6 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div6 , NRF_AUXPLL_CTRL_OUTSEL_DIV_8 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div8 , NRF_AUXPLL_CTRL_OUTSEL_DIV_12 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div12 , NRF_AUXPLL_CTRL_OUTSEL_DIV_16 = AUXPLL_AUXPLLCTRL_OUTSEL_OUTSEL_Div16 } |
| AUXPLL output prescaler ratio. More... | |
| enum | nrf_auxpll_ctrl_mode_t { NRF_AUXPLL_CTRL_MODE_AUTO = AUXPLL_AUXPLLCTRL_MODE_MODECTRL_Auto , NRF_AUXPLL_CTRL_MODE_FREERUN = AUXPLL_AUXPLLCTRL_MODE_MODECTRL_Freerun , NRF_AUXPLL_CTRL_MODE_LOCKED = AUXPLL_AUXPLLCTRL_MODE_MODECTRL_Locked } |
| AUXPLL freerunning mode control. More... | |
| enum | nrf_auxpll_divider_range_t { NRF_AUXPLL_DIVIDER_RANGE_LOW = AUXPLL_CONFIG_CFGSTATIC_AUXPLLRANGE_Low , NRF_AUXPLL_DIVIDER_RANGE_MID = AUXPLL_CONFIG_CFGSTATIC_AUXPLLRANGE_Mid , NRF_AUXPLL_DIVIDER_RANGE_HIGH = AUXPLL_CONFIG_CFGSTATIC_AUXPLLRANGE_High , NRF_AUXPLL_DIVIDER_RANGE_MAX = AUXPLL_CONFIG_CFGSTATIC_AUXPLLRANGE_StaticHigh } |
| AUXPLL Loop divider base settings. More... | |
| enum | nrf_auxpll_freq_div_ratio_t { NRF_AUXPLL_FREQUENCY_DIV_MIN = AUXPLL_AUXPLLCTRL_FREQUENCY_FREQUENCY_MinimumDiv , NRF_AUXPLL_FREQUENCY_AUDIO_44K1 = AUXPLL_AUXPLLCTRL_FREQUENCY_FREQUENCY_Audio44k1 , NRF_AUXPLL_FREQUENCY_USB_24M = AUXPLL_AUXPLLCTRL_FREQUENCY_FREQUENCY_USB24M , NRF_AUXPLL_FREQUENCY_AUDIO_48K = AUXPLL_AUXPLLCTRL_FREQUENCY_FREQUENCY_Audio48k , NRF_AUXPLL_FREQUENCY_DIV_MAX = AUXPLL_AUXPLLCTRL_FREQUENCY_FREQUENCY_MaximumDiv } |
| AUXPLL fractional PLL Divider ratio. More... | |
Functions | |
| NRF_STATIC_INLINE void | nrf_auxpll_task_trigger (NRF_AUXPLL_Type *p_reg, nrf_auxpll_task_t task) |
| Function for activating the specified AUXPLL task. | |
| NRF_STATIC_INLINE uint32_t | nrf_auxpll_task_address_get (NRF_AUXPLL_Type const *p_reg, nrf_auxpll_task_t task) |
| Function for getting the address of the specified AUXPLL task register. | |
| NRF_STATIC_INLINE void | nrf_auxpll_event_clear (NRF_AUXPLL_Type *p_reg, nrf_auxpll_event_t event) |
| Function for clearing the specified AUXPLL event. | |
| NRF_STATIC_INLINE bool | nrf_auxpll_event_check (NRF_AUXPLL_Type const *p_reg, nrf_auxpll_event_t event) |
| Function for retrieving the state of the AUXPLL event. | |
| NRF_STATIC_INLINE uint32_t | nrf_auxpll_event_address_get (NRF_AUXPLL_Type const *p_reg, nrf_auxpll_event_t event) |
| Function for getting the address of the specified AUXPLL event register. | |
| NRF_STATIC_INLINE void | nrf_auxpll_int_enable (NRF_AUXPLL_Type *p_reg, uint32_t mask) |
| Function for enabling the specified interrupts. | |
| NRF_STATIC_INLINE void | nrf_auxpll_int_disable (NRF_AUXPLL_Type *p_reg, uint32_t mask) |
| Function for disabling the specified interrupts. | |
| NRF_STATIC_INLINE bool | nrf_auxpll_int_enable_check (NRF_AUXPLL_Type const *p_reg, uint32_t mask) |
| Function for checking if the specified interrupts are enabled. | |
| NRF_STATIC_INLINE bool | nrf_auxpll_int_pending_check (NRF_AUXPLL_Type const *p_reg, uint32_t mask) |
| Function for checking if the specified interrupts are pending. | |
| NRF_STATIC_INLINE uint32_t | nrf_auxpll_status_get (NRF_AUXPLL_Type const *p_reg) |
| Function for getting AUXPLL status. | |
| NRF_STATIC_INLINE void | nrf_auxpll_config_get (NRF_AUXPLL_Type const *p_reg, nrf_auxpll_config_t *p_cfg) |
| Function for getting the AUXPLL configuration. | |
| NRF_STATIC_INLINE void | nrf_auxpll_config_set (NRF_AUXPLL_Type *p_reg, nrf_auxpll_config_t const *p_cfg) |
| Function for setting the AUXPLL configuration. | |
| NRF_STATIC_INLINE void | nrf_auxpll_trim_ctune_set (NRF_AUXPLL_Type *p_reg, uint8_t value) |
| Function for setting the AUXPLL ring oscillator core process corner tuning. | |
| NRF_STATIC_INLINE uint8_t | nrf_auxpll_trim_ctune_get (NRF_AUXPLL_Type const *p_reg) |
| Function for getting the AUXPLL ring oscillator core process corner tuning. | |
| NRF_STATIC_INLINE void | nrf_auxpll_ctrl_frequency_set (NRF_AUXPLL_Type *p_reg, nrf_auxpll_freq_div_ratio_t value) |
| Function for setting the AUXPLL fractional PLL divider ratio tuning. | |
| NRF_STATIC_INLINE uint16_t | nrf_auxpll_ctrl_frequency_get (NRF_AUXPLL_Type const *p_reg) |
| Function for getting the AUXPLL fractional PLL divider ratio. | |
| NRF_STATIC_INLINE void | nrf_auxpll_ctrl_freqinc_set (NRF_AUXPLL_Type *p_reg, int8_t value) |
| Function for setting the AUXPLL frequency increment value. | |
| NRF_STATIC_INLINE int8_t | nrf_auxpll_ctrl_freqinc_get (NRF_AUXPLL_Type const *p_reg) |
| Function for getting the AUXPLL frequency increment value. | |
| NRF_STATIC_INLINE void | nrf_auxpll_ctrl_freqinc_period_set (NRF_AUXPLL_Type *p_reg, uint16_t value) |
| Function for setting the AUXPLL frequency increment period. | |
| NRF_STATIC_INLINE uint16_t | nrf_auxpll_ctrl_freqinc_period_get (NRF_AUXPLL_Type const *p_reg) |
| Function for getting the AUXPLL frequency increment period value. | |
| NRF_STATIC_INLINE void | nrf_auxpll_ctrl_outsel_set (NRF_AUXPLL_Type *p_reg, nrf_auxpll_ctrl_outsel_t value) |
| Function for setting the AUXPLL output prescaler. | |
| NRF_STATIC_INLINE nrf_auxpll_ctrl_outsel_t | nrf_auxpll_ctrl_outsel_get (NRF_AUXPLL_Type const *p_reg) |
| Function for getting the AUXPLL output prescaler value. | |
| NRF_STATIC_INLINE void | nrf_auxpll_ctrl_mode_set (NRF_AUXPLL_Type *p_reg, nrf_auxpll_ctrl_mode_t value) |
| Function for setting the AUXPLL mode. | |
| NRF_STATIC_INLINE nrf_auxpll_ctrl_mode_t | nrf_auxpll_ctrl_mode_get (NRF_AUXPLL_Type const *p_reg) |
| Function for getting the AUXPLL mode. | |
| NRF_STATIC_INLINE void | nrf_auxpll_lock (NRF_AUXPLL_Type *p_reg) |
| Enable LOCK for mirrored AUXPLL registers. | |
| NRF_STATIC_INLINE void | nrf_auxpll_unlock (NRF_AUXPLL_Type *p_reg) |
| Disable the lock after configuring all AUXPLL mirrored registers. | |
| NRF_STATIC_INLINE bool | nrf_auxpll_lock_check (NRF_AUXPLL_Type const *p_reg) |
| Check if mirrored AUXPLL registers are locked. | |
| NRF_STATIC_INLINE uint8_t | nrf_auxpll_static_ratio_get (NRF_AUXPLL_Type const *p_reg) |
| Obtain static ratio when DSM is disabled. | |
| NRF_STATIC_INLINE bool | nrf_auxpll_mode_locked_check (NRF_AUXPLL_Type const *p_reg) |
| Check if AUXPLL is locked. | |
| NRF_STATIC_INLINE bool | nrf_auxpll_running_check (NRF_AUXPLL_Type const *p_reg) |
| Check if AUXPLL is running. | |
Hardware access layer for managing the Auxiliary Phase Locked Loop (AUXPLL) peripheral.
AUXPLL output prescaler ratio.
AUXPLL Loop divider base settings.
| enum nrf_auxpll_event_t |
AUXPLL fractional PLL Divider ratio.
AUXPLL STATUS register bit masks.
| enum nrf_auxpll_task_t |
AUXPLL tasks.
| NRF_STATIC_INLINE void nrf_auxpll_config_get | ( | NRF_AUXPLL_Type const * | p_reg, |
| nrf_auxpll_config_t * | p_cfg ) |
Function for getting the AUXPLL configuration.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [out] | p_cfg | Pointer to the structure to be filled with current AUXPLL configuration. |
| NRF_STATIC_INLINE void nrf_auxpll_config_set | ( | NRF_AUXPLL_Type * | p_reg, |
| nrf_auxpll_config_t const * | p_cfg ) |
Function for setting the AUXPLL configuration.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | p_cfg | Pointer to the structure with AUXPLL configuration. |
| NRF_STATIC_INLINE int8_t nrf_auxpll_ctrl_freqinc_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Function for getting the AUXPLL frequency increment value.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE uint16_t nrf_auxpll_ctrl_freqinc_period_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Function for getting the AUXPLL frequency increment period value.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_auxpll_ctrl_freqinc_period_set | ( | NRF_AUXPLL_Type * | p_reg, |
| uint16_t | value ) |
Function for setting the AUXPLL frequency increment period.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | value | Frequency increment period in 1 us steps. |
| NRF_STATIC_INLINE void nrf_auxpll_ctrl_freqinc_set | ( | NRF_AUXPLL_Type * | p_reg, |
| int8_t | value ) |
Function for setting the AUXPLL frequency increment value.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | value | Signed 8-bit frequency increment, applied to current value of FREQUENCY register. |
| NRF_STATIC_INLINE uint16_t nrf_auxpll_ctrl_frequency_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Function for getting the AUXPLL fractional PLL divider ratio.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_auxpll_ctrl_frequency_set | ( | NRF_AUXPLL_Type * | p_reg, |
| nrf_auxpll_freq_div_ratio_t | value ) |
Function for setting the AUXPLL fractional PLL divider ratio tuning.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | value | Fractional divider ratio. |
| NRF_STATIC_INLINE nrf_auxpll_ctrl_mode_t nrf_auxpll_ctrl_mode_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Function for getting the AUXPLL mode.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_auxpll_ctrl_mode_set | ( | NRF_AUXPLL_Type * | p_reg, |
| nrf_auxpll_ctrl_mode_t | value ) |
Function for setting the AUXPLL mode.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | value | AUXPLL running mode. |
| NRF_STATIC_INLINE nrf_auxpll_ctrl_outsel_t nrf_auxpll_ctrl_outsel_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Function for getting the AUXPLL output prescaler value.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_auxpll_ctrl_outsel_set | ( | NRF_AUXPLL_Type * | p_reg, |
| nrf_auxpll_ctrl_outsel_t | value ) |
Function for setting the AUXPLL output prescaler.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | value | Prescaler ratio. |
| NRF_STATIC_INLINE uint32_t nrf_auxpll_event_address_get | ( | NRF_AUXPLL_Type const * | p_reg, |
| nrf_auxpll_event_t | event ) |
Function for getting the address of the specified AUXPLL event register.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | The specified event. |
| NRF_STATIC_INLINE bool nrf_auxpll_event_check | ( | NRF_AUXPLL_Type const * | p_reg, |
| nrf_auxpll_event_t | event ) |
Function for retrieving the state of the AUXPLL 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_auxpll_event_clear | ( | NRF_AUXPLL_Type * | p_reg, |
| nrf_auxpll_event_t | event ) |
Function for clearing the specified AUXPLL event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | Event to clear. |
| NRF_STATIC_INLINE void nrf_auxpll_int_disable | ( | NRF_AUXPLL_Type * | p_reg, |
| uint32_t | mask ) |
Function for disabling the specified interrupts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Mask of interrupts to be disabled. Use nrf_auxpll_int_mask_t values for bit masking. |
| NRF_STATIC_INLINE void nrf_auxpll_int_enable | ( | NRF_AUXPLL_Type * | p_reg, |
| uint32_t | mask ) |
Function for enabling the specified interrupts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Mask of interrupts to be enabled. Use nrf_auxpll_int_mask_t values for bit masking. |
| NRF_STATIC_INLINE bool nrf_auxpll_int_enable_check | ( | NRF_AUXPLL_Type const * | p_reg, |
| uint32_t | mask ) |
Function for checking if the specified interrupts are enabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Mask of interrupts to be checked. Use nrf_auxpll_int_mask_t values for bit masking. |
| NRF_STATIC_INLINE bool nrf_auxpll_int_pending_check | ( | NRF_AUXPLL_Type const * | p_reg, |
| uint32_t | mask ) |
Function for checking if the specified interrupts are pending.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Mask of interrupts to be checked. Use nrf_auxpll_int_mask_t values for bit masking. |
| NRF_STATIC_INLINE void nrf_auxpll_lock | ( | NRF_AUXPLL_Type * | p_reg | ) |
Enable LOCK for mirrored AUXPLL registers.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE bool nrf_auxpll_lock_check | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Check if mirrored AUXPLL registers are locked.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| true | The AUXPLL mirrored register lock enabled. |
| false | The AUXPLL mirrored register lock disabled. |
| NRF_STATIC_INLINE bool nrf_auxpll_mode_locked_check | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Check if AUXPLL is locked.
| p_reg | Pointer to the structure of registers of the peripheral. |
| true | The AUXPLL is locked. |
| false | The AUXPLL is not locked. |
| NRF_STATIC_INLINE bool nrf_auxpll_running_check | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Check if AUXPLL is running.
| p_reg | Pointer to the structure of registers of the peripheral. |
| true | The AUXPLL is running. |
| false | The AUXPLL is not running. |
| NRF_STATIC_INLINE uint8_t nrf_auxpll_static_ratio_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Obtain static ratio when DSM is disabled.
| p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE uint32_t nrf_auxpll_status_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Function for getting AUXPLL status.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE uint32_t nrf_auxpll_task_address_get | ( | NRF_AUXPLL_Type const * | p_reg, |
| nrf_auxpll_task_t | task ) |
Function for getting the address of the specified AUXPLL task register.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | task | The specified task. |
| NRF_STATIC_INLINE void nrf_auxpll_task_trigger | ( | NRF_AUXPLL_Type * | p_reg, |
| nrf_auxpll_task_t | task ) |
Function for activating the specified AUXPLL task.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | task | Task to be activated. |
| NRF_STATIC_INLINE uint8_t nrf_auxpll_trim_ctune_get | ( | NRF_AUXPLL_Type const * | p_reg | ) |
Function for getting the AUXPLL ring oscillator core process corner tuning.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_auxpll_trim_ctune_set | ( | NRF_AUXPLL_Type * | p_reg, |
| uint8_t | value ) |
Function for setting the AUXPLL ring oscillator core process corner tuning.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | value | tuning frequency value. |
| NRF_STATIC_INLINE void nrf_auxpll_unlock | ( | NRF_AUXPLL_Type * | p_reg | ) |
Disable the lock after configuring all AUXPLL mirrored registers.
The individual mirrored registers can be updated any time when the lock is disabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |