 |
nrfxlib API 3.3.99
|
|
nrfxlib API 3.3.99
|
| uint8_t sdc_hci_cmd_le_setup_iso_data_path | ( | const sdc_hci_cmd_le_setup_iso_data_path_t * | p_params, |
| sdc_hci_cmd_le_setup_iso_data_path_return_t * | p_return ) |
#include <softdevice_controller/include/sdc_hci_cmd_le.h>
LE Setup ISO Data Path.
The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.8.109
This command is used to identify and create the isochronous data path between the Host and the Controller for a CIS, CIS configuration, or BIS identified by the Connection_Handle parameter. This command can also be used to configure a codec for each data path. When a connection is created no data paths are set up for that connection. When the command has completed successfully, data shall be allowed to flow over the specified path in the specified direction irrespective of the state of the other direction or any other path.
The input and output directions are defined from the perspective of the Controller, so "input" refers to data flowing from the Host to the Controller.
The Data_Path_Direction parameter specifies the direction for which the data path is being configured.
The Data_Path_ID parameter specifies the data transport path used. When set to 0x00, the data path shall be over the HCI transport. When set to a value in the range 0x01 to 0xFE, the data path shall use a vendor-specific transport interface (e.g., a PCM interface) with logical transport numbers. The meanings of these logical transport numbers are vendor-specific.
The Codec_ID parameter specifies the coding format used over the air.
When Data_Path_Direction is set to 0x00 (input), the Controller_Delay parameter specifies the delay at the data source from the reference time of an SDU to the CIG reference point (see [Vol 6] Part B, Section 4.5.14.1) or BIG anchor point (see [Vol 6] Part B, Section 4.4.6.4). When Data_Path_Direction is set to 0x01 (output), Controller_Delay specifies the delay from the SDU_Synchronization_Reference to the point in time at which the Controller begins to transfer the corresponding data to the data path interface. The Host should use the HCI_Read_Local_Supported_Controller_Delay command to obtain a suitable value for Controller_Delay. Note: Controller vendors can provide additional guidance to the Host on how to select a suitable Controller_Delay value from the range of values provided by the HCI_Read_Local_Supported_Controller_Delay command for various configurations of the data path interface.
The Codec_Configuration parameter specifies codec-specific configuration information for the specified direction.
Errors:
See Section 4.5.2 for a list of error types and descriptions.
Type Condition Error code
MC A data path for the same Connection_Handle and direction has been set Command
up and not removed. Disallowed
(0x0C)
MC Connection_Handle identifies a CIS on a Peripheral and the Command
HCI_LE_Accept_CIS_Request command for that CIS has not completed Disallowed
successfully. (0x0C)
MC The data transport path is vendor-specific and has not been Command
configured. Disallowed
(0x0C)
MC Connection Handle does not identify a CIS, CIS configuration, or BIS. Unknown
Connection
Identifier
(0x02)
MC Data_Path_Direction is output and Connection_Handle identifies an Command
Isochronous Broadcaster. Disallowed
(0x0C)
MC Data_Path_Direction is input and Connection_Handle identifies a Command
Synchronized Receiver. Disallowed
(0x0C)
MC Connection_Handle identifies a unidirectional CIS and Command
Data_Path_Direction is the direction where BN is set to 0. Disallowed
(0x0C)
MC Codec_Configuration_Length is non-zero and Codec_ID is set to Invalid HCI
transparent air mode. Command
Parameters
(0x12)
MC The codec-related parameters exceed the bandwidth and latency allowed Invalid HCI
on the established CIS or BIS identified by Connection_Handle. Command
Parameters
(0x12)
MC Connection_Handle identifies a CIS or BIS that is in ISO Test mode Command
(see Section 7.8.111, Section 7.8.112, and [Vol 6] Part B, Section 7) Disallowed
for the specified Data_Path_Direction. (0x0C)
Event(s) generated (unless masked away):
When the HCI_LE_Setup_ISO_Data_Path command has completed, an HCI_Command_Complete event shall be generated.
| [in] | p_params | Input parameters. |
| [out] | p_return | Extra return parameters. |
| 0 | if success. |
1.12.0