AAR HAL

group nrf_aar_hal

Hardware access layer for managing the Accelerated Address Resolver (AAR) peripheral.

Defines

NRF_AAR_HAS_ERROR

Presence of the ERROR event and ERRORSTATUS register.

NRF_AAR_HAS_OUT_AMOUNT

Presence of the OUT.AMOUNT register.

NRF_AAR_HAS_NIRK

Presence of the NIRK register.

NRF_AAR_HAS_IRKPTR

Presence of the IRKPTR register.

NRF_AAR_HAS_IN_PTR

Presence of the IN.PTR register.

NRF_AAR_HAS_OUT_PTR

Presence of the OUT.PTR register.

NRF_AAR_HAS_ADDRPTR

Presence of the ADDRPTR register.

NRF_AAR_HAS_SCRATCHPTR

Presence of the SCRATCHPTR register.

NRF_AAR_HAS_STATUS

Presence of the STATUS register.

NRF_AAR_HAS_MAXRESOLVED

Presence of the MAXRESOLVED register.

Enums

enum nrf_aar_event_t

AAR events.

Values:

enumerator NRF_AAR_EVENT_END

Address resolution procedure complete.

enumerator NRF_AAR_EVENT_RESOLVED

Address resolved.

enumerator NRF_AAR_EVENT_NOTRESOLVED

Address not resolved.

enumerator NRF_AAR_EVENT_ERROR

Address resolution procedure aborted due to STOP task or error.

enum nrf_aar_int_mask_t

AAR interrupts.

Values:

enumerator NRF_AAR_INT_END_MASK

Interrupt on END event.

enumerator NRF_AAR_INT_RESOLVED_MASK

Interrupt on RESOLVED event.

enumerator NRF_AAR_INT_NOTRESOLVED_MASK

Interrupt on NOTRESOLVED event.

enumerator NRF_AAR_INT_ERROR_MASK

Interrupt on NOTRESOLVED event.

enum nrf_aar_error_t

AAR error status when ERROR event is generated.

Values:

enumerator NRF_AAR_ERROR_NO_ERROR

No errors have occurred.

enumerator NRF_AAR_ERROR_PREMATURE_INPTR_END

End of INPTR job list before data structure was read.

enumerator NRF_AAR_ERROR_PREMATURE_OUTPTR_END

End of OUTPTR job list before data structure was read.

enumerator NRF_AAR_ERROR_DMA_ERROR

Bus error during DMA access.

enum nrf_aar_task_t

AAR tasks.

Values:

enumerator NRF_AAR_TASK_START

Start address resolution procedure.

enumerator NRF_AAR_TASK_STOP

Stop address resolution procedure.

Functions

NRF_STATIC_INLINE bool nrf_aar_event_check(NRF_AAR_Type const *p_reg, nrf_aar_event_t event)

Function for retrieving the state of the AAR event.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• event – [in] Event to be checked.

Return values:

• true – Event is set.

• false – Event is not set.

NRF_STATIC_INLINE void nrf_aar_event_clear(NRF_AAR_Type *p_reg, nrf_aar_event_t event)

Function for clearing the specified AAR event.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• event – [in] Event to be cleared.

NRF_STATIC_INLINE uint32_t nrf_aar_event_address_get(NRF_AAR_Type const *p_reg, nrf_aar_event_t event)

Function for getting the address of the specified AAR event register.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• event – [in] Event to get the address of.

Returns:

Address of the specified event register.

NRF_STATIC_INLINE void nrf_aar_int_enable(NRF_AAR_Type *p_reg, uint32_t mask)

Function for enabling the specified interrupts.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• mask – [in] Mask of interrupts to be enabled. Use nrf_aar_int_mask_t values for bit masking.

NRF_STATIC_INLINE uint32_t nrf_aar_int_enable_check(NRF_AAR_Type const *p_reg, uint32_t mask)

Function for checking if the specified interrupts are enabled.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• mask – [in] Mask of interrupts to be checked. Use nrf_aar_int_mask_t values for bit masking.

Returns:

Mask of enabled interrupts.

NRF_STATIC_INLINE void nrf_aar_int_disable(NRF_AAR_Type *p_reg, uint32_t mask)

Function for disabling the specified interrupts.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• mask – [in] Mask of interrupts to be disabled. Use nrf_aar_int_mask_t values for bit masking.

NRF_STATIC_INLINE void nrf_aar_task_trigger(NRF_AAR_Type *p_reg, nrf_aar_task_t task)

Function for starting an AAR task.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• task – [in] Task to be activated.

NRF_STATIC_INLINE uint32_t nrf_aar_task_address_get(NRF_AAR_Type const *p_reg, nrf_aar_task_t task)

Function for getting the address of a specific AAR task register.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• task – [in] Requested AAR task.

Returns:

Address of the specified task register.

NRF_STATIC_INLINE void nrf_aar_enable(NRF_AAR_Type *p_reg)

Function for enabling AAR.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_aar_disable(NRF_AAR_Type *p_reg)

Function for disabling AAR.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE nrf_aar_error_t nrf_aar_error_get(NRF_AAR_Type const *p_reg)

Function for getting the error status when ERROR event is generated.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

Error – status when the ERROR event is generated.

NRF_STATIC_INLINE void nrf_aar_irk_pointer_set(NRF_AAR_Type *p_reg, uint8_t const *irk_ptr)

Function for setting the pointer to the Identity Resolving Keys (IRK) data structure.

The size of the provided data structure must correspond to the number of keys available. Each key occupies 16 bytes.

See also

nrf_aar_irk_number_set

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• irk_ptr – [in] Pointer to the IRK data structure. Must point to the Data RAM region.

