/**
******************************************************************************
* @file bluenrg1_events.h
* @author AMG - RF Application team
* @version V1.0.0
* @date 31 May 2018
* @brief Header file for external uC - BlueNRG-x in network coprocessor mode (Event callbacks)
* Autogenerated files, do not edit!!
******************************************************************************
* @attention
*
* THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
* WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
* TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
* DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
* FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
* CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
*
* © COPYRIGHT STMicroelectronics
******************************************************************************
*/
#ifndef _BLUENRG1_EVENTS_H_
#define _BLUENRG1_EVENTS_H_
#include
#include "compiler.h"
#include "bluenrg1_types.h"
/**
*@defgroup HCI_events HCI events
*@brief HCI events layer.
*@{
*/
/* HCI events */
/** Documentation for C struct Handle_Packets_Pair_Entry_t */
typedef struct Handle_Packets_Pair_Entry_t_s {
/** Connection handle
*/
uint16_t Connection_Handle;
/** 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.
*/
uint16_t HC_Num_Of_Completed_Packets;
} Handle_Packets_Pair_Entry_t;
/**
* @brief The Disconnection Complete 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 can be ignored by the Host. For example, this can be the
case if the Host has issued the Disconnect command and there was a parameter
error, or the command was not presently allowed, or a Connection_Handle
that didn't correspond to a connection was given.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection_Handle which was disconnected.
* Values:
- 0x0000 ... 0x0EFF
* @param Reason Reason for disconnection.
* Values:
- 0x00: Success
- 0x01: Unknown HCI Command
- 0x02: Unknown Connection Identifier
- 0x03: Hardware Failure
- 0x04: Page Timeout
- 0x05: Authentication Failure
- 0x06: PIN or Key Missing
- 0x07: Memory Capacity Exceeded
- 0x08: Connection Timeout
- 0x09: Connection Limit Exceeded
- 0x0A: Synchronous Connection Limit to a Device Exceeded
- 0x0B: ACL Connection Already Exists
- 0x0C: Command Disallowed
- 0x0D: Connection Rejected Due To Limited Resources
- 0x0E: Connection Rejected Due To Security Reasons
- 0x0F: Connection Rejected due to Unacceptable BD_ADDR
- 0x10: Connection Accept Timeout Exceeded
- 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
- 0x17: Repeated Attempts
- 0x18: Pairing Not Allowed
- 0x19: Unknown LMP PDU
- 0x1A: Unsupported Remote Feature / Unsupported LMP Feature
- 0x1B: SCO Offset Rejected
- 0x1C: SCO Interval Rejected
- 0x1D: SCO Air Mode Rejected
- 0x1E: Invalid LMP Parameters
- 0x1F: Unspecified Error
- 0x20: Unsupported LMP Parameter Value
- 0x21: Role Change Not Allowed
- 0x22: LMP Response Timeout / LL Response Timeout
- 0x23: LMP Error Transaction Collision
- 0x24: LMP PDU Not Allowed
- 0x25: Encryption Mode Not Acceptable
- 0x26: Link Key cannot be Changed
- 0x27: Requested QoS Not Supported
- 0x28: Instant Passed
- 0x29: Pairing With Unit Key Not Supported
- 0x2A: Different Transaction Collision
- 0x2C: QoS Unacceptable Parameter
- 0x2D: QoS Rejected
- 0x2E: Channel Assessment Not Supported
- 0x2F: Insufficient Security
- 0x30: Parameter Out Of Mandatory Range
- 0x32: Role Switch Pending
- 0x34: Reserved Slot Violation
- 0x35: Role Switch Failed
- 0x36: Extended Inquiry Response Too Large
- 0x37: Secure Simple Pairing Not Supported by Host
- 0x38: Host Busy - Pairing
- 0x39: Connection Rejected due to No Suitable Channel Found
- 0x3A: Controller Busy
- 0x3B: Unacceptable Connection Interval
- 0x3C: Directed Advertising Timeout
- 0x3D: Connection Terminated Due to MIC Failure
- 0x3E: Connection Failed to be Established
- 0x3F: MAC of the 802.11 AMP
- 0x41: Failed
- 0x42: Invalid parameters
- 0x43: Busy
- 0x44: Invalid length
- 0x45: Pending
- 0x46: Not allowed
- 0x47: GATT error
- 0x48: Address not resolved
- 0x50: Invalid CID
- 0x5A: CSRK not found
- 0x5B: IRK not found
- 0x5C: Device not found in DB
- 0x5D: Security DB full
- 0x5E: Device not bonded
- 0x5F: Device in blacklist
- 0x60: Invalid handle
- 0x61: Invalid parameter
- 0x62: Out of handles
- 0x63: Invalid operation
- 0x64: Insufficient resources
- 0x65: Insufficient encryption key size
- 0x66: Characteristic already exist
- 0x82: No valid slot
- 0x83: Short window
- 0x84: New interval failed
- 0x85: Too large interval
- 0x86: Slot length failed
- 0xFA: Flash read failed
- 0xFB: Flash write failed
- 0xFC: Flash erase failed
* @retval None
*/
WEAK_FUNCTION(void hci_disconnection_complete_event(uint8_t Status,
uint16_t Connection_Handle,
uint8_t Reason));
/**
* @brief The Encryption Change event is used to indicate that the change of the encryption
mode has been completed. The Connection_Handle will be a Connection_Handle
for an ACL connection. The Encryption_Enabled event parameter
specifies the new Encryption_Enabled parameter for the Connection_Handle
specified by the Connection_Handle event parameter. This event will occur on
both devices to notify the Hosts when Encryption has changed for the specified
Connection_Handle between two devices. Note: This event shall not be generated
if encryption is paused or resumed; during a role switch, for example.
The meaning of the Encryption_Enabled parameter depends on whether the
Host has indicated support for Secure Connections in the Secure_Connections_Host_Support
parameter. When Secure_Connections_Host_Support is
'disabled' or the Connection_Handle refers to an LE link, the Controller shall
only use Encryption_Enabled values 0x00 (OFF) and 0x01 (ON).
(See Bluetooth Specification v.4.1, Vol. 2, Part E, 7.7.8)
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection handle for which the command is given.
* Values:
- 0x0000 ... 0x0EFF
* @param Encryption_Enabled Link Level Encryption.
* Values:
- 0x00: Link Level Encryption OFF
- 0x01: Link Level Encryption is ON with AES-CCM
* @retval None
*/
WEAK_FUNCTION(void hci_encryption_change_event(uint8_t Status,
uint16_t Connection_Handle,
uint8_t Encryption_Enabled));
/**
* @brief The Read Remote Version Information Complete event is used to indicate the
completion of the process obtaining the version information of the remote Controller
specified by the Connection_Handle event parameter. The Connection_Handle
shall be for an ACL connection.
The Version event parameter defines the specification version of the LE Controller.
The Manufacturer_Name event parameter indicates the manufacturer
of the remote Controller. The Subversion event parameter is controlled
by the manufacturer and is implementation dependent. The Subversion
event parameter defines the various revisions that each version of the Bluetooth
hardware will go through as design processes change and errors are
fixed. This allows the software to determine what Bluetooth hardware is being
used and, if necessary, to work around various bugs in the hardware.
When the Connection_Handle is associated with an LE-U logical link, the Version
event parameter shall be Link Layer VersNr parameter, the Manufacturer_Name
event parameter shall be the CompId parameter, and the Subversion
event parameter shall be the SubVersNr parameter.
(See Bluetooth Specification v.4.1, Vol. 2, Part E, 7.7.12)
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection handle for which the command is given.
* Values:
- 0x0000 ... 0x0EFF
* @param Version Version of the Current LMP in the remote Controller
* @param Manufacturer_Name Manufacturer Name of the remote Controller
* @param Subversion Subversion of the LMP in the remote Controller
* @retval None
*/
WEAK_FUNCTION(void hci_read_remote_version_information_complete_event(uint8_t Status,
uint16_t Connection_Handle,
uint8_t Version,
uint16_t Manufacturer_Name,
uint16_t Subversion));
/**
* @brief The Hardware Error event is used to indicate some implementation specific type of hardware failure for the controller. This event is used to notify the Host that a hardware failure has occurred in the Controller.
* @param Hardware_Code Hardware Error Event code.
Error code 0x01 and 0x02 are errors generally caused by hardware issue on the PCB; another possible cause is a slow crystal startup.
In the latter case, the HS_STARTUP_TIME in the device configuration needs to be tuned.
Error code 0x03 indicates an internal error of the protocol stack.
After this event is recommended to force device reset.
* Values:
- 0x01: Radio state error
- 0x02: Timer overrun error
- 0x03: Internal queue overflow error
* @retval None
*/
WEAK_FUNCTION(void hci_hardware_error_event(uint8_t Hardware_Code));
/**
* @brief 'The Number Of Completed Packets event is used by the Controller to indicate
to the Host how many HCI Data Packets have been completed (transmitted or
flushed) for each Connection_Handle since the previous Number Of Completed
Packets event was sent to the Host. This means that the corresponding
buffer space has been freed in the Controller. Based on this information, and
the HC_Total_Num_ACL_Data_Packets and HC_Total_Num_Synchronous_-
Data_Packets return parameter of the Read_Buffer_Size command, the Host
can determine for which Connection_Handles the following HCI Data Packets
should be sent to the Controller. The Number Of Completed Packets event
must not be sent before the corresponding Connection Complete event. While
the Controller has HCI data packets in its buffer, it must keep sending the Number
Of Completed Packets event to the Host at least periodically, until it finally
reports that all the pending ACL Data Packets have been transmitted or
flushed.
* @param Number_of_Handles The number of Connection_Handles and Num_HCI_Data_Packets parameters pairs contained in this event
* @param Handle_Packets_Pair_Entry See @ref Handle_Packets_Pair_Entry_t
* @retval None
*/
WEAK_FUNCTION(void hci_number_of_completed_packets_event(uint8_t Number_of_Handles,
Handle_Packets_Pair_Entry_t Handle_Packets_Pair_Entry[]));
/**
* @brief '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. The
Link_Type parameter is used to indicate that the overflow was caused by ACL data.
* @param Link_Type On wich type of channel overflow has occurred.
* Values:
- 0x01: ACL Buffer Overflow
* @retval None
*/
WEAK_FUNCTION(void hci_data_buffer_overflow_event(uint8_t Link_Type));
/**
* @brief 'The Encryption Key Refresh Complete event is used to indicate to the Host
that the encryption key was refreshed on the given Connection_Handle any
time encryption is paused and then resumed.
If the Encryption Key Refresh Complete event was generated due to an
encryption pause and resume operation embedded within a change connection
link key procedure, the Encryption Key Refresh Complete event shall be sent
prior to the Change Connection Link Key Complete event.
If the Encryption Key Refresh Complete event was generated due to an
encryption pause and resume operation embedded within a role switch procedure,
the Encryption Key Refresh Complete event shall be sent prior to the
Role Change event.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection handle for which the command is given.
* Values:
- 0x0000 ... 0x0EFF
* @retval None
*/
WEAK_FUNCTION(void hci_encryption_key_refresh_complete_event(uint8_t Status,
uint16_t Connection_Handle));
/**
* @}
*/
/**
*@defgroup HCI_LE_meta_events HCI LE meta events
*@brief HCI LE meta events layer.
*@{
*/
/* HCI LE meta events */
/** Documentation for C struct Advertising_Report_t */
typedef struct Advertising_Report_t_s {
/** 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.
* Values:
- 0x00: ADV_IND
- 0x01: ADV_DIRECT_IND
- 0x02: ADV_SCAN_IND
- 0x03: ADV_NONCONN_IND
- 0x04: SCAN_RSP
*/
uint8_t Event_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)
* Values:
- 0x00: Public Device Address
- 0x01: Random Device Address
- 0x02: Public Identity Address
- 0x03: Random (Static) Identity Address
*/
uint8_t Address_Type;
/** Public Device Address, Random Device Address, Public Identity
Address or Random (static) Identity Address of the advertising
device.
*/
uint8_t Address[6];
/** Length of the Data[i] field for each device which responded.
* Values:
- 0 ... 31
*/
uint8_t Length_Data;
/** Length_Data[i] octets of advertising or scan response data formatted
as defined in [Vol 3] Part C, Section 8.
*/
uint8_t *Data;
/** N Size: 1 Octet (signed integer)
Units: dBm
* Values:
- 127: RSSI not available
- -127 ... 20
*/
uint8_t RSSI;
} Advertising_Report_t;
/** Documentation for C struct Direct_Advertising_Report_t */
typedef struct Direct_Advertising_Report_t_s {
/** Advertising type
* Values:
- 0x01: Connectable directed advertising (ADV_DIRECT_IND)
*/
uint8_t Event_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)
* Values:
- 0x00: Public Device Address
- 0x01: Random Device Address
- 0x02: Public Identity Address
- 0x03: Random (Static) Identity Address
*/
uint8_t Address_Type;
/** Public Device Address, Random Device Address, Public Identity
Address or Random (static) Identity Address of the advertising device.
*/
uint8_t Address[6];
/** 0x01 Random Device Address
* Values:
- 0x01: Random Device Address
*/
uint8_t Direct_Address_Type;
/** Random Device Address
*/
uint8_t Direct_Address[6];
/** N Size: 1 Octet (signed integer)
Units: dBm
* Values:
- 127: RSSI not available
- -127 ... 20
*/
uint8_t RSSI;
} Direct_Advertising_Report_t;
/**
* @brief The LE Connection Complete event indicates to both of the Hosts forming the
connection that a new connection has been created. Upon the creation of the
connection a Connection_Handle shall be assigned by the Controller, and
passed to the Host in this event. If the connection establishment fails this event
shall be provided to the Host that had issued the LE_Create_Connection command.
This event indicates to the Host which issued a LE_Create_Connection
command and received a Command Status event if the connection
establishment failed or was successful.
The Master_Clock_Accuracy parameter is only valid for a slave. On a master,
this parameter shall be set to 0x00.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection handle to be used to identify the connection with the peer device.
* Values:
- 0x0000 ... 0x0EFF
* @param Role Role of the local device in the connection.
* Values:
- 0x00: Master
- 0x01: Slave
* @param Peer_Address_Type The address type of the peer device.
* Values:
- 0x00: Public Device Address
- 0x01: Random Device Address
* @param Peer_Address Public Device Address or Random Device Address of the peer
device
* @param Conn_Interval Connection interval used on this connection.
Time = N * 1.25 msec
* Values:
- 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)
* @param Conn_Latency Slave latency for the connection in number of connection events.
* Values:
- 0x0000 ... 0x01F3
* @param Supervision_Timeout Supervision timeout for the LE Link.
It shall be a multiple of 10 ms and larger than (1 + connSlaveLatency) * connInterval * 2.
Time = N * 10 msec.
* Values:
- 0x000A (100 ms) ... 0x0C80 (32000 ms)
* @param Master_Clock_Accuracy Master clock accuracy. Only valid for a slave.
* Values:
- 0x00: 500 ppm
- 0x01: 250 ppm
- 0x02: 150 ppm
- 0x03: 100 ppm
- 0x04: 75 ppm
- 0x05: 50 ppm
- 0x06: 30 ppm
- 0x07: 20 ppm
* @retval None
*/
WEAK_FUNCTION(void hci_le_connection_complete_event(uint8_t Status,
uint16_t Connection_Handle,
uint8_t Role,
uint8_t Peer_Address_Type,
uint8_t Peer_Address[6],
uint16_t Conn_Interval,
uint16_t Conn_Latency,
uint16_t Supervision_Timeout,
uint8_t Master_Clock_Accuracy));
/**
* @brief The LE Advertising Report event indicates that a Bluetooth device or multiple
Bluetooth 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.
* @param Num_Reports Number of responses in this event.
* Values:
- 0x01
* @param Advertising_Report See @ref Advertising_Report_t
* @retval None
*/
WEAK_FUNCTION(void hci_le_advertising_report_event(uint8_t Num_Reports,
Advertising_Report_t Advertising_Report[]));
/**
* @brief The LE Connection Update Complete event is used to indicate that the Controller
process to update the connection has completed.
On a slave, if no connection parameters are updated, then this event shall not be issued.
On a master, this event shall be issued if the Connection_Update command was sent.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection handle to be used to identify the connection with the peer device.
* Values:
- 0x0000 ... 0x0EFF
* @param Conn_Interval Connection interval used on this connection.
Time = N * 1.25 msec
* Values:
- 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)
* @param Conn_Latency Slave latency for the connection in number of connection events.
* Values:
- 0x0000 ... 0x01F3
* @param Supervision_Timeout Supervision timeout for the LE Link.
It shall be a multiple of 10 ms and larger than (1 + connSlaveLatency) * connInterval * 2.
Time = N * 10 msec.
* Values:
- 0x000A (100 ms) ... 0x0C80 (32000 ms)
* @retval None
*/
WEAK_FUNCTION(void hci_le_connection_update_complete_event(uint8_t Status,
uint16_t Connection_Handle,
uint16_t Conn_Interval,
uint16_t Conn_Latency,
uint16_t Supervision_Timeout));
/**
* @brief The LE Read Remote Used Features Complete event is used to indicate the
completion of the process of the Controller obtaining the used features of the
remote Bluetooth device specified by the Connection_Handle event parameter.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection handle to be used to identify the connection with the peer device.
* Values:
- 0x0000 ... 0x0EFF
* @param LE_Features Bit Mask List of used LE features. For details see LE Link Layer specification.
* @retval None
*/
WEAK_FUNCTION(void hci_le_read_remote_used_features_complete_event(uint8_t Status,
uint16_t Connection_Handle,
uint8_t LE_Features[8]));
/**
* @brief The LE Long Term Key Request event indicates that the master device is
attempting to encrypt or re-encrypt the link and is requesting the Long Term
Key from the Host. (See [Vol 6] Part B, Section 5.1.3).
* @param Connection_Handle Connection handle to be used to identify the connection with the peer device.
* Values:
- 0x0000 ... 0x0EFF
* @param Random_Number 64-bit random number
* @param Encrypted_Diversifier 16-bit encrypted diversifier
* @retval None
*/
WEAK_FUNCTION(void hci_le_long_term_key_request_event(uint16_t Connection_Handle,
uint8_t Random_Number[8],
uint16_t Encrypted_Diversifier));
/**
* @brief The LE Data Length Change event notifies the Host of a change to either the maximum Payload length or the maximum transmission time of Data Channel PDUs in either direction. The values reported are the maximum that will actually be used on the connection following the change.
* @param Connection_Handle Connection_Handle to be used to identify a connection.
* @param MaxTxOctets The maximum number of payload octets in a Link Layer Data Channel PDU that the local Controller will send on this connection (connEffectiveMaxTxOctets defined in [Vol 6] Part B, Section 4.5.10).
Range 0x001B-0x00FB (0x0000 - 0x001A and 0x00FC - 0xFFFF Reserved for future use)
* @param MaxTxTime The maximum time that the local Controller will take to send a Link Layer Data Channel PDU on this connection (connEffectiveMaxTx-Time defined in [Vol 6] Part B, Section 4.5.10).
Range 0x0148-0x0848 (0x0000 - 0x0127 and 0x0849 - 0xFFFF
Reserved for future use)
* @param MaxRxOctets The maximum number of payload octets in a Link Layer Data Channel PDU that the local controller expects to receive on this connection (connEfectiveMaxRxOctets defined in [Vol 6] Part B, Section 4.5.10).
Range 0x001B-0x00FB (0x0000 - 0x001A and 0x00FC - 0xFFFF Reserved for future use)
* @param MaxRxTime The maximum time that the local Controller expects to take to receive a Link Layer Data Channel PDU on this connection (connEffectiveMax-RxTime defined in [Vol 6] Part B, Section 4.5.10).
Range 0x0148-0x0848 (0x0000 - 0x0127 and 0x0849 - 0xFFFF Reserved for future use)
* @retval None
*/
WEAK_FUNCTION(void hci_le_data_length_change_event(uint16_t Connection_Handle,
uint16_t MaxTxOctets,
uint16_t MaxTxTime,
uint16_t MaxRxOctets,
uint16_t MaxRxTime));
/**
* @brief This event is generated when local P-256 key generation is complete.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Local_P256_Public_Key Local P-256 public key.
* @retval None
*/
WEAK_FUNCTION(void hci_le_read_local_p256_public_key_complete_event(uint8_t Status,
uint8_t Local_P256_Public_Key[64]));
/**
* @brief This event indicates that LE Diffie Hellman key generation has been completed
by the Controller.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param DHKey Diffie Hellman Key
* @retval None
*/
WEAK_FUNCTION(void hci_le_generate_dhkey_complete_event(uint8_t Status,
uint8_t DHKey[32]));
/**
* @brief The LE Enhanced Connection Complete event indicates to both of the Hosts
forming the connection that a new connection has been created. Upon the
creation of the connection a Connection_Handle shall be assigned by the
Controller, and passed to the Host in this event. If the connection establishment
fails, this event shall be provided to the Host that had issued the
LE_Create_Connection command.
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 Master_Clock_Accuracy parameter is only valid for a slave. On a master,
this parameter shall be set to 0x00.
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Connection_Handle Connection handle to be used to identify the connection with the peer device.
* Values:
- 0x0000 ... 0x0EFF
* @param Role Role of the local device in the connection.
* Values:
- 0x00: Master
- 0x01: Slave
* @param Peer_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)
* Values:
- 0x00: Public Device Address
- 0x01: Random Device Address
- 0x02: Public Identity Address
- 0x03: Random (Static) Identity Address
* @param Peer_Address Public Device Address, Random Device Address, Public Identity
Address or Random (static) Identity Address of the device to be connected.
* @param Local_Resolvable_Private_Address 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.
* @param Peer_Resolvable_Private_Address 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.
* @param Conn_Interval Connection interval used on this connection.
Time = N * 1.25 msec
* Values:
- 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)
* @param Conn_Latency Slave latency for the connection in number of connection events.
* Values:
- 0x0000 ... 0x01F3
* @param Supervision_Timeout Supervision timeout for the LE Link.
It shall be a multiple of 10 ms and larger than (1 + connSlaveLatency) * connInterval * 2.
Time = N * 10 msec.
* Values:
- 0x000A (100 ms) ... 0x0C80 (32000 ms)
* @param Master_Clock_Accuracy Master clock accuracy. Only valid for a slave.
* Values:
- 0x00: 500 ppm
- 0x01: 250 ppm
- 0x02: 150 ppm
- 0x03: 100 ppm
- 0x04: 75 ppm
- 0x05: 50 ppm
- 0x06: 30 ppm
- 0x07: 20 ppm
* @retval None
*/
WEAK_FUNCTION(void hci_le_enhanced_connection_complete_event(uint8_t Status,
uint16_t Connection_Handle,
uint8_t Role,
uint8_t Peer_Address_Type,
uint8_t Peer_Address[6],
uint8_t Local_Resolvable_Private_Address[6],
uint8_t Peer_Resolvable_Private_Address[6],
uint16_t Conn_Interval,
uint16_t Conn_Latency,
uint16_t Supervision_Timeout,
uint8_t Master_Clock_Accuracy));
/**
* @brief The LE Direct Advertising Report 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_Addres is the address the directed
advertisements are being directed to. Address_Type and Address is the
address of the advertiser sending the directed advertisements.
* @param Num_Reports Number of responses in this event.
* Values:
- 0x01
* @param Direct_Advertising_Report See @ref Direct_Advertising_Report_t
* @retval None
*/
WEAK_FUNCTION(void hci_le_direct_advertising_report_event(uint8_t Num_Reports,
Direct_Advertising_Report_t Direct_Advertising_Report[]));
/**
* @}
*/
/**
*@defgroup ACI_GAP_events ACI GAP events
*@brief ACI GAP events layer.
*@{
*/
/* ACI GAP events */
/**
* @brief This event is generated by the controller when the limited discoverable mode ends due to
timeout. The timeout is 180 seconds.
* @retval None
*/
WEAK_FUNCTION(void aci_gap_limited_discoverable_event(void));
/**
* @brief 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.
* @param Connection_Handle Connection handle on which the pairing procedure completed
* @param Status Pairing status
* Values:
- 0x00: Success
- 0x01: Timeout
- 0x02: Failed
* @param Reason Pairing reason error code
* Values:
- 0x00
- 0x01: PASSKEY_ENTRY_FAILED
- 0x02: OOB_NOT_AVAILABLE
- 0x03: AUTH_REQ_CANNOT_BE_MET
- 0x04: CONFIRM_VALUE_FAILED
- 0x05: PAIRING_NOT_SUPPORTED
- 0x06: INSUFF_ENCRYPTION_KEY_SIZE
- 0x07: CMD_NOT_SUPPORTED
- 0x08: UNSPECIFIED_REASON
- 0x09: VERY_EARLY_NEXT_ATTEMPT
- 0x0A: SM_INVALID_PARAMS
- 0x0B: SMP_SC_DHKEY_CHECK_FAILED
- 0x0C: SMP_SC_NUMCOMPARISON_FAILED
* @retval None
*/
WEAK_FUNCTION(void aci_gap_pairing_complete_event(uint16_t Connection_Handle,
uint8_t Status,
uint8_t Reason));
/**
* @brief 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
@ref aci_gap_pass_key_resp command.
* @param Connection_Handle Connection handle for which the passkey has been requested.
* @retval None
*/
WEAK_FUNCTION(void aci_gap_pass_key_req_event(uint16_t Connection_Handle));
/**
* @brief 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,
@ref aci_gap_authorization_resp command should be used to respond by the application.
* @param Connection_Handle Connection handle for which authorization has been requested.
* @retval None
*/
WEAK_FUNCTION(void aci_gap_authorization_req_event(uint16_t Connection_Handle));
/**
* @brief This event is generated when the slave security request is successfully sent to the master.
* @retval None
*/
WEAK_FUNCTION(void aci_gap_slave_security_initiated_event(void));
/**
* @brief This event is generated on the slave when a ACI_GAP_SLAVE_SECURITY_REQUEST is called to reestablish the bond
with a master but the master has lost the bond. When this event is received, the upper layer has to issue the
ACI_GAP_ALLOW_REBOND command in order to allow the slave to continue the pairing process with the master.
On the master this event is raised when ACI_GAP_SEND_PAIRING_REQUEST is called to reestablish a bond with a slave
but the slave has lost the bond. In order to create a new bond the master has to launch ACI_GAP_SEND_PAIRING_REQUEST
with force_rebond set to 1.
* @retval None
*/
WEAK_FUNCTION(void aci_gap_bond_lost_event(void));
/**
* @brief 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
* @param Procedure_Code Terminated procedure.
* Values:
- 0x01: LIMITED_DISCOVERY_PROC
- 0x02: GENERAL_DISCOVERY_PROC
- 0x04: NAME_DISCOVERY_PROC
- 0x08: AUTO_CONNECTION_ESTABLISHMENT_PROC
- 0x10: GENERAL_CONNECTION_ESTABLISHMENT_PROC
- 0x20: SELECTIVE_CONNECTION_ESTABLISHMENT_PROC
- 0x40: DIRECT_CONNECTION_ESTABLISHMENT_PROC
- 0x80: OBSERVATION_PROC
* @param Status For standard error codes see Bluetooth specification, Vol. 2, part D. For proprietary error code refer to Error codes section
* @param Data_Length Length of Data in octets
* @param Data Procedure Specific Data:
- For Name Discovery Procedure: the name of the peer device if the procedure completed successfully.
* @retval None
*/
WEAK_FUNCTION(void aci_gap_proc_complete_event(uint8_t Procedure_Code,
uint8_t Status,
uint8_t Data_Length,
uint8_t Data[]));
/**
* @brief This event is sent only by a privacy enabled Peripheral. The event is sent to the
upper layers when the peripheral is unsuccessful in resolving the resolvable
address of the peer device after connecting to it.
* @param Connection_Handle Connection handle for which the private address could not be
resolved with any of the stored IRK's.
* @retval None
*/
WEAK_FUNCTION(void aci_gap_addr_not_resolved_event(uint16_t Connection_Handle));
/**
* @brief This event is sent only during SC v.4.2 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
@ref aci_gap_numeric_comparison_value_confirm_yesno command
* @param Connection_Handle Connection handle related to the underlying Pairing
* @param Numeric_Value
* @retval None
*/
WEAK_FUNCTION(void aci_gap_numeric_comparison_value_event(uint16_t Connection_Handle,
uint32_t Numeric_Value));
/**
* @brief This event is sent only during SC v.4.2 Pairing, when Keypress Notifications are supported, in order to show the input type signalled by the peer device, having Keyboard only I/O capabilities. When this event is received, no action is required to the User.
* @param Connection_Handle Connection handle related to the underlying Pairing
* @param Notification_Type Type of Keypress input notified/signaled by peer device (having Keyboard only I/O capabilities
* @retval None
*/
WEAK_FUNCTION(void aci_gap_keypress_notification_event(uint16_t Connection_Handle,
uint8_t Notification_Type));
/**
* @}
*/
/**
*@defgroup ACI_GATT_ATT_events ACI GATT/ATT events
*@brief ACI GATT/ATT events layer.
*@{
*/
/* ACI GATT/ATT events */
/** Documentation for C struct Attribute_Group_Handle_Pair_t */
typedef struct Attribute_Group_Handle_Pair_t_s {
/** Found Attribute handle
*/
uint16_t Found_Attribute_Handle;
/** Group End handle
*/
uint16_t Group_End_Handle;
} Attribute_Group_Handle_Pair_t;
/** Documentation for C struct Handle_Item_t */
typedef struct Handle_Item_t_s {
/**
*/
uint16_t Handle;
} Handle_Item_t;
/**
* @brief 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.
* @param Connection_Handle The connection handle which modified the attribute.
* @param Attr_Handle Handle of the attribute that was modified.
* @param Offset SoC mode: the offset is never used and it is always 0. Network coprocessor mode:
- Bits 0-14: offset of the reported value inside the attribute.
- Bit 15: if the entire value of the attribute does not fit inside a single ACI_GATT_ATTRIBUTE_MODIFIED_EVENT event, this bit is set to 1 to notify that other ACI_GATT_ATTRIBUTE_MODIFIED_EVENT events will follow to report the remaining value.
* @param Attr_Data_Length Length of Attr_Data in octets
* @param Attr_Data The modified value
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_attribute_modified_event(uint16_t Connection_Handle,
uint16_t Attr_Handle,
uint16_t Offset,
uint16_t Attr_Data_Length,
uint8_t Attr_Data[]));
/**
* @brief 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 applications is exptected to issue an @ref aci_gap_terminate to disconnect from the peer device. It is important to leave an 100 ms blank window before sending the @ref aci_gap_terminate, since immediately after this event, system could save important information in non volatile memory.
* @param Connection_Handle Connection handle on which the GATT procedure has timed out
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_proc_timeout_event(uint16_t Connection_Handle));
/**
* @brief This event is generated in response to an Exchange MTU request. See
@ref aci_gatt_exchange_config.
* @param Connection_Handle Connection handle related to the response
* @param Server_RX_MTU ATT_MTU value agreed between server and client
* @retval None
*/
WEAK_FUNCTION(void aci_att_exchange_mtu_resp_event(uint16_t Connection_Handle,
uint16_t Server_RX_MTU));
/**
* @brief This event is generated in response to a Find Information Request. See
@ref aci_att_find_info_req and Find Information Response in Bluetooth Core v4.1
spec.
* @param Connection_Handle Connection handle related to the response
* @param Format Format of the hanndle-uuid pairs
* @param Event_Data_Length Length of Handle_UUID_Pair in octets
* @param Handle_UUID_Pair 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]
* @retval None
*/
WEAK_FUNCTION(void aci_att_find_info_resp_event(uint16_t Connection_Handle,
uint8_t Format,
uint8_t Event_Data_Length,
uint8_t Handle_UUID_Pair[]));
/**
* @brief This event is generated in response to a @ref aci_att_find_by_type_value_req
* @param Connection_Handle Connection handle related to the response
* @param Num_of_Handle_Pair Number of attribute, group handle pairs
* @param Attribute_Group_Handle_Pair See @ref Attribute_Group_Handle_Pair_t
* @retval None
*/
WEAK_FUNCTION(void aci_att_find_by_type_value_resp_event(uint16_t Connection_Handle,
uint8_t Num_of_Handle_Pair,
Attribute_Group_Handle_Pair_t Attribute_Group_Handle_Pair[]));
/**
* @brief This event is generated in response to a @ref aci_att_read_by_type_req. See
@ref aci_gatt_find_included_services and @ref aci_gatt_disc_all_char_desc.
* @param Connection_Handle Connection handle related to the response
* @param Handle_Value_Pair_Length The size of each attribute handle-value pair
* @param Data_Length Length of Handle_Value_Pair_Data in octets
* @param Handle_Value_Pair_Data Attribute Data List as defined in Bluetooth Core v4.1 spec. A sequence of handle-value pairs: [2 octets for Attribute Handle, (Handle_Value_Pair_Length - 2 octets) for Attribute Value]
* @retval None
*/
WEAK_FUNCTION(void aci_att_read_by_type_resp_event(uint16_t Connection_Handle,
uint8_t Handle_Value_Pair_Length,
uint8_t Data_Length,
uint8_t Handle_Value_Pair_Data[]));
/**
* @brief This event is generated in response to a Read Request. See @ref aci_gatt_read_char_value.
* @param Connection_Handle Connection handle related to the response
* @param Event_Data_Length Length of following data
* @param Attribute_Value The value of the attribute.
* @retval None
*/
WEAK_FUNCTION(void aci_att_read_resp_event(uint16_t Connection_Handle,
uint8_t Event_Data_Length,
uint8_t Attribute_Value[]));
/**
* @brief This event can be generated during a read long characteristic value procedure. See @ref aci_gatt_read_long_char_value.
* @param Connection_Handle Connection handle related to the response
* @param Event_Data_Length Length of following data
* @param Attribute_Value Part of the attribute value.
* @retval None
*/
WEAK_FUNCTION(void aci_att_read_blob_resp_event(uint16_t Connection_Handle,
uint8_t Event_Data_Length,
uint8_t Attribute_Value[]));
/**
* @brief This event is generated in response to a Read Multiple Request.
* @param Connection_Handle Connection handle related to the response
* @param Event_Data_Length Length of following data
* @param Set_Of_Values 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.
* @retval None
*/
WEAK_FUNCTION(void aci_att_read_multiple_resp_event(uint16_t Connection_Handle,
uint8_t Event_Data_Length,
uint8_t Set_Of_Values[]));
/**
* @brief This event is generated in response to a Read By Group Type Request. See
@ref aci_gatt_disc_all_primary_services.
* @param Connection_Handle Connection handle related to the response
* @param Attribute_Data_Length The size of each attribute data
* @param Data_Length Length of Attribute_Data_List in octets
* @param Attribute_Data_List Attribute Data List as defined in Bluetooth Core v4.1 spec. A sequence of attribute handle, end group handle, attribute value tuples: [2 octets for Attribute Handle, 2 octets End Group Handle, (Attribute_Data_Length - 4 octets) for Attribute Value]
* @retval None
*/
WEAK_FUNCTION(void aci_att_read_by_group_type_resp_event(uint16_t Connection_Handle,
uint8_t Attribute_Data_Length,
uint8_t Data_Length,
uint8_t Attribute_Data_List[]));
/**
* @brief This event is generated in response to a @ref aci_att_prepare_write_req.
* @param Connection_Handle Connection handle related to the response
* @param Attribute_Handle The handle of the attribute to be written
* @param Offset The offset of the first octet to be written.
* @param Part_Attribute_Value_Length Length of Part_Attribute_Value in octets
* @param Part_Attribute_Value The value of the attribute to be written
* @retval None
*/
WEAK_FUNCTION(void aci_att_prepare_write_resp_event(uint16_t Connection_Handle,
uint16_t Attribute_Handle,
uint16_t Offset,
uint8_t Part_Attribute_Value_Length,
uint8_t Part_Attribute_Value[]));
/**
* @brief This event is generated in response to an Execute Write Request.
* @param Connection_Handle Connection handle related to the response
* @retval None
*/
WEAK_FUNCTION(void aci_att_exec_write_resp_event(uint16_t Connection_Handle));
/**
* @brief This event is generated when an indication is received from the server.
* @param Connection_Handle Connection handle related to the response
* @param Attribute_Handle The handle of the attribute
* @param Attribute_Value_Length Length of Attribute_Value in octets
* @param Attribute_Value The current value of the attribute
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_indication_event(uint16_t Connection_Handle,
uint16_t Attribute_Handle,
uint8_t Attribute_Value_Length,
uint8_t Attribute_Value[]));
/**
* @brief This event is generated when a notification is received from the server.
* @param Connection_Handle Connection handle related to the response
* @param Attribute_Handle The handle of the attribute
* @param Attribute_Value_Length Length of Attribute_Value in octets
* @param Attribute_Value The current value of the attribute
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_notification_event(uint16_t Connection_Handle,
uint16_t Attribute_Handle,
uint8_t Attribute_Value_Length,
uint8_t Attribute_Value[]));
/**
* @brief This event is generated when a GATT client procedure completes either with error or
successfully.
* @param Connection_Handle Connection handle related to the response
* @param Error_Code Indicates whether the procedure completed with an error or was successful
* Values:
- 0x00: Success
- 0x01: Unknown HCI Command
- 0x02: Unknown Connection Identifier
- 0x03: Hardware Failure
- 0x04: Page Timeout
- 0x05: Authentication Failure
- 0x06: PIN or Key Missing
- 0x07: Memory Capacity Exceeded
- 0x08: Connection Timeout
- 0x09: Connection Limit Exceeded
- 0x0A: Synchronous Connection Limit to a Device Exceeded
- 0x0B: ACL Connection Already Exists
- 0x0C: Command Disallowed
- 0x0D: Connection Rejected Due To Limited Resources
- 0x0E: Connection Rejected Due To Security Reasons
- 0x0F: Connection Rejected due to Unacceptable BD_ADDR
- 0x10: Connection Accept Timeout Exceeded
- 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
- 0x17: Repeated Attempts
- 0x18: Pairing Not Allowed
- 0x19: Unknown LMP PDU
- 0x1A: Unsupported Remote Feature / Unsupported LMP Feature
- 0x1B: SCO Offset Rejected
- 0x1C: SCO Interval Rejected
- 0x1D: SCO Air Mode Rejected
- 0x1E: Invalid LMP Parameters
- 0x1F: Unspecified Error
- 0x20: Unsupported LMP Parameter Value
- 0x21: Role Change Not Allowed
- 0x22: LMP Response Timeout / LL Response Timeout
- 0x23: LMP Error Transaction Collision
- 0x24: LMP PDU Not Allowed
- 0x25: Encryption Mode Not Acceptable
- 0x26: Link Key cannot be Changed
- 0x27: Requested QoS Not Supported
- 0x28: Instant Passed
- 0x29: Pairing With Unit Key Not Supported
- 0x2A: Different Transaction Collision
- 0x2C: QoS Unacceptable Parameter
- 0x2D: QoS Rejected
- 0x2E: Channel Assessment Not Supported
- 0x2F: Insufficient Security
- 0x30: Parameter Out Of Mandatory Range
- 0x32: Role Switch Pending
- 0x34: Reserved Slot Violation
- 0x35: Role Switch Failed
- 0x36: Extended Inquiry Response Too Large
- 0x37: Secure Simple Pairing Not Supported by Host
- 0x38: Host Busy - Pairing
- 0x39: Connection Rejected due to No Suitable Channel Found
- 0x3A: Controller Busy
- 0x3B: Unacceptable Connection Interval
- 0x3C: Directed Advertising Timeout
- 0x3D: Connection Terminated Due to MIC Failure
- 0x3E: Connection Failed to be Established
- 0x3F: MAC of the 802.11 AMP
- 0x41: Failed
- 0x42: Invalid parameters
- 0x43: Busy
- 0x44: Invalid length
- 0x45: Pending
- 0x46: Not allowed
- 0x47: GATT error
- 0x48: Address not resolved
- 0x50: Invalid CID
- 0x5A: CSRK not found
- 0x5B: IRK not found
- 0x5C: Device not found in DB
- 0x5D: Security DB full
- 0x5E: Device not bonded
- 0x5F: Device in blacklist
- 0x60: Invalid handle
- 0x61: Invalid parameter
- 0x62: Out of handles
- 0x63: Invalid operation
- 0x64: Insufficient resources
- 0x65: Insufficient encryption key size
- 0x66: Characteristic already exist
- 0x82: No valid slot
- 0x83: Short window
- 0x84: New interval failed
- 0x85: Too large interval
- 0x86: Slot length failed
- 0xFA: Flash read failed
- 0xFB: Flash write failed
- 0xFC: Flash erase failed
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_proc_complete_event(uint16_t Connection_Handle,
uint8_t Error_Code));
/**
* @brief 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.
* @param Connection_Handle Connection handle related to the response
* @param Req_Opcode The request that generated this error response
* @param Attribute_Handle The attribute handle that generated this error response
* @param Error_Code The reason why the request has generated an error response (ATT error codes)
* Values:
- 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
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_error_resp_event(uint16_t Connection_Handle,
uint8_t Req_Opcode,
uint16_t Attribute_Handle,
uint8_t Error_Code));
/**
* @brief This event can be generated during a "Discover Characteristics By UUID" procedure or a
"Read using Characteristic UUID" procedure.
The attribute value will be a service declaration as defined in Bluetooth Core v4.1spec
(vol.3, Part G, ch. 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.
* @param Connection_Handle Connection handle related to the response
* @param Attribute_Handle The handle of the attribute
* @param Attribute_Value_Length Length of Attribute_Value in octets
* @param Attribute_Value The attribute value will be a service declaration as defined in Bluetooth Core v4.0 spec
(vol.3, Part G, ch. 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.
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_disc_read_char_by_uuid_resp_event(uint16_t Connection_Handle,
uint16_t Attribute_Handle,
uint8_t Attribute_Value_Length,
uint8_t Attribute_Value[]));
/**
* @brief 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 @ref aci_gatt_write_resp.
The details of the parameters of the command can be found. Based on the response from
the application, the attribute value will be modified by the stack. If the write is rejected by the
application, then the value of the attribute will not be modified. In case of a write REQ, an
error response will be sent to the client, with the error code as specified by the application.
In case of write/signed write commands, no response is sent to the client but the attribute is
not modified.
* @param Connection_Handle Handle of the connection on which there was the request to write the attribute
* @param Attribute_Handle The handle of the attribute
* @param Data_Length Length of Data field
* @param Data The data that the client has requested to write
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_write_permit_req_event(uint16_t Connection_Handle,
uint16_t Attribute_Handle,
uint8_t Data_Length,
uint8_t Data[]));
/**
* @brief 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 has to send the @ref aci_gatt_allow_read command to indicate to the stack that it
can send the response to the client.
* @param Connection_Handle Connection handle related to the response
* @param Attribute_Handle The handle of the attribute
* @param Offset Contains the offset from which the read has been requested
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_read_permit_req_event(uint16_t Connection_Handle,
uint16_t Attribute_Handle,
uint16_t Offset));
/**
* @brief 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 has to send the @ref aci_gatt_allow_read command to indicate to the stack that it
can send the response to the client.
* @param Connection_Handle Handle of the connection which requested to read the attribute
* @param Number_of_Handles
* @param Handle_Item See @ref Handle_Item_t
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_read_multi_permit_req_event(uint16_t Connection_Handle,
uint8_t Number_of_Handles,
Handle_Item_t Handle_Item[]));
/**
* @brief Each time BLE FW stack raises the error code @ref ble_status_insufficient_resources (0x64),
the @ref aci_gatt_tx_pool_available_event event is generated as soon as the available buffer size
is greater than maximum ATT MTU (on stack versions below v2.1 this event is generated when at least 2 packets
with MTU of 23 bytes are available).
* @param Connection_Handle Connection handle related to the request
* @param Available_Buffers Not used.
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_tx_pool_available_event(uint16_t Connection_Handle,
uint16_t Available_Buffers));
/**
* @brief This event is generated when the client has sent the confirmation to a previously sent indication
* @param Connection_Handle Connection handle related to the event
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_server_confirmation_event(uint16_t Connection_Handle));
/**
* @brief 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 @ref aci_gatt_write_resp.
Based on the response from the application, the attribute value will be modified by the stack.
If the write is rejected by the application, then the value of the attribute will not be modified
and an error response will be sent to the client, with the error code as specified by the application.
* @param Connection_Handle Handle of the connection on which there was the request to write the attribute
* @param Attribute_Handle The handle of the attribute
* @param Offset The offset from which the prepare write has been requested
* @param Data_Length Length of Data field
* @param Data The data that the client has requested to write
* @retval None
*/
WEAK_FUNCTION(void aci_gatt_prepare_write_permit_req_event(uint16_t Connection_Handle,
uint16_t Attribute_Handle,
uint16_t Offset,
uint8_t Data_Length,
uint8_t Data[]));
/**
* @}
*/
/**
*@defgroup ACI_L2CAP_events ACI L2CAP events
*@brief ACI L2CAP events layer.
*@{
*/
/* ACI L2CAP events */
/**
* @brief This event is generated when the master responds to the connection update request packet
with a connection update response packet.
* @param Connection_Handle Connection handle referring to the COS Channel where the Disconnection has been received.
* @param Result
* @retval None
*/
WEAK_FUNCTION(void aci_l2cap_connection_update_resp_event(uint16_t Connection_Handle,
uint16_t Result));
/**
* @brief This event is generated when the master does not respond to the connection update
request packet with a connection update response packet or a command reject packet
within 30 seconds.
* @param Connection_Handle Handle of the connection related to this
L2CAP procedure.
* @param Data_Length Length of following data
* @param Data
* @retval None
*/
WEAK_FUNCTION(void aci_l2cap_proc_timeout_event(uint16_t Connection_Handle,
uint8_t Data_Length,
uint8_t Data[]));
/**
* @brief The event is given by the L2CAP layer when a connection update request is received from
the slave. The upper layer which receives this event has to respond by sending a
@ref aci_l2cap_connection_parameter_update_resp command.
* @param Connection_Handle Handle of the connection related to this
L2CAP procedure.
* @param Identifier This is the identifier which associate the request to the
response.
* @param L2CAP_Length Length of the L2CAP connection update request.
* @param Interval_Min Minimum value for the connection event interval. This shall be less
than or equal to Conn_Interval_Max.
Time = N * 1.25 msec.
* Values:
- 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)
* @param Interval_Max Maximum value for the connection event interval. This shall be
greater than or equal to Conn_Interval_Min.
Time = N * 1.25 msec.
* Values:
- 0x0006 (7.50 ms) ... 0x0C80 (4000.00 ms)
* @param Slave_Latency Slave latency for the connection in number of connection events.
* Values:
- 0x0000 ... 0x01F3
* @param Timeout_Multiplier Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms.
* @retval None
*/
WEAK_FUNCTION(void aci_l2cap_connection_update_req_event(uint16_t Connection_Handle,
uint8_t Identifier,
uint16_t L2CAP_Length,
uint16_t Interval_Min,
uint16_t Interval_Max,
uint16_t Slave_Latency,
uint16_t Timeout_Multiplier));
/**
* @brief This event is generated when the master responds to the connection update request packet
with a command reject packet.
* @param Connection_Handle Connection handle referring to the COS Channel where the Disconnection has been received.
* @param Identifier This is the identifier which associate the request to the
response.
* @param Reason Reason
* @param Data_Length Length of following data
* @param Data Data field associated with Reason
* @retval None
*/
WEAK_FUNCTION(void aci_l2cap_command_reject_event(uint16_t Connection_Handle,
uint8_t Identifier,
uint16_t Reason,
uint8_t Data_Length,
uint8_t Data[]));
/**
* @}
*/
/**
*@defgroup ACI_HAL_events ACI HAL events
*@brief ACI HAL events layer.
*@{
*/
/* ACI HAL events */
/**
* @brief This event inform the application that the network coprocessor has been reset. If the reason code is a system crash,
a following event @ref aci_blue_crash_info_event will provide more information regarding the system crash details.
* @param Reason_Code Reason code describing why device was reset and in which mode is operating (Updater or Normal mode)
* Values:
- 0x01: Firmware started properly
- 0x02: Updater mode entered with ACI command
- 0x03: Updater mode entered due to bad Blue Flag
- 0x04: Updater mode entered due to IRQ pin
- 0x05: System reset due to watchdog
- 0x06: System reset due to lockup
- 0x07: System reset due to brownout reset
- 0x08: System reset due to crash
- 0x09: System reset due to ECC error
* @retval None
*/
WEAK_FUNCTION(void aci_blue_initialized_event(uint8_t Reason_Code));
/**
* @brief 'This event is generated when an overflow occurs in the event queue read by the
external microcontroller. This is normally caused when the external microcontroller does
not read pending events. The returned bitmap indicates which event has been lost. Please
note that one bit set to 1 indicates one or more occurrences of the particular events.
The event ACI_BLUE_EVENTS_LOST_EVENT cannot be lost and it will inserted in the
event queue as soon as a position is freed in the event queue. This event should not happen under normal
operating condition where external microcontroller promptly reads events signaled by IRQ pin.
It is provided to detected unexpected behavior of the external microcontroller or to
allow application to recover situations where critical events are lost.
* @param Lost_Events Bitmap of lost events. Each bit indicates one or more occurrences of the specific event.
* Flags:
- 0x0000000000000001: HCI_DISCONNECTION_COMPLETE_EVENT
- 0x0000000000000002: HCI_ENCRYPTION_CHANGE_EVENT
- 0x0000000000000004: HCI_READ_REMOTE_VERSION_INFORMATION_COMPLETE_EVENT
- 0x0000000000000008: HCI_COMMAND_COMPLETE_EVENT
- 0x0000000000000010: HCI_COMMAND_STATUS_EVENT
- 0x0000000000000020: HCI_HARDWARE_ERROR_EVENT
- 0x0000000000000040: HCI_NUMBER_OF_COMPLETED_PACKETS_EVENT
- 0x0000000000000080: HCI_ENCRYPTION_KEY_REFRESH_COMPLETE_EVENT
- 0x0000000000000100: ACI_BLUE_INITIALIZED_EVENT
- 0x0000000000000200: ACI_GAP_LIMITED_DISCOVERABLE_EVENT
- 0x0000000000000400: ACI_GAP_PAIRING_COMPLETE_EVENT
- 0x0000000000000800: ACI_GAP_PASS_KEY_REQ_EVENT
- 0x0000000000001000: ACI_GAP_AUTHORIZATION_REQ_EVENT
- 0x0000000000002000: ACI_GAP_SLAVE_SECURITY_INITIATED_EVENT
- 0x0000000000004000: ACI_GAP_BOND_LOST_EVENT
- 0x0000000000008000: ACI_GAP_PROC_COMPLETE_EVENT
- 0x0000000000010000: ACI_GAP_ADDR_NOT_RESOLVED_EVENT
- 0x0000000000020000: ACI_L2CAP_CONNECTION_UPDATE_RESP_EVENT
- 0x0000000000040000: ACI_L2CAP_PROC_TIMEOUT_EVENT
- 0x0000000000080000: ACI_L2CAP_CONNECTION_UPDATE_REQ_EVENT
- 0x0000000000100000: ACI_GATT_ATTRIBUTE_MODIFIED_EVENT
- 0x0000000000200000: ACI_GATT_PROC_TIMEOUT_EVENT
- 0x0000000000400000: ACI_ATT_EXCHANGE_MTU_RESP_EVENT
- 0x0000000000800000: ACI_ATT_FIND_INFO_RESP_EVENT
- 0x0000000001000000: ACI_ATT_FIND_BY_TYPE_VALUE_RESP_EVENT
- 0x0000000002000000: ACI_ATT_READ_BY_TYPE_RESP_EVENT
- 0x0000000004000000: ACI_ATT_READ_RESP_EVENT
- 0x0000000008000000: ACI_ATT_READ_BLOB_RESP_EVENT
- 0x0000000010000000: ACI_ATT_READ_MULTIPLE_RESP_EVENT
- 0x0000000020000000: ACI_ATT_READ_BY_GROUP_TYPE_RESP_EVENT
- 0x0000000040000000: ACI_ATT_WRITE_RESP_EVENT
- 0x0000000080000000: ACI_ATT_PREPARE_WRITE_RESP_EVENT
- 0x0000000100000000: ACI_ATT_EXEC_WRITE_RESP_EVENT
- 0x0000000200000000: ACI_GATT_INDICATION_EVENT
- 0x0000000400000000: ACI_GATT_NOTIFICATION_EVENT
- 0x0000000800000000: ACI_GATT_PROC_COMPLETE_EVENT
- 0x0000001000000000: ACI_GATT_ERROR_RESP_EVENT
- 0x0000002000000000: ACI_GATT_DISC_READ_CHAR_BY_UUID_RESP_EVENT
- 0x0000004000000000: ACI_GATT_WRITE_PERMIT_REQ_EVENT
- 0x0000008000000000: ACI_GATT_READ_PERMIT_REQ_EVENT
- 0x0000010000000000: ACI_GATT_READ_MULTI_PERMIT_REQ_EVENT
- 0x0000020000000000: ACI_GATT_TX_POOL_AVAILABLE_EVENT
- 0x0000040000000000: ACI_GATT_SERVER_CONFIRMATION_EVENT
- 0x0000080000000000: ACI_GATT_PREPARE_WRITE_PERMIT_REQ_EVENT
- 0x0000100000000000: HCI_LE_CONNECTION_COMPLETE_EVENT
- 0x0000200000000000: HCI_LE_ADVERTISING_REPORT_EVENT
- 0x0000400000000000: HCI_LE_CONNECTION_UPDATE_COMPLETE_EVENT
- 0x0000800000000000: HCI_LE_READ_REMOTE_USED_FEATURES_COMPLETE_EVENT
- 0x0001000000000000: HCI_LE_LONG_TERM_KEY_REQUEST_EVENT
- 0x0002000000000000: HCI_LE_DATA_LENGTH_CHANGE_EVENT
- 0x0004000000000000: HCI_LE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE_EVENT
- 0x0008000000000000: HCI_LE_GENERATE_DHKEY_COMPLETE_EVENT
- 0x0010000000000000: HCI_LE_ENHANCED_CONNECTION_COMPLETE_EVENT
- 0x0020000000000000: HCI_LE_DIRECT_ADVERTISING_REPORT_EVENT
- 0x0040000000000000: ACI_GAP_NUMERIC_COMPARISON_VALUE_EVENT
- 0x0080000000000000: ACI_GAP_KEYPRESS_NOTIFICATION_EVENT
* @retval None
*/
WEAK_FUNCTION(void aci_blue_events_lost_event(uint8_t Lost_Events[8]));
/**
* @brief 'This event is given to the application after the @ref aci_blue_initialized_event
when a system crash is detected. This events returns system crash information for debugging purposes.
Information reported are useful to understand the root cause of the crash.
* @param Crash_Type Crash type
* Values:
- 0x00: Assert failed
- 0x01: NMI fault
- 0x02: Hard fault
* @param SP Stack pointer
* @param R0 Register R0
* @param R1 Register R1
* @param R2 Register R2
* @param R3 Register R3
* @param R12 Register R12
* @param LR Link register
* @param PC Program counter where crash occurred
* @param xPSR xPSR register
* @param Debug_Data_Length Length of Debug_Data field
* @param Debug_Data Debug data
* @retval None
*/
WEAK_FUNCTION(void aci_blue_crash_info_event(uint8_t Crash_Type,
uint32_t SP,
uint32_t R0,
uint32_t R1,
uint32_t R2,
uint32_t R3,
uint32_t R12,
uint32_t LR,
uint32_t PC,
uint32_t xPSR,
uint8_t Debug_Data_Length,
uint8_t Debug_Data[]));
/**
* @brief 'This event is generated when the device completes a radio activity and provide information when a new radio acitivity will be performed.
Informtation provided includes type of radio activity and absolute time in system ticks when a new radio acitivity is schedule, if any. Application can use this information to schedule user activities synchronous to selected radio activitities. A command @ref 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 enablinng 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, switiching antenna at the end of advertising or performing flash erase operation while radio is idle.
* @param Last_State Completed radio events
* Values:
- 0x00: Idle
- 0x01: Advertising
- 0x02: Connection event slave
- 0x03: Scanning
- 0x04: Connection request
- 0x05: Connection event master
- 0x06: TX test mode
- 0x07: RX test mode
* @param Next_State Incoming radio events
* Values:
- 0x00: Idle
- 0x01: Advertising
- 0x02: Connection event slave
- 0x03: Scanning
- 0x04: Connection request
- 0x05: Connection event master
- 0x06: TX test mode
- 0x07: RX test mode
* @param Next_State_SysTime 32bit absolute current time expressed in internal time units.
* @retval None
*/
WEAK_FUNCTION(void aci_hal_end_of_radio_activity_event(uint8_t Last_State,
uint8_t Next_State,
uint32_t Next_State_SysTime));
/**
* @brief This event is reported to the application after a scan request is received and a scan reponse
is scheduled to be transmitted.
* @param RSSI N Size: 1 Octet (signed integer)
Units: dBm
* Values:
- 127: RSSI not available
- -127 ... 20
* @param Peer_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)
* Values:
- 0x00: Public Device Address
- 0x01: Random Device Address
- 0x02: Public Identity Address
- 0x03: Random (Static) Identity Address
* @param Peer_Address Public Device Address or Random Device Address of the peer device
* @retval None
*/
WEAK_FUNCTION(void aci_hal_scan_req_report_event(uint8_t RSSI,
uint8_t Peer_Address_Type,
uint8_t Peer_Address[6]));
/**
* @brief This event is generated to report firmware error informations.
* @param FW_Error_Type FW Error type
* Values:
- 0x01: L2CAP recombination failure
* @param Data_Length Length of Data in octets
* @param Data The error event info
* @retval None
*/
WEAK_FUNCTION(void aci_hal_fw_error_event(uint8_t FW_Error_Type,
uint8_t Data_Length,
uint8_t Data[]));
/**
* @}
*/
#endif /* _BLUENRG1_EVENTS_H_ */