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

◆ sdc_hci_cmd_le_conn_rate_request()

uint8_t sdc_hci_cmd_le_conn_rate_request ( const sdc_hci_cmd_le_conn_rate_request_t * p_params)

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Connection Rate Request.

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

This command is used by a Central or a Peripheral to request a change to existing connection parameters (see Section 4.5.1) using the Connection Rate Update procedure (see [Vol 6] Part B, Section 5.1.32) or the Connection Rate Request procedure (see [Vol 6] Part B, Section 5.1.33).

The Connection_Interval_Min and Connection_Interval_Max parameters are used to define the minimum and maximum allowed connection interval.

The Subrate_Min and Subrate_Max parameters specify the range of acceptable subrating factors being requested.

The Max_Latency parameter specifies the maximum allowed Peripheral latency in units of subrated connection events. The same maximum shall apply irrespective of the subrating factor actually chosen.

The Continuation_Number parameter specifies the number of underlying connection intervals to remain active after a packet other than an empty packet is transmitted or received.

The Supervision_Timeout parameter specifies the link supervision timeout for the connection.

If this command is issued on the Central, then it also sets the acceptable parameters for requests from the Peripheral (see [Vol 6] Part B, Section 5.1.33). The acceptable parameters set by this command override those provided via the HCI_LE_Set_Default_Rate_Parameters command or any values set by previous uses of this command on the same connection. The Min_CE_Length and Max_CE_Length parameters provide the Controller with the expected minimum and maximum length of the connection events. The Controller is not required to use these values.

If this command is issued on the Central before the devices have performed the Feature Exchange procedure, then the Controller shall complete that procedure before initiating the Connection Rate Request procedure.

Errors:

See Section 4.5.2 for a list of error types and descriptions.

Type   Condition                                                         Error Code
MC     One or more CS procedures are enabled.                            Command Disallowed
                                                                         (0x0C)
MC     A Connection Parameters Request procedure or a Connection         Command Disallowed
       Subrate Request procedure is in progress.                         (0x0C)
MC     The Connection_Handle parameter does not identify an              Unknown Connection
       established ACL connection.                                       Identifier (0x02)
MC     Subrate_Max × (Max_Latency + 1) is greater than 500.              Invalid HCI Command
                                                                         Parameters (0x12)
MC     Connection_Interval_Max × Subrate_Max × (Max_Latency + 1) is      Invalid HCI Command
       greater than or equal to Supervision_Timeout × 40.                Parameters (0x12)
MC     Connection_Interval_Max is less than Connection_Interval_Min.     Invalid HCI Command
                                                                         Parameters (0x12)
MC     Connection_Interval_Min and Connection_Interval_Max specify a     Unsupported LL
       range of connection intervals which is not supported by the       Parameter Value (0x20)
       Controller.
MC     Connection_Interval_Max is less than connIntervalRequired (see    Unsupported Feature or
       [Vol 6] Part B, Section 4.5.10).                                  Parameter Value (0x11)
MC     Subrate_Max is less than Subrate_Min.                             Invalid HCI Command
                                                                         Parameters (0x12)
MC     Continuation_Number is greater than or equal to Subrate_Max.      Invalid HCI Command
                                                                         Parameters (0x12)
MC     The Connection Rate (Host Support) bit is not set in the local    Unsupported Remote
       or remote device’s FeatureSet.                                    Feature (0x1A)
MC     Max_CE_Length is less than Min_CE_Length                          Invalid HCI Command
                                                                         Parameters (0x12)

Event(s) generated (unless masked away):

When the Controller receives the HCI_LE_Connection_Rate_Request command, the Controller shall send the HCI_Command_Status event to the Host. An HCI_LE_Connection_Rate_Change event shall be generated when the Connection Rate Update procedure or the Connection Rate Request procedure has completed.

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.