◆ sdc_hci_cmd_vs_channel_reporting_enable()

uint8_t sdc_hci_cmd_vs_channel_reporting_enable ( const sdc_hci_cmd_vs_channel_reporting_enable_t * p_params )

#include <softdevice_controller/include/sdc_hci_vs.h>

Enable channel classification reporting on a connection.

This vendor-specific command is used to enable or disable Channel Classification reporting for the ACL connection identified by the Connection_Handle parameter.

The command initiates the Channel Classification Enable Link Layer procedure on the Central by sending an LL_CHANNEL_REPORTING_IND PDU to the Peripheral. See Core Specification, Vol 6, Part B, Section 5.1.21.

When the Enable parameter is set to 0x01, the Peripheral shall report channel classification information by initiating the Channel Classification Reporting procedure (see Core Specification, Vol 6, Part B, Section 5.1.22). When the Enable parameter is set to 0x00, the Peripheral shall not send channel classification information.

When reporting is enabled, the Min_Spacing and Max_Delay parameters configure the minimum time between consecutive LL_CHANNEL_STATUS_IND PDUs and the maximum delay from a channel classification change until reporting, respectively. Both parameters are expressed in units of 200 ms. Valid values are in the range 5 to 150 (1 second to 30 seconds). Max_Delay shall be greater than or equal to Min_Spacing.

When reporting is enabled, the Controller generates SDC_HCI_SUBEVENT_VS_CHANNEL_CLASSIFICATION_REPORT events when an LL_CHANNEL_STATUS_IND PDU is received from the Peripheral.

Errors:

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

Type   Condition                                                        Error code
MC     Connection_Handle does not identify a current ACL.               Unknown Connection
                                                                        Identifier (0x02)
MC     The local Controller is not the Central of the connection.       Command Disallowed
                                                                        (0x0C)
MC     The remote device does not support the Channel Classification    Unsupported Remote
       feature.                                                         Feature (0x1A)
MC     A Channel Classification Enable procedure is still in progress   Controller Busy
       on this connection.                                              (0x3A)
MC     Enable is greater than 0x01, or Min_Spacing or Max_Delay is      Invalid HCI Command
       out of range, or Max_Delay is less than Min_Spacing.             Parameters (0x12)

Event(s) generated (unless masked away):

When the Controller receives the HCI_VS_Channel_Reporting_Enable command, the Controller shall send the HCI_Command_Status event to the Host. When the HCI_VS_Channel_Reporting_Enable command has completed, an HCI_VS_Channel_Reporting_Enable_Complete event shall be generated.

Parameters

[in] p_params Input parameters.

Return values

0	if 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.