NRF_STATIC_INLINE uint8_t const *nrf_aar_irk_pointer_get(NRF_AAR_Type const *p_reg)

Function for getting the pointer to the Identity Resolving Keys data structure.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Pointer to the IRK data structure.

NRF_STATIC_INLINE void nrf_aar_irk_number_set(NRF_AAR_Type *p_reg, uint8_t irk_num)

Function for setting the number of keys available in the Identity Resolving Keys data structure.

See also

nrf_aar_irk_pointer_set

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• irk_num – [in] Number of keys available in the IRK data structure. Maximum is 16. Must correspond to the size of the provided IRK data structure.

NRF_STATIC_INLINE uint8_t nrf_aar_irk_number_get(NRF_AAR_Type const *p_reg)

Function for getting the number of keys available in the Identity Resolving Keys data structure.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Number of keys in the IRK data structure.

NRF_STATIC_INLINE void nrf_aar_maxresolved_set(NRF_AAR_Type *p_reg, uint16_t maxresolved)

Function for setting maximum number of Identity Resolving Keys to resolve.

See also

nrf_aar_irk_pointer_set

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• maxresolved – [in] Maximum number of Identity Resolving Keys to resolve.

NRF_STATIC_INLINE uint16_t nrf_aar_maxresolved_get(NRF_AAR_Type const *p_reg)

Function for getting maximum number of Identity Resolving Keys to resolve.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Maximum number of Identity Resolving Keys to resolve.

NRF_STATIC_INLINE void nrf_aar_addr_pointer_set(NRF_AAR_Type *p_reg, uint8_t const *addr_ptr)

Function for setting the pointer to the resolvable address.

The resolvable address must consist of 6 bytes.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• addr_ptr – [in] Pointer to the address to resolve using the available IRK keys. Must point to the Data RAM region.

NRF_STATIC_INLINE uint8_t const *nrf_aar_addr_pointer_get(NRF_AAR_Type const *p_reg)

Function for getting the pointer to the resolvable address.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Pointer to the address to resolve.

NRF_STATIC_INLINE void nrf_aar_out_ptr_set(NRF_AAR_Type *p_reg, nrf_vdma_job_t const *p_job)

Function for setting the pointer to a job list containing description to store resolved addresses.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• p_job – [in] Pointer to a job list.

NRF_STATIC_INLINE nrf_vdma_job_t *nrf_aar_out_ptr_get(NRF_AAR_Type const *p_reg)

Function for getting the pointer to a job list containing description to store resolved addresses.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Pointer to the job list.

NRF_STATIC_INLINE void nrf_aar_in_ptr_set(NRF_AAR_Type *p_reg, nrf_vdma_job_t const *p_job)

Function for setting the pointer to a job list containing both the Hash and Prand parts of the private resolvable address (DEVICEADDR) field from the Bluetooth packet, and a number of Identity Resolving Keys (IRK).

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• p_job – [in] Pointer to a job list.

NRF_STATIC_INLINE nrf_vdma_job_t *nrf_aar_in_ptr_get(NRF_AAR_Type const *p_reg)

Function for getting the pointer to a job list containing both the Hash and Prand parts of the private resolvable address (DEVICEADDR) field from the Bluetooth packet, and a number of Identity Resolving Keys (IRK).

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Pointer to the job list.

NRF_STATIC_INLINE uint32_t nrf_aar_out_amount_get(NRF_AAR_Type const *p_reg)

Function for getting number of bytes available in the output data, not including the job list structure.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Number of bytes available in the output data.

NRF_STATIC_INLINE void nrf_aar_scratch_pointer_set(NRF_AAR_Type *p_reg, uint8_t *scratch_ptr)

Function for setting the pointer to the scratch data area.

The scratch data area is used for temporary storage during the address resolution procedure. A space of minimum 3 bytes must be reserved for the scratch data area.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• scratch_ptr – [in] Pointer to the scratch data area. Must point to the Data RAM region.

NRF_STATIC_INLINE uint8_t *nrf_aar_scratch_pointer_get(NRF_AAR_Type const *p_reg)

Function for getting the pointer to the scratch data area.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Pointer to the scratch data area.

NRF_STATIC_INLINE uint8_t nrf_aar_resolution_status_get(NRF_AAR_Type const *p_reg)

Function for getting the index of the Identity Resolving Key that was used the last time an address was resolved.

This function can be used to get the IRK index that matched the resolvable address, provided that NRF_AAR_EVENT_RESOLVED occured. Otherwise, it will return the index of the last IRK stored in the IRK data structure.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

The index of the IRK that was used the last time an address was resolved.

NRF_STATIC_INLINE void nrf_aar_subscribe_set(NRF_AAR_Type *p_reg, nrf_aar_task_t task, uint8_t channel)

Function for setting the subscribe configuration for a given AAR task.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• task – [in] Task for which to set the configuration.

• channel – [in] Channel through which to subscribe events.

NRF_STATIC_INLINE void nrf_aar_subscribe_clear(NRF_AAR_Type *p_reg, nrf_aar_task_t task)

Function for clearing the subscribe configuration for a given AAR task.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• task – [in] Task for which to clear the configuration.

NRF_STATIC_INLINE void nrf_aar_publish_set(NRF_AAR_Type *p_reg, nrf_aar_event_t event, uint8_t channel)

Function for setting the publish configuration for a given AAR event.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• event – [in] Event for which to set the configuration.

• channel – [in] Channel through which to publish the event.

NRF_STATIC_INLINE void nrf_aar_publish_clear(NRF_AAR_Type *p_reg, nrf_aar_event_t event)

Function for clearing the publish configuration for a given AAR event.

Parameters:

• p_reg – [in] Pointer to the structure of registers of the peripheral.

• event – [in] Event for which to clear the configuration.