STM32WBA BLE Wireless Interface

This document specifies the commands and events that constitute the Application Command Interface (ACI) and Host Controller Interface (HCI) of the Bluetooth® LE Host and Controller protocol stack (BLE stack) dedicated to the STM32WBA wireless microcontroller.

Notes:
- In this document, the term "Core Specification" refers to the Bluetooth Core Specification Version 6.1.
- ACI commands and events follow the HCI data formats as defined in the Core Specification [Vol 4, Part E, 5], using HCI vendor-specific codes.

See also:

STM32WBA Series website

STM32WBA BLE stack software integration wiki page

Guidelines for BLE stack programming on STM32WB/STM32WBA MCUs

Contents

HCI/ACI commands

HCI/ACI events

Annex

Revision history

HCI/ACI commands

HCI commands

HCI Test commands

ACI General commands

ACI GAP commands

ACI GATT/ATT commands

ACI L2CAP commands

ACI HAL commands

Note: in the command tables, a "Y" in the "BP", "BF", "PO" or "LO" column, means that the corresponding command applies to the "Basic Plus", "Basic Features", "Peripheral Only" or "Link Layer Only" variant of the BLE stack, respectively.

HCI commands

CommandOpcodeBPBFPOLO
HCI_DISCONNECT

0x0406

Y

HCI_READ_REMOTE_VERSION_INFORMATION

0x041D

Y

Y

Y

Y

HCI_SET_EVENT_MASK

0x0C01

Y

Y

Y

Y

HCI_RESET

0x0C03

Y

Y

Y

Y

HCI_READ_CONNECTION_ACCEPT_TIMEOUT

0x0C15

Y

HCI_WRITE_CONNECTION_ACCEPT_TIMEOUT

0x0C16

Y

HCI_READ_TRANSMIT_POWER_LEVEL

0x0C2D

Y

Y

Y

Y

HCI_SET_CONTROLLER_TO_HOST_FLOW_CONTROL

0x0C31

Y

HCI_HOST_BUFFER_SIZE

0x0C33

Y

HCI_HOST_NUMBER_OF_COMPLETED_PACKETS

0x0C35

Y

HCI_READ_AFH_CHANNEL_ASSESSMENT_MODE

0x0C48

Y

HCI_WRITE_AFH_CHANNEL_ASSESSMENT_MODE

0x0C49

Y

HCI_SET_EVENT_MASK_PAGE_2

0x0C63

Y

HCI_READ_AUTHENTICATED_PAYLOAD_TIMEOUT

0x0C7B

Y

Y

HCI_WRITE_AUTHENTICATED_PAYLOAD_TIMEOUT

0x0C7C

Y

Y

HCI_SET_ECOSYSTEM_BASE_INTERVAL

0x0C82

Y

HCI_CONFIGURE_DATA_PATH

0x0C83

Y

HCI_READ_LOCAL_VERSION_INFORMATION

0x1001

Y

Y

Y

Y

HCI_READ_LOCAL_SUPPORTED_COMMANDS

0x1002

Y

HCI_READ_LOCAL_SUPPORTED_FEATURES

0x1003

Y

HCI_READ_BD_ADDR

0x1009

Y

Y

Y

Y

HCI_READ_LOCAL_SUPPORTED_CODECS_V2

0x100D

Y

HCI_READ_LOCAL_SUPPORTED_CODEC_CAPABILITIES

0x100E

Y

HCI_READ_LOCAL_SUPPORTED_CONTROLLER_DELAY

0x100F

Y

HCI_READ_RSSI

0x1405

Y

Y

Y

Y

HCI_LE_SET_EVENT_MASK

0x2001

Y

Y

Y

Y

HCI_LE_READ_BUFFER_SIZE

0x2002

Y

HCI_LE_READ_LOCAL_SUPPORTED_FEATURES_PAGE_0

0x2003

Y

HCI_LE_SET_RANDOM_ADDRESS

0x2005

Y

HCI_LE_SET_ADVERTISING_PARAMETERS

0x2006

Y

HCI_LE_READ_ADVERTISING_PHYSICAL_CHANNEL_TX_POWER

0x2007

Y

HCI_LE_SET_ADVERTISING_DATA

0x2008

Y

Y

Y

Y

HCI_LE_SET_SCAN_RESPONSE_DATA

0x2009

Y

Y

Y

Y

HCI_LE_SET_ADVERTISING_ENABLE

0x200A

Y

HCI_LE_SET_SCAN_PARAMETERS

0x200B

Y

HCI_LE_SET_SCAN_ENABLE

0x200C

Y

HCI_LE_CREATE_CONNECTION

0x200D

Y

HCI_LE_CREATE_CONNECTION_CANCEL

0x200E

Y

HCI_LE_READ_FILTER_ACCEPT_LIST_SIZE

0x200F

Y

HCI_LE_CLEAR_FILTER_ACCEPT_LIST

0x2010

Y

HCI_LE_ADD_DEVICE_TO_FILTER_ACCEPT_LIST

0x2011

Y

HCI_LE_REMOVE_DEVICE_FROM_FILTER_ACCEPT_LIST

0x2012

Y

HCI_LE_CONNECTION_UPDATE

0x2013

Y

HCI_LE_SET_HOST_CHANNEL_CLASSIFICATION

0x2014

Y

Y

Y

HCI_LE_READ_CHANNEL_MAP

0x2015

Y

Y

Y

Y

HCI_LE_READ_REMOTE_FEATURES_PAGE_0

0x2016

Y

Y

Y

Y

HCI_LE_ENCRYPT

0x2017

Y

Y

Y

Y

HCI_LE_RAND

0x2018

Y

Y

Y

Y

HCI_LE_ENABLE_ENCRYPTION

0x2019

Y

HCI_LE_LONG_TERM_KEY_REQUEST_REPLY

0x201A

Y

Y

Y

Y

HCI_LE_LONG_TERM_KEY_REQUEST_NEGATIVE_REPLY

0x201B

Y

Y

Y

Y

HCI_LE_READ_SUPPORTED_STATES

0x201C

Y

HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_REPLY

0x2020

Y

Y

Y

Y

HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_NEGATIVE_REPLY

0x2021

Y

Y

Y

Y

HCI_LE_SET_DATA_LENGTH

0x2022

Y

Y

Y

Y

HCI_LE_READ_SUGGESTED_DEFAULT_DATA_LENGTH

0x2023

Y

Y

Y

Y

HCI_LE_WRITE_SUGGESTED_DEFAULT_DATA_LENGTH

0x2024

Y

Y

Y

Y

HCI_LE_READ_LOCAL_P256_PUBLIC_KEY

0x2025

Y

Y

Y

Y

HCI_LE_GENERATE_DHKEY

0x2026

Y

Y

Y

Y

HCI_LE_ADD_DEVICE_TO_RESOLVING_LIST

0x2027

Y

HCI_LE_REMOVE_DEVICE_FROM_RESOLVING_LIST

0x2028

Y

HCI_LE_CLEAR_RESOLVING_LIST

0x2029

Y

HCI_LE_READ_RESOLVING_LIST_SIZE

0x202A

Y

HCI_LE_READ_PEER_RESOLVABLE_ADDRESS

0x202B

Y

Y

Y

Y

HCI_LE_READ_LOCAL_RESOLVABLE_ADDRESS

0x202C

Y

Y

Y

Y

HCI_LE_SET_ADDRESS_RESOLUTION_ENABLE

0x202D

Y

HCI_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT

0x202E

Y

Y

Y

Y

HCI_LE_READ_MAXIMUM_DATA_LENGTH

0x202F

Y

Y

Y

Y

HCI_LE_READ_PHY

0x2030

Y

Y

Y

Y

HCI_LE_SET_DEFAULT_PHY

0x2031

Y

Y

Y

Y

HCI_LE_SET_PHY

0x2032

Y

Y

Y

Y

HCI_LE_SET_ADVERTISING_SET_RANDOM_ADDRESS

0x2035

Y

HCI_LE_SET_EXTENDED_ADVERTISING_PARAMETERS

0x2036

Y

HCI_LE_SET_EXTENDED_ADVERTISING_DATA

0x2037

Y

HCI_LE_SET_EXTENDED_SCAN_RESPONSE_DATA

0x2038

Y

HCI_LE_SET_EXTENDED_ADVERTISING_ENABLE

0x2039

Y

HCI_LE_READ_MAXIMUM_ADVERTISING_DATA_LENGTH

0x203A

Y

Y

HCI_LE_READ_NUMBER_OF_SUPPORTED_ADVERTISING_SETS

0x203B

Y

Y

HCI_LE_REMOVE_ADVERTISING_SET

0x203C

Y

HCI_LE_CLEAR_ADVERTISING_SETS

0x203D

Y

HCI_LE_SET_PERIODIC_ADVERTISING_PARAMETERS

0x203E

Y

HCI_LE_SET_PERIODIC_ADVERTISING_DATA

0x203F

Y

HCI_LE_SET_PERIODIC_ADVERTISING_ENABLE

0x2040

Y

HCI_LE_SET_EXTENDED_SCAN_PARAMETERS

0x2041

Y

HCI_LE_SET_EXTENDED_SCAN_ENABLE

0x2042

Y

HCI_LE_EXTENDED_CREATE_CONNECTION

0x2043

Y

HCI_LE_PERIODIC_ADVERTISING_CREATE_SYNC

0x2044

Y

HCI_LE_PERIODIC_ADVERTISING_CREATE_SYNC_CANCEL

0x2045

Y

HCI_LE_PERIODIC_ADVERTISING_TERMINATE_SYNC

0x2046

Y

HCI_LE_ADD_DEVICE_TO_PERIODIC_ADVERTISER_LIST

0x2047

Y

HCI_LE_REMOVE_DEVICE_FROM_PERIODIC_ADVERTISER_LIST

0x2048

Y

HCI_LE_CLEAR_PERIODIC_ADVERTISER_LIST

0x2049

Y

HCI_LE_READ_PERIODIC_ADVERTISER_LIST_SIZE

0x204A

Y

HCI_LE_READ_TRANSMIT_POWER

0x204B

Y

HCI_LE_READ_RF_PATH_COMPENSATION

0x204C

Y

HCI_LE_WRITE_RF_PATH_COMPENSATION

0x204D

Y

HCI_LE_SET_PRIVACY_MODE

0x204E

Y

Y

Y

Y

HCI_LE_SET_CONNECTIONLESS_CTE_TRANSMIT_PARAMETERS

0x2051

Y

HCI_LE_SET_CONNECTIONLESS_CTE_TRANSMIT_ENABLE

0x2052

Y

HCI_LE_SET_CONNECTIONLESS_IQ_SAMPLING_ENABLE

0x2053

Y

HCI_LE_SET_CONNECTION_CTE_RECEIVE_PARAMETERS

0x2054

Y

HCI_LE_SET_CONNECTION_CTE_TRANSMIT_PARAMETERS

0x2055

Y

HCI_LE_CONNECTION_CTE_REQUEST_ENABLE

0x2056

Y

HCI_LE_CONNECTION_CTE_RESPONSE_ENABLE

0x2057

Y

HCI_LE_READ_ANTENNA_INFORMATION

0x2058

Y

HCI_LE_SET_PERIODIC_ADVERTISING_RECEIVE_ENABLE

0x2059

Y

HCI_LE_PERIODIC_ADVERTISING_SYNC_TRANSFER

0x205A

Y

HCI_LE_PERIODIC_ADVERTISING_SET_INFO_TRANSFER

0x205B

Y

HCI_LE_SET_PERIODIC_ADVERTISING_SYNC_TRANSFER_PARAMETERS

0x205C

Y

HCI_LE_SET_DEFAULT_PERIODIC_ADVERTISING_SYNC_TRANSFER_PARAMETERS

0x205D

Y

HCI_LE_GENERATE_DHKEY_V2

0x205E

Y

HCI_LE_READ_BUFFER_SIZE_V2

0x2060

Y

HCI_LE_READ_ISO_TX_SYNC

0x2061

Y

HCI_LE_SET_CIG_PARAMETERS

0x2062

Y

HCI_LE_SET_CIG_PARAMETERS_TEST

0x2063

Y

HCI_LE_CREATE_CIS

0x2064

Y

HCI_LE_REMOVE_CIG

0x2065

Y

HCI_LE_ACCEPT_CIS_REQUEST

0x2066

Y

HCI_LE_REJECT_CIS_REQUEST

0x2067

Y

HCI_LE_CREATE_BIG

0x2068

Y

HCI_LE_CREATE_BIG_TEST

0x2069

Y

HCI_LE_TERMINATE_BIG

0x206A

Y

HCI_LE_BIG_CREATE_SYNC

0x206B

Y

HCI_LE_BIG_TERMINATE_SYNC

0x206C

Y

HCI_LE_REQUEST_PEER_SCA

0x206D

Y

HCI_LE_SETUP_ISO_DATA_PATH

0x206E

Y

HCI_LE_REMOVE_ISO_DATA_PATH

0x206F

Y

HCI_LE_SET_HOST_FEATURE

0x2074

Y

Y

HCI_LE_READ_ISO_LINK_QUALITY

0x2075

Y

HCI_LE_ENHANCED_READ_TRANSMIT_POWER_LEVEL

0x2076

Y

Y

HCI_LE_READ_REMOTE_TRANSMIT_POWER_LEVEL

0x2077

Y

Y

HCI_LE_SET_PATH_LOSS_REPORTING_PARAMETERS

0x2078

Y

Y

HCI_LE_SET_PATH_LOSS_REPORTING_ENABLE

0x2079

Y

Y

HCI_LE_SET_TRANSMIT_POWER_REPORTING_ENABLE

0x207A

Y

Y

HCI_LE_SET_DATA_RELATED_ADDRESS_CHANGES

0x207C

Y

Y

HCI_LE_SET_DEFAULT_SUBRATE

0x207D

Y

Y

HCI_LE_SUBRATE_REQUEST

0x207E

Y

Y

HCI_LE_SET_EXTENDED_ADVERTISING_PARAMETERS_V2

0x207F

Y

HCI_LE_SET_PERIODIC_ADVERTISING_SUBEVENT_DATA

0x2082

Y

HCI_LE_SET_PERIODIC_ADVERTISING_RESPONSE_DATA

0x2083

Y

HCI_LE_SET_PERIODIC_SYNC_SUBEVENT

0x2084

Y

HCI_LE_EXTENDED_CREATE_CONNECTION_V2

0x2085

Y

HCI_LE_SET_PERIODIC_ADVERTISING_PARAMETERS_V2

0x2086

Y

HCI_LE_READ_ALL_LOCAL_SUPPORTED_FEATURES

0x2087

Y

HCI_LE_READ_ALL_REMOTE_FEATURES

0x2088

Y

HCI_LE_CS_READ_LOCAL_SUPPORTED_CAPABILITIES

0x2089

Y

HCI_LE_CS_READ_REMOTE_SUPPORTED_CAPABILITIES

0x208A

Y

HCI_LE_CS_WRITE_CACHED_REMOTE_SUPPORTED_CAPABILITIES

0x208B

Y

HCI_LE_CS_SECURITY_ENABLE

0x208C

Y

HCI_LE_CS_SET_DEFAULT_SETTINGS

0x208D

Y

HCI_LE_CS_READ_REMOTE_FAE_TABLE

0x208E

Y

HCI_LE_CS_WRITE_CACHED_REMOTE_FAE_TABLE

0x208F

Y

HCI_LE_CS_CREATE_CONFIG

0x2090

Y

HCI_LE_CS_REMOVE_CONFIG

0x2091

Y

HCI_LE_CS_SET_CHANNEL_CLASSIFICATION

0x2092

Y

HCI_LE_CS_SET_PROCEDURE_PARAMETERS

0x2093

Y

HCI_LE_CS_PROCEDURE_ENABLE

0x2094

Y

HCI_LE_ADD_DEVICE_TO_MONITORED_ADVERTISERS_LIST

0x2098

Y

HCI_LE_REMOVE_DEVICE_FROM_MONITORED_ADVERTISERS_LIST

0x2099

Y

HCI_LE_CLEAR_MONITORED_ADVERTISERS_LIST

0x209A

Y

HCI_LE_READ_MONITORED_ADVERTISERS_LIST_SIZE

0x209B

Y

HCI_LE_ENABLE_MONITORING_ADVERTISERS

0x209C

Y

HCI_LE_FRAME_SPACE_UPDATE

0x209D

Y

HCI_DISCONNECT

Description

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 Core Specification [Vol 4, Part E, 7.1.6].

Input parameters

ParameterSizeDescriptionPossible values

Connection_Handle

2

Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Reason

    1

    The reason for ending the connection.

  • 0x05: Authentication Failure
  • 0x13: Remote User Terminated Connection
  • 0x14: Remote Device Terminated Connection due to Low Resources
  • 0x15: Remote Device Terminated Connection due to Power Off
  • 0x1A: Unsupported Remote Feature
  • 0x3B: Unacceptable Connection Parameters

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_DISCONNECTION_COMPLETE_EVENT

    • HCI_READ_REMOTE_VERSION_INFORMATION

    Description

    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 Core Specification [Vol 4, Part E, 7.1.23].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_READ_REMOTE_VERSION_INFORMATION_COMPLETE_EVENT

    • HCI_SET_EVENT_MASK

    Description

    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 Core Specification [Vol 4, Part E, 7.3.1].

    Input parameters

    ParameterSizeDescriptionPossible values

    Event_Mask

    8

    Event mask. Default: 0x2000FFFFFFFFFFFF

    Bitmask of:

  • 0x0000000000000000: No events specified
  • 0x0000000000000010: Disconnection Complete Event
  • 0x0000000000000080: Encryption Change Event
  • 0x0000000000000800: Read Remote Version Information Complete Event
  • 0x0000000000008000: Hardware Error Event
  • 0x0000000002000000: Data Buffer Overflow Event
  • 0x0000800000000000: Encryption Key Refresh Complete Event
  • 0x2000000000000000: LE Meta-Event

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_RESET

    Description

    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 Core Specification [Vol 4, Part E, 7.3.2].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_CONNECTION_ACCEPT_TIMEOUT

    Description

    This command reads the value for the Connection Accept Timeout configuration parameter.
    See Core Specification [Vol 4, Part E, 7.3.13].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Accept_Timeout

    2

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_WRITE_CONNECTION_ACCEPT_TIMEOUT

    Description

    This command writes the value for the Connection Accept Timeout configuration parameter.
    See Core Specification [Vol 4, Part E, 7.3.14].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Accept_Timeout

    2

    Connection Accept Timeout measured in number of baseband slots. Interval Length = N * 0.625 ms.

  • 0x00A0 (100.000 ms) ... 0xB540 (29000.000 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_TRANSMIT_POWER_LEVEL

    Description

    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 Core Specification [Vol 4, Part E, 7.3.35].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Type

    1

    Current or maximum transmit power level.

  • 0x00: Read Current Transmit Power Level.
  • 0x01: Read Maximum Transmit Power Level.

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Transmit_Power_Level

    1

    Size: 1 Octet (signed integer). Units: dBm.

  • -30 ... 20

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_SET_CONTROLLER_TO_HOST_FLOW_CONTROL

    Description

    This command is used by the Host to turn flow control on or off for ACL data sent in the direction from the Controller to the Host.
    The Flow_Control_Enable parameter shall only be changed if no connections exist.
    See Core Specification [Vol 4, Part E, 7.3.38].

    Input parameters

    ParameterSizeDescriptionPossible values

    Flow_Control_Enable

    1

    Enable/Disable the Flow Control

  • 0x00: Flow control off in direction from Controller to Host. Default.
  • 0x01: Flow control on for HCI ACL Data Packets and off for HCI synchronous.Data Packets in direction from Controller to Host.
  • 0x02: Flow control off for HCI ACL Data Packets and on for HCI synchronous.Data Packets in direction from Controller to Host. Not supported.
  • 0x03: Flow control on both for HCI ACL Data Packets and HCI synchronous.Data Packets in direction from Controller to Host. Not supported.

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_HOST_BUFFER_SIZE

    Description

    This command notifies the Controller about the total number of HCI ACL 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 this command has not been issued by the Host, 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, this command shall after a power-on or a reset always be sent by the Host before the first HCI_HOST_NUMBER_OF_COMPLETED_PACKETS command is sent.
    The HCI_SET_CONTROLLER_TO_HOST_FLOW_CONTROL command is used to turn flow control on or off.
    The Host_ACL_Data_Packet_Length 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. 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 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_Synchronous_Data_Packet_Length and Host_Total_Num_Synchronous_Data_Packets parameters are not used.
    Note: The Host_ACL_Data_Packet_Length parameter does not include the length of the HCI Data Packet header.
    See Core Specification [Vol 4, Part E, 7.3.39].

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 251 ... 65535

    • 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.

  • 1 ... 65535

    • 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_HOST_NUMBER_OF_COMPLETED_PACKETS

    Description

    This 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 HCI_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 parameter of the HCI_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. 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 HCI_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.
    Note: This 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 independent of other commands. The normal flow control for commands is not used for this command.
    See Core Specification [Vol 4, Part E, 7.3.40].

    Input parameters

    ParameterSizeDescriptionPossible 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

    Output parameters

    None

    Events generated

    Normally, no event is generated after this command has completed. However, if this command contains one or more invalid parameters, the Controller returns a Command Complete event with a failure status indicating the Invalid HCI Command Parameters error code.

    HCI_READ_AFH_CHANNEL_ASSESSMENT_MODE

    Description

    This command reads the value for the AFH_Channel_Assessment_Mode parameter. The AFH_Channel_Assessment_Mode parameter controls whether the Controller's channel assessment scheme is enabled or disabled.
    See Core Specification [Vol 4, Part E, 7.3.53].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    AFH_Channel_Assessment_Mode

    1

    Controller channel assessment enable/disable.

  • 0x00: Controller channel assessment disabled
  • 0x01: Controller channel assessment enabled

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_WRITE_AFH_CHANNEL_ASSESSMENT_MODE

    Description

    This command writes the value for the AFH_Channel_Assessment_Mode parameter. The AFH_Channel_Assessment_Mode parameter controls whether the Controller's channel assessment scheme is enabled or disabled.
    See Core Specification [Vol 4, Part E, 7.3.54].

    Input parameters

    ParameterSizeDescriptionPossible values

    AFH_Channel_Assessment_Mode

    1

    Controller channel assessment enable/disable.

  • 0x00: Controller channel assessment disabled
  • 0x01: Controller channel assessment enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_SET_EVENT_MASK_PAGE_2

    Description

    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 Core Specification [Vol 4, Part E, 7.3.69].

    Input parameters

    ParameterSizeDescriptionPossible values

    Event_Mask_Page_2

    8

    Event mask page 2. Default: 0

    Bitmask of:

  • 0x0000000000800000: Authenticated Payload Timeout Expired event

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_AUTHENTICATED_PAYLOAD_TIMEOUT

    Description

    This command reads the Authenticated_Payload_Timeout parameter in the Controller on the specified Connection_Handle.
    See Core Specification [Vol 4, Part E, 7.3.93].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Authenticated_Payload_Timeout

    2

    Maximum amount of time specified between packets authenticated by a valid MIC. Time = N * 10 ms

  • 0x0001 (10 ms) ... 0xFFFF (655350 ms)

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_WRITE_AUTHENTICATED_PAYLOAD_TIMEOUT

    Description

    This command writes the Authenticated_Payload_Timeout parameter in the Controller for the specified Connection_Handle.
    See Core Specification [Vol 4, Part E, 7.3.94].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Authenticated_Payload_Timeout

    2

    Maximum amount of time specified between packets authenticated by a valid MIC. Time = N * 10 ms

  • 0x0001 (10 ms) ... 0xFFFF (655350 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_SET_ECOSYSTEM_BASE_INTERVAL

    Description

    This command provides a hint to the Controller specifying the base communication interval the Controller can expect current and future communications to use.
    See Core Specification [Vol 4, Part E, 7.3.100].

    Input parameters

    ParameterSizeDescriptionPossible values

    Interval

    2

    Hint for the base interval of the ecosystem. Time = N * 1.25 ms

  • 0x0000 (NaN) : Ignore any previous hint
  • 0x0002 (2.50 ms) ... 0x7DF0 (40300.00 ms) : Base interval of the ecosystem

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_CONFIGURE_DATA_PATH

    Description

    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 Core Specification [Vol 4, Part E, 7.3.101].

    Input parameters

    ParameterSizeDescriptionPossible values

    Data_Path_Direction

    1

    Data path direction.

  • 0x00: Input (Host to Controller)
  • 0x01: Output (Controller to Host)

    • Data_Path_ID

    1

    Data path identifier.

  • 0x01 ... 0xFE: Logical channel number; the meaning is vendor-specific.

    • 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_LOCAL_VERSION_INFORMATION

    Description

    This command reads the values for the version information for the local Controller.
    See Core Specification [Vol 4, Part E, 7.4.1].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    HCI_Version

    1

    Version of the HCI Specification supported by the Controller. See Bluetooth Assigned Numbers.

    HCI_Subversion

    2

    Revision of the HCI implementation in the Controller. This value is vendor-specific. This parameter gives the BLE stack reduced version number.

    LMP_Version

    1

    Version of the Current LMP supported by the Controller. See Bluetooth Assigned Numbers.

    Company_Identifier

    2

    Company identifier for the manufacturer of the Controller. See Bluetooth Assigned Numbers.

  • 0x0030: STMicroelectronics

    • LMP_Subversion

    2

    Subversion of the Current LMP in the Controller. This value is vendor-specific. The most significant byte gives the LL HW version. The least significant byte gives the LL FW version.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_LOCAL_SUPPORTED_COMMANDS

    Description

    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 Core Specification [Vol 4, Part E, 7.4.2].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible 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.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_LOCAL_SUPPORTED_FEATURES

    Description

    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 Core Specification [Vol 4, Part E, 7.4.3].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    LMP_Features

    8

    Bit Mask List of LMP features.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_BD_ADDR

    Description

    On an LE Controller, this command shall read the Public Device Address.
    See Core Specification [Vol 4, Part E, 7.4.6].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    BD_ADDR

    6

    BD_ADDR (Bluetooth Device Address) of the device.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_LOCAL_SUPPORTED_CODECS_V2

    Description

    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 Core Specification [Vol 4, Part E, 7.4.8].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible 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

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_LOCAL_SUPPORTED_CODEC_CAPABILITIES

    Description

    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 Core Specification [Vol 4, Part E, 7.4.10].

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x02: LE CIS
  • 0x03: LE BIS

    • Direction

    1

    Codec direction.

  • 0x00: Input (Host to Controller)
  • 0x01: Output (Controller to Host)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Num_Codec_Capabilities

    1

    Codec_Capabilities

    250

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_LOCAL_SUPPORTED_CONTROLLER_DELAY

    Description

    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 Core Specification [Vol 4, Part E, 7.4.11].

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x02: LE CIS
  • 0x03: LE BIS

    • Direction

    1

    Codec direction.

  • 0x00: Input (Host to Controller)
  • 0x01: Output (Controller to Host)

    • Codec_Configuration_Length

    1

    Length of Codec_Configuration in octets

    Codec_Configuration

    Codec_Configuration_Length

    Codec-specific configuration data.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Min_Controller_Delay

    3

    Minimum Controller delay in us.

  • 0 ... 4000000

    • Max_Controller_Delay

    3

    Maximum Controller delay in us.

  • 0 ... 4000000

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_READ_RSSI

    Description

    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 Core Specification [Vol 4, Part E, 7.5.4].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • RSSI

    1

    RSSI (signed integer). Units: dBm.

  • 127: RSSI not available
  • -127 ... 20

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_EVENT_MASK

    Description

    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 Core Specification [Vol 4, Part E, 7.8.1].

    Input parameters

    ParameterSizeDescriptionPossible values

    LE_Event_Mask

    8

    LE event mask. Default: 0x000000C7FFF7F85F. Note that the BLE stack ignores the bits which represent events it does not support (according to its variant).

    Bitmask of:

  • 0x0000000000000000: No LE events specified
  • 0x0000000000000001: LE Connection Complete event
  • 0x0000000000000002: LE Advertising Report event
  • 0x0000000000000004: LE Connection Update Complete event
  • 0x0000000000000008: LE Read Remote Features Complete event
  • 0x0000000000000010: LE Long Term Key Request event
  • 0x0000000000000020: LE Remote Connection Parameter Request event
  • 0x0000000000000040: LE Data Length Change event
  • 0x0000000000000080: LE Read Local P-256 Public Key Complete event
  • 0x0000000000000100: LE Generate DHKey Complete event
  • 0x0000000000000200: LE Enhanced Connection Complete event
  • 0x0000000000000400: LE Directed Advertising Report event
  • 0x0000000000000800: LE PHY Update Complete event
  • 0x0000000000001000: LE Extended Advertising Report event
  • 0x0000000000002000: LE Periodic Advertising Sync Established event
  • 0x0000000000004000: LE Periodic Advertising Report event
  • 0x0000000000008000: LE Periodic Advertising Sync Lost event
  • 0x0000000000010000: LE Scan Timeout event
  • 0x0000000000020000: LE Advertising Set Terminated event
  • 0x0000000000040000: LE Scan Request Received event
  • 0x0000000000080000: LE Channel Selection Algorithm event
  • 0x0000000000100000: LE Connectionless IQ Report event
  • 0x0000000000200000: LE Connection IQ Report event
  • 0x0000000000400000: LE CTE Request Failed event
  • 0x0000000000800000: LE Periodic Advertising Sync Transfer Received event
  • 0x0000000001000000: LE CIS Established event
  • 0x0000000002000000: LE CIS Request event
  • 0x0000000004000000: LE Create BIG Complete event
  • 0x0000000008000000: LE Terminate BIG Complete event
  • 0x0000000010000000: LE BIG Sync Established event
  • 0x0000000020000000: LE BIG Sync Lost event
  • 0x0000000040000000: LE Request Peer SCA Complete event
  • 0x0000000080000000: LE Path Loss Threshold event
  • 0x0000000100000000: LE Transmit Power Reporting event
  • 0x0000000200000000: LE BIGInfo Advertising Report event
  • 0x0000000400000000: LE Subrate Change event
  • 0x0000000800000000: LE Periodic Advertising Sync Established event [v2]
  • 0x0000001000000000: LE Periodic Advertising Report event [v2]
  • 0x0000002000000000: LE Periodic Advertising Sync Transfer Received event [v2]
  • 0x0000004000000000: LE Periodic Advertising Subevent Data Request event
  • 0x0000008000000000: LE Periodic Advertising Response Report event
  • 0x0000010000000000: LE Enhanced Connection Complete event [v2]
  • 0x0000020000000000: LE CIS Established event [v2]
  • 0x0000040000000000: LE Read All Remote Features Complete event
  • 0x0000080000000000: LE CS Read Remote Supported Capabilities Complete event
  • 0x0000100000000000: LE CS Read Remote FAE Table Complete event
  • 0x0000200000000000: LE CS Security Enable Complete event
  • 0x0000400000000000: LE CS Config Complete event
  • 0x0000800000000000: LE CS Procedure Enable Complete event
  • 0x0001000000000000: LE CS Subevent Result event
  • 0x0002000000000000: LE CS Subevent Result Continue event
  • 0x0004000000000000: LE CS Test End Complete event
  • 0x0008000000000000: LE Monitored Advertisers Report event
  • 0x0010000000000000: LE Frame Space Update Complete event

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_BUFFER_SIZE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.2].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0000: No dedicated LE Buffer exists.
  • 0x001B ... 0x00FF: Maximum length (in octets) of the data portion of each HCI ACL data packet.

    • 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.

  • 0x00: No dedicated LE Buffer exists.
  • 0x01 ... 0xFF: The total number of HCI ACL data packets that can be stored in the data buffers of the Controller.

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_LOCAL_SUPPORTED_FEATURES_PAGE_0

    Description

    This command requests page 0 of the list of the supported LE features for the Controller.
    See Core Specification [Vol 4, Part E, 7.8.3].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    LE_Features

    8

    Bit Mask List of page 0 of the supported LE features. See Core Specification [Vol 6, Part B, 4.6].

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_RANDOM_ADDRESS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.4].

    Input parameters

    ParameterSizeDescriptionPossible values

    Random_Address

    6

    Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_ADVERTISING_PARAMETERS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.5].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Interval_Min

    2

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms)

    • Advertising_Interval_Max

    2

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms)

    • Advertising_Type

    1

    Advertising type.

  • 0x00: ADV_IND (Connectable undirected advertising)
  • 0x01: ADV_DIRECT_IND, high duty cycle (Connectable high duty cycle directed advertising)
  • 0x02: ADV_SCAN_IND (Scannable undirected advertising)
  • 0x03: ADV_NONCONN_IND (Non connectable undirected advertising)
  • 0x04: ADV_DIRECT_IND_LDC, low duty cycle (Connectable low duty cycle directed advertising)

    • Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random Address

    • Peer_Address_Type

    1

    Address type of the peer device.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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:

  • 0x01: Channel 37 shall be used
  • 0x02: Channel 38 shall be used
  • 0x04: Channel 39 shall be used

    • Advertising_Filter_Policy

    1

    Advertising filter policy.

  • 0x00: Allow Scan Request from Any, Allow Connect Request from Any
  • 0x01: Allow Scan Request from Filter Accept List Only, Allow Connect Request from Any
  • 0x02: Allow Scan Request from Any, Allow Connect Request from Filter Accept List Only
  • 0x03: Allow Scan Request from Filter Accept List Only, Allow Connect Request from Filter Accept List Only

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_ADVERTISING_PHYSICAL_CHANNEL_TX_POWER

    Description

    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 Core Specification [Vol 4, Part E, 7.8.6].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Transmit_Power_Level

    1

    Size: 1 Octet (signed integer) Units: dBm Accuracy: +/- 4 dBm

  • -20 ... 10

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_ADVERTISING_DATA

    Description

    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 Core Specification [Vol 4, Part E, 7.8.7].

    Input parameters

    ParameterSizeDescriptionPossible 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_SCAN_RESPONSE_DATA

    Description

    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 Core Specification [Vol 4, Part E, 7.8.8].

    Input parameters

    ParameterSizeDescriptionPossible 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_ADVERTISING_ENABLE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.9].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Enable

    1

    Enable/disable advertising.

  • 0x00: Advertising is disabled
  • 0x01: Advertising is enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_CONNECTION_COMPLETE_EVENT

    • HCI_LE_SET_SCAN_PARAMETERS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.10].

    Input parameters

    ParameterSizeDescriptionPossible values

    LE_Scan_Type

    1

    Passive or active scanning. With passive scanning, no scan request PDUs are sent.

  • 0x00: Passive scanning
  • 0x01: Active scanning

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms)

    • Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random 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.

  • 0x00: Basic unfiltered scanning filter policy
  • 0x01: Basic filtered scanning filter policy
  • 0x02: Extended unfiltered scanning filter policy
  • 0x03: Extended filtered scanning filter policy

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_SCAN_ENABLE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.11].

    Input parameters

    ParameterSizeDescriptionPossible values

    LE_Scan_Enable

    1

    Enable/disable scan.

  • 0x00: Scanning disabled
  • 0x01: Scanning enabled

    • Filter_Duplicates

    1

    Enable/disable duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_ADVERTISING_REPORT_EVENT

    • HCI_LE_CREATE_CONNECTION

    Description

    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 Core Specification [Vol 4, Part E, 7.8.12].

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms)

    • Initiator_Filter_Policy

    1

    Initiator filter policy.

  • 0x00: Filter Accept List is not used to determine which advertiser to connect to
  • 0x01: Filter Accept List is used to determine which advertiser to connect to (Peer_Address_Type and Peer_Address are ignored)

    • Peer_Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Public Identity Address (corresponds to the Resolved Private Address)
  • 0x03: Random (static) Identity Address (corresponds to the 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.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random Address

    • Conn_Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Minimum_CE_Length

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Maximum_CE_Length

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CONNECTION_COMPLETE_EVENT
  • HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT

    • HCI_LE_CREATE_CONNECTION_CANCEL

    Description

    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 Core Specification [Vol 4, Part E, 7.8.13].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_CONNECTION_COMPLETE_EVENT
  • HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT

    • HCI_LE_READ_FILTER_ACCEPT_LIST_SIZE

    Description

    This command is used to read the total number of Filter Accept List entries that can be stored in the Controller.
    See Core Specification [Vol 4, Part E, 7.8.14].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible 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.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CLEAR_FILTER_ACCEPT_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.15].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ADD_DEVICE_TO_FILTER_ACCEPT_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.16].

    Input parameters

    ParameterSizeDescriptionPossible values

    Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0xFF: Devices sending anonymous advertisements

    • Address

    6

    Public Device Address or Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOVE_DEVICE_FROM_FILTER_ACCEPT_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.17].

    Input parameters

    ParameterSizeDescriptionPossible values

    Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0xFF: Devices sending anonymous advertisements

    • Address

    6

    Public Device Address or Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CONNECTION_UPDATE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.18].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Conn_Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Minimum_CE_Length

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Maximum_CE_Length

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CONNECTION_UPDATE_COMPLETE_EVENT

    • HCI_LE_SET_HOST_CHANNEL_CLASSIFICATION

    Description

    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 Core Specification [Vol 4, Part E, 7.8.19].

    Input parameters

    ParameterSizeDescriptionPossible 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_CHANNEL_MAP

    Description

    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 Core Specification [Vol 4, Part E, 7.8.20].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • 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.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_REMOTE_FEATURES_PAGE_0

    Description

    This command requests, from the remote device identified by the Connection_Handle, page 0 of the features used on the connection and the features supported by the remote device.
    This command may be issued on both the Central and Peripheral.
    See Core Specification [Vol 4, Part E, 7.8.21].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_READ_REMOTE_FEATURES_PAGE_0_COMPLETE_EVENT

    • HCI_LE_ENCRYPT

    Description

    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 Core Specification [Vol 4, Part E, 7.8.22].

    Input parameters

    ParameterSizeDescriptionPossible 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Encrypted_Data

    16

    128 bit encrypted data block.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_RAND

    Description

    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 Core Specification [Vol 4, Part E, 7.8.23].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Random_Number

    8

    Random Number

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ENABLE_ENCRYPTION

    Description

    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 Core Specification [Vol 4, Part E, 7.8.24].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Random_Number

    8

    64 bit random number.

    Encrypted_Diversifier

    2

    16 bit encrypted diversifier.

    Long_Term_Key

    16

    128 bit long term key.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_ENCRYPTION_CHANGE_EVENT
  • HCI_ENCRYPTION_KEY_REFRESH_COMPLETE_EVENT

    • HCI_LE_LONG_TERM_KEY_REQUEST_REPLY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.25].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Long_Term_Key

    16

    128 bit long term key.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_LONG_TERM_KEY_REQUEST_NEGATIVE_REPLY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.26].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_SUPPORTED_STATES

    Description

    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 Core Specification [Vol 4, Part E, 7.8.27].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    LE_States

    8

    State or state combination is supported by the Controller.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_REPLY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.31].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Max_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Min_CE_Length

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Max_CE_Length

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_NEGATIVE_REPLY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.32].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Reason

    1

    Reason that the connection parameter request was rejected (see "Status error codes" section)

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_DATA_LENGTH

    Description

    The LE_Set_Data_Length command allows the Host to suggest maximum transmission packet size and maximum packet transmission time (connMaxTxOctets and connMaxTxTime - see Core Specification [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 Core Specification [Vol 4, Part E, 7.8.33].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • TxOctets

    2

    Preferred maximum number of payload octets that the local Controller should include in a single Link Layer packet on this connection.

  • 0x001B ... 0x00FB

    • TxTime

    2

    Preferred maximum number of microseconds that the local Controller should use to transmit a single Link Layer packet on this connection.

  • 0x0148 ... 0x4290

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_SUGGESTED_DEFAULT_DATA_LENGTH

    Description

    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 Core Specification [Vol 4, Part E, 7.8.34].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible 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.

  • 0x001B ... 0x00FB

    • SuggestedMaxTxTime

    2

    The Host's suggested value for the Controller's maximum packet transmission time to be used for new connections.

  • 0x0148 ... 0x4290

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_WRITE_SUGGESTED_DEFAULT_DATA_LENGTH

    Description

    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 Core Specification [Vol 4, Part E, 7.8.35].

    Input parameters

    ParameterSizeDescriptionPossible values

    SuggestedMaxTxOctets

    2

    The Host's suggested value for the Controller's maximum transmitted number of payload octets to be used for new connections.

  • 0x001B ... 0x00FB

    • SuggestedMaxTxTime

    2

    The Host's suggested value for the Controller's maximum packet transmission time to be used for new connections.

  • 0x0148 ... 0x4290

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_LOCAL_P256_PUBLIC_KEY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.36].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE_EVENT

    • HCI_LE_GENERATE_DHKEY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.37].

    Input parameters

    ParameterSizeDescriptionPossible 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_GENERATE_DHKEY_COMPLETE_EVENT

    • HCI_LE_ADD_DEVICE_TO_RESOLVING_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.38].

    Input parameters

    ParameterSizeDescriptionPossible values

    Peer_Identity_Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOVE_DEVICE_FROM_RESOLVING_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.39].

    Input parameters

    ParameterSizeDescriptionPossible values

    Peer_Identity_Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Peer_Identity_Address

    6

    Public or Random (static) Identity Address of the peer device

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CLEAR_RESOLVING_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.40].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_RESOLVING_LIST_SIZE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.41].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Resolving_List_Size

    1

    Number of address translation entries in the resolving list

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_PEER_RESOLVABLE_ADDRESS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.42].

    Input parameters

    ParameterSizeDescriptionPossible values

    Peer_Identity_Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Peer_Identity_Address

    6

    Public or Random (static) Identity Address of the peer device

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Peer_Resolvable_Address

    6

    Resolvable Private Address being used by the peer device

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_LOCAL_RESOLVABLE_ADDRESS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.43].

    Input parameters

    ParameterSizeDescriptionPossible values

    Peer_Identity_Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Peer_Identity_Address

    6

    Public or Random (static) Identity Address of the peer device

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Local_Resolvable_Address

    6

    Resolvable Private Address being used by the local device

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_ADDRESS_RESOLUTION_ENABLE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.44].

    Input parameters

    ParameterSizeDescriptionPossible 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

  • 0x00: Address Resolution in controller disabled (default)
  • 0x01: Address Resolution in controller enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT

    Description

    This command sets 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 resolvable private addresses generated by the Controller.
    See Core Specification [Vol 4, Part E, 7.8.45].

    Input parameters

    ParameterSizeDescriptionPossible values

    RPA_Timeout

    2

    RPA_Timeout in seconds. Time range: 1 s to 1 hour. Default: 0x0384 (900 s or 15 minutes)

  • 0x0001 ... 0x0E10

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_MAXIMUM_DATA_LENGTH

    Description

    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 Core Specification [Vol 4, Part E, 7.8.46].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible 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.

  • 0x001B ... 0x00FB

    • supportedMaxTxTime

    2

    Maximum time, in microseconds, that the local Controller supports for transmission of a single Link Layer packet on a data connection.

  • 0x0148 ... 0x4290

    • supportedMaxRxOctets

    2

    Maximum number of payload octets that the local Controller supports for reception of a single Link Layer packet on a data connection.

  • 0x001B ... 0x00FB

    • supportedMaxRxTime

    2

    Maximum time, in microseconds, that the local Controller supports for reception of a single Link Layer packet on a data connection.

  • 0x0148 ... 0x4290

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_PHY

    Description

    This command is used to read the current transmitter PHY and receiver PHY on the connection identified by the Connection_Handle.
    See Core Specification [Vol 4, Part E, 7.8.47].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • TX_PHY

    1

    Transmitter PHY in use.

  • 0x01: The transmitter PHY for the connection is LE 1M
  • 0x02: The transmitter PHY for the connection is LE 2M
  • 0x03: The transmitter PHY for the connection is LE Coded

    • RX_PHY

    1

    Receiver PHY in use.

  • 0x01: The receiver PHY for the connection is LE 1M
  • 0x02: The receiver PHY for the connection is LE 2M
  • 0x03: The receiver PHY for the connection is LE Coded

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_DEFAULT_PHY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.48].

    Input parameters

    ParameterSizeDescriptionPossible values

    ALL_PHYS

    1

    Preferences for TX PHY and RX PHY.

    Bitmask of:

  • 0x01: The Host has no preference among the transmitter PHYs supported by the Controller
  • 0x02: The Host has no preference among the receiver PHYs supported by the Controller

    • TX_PHYS

    1

    Preferences for TX PHY.

    Bitmask of:

  • 0x01: The Host prefers to use the LE 1M transmitter PHY (possibly among others)
  • 0x02: The Host prefers to use the LE 2M transmitter PHY (possibly among others)
  • 0x04: The Host prefers to use the LE Coded transmitter PHY (possibly among others)

    • RX_PHYS

    1

    Preferences for RX PHY.

    Bitmask of:

  • 0x01: The Host prefers to use the LE 1M receiver PHY (possibly among others)
  • 0x02: The Host prefers to use the LE 2M receiver PHY (possibly among others)
  • 0x04: The Host prefers to use the LE Coded receiver PHY (possibly among others)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PHY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.49].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • ALL_PHYS

    1

    Preferences for TX PHY and RX PHY.

    Bitmask of:

  • 0x01: The Host has no preference among the transmitter PHYs supported by the Controller
  • 0x02: The Host has no preference among the receiver PHYs supported by the Controller

    • TX_PHYS

    1

    Preferences for TX PHY.

    Bitmask of:

  • 0x01: The Host prefers to use the LE 1M transmitter PHY (possibly among others)
  • 0x02: The Host prefers to use the LE 2M transmitter PHY (possibly among others)
  • 0x04: The Host prefers to use the LE Coded transmitter PHY (possibly among others)

    • RX_PHYS

    1

    Preferences for RX PHY.

    Bitmask of:

  • 0x01: The Host prefers to use the LE 1M receiver PHY (possibly among others)
  • 0x02: The Host prefers to use the LE 2M receiver PHY (possibly among others)
  • 0x04: The Host prefers to use the LE Coded receiver PHY (possibly among others)

    • PHY_options

    2

    Bit field used to specify options for PHYs.

  • 0x0000: the Host has no preferred coding when transmitting on the LE Coded PHY
  • 0x0001: the Host prefers that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x0002: the Host prefers that S=8 coding be used when transmitting on the LE Coded PHY

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_PHY_UPDATE_COMPLETE_EVENT

    • HCI_LE_SET_ADVERTISING_SET_RANDOM_ADDRESS

    Description

    This command is used by the Host to set the random device address specified by the Random_Address parameter.
    See Core Specification [Vol 4, Part E, 7.8.52].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Random_Address

    6

    Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_EXTENDED_ADVERTISING_PARAMETERS

    Description

    This command is used by the Host to set the extended advertising parameters.
    See Core Specification [Vol 4, Part E, 7.8.53].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Adv_Event_Properties

    2

    Type of advertising event.

    Bitmask of:

  • 0x0001: Connectable advertising
  • 0x0002: Scannable advertising
  • 0x0004: Directed advertising
  • 0x0008: High Duty Cycle Directed Connectable advertising
  • 0x0010: Use legacy advertising PDUs
  • 0x0020: Anonymous advertising
  • 0x0040: Include TxPower in at least one advertising PDU

    • Primary_Adv_Interval_Min

    3

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x000020 (20.000 ms) ... 0xFFFFFF (10485759.375 ms)

    • Primary_Adv_Interval_Max

    3

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x000020 (20.000 ms) ... 0xFFFFFF (10485759.375 ms)

    • Primary_Adv_Channel_Map

    1

    Advertising channel map.

    Bitmask of:

  • 0x01: Channel 37 shall be used
  • 0x02: Channel 38 shall be used
  • 0x04: Channel 39 shall be used

    • Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random Address

    • Peer_Address_Type

    1

    Address type of the peer device.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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

  • 0x00: Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use)
  • 0x01: Process connection requests from all devices and scan requests only from devices that are in the Filter Accept List.
  • 0x02: Process scan requests from all devices and connection requests only from devices that are in the Filter Accept List.
  • 0x03: Process scan and connection requests only from devices in the Filter Accept List.

    • Adv_TX_Power

    1

    Advertising TX power. Units: dBm.

  • 127: Host has no preference
  • -127 ... 20

    • Primary_Adv_PHY

    1

    Primary advertising PHY.

  • 0x01: Primary advertisement PHY is LE 1M
  • 0x03: Primary advertisement PHY is LE Coded

    • Secondary_Adv_Max_Skip

    1

    Secondary advertising maximum skip.

  • 0x00: AUX_ADV_IND shall be sent prior to the next advertising event
  • 0x01 ... 0xFF: Maximum advertising events the Controller can skip before sending the AUX_ADV_IND packets on the secondary advertising physical channel

    • Secondary_Adv_PHY

    1

    Secondary advertising PHY.

  • 0x01: Secondary advertisement PHY is LE 1M
  • 0x02: Secondary advertisement PHY is LE 2M
  • 0x03: Secondary advertisement PHY is LE Coded

    • Adv_SID

    1

    Value of the Advertising SID subfield in the ADI field of the PDU.

  • 0x00 ... 0x0F

    • Scan_Req_Notification_Enable

    1

    Scan request notifications.

  • 0x00: Scan request notifications disabled
  • 0x01: Scan request notifications enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Selected_TX_Power

    1

    Power level selected by the Controller. Units: dBm.

  • -127 ... 20

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_EXTENDED_ADVERTISING_DATA

    Description

    This command is used to set the data used in extended advertising PDUs that have a data field.
    See Core Specification [Vol 4, Part E, 7.8.54].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Operation

    1

    Advertising operation.

  • 0x00: Intermediate fragment of fragmented extended advertising data
  • 0x01: First fragment of fragmented extended advertising data
  • 0x02: Last fragment of fragmented extended advertising data
  • 0x03: Complete extended advertising data
  • 0x04: Unchanged data (just update the Advertising DID)

    • Fragment_Preference

    1

    Fragment preference.

  • 0x00: The Controller may fragment all data
  • 0x01: The Controller should not fragment or should minimize fragmentation of data

    • Advertising_Data_Length

    1

    Length of Advertising_Data in octets

    Advertising_Data

    Advertising_Data_Length

    Data formatted as defined in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_EXTENDED_SCAN_RESPONSE_DATA

    Description

    This command is used to provide scan response data used in scanning response PDUs during extended advertising.
    See Core Specification [Vol 4, Part E, 7.8.55].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Operation

    1

    Scan response operation.

  • 0x00: Intermediate fragment of fragmented scan response data
  • 0x01: First fragment of fragmented scan response data
  • 0x02: Last fragment of fragmented scan response data
  • 0x03: Complete scan response data

    • Fragment_Preference

    1

    Fragment preference.

  • 0x00: The Controller may fragment all data
  • 0x01: The Controller should not fragment or should minimize fragmentation of data

    • Scan_Response_Data_Length

    1

    Length of Scan_Response_Data in octets

    Scan_Response_Data

    Scan_Response_Data_Length

    Data formatted as defined in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_EXTENDED_ADVERTISING_ENABLE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.56].

    Input parameters

    ParameterSizeDescriptionPossible values

    Enable

    1

    Enable/disable advertising.

  • 0x00: Advertising is disabled
  • 0x01: Advertising is enabled

    • Num_Sets

    1

    Number of advertising sets.

  • 0x00: Disable all advertising sets
  • 0x01 ... 0x3F: Number of advertising sets to enable or disable

    • Advertising_Handle[i]

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Duration[i]

    2

    Duration of advertising set. Time = N * 10 ms.

  • 0x0000 (0 ms) : No advertising duration.
  • 0x0001 (10 ms) ... 0xFFFF (655350 ms) : Advertising duration

    • Max_Extended_Advertising_Events[i]

    1

    Maximum number of advertising events.

  • 0x00: No maximum number of advertising events
  • 0x01 ... 0xFF: Maximum number of extended advertising events the Controller shall attempt to send prior to terminating the extended advertising

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_ADVERTISING_SET_TERMINATED_EVENT
  • HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT

    • HCI_LE_READ_MAXIMUM_ADVERTISING_DATA_LENGTH

    Description

    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 Core Specification [Vol 4, Part E, 7.8.57].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Max_Advertising_Data_Length

    2

    Maximum supported advertising data length.

  • 0x001F ... 0x0672

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_NUMBER_OF_SUPPORTED_ADVERTISING_SETS

    Description

    This command is used to read the maximum number of advertising sets supported by the Controller at the same time during extended advertising.
    See Core Specification [Vol 4, Part E, 7.8.58].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Num_Supported_Advertising_Sets

    1

    Number of advertising sets supported at the same time.

  • 0x01 ... 0xF0

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOVE_ADVERTISING_SET

    Description

    This command is used to remove an advertising set from the Controller.
    See Core Specification [Vol 4, Part E, 7.8.59].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CLEAR_ADVERTISING_SETS

    Description

    This command is used to remove all existing advertising sets from the Controller.
    See Core Specification [Vol 4, Part E, 7.8.60].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_PARAMETERS

    Description

    This command is used by the Host to set the parameters for periodic advertising.
    See Core Specification [Vol 4, Part E, 7.8.61].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Periodic_Adv_Interval_Min

    2

    Minimum advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Periodic_Adv_Interval_Max

    2

    Maximum advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Periodic_Adv_Properties

    2

    Properties.

    Bitmask of:

  • 0x0040: Include TxPower in the advertising PDU

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_DATA

    Description

    This command is used to set the data used in periodic advertising PDUs.
    See Core Specification [Vol 4, Part E, 7.8.62].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Operation

    1

    Advertising operation.

  • 0x00: Intermediate fragment of fragmented extended advertising data
  • 0x01: First fragment of fragmented extended advertising data
  • 0x02: Last fragment of fragmented extended advertising data
  • 0x03: Complete extended advertising data
  • 0x04: Unchanged data (just update the Advertising DID)

    • Advertising_Data_Length

    1

    Length of Advertising_Data in octets

    Advertising_Data

    Advertising_Data_Length

    Data formatted as defined in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_ENABLE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.63].

    Input parameters

    ParameterSizeDescriptionPossible values

    Enable

    1

    Enable/disable advertising.

    Bitmask of:

  • 0x01: Enable periodic advertising
  • 0x02: Include the ADI field in AUX_SYNC_IND PDUs

    • Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_EXTENDED_SCAN_PARAMETERS

    Description

    This command is used to set the extended scan parameters to be used on the advertising physical channels.
    See Core Specification [Vol 4, Part E, 7.8.64].

    Input parameters

    ParameterSizeDescriptionPossible values

    Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random 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.

    Bitmask of:

  • 0x01: 0 = unfiltered scanning policy; 1 = filtered scanning policy
  • 0x02: 0 = Basic filter policy; 1 = Extended filter policy
  • 0x04: Decision scanning filter policy mode - bit 0 (not supported)
  • 0x08: Decision scanning filter policy mode - bit 1 (not supported)

    • Scanning_PHYs

    1

    Scan PHYs.

    Bitmask of:

  • 0x01: Scan advertisements on the LE 1M PHY
  • 0x04: Scan advertisements on the LE Coded PHY

    • Scan_Type[i]

    1

    Passive or active scanning. With passive scanning, no scan request PDUs are sent.

  • 0x00: Passive scanning
  • 0x01: Active scanning

    • 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.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Scan_Window[i]

    2

    Duration of the scan on the primary advertising physical channel. Time = N * 0.625 ms.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_EXTENDED_SCAN_ENABLE

    Description

    This command is used to enable or disable extended scanning.
    See Core Specification [Vol 4, Part E, 7.8.65].

    Input parameters

    ParameterSizeDescriptionPossible values

    Enable

    1

    Enable/disable scan.

  • 0x00: Scanning disabled
  • 0x01: Scanning enabled

    • Filter_Duplicates

    1

    Duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled
  • 0x02: Duplicate filtering enabled, reset for each scan period

    • Duration

    2

    Scan duration. Time = N * 10 ms.

  • 0x0000 (0 ms) : Scan continuously until explicitly disable
  • 0x0001 (10 ms) ... 0xFFFF (655350 ms) : Scan duration

    • Period

    2

    Scan period. Time = N * 1.28 s.

  • 0x0000 (0 ms) : Scan continuously
  • 0x0001 (1280 ms) ... 0xFFFF (83884800 ms) : Time interval from when the Controller started its last Scan_Duration until it begins the subsequent Scan_Duration

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT

    • HCI_LE_EXTENDED_CREATE_CONNECTION

    Description

    This command is used to create an ACL connection to a connectable advertiser by means of extended scanning.
    See Core Specification [Vol 4, Part E, 7.8.66].

    Input parameters

    ParameterSizeDescriptionPossible values

    Initiator_Filter_Policy

    1

    Initiator filter policy.

  • 0x00: Filter Accept List is not used to determine which advertiser to connect to
  • 0x01: Filter Accept List is used to determine which advertiser to connect to (Peer_Address_Type and Peer_Address are ignored)

    • Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random Address

    • Peer_Address_Type

    1

    Address type of the peer device.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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:

  • 0x01: Scan connectable advertisements on the LE 1M PHY- Connection parameters for the LE 1M PHY
  • 0x02: Connection parameters for the LE 2M PHY
  • 0x04: Scan connectable advertisements on the LE Coded PHY

    • 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.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Scan_Window[i]

    2

    Duration of the scan on the primary advertising physical channel. Time = N * 0.625 ms.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Conn_Interval_Min[i]

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max[i]

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency[i]

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Min_CE_Length[i]

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Max_CE_Length[i]

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT

    • HCI_LE_PERIODIC_ADVERTISING_CREATE_SYNC

    Description

    This command is used to synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets.
    See Core Specification [Vol 4, Part E, 7.8.67].

    Input parameters

    ParameterSizeDescriptionPossible values

    Options

    1

    Determines whether the Periodic Advertiser List is used, whether HCI_LE_Periodic_Advertising_Report events for this periodic advertising train are initially enabled or disabled, and whether duplicate reports are filtered or not.

    Bitmask of:

  • 0x01: 0=Use the Advertising_SID, Advertiser_Address_Type, and Advertiser_Address parameters to determine which advertiser to listen to; 1=Use the Periodic Advertiser List to determine which advertiser to listen to
  • 0x02: 0=Reporting initially enabled; 1=Reporting initially disabled
  • 0x04: 0=Duplicate filtering initially disabled; 1=Duplicate filtering initially enabled

    • Advertising_SID

    1

    Value of the Advertising SID subfield in the ADI field of the PDU.

  • 0x00 ... 0x0F

    • Advertiser_Address_Type

    1

    The address type of the advertiser.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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.

  • 0x0000 ... 0x01F3

    • Sync_Timeout

    2

    Synchronization timeout for the periodic advertising train. Time = N * 10 ms.

  • 0x000A (100 ms) ... 0x4000 (163840 ms)

    • Sync_CTE_Type

    1

    Specifies whether to only synchronize to periodic advertising with certain types of CTE.

    Bitmask of:

  • 0x01: Do not sync to packets with an AoA Constant Tone Extension
  • 0x02: Do not sync to packets with an AoD Constant Tone Extension with 1 us slots
  • 0x04: Do not sync to packets with an AoD Constant Tone Extension with 2 us slots
  • 0x10: Do not sync to packets without a Constant Tone Extension

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT

    • HCI_LE_PERIODIC_ADVERTISING_CREATE_SYNC_CANCEL

    Description

    This command is used to cancel the HCI_LE_Periodic_Advertising_Create_Sync command while it is pending.
    See Core Specification [Vol 4, Part E, 7.8.68].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_PERIODIC_ADVERTISING_TERMINATE_SYNC

    Description

    This command is used to stop reception of the periodic advertising train identified by the Sync_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.69].

    Input parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ADD_DEVICE_TO_PERIODIC_ADVERTISER_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.70].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertiser_Address_Type

    1

    The address type of the advertiser.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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.

  • 0x00 ... 0x0F

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOVE_DEVICE_FROM_PERIODIC_ADVERTISER_LIST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.71].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertiser_Address_Type

    1

    The address type of the advertiser.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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.

  • 0x00 ... 0x0F

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CLEAR_PERIODIC_ADVERTISER_LIST

    Description

    This command is used to remove all entries from the list of Periodic Advertisers in the Controller.
    See Core Specification [Vol 4, Part E, 7.8.72].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_PERIODIC_ADVERTISER_LIST_SIZE

    Description

    This command is used to read the total number of Periodic Advertiser list entries that can be stored in the Controller.
    See Core Specification [Vol 4, Part E, 7.8.73].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Periodic_Advertiser_List_Size

    1

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_TRANSMIT_POWER

    Description

    This command is used to read the minimum and maximum transmit powers supported by the Controller.
    See Core Specification [Vol 4, Part E, 7.8.74].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Min_TX_Power

    1

    Signed integer. Units: dBm.

  • -127 ... 20

    • Max_TX_Power

    1

    Signed integer. Units: dBm.

  • -127 ... 20

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_RF_PATH_COMPENSATION

    Description

    This command is used to read the RF path compensation value parameters used in the Tx power level and RSSI calculation.
    See Core Specification [Vol 4, Part E, 7.8.75].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    RF_TX_Path_Compensation

    2

    RF TX Path Compensation Value (16-bit signed integer). Units: 0.1 dB.

  • -1280 ... 1280

    • RF_RX_Path_Compensation

    2

    RF RX Path Compensation Value (16-bit signed integer). Units: 0.1 dB.

  • -1280 ... 1280

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_WRITE_RF_PATH_COMPENSATION

    Description

    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 Core Specification [Vol 4, Part E, 7.8.76].

    Input parameters

    ParameterSizeDescriptionPossible values

    RF_TX_Path_Compensation

    2

    RF TX Path Compensation Value (16-bit signed integer). Units: 0.1 dB.

  • -1280 ... 1280

    • RF_RX_Path_Compensation

    2

    RF RX Path Compensation Value (16-bit signed integer). Units: 0.1 dB.

  • -1280 ... 1280

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PRIVACY_MODE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.77].

    Input parameters

    ParameterSizeDescriptionPossible values

    Peer_Identity_Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Peer_Identity_Address

    6

    Public or Random (static) Identity Address of the peer device

    Privacy_Mode

    1

    Privacy Mode.

  • 0x00: Use Network Privacy Mode
  • 0x01: Use Device Privacy Mode

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_CONNECTIONLESS_CTE_TRANSMIT_PARAMETERS

    Description

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • CTE_Length

    1

    Constant Tone Extension length in 8 us units.

  • 0x02 ... 0x14

    • CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots

    • CTE_Count

    1

    Number of Constant Tone Extensions to transmit in each periodic advertising interval.

  • 0x01 ... 0x10

    • Switching_Pattern_Length

    1

    Number of Antenna IDs in the pattern.

  • 0x02 ... 0x4B

    • Antenna_IDs

    Switching_Pattern_Length

    Antenna ID in the pattern.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_CONNECTIONLESS_CTE_TRANSMIT_ENABLE

    Description

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • CTE_Enable

    1

    Used to enable or disable Constant Tone Extension.

  • 0x00: Advertising with CTE is disabled (default)
  • 0x01: Advertising with CTE is enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_CONNECTIONLESS_IQ_SAMPLING_ENABLE

    Description

    Input parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Sampling_Enable

    1

    Used to enable or disable IQ sampling.

  • 0x00: IQ sampling is disabled (default)
  • 0x01: IQ sampling is enabled

    • Slot_Durations

    1

    Slot Durations.

  • 0x01: Switching and sampling slots are 1 us each
  • 0x02: Switching and sampling slots are 2 us each

    • Max_Sampled_CTEs

    1

    Number of Constant Tone Extensions to sample and report.

  • 0x00: Sample and report all available CTEs
  • 0x01 ... 0x10: The maximum number of CTEs to sample and report in each periodic advertising interval

    • Switching_Pattern_Length

    1

    Number of Antenna IDs in the pattern.

  • 0x02 ... 0x4B

    • Antenna_IDs

    Switching_Pattern_Length

    Antenna ID in the pattern.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_CONNECTIONLESS_IQ_REPORT_EVENT

    • HCI_LE_SET_CONNECTION_CTE_RECEIVE_PARAMETERS

    Description

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Sampling_Enable

    1

    Used to enable or disable IQ sampling.

  • 0x00: IQ sampling is disabled (default)
  • 0x01: IQ sampling is enabled

    • Slot_Durations

    1

    Slot Durations.

  • 0x01: Switching and sampling slots are 1 us each
  • 0x02: Switching and sampling slots are 2 us each

    • Switching_Pattern_Length

    1

    Number of Antenna IDs in the pattern.

  • 0x02 ... 0x4B

    • Antenna_IDs

    Switching_Pattern_Length

    Antenna ID in the pattern.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_CONNECTION_CTE_TRANSMIT_PARAMETERS

    Description

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • CTE_Types

    1

    Allowed Constant Tone Extension response type.

  • 0x00: Allow AoA CTE Response
  • 0x01: Allow AoD CTE Response with 1 us slots
  • 0x02: Allow AoD CTE Response with 2 us slots

    • Switching_Pattern_Length

    1

    Number of Antenna IDs in the pattern.

  • 0x02 ... 0x4B

    • Antenna_IDs

    Switching_Pattern_Length

    Antenna ID in the pattern.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CONNECTION_CTE_REQUEST_ENABLE

    Description

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Enable

    1

    Used to enable or disable Constant Tone Extension Request for the connection.

  • 0x00: Disable CTE Request (default)
  • 0x01: Enable CTE Request

    • CTE_Request_Interval

    2

    Constant Tone Extension Request interval.

  • 0x0000: Initiate the CTE Request procedure once, at the earliest practical opportunity
  • 0x0001 ... 0xFFFF: Requested interval for initiating the CTE Request procedure in number of underlying connection events

    • Requested_CTE_Length

    1

    Minimum length of the Constant Tone Extension being requested in 8 us units.

  • 0x02 ... 0x14

    • Requested_CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_CONNECTION_IQ_REPORT_EVENT
  • HCI_LE_CTE_REQUEST_FAILED_EVENT

    • HCI_LE_CONNECTION_CTE_RESPONSE_ENABLE

    Description

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Enable

    1

    Used to enable or disable Constant Tone Extension Response for the connection.

  • 0x00: Disable CTE Response (default)
  • 0x01: Enable CTE Response

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_ANTENNA_INFORMATION

    Description

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Supported_Switching_Sampling_Rates

    1

    Supported switching and sampling rates.

    Bitmask of:

  • 0x01: 1 us switching supported for AoD transmission
  • 0x02: 1 us sampling supported for AoD reception
  • 0x04: 1 us switching and sampling supported for AoA reception

    • Num_Antennae

    1

    Number of antennae supported by the Controller.

  • 0x01 ... 0x4B

    • Max_Switching_Pattern_Length

    1

    Maximum length of antenna switching pattern supported by the Controller.

  • 0x02 ... 0x4B

    • Max_CTE_Length

    1

    Maximum length of a transmitted Constant Tone Extension supported in 8 us units.

  • 0x02 ... 0x14

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_RECEIVE_ENABLE

    Description

    This command is used to enable or disable reports for the periodic advertising train identified by the Sync_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.88].

    Input parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Enable

    1

    Used to determine whether reporting and duplicate filtering are enabled or disabled.

    Bitmask of:

  • 0x01: Reporting enabled
  • 0x02: Duplicate filtering enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_PERIODIC_ADVERTISING_SYNC_TRANSFER

    Description

    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 Core Specification [Vol 4, Part E, 7.8.89].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Service_Data

    2

    A value provided by the Host.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_PERIODIC_ADVERTISING_SET_INFO_TRANSFER

    Description

    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 Core Specification [Vol 4, Part E, 7.8.90].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Service_Data

    2

    A value provided by the Host.

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_SYNC_TRANSFER_PARAMETERS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.91].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Mode

    1

    Action to be taken when periodic advertising synchronization information is received.

  • 0x00: No attempt is made to synchronize to the periodic advertising and no HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host.
  • 0x01: An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be disabled.
  • 0x02: An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be enabled with duplicate filtering disabled.
  • 0x03: An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be enabled with duplicate filtering enabled.

    • Skip

    2

    Maximum number of periodic advertising events that can be skipped after a successful receive.

  • 0x0000 ... 0x01F3

    • Sync_Timeout

    2

    Synchronization timeout for the periodic advertising train. Time = N * 10 ms.

  • 0x000A (100 ms) ... 0x4000 (163840 ms)

    • CTE_Type

    1

    Specifies whether to only synchronize to periodic advertising with certain types of CTE.

    Bitmask of:

  • 0x01: Do not sync to packets with an AoA Constant Tone Extension
  • 0x02: Do not sync to packets with an AoD Constant Tone Extension with 1 us slots
  • 0x04: Do not sync to packets with an AoD Constant Tone Extension with 2 us slots
  • 0x10: Do not sync to packets without a Constant Tone Extension

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_DEFAULT_PERIODIC_ADVERTISING_SYNC_TRANSFER_PARAMETERS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.92].

    Input parameters

    ParameterSizeDescriptionPossible values

    Mode

    1

    Action to be taken when periodic advertising synchronization information is received.

  • 0x00: No attempt is made to synchronize to the periodic advertising and no HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host.
  • 0x01: An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be disabled.
  • 0x02: An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be enabled with duplicate filtering disabled.
  • 0x03: An HCI_LE_Periodic_Advertising_Sync_Transfer_Received event is sent to the Host. HCI_LE_Periodic_Advertising_Report events will be enabled with duplicate filtering enabled.

    • Skip

    2

    Maximum number of periodic advertising events that can be skipped after a successful receive.

  • 0x0000 ... 0x01F3

    • Sync_Timeout

    2

    Synchronization timeout for the periodic advertising train. Time = N * 10 ms.

  • 0x000A (100 ms) ... 0x4000 (163840 ms)

    • CTE_Type

    1

    Specifies whether to only synchronize to periodic advertising with certain types of CTE.

    Bitmask of:

  • 0x01: Do not sync to packets with an AoA Constant Tone Extension
  • 0x02: Do not sync to packets with an AoD Constant Tone Extension with 1 us slots
  • 0x04: Do not sync to packets with an AoD Constant Tone Extension with 2 us slots
  • 0x10: Do not sync to packets without a Constant Tone Extension

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_GENERATE_DHKEY_V2

    Description

    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 Core Specification [Vol 4, Part E, 7.8.37].

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x00: Use the generated private key
  • 0x01: Use the debug private key

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_GENERATE_DHKEY_COMPLETE_EVENT

    • HCI_LE_READ_BUFFER_SIZE_V2

    Description

    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 Core Specification [Vol 4, Part E, 7.8.2].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0000: No dedicated LE Buffer exists.
  • 0x001B ... 0x00FF: Maximum length (in octets) of the data portion of each HCI ACL data packet.

    • 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.

  • 0x00: No dedicated LE Buffer exists.
  • 0x01 ... 0xFF: 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.

  • 0x0000: No dedicated ISO Buffer exists.
  • 0x0001 ... 0x0FFF: The maximum length (in octets) of the data portion of each HCI ISO data packet.

    • 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.

  • 0x00: No dedicated ISO Buffer exists.
  • 0x01 ... 0xFF: The total number of HCI ISO data packets that can be stored in the ISO buffers of the Controller.

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_ISO_TX_SYNC

    Description

    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 Core Specification [Vol 4, Part E, 7.8.96].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Packet_Sequence_Number

    2

    The packet sequence number of an SDU.

  • 0x0000 ... 0xFFFF

    • TX_Time_Stamp

    4

    The CIG reference point or BIG anchor point of a transmitted SDU derived using the Controller's free running reference clock (in microseconds).

  • 0x00000000 ... 0xFFFFFFFF

    • Time_Offset

    3

    The time offset, in microseconds, that is associated with a transmitted SDU.

  • 0x000000 ... 0xFFFFFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_CIG_PARAMETERS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.97].

    Input parameters

    ParameterSizeDescriptionPossible values

    CIG_ID

    1

    CIG identifier.

  • 0x00 ... 0xEF

    • SDU_Interval_C_To_P

    3

    Interval, in microseconds, of periodic SDUs.

  • 0x0000FF ... 0x0FFFFF

    • SDU_Interval_P_To_C

    3

    Interval, in microseconds, of periodic SDUs.

  • 0x0000FF ... 0x0FFFFF

    • Worst_Case_SCA

    1

    Worst-case sleep clock accuracy.

  • 0x00: 251 ppm to 500 ppm
  • 0x01: 151 ppm to 250 ppm
  • 0x02: 101 ppm to 150 ppm
  • 0x03: 76 ppm to 100 ppm
  • 0x04: 51 ppm to 75 ppm
  • 0x05: 31 ppm to 50 ppm
  • 0x06: 21 ppm to 30 ppm
  • 0x07: 0 ppm to 20 ppm

    • Packing

    1

    Preferred method of arranging subevents of multiple CISes.

  • 0x00: Sequential
  • 0x01: Interleaved

    • Framing

    1

    Format of the CIS Data PDUs.

  • 0x00: Unframed
  • 0x01: Framed

    • Max_Transport_Latency_C_To_P

    2

    Maximum transport latency, in milliseconds.

  • 5 ... 4000

    • Max_Transport_Latency_P_To_C

    2

    Maximum transport latency, in milliseconds.

  • 5 ... 4000

    • CIS_Count

    1

    Total number of CIS configurations in the CIG.

  • 0 ... 31

    • CIS_ID[i]

    1

    CIS identifier.

  • 0x00 ... 0xEF

    • Max_SDU_C_To_P[i]

    2

    Maximum size, in octets, of the payload from the Central's Host.

  • 0 ... 310

    • Max_SDU_P_To_C[i]

    2

    Maximum size, in octets, of the payload from the Peripheral's Host.

  • 0 ... 310

    • PHY_C_To_P[i]

    1

    PHY used for transmission from the Central to the Peripheral.

    Bitmask of:

  • 0x01: The transmitter PHY of packets from the Central is LE 1M
  • 0x02: The transmitter PHY of packets from the Central is LE 2M
  • 0x04: The transmitter PHY of packets from the Central is LE Coded

    • PHY_P_To_C[i]

    1

    PHY used for transmission from the Peripheral to the Central.

    Bitmask of:

  • 0x01: The transmitter PHY of packets from the Peripheral is LE 1M
  • 0x02: The transmitter PHY of packets from the Peripheral is LE 2M
  • 0x04: The transmitter PHY of packets from the Peripheral is LE Coded

    • 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    CIG_ID

    1

    CIG identifier.

  • 0x00 ... 0xEF

    • CIS_Count_Ret

    1

    Total number of CIS configurations added or modified by this command.

  • 0x00 ... 0x1F

    • Connection_Handle

    CIS_Count_Ret

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_CIG_PARAMETERS_TEST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.98].

    Input parameters

    ParameterSizeDescriptionPossible values

    CIG_ID

    1

    CIG identifier.

  • 0x00 ... 0xEF

    • SDU_Interval_C_To_P

    3

    Interval, in microseconds, of periodic SDUs.

  • 0x0000FF ... 0x0FFFFF

    • SDU_Interval_P_To_C

    3

    Interval, in microseconds, of periodic SDUs.

  • 0x0000FF ... 0x0FFFFF

    • FT_C_To_P

    1

    Flush timeout in multiples of ISO_Interval for each payload sent from the Central to Peripheral.

  • 0x01 ... 0xFF

    • FT_P_To_C

    1

    Flush timeout in multiples of ISO_Interval for each payload sent from the Peripheral to Central.

  • 0x01 ... 0xFF

    • ISO_Interval

    2

    Time between consecutive BIG anchor points. Time = N * 1.25 ms.

  • 0x0004 (5.00 ms) ... 0x0C80 (4000.00 ms)

    • Worst_Case_SCA

    1

    Worst-case sleep clock accuracy.

  • 0x00: 251 ppm to 500 ppm
  • 0x01: 151 ppm to 250 ppm
  • 0x02: 101 ppm to 150 ppm
  • 0x03: 76 ppm to 100 ppm
  • 0x04: 51 ppm to 75 ppm
  • 0x05: 31 ppm to 50 ppm
  • 0x06: 21 ppm to 30 ppm
  • 0x07: 0 ppm to 20 ppm

    • Packing

    1

    Preferred method of arranging subevents of multiple CISes.

  • 0x00: Sequential
  • 0x01: Interleaved

    • Framing

    1

    Format of the CIS Data PDUs.

  • 0x00: Unframed
  • 0x01: Framed

    • CIS_Count

    1

    Total number of CIS configurations in the CIG.

  • 0 ... 31

    • CIS_ID[i]

    1

    CIS identifier.

  • 0x00 ... 0xEF

    • NSE[i]

    1

    Number of subevents in each interval of each BIS in the BIG.

  • 1 ... 31

    • Max_SDU_C_To_P[i]

    2

    Maximum size, in octets, of the payload from the Central's Host.

  • 0 ... 310

    • Max_SDU_P_To_C[i]

    2

    Maximum size, in octets, of the payload from the Peripheral's Host.

  • 0 ... 310

    • Max_PDU_C_To_P[i]

    2

    Maximum size, in octets, of the payload from the Central to the Peripheral.

  • 0 ... 251

    • Max_PDU_P_To_C[i]

    2

    Maximum size, in octets, of the payload from the Peripheral to the Central.

  • 0 ... 251

    • PHY_C_To_P[i]

    1

    PHY used for transmission from the Central to the Peripheral.

    Bitmask of:

  • 0x01: The transmitter PHY of packets from the Central is LE 1M
  • 0x02: The transmitter PHY of packets from the Central is LE 2M
  • 0x04: The transmitter PHY of packets from the Central is LE Coded

    • PHY_P_To_C[i]

    1

    PHY used for transmission from the Peripheral to the Central.

    Bitmask of:

  • 0x01: The transmitter PHY of packets from the Peripheral is LE 1M
  • 0x02: The transmitter PHY of packets from the Peripheral is LE 2M
  • 0x04: The transmitter PHY of packets from the Peripheral is LE Coded

    • BN_C_To_P[i]

    1

    Burst number for Central to Peripheral.

  • 0x00: No isochronous data from the Central to the Peripheral
  • 0x01 ... 0x0F

    • BN_P_To_C[i]

    1

    Burst number for Peripheral to Central.

  • 0x00: No isochronous data from the Peripheral to the Central
  • 0x01 ... 0x0F

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    CIG_ID

    1

    CIG identifier.

  • 0x00 ... 0xEF

    • CIS_Count_Ret

    1

    Total number of CIS configurations added or modified by this command.

  • 0x00 ... 0x1F

    • Connection_Handle

    CIS_Count_Ret

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CREATE_CIS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.99].

    Input parameters

    ParameterSizeDescriptionPossible values

    CIS_Count

    1

    Total number of CIS configurations in the CIG.

  • 0 ... 31

    • CIS_Connection_Handle[i]

    2

    Connection handle of a CIS.

  • 0x0000 ... 0x0EFF

    • ACL_Connection_Handle[i]

    2

    Connection handle of an ACL connection.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CIS_ESTABLISHED_EVENT

    • HCI_LE_REMOVE_CIG

    Description

    This command is used by the Central's Host to remove the CIG identified by CIG_ID.
    See Core Specification [Vol 4, Part E, 7.8.100].

    Input parameters

    ParameterSizeDescriptionPossible values

    CIG_ID

    1

    CIG identifier.

  • 0x00 ... 0xEF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    CIG_ID

    1

    CIG identifier.

  • 0x00 ... 0xEF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ACCEPT_CIS_REQUEST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.101].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CIS_ESTABLISHED_EVENT

    • HCI_LE_REJECT_CIS_REQUEST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.102].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Reason

    1

    Reason the CIS request was rejected (see "Status error codes" section).

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CREATE_BIG

    Description

    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 Core Specification [Vol 4, Part E, 7.8.103].

    Input parameters

    ParameterSizeDescriptionPossible values

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Num_BIS

    1

    Total number of BISes in the BIG.

  • 1 ... 31

    • SDU_Interval

    3

    Interval, in microseconds, of periodic SDUs.

  • 0x0000FF ... 0x0FFFFF

    • Max_SDU

    2

    Maximum size of an SDU in octets.

  • 1 ... 4095

    • Max_Transport_Latency

    2

    Maximum transport latency, in milliseconds.

  • 5 ... 4000

    • RTN

    1

    Number of times that every BIS Data PDU should be retransmitted.

  • 0 ... 30

    • PHY

    1

    PHY used for transmission of PDUs of BISes in the BIG.

    Bitmask of:

  • 0x01: The transmitter PHY of packets is LE 1M
  • 0x02: The transmitter PHY of packets is LE 2M
  • 0x04: The transmitter PHY of packets is LE Coded

    • Packing

    1

    Preferred method of arranging subevents of multiple CISes.

  • 0x00: Sequential
  • 0x01: Interleaved

    • Framing

    1

    Format of the CIS Data PDUs.

  • 0x00: Unframed
  • 0x01: Framed

    • Encryption

    1

    Encryption mode of the BISes.

  • 0x00: Unencrypted
  • 0x01: Encrypted

    • Broadcast_Code

    16

    Code used to encrypt and decrypt BIS payloads.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CREATE_BIG_COMPLETE_EVENT

    • HCI_LE_CREATE_BIG_TEST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.104].

    Input parameters

    ParameterSizeDescriptionPossible values

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Num_BIS

    1

    Total number of BISes in the BIG.

  • 1 ... 31

    • SDU_Interval

    3

    Interval, in microseconds, of periodic SDUs.

  • 0x0000FF ... 0x0FFFFF

    • ISO_Interval

    2

    Time between consecutive BIG anchor points. Time = N * 1.25 ms.

  • 0x0004 (5.00 ms) ... 0x0C80 (4000.00 ms)

    • NSE

    1

    Number of subevents in each interval of each BIS in the BIG.

  • 1 ... 31

    • Max_SDU

    2

    Maximum size of an SDU in octets.

  • 1 ... 4095

    • Max_PDU

    2

    Maximum size, in octets, of payload.

  • 1 ... 251

    • PHY

    1

    PHY used for transmission of PDUs of BISes in the BIG.

    Bitmask of:

  • 0x01: The transmitter PHY of packets is LE 1M
  • 0x02: The transmitter PHY of packets is LE 2M
  • 0x04: The transmitter PHY of packets is LE Coded

    • Packing

    1

    Preferred method of arranging subevents of multiple CISes.

  • 0x00: Sequential
  • 0x01: Interleaved

    • Framing

    1

    Format of the CIS Data PDUs.

  • 0x00: Unframed
  • 0x01: Framed

    • BN

    1

    Number of new payloads in each interval for each BIS.

  • 0x01 ... 0x07

    • IRC

    1

    Number of times the scheduled payloads are transmitted in a given event.

  • 1 ... 15

    • PTO

    1

    Offset used for pre-transmissions.

  • 0x00 ... 0x0F

    • Encryption

    1

    Encryption mode of the BISes.

  • 0x00: Unencrypted
  • 0x01: Encrypted

    • Broadcast_Code

    16

    Code used to encrypt and decrypt BIS payloads.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CREATE_BIG_COMPLETE_EVENT

    • HCI_LE_TERMINATE_BIG

    Description

    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 Core Specification [Vol 4, Part E, 7.8.105].

    Input parameters

    ParameterSizeDescriptionPossible values

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Reason

    1

    BIG termination reason (see "Status error codes" section).

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_TERMINATE_BIG_COMPLETE_EVENT

    • HCI_LE_BIG_CREATE_SYNC

    Description

    This command is used to synchronize to a BIG described in the periodic advertising train specified by the Sync_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.106].

    Input parameters

    ParameterSizeDescriptionPossible values

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Encryption

    1

    Encryption mode of the BISes.

  • 0x00: Unencrypted
  • 0x01: Encrypted

    • 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.

  • 0: The Controller can schedule reception of any number of subevents up to NSE
  • 1 ... 31

    • BIG_Sync_Timeout

    2

    Synchronization timeout for the BIG. Time = N * 10 ms.

  • 0x000A (100 ms) ... 0x4000 (163840 ms)

    • Num_BIS

    1

    Total number of BISes in the BIG.

  • 1 ... 31

    • BIS

    Num_BIS

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_BIG_SYNC_ESTABLISHED_EVENT

    • HCI_LE_BIG_TERMINATE_SYNC

    Description

    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 Core Specification [Vol 4, Part E, 7.8.107].

    Input parameters

    ParameterSizeDescriptionPossible values

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_BIG_SYNC_ESTABLISHED_EVENT

    • HCI_LE_REQUEST_PEER_SCA

    Description

    This command is used to read the Sleep Clock Accuracy (SCA) of the peer device.
    See Core Specification [Vol 4, Part E, 7.8.108].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_REQUEST_PEER_SCA_COMPLETE_EVENT

    • HCI_LE_SETUP_ISO_DATA_PATH

    Description

    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 Core Specification [Vol 4, Part E, 7.8.109].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Data_Path_Direction

    1

    Data path direction.

  • 0x00: Input (Host to Controller)
  • 0x01: Output (Controller to Host)

    • Data_Path_ID

    1

    ISO data path identifier.

  • 0x00: HCI
  • 0x01 ... 0xFE: Logical_Channel_Number

    • 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.

  • 0x000000 ... 0x3D0900

    • Codec_Configuration_Length

    1

    Length of Codec_Configuration in octets

    Codec_Configuration

    Codec_Configuration_Length

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOVE_ISO_DATA_PATH

    Description

    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 Core Specification [Vol 4, Part E, 7.8.110].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Data_Path_Direction

    1

    ISO data path directions to be removed.

    Bitmask of:

  • 0x01: Remove input data path
  • 0x02: Remove output data path

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_HOST_FEATURE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.115].

    Input parameters

    ParameterSizeDescriptionPossible values

    Bit_Number

    1

    Bit position in the FeatureSet.

  • 0x00 ... 0x3F

    • Bit_Value

    1

    Bit in the FeatureSet set/reset.

  • 0x00: The Host feature is disabled and so the bit in the FeatureSet is set to 0
  • 0x01: The Host feature is enabled and so the bit in the FeatureSet is set to 1

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_ISO_LINK_QUALITY

    Description

    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 Core Specification [Vol 4, Part E, 7.8.116].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • TX_UnACKed_Packets

    4

    Value of the Tx_UnACKed_Packets counter.

    TX_Flushed_Packets

    4

    Value of the TX_Flushed_Packets counter.

    TX_Last_Subevent_Packets

    4

    Value of the TX_Last_Subevent_Packets counter.

    Retransmitted_Packets

    4

    Value of the Retransmitted_Packets counter.

    CRC_Error_Packets

    4

    Value of the CRC_Error_Packet counter.

    RX_Unreceived_Packets

    4

    Value of the RX_Unreceived_Packets counter.

    Duplicate_Packets

    4

    Value of the Duplicate_Packets counter.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ENHANCED_READ_TRANSMIT_POWER_LEVEL

    Description

    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 Core Specification [Vol 4, Part E, 7.8.117].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • PHY

    1

    Applying PHY.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE Coded PHY with S=8 data coding
  • 0x04: LE Coded PHY with S=2 data coding

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • PHY

    1

    Applying PHY.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE Coded PHY with S=8 data coding
  • 0x04: LE Coded PHY with S=2 data coding

    • Current_TX_Power_Level

    1

    Current transmit power level (signed integer). Units: dBm.

  • 127: Current transmit power level is unavailable
  • -127 ... 20

    • Max_TX_Power_Level

    1

    Signed integer. Units: dBm.

  • -127 ... 20

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_REMOTE_TRANSMIT_POWER_LEVEL

    Description

    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 Core Specification [Vol 4, Part E, 7.8.118].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • PHY

    1

    Applying PHY.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE Coded PHY with S=8 data coding
  • 0x04: LE Coded PHY with S=2 data coding

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_TRANSMIT_POWER_REPORTING_EVENT

    • HCI_LE_SET_PATH_LOSS_REPORTING_PARAMETERS

    Description

    This command is used to set the path loss threshold reporting parameters for the ACL connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.119].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • High_Threshold

    1

    High threshold for the path loss. Units: dB.

  • 255: High Threshold unused
  • 0 ... 254

    • 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.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_PATH_LOSS_THRESHOLD_EVENT

    • HCI_LE_SET_PATH_LOSS_REPORTING_ENABLE

    Description

    This command is used to enable or disable path loss reporting for the ACL connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.120].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Enable

    1

    Reporting enable/disable.

  • 0x00: Reporting disabled
  • 0x01: Reporting enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_PATH_LOSS_THRESHOLD_EVENT

    • HCI_LE_SET_TRANSMIT_POWER_REPORTING_ENABLE

    Description

    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 Core Specification [Vol 4, Part E, 7.8.121].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Local_Enable

    1

    Local reporting enable/disable.

  • 0x00: Disable local transmit power reports
  • 0x01: Enable local transmit power reports

    • Remote_Enable

    1

    Remote reporting enable/disable.

  • 0x00: Disable remote transmit power reports
  • 0x01: Enable remote transmit power reports

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_TRANSMIT_POWER_REPORTING_EVENT

    • HCI_LE_SET_DATA_RELATED_ADDRESS_CHANGES

    Description

    This command specifies circumstances when the Controller shall refresh any Resolvable Private Address used by the advertising set identified by the Advertising_Handle parameter, whether or not the address timeout period has been reached. This command may be used while advertising is enabled.
    See Core Specification [Vol 4, Part E, 7.8.122].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Change_Reasons

    1

    Reason(s) for refreshing addresses.

    Bitmask of:

  • 0x01: Change the address whenever the advertising data changes
  • 0x02: Change the address whenever the scan response data changes

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_DEFAULT_SUBRATE

    Description

    This command is used by the Host to set the initial values for the acceptable parameters for subrating requests, as defined by the HCI_LE Subrate_Request command, for all future ACL connections where the Controller is the Central. This command does not affect any existing connection.
    See Core Specification [Vol 4, Part E, 7.8.123].

    Input parameters

    ParameterSizeDescriptionPossible values

    Subrate_Min

    2

    Minimum subrate factor.

  • 0x0001 ... 0x01F4

    • Subrate_Max

    2

    Maximum subrate factor.

  • 0x0001 ... 0x01F4

    • Max_Latency

    2

    Maximum Peripheral latency allowed in requests by a Peripheral, in units of subrated connection intervals.

  • 0x0000 ... 0x01F3

    • Continuation_Number

    2

    Minimum number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received in requests by a Peripheral.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SUBRATE_REQUEST

    Description

    This command is used by a Central or a Peripheral to request a change to the subrating factor and/or other parameters applied to an existing connection using the Connection Subrate Update procedure.
    See Core Specification [Vol 4, Part E, 7.8.124].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Subrate_Min

    2

    Minimum subrate factor.

  • 0x0001 ... 0x01F4

    • Subrate_Max

    2

    Maximum subrate factor.

  • 0x0001 ... 0x01F4

    • Max_Latency

    2

    Maximum Peripheral latency allowed in requests by a Peripheral, in units of subrated connection intervals.

  • 0x0000 ... 0x01F3

    • Continuation_Number

    2

    Minimum number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received in requests by a Peripheral.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_SUBRATE_CHANGE_EVENT

    • HCI_LE_SET_EXTENDED_ADVERTISING_PARAMETERS_V2

    Description

    This command is used by the Host to set the advertising parameters.
    See Core Specification [Vol 4, Part E, 7.8.53].

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Adv_Event_Properties

    2

    Type of advertising event.

    Bitmask of:

  • 0x0001: Connectable advertising
  • 0x0002: Scannable advertising
  • 0x0004: Directed advertising
  • 0x0008: High Duty Cycle Directed Connectable advertising
  • 0x0010: Use legacy advertising PDUs
  • 0x0020: Anonymous advertising
  • 0x0040: Include TxPower in at least one advertising PDU

    • Primary_Adv_Interval_Min

    3

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x000020 (20.000 ms) ... 0xFFFFFF (10485759.375 ms)

    • Primary_Adv_Interval_Max

    3

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x000020 (20.000 ms) ... 0xFFFFFF (10485759.375 ms)

    • Primary_Adv_Channel_Map

    1

    Advertising channel map.

    Bitmask of:

  • 0x01: Channel 37 shall be used
  • 0x02: Channel 38 shall be used
  • 0x04: Channel 39 shall be used

    • Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random Address

    • Peer_Address_Type

    1

    Address type of the peer device.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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

  • 0x00: Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use)
  • 0x01: Process connection requests from all devices and scan requests only from devices that are in the Filter Accept List.
  • 0x02: Process scan requests from all devices and connection requests only from devices that are in the Filter Accept List.
  • 0x03: Process scan and connection requests only from devices in the Filter Accept List.

    • Adv_TX_Power

    1

    Advertising TX power. Units: dBm.

  • 127: Host has no preference
  • -127 ... 20

    • Primary_Adv_PHY

    1

    Primary advertising PHY.

  • 0x01: Primary advertisement PHY is LE 1M
  • 0x03: Primary advertisement PHY is LE Coded

    • Secondary_Adv_Max_Skip

    1

    Secondary advertising maximum skip.

  • 0x00: AUX_ADV_IND shall be sent prior to the next advertising event
  • 0x01 ... 0xFF: Maximum advertising events the Controller can skip before sending the AUX_ADV_IND packets on the secondary advertising physical channel

    • Secondary_Adv_PHY

    1

    Secondary advertising PHY.

  • 0x01: Secondary advertisement PHY is LE 1M
  • 0x02: Secondary advertisement PHY is LE 2M
  • 0x03: Secondary advertisement PHY is LE Coded

    • Adv_SID

    1

    Value of the Advertising SID subfield in the ADI field of the PDU.

  • 0x00 ... 0x0F

    • Scan_Req_Notification_Enable

    1

    Scan request notifications.

  • 0x00: Scan request notifications disabled
  • 0x01: Scan request notifications enabled

    • Primary_Adv_PHY_Options

    1

    Advertising PHY options.

  • 0x00: The Host has no preferred or required coding when transmitting on the LE Coded PHY
  • 0x01: The Host prefers that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x02: The Host prefers that S=8 coding be used when transmitting on the LE Coded PHY
  • 0x03: The Host requires that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x04: The Host requires that S=8 coding be used when transmitting on the LE Coded PHY

    • Secondary_Adv_PHY_Options

    1

    Advertising PHY options.

  • 0x00: The Host has no preferred or required coding when transmitting on the LE Coded PHY
  • 0x01: The Host prefers that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x02: The Host prefers that S=8 coding be used when transmitting on the LE Coded PHY
  • 0x03: The Host requires that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x04: The Host requires that S=8 coding be used when transmitting on the LE Coded PHY

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Selected_TX_Power

    1

    Power level selected by the Controller. Units: dBm.

  • -127 ... 20

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_SUBEVENT_DATA

    Description

    This command is used by the Host to set the data for one or more subevents of PAwR in reply to an HCI_LE_Periodic_Advertising_Subevent_Data_Request event. The data for a subevent is transmitted only once.
    See Core Specification [Vol 4, Part E, 7.8.125].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Num_Subevents

    1

    Number of subevent data in the command.

  • 0x01 ... 0x0F

    • Subevent_Param

    252

    Must be composed of the following fields: Subevent (1 byte), Response_Slot_Start (1 byte), Response_Slot_Count (1 byte), Subevent_Data_Length (1 byte), Subevent_Data ('Subevent_Data_Length' bytes). All fields are repeated 'Num_Subevents' times. Note: the indicated size is the maximum size.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_RESPONSE_DATA

    Description

    This command is used by the Host to set the data for a response slot in a specific subevent of the PAwR identified by the Sync_Handle. The data for a response slot is transmitted only once.
    See Core Specification [Vol 4, Part E, 7.8.126].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Request_Event

    2

    The value of paEventCounter (see Core Specification [Vol 6, Part B, 4.4.2.1]) for the periodic advertising packet that the Host is responding to.

    Request_Subevent

    1

    The subevent for the periodic advertising packet that the Host is responding to.

    Response_Subevent

    1

    Used to identify the subevent of the PAwR train.

  • 0x00 ... 0x7F

    • Response_Slot

    1

    Used to identify the response slot of the PAwR train.

  • 0x00 ... 0xFF

    • Response_Data_Length

    1

    Length of Response_Data in octets

    Response_Data

    Response_Data_Length

    Response data formatted as defined in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_SYNC_SUBEVENT

    Description

    This command is used to instruct the Controller to synchronize with a subset of the subevents within a PAwR train identified by the Sync_Handle parameter, listen for packets sent by the peer device and pass any received data up to the Host.
    See Core Specification [Vol 4, Part E, 7.8.127].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Periodic_Advertising_Properties

    2

    Properties.

    Bitmask of:

  • 0x0040: Include TxPower in the advertising PDU

    • Num_Subevents

    1

    Length of Subevent in octets

    Subevent

    Num_Subevents

    Subevent number.

  • 0x00 ... 0x7F

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_EXTENDED_CREATE_CONNECTION_V2

    Description

    This command is used to create an ACL connection, with the local device in the Central role, to a connectable advertiser. The command is also used to create an ACL connection between a periodic advertiser and a synchronized device.
    See Core Specification [Vol 4, Part E, 7.8.68].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify the subevent where a connection request shall be initiated from a periodic advertising train.

  • 0xFF: Parameter not used
  • 0x00 ... 0xEF

    • Subevent

    1

    Subevent where the connection request is to be sent.

  • 0xFF: Parameter not used
  • 0x00 ... 0x7F

    • Initiator_Filter_Policy

    1

    Initiator filter policy.

  • 0x00: Filter Accept List is not used to determine which advertiser to connect to
  • 0x01: Filter Accept List is used to determine which advertiser to connect to (Peer_Address_Type and Peer_Address are ignored)

    • Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random Address

    • Peer_Address_Type

    1

    Address type of the peer device.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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:

  • 0x01: Scan connectable advertisements on the LE 1M PHY- Connection parameters for the LE 1M PHY
  • 0x02: Connection parameters for the LE 2M PHY
  • 0x04: Scan connectable advertisements on the LE Coded PHY

    • 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.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Scan_Window[i]

    2

    Duration of the scan on the primary advertising physical channel. Time = N * 0.625 ms.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Conn_Interval_Min[i]

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max[i]

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency[i]

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Min_CE_Length[i]

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Max_CE_Length[i]

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT

    • HCI_LE_SET_PERIODIC_ADVERTISING_PARAMETERS_V2

    Description

    This command is used by the Host to set the parameters for periodic advertising.
    See Core Specification [Vol 4, Part E, 7.8.61].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Periodic_Adv_Interval_Min

    2

    Minimum advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Periodic_Adv_Interval_Max

    2

    Maximum advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Periodic_Adv_Properties

    2

    Properties.

    Bitmask of:

  • 0x0040: Include TxPower in the advertising PDU

    • Num_Subevents

    1

    Number of subevents.

  • 0x00 ... 0x80

    • Subevent_Interval

    1

    Interval between subevents. Time = N * 1.25 ms.

  • 0x06 (7.50 ms) ... 0xFF (318.75 ms)

    • Response_Slot_Delay

    1

    Time between the advertising packet in a subevent and the first response slot. Time = N * 1.25 ms.

  • 0x00 (0.00 ms) : No response slots
  • 0x01 (1.25 ms) ... 0xFE (317.50 ms)

    • Response_Slot_Spacing

    1

    Time between response slots. Time = N * 0.125 ms.

  • 0x00 (0.000 ms) : No response slots
  • 0x02 (0.250 ms) ... 0xFF (31.875 ms)

    • Num_Response_Slots

    1

    Number of subevent response slots.

  • 0x00: No response slots
  • 0x01 ... 0xFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_ALL_LOCAL_SUPPORTED_FEATURES

    Description

    This command requests the supported LE features for the Controller.
    See Core Specification [Vol 4, Part E, 7.8.128].

    This command is not available on STM32WBA5/6.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Max_Page

    1

    The number of the highest-numbered page of the supported LE features that contains at least one bit set to 1.

  • 0x01 ... 0x0A

    • LE_Features

    248

    Bit Mask List of the supported LE features. See Core Specification [Vol 6, Part B, 4.6].

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_ALL_REMOTE_FEATURES

    Description

    This command requests, from the remote device identified by the Connection_Handle, the features used on the connection and the features supported by the remote device.
    See Core Specification [Vol 4, Part E, 7.8.129].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Pages_Requested

    1

    The number of the highest-numbered page of features that the Host requires and the Controller shall obtain.

  • 0x01 ... 0x0A

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_READ_ALL_REMOTE_FEATURES_COMPLETE_EVENT

    • HCI_LE_CS_READ_LOCAL_SUPPORTED_CAPABILITIES

    Description

    This command allows a Host to read the CS capabilities that are supported by the local Controller. This command may be used along with the local supported features to provide additional details of the supported CS capabilities.
    See Core Specification [Vol 4, Part E, 7.8.130].

    This command is not available on STM32WBA5/6.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Num_Config_Supported

    1

    Number of CS configurations supported per connection.

  • 0x01 ... 0x04

    • Max_Consecutive_Procedures_Supported

    2

    Maximum number of consecutive CS procedures supported.

  • 0x0000: Support for both a fixed number of consecutive CS procedures and for an indefinite number of CS procedures until termination
  • 0x0001 ... 0xFFFF

    • Num_Antennas_Supported

    1

    Number of antennas supported.

  • 0x01 ... 0x04

    • Max_Antenna_Paths_Supported

    1

    Maximum number of antenna paths supported.

  • 0x01 ... 0x04

    • Roles_Supported

    1

    Indicates the CS roles that are supported by the remote Controller.

    Bitmask of:

  • 0x01: Initiator
  • 0x02: Reflector

    • Optional_Modes_Supported

    1

    Indicates the optional CS modes that are supported by the remote Controller.

    Bitmask of:

  • 0x01: Mode-3

    • RTT_Capability

    1

    Indicates (with following parameters) the time-of-flight accuracy.

    Bitmask of:

  • 0x01: If set to 1, then the value reflected in the RTT_AA_Only_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_AA_Only_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_AA_Only_N field is set to 0, then the bit shall be ignored.
  • 0x02: If set to 1, then the value reflected in the RTT_Sounding_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_Sounding_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_Sounding_N field is set to 0, then the bit shall be ignored.
  • 0x04: If set to 1, then the value reflected in the RTT_Random_Payload_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_Random_Payload_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_Random_Payload_N field is set to 0, then the bit shall be ignored.

    • RTT_AA_Only_N

    1

    Number of CS_SYNC exchanges needed to satisfy the precision requirements.

  • 0x00: RTT AA-only not supported
  • 0x01 ... 0xFF

    • RTT_Sounding_N

    1

    Number of CS_SYNC exchanges needed to satisfy the precision requirements.

  • 0x00: RTT Sounding not supported
  • 0x01 ... 0xFF

    • RTT_Random_Payload_N

    1

    Number of CS_SYNC exchanges needed to satisfy the time-of-flight precision requirements.

  • 0x00: RTT Random Payload not supported
  • 0x01 ... 0xFF

    • NADM_Sounding_Capability

    2

    Indicates (with next parameter) the support by the remote Controller for reporting Normalized Attack Detector Metric (NADM) when a CS_SYNC with a sounding sequence or random sequence is received.

    Bitmask of:

  • 0x0001: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with sounding sequence is received

    • NADM_Random_Capability

    2

    Indicates (with previous parameter) the support by the remote Controller for reporting Normalized Attack Detector Metric (NADM) when a CS_SYNC with a sounding sequence or random sequence is received.

    Bitmask of:

  • 0x0001: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with random sequence is received

    • CS_SYNC_PHYs_Supported

    1

    Indicates the optional transmit and receive PHYs that are supported by the remote Controller for CS_SYNC exchanges.

    Bitmask of:

  • 0x02: LE 2M PHY
  • 0x04: LE 2M 2BT PHY

    • Subfeatures_Supported

    2

    Indicates which optional subfeatures are supported by the remote Controller.

    Bitmask of:

  • 0x0002: CS with a Frequency Actuation Error of zero relative to mode-0 transmissions in the reflector role
  • 0x0004: CS Channel Selection Algorithm #3c

    • T_IP1_Times_Supported

    2

    Indicates the supported time durations for T_IP1.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported

    • T_IP2_Times_Supported

    2

    Indicates the supported time durations for T_IP2.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported

    • T_FCS_Times_Supported

    2

    Indicates the supported time durations for T_FCS.

    Bitmask of:

  • 0x0001: 15 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported
  • 0x0080: 100 us supported
  • 0x0100: 120 us supported

    • T_PM_Times_Supported

    2

    Indicates the supported time durations for T_PM.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported

    • T_SW_Time_Supported

    1

    Time in microseconds for the antenna switch period of the CS tones.

  • 0x00
  • 0x01
  • 0x02
  • 0x04
  • 0x0A

    • TX_SNR_Capability

    1

    Indicates the supported SNR levels used in RTT packets.

    Bitmask of:

  • 0x01: 18 dB supported
  • 0x02: 21 dB supported
  • 0x04: 24 dB supported
  • 0x08: 27 dB supported
  • 0x10: 30 dB supported

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CS_READ_REMOTE_SUPPORTED_CAPABILITIES

    Description

    This command allows a Host to query the CS capabilities that are supported by the remote Controller. If no Channel Sounding Capability Exchange procedure has been initiated on the ACL connection specified by the Connection_Handle and if no prior HCI_LE_CS_Write_Cached_Remote_Supported_Capabilities command has been issued by the Host, then the Controller shall initiate a Channel Sounding Capability Exchange procedure on the ACL. Otherwise, the Controller may use a cached copy of the capabilities of the remote device.
    See Core Specification [Vol 4, Part E, 7.8.131].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CS_READ_REMOTE_SUPPORTED_CAPABILITIES_COMPLETE_EVENT

    • HCI_LE_CS_WRITE_CACHED_REMOTE_SUPPORTED_CAPABILITIES

    Description

    This command allows a Host to write the cached copy of the CS capabilities that are supported by the remote Controller for the connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.132].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Num_Config_Supported

    1

    Number of CS configurations supported per connection.

  • 0x01 ... 0x04

    • Max_Consecutive_Procedures_Supported

    2

    Maximum number of consecutive CS procedures supported.

  • 0x0000: Support for both a fixed number of consecutive CS procedures and for an indefinite number of CS procedures until termination
  • 0x0001 ... 0xFFFF

    • Num_Antennas_Supported

    1

    Number of antennas supported.

  • 0x01 ... 0x04

    • Max_Antenna_Paths_Supported

    1

    Maximum number of antenna paths supported.

  • 0x01 ... 0x04

    • Roles_Supported

    1

    Indicates the CS roles that are supported by the remote Controller.

    Bitmask of:

  • 0x01: Initiator
  • 0x02: Reflector

    • Modes_Supported

    1

    Indicates the optional CS modes that are supported by the remote Controller.

    Bitmask of:

  • 0x01: Mode-3

    • RTT_Capability

    1

    Indicates (with following parameters) the time-of-flight accuracy.

    Bitmask of:

  • 0x01: If set to 1, then the value reflected in the RTT_AA_Only_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_AA_Only_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_AA_Only_N field is set to 0, then the bit shall be ignored.
  • 0x02: If set to 1, then the value reflected in the RTT_Sounding_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_Sounding_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_Sounding_N field is set to 0, then the bit shall be ignored.
  • 0x04: If set to 1, then the value reflected in the RTT_Random_Payload_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_Random_Payload_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_Random_Payload_N field is set to 0, then the bit shall be ignored.

    • RTT_AA_Only_N

    1

    Number of CS_SYNC exchanges needed to satisfy the precision requirements.

  • 0x00: RTT AA-only not supported
  • 0x01 ... 0xFF

    • RTT_Sounding_N

    1

    Number of CS_SYNC exchanges needed to satisfy the precision requirements.

  • 0x00: RTT Sounding not supported
  • 0x01 ... 0xFF

    • RTT_Random_Payload_N

    1

    Number of CS_SYNC exchanges needed to satisfy the time-of-flight precision requirements.

  • 0x00: RTT Random Payload not supported
  • 0x01 ... 0xFF

    • NADM_Sounding_Capability

    2

    Indicates (with next parameter) the support by the remote Controller for reporting Normalized Attack Detector Metric (NADM) when a CS_SYNC with a sounding sequence or random sequence is received.

    Bitmask of:

  • 0x0001: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with sounding sequence is received

    • NADM_Random_Capability

    2

    Indicates (with previous parameter) the support by the remote Controller for reporting Normalized Attack Detector Metric (NADM) when a CS_SYNC with a sounding sequence or random sequence is received.

    Bitmask of:

  • 0x0001: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with random sequence is received

    • CS_SYNC_PHYs_Supported

    1

    Indicates the optional transmit and receive PHYs that are supported by the remote Controller for CS_SYNC exchanges.

    Bitmask of:

  • 0x02: LE 2M PHY
  • 0x04: LE 2M 2BT PHY

    • Subfeatures_Supported

    2

    Indicates which optional subfeatures are supported by the remote Controller.

    Bitmask of:

  • 0x0002: CS with a Frequency Actuation Error of zero relative to mode-0 transmissions in the reflector role
  • 0x0004: CS Channel Selection Algorithm #3c

    • T_IP1_Times_Supported

    2

    Indicates the supported time durations for T_IP1.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported

    • T_IP2_Times_Supported

    2

    Indicates the supported time durations for T_IP2.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported

    • T_FCS_Times_Supported

    2

    Indicates the supported time durations for T_FCS.

    Bitmask of:

  • 0x0001: 15 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported
  • 0x0080: 100 us supported
  • 0x0100: 120 us supported

    • T_PM_Times_Supported

    2

    Indicates the supported time durations for T_PM.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported

    • T_SW_Time_Supported

    1

    Time in microseconds for the antenna switch period of the CS tones.

  • 0x00
  • 0x01
  • 0x02
  • 0x04
  • 0x0A

    • TX_SNR_Capability

    1

    Indicates the supported SNR levels used in RTT packets.

    Bitmask of:

  • 0x01: 18 dB supported
  • 0x02: 21 dB supported
  • 0x04: 24 dB supported
  • 0x08: 27 dB supported
  • 0x10: 30 dB supported

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CS_SECURITY_ENABLE

    Description

    This command is used by a Host to start or restart the Channel Sounding Security Start procedure in the local Controller for the ACL connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.133].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CS_SECURITY_ENABLE_COMPLETE_EVENT

    • HCI_LE_CS_SET_DEFAULT_SETTINGS

    Description

    This command is used by a Host to set default CS settings in the local Controller for the connection identified by the Connection_Handle parameter. The default settings specify that all roles are disabled in a Controller and CS_SYNC_Antenna_Selection is set to 0x01.
    See Core Specification [Vol 4, Part E, 7.8.134].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Role_Enable

    1

    Enables or disables the CS roles in the local Controller.

    Bitmask of:

  • 0x01: Initiator role is enabled
  • 0x02: Reflector role is enabled

    • CS_SYNC_Antenna_Selection

    1

    Antenna identifier to be used for CS_SYNC packets by the local Controller.

  • 0xFE: In repetitive order from 1 to 4
  • 0xFF: Host does not have a recommendation
  • 0x01 ... 0x04

    • Max_TX_Power

    1

    The maximum transmit power level to be used for all CS transmissions (signed integer). Units: dBm.

  • -127 ... 20

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CS_READ_REMOTE_FAE_TABLE

    Description

    This command is used by a Host to read the per-channel mode 0 Frequency Actuation Error table of the remote Controller.
    See Core Specification [Vol 4, Part E, 7.8.135].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CS_READ_REMOTE_FAE_TABLE_COMPLETE_EVENT

    • HCI_LE_CS_WRITE_CACHED_REMOTE_FAE_TABLE

    Description

    This command is used by a Host to write a cached copy of the per-channel mode 0 Frequency Actuation Error table of the remote device in the local Controller.
    See Core Specification [Vol 4, Part E, 7.8.136].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Remote_FAE_Table

    72

    Per-channel mode-0 Frequency Actuation Error table of the local Controller.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CS_CREATE_CONFIG

    Description

    This command is used by a Host to create a new CS configuration or update an existing CS configuration with the identifier Config_ID on the connection identified by the Connection_Handle in the local and/or the remote Controller.
    See Core Specification [Vol 4, Part E, 7.8.137].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • Create_Context

    1

    Indicates the destination of the CS configuration.

  • 0x00: Write CS configuration in local Controller only
  • 0x01: Write CS configuration in both local and remote Controller using Channel Sounding Configuration procedure

    • Main_Mode_Type

    1

    Indicates the CS mode to be used.

  • 0x01: Mode-1
  • 0x02: Mode-2
  • 0x03: Mode-3

    • Sub_Mode_Type

    1

    Indicates the CS sub-mode to be used.

  • 0x01: Mode-1
  • 0x02: Mode-2
  • 0x03: Mode-3
  • 0xFF: Unused

    • Min_Main_Mode_Steps

    1

    Minimum number of CS main mode steps to be executed before a submode step is executed.

  • 0x02 ... 0xFF

    • Max_Main_Mode_Steps

    1

    Maximum number of CS main mode steps to be executed before a submode step is executed.

  • 0x02 ... 0xFF

    • Main_Mode_Repetition

    1

    The number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event.

  • 0 ... 3

    • Mode_0_Steps

    1

    Number of CS mode-0 steps to be included at the beginning of each CS subevent.

  • 1 ... 3

    • Role

    1

    Indicates the CS role for the local Controller.

  • 0x00: Initiator
  • 0x01: Reflector

    • RTT_Type

    1

    Indicates the RTT variant to be used during the CS procedure.

  • 0x00: RTT AA-only
  • 0x01: RTT with 32-bit sounding sequence
  • 0x02: RTT with 96-bit sounding sequence
  • 0x03: RTT with 32-bit random sequence
  • 0x04: RTT with 64-bit random sequence
  • 0x05: RTT with 96-bit random sequence
  • 0x06: RTT with 128-bit random sequence

    • CS_SYNC_PHY

    1

    Indicates the PHY to be used for CS_SYNC exchanges during the CS procedure.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE 2M 2BT PHY

    • Channel_Map

    10

    This parameter contains 80 1-bit fields. The nth such field (in the range 0 to 78) contains the value for the CS channel index n. Channel n is enabled for CS procedure = 1 Channel n is disabled for CS procedure = 0 Channels n = 0, 1, 23, 24, 25, 77, and 78 shall be ignored and shall be set to zero. At least 15 channels shall be enabled. The most significant bit (bit 79) is reserved for future use.

    Channel_Map_Repetition

    1

    The number of times the map represented by the Channel_Map field is to be cycled through for non-mode-0 steps within a CS procedure.

  • 0x01 ... 0xFF

    • Channel_Selection_Type

    1

    Indicates the Channel Selection Algorithm to be used during the CS procedure for non-mode-0 steps.

  • 0x00: Use Channel Selection Algorithm #3b for non-mode-0 CS steps
  • 0x01: Use Channel Selection Algorithm #3c for non-mode-0 CS steps

    • Ch3c_Shape

    1

    Indicates the shape to be used for user-specified channel sequence.

  • 0x00: Use Hat shape
  • 0x01: Use X shape

    • Ch3c_Jump

    1

    Number of channels skipped in each rising and falling sequence.

  • 0x02 ... 0x08

    • Reserved

    1

    Reserved, shall be set to 0.

  • 0x00

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CS_CONFIG_COMPLETE_EVENT

    • HCI_LE_CS_REMOVE_CONFIG

    Description

    This command is used to remove a CS configuration identified by Config_ID from the local Controller for the connection identified by the Connection_Handle parameter. When the Host issues this command, the local Controller shall initiate a Channel Sounding Configuration procedure to remove the CS configuration from both the local and remote device.
    See Core Specification [Vol 4, Part E, 7.8.138].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CS_CONFIG_COMPLETE_EVENT

    • HCI_LE_CS_SET_CHANNEL_CLASSIFICATION

    Description

    This command is used by a Host to update the channel classification based on its local information. This channel classification persists until overwritten with a subsequent HCI_LE_CS_Set_CS_Channel_Classification command or until the Controller is reset. The Controller may combine the channel classification information provided by the Host along with local channel classification information to send an updated CS channel map to the remote Controller.
    See Core Specification [Vol 4, Part E, 7.8.139].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Channel_Classification

    10

    This parameter contains 80 1-bit fields. The nth such field (in the range 0 to 78) contains the value for the CS channel index n. Channel n is enabled for CS procedure = 1 Channel n is disabled for CS procedure = 0 Channels n = 0, 1, 23, 24, 25, 77, and 78 shall be reserved for future use and shall be set to zero. At least 15 channels shall be enabled. The most significant bit (bit 79) is reserved for future use.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CS_SET_PROCEDURE_PARAMETERS

    Description

    This command is used by a Host to set the parameters for the scheduling of one or more CS procedures by the local Controller, with the remote device for the CS configuration identified by Config_ID and the connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.140].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • Max_Procedure_Len

    2

    Maximum duration for each CS procedure. Time = N * 0.625 ms.

  • 0x0001 (0.625 ms) ... 0xFFFF (40959.375 ms)

    • Min_Procedure_Interval

    2

    Minimum number of connection events between consecutive CS procedures.

  • 0x0001 ... 0xFFFF

    • Max_Procedure_Interval

    2

    Maximum number of connection events between consecutive CS procedures.

  • 0x0001 ... 0xFFFF

    • Max_Procedure_Count

    2

    Maximum number of CS procedures to be scheduled.

  • 0x0000: CS procedures to continue until disabled
  • 0x0001 ... 0xFFFF

    • Min_Subevent_Len

    3

    Minimum suggested duration for each CS subevent in microseconds.

  • 1250 ... 4000000

    • Max_Subevent_Len

    3

    Maximum suggested duration for each CS subevent in microseconds.

  • 1250 ... 4000000

    • Tone_Antenna_Config_Selection

    1

    Antenna Configuration Index.

  • 0 ... 7

    • PHY

    1

    Applying PHY.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE Coded PHY with S=8 data coding
  • 0x04: LE Coded PHY with S=2 data coding

    • Tx_Power_Delta

    1

    Transmit power delta, in signed dB, to indicate the recommended difference between the remote device's power level for the CS tones and RTT packets and the existing power level for the PHY indicated by the PHY parameter.

  • 0x80: Host does not have a recommendation for transmit power delta
  • 0x00 ... 0x7F: 0 to 127 dB
  • 0x81 ... 0xFF: -127 to -1 dB

    • Preferred_Peer_Antenna

    1

    Preferred peer-ordered antenna elements to be used by the remote device.

    Bitmask of:

  • 0x01: Use first ordered antenna element
  • 0x02: Use second ordered antenna element
  • 0x04: Use third ordered antenna element
  • 0x08: Use fourth ordered antenna element

    • SNR_Control_Initiator

    1

    SNR control adjustment for the CS_SYNC transmissions of the initiator.

  • 0x00: SNR control adjustment of 18 dB
  • 0x01: SNR control adjustment of 21 dB
  • 0x02: SNR control adjustment of 24 dB
  • 0x03: SNR control adjustment of 27 dB
  • 0x04: SNR control adjustment of 30 dB
  • 0xFF: SNR control is not to be applied

    • SNR_Control_Reflector

    1

    SNR control adjustment for the CS_SYNC transmissions of the reflector.

  • 0x00: SNR control adjustment of 18 dB
  • 0x01: SNR control adjustment of 21 dB
  • 0x02: SNR control adjustment of 24 dB
  • 0x03: SNR control adjustment of 27 dB
  • 0x04: SNR control adjustment of 30 dB
  • 0xFF: SNR control is not to be applied

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CS_PROCEDURE_ENABLE

    Description

    This command is used by a Host to enable or disable the scheduling of CS procedures by the local Controller, with the remote device for the connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.8.141].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • Enable

    1

    Enables or disables CS procedures by the local Controller.

  • 0x00: CS procedures are to be disabled
  • 0x01: CS procedures are to be enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CS_PROCEDURE_ENABLE_COMPLETE_EVENT

    • HCI_LE_ADD_DEVICE_TO_MONITORED_ADVERTISERS_LIST

    Description

    This command is used to add a single device to a list of devices monitored while scanning.
    See Core Specification [Vol 4, Part E, 7.8.146].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Address

    6

    Public Device Address or Random Device Address.

    RSSI_Threshold_Low

    1

    (signed integer). Units: dBm.

  • -127 ... 20

    • RSSI_Threshold_High

    1

    (signed integer). Units: dBm.

  • -127 ... 20

    • Timeout

    1

    Time (in seconds) that the device from which advertisements are received has an RSSI value that remains below the RSSI_Threshold_Low before an event is generated.

  • 0x01 ... 0xFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_REMOVE_DEVICE_FROM_MONITORED_ADVERTISERS_LIST

    Description

    This command is used to remove a single device from the Monitored Advertisers List..
    See Core Specification [Vol 4, Part E, 7.8.147].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Address

    6

    Public Device Address or Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CLEAR_MONITORED_ADVERTISERS_LIST

    Description

    This command is used to remove all devices from the Monitored Advertisers List.
    See Core Specification [Vol 4, Part E, 7.8.148].

    This command is not available on STM32WBA5/6.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_READ_MONITORED_ADVERTISERS_LIST_SIZE

    Description

    This command is used to read the total number of entries in the Monitored Advertisers List that the Controller can store.
    See Core Specification [Vol 4, Part E, 7.8.150].

    This command is not available on STM32WBA5/6.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Number

    1

    Number of entries allowed in the Monitored Advertisers List.

  • 0x01 ... 0xFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ENABLE_MONITORING_ADVERTISERS

    Description

    This command is used by a Host to request the Controller to enable or disable the monitoring of advertisers in the Monitored Advertisers List and generate the HCI_LE_MONITORED_ADVERTISERS_REPORT_EVENT when necessary..
    See Core Specification [Vol 4, Part E, 7.8.149].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Enable

    1

    Enables or disables the monitoring of advertisers.

  • 0x00: Disable
  • 0x01: Enable

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_MONITORED_ADVERTISERS_REPORT_EVENT

    • HCI_LE_FRAME_SPACE_UPDATE

    Description

    This command allows the Host to request a change to one or more frame space values. This command may be issued on both the Central and the Peripheral..
    See Core Specification [Vol 4, Part E, 7.8.151].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Frame_Space_Min

    2

    The minimum requested frame space value, in microseconds.

  • 0x0000 ... 0x2710

    • Frame_Space_Max

    2

    The maximum requested frame space value, in microseconds.

  • 0x0000 ... 0x2710

    • PHYS

    1

    Indicates (with Spacing_Types) which frame space values are impacted by the update.

    Bitmask of:

  • 0x01: LE 1M
  • 0x02: LE 2M
  • 0x04: LE Coded PHY

    • Spacing_Types

    2

    Indicates (with PHYS) which frame space values are impacted by the update.

    Bitmask of:

  • 0x0001: T_IFS_ACL_CP
  • 0x0002: T_IFS_ACL_PC
  • 0x0004: T_MCES
  • 0x0008: T_IFS_CIS
  • 0x0010: T_MSS_CIS

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_FRAME_SPACE_UPDATE_COMPLETE_EVENT

    • HCI Test commands

    CommandOpcodeBPBFPOLO
    HCI_LE_RECEIVER_TEST

    0x201D

    Y

    Y

    Y

    Y

    HCI_LE_TRANSMITTER_TEST

    0x201E

    Y

    Y

    Y

    Y

    HCI_LE_TEST_END

    0x201F

    Y

    Y

    Y

    Y

    HCI_LE_RECEIVER_TEST_V2

    0x2033

    Y

    Y

    Y

    Y

    HCI_LE_TRANSMITTER_TEST_V2

    0x2034

    Y

    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

    Y

    HCI_LE_CS_TEST

    0x2095

    Y

    HCI_LE_CS_TEST_END

    0x2096

    Y

    HCI_LE_RECEIVER_TEST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.28].

    Input parameters

    ParameterSizeDescriptionPossible values

    RX_Frequency

    1

    N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz

  • 0x00 ... 0x27

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_TRANSMITTER_TEST

    Description

    This command is used to start a test where the DUT generates test reference packets at a fixed interval.
    See Core Specification [Vol 4, Part E, 7.8.29].

    Input parameters

    ParameterSizeDescriptionPossible values

    TX_Frequency

    1

    N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz

  • 0x00 ... 0x27

    • Length_Of_Test_Data

    1

    Length in bytes of payload data in each packet.

  • 0x00 ... 0x25: for BO variant
  • 0x00 ... 0xFF: otherwise

    • Packet_Payload

    1

    Type of packet payload.

  • 0x00: Pseudo-Random bit sequence 9
  • 0x01: Pattern of alternating bits '11110000'
  • 0x02: Pattern of alternating bits '10101010'
  • 0x03: Pseudo-Random bit sequence 15
  • 0x04: Pattern of All '1' bits
  • 0x05: Pattern of All '0' bits
  • 0x06: Pattern of alternating bits '00001111'
  • 0x07: Pattern of alternating bits '0101'

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_TEST_END

    Description

    This command is used to stop any test which is in progress. The Number_Of_Packets for a transmitter test is reported as 0x0000. The Number_Of_Packets is an unsigned number and contains the number of received packets.
    See Core Specification [Vol 4, Part E, 7.8.30].

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Number_Of_Packets

    2

    Number of packets received

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_RECEIVER_TEST_V2

    Description

    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 Core Specification [Vol 4, Part E, 7.8.28].

    Input parameters

    ParameterSizeDescriptionPossible values

    RX_Frequency

    1

    N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz

  • 0x00 ... 0x27

    • PHY

    1

    PHY to be used by the receiver.

  • 0x01: Receiver set to use the LE 1M PHY
  • 0x02: Receiver set to use the LE 2M PHY
  • 0x03: Receiver set to use the LE Coded PHY

    • Modulation_Index

    1

    Modulation index capability of the transmitter

  • 0x00: Assume transmitter will have a standard modulation index
  • 0x01: Assume transmitter will have a stable modulation index

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_TRANSMITTER_TEST_V2

    Description

    This command is used to start a test where the DUT generates test reference packets at a fixed interval.
    See Core Specification [Vol 4, Part E, 7.8.29].

    Input parameters

    ParameterSizeDescriptionPossible values

    TX_Frequency

    1

    N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz

  • 0x00 ... 0x27

    • Length_Of_Test_Data

    1

    Length in bytes of payload data in each packet.

  • 0x00 ... 0x25: for BO variant
  • 0x00 ... 0xFF: otherwise

    • Packet_Payload

    1

    Type of packet payload.

  • 0x00: Pseudo-Random bit sequence 9
  • 0x01: Pattern of alternating bits '11110000'
  • 0x02: Pattern of alternating bits '10101010'
  • 0x03: Pseudo-Random bit sequence 15
  • 0x04: Pattern of All '1' bits
  • 0x05: Pattern of All '0' bits
  • 0x06: Pattern of alternating bits '00001111'
  • 0x07: Pattern of alternating bits '0101'

    • PHY

    1

    PHY to use for test packet

  • 0x01: Transmitter set to use the LE 1M PHY
  • 0x02: Transmitter set to use the LE 2M PHY
  • 0x03: Transmitter set to use the LE Coded PHY with S=8 data coding
  • 0x04: Transmitter set to use the LE Coded PHY with S=2 data coding

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_RECEIVER_TEST_V3

    Description

    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 Core Specification [Vol 4, Part E, 7.8.28].

    Input parameters

    ParameterSizeDescriptionPossible values

    RX_Frequency

    1

    N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz

  • 0x00 ... 0x27

    • PHY

    1

    PHY to be used by the receiver.

  • 0x01: Receiver set to use the LE 1M PHY
  • 0x02: Receiver set to use the LE 2M PHY
  • 0x03: Receiver set to use the LE Coded PHY

    • Modulation_Index

    1

    Modulation index capability of the transmitter

  • 0x00: Assume transmitter will have a standard modulation index
  • 0x01: Assume transmitter will have a stable modulation index

    • Expected_CTE_Length

    1

    Expected length of the Constant Tone Extensions in received test reference packets.

  • 0x00: No Constant Tone Extension expected (default)
  • 0x02 ... 0x14: Expected length of the Constant Tone Extension in 8 us units

    • Expected_CTE_Type

    1

    Expected type of the Constant Tone Extensions in received test reference packets.

  • 0x00: Expect AoA Constant Tone Extension
  • 0x01: Expect AoD Constant Tone Extension with 1 us slots
  • 0x02: Expect AoD Constant Tone Extension with 2 us slots

    • Slot_Durations

    1

    Slot Durations.

  • 0x01: Switching and sampling slots are 1 us each
  • 0x02: Switching and sampling slots are 2 us each

    • Switching_Pattern_Length

    1

    Number of Antenna IDs in the pattern.

  • 0x02 ... 0x4B

    • Antenna_IDs

    Switching_Pattern_Length

    Antenna ID in the pattern.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_CONNECTIONLESS_IQ_REPORT_EVENT

    • HCI_LE_TRANSMITTER_TEST_V3

    Description

    This command is used for testing purpose.
    See Core Specification [Vol 4, Part E, 7.8.29].

    Input parameters

    ParameterSizeDescriptionPossible values

    TX_Frequency

    1

    N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz

  • 0x00 ... 0x27

    • Length_Of_Test_Data

    1

    Length in bytes of payload data in each packet.

  • 0x00 ... 0x25: for BO variant
  • 0x00 ... 0xFF: otherwise

    • Packet_Payload

    1

    Type of packet payload.

  • 0x00: Pseudo-Random bit sequence 9
  • 0x01: Pattern of alternating bits '11110000'
  • 0x02: Pattern of alternating bits '10101010'
  • 0x03: Pseudo-Random bit sequence 15
  • 0x04: Pattern of All '1' bits
  • 0x05: Pattern of All '0' bits
  • 0x06: Pattern of alternating bits '00001111'
  • 0x07: Pattern of alternating bits '0101'

    • PHY

    1

    PHY to use for test packet

  • 0x01: Transmitter set to use the LE 1M PHY
  • 0x02: Transmitter set to use the LE 2M PHY
  • 0x03: Transmitter set to use the LE Coded PHY with S=8 data coding
  • 0x04: Transmitter set to use the LE Coded PHY with S=2 data coding

    • CTE_Length

    1

    Constant Tone Extension length in 8 us units.

  • 0x00: Do not transmit a Constant Tone Extension
  • 0x02 ... 0x14

    • CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots

    • Switching_Pattern_Length

    1

    Number of Antenna IDs in the pattern.

  • 0x02 ... 0x4B

    • Antenna_IDs

    Switching_Pattern_Length

    Antenna ID in the pattern.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ISO_TRANSMIT_TEST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.111].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Payload_Type

    1

    SDU configtration.

  • 0x00: Zero length payload
  • 0x01: Variable length payload
  • 0x02: Maximum length payload

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ISO_RECEIVE_TEST

    Description

    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 Core Specification [Vol 4, Part E, 7.8.112].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Payload_Type

    1

    SDU configtration.

  • 0x00: Zero length payload
  • 0x01: Variable length payload
  • 0x02: Maximum length payload

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ISO_READ_TEST_COUNTERS

    Description

    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 Core Specification [Vol 4, Part E, 7.8.113].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Received_SDU_Count

    4

    Number in the Received_SDU_Count.

    Missed_SDU_Count

    4

    Number in the Missed_SDU_Count.

    Failed_SDU_Count

    4

    Number in the Failed_SDU_Count.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_ISO_TEST_END

    Description

    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 Core Specification [Vol 4, Part E, 7.8.114].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Received_SDU_Count

    4

    Number in the Received_SDU_Count.

    Missed_SDU_Count

    4

    Number in the Missed_SDU_Count.

    Failed_SDU_Count

    4

    Number in the Failed_SDU_Count.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_TRANSMITTER_TEST_V4

    Description

    This command is used for testing purpose.
    See Core Specification [Vol 4, Part E, 7.8.29].

    Input parameters

    ParameterSizeDescriptionPossible values

    TX_Frequency

    1

    N = (F - 2402) / 2 Frequency Range : 2402 MHz to 2480 MHz

  • 0x00 ... 0x27

    • Length_Of_Test_Data

    1

    Length in bytes of payload data in each packet.

  • 0x00 ... 0x25: for BO variant
  • 0x00 ... 0xFF: otherwise

    • Packet_Payload

    1

    Type of packet payload.

  • 0x00: Pseudo-Random bit sequence 9
  • 0x01: Pattern of alternating bits '11110000'
  • 0x02: Pattern of alternating bits '10101010'
  • 0x03: Pseudo-Random bit sequence 15
  • 0x04: Pattern of All '1' bits
  • 0x05: Pattern of All '0' bits
  • 0x06: Pattern of alternating bits '00001111'
  • 0x07: Pattern of alternating bits '0101'

    • PHY

    1

    PHY to use for test packet

  • 0x01: Transmitter set to use the LE 1M PHY
  • 0x02: Transmitter set to use the LE 2M PHY
  • 0x03: Transmitter set to use the LE Coded PHY with S=8 data coding
  • 0x04: Transmitter set to use the LE Coded PHY with S=2 data coding

    • CTE_Length

    1

    Constant Tone Extension length in 8 us units.

  • 0x00: Do not transmit a Constant Tone Extension
  • 0x02 ... 0x14

    • CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots

    • Switching_Pattern_Length

    1

    Number of Antenna IDs in the pattern.

  • 0x02 ... 0x4B

    • Antenna_IDs

    Switching_Pattern_Length

    Antenna ID in the pattern.

    TX_Power_Level

    1

    Transmit power level (signed integer). Units: dBm.

  • 126: Minimum transmit power level
  • 127: Maximum transmit power level
  • -127 ... 20

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI_LE_CS_TEST

    Description

    This command is used to start a CS test where the Device Under Test (DUT) is placed in the role of either the initiator or reflector.
    See Core Specification [Vol 4, Part E, 7.8.142].

    This command is not available on STM32WBA5/6.

    Input parameters

    ParameterSizeDescriptionPossible values

    Main_Mode_Type

    1

    Indicates the CS mode to be used.

  • 0x01: Mode-1
  • 0x02: Mode-2
  • 0x03: Mode-3

    • Sub_Mode_Type

    1

    Indicates the CS sub-mode to be used.

  • 0x01: Mode-1
  • 0x02: Mode-2
  • 0x03: Mode-3
  • 0xFF: Unused

    • Main_Mode_Repetition

    1

    The number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event.

  • 0 ... 3

    • Mode_0_Steps

    1

    Number of CS mode-0 steps to be included at the beginning of each CS subevent.

  • 1 ... 3

    • Role

    1

    Indicates the CS role for the local Controller.

  • 0x00: Initiator
  • 0x01: Reflector

    • RTT_Type

    1

    Indicates the RTT variant to be used during the CS procedure.

  • 0x00: RTT AA-only
  • 0x01: RTT with 32-bit sounding sequence
  • 0x02: RTT with 96-bit sounding sequence
  • 0x03: RTT with 32-bit random sequence
  • 0x04: RTT with 64-bit random sequence
  • 0x05: RTT with 96-bit random sequence
  • 0x06: RTT with 128-bit random sequence

    • CS_SYNC_PHY

    1

    Indicates the PHY to be used for CS_SYNC exchanges during the CS procedure.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE 2M 2BT PHY

    • CS_SYNC_Antenna_Selection

    1

    Antenna identifier to be used for CS_SYNC packets, including mode-0 packets.

  • 0x01 ... 0x04

    • Subevent_Len

    3

    Duration for each CS subevent in microseconds.

  • 1250 ... 4000000

    • Subevent_Interval

    2

    Time between consecutive CS subevents anchored off the same ACL connection event. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) : Single CS subevent
  • 0x0001 (0.625 ms) ... 0xFFFF (40959.375 ms)

    • Max_Num_Subevents

    1

    The maximum allowed number of subevents in the procedure.

  • 0x00: This parameter is ignored when determining the number of subevents in the procedure
  • 0x01 ... 0x20

    • Transmit_Power_Level

    1

    Set transmitter to the specified or nearest transmit power level (signed integer). Units: dBm.

  • 126: Set transmitter to minimum transmit power level
  • 127: Set transmitter to maximum transmit power level
  • -127 ... 20

    • T_IP1_Time

    1

    Interlude time in microseconds between the RTT packets.

  • 10
  • 20
  • 30
  • 40
  • 50
  • 60
  • 80
  • 145

    • T_IP2_Time

    1

    Interlude time in microseconds between the CS tones.

  • 10
  • 20
  • 30
  • 40
  • 50
  • 60
  • 80
  • 145

    • T_FCS_Time

    1

    Time in microseconds for frequency changes.

  • 15
  • 20
  • 30
  • 40
  • 50
  • 60
  • 80
  • 100
  • 120
  • 150

    • T_PM_Time

    1

    Time in microseconds for the phase measurement period of the CS tones.

  • 10
  • 20
  • 40

    • T_SW_Time

    1

    Time in microseconds for the antenna switch period of the CS tones.

  • 0x00
  • 0x01
  • 0x02
  • 0x04
  • 0x0A

    • Tone_Antenna_Config_Selection

    1

    Antenna Configuration Index.

  • 0 ... 7

    • Reserved

    1

    Reserved, shall be set to 0.

  • 0x00

    • SNR_Control_Initiator

    1

    SNR control adjustment for the CS_SYNC transmissions of the initiator.

  • 0x00: SNR control adjustment of 18 dB
  • 0x01: SNR control adjustment of 21 dB
  • 0x02: SNR control adjustment of 24 dB
  • 0x03: SNR control adjustment of 27 dB
  • 0x04: SNR control adjustment of 30 dB
  • 0xFF: SNR control is not to be applied

    • SNR_Control_Reflector

    1

    SNR control adjustment for the CS_SYNC transmissions of the reflector.

  • 0x00: SNR control adjustment of 18 dB
  • 0x01: SNR control adjustment of 21 dB
  • 0x02: SNR control adjustment of 24 dB
  • 0x03: SNR control adjustment of 27 dB
  • 0x04: SNR control adjustment of 30 dB
  • 0xFF: SNR control is not to be applied

    • DRBG_Nonce

    2

    The DRBG_Nonce value determines octets 14 and 15 of the initial value of the DRBG nonce.

    Channel_Map_Repetition

    1

    The number of times the map represented by the Channel_Map field is to be cycled through for non-mode-0 steps within a CS procedure.

  • 0x01 ... 0xFF

    • Override_Config

    2

    Indicates which CS parameters are not derived from the DRBG but determined from the Override_Parameters_Data parameter.

    Bitmask of:

  • 0x0001: If the bit is set to 1, then the channel sequence for the subevent is determined by the values of Channel_Length and Channel[i] parameters. If bit is set to 0, then the channel sequence for the subevent is determined by the values of Channel_Map, Channel_Selection_Type, Ch3c_Shape, and Ch3c_Jump.
  • 0x0004: The number of main mode CS steps to be executed before a submode CS step is executed during the CS procedure is determined by the value of Main_Mode_Steps parameter.
  • 0x0008: The transmission of tone extensions within each Mode-2 or Mode-3 step is determined by the value of T_PM_Tone_Ext parameter.
  • 0x0010: The Tone antenna permutation index for each Mode-2 or Mode-3 step is determined by the value of Tone_Antenna_Permutation parameter.
  • 0x0020: The CS Access Address of all packets sent by the initiator is determined by CS_SYNC_AA_Initiator parameter. The CS Access Address of all packets sent by the reflector is determined by CS_SYNC_AA_Reflector parameter.
  • 0x0040: The Marker positions for each CS_SYNC packet with a marker is determined by the value of SS_Marker1_Position and SS_Marker2_Position parameters
  • 0x0080: The Marker value for each marker within a CS_SYNC packet is determined by SS_Marker_Value parameter.
  • 0x0100: The payload of the CS_SYNC packet is determined by the value of CS_SYNC_Payload_Pattern parameter.
  • 0x0400: Stable Phase test.

    • Override_Parameters_Length

    1

    Length of Override_Parameters_Data in octets

    Override_Parameters_Data

    Override_Parameters_Length

    Variable set of parameters which are present dependent on the bits set in the Override_Config parameter. See Core Specification.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_CS_SUBEVENT_RESULT_EVENT
  • HCI_LE_CS_SUBEVENT_RESULT_CONTINUE_EVENT

    • HCI_LE_CS_TEST_END

    Description

    This command is used to stop any CS test that is in progress.
    See Core Specification [Vol 4, Part E, 7.8.143].

    This command is not available on STM32WBA5/6.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CS_TEST_END_COMPLETE_EVENT

    • ACI General commands

    CommandOpcodeBPBFPOLO
    ACI_RESET

    0xFF00

    Y

    Y

    Y

    Y

    ACI_GET_INFORMATION

    0xFF01

    Y

    Y

    Y

    Y

    ACI_WRITE_CONFIG_DATA

    0xFF02

    Y

    Y

    Y

    Y

    ACI_READ_CONFIG_DATA

    0xFF03

    Y

    Y

    Y

    Y

    ACI_RESET

    Description

    This command resets the BLE stack (Host and LE Controller).

    Input parameters

    ParameterSizeDescriptionPossible values

    Mode

    1

    ACI reset mode.

  • 0x00: Reset without BLE stack options change
  • 0x01: Reset with BLE stack option changes

    • Options

    4

    New BLE stack options to set at ACI reset (a bit set to 1 means that the corresponding optional feature is activated).

    Bitmask of:

  • 0x00000001: LL only mode
  • 0x00000002: No service change description
  • 0x00000004: Device Name is read-only
  • 0x00000008: Support of Extended Advertising
  • 0x00000020: Reduced GATT database in NVM
  • 0x00000040: Support of GATT caching
  • 0x00000080: Support of LE Power Class 1 (flag not available in RCP mode)
  • 0x00000100: Appearance is writable
  • 0x00000200: Support of Enhanced ATT

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GET_INFORMATION

    Description

    This command reads the local ACI information.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Version

    8

    BLE stack version.

    Options

    4

    Current BLE stack options (a bit set to 1 means that the corresponding optional feature is activated).

    Bitmask of:

  • 0x00000001: LL only mode
  • 0x00000002: No service change description
  • 0x00000004: Device Name is read-only
  • 0x00000008: Support of Extended Advertising
  • 0x00000020: Reduced GATT database in NVM
  • 0x00000040: Support of GATT caching
  • 0x00000080: Support of LE Power Class 1 (flag not available in RCP mode)
  • 0x00000100: Appearance is writable
  • 0x00000200: Support of Enhanced ATT

    • Debug_Info

    12

    BLE stack debug information.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_WRITE_CONFIG_DATA

    Description

    This command writes a value to a configure data structure. It is useful to setup directly some parameters for the BLE stack.
    Refer to Annex for details on the different parameters that can be configured.

    Input parameters

    ParameterSizeDescriptionPossible values

    Offset

    1

    Offset of the element in the configuration data structure which has to be written.

  • 0x00: CONFIG_DATA_PUBLIC_ADDRESS_OFFSET; Bluetooth public address; 6 bytes
  • 0x08: CONFIG_DATA_ER_OFFSET; Encryption root key; 16 bytes
  • 0x18: CONFIG_DATA_IR_OFFSET; Identity root key; 16 bytes
  • 0x2E: CONFIG_DATA_RANDOM_ADDRESS_OFFSET; Static Random Address; 6 bytes
  • 0x34: CONFIG_DATA_GAP_ADD_REC_NBR_OFFSET; GAP service additional record number; 1 byte
  • 0x35: CONFIG_DATA_SC_KEY_TYPE_OFFSET; Secure Connections key type; 1 byte
  • 0xB0: CONFIG_DATA_SMP_MODE_OFFSET; SMP mode; 1 byte
  • 0xC2: CONFIG_DATA_LL_RSSI_GOLDEN_RANGE_OFFSET; LL RSSI golden range; 2 bytes
  • 0xC4: CONFIG_DATA_LL_RX_ACL_CTRL_OFFSET; LL RX ACL control; 2 bytes

    • Length

    1

    Length of data to be written

    Value

    Length

    Data to be written

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_READ_CONFIG_DATA

    Description

    This command requests the value in the configure data structure. The number of read bytes changes for different Offset.

    Input parameters

    ParameterSizeDescriptionPossible values

    Offset

    1

    Offset of the element in the configuration data structure which has to be read.

  • 0x00: CONFIG_DATA_PUBLIC_ADDRESS_OFFSET; Bluetooth public address; 6 bytes
  • 0x08: CONFIG_DATA_ER_OFFSET; Encryption root key used to derive LTK (legacy) and CSRK; 16 bytes
  • 0x18: CONFIG_DATA_IR_OFFSET Identity root key used to derive DHK (legacy) and IRK; 16 bytes
  • 0x2E: CONFIG_DATA_RANDOM_ADDRESS_OFFSET; Static Random Address; 6 bytes
  • 0xC2: CONFIG_DATA_LL_RSSI_GOLDEN_RANGE_OFFSET; LL RSSI golden range (two 8-bit signed values in dBm - byte #0 is the lower value, byte #1 is the upper value); 2 bytes

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Data_Length

    1

    Length of Data in octets

    Data

    Data_Length

    Data field associated with Offset parameter

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI GAP commands

    CommandOpcodeBPBFPOLO
    ACI_GAP_SET_NON_DISCOVERABLE

    0xFC81

    Y

    Y

    Y

    ACI_GAP_SET_LIMITED_DISCOVERABLE

    0xFC82

    Y

    Y

    Y

    ACI_GAP_SET_DISCOVERABLE

    0xFC83

    Y

    Y

    Y

    ACI_GAP_SET_DIRECT_CONNECTABLE

    0xFC84

    Y

    Y

    Y

    ACI_GAP_SET_IO_CAPABILITY

    0xFC85

    Y

    Y

    Y

    ACI_GAP_SET_AUTHENTICATION_REQUIREMENT

    0xFC86

    Y

    Y

    Y

    ACI_GAP_SET_AUTHORIZATION_REQUIREMENT

    0xFC87

    Y

    Y

    Y

    ACI_GAP_PASS_KEY_RESP

    0xFC88

    Y

    Y

    Y

    ACI_GAP_AUTHORIZATION_RESP

    0xFC89

    Y

    Y

    Y

    ACI_GAP_INIT

    0xFC8A

    Y

    Y

    Y

    ACI_GAP_SET_NON_CONNECTABLE

    0xFC8B

    Y

    Y

    Y

    ACI_GAP_SET_UNDIRECTED_CONNECTABLE

    0xFC8C

    Y

    Y

    Y

    ACI_GAP_PERIPHERAL_SECURITY_REQ

    0xFC8D

    Y

    Y

    Y

    ACI_GAP_UPDATE_ADV_DATA

    0xFC8E

    Y

    Y

    Y

    ACI_GAP_DELETE_AD_TYPE

    0xFC8F

    Y

    Y

    Y

    ACI_GAP_GET_SECURITY_LEVEL

    0xFC90

    Y

    Y

    Y

    ACI_GAP_SET_EVENT_MASK

    0xFC91

    Y

    Y

    Y

    ACI_GAP_CONFIGURE_FILTER_ACCEPT_LIST

    0xFC92

    Y

    Y

    Y

    ACI_GAP_TERMINATE

    0xFC93

    Y

    Y

    Y

    ACI_GAP_CLEAR_SECURITY_DB

    0xFC94

    Y

    Y

    Y

    ACI_GAP_ALLOW_REBOND

    0xFC95

    Y

    Y

    Y

    ACI_GAP_START_LIMITED_DISCOVERY_PROC

    0xFC96

    Y

    Y

    ACI_GAP_START_GENERAL_DISCOVERY_PROC

    0xFC97

    Y

    Y

    ACI_GAP_START_AUTO_CONNECTION_ESTABLISH_PROC

    0xFC99

    Y

    Y

    ACI_GAP_START_GENERAL_CONNECTION_ESTABLISH_PROC

    0xFC9A

    Y

    Y

    ACI_GAP_START_SELECTIVE_CONNECTION_ESTABLISH_PROC

    0xFC9B

    Y

    Y

    ACI_GAP_CREATE_CONNECTION

    0xFC9C

    Y

    Y

    ACI_GAP_TERMINATE_GAP_PROC

    0xFC9D

    Y

    Y

    ACI_GAP_START_CONNECTION_UPDATE

    0xFC9E

    Y

    Y

    ACI_GAP_SEND_PAIRING_REQ

    0xFC9F

    Y

    Y

    ACI_GAP_SET_BROADCAST_MODE

    0xFCA1

    Y

    Y

    ACI_GAP_START_OBSERVATION_PROC

    0xFCA2

    Y

    Y

    ACI_GAP_GET_BONDED_DEVICES

    0xFCA3

    Y

    Y

    Y

    ACI_GAP_CHECK_BONDED_DEVICE

    0xFCA4

    Y

    Y

    Y

    ACI_GAP_NUMERIC_COMPARISON_VALUE_CONFIRM_YESNO

    0xFCA5

    Y

    Y

    Y

    ACI_GAP_PASSKEY_INPUT

    0xFCA6

    Y

    Y

    Y

    ACI_GAP_GET_OOB_DATA

    0xFCA7

    Y

    Y

    Y

    ACI_GAP_SET_OOB_DATA

    0xFCA8

    Y

    Y

    Y

    ACI_GAP_REMOVE_BONDED_DEVICE

    0xFCAA

    Y

    Y

    Y

    ACI_GAP_ADD_DEVICES_TO_LIST

    0xFCAB

    Y

    Y

    Y

    ACI_GAP_PAIRING_REQUEST_REPLY

    0xFCAD

    Y

    Y

    Y

    ACI_GAP_ADV_SET_CONFIGURATION

    0xFCC0

    Y

    ACI_GAP_ADV_SET_ENABLE

    0xFCC1

    Y

    ACI_GAP_ADV_SET_ADV_DATA

    0xFCC2

    Y

    ACI_GAP_ADV_SET_SCAN_RESP_DATA

    0xFCC3

    Y

    ACI_GAP_ADV_REMOVE_SET

    0xFCC4

    Y

    ACI_GAP_ADV_CLEAR_SETS

    0xFCC5

    Y

    ACI_GAP_ADV_SET_RANDOM_ADDRESS

    0xFCC6

    Y

    ACI_GAP_ADV_SET_PERIODIC_PARAMETERS

    0xFCC7

    ACI_GAP_ADV_SET_PERIODIC_DATA

    0xFCC8

    ACI_GAP_ADV_SET_PERIODIC_ENABLE

    0xFCC9

    ACI_GAP_ADV_SET_CONFIGURATION_V2

    0xFCCD

    Y

    ACI_GAP_EXT_START_SCAN

    0xFCD0

    Y

    ACI_GAP_EXT_CREATE_CONNECTION

    0xFCD1

    Y

    ACI_GAP_SET_NON_DISCOVERABLE

    Description

    This command stops advertising.
    Note: this command only supports legacy advertising. For extended advertising, refer to ACI_GAP_ADV_SET_ENABLE.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_LIMITED_DISCOVERABLE

    Description

    Puts the device in limited discoverable mode (as defined in Core Specification [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 For extended advertising, refer to ACI_GAP_ADV_SET_CONFIGURATION and ACI_GAP_ADV_SET_ENABLE..

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Type

    1

    Advertising type

  • 0x00: ADV_IND (Connectable undirected advertising)
  • 0x02: ADV_SCAN_IND (Scannable undirected advertising)
  • 0x03: ADV_NONCONN_IND (Non connectable undirected advertising)

    • Advertising_Interval_Min

    2

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms)

    • Advertising_Interval_Max

    2

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: 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.

  • 0x0000 (NaN)
  • 0xFFFF (NaN) : No specific minimum
  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • 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

  • 0x0000 (NaN)
  • 0xFFFF (NaN) : No specific maximum
  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GAP_LIMITED_DISCOVERABLE_EVENT

    • ACI_GAP_SET_DISCOVERABLE

    Description

    Puts the device in general discoverable mode (as defined in Core Specification [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. For extended advertising, refer to ACI_GAP_ADV_SET_CONFIGURATION and ACI_GAP_ADV_SET_ENABLE.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Type

    1

    Advertising type

  • 0x00: ADV_IND (Connectable undirected advertising)
  • 0x02: ADV_SCAN_IND (Scannable undirected advertising)
  • 0x03: ADV_NONCONN_IND (Non connectable undirected advertising)

    • Advertising_Interval_Min

    2

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms)

    • Advertising_Interval_Max

    2

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: 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.

  • 0x0000 (NaN)
  • 0xFFFF (NaN) : No specific minimum
  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • 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

  • 0x0000 (NaN)
  • 0xFFFF (NaN) : No specific maximum
  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_DIRECT_CONNECTABLE

    Description

    Sets the device in directed connectable mode (as defined in Core Specification [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. For extended advertising, refer to ACI_GAP_ADV_SET_CONFIGURATION and ACI_GAP_ADV_SET_ENABLE.

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address

    • Directed_Advertising_Type

    1

    Advertising type

  • 0x01: High Duty Cycle Directed Advertising
  • 0x04: Low Duty Cycle Directed Advertising

    • Direct_Address_Type

    1

    The address type of the peer device.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Direct_Address

    6

    Initiator address

    Advertising_Interval_Min

    2

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x0006 (3.750 ms) : for High Duty Cycle Directed Advertising
  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms) : for Low Duty Cycle Directed Advertising

    • Advertising_Interval_Max

    2

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x0006 (3.750 ms) : for High Duty Cycle Directed Advertising
  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms) : for Low Duty Cycle Directed Advertising

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • HCI_LE_CONNECTION_COMPLETE_EVENT

    • ACI_GAP_SET_IO_CAPABILITY

    Description

    Sets the IO capabilities of the device. This command has to be given only when the device is not in a connected state.

    Input parameters

    ParameterSizeDescriptionPossible values

    IO_Capability

    1

    IO capability of the device.

  • 0x00: IO_CAP_DISPLAY_ONLY
  • 0x01: IO_CAP_DISPLAY_YES_NO
  • 0x02: IO_CAP_KEYBOARD_ONLY
  • 0x03: IO_CAP_NO_INPUT_NO_OUTPUT
  • 0x04: IO_CAP_KEYBOARD_DISPLAY

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_AUTHENTICATION_REQUIREMENT

    Description

    Sets the authentication requirements for the device. This command has to be given only when the device is not in a connected state.

    Input parameters

    ParameterSizeDescriptionPossible values

    Bonding_Mode

    1

    Bonding mode. Only if bonding is enabled (0x01), the bonding information is stored in flash

  • 0x00: No-bonding mode
  • 0x01: Bonding mode

    • MITM_Mode

    1

    MITM mode.

  • 0x00: MITM protection not required
  • 0x01: MITM protection required as mandatory
  • 0x02: MITM protection required as optional

    • SC_Support

    1

    LE Secure connections support

  • 0x00: Secure Connections Pairing not supported
  • 0x01: Secure Connections Pairing supported but optional
  • 0x02: Secure Connections Pairing supported and mandatory (SC Only Mode)

    • KeyPress_Notification_Support

    1

    Keypress notification support

  • 0x00: Keypress notification not supported
  • 0x01: Keypress notification supported

    • 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

  • 0x00: use a fixed pin (deprecated option that should not be used)
  • 0x01: do not use a fixed pin

    • Fixed_Pin

    4

    Fixed pin to be used during pairing (deprecated parameter).

  • 0 ... 999999

    • Identity_Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_AUTHORIZATION_REQUIREMENT

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • 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.

  • 0x00: Authorization not required
  • 0x01: Authorization required

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_PASS_KEY_RESP

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Pass_Key

    4

    Pass key that will be used during the pairing process. Must be a six-digit decimal number.

  • 0 ... 999999

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_GAP_PAIRING_COMPLETE_EVENT

    • ACI_GAP_AUTHORIZATION_RESP

    Description

    Authorizes a device to access attributes. This command should be sent by the host in response to ACI_GAP_AUTHORIZATION_REQ_EVENT event.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Authorize

    1

    Authorization response.

  • 0x01: Authorize
  • 0x02: Reject

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_INIT

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Role

    1

    Bitmap of allowed roles.

    Bitmask of:

  • 0x01: Peripheral
  • 0x02: Broadcaster
  • 0x04: Central
  • 0x08: Observer

    • privacy_enabled

    1

    This parameter specifies if Privacy is enabled or not. N.B.: only Controller Privacy is supported.

  • 0x00: Privacy disabled
  • 0x02: Privacy enabled

    • device_name_char_len

    1

    Length of the device name characteristic

    Output parameters

    ParameterSizeDescriptionPossible 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

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_NON_CONNECTABLE

    Description

    This command starts advertising in non connectable mode (i.e., this mode does not support connection).
    Advertiser filter policy is internally set to 0 (i.e., the Filter Accept List is not in use).
    Note: this command only supports legacy advertising. For extended advertising, refer to ACI_GAP_ADV_SET_CONFIGURATION and ACI_GAP_ADV_SET_ENABLE.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Event_Type

    1

    Advertising type

  • 0x02: ADV_SCAN_IND (Scannable undirected advertising)
  • 0x03: ADV_NONCONN_IND (Non connectable undirected advertising)

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: Non-resolvable private address

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_UNDIRECTED_CONNECTABLE

    Description

    This command starts advertising in 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. For extended advertising, refer to ACI_GAP_ADV_SET_CONFIGURATION and ACI_GAP_ADV_SET_ENABLE.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Interval_Min

    2

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms)

    • Advertising_Interval_Max

    2

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address

    • Adv_Filter_Policy

    1

    Advertising filter policy.

  • 0x00: Allow Scan Request from Any, Allow Connect Request from Any
  • 0x03: Allow Scan Request from Filter Accept List Only, Allow Connect Request from Filter Accept List Only

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_PERIPHERAL_SECURITY_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GAP_PAIRING_COMPLETE_EVENT

    • ACI_GAP_UPDATE_ADV_DATA

    Description

    This command can be used to update the advertising data for particular AD types. The data argument shall consist of valid advertising data composed of one or more AD types. If one of the specified AD types does not exist in the current advertising data, then it is added to the advertising data; while the AD types already present in the current advertising data are updated with the new values. 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.
    Note: this command only supports legacy advertising. For extended advertising, refer to ACI_GAP_ADV_SET_ADV_DATA.

    Input parameters

    ParameterSizeDescriptionPossible values

    AdvDataLen

    1

    Length of AdvData in octets

    AdvData

    AdvDataLen

    Advertising data used by the device while advertising.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_DELETE_AD_TYPE

    Description

    This command can be used to delete the specified AD type from the advertisement data if present.
    Note: this command only supports legacy advertising. For extended advertising, refer to ACI_GAP_ADV_SET_ADV_DATA.

    Input parameters

    ParameterSizeDescriptionPossible values

    ADType

    1

    One of the AD types as in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_GET_SECURITY_LEVEL

    Description

    This command can be used to get the current security settings of the device.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Security_Mode

    1

    Security mode.

  • 0x01: Security Mode 1

    • Security_Level

    1

    Security Level.

  • 0x01: Security Level 1
  • 0x02: Security Level 2
  • 0x03: Security Level 3
  • 0x04: Security Level 4

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_EVENT_MASK

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    GAP_Evt_Mask

    2

    ACI GAP/L2CAP event mask. Default: 0xFFFF.

    Bitmask of:

  • 0x0000: No events
  • 0x0001: ACI_GAP_LIMITED_DISCOVERABLE_EVENT
  • 0x0002: ACI_GAP_PAIRING_COMPLETE_EVENT
  • 0x0004: ACI_GAP_PASS_KEY_REQ_EVENT
  • 0x0008: ACI_GAP_AUTHORIZATION_REQ_EVENT
  • 0x0020: ACI_GAP_BOND_LOST_EVENT
  • 0x0080: ACI_GAP_PROC_COMPLETE_EVENT
  • 0x0100: ACI_L2CAP_CONNECTION_UPDATE_REQ_EVENT
  • 0x0200: ACI_L2CAP_CONNECTION_UPDATE_RESP_EVENT
  • 0x0400: ACI_L2CAP_PROC_TIMEOUT_EVENT
  • 0x0800: ACI_GAP_ADDR_NOT_RESOLVED_EVENT

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_CONFIGURE_FILTER_ACCEPT_LIST

    Description

    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.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_TERMINATE

    Description

    Commands the controller to terminate the connection. A HCI_DISCONNECTION_COMPLETE_EVENT event is generated when the link is disconnected.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Reason

    1

    The reason for ending the connection.

  • 0x05: Authentication Failure
  • 0x13: Remote User Terminated Connection
  • 0x14: Remote Device Terminated Connection due to Low Resources
  • 0x15: Remote Device Terminated Connection due to Power Off
  • 0x1A: Unsupported Remote Feature
  • 0x3B: Unacceptable Connection Parameters

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_DISCONNECTION_COMPLETE_EVENT

    • ACI_GAP_CLEAR_SECURITY_DB

    Description

    Clears the bonding table. All the devices in the bonding table are removed.
    See also ACI_GAP_REMOVE_BONDED_DEVICE to remove only one device.
    Note: as a fallback mode, in case the bonding table is full, the BLE stack automatically clears the bonding table just before putting into it information about a new bonded device.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ALLOW_REBOND

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_START_LIMITED_DISCOVERY_PROC

    Description

    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 (or via HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT when the extended advertising feature is supported).

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: Non-resolvable private address

    • Filter_Duplicates

    1

    Enable/disable duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_ADVERTISING_REPORT_EVENT
  • HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_START_GENERAL_DISCOVERY_PROC

    Description

    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).

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: Non-resolvable private address

    • Filter_Duplicates

    1

    Enable/disable duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_ADVERTISING_REPORT_EVENT
  • HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_START_AUTO_CONNECTION_ESTABLISH_PROC

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address

    • Conn_Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Minimum_CE_Length

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Maximum_CE_Length

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 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.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Peer_Address[i]

    6

    Public Device Address or Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_START_GENERAL_CONNECTION_ESTABLISH_PROC

    Description

    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 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. 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.
    Before the call to ACI_GAP_CREATE_CONNECTION, the procedure can be terminated by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the procedure code set to 0x10.
    After the call to ACI_GAP_CREATE_CONNECTION, 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 0x40. On completion of the procedure a ACI_GAP_PROC_COMPLETE_EVENT event is generated 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 generates a RPA.

    Input parameters

    ParameterSizeDescriptionPossible values

    LE_Scan_Type

    1

    Passive or active scanning. With passive scanning, no scan request PDUs are sent.

  • 0x00: Passive scanning
  • 0x01: Active scanning

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: 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.

  • 0x00: Basic unfiltered scanning filter policy
  • 0x01: Basic filtered scanning filter policy
  • 0x02: Extended unfiltered scanning filter policy
  • 0x03: Extended filtered scanning filter policy

    • Filter_Duplicates

    1

    Enable/disable duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_START_SELECTIVE_CONNECTION_ESTABLISH_PROC

    Description

    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.
    Before the call to ACI_GAP_CREATE_CONNECTION, the procedure can be terminated by issuing the command ACI_GAP_TERMINATE_GAP_PROC with the procedure code set to 0x20.
    After the call to ACI_GAP_CREATE_CONNECTION, 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 0x40. On completion of the procedure a ACI_GAP_PROC_COMPLETE_EVENT event is generated 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 generates a RPA.

    Input parameters

    ParameterSizeDescriptionPossible values

    LE_Scan_Type

    1

    Passive or active scanning. With passive scanning, no scan request PDUs are sent.

  • 0x00: Passive scanning
  • 0x01: Active scanning

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: 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.

  • 0x00: Basic unfiltered scanning filter policy
  • 0x01: Basic filtered scanning filter policy
  • 0x02: Extended unfiltered scanning filter policy
  • 0x03: Extended filtered scanning filter policy

    • Filter_Duplicates

    1

    Enable/disable duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled

    • 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.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Peer_Address[i]

    6

    Public Device Address or Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_ADVERTISING_REPORT_EVENT
  • HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_CREATE_CONNECTION

    Description

    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 (or HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT if privacy or extended advertising is used) 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 generates a RPA.

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • Peer_Address_Type

    1

    The address type of the peer device.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address

    • Conn_Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Minimum_CE_Length

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Maximum_CE_Length

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CONNECTION_COMPLETE_EVENT
  • HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_TERMINATE_GAP_PROC

    Description

    Terminates the specified GAP procedure. An ACI_GAP_PROC_COMPLETE_EVENT event is returned with the procedure code set to the corresponding procedure.
    Note: in case of GAP procedure started with ACI_GAP_CREATE_CONNECTION or ACI_GAP_START_AUTO_CONNECTION_ESTABLISH_PROC, a HCI_LE_CREATE_CONNECTION_CANCEL is issued to the Controller.

    Input parameters

    ParameterSizeDescriptionPossible values

    Procedure_Code

    1

    GAP procedure bitmap.

  • 0x00: No events
  • 0x01: GAP_LIMITED_DISCOVERY_PROC
  • 0x02: GAP_GENERAL_DISCOVERY_PROC
  • 0x08: GAP_AUTO_CONNECTION_ESTABLISHMENT_PROC
  • 0x10: GAP_GENERAL_CONNECTION_ESTABLISHMENT_PROC
  • 0x20: GAP_SELECTIVE_CONNECTION_ESTABLISHMENT_PROC
  • 0x40: GAP_DIRECT_CONNECTION_ESTABLISHMENT_PROC
  • 0x80: GAP_OBSERVATION_PROC

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_START_CONNECTION_UPDATE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Conn_Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Minimum_CE_Length

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Maximum_CE_Length

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_CONNECTION_UPDATE_COMPLETE_EVENT

    • ACI_GAP_SEND_PAIRING_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Force_Rebond

    1

    If 1, Pairing request will be sent even if the device was previously bonded, otherwise pairing request is not sent.

  • 0x00: NO
  • 0x01: YES

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GAP_PAIRING_COMPLETE_EVENT

    • ACI_GAP_SET_BROADCAST_MODE

    Description

    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. For extended advertising, refer to ACI_GAP_ADV_SET_CONFIGURATION and ACI_GAP_ADV_SET_ENABLE.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Interval_Min

    2

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms)

    • Advertising_Interval_Max

    2

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x0020 (20.000 ms) ... 0x4000 (10240.000 ms)

    • Advertising_Type

    1

    Advertising type

  • 0x02: ADV_SCAN_IND (Scannable undirected advertising)
  • 0x03: ADV_NONCONN_IND (Non connectable undirected advertising)

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: 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.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Peer_Address[i]

    6

    Public Device Address or Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_START_OBSERVATION_PROC

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • 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.

  • 0x0004 (2.500 ms) ... 0x4000 (10240.000 ms) : legacy advertising
  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : extended advertising

    • LE_Scan_Type

    1

    Passive or active scanning. With passive scanning, no scan request PDUs are sent.

  • 0x00: Passive scanning
  • 0x01: Active scanning

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: Non-resolvable private address

    • Filter_Duplicates

    1

    Enable/disable duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled

    • 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.

  • 0x00: Basic unfiltered scanning filter policy
  • 0x01: Basic filtered scanning filter policy
  • 0x02: Extended unfiltered scanning filter policy
  • 0x03: Extended filtered scanning filter policy

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_ADVERTISING_REPORT_EVENT
  • HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT

    • ACI_GAP_GET_BONDED_DEVICES

    Description

    This command gets the list of the devices which are present in the bonding table. It returns the number of addresses and the corresponding address types and values.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Num_of_Addresses

    1

    The number of bonded devices

    Address_Type[i]

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Address[i]

    6

    Public Device Address or Random Device Address.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_CHECK_BONDED_DEVICE

    Description

    The command finds whether the device, whose address is specified in the command, is present in the bonding table. If the device is found, the command returns "Success".
    Note: the specified address can be a Resolvable Private Address (RPA). In this case, even if privacy is not enabled, this address is resolved to check the presence of the peer device in the bonding table. If the address is resolved successfully with any one of the IRKs present in the database, the command returns success and also the corresponding public or static random address stored with the IRK in the database (i.e. the peer device identity address distributed during bonding).

    Input parameters

    ParameterSizeDescriptionPossible values

    Peer_Address_Type

    1

    The address type of the peer device.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Peer_Address

    6

    Public Device Address or Random Device Address of the peer device

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Id_Address_Type

    1

    The address type of the peer device, distributed during pairing phase.

    Id_Address

    6

    The public or static random address of the peer device, distributed during pairing phase.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_NUMERIC_COMPARISON_VALUE_CONFIRM_YESNO

    Description

    This command allows the User to validate/confirm or not the Numeric Comparison value showed through the ACI_GAP_NUMERIC_COMPARISON_VALUE_EVENT.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Confirm_Yes_No

    1

    Indicates if the numeric values showed on both local and peer device are different or equal

  • 0x00: No (numeric values are different)
  • 0x01: Yes (numeric values are equal)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_PASSKEY_INPUT

    Description

    This command permits to signal to the Stack the input type detected during Passkey input.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Input_Type

    1

    Passkey input type detected

  • 0x00: Passkey entry started
  • 0x01: Passkey digit entered
  • 0x02: Passkey digit erased
  • 0x03: Passkey cleared
  • 0x04: Passkey entry completed

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_GET_OOB_DATA

    Description

    This command is sent by the User to get (i.e. to extract from the Stack) the OOB data generated by the Stack itself.

    Input parameters

    ParameterSizeDescriptionPossible values

    OOB_Data_Type

    1

    Type of OOB data

  • 0x00: TK (Legacy pairing)
  • 0x01: Random (SC)
  • 0x02: Confirm (SC)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Address

    6

    Public or Random (static) address of this device

    OOB_Data_Type

    1

    Type of OOB data

  • 0x00: TK (Legacy pairing)
  • 0x01: Random (SC)
  • 0x02: Confirm (SC)

    • OOB_Data_Len

    1

    Length of OOB data

  • 16

    • OOB_Data

    16

    Local OOB data

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_SET_OOB_DATA

    Description

    This command is sent (by the User) to input the OOB data arrived via OOB communication.

    Input parameters

    ParameterSizeDescriptionPossible values

    Device_Type

    1

    OOB Device type

  • 0x00: Local device (Address_Type and Address are not used)
  • 0x01: Remote device

    • Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Address

    6

    Public or Random (static) Identity Address of the peer device

    OOB_Data_Type

    1

    Type of OOB data

  • 0x00: TK (Legacy pairing)
  • 0x01: Random (SC)
  • 0x02: Confirm (SC)

    • OOB_Data_Len

    1

    Length of OOB data

  • 0: SC Random/Confirm generation (OOB_Data and OOB_Data_Type are not used)
  • 16

    • OOB_Data

    16

    Either local OOB data or remote OOB data received through OOB from peer device (see Device_Type)

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_REMOVE_BONDED_DEVICE

    Description

    This command removes a specified device from bonding table; i.e. it removes from bonding table all security and GATT information related to the specified device.

    Input parameters

    ParameterSizeDescriptionPossible values

    Peer_Identity_Address_Type

    1

    Identity address type

  • 0x00: Public Identity Address
  • 0x01: Random (static) Identity Address

    • Peer_Identity_Address

    6

    Public or Random (static) Identity Address of the peer device

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADD_DEVICES_TO_LIST

    Description

    This command is used to add specific device addresses to the Filter Accept List and/or resolving list.

    Input parameters

    ParameterSizeDescriptionPossible values

    Num_of_List_Entries

    1

    Number of devices that have to be added to the list.

    Address_Type[i]

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Address[i]

    6

    Public Device Address or Random Device Address.

    Mode

    1

    Mode used for adding devices in the lists.

  • 0x00: Append to the resolving list only
  • 0x01: Clear and set the resolving list only
  • 0x02: Append to the Filter Accept List only
  • 0x03: Clear and set the Filter Accept List only
  • 0x04: Append to both resolving list and Filter Accept List
  • 0x05: Clear and set both resolving list and Filter Accept List

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_PAIRING_REQUEST_REPLY

    Description

    This command is used to reply to ACI_GAP_PAIRING_REQUEST_EVENT. It enables to allow or reject either the Pairing Request from the Central or the Security Request from the Peripheral.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Accept

    1

    Enables to accept or reject the pairing request.

  • 0x00: Reject
  • 0x01: Accept

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_CONFIGURATION

    Description

    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.
    Note: this command is deprecated; it is better to use ACI_GAP_ADV_SET_CONFIGURATION_V2.

    Input parameters

    ParameterSizeDescriptionPossible values

    Adv_Mode

    1

    Bitmap of extended advertising modes

    Bitmask of:

  • 0x01: Use specific random address
  • 0x02: Use LE Coded as primary advertising PHY

    • Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Adv_Event_Properties

    2

    Type of advertising event.

    Bitmask of:

  • 0x0001: Connectable advertising
  • 0x0002: Scannable advertising
  • 0x0004: Directed advertising
  • 0x0008: High Duty Cycle Directed Connectable advertising
  • 0x0010: Use legacy advertising PDUs
  • 0x0020: Anonymous advertising
  • 0x0040: Include TxPower in at least one advertising PDU

    • Primary_Adv_Interval_Min

    4

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x00000020 (20.000 ms) ... 0x00FFFFFF (10485759.375 ms)

    • Primary_Adv_Interval_Max

    4

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x00000020 (20.000 ms) ... 0x00FFFFFF (10485759.375 ms)

    • Primary_Adv_Channel_Map

    1

    Advertising channel map.

    Bitmask of:

  • 0x01: Channel 37 shall be used
  • 0x02: Channel 38 shall be used
  • 0x04: Channel 39 shall be used

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: Non-resolvable private address

    • Peer_Address_Type

    1

    Address type of the peer device.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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

  • 0x00: Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use)
  • 0x01: Process connection requests from all devices and scan requests only from devices that are in the Filter Accept List.
  • 0x02: Process scan requests from all devices and connection requests only from devices that are in the Filter Accept List.
  • 0x03: Process scan and connection requests only from devices in the Filter Accept List.

    • Adv_TX_Power

    1

    Advertising TX power. Units: dBm.

  • 127: Host has no preference
  • -127 ... 20

    • Secondary_Adv_Max_Skip

    1

    Secondary advertising maximum skip.

  • 0x00: AUX_ADV_IND shall be sent prior to the next advertising event
  • 0x01 ... 0xFF: Maximum advertising events the Controller can skip before sending the AUX_ADV_IND packets on the secondary advertising physical channel

    • Secondary_Adv_PHY

    1

    Secondary advertising PHY.

  • 0x01: Secondary advertisement PHY is LE 1M
  • 0x02: Secondary advertisement PHY is LE 2M
  • 0x03: Secondary advertisement PHY is LE Coded

    • Adv_SID

    1

    Value of the Advertising SID subfield in the ADI field of the PDU.

  • 0x00 ... 0x0F

    • Scan_Req_Notification_Enable

    1

    Scan request notifications.

  • 0x00: Scan request notifications disabled
  • 0x01: Scan request notifications enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_ENABLE

    Description

    This command is used to request the Controller to enable or disable one or more extended advertising sets.

    Input parameters

    ParameterSizeDescriptionPossible values

    Enable

    1

    Enable/disable advertising.

  • 0x00: Advertising is disabled
  • 0x01: Advertising is enabled

    • Num_Sets

    1

    Number of advertising sets.

  • 0x00: Disable all advertising sets
  • 0x01 ... 0x3F: Number of advertising sets to enable or disable

    • Advertising_Handle[i]

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Duration[i]

    2

    Duration of advertising set. Time = N * 10 ms.

  • 0x0000 (0 ms) : No advertising duration.
  • 0x0001 (10 ms) ... 0xFFFF (655350 ms) : Advertising duration

    • Max_Extended_Advertising_Events[i]

    1

    Maximum number of advertising events.

  • 0x00: No maximum number of advertising events
  • 0x01 ... 0xFF: Maximum number of extended advertising events the Controller shall attempt to send prior to terminating the extended advertising

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_ADV_DATA

    Description

    This command is used to set the data used in extended advertising PDUs that have a data field.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Operation

    1

    Advertising operation.

  • 0x00: Intermediate fragment of fragmented extended advertising data
  • 0x01: First fragment of fragmented extended advertising data
  • 0x02: Last fragment of fragmented extended advertising data
  • 0x03: Complete extended advertising data
  • 0x04: Unchanged data (just update the Advertising DID)

    • Fragment_Preference

    1

    Fragment preference.

  • 0x00: The Controller may fragment all data
  • 0x01: The Controller should not fragment or should minimize fragmentation of data

    • Advertising_Data_Length

    1

    Length of Advertising_Data in octets

    Advertising_Data

    Advertising_Data_Length

    Data formatted as defined in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_SCAN_RESP_DATA

    Description

    This command is used to provide scan response data used during extended advertising.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Operation

    1

    Scan response operation.

  • 0x00: Intermediate fragment of fragmented scan response data
  • 0x01: First fragment of fragmented scan response data
  • 0x02: Last fragment of fragmented scan response data
  • 0x03: Complete scan response data

    • Fragment_Preference

    1

    Fragment preference.

  • 0x00: The Controller may fragment all data
  • 0x01: The Controller should not fragment or should minimize fragmentation of data

    • Scan_Response_Data_Length

    1

    Length of Scan_Response_Data in octets

    Scan_Response_Data

    Scan_Response_Data_Length

    Data formatted as defined in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_REMOVE_SET

    Description

    This command is used to remove an advertising set from the Controller.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_CLEAR_SETS

    Description

    This command is used to remove all existing advertising sets from the Controller.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_RANDOM_ADDRESS

    Description

    This command is used to set the random device address of an advertising set configured to use specific random address.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Random_Address

    6

    Random Device Address.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_PERIODIC_PARAMETERS

    Description

    This command is used to set the parameters for periodic advertising.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Periodic_Adv_Interval_Min

    2

    Minimum advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Periodic_Adv_Interval_Max

    2

    Maximum advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Periodic_Adv_Properties

    2

    Properties.

    Bitmask of:

  • 0x0040: Include TxPower in the advertising PDU

    • Num_Subevents

    1

    Number of subevents.

  • 0x00 ... 0x80

    • Subevent_Interval

    1

    Interval between subevents. Time = N * 1.25 ms.

  • 0x06 (7.50 ms) ... 0xFF (318.75 ms)

    • Response_Slot_Delay

    1

    Time between the advertising packet in a subevent and the first response slot. Time = N * 1.25 ms.

  • 0x00 (0.00 ms) : No response slots
  • 0x01 (1.25 ms) ... 0xFE (317.50 ms)

    • Response_Slot_Spacing

    1

    Time between response slots. Time = N * 0.125 ms.

  • 0x00 (0.000 ms) : No response slots
  • 0x02 (0.250 ms) ... 0xFF (31.875 ms)

    • Num_Response_Slots

    1

    Number of subevent response slots.

  • 0x00: No response slots
  • 0x01 ... 0xFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_PERIODIC_DATA

    Description

    This command is used to set the data used in periodic advertising PDUs.

    Input parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Operation

    1

    Advertising operation.

  • 0x00: Intermediate fragment of fragmented extended advertising data
  • 0x01: First fragment of fragmented extended advertising data
  • 0x02: Last fragment of fragmented extended advertising data
  • 0x03: Complete extended advertising data
  • 0x04: Unchanged data (just update the Advertising DID)

    • Advertising_Data_Length

    1

    Length of Advertising_Data in octets

    Advertising_Data

    Advertising_Data_Length

    Data formatted as defined in Core Specification [Vol 3, Part C, 11].

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_PERIODIC_ENABLE

    Description

    This command is used to enable or disable the periodic advertising for the advertising set specified by the Advertising_Handle parameter.

    Input parameters

    ParameterSizeDescriptionPossible values

    Enable

    1

    Enable/disable advertising.

    Bitmask of:

  • 0x01: Enable periodic advertising
  • 0x02: Include the ADI field in AUX_SYNC_IND PDUs

    • Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_ADV_SET_CONFIGURATION_V2

    Description

    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.
    To configure a periodic advertising set, the command ACI_GAP_ADV_SET_PERIODIC_PARAMETERS (in association with ACI_GAP_ADV_SET_PERIODIC_DATA and ACI_GAP_ADV_SET_PERIODIC_ENABLE) shall be used instead of this one.

    Input parameters

    ParameterSizeDescriptionPossible values

    Adv_Mode

    1

    Bitmap of extended advertising modes

    Bitmask of:

  • 0x01: Use specific random address

    • Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Adv_Event_Properties

    2

    Type of advertising event.

    Bitmask of:

  • 0x0001: Connectable advertising
  • 0x0002: Scannable advertising
  • 0x0004: Directed advertising
  • 0x0008: High Duty Cycle Directed Connectable advertising
  • 0x0010: Use legacy advertising PDUs
  • 0x0020: Anonymous advertising
  • 0x0040: Include TxPower in at least one advertising PDU

    • Primary_Adv_Interval_Min

    4

    Minimum advertising interval. Time = N * 0.625 ms.

  • 0x00000020 (20.000 ms) ... 0x00FFFFFF (10485759.375 ms)

    • Primary_Adv_Interval_Max

    4

    Maximum advertising interval. Time = N * 0.625 ms.

  • 0x00000020 (20.000 ms) ... 0x00FFFFFF (10485759.375 ms)

    • Primary_Adv_Channel_Map

    1

    Advertising channel map.

    Bitmask of:

  • 0x01: Channel 37 shall be used
  • 0x02: Channel 38 shall be used
  • 0x04: Channel 39 shall be used

    • Own_Address_Type

    1

    Own address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Resolvable Private Address if available, otherwise Public Address
  • 0x03: Resolvable Private Address if available, otherwise Random Address

    • Peer_Address_Type

    1

    Address type of the peer device.

  • 0x00: Public Device Address or Public Identity Address
  • 0x01: Random Device Address or Random (static) Identity Address

    • 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

  • 0x00: Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use)
  • 0x01: Process connection requests from all devices and scan requests only from devices that are in the Filter Accept List.
  • 0x02: Process scan requests from all devices and connection requests only from devices that are in the Filter Accept List.
  • 0x03: Process scan and connection requests only from devices in the Filter Accept List.

    • Adv_TX_Power

    1

    Advertising TX power. Units: dBm.

  • 127: Host has no preference
  • -127 ... 20

    • Primary_Adv_PHY

    1

    Primary advertising PHY.

  • 0x01: Primary advertisement PHY is LE 1M
  • 0x03: Primary advertisement PHY is LE Coded

    • Secondary_Adv_Max_Skip

    1

    Secondary advertising maximum skip.

  • 0x00: AUX_ADV_IND shall be sent prior to the next advertising event
  • 0x01 ... 0xFF: Maximum advertising events the Controller can skip before sending the AUX_ADV_IND packets on the secondary advertising physical channel

    • Secondary_Adv_PHY

    1

    Secondary advertising PHY.

  • 0x01: Secondary advertisement PHY is LE 1M
  • 0x02: Secondary advertisement PHY is LE 2M
  • 0x03: Secondary advertisement PHY is LE Coded

    • Adv_SID

    1

    Value of the Advertising SID subfield in the ADI field of the PDU.

  • 0x00 ... 0x0F

    • Scan_Req_Notification_Enable

    1

    Scan request notifications.

  • 0x00: Scan request notifications disabled
  • 0x01: Scan request notifications enabled

    • Primary_Adv_PHY_Options

    1

    Advertising PHY options.

  • 0x00: The Host has no preferred or required coding when transmitting on the LE Coded PHY
  • 0x01: The Host prefers that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x02: The Host prefers that S=8 coding be used when transmitting on the LE Coded PHY
  • 0x03: The Host requires that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x04: The Host requires that S=8 coding be used when transmitting on the LE Coded PHY

    • Secondary_Adv_PHY_Options

    1

    Advertising PHY options.

  • 0x00: The Host has no preferred or required coding when transmitting on the LE Coded PHY
  • 0x01: The Host prefers that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x02: The Host prefers that S=8 coding be used when transmitting on the LE Coded PHY
  • 0x03: The Host requires that S=2 coding be used when transmitting on the LE Coded PHY
  • 0x04: The Host requires that S=8 coding be used when transmitting on the LE Coded PHY

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GAP_EXT_START_SCAN

    Description

    This command is used to start a scanning procedure when the extended advertising feature is supported.
    The Scanning_PHYs and subsequent parameters are used to specify the scanning parameters as defined for HCI_LE_SET_EXTENDED_SCAN_PARAMETERS: for more details, refer to Core Specification [Vol 4, Part E, 7.8.64].
    Note: this more generic command can be used instead of ACI_GAP_START_LIMITED_DISCOVERY_PROC, ACI_GAP_START_GENERAL_DISCOVERY_PROC, ACI_GAP_START_GENERAL_CONNECTION_ESTABLISH_PROC, ACI_GAP_START_SELECTIVE_CONNECTION_ESTABLISH_PROC or ACI_GAP_START_OBSERVATION_PROC.

    Input parameters

    ParameterSizeDescriptionPossible values

    Scan_Mode

    1

    Reserved, shall be set to 0.

  • 0x00

    • Procedure

    1

    Scan procedure.

  • 0x01: GAP_LIMITED_DISCOVERY_PROC
  • 0x02: GAP_GENERAL_DISCOVERY_PROC
  • 0x10: GAP_GENERAL_CONNECTION_ESTABLISHMENT_PROC
  • 0x20: GAP_SELECTIVE_CONNECTION_ESTABLISHMENT_PROC
  • 0x80: GAP_OBSERVATION_PROC

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address
  • 0x03: Non-resolvable private address

    • Filter_Duplicates

    1

    Duplicate filtering.

  • 0x00: Duplicate filtering disabled
  • 0x01: Duplicate filtering enabled
  • 0x02: Duplicate filtering enabled, reset for each scan period

    • Duration

    2

    Scan duration. Time = N * 10 ms.

  • 0x0000 (0 ms) : Scan continuously until explicitly disable
  • 0x0001 (10 ms) ... 0xFFFF (655350 ms) : Scan duration

    • Period

    2

    Scan period. Time = N * 1.28 s.

  • 0x0000 (0 ms) : Scan continuously
  • 0x0001 (1280 ms) ... 0xFFFF (83884800 ms) : Time interval from when the Controller started its last Scan_Duration until it begins the subsequent Scan_Duration

    • 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.

  • 0x00: Basic unfiltered scanning filter policy
  • 0x01: Basic filtered scanning filter policy
  • 0x02: Extended unfiltered scanning filter policy
  • 0x03: Extended filtered scanning filter policy

    • Scanning_PHYs

    1

    Scan PHYs.

    Bitmask of:

  • 0x01: Scan advertisements on the LE 1M PHY
  • 0x04: Scan advertisements on the LE Coded PHY

    • Scan_Type[i]

    1

    Passive or active scanning. With passive scanning, no scan request PDUs are sent.

  • 0x00: Passive scanning
  • 0x01: Active scanning

    • 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.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Scan_Window[i]

    2

    Duration of the scan on the primary advertising physical channel. Time = N * 0.625 ms.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI_GAP_EXT_CREATE_CONNECTION

    Description

    This command is used to create a connection with the local device in the Central role to an advertiser when the extended advertising feature is supported.
    The Advertising_Handle and Subevent parameters shall be used for a connection to a periodic advertiser. Otherwise, they shall be set to 0xFF.
    The Initiating_PHYs and subsequent parameters are used to specify the initiating parameters as defined for HCI_LE_EXTENDED_CREATE_CONNECTION: for more details, refer to Core Specification [Vol 4, Part E, 7.8.66].
    Note: this more generic command can be used instead of ACI_GAP_CREATE_CONNECTION or ACI_GAP_START_AUTO_CONNECTION_ESTABLISH_PROC.

    Input parameters

    ParameterSizeDescriptionPossible values

    Initiating_Mode

    1

    Reserved, shall be set to 0.

  • 0x00

    • Procedure

    1

    Connection procedure.

  • 0x08: GAP_AUTO_CONNECTION_ESTABLISHMENT_PROC
  • 0x40: GAP_DIRECT_CONNECTION_ESTABLISHMENT_PROC

    • 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.

  • 0x00: Public address
  • 0x01: Static random address
  • 0x02: Resolvable private address

    • Peer_Address_Type

    1

    The address type of the peer device.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • Peer_Address

    6

    Public Device Address or Random Device Address of the device to be connected.

    Advertising_Handle

    1

    Used to identify the subevent where a connection request shall be initiated from a periodic advertising train.

  • 0xFF: Parameter not used
  • 0x00 ... 0xEF

    • Subevent

    1

    Subevent where the connection request is to be sent.

  • 0xFF: Parameter not used
  • 0x00 ... 0x7F

    • Initiator_Filter_Policy

    1

    Initiator filter policy.

  • 0x00: Filter Accept List is not used to determine which advertiser to connect to
  • 0x01: Filter Accept List is used to determine which advertiser to connect to (Peer_Address_Type and Peer_Address are ignored)

    • Initiating_PHYs

    1

    Initiating PHYs.

    Bitmask of:

  • 0x01: Scan connectable advertisements on the LE 1M PHY- Connection parameters for the LE 1M PHY
  • 0x02: Connection parameters for the LE 2M PHY
  • 0x04: Scan connectable advertisements on the LE Coded PHY

    • 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.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Scan_Window[i]

    2

    Duration of the scan on the primary advertising physical channel. Time = N * 0.625 ms.

  • 0x0004 (2.500 ms) ... 0xFFFF (40959.375 ms) : full supported range

    • Conn_Interval_Min[i]

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max[i]

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency[i]

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Min_CE_Length[i]

    2

    Information parameter about the minimum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Max_CE_Length[i]

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT
  • ACI_GAP_PROC_COMPLETE_EVENT

    • ACI GATT/ATT commands

    CommandOpcodeBPBFPOLO
    ACI_GATT_INIT

    0xFD01

    Y

    Y

    Y

    ACI_GATT_ADD_SERVICE

    0xFD02

    Y

    Y

    Y

    ACI_GATT_INCLUDE_SERVICE

    0xFD03

    Y

    Y

    Y

    ACI_GATT_ADD_CHAR

    0xFD04

    Y

    Y

    Y

    ACI_GATT_ADD_CHAR_DESC

    0xFD05

    Y

    Y

    Y

    ACI_GATT_UPDATE_CHAR_VALUE

    0xFD06

    Y

    Y

    Y

    ACI_GATT_DEL_CHAR

    0xFD07

    Y

    Y

    Y

    ACI_GATT_DEL_SERVICE

    0xFD08

    Y

    Y

    Y

    ACI_GATT_DEL_INCLUDE_SERVICE

    0xFD09

    Y

    Y

    Y

    ACI_GATT_SET_EVENT_MASK

    0xFD0A

    Y

    Y

    Y

    ACI_GATT_EXCHANGE_CONFIG

    0xFD0B

    Y

    Y

    ACI_ATT_FIND_INFO_REQ

    0xFD0C

    Y

    Y

    ACI_ATT_FIND_BY_TYPE_VALUE_REQ

    0xFD0D

    Y

    Y

    ACI_ATT_READ_BY_TYPE_REQ

    0xFD0E

    Y

    Y

    ACI_ATT_READ_BY_GROUP_TYPE_REQ

    0xFD0F

    Y

    Y

    ACI_ATT_PREPARE_WRITE_REQ

    0xFD10

    Y

    Y

    ACI_ATT_EXECUTE_WRITE_REQ

    0xFD11

    Y

    Y

    ACI_GATT_DISC_ALL_PRIMARY_SERVICES

    0xFD12

    Y

    Y

    ACI_GATT_DISC_PRIMARY_SERVICE_BY_UUID

    0xFD13

    Y

    Y

    ACI_GATT_FIND_INCLUDED_SERVICES

    0xFD14

    Y

    Y

    ACI_GATT_DISC_ALL_CHAR_OF_SERVICE

    0xFD15

    Y

    Y

    ACI_GATT_DISC_CHAR_BY_UUID

    0xFD16

    Y

    Y

    ACI_GATT_DISC_ALL_CHAR_DESC

    0xFD17

    Y

    Y

    ACI_GATT_READ_CHAR_VALUE

    0xFD18

    Y

    Y

    ACI_GATT_READ_USING_CHAR_UUID

    0xFD19

    Y

    Y

    ACI_GATT_READ_LONG_CHAR_VALUE

    0xFD1A

    Y

    Y

    ACI_GATT_READ_MULTIPLE_CHAR_VALUE

    0xFD1B

    Y

    Y

    ACI_GATT_WRITE_CHAR_VALUE

    0xFD1C

    Y

    Y

    ACI_GATT_WRITE_LONG_CHAR_VALUE

    0xFD1D

    Y

    Y

    ACI_GATT_WRITE_CHAR_RELIABLE

    0xFD1E

    Y

    Y

    ACI_GATT_WRITE_WITHOUT_RESP

    0xFD23

    Y

    Y

    ACI_GATT_SIGNED_WRITE_WITHOUT_RESP

    0xFD24

    Y

    Y

    ACI_GATT_CONFIRM_INDICATION

    0xFD25

    Y

    Y

    ACI_GATT_PERMIT_WRITE

    0xFD26

    Y

    Y

    Y

    ACI_GATT_PERMIT_READ

    0xFD27

    Y

    Y

    Y

    ACI_GATT_SET_SECURITY_PERMISSION

    0xFD28

    Y

    Y

    Y

    ACI_GATT_SET_DESC_VALUE

    0xFD29

    Y

    Y

    Y

    ACI_GATT_READ_HANDLE_VALUE

    0xFD2A

    Y

    Y

    Y

    ACI_GATT_UPDATE_CHAR_VALUE_EXT

    0xFD2C

    Y

    Y

    Y

    ACI_GATT_SET_ACCESS_PERMISSION

    0xFD2E

    Y

    Y

    Y

    ACI_GATT_STORE_DB

    0xFD30

    Y

    Y

    Y

    ACI_GATT_SEND_MULT_NOTIFICATION

    0xFD31

    Y

    ACI_GATT_READ_MULTIPLE_VAR_CHAR_VALUE

    0xFD32

    Y

    ACI_GATT_WRITE_WITHOUT_RESP_EXT

    0xFD40

    Y

    Y

    ACI_GATT_WRITE_WITH_RESP_EXT

    0xFD41

    Y

    Y

    ACI_GATT_INIT

    Description

    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.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_ADD_SERVICE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 0x01: Primary Service
  • 0x02: Secondary Service

    • Max_Attribute_Records

    1

    Maximum number of attribute records that can be added to this service

    Output parameters

    ParameterSizeDescriptionPossible 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>

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_INCLUDE_SERVICE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Include_Handle

    2

    Handle of the include declaration

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_ADD_CHAR

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible 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 (Core Specification [Vol 3, Part G, 3.3.1.1])

    Bitmask of:

  • 0x00: CHAR_PROP_NONE
  • 0x01: CHAR_PROP_BROADCAST (Broadcast)
  • 0x02: CHAR_PROP_READ (Read)
  • 0x04: CHAR_PROP_WRITE_WITHOUT_RESP (Write w/o resp)
  • 0x08: CHAR_PROP_WRITE (Write)
  • 0x10: CHAR_PROP_NOTIFY (Notify)
  • 0x20: CHAR_PROP_INDICATE (Indicate)
  • 0x40: CHAR_PROP_SIGNED_WRITE (Authenticated Signed Writes)
  • 0x80: CHAR_PROP_EXT (Extended Properties)

    • Security_Permissions

    1

    Security permission flags.

    Bitmask of:

  • 0x00: None
  • 0x01: AUTHEN_READ (need authentication to read)
  • 0x02: AUTHOR_READ (need authorization to read)
  • 0x04: ENCRY_READ (need encryption to read)
  • 0x08: AUTHEN_WRITE (need authentication to write)
  • 0x10: AUTHOR_WRITE (need authorization to write)
  • 0x20: ENCRY_WRITE (need encryption to write)
  • 0x40: SC_READ (need Secure Connections to read)
  • 0x80: SC_WRITE (need Secure Connections to write)

    • GATT_Evt_Mask

    1

    GATT event mask.

    Bitmask of:

  • 0x00: GATT_DONT_NOTIFY_EVENTS
  • 0x01: GATT_NOTIFY_ATTRIBUTE_WRITE
  • 0x02: GATT_NOTIFY_WRITE_REQ_AND_WAIT_FOR_APPL_RESP
  • 0x04: GATT_NOTIFY_READ_REQ_AND_WAIT_FOR_APPL_RESP
  • 0x08: GATT_NOTIFY_NOTIFICATION_COMPLETION

    • Enc_Key_Size

    1

    Minimum encryption key size required to read the characteristic.

  • 0x07 ... 0x10

    • Is_Variable

    1

    Specify if the characteristic value has a fixed length or a variable length.

  • 0x00: Fixed length
  • 0x01: Variable length

    • Output parameters

    ParameterSizeDescriptionPossible 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).

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_ADD_CHAR_DESC

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible 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:

  • 0x00: None
  • 0x01: AUTHEN_READ (need authentication to read)
  • 0x02: AUTHOR_READ (need authorization to read)
  • 0x04: ENCRY_READ (need encryption to read)
  • 0x08: AUTHEN_WRITE (need authentication to write)
  • 0x10: AUTHOR_WRITE (need authorization to write)
  • 0x20: ENCRY_WRITE (need encryption to write)
  • 0x40: SC_READ (need Secure Connections to read)
  • 0x80: SC_WRITE (need Secure Connections to write)

    • Access_Permissions

    1

    Access permission

    Bitmask of:

  • 0x00: None
  • 0x01: READ
  • 0x02: WRITE
  • 0x04: WRITE_WO_RESP
  • 0x08: SIGNED_WRITE

    • GATT_Evt_Mask

    1

    GATT event mask.

    Bitmask of:

  • 0x00: GATT_DONT_NOTIFY_EVENTS
  • 0x01: GATT_NOTIFY_ATTRIBUTE_WRITE
  • 0x02: GATT_NOTIFY_WRITE_REQ_AND_WAIT_FOR_APPL_RESP
  • 0x04: GATT_NOTIFY_READ_REQ_AND_WAIT_FOR_APPL_RESP

    • Enc_Key_Size

    1

    Minimum encryption key size required to read the characteristic.

  • 0x07 ... 0x10

    • Is_Variable

    1

    Specify if the characteristic value has a fixed length or a variable length.

  • 0x00: Fixed length
  • 0x01: Variable length

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Char_Desc_Handle

    2

    Handle of the characteristic descriptor

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_UPDATE_CHAR_VALUE

    Description

    Updates a characteristic value in a service. If notifications (or indications) are enabled on that characteristic, a notification (or indication) is sent to any client that has registered for notifications (or indications) via the Client Characteristic Configuration.
    Notes:
    - The command is disallowed if it would cause the generation of an indication on a bearer which is still awaiting confirmation of a previous indication.
    - The command does not execute and returns BLE_STATUS_BUSY if notifications from a previous call are not completed. The application can enable and wait for the event ACI_GATT_NOTIFICATION_COMPLETE_EVENT to avoid this case.
    - The command does not execute and returns BLE_STATUS_INSUFFICIENT_RESOURCES if there is no more room in the TX pool to allocate notification (or indication) packets. This happens if notifications (or indications) are enabled and the application calls this command 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). The application can wait for the event ACI_GATT_TX_POOL_AVAILABLE_EVENT before retrying a call to this command. It can also retry the call until it does not return BLE_STATUS_INSUFFICIENT_RESOURCES anymore.
    - When calling this command, the characteristic value is updated only if the command returns BLE_STATUS_SUCCESS or BLE_STATUS_SEC_PERMISSION_ERROR. The security permission error means that at least one client has not been notified due to security requirements not met.

    Input parameters

    ParameterSizeDescriptionPossible 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 Char_Value parameter in octets.

    Char_Value

    Char_Value_Length

    Characteristic value

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_GATT_NOTIFICATION_COMPLETE_EVENT

    • ACI_GATT_DEL_CHAR

    Description

    Deletes the specified characteristic from the service.

    Input parameters

    ParameterSizeDescriptionPossible values

    Serv_Handle

    2

    Handle of service to which the characteristic belongs

    Char_Handle

    2

    Handle of the characteristic which has to be deleted

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_DEL_SERVICE

    Description

    Deletes the specified service from the GATT server database.

    Input parameters

    ParameterSizeDescriptionPossible values

    Serv_Handle

    2

    Handle of the service to be deleted

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_DEL_INCLUDE_SERVICE

    Description

    Deletes the Include definition from the service.

    Input parameters

    ParameterSizeDescriptionPossible 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_SET_EVENT_MASK

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    GATT_Evt_Mask

    4

    ACI GATT/ATT event mask. Default: 0x000FFFFF.

  • 0x00000001: ACI_GATT_ATTRIBUTE_MODIFIED_EVENT
  • 0x00000002: ACI_GATT_PROC_TIMEOUT_EVENT
  • 0x00000004: ACI_ATT_EXCHANGE_MTU_RESP_EVENT
  • 0x00000008: ACI_ATT_FIND_INFO_RESP_EVENT
  • 0x00000010: ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT
  • 0x00000020: ACI_ATT_READ_BY_TYPE_RESP_EVENT
  • 0x00000040: ACI_ATT_READ_RESP_EVENT
  • 0x00000080: ACI_ATT_READ_BLOB_RESP_EVENT
  • 0x00000100: ACI_ATT_READ_MULTIPLE_RESP_EVENT
  • 0x00000200: ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT
  • 0x00000800: ACI_ATT_PREPARE_WRITE_RESP_EVENT
  • 0x00001000: ACI_ATT_EXEC_WRITE_RESP_EVENT
  • 0x00002000: ACI_GATT_INDICATION_EVENT
  • 0x00004000: ACI_GATT_NOTIFICATION_EVENT
  • 0x00008000: ACI_GATT_ERROR_RESP_EVENT
  • 0x00010000: ACI_GATT_PROC_COMPLETE_EVENT
  • 0x00020000: ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT
  • 0x00040000: ACI_GATT_TX_POOL_AVAILABLE_EVENT
  • 0x00100000: ACI_GATT_READ_EXT_EVENT
  • 0x00200000: ACI_GATT_INDICATION_EXT_EVENT
  • 0x00400000: ACI_GATT_NOTIFICATION_EXT_EVENT

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_EXCHANGE_CONFIG

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_EXCHANGE_MTU_RESP_EVENT

    • ACI_ATT_FIND_INFO_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Start_Handle

    2

    First requested handle number

    End_Handle

    2

    Last requested handle number

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_FIND_INFO_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_ATT_FIND_BY_TYPE_VALUE_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_ATT_READ_BY_TYPE_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_BY_TYPE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_ATT_READ_BY_GROUP_TYPE_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_ATT_PREPARE_WRITE_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_PREPARE_WRITE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_ATT_EXECUTE_WRITE_REQ

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Execute

    1

    Execute or cancel writes.

  • 0x00: Cancel all prepared writes
  • 0x01: Immediately write all pending prepared values

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_EXEC_WRITE_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_DISC_ALL_PRIMARY_SERVICES

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_DISC_PRIMARY_SERVICE_BY_UUID

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_FIND_INCLUDED_SERVICES

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Start_Handle

    2

    Start attribute handle of the service

    End_Handle

    2

    End attribute handle of the service

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_BY_TYPE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_DISC_ALL_CHAR_OF_SERVICE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Start_Handle

    2

    Start attribute handle of the service

    End_Handle

    2

    End attribute handle of the service

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_BY_TYPE_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_DISC_CHAR_BY_UUID

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_DISC_ALL_CHAR_DESC

    Description

    Starts the procedure to discover all characteristic descriptors within a characteristic definition.
    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Char_Handle

    2

    Handle of the characteristic value

    End_Handle

    2

    End handle of the characteristic

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_FIND_INFO_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_READ_CHAR_VALUE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Attr_Handle

    2

    Handle of the characteristic value (or descriptor) to be read

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_READ_USING_CHAR_UUID

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_READ_LONG_CHAR_VALUE

    Description

    Starts the procedure to read a long characteristic value (or descriptor).
    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Attr_Handle

    2

    Handle of the characteristic value (or descriptor) to be read

    Val_Offset

    2

    Offset from which the value needs to be read

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_BLOB_RESP_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_READ_MULTIPLE_CHAR_VALUE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Number_of_Handles

    1

    Number of handles in the following table

  • 0x02 ... 0x7E

    • Handle[i]

    2

    Attribute handle

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_MULTIPLE_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_WRITE_CHAR_VALUE

    Description

    Starts the procedure to write a characteristic value (or a characteristic descriptor).
    When the procedure is completed, a ACI_GATT_PROC_COMPLETE_EVENT event is generated.
    The length of the value to be written must not exceed (ATT_MTU - 3).

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_WRITE_LONG_CHAR_VALUE

    Description

    Starts the procedure to write a long characteristic value (or 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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT
  • ACI_ATT_PREPARE_WRITE_RESP_EVENT
  • ACI_ATT_EXEC_WRITE_RESP_EVENT

    • ACI_GATT_WRITE_CHAR_RELIABLE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT
  • ACI_ATT_PREPARE_WRITE_RESP_EVENT
  • ACI_ATT_EXEC_WRITE_RESP_EVENT

    • ACI_GATT_WRITE_WITHOUT_RESP

    Description

    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).

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_SIGNED_WRITE_WITHOUT_RESP

    Description

    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).

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_CONFIRM_INDICATION

    Description

    Allow application to confirm indication. This command has to be sent when the application receives the event ACI_GATT_INDICATION_EVENT.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_PERMIT_WRITE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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.

  • 0x00: The value can be written to the attribute specified by attr_handle
  • 0x01: The value cannot be written to the attribute specified by the attr_handle

    • Error_Code

    1

    The error code that has to be passed to the client in case the access is denied.

  • 0x08: Insufficient Authorization
  • 0x80 ... 0x9F: Application Error

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_PERMIT_READ

    Description

    This command is used to allow or deny the GATT server to send a response to a read request from a client. The application must end this command when it receives the permission request event, either ACI_GATT_READ_PERMIT_REQ_EVENT or ACI_GATT_READ_MULTI_PERMIT_REQ_EVENT. The application should issue this command within 30 seconds from the reception of the permission request event; otherwise the GATT procedure issues a timeout.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Read_status

    1

    Specifies whether read access is allowed for all attributes from the permission request event (0), or denied for some or all attributes (1).

  • 0x00: Read access is allowed
  • 0x01: Read access is denied

    • Error_Code

    1

    The error code that has to be passed to the client in case the access is denied.

  • 0x08: Insufficient Authorization
  • 0x80 ... 0x9F: Application Error

    • Attr_Handle

    2

    This parameter is only valid if one or more read permissions are denied. It is the handle of the first attribute in the permission request event for which read permission is denied. When set to 0, reading all attributes from the event is denied.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_SET_SECURITY_PERMISSION

    Description

    This command sets the security permission flags for the attribute handle specified. It can be used to change the default value of these flags after an attribute has been created.

    Input parameters

    ParameterSizeDescriptionPossible values

    Serv_Handle

    2

    Handle of the service which contains the attribute whose permission has to be modified

    Attr_Handle

    2

    Handle of the attribute whose permission has to be modified

    Security_Permissions

    1

    Security permission flags.

    Bitmask of:

  • 0x00: None
  • 0x01: AUTHEN_READ (need authentication to read)
  • 0x02: AUTHOR_READ (need authorization to read)
  • 0x04: ENCRY_READ (need encryption to read)
  • 0x08: AUTHEN_WRITE (need authentication to write)
  • 0x10: AUTHOR_WRITE (need authorization to write)
  • 0x20: ENCRY_WRITE (need encryption to write)
  • 0x40: SC_READ (need Secure Connections to read)
  • 0x80: SC_WRITE (need Secure Connections to write)

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_SET_DESC_VALUE

    Description

    This command sets the value of the descriptor specified by Char_Desc_Handle.

    Input parameters

    ParameterSizeDescriptionPossible 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_READ_HANDLE_VALUE

    Description

    Reads the value of the attribute handle specified from the local GATT database.

    Input parameters

    ParameterSizeDescriptionPossible 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

    Output parameters

    ParameterSizeDescriptionPossible 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

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_UPDATE_CHAR_VALUE_EXT

    Description

    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.
    The description notes for the ACI_GATT_UPDATE_CHAR_VALUE command also apply here.

    Input parameters

    ParameterSizeDescriptionPossible values

    Conn_Handle_To_Notify

    2

    Specifies the client(s) to be notified.

  • 0x0000: Notify all subscribed clients on their unenhanced ATT bearer
  • 0x0001 ... 0x0EFF: Notify one client on the specified unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Notify one client on the specified enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Service_Handle

    2

    Handle of service to which the characteristic belongs

    Char_Handle

    2

    Handle of the characteristic declaration

    Update_Type

    1

    Allow Notification or Indication generation, if enabled in the client characteristic configuration descriptor

    Bitmask of:

  • 0x00: Do not notify
  • 0x01: Notification
  • 0x02: Indication

    • 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_GATT_NOTIFICATION_COMPLETE_EVENT

    • ACI_GATT_SET_ACCESS_PERMISSION

    Description

    This command sets the access permission for the attribute handle specified.

    Input parameters

    ParameterSizeDescriptionPossible values

    Serv_Handle

    2

    Handle of the service which contains the attribute whose permission has to be modified

    Attr_Handle

    2

    Handle of the attribute whose permission has to be modified

    Access_Permissions

    1

    Access permission

    Bitmask of:

  • 0x00: None
  • 0x01: READ
  • 0x02: WRITE
  • 0x04: WRITE_WO_RESP
  • 0x08: SIGNED_WRITE

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_STORE_DB

    Description

    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.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_SEND_MULT_NOTIFICATION

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Number_of_Handles

    1

    Number of handles in the following table

  • 0x02 ... 0x7E

    • Handle[i]

    2

    Attribute handle

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_READ_MULTIPLE_VAR_CHAR_VALUE

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the command applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Number_of_Handles

    1

    Number of handles in the following table

  • 0x02 ... 0x7E

    • Handle[i]

    2

    Attribute handle

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_ATT_READ_MULTIPLE_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI_GATT_WRITE_WITHOUT_RESP_EXT

    Description

    This command is used on the client side to write an attribute value to the server. It can replace ACI_GATT_WRITE_WITHOUT_RESP or ACI_GATT_SIGNED_WRITE_WITHOUT_RESP when the length of the data to be written exceeds the capacity supported by these commands. In this case, the data to be written is not part of the command, but is stored in the "extra data" buffer, which must be pre-filled by the application before calling this command. The used portion of the "extra data" buffer can only be reused after receiving HCI_COMMAND_COMPLETE_EVENT.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Attr_Handle

    2

    Handle of the characteristic value to be written

    Signed_Mode

    1

    Specifies the type of GATT write without response: signed or not.

  • 0x00: Write Without Response
  • 0x01: Signed Write Without Response

    • Data_Length

    2

    Length of the data to be written.

    Data_Pointer

    4

    Pointer to the data to be written (it is the offset in bytes from the start of the "extra data" buffer).

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_GATT_WRITE_WITH_RESP_EXT

    Description

    This command is used on the client side to write an attribute value to the server. It can replace ACI_GATT_WRITE_CHAR_VALUE, ACI_GATT_WRITE_LONG_CHAR_VALUE or ACI_GATT_WRITE_CHAR_RELIABLE when the length of the data to be written exceeds the capacity supported by these commands. In this case, the data to be written is not part of the command, but is stored in the "extra data" buffer, which must be pre-filled by the application before calling this command. The used portion of the "extra data" buffer can only be reused after receiving ACI_GATT_PROC_COMPLETE_EVENT.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Attr_Handle

    2

    Handle of the characteristic value to be written

    Write_Mode

    1

    Specifies the type of GATT write with response procedure.

  • 0x00: Write Characteristic Value/Descriptor
  • 0x01: Write Long Characteristic Value/Descriptor
  • 0x02: Reliable Write Characteristic Value

    • Val_Offset

    2

    Offset at which the attribute has to be written

    Data_Length

    2

    Length of the data to be written.

    Data_Pointer

    4

    Pointer to the data to be written (it is the offset in bytes from the start of the "extra data" buffer).

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_GATT_ERROR_RESP_EVENT
  • ACI_ATT_PREPARE_WRITE_RESP_EVENT
  • ACI_ATT_EXEC_WRITE_RESP_EVENT
  • ACI_GATT_PROC_COMPLETE_EVENT

    • ACI L2CAP commands

    CommandOpcodeBPBFPOLO
    ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_REQ

    0xFD81

    Y

    Y

    Y

    ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_RESP

    0xFD82

    Y

    Y

    ACI_L2CAP_COC_CONNECT

    0xFD88

    Y

    ACI_L2CAP_COC_CONNECT_CONFIRM

    0xFD89

    Y

    ACI_L2CAP_COC_RECONF

    0xFD8A

    Y

    ACI_L2CAP_COC_RECONF_CONFIRM

    0xFD8B

    Y

    ACI_L2CAP_COC_DISCONNECT

    0xFD8C

    Y

    ACI_L2CAP_COC_FLOW_CONTROL

    0xFD8D

    Y

    ACI_L2CAP_COC_TX_DATA

    0xFD8E

    Y

    ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_REQ

    Description

    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).

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Conn_Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • Timeout_Multiplier

    2

    Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_STATUS_EVENT
  • ACI_L2CAP_CONNECTION_UPDATE_RESP_EVENT
  • ACI_L2CAP_PROC_TIMEOUT_EVENT
  • ACI_L2CAP_COMMAND_REJECT_EVENT

    • ACI_L2CAP_CONNECTION_PARAMETER_UPDATE_RESP

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Conn_Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Maximum_CE_Length

    2

    Information parameter about the maximum length of connection needed for this LE connection. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Identifier

    1

    Received identifier.

    Accept

    1

    Specify if connection update parameters are acceptable or not.

  • 0x00: Reject
  • 0x01: Accept

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_L2CAP_COC_CONNECT

    Description

    This command sends a Credit Based Connection Request packet on the specified connection. See Core Specification [Vol 3, Part A].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • SPSM

    2

    Simplified Protocol/Service Multiplexer.

  • 0x0001 ... 0x00FF

    • MTU

    2

    Maximum Transmission Unit.

  • 23 ... 65535
  • 64 ... 246: for Enhanced ATT

    • MPS

    2

    Maximum payload size (in octets).

  • 23 ... 248
  • 64 ... 248: for Enhanced ATT

    • Initial_Credits

    2

    Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet.

  • 0 ... 65535

    • 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.

  • 0 ... 5

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_L2CAP_COC_CONNECT_CONFIRM_EVENT
  • ACI_L2CAP_PROC_TIMEOUT_EVENT
  • ACI_L2CAP_COMMAND_REJECT_EVENT

    • ACI_L2CAP_COC_CONNECT_CONFIRM

    Description

    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.
    By setting the Result parameter to 0x0000, the application can accept all connections or only some. In this case, the number of accepted connections depends on the Max_Channel_Number parameter. Note that if some connections are refused, the Result parameter is automatically modified by the BLE stack.
    By setting the Result parameter to a non-zero value, the application can refuse all connections. The Result value shall then be one of the "Connection refused" or "All connections refused" values.
    See Core Specification [Vol 3, Part A].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • MTU

    2

    Maximum Transmission Unit.

  • 23 ... 65535
  • 64 ... 246: for Enhanced ATT

    • MPS

    2

    Maximum payload size (in octets).

  • 23 ... 248
  • 64 ... 248: for Enhanced ATT

    • Initial_Credits

    2

    Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet.

  • 0 ... 65535

    • Result

    2

    Indicates the outcome of the request. See Core Specification [Vol 3, Part A, Table 4.16] for LE credit based connection-oriented channels, or [Vol 3, Part A, Table 4.17] for enhanced credit based connection-oriented channels.

  • 0x0000 ... 0x000F

    • Max_Channel_Number

    1

    Indicates the maximum number of channels that can be created.

  • 0x01 ... 0x05

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Channel_Number

    1

    Number of created channels. It is the length of Channel_Index_List.

  • 0 ... 5

    • Channel_Index_List

    Channel_Number

    List of channel indexes for which the primitive applies.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_L2CAP_COC_RECONF

    Description

    This command sends a Credit Based Reconfigure Request packet on the specified connection. See Core Specification [Vol 3, Part A].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • MTU

    2

    Maximum Transmission Unit.

  • 23 ... 65535
  • 64 ... 246: for Enhanced ATT

    • MPS

    2

    Maximum payload size (in octets).

  • 23 ... 248
  • 64 ... 248: for Enhanced ATT

    • Channel_Number

    1

    Number of created channels. It is the length of Channel_Index_List.

  • 1 ... 5

    • Channel_Index_List

    Channel_Number

    List of channel indexes for which the primitive applies.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_L2CAP_COC_RECONF_CONFIRM_EVENT
  • ACI_L2CAP_PROC_TIMEOUT_EVENT
  • ACI_L2CAP_COMMAND_REJECT_EVENT

    • ACI_L2CAP_COC_RECONF_CONFIRM

    Description

    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. A Result value of 0x0000 indicates success while a non-zero value indicates the request is refused.
    See Core Specification [Vol 3, Part A].

    Input parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Result

    2

    Indicates the outcome of the request. See Core Specification [Vol 3, Part A, Table 4.18].

  • 0x0000 ... 0x0004

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_L2CAP_COC_DISCONNECT

    Description

    This command sends a Disconnection Request signaling packet on the specified connection-oriented channel. See Core Specification [Vol 3, Part A].
    The ACI_L2CAP_COC_DISCONNECT_EVENT event is received when the disconnection of the channel is effective.

    Input parameters

    ParameterSizeDescriptionPossible values

    Channel_Index

    1

    Index of the connection-oriented channel for which the primitive applies.

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_L2CAP_COC_DISCONNECT_EVENT
  • ACI_L2CAP_PROC_TIMEOUT_EVENT
  • ACI_L2CAP_COMMAND_REJECT_EVENT

    • ACI_L2CAP_COC_FLOW_CONTROL

    Description

    This command sends a Flow Control Credit signaling packet on the specified connection-oriented channel. See Core Specification [Vol 3, Part A].

    Input parameters

    ParameterSizeDescriptionPossible 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.

  • 1 ... 65535

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_L2CAP_COC_TX_DATA

    Description

    This command sends a K-frame packet on the specified connection-oriented channel. See 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.

    Input parameters

    ParameterSizeDescriptionPossible 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

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI HAL commands

    CommandOpcodeBPBFPOLO
    ACI_HAL_WRITE_CONFIG_DATA

    0xFC0C

    Y

    Y

    Y

    Y

    ACI_HAL_READ_CONFIG_DATA

    0xFC0D

    Y

    Y

    Y

    Y

    ACI_HAL_SET_TX_POWER_LEVEL

    0xFC0F

    Y

    Y

    Y

    Y

    ACI_HAL_LE_TX_TEST_PACKET_NUMBER

    0xFC14

    Y

    Y

    Y

    Y

    ACI_HAL_TONE_START

    0xFC15

    Y

    Y

    Y

    Y

    ACI_HAL_TONE_STOP

    0xFC16

    Y

    Y

    Y

    Y

    ACI_HAL_SET_RADIO_ACTIVITY_MASK

    0xFC18

    Y

    Y

    Y

    Y

    ACI_HAL_SET_EVENT_MASK

    0xFC1A

    Y

    Y

    Y

    Y

    ACI_HAL_GET_LINK_STATUS_V2

    0xFC1B

    Y

    Y

    Y

    Y

    ACI_HAL_SET_PERIPHERAL_LATENCY

    0xFC20

    Y

    Y

    Y

    Y

    ACI_HAL_SET_SYNC_EVENT_CONFIG

    0xFC21

    Y

    ACI_HAL_READ_RSSI

    0xFC22

    Y

    Y

    Y

    Y

    ACI_HAL_CONTINUOUS_TX_START

    0xFC2E

    ACI_HAL_EAD_ENCRYPT_DECRYPT

    0xFC2F

    Y

    ACI_HAL_WRITE_CONFIG_DATA

    Description

    This command writes a value to a configure data structure. It is useful to setup directly some parameters for the BLE stack.
    Refer to Annex for details on the different parameters that can be configured.
    Note: this command is an alias of ACI_WRITE_CONFIG_DATA.

    Input parameters

    ParameterSizeDescriptionPossible values

    Offset

    1

    Offset of the element in the configuration data structure which has to be written.

  • 0x00: CONFIG_DATA_PUBLIC_ADDRESS_OFFSET; Bluetooth public address; 6 bytes
  • 0x08: CONFIG_DATA_ER_OFFSET; Encryption root key; 16 bytes
  • 0x18: CONFIG_DATA_IR_OFFSET; Identity root key; 16 bytes
  • 0x2E: CONFIG_DATA_RANDOM_ADDRESS_OFFSET; Static Random Address; 6 bytes
  • 0x34: CONFIG_DATA_GAP_ADD_REC_NBR_OFFSET; GAP service additional record number; 1 byte
  • 0x35: CONFIG_DATA_SC_KEY_TYPE_OFFSET; Secure Connections key type; 1 byte
  • 0xB0: CONFIG_DATA_SMP_MODE_OFFSET; SMP mode; 1 byte
  • 0xC2: CONFIG_DATA_LL_RSSI_GOLDEN_RANGE_OFFSET; LL RSSI golden range; 2 bytes
  • 0xC4: CONFIG_DATA_LL_RX_ACL_CTRL_OFFSET; LL RX ACL control; 2 bytes

    • Length

    1

    Length of data to be written

    Value

    Length

    Data to be written

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_READ_CONFIG_DATA

    Description

    This command requests the value in the configure data structure. The number of read bytes changes for different Offset.
    Note: this command is an alias of ACI_READ_CONFIG_DATA.

    Input parameters

    ParameterSizeDescriptionPossible values

    Offset

    1

    Offset of the element in the configuration data structure which has to be read.

  • 0x00: CONFIG_DATA_PUBLIC_ADDRESS_OFFSET; Bluetooth public address; 6 bytes
  • 0x08: CONFIG_DATA_ER_OFFSET; Encryption root key used to derive LTK (legacy) and CSRK; 16 bytes
  • 0x18: CONFIG_DATA_IR_OFFSET Identity root key used to derive DHK (legacy) and IRK; 16 bytes
  • 0x2E: CONFIG_DATA_RANDOM_ADDRESS_OFFSET; Static Random Address; 6 bytes
  • 0xC2: CONFIG_DATA_LL_RSSI_GOLDEN_RANGE_OFFSET; LL RSSI golden range (two 8-bit signed values in dBm - byte #0 is the lower value, byte #1 is the upper value); 2 bytes

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Data_Length

    1

    Length of Data in octets

    Data

    Data_Length

    Data field associated with Offset parameter

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_SET_TX_POWER_LEVEL

    Description

    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 BLE 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.

    Input parameters

    ParameterSizeDescriptionPossible values

    En_High_Power

    1

    Enable High Power mode - Deprecated and ignored

  • 0x00: Standard Power
  • 0x01: High Power

    • PA_Level

    1

    Power amplifier output level.

  • 0x00 ... 0x23

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_LE_TX_TEST_PACKET_NUMBER

    Description

    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.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Number_Of_Packets

    4

    Number of packets sent during the last Direct TX test.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_TONE_START

    Description

    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 BLE activities are ongoing.
    The tone should be stopped by ACI_HAL_TONE_STOP command.

    Input parameters

    ParameterSizeDescriptionPossible 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).

  • 0x00 ... 0x27

    • Freq_offset

    1

    Frequency Offset for tone channel

  • 0x00 ... 0xFF

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_TONE_STOP

    Description

    This command is used to stop the previously started ACI_HAL_TONE_START command.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_SET_RADIO_ACTIVITY_MASK

    Description

    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

    Input parameters

    ParameterSizeDescriptionPossible values

    Radio_Activity_Mask

    2

    Bitmask of radio events

    Bitmask of:

  • 0x0001: Idle
  • 0x0002: Advertising
  • 0x0004: Peripheral connection
  • 0x0008: Scanning
  • 0x0020: Central connection
  • 0x0040: TX test mode
  • 0x0080: RX test mode
  • 0x0200: Periodic advertising
  • 0x0400: Periodic sync
  • 0x0800: Iso broadcast
  • 0x1000: Iso sync
  • 0x2000: Iso peripheral connection
  • 0x4000: Iso central connection

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT
  • ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT

    • ACI_HAL_SET_EVENT_MASK

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Event_Mask

    4

    ACI HAL event mask. Default: 0x00000000.

    Bitmask of:

  • 0x00000000: No events specified (Default)
  • 0x00000002: ACI_HAL_SYNC_EVENT

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_GET_LINK_STATUS_V2

    Description

    This command returns the status of the BLE links managed by the device.

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Link_Status

    22

    Array of link status (up to 20 links plus 2 ISO streams). Each link status is 1 byte.

  • 0x00: Idle
  • 0x01: Advertising
  • 0x02: Peripheral connection
  • 0x03: Scanning
  • 0x05: Central connection
  • 0x06: TX test mode
  • 0x07: RX test mode
  • 0x09: Periodic advertising
  • 0x0A: Periodic sync
  • 0x0B: Iso broadcast
  • 0x0C: Iso sync
  • 0x0D: Iso peripheral connection
  • 0x0E: Iso central connection

    • Link_Connection_Handle

    44

    Array of connection handles (2 bytes). Valid only if the corresponding link status is "connected"

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_SET_PERIPHERAL_LATENCY

    Description

    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.

    Input parameters

    ParameterSizeDescriptionPossible values

    Enable

    1

    Enable/disable Peripheral latency.

  • 0x00: Peripheral latency is disabled
  • 0x01: Peripheral latency is enabled

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_SET_SYNC_EVENT_CONFIG

    Description

    This command is used to configure ACI_HAL_SYNC_EVENT.

    Input parameters

    ParameterSizeDescriptionPossible values

    Group_Id

    1

    Identifier of the CIG or BIG.

  • 0x00 ... 0xEF

    • Enable_Sync

    1

    Enable or disable generation of sync event.

  • 0x00 ... 0x01

    • Enable_Cb_Trigger

    1

    Enable or disable generation of calibration signal.

  • 0x00 ... 0x01

    • Trigger_Source

    1

    Identify trigger source (CIG or BIG).

  • 0x00: CIG
  • 0x01: BIG

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_READ_RSSI

    Description

    This command returns the value of the RSSI.
    Note: in Direct Test Mode, the RSSI can only be read when the test has ended (after LE Test End command).

    Input parameters

    None

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    RSSI

    1

    RSSI (signed integer). Units: dBm.

  • 127: RSSI not available
  • -127 ... 20

    • Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_CONTINUOUS_TX_START

    Description

    This command starts the continuous transmit test mode.

    Input parameters

    ParameterSizeDescriptionPossible values

    RF_Channel

    1

    Index of the BLE RF channel used for test mode.

  • 0x00 ... 0x27

    • PHY

    1

    PHY used for test mode.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY

    • Pattern

    1

    Data pattern used for test mode.

  • 0x00: Pseudo-Random bit sequence 9
  • 0x01: Pattern of alternating bits '11110000'
  • 0x02: Pattern of alternating bits '10101010'
  • 0x03: Pseudo-Random bit sequence 15
  • 0x04: Pattern of All '1' bits
  • 0x05: Pattern of All '0' bits
  • 0x06: Pattern of alternating bits '00001111'
  • 0x07: Pattern of alternating bits '0101'

    • Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • ACI_HAL_EAD_ENCRYPT_DECRYPT

    Description

    This command encrypts or decrypts data following the Encrypted Advertising Data scheme.
    When encryption mode is selected, In_Data shall only contain the Payload field to encrypt. The command adds the Randomizer and MIC fields in the result. The result data length (Out_Data_Length) is equal to the input length plus 9.
    When decryption mode is selected, In_Data shall contain the full Encrypted Data (Randomizer + Payload + MIC). The result data length (Out_Data_Length) is equal to the input length minus 9.
    If the decryption fails, the returned status is BLE_STATUS_FAILED, otherwise it is BLE_STATUS_SUCCESS.

    Input parameters

    ParameterSizeDescriptionPossible values

    Mode

    1

    EAD operation mode: encryption or decryption.

  • 0x00: Encryption
  • 0x01: Decryption

    • Key

    16

    Session key used for EAD operation (in Little Endian format).

    IV

    8

    Initialization vector used for EAD operation (in Little Endian format).

    In_Data_Length

    2

    Length of input data

    In_Data

    In_Data_Length

    Input data

    Output parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Out_Data_Length

    2

    Length of result data

    Out_Data

    Out_Data_Length

    Result data

    Events generated

  • HCI_COMMAND_COMPLETE_EVENT

    • HCI/ACI events

    HCI events

    HCI LE events

    ACI General events

    ACI GAP events

    ACI GATT/ATT events

    ACI L2CAP events

    ACI HAL events

    Note: in the event tables, a "Y" in the "BP", "BF", "PO" or "LO" column, means that the corresponding event applies to the "Basic Plus", "Basic Features", "Peripheral Only" or "Link Layer Only" variant of the BLE stack, respectively.

    HCI events

    Event nameEvent codeBPBFPOLO
    HCI_DISCONNECTION_COMPLETE_EVENT

    0x05

    Y

    Y

    Y

    Y

    HCI_ENCRYPTION_CHANGE_EVENT

    0x08

    Y

    Y

    Y

    Y

    HCI_READ_REMOTE_VERSION_INFORMATION_COMPLETE_EVENT

    0x0C

    Y

    Y

    Y

    Y

    HCI_COMMAND_COMPLETE_EVENT

    0x0E

    Y

    Y

    Y

    Y

    HCI_COMMAND_STATUS_EVENT

    0x0F

    Y

    Y

    Y

    Y

    HCI_HARDWARE_ERROR_EVENT

    0x10

    Y

    Y

    Y

    Y

    HCI_NUMBER_OF_COMPLETED_PACKETS_EVENT

    0x13

    Y

    HCI_DATA_BUFFER_OVERFLOW_EVENT

    0x1A

    Y

    HCI_ENCRYPTION_KEY_REFRESH_COMPLETE_EVENT

    0x30

    Y

    Y

    Y

    Y

    HCI_AUTHENTICATED_PAYLOAD_TIMEOUT_EXPIRED_EVENT

    0x57

    Y

    Y

    Note: all HCI events are enabled by default. See HCI_SET_EVENT_MASK.

    HCI_DISCONNECTION_COMPLETE_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.5].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Reason

    1

    Reason for disconnection (see Core Specification [Vol 1, Part F] Error Codes).

    HCI_ENCRYPTION_CHANGE_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.8].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Encryption_Enabled

    1

    Link Level Encryption.

  • 0x00: Link Level Encryption OFF
  • 0x01: Link Level Encryption is ON with AES-CCM

    • HCI_READ_REMOTE_VERSION_INFORMATION_COMPLETE_EVENT

    Description

    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 BLE hardware will go through as design processes change and errors are fixed. This allows the software to determine what BLE 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 Core Specification [Vol 4, Part E, 7.7.12].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • 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

    HCI_COMMAND_COMPLETE_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible 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.

    HCI_COMMAND_STATUS_EVENT

    Description

    This 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.

    Event parameters

    ParameterSizeDescriptionPossible 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.

    HCI_HARDWARE_ERROR_EVENT

    Description

    This event is used to notify the Host that a hardware failure has occurred in the Controller.
    Refer to Annex for details on the possible values of Hardware_Code.

    Event parameters

    ParameterSizeDescriptionPossible values

    Hardware_Code

    1

    Implementation-specific hardware code.

    HCI_NUMBER_OF_COMPLETED_PACKETS_EVENT

    Description

    This 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.

    Event parameters

    ParameterSizeDescriptionPossible 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.

    HCI_DATA_BUFFER_OVERFLOW_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Link_Type

    1

    Type of data whose buffers overflowed.

  • 0x00: Synchronous Data packet buffers
  • 0x01: ACL Data packet buffers
  • 0x02: ISO Data packet buffers

    • HCI_ENCRYPTION_KEY_REFRESH_COMPLETE_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • HCI_AUTHENTICATED_PAYLOAD_TIMEOUT_EXPIRED_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.75].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • HCI LE events

    Event nameLE subevent codeBPBFPOLO
    HCI_LE_CONNECTION_COMPLETE_EVENT

    0x01

    Y

    Y

    Y

    Y

    HCI_LE_ADVERTISING_REPORT_EVENT

    0x02

    Y

    Y

    Y

    HCI_LE_CONNECTION_UPDATE_COMPLETE_EVENT

    0x03

    Y

    Y

    Y

    Y

    HCI_LE_READ_REMOTE_FEATURES_PAGE_0_COMPLETE_EVENT

    0x04

    Y

    Y

    Y

    Y

    HCI_LE_LONG_TERM_KEY_REQUEST_EVENT

    0x05

    Y

    Y

    Y

    Y

    HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_EVENT

    0x06

    Y

    Y

    Y

    Y

    HCI_LE_DATA_LENGTH_CHANGE_EVENT

    0x07

    Y

    Y

    Y

    Y

    HCI_LE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE_EVENT

    0x08

    Y

    Y

    Y

    Y

    HCI_LE_GENERATE_DHKEY_COMPLETE_EVENT

    0x09

    Y

    Y

    Y

    Y

    HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT

    0x0A

    Y

    Y

    Y

    Y

    HCI_LE_DIRECTED_ADVERTISING_REPORT_EVENT

    0x0B

    Y

    Y

    Y

    HCI_LE_PHY_UPDATE_COMPLETE_EVENT

    0x0C

    Y

    Y

    Y

    Y

    HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT

    0x0D

    Y

    Y

    HCI_LE_PERIODIC_ADVERTISING_SYNC_ESTABLISHED_EVENT

    0x0E

    Y

    HCI_LE_PERIODIC_ADVERTISING_REPORT_EVENT

    0x0F

    Y

    HCI_LE_PERIODIC_ADVERTISING_SYNC_LOST_EVENT

    0x10

    Y

    HCI_LE_SCAN_TIMEOUT_EVENT

    0x11

    Y

    Y

    HCI_LE_ADVERTISING_SET_TERMINATED_EVENT

    0x12

    Y

    Y

    HCI_LE_SCAN_REQUEST_RECEIVED_EVENT

    0x13

    Y

    Y

    HCI_LE_CHANNEL_SELECTION_ALGORITHM_EVENT

    0x14

    Y

    Y

    Y

    Y

    HCI_LE_CONNECTIONLESS_IQ_REPORT_EVENT

    0x15

    Y

    HCI_LE_CONNECTION_IQ_REPORT_EVENT

    0x16

    Y

    HCI_LE_CTE_REQUEST_FAILED_EVENT

    0x17

    Y

    HCI_LE_PERIODIC_ADVERTISING_SYNC_TRANSFER_RECEIVED_EVENT

    0x18

    Y

    HCI_LE_CIS_ESTABLISHED_EVENT

    0x19

    Y

    HCI_LE_CIS_REQUEST_EVENT

    0x1A

    Y

    HCI_LE_CREATE_BIG_COMPLETE_EVENT

    0x1B

    Y

    HCI_LE_TERMINATE_BIG_COMPLETE_EVENT

    0x1C

    Y

    HCI_LE_BIG_SYNC_ESTABLISHED_EVENT

    0x1D

    Y

    HCI_LE_BIG_SYNC_LOST_EVENT

    0x1E

    Y

    HCI_LE_REQUEST_PEER_SCA_COMPLETE_EVENT

    0x1F

    Y

    HCI_LE_PATH_LOSS_THRESHOLD_EVENT

    0x20

    Y

    Y

    HCI_LE_TRANSMIT_POWER_REPORTING_EVENT

    0x21

    Y

    Y

    HCI_LE_BIGINFO_ADVERTISING_REPORT_EVENT

    0x22

    Y

    HCI_LE_SUBRATE_CHANGE_EVENT

    0x23

    Y

    Y

    HCI_LE_PERIODIC_ADVERTISING_SYNC_ESTABLISHED_V2_EVENT

    0x24

    Y

    HCI_LE_PERIODIC_ADVERTISING_REPORT_V2_EVENT

    0x25

    Y

    HCI_LE_PERIODIC_ADVERTISING_SYNC_TRANSFER_RECEIVED_V2_EVENT

    0x26

    Y

    HCI_LE_PERIODIC_ADVERTISING_SUBEVENT_DATA_REQUEST_EVENT

    0x27

    Y

    HCI_LE_PERIODIC_ADVERTISING_RESPONSE_REPORT_EVENT

    0x28

    Y

    HCI_LE_ENHANCED_CONNECTION_COMPLETE_V2_EVENT

    0x29

    Y

    HCI_LE_CIS_ESTABLISHED_V2_EVENT

    0x2A

    Y

    HCI_LE_READ_ALL_REMOTE_FEATURES_COMPLETE_EVENT

    0x2B

    Y

    HCI_LE_CS_READ_REMOTE_SUPPORTED_CAPABILITIES_COMPLETE_EVENT

    0x2C

    Y

    HCI_LE_CS_READ_REMOTE_FAE_TABLE_COMPLETE_EVENT

    0x2D

    Y

    HCI_LE_CS_SECURITY_ENABLE_COMPLETE_EVENT

    0x2E

    Y

    HCI_LE_CS_CONFIG_COMPLETE_EVENT

    0x2F

    Y

    HCI_LE_CS_PROCEDURE_ENABLE_COMPLETE_EVENT

    0x30

    Y

    HCI_LE_CS_SUBEVENT_RESULT_EVENT

    0x31

    Y

    HCI_LE_CS_SUBEVENT_RESULT_CONTINUE_EVENT

    0x32

    Y

    HCI_LE_CS_TEST_END_COMPLETE_EVENT

    0x33

    Y

    HCI_LE_MONITORED_ADVERTISERS_REPORT_EVENT

    0x34

    Y

    HCI_LE_FRAME_SPACE_UPDATE_COMPLETE_EVENT

    0x35

    Y

    Note: not all HCI LE events are enabled by default. See HCI_LE_SET_EVENT_MASK.

    HCI_LE_CONNECTION_COMPLETE_EVENT

    Description

    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.
    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 Core Specification [Vol 4, Part E, 7.7.65.1].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Role

    1

    Role of the local device in the connection.

  • 0x00: Central
  • 0x01: Peripheral

    • Peer_Address_Type

    1

    The address type of the peer device.

  • 0x00: Public Device Address
  • 0x01: Random Device Address

    • 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.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Central_Clock_Accuracy

    1

    Central clock accuracy. Only valid for a Peripheral.

  • 0x00: 500 ppm
  • 0x01: 250 ppm
  • 0x02: 150 ppm
  • 0x03: 100 ppm
  • 0x04: 75 ppm
  • 0x05: 50 ppm
  • 0x06: 30 ppm
  • 0x07: 20 ppm

    • HCI_LE_ADVERTISING_REPORT_EVENT

    Description

    This 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 Core Specification [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).

    Event parameters

    ParameterSizeDescriptionPossible values

    Num_Reports

    1

    Number of responses in this event.

  • 0x01

    • 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.

  • 0x00: ADV_IND
  • 0x01: ADV_DIRECT_IND
  • 0x02: ADV_SCAN_IND
  • 0x03: ADV_NONCONN_IND
  • 0x04: SCAN_RSP

    • Address_Type[i]

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Public Identity Address (corresponds to the Resolved Private Address)
  • 0x03: Random (static) Identity Address (corresponds to the 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.

  • 0 ... 31

    • Data[i]

    Length_Data[i]

    Octets of advertising or scan response data formatted as defined in Core Specification [Vol 3, Part C, 11].

    RSSI[i]

    1

    RSSI (signed integer). Units: dBm.

  • 127: RSSI not available
  • -127 ... 20

    • HCI_LE_CONNECTION_UPDATE_COMPLETE_EVENT

    Description

    This event is used to indicate that the Controller process to update the connection has completed.
    See Core Specification [Vol 4, Part E, 7.7.65.3].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Conn_Interval

    2

    Connection interval used on this connection. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • HCI_LE_READ_REMOTE_FEATURES_PAGE_0_COMPLETE_EVENT

    Description

    This event is used to indicate the completion of the process of the Controller obtaining page 0 of the features used on the connection and the features supported by the remote BLE device specified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.7.65.4].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • LE_Features

    8

    Bit Mask List of page 0 of the supported LE features. See Core Specification [Vol 6, Part B, 4.6].

    HCI_LE_LONG_TERM_KEY_REQUEST_EVENT

    Description

    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 Core Specification [Vol 6, Part B, 5.1.3] and [Vol 4, Part E, 7.7.65.5].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Random_Number

    8

    64-bit random number

    Encrypted_Diversifier

    2

    16-bit encrypted diversifier

    HCI_LE_REMOTE_CONNECTION_PARAMETER_REQUEST_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.6].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Interval_Min

    2

    Minimum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Max_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • HCI_LE_DATA_LENGTH_CHANGE_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.7] and [Vol 6, Part B, 4.5.10].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • MaxTxOctets

    2

    The maximum number of payload octets in a Link Layer packet that the local Controller will send on this connection (connEffectiveMaxTxOctets).

  • 0x001B ... 0x00FB

    • MaxTxTime

    2

    The maximum time that the local Controller will take to send a Link Layer packet on this connection (connEffectiveMaxTxTime).

  • 0x0148 ... 0x4290

    • MaxRxOctets

    2

    The maximum number of payload octets in a Link Layer packet that the local Controller expects to receive on this connection (connEffectiveMaxRxOctets).

  • 0x001B ... 0x00FB

    • MaxRxTime

    2

    The maximum time that the local Controller expects to take to receive a Link Layer packet on this connection (connEffectiveMaxRxTime).

  • 0x0148 ... 0x4290

    • HCI_LE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE_EVENT

    Description

    This event is generated when local P-256 key generation is complete.
    See Core Specification [Vol 4, Part E, 7.7.65.8].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Local_P256_Public_Key

    64

    Local P-256 public key.

    HCI_LE_GENERATE_DHKEY_COMPLETE_EVENT

    Description

    This event indicates that LE Diffie Hellman key generation has been completed by the Controller.
    See Core Specification [Vol 4, Part E, 7.7.65.9].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    DHKey

    32

    Diffie Hellman Key

    HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.10].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Role

    1

    Role of the local device in the connection.

  • 0x00: Central
  • 0x01: Peripheral

    • Peer_Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Public Identity Address (corresponds to the Resolved Private Address)
  • 0x03: Random (static) Identity Address (corresponds to the 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.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Central_Clock_Accuracy

    1

    Central clock accuracy. Only valid for a Peripheral.

  • 0x00: 500 ppm
  • 0x01: 250 ppm
  • 0x02: 150 ppm
  • 0x03: 100 ppm
  • 0x04: 75 ppm
  • 0x05: 50 ppm
  • 0x06: 30 ppm
  • 0x07: 20 ppm

    • HCI_LE_DIRECTED_ADVERTISING_REPORT_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.11].

    Event parameters

    ParameterSizeDescriptionPossible values

    Num_Reports

    1

    Number of responses in this event.

  • 0x01

    • Event_Type[i]

    1

    Advertising type

  • 0x01: Connectable directed advertising (ADV_DIRECT_IND)

    • Address_Type[i]

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Public Identity Address (corresponds to the Resolved Private Address)
  • 0x03: Random (static) Identity Address (corresponds to the 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

  • 0x01: Random Device Address

    • Direct_Address[i]

    6

    Random Device Address

    RSSI[i]

    1

    RSSI (signed integer). Units: dBm.

  • 127: RSSI not available
  • -127 ... 20

    • HCI_LE_PHY_UPDATE_COMPLETE_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.12].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • TX_PHY

    1

    Transmitter PHY in use.

  • 0x01: The transmitter PHY for the connection is LE 1M
  • 0x02: The transmitter PHY for the connection is LE 2M
  • 0x03: The transmitter PHY for the connection is LE Coded

    • RX_PHY

    1

    Receiver PHY in use.

  • 0x01: The receiver PHY for the connection is LE 1M
  • 0x02: The receiver PHY for the connection is LE 2M
  • 0x03: The receiver PHY for the connection is LE Coded

    • HCI_LE_EXTENDED_ADVERTISING_REPORT_EVENT

    Description

    This event indicates that a BLE device has responded to an active scan or has broadcast advertisements that were received during a passive scan.
    See Core Specification [Vol 4, Part E, 7.7.65.13].

    Event parameters

    ParameterSizeDescriptionPossible values

    Num_Reports

    1

    Number of responses in this event.

  • 0x01

    • Event_Type

    2

    Event type.

    Bitmask of:

  • 0x0001: Connectable advertising
  • 0x0002: Scannable advertising
  • 0x0004: Directed advertising
  • 0x0008: Scan response
  • 0x0010: Legacy advertising PDUs used
  • 0x0020: Incomplete, more data to come
  • 0x0040: Incomplete, data truncated, no more to come

    • Address_Type

    1

    Address type of the advertising device.

  • 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)
  • 0xFF: No address provided (anonymous advertisement)

    • 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.

  • 0x01: Advertiser PHY is LE 1M

    • Secondary_PHY

    1

    Secondary advertising PHY.

  • 0x00: No packets on the secondary advertising physical channel
  • 0x01: Advertiser PHY is LE 1M
  • 0x02: Advertiser PHY is LE 2M
  • 0x03: Advertiser PHY is LE Coded

    • 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.

  • 0xFF: No ADI field provided
  • 0x00 ... 0x0F: Advertising SID subfield

    • TX_Power

    1

    Tx Power (signed integer). Units: dBm.

  • 127: Tx power information not available
  • -127 ... 20: Tx power

    • RSSI

    1

    RSSI (signed integer). Units: dBm.

  • 127: RSSI not available
  • -127 ... 20

    • Periodic_Adv_Interval

    2

    Interval of the periodic advertising.

  • 0x0000: No periodic advertising

    • Direct_Address_Type

    1

    Target device 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)
  • 0xFE: Random Device Address (Controller unable to resolve)

    • 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 Core Specification [Vol 3, Part C, 11].

    HCI_LE_PERIODIC_ADVERTISING_SYNC_ESTABLISHED_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.14].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • 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.

  • 0xFF: No ADI field provided
  • 0x00 ... 0x0F: Advertising SID subfield

    • Advertiser_Address_Type

    1

    Advertiser 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)

    • 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.

  • 0x01: Advertiser PHY is LE 1M
  • 0x02: Advertiser PHY is LE 2M
  • 0x03: Advertiser PHY is LE Coded

    • Periodic_Advertising_Interval

    2

    Periodic advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Advertiser_Clock_Accuracy

    1

    Advertiser clock accuracy.

  • 0x00: 500 ppm
  • 0x01: 250 ppm
  • 0x02: 150 ppm
  • 0x03: 100 ppm
  • 0x04: 75 ppm
  • 0x05: 50 ppm
  • 0x06: 30 ppm
  • 0x07: 20 ppm

    • HCI_LE_PERIODIC_ADVERTISING_REPORT_EVENT

    Description

    This event indicates that the Controller has received a periodic advertisement.
    See Core Specification [Vol 4, Part E, 7.7.65.15].

    Event parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • TX_Power

    1

    Tx Power (signed integer). Units: dBm.

  • 127: Tx power information not available
  • -127 ... 20: Tx power

    • RSSI

    1

    RSSI (signed integer). Units: dBm.

  • 127: RSSI not available
  • -127 ... 20

    • CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots
  • 0xFF: No CTE

    • Data_Status

    1

    Data status.

  • 0x00: Data complete
  • 0x01: Data incomplete, more data to come
  • 0x02: Data incomplete, data truncated, no more to come
  • 0xFF: Failed to receive an AUX_SYNC_SUBEVENT_IND PDU

    • Data_Length

    1

    Length of Data

    Data

    Data_Length

    Octets of advertising or scan response data formatted as defined in Core Specification [Vol 3, Part C, 11].

    HCI_LE_PERIODIC_ADVERTISING_SYNC_LOST_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.16].

    Event parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • HCI_LE_SCAN_TIMEOUT_EVENT

    Description

    This event indicates that scanning has ended because the duration has expired.
    See Core Specification [Vol 4, Part E, 7.7.65.17].

    Event parameters

    None

    HCI_LE_ADVERTISING_SET_TERMINATED_EVENT

    Description

    This event indicates that the Controller has terminated advertising in the advertising sets specified by the Advertising_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.7.65.18].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Num_Completed_Ext_Adv_Events

    1

    Number of completed extended advertising events transmitted by the Controller.

  • 0x00 ... 0xFF

    • HCI_LE_SCAN_REQUEST_RECEIVED_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.19].

    Event parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Scanner_Address_Type

    1

    Scanner 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)

    • Scanner_Address

    6

    Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the scanner device.

    HCI_LE_CHANNEL_SELECTION_ALGORITHM_EVENT

    Description

    This event indicates which channel selection algorithm is used on a data physical channel connection.
    See Core Specification [Vol 4, Part E, 7.7.65.20].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Channel_Selection_Algorithm

    1

    LE Channel Selection Algorithm.

  • 0x00: Algorithm #1 is used
  • 0x01: Algorithm #2 is used

    • HCI_LE_CONNECTIONLESS_IQ_REPORT_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.21].

    Event parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • 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.

  • 0x00 ... 0x27

    • RSSI

    2

    RSSI (signed integer). Units: 0.1 dBm.

  • -1270 ... 200

    • RSSI_Antenna_ID

    1

    ID of the antenna on which the RSSI is measured.

    CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots

    • Slot_Durations

    1

    Slot Durations.

  • 0x01: Switching and sampling slots are 1 us each
  • 0x02: Switching and sampling slots are 2 us each

    • Packet_Status

    1

    Packet status.

  • 0x00: CRC was correct
  • 0x01: CRC was incorrect and the Length and CTETime fields of the packet were used to determine sampling points
  • 0x02: CRC was incorrect but the Controller has determined the position and length of the CTE in some other way
  • 0xFF: Insufficient resources to sample

    • Periodic_Event_Counter

    2

    Value of paEventCounter for the reported packet.

    Sample_Count

    1

    I_Sample[i]

    1

    Q_Sample[i]

    1

    HCI_LE_CONNECTION_IQ_REPORT_EVENT

    Description

    This event is used by the Controller to report the IQ samples from the Constant Tone Extension of a received packet.
    See Core Specification [Vol 4, Part E, 7.7.65.22].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • RX_PHY

    1

    Receiver PHY.

  • 0x01: The receiver PHY for the connection is LE 1M
  • 0x02: The receiver PHY for the connection is LE 2M

    • Data_Channel_Index

    1

    Index of the data channel on which the Data Physical Channel PDU was received.

  • 0x00 ... 0x24

    • RSSI

    2

    RSSI (signed integer). Units: 0.1 dBm.

  • -1270 ... 200

    • RSSI_Antenna_ID

    1

    ID of the antenna on which the RSSI is measured.

    CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots

    • Slot_Durations

    1

    Slot Durations.

  • 0x01: Switching and sampling slots are 1 us each
  • 0x02: Switching and sampling slots are 2 us each

    • Packet_Status

    1

    Packet status.

  • 0x00: CRC was correct
  • 0x01: CRC was incorrect and the Length and CTETime fields of the packet were used to determine sampling points
  • 0x02: CRC was incorrect but the Controller has determined the position and length of the CTE in some other way
  • 0xFF: Insufficient resources to sample

    • Connection_Event_Counter

    2

    Value of paEventCounter for the reported packet.

    Sample_Count

    1

    I_Sample[i]

    1

    Q_Sample[i]

    1

    HCI_LE_CTE_REQUEST_FAILED_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.23].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • HCI_LE_PERIODIC_ADVERTISING_SYNC_TRANSFER_RECEIVED_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.24].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Service_Data

    2

    Service data.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • 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.

  • 0xFF: No ADI field provided
  • 0x00 ... 0x0F: Advertising SID subfield

    • Advertiser_Address_Type

    1

    Advertiser 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)

    • 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.

  • 0x01: Advertiser PHY is LE 1M
  • 0x02: Advertiser PHY is LE 2M
  • 0x03: Advertiser PHY is LE Coded

    • Periodic_Advertising_Interval

    2

    Periodic advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Advertiser_Clock_Accuracy

    1

    Advertiser clock accuracy.

  • 0x00: 500 ppm
  • 0x01: 250 ppm
  • 0x02: 150 ppm
  • 0x03: 100 ppm
  • 0x04: 75 ppm
  • 0x05: 50 ppm
  • 0x06: 30 ppm
  • 0x07: 20 ppm

    • HCI_LE_CIS_ESTABLISHED_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.25].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • CIG_Sync_Delay

    3

    The maximum time, in microseconds, for transmission of PDUs of all CISes in a CIG event.

  • 0x0000EA ... 0x7FFFFF

    • CIS_Sync_Delay

    3

    The maximum time, in microseconds, for transmission of PDUs of the specified CIS in a CIG event.

  • 0x0000EA ... 0x7FFFFF

    • Transport_Latency_C_To_P

    3

    The actual transport latency, in microseconds, from Central to Peripheral.

  • 0x0000F2 ... 0x7FFFFF

    • Transport_Latency_P_To_C

    3

    The actual transport latency, in microseconds, from Peripheral to Central.

  • 0x0000F2 ... 0x7FFFFF

    • PHY_C_To_P

    1

    PHY used for transmission from the Central to the Peripheral.

  • 0x01: The transmitter PHY of packets from the Central is LE 1M
  • 0x02: The transmitter PHY of packets from the Central is LE 2M
  • 0x03: The transmitter PHY of packets from the Central is LE Coded

    • PHY_P_To_C

    1

    PHY used for transmission from the Peripheral to the Central.

  • 0x01: The transmitter PHY of packets from the Peripheral is LE 1M
  • 0x02: The transmitter PHY of packets from the Peripheral is LE 2M
  • 0x03: The transmitter PHY of packets from the Peripheral is LE Coded

    • NSE

    1

    Number of subevents in each interval of each BIS in the BIG.

  • 1 ... 31

    • BN_C_To_P

    1

    Burst number for Central to Peripheral.

  • 0x00: No isochronous data from the Central to the Peripheral
  • 0x01 ... 0x0F

    • BN_P_To_C

    1

    Burst number for Peripheral to Central.

  • 0x00: No isochronous data from the Peripheral to the Central
  • 0x01 ... 0x0F

    • FT_C_To_P

    1

    Flush timeout in multiples of ISO_Interval for each payload sent from the Central to Peripheral.

  • 0x01 ... 0xFF

    • FT_P_To_C

    1

    Flush timeout in multiples of ISO_Interval for each payload sent from the Peripheral to Central.

  • 0x01 ... 0xFF

    • Max_PDU_C_To_P

    2

    Maximum size, in octets, of the payload from the Central to the Peripheral.

  • 0 ... 251

    • Max_PDU_P_To_C

    2

    Maximum size, in octets, of the payload from the Peripheral to the Central.

  • 0 ... 251

    • ISO_Interval

    2

    Time between consecutive BIG anchor points. Time = N * 1.25 ms.

  • 0x0004 (5.00 ms) ... 0x0C80 (4000.00 ms)

    • HCI_LE_CIS_REQUEST_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.26].

    Event parameters

    ParameterSizeDescriptionPossible values

    ACL_Connection_Handle

    2

    Connection handle of an ACL connection.

  • 0x0000 ... 0x0EFF

    • CIS_Connection_Handle

    2

    Connection handle of a CIS.

  • 0x0000 ... 0x0EFF

    • CIG_ID

    1

    CIG identifier.

  • 0x00 ... 0xEF

    • CIS_ID

    1

    CIS identifier.

  • 0x00 ... 0xEF

    • HCI_LE_CREATE_BIG_COMPLETE_EVENT

    Description

    This event indicates that the HCI_LE_Create_BIG command has completed.
    See Core Specification [Vol 4, Part E, 7.7.65.27].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • BIG_Sync_Delay

    3

    Maximum time in microseconds for transmission of PDUs of all BISes in a BIG event.

  • 0x0000EA ... 0x7FFFFF

    • Transport_Latency_BIG

    3

    Transport latency, in microseconds.

  • 0x0000EA ... 0x7FFFFF

    • PHY

    1

    PHY used to create the BIG.

  • 0x01: The PHY used to create the BIG is LE 1M
  • 0x02: The PHY used to create the BIG is LE 2M
  • 0x03: The PHY used to create the BIG is LE Coded

    • NSE

    1

    Number of subevents in each interval of each BIS in the BIG.

  • 1 ... 31

    • BN

    1

    Number of new payloads in each interval for each BIS.

  • 0x01 ... 0x07

    • PTO

    1

    Offset used for pre-transmissions.

  • 0x00 ... 0x0F

    • IRC

    1

    Number of times the scheduled payloads are transmitted in a given event.

  • 1 ... 15

    • Max_PDU

    2

    Maximum size, in octets, of payload.

  • 1 ... 251

    • ISO_Interval

    2

    Time between consecutive BIG anchor points. Time = N * 1.25 ms.

  • 0x0004 (5.00 ms) ... 0x0C80 (4000.00 ms)

    • Num_BIS

    1

    Total number of BISes in the BIG.

  • 1 ... 31

    • Connection_Handle[i]

    2

    HCI_LE_TERMINATE_BIG_COMPLETE_EVENT

    Description

    This event indicates that the transmission of all the BISes in the BIG are terminated.
    See Core Specification [Vol 4, Part E, 7.7.65.28].

    Event parameters

    ParameterSizeDescriptionPossible values

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Reason

    1

    See "Status error codes" section.

    HCI_LE_BIG_SYNC_ESTABLISHED_EVENT

    Description

    This event indicates that the HCI_LE_BIG_Create_Sync command has completed.
    See Core Specification [Vol 4, Part E, 7.7.65.29].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Transport_Latency_BIG

    3

    Transport latency, in microseconds.

  • 0x0000EA ... 0x7FFFFF

    • NSE

    1

    Number of subevents in each interval of each BIS in the BIG.

  • 1 ... 31

    • BN

    1

    Number of new payloads in each interval for each BIS.

  • 0x01 ... 0x07

    • PTO

    1

    Offset used for pre-transmissions.

  • 0x00 ... 0x0F

    • IRC

    1

    Number of times the scheduled payloads are transmitted in a given event.

  • 1 ... 15

    • Max_PDU

    2

    Maximum size, in octets, of payload.

  • 1 ... 251

    • ISO_Interval

    2

    Time between consecutive BIG anchor points. Time = N * 1.25 ms.

  • 0x0004 (5.00 ms) ... 0x0C80 (4000.00 ms)

    • Num_BIS

    1

    Total number of BISes in the BIG.

  • 1 ... 31

    • Connection_Handle[i]

    2

    HCI_LE_BIG_SYNC_LOST_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.30].

    Event parameters

    ParameterSizeDescriptionPossible values

    BIG_Handle

    1

    BIG identifier.

  • 0x00 ... 0xEF

    • Reason

    1

    See "Status error codes" section.

    HCI_LE_REQUEST_PEER_SCA_COMPLETE_EVENT

    Description

    This event indicates that the HCI_LE_Request_Peer_SCA command has been completed.
    See Core Specification [Vol 4, Part E, 7.7.65.31].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Peer_Clock_Accuracy

    1

    Sleep clock accuracy of the peer.

  • 0x00: 251 ppm to 500 ppm
  • 0x01: 151 ppm to 250 ppm
  • 0x02: 101 ppm to 150 ppm
  • 0x03: 76 ppm to 100 ppm
  • 0x04: 51 ppm to 75 ppm
  • 0x05: 31 ppm to 50 ppm
  • 0x06: 21 ppm to 30 ppm
  • 0x07: 0 ppm to 20 ppm

    • HCI_LE_PATH_LOSS_THRESHOLD_EVENT

    Description

    This event is used to report a path loss threshold crossing on the ACL connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.7.65.32].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Current_Path_Loss

    1

    Current path loss (always zero or positive). Units: dB.

  • 255: Unavailable
  • 0 ... 254

    • Zone_Entered

    1

    Entered zone (shall be ignored if Current_Path_Loss is set to 0xFF).

  • 0x00: Entered low zone
  • 0x01: Entered middle zone
  • 0x02: Entered high zone

    • HCI_LE_TRANSMIT_POWER_REPORTING_EVENT

    Description

    This event is used to report the transmit power level on the ACL connection identified by the Connection_Handle parameter.
    See Core Specification [Vol 4, Part E, 7.7.65.33].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Reason

    1

    Event reason.

  • 0x00: Local transmit power changed
  • 0x01: Remote transmit power changed
  • 0x02: HCI_LE_Read_Remote_Transmit_Power_Level command completed

    • PHY

    1

    Applying PHY.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE Coded PHY with S=8 data coding
  • 0x04: LE Coded PHY with S=2 data coding

    • TX_Power_Level

    1

    Transmit power level (signed integer). Units: dBm.

  • 126: Remote device is not managing power levels on this PHY.
  • 127: Transmit power level is not available
  • -127 ... 20

    • 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.

  • 0x00: Transmit power level is at minimum level
  • 0x01: Transmit power level is at maximum level

    • Delta

    1

    Change in transmit power level (signed integer - positive indicates increased power, negative indicates decreased power, zero indicates unchanged). Units: dB.

  • 127: Change is not available or is out of range
  • -127 ... 126

    • HCI_LE_BIGINFO_ADVERTISING_REPORT_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.34].

    Event parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Num_BIS

    1

    Total number of BISes in the BIG.

  • 1 ... 31

    • NSE

    1

    Number of subevents in each interval of each BIS in the BIG.

  • 1 ... 31

    • ISO_Interval

    2

    Time between consecutive BIG anchor points. Time = N * 1.25 ms.

  • 0x0004 (5.00 ms) ... 0x0C80 (4000.00 ms)

    • BN

    1

    Number of new payloads in each interval for each BIS.

  • 0x01 ... 0x07

    • PTO

    1

    Offset used for pre-transmissions.

  • 0x00 ... 0x0F

    • IRC

    1

    Number of times the scheduled payloads are transmitted in a given event.

  • 1 ... 15

    • Max_PDU

    2

    Maximum size, in octets, of payload.

  • 1 ... 251

    • SDU_Interval

    3

    Interval, in microseconds, of periodic SDUs.

  • 0x0000FF ... 0x0FFFFF

    • Max_SDU

    2

    Maximum size of an SDU in octets.

  • 1 ... 4095

    • PHY

    1

    PHY of the Advertising PDU.

  • 0x01: The BIG is transmitted on the LE 1M PHY
  • 0x02: The BIG is transmitted on the LE 2M PHY
  • 0x03: The BIG is transmitted on the LE Coded PHY

    • Framing

    1

    Format of the CIS Data PDUs.

  • 0x00: Unframed
  • 0x01: Framed

    • Encryption

    1

    Encryption mode of the BISes.

  • 0x00: Unencrypted
  • 0x01: Encrypted

    • HCI_LE_SUBRATE_CHANGE_EVENT

    Description

    This event is used to indicate that a Connection Subrate Update procedure has completed and some parameters of the specified connection have changed.
    See Core Specification [Vol 4, Part E, 7.7.65.35].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Subrate_Factor

    2

    New subrate factor applied to the specified underlying connection interval Range.

  • 0x0001 ... 0x01F4

    • Peripheral_Latency

    2

    New Peripheral latency for the connection in number of subrated connection events.

  • 0x0000 ... 0x01F3

    • Continuation_Number

    2

    Minimum number of underlying connection events to remain active after a packet containing a Link Layer PDU with a non-zero Length field is sent or received in requests by a Peripheral.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • HCI_LE_PERIODIC_ADVERTISING_SYNC_ESTABLISHED_V2_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.14].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • 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.

  • 0xFF: No ADI field provided
  • 0x00 ... 0x0F: Advertising SID subfield

    • Advertiser_Address_Type

    1

    Advertiser 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)

    • 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.

  • 0x01: Advertiser PHY is LE 1M
  • 0x02: Advertiser PHY is LE 2M
  • 0x03: Advertiser PHY is LE Coded

    • Periodic_Advertising_Interval

    2

    Periodic advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Advertiser_Clock_Accuracy

    1

    Advertiser clock accuracy.

  • 0x00: 500 ppm
  • 0x01: 250 ppm
  • 0x02: 150 ppm
  • 0x03: 100 ppm
  • 0x04: 75 ppm
  • 0x05: 50 ppm
  • 0x06: 30 ppm
  • 0x07: 20 ppm

    • Num_Subevents

    1

    Number of subevents.

  • 0x00 ... 0x80

    • Subevent_Interval

    1

    Interval between subevents. Time = N * 1.25 ms.

  • 0x00 (0.00 ms) : No subevents
  • 0x06 (7.50 ms) ... 0xFF (318.75 ms)

    • Response_Slot_Delay

    1

    Time between the advertising packet in a subevent and the first response slot. Time = N * 1.25 ms.

  • 0x00 (0.00 ms) : No response slots
  • 0x01 (1.25 ms) ... 0xFE (317.50 ms)

    • Response_Slot_Spacing

    1

    Time between response slots. Time = N * 0.125 ms.

  • 0x00 (0.000 ms) : No response slots
  • 0x02 (0.250 ms) ... 0xFF (31.875 ms)

    • HCI_LE_PERIODIC_ADVERTISING_REPORT_V2_EVENT

    Description

    This event indicates that the Controller has received a periodic advertisement or has failed to receive an AUX_SYNC_SUBEVENT_IND PDU. The Sync_Handle parameter identifies the periodic advertising train that the report relates to.
    See Core Specification [Vol 4, Part E, 7.7.65.15].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • Tx_Power

    1

    Tx Power (signed integer). Units: dBm.

  • 127: Tx power information not available
  • -127 ... 20: Tx power

    • RSSI

    1

    RSSI (signed integer). Units: dBm.

  • 127: RSSI not available
  • -127 ... 20

    • CTE_Type

    1

    Constant Tone Extension type.

  • 0x00: AoA CTE
  • 0x01: AoD CTE with 1 us slots
  • 0x02: AoD CTE with 2 us slots
  • 0xFF: No CTE

    • Periodic_Event_Counter

    2

    Value of paEventCounter for the reported packet.

    Subevent

    1

    The subevent number.

  • 0xFF: No subevents
  • 0x00 ... 0x7F

    • Data_Status

    1

    Data status.

  • 0x00: Data complete
  • 0x01: Data incomplete, more data to come
  • 0x02: Data incomplete, data truncated, no more to come
  • 0xFF: Failed to receive an AUX_SYNC_SUBEVENT_IND PDU

    • Data_Length

    1

    Length of Data

    Data

    Data_Length

    Octets of advertising or scan response data formatted as defined in Core Specification [Vol 3, Part C, 11].

    HCI_LE_PERIODIC_ADVERTISING_SYNC_TRANSFER_RECEIVED_V2_EVENT

    Description

    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 Core Specification [Vol 4, Part E, 7.7.65.24].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • Service_Data

    2

    Service data.

    Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0x0000 ... 0x0EFF

    • 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.

  • 0xFF: No ADI field provided
  • 0x00 ... 0x0F: Advertising SID subfield

    • Advertiser_Address_Type

    1

    Advertiser 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)

    • 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.

  • 0x01: Advertiser PHY is LE 1M
  • 0x02: Advertiser PHY is LE 2M
  • 0x03: Advertiser PHY is LE Coded

    • Periodic_Advertising_Interval

    2

    Periodic advertising interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0xFFFF (81918.75 ms)

    • Advertiser_Clock_Accuracy

    1

    Advertiser clock accuracy.

  • 0x00: 500 ppm
  • 0x01: 250 ppm
  • 0x02: 150 ppm
  • 0x03: 100 ppm
  • 0x04: 75 ppm
  • 0x05: 50 ppm
  • 0x06: 30 ppm
  • 0x07: 20 ppm

    • Num_Subevents

    1

    Number of subevents.

  • 0x00 ... 0x80

    • Subevent_Interval

    1

    Interval between subevents. Time = N * 1.25 ms.

  • 0x06 (7.50 ms) ... 0xFF (318.75 ms)

    • Response_Slot_Delay

    1

    Response slot delay. Time = N * 1.25 ms.

  • 0x01 (1.25 ms) ... 0xFE (317.50 ms)

    • Response_Slot_Spacing

    1

    Response slot spacing. Time = N * 0.125 ms.

  • 0x02 (0.250 ms) ... 0xFF (31.875 ms)

    • HCI_LE_PERIODIC_ADVERTISING_SUBEVENT_DATA_REQUEST_EVENT

    Description

    This event is used to allow the Controller to indicate that it is ready to transmit one or more subevents and is requesting the advertising data for these subevents. The Subevent_Data_Count parameter shall be less than or equal to the number of subevents. The Subevent_Start parameter is the first subevent being requested and the Subevent_Data_Count parameter determines the subsequent subevents being requested. The subevent numbers wrap from one less than the number of subevents to zero.
    See Core Specification [Vol 4, Part E, 7.7.65.36].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Subevent_Start

    1

    The first subevent that data is requested for.

  • 0x00 ... 0x7F

    • Subevent_Data_Count

    1

    The number of subevents that data is requested for.

  • 0x01 ... 0x80

    • HCI_LE_PERIODIC_ADVERTISING_RESPONSE_REPORT_EVENT

    Description

    This event indicates that one or more BLE devices have responded to a periodic advertising subevent during a PAwR train. The Controller may queue these advertising reports and send information from multiple devices in one HCI_LE_Periodic_Advertising_Response_Report event.
    See Core Specification [Vol 4, Part E, 7.7.65.37].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Advertising_Handle

    1

    Used to identify an advertising set.

  • 0x00 ... 0xEF

    • Subevent

    1

    Subevent number.

  • 0x00 ... 0x7F

    • Tx_Status

    1

    The TX status.

  • 0x00: AUX_SYNC_SUBEVENT_IND packet was transmitted.
  • 0x01: AUX_SYNC_SUBEVENT_IND packet was not transmitted.

    • Num_Responses

    1

    Number of responses in event.

  • 0x00 ... 0x19

    • Responses

    250

    Must be composed of the following fields: Tx_Power (1 byte), RSSI (1 byte), CTE_Type (1 byte), Response_Slot (1 byte), Data_Status (1 byte), Data_Length (1 byte), Data ('Data_Length' bytes). All fields are repeated 'Num_Responses' times. Note: the indicated size is the maximum size.

    HCI_LE_ENHANCED_CONNECTION_COMPLETE_V2_EVENT

    Description

    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 creation fails, this event shall be provided to the Host that had issued the HCI_LE_Create_Connection or HCI_LE_Extended_Create_Connection command.
    See Core Specification [Vol 4, Part E, 7.7.65.10].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Role

    1

    Role of the local device in the connection.

  • 0x00: Central
  • 0x01: Peripheral

    • Peer_Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Public Identity Address (corresponds to the Resolved Private Address)
  • 0x03: Random (static) Identity Address (corresponds to the 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.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Conn_Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • 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.

  • 0x000A (100 ms) ... 0x0C80 (32000 ms)

    • Central_Clock_Accuracy

    1

    Central clock accuracy. Only valid for a Peripheral.

  • 0x00: 500 ppm
  • 0x01: 250 ppm
  • 0x02: 150 ppm
  • 0x03: 100 ppm
  • 0x04: 75 ppm
  • 0x05: 50 ppm
  • 0x06: 30 ppm
  • 0x07: 20 ppm

    • Advertising_Handle

    1

    Used to identify an advertising set.

  • 0xFF: No Advertising Handle
  • 0x00 ... 0xEF

    • Sync_Handle

    2

    Handle identifying the periodic advertising train.

  • 0xFFFF: No Sync Handle
  • 0x0000 ... 0x0EFF

    • HCI_LE_CIS_ESTABLISHED_V2_EVENT

    Description

    This event indicates that a CIS has been established, was considered lost before being established, or - on the Central - was rejected by the Peripheral.
    See Core Specification [Vol 4, Part E, 7.7.65.25].

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the command applies.

  • 0x0000 ... 0x0EFF

    • CIG_Sync_Delay

    3

    The maximum time, in microseconds, for transmission of PDUs of all CISes in a CIG event.

  • 0x0000EA ... 0x7FFFFF

    • CIS_Sync_Delay

    3

    The maximum time, in microseconds, for transmission of PDUs of the specified CIS in a CIG event.

  • 0x0000EA ... 0x7FFFFF

    • Transport_Latency_C_To_P

    3

    The actual transport latency, in microseconds, from Central to Peripheral.

  • 0x0000F2 ... 0x7FFFFF

    • Transport_Latency_P_To_C

    3

    The actual transport latency, in microseconds, from Peripheral to Central.

  • 0x0000F2 ... 0x7FFFFF

    • PHY_C_To_P

    1

    PHY used for transmission from the Central to the Peripheral.

  • 0x01: The transmitter PHY of packets from the Central is LE 1M
  • 0x02: The transmitter PHY of packets from the Central is LE 2M
  • 0x03: The transmitter PHY of packets from the Central is LE Coded

    • PHY_P_To_C

    1

    PHY used for transmission from the Peripheral to the Central.

  • 0x01: The transmitter PHY of packets from the Peripheral is LE 1M
  • 0x02: The transmitter PHY of packets from the Peripheral is LE 2M
  • 0x03: The transmitter PHY of packets from the Peripheral is LE Coded

    • NSE

    1

    Number of subevents in each interval of each BIS in the BIG.

  • 1 ... 31

    • BN_C_To_P

    1

    Burst number for Central to Peripheral.

  • 0x00: No isochronous data from the Central to the Peripheral
  • 0x01 ... 0x0F

    • BN_P_To_C

    1

    Burst number for Peripheral to Central.

  • 0x00: No isochronous data from the Peripheral to the Central
  • 0x01 ... 0x0F

    • FT_C_To_P

    1

    Flush timeout in multiples of ISO_Interval for each payload sent from the Central to Peripheral.

  • 0x01 ... 0xFF

    • FT_P_To_C

    1

    Flush timeout in multiples of ISO_Interval for each payload sent from the Peripheral to Central.

  • 0x01 ... 0xFF

    • Max_PDU_C_To_P

    2

    Maximum size, in octets, of the payload from the Central to the Peripheral.

  • 0 ... 251

    • Max_PDU_P_To_C

    2

    Maximum size, in octets, of the payload from the Peripheral to the Central.

  • 0 ... 251

    • ISO_Interval

    2

    Time between consecutive BIG anchor points. Time = N * 1.25 ms.

  • 0x0004 (5.00 ms) ... 0x0C80 (4000.00 ms)

    • Sub_Interval

    3

    Time, in microseconds, between the start of consecutive subevents in a CIS event.

  • 0x000000: NSE = 1 (meaning there is no Sub_Interval)
  • 0x000190 ... 0xFFFFFF: (note that range is limited by ISO_Interval multiplied by 1250)

    • Max_SDU_C_To_P

    2

    Maximum size, in octets, of the payload from the Central's Host.

  • 0 ... 310

    • Max_SDU_P_To_C

    2

    Maximum size, in octets, of the payload from the Peripheral's Host.

  • 0 ... 310

    • SDU_Interval_C_To_P

    3

    Time, in microseconds, between the start of consecutive SDUs sent by the Central.

  • 0x0000FF ... 0x0FFFFF

    • SDU_Interval_P_To_C

    3

    Time, in microseconds, between the start of consecutive SDUs sent by the Peripheral.

  • 0x0000FF ... 0x0FFFFF

    • Framing

    1

    Format of the CIS Data PDUs.

  • 0x00: Unframed
  • 0x01: Framed

    • HCI_LE_READ_ALL_REMOTE_FEATURES_COMPLETE_EVENT

    Description

    This event is used to indicate the completion of the process of the Controller obtaining the features supported by the remote BLE device specified by the Connection_Handle event parameter.
    See Core Specification [Vol 4, Part E, 7.7.65.38].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Max_Remote_Page

    1

    The number of the highest-numbered page of the remote device's supported LE features that contains at least one bit set to 1.

  • 0x01 ... 0x0A

    • Max_Valid_Page

    1

    The number of the highest-numbered page of LE_Features that contains valid data.

  • 0x01 ... 0x0A

    • LE_Features

    248

    Bit Mask List of the supported LE features. See Core Specification [Vol 6, Part B, 4.6].

    HCI_LE_CS_READ_REMOTE_SUPPORTED_CAPABILITIES_COMPLETE_EVENT

    Description

    This event is generated when a locally initiated CS Capabilities Exchange procedure has completed or when the local Controller has received an LL_CS_CAPABILITIES_REQ from the remote Controller.
    See Core Specification [Vol 4, Part E, 7.7.65.39].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Num_Config_Supported

    1

    Number of CS configurations supported per connection.

  • 0x01 ... 0x04

    • Max_Consecutive_Procedures_Supported

    2

    Maximum number of consecutive CS procedures supported.

  • 0x0000: Support for both a fixed number of consecutive CS procedures and for an indefinite number of CS procedures until termination
  • 0x0001 ... 0xFFFF

    • Num_Antennas_Supported

    1

    Number of antennas supported.

  • 0x01 ... 0x04

    • Max_Antenna_Paths_Supported

    1

    Maximum number of antenna paths supported.

  • 0x01 ... 0x04

    • Roles_Supported

    1

    Indicates the CS roles that are supported by the remote Controller.

    Bitmask of:

  • 0x01: Initiator
  • 0x02: Reflector

    • Optional_Modes_Supported

    1

    Indicates the optional CS modes that are supported by the remote Controller.

    Bitmask of:

  • 0x01: Mode-3

    • RTT_Capability

    1

    Indicates (with following parameters) the time-of-flight accuracy.

    Bitmask of:

  • 0x01: If set to 1, then the value reflected in the RTT_AA_Only_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_AA_Only_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_AA_Only_N field is set to 0, then the bit shall be ignored.
  • 0x02: If set to 1, then the value reflected in the RTT_Sounding_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_Sounding_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_Sounding_N field is set to 0, then the bit shall be ignored.
  • 0x04: If set to 1, then the value reflected in the RTT_Random_Payload_N field refers to the 10 ns time-of-flight precision requirement. Otherwise, the RTT_Random_Payload_N field refers to the 150 ns time-of-flight precision requirement. If the RTT_Random_Payload_N field is set to 0, then the bit shall be ignored.

    • RTT_AA_Only_N

    1

    Number of CS_SYNC exchanges needed to satisfy the precision requirements.

  • 0x00: RTT AA-only not supported
  • 0x01 ... 0xFF

    • RTT_Sounding_N

    1

    Number of CS_SYNC exchanges needed to satisfy the precision requirements.

  • 0x00: RTT Sounding not supported
  • 0x01 ... 0xFF

    • RTT_Random_Payload_N

    1

    Number of CS_SYNC exchanges needed to satisfy the time-of-flight precision requirements.

  • 0x00: RTT Random Payload not supported
  • 0x01 ... 0xFF

    • NADM_Sounding_Capability

    2

    Indicates (with next parameter) the support by the remote Controller for reporting Normalized Attack Detector Metric (NADM) when a CS_SYNC with a sounding sequence or random sequence is received.

    Bitmask of:

  • 0x0001: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with sounding sequence is received

    • NADM_Random_Capability

    2

    Indicates (with previous parameter) the support by the remote Controller for reporting Normalized Attack Detector Metric (NADM) when a CS_SYNC with a sounding sequence or random sequence is received.

    Bitmask of:

  • 0x0001: Support for Phase-based Normalized Attack Detector Metric when a CS_SYNC with random sequence is received

    • CS_SYNC_PHYs_Supported

    1

    Indicates the optional transmit and receive PHYs that are supported by the remote Controller for CS_SYNC exchanges.

    Bitmask of:

  • 0x02: LE 2M PHY
  • 0x04: LE 2M 2BT PHY

    • Subfeatures_Supported

    2

    Indicates which optional subfeatures are supported by the remote Controller.

    Bitmask of:

  • 0x0002: CS with a Frequency Actuation Error of zero relative to mode-0 transmissions in the reflector role
  • 0x0004: CS Channel Selection Algorithm #3c

    • T_IP1_Times_Supported

    2

    Indicates the supported time durations for T_IP1.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported

    • T_IP2_Times_Supported

    2

    Indicates the supported time durations for T_IP2.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported

    • T_FCS_Times_Supported

    2

    Indicates the supported time durations for T_FCS.

    Bitmask of:

  • 0x0001: 15 us supported
  • 0x0002: 20 us supported
  • 0x0004: 30 us supported
  • 0x0008: 40 us supported
  • 0x0010: 50 us supported
  • 0x0020: 60 us supported
  • 0x0040: 80 us supported
  • 0x0080: 100 us supported
  • 0x0100: 120 us supported

    • T_PM_Times_Supported

    2

    Indicates the supported time durations for T_PM.

    Bitmask of:

  • 0x0001: 10 us supported
  • 0x0002: 20 us supported

    • T_SW_Time_Supported

    1

    Time in microseconds for the antenna switch period of the CS tones.

  • 0x00
  • 0x01
  • 0x02
  • 0x04
  • 0x0A

    • TX_SNR_Capability

    1

    Indicates the supported SNR levels used in RTT packets.

    Bitmask of:

  • 0x01: 18 dB supported
  • 0x02: 21 dB supported
  • 0x04: 24 dB supported
  • 0x08: 27 dB supported
  • 0x10: 30 dB supported

    • HCI_LE_CS_READ_REMOTE_FAE_TABLE_COMPLETE_EVENT

    Description

    This event is generated when a locally initiated CS Mode 0 Frequency Actuation Error Table Update procedure has completed.
    See Core Specification [Vol 4, Part E, 7.7.65.40].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Remote_FAE_Table

    72

    Per-channel mode-0 Frequency Actuation Error table of the remote Controller as described in Core Specification [Vol 6, Part B, 2.4.2.53].

    HCI_LE_CS_SECURITY_ENABLE_COMPLETE_EVENT

    Description

    This event is generated when a locally initiated CS Security Start procedure has completed or when the local Controller has responded to a CS security request from the remote Controller.
    See Core Specification [Vol 4, Part E, 7.7.65.41].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • HCI_LE_CS_CONFIG_COMPLETE_EVENT

    Description

    This event is generated when a locally initiated Channel Sounding Configuration procedure has completed or when the local Controller has responded to a CS configuration request from the remote Controller for the CS configuration identified by Config_ID or when a CS configuration is created only with local context. The Action parameter indicates if a CS configuration was requested to be created or removed. The Status parameter indicates whether the request indicated by the Action parameter was successful.
    See Core Specification [Vol 4, Part E, 7.7.65.42].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • Action

    1

    Indicates if the CS configuration was requested to be created or removed.

  • 0x00: CS configuration is removed
  • 0x01: CS configuration is created

    • Main_Mode_Type

    1

    Indicates the CS mode to be used.

  • 0x01: Mode-1
  • 0x02: Mode-2
  • 0x03: Mode-3

    • Sub_Mode_Type

    1

    Indicates the CS sub-mode to be used.

  • 0x01: Mode-1
  • 0x02: Mode-2
  • 0x03: Mode-3
  • 0xFF: Unused

    • Min_Main_Mode_Steps

    1

    Minimum number of CS main mode steps to be executed before a submode step is executed.

  • 0x02 ... 0xFF

    • Max_Main_Mode_Steps

    1

    Maximum number of CS main mode steps to be executed before a submode step is executed.

  • 0x02 ... 0xFF

    • Main_Mode_Repetition

    1

    The number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event.

  • 0 ... 3

    • Mode_0_Steps

    1

    Number of CS mode-0 steps to be included at the beginning of each CS subevent.

  • 1 ... 3

    • Role

    1

    Indicates the CS role for the local Controller.

  • 0x00: Initiator
  • 0x01: Reflector

    • RTT_Type

    1

    Indicates the RTT variant to be used during the CS procedure.

  • 0x00: RTT AA-only
  • 0x01: RTT with 32-bit sounding sequence
  • 0x02: RTT with 96-bit sounding sequence
  • 0x03: RTT with 32-bit random sequence
  • 0x04: RTT with 64-bit random sequence
  • 0x05: RTT with 96-bit random sequence
  • 0x06: RTT with 128-bit random sequence

    • CS_SYNC_PHY

    1

    Indicates the PHY to be used for CS_SYNC exchanges during the CS procedure.

  • 0x01: LE 1M PHY
  • 0x02: LE 2M PHY
  • 0x03: LE 2M 2BT PHY

    • Channel_Map

    10

    This parameter contains 80 1-bit fields. The nth such field (in the range 0 to 78) contains the value for the CS channel index n. Channel n is enabled for CS procedure = 1 Channel n is disabled for CS procedure = 0 Channels n = 0, 1, 23, 24, 25, 77, and 78 shall be ignored and shall be set to zero. At least 15 channels shall be enabled. The most significant bit (bit 79) is reserved for future use.

    Channel_Map_Repetition

    1

    The number of times the map represented by the Channel_Map field is to be cycled through for non-mode-0 steps within a CS procedure.

  • 0x01 ... 0xFF

    • Channel_Selection_Type

    1

    Indicates the Channel Selection Algorithm to be used during the CS procedure for non-mode-0 steps.

  • 0x00: Use Channel Selection Algorithm #3b for non-mode-0 CS steps
  • 0x01: Use Channel Selection Algorithm #3c for non-mode-0 CS steps

    • Ch3c_Shape

    1

    Indicates the shape to be used for user-specified channel sequence.

  • 0x00: Use Hat shape
  • 0x01: Use X shape

    • Ch3c_Jump

    1

    Number of channels skipped in each rising and falling sequence.

  • 0x02 ... 0x08

    • Reserved

    1

    Reserved, shall be set to 0.

  • 0x00

    • T_IP1_Time

    1

    Interlude time in microseconds between the RTT packets.

  • 10
  • 20
  • 30
  • 40
  • 50
  • 60
  • 80
  • 145

    • T_IP2_Time

    1

    Interlude time in microseconds between the CS tones.

  • 10
  • 20
  • 30
  • 40
  • 50
  • 60
  • 80
  • 145

    • T_FCS_Time

    1

    Time in microseconds for frequency changes.

  • 15
  • 20
  • 30
  • 40
  • 50
  • 60
  • 80
  • 100
  • 120
  • 150

    • T_PM_Time

    1

    Time in microseconds for the phase measurement period of the CS tones.

  • 10
  • 20
  • 40

    • HCI_LE_CS_PROCEDURE_ENABLE_COMPLETE_EVENT

    Description

    This event is generated when the local or remote Controller has scheduled a new CS procedure measurement or disabled an ongoing CS procedure measurement as a result of an HCI_LE_CS_Procedure_Enable command. When a new CS procedure measurement is enabled, the HCI_LE_CS_Procedure_Enable_Complete event shall be sent to the Host after the LL_CS_IND is transmitted or received and before any CS subevent results are available.
    See Core Specification [Vol 4, Part E, 7.7.65.43].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • State

    1

    State of CS procedures.

  • 0x00: CS procedures are disabled
  • 0x01: CS procedures are enabled

    • Tone_Antenna_Config_Selection

    1

    Antenna Configuration Index.

  • 0 ... 7

    • Selected_TX_Power

    1

    Transmit power level used for CS procedure (signed integer). Units: dBm.

  • 127: Transmit power level is unavailable
  • -127 ... 20

    • Subevent_Len

    3

    Duration for each CS subevent in microseconds.

  • 1250 ... 4000000

    • Subevents_Per_Event

    1

    Number of CS subevents anchored off the same ACL connection event.

  • 1 ... 32

    • Subevent_Interval

    2

    Time between consecutive CS subevents anchored off the same ACL connection event. Time = N * 0.625 ms.

  • 0x0000 (0.000 ms) ... 0xFFFF (40959.375 ms)

    • Event_Interval

    2

    Number of ACL connection events between consecutive CS event anchor points.

  • 0x0000 ... 0xFFFF

    • Procedure_Interval

    2

    Number of ACL connection events between consecutive CS procedure anchor points.

  • 0x0000 ... 0xFFFF

    • Procedure_Count

    2

    Number of CS procedures to be scheduled.

  • 0x0000: CS procedures to continue until disabled
  • 0x0001 ... 0xFFFF

    • Max_Procedure_Len

    2

    Maximum duration for each CS procedure. Time = N * 0.625 ms.

  • 0x0001 (0.625 ms) ... 0xFFFF (40959.375 ms)

    • HCI_LE_CS_SUBEVENT_RESULT_EVENT

    Description

    This event is generated when the local Controller has results to report for a CS subevent during the CS procedure. Depending on the number of CS steps in the CS subevent, the Controller may choose to report complete or partial results. When the number of CS steps exceeds the maximum HCI event size, the Controller may report further results for the CS subevent using the HCI_LE_CS_Subevent_Result_Continue event.
    See Core Specification [Vol 4, Part E, 7.7.65.44].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • Start_ACL_Conn_Event_Counter

    2

    Starting ACL connection event counter for the results reported in the event.

    Procedure_Counter

    2

    CS procedure count since completion of the Channel Sounding Security Start procedure.

    Frequency_Compensation

    2

    Frequency compensation value in units of 0.01 ppm (15-bit signed integer).

  • 0xC000: Frequency compensation value is not available, or the role is not initiator
  • 0x2710 ... 0x58F0

    • Reference_Power_Level

    1

    Reference power level (signed integer). Units: dBm.

  • 127: Reference power level is not applicable
  • -127 ... 20

    • Procedure_Done_Status

    1

    CS procedure status.

    Bitmask of:

  • 0x00: All results complete for the CS procedure
  • 0x01: Partial results with more to follow for the CS procedure
  • 0x0F: All subsequent CS procedures aborted

    • Subevent_Done_Status

    1

    CS subevent status.

    Bitmask of:

  • 0x00: All results complete for the CS subevent
  • 0x01: Partial results with more to follow for the CS subevent
  • 0x0F: Current CS subevent aborted

    • Abort_Reason

    1

    Indicates the abort reason when abort has occured.

    Bitmask of:

  • 0x00: Report with no abort
  • 0x01: All subsequent CS procedures aborted: Abort because of local Host or remote request
  • 0x02: All subsequent CS procedures aborted: Abort because filtered channel map has less than 15 channels
  • 0x03: All subsequent CS procedures aborted: Abort because the channel map update instant has passed
  • 0x0F: All subsequent CS procedures aborted: Abort because of unspecified reasons
  • 0x10: Current CS subevent aborted: Abort because of local Host or remote request
  • 0x20: Current CS subevent aborted: Abort because no CS_SYNC (mode-0) received
  • 0x30: Current CS subevent aborted: Abort because of scheduling conflicts or limited resources
  • 0xF0: Current CS subevent aborted: Abort because of unspecified reasons

    • Num_Antenna_Paths

    1

    Number of antenna paths used during the phase measurement stage of the CS step

  • 0: Ignored because phase measurement does not occur during the CS step
  • 1 ... 4

    • Num_Steps_Reported

    1

    Number of steps in the CS subevent for which results are reported

  • 0x00 ... 0xA0

    • Step_Param

    239

    Must be composed of the following fields: Step_Mode (1 byte), Step_Channel (1 byte), Step_Data_Length (1 byte), Step_Data ('Step_Data_Length' bytes). All fields are repeated 'Num_Steps_Reported' times. Note: the indicated size is the maximum size.

    HCI_LE_CS_SUBEVENT_RESULT_CONTINUE_EVENT

    Description

    This event is generated after the local Controller has completed a new CS subevent measurement and has already sent an HCI_LE_CS_Subevent_Result event for the specified CS subevent.
    See Core Specification [Vol 4, Part E, 7.7.65.45].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Config_ID

    1

    CS configuration identifier.

  • 0x00 ... 0x03

    • Procedure_Done_Status

    1

    CS procedure status.

    Bitmask of:

  • 0x00: All results complete for the CS procedure
  • 0x01: Partial results with more to follow for the CS procedure
  • 0x0F: All subsequent CS procedures aborted

    • Subevent_Done_Status

    1

    CS subevent status.

    Bitmask of:

  • 0x00: All results complete for the CS subevent
  • 0x01: Partial results with more to follow for the CS subevent
  • 0x0F: Current CS subevent aborted

    • Abort_Reason

    1

    Indicates the abort reason when abort has occured.

    Bitmask of:

  • 0x00: Report with no abort
  • 0x01: All subsequent CS procedures aborted: Abort because of local Host or remote request
  • 0x02: All subsequent CS procedures aborted: Abort because filtered channel map has less than 15 channels
  • 0x03: All subsequent CS procedures aborted: Abort because the channel map update instant has passed
  • 0x0F: All subsequent CS procedures aborted: Abort because of unspecified reasons
  • 0x10: Current CS subevent aborted: Abort because of local Host or remote request
  • 0x20: Current CS subevent aborted: Abort because no CS_SYNC (mode-0) received
  • 0x30: Current CS subevent aborted: Abort because of scheduling conflicts or limited resources
  • 0xF0: Current CS subevent aborted: Abort because of unspecified reasons

    • Num_Antenna_Paths

    1

    Number of antenna paths used during the phase measurement stage of the CS step

  • 0: Ignored because phase measurement does not occur during the CS step
  • 1 ... 4

    • Num_Steps_Reported

    1

    Number of steps in the CS subevent for which results are reported

  • 0x00 ... 0xA0

    • Step_Param

    246

    Must be composed of the following fields: Step_Mode (1 byte), Step_Channel (1 byte), Step_Data_Length (1 byte), Step_Data ('Step_Data_Length' bytes). All fields are repeated 'Num_Steps_Reported' times. Note: the indicated size is the maximum size.

    HCI_LE_CS_TEST_END_COMPLETE_EVENT

    Description

    This event is generated when the local Controller has stopped an ongoing CS test as a result of the HCI_LE_CS_TEST_END command.
    See Core Specification [Vol 4, Part E, 7.7.65.46].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    HCI_LE_MONITORED_ADVERTISERS_REPORT_EVENT

    Description

    This event indicates that an advertiser on the Monitored Advertisers List has met an RSSI threshold condition established by the HCI_LE_ENABLE_MONITORING_ADVERTISERS command.
    See Core Specification [Vol 4, Part E, 7.7.65.47].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Address_Type

    1

    Address type.

  • 0x00: Public Device Address
  • 0x01: Random Device Address
  • 0x02: Public Identity Address (corresponds to the Resolved Private Address)
  • 0x03: Random (static) Identity Address (corresponds to the Resolved Private Address)

    • Address

    6

    Public Device Address, Random Device Address, Public Identity Address, or Random (static) Identity Address of the device being monitored.

    Condition

    1

    RSSI threshold condition.

  • 0x00: Device RSSI below the low RSSI threshold for longer than the timeout period
  • 0x01: Device RSSI greater than or equal to the high RSSI threshold

    • HCI_LE_FRAME_SPACE_UPDATE_COMPLETE_EVENT

    Description

    This event is used to indicate that the Frame Space Update procedure has completed and, if initiated autonomously by the local Controller or the peer device, that at least one frame space value has changed.
    See Core Specification [Vol 4, Part E, 7.7.65.48].

    This event is not used on STM32WBA5/6.

    Event parameters

    ParameterSizeDescriptionPossible values

    Status

    1

    Status error code.

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Initiator

    1

    Indicates who initiated the Frame Space Update procedure.

  • 0x00: Local Host initiated
  • 0x01: Local Controller initiated
  • 0x02: Peer initiated

    • Frame_Space

    2

    The new frame space value being used, in microseconds.

  • 0x0000 ... 0x2710

    • PHYS

    1

    Indicates (with Spacing_Types) which frame space values are impacted by the update.

    Bitmask of:

  • 0x01: LE 1M
  • 0x02: LE 2M
  • 0x04: LE Coded PHY

    • Spacing_Types

    2

    Indicates (with PHYS) which frame space values are impacted by the update.

    Bitmask of:

  • 0x0001: T_IFS_ACL_CP
  • 0x0002: T_IFS_ACL_PC
  • 0x0004: T_MCES
  • 0x0008: T_IFS_CIS
  • 0x0010: T_MSS_CIS

    • ACI General events

    Event nameLE subevent codeBPBFPOLO
    ACI_WARNING_EVENT

    0x06

    Y

    Y

    Y

    Note: all ACI General events are enabled by default.

    ACI_WARNING_EVENT

    Description

    This event is generated to report warning information.

    Event parameters

    ParameterSizeDescriptionPossible values

    Warning_Type

    1

    Warning type

  • 0x01: L2CAP recombination failure
  • 0x02: GATT unexpected peer message
  • 0x03: NVM almost full
  • 0x04: COC RX data length too large
  • 0x05: COC already assigned DCID
  • 0x06: SMP unexpected LTK request
  • 0x07: GATT bearer not allocated

    • Data_Length

    1

    Length of Data in octets

    Data

    Data_Length

    Debug information.

    ACI GAP events

    Event nameVendor specific subevent codeBPBFPOLO
    ACI_GAP_LIMITED_DISCOVERABLE_EVENT

    0x0400

    Y

    Y

    Y

    ACI_GAP_PAIRING_COMPLETE_EVENT

    0x0401

    Y

    Y

    Y

    ACI_GAP_PASS_KEY_REQ_EVENT

    0x0402

    Y

    Y

    Y

    ACI_GAP_AUTHORIZATION_REQ_EVENT

    0x0403

    Y

    Y

    Y

    ACI_GAP_BOND_LOST_EVENT

    0x0405

    Y

    Y

    Y

    ACI_GAP_PROC_COMPLETE_EVENT

    0x0407

    Y

    Y

    Y

    ACI_GAP_ADDR_NOT_RESOLVED_EVENT

    0x0408

    Y

    Y

    Y

    ACI_GAP_NUMERIC_COMPARISON_VALUE_EVENT

    0x0409

    Y

    Y

    Y

    ACI_GAP_KEYPRESS_NOTIFICATION_EVENT

    0x040A

    Y

    Y

    Y

    ACI_GAP_PAIRING_REQUEST_EVENT

    0x040B

    Y

    Y

    Y

    Note: all ACI GAP events are enabled by default. See ACI_GAP_SET_EVENT_MASK.

    ACI_GAP_LIMITED_DISCOVERABLE_EVENT

    Description

    This event is generated by the controller when the limited discoverable mode ends due to timeout. The timeout is 180 seconds.

    Event parameters

    None

    ACI_GAP_PAIRING_COMPLETE_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Status

    1

    Pairing status

  • 0x00: Success
  • 0x01: SMP timeout
  • 0x02: Pairing failed
  • 0x03: Encryption failed

    • Reason

    1

    Pairing failed reason code (valid in case of pairing failed status)

  • 0x01: Passkey Entry Failed
  • 0x02: OOB Not Available
  • 0x03: Authentication Requirements
  • 0x04: Confirm Value Failed
  • 0x05: Pairing Not Supported
  • 0x06: Encryption Key Size
  • 0x07: Command Not Supported
  • 0x08: Unspecified Reason
  • 0x09: Repeated Attempts
  • 0x0A: Invalid Parameters
  • 0x0B: DHKey Check Failed
  • 0x0C: Numeric Comparison Failed
  • 0x0F: Key Rejected
  • 0x10: Busy

    • ACI_GAP_PASS_KEY_REQ_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • ACI_GAP_AUTHORIZATION_REQ_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • ACI_GAP_BOND_LOST_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • ACI_GAP_PROC_COMPLETE_EVENT

    Description

    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

    Event parameters

    ParameterSizeDescriptionPossible values

    Procedure_Code

    1

    Terminated procedure.

  • 0x01: GAP_LIMITED_DISCOVERY_PROC
  • 0x02: GAP_GENERAL_DISCOVERY_PROC
  • 0x08: GAP_AUTO_CONNECTION_ESTABLISHMENT_PROC
  • 0x10: GAP_GENERAL_CONNECTION_ESTABLISHMENT_PROC
  • 0x20: GAP_SELECTIVE_CONNECTION_ESTABLISHMENT_PROC
  • 0x40: GAP_DIRECT_CONNECTION_ESTABLISHMENT_PROC
  • 0x80: GAP_OBSERVATION_PROC

    • Status

    1

    Status error code.

    Data_Length

    1

    Length of Data in octets

    Data

    Data_Length

    Procedure Specific Data.

    ACI_GAP_ADDR_NOT_RESOLVED_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • ACI_GAP_NUMERIC_COMPARISON_VALUE_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Numeric_Value

    4

    Generated numeric value.

    ACI_GAP_KEYPRESS_NOTIFICATION_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Notification_Type

    1

    Type of Keypress input notified/signaled by peer device (having Keyboard only I/O capabilities.

    ACI_GAP_PAIRING_REQUEST_EVENT

    Description

    This event is sent only when SMP mode bit 3 is configured to 1. With this configuration, it is generated in two cases:
    - in Peripheral case, when a Pairing Request is received;
    - in Central case, when a Security Request is received that leads to the sending of a Pairing Request.
    The application shall respond to this event with ACI_GAP_PAIRING_REQUEST_REPLY command.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Bonded

    1

    Indicates if the peer device is already bonded or not.

  • 0x00: The device is not already bonded
  • 0x01: The device is already bonded

    • Auth_Req

    1

    AuthReq field from Pairing Request (see Core Specification [Vol 3, Part H, 3.5.1]) or Security Request (see Core Specification [Vol 3, Part H, 3.6.7]).

    ACI GATT/ATT events

    Event nameVendor specific subevent codeBPBFPOLO
    ACI_GATT_ATTRIBUTE_MODIFIED_EVENT

    0x0C01

    Y

    Y

    Y

    ACI_GATT_PROC_TIMEOUT_EVENT

    0x0C02

    Y

    Y

    Y

    ACI_ATT_EXCHANGE_MTU_RESP_EVENT

    0x0C03

    Y

    Y

    Y

    ACI_ATT_FIND_INFO_RESP_EVENT

    0x0C04

    Y

    Y

    ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT

    0x0C05

    Y

    Y

    ACI_ATT_READ_BY_TYPE_RESP_EVENT

    0x0C06

    Y

    Y

    ACI_ATT_READ_RESP_EVENT

    0x0C07

    Y

    Y

    ACI_ATT_READ_BLOB_RESP_EVENT

    0x0C08

    Y

    Y

    ACI_ATT_READ_MULTIPLE_RESP_EVENT

    0x0C09

    Y

    Y

    ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT

    0x0C0A

    Y

    Y

    ACI_ATT_PREPARE_WRITE_RESP_EVENT

    0x0C0C

    Y

    Y

    ACI_ATT_EXEC_WRITE_RESP_EVENT

    0x0C0D

    Y

    Y

    ACI_GATT_INDICATION_EVENT

    0x0C0E

    Y

    Y

    ACI_GATT_NOTIFICATION_EVENT

    0x0C0F

    Y

    Y

    ACI_GATT_PROC_COMPLETE_EVENT

    0x0C10

    Y

    Y

    ACI_GATT_ERROR_RESP_EVENT

    0x0C11

    Y

    Y

    ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT

    0x0C12

    Y

    Y

    ACI_GATT_WRITE_PERMIT_REQ_EVENT

    0x0C13

    Y

    Y

    Y

    ACI_GATT_READ_PERMIT_REQ_EVENT

    0x0C14

    Y

    Y

    Y

    ACI_GATT_READ_MULTI_PERMIT_REQ_EVENT

    0x0C15

    Y

    Y

    Y

    ACI_GATT_TX_POOL_AVAILABLE_EVENT

    0x0C16

    Y

    Y

    Y

    ACI_GATT_SERVER_CONFIRMATION_EVENT

    0x0C17

    Y

    Y

    Y

    ACI_GATT_PREPARE_WRITE_PERMIT_REQ_EVENT

    0x0C18

    Y

    Y

    Y

    ACI_GATT_EATT_BEARER_EVENT

    0x0C19

    Y

    ACI_GATT_MULT_NOTIFICATION_EVENT

    0x0C1A

    Y

    ACI_GATT_NOTIFICATION_COMPLETE_EVENT

    0x0C1B

    Y

    Y

    Y

    ACI_GATT_READ_EXT_EVENT

    0x0C1D

    Y

    Y

    ACI_GATT_INDICATION_EXT_EVENT

    0x0C1E

    Y

    Y

    ACI_GATT_NOTIFICATION_EXT_EVENT

    0x0C1F

    Y

    Y

    Note: not all ACI GATT/ATT events are enabled by default. See ACI_GATT_SET_EVENT_MASK and ACI_GATT_ADD_CHAR.

    ACI_GATT_ATTRIBUTE_MODIFIED_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_GATT_PROC_TIMEOUT_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • ACI_ATT_EXCHANGE_MTU_RESP_EVENT

    Description

    This event is generated in response to an Exchange MTU request. See ACI_GATT_EXCHANGE_CONFIG.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Server_RX_MTU

    2

    Attribute server receive MTU size

    ACI_ATT_FIND_INFO_RESP_EVENT

    Description

    This event is generated in response to a Find Information Request. See ACI_ATT_FIND_INFO_REQ and Find Information Response in Core Specification. This event is also generated in response to ACI_GATT_DISC_ALL_CHAR_DESC

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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]

    ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT

    Description

    This event is generated in response to a ACI_ATT_FIND_BY_TYPE_VALUE_REQ

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_ATT_READ_BY_TYPE_RESP_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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 Core Specification. A sequence of handle-value pairs: [2 octets for Attribute Handle, (Handle_Value_Pair_Length - 2 octets) for Attribute Value]

    ACI_ATT_READ_RESP_EVENT

    Description

    This event is generated in response to a Read Request. See ACI_GATT_READ_CHAR_VALUE.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Event_Data_Length

    1

    Length of following data

    Attribute_Value

    Event_Data_Length

    The value of the attribute.

    ACI_ATT_READ_BLOB_RESP_EVENT

    Description

    This event can be generated during a read long characteristic value procedure. See ACI_GATT_READ_LONG_CHAR_VALUE.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Event_Data_Length

    1

    Length of following data

    Attribute_Value

    Event_Data_Length

    Part of the attribute value.

    ACI_ATT_READ_MULTIPLE_RESP_EVENT

    Description

    This event is generated in response to a Read Multiple Characteristic Values Request or a Read Multiple Variable Length Characteristic Values Request.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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.

    ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT

    Description

    This event is generated in response to a Read By Group Type Request. See ACI_GATT_DISC_ALL_PRIMARY_SERVICES.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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 Core Specification. 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]

    ACI_ATT_PREPARE_WRITE_RESP_EVENT

    Description

    This event is generated in response to a ACI_ATT_PREPARE_WRITE_REQ.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_ATT_EXEC_WRITE_RESP_EVENT

    Description

    This event is generated in response to an Execute Write Request.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • ACI_GATT_INDICATION_EVENT

    Description

    This event is generated when an indication is received from the server.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_GATT_NOTIFICATION_EVENT

    Description

    This event is generated when a notification is received from the server.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_GATT_PROC_COMPLETE_EVENT

    Description

    This event is generated when a GATT client procedure completes either with error or successfully.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Error_Code

    1

    Indicates whether the procedure completed with an error or was successful (see "Status error codes" section)

    ACI_GATT_ERROR_RESP_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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)

  • 0x01: Invalid handle
  • 0x02: Read not permitted
  • 0x03: Write not permitted
  • 0x04: Invalid PDU
  • 0x05: Insufficient authentication
  • 0x06: Request not supported
  • 0x07: Invalid offset
  • 0x08: Insufficient authorization
  • 0x09: Prepare queue full
  • 0x0A: Attribute not found
  • 0x0B: Attribute not long
  • 0x0C: Insufficient encryption key size
  • 0x0D: Invalid attribute value length
  • 0x0E: Unlikely error
  • 0x0F: Insufficient encryption
  • 0x10: Unsupported group type
  • 0x11: Insufficient resources
  • 0x12: Database Out Of Sync
  • 0x13: Value Not Allowed

    • ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT

    Description

    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 Core Specification [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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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 Core Specification [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.

    ACI_GATT_WRITE_PERMIT_REQ_EVENT

    Description

    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_PERMIT_WRITE.
    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_GATT_READ_PERMIT_REQ_EVENT

    Description

    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_PERMIT_READ command to indicate to the stack that it can send the response to the client.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Attribute_Handle

    2

    The handle of the attribute

    Offset

    2

    Contains the offset from which the read has been requested

    ACI_GATT_READ_MULTI_PERMIT_REQ_EVENT

    Description

    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_PERMIT_READ command to indicate to the stack that it can send the response to the client.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • Number_of_Handles

    1

    Number of attribute handles contained in this event

    Handle[i]

    2

    ACI_GATT_TX_POOL_AVAILABLE_EVENT

    Description

    Each time one of the following GATT commands raises the error code BLE_STATUS_INSUFFICIENT_RESOURCES, the ACI_GATT_TX_POOL_AVAILABLE_EVENT event is generated as soon as there is at least one buffer (with a size of ATT_MTU) available in the TX pool:
    - ACI_GATT_UPDATE_CHAR_VALUE,
    - ACI_GATT_UPDATE_CHAR_VALUE_EXT,
    - ACI_GATT_SEND_MULT_NOTIFICATION,
    - ACI_GATT_WRITE_WITHOUT_RESP,
    - ACI_GATT_SIGNED_WRITE_WITHOUT_RESP.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Not used.

    Available_Buffers

    2

    Number of buffers available.

    ACI_GATT_SERVER_CONFIRMATION_EVENT

    Description

    This event is generated when the client has sent the confirmation to a previously sent indication

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • ACI_GATT_PREPARE_WRITE_PERMIT_REQ_EVENT

    Description

    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_PERMIT_WRITE. 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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_GATT_EATT_BEARER_EVENT

    Description

    This event informs the application of a change in status of the Enhanced ATT bearer handled by the specified L2CAP channel.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Connection handle for which the event applies.

  • 0x0000 ... 0x0EFF

    • Channel_Index

    1

    Index of the connection-oriented channel for which the primitive applies.

    EAB_State

    1

    Enhanced ATT bearer state.

  • 0x00: Enhanced ATT bearer created
  • 0x01: Enhanced ATT bearer terminated
  • 0x02: Enhanced ATT bearer reconfigured

    • MTU

    2

    ATT_MTU value used on the bearer.

  • 64 ... 246

    • ACI_GATT_MULT_NOTIFICATION_EVENT

    Description

    This event is generated when a Multiple Handle Value notification is received from the server.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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 Core Specification

    ACI_GATT_NOTIFICATION_COMPLETE_EVENT

    Description

    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).

    Event parameters

    ParameterSizeDescriptionPossible values

    Attr_Handle

    2

    Handle of the updated characteristic value

    ACI_GATT_READ_EXT_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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).

    ACI_GATT_INDICATION_EXT_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI_GATT_NOTIFICATION_EXT_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Specifies the ATT bearer for which the event applies.

  • 0x0000 ... 0x0EFF: Unenhanced ATT bearer (the parameter is the connection handle)
  • 0xEA00 ... 0xEA3F: Enhanced ATT bearer (the LSB-byte of the parameter is the connection-oriented channel index)

    • 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

    ACI L2CAP events

    Event nameVendor specific subevent codeBPBFPOLO
    ACI_L2CAP_CONNECTION_UPDATE_RESP_EVENT

    0x0800

    Y

    Y

    Y

    ACI_L2CAP_PROC_TIMEOUT_EVENT

    0x0801

    Y

    Y

    Y

    ACI_L2CAP_CONNECTION_UPDATE_REQ_EVENT

    0x0802

    Y

    Y

    ACI_L2CAP_COMMAND_REJECT_EVENT

    0x080A

    Y

    Y

    Y

    ACI_L2CAP_COC_CONNECT_EVENT

    0x0810

    Y

    ACI_L2CAP_COC_CONNECT_CONFIRM_EVENT

    0x0811

    Y

    ACI_L2CAP_COC_RECONF_EVENT

    0x0812

    Y

    ACI_L2CAP_COC_RECONF_CONFIRM_EVENT

    0x0813

    Y

    ACI_L2CAP_COC_DISCONNECT_EVENT

    0x0814

    Y

    ACI_L2CAP_COC_FLOW_CONTROL_EVENT

    0x0815

    Y

    ACI_L2CAP_COC_RX_DATA_EVENT

    0x0816

    Y

    ACI_L2CAP_COC_TX_POOL_AVAILABLE_EVENT

    0x0817

    Y

    Note: all ACI L2CAP events are enabled by default. See ACI_GAP_SET_EVENT_MASK.

    ACI_L2CAP_CONNECTION_UPDATE_RESP_EVENT

    Description

    This event is generated when the Central responds to the connection update request packet with a connection update response packet.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Result

    2

    Result field from the response packet.

  • 0x0000: Connection Parameters accepted
  • 0x0001: Connection Parameters rejected

    • ACI_L2CAP_PROC_TIMEOUT_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Data_Length

    1

    Length of following data

  • 0x00

    • Data

    Data_Length

    Not used

    ACI_L2CAP_CONNECTION_UPDATE_REQ_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Identifier

    1

    Received identifier.

    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.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Interval_Max

    2

    Maximum value for the connection event interval. Time = N * 1.25 ms.

  • 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)

    • Latency

    2

    Maximum Peripheral latency for the connection in number of connection events.

  • 0x0000 ... 0x01F3

    • Timeout_Multiplier

    2

    Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms.

    ACI_L2CAP_COMMAND_REJECT_EVENT

    Description

    This event is generated upon receipt of a valid L2CAP Command Reject packet (e.g. when the Central responds to the Connection Update Request packet with a L2CAP Command Reject packet).

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Identifier

    1

    Received identifier.

    Reason

    2

    Describes why the request packet was rejected.

  • 0x0000: Command not understood
  • 0x0001: Signaling MTU exceeded
  • 0x0002: Invalid CID in request

    • Data_Length

    1

    Length of following data

    Data

    Data_Length

    Data field associated with Reason (see Core Specification [Vol 3, Part A, 4.1])

    ACI_L2CAP_COC_CONNECT_EVENT

    Description

    This event is generated when receiving a valid Credit Based Connection Request packet.
    See Core Specification [Vol 3, Part A].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • SPSM

    2

    Simplified Protocol/Service Multiplexer.

  • 0x0001 ... 0x00FF

    • MTU

    2

    Maximum Transmission Unit.

  • 23 ... 65535
  • 64 ... 246: for Enhanced ATT

    • MPS

    2

    Maximum payload size (in octets).

  • 23 ... 248
  • 64 ... 248: for Enhanced ATT

    • Initial_Credits

    2

    Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet.

  • 0 ... 65535

    • 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.

  • 0 ... 5

    • ACI_L2CAP_COC_CONNECT_CONFIRM_EVENT

    Description

    This event is generated when receiving a valid Credit Based Connection Response packet.
    See Core Specification [Vol 3, Part A].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • MTU

    2

    Maximum Transmission Unit.

  • 23 ... 65535
  • 64 ... 246: for Enhanced ATT

    • MPS

    2

    Maximum payload size (in octets).

  • 23 ... 248
  • 64 ... 248: for Enhanced ATT

    • Initial_Credits

    2

    Number of K-frames that can be received on the created channel(s) by the L2CAP layer entity sending this packet.

  • 0 ... 65535

    • Result

    2

    Indicates the outcome of the request. See Core Specification [Vol 3, Part A, Table 4.16] for LE credit based connection-oriented channels, or [Vol 3, Part A, Table 4.17] for enhanced credit based connection-oriented channels.

  • 0x0000 ... 0x000F

    • Channel_Number

    1

    Number of created channels. It is the length of Channel_Index_List.

  • 0 ... 5

    • Channel_Index_List

    Channel_Number

    List of channel indexes for which the primitive applies.

    ACI_L2CAP_COC_RECONF_EVENT

    Description

    This event is generated when receiving a valid Credit Based Reconfigure Request packet.
    See Core Specification [Vol 3, Part A].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • MTU

    2

    Maximum Transmission Unit.

  • 23 ... 65535
  • 64 ... 246: for Enhanced ATT

    • MPS

    2

    Maximum payload size (in octets).

  • 23 ... 248
  • 64 ... 248: for Enhanced ATT

    • Channel_Number

    1

    Number of created channels. It is the length of Channel_Index_List.

  • 1 ... 5

    • Channel_Index_List

    Channel_Number

    List of channel indexes for which the primitive applies.

    ACI_L2CAP_COC_RECONF_CONFIRM_EVENT

    Description

    This event is generated when receiving a valid Credit Based Reconfigure Response packet.
    See Core Specification [Vol 3, Part A].

    Event parameters

    ParameterSizeDescriptionPossible values

    Connection_Handle

    2

    Handle of the connection where this event occurred.

  • 0x0000 ... 0x0EFF

    • Result

    2

    Indicates the outcome of the request. See Core Specification [Vol 3, Part A, Table 4.18].

  • 0x0000 ... 0x0004

    • ACI_L2CAP_COC_DISCONNECT_EVENT

    Description

    This event is generated when a connection-oriented channel is disconnected following an L2CAP channel termination procedure.
    See Core Specification [Vol 3, Part A].

    Event parameters

    ParameterSizeDescriptionPossible values

    Channel_Index

    1

    Index of the connection-oriented channel for which the primitive applies.

    ACI_L2CAP_COC_FLOW_CONTROL_EVENT

    Description

    This event is generated when receiving a valid Flow Control Credit signaling packet.
    See Core Specification [Vol 3, Part A].

    Event parameters

    ParameterSizeDescriptionPossible 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.

  • 1 ... 65535

    • ACI_L2CAP_COC_RX_DATA_EVENT

    Description

    This event is generated when receiving a valid K-frame packet on a connection-oriented channel.
    See Core Specification [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.

    Event parameters

    ParameterSizeDescriptionPossible 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

    ACI_L2CAP_COC_TX_POOL_AVAILABLE_EVENT

    Description

    Each time ACI_L2CAP_COC_TX_DATA raises the error code BLE_STATUS_INSUFFICIENT_RESOURCES, the ACI_L2CAP_COC_TX_POOL_AVAILABLE_EVENT event is generated as soon as there is a free buffer available for sending K-frames.

    Event parameters

    None

    ACI HAL events

    Event nameVendor specific subevent codeBPBFPOLO
    ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT

    0x1804

    Y

    Y

    Y

    Y

    ACI_HAL_SYNC_EVENT

    0x1808

    Y

    Note: not all ACI HAL events are enabled by default. See ACI_HAL_SET_EVENT_MASK and ACI_HAL_SET_RADIO_ACTIVITY_MASK.

    ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT

    Description

    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.

    Event parameters

    ParameterSizeDescriptionPossible values

    Last_State

    1

    Completed radio event

  • 0x00: Idle
  • 0x01: Advertising
  • 0x02: Peripheral connection
  • 0x03: Scanning
  • 0x05: Central connection
  • 0x06: TX test mode
  • 0x07: RX test mode
  • 0x09: Periodic advertising
  • 0x0A: Periodic sync
  • 0x0B: Iso broadcast
  • 0x0C: Iso sync
  • 0x0D: Iso peripheral connection
  • 0x0E: Iso central connection

    • Next_State

    1

    Incoming radio event

  • 0x00: Idle
  • 0x01: Advertising
  • 0x02: Peripheral connection
  • 0x03: Scanning
  • 0x05: Central connection
  • 0x06: TX test mode
  • 0x07: RX test mode
  • 0x09: Periodic advertising
  • 0x0A: Periodic sync
  • 0x0B: Iso broadcast
  • 0x0C: Iso sync
  • 0x0D: Iso peripheral connection
  • 0x0E: Iso central connection

    • Next_State_SysTime

    4

    Remaining time before next event expressed in microseconds.

    Last_State_Slot

    1

    Not used.

  • 0xFF: Idle
  • 0x00 ... 0x07

    • Next_State_Slot

    1

    Not used.

  • 0xFF: Idle
  • 0x00 ... 0x07

    • ACI_HAL_SYNC_EVENT

    Description

    This event is generated after the execution of CIG or BIG is completed on hardware. The command ACI_HAL_SET_SYNC_EVENT_CONFIG must be used to configure the generation of this event.

    Event parameters

    ParameterSizeDescriptionPossible values

    Group_Id

    1

    Identifier of the CIG or BIG.

  • 0x00 ... 0xEF

    • 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

    Annex

    Status error codes

    TX Power Level

    Configuration data

    Hardware codes

    Status error codes

    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 Core Specification [Vol 1, Part F]), while more codes are defined for ACI commands (see table below).

    Status error codeDescription

    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

    0x5E

    Device not bonded

    0x60

    Invalid handle

    0x61

    Out of handles

    0x62

    Invalid operation

    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

    TX Power Level

    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 STM32WBA output).

    PA_LevelOutput 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.

    Configuration data

    The configuration data are a set of BLE stack parameters that can be configured via ACI_WRITE_CONFIG_DATA. Hereafter are some details about each parameter.

    Note: the reset value should be understood as the parameter value after initialization or after a call to the ACI_RESET or HCI_RESET command.

  • PUBLIC_ADDRESS
  • ER
  • IR
  • RANDOM_ADDRESS
  • GAP_ADD_REC_NBR
  • SC_KEY_TYPE
  • SMP_MODE
  • LL_RSSI_GOLDEN_RANGE
  • LL_RX_ACL_CTRL

    • PUBLIC_ADDRESS

    This parameter is the local device public address. It is the address returned by HCI_READ_BD_ADDR.

    It is used by both the Controller and the Host.

    Reset value: 0x0280E1000000.

    ER

    This parameter is the Encryption root key used to derive LTK (legacy pairing) and CSRK. When the application uses the GATT signed write feature, this parameter must be initialized with a static random value different for each device.

    This parameter is used by the Host only.

    Reset value: all 0s (or a different constant value in case of specific debug BLE stack initialization).

    IR

    This parameter is the Identity root key used to derive DHK (legacy pairing) and IRK. When the application uses the privacy feature, this parameter must be initialized with a static random value different for each device.

    This parameter is used by the Host only.

    Reset value: all 0s (or a different constant value in case of specific debug BLE stack initialization).

    RANDOM_ADDRESS

    This parameter is the local device static random address.

    It is used by the Host only.

    Reset value: all 0s (or a random value in case of specific debug BLE stack initialization).

    GAP_ADD_REC_NBR

    This parameter is the GAP service additional record number. It is used by the ACI_GAP_INIT command to reserve additional records at the end of the GAP service. These records can be used to add custom characteristics in the GAP service. Note that the attribute handles used for the custom services immediately after the GAP service are incremented by this number.

    This parameter is used by the Host only (actually, only by GAP when in Central or Peripheral role).

    Reset value: 0.

    SC_KEY_TYPE

    This parameter is the Secure Connections key type.

    - 0 must be used for "normal" key type. During Secure Connections, the public and private keys are generated.

    - 1 must be used for "debug" key type. During Secure Connections, the standard debug public and private keys are used.

    This parameter is used by both the Controller and the Host when Secure Connections are supported.

    Reset value: 0.

    SMP_MODE

    This parameter is the SMP mode. It is an 8-bit bitmap of the following binary flags:

    - bit 0: "bypass"; when this bit is set, the SMP is deactivated and the Controller events that should go to the SMP are transmitted directly to the application.

    - bit 1: "no blacklist"; when this bit is set, the "Repeated Attempts" protection is deactivated.

    - bit 2: "no peer debug key"; when this bit is set, the usage by the peer of the standard Secure Connections debug key is forbidden.

    - bit 3: "pairing request event"; when this bit is set, the SMP may generate ACI_GAP_PAIRING_REQUEST_EVENT.

    - bit 4: "no just works"; when this bit is set, the Just Works association model is forbidden.

    - bit 5: "no passkey entry"; when this bit is set, the Passkey Entry association model is forbidden.

    - bit 6: "no out-of-band;" when this bit is set, the Out of Band (OOB) association model is forbidden.

    - bit 7: "no numeric comparison"; when this bit is set, the Numeric Comparison association model is forbidden.

    This parameter is used by the Host only.

    Reset value: 0.

    LL_RSSI_GOLDEN_RANGE

    This parameter is the Link Layer RSSI golden range. It is composed of two 8-bit signed values in dBm; byte #0 is the lower value, byte #1 is the upper value.

    This parameter is used by the Controller only.

    Reset value: [-77,-68].

    LL_RX_ACL_CTRL

    This parameter is the Link Layer RX ACL control. It is composed of 2 bytes; byte #0 is "rx_pckt_count", byte #1 is "rx_pckt_len".

    "rx_pckt_count" is the number of RX packets expected to be received with a payload size of "rx_pckt_len" octets.

    "rx_pckt_len" is the length of RX packets expected to be received on the first "rx_pckt_count" slots.

    It is used by the Controller only.

    Reset value: [0,0].

    Hardware codes

    Hardware codes are used by HCI_HARDWARE_ERROR_EVENT to report the type of failure that has occurred in the Controller. The different values are listed in the table below.

    Hardware_CodeDescription

    0x03

    event_fifo_full: internal FIFO full error

    0x80

    ll_undefined_error: LL undefined issue

    0x81

    bl_search_error: issue while searching in the Duplicated Connection list

    0x82

    rl_search_error: issue while searching in the Resolving list

    0x83

    wl_search_error: issue while searching in the Filter Accept list

    0x84

    pdu_parsing_error: issue while parsing PDU

    0x85

    pdu_receiving_error: unexpected PDU type received

    0x86

    sm_update_error: state machine update issue

    0x87

    unregistering_error: issue while unregistering an event

    0x88

    starting_connection_error: issue while starting a connection

    0x89

    memory_exceeded_error: issue while allocating memory

    0x8A

    unexpected_adv_state_error: unexpected advertising state

    Other values are reserved.

    Revision history

    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.

    June 2023 - Rev 1.10 - Fixed maximum value of MPS; Changed note for ACI_GATT_UPDATE_CHAR_VALUE; Changed description of PHY_options.

    August 2023 - Rev 1.11 - Added HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT as "Events generated"; Updated HCI_READ_LOCAL_VERSION_INFORMATION; Added some details about bonding table; Added new mode in ACI_GAP_ADV_SET_CONFIGURATION; Added ACI_GAP_EXT_START_SCAN and ACI_GAP_EXT_CREATE_CONNECTION; Added ACI_GAP_ADV_SET_PERIODIC_PARAMETERS, ACI_GAP_ADV_SET_PERIODIC_DATA and ACI_GAP_ADV_SET_PERIODIC_ENABLE; Added possible values for FW_Error_Type; Updated HCI_LE_SET_EVENT_MASK possible values.

    September 2023 - Rev 1.12 - Fixed possible values of Advertising_TX_Power.

    November 2023 - Rev 1.13 - Added Connection Subrating and Channel Classification features. Added HCI_LE_SET_DATA_RELATED_ADDRESS_CHANGES command; Updated description of ACI_GATT_UPDATE_CHAR_VALUE and ACI_GATT_TX_POOL_AVAILABLE_EVENT; Updated description and possible values of ACI_HAL_WRITE_CONFIG_DATA; Upgraded ACI_HAL_GET_LINK_STATUS_V2 command to support 22 links.

    February 2024 - Rev 1.14 - Added "no peer debug key" bit for SMP mode in ACI_HAL_WRITE_CONFIG_DATA.

    April 2024 - Rev 1.15 - Added BP and PO variants; Added ACI_HAL_EAD_ENCRYPT_DECRYPT command.

    August 2024 - Rev 1.16 - Removed ACI_HAL_SCAN_REQ_REPORT_EVENT; Fixed possible values for Enable of periodic advertising; Added configuration of RSSI golden range; Updated description of ACI_HAL_END_OF_RADIO_ACTIVITY_EVENT parameters; Changed description of ACI_GAP_IS_DEVICE_BONDED; Fixed possible values of PHY for receiver test; Added bits for SMP mode in ACI_HAL_WRITE_CONFIG_DATA; Added ACI_GAP_ADV_SET_CONFIGURATION_V2 and HCI_LE_SET_EXTENDED_ADVERTISING_PARAMETERS_V2 to support Advertising Coding Selection; Added HCI_LE_LONG_TERM_KEY_REQUEST_REPLY, HCI_LE_LONG_TERM_KEY_REQUEST_NEGATIVE_REPLY and HCI_LE_SET_HOST_CHANNEL_CLASSIFICATION in BP, BF and PO variants; Removed HCI_DISCONNECT and HCI_LE_CONNECTION_UPDATE from BP, BF and PO variants; Added ACI_GAP_PAIRING_REQUEST_EVENT and ACI_GAP_PAIRING_REQUEST_REPLY.

    September 2024 - Rev 1.17 - Aligned with Bluetooth Core v.6.0; Added LL RX ACL control in ACI_HAL_WRITE_CONFIG_DATA.

    September 2024 - Rev 1.18 - Added LL error in HCI_HARDWARE_ERROR_EVENT.

    December 2024 - Rev 1.19 - Created annex for configuration data and hardware codes; Added HCI_LE_GENERATE_DHKEY and HCI_LE_GENERATE_DHKEY_COMPLETE_EVENT in BP, BF and PO variants; Fixed possible values for HCI_LE_SET_PHY, HCI_LE_SET_DEFAULT_PHY, HCI_LE_SET_PERIODIC_ADVERTISING_RECEIVE_ENABLE, HCI_LE_ADD_DEVICE_TO_FILTER_ACCEPT_LIST, HCI_LE_REMOVE_DEVICE_FROM_FILTER_ACCEPT_LIST, ACI_GAP_START_GENERAL_DISCOVERY_PROC and ACI_GAP_EXT_START_SCAN; Added HCI_LE_CIS_ESTABLISHED_V2_EVENT. Rework notes for legacy advertising commands; Renamed ACI_HAL_FW_ERROR_EVENT to ACI_HAL_WARNING_EVENT; Added parameter in ACI_GAP_BOND_LOST_EVENT; Removed ACI_GAP_PERIPHERAL_SECURITY_INITIATED_EVENT; Added "SMP unexpected LTK request" warning.

    January 2025 - Rev 1.20 - Changed description of ACI_HAL_GET_LINK_STATUS_V2; Removed ACI_GAP_RESOLVE_PRIVATE_ADDR and ACI_GAP_IS_DEVICE_BONDED; Added ACI_GAP_CHECK_BONDED_DEVICE; Added "Connection Parameters Request" feature on all variants.

    March 2025 - Rev 1.21 - Added LL features: Periodic Advertising with Responses, Channel Sounding, Monitoring Advertisers, LE Frame Space Update and LL Extended Feature Set; Fixed possible values of Data_Path_Direction for HCI_LE_REMOVE_ISO_DATA_PATH; Fixed possible values of CTE_Type for HCI_LE_TRANSMITTER_TEST_V3 and HCI_LE_TRANSMITTER_TEST_V4; Fixed maximum SDU size in HCI_LE_SET_CIG_PARAMETERS, HCI_LE_SET_CIG_PARAMETERS_TEST and HCI_LE_CIS_ESTABLISHED_V2_EVENT; Added new value for warning type; Added note about event mask after the event tables; Fixed description of ACI_HAL_SET_EVENT_MASK, ACI_GATT_SET_EVENT_MASK and ACI_GAP_SET_EVENT_MASK; Added new pairing failed reason; Changed description of ACI_GATT_DISC_ALL_CHAR_DESC; Removed ACI_GAP_ADD_DEVICES_TO_RESOLVING_LIST; Changed description of ACI_GATT_SET_SECURITY_PERMISSION.

    April 2025 - Rev 1.22 - Changed description of ACI_GAP_UPDATE_ADV_DATA; Changed parameters of ACI_GATT_EATT_BEARER_EVENT; Added Max_Channel_Number parameter to ACI_L2CAP_COC_CONNECT_CONFIRM; Changed description of ACI_L2CAP_COMMAND_REJECT_EVENT; Changed description of HCI_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT.

    April 2025 - Rev 1.23 - Removed references to STM32WB in descriptions; Added note for ACI_HAL_READ_RSSI; Added ACI_RESET, ACI_GET_INFORMATION, ACI_WRITE_CONFIG_DATA and ACI_READ_CONFIG_DATA; Renamed ACI_HAL_WARNING_EVENT to ACI_WARNING_EVENT; Removed ACI_HAL_GET_FW_BUILD_NUMBER and ACI_HAL_GET_PM_DEBUG_INFO_V2.

    May 2025 - Rev 1.24 - Aligned with Bluetooth Core v.6.1.

    June 2025 - Rev 1.25 - Added ACI_GATT_WRITE_WITHOUT_RESP_EXT and ACI_GATT_WRITE_WITH_RESP_EXT; Removed ACI_GATT_READ_CHAR_DESC, ACI_GATT_READ_LONG_CHAR_DESC, ACI_GATT_WRITE_CHAR_DESC and ACI_GATT_WRITE_LONG_CHAR_DESC; Added possible values for Security_Permissions and MITM_Mode; Renamed ACI_GATT_WRITE_RESP to ACI_GATT_PERMIT_WRITE; Replaced ACI_GATT_ALLOW_READ and ACI_GATT_DENY_READ by ACI_GATT_PERMIT_READ; Reworked description of HCI_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, HCI_HOST_BUFFER_SIZE and HCI_HOST_NUMBER_OF_COMPLETED_PACKETS; Changed subevent code of ACI HAL events.

    August 2025 - Rev 1.26 - Completed description of HCI_READ_LOCAL_VERSION_INFORMATION; Declared the use of fixed pin deprecated; Added ACI_HAL_EAD_ENCRYPT_DECRYPT in LO variant; Added ACI_HAL_SET_EVENT_MASK in all variants; Removed LB variant; Completed description of ACI_HAL_SET_SYNC_EVENT_CONFIG.

    © 2018-2025 STMicroelectronics. All rights reserved.