nrfxlib API 3.3.99
Loading...
Searching...
No Matches

◆ sdc_hci_cmd_le_set_resolvable_private_address_timeout()

uint8_t sdc_hci_cmd_le_set_resolvable_private_address_timeout ( const sdc_hci_cmd_le_set_resolvable_private_address_timeout_t * p_params)

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Set Resolvable Private Address Timeout [v1].

The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.8.45

Version [v1] of this command sets the length of time the Controller uses a Resolvable Private Address before a new Resolvable Private Address is generated and starts being used.

Version [v2] of this command sets the range of time the Controller uses a Resolvable Private Address before a new Resolvable Private Address is generated and starts being used.

This timeout applies to all resolvable private addresses generated by the Controller.

The RPA_Timeout parameter specifies the time after which a new Resolvable Private Address shall start being used.

The RPA_Timeout_Min parameter specifies the minimum time after which a new Resolvable Private Address shall start being used.

The RPA_Timeout_Max parameter specifies the maximum time after which a new Resolvable Private Address shall start being used.

When the Controller supports the HCI_LE_Set_Resolvable_Private_Address_Timeout [v2] command and needs to set a new timeout (e.g., when the RPA is set for the first time, or when the current timeout expires), the new timeout shall be a random value between RPA_Timeout_Min and RPA_Timeout_Max generated so as to meet the requirements for random number generation defined in [Vol 2] Part H, Section 2.

If RPA_Timeout_Min is greater than RPA_Timeout_Max, then the Controller shall return the error code Invalid HCI Command Parameters (0x12).

If the Controller supports version [v2] of this command, then the default behavior shall be to use the range 8 to 15 minutes. Otherwise the default timeout shall be 15 minutes.

Event(s) generated (unless masked away):

When the HCI_LE_Set_Resolvable_Private_Address_Timeout command has completed, an HCI_Command_Complete event shall be generated.

Parameters
[in]p_paramsInput parameters.
Return values
0if success.
Returns
Returns value between 0x01-0xFF in case of error. See Vol 2, Part D, Error for a list of error codes and descriptions.