 |
nrfxlib API 2.8.99
|
|
nrfxlib API 2.8.99
|
| uint8_t sdc_hci_cmd_le_create_big | ( | const sdc_hci_cmd_le_create_big_t * | p_params | ) |
#include <softdevice_controller/include/sdc_hci_cmd_le.h>
LE Create BIG.
The description below is extracted from Core_v6.0, Vol 4, Part E, Section 7.8.103
The HCI_LE_Create_BIG command is used to create a BIG with one or more BISes (see [Vol 6] Part B, Section 4.4.6). All BISes in a BIG have the same value for all parameters.
The BIG_Handle contains the identifier of the BIG. This parameter is allocated by the Host and used by the Controller and the Host to identify a BIG.
The Advertising_Handle identifies the associated periodic advertising train of the BIG (see [Vol 6] Part B, Section 4.4.5.1).
The Num_BIS parameter contains the total number of BISes in the BIG.
The SDU_Interval parameter contains the time interval of the periodic SDUs.
The Max_SDU parameter contains the maximum size of an SDU.
The Max_Transport_Latency parameter is the maximum transport latency (in milliseconds) as described in [Vol 6] Part G, Section 3.2.1 and [Vol 6] Part G, Section 3.2.2. This includes pre-transmissions.
The RTN (Retransmission Number) parameter contains the number of times every PDU should be retransmitted, irrespective of which BIG events the retransmissions occur in. This is a recommendation to the Controller which the Controller may ignore.
The PHY parameter is a bit field that indicates the PHY used for transmission of PDUs of BISes in the BIG. The Host shall set at least one bit in this parameter and the Controller shall pick a PHY from the bits set. If the Host sets, in the PHY parameter, a bit for a PHY that the Controller does not support, including a bit that is reserved for future use, then the Controller shall return the error code Unsupported Feature or Parameter Value (0x11).
The Packing parameter is used to indicate the preferred method of arranging subevents of multiple BISes. The subevents can be arranged in Sequential or Interleaved arrangement. This is a recommendation to the Controller which it may ignore. This parameter shall be ignored when there is only one BIS in the BIG.
The Framing parameter indicates the format of the BIS Data PDUs and the mode of framed PDUs that the Host is requesting the Controller to use on the specified BIG. The Controller may use any combination of format and mode permitted by [Vol 6] Part G, Table 2.1
The Encryption parameter identifies the encryption mode of the BISes. If the Encryption parameter is set to 1 (encrypted), then the Broadcast_Code is used in the encryption of payloads (see [Vol 6] Part B, Section 4.4.6.10).
The Broadcast_Code parameter is used to generate the encryption key for encrypting payloads of all BISes. When the Encryption parameter is set to 0 (unencrypted), the Broadcast_Code parameter shall be set to zero by the Host and ignored by the Controller.
If the Controller cannot create all BISes of the BIG or if Num_BIS exceeds the maximum value supported by the Controller, then it shall return the error code Connection Rejected due to Limited Resources (0x0D).
If the Advertising_Handle does not identify a periodic advertising train, the periodic advertising train is associated with another BIG, or the periodic advertising train has responses and the Controller does not support that, then the Controller shall return the error code Unknown Advertising Identifier (0x42).
If the Host issues this command with a BIG_Handle for a BIG that is already created, then the Controller shall return the error code Command Disallowed (0x0C).
If the Host specifies an invalid combination of BIG parameters, then the Controller shall return an error which should use the error code Invalid HCI Command Parameters (0x12).
If the length of the associated periodic advertising, with the BIGInfo added to the ACAD, is greater than the maximum that the Controller can transmit within the periodic advertising interval (if periodic advertising is currently enabled) or the Periodic_Advertising_Interval_Max for the advertising set (if currently disabled), then the Controller shall return an error and should use the error code Packet Too Long (0x45). If advertising on the LE Coded PHY, then the S=8 coding shall be assumed unless the current advertising parameters require the use of S=2 for an advertising physical channel, in which case the S=2 coding shall be assumed for that advertising physical channel.
Event(s) generated (unless masked away): When the Controller receives the HCI_LE_Create_BIG command, the Controller sends the HCI_Command_Status event to the Host. When the HCI_LE_Create_BIG command has completed, the HCI_LE_Create_BIG_Complete event is generated.
| [in] | p_params | Input parameters. |
| 0 | if success. |
1.12.0