This document describes the STM32WBA BLE Application Commands Interface (ACI) and Host Commands Interface (HCI).
June 2022 - Rev 1.0 - First release.
July 2022 - Rev 1.1 - Fixed Event_Mask default value.
August 2022 - Rev 1.2 - Fixed HCI_READ_LOCAL_SUPPORTED_CODECS_V2; Removed "SCA Updates" feature; Fixed some spelling issues.
October 2022 - Rev 1.3 - Added Enhanced ATT feature; Added new commands: ACI_HAL_CONTINUOUS_TX_START, ACI_GATT_SEND_MULT_NOTIFICATION and ACI_GATT_READ_MULTIPLE_VAR_CHAR_VALUE; Added new events: ACI_GATT_EATT_BEARER_EVENT and ACI_GATT_MULT_NOTIFICATION_EVENT; Changed ACI_GATT_ADD_CHAR and ACI_GATT_TX_POOL_AVAILABLE_EVENT descriptions; Added note for GAP peripheral commands that only support legacy advertising; Fixed formula of RF_Channel; Added possible values for HCI_HOST_BUFFER_SIZE and HCI_WRITE_CONNECTION_ACCEPT_TIMEOUT; Created annex for TX Power Level; Replaced ACI_HAL_GET_LINK_STATUS by ACI_HAL_GET_LINK_STATUS_V2.
January 2023 - Rev 1.4 - Completed the description of Connection_Handle for some primitives; Completed the description of ACI_GAP_ADDR_NOT_RESOLVED_EVENT.
January 2023 - Rev 1.5 - Added new ATT error codes; Added ACI_HAL_SYNC_EVENT in ACI_HAL_SET_EVENT_MASK; Completed possible values of ACI_HAL_SET_RADIO_ACTIVITY_MASK and ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT.
March 2023 - Rev 1.6 - Updated HCI status error codes; Added HCI_LE_REQUEST_PEER_SCA and HCI_LE_REQUEST_PEER_SCA_COMPLETE_EVENT; Fixed possible values for HCI_LE_READ_ANTENNA_INFORMATION; Added ACI_GATT_NOTIFICATION_COMPLETE_EVENT; Added GAP service additional record number in ACI_HAL_WRITE_CONFIG_DATA; Completed description of ACI_GATT_ADD_CHAR and ACI_GATT_ADD_CHAR_DESC; Modified ACI_HAL_SYNC_EVENT.
March 2023 - Rev 1.7 - Added HCI_LE_GENERATE_DHKEY_V2 in LB variant; Completed some missing descriptions and possible values; Fixed description of HCI_ENCRYPTION_KEY_REFRESH_COMPLETE_EVENT, ACI_GATT_SET_EVENT_MASK, ACI_GAP_SET_EVENT_MASK and ACI_HAL_SET_EVENT_MASK; Added SC key type in ACI_HAL_WRITE_CONFIG_DATA.
May 2023 - Rev 1.8 - Changed description of ACI_GAP_SET_OOB_DATA, ACI_GAP_GET_OOB_DATA and ACI_GAP_SET_DIRECT_CONNECTABLE; Updated description of scanning and initiator filter policy; Renamed ACI_GAP_CONFIGURE_WHITELIST, ACI_HAL_SET_SLAVE_LATENCY, ACI_GAP_SLAVE_SECURITY_REQ and ACI_GAP_SLAVE_SECURITY_INITIATED_EVENT, as well as some parameter names; Replaced ACI_HAL_GET_PM_DEBUG_INFO by ACI_HAL_GET_PM_DEBUG_INFO_V2.
May 2023 - Rev 1.9 - Changed description of ACI_HAL_SET_TX_POWER_LEVEL; Fixed some spelling issues.
Note: in the command tables, a "Y" in the "BF", "LO" or "LB" column, means that the corresponding command applies to the "Basic Features", "Link Layer Only" or "Link Layer Only Basic" variant of the BLE stack, respectively.
The HCI_DISCONNECT is used to terminate an existing connection. The Connection_Handle command parameter indicates which connection is to be disconnected. The Reason command parameter indicates the reason for ending the connection. The remote Controller will receive the Reason command parameter in the HCI_DISCONNECTION_COMPLETE_EVENT event. All synchronous connections on a physical link should be disconnected before the ACL connection on the same physical connection is disconnected.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.1.6].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Reason | 1 | The reason for ending the connection. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command will obtain the values for the version information for the remote device identified by the Connection_Handle parameter. The Connection_Handle must be a Connection_Handle for an ACL or LE connection.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.1.23].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The Set_Event_Mask command is used to control which events are generated by the HCI for the Host. If the bit in the Event_Mask is set to a one, then the event associated with that bit will be enabled. For an LE Controller, the LE Meta Event bit in the Event_Mask shall enable or disable all LE events in the LE Meta Event. The Host has to deal with each event that occurs. The event mask allows the Host to control how much it is interrupted.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.1].
Parameter | Size | Description | Possible values |
---|---|---|---|
Event_Mask | 8 | Event mask. Default: 0x2000FFFFFFFFFFFF | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The Reset command resets the Link Layer on an LE Controller. The Reset command shall not affect the used HCI transport layer since the HCI transport layers may have reset mechanisms of their own. After the reset is completed, the current operational state is lost, the Controller enters standby mode and the Controller automatically reverts to the default values for the parameters for which default values are defined in the specification.
Note: The Reset command does not necessarily perform a hardware reset. This is implementation defined.
The Host shall not send additional HCI commands before the Command Complete event related to the Reset command has been received.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.2].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command reads the value for the Connection Accept Timeout configuration parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.13].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Accept_Timeout | 2 |
This command writes the value for the Connection Accept Timeout configuration parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.14].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Accept_Timeout | 2 | Connection Accept Timeout measured in number of baseband slots. Interval Length = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command reads the values for the Transmit_Power_Level parameter for the specified Connection_Handle. The Connection_Handle shall be a Connection_Handle for an ACL connection.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.35].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Type | 1 | Current or maximum transmit power level. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Transmit_Power_Level | 1 | Size: 1 Octet (signed integer). Units: dBm. |
This command is used by the Host to turn flow control on or off for data and/or voice sent in the direction from the Controller to the Host. If flow control is turned off, the Host should not send the Host_Number_Of_Completed_Packets command. That command will be ignored by the Controller if it is sent by the Host and flow control is off. If flow control is turned on for HCI ACL Data Packets and off for HCI synchronous Data Packets, Host_Number_Of_Completed_Packets commands sent by the Host should only contain Connection_Handles for ACL connections. If flow control is turned off for HCI ACL Data Packets and on for HCI synchronous Data Packets, Host_Number_Of_Completed_Packets commands sent by the Host should only contain Connection_Handles for synchronous connections. If flow control is turned on for HCI ACL Data Packets and HCI synchronous Data Packets, the Host will send Host_Number_Of_Completed_Packets commands both for ACL connections and synchronous connections.
The Flow_Control_Enable parameter shall only be changed if no connections exist.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.38].
Parameter | Size | Description | Possible values |
---|---|---|---|
Flow_Control_Enable | 1 | Enable/Disable the Flow Control |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The Host_Buffer_Size command is used by the Host to notify the Controller about the maximum size of the data portion of HCI ACL and synchronous Data Packets sent from the Controller to the Host. The Controller shall segment the data to be transmitted from the Controller to the Host according to these sizes, so that the HCI Data Packets will contain data with up to these sizes. The Host_Buffer_Size command also notifies the Controller about the total number of HCI ACL and synchronous Data Packets that can be stored in the data buffers of the Host. If flow control from the Controller to the Host is turned off, and the Host_Buffer_Size command has not been issued by the Host, this means that the Controller will send HCI Data Packets to the Host with any lengths the Controller wants to use, and it is assumed that the data buffer sizes of the Host are unlimited. If flow control from the Controller to the Host is turned on, the Host_Buffer_Size command shall after a power-on or a reset always be sent by the Host before the first Host_Number_Of_Completed_Packets command is sent.
The Set Controller To Host Flow Control Command is used to turn flow control on or off.
The Host_ACL_Data_Packet_Length command parameter will be used to determine the size of the L2CAP segments contained in ACL Data Packets, which are transferred from the Controller to the Host.
The Host_Synchronous_Data_Packet_Length command parameter is used to determine the maximum size of HCI synchronous Data Packets. Both the Host and the Controller shall support command and event packets, where the data portion (excluding header) contained in the packets is 255 octets in size.
The Host_Total_Num_ACL_Data_Packets command parameter contains the total number of HCI ACL Data Packets that can be stored in the data buffers of the Host. The Controller will determine how the buffers are to be divided between different Connection_Handles.
The Host_Total_Num_Synchronous_Data_Packets command parameter gives the same information for HCI synchronous Data Packets.
Note: The Host_ACL_Data_Packet_Length and Host_Synchronous_Data_Packet_Length command parameters do not include the length of the HCI Data Packet header.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.39].
Parameter | Size | Description | Possible values |
---|---|---|---|
Host_ACL_Data_Packet_Length | 2 | Maximum length (in octets) of the data portion of each HCI ACL Data Packet that the Host is able to accept. | |
Host_Synchronous_Data_Packet_Length | 1 | Maximum length (in octets) of the data portion of each HCI synchronous Data Packet that the Host is able to accept. Not used. | |
Host_Total_Num_ACL_Data_Packets | 2 | Total number of HCI ACL Data Packets that can be stored in the data buffers of the Host. | |
Host_Total_Num_Synchronous_Data_Packets | 2 | Total number of HCI synchronous Data Packets that can be stored in the data buffers of the Host. Not used. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The Host_Number_Of_Completed_Packets command is used by the Host to indicate to the Controller the number of HCI Data Packets that have been completed for each Connection_Handle since the previous Host_Number_Of_Completed_Packets command was sent to the Controller. This means that the corresponding buffer space has been freed in the Host. Based on this information, and the Host_Total_Num_ACL_Data_Packets and Host_Total_Num_Synchronous_Data_Packets command parameters of the Host_Buffer_Size command, the Controller can determine for which Connection_Handles the following HCI Data Packets should be sent to the Host. The command should only be issued by the Host if flow control in the direction from the Controller to the Host is on and there is at least one connection, or if the Controller is in local loopback mode. Otherwise, the command will be ignored by the Controller. When the Host has completed one or more HCI Data Packet(s) it shall send a Host_Number_Of_Completed_Packets command to the Controller, until it finally reports that all pending HCI Data Packets have been completed. The frequency at which this command is sent is manufacturer specific.
The Set Controller To Host Flow Control Command is used to turn flow control on or off. If flow control from the Controller to the Host is turned on, the Host_Buffer_Size command shall always be sent by the Host after a power-on or a reset before the first Host_Number_Of_Completed_Packets command is sent.
Note: The Host_Number_Of_Completed_Packets command is a special command in the sense that no event is normally generated after the command has completed. The command may be sent at any time by the Host when there is at least one connection, or if the Controller is in local loopback mode independent of other commands. The normal flow control for commands is not used for the Host_Number_Of_Completed_Packets command.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.40].
Parameter | Size | Description | Possible values |
---|---|---|---|
Number_Of_Handles | 1 | The number of Connection_Handles and Host_Num_Of_Completed_Packets parameters pairs contained in this command. | 0-255 |
Connection_Handle[i] | Number_Of_Handles * 2 | Connection_Handle | 0x0000-0x0EFF |
Host_Num_Of_Completed_Packets[i] | Number_Of_Handles * 2 | The number of HCI Data Packets that have been completed for the associated Connection_Handle since the previous time the event was returned. | 0x0000-0xFFFF |
None
Normally, no event is generated after the Host_Number_Of_Completed_Packets command has completed. However, if the Host_Number_Of_Completed_Packets command contains one or more invalid parameters, the Controller shall return a Command Complete event with a failure status indicating the Invalid HCI Command Parameters error code. The Host may send the Host_Number_Of_Completed_Packets command at any time when there is at least one connection, or if the Controller is in local loopback mode. The normal flow control for commands is not used for this command.
The HCI_Set_Event_Mask_Page_2 command is used to control which events are generated by the HCI for the Host. The Event_Mask_Page_2 is a logical extension to the Event_Mask parameter of the HCI_Set_Event_Mask command.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.69].
Parameter | Size | Description | Possible values |
---|---|---|---|
Event_Mask_Page_2 | 8 | Event mask page 2. Default: 0 | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command reads the Authenticated_Payload_Timeout parameter in the Controller on the specified Connection_Handle.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.93].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Authenticated_Payload_Timeout | 2 | Maximum amount of time specified between packets authenticated by a valid MIC. Time = N * 10 ms |
This command writes the Authenticated_Payload_Timeout parameter in the Controller for the specified Connection_Handle.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.94].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Authenticated_Payload_Timeout | 2 | Maximum amount of time specified between packets authenticated by a valid MIC. Time = N * 10 ms |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command provides a hint to the Controller specifying the base communication interval the Controller can expect current and future communications to use.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.100].
Parameter | Size | Description | Possible values |
---|---|---|---|
Interval | 2 | Hint for the base interval of the ecosystem. Time = N * 1.25 ms |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to request the Controller to configure the data transport path in a given direction between the Controller and the Host.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.3.101].
Parameter | Size | Description | Possible values |
---|---|---|---|
Data_Path_Direction | 1 | Data path direction. | |
Data_Path_ID | 1 | Data path identifier. | |
Vendor_Specific_Config_Length | 1 | Length of Vendor_Specific_Config in octets | |
Vendor_Specific_Config | Vendor_Specific_Config_Length | Vendor-specific configuration data for the data path being configured. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command reads the values for the version information for the local Controller. The HCI Version information defines the version information of the HCI layer. The LMP/PAL Version information defines the version of the LMP or PAL. The Manufacturer_Name information indicates the manufacturer of the local device. The HCI Revision and LMP/PAL Subversion are implementation dependent.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.4.1].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
HCI_Version | 1 | See Bluetooth Assigned Numbers (https://www.bluetooth.org/en-us/specification/assigned-numbers) | |
HCI_Revision | 2 | Revision of the Current HCI in the BR/EDR Controller. | |
LMP_PAL_Version | 1 | Version of the Current LMP or PAL in the Controller. See Bluetooth Assigned Numbers (https://www.bluetooth.org/en-us/specification/assigned-numbers) | |
Manufacturer_Name | 2 | Manufacturer Name of the BR/EDR Controller. See Bluetooth Assigned Numbers (https://www.bluetooth.org/en-us/specification/assigned-numbers) | |
LMP_PAL_Subversion | 2 | Subversion of the Current LMP or PAL in the Controller. This value is implementation dependent. |
This command reads the list of HCI commands supported for the local Controller. This command shall return the Supported_Commands configuration parameter. It is implied that if a command is listed as supported, the feature underlying that command is also supported.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.4.2].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Supported_Commands | 64 | Bit mask for each HCI Command. If a bit is 1, the Controller supports the corresponding command and the features required for the command. Unsupported or undefined commands shall be set to 0. |
This command requests a list of the supported features for the local Controller. This command will return a list of the LMP features. For details see Part C, Link Manager Protocol Specification.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.4.3].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
LMP_Features | 8 | Bit Mask List of LMP features. |
On an LE Controller, this command shall read the Public Device Address as defined in [Vol 6] Part B, Section 1.3, Device Address. If this Controller does not have a Public Device Address, the value 0x000000000000 shall be returned.
On an LE Controller, the public address shall be the same as the BD_ADDR.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.4.6].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
BD_ADDR | 6 | BD_ADDR ( Bluetooth Device Address) of the Device. |
This command reads a list of the Bluetooth SIG approved codecs supported by the Controller, as well as vendor specific codecs, which are defined by an individual manufacturer.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.4.8].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Num_Supported_Standard_Codecs | 1 | Length of Standard_Codec in octets | |
Standard_Codec | Num_Supported_Standard_Codecs * 2 | Standard codec ID and Transport | |
Num_Supported_Vendor_Specific_Codecs | 1 | Length of Vendor_Specific_Codec in octets | |
Vendor_Specific_Codec | Num_Supported_Vendor_Specific_Codecs * 5 | Vendor specific codec ID and Transport |
This command returns a list of codec capabilities supported by the Controller for a given codec. Only capabilities for the codec specified by the Codec_ID parameter and that match the transport specified by the Logical_Transport_Type parameter and direction specified by the Direction parameter are returned.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.4.10].
Parameter | Size | Description | Possible values |
---|---|---|---|
Codec_ID | 5 | Codec Identifier - Octet 0: See Assigned Numbers - Octets 1 to 2: Company ID, see Assigned Numbers for Company Identifier. Shall be ignored if octet 0 is not 0xFF. - Octets 3 to 4: Vendor-defined codec ID. Shall be ignored if octet 0 is not 0xFF. | |
Logical_Transport_Type | 1 | Codec transport type. | |
Direction | 1 | Codec direction. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Num_Codec_Capabilities | 1 | ||
Codec_Capabilities | 250 |
This command returns the range of supported Controller delays for the codec specified by the Codec_ID parameter on a given transport type specified by the Logical_Transport_Type parameter, in the direction specified by the Direction parameter, and with the codec configuration specified by the Codec_Configuration parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.4.11].
Parameter | Size | Description | Possible values |
---|---|---|---|
Codec_ID | 5 | Codec Identifier - Octet 0: See Assigned Numbers - Octets 1 to 2: Company ID, see Assigned Numbers for Company Identifier. Shall be ignored if octet 0 is not 0xFF. - Octets 3 to 4: Vendor-defined codec ID. Shall be ignored if octet 0 is not 0xFF. | |
Logical_Transport_Type | 1 | Codec transport type. | |
Direction | 1 | Codec direction. | |
Codec_Configuration_Length | 1 | Length of Codec_Configuration in octets | |
Codec_Configuration | Codec_Configuration_Length | Codec-specific configuration data. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Min_Controller_Delay | 3 | Minimum Controller delay in us. | |
Max_Controller_Delay | 3 | Maximum Controller delay in us. |
This command reads the Received Signal Strength Indication (RSSI) value from a Controller. For an LE transport, a Connection_Handle is used as the Handle command parameter and return parameter. The meaning of the RSSI metric is an absolute receiver signal strength value in dBm to +/- 6 dB accuracy. If the RSSI cannot be read, the RSSI metric shall be set to 127.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.5.4].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
RSSI | 1 | RSSI (signed integer). Units: dBm. |
The LE_Set_Event_Mask command is used to control which LE events are generated by the HCI for the Host. If the bit in the LE_Event_Mask is set to a one, then the event associated with that bit will be enabled. The Host has to deal with each event that is generated by an LE Controller. The event mask allows the Host to control which events will interrupt it.
For LE events to be generated, the LE Meta-Event bit in the Event_Mask shall also be set. If that bit is not set, then LE events shall not be generated, regardless of how the LE_Event_Mask is set.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.1].
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Event_Mask | 8 | LE event mask. Default: 0x000000000003185F. | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Read_Buffer_Size command is used to read the maximum size of the data portion of HCI LE ACL Data Packets sent from the Host to the Controller.
The Host will segment the data transmitted to the Controller according to these values, so that the HCI Data Packets will contain data with up to this size. The LE_Read_Buffer_Size command also returns the total number of HCI LE ACL Data Packets that can be stored in the data buffers of the Controller. The LE_Read_Buffer_Size command must be issued by the Host before it sends any data to an LE Controller (see Section 4.1.1).
If the Controller returns a length value of zero, the Host shall use the Read_Buffer_Size command to determine the size of the data buffers.
Note: Both the Read_Buffer_Size and LE_Read_Buffer_Size commands may return buffer length and number of packets parameter values that are nonzero.
The HC_LE_ACL_Data_Packet_Length return parameter shall be used to determine the size of the L2CAP PDU segments contained in ACL Data Packets, which are transferred from the Host to the Controller to be broken up into packets by the Link Layer. Both the Host and the Controller shall support command and event packets, where the data portion (excluding header) contained in the packets is 255 octets in size. The HC_Total_Num_LE_ACL_Data_Packets return parameter contains the total number of HCI ACL Data Packets that can be stored in the data buffers of the Controller. The Host determines how the buffers are to be divided between different Connection Handles.
Note: The HC_LE_ACL_Data_Packet_Length return parameter does not include the length of the HCI Data Packet header.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.2].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
HC_LE_ACL_Data_Packet_Length | 2 | Used to determine the maximum size of the L2CAP PDU segments that are contained in ACL data packets, and which are transferred from the Host to the Controller to be broken up into packets by the Link Layer. | |
HC_Total_Num_LE_ACL_Data_Packets | 1 | Contains the total number of HCI ACL Data packets that can be stored in the data buffers of the Controller. |
This command requests the list of the supported LE features for the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.3].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
LE_Features | 8 | Bit Mask List of LE features. See Bluetooth Core specification. |
The LE_Set_Random_Address command is used by the Host to set the LE Random Device Address in the Controller (see [Vol 6] Part B, Section 1.3).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.4].
Parameter | Size | Description | Possible values |
---|---|---|---|
Random_Address | 6 | Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Set_Advertising_Parameters command is used by the Host to set the advertising parameters.
The Advertising_Interval_Min shall be less than or equal to the Advertising_Interval_Max.
The Advertising_Interval_Min and Advertising_Interval_Max should not be the same value to enable the Controller to determine the best advertising interval given other activities.
For high duty cycle directed advertising, i.e. when Advertising_Type is 0x01 (ADV_DIRECT_IND, high duty cycle), the Advertising_Interval_Min and Advertising_Interval_Max parameters are not used and shall be ignored.
The Advertising_Type is used to determine the packet type that is used for advertising when advertising is enabled.
The Advertising_Interval_Min and Advertising_Interval_Max shall not be set to less than 0x00A0 (100 ms) if the Advertising_Type is set to 0x02 (ADV_SCAN_IND) or 0x03 (ADV_NONCONN_IND). The Own_Address_Type determines if the advertising packets are identified with the Public Device Address of the device, or a Random Device Address as written by the LE_Set_Random_Address command.
If directed advertising is performed, i.e. when Advertising_Type is set to 0x01 (ADV_DIRECT_IND, high duty cycle) or 0x04 (ADV_DIRECT_IND, low duty cycle mode), then the Direct_Address_Type and Direct_Address shall be valid, otherwise they shall be ignored by the Controller and not used.
The Advertising_Channel_Map is a bit field that indicates the advertising channels that shall be used when transmitting advertising packets. At least one channel bit shall be set in the Advertising_Channel_Map parameter.
The Advertising_Filter_Policy parameter shall be ignored when directed advertising is enabled.
The Host shall not issue this command when advertising is enabled in the Controller; if it is the Command Disallowed error code shall be used.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.5].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Interval_Min | 2 | Minimum advertising interval. Time = N * 0.625 ms. | |
Advertising_Interval_Max | 2 | Maximum advertising interval. Time = N * 0.625 ms. | |
Advertising_Type | 1 | Advertising type. | |
Own_Address_Type | 1 | Own address type. | |
Peer_Address_Type | 1 | Address type of the peer device. | |
Peer_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the device to be connected. | |
Advertising_Channel_Map | 1 | Advertising channel map. | Bitmask of: |
Advertising_Filter_Policy | 1 | Advertising filter policy. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Read_Advertising_Physical_Channel_Tx_Power command is used by the Host to read the transmit power level used for LE advertising physical channel packets.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.6].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Transmit_Power_Level | 1 | Size: 1 Octet (signed integer) Units: dBm Accuracy: +/- 4 dBm |
The LE_Set_Advertising_Data command is used to set the data used in advertising packets that have a data field.
Only the significant part of the Advertising_Data is transmitted in the advertising packets, as defined in [Vol 3] Part C, Section 11.,
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.7].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Data_Length | 1 | The number of significant octets in the following data field | |
Advertising_Data | 31 | 31 octets of data formatted as defined in [Vol 3] Part C, Section 11. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to provide data used in Scanning Packets that have a data field.
Only the significant part of the Scan_Response_Data is transmitted in the Scanning Packets, as defined in [Vol 3] Part C, Section 11.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.8].
Parameter | Size | Description | Possible values |
---|---|---|---|
Scan_Response_Data_Length | 1 | The number of significant octets in the following data field | |
Scan_Response_Data | 31 | 31 octets of data formatted as defined in [Vol 3] Part C, Section 11. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Set_Advertising_Enable command is used to request the Controller to start or stop advertising. The Controller manages the timing of advertisements as per the advertising parameters given in the LE_Set_Advertising_Parameters command.
The Controller shall continue advertising until the Host issues an LE_Set_Advertising_Enable command with Advertising_Enable set to 0x00 (Advertising is disabled) or until a connection is created or until the Advertising is timed out due to high duty cycle Directed Advertising. In these cases, advertising is then disabled.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.9].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Enable | 1 | Enable/disable advertising. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Set_Scan_Parameters command is used to set the scan parameters.
The LE_Scan_Type parameter controls the type of scan to perform.
The LE_Scan_Interval and LE_Scan_Window parameters are recommendations from the Host on how long (LE_Scan_Window) and how frequently (LE_Scan_Interval) the Controller should scan (See [Vol 6] Part B, Section 4.4.3). The LE_Scan_Window parameter shall always be set to a value smaller or equal to the value set for the LE_Scan_Interval parameter. If they are set to the same value scanning should be run continuously.
The Own_Address_Type parameter determines the address used (Public or Random Device Address) when performing active scan.
The Host shall not issue this command when scanning is enabled in the Controller; if it is the Command Disallowed error code shall be used.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.10].
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Type | 1 | Passive or active scanning. With passive scanning, no scan request PDUs are sent. | |
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type. | |
Scanning_Filter_Policy | 1 | The scanning filter policy determines how the scanner's Link Layer processes advertising and scan response PDUs. There is a choice of two primary filter policies: unfiltered and filtered. Unfiltered: the Link Layer processes all advertising and scan response PDUs (i.e., the Filter Accept List is not used). Filtered: the Link Layer processes advertising and scan response PDUs only from devices in the Filter Accept List. With extended scanning filter policies, a directed advertising PDU accepted by the primary filter policy shall nevertheless be ignored unless either the TargetA field is identical to the scanner's device address, or TargetA field is a resolvable private address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Set_Scan_Enable command is used to start scanning. Scanning is used to discover advertising devices nearby.
The Filter_Duplicates parameter controls whether the Link Layer shall filter duplicate advertising reports to the Host, or if the Link Layer should generate advertising reports for each packet received.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.11].
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Enable | 1 | Enable/disable scan. | |
Filter_Duplicates | 1 | Enable/disable duplicate filtering. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Create_Connection command is used to create a Link Layer connection to a connectable advertiser.
The LE_Scan_Interval and LE_Scan_Window parameters are recommendations from the Host on how long (LE_Scan_Window) and how frequently (LE_Scan_Interval) the Controller should scan. The LE_Scan_Window parameter shall be set to a value smaller or equal to the value set for the LE_Scan_Interval parameter. If both are set to the same value, scanning should run continuously.
The Initiator_Filter_Policy is used to determine whether the Filter Accept List is used. If the Filter Accept List is not used, the Peer_Address_Type and the Peer_Address parameters specify the address type and address of the advertising device to connect to.
The Link Layer shall set the address in the CONNECT_REQ packets to either the Public Device Address or the Random Device Addressed based on the Own_Address_Type parameter.
The Conn_Interval_Min and Conn_Interval_Max parameters define the minimum and maximum allowed connection interval. The Conn_Interval_Min parameter shall not be greater than the Conn_Interval_Max parameter.
The Conn_Latency parameter defines the maximum allowed connection latency.
The Supervision_Timeout parameter defines the link supervision timeout for the connection. The Supervision_Timeout in milliseconds shall be larger than (1 + Conn_Latency) * Conn_Interval_Max * 2, where Conn_Interval_Max is given in milliseconds.
The Minimum_CE_Length and Maximum_CE_Length parameters are informative parameters providing the Controller with the expected minimum and maximum length of the connection events. The Minimum_CE_Length parameter shall be less than or equal to the Maximum_CE_Length parameter.
The Host shall not issue this command when another LE_Create_Connection is pending in the Controller; if this does occur the Controller shall return the Command Disallowed error code shall be used.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.12].
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Initiator_Filter_Policy | 1 | Initiator filter policy. | |
Peer_Address_Type | 1 | Address type 0x00 Public Device Address 0x01 Random Device Address 0x02 Public Identity Address (Corresponds to Resolved Private Address) 0x03 Random (Static) Identity Address (Corresponds to Resolved Private Address) | |
Peer_Address | 6 | Public Device Address or Random Device Address of the device to be connected. | |
Own_Address_Type | 1 | Own address type. | |
Conn_Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Minimum_CE_Length | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Maximum_CE_Length | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Create_Connection_Cancel command is used to cancel the LE_Create_Connection command. This command shall only be issued after the LE_Create_Connection command has been issued, a Command Status event has been received for the LE Create Connection command and before the LE Connection Complete event.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.13].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to read the total number of Filter Accept List entries that can be stored in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.14].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Filter_Accept_List_Size | 1 | Total number of Filter Accept List entries that can be stored in the Controller. |
This command is used to clear the Filter Accept List stored in the Controller.
This command can be used at any time except when:
- the advertising filter policy uses the Filter Accept List and advertising is enabled.
- the scanning filter policy uses the Filter Accept List and scanning is enabled.
- the initiator filter policy uses the Filter Accept List and an HCI_LE_Create_Connection or HCI_LE_Extended_Create_Connection command is pending.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.15].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to add a single device to the Filter Accept List stored in the Controller.
This command can be used at any time except when:
- the advertising filter policy uses the Filter Accept List and advertising is enabled.
- the scanning filter policy uses the Filter Accept List and scanning is enabled.
- the initiator filter policy uses the Filter Accept List and an HCI_LE_Create_Connection or HCI_LE_Extended_Create_Connection command is pending.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.16].
Parameter | Size | Description | Possible values |
---|---|---|---|
Address_Type | 1 | Address type. | |
Address | 6 | Public Device Address or Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove a single device from the Filter Accept List stored in the Controller.
This command can be used at any time except when:
- the advertising filter policy uses the Filter Accept List and advertising is enabled.
- the scanning filter policy uses the Filter Accept List and scanning is enabled.
- the initiator filter policy uses the Filter Accept List and an HCI_LE_Create_Connection or HCI_LE_Extended_Create_Connection command is pending.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.17].
Parameter | Size | Description | Possible values |
---|---|---|---|
Address_Type | 1 | Address type. | |
Address | 6 | Public Device Address or Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Connection_Update command is used to change the Link Layer connection parameters of a connection. This command is supported only on Central side.
The Conn_Interval_Min and Conn_Interval_Max parameters are used to define the minimum and maximum allowed connection interval. The Conn_Interval_Min parameter shall not be greater than the Conn_Interval_Max parameter.
The Conn_Latency parameter shall define the maximum allowed connection latency.
The Supervision_Timeout parameter shall define the link supervision timeout for the LE link. The Supervision_Timeout in milliseconds shall be larger than (1 + Conn_Latency) * Conn_Interval_Max * 2, where Conn_Interval_Max is given in milliseconds.
The Minimum_CE_Length and Maximum_CE_Length are information parameters providing the Controller with a hint about the expected minimum and maximum length of the connection events. The Minimum_CE_Length shall be less than or equal to the Maximum_CE_Length.
The actual parameter values selected by the Link Layer may be different from the parameter values provided by the Host through this command.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.18].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Conn_Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Minimum_CE_Length | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Maximum_CE_Length | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Set_Host_Channel_Classification command allows the Host to specify a channel classification for data channels based on its "local information". This classification persists until overwritten with a subsequent LE_Set_Host_Channel_Classification command or until the Controller is reset using the Reset command (see [Vol 6] Part B, Section 4.5.8.1).
If this command is used, the Host should send it within 10 seconds of knowing that the channel classification has changed. The interval between two successive commands sent shall be at least one second.
This command shall only be used when the local device supports the Central role.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.19].
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Channel_Map | 5 | This parameter contains 37 1-bit fields. The nth such field (in the range 0 to 36) contains the value for the link layer channel index n. Channel n is bad = 0. Channel n is unknown = 1. The most significant bits are reserved and shall be set to 0. At least one channel shall be marked as unknown. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Read_Channel_Map command returns the current Channel_Map for the specified Connection_Handle. The returned value indicates the state of the Channel_Map specified by the last transmitted or received Channel_Map (in a CONNECT_REQ or LL_CHANNEL_MAP_REQ message) for the specified Connection_Handle, regardless of whether the Central has received an acknowledgment.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.20].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
LE_Channel_Map | 5 | This parameter contains 37 1-bit fields. The nth such field (in the range 0 to 36) contains the value for the link layer channel index n. Channel n is unused = 0. Channel n is used = 1. The most significant bits are reserved and shall be set to 0. |
This command requests a list of the used LE features from the remote device.
This command shall return a list of the used LE features. For details see [Vol 6] Part B, Section 4.6.
This command may be issued on both the Central and Peripheral.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.21].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Encrypt command is used to request the Controller to encrypt the Plaintext_Data in the command using the Key given in the command and returns the Encrypted_Data to the Host. The AES-128 bit block cypher is defined in NIST Publication FIPS-197 (http://csrc.nist.gov/publications/fips/fips197/fips-197.pdf).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.22].
Parameter | Size | Description | Possible values |
---|---|---|---|
Key | 16 | 128 bit key for the encryption of the data given in the command. | |
Plaintext_Data | 16 | 128 bit data block that is requested to be encrypted. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Encrypted_Data | 16 | 128 bit encrypted data block. |
The LE_Rand command is used to request the Controller to generate 8 octets of random data to be sent to the Host. The Random_Number shall be generated according to [Vol 2] Part H, Section 2 if the LE Feature (LL Encryption) is supported.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.23].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Random_Number | 8 | Random Number |
The LE_Enable_Encryption command is used to authenticate the given encryption key associated with the remote device specified by the connection handle, and once authenticated will encrypt the connection. The parameters are as defined in [Vol 3] Part H, Section 2.4.4.
If the connection is already encrypted then the Controller shall pause connection encryption before attempting to authenticate the given encryption key, and then re-encrypt the connection. While encryption is paused no user data shall be transmitted.
On an authentication failure, the connection shall be automatically disconnected by the Link Layer. If this command succeeds, then the connection shall be encrypted.
This command shall only be used when the local device's role is Central.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.24].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Random_Number | 8 | 64 bit random number. | |
Encrypted_Diversifier | 2 | 16 bit encrypted diversifier. | |
Long_Term_Key | 16 | 128 bit long term key. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
The LE_Long_Term_Key_Request_Reply command is used to reply to an LE Long Term Key Request event from the Controller, and specifies the Long_Term_Key parameter that shall be used for this Connection_Handle. The Long_Term_Key is used as defined in [Vol 6] Part B, Section 5.1.3.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.25].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Long_Term_Key | 16 | 128 bit long term key. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
The LE_Long_Term_Key_Request_Negative_Reply command is used to reply to an LE Long Term Key Request event from the Controller if the Host cannot provide a Long Term Key for this Connection_Handle.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.26].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
The LE_Read_Supported_States command reads the states and state combinations that the link layer supports. See [Vol 6] Part B, Section 1.1.1.
LE_States is an 8-octet bit field. If a bit is set to 1 then this state or state combination is supported by the Controller. Multiple bits in LE_States may be set to 1 to indicate support for multiple state and state combinations.
All the Advertising type with the Initiate State combinations shall be set only if the corresponding Advertising types and Central role combination are set.
All the Scanning types and the Initiate State combinations shall be set only if the corresponding Scanning types and Central role combination are set.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.27].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
LE_States | 8 | State or state combination is supported by the Controller. |
This command is used to reply to the HCI_LE_Remote_Connection_Parameter_Request event. This indicates that the Host has accepted the remote device's request to change connection parameters.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.31].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Max_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Min_CE_Length | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Max_CE_Length | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to reply to the HCI_LE_Remote_Connection_Parameter_Request event. This indicates that the Host has rejected the remote device's request to change connection parameters.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.32].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Reason | 1 | Reason that the connection parameter request was rejected (see "Status error codes" section) |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
The LE_Set_Data_Length command allows the Host to suggest maximum transmission packet size and maximum packet transmission time (connMaxTxOctets and connMaxTxTime - see Bluetooth spec. Vol 6 [Part B] 4.5.10) to be used for a given connection. The Controller may use smaller or larger values based on local information.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.33].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
TxOctets | 2 | Preferred maximum number of payload octets that the local Controller should include in a single Link Layer packet on this connection. | |
TxTime | 2 | Preferred maximum number of microseconds that the local Controller should use to transmit a single Link Layer packet on this connection. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command allows the Host to read the Host's suggested values (SuggestedMaxTxOctets and SuggestedMaxTxTime) for the Controller's maximum transmitted number of payload octets and maximum packet transmission time to be used for new connections.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.34].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
SuggestedMaxTxOctets | 2 | The Host's suggested value for the Controller's maximum transmitted number of payload octets to be used for new connections. | |
SuggestedMaxTxTime | 2 | The Host's suggested value for the Controller's maximum packet transmission time to be used for new connections. |
This command allows the Host to specify its suggested values for the Controller's maximum transmission number of payload octets and maximum packet transmission time to be used for new connections. The Controller may use smaller or larger values for connInitialMaxTxOctets and connInitialMaxTxTime based on local information.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.35].
Parameter | Size | Description | Possible values |
---|---|---|---|
SuggestedMaxTxOctets | 2 | The Host's suggested value for the Controller's maximum transmitted number of payload octets to be used for new connections. | |
SuggestedMaxTxTime | 2 | The Host's suggested value for the Controller's maximum packet transmission time to be used for new connections. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to return the local P-256 public key from the Controller. The Controller shall generate a new P-256 public/private key pair upon receipt of this command.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.36].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to initiate generation of a Diffie-Hellman key in the Controller for use over the LE transport. This command takes the remote P-256 public key as input. The Diffie-Hellman key generation uses the private key generated by LE_Read_Local_P256_Public_Key command.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.37].
Parameter | Size | Description | Possible values |
---|---|---|---|
Remote_P256_Public_Key | 64 | The remote P-256 public key in X, Y format: Octets 31-0: X coordinate Octets 63-32: Y coordinate Little Endian Format |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to add one device to the list of address translations used to resolve Resolvable Private Addresses in the Controller.
This command cannot be used when address translation is enabled in the Controller and:
- Advertising is enabled
- Scanning is enabled
- Create connection command is outstanding
This command can be used at any time when address translation is disabled in the Controller.
When a Controller cannot add a device to the resolving list because the list is full, it shall respond with error code 0x07 (Memory Capacity Exceeded).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.38].
Parameter | Size | Description | Possible values |
---|---|---|---|
Peer_Identity_Address_Type | 1 | Identity address type | |
Peer_Identity_Address | 6 | Public or Random (static) Identity Address of the peer device | |
Peer_IRK | 16 | IRK of the peer device | |
Local_IRK | 16 | IRK of the local device |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove one device from the list of address translations used to resolve Resolvable Private Addresses in the controller.
This command cannot be used when address translation is enabled in the Controller and:
- Advertising is enabled
- Scanning is enabled
- Create connection command is outstanding
This command can be used at any time when address translation is disabled in the Controller.
When a Controller cannot remove a device from the resolving list because it is not found, it shall respond with error code 0x02 (Unknown Connection Identifier).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.39].
Parameter | Size | Description | Possible values |
---|---|---|---|
Peer_Identity_Address_Type | 1 | Identity address type | |
Peer_Identity_Address | 6 | Public or Random (static) Identity Address of the peer device |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove all devices from the list of address translations used to resolve Resolvable Private Addresses in the Controller.
This command cannot be used when address translation is enabled in the Controller and:
- Advertising is enabled
- Scanning is enabled
- Create connection command is outstanding
This command can be used at any time when address translation is disabled in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.40].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to read the total number of address translation entries in the resolving list that can be stored in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.41].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Resolving_List_Size | 1 | Number of address translation entries in the resolving list |
This command is used to get the current peer Resolvable Private Address being used for the corresponding peer Public and Random (static) Identity Address. The peer's resolvable address being used may change after the command is called.
This command can be used at any time.
When a Controller cannot find a Resolvable Private Address associated with the Peer Identity Address, it shall respond with error code 0x02 (Unknown Connection Identifier).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.42].
Parameter | Size | Description | Possible values |
---|---|---|---|
Peer_Identity_Address_Type | 1 | Identity address type | |
Peer_Identity_Address | 6 | Public or Random (static) Identity Address of the peer device |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Peer_Resolvable_Address | 6 | Resolvable Private Address being used by the peer device |
This command is used to get the current local Resolvable Private Address being used for the corresponding peer Identity Address. The local's resolvable address being used may change after the command is called.
This command can be used at any time.
When a Controller cannot find a Resolvable Private Address associated with the Peer Identity Address, it shall respond with error code 0x02 (Unknown Connection Identifier).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.43].
Parameter | Size | Description | Possible values |
---|---|---|---|
Peer_Identity_Address_Type | 1 | Identity address type | |
Peer_Identity_Address | 6 | Public or Random (static) Identity Address of the peer device |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Local_Resolvable_Address | 6 | Resolvable Private Address being used by the local device |
This command is used to enable resolution of Resolvable Private Addresses in the Controller. This causes the Controller to use the resolving list whenever the Controller receives a local or peer Resolvable Private Address.
This command can be used at any time except when:
- Advertising is enabled
- Scanning is enabled
- Create connection command is outstanding
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.44].
Parameter | Size | Description | Possible values |
---|---|---|---|
Address_Resolution_Enable | 1 | Enable/disable address resolution in the controller. 0x00: Address Resolution in controller disabled (default), 0x01: Address Resolution in controller enabled |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the length of time the controller uses a Resolvable Private Address before a new resolvable private address is generated and starts being used. This timeout applies to all addresses generated by the controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.45].
Parameter | Size | Description | Possible values |
---|---|---|---|
RPA_Timeout | 2 | RPA_Timeout measured in seconds. Range for N: 0x0001 - 0xA1B8 (1 sec - approximately 11.5 hours) Default: N= 0x0384 (900 secs or 15 minutes) |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command allows the Host to read the Controller's maximum supported payload octets and packet duration times for transmission and reception (supportedMaxTxOctets and supportedMaxTxTime, supportedMaxRxOctets, and supportedMaxRxTime.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.46].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
supportedMaxTxOctets | 2 | Maximum number of payload octets that the local Controller supports for transmission of a single Link Layer packet on a data connection. | |
supportedMaxTxTime | 2 | Maximum time, in microseconds, that the local Controller supports for transmission of a single Link Layer packet on a data connection. | |
supportedMaxRxOctets | 2 | Maximum number of payload octets that the local Controller supports for reception of a single Link Layer packet on a data connection. | |
supportedMaxRxTime | 2 | Maximum time, in microseconds, that the local Controller supports for reception of a single Link Layer packet on a data connection. |
This command is used to read the current transmitter PHY and receiver PHY on the connection identified by the Connection_Handle.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.47].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
TX_PHY | 1 | Transmitter PHY in use. | |
RX_PHY | 1 | Receiver PHY in use. |
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 is 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 is ignored; otherwise at least one bit shall be set to 1.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.48].
Parameter | Size | Description | Possible values |
---|---|---|---|
ALL_PHYS | 1 | Host preferences for TX PHY and RX PHY | |
TX_PHYS | 1 | Host preferences for TX PHY (no LE coded support on STM32WB) | |
RX_PHYS | 1 | Host preferences for RX PHY (no LE coded support on STM32WB) |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the PHY preferences for the connection identified by the Connection_Handle. The Controller might not be able to make the change (e.g. because the peer does not support the requested PHY) or may decide that the current PHY is preferable.
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 is 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 is ignored; otherwise at least one bit shall be set to 1.
If, for at least one direction, the Host has specified a preference and the current PHY is not one of those preferred, the Controller shall request a change. Otherwise the Controller may, but need not, request a change.
The PHY preferences provided by the LE Set PHY command override those provided via the LE Set Default PHY command (Section 7.8.48) or any preferences previously set using the LE Set PHY command on the same connection.
The PHY_options parameter is a bit field that allows the Host to specify options for PHYs. The default value for a new connection shall be all zero bits. The Controller may override any preferred coding for transmitting on the LE Coded PHY.
The Host may specify a preferred coding even if it prefers not to use the LE Coded transmitter PHY since the Controller may override the PHY preference.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.49].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
ALL_PHYS | 1 | Host preferences for TX PHY and RX PHY | |
TX_PHYS | 1 | Host preferences for TX PHY (no LE coded support on STM32WB) | |
RX_PHYS | 1 | Host preferences for RX PHY (no LE coded support on STM32WB) | |
PHY_options | 2 | Not supported |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used by the Host to set the random device address specified by the Random_Address parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.52].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Random_Address | 6 | Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used by the Host to set the extended advertising parameters.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.53].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Adv_Event_Properties | 2 | Type of advertising event. | Bitmask of: |
Primary_Adv_Interval_Min | 3 | Minimum advertising interval. Time = N * 0.625 ms. | |
Primary_Adv_Interval_Max | 3 | Maximum advertising interval. Time = N * 0.625 ms. | |
Primary_Adv_Channel_Map | 1 | Advertising channel map. | Bitmask of: |
Own_Address_Type | 1 | Own address type. | |
Peer_Address_Type | 1 | Address type of the peer device. | |
Peer_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the device to be connected. | |
Adv_Filter_Policy | 1 | Advertising filter policy | |
Adv_TX_Power | 1 | Advertising TX power. Units: dBm. | |
Primary_Adv_PHY | 1 | Primary advertising PHY. | |
Secondary_Adv_Max_Skip | 1 | Secondary advertising maximum skip. | |
Secondary_Adv_PHY | 1 | Secondary advertising PHY. | |
Adv_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU. | |
Scan_Req_Notification_Enable | 1 | Scan request notifications. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Selected_TX_Power | 1 | Power level selected by the Controller. Units: dBm. |
This command is used to set the data used in extended advertising PDUs that have a data field.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.54].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Operation | 1 | Advertising operation. | |
Fragment_Preference | 1 | Fragment preference. | |
Advertising_Data_Length | 1 | Length of Advertising_Data in octets | |
Advertising_Data | Advertising_Data_Length | Data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to provide scan response data used in scanning response PDUs during extended advertising.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.55].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Operation | 1 | Scan response operation. | |
Fragment_Preference | 1 | Fragment preference. | |
Scan_Response_Data_Length | 1 | Length of Scan_Response_Data in octets | |
Scan_Response_Data | Scan_Response_Data_Length | Data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to request the Controller to enable or disable one or more advertising sets using the advertising sets identified by the Advertising_Handle[i] parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.56].
Parameter | Size | Description | Possible values |
---|---|---|---|
Enable | 1 | Enable/disable advertising. | |
Num_Sets | 1 | Number of advertising sets. | |
Advertising_Handle[i] | 1 | Used to identify an advertising set. | |
Duration[i] | 2 | Duration of advertising set. Time = N * 10 ms. | |
Max_Extended_Advertising_Events[i] | 1 | Maximum number of advertising events. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to read the maximum length of data supported by the Controller for use as advertisement data or scan response data in an extended advertising event.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.57].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Max_Advertising_Data_Length | 2 | Maximum supported advertising data length. |
This command is used to read the maximum number of advertising sets supported by the Controller at the same time during extended advertising.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.58].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Num_Supported_Advertising_Sets | 1 | Number of advertising sets supported at the same time. |
This command is used to remove an advertising set from the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.59].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove all existing advertising sets from the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.60].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used by the Host to set the parameters for periodic advertising.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.61].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Periodic_Adv_Interval_Min | 2 | Minimum advertising interval. Time = N * 1.25 ms. | |
Periodic_Adv_Interval_Max | 2 | Maximum advertising interval. Time = N * 1.25 ms. | |
Periodic_Adv_Properties | 2 | Specifies the fields included in the advertising packet. | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the data used in periodic advertising PDUs.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.62].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Operation | 1 | Advertising operation. | |
Advertising_Data_Length | 1 | Length of Advertising_Data in octets | |
Advertising_Data | Advertising_Data_Length | Data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to request the Controller to enable or disable the periodic advertising for the advertising set specified by the Advertising_Handle parameter (ordinary advertising is not affected).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.63].
Parameter | Size | Description | Possible values |
---|---|---|---|
Enable | 1 | Enable/disable advertising. | |
Advertising_Handle | 1 | Used to identify an advertising set. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the extended scan parameters to be used on the advertising physical channels.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.64].
Parameter | Size | Description | Possible values |
---|---|---|---|
Own_Address_Type | 1 | Own address type. | |
Scanning_Filter_Policy | 1 | The scanning filter policy determines how the scanner's Link Layer processes advertising and scan response PDUs. There is a choice of two primary filter policies: unfiltered and filtered. Unfiltered: the Link Layer processes all advertising and scan response PDUs (i.e., the Filter Accept List is not used). Filtered: the Link Layer processes advertising and scan response PDUs only from devices in the Filter Accept List. With extended scanning filter policies, a directed advertising PDU accepted by the primary filter policy shall nevertheless be ignored unless either the TargetA field is identical to the scanner's device address, or TargetA field is a resolvable private address. | |
Scanning_PHYs | 1 | Scan PHYs. | Bitmask of: |
Scan_Type[i] | 1 | Passive or active scanning. With passive scanning, no scan request PDUs are sent. | |
Scan_Interval[i] | 2 | Time interval from when the Controller started its last scan until it begins the subsequent scan on the primary advertising physical channel. Time = N * 0.625 ms. | |
Scan_Window[i] | 2 | Duration of the scan on the primary advertising physical channel. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to enable or disable extended scanning.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.65].
Parameter | Size | Description | Possible values |
---|---|---|---|
Enable | 1 | Enable/disable scan. | |
Filter_Duplicates | 1 | Duplicate filtering. | |
Duration | 2 | Scan duration. Time = N * 10 ms. | |
Period | 2 | Scan period. Time = N * 1.28 s. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to create an ACL connection to a connectable advertiser by means of extended scanning.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.66].
Parameter | Size | Description | Possible values |
---|---|---|---|
Initiator_Filter_Policy | 1 | Initiator filter policy. | |
Own_Address_Type | 1 | Own address type. | |
Peer_Address_Type | 1 | Address type of the peer device. | |
Peer_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the device to be connected. | |
Initiating_PHYs | 1 | Initiating PHYs. | Bitmask of: |
Scan_Interval[i] | 2 | Time interval from when the Controller started its last scan until it begins the subsequent scan on the primary advertising physical channel. Time = N * 0.625 ms. | |
Scan_Window[i] | 2 | Duration of the scan on the primary advertising physical channel. Time = N * 0.625 ms. | |
Conn_Interval_Min[i] | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max[i] | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Latency[i] | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout[i] | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Min_CE_Length[i] | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Max_CE_Length[i] | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.67].
Parameter | Size | Description | Possible values |
---|---|---|---|
Options | 1 | Bitmask of: | |
Advertising_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU. | |
Advertiser_Address_Type | 1 | The address type of the advertiser. | |
Advertiser_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the advertiser. | |
Skip | 2 | Maximum number of periodic advertising events that can be skipped after a successful receive. | |
Sync_Timeout | 2 | Synchronization timeout for the periodic advertising train. Time = N * 10 ms. | |
Sync_CTE_Type | 1 | Specifies whether to only synchronize to periodic advertising with certain types of CTE. | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to cancel the HCI_LE_Periodic_Advertising_Create_Sync command while it is pending.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.68].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to stop reception of the periodic advertising train identified by the Sync_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.69].
Parameter | Size | Description | Possible values |
---|---|---|---|
Sync_Handle | 2 | Handle identifying the periodic advertising train. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to add an entry, consisting of a single device address and SID, to the Periodic Advertiser list stored in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.70].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertiser_Address_Type | 1 | The address type of the advertiser. | |
Advertiser_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the advertiser. | |
Advertising_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove one entry from the list of Periodic Advertisers stored in the Controller. Removals from the Periodic Advertisers List take effect immediately.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.71].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertiser_Address_Type | 1 | The address type of the advertiser. | |
Advertiser_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the advertiser. | |
Advertising_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove all entries from the list of Periodic Advertisers in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.72].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to read the total number of Periodic Advertiser list entries that can be stored in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.73].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Periodic_Advertiser_List_Size | 1 |
This command is used to read the minimum and maximum transmit powers supported by the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.74].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Min_TX_Power | 1 | Signed integer. Units: dBm. | |
Max_TX_Power | 1 | Signed integer. Units: dBm. |
This command is used to read the RF path compensation value parameters used in the Tx power level and RSSI calculation.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.75].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
RF_TX_Path_Compensation | 2 | RF TX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. | |
RF_RX_Path_Compensation | 2 | RF RX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. |
This command is used to indicate the RF path gain or loss between the RF transceiver and the antenna contributed by intermediate components. A positive value means a net RF path gain and a negative value means a net RF path loss.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.76].
Parameter | Size | Description | Possible values |
---|---|---|---|
RF_TX_Path_Compensation | 2 | RF TX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. | |
RF_RX_Path_Compensation | 2 | RF RX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to allow the Host to specify the privacy mode to be used for a given entry on the resolving list.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.77].
Parameter | Size | Description | Possible values |
---|---|---|---|
Peer_Identity_Address_Type | 1 | Identity address type | |
Peer_Identity_Address | 6 | Public or Random (static) Identity Address of the peer device | |
Privacy_Mode | 1 | Privacy Mode. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
CTE_Length | 1 | Constant Tone Extension length in 8 us units. | |
CTE_Type | 1 | Constant Tone Extension type. | |
CTE_Count | 1 | Number of Constant Tone Extensions to transmit in each periodic advertising interval. | |
Switching_Pattern_Length | 1 | Number of Antenna IDs in the pattern. | |
Antenna_IDs | Switching_Pattern_Length | Antenna ID in the pattern. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
CTE_Enable | 1 | Used to enable or disable Constant Tone Extension. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
Sampling_Enable | 1 | Used to enable or disable IQ sampling. | |
Slot_Durations | 1 | Slot Durations. | |
Max_Sampled_CTEs | 1 | Number of Constant Tone Extensions to sample and report. | |
Switching_Pattern_Length | 1 | Number of Antenna IDs in the pattern. | |
Antenna_IDs | Switching_Pattern_Length | Antenna ID in the pattern. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Sync_Handle | 2 | Handle identifying the periodic advertising train. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Sampling_Enable | 1 | Used to enable or disable IQ sampling. | |
Slot_Durations | 1 | Slot Durations. | |
Switching_Pattern_Length | 1 | Number of Antenna IDs in the pattern. | |
Antenna_IDs | Switching_Pattern_Length | Antenna ID in the pattern. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
CTE_Types | 1 | Allowed Constant Tone Extension response type. | |
Switching_Pattern_Length | 1 | Number of Antenna IDs in the pattern. | |
Antenna_IDs | Switching_Pattern_Length | Antenna ID in the pattern. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Enable | 1 | Used to enable or disable Constant Tone Extension Request for the connection. | |
CTE_Request_Interval | 2 | Constant Tone Extension Request interval. | |
Requested_CTE_Length | 1 | Minimum length of the Constant Tone Extension being requested in 8 us units. | |
Requested_CTE_Type | 1 | Constant Tone Extension type. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Enable | 1 | Used to enable or disable Constant Tone Extension Response for the connection. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Supported_Switching_Sampling_Rates | 1 | Supported switching and sampling rates. | Bitmask of: |
Num_Antennae | 1 | Number of antennae supported by the Controller. | |
Max_Switching_Pattern_Length | 1 | Maximum length of antenna switching pattern supported by the Controller. | |
Max_CTE_Length | 1 | Maximum length of a transmitted Constant Tone Extension supported in 8 us units. |
This command is used to enable or disable reports for the periodic advertising train identified by the Sync_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.88].
Parameter | Size | Description | Possible values |
---|---|---|---|
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
Enable | 1 | Used to determine whether reporting and duplicate filtering are enabled or disabled. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to instruct the Controller to send synchronization information about the periodic advertising train identified by the Sync_Handle parameter to a connected device..
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.89].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Service_Data | 2 | A value provided by the Host. | |
Sync_Handle | 2 | Handle identifying the periodic advertising train. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to instruct the Controller to send synchronization information about the periodic advertising in an advertising set to a connected device.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.90].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Service_Data | 2 | A value provided by the Host. | |
Advertising_Handle | 1 | Used to identify an advertising set. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to specify how the Controller will process periodic advertising synchronization information received from the device identified by the Connection_Handle parameter (the "transfer mode").
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.91].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Mode | 1 | Action to be taken when periodic advertising synchronization information is received. | |
Skip | 2 | Maximum number of periodic advertising events that can be skipped after a successful receive. | |
Sync_Timeout | 2 | Synchronization timeout for the periodic advertising train. Time = N * 10 ms. | |
CTE_Type | 1 | Specifies whether to only synchronize to periodic advertising with certain types of CTE. | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to specify the initial value for the mode, skip, timeout, and Constant Tone Extension type (set by the HCI_LE_Set_Periodic_Advertising_Sync_Transfer_Parameters command) to be used for all subsequent connections over the LE transport.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.92].
Parameter | Size | Description | Possible values |
---|---|---|---|
Mode | 1 | Action to be taken when periodic advertising synchronization information is received. | |
Skip | 2 | Maximum number of periodic advertising events that can be skipped after a successful receive. | |
Sync_Timeout | 2 | Synchronization timeout for the periodic advertising train. Time = N * 10 ms. | |
CTE_Type | 1 | Specifies whether to only synchronize to periodic advertising with certain types of CTE. | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to initiate generation of a Diffie-Hellman key in the Controller for use over the LE transport. This command takes the remote P-256 public key as input. The Diffie-Hellman key generation uses the private key generated by the HCI_LE_Read_Local_P-256_Public_Key command or the private debug key.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.37].
Parameter | Size | Description | Possible values |
---|---|---|---|
Remote_P256_Public_Key | 64 | The remote P-256 public key in X, Y format: Octets 31-0: X coordinate Octets 63-32: Y coordinate Little Endian Format | |
Key_Type | 1 | Type of private key used for the Diffie-Hellman key generation. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to read the maximum size of the data portion of ACL data packets and isochronous data packets sent from the Host to the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.2].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
LE_ACL_Data_Packet_Length | 2 | Used to determine the maximum size of the L2CAP PDU segments that are contained in ACL data packets, and which are transferred from the Host to the Controller to be broken up into packets by the Link Layer. | |
Total_Num_LE_ACL_Data_Packets | 1 | Contains the total number of HCI ACL Data packets that can be stored in the data buffers of the Controller. | |
ISO_Data_Packet_Length | 2 | Used to determine the maximum size of the SDU segments that are contained in isochronous data packets, and which are transferred from the Host to the Controller. | |
Total_Num_ISO_Data_Packets | 1 | Contains the total number of isochronous data packets that can be stored in the data buffers of the Controller. |
This command is used to read the TX_Time_Stamp and Time_Offset of a transmitted SDU identified by the Packet_Sequence_Number on a CIS or BIS identified by the Connection_Handle parameter on the Central or Peripheral.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.96].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Packet_Sequence_Number | 2 | ||
TX_Time_Stamp | 4 | ||
Time_Offset | 3 |
This command is used by a Central's Host to create a CIG and to set the parameters of one or more CISes that are associated with a CIG in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.97].
Parameter | Size | Description | Possible values |
---|---|---|---|
CIG_ID | 1 | CIG identifier. | |
SDU_Interval_C_To_P | 3 | Interval, in microseconds, of periodic SDUs. | |
SDU_Interval_P_To_C | 3 | Interval, in microseconds, of periodic SDUs. | |
Worst_Case_SCA | 1 | Worst-case sleep clock accuracy. | |
Packing | 1 | Preferred method of arranging subevents of multiple CISes. | |
Framing | 1 | Format of the CIS Data PDUs. | |
Max_Transport_Latency_C_To_P | 2 | Maximum transport latency, in milliseconds. | |
Max_Transport_Latency_P_To_C | 2 | Maximum transport latency, in milliseconds. | |
CIS_Count | 1 | Total number of CIS configurations in the CIG. | |
CIS_ID[i] | 1 | CIS identifier. | |
Max_SDU_C_To_P[i] | 2 | Maximum size, in octets, of the payload from the Central's Host. | |
Max_SDU_P_To_C[i] | 2 | Maximum size, in octets, of the payload from the Peripheral's Host. | |
PHY_C_To_P[i] | 1 | PHY used for transmission from the Central to the Peripheral. | Bitmask of: |
PHY_P_To_C[i] | 1 | PHY used for transmission from the Peripheral to the Central. | Bitmask of: |
RTN_C_To_P[i] | 1 | Number of times every CIS Data PDU should be retransmitted from the Central to the Peripheral. | |
RTN_P_To_C[i] | 1 | Number of times every CIS Data PDU should be retransmitted from the Peripheral to the Central. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
CIG_ID | 1 | CIG identifier. | |
CIS_Count_Ret | 1 | Total number of CIS configurations added or modified by this command. | |
Connection_Handle | CIS_Count_Ret |
This command is used for testing purposes by a Central's Host to create a CIG and to set the parameters of one or more CISes that are associated with a CIG in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.98].
Parameter | Size | Description | Possible values |
---|---|---|---|
CIG_ID | 1 | CIG identifier. | |
SDU_Interval_C_To_P | 3 | Interval, in microseconds, of periodic SDUs. | |
SDU_Interval_P_To_C | 3 | Interval, in microseconds, of periodic SDUs. | |
FT_C_To_P | 1 | Flush timeout in multiples of ISO_Interval for each payload sent from the Central to Peripheral. | |
FT_P_To_C | 1 | Flush timeout in multiples of ISO_Interval for each payload sent from the Peripheral to Central. | |
ISO_Interval | 2 | Time between consecutive BIG anchor points. Time = N * 1.25 ms. | |
Worst_Case_SCA | 1 | Worst-case sleep clock accuracy. | |
Packing | 1 | Preferred method of arranging subevents of multiple CISes. | |
Framing | 1 | Format of the CIS Data PDUs. | |
CIS_Count | 1 | Total number of CIS configurations in the CIG. | |
CIS_ID[i] | 1 | CIS identifier. | |
NSE[i] | 1 | Number of subevents in each interval of each BIS in the BIG. | |
Max_SDU_C_To_P[i] | 2 | Maximum size, in octets, of the payload from the Central's Host. | |
Max_SDU_P_To_C[i] | 2 | Maximum size, in octets, of the payload from the Peripheral's Host. | |
Max_PDU_C_To_P[i] | 2 | Maximum size, in octets, of the payload from the Central to the Peripheral. | |
Max_PDU_P_To_C[i] | 2 | Maximum size, in octets, of the payload from the Peripheral to the Central. | |
PHY_C_To_P[i] | 1 | PHY used for transmission from the Central to the Peripheral. | Bitmask of: |
PHY_P_To_C[i] | 1 | PHY used for transmission from the Peripheral to the Central. | Bitmask of: |
BN_C_To_P[i] | 1 | Burst number for Central to Peripheral. | |
BN_P_To_C[i] | 1 | Burst number for Peripheral to Central. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
CIG_ID | 1 | CIG identifier. | |
CIS_Count_Ret | 1 | Total number of CIS configurations added or modified by this command. | |
Connection_Handle | CIS_Count_Ret |
This command is used by the Central's Host to create one or more CISes using the connections identified by the ACL_Connection_Handle arrayed parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.99].
Parameter | Size | Description | Possible values |
---|---|---|---|
CIS_Count | 1 | Total number of CIS configurations in the CIG. | |
CIS_Connection_Handle[i] | 2 | Connection handle of a CIS. | |
ACL_Connection_Handle[i] | 2 | Connection handle of an ACL connection. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used by the Central's Host to remove the CIG identified by CIG_ID.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.100].
Parameter | Size | Description | Possible values |
---|---|---|---|
CIG_ID | 1 | CIG identifier. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
CIG_ID | 1 | CIG identifier. |
This command is used by the Peripheral's Host to inform the Controller to accept the request for the CIS that is identified by the Connection_Handle.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.101].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used by the Peripheral's Host to inform the Controller to reject the request for the CIS that is identified by the Connection_Handle.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.102].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Reason | 1 | Reason the CIS request was rejected (see "Status error codes" section). |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to create a BIG with one or more BISes. All BISes in a BIG have the same value for all parameters.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.103].
Parameter | Size | Description | Possible values |
---|---|---|---|
BIG_Handle | 1 | BIG identifier. | |
Advertising_Handle | 1 | Used to identify an advertising set. | |
Num_BIS | 1 | Total number of BISes in the BIG. | |
SDU_Interval | 3 | Interval, in microseconds, of periodic SDUs. | |
Max_SDU | 2 | Maximum size of an SDU in octets. | |
Max_Transport_Latency | 2 | Maximum transport latency, in milliseconds. | |
RTN | 1 | Number of times that every BIS Data PDU should be retransmitted. | |
PHY | 1 | PHY used for transmission of PDUs of BISes in the BIG. | Bitmask of: |
Packing | 1 | Preferred method of arranging subevents of multiple CISes. | |
Framing | 1 | Format of the CIS Data PDUs. | |
Encryption | 1 | Encryption mode of the BISes. | |
Broadcast_Code | 16 | Code used to encrypt and decrypt BIS payloads. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used for testing purposes to create one or more BISes of a BIG. All BISes in the BIG have the same values for all parameters.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.104].
Parameter | Size | Description | Possible values |
---|---|---|---|
BIG_Handle | 1 | BIG identifier. | |
Advertising_Handle | 1 | Used to identify an advertising set. | |
Num_BIS | 1 | Total number of BISes in the BIG. | |
SDU_Interval | 3 | Interval, in microseconds, of periodic SDUs. | |
ISO_Interval | 2 | Time between consecutive BIG anchor points. Time = N * 1.25 ms. | |
NSE | 1 | Number of subevents in each interval of each BIS in the BIG. | |
Max_SDU | 2 | Maximum size of an SDU in octets. | |
Max_PDU | 2 | Maximum size, in octets, of payload. | |
PHY | 1 | PHY used for transmission of PDUs of BISes in the BIG. | Bitmask of: |
Packing | 1 | Preferred method of arranging subevents of multiple CISes. | |
Framing | 1 | Format of the CIS Data PDUs. | |
BN | 1 | Number of new payloads in each interval for each BIS. | |
IRC | 1 | Number of times the scheduled payloads are transmitted in a given event. | |
PTO | 1 | Offset used for pre-transmissions. | |
Encryption | 1 | Encryption mode of the BISes. | |
Broadcast_Code | 16 | Code used to encrypt and decrypt BIS payloads. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to terminate a BIG identified by the BIG_Handle parameter. The command also terminates the transmission of all BISes of the BIG, destroys the associated connection handles of the BISes in the BIG and removes the data paths for all BISes in the BIG.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.105].
Parameter | Size | Description | Possible values |
---|---|---|---|
BIG_Handle | 1 | BIG identifier. | |
Reason | 1 | BIG termination reason (see "Status error codes" section). |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to synchronize to a BIG described in the periodic advertising train specified by the Sync_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.106].
Parameter | Size | Description | Possible values |
---|---|---|---|
BIG_Handle | 1 | BIG identifier. | |
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
Encryption | 1 | Encryption mode of the BISes. | |
Broadcast_Code | 16 | Code used to encrypt and decrypt BIS payloads. | |
MSE | 1 | Maximum number of subevents that should be used to receive data payloads in each BIS event. | |
BIG_Sync_Timeout | 2 | Synchronization timeout for the BIG. Time = N * 10 ms. | |
Num_BIS | 1 | Total number of BISes in the BIG. | |
BIS | Num_BIS |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to stop synchronizing or cancel the process of synchronizing to the BIG identified by the BIG_Handle parameter. The command also terminates the reception of BISes in the BIG specified in the HCI_LE_BIG_Create_Sync command, destroys the associated connection handles of the BISes in the BIG and removes the data paths for all BISes in the BIG.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.107].
Parameter | Size | Description | Possible values |
---|---|---|---|
BIG_Handle | 1 | BIG identifier. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
BIG_Handle | 1 | BIG identifier. |
This command is used to read the Sleep Clock Accuracy (SCA) of the peer device.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.108].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
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.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.109].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Data_Path_Direction | 1 | ISO data path direction. | |
Data_Path_ID | 1 | ISO data path identifier. | |
Codec_ID | 5 | Octet 0 See Assigned Numbers for Coding Format. Octets 1 to 2 Company ID, see Assigned Numbers for Company Identifier (Shall be ignored if octet 0 is not 0xFF). Octets 3 to 4 Vendor-defined codec ID (Shall be ignored if octet 0 is not 0xFF). | |
Controller_Delay | 3 | Controller delay in microseconds. | |
Codec_Configuration_Length | 1 | Length of Codec_Configuration in octets | |
Codec_Configuration | Codec_Configuration_Length |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to remove the input and/or output data path(s) associated with a CIS, CIS configuration, or BIS identified by the Connection_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.110].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Data_Path_Direction | 1 | ISO data path direction. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used by the Host to set or clear a bit controlled by the Host in the Link Layer FeatureSet stored in the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.115].
Parameter | Size | Description | Possible values |
---|---|---|---|
Bit_Number | 1 | Bit position in the FeatureSet. | |
Bit_Value | 1 | Bit in the FeatureSet set/reset. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command returns the values of various counters related to link quality that are associated with the isochronous stream specified by the Connection_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.116].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
TX_UnACKed_Packets | 4 | ||
TX_Flushed_Packets | 4 | ||
TX_Last_Subevent_Packets | 4 | ||
Retransmitted_Packets | 4 | ||
CRC_Error_Packets | 4 | ||
RX_Unreceived_Packets | 4 | ||
Duplicate_Packets | 4 |
This command is used to read the current and maximum transmit power levels of the local Controller on the ACL connection identified by the Connection_Handle parameter and the PHY indicated by the PHY parameter..
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.117].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
PHY | 1 | Applying PHY. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
PHY | 1 | Applying PHY. | |
Current_TX_Power_Level | 1 | Current transmit power level (signed integer). Units: dBm. | |
Max_TX_Power_Level | 1 | Signed integer. Units: dBm. |
This command is used to read the transmit power level used by the remote Controller on the ACL connection that is identified by the Connection_Handle parameter and the PHY indicated by the PHY parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.118].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
PHY | 1 | Applying PHY. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the path loss threshold reporting parameters for the ACL connection identified by the Connection_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.119].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
High_Threshold | 1 | High threshold for the path loss. Units: dB. | |
High_Hysteresis | 1 | Hysteresis value for the high threshold. Units: dB. | |
Low_Threshold | 1 | Low threshold for the path loss. Units: dB. | |
Low_Hysteresis | 1 | Hysteresis value for the low threshold. Units: dB. | |
Min_Time_Spent | 2 | Minimum time in number of connection events to be observed once the path loss crosses the threshold before an event is generated. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to enable or disable path loss reporting for the ACL connection identified by the Connection_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.120].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Enable | 1 | Reporting enable/disable. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used to enable or disable the reporting to the local Host of transmit power level changes in the local and remote Controllers for the ACL connection identified by the Connection_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.121].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Local_Enable | 1 | Local reporting enable/disable. | |
Remote_Enable | 1 | Remote reporting enable/disable. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
Command | Opcode | BF | LO | LB |
---|---|---|---|---|
HCI_LE_RECEIVER_TEST | 0x201D | Y | Y | Y |
HCI_LE_TRANSMITTER_TEST | 0x201E | Y | Y | Y |
HCI_LE_TEST_END | 0x201F | Y | Y | Y |
HCI_LE_RECEIVER_TEST_V2 | 0x2033 | Y | Y | Y |
HCI_LE_TRANSMITTER_TEST_V2 | 0x2034 | Y | Y | Y |
HCI_LE_RECEIVER_TEST_V3 | 0x204F | Y | ||
HCI_LE_TRANSMITTER_TEST_V3 | 0x2050 | Y | ||
HCI_LE_ISO_TRANSMIT_TEST | 0x2070 | Y | ||
HCI_LE_ISO_RECEIVE_TEST | 0x2071 | Y | ||
HCI_LE_ISO_READ_TEST_COUNTERS | 0x2072 | Y | ||
HCI_LE_ISO_TEST_END | 0x2073 | Y | ||
HCI_LE_TRANSMITTER_TEST_V4 | 0x207B | Y |
This command is used to start a test where the DUT receives test reference packets at a fixed interval. The tester generates the test reference packets.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.28].
Parameter | Size | Description | Possible values |
---|---|---|---|
RX_Frequency | 1 | N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to start a test where the DUT generates test reference packets at a fixed interval. The Controller shall transmit at maximum power.
An LE Controller supporting the LE_Transmitter_Test command shall support Packet_Payload values 0x00, 0x01 and 0x02. An LE Controller may support other values of Packet_Payload.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.29].
Parameter | Size | Description | Possible values |
---|---|---|---|
TX_Frequency | 1 | N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz | |
Length_Of_Test_Data | 1 | Length in bytes of payload data in each packet. | |
Packet_Payload | 1 | Type of packet payload. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to stop any test which is in progress. The Number_Of_Packets for a transmitter test shall be reported as 0x0000. The Number_Of_Packets is an unsigned number and contains the number of received packets.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.30].
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Number_Of_Packets | 2 | Number of packets received |
This command is used to start a test where the DUT receives test reference packets at a fixed interval. The tester generates the test reference packets.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.28].
Parameter | Size | Description | Possible values |
---|---|---|---|
RX_Frequency | 1 | N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz | |
PHY | 1 | PHY to use for test packet | |
Modulation_Index | 1 | Modulation index capability of the transmitter |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to start a test where the DUT generates test reference packets at a fixed interval. The Controller shall transmit at maximum power.
An LE Controller supporting this command shall support Packet_Payload values 0x00, 0x01 and 0x02. An LE Controller supporting the LE Coded PHY shall also support Packet_Payload value 0x04 (not supported by STM32WB). An LE Controller may support other values of Packet_Payload.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.29].
Parameter | Size | Description | Possible values |
---|---|---|---|
TX_Frequency | 1 | N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz | |
Length_Of_Test_Data | 1 | Length in bytes of payload data in each packet. | |
Packet_Payload | 1 | Type of packet payload. | |
PHY | 1 | PHY to use for test packet |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to start a test where the DUT receives test reference packets at a fixed interval. The tester generates the test reference packets.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.28].
Parameter | Size | Description | Possible values |
---|---|---|---|
RX_Frequency | 1 | N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz | |
PHY | 1 | PHY to use for test packet | |
Modulation_Index | 1 | Modulation index capability of the transmitter | |
Expected_CTE_Length | 1 | Expected length of the Constant Tone Extensions in received test reference packets. | |
Expected_CTE_Type | 1 | Expected type of the Constant Tone Extensions in received test reference packets. | |
Slot_Durations | 1 | Slot Durations. | |
Switching_Pattern_Length | 1 | Number of Antenna IDs in the pattern. | |
Antenna_IDs | Switching_Pattern_Length | Antenna ID in the pattern. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used for testing purpose.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.29].
Parameter | Size | Description | Possible values |
---|---|---|---|
TX_Frequency | 1 | N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz | |
Length_Of_Test_Data | 1 | Length in bytes of payload data in each packet. | |
Packet_Payload | 1 | Type of packet payload. | |
PHY | 1 | PHY to use for test packet | |
CTE_Length | 1 | Constant Tone Extension length in 8 us units. | |
CTE_Type | 1 | Constant Tone Extension type. | |
Switching_Pattern_Length | 1 | Number of Antenna IDs in the pattern. | |
Antenna_IDs | Switching_Pattern_Length | Antenna ID in the pattern. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used for testing purposes to configure an established CIS or BIS specified by the Connection_Handle parameter, and transmit test payloads which are generated by the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.111].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Payload_Type | 1 | SDU configtration. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used for testing purposes to configure an established CIS or a synchronized BIG specified by the Connection_Handle parameter to receive payloads.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.112].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Payload_Type | 1 | SDU configtration. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This command is used for testing purposes to read the test counters in the Controller which is configured in ISO Receive Test mode for a CIS or BIS specified by the Connection_Handle. Reading the test counters does not reset the test counters.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.113].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Received_SDU_Count | 4 | ||
Missed_SDU_Count | 4 | ||
Failed_SDU_Count | 4 |
This command is used for testing purposes to terminate the ISO Transmit and/or Receive Test mode for a CIS or BIS specified by the Connection_Handle parameter but does not terminate the CIS or BIS.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.114].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Received_SDU_Count | 4 | ||
Missed_SDU_Count | 4 | ||
Failed_SDU_Count | 4 |
This command is used for testing purpose.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.8.29].
Parameter | Size | Description | Possible values |
---|---|---|---|
TX_Frequency | 1 | N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz | |
Length_Of_Test_Data | 1 | Length in bytes of payload data in each packet. | |
Packet_Payload | 1 | Type of packet payload. | |
PHY | 1 | PHY to use for test packet | |
CTE_Length | 1 | Constant Tone Extension length in 8 us units. | |
CTE_Type | 1 | Constant Tone Extension type. | |
Switching_Pattern_Length | 1 | Number of Antenna IDs in the pattern. | |
Antenna_IDs | Switching_Pattern_Length | Antenna ID in the pattern. | |
TX_Power_Level | 1 | Transmit power level (signed integer). Units: dBm. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Command | Opcode | BF | LO | LB |
---|---|---|---|---|
ACI_HAL_GET_FW_BUILD_NUMBER | 0xFC00 | Y | Y | Y |
ACI_HAL_WRITE_CONFIG_DATA | 0xFC0C | Y | Y | Y |
ACI_HAL_READ_CONFIG_DATA | 0xFC0D | Y | Y | Y |
ACI_HAL_SET_TX_POWER_LEVEL | 0xFC0F | Y | Y | Y |
ACI_HAL_LE_TX_TEST_PACKET_NUMBER | 0xFC14 | Y | Y | Y |
ACI_HAL_TONE_START | 0xFC15 | Y | Y | Y |
ACI_HAL_TONE_STOP | 0xFC16 | Y | Y | Y |
ACI_HAL_SET_RADIO_ACTIVITY_MASK | 0xFC18 | Y | Y | Y |
ACI_HAL_GET_ANCHOR_PERIOD | 0xFC19 | Y | Y | Y |
ACI_HAL_SET_EVENT_MASK | 0xFC1A | |||
ACI_HAL_GET_LINK_STATUS_V2 | 0xFC1B | Y | Y | Y |
ACI_HAL_GET_PM_DEBUG_INFO_V2 | 0xFC1D | |||
ACI_HAL_SET_PERIPHERAL_LATENCY | 0xFC20 | Y | Y | Y |
ACI_HAL_SET_SYNC_EVENT_CONFIG | 0xFC21 | Y | ||
ACI_HAL_READ_RSSI | 0xFC22 | Y | Y | Y |
ACI_HAL_CONTINUOUS_TX_START | 0xFC2E |
This command returns the build number associated with the firmware version currently running
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Build_Number | 2 | Build number of the firmware. |
This command writes a value to a configure data structure. It is useful to setup directly some parameters for the BLE stack.
Note: the static random address set by this command is taken into account by the GAP only when it receives the ACI_GAP_INIT command.
Parameter | Size | Description | Possible values |
---|---|---|---|
Offset | 1 | Offset of the element in the configuration data structure which has to be written. | |
Length | 1 | Length of data to be written | |
Value | Length | Data to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command requests the value in the configure data structure. The number of read bytes changes for different Offset.
Parameter | Size | Description | Possible values |
---|---|---|---|
Offset | 1 | Offset of the element in the configuration data structure which has to be read. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Data_Length | 1 | Length of Data in octets | |
Data | Data_Length | Data field associated with Offset parameter |
This command sets the TX power level of the device. By controlling the PA level, that determines the output power level (dBm) at the IC pin.
When the system starts up or reboots, the default TX power level is used, which is the maximum value. Once this command is given, the output power changes instantly, regardless if there is Bluetooth communication going on or not. For example, for debugging purpose, the device can be set to advertise all the time. By using this command, one can then observe the evolution of the TX signal strength.
The system keeps the last received TX power level from the command, i.e. the 2nd command overwrites the previous TX power level. The new TX power level remains until another ACI_HAL_SET_TX_POWER_LEVEL command, or the system reboots. However, note that the advertising extensions commands allow, per advertising set, to override the value of TX power determined by ACI_HAL_SET_TX_POWER_LEVEL command (e.g. see ACI_GAP_ADV_SET_CONFIGURATION).
Refer to Annex for the dBm corresponding values of PA_Level parameter.
Parameter | Size | Description | Possible values |
---|---|---|---|
En_High_Power | 1 | Enable High Power mode - Deprecated and ignored | |
PA_Level | 1 | Power amplifier output level. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command returns the number of packets sent in Direct Test Mode.
When the Direct TX test is started, a 16-bit counter is used to count how many packets have been transmitted.
This command can be used to check how many packets have been sent during the Direct TX test.
The counter starts from 0 and counts upwards. The counter can wrap and start from 0 again. The counter is not cleared until the next Direct TX test starts.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Number_Of_Packets | 4 | Number of packets sent during the last Direct TX test. |
This command starts a carrier frequency, i.e. a tone, on a specific channel. The frequency sine wave at the specific channel may be used for debugging purpose only. The channel ID is a parameter from 0x00 to 0x27 for the 40 BLE channels, e.g. 0x00 for 2.402 GHz, 0x01 for 2.404 GHz etc.
This command should not be used when normal Bluetooth activities are ongoing.
The tone should be stopped by ACI_HAL_TONE_STOP command.
Parameter | Size | Description | Possible values |
---|---|---|---|
RF_Channel | 1 | BLE Channel ID, from 0x00 to 0x27 meaning (2.402 + 0.002*0xXX) GHz Device will continuously emit 0s, that means that the tone will be at the channel center frequency minus the maximum frequency deviation (250 kHz). | |
Freq_offset | 1 | Frequency Offset for tone channel |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to stop the previously started ACI_HAL_TONE_START command.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command set the bitmask associated to ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT.
Only the radio activities enabled in the mask will be reported to application by ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT
Parameter | Size | Description | Possible values |
---|---|---|---|
Radio_Activity_Mask | 2 | Bitmask of radio events | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command returns information about the Anchor Period to help application in selecting slot timings when operating in multi-link scenarios.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Anchor_Period | 4 | Current anchor period. T = N * 0.625 ms. | |
Max_Free_Slot | 4 | Maximum available time that can be allocated for a new slot. T = N * 0.625 ms. |
This command is used to enable/disable the generation of HAL events. If the bit in the Event_Mask is set to a one, then the event associated with that bit will be enabled.
Parameter | Size | Description | Possible values |
---|---|---|---|
Event_Mask | 4 | Mask to enable/disable generation of HAL events | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command returns the status of the 10 Bluetooth Low Energy links managed by the device
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Link_Status | 10 | Array of link status (8 links). Each link status is 1 byte. | |
Link_Connection_Handle | 20 | Array of connection handles (2 bytes). Valid only if the corresponding link status is "connected" |
This command is used to retrieve TX, RX and total buffer count allocated for ACL packets.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Allocated_For_TX | 2 | MBlocks allocated for TXing | |
Allocated_For_RX | 2 | MBlocks allocated for RXing | |
Allocated_MBlocks | 2 | Overall allocated MBlocks |
This command is used to disable/enable the Peripheral latency feature during a connection. Note that, by default, the Peripheral latency is enabled at connection time.
Parameter | Size | Description | Possible values |
---|---|---|---|
Enable | 1 | Enable/disable Peripheral latency. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to configure ACI_HAL_SYNC_EVENT.
Parameter | Size | Description | Possible values |
---|---|---|---|
Group_Id | 1 | Identifier of the CIG or BIG. | |
Enable_Sync | 1 | ||
Enable_Cb_Trigger | 1 | ||
Trigger_Source | 1 |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command returns the value of the RSSI.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
RSSI | 1 | RSSI (signed integer). Units: dBm. |
This command starts the continuous transmit test mode.
Parameter | Size | Description | Possible values |
---|---|---|---|
RF_Channel | 1 | Index of the BLE RF channel used for test mode. | |
PHY | 1 | PHY used for test mode. | |
Pattern | 1 | Data pattern used for test mode. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Puts the device in non-discoverable mode. This command disables the LL advertising.
Note: this command only supports legacy advertising.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Puts the device in limited discoverable mode (as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 9.2.3]). The device will be discoverable for maximum period of TGAP (lim_adv_timeout) = 180 seconds (from errata). The advertising can be disabled at any time by issuing ACI_GAP_SET_NON_DISCOVERABLE command.
The Adv_Interval_Min and Adv_Interval_Max parameters are optional. If both are set to 0, the GAP will use default values for adv intervals for limited discoverable mode (250 ms and 500 ms respectively).
To allow a fast connection, the host can set Local_Name, Service_Uuid_List, Conn_Interval_Min and Conn_Interval_Max. If provided, these data will be inserted into the advertising packet payload as AD data. These parameters are optional in this command. These values can be set in advertised data using ACI_GAP_UPDATE_ADV_DATA command separately.
The total size of data in advertising packet cannot exceed 31 bytes.
With this command, the BLE Stack will also add automatically the following standard AD types:
- AD Flags
- Power Level
When advertising timeout happens (i.e. limited discovery period has elapsed), controller generates ACI_GAP_LIMITED_DISCOVERABLE_EVENT event.
Note: this command only supports legacy advertising.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Type | 1 | Advertising type | |
Advertising_Interval_Min | 2 | Minimum advertising interval. Time = N * 0.625 ms. | |
Advertising_Interval_Max | 2 | Maximum advertising interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Advertising_Filter_Policy | 1 | Advertising filter policy: not applicable (the value of Advertising_Filter_Policy parameter is not used inside the Stack) | |
Local_Name_Length | 1 | Length of the local_name field in octets. If length is set to 0x00, Local_Name parameter is not used. | |
Local_Name | Local_Name_Length | Local name of the device. First byte must be 0x08 for Shortened Local Name or 0x09 for Complete Local Name. No NULL character at the end. | |
Service_Uuid_length | 1 | Length of the Service Uuid List in octets. If there is no service to be advertised, set this field to 0x00. | |
Service_Uuid_List | Service_Uuid_length | This is the list of the UUIDs as defined in Volume 3, Section 11 of GAP Specification. First byte is the AD Type. | |
Conn_Interval_Min | 2 | Connection interval minimum value suggested by Peripheral. If Conn_Interval_Min and Conn_Interval_Max are not 0x0000, Peripheral Connection Interval Range AD structure will be added in advertising data. Connection interval is defined in the following manner: connIntervalmin = Conn_Interval_Min x 1.25ms. | |
Conn_Interval_Max | 2 | Connection interval maximum value suggested by Peripheral. If Conn_Interval_Min and Conn_Interval_Max are not 0x0000, Peripheral Connection Interval Range AD structure will be added in advertising data. Connection interval is defined in the following manner: connIntervalmax = Conn_Interval_Max x 1.25ms |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Puts the device in general discoverable mode (as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 9.2.4]). The device will be discoverable until the host issues the ACI_GAP_SET_NON_DISCOVERABLE command. The Adv_Interval_Min and Adv_Interval_Max parameters are optional. If both are set to 0, the GAP uses the default values for adv intervals for general discoverable mode.
When using connectable undirected advertising events:
- Adv_Interval_Min = 30 ms
- Adv_Interval_Max = 60 ms
When using non-connectable advertising events or scannable undirected advertising events:
- Adv_Interval_Min = 100 ms
- Adv_Interval_Max = 150 ms
Host can set the Local Name, a Service UUID list and the Peripheral Connection Interval Range.
If provided, these data will be inserted into the advertising packet payload as AD data.
These parameters are optional in this command. These values can be also set using ACI_GAP_UPDATE_ADV_DATA command separately.
The total size of data in advertising packet cannot exceed 31 bytes.
With this command, the BLE Stack will also add automatically the following standard AD types:
- AD Flags
- TX Power Level
Note: this command only supports legacy advertising.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Type | 1 | Advertising type | |
Advertising_Interval_Min | 2 | Minimum advertising interval. Time = N * 0.625 ms. | |
Advertising_Interval_Max | 2 | Maximum advertising interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Advertising_Filter_Policy | 1 | Advertising filter policy: not applicable (the value of Advertising_Filter_Policy parameter is not used inside the Stack) | |
Local_Name_Length | 1 | Length of the local_name field in octets. If length is set to 0x00, Local_Name parameter is not used. | |
Local_Name | Local_Name_Length | Local name of the device. First byte must be 0x08 for Shortened Local Name or 0x09 for Complete Local Name. No NULL character at the end. | |
Service_Uuid_length | 1 | Length of the Service Uuid List in octets. If there is no service to be advertised, set this field to 0x00. | |
Service_Uuid_List | Service_Uuid_length | This is the list of the UUIDs as defined in Volume 3, Section 11 of GAP Specification. First byte is the AD Type. | |
Conn_Interval_Min | 2 | Connection interval minimum value suggested by Peripheral. If Conn_Interval_Min and Conn_Interval_Max are not 0x0000, Peripheral Connection Interval Range AD structure will be added in advertising data. Connection interval is defined in the following manner: connIntervalmin = Conn_Interval_Min x 1.25ms. | |
Conn_Interval_Max | 2 | Connection interval maximum value suggested by Peripheral. If Conn_Interval_Min and Conn_Interval_Max are not 0x0000, Peripheral Connection Interval Range AD structure will be added in advertising data. Connection interval is defined in the following manner: connIntervalmax = Conn_Interval_Max x 1.25ms |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sets the device in directed connectable mode (as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 9.3.3]). In this mode, the device advertises using high duty cycle connectable directed advertising events or low duty cycle connectable directed advertising events.
The device's own address used in advertising packets is defined by the Own_Address_Type parameter depending on whether privacy is enabled or not.
When using high duty cycle connectable directed advertising events, the device stays in directed connectable mode only for 1.28 seconds. If no connection is established within this duration, the device enters non discoverable mode and advertising has to be again enabled explicitly.
The controller generates a HCI_LE_CONNECTION_COMPLETE_EVENT event with the status set to HCI_ADVERTISING_TIMEOUT_ERR_CODE if the connection was not established and BLE_STATUS_SUCCESS (0x00) if the connection was successfully established.
Note: this command only supports legacy advertising.
Parameter | Size | Description | Possible values |
---|---|---|---|
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address. | |
Directed_Advertising_Type | 1 | Advertising type | |
Direct_Address_Type | 1 | The address type of the peer device. | |
Direct_Address | 6 | Initiator address | |
Advertising_Interval_Min | 2 | Minimum advertising interval. Time = N * 0.625 ms. | |
Advertising_Interval_Max | 2 | Maximum advertising interval. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sets the IO capabilities of the device. This command has to be given only when the device is not in a connected state.
Parameter | Size | Description | Possible values |
---|---|---|---|
IO_Capability | 1 | IO capability of the device. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sets the authentication requirements for the device. This command has to be given only when the device is not in a connected state.
Parameter | Size | Description | Possible values |
---|---|---|---|
Bonding_Mode | 1 | Bonding mode. Only if bonding is enabled (0x01), the bonding information is stored in flash | |
MITM_Mode | 1 | MITM mode. | |
SC_Support | 1 | LE Secure connections support | |
KeyPress_Notification_Support | 1 | Keypress notification support | |
Min_Encryption_Key_Size | 1 | Minimum encryption key size to be used during pairing | |
Max_Encryption_Key_Size | 1 | Maximum encryption key size to be used during pairing | |
Use_Fixed_Pin | 1 | Use or not fixed pin. If set to 0x00, then during the pairing process the application will not be requested for a pin (Fixed_Pin will be used). If set to 0x01, then during pairing process if a passkey is required the application will be notified | |
Fixed_Pin | 4 | Fixed pin to be used during pairing if MITM protection is enabled. Any random value between 0 to 999999 | |
Identity_Address_Type | 1 | Identity address type |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sets the authorization requirements of the device. This command has to be given when connected to a device if authorization is required to access services which require authorization.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Authorization_Enable | 1 | Enable the authorization in the device and when a remote device tries to read/write a characteristic with authorization requirements, the stack will send back an error response with "Insufficient authorization" error code. After pairing is complete an ACI_GAP_AUTHORIZATION_REQ_EVENT will be sent to the Host. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command should be sent by the host in response to ACI_GAP_PASS_KEY_REQ_EVENT event. The command parameter contains the pass key which will be used during the pairing process.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Pass_Key | 4 | Pass key that will be used during the pairing process. Must be a six-digit decimal number. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Authorizes a device to access attributes. This command should be sent by the host in response to ACI_GAP_AUTHORIZATION_REQ_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Authorize | 1 | Authorization response. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Initializes the GAP layer. Register the GAP service with the GATT.
All the standard GAP characteristics will also be added:
- Device Name
- Appearance
- Peripheral Preferred Connection Parameters (peripheral role only).
Note that if the Peripheral Preferred Connection Parameters characteristic is added, its handle is equal to the Appearance characteristic handle plus 2.
Note also that if privacy is enabled, this command automatically unmasks the HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Role | 1 | Bitmap of allowed roles. | Bitmask of: |
privacy_enabled | 1 | This parameter specifies if Privacy is enabled or not. N.B.: only Controller Privacy is supported. | |
device_name_char_len | 1 | Length of the device name characteristic |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Service_Handle | 2 | Handle of the GAP service | |
Dev_Name_Char_Handle | 2 | Device Name Characteristic handle | |
Appearance_Char_Handle | 2 | Appearance Characteristic handle |
Puts the device into non connectable mode. This mode does not support connection. The privacy setting done in the ACI_GAP_INIT command plays a role in deciding the valid parameters for this command.
Advertiser filter policy is internally set to 0.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Event_Type | 1 | Advertising type | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Puts the device into undirected connectable mode.
If privacy is enabled in the device, a resolvable private address is generated and used as the advertiser's address. If not, the address of the type specified in Own_Address_Type is used for advertising.
Note: this command only supports legacy advertising.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Interval_Min | 2 | Minimum advertising interval. Time = N * 0.625 ms. | |
Advertising_Interval_Max | 2 | Maximum advertising interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address. | |
Adv_Filter_Policy | 1 | Advertising filter policy. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends a Peripheral Security Request to the Central.
This command has to be issued to notify the Central of the security requirements of the Peripheral. The Central may encrypt the link, initiate the pairing procedure, or reject the request.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command can be used to update the advertising data for a particular AD type. If the AD type specified does not exist, then it is added to the advertising data. If the overall advertising data length is more than 31 octets after the update, then the command is rejected and the old data is retained.
Parameter | Size | Description | Possible values |
---|---|---|---|
AdvDataLen | 1 | Length of AdvData in octets | |
AdvData | AdvDataLen | Advertising data used by the device while advertising. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command can be used to delete the specified AD type from the advertisement data if present.
Parameter | Size | Description | Possible values |
---|---|---|---|
ADType | 1 | One of the AD types as in Bluetooth spec. [Vol 3, Part C, 11]. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command can be used to get the current security settings of the device.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Security_Mode | 1 | Security mode. | |
Security_Level | 1 | Security Level. |
It allows masking events from the GAP. If the bit in the GAP_Evt_Mask is set to a one, then the event associated with that bit will be enabled.
The default configuration is all the events masked.
Parameter | Size | Description | Possible values |
---|---|---|---|
GAP_Evt_Mask | 2 | GAP event mask. Default: 0xFFFF. | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command adds addresses of bonded devices into the controller's Filter Accept List, which is cleared first. It returns an error if it was unable to add all bonded devices into the Filter Accept List.
This command shall not be used when the device is advertising, scanning or initiating with a filter policy using the Filter Accept List.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Commands the controller to terminate the connection. A HCI_DISCONNECTION_COMPLETE_EVENT event is generated when the link is disconnected.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Reason | 1 | The reason for ending the connection. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Clears the security database. All the devices in the security database are removed.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Allows the security manager to complete the pairing procedure and re-bond with the Central. This command should be given by the application when it receives the ACI_GAP_BOND_LOST_EVENT if it wants the re-bonding to happen successfully. If this command is not given on receiving the event, the bonding procedure will timeout.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the limited discovery procedure. The controller is commanded to start active scanning.
When this procedure is started, only the devices in limited discoverable mode are returned to the upper layers.
The procedure is terminated when either the upper layers issue a command to terminate the procedure by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the procedure code set to 0x01 or a timeout happens (the timeout value is fixed at 10.24 s.). When the procedure is terminated due to any of the above reasons, ACI_GAP_PROC_COMPLETE_EVENT event is returned with the procedure code set to 0x01.
The device found when the procedure is ongoing is returned to the upper layers through the event HCI_LE_ADVERTISING_REPORT_EVENT.
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Filter_Duplicates | 1 | Enable/disable duplicate filtering. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the general discovery procedure. The controller is commanded to start active scanning. The procedure is terminated when either the upper layers issue a command to terminate the procedure by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the procedure code set to 0x02 or a timeout happens (the timeout value is fixed at 10.24 s.). When the procedure is terminated due to any of the above reasons, ACI_GAP_PROC_COMPLETE_EVENT event is returned with the procedure code set to 0x02.
The devices found when the procedure is ongoing are returned via HCI_LE_ADVERTISING_REPORT_EVENT (or via HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT when the extended advertising feature is supported).
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Filter_Duplicates | 1 | Enable/disable duplicate filtering. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the auto connection establishment procedure. The devices specified are added to the Filter Accept List of the controller and a LE_Create_Connection call will be made to the controller by GAP with the initiator filter policy set to "Filter Accept List is used to determine which advertiser to connect to". When a command is issued to terminate the procedure by upper layer, a LE_Create_Connection_Cancel call will be made to the controller by GAP.
The procedure is terminated when either a connection is successfully established with one of the specified devices in the Filter Accept List or the procedure is explicitly terminated by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the procedure code set to 0x08. A ACI_GAP_PROC_COMPLETE_EVENT event is returned with the procedure code set to 0x08.
If privacy is enabled and the peer device (advertiser) is in the resolving list then the link layer generates a RPA, if it is not then the RPA generated by the Host is used.
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address. | |
Conn_Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Minimum_CE_Length | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Maximum_CE_Length | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Num_of_Peer_Entries | 1 | Number of devices that have to be added to the Filter Accept List. Each device is defined by Peer_Address_Type and Peer_Address. | |
Peer_Address_Type[i] | 1 | Address type. | |
Peer_Address[i] | 6 | Public Device Address or Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts a general connection establishment procedure. The host enables scanning in the controller with the scanner filter policy set to "accept all advertising packets" and from the scanning results, all the devices are sent to the upper layer using the event LE_Advertising_Report. The upper layer then has to select one of the devices to which it wants to connect by issuing the command ACI_GAP_CREATE_CONNECTION. If privacy is enabled, then either a private resolvable address or a non-resolvable address, based on the address type specified in the command is set as the scanner address but the gap create connection always uses a private resolvable address if the general connection establishment procedure is active.
The procedure is terminated when a connection is established or the upper layer terminates the procedure by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the procedure code set to 0x10. On completion of the procedure a ACI_GAP_PROC_COMPLETE_EVENT event is generated with the procedure code set to 0x10.
If privacy is enabled and the peer device (advertiser) is in the resolving list then the link layer will generate a RPA, if it is not then the RPA/NRPA generated by the Host will be used.
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Type | 1 | Passive or active scanning. With passive scanning, no scan request PDUs are sent. | |
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Scanning_Filter_Policy | 1 | The scanning filter policy determines how the scanner's Link Layer processes advertising and scan response PDUs. There is a choice of two primary filter policies: unfiltered and filtered. Unfiltered: the Link Layer processes all advertising and scan response PDUs (i.e., the Filter Accept List is not used). Filtered: the Link Layer processes advertising and scan response PDUs only from devices in the Filter Accept List. With extended scanning filter policies, a directed advertising PDU accepted by the primary filter policy shall nevertheless be ignored unless either the TargetA field is identical to the scanner's device address, or TargetA field is a resolvable private address. | |
Filter_Duplicates | 1 | Enable/disable duplicate filtering. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts a selective connection establishment procedure. The GAP adds the specified device addresses into Filter Accept List and enables scanning in the controller with a scanning filter policy that should be set to "filtered". All the devices found are sent to the upper layer by the event HCI_LE_ADVERTISING_REPORT_EVENT (or by the event HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT when the extended advertising feature is supported). The upper layer then has to select one of the devices to which it wants to connect by issuing the command ACI_GAP_CREATE_CONNECTION.
On completion of the procedure a ACI_GAP_PROC_COMPLETE_EVENT event is generated with the procedure code set to 0x20. The procedure is terminated when a connection is established or the upper layer terminates the procedure by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the procedure code set to 0x20.
If privacy is enabled and the peer device (advertiser) is in the resolving list then the link layer will generate a RPA, if it is not then the RPA/NRPA generated by the Host will be used.
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Type | 1 | Passive or active scanning. With passive scanning, no scan request PDUs are sent. | |
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Scanning_Filter_Policy | 1 | The scanning filter policy determines how the scanner's Link Layer processes advertising and scan response PDUs. There is a choice of two primary filter policies: unfiltered and filtered. Unfiltered: the Link Layer processes all advertising and scan response PDUs (i.e., the Filter Accept List is not used). Filtered: the Link Layer processes advertising and scan response PDUs only from devices in the Filter Accept List. With extended scanning filter policies, a directed advertising PDU accepted by the primary filter policy shall nevertheless be ignored unless either the TargetA field is identical to the scanner's device address, or TargetA field is a resolvable private address. | |
Filter_Duplicates | 1 | Enable/disable duplicate filtering. | |
Num_of_Peer_Entries | 1 | Number of devices that have to be added to the Filter Accept List. Each device is defined by Peer_Address_Type and Peer_Address. | |
Peer_Address_Type[i] | 1 | Address type. | |
Peer_Address[i] | 6 | Public Device Address or Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the direct connection establishment procedure. A LE_Create_Connection call will be made to the controller by GAP with the initiator filter policy set to "Filter Accept List is not used to determine which advertiser to connect to". The procedure can be terminated explicitly by the upper layer by issuing the command ACI_GAP_TERMINATE_GAP_PROC. When a command is issued to terminate the procedure by upper layer, a HCI_LE_CREATE_CONNECTION_CANCEL call will be made to the controller by GAP.
On termination of the procedure, a HCI_LE_CONNECTION_COMPLETE_EVENT event is returned. The procedure can be explicitly terminated by the upper layer by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the Procedure_Code set to 0x40.
If privacy is enabled and the peer device (advertiser) is in the resolving list then the link layer will generate a RPA, if it is not then the RPA generated by the Host will be used.
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
Peer_Address_Type | 1 | The address type of the peer device. | |
Peer_Address | 6 | Public Device Address or Random Device Address of the device to be connected. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address. | |
Conn_Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Minimum_CE_Length | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Maximum_CE_Length | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Terminates the specified GAP procedure. An ACI_GAP_PROC_COMPLETE_EVENT event is returned with the procedure code set to the corresponding procedure.
Parameter | Size | Description | Possible values |
---|---|---|---|
Procedure_Code | 1 | GAP procedure bitmap. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the connection update procedure (only when role is Central). A HCI_LE_CONNECTION_UPDATE is called.
On completion of the procedure, an HCI_LE_CONNECTION_UPDATE_COMPLETE_EVENT event is returned to the upper layer.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Conn_Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Minimum_CE_Length | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Maximum_CE_Length | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends the SM pairing request to start a pairing process. The authentication requirements and IO capabilities should be set before issuing this command using the ACI_GAP_SET_IO_CAPABILITY and ACI_GAP_SET_AUTHENTICATION_REQUIREMENT commands.
A ACI_GAP_PAIRING_COMPLETE_EVENT event is returned after the pairing process is completed.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Force_Rebond | 1 |
|
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command tries to resolve the address provided with the IRKs present in its database. If the address is resolved successfully with any one of the IRKs present in the database, it returns success and also the corresponding public/static random address stored with the IRK in the database.
Parameter | Size | Description | Possible values |
---|---|---|---|
Address | 6 | Address to be resolved |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Actual_Address | 6 | The public or static random address of the peer device, distributed during pairing phase. |
This command puts the device into broadcast mode. A privacy enabled device uses either a resolvable private address or a non-resolvable private address as specified in the Own_Address_Type parameter of the command.
Note: this command only supports legacy advertising.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Interval_Min | 2 | Minimum advertising interval. Time = N * 0.625 ms. | |
Advertising_Interval_Max | 2 | Maximum advertising interval. Time = N * 0.625 ms. | |
Advertising_Type | 1 | Advertising type | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Adv_Data_Length | 1 | Length of the advertising data in the advertising packet. | |
Adv_Data | Adv_Data_Length | Advertising data used by the device while advertising. | |
Num_of_Peer_Entries | 1 | Number of devices that have to be added to the Filter Accept List. Each device is defined by Peer_Address_Type and Peer_Address. | |
Peer_Address_Type[i] | 1 | Address type. | |
Peer_Address[i] | 6 | Public Device Address or Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts an Observation procedure when the device is in Observer Role. The host enables scanning in the controller. The advertising reports are sent to the upper layer using standard LE Advertising Report Event.
If privacy is enabled and the peer device (advertiser) is in the resolving list then the link layer will generate a RPA, if it is not then the RPA/NRPA generated by the Host will be used.
Parameter | Size | Description | Possible values |
---|---|---|---|
LE_Scan_Interval | 2 | This is defined as the time interval from when the Controller started its last LE scan until it begins the subsequent LE scan. Time = N * 0.625 ms. | |
LE_Scan_Window | 2 | Amount of time for the duration of the LE scan. LE_Scan_Window shall be less than or equal to LE_Scan_Interval. Time = N * 0.625 ms. | |
LE_Scan_Type | 1 | Passive or active scanning. With passive scanning, no scan request PDUs are sent. | |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Filter_Duplicates | 1 | Enable/disable duplicate filtering. | |
Scanning_Filter_Policy | 1 | The scanning filter policy determines how the scanner's Link Layer processes advertising and scan response PDUs. There is a choice of two primary filter policies: unfiltered and filtered. Unfiltered: the Link Layer processes all advertising and scan response PDUs (i.e., the Filter Accept List is not used). Filtered: the Link Layer processes advertising and scan response PDUs only from devices in the Filter Accept List. With extended scanning filter policies, a directed advertising PDU accepted by the primary filter policy shall nevertheless be ignored unless either the TargetA field is identical to the scanner's device address, or TargetA field is a resolvable private address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command gets the list of the devices which are bonded. It returns the number of addresses and the corresponding address types and values.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Num_of_Addresses | 1 | The number of bonded devices | |
Address_Type[i] | 1 | Address type. | |
Address[i] | 6 | Public Device Address or Random Device Address. |
The command finds whether the device, whose address is specified in the command, is bonded. If the device is using a resolvable private address and it has been bonded, then the command will return BLE_STATUS_SUCCESS.
Parameter | Size | Description | Possible values |
---|---|---|---|
Peer_Address_Type | 1 | Identity address type | |
Peer_Address | 6 | Public or Random (static) Identity Address of the peer device |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command allows the User to validate/confirm or not the Numeric Comparison value showed through the ACI_GAP_NUMERIC_COMPARISON_VALUE_EVENT.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Confirm_Yes_No | 1 | Indicates if the numeric values showed on both local and peer device are different or equal |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command permits to signal to the Stack the input type detected during Passkey input.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Input_Type | 1 | Passkey input type detected |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is sent by the User to get (i.e. to extract from the Stack) the OOB data generated by the Stack itself.
Parameter | Size | Description | Possible values |
---|---|---|---|
OOB_Data_Type | 1 | Type of OOB data |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Address_Type | 1 | Identity address type | |
Address | 6 | Public or Random (static) address of this device | |
OOB_Data_Type | 1 | Type of OOB data | |
OOB_Data_Len | 1 | Length of OOB data | |
OOB_Data | 16 | Local OOB data |
This command is sent (by the User) to input the OOB data arrived via OOB communication.
Parameter | Size | Description | Possible values |
---|---|---|---|
Device_Type | 1 | OOB Device type | |
Address_Type | 1 | Identity address type | |
Address | 6 | Public or Random (static) Identity Address of the peer device | |
OOB_Data_Type | 1 | Type of OOB data | |
OOB_Data_Len | 1 | Length of OOB data | |
OOB_Data | 16 | Either local OOB data or remote OOB data received through OOB from peer device (see Device_Type) |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to add devices to the list of address translations used to resolve Resolvable Private Addresses in the Controller.
Parameter | Size | Description | Possible values |
---|---|---|---|
Num_of_Resolving_list_Entries | 1 | Number of devices that have to be added to the list. | |
Peer_Identity_Address_Type[i] | 1 | Identity address type | |
Peer_Identity_Address[i] | 6 | Public or Random (static) Identity Address of the peer device | |
Clear_Resolving_List | 1 | Clear the resolving list |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove a specified device from bonding table
Parameter | Size | Description | Possible values |
---|---|---|---|
Peer_Identity_Address_Type | 1 | Identity address type | |
Peer_Identity_Address | 6 | Public or Random (static) Identity Address of the peer device |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to add specific device addresses to the Filter Accept List and/or resolving list.
Parameter | Size | Description | Possible values |
---|---|---|---|
Num_of_List_Entries | 1 | Number of devices that have to be added to the list. | |
Address_Type[i] | 1 | Address type. | |
Address[i] | 6 | Public Device Address or Random Device Address. | |
Mode | 1 | Mode used for adding devices in the lists. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the extended advertising configuration for one advertising set.
This command, in association with ACI_GAP_ADV_SET_SCAN_RESP_DATA, ACI_GAP_ADV_SET_ADV_DATA and ACI_GAP_ADV_SET_ENABLE, enables to start extended advertising. These commands must be used in replacement of ACI_GAP_SET_DISCOVERABLE, ACI_GAP_SET_LIMITED_DISCOVERABLE, ACI_GAP_SET_DIRECT_CONNECTABLE, ACI_GAP_SET_NON_CONNECTABLE, ACI_GAP_SET_UNDIRECTED_CONNECTABLE and ACI_GAP_SET_BROADCAST_MODE that only support legacy advertising.
If bit 0 of Adv_Mode is set, the Own_Address_Type parameter is ignored and the own address shall be set with the ACI_GAP_ADV_SET_RANDOM_ADDRESS command. This mode is only valid for non-connectable advertising.
Parameter | Size | Description | Possible values |
---|---|---|---|
Adv_Mode | 1 | Bitmap of extended advertising modes | Bitmask of: |
Advertising_Handle | 1 | Used to identify an advertising set. | |
Adv_Event_Properties | 2 | Type of advertising event. | Bitmask of: |
Primary_Adv_Interval_Min | 4 | Minimum advertising interval. Time = N * 0.625 ms. | |
Primary_Adv_Interval_Max | 4 | Maximum advertising interval. Time = N * 0.625 ms. | |
Primary_Adv_Channel_Map | 1 | Advertising channel map. | Bitmask of: |
Own_Address_Type | 1 | Own address type: if Privacy is disabled, the address can be public or static random; otherwise, it can be a resolvable private address or a non-resolvable private address. | |
Peer_Address_Type | 1 | Address type of the peer device. | |
Peer_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the device to be connected. | |
Adv_Filter_Policy | 1 | Advertising filter policy | |
Adv_TX_Power | 1 | Advertising TX power. Units: dBm. | |
Secondary_Adv_Max_Skip | 1 | Secondary advertising maximum skip. | |
Secondary_Adv_PHY | 1 | Secondary advertising PHY. | |
Adv_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU. | |
Scan_Req_Notification_Enable | 1 | Scan request notifications. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to request the Controller to enable or disable one or more extended advertising sets.
Parameter | Size | Description | Possible values |
---|---|---|---|
Enable | 1 | Enable/disable advertising. | |
Num_Sets | 1 | Number of advertising sets. | |
Advertising_Handle[i] | 1 | Used to identify an advertising set. | |
Duration[i] | 2 | Duration of advertising set. Time = N * 10 ms. | |
Max_Extended_Advertising_Events[i] | 1 | Maximum number of advertising events. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the data used in extended advertising PDUs that have a data field.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Operation | 1 | Advertising operation. | |
Fragment_Preference | 1 | Fragment preference. | |
Advertising_Data_Length | 1 | Length of Advertising_Data in octets | |
Advertising_Data | Advertising_Data_Length | Data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to provide scan response data used during extended advertising.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Operation | 1 | Scan response operation. | |
Fragment_Preference | 1 | Fragment preference. | |
Scan_Response_Data_Length | 1 | Length of Scan_Response_Data in octets | |
Scan_Response_Data | Scan_Response_Data_Length | Data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove an advertising set from the Controller.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to remove all existing advertising sets from the Controller.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to set the random device address of an advertising set configured to use specific random address.
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Random_Address | 6 | Random Device Address. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Initializes the GATT layer for server and client roles. It also adds the GATT service with Service Changed Characteristic.
Until this command is issued the GATT channel does not process any commands even if the connection is opened. This command has to be given before using any of the GAP features.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Add a service to GATT Server. When a service is created in the server, the host needs to reserve the handle ranges for this service using Max_Attribute_Records parameter. This parameter specifies the maximum number of attribute records that can be added to this service (including the service attribute, include attribute, characteristic attribute, characteristic value attribute and characteristic descriptor attribute). Handle of the created service is returned in command complete event. Service declaration is taken from the service pool.
The attributes for characteristics and descriptors are allocated from the attribute pool.
Parameter | Size | Description | Possible values |
---|---|---|---|
Service_UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
Service_UUID | 2 or 16 | 16-bit UUID or 128-bit UUID | |
Service_Type | 1 | Service type. | |
Max_Attribute_Records | 1 | Maximum number of attribute records that can be added to this service |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Service_Handle | 2 | Handle of the Service. When this service is added, a handle is allocated by the server for this service. Server also allocates a range of handles for this service from serviceHandle to <serviceHandle + max_attr_records - 1> |
Include a service given by Include_Start_Handle and Include_End_Handle to another service given by Service_Handle. Attribute server creates an INCLUDE definition attribute and return the handle of this attribute in Included_handle.
Parameter | Size | Description | Possible values |
---|---|---|---|
Service_Handle | 2 | Handle of the Service to which another service has to be included. | |
Include_Start_Handle | 2 | Start Handle of the Service which has to be included in service | |
Include_End_Handle | 2 | End Handle of the Service which has to be included in service | |
Include_UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
Include_UUID | 2 or 16 | 16-bit UUID or 128-bit UUID |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Include_Handle | 2 | Handle of the include declaration |
Adds a characteristic to a service.
The command returns the handle of the declaration attribute. The attribute that holds the Characteristic Value is always allocated at the next handle (Char_Handle + 1). The Characteristic Value is immediately followed, in order, by:
- the Server Characteristic Configuration descriptor if CHAR_PROP_BROADCAST is selected;
- the Client Characteristic Configuration descriptor if CHAR_PROP_NOTIFY or CHAR_PROP_INDICATE properties is selected;
- the Characteristic Extended Properties descriptor if CHAR_PROP_EXT is selected.
For instance, if CHAR_PROP_NOTIFY is selected but not CHAR_PROP_BROADCAST nor CHAR_PROP_EXT, then the Client Characteristic Configuration attribute handle is Char_Handle + 2.
Additional descriptors can be added to the characteristic by calling the ACI_GATT_ADD_CHAR_DESC command immediately after calling this command.
Parameter | Size | Description | Possible values |
---|---|---|---|
Service_Handle | 2 | Handle of the Service to which the characteristic will be added | |
Char_UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
Char_UUID | 2 or 16 | 16-bit UUID or 128-bit UUID | |
Char_Value_Length | 2 | Maximum length of the characteristic value. | |
Char_Properties | 1 | Characteristic Properties (Volume 3, Part G, section 3.3.1.1 of Bluetooth Core Specification) | Bitmask of: |
Security_Permissions | 1 | Security permission flags. | Bitmask of: |
GATT_Evt_Mask | 1 | GATT event mask. | Bitmask of: |
Enc_Key_Size | 1 | Minimum encryption key size required to read the characteristic. | |
Is_Variable | 1 | Specify if the characteristic value has a fixed length or a variable length. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Char_Handle | 2 | Handle of the characteristic that has been added (it is the handle of the characteristic declaration). |
Adds a characteristic descriptor to a service.
Note that this command allocates the new handle for the descriptor after the currently allocated handles. It is therefore advisable to call this command following the call of the command ACI_GATT_ADD_CHAR which created the characteristic containing this descriptor.
Parameter | Size | Description | Possible values |
---|---|---|---|
Service_Handle | 2 | Handle of service to which the characteristic belongs | |
Char_Handle | 2 | Handle of the characteristic to which description has to be added | |
Char_Desc_Uuid_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
Char_Desc_Uuid | 2 or 16 | 16-bit UUID or 128-bit UUID | |
Char_Desc_Value_Max_Len | 1 | The maximum length of the descriptor value | |
Char_Desc_Value_Length | 1 | Current Length of the characteristic descriptor value | |
Char_Desc_Value | Char_Desc_Value_Length | Value of the characteristic description | |
Security_Permissions | 1 | Security permission flags. | Bitmask of: |
Access_Permissions | 1 | Access permission | Bitmask of: |
GATT_Evt_Mask | 1 | GATT event mask. | Bitmask of: |
Enc_Key_Size | 1 | Minimum encryption key size required to read the characteristic. | |
Is_Variable | 1 | Specify if the characteristic value has a fixed length or a variable length. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Char_Desc_Handle | 2 | Handle of the characteristic descriptor |
Updates a characteristic value in a service. If notifications (or indications) are enabled on that characteristic, a notification (or indication) is sent to the client after sending this command. The command is queued into the STM32WB command queue.
If the buffer is full, because previous commands could not be still processed, the function will return BLE_STATUS_INSUFFICIENT_RESOURCES. This will happen if notifications (or indications) are enabled and the application calls ACI_GATT_UPDATE_CHAR_VALUE at an higher rate than what is allowed by the link.
Throughput on BLE link depends on connection interval and connection length parameters (decided by the Central, see ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_REQ for more information on how to suggest new connection parameters from a Peripheral). If the application does not want to lose notifications because STM32WB buffer becomes full, it must retry again till the function returns BLE_STATUS_SUCCESS or any other error code.
Note that the characteristic is updated only if the command returns BLE_STATUS_SUCCESS.
Parameter | Size | Description | Possible values |
---|---|---|---|
Service_Handle | 2 | Handle of service to which the characteristic belongs | |
Char_Handle | 2 | Handle of the characteristic declaration | |
Val_Offset | 1 | The offset from which the attribute value has to be updated. If this is set to 0 and the attribute value is of variable length, then the length of the attribute will be set to the Char_Value_Length. If the Val_Offset is set to a value greater than 0, then the length of the attribute will be set to the maximum length as specified for the attribute while adding the characteristic. | |
Char_Value_Length | 1 | Length of the characteristic value in octets | |
Char_Value | Char_Value_Length | Characteristic value |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Deletes the specified characteristic from the service.
Parameter | Size | Description | Possible values |
---|---|---|---|
Serv_Handle | 2 | Handle of service to which the characteristic belongs | |
Char_Handle | 2 | Handle of the characteristic which has to be deleted |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Deletes the specified service from the GATT server database.
Parameter | Size | Description | Possible values |
---|---|---|---|
Serv_Handle | 2 | Handle of the service to be deleted |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Deletes the Include definition from the service.
Parameter | Size | Description | Possible values |
---|---|---|---|
Serv_Handle | 2 | Handle of the service to which the include service belongs | |
Include_Handle | 2 | Handle of the included service which has to be deleted |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Masks events from the GATT. If the bit in the GATT_Evt_Mask is set to a one, then the event associated with that bit will be enabled.
The default configuration is all the events masked.
Parameter | Size | Description | Possible values |
---|---|---|---|
GATT_Evt_Mask | 4 | GATT/ATT event mask. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Performs an ATT MTU exchange procedure.
When the ATT MTU exchange procedure is completed, a ACI_ATT_EXCHANGE_MTU_RESP_EVENT event is generated. A ACI_GATT_PROC_COMPLETE_EVENT event is also generated to indicate the end of the procedure.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends a Find Information Request.
This command is used to obtain the mapping of attribute handles with their associated types. The responses of the procedure are given through the ACI_ATT_FIND_INFO_RESP_EVENT event. The end of the procedure is indicated by a ACI_GATT_PROC_COMPLETE_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Start_Handle | 2 | First requested handle number | |
End_Handle | 2 | Last requested handle number |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends a Find By Type Value Request
The Find By Type Value Request is used to obtain the handles of attributes that have a given 16-bit UUID attribute type and a given attribute value.
The responses of the procedure are given through the ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT event.
The end of the procedure is indicated by a ACI_GATT_PROC_COMPLETE_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Start_Handle | 2 | First requested handle number | |
End_Handle | 2 | Last requested handle number | |
UUID | 2 | 2 octet UUID to find (little-endian) | |
Attribute_Val_Length | 1 | Length of attribute value (maximum value is ATT_MTU - 7). | |
Attribute_Val | Attribute_Val_Length | Attribute value to find |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends a Read By Type Request.
The Read By Type Request is used to obtain the values of attributes where the attribute type is known but the handle is not known.
The responses are given through the ACI_ATT_READ_BY_TYPE_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Start_Handle | 2 | First requested handle number | |
End_Handle | 2 | Last requested handle number | |
UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
UUID | 2 or 16 | 16-bit UUID or 128-bit UUID |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends a Read By Group Type Request.
The Read By Group Type Request is used to obtain the values of grouping attributes where the attribute type is known but the handle is not known. Grouping attributes are defined at GATT layer. The grouping attribute types are: "Primary Service", "Secondary Service" and "Characteristic".
The responses of the procedure are given through the ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT event.
The end of the procedure is indicated by a ACI_GATT_PROC_COMPLETE_EVENT.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Start_Handle | 2 | First requested handle number | |
End_Handle | 2 | Last requested handle number | |
UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
UUID | 2 or 16 | 16-bit UUID or 128-bit UUID |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends a Prepare Write Request.
The Prepare Write Request is used to request the server to prepare to write the value of an attribute.
The responses of the procedure are given through the ACI_ATT_PREPARE_WRITE_RESP_EVENT event.
The end of the procedure is indicated by a ACI_GATT_PROC_COMPLETE_EVENT.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Attr_Handle | 2 | Handle of the attribute to be written | |
Val_Offset | 2 | The offset of the first octet to be written | |
Attribute_Val_Length | 1 | Length of attribute value (maximum value is ATT_MTU - 5). | |
Attribute_Val | Attribute_Val_Length | The value of the attribute to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Sends an Execute Write Request.
The Execute Write Request is used to request the server to write or cancel the write of all the prepared values currently held in the prepare queue from this client.
The result of the procedure is given through the ACI_ATT_EXEC_WRITE_RESP_EVENT event.
The end of the procedure is indicated by a ACI_GATT_PROC_COMPLETE_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Execute | 1 | Execute or cancel writes. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the GATT client procedure to discover all primary services on the server.
The responses of the procedure are given through the ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to discover the primary services of the specified UUID on the server.
The responses of the procedure are given through the ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT event.
The end of the procedure is indicated by a ACI_GATT_PROC_COMPLETE_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
UUID | 2 or 16 | 16-bit UUID or 128-bit UUID |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to find all included services.
The responses of the procedure are given through the ACI_ATT_READ_BY_TYPE_RESP_EVENT event.
The end of the procedure is indicated by a ACI_GATT_PROC_COMPLETE_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Start_Handle | 2 | Start attribute handle of the service | |
End_Handle | 2 | End attribute handle of the service |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to discover all the characteristics of a given service.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packets are given through ACI_ATT_READ_BY_TYPE_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Start_Handle | 2 | Start attribute handle of the service | |
End_Handle | 2 | End attribute handle of the service |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to discover all the characteristics specified by a UUID.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packets are given through ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Start_Handle | 2 | Start attribute handle of the service | |
End_Handle | 2 | End attribute handle of the service | |
UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
UUID | 2 or 16 | 16-bit UUID or 128-bit UUID |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to discover all characteristic descriptors on the server.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packets are given through ACI_ATT_FIND_INFO_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Char_Handle | 2 | Handle of the characteristic value | |
End_Handle | 2 | End handle of the characteristic |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to read the attribute value.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packet is given through ACI_ATT_READ_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the characteristic value to be read |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a Read By Type Request packet to the server in order to read the value attribute of the characteristics specified by the UUID.
When the procedure is completed, an ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion, the response packet is given through one ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT event per reported attribute.
Note: the number of bytes of a value reported by ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT event cannot exceed BLE_EVT_MAX_PARAM_LEN - 7 i.e. 248 bytes for default value of BLE_EVT_MAX_PARAM_LEN.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Start_Handle | 2 | Starting handle of the range to be searched | |
End_Handle | 2 | End handle of the range to be searched | |
UUID_Type | 1 | UUID type: 0x01 = 16 bits UUID while 0x02 = 128 bits UUID | |
UUID | 2 or 16 | 16-bit UUID or 128-bit UUID |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to read a long characteristic value.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packets are given through ACI_ATT_READ_BLOB_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the characteristic value to be read | |
Val_Offset | 2 | Offset from which the value needs to be read |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts a procedure to read multiple characteristic values from a server.
The command must specify the handles of the characteristic values to be read.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packets are given through ACI_ATT_READ_MULTIPLE_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Number_of_Handles | 1 | Number of handles in the following table | |
Handle[i] | 2 | Attribute handle |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to write a characteristic value.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the characteristic value to be written | |
Attribute_Val_Length | 1 | Length of the value to be written | |
Attribute_Val | Attribute_Val_Length | Value to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to write a long characteristic value.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. During the procedure, ACI_ATT_PREPARE_WRITE_RESP_EVENT and ACI_ATT_EXEC_WRITE_RESP_EVENT events are raised.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the characteristic value to be written | |
Val_Offset | 2 | Offset at which the attribute has to be written | |
Attribute_Val_Length | 1 | Length of the value to be written | |
Attribute_Val | Attribute_Val_Length | Value to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to write a characteristic reliably.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. During the procedure, ACI_ATT_PREPARE_WRITE_RESP_EVENT and ACI_ATT_EXEC_WRITE_RESP_EVENT events are raised.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the attribute to be written | |
Val_Offset | 2 | Offset at which the attribute has to be written | |
Attribute_Val_Length | 1 | Length of the value to be written | |
Attribute_Val | Attribute_Val_Length | Value to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to write a long characteristic descriptor.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. During the procedure, ACI_ATT_PREPARE_WRITE_RESP_EVENT and ACI_ATT_EXEC_WRITE_RESP_EVENT events are raised.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the attribute to be written | |
Val_Offset | 2 | Offset at which the attribute has to be written | |
Attribute_Val_Length | 1 | Length of the value to be written | |
Attribute_Val | Attribute_Val_Length | Value to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to read a long characteristic value.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packets are given through ACI_ATT_READ_BLOB_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the characteristic descriptor | |
Val_Offset | 2 | Offset from which the value needs to be read |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to write a characteristic descriptor.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the attribute to be written | |
Attribute_Val_Length | 1 | Length of the value to be written | |
Attribute_Val | Attribute_Val_Length | Value to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to read the descriptor specified.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated.
Before procedure completion the response packet is given through ACI_ATT_READ_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the descriptor to be read |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts the procedure to write a characteristic value without waiting for any response from the server. No events are generated after this command is executed. The length of the value to be written must not exceed (ATT_MTU - 3); it must also not exceed (BLE_EVT_MAX_PARAM_LEN - 5) i.e. 250 for BLE_EVT_MAX_PARAM_LEN default value.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the characteristic value to be written | |
Attribute_Val_Length | 1 | Length of the value to be written | |
Attribute_Val | Attribute_Val_Length | Value to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts a signed write without response from the server.
The procedure is used to write a characteristic value with an authentication signature without waiting for any response from the server. It cannot be used when the link is encrypted. The length of the value to be written must not exceed (ATT_MTU - 15); it must also not exceed (BLE_EVT_MAX_PARAM_LEN - 5) i.e. 250 for BLE_EVT_MAX_PARAM_LEN default value.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Attr_Handle | 2 | Handle of the characteristic value to be written | |
Attribute_Val_Length | 1 | Length of the value to be written | |
Attribute_Val | Attribute_Val_Length | Value to be written |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Allow application to confirm indication. This command has to be sent when the application receives the event ACI_GATT_INDICATION_EVENT.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Allow or reject a write request from a client.
This command has to be sent by the application when it receives the
ACI_GATT_WRITE_PERMIT_REQ_EVENT. If the write can be allowed, then the status and error code have to be set to 0. If the write cannot be allowed, then the status has to be set to 1 and the error code has to be set to the error code that has to be passed to the client.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Attr_Handle | 2 | Handle of the attribute that was passed in the event ACI_GATT_WRITE_PERMIT_REQ_EVENT | |
Write_status | 1 | If the value can be written or not. | |
Error_Code | 1 | The error code that has to be passed to the client in case the write has to be rejected | |
Attribute_Val_Length | 1 | Length of the value to be written as passed in the event ACI_GATT_WRITE_PERMIT_REQ_EVENT | |
Attribute_Val | Attribute_Val_Length | Value as passed in the event ACI_GATT_WRITE_PERMIT_REQ_EVENT |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Allow the GATT server to send a response to a read request from a client.
The application has to send this command when it receives the
ACI_GATT_READ_PERMIT_REQ_EVENT or ACI_GATT_READ_MULTI_PERMIT_REQ_EVENT. This command indicates to the stack that the response can be sent to the client. So if the application wishes to update any of the attributes before they are read by the client, it must update the characteristic values using the ACI_GATT_UPDATE_CHAR_VALUE and then give this command. The application should perform the required operations within 30 seconds. Otherwise the GATT procedure will be timeout.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sets the security permission for the attribute handle specified. Currently the setting of security permission is allowed only for client configuration descriptor.
Parameter | Size | Description | Possible values |
---|---|---|---|
Serv_Handle | 2 | Handle of the service which contains the attribute whose security permission has to be modified | |
Attr_Handle | 2 | Handle of the attribute whose security permission has to be modified | |
Security_Permissions | 1 | Security permission flags. | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sets the value of the descriptor specified by Char_Desc_Handle.
Parameter | Size | Description | Possible values |
---|---|---|---|
Serv_Handle | 2 | Handle of the service which contains the characteristic descriptor | |
Char_Handle | 2 | Handle of the characteristic which contains the descriptor | |
Char_Desc_Handle | 2 | Handle of the descriptor whose value has to be set | |
Val_Offset | 2 | Offset from which the descriptor value has to be updated | |
Char_Desc_Value_Length | 1 | Length of the descriptor value | |
Char_Desc_Value | Char_Desc_Value_Length | Descriptor value |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Reads the value of the attribute handle specified from the local GATT database.
Parameter | Size | Description | Possible values |
---|---|---|---|
Attr_Handle | 2 | Handle of the attribute to read | |
Offset | 2 | Offset from which the value needs to be read | |
Value_Length_Requested | 2 | Maximum number of octets to be returned as attribute value |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Length | 2 | Length of the attribute value | |
Value_Length | 2 | Length in octets of the Value parameter | |
Value | Value_Length | Attribute value |
This command is a more flexible version of ACI_GATT_UPDATE_CHAR_VALUE to support update of long attribute up to 512 bytes and indicate selectively the generation of Indication/Notification.
Parameter | Size | Description | Possible values |
---|---|---|---|
Conn_Handle_To_Notify | 2 | Specifies the client(s) to be notified. | |
Service_Handle | 2 | Handle of service to which the characteristic belongs | |
Char_Handle | 2 | Handle of the characteristic declaration | |
Update_Type | 1 |
| Bitmask of: |
Char_Length | 2 | Total length of the characteristic value. In case of a variable size characteristic, this field specifies the new length of the characteristic value after the update; in case of fixed length characteristic this field is ignored. | |
Value_Offset | 2 | The offset from which the attribute value has to be updated. | |
Value_Length | 1 | Length of the Value parameter in octets | |
Value | Value_Length | Updated characteristic value |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command is used to deny the GATT server to send a response to a read request from a client.
The application may send this command when it receives the ACI_GATT_READ_PERMIT_REQ_EVENT or ACI_GATT_READ_MULTI_PERMIT_REQ_EVENT.
This command indicates to the stack that the client is not allowed to read the requested characteristic due to e.g. application restrictions.
The Error code shall be either 0x08 (Insufficient Authorization) or a value in the range 0x80-0x9F (Application Error).
The application should issue the ACI_GATT_DENY_READ or ACI_GATT_ALLOW_READ command within 30 seconds from the reception of the ACI_GATT_READ_PERMIT_REQ_EVENT or ACI_GATT_READ_MULTI_PERMIT_REQ_EVENT events; otherwise the GATT procedure issues a timeout.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Error_Code | 1 | Error code for the command |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sets the access permission for the attribute handle specified.
Parameter | Size | Description | Possible values |
---|---|---|---|
Serv_Handle | 2 | Handle of the service which contains the attribute whose access permission has to be modified | |
Attr_Handle | 2 | Handle of the attribute whose security permission has to be modified | |
Access_Permissions | 1 | Access permission | Bitmask of: |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command forces the saving of the GATT database for all active connections. Note that, by default, the GATT database is saved per active connection at the time of disconnection.
None
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a Multiple Handle Value Notification over the ATT bearer specified in parameter. The handles provided as parameters must be the handles of the characteristic declarations.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Number_of_Handles | 1 | Number of handles in the following table | |
Handle[i] | 2 | Attribute handle |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Starts a procedure to read multiple variable length characteristic values from a server.
The command must specify the handles of the characteristic values to be read.
When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated. Before procedure completion the response packets are given through ACI_ATT_READ_MULTIPLE_RESP_EVENT event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the command applies. | |
Number_of_Handles | 1 | Number of handles in the following table | |
Handle[i] | 2 | Attribute handle |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Command | Opcode | BF | LO | LB |
---|---|---|---|---|
ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_REQ | 0xFD81 | Y | ||
ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_RESP | 0xFD82 | Y | ||
ACI_L2CAP_COC_CONNECT | 0xFD88 | |||
ACI_L2CAP_COC_CONNECT_CONFIRM | 0xFD89 | |||
ACI_L2CAP_COC_RECONF | 0xFD8A | |||
ACI_L2CAP_COC_RECONF_CONFIRM | 0xFD8B | |||
ACI_L2CAP_COC_DISCONNECT | 0xFD8C | |||
ACI_L2CAP_COC_FLOW_CONTROL | 0xFD8D | |||
ACI_L2CAP_COC_TX_DATA | 0xFD8E |
Sends an L2CAP connection parameter update request from the Peripheral to the Central.
An ACI_L2CAP_CONNECTION_UPDATE_RESP_EVENT event is raised when the Central responds to the request (accepts or rejects).
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Conn_Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Timeout_Multiplier | 2 | Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Accepts or rejects a connection update. This command should be sent in response to an ACI_L2CAP_CONNECTION_UPDATE_REQ_EVENT event from the controller. The accept parameter has to be set if the connection parameters given in the event are acceptable.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Conn_Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Conn_Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Timeout_Multiplier | 2 | Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms. | |
Minimum_CE_Length | 2 | Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Maximum_CE_Length | 2 | Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms. | |
Identifier | 1 | Identifier received in ACI_L2CAP_Connection_Update_Req event. | |
Accept | 1 | Specify if connection update parameters are acceptable or not. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a Credit Based Connection Request packet on the specified connection. See Bluetooth Core specification Vol.3 Part A.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
SPSM | 2 | Simplified Protocol/Service Multiplexer. | |
MTU | 2 | Maximum Transmission Unit. | |
MPS | 2 | Maximum payload size (in octets). | |
Initial_Credits | 2 | Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet. | |
Channel_Number | 1 | Number of channels to be created. If this parameter is set to 0, it requests the creation of one LE credit based connection-oriented channel. Otherwise, it requests the creation of one or more enhanced credit based connection-oriented channels. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a Credit Based Connection Response packet. It must be used upon receipt of a connection request through an ACI_L2CAP_COC_CONNECT_EVENT event. See Bluetooth Core specification Vol.3 Part A.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
MTU | 2 | Maximum Transmission Unit. | |
MPS | 2 | Maximum payload size (in octets). | |
Initial_Credits | 2 | Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet. | |
Result | 2 | This parameter indicates the outcome of the request. A value of 0x0000 indicates success while a non-zero value indicates the request is refused. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Channel_Number | 1 | Number of created channels. It is the length of Channel_Index_List. | |
Channel_Index_List | Channel_Number | List of channel indexes for which the primitive applies. |
This command sends a Credit Based Reconfigure Request packet on the specified connection. See Bluetooth Core specification Vol.3 Part A.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
MTU | 2 | Maximum Transmission Unit. | |
MPS | 2 | Maximum payload size (in octets). | |
Channel_Number | 1 | Number of created channels. It is the length of Channel_Index_List. | |
Channel_Index_List | Channel_Number | List of channel indexes for which the primitive applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a Credit Based Reconfigure Response packet. It must be used upon receipt of a Credit Based Reconfigure Request through an ACI_L2CAP_COC_RECONF_EVENT event. See Bluetooth Core specification Vol.3 Part A.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Result | 2 | This parameter indicates the outcome of the request. A value of 0x0000 indicates success while a non-zero value indicates the request is refused. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a Disconnection Request signaling packet on the specified connection-oriented channel. See Bluetooth Core specification Vol.3 Part A.
The ACI_L2CAP_COC_DISCONNECT_EVENT event is received when the disconnection of the channel is effective.
Parameter | Size | Description | Possible values |
---|---|---|---|
Channel_Index | 1 | Index of the connection-oriented channel for which the primitive applies. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a Flow Control Credit signaling packet on the specified connection-oriented channel. See Bluetooth Core specification Vol.3 Part A.
Parameter | Size | Description | Possible values |
---|---|---|---|
Channel_Index | 1 | Index of the connection-oriented channel for which the primitive applies. | |
Credits | 2 | Number of credits the receiving device can increment, corresponding to the number of K-frames that can be sent to the peer device sending the Flow Control Credit packet. |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
This command sends a K-frame packet on the specified connection-oriented channel. See Bluetooth Core specification Vol.3 Part A.
Note: for the first K-frame of the SDU, the Information data shall contain the L2CAP SDU Length coded on two octets followed by the K-frame information payload. For the next K-frames of the SDU, the Information data shall only contain the K-frame information payload.
The Length value must not exceed (BLE_CMD_MAX_PARAM_LEN - 3) i.e. 252 for BLE_CMD_MAX_PARAM_LEN default value.
Parameter | Size | Description | Possible values |
---|---|---|---|
Channel_Index | 1 | Index of the connection-oriented channel for which the primitive applies. | |
Length | 2 | Length of Data (in octets) | |
Data | Length | Information data |
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. |
Note: in the event tables, a "Y" in the "BF", "LO" or "LB" column, means that the corresponding event applies to the "Basic Features", "Link Layer Only" or "Link Layer Only Basic" variant of the BLE stack, respectively.
Event name | Event code | BF | LO | LB |
---|---|---|---|---|
HCI_DISCONNECTION_COMPLETE_EVENT | 0x05 | Y | Y | Y |
HCI_ENCRYPTION_CHANGE_EVENT | 0x08 | Y | Y | Y |
HCI_READ_REMOTE_VERSION_INFORMATION_COMPLETE_EVENT | 0x0C | Y | Y | Y |
HCI_COMMAND_COMPLETE_EVENT | 0x0E | Y | Y | Y |
HCI_COMMAND_STATUS_EVENT | 0x0F | Y | Y | Y |
HCI_HARDWARE_ERROR_EVENT | 0x10 | Y | Y | Y |
HCI_NUMBER_OF_COMPLETED_PACKETS_EVENT | 0x13 | Y | Y | |
HCI_DATA_BUFFER_OVERFLOW_EVENT | 0x1A | Y | Y | |
HCI_ENCRYPTION_KEY_REFRESH_COMPLETE_EVENT | 0x30 | Y | Y | Y |
HCI_AUTHENTICATED_PAYLOAD_TIMEOUT_EXPIRED_EVENT | 0x57 | Y |
This event occurs when a connection is terminated. The status parameter indicates if the disconnection was successful or not. The reason parameter indicates the reason for the disconnection if the disconnection was successful. If the disconnection was not successful, the value of the reason parameter shall be ignored by the Host.
Note: if the connection is terminated by the remote device, the reason parameter of this event is set to the reason specified by the remote device only if it has an allowed value, otherwise the reason is forced to Remote User Terminated Connection error code (0x13). Allowed remote reason values are: Authentication Failure error code (0x05), Other End Terminated Connection error codes (0x13 to 0x15), Unsupported Remote Feature error code (0x1A), and Unacceptable Connection Parameters error code (0x3B).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.5].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Reason | 1 | Reason for disconnection (see Bluetooth spec. [Vol 1, Part F] Error Codes). |
The Encryption Change event is used to indicate that the change of the encryption mode has been completed. The Connection_Handle will be a Connection_Handle for an ACL connection. The Encryption_Enabled event parameter specifies the new Encryption_Enabled parameter for the Connection_Handle specified by the Connection_Handle event parameter. This event will occur on both devices to notify the Hosts when Encryption has changed for the specified Connection_Handle between two devices. Note: This event shall not be generated if encryption is paused or resumed; during a role switch, for example.
The meaning of the Encryption_Enabled parameter depends on whether the Host has indicated support for Secure Connections in the Secure_Connections_Host_Support parameter. When Secure_Connections_Host_Support is 'disabled' or the Connection_Handle refers to an LE link, the Controller shall only use Encryption_Enabled values 0x00 (OFF) and 0x01 (ON).
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.8].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Encryption_Enabled | 1 | Link Level Encryption. |
The Read Remote Version Information Complete event is used to indicate the completion of the process obtaining the version information of the remote Controller specified by the Connection_Handle event parameter. The Connection_Handle shall be for an ACL connection.
The Version event parameter defines the specification version of the LE Controller.
The Manufacturer_Name event parameter indicates the manufacturer of the remote Controller. The Subversion event parameter is controlled by the manufacturer and is implementation dependent. The Subversion event parameter defines the various revisions that each version of the Bluetooth hardware will go through as design processes change and errors are fixed. This allows the software to determine what Bluetooth hardware is being used and, if necessary, to work around various bugs in the hardware.
When the Connection_Handle is associated with an LE-U logical link, the Version event parameter shall be Link Layer VersNr parameter, the Manufacturer_Name event parameter shall be the CompId parameter, and the Subversion event parameter shall be the SubVersNr parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.12].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Version | 1 | Version of the Current LMP in the remote Controller | |
Manufacturer_Name | 2 | Manufacturer Name of the remote Controller | |
Subversion | 2 | Subversion of the LMP in the remote Controller |
The Command Complete event is used by the Controller for most commands to transmit return status of a command and the other event parameters that are specified for the issued HCI command.
The Num_HCI_Command_Packets event parameter allows the Controller to indicate the number of HCI command packets the Host can send to the Controller.
If the Controller requires the Host to stop sending commands, the Num_HCI_Command_Packets event parameter will be set to zero. To indicate to the Host that the Controller is ready to receive HCI command packets, the Controller generates a Command Complete event with the Command_Opcode 0x0000, and the Num_HCI_Command_Packets event parameter is set to 1 or more. See each command for the parameters that are returned by this event.
Parameter | Size | Description | Possible values |
---|---|---|---|
Num_HCI_Command_Packets | 1 | The Number of HCI command packets which are allowed to be sent to the Controller from the Host. | |
Command_Opcode | 2 | Opcode of the command which caused this event. | |
Return_Parameters | variable | This is the return parameter(s) for the command specified in the Command_Opcode event parameter. See each command's definition for the list of return parameters associated with that command. |
The Command Status event is used to indicate that the command described by the Command_Opcode parameter has been received, and that the Controller is currently performing the task for this command. This event is needed to provide mechanisms for asynchronous operation, which makes it possible to prevent the Host from waiting for a command to finish. If the command cannot begin to execute (a parameter error may have occurred, or the command may currently not be allowed), the Status event parameter will contain the corresponding error code, and no complete event will follow since the command was not started. The Num_HCI_Command_Packets event parameter allows the Controller to indicate the number of HCI command packets the Host can send to the Controller. If the Controller requires the Host to stop sending commands, the Num_HCI_Command_Packets event parameter will be set to zero. To indicate to the Host that the Controller is ready to receive HCI command packets, the Controller generates a Command Status event with Status 0x00 and Command_Opcode 0x0000, and the Num_HCI_Command_Packets event parameter is set to 1 or more.
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Num_HCI_Command_Packets | 1 | The Number of HCI command packets which are allowed to be sent to the Controller from the Host. | |
Command_Opcode | 2 | Opcode of the command which caused this event. |
The Hardware Error event is used to indicate some implementation specific type of hardware failure for the controller. This event is used to notify the Host that a hardware failure has occurred in the Controller.
Parameter | Size | Description | Possible values |
---|---|---|---|
Hardware_Code | 1 | Hardware Error Event code. Error code 0 is not used. Error code 1 is bluecore act2 error detected (only for STM32WB). Error code 2 is bluecore time overrun error detected (only for STM32WB). Error code 3 is internal FIFO full. Error code 4 is ISR delay error detected (only for STM32WB and only from cut 2.2). |
The Number Of Completed Packets event is used by the Controller to indicate to the Host how many HCI Data Packets have been completed (transmitted or flushed) for each Connection_Handle since the previous Number Of Completed Packets event was sent to the Host. This means that the corresponding buffer space has been freed in the Controller. Based on this information, and the HC_Total_Num_ACL_Data_Packets and HC_Total_Num_Synchronous_Data_Packets return parameter of the Read_Buffer_Size command, the Host can determine for which Connection_Handles the following HCI Data Packets should be sent to the Controller. The Number Of Completed Packets event must not be sent before the corresponding Connection Complete event. While the Controller has HCI data packets in its buffer, it must keep sending the Number Of Completed Packets event to the Host at least periodically, until it finally reports that all the pending ACL Data Packets have been transmitted or flushed.
Parameter | Size | Description | Possible values |
---|---|---|---|
Number_of_Handles | 1 | The number of Connection_Handles and Num_HCI_Data_Packets parameters pairs contained in this event | |
Connection_Handle[i] | 2 | Connection handle | |
HC_Num_Of_Completed_Packets[i] | 2 | The number of HCI Data Packets that have been completed (transmitted or flushed) for the associated Connection_Handle since the previous time the event was returned. |
This event is used to indicate that the Controller's data buffers have been overflowed. This can occur if the Host has sent more packets than allowed.
Parameter | Size | Description | Possible values |
---|---|---|---|
Link_Type | 1 | Type of data whose buffers overflowed. |
This event is used to indicate to the Host that the encryption key was refreshed on the given Connection_Handle. The Controller sends this event when the encryption key has been refreshed due to encryption being started or resumed.
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. |
This event is used to indicate that a packet containing a valid MIC on the Connection_Handle was not received within the LE Authenticated Payload Timeout.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.75].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. |
The LE Connection Complete event indicates to both of the Hosts forming the connection that a new connection has been created. Upon the creation of the connection a Connection_Handle shall be assigned by the Controller, and passed to the Host in this event. If the connection establishment fails this event shall be provided to the Host that had issued the LE_Create_Connection command.
This event indicates to the Host which issued a LE_Create_Connection command and received a Command Status event if the connection establishment failed or was successful.
The Central_Clock_Accuracy parameter is only valid for a Peripheral. On a Central, this parameter is set to 0x00.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.1].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Role | 1 | Role of the local device in the connection. | |
Peer_Address_Type | 1 | The address type of the peer device. | |
Peer_Address | 6 | Public Device Address or Random Device Address of the peer device | |
Conn_Interval | 2 | Connection interval used on this connection. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Central_Clock_Accuracy | 1 | Central clock accuracy. Only valid for a Peripheral. |
The LE Advertising Report event indicates that a device or multiple devices have responded to an active scan or received some information during a passive scan. The Controller may queue these advertising reports and send information from multiple devices in one LE Advertising Report event.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.2].
Note: in the current BLE stack version, only one report is sent per event (Num_Reports = 1).
Parameter | Size | Description | Possible values |
---|---|---|---|
Num_Reports | 1 | Number of responses in this event. | |
Event_Type[i] | 1 | Type of advertising report event: ADV_IND: Connectable undirected advertising', ADV_DIRECT_IND: Connectable directed advertising, ADV_SCAN_IND: Scannable undirected advertising, ADV_NONCONN_IND: Non connectable undirected advertising, SCAN_RSP: Scan response. | |
Address_Type[i] | 1 | Address type 0x00 Public Device Address 0x01 Random Device Address 0x02 Public Identity Address (Corresponds to Resolved Private Address) 0x03 Random (Static) Identity Address (Corresponds to Resolved Private Address) | |
Address[i] | 6 | Public Device Address or Random Device Address of the device to be connected. | |
Length_Data[i] | 1 | Length of the Data field for each device which responded. | |
Data[i] | Length_Data[i] | Octets of advertising or scan response data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. | |
RSSI[i] | 1 | RSSI (signed integer). Units: dBm. |
The LE Connection Update Complete event is used to indicate that the Controller process to update the connection has completed.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.3].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Conn_Interval | 2 | Connection interval used on this connection. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. |
This event is used to indicate the completion of the process of the Controller obtaining the used features of the remote Bluetooth device specified by the Connection_Handle event parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.4].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
LE_Features | 8 | Bit Mask List of used LE features. For details see LE Link Layer specification. |
This event indicates that the Central is attempting to encrypt or re-encrypt the link and is requesting the Long Term Key from the Host.
See Bluetooth spec. v.5.4 [Vol 6, Part B, 5.1.3] and [Vol 4, Part E, 7.7.65.5].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the event applies. | |
Random_Number | 8 | 64-bit random number | |
Encrypted_Diversifier | 2 | 16-bit encrypted diversifier |
This event indicates to the Central's Host or the Peripheral's Host that the remote device is requesting a change in the connection parameters using the Connection Update procedure. The Host replies either with the HCI_LE_Remote_Connection_Parameter_Request_Reply command or the HCI_LE_Remote_Connection_Parameter_Request_Negative_Reply command.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.6].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the event applies. | |
Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Max_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. |
This event notifies the Host of a change to either the maximum Payload length or the maximum transmission time of packets in either direction. The values reported are the maximum that will actually be used on the connection following the change, except that on the LE Coded PHY a packet taking up to 2704 us to transmit may be sent even though the corresponding parameter has a lower value.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.7] and [Vol 6, Part B, 4.5.10].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the event applies. | |
MaxTxOctets | 2 | The maximum number of payload octets in a Link Layer packet that the local Controller will send on this connection (connEffectiveMaxTxOctets). | |
MaxTxTime | 2 | The maximum time that the local Controller will take to send a Link Layer packet on this connection (connEffectiveMaxTxTime). | |
MaxRxOctets | 2 | The maximum number of payload octets in a Link Layer packet that the local Controller expects to receive on this connection (connEffectiveMaxRxOctets). | |
MaxRxTime | 2 | The maximum time that the local Controller expects to take to receive a Link Layer packet on this connection (connEffectiveMaxRxTime). |
This event is generated when local P-256 key generation is complete.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.8].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Local_P256_Public_Key | 64 | Local P-256 public key. |
This event indicates that LE Diffie Hellman key generation has been completed by the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.9].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
DHKey | 32 | Diffie Hellman Key |
This event indicates to both of the Hosts forming the connection that a new connection has been created. Upon the creation of the connection a Connection_Handle shall be assigned by the Controller, and passed to the Host in this event. If the connection establishment fails, this event shall be provided to the Host that had issued the LE_Create_Connection command.
If this event is unmasked and LE Connection Complete event is unmasked, only the LE Enhanced Connection Complete event is sent when a new connection has been completed.
This event indicates to the Host that issued a LE_Create_Connection command and received a Command Status event if the connection establishment failed or was successful.
The Central_Clock_Accuracy parameter is only valid for a Peripheral. On a Central, this parameter is set to 0x00.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.10].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Role | 1 | Role of the local device in the connection. | |
Peer_Address_Type | 1 | Address type 0x00 Public Device Address 0x01 Random Device Address 0x02 Public Identity Address (Corresponds to Resolved Private Address) 0x03 Random (Static) Identity Address (Corresponds to Resolved Private Address) | |
Peer_Address | 6 | Public Device Address, Random Device Address, Public Identity Address or Random (static) Identity Address of the device to be connected. | |
Local_Resolvable_Private_Address | 6 | Resolvable Private Address being used by the local device for this connection. This is only valid when the Own_Address_Type is set to 0x02 or 0x03. For other Own_Address_Type values, the Controller shall return all zeros. | |
Peer_Resolvable_Private_Address | 6 | Resolvable Private Address being used by the peer device for this connection. This is only valid for Peer_Address_Type 0x02 and 0x03. For other Peer_Address_Type values, the Controller shall return all zeros. | |
Conn_Interval | 2 | Connection interval used on this connection. Time = N * 1.25 ms. | |
Conn_Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Supervision_Timeout | 2 | Supervision timeout for the LE Link. It shall be a multiple of 10 ms and larger than (1 + connPeripheralLatency) * connInterval * 2. Time = N * 10 ms. | |
Central_Clock_Accuracy | 1 | Central clock accuracy. Only valid for a Peripheral. |
This event indicates that directed advertisements have been received where the advertiser is using a resolvable private address for the InitA field in the ADV_DIRECT_IND PDU and the Scanning_Filter_Policy is equal to 0x02 or 0x03, see HCI_LE_Set_Scan_Parameters.
Direct_Address_Type and Direct_Address specify the address the directed advertisements are being directed to. Address_Type and Address specify the address of the advertiser sending the directed advertisements.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.11].
Parameter | Size | Description | Possible values |
---|---|---|---|
Num_Reports | 1 | Number of responses in this event. | |
Event_Type[i] | 1 | Advertising type | |
Address_Type[i] | 1 | Address type 0x00 Public Device Address 0x01 Random Device Address 0x02 Public Identity Address (Corresponds to Resolved Private Address) 0x03 Random (Static) Identity Address (Corresponds to Resolved Private Address) | |
Address[i] | 6 | Public Device Address, Random Device Address, Public Identity Address or Random (static) Identity Address of the advertising device. | |
Direct_Address_Type[i] | 1 | 0x01 Random Device Address | |
Direct_Address[i] | 6 | Random Device Address | |
RSSI[i] | 1 | RSSI (signed integer). Units: dBm. |
This event is used to indicate that the Controller has changed the transmitter PHY or receiver PHY in use.
If the Controller changes the transmitter PHY, the receiver PHY, or both PHYs, this event shall be issued.
If an LE_Set_PHY command was sent and the Controller determines that neither PHY will change as a result, it issues this event immediately.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.12].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
TX_PHY | 1 | Transmitter PHY in use. | |
RX_PHY | 1 | Receiver PHY in use. |
The HCI_LE_Extended_Advertising_Report event indicates that a Bluetooth device has responded to an active scan or has broadcast advertisements that were received during a passive scan.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.13].
Parameter | Size | Description | Possible values |
---|---|---|---|
Num_Reports | 1 | Number of responses in this event. | |
Event_Type | 2 | Event type. | Bitmask of: |
Address_Type | 1 | Address type of the advertising device. | |
Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the advertising device. | |
Primary_PHY | 1 | Primary advertising PHY. | |
Secondary_PHY | 1 | Secondary advertising PHY. | |
Advertising_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU or, for scan responses, in the ADI field of the original scannable. | |
TX_Power | 1 | Tx Power (signed integer). Units: dBm. | |
RSSI | 1 | RSSI (signed integer). Units: dBm. | |
Periodic_Adv_Interval | 2 | Interval of the periodic advertising. | |
Direct_Address_Type | 1 | Target device address type. | |
Direct_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the target device. | |
Data_Length | 1 | Length of Data | |
Data | Data_Length | Octets of advertising or scan response data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. |
This event indicates that the Controller has received the first periodic advertising packet from an advertiser after the HCI_LE_Periodic_Advertising_Create_Sync command has been sent to the Controller.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.14].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Periodic advertising sync status. | |
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
Advertising_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU or, for scan responses, in the ADI field of the original scannable. | |
Advertiser_Address_Type | 1 | Advertiser address type. | |
Advertiser_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the advertiser. | |
Advertiser_PHY | 1 | Advertiser PHY. | |
Periodic_Advertising_Interval | 2 | Periodic advertising interval. Time = N * 1.25 ms. | |
Advertiser_Clock_Accuracy | 1 | Advertiser clock accuracy. |
This event indicates that the Controller has received a periodic advertisement.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.15].
Parameter | Size | Description | Possible values |
---|---|---|---|
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
TX_Power | 1 | Tx Power (signed integer). Units: dBm. | |
RSSI | 1 | RSSI (signed integer). Units: dBm. | |
CTE_Type | 1 | Constant Tone Extension type. | |
Data_Status | 1 | Data status. | |
Data_Length | 1 | Length of Data | |
Data | Data_Length | Octets of advertising or scan response data formatted as defined in Bluetooth spec. v.5.4 [Vol 3, Part C, 11]. |
This event indicates that the Controller has not received a Periodic Advertising packet from the train identified by Sync_Handle within the timeout period.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.16].
Parameter | Size | Description | Possible values |
---|---|---|---|
Sync_Handle | 2 | Handle identifying the periodic advertising train. |
This event indicates that scanning has ended because the duration has expired.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.17].
None
This event indicates that the Controller has terminated advertising in the advertising sets specified by the Advertising_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.18].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Advertising_Handle | 1 | Used to identify an advertising set. | |
Connection_Handle | 2 | Connection handle for which the event applies. | |
Num_Completed_Ext_Adv_Events | 1 | Number of completed extended advertising events transmitted by the Controller. |
This event indicates that a SCAN_REQ PDU or an AUX_SCAN_REQ PDU has been received by the advertiser. The request contains a device address from a scanner that is allowed by the advertising filter policy. The advertising set is identified by Advertising_Handle.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.19].
Parameter | Size | Description | Possible values |
---|---|---|---|
Advertising_Handle | 1 | Used to identify an advertising set. | |
Scanner_Address_Type | 1 | Scanner address type. | |
Scanner_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the scanner device. |
This event indicates which channel selection algorithm is used on a data physical channel connection.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.20].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the event applies. | |
Channel_Selection_Algorithm | 1 | LE Channel Selection Algorithm. |
This event is used by the Controller to report IQ information from the Constant Tone Extension of a received advertising packet forming part of the periodic advertising train identified by Sync_Handle and to report IQ information from the Constant Tone Extension of a received Test Mode packet.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.21].
Parameter | Size | Description | Possible values |
---|---|---|---|
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
Channel_Index | 1 | Index of the channel on which the packet was received. Note: 0x25 to 0x27 can be used only for packets generated during test modes. | |
RSSI | 2 | RSSI (signed integer). Units: 0.1 dBm. | |
RSSI_Antenna_ID | 1 | ID of the antenna on which the RSSI is measured. | |
CTE_Type | 1 | Constant Tone Extension type. | |
Slot_Durations | 1 | Slot Durations. | |
Packet_Status | 1 | Packet status. | |
Periodic_Event_Counter | 2 | Value of paEventCounter for the reported packet. | |
Sample_Count | 1 | Total number of sample pairs | |
IQ_Sample | Sample_Count | I/Q sample pairs |
This event is used by the Controller to report the IQ samples from the Constant Tone Extension of a received packet.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.22].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
RX_PHY | 1 | Receiver PHY. | |
Data_Channel_Index | 1 | Index of the data channel on which the Data Physical Channel PDU was received. | |
RSSI | 2 | RSSI (signed integer). Units: 0.1 dBm. | |
RSSI_Antenna_ID | 1 | ID of the antenna on which the RSSI is measured. | |
CTE_Type | 1 | Constant Tone Extension type. | |
Slot_Durations | 1 | Slot Durations. | |
Packet_Status | 1 | Packet status. | |
Connection_Event_Counter | 2 | Value of paEventCounter for the reported packet. | |
Sample_Count | 1 | Total number of sample pairs | |
IQ_Sample | Sample_Count | I/Q sample pairs |
This event is used by the Controller to report an issue following a request to a peer device to reply with a packet containing an LL_CTE_RSP PDU and a Constant Tone Extension. It shall be generated if the packet containing the LL_CTE_RSP PDU sent in response did not contain a Constant Tone Extension or if the peer rejected the request. It shall not be generated if the packet containing the LL_CTE_RSP PDU had a CRC error or if the procedure response timeout timer expired.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.23].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | CTE request failed status. | |
Connection_Handle | 2 | Handle of the connection where this event occurred. |
This event is used by the Controller to report that it has received periodic advertising synchronization information from the device referred to by the Connection_Handle parameter and either successfully synchronized to the periodic advertising train or timed out while attempting to synchronize. The Status will be zero if it successfully synchronized and non-zero otherwise.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.24].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Periodic advertising sync status. | |
Connection_Handle | 2 | Connection handle for which the command applies. | |
Service_Data | 2 | Service data. | |
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
Advertising_SID | 1 | Value of the Advertising SID subfield in the ADI field of the PDU or, for scan responses, in the ADI field of the original scannable. | |
Advertiser_Address_Type | 1 | Advertiser address type. | |
Advertiser_Address | 6 | Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the advertiser. | |
Advertiser_PHY | 1 | Advertiser PHY. | |
Periodic_Advertising_Interval | 2 | Periodic advertising interval. Time = N * 1.25 ms. | |
Advertiser_Clock_Accuracy | 1 | Advertiser clock accuracy. |
This event indicates that a CIS has been established, was considered lost before being established, or, on the Central, was rejected by the Peripheral. It is generated by the Controller in the Central and Peripheral. The Connection_Handle parameter shall be set to the value provided in the HCI_LE_Create_CIS command on the Central and in the HCI_LE_CIS_Request event on the Peripheral.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.25].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | ||
Connection_Handle | 2 | Connection handle for which the command applies. | |
CIG_Sync_Delay | 3 | The maximum time, in microseconds, for transmission of PDUs of all CISes in a CIG event. | |
CIS_Sync_Delay | 3 | The maximum time, in microseconds, for transmission of PDUs of the specified CIS in a CIG event. | |
Transport_Latency_C_To_P | 3 | ||
Transport_Latency_P_To_C | 3 | ||
PHY_C_To_P | 1 | PHY used for transmission from the Central to the Peripheral. | |
PHY_P_To_C | 1 | PHY used for transmission from the Peripheral to the Central. | |
NSE | 1 | Number of subevents in each interval of each BIS in the BIG. | |
BN_C_To_P | 1 | Burst number for Central to Peripheral. | |
BN_P_To_C | 1 | Burst number for Peripheral to Central. | |
FT_C_To_P | 1 | Flush timeout in multiples of ISO_Interval for each payload sent from the Central to Peripheral. | |
FT_P_To_C | 1 | Flush timeout in multiples of ISO_Interval for each payload sent from the Peripheral to Central. | |
Max_PDU_C_To_P | 2 | Maximum size, in octets, of the payload from the Central to the Peripheral. | |
Max_PDU_P_To_C | 2 | Maximum size, in octets, of the payload from the Peripheral to the Central. | |
ISO_Interval | 2 | Time between consecutive BIG anchor points. Time = N * 1.25 ms. |
This event indicates that a Controller has received a request to establish a CIS. If the Controller receives such a request while the HCI_LE_CIS_Request event is masked away, it shall reject it. Otherwise the Controller shall assign a connection handle for the requested CIS and send the handle in the CIS_Connection_Handle parameter of the event.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.26].
Parameter | Size | Description | Possible values |
---|---|---|---|
ACL_Connection_Handle | 2 | Connection handle of an ACL connection. | |
CIS_Connection_Handle | 2 | Connection handle of a CIS. | |
CIG_ID | 1 | CIG identifier. | |
CIS_ID | 1 | CIS identifier. |
This event indicates that the HCI_LE_Create_BIG command has completed.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.27].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | ||
BIG_Handle | 1 | BIG identifier. | |
BIG_Sync_Delay | 3 | Maximum time in microseconds for transmission of PDUs of all BISes in a BIG event. | |
Transport_Latency_BIG | 3 | Transport latency, in microseconds. | |
PHY | 1 | PHY used to create the BIG. | |
NSE | 1 | Number of subevents in each interval of each BIS in the BIG. | |
BN | 1 | Number of new payloads in each interval for each BIS. | |
PTO | 1 | Offset used for pre-transmissions. | |
IRC | 1 | Number of times the scheduled payloads are transmitted in a given event. | |
Max_PDU | 2 | Maximum size, in octets, of payload. | |
ISO_Interval | 2 | Time between consecutive BIG anchor points. Time = N * 1.25 ms. | |
Num_BIS | 1 | Total number of BISes in the BIG. | |
Connection_Handle | Num_BIS |
This event indicates that the transmission of all the BISes in the BIG are terminated.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.28].
Parameter | Size | Description | Possible values |
---|---|---|---|
BIG_Handle | 1 | BIG identifier. | |
Reason | 1 | See "Status error codes" section. |
This event indicates that the HCI_LE_BIG_Create_Sync command has completed.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.29].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | ||
BIG_Handle | 1 | BIG identifier. | |
Transport_Latency_BIG | 3 | Transport latency, in microseconds. | |
NSE | 1 | Number of subevents in each interval of each BIS in the BIG. | |
BN | 1 | Number of new payloads in each interval for each BIS. | |
PTO | 1 | Offset used for pre-transmissions. | |
IRC | 1 | Number of times the scheduled payloads are transmitted in a given event. | |
Max_PDU | 2 | Maximum size, in octets, of payload. | |
ISO_Interval | 2 | Time between consecutive BIG anchor points. Time = N * 1.25 ms. | |
Num_BIS | 1 | Total number of BISes in the BIG. | |
Connection_Handle | Num_BIS |
This event indicates that the Controller has not received any PDUs on a BIG within the timeout period BIG_Sync_Timeout or the BIG has been terminated by the remote device.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.30].
Parameter | Size | Description | Possible values |
---|---|---|---|
BIG_Handle | 1 | BIG identifier. | |
Reason | 1 | See "Status error codes" section. |
This event indicates that the HCI_LE_Request_Peer_SCA command has been completed.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.31].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Peer clock accuracy request status. | |
Connection_Handle | 2 | Connection handle for which the command applies. | |
Peer_Clock_Accuracy | 1 | Sleep clock accuracy of the peer. |
This event is used to report a path loss threshold crossing on the ACL connection identified by the Connection_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.32].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the command applies. | |
Current_Path_Loss | 1 | Current path loss (always zero or positive). Units: dB. | |
Zone_Entered | 1 | Entered zone (shall be ignored if Current_Path_Loss is set to 0xFF). |
This event is used to report the transmit power level on the ACL connection identified by the Connection_Handle parameter.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.33].
Parameter | Size | Description | Possible values |
---|---|---|---|
Status | 1 | Status error code. | |
Connection_Handle | 2 | Connection handle for which the command applies. | |
Reason | 1 | Event reason. | |
PHY | 1 | Applying PHY. | |
TX_Power_Level | 1 | Transmit power level (signed integer). Units: dBm. | |
TX_Power_Level_Flag | 1 | Indicates whether the transmit power level has reached its minimum and/or maximum level. Shall be ignored if the TX_Power_Level parameter is set to 0x7E or 0x7F. | |
Delta | 1 | Change in transmit power level (signed integer - positive indicates increased power, negative indicates decreased power, zero indicates unchanged). Units: dB. |
This event indicates that the Controller has received an Advertising PDU that contained a BIGInfo field. If the Controller also generates an HCI_LE_Periodic_Advertising_Report event, the HCI_LE_BIGInfo_Advertising_Report event shall immediately follow that event.
See Bluetooth spec. v.5.4 [Vol 4, Part E, 7.7.65.34].
Parameter | Size | Description | Possible values |
---|---|---|---|
Sync_Handle | 2 | Handle identifying the periodic advertising train. | |
Num_BIS | 1 | Total number of BISes in the BIG. | |
NSE | 1 | Number of subevents in each interval of each BIS in the BIG. | |
ISO_Interval | 2 | Time between consecutive BIG anchor points. Time = N * 1.25 ms. | |
BN | 1 | Number of new payloads in each interval for each BIS. | |
PTO | 1 | Offset used for pre-transmissions. | |
IRC | 1 | Number of times the scheduled payloads are transmitted in a given event. | |
Max_PDU | 2 | Maximum size, in octets, of payload. | |
SDU_Interval | 3 | Interval, in microseconds, of periodic SDUs. | |
Max_SDU | 2 | Maximum size of an SDU in octets. | |
PHY | 1 | PHY of the Advertising PDU. | |
Framing | 1 | Format of the CIS Data PDUs. | |
Encryption | 1 | Encryption mode of the BISes. |
Event name | Vendor specific subevent code | BF | LO | LB |
---|---|---|---|---|
ACI_GAP_LIMITED_DISCOVERABLE_EVENT | 0x0400 | Y | ||
ACI_GAP_PAIRING_COMPLETE_EVENT | 0x0401 | Y | ||
ACI_GAP_PASS_KEY_REQ_EVENT | 0x0402 | Y | ||
ACI_GAP_AUTHORIZATION_REQ_EVENT | 0x0403 | Y | ||
ACI_GAP_PERIPHERAL_SECURITY_INITIATED_EVENT | 0x0404 | Y | ||
ACI_GAP_BOND_LOST_EVENT | 0x0405 | Y | ||
ACI_GAP_PROC_COMPLETE_EVENT | 0x0407 | Y | ||
ACI_GAP_ADDR_NOT_RESOLVED_EVENT | 0x0408 | Y | ||
ACI_GAP_NUMERIC_COMPARISON_VALUE_EVENT | 0x0409 | Y | ||
ACI_GAP_KEYPRESS_NOTIFICATION_EVENT | 0x040A | Y |
This event is generated by the controller when the limited discoverable mode ends due to timeout. The timeout is 180 seconds.
None
This event is generated when the pairing process has completed successfully or a pairing procedure timeout has occurred or the pairing has failed. This is to notify the application that we have paired with a remote device so that it can take further actions or to notify that a timeout has occurred so that the upper layer can decide to disconnect the link.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Status | 1 | Pairing status | |
Reason | 1 | Pairing reason error code (valid in case of pairing failed status) |
This event is generated by the Security manager to the application when a passkey is required for pairing. When this event is received, the application has to respond with the ACI_GAP_PASS_KEY_RESP command.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. |
This event is generated by the Security manager to the application when the application has set that authorization is required for reading/writing of attributes. This event will be generated as soon as the pairing is complete. When this event is received, ACI_GAP_AUTHORIZATION_RESP command should be used to respond by the application.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. |
This event is generated when the Peripheral Security Request is successfully sent to the Central.
None
This event is generated when a pairing request is issued in response to a Peripheral Security Request from a Central which has previously bonded with the Peripheral. When this event is received, the upper layer has to issue the command ACI_GAP_ALLOW_REBOND in order to allow the Peripheral to continue the pairing process with the Central.
None
This event is sent by the GAP to the upper layers when a procedure previously started has been terminated by the upper layer or has completed for any other reason
Parameter | Size | Description | Possible values |
---|---|---|---|
Procedure_Code | 1 | Terminated procedure. | |
Status | 1 | Status error code. | |
Data_Length | 1 | Length of Data in octets | |
Data | Data_Length | Procedure Specific Data: - For Name Discovery Procedure: the name of the peer device if the procedure completed successfully. |
This event is sent only by a privacy enabled peripheral with a non-empty bonded device list. The event is sent to the application when the peripheral is unsuccessful in resolving the resolvable address of the peer device after connecting to it.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. |
This event is sent only during SC Pairing, when Numeric Comparison Association model is selected, in order to show the Numeric Value generated, and to ask for Confirmation to the User. When this event is received, the application has to respond with the ACI_GAP_NUMERIC_COMPARISON_RESP command.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Numeric_Value | 4 | Generated numeric value. |
This event is sent only during SC Pairing, when Keypress Notifications are supported, in order to show the input type signaled by the peer device, having Keyboard only I/O capabilities. When this event is received, no action is required to the User.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Notification_Type | 1 | Type of Keypress input notified/signaled by peer device (having Keyboard only I/O capabilities. |
This event is generated to the application by the GATT server when a client modifies any attribute on the server, as consequence of one of the following GATT procedures:
- write without response
- signed write without response
- write characteristic value
- write long characteristic value
- reliable write.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attr_Handle | 2 | Handle of the attribute that was modified. | |
Offset | 2 | Bits 14-0: offset from which the write has been performed by the peer device. Bit 15 is used as flag: when set to 1 it indicates that more data are to come (fragmented event in case of long attribute data). | |
Attr_Data_Length | 2 | Length of Attr_Data in octets | |
Attr_Data | Attr_Data_Length | The modified value |
This event is generated by the client/server to the application on a GATT timeout (30 seconds). This is a critical event that should not happen during normal operating conditions. It is an indication of either a major disruption in the communication link or a mistake in the application which does not provide a reply to GATT procedures. After this event, the GATT channel is closed and no more GATT communication can be performed. The application is expected to issue an ACI_GAP_TERMINATE to disconnect from the peer device. It is important to leave a 100 ms blank window before sending the ACI_GAP_TERMINATE, since immediately after this event, system could save important information in non-volatile memory.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. |
This event is generated in response to an Exchange MTU request. See ACI_GATT_EXCHANGE_CONFIG.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Connection handle for which the event applies. | |
Server_RX_MTU | 2 | Attribute server receive MTU size |
This event is generated in response to a Find Information Request. See ACI_ATT_FIND_INFO_REQ and Find Information Response in Bluetooth Core spec. This event is also generated in response to ACI_GATT_DISC_ALL_CHAR_DESC
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Format | 1 | Format of the handle-UUID pairs | |
Event_Data_Length | 1 | Length of Handle_UUID_Pair in octets | |
Handle_UUID_Pair | Event_Data_Length | A sequence of handle-uuid pairs. if format=1, each pair is:[2 octets for handle, 2 octets for UUIDs], if format=2, each pair is:[2 octets for handle, 16 octets for UUIDs] |
This event is generated in response to a ACI_ATT_FIND_BY_TYPE_VALUE_REQ
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Num_of_Handle_Pair | 1 | Number of attribute, group handle pairs | |
Found_Attribute_Handle[i] | 2 | Found Attribute handle | |
Group_End_Handle[i] | 2 | Group End handle |
This event is generated in response to a ACI_ATT_READ_BY_TYPE_REQ. See ACI_GATT_FIND_INCLUDED_SERVICES and ACI_GATT_DISC_ALL_CHAR_DESC.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Handle_Value_Pair_Length | 1 | The size of each attribute handle-value pair | |
Data_Length | 1 | Length of Handle_Value_Pair_Data in octets | |
Handle_Value_Pair_Data | Data_Length | Attribute Data List as defined in Bluetooth Core spec. A sequence of handle-value pairs: [2 octets for Attribute Handle, (Handle_Value_Pair_Length - 2 octets) for Attribute Value] |
This event is generated in response to a Read Request. See ACI_GATT_READ_CHAR_VALUE.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Event_Data_Length | 1 | Length of following data | |
Attribute_Value | Event_Data_Length | The value of the attribute. |
This event can be generated during a read long characteristic value procedure. See ACI_GATT_READ_LONG_CHAR_VALUE.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Event_Data_Length | 1 | Length of following data | |
Attribute_Value | Event_Data_Length | Part of the attribute value. |
This event is generated in response to a Read Multiple Characteristic Values Request or a Read Multiple Variable Length Characteristic Values Request.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Event_Data_Length | 1 | Length of following data | |
Set_Of_Values | Event_Data_Length | A set of two or more values. A concatenation of attribute values for each of the attribute handles in the request in the order that they were requested. |
This event is generated in response to a Read By Group Type Request. See ACI_GATT_DISC_ALL_PRIMARY_SERVICES.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Data_Length | 1 | The size of each attribute data | |
Data_Length | 1 | Length of Attribute_Data_List in octets | |
Attribute_Data_List | Data_Length | Attribute Data List as defined in Bluetooth Core spec. A sequence of attribute handle, end group handle, attribute value tuples: [2 octets for Attribute Handle, 2 octets End Group Handle, (Attribute_Data_Length - 4 octets) for Attribute Value] |
This event is generated in response to a ACI_ATT_PREPARE_WRITE_REQ.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute to be written | |
Offset | 2 | The offset of the first octet to be written. | |
Part_Attribute_Value_Length | 1 | Length of Part_Attribute_Value in octets | |
Part_Attribute_Value | Part_Attribute_Value_Length | The value of the attribute to be written |
This event is generated in response to an Execute Write Request.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. |
This event is generated when an indication is received from the server.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Attribute_Value_Length | 1 | Length of Attribute_Value in octets | |
Attribute_Value | Attribute_Value_Length | The current value of the attribute |
This event is generated when a notification is received from the server.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Attribute_Value_Length | 1 | Length of Attribute_Value in octets | |
Attribute_Value | Attribute_Value_Length | The current value of the attribute |
This event is generated when a GATT client procedure completes either with error or successfully.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Error_Code | 1 | Indicates whether the procedure completed with an error or was successful (see "Status error codes" section) |
This event is generated when an Error Response is received from the server. The error response can be given by the server at the end of one of the GATT discovery procedures. This does not mean that the procedure ended with an error, but this error event is part of the procedure itself.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Req_Opcode | 1 | The request that generated this error response | |
Attribute_Handle | 2 | The attribute handle that generated this error response | |
Error_Code | 1 | The reason why the request has generated an error response (ATT error codes) |
This event can be generated during a "Discover Characteristics By UUID" procedure or a "Read using Characteristic UUID" procedure.
The attribute value will be a service declaration as defined in Bluetooth spec. v.5.4 [Vol 3, Part G, 3.3.1], when a "Discover Characteristics By UUID" has been started. It will be the value of the Characteristic if a* "Read using Characteristic UUID" has been performed.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Attribute_Value_Length | 1 | Length of Attribute_Value in octets | |
Attribute_Value | Attribute_Value_Length | The attribute value will be a service declaration as defined in Bluetooth spec. v.5.4 [Vol 3, Part G, 3.3.1], when a "Discover Characteristics By UUID" has been started. It will be the value of the Characteristic if a "Read using Characteristic UUID" has been performed. |
This event is given to the application when a write request, write command or signed write command is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added.
When this event is received, the application has to check whether the value being requested for write can be allowed to be written and respond with the command ACI_GATT_WRITE_RESP.
The details of the parameters of the command can be found. Based on the response from the application, the attribute value will be modified by the stack. If the write is rejected by the application, then the value of the attribute will not be modified. In case of a write REQ, an error response will be sent to the client, with the error code as specified by the application.
In case of write/signed write commands, no response is sent to the client but the attribute is not modified.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Data_Length | 1 | Length of Data field | |
Data | Data_Length | The data that the client has requested to write |
This event is given to the application when a read request or read blob request is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added.
On receiving this event, the application can update the value of the handle if it desires and when done, it must send the ACI_GATT_ALLOW_READ command to indicate to the stack that it can send the response to the client.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Offset | 2 | Contains the offset from which the read has been requested |
This event is given to the application when a read multiple request or read by type request is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added.
On receiving this event, the application can update the values of the handles if it desires and when done, it must send the ACI_GATT_ALLOW_READ command to indicate to the stack that it can send the response to the client.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Number_of_Handles | 1 | ||
Handle[i] | 2 |
Each time BLE stack raises the error code BLE_STATUS_INSUFFICIENT_RESOURCES (0x64), the ACI_GATT_TX_POOL_AVAILABLE_EVENT event is generated as soon as there are at least two buffers available for notifications or write commands.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Not used. | |
Available_Buffers | 2 | Number of buffers available. |
This event is generated when the client has sent the confirmation to a previously sent indication
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. |
This event is given to the application when a prepare write request is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added.
When this event is received, the application has to check whether the value being requested for write can be allowed to be written and respond with the command ACI_GATT_WRITE_RESP. Based on the response from the application, the attribute value will be modified by the stack.
If the write is rejected by the application, then the value of the attribute will not be modified and an error response will be sent to the client, with the error code as specified by the application.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Offset | 2 | The offset from which the prepare write has been requested | |
Data_Length | 1 | Length of Data field | |
Data | Data_Length | The data that the client has requested to write |
This event informs the application of a change in status of the Enhanced ATT bearer handled by the specified L2CAP channel.
Parameter | Size | Description | Possible values |
---|---|---|---|
Channel_Index | 1 | Index of the connection-oriented channel for which the primitive applies. | |
EAB_State | 1 | Enhanced ATT bearer state. | |
Status | 1 | Status error code. |
This event is generated when a Multiple Handle Value notification is received from the server.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Offset | 2 | Bits 14-0: offset in octets from which Attribute_Value data starts. Bit 15 is used as flag: when set to 1 it indicates that more data are to come (fragmented event in case of long attribute data). | |
Data_Length | 2 | Length of Data in bytes | |
Data | Data_Length | List of "Handle Length Value" tuples as defined in Bluetooth Core specification |
This event is generated on server side after the transmission of all notifications linked with a local update of a characteristic value (if it is enabled at the creation of the characteristic with GATT_NOTIFY_NOTIFICATION_COMPLETION mask and if the characteristic supports notifications).
Parameter | Size | Description | Possible values |
---|---|---|---|
Attr_Handle | 2 | Handle of the updated characteristic value |
When it is enabled with ACI_GATT_SET_EVENT_MASK, this event is generated instead of ACI_ATT_READ_RESP_EVENT / ACI_ATT_READ_BLOB_RESP_EVENT / ACI_ATT_READ_MULTIPLE_RESP_EVENT.
This event should be used instead of those events when ATT_MTU > (BLE_EVT_MAX_PARAM_LEN - 4) i.e. ATT_MTU > 251 for BLE_EVT_MAX_PARAM_LEN default value.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Offset | 2 | Bits 14-0: offset in octets from which Attribute_Value data starts. Bit 15 is used as flag: when set to 1 it indicates that more data are to come (fragmented event in case of long attribute data). | |
Event_Data_Length | 2 | Length of following data | |
Attribute_Value | Event_Data_Length | The value of the attribute(s). |
When it is enabled with ACI_GATT_SET_EVENT_MASK and when an indication is received from the server, this event is generated instead of ACI_GATT_INDICATION_EVENT.
This event should be used instead of ACI_GATT_INDICATION_EVENT when ATT_MTU > (BLE_EVT_MAX_PARAM_LEN - 4) i.e. ATT_MTU > 251 for BLE_EVT_MAX_PARAM_LEN default value.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Offset | 2 | Bits 14-0: offset in octets from which Attribute_Value data starts. Bit 15 is used as flag: when set to 1 it indicates that more data are to come (fragmented event in case of long attribute data). | |
Attribute_Value_Length | 2 | Length of Attribute_Value in octets | |
Attribute_Value | Attribute_Value_Length | The current value of the attribute |
When it is enabled with ACI_GATT_SET_EVENT_MASK and when a notification is received from the server, this event is generated instead of ACI_GATT_NOTIFICATION_EVENT.
This event should be used instead of ACI_GATT_NOTIFICATION_EVENT when ATT_MTU > (BLE_EVT_MAX_PARAM_LEN - 4) i.e. ATT_MTU > 251 for BLE_EVT_MAX_PARAM_LEN default value.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Specifies the ATT bearer for which the event applies. | |
Attribute_Handle | 2 | The handle of the attribute | |
Offset | 2 | Bits 14-0: offset in octets from which Attribute_Value data starts. Bit 15 is used as flag: when set to 1 it indicates that more data are to come (fragmented event in case of long attribute data). | |
Attribute_Value_Length | 2 | Length of Attribute_Value in octets | |
Attribute_Value | Attribute_Value_Length | The current value of the attribute |
Event name | Vendor specific subevent code | BF | LO | LB |
---|---|---|---|---|
ACI_L2CAP_CONNECTION_UPDATE_RESP_EVENT | 0x0800 | Y | ||
ACI_L2CAP_PROC_TIMEOUT_EVENT | 0x0801 | Y | ||
ACI_L2CAP_CONNECTION_UPDATE_REQ_EVENT | 0x0802 | Y | ||
ACI_L2CAP_COMMAND_REJECT_EVENT | 0x080A | Y | ||
ACI_L2CAP_COC_CONNECT_EVENT | 0x0810 | |||
ACI_L2CAP_COC_CONNECT_CONFIRM_EVENT | 0x0811 | |||
ACI_L2CAP_COC_RECONF_EVENT | 0x0812 | |||
ACI_L2CAP_COC_RECONF_CONFIRM_EVENT | 0x0813 | |||
ACI_L2CAP_COC_DISCONNECT_EVENT | 0x0814 | |||
ACI_L2CAP_COC_FLOW_CONTROL_EVENT | 0x0815 | |||
ACI_L2CAP_COC_RX_DATA_EVENT | 0x0816 | |||
ACI_L2CAP_COC_TX_POOL_AVAILABLE_EVENT | 0x0817 |
This event is generated when the Central responds to the connection update request packet with a connection update response packet.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Result | 2 | Result field from the response packet. |
This event is generated when the Central does not respond to the connection update request packet with a connection update response packet or a command reject packet within 30 seconds.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Data_Length | 1 | Length of following data | |
Data | Data_Length |
The event is given by the L2CAP layer when a connection update request is received from the Peripheral. The upper layer which receives this event has to respond by sending a ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_RESP command.
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Identifier | 1 | This is the identifier which associate the request to the response. | |
L2CAP_Length | 2 | Length of the L2CAP connection update request. | |
Interval_Min | 2 | Minimum value for the connection event interval. Time = N * 1.25 ms. | |
Interval_Max | 2 | Maximum value for the connection event interval. Time = N * 1.25 ms. | |
Latency | 2 | Maximum Peripheral latency for the connection in number of connection events. | |
Timeout_Multiplier | 2 | Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms. |
This event is generated upon receipt of a valid Command Reject packet (e.g. when the Central responds to the Connection Update Request packet with a Command Reject packet).
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Identifier | 1 | This is the identifier which associate the request to the response. | |
Reason | 2 | Reason | |
Data_Length | 1 | Length of following data | |
Data | Data_Length | Data field associated with Reason |
This event is generated when receiving a valid Credit Based Connection Request packet.
See Bluetooth spec. v.5.4 [Vol 3, Part A].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
SPSM | 2 | Simplified Protocol/Service Multiplexer. | |
MTU | 2 | Maximum Transmission Unit. | |
MPS | 2 | Maximum payload size (in octets). | |
Initial_Credits | 2 | Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet. | |
Channel_Number | 1 | Number of channels to be created. If this parameter is set to 0, it requests the creation of one LE credit based connection-oriented channel. Otherwise, it requests the creation of one or more enhanced credit based connection-oriented channels. |
This event is generated when receiving a valid Credit Based Connection Response packet.
See Bluetooth spec. v.5.4 [Vol 3, Part A].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
MTU | 2 | Maximum Transmission Unit. | |
MPS | 2 | Maximum payload size (in octets). | |
Initial_Credits | 2 | Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet. | |
Result | 2 | This parameter indicates the outcome of the request. A value of 0x0000 indicates success while a non-zero value indicates the request is refused. | |
Channel_Number | 1 | Number of created channels. It is the length of Channel_Index_List. | |
Channel_Index_List | Channel_Number | List of channel indexes for which the primitive applies. |
This event is generated when receiving a valid Credit Based Reconfigure Request packet.
See Bluetooth spec. v.5.4 [Vol 3, Part A].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
MTU | 2 | Maximum Transmission Unit. | |
MPS | 2 | Maximum payload size (in octets). | |
Channel_Number | 1 | Number of created channels. It is the length of Channel_Index_List. | |
Channel_Index_List | Channel_Number | List of channel indexes for which the primitive applies. |
This event is generated when receiving a valid Credit Based Reconfigure Response packet.
See Bluetooth spec. v.5.4 [Vol 3, Part A].
Parameter | Size | Description | Possible values |
---|---|---|---|
Connection_Handle | 2 | Handle of the connection where this event occurred. | |
Result | 2 | This parameter indicates the outcome of the request. A value of 0x0000 indicates success while a non-zero value indicates the request is refused. |
This event is generated when a connection-oriented channel is disconnected following an L2CAP channel termination procedure.
See Bluetooth spec. v.5.4 [Vol 3, Part A].
Parameter | Size | Description | Possible values |
---|---|---|---|
Channel_Index | 1 | Index of the connection-oriented channel for which the primitive applies. |
This event is generated when receiving a valid Flow Control Credit signaling packet.
See Bluetooth spec. v.5.4 [Vol 3, Part A].
Parameter | Size | Description | Possible values |
---|---|---|---|
Channel_Index | 1 | Index of the connection-oriented channel for which the primitive applies. | |
Credits | 2 | Number of credits the receiving device can increment, corresponding to the number of K-frames that can be sent to the peer device sending the Flow Control Credit packet. |
This event is generated when receiving a valid K-frame packet on a connection-oriented channel.
See Bluetooth spec. v.5.4 [Vol 3, Part A].
Note: for the first K-frame of the SDU, the Information data contains the L2CAP SDU Length coded on two octets followed by the K-frame information payload. For the next K-frames of the SDU, the Information data only contains the K-frame information payload.
Parameter | Size | Description | Possible values |
---|---|---|---|
Channel_Index | 1 | Index of the connection-oriented channel for which the primitive applies. | |
Length | 2 | Length of Data (in octets) | |
Data | Length | Information data |
Each time ACI_L2CAP_COC_TX_DATA raises the error code BLE_STATUS_INSUFFICIENT_RESOURCES (0x64), the ACI_L2CAP_COC_TX_POOL_AVAILABLE_EVENT event is generated as soon as there is a free buffer available for sending K-frames.
None
Event name | Vendor specific subevent code | BF | LO | LB |
---|---|---|---|---|
ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT | 0x0004 | Y | Y | Y |
ACI_HAL_SCAN_REQ_REPORT_EVENT | 0x0005 | |||
ACI_HAL_FW_ERROR_EVENT | 0x0006 | Y | ||
ACI_HAL_SYNC_EVENT | 0x0008 | Y |
This event is generated when the device completes a radio activity and provide information when a new radio activity will be performed.
Information provided includes type of radio activity and absolute time in system ticks when a new radio activity is schedule, if any. Application can use this information to schedule user activities synchronous to selected radio activities. A command ACI_HAL_SET_RADIO_ACTIVITY_MASK is provided to enable radio activity events of user interests, by default no events are enabled.
User should take into account that enabling radio events in application with intense radio activity could lead to a fairly high rate of events generated.
Application use cases includes synchronizing notification with connection interval, switching antenna at the end of advertising or performing flash erase operation while radio is idle.
Parameter | Size | Description | Possible values |
---|---|---|---|
Last_State | 1 | Completed radio event | |
Next_State | 1 | Incoming radio event | |
Next_State_SysTime | 4 | 32bit absolute current time expressed in internal time units. | |
Last_State_Slot | 1 | Slot number of completed radio event | |
Next_State_Slot | 1 | Slot number of incoming radio event |
This event is reported to the application after a scan request is received and a scan response is scheduled to be transmitted.
Note: RSSI in this event is valid only when privacy is not used.
Parameter | Size | Description | Possible values |
---|---|---|---|
RSSI | 1 | RSSI (signed integer). Units: dBm. | |
Peer_Address_Type | 1 | Address type 0x00 Public Device Address 0x01 Random Device Address 0x02 Public Identity Address (Corresponds to Resolved Private Address) 0x03 Random (Static) Identity Address (Corresponds to Resolved Private Address) | |
Peer_Address | 6 | Public Device Address or Random Device Address of the peer device |
This event is generated to report firmware error information.
Parameter | Size | Description | Possible values |
---|---|---|---|
FW_Error_Type | 1 | FW Error type | |
Data_Length | 1 | Length of Data in octets | |
Data | Data_Length | The error event info |
This event is generated after the execution of CIG or BIG is completed on hardware.
Parameter | Size | Description | Possible values |
---|---|---|---|
Group_Id | 1 | Identifier of the CIG or BIG. | |
Next_Anchor_Point | 4 | Timestamp of the next ISO anchor point | |
Time_Stamp | 4 | Timestamp of the calibration signal | |
Next_Sdu_Delivery_Timeout | 4 | Timestamp before which the SDU must be provided to the LL for being handled in the next ISO event |
Status error codes are used for the return status of all commands. Only the codes from 0 to 0x45 are used for HCI commands (see Bluetooth spec. v.5.4 [Vol 1, Part F]), while more codes are defined for ACI commands (see table below).
Status error code | Description |
---|---|
0x00 | Success |
0x01 | Unknown HCI Command |
0x02 | Unknown Connection Identifier |
0x03 | Hardware Failure |
0x05 | Authentication Failure |
0x06 | PIN or Key Missing |
0x07 | Memory Capacity Exceeded |
0x08 | Connection Timeout |
0x09 | Connection Limit Exceeded |
0x0B | ACL Connection Already Exists |
0x0C | Command Disallowed |
0x11 | Unsupported Feature Or Parameter Value |
0x12 | Invalid HCI Command Parameters |
0x13 | Remote User Terminated Connection |
0x14 | Remote Device Terminated Connection due to Low Resources |
0x15 | Remote Device Terminated Connection due to Power Off |
0x16 | Connection Terminated By Local Host |
0x1A | Unsupported Remote Feature |
0x1E | Invalid LL Parameters |
0x1F | Unspecified Error |
0x22 | LL Response Timeout |
0x23 | LL Procedure Collision |
0x24 | LMP PDU Not Allowed |
0x28 | Instant Passed |
0x2A | Different Transaction Collision |
0x2E | Channel Assessment Not Supported |
0x2F | Insufficient Security |
0x30 | Parameter Out Of Mandatory Range |
0x38 | Host Busy - Pairing |
0x3A | Controller Busy |
0x3B | Unacceptable Connection Parameters |
0x3C | Directed Advertising Timeout |
0x3D | Connection Terminated Due to MIC Failure |
0x3E | Connection Failed to be Established |
0x42 | Unknown Advertising Identifier |
0x43 | Limit Reached |
0x45 | Packet Too Long |
0x59 | Device in blacklist |
0x5A | CSRK not found |
0x5B | IRK not found |
0x5C | Device not found in DB |
0x5D | Security DB full |
0x5E | Device not bonded |
0x5F | Insufficient encryption key size |
0x60 | Invalid handle |
0x61 | Out of handles |
0x62 | Invalid operation |
0x63 | Characteristic already exist |
0x64 | Insufficient resources |
0x65 | Security permission error |
0x70 | Address not resolved |
0x82 | No valid slot |
0x83 | Short window |
0x84 | New interval failed |
0x85 | Too large interval |
0x86 | Slot length failed |
0x91 | Failed |
0x92 | Invalid parameters |
0x93 | Busy |
0x95 | Pending |
0x97 | Host error |
0x98 | Out of memory |
The following table gives the values in dBm corresponding to the possible values of PA_Level parameter from ACI_HAL_SET_TX_POWER_LEVEL. Output power is indicative and depends on the PCB layout and associated components. Here the values are given at the STM32WBA output
PA_Level | Output power |
---|---|
0x00 | -20.4 dBm |
0x01 | -20.4 dBm |
0x02 | -20.4 dBm |
0x03 | -20.4 dBm |
0x04 | -20.4 dBm |
0x05 | -20.4 dBm |
0x06 | -19.4 dBm |
0x07 | -18.3 dBm |
0x08 | -17.3 dBm |
0x09 | -16.4 dBm |
0x0A | -15.4 dBm |
0x0B | -14.3 dBm |
0x0C | -13.3 dBm |
0x0D | -12.3 dBm |
0x0E | -11.4 dBm |
0x0F | -10.4 dBm |
0x10 | -9.5 dBm |
0x11 | -8.4 dBm |
0x12 | -7.5 dBm |
0x13 | -6.5 dBm |
0x14 | -5.4 dBm |
0x15 | -4.5 dBm |
0x16 | -3.5 dBm |
0x17 | -2.4 dBm |
0x18 | -1.5 dBm |
0x19 | -0.3 dBm |
0x1A | +0.9 dBm |
0x1B | +2.3 dBm |
0x1C | +2.8 dBm |
0x1D | +3.9 dBm |
0x1E | +4.8 dBm |
0x1F | +5.6 dBm |
0x20 | +6.9 dBm |
0x21 | +7.5 dBm |
0x22 | +8.5 dBm |
0x23 | +10 dBm |
Other values are reserved.