◆ sdc_hci_cmd_le_set_default_phy()

uint8_t sdc_hci_cmd_le_set_default_phy ( const sdc_hci_cmd_le_set_default_phy_t * p_params )

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Set Default PHY.

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

This command allows the Host to specify its preferred values for the transmitter PHY and receiver PHY to be used for all subsequent connections over the LE transport.

The All_PHYs parameter is a bit field that allows the Host to specify, for each direction, whether it has no preference among the PHYs that the Controller supports in a given direction or whether it has specified particular PHYs that it prefers in the TX_PHYs or RX_PHYs parameter.

The TX_PHYs parameter is a bit field that indicates the transmitter PHYs that the Host prefers the Controller to use. If the All_PHYs parameter specifies that the Host has no preference, the TX_PHYs parameter shall be ignored; otherwise at least one bit shall be set to 1.

The RX_PHYs parameter is a bit field that indicates the receiver PHYs that the Host prefers the Controller to use. If the All_PHYs parameter specifies that the Host has no preference, the RX_PHYs parameter shall be ignored; otherwise at least one bit shall be set to 1.

If the Host sets, in the TX_PHYs or RX_PHYs parameter, a bit for a PHY that the Controller does not support, including a bit that is reserved for future use, the Controller shall return the error code Unsupported Feature or Parameter Value (0x11).

Errors:

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

Type   Condition                                                           Error code
MC     The Controller does not support asymmetric connections (see [Vol    Unsupported Feature
       6] Part B, Section 4.6.9.1), All_PHYs is 0x00, and TX_PHYs is not   or Parameter Value
       the same as RX_PHYs.                                                (0x11)

Event(s) generated (unless masked away):

When the HCI_LE_Set_Default_PHY command has completed, an HCI_Command_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.