hci_tl.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*!*****************************************************************************
 *  @addtogroup HCI
 *  @{
 *  @file       hci_tl.h
 * @brief Types, constants, external functions etc. for
        the BLE HCI Transport Layer.
 */

#ifndef HCI_TL_H
#define HCI_TL_H

#ifdef __cplusplus
extern "C"
{
#endif

/*******************************************************************************
 * INCLUDES
 */

#include "hci.h"
#include "osal.h"
#include "hci_data.h"
#include "hci_event.h"

extern uint8 hciTaskID;
//
extern uint8 hciTestTaskID;
extern uint8 hciGapTaskID;
extern uint8 hciL2capTaskID;
extern uint8 hciSmpTaskID;

/*******************************************************************************
 * MACROS
 */

#define HCI_ASSERT(condition)  HAL_ASSERT(condition)
 // end of ATT_GATT

/*******************************************************************************
 * CONSTANTS
 */

// OSAL Task Events
#define HCI_TX_PROCESS_EVENT                              0x0001
#define HCI_TEST_UART_SEND_EVENT                          0x0002
#define HCI_ADV_NOTICE_EVENT                              0x0004
#define HCI_SCAN_NOTICE_EVENT                             0x0008
#define HCI_CONN_NOTICE_EVENT                             0x0010
#define HCI_BDADDR_UPDATED_EVENT                          0x4000

// OSAL Message Header Events
#define HCI_CTRL_TO_HOST_EVENT                            0x01
#define HCI_HOST_TO_CTRL_CMD_EVENT                        0x02
#define HCI_HOST_TO_CTRL_DATA_EVENT                       0x03

#define HCI_BDADDR_LEN                                    6

// Max Allowed HCI Packet
#define HCI_MAX_CMD_PKT_SIZE                              0xFF
#define HCI_MAX_DATA_PKT_SIZE                             0xFFFF

// Max Data Length in Packet
#define HCI_DATA_MAX_DATA_LENGTH                          27

//
// Minimum length for CMD packet is 1+2+1
// | Packet Type (1) | OPCode(2) | Length(1) |
//
#define HCI_CMD_MIN_LENGTH                                4

//
// Minimum length for EVENT packet is 1+1+1
// | Packet Type (1) | Event Code(1) | Length(1) |
//
#define HCI_EVENT_MIN_LENGTH                              3

//
// Minimum length for DATA packet is 1+2+2
// | Packet Type (1) | Handler(2) | Length(2) |
//
#define HCI_DATA_MIN_LENGTH                               5

// Max Number of Connections
#define HCI_MAX_NUM_CONNECTIONS                           0x03
//
#define HCI_TX_DATA_ANY_CONNECTION                        0xFF

// HCI Packet Types
#define HCI_CMD_PACKET                                    0x01
#define HCI_ACL_DATA_PACKET                               0x02
#define HCI_SCO_DATA_PACKET                               0x03
#define HCI_EVENT_PACKET                                  0x04


// States for Command and Data packet parser
#define HCI_PARSER_STATE_PKT_TYPE                         0
//
#define HCI_CMD_PARSER_STATE_OPCODE                       1
#define HCI_CMD_PARSER_STATE_LENGTH                       2
#define HCI_CMD_PARSER_STATE_DATA                         3
//
#define HCI_DATA_PARSER_STATE_HANDLE                      4
#define HCI_DATA_PARSER_STATE_LENGTH                      5
#define HCI_DATA_PARSER_STATE_DATA                        6

// HCI Command Subgroup
#define HCI_OPCODE_CSG_LINK_LAYER                         0
#define HCI_OPCODE_CSG_CSG_L2CAP                          1
#define HCI_OPCODE_CSG_CSG_ATT                            2
#define HCI_OPCODE_CSG_CSG_GATT                           3
#define HCI_OPCODE_CSG_CSG_GAP                            4
#define HCI_OPCODE_CSG_CSG_SM                             5
#define HCI_OPCODE_CSG_CSG_Reserved                       6
#define HCI_OPCODE_CSG_CSG_USER_PROFILE                   7

// Vendor Specific OGF
#define VENDOR_SPECIFIC_OGF                               0x3F

/*
** HCI Command Opcodes
*/

// Link Control Commands
#define HCI_DISCONNECT                                    0x0406
#define HCI_READ_REMOTE_VERSION_INFO                      0x041D

// Controller and Baseband Commands
#define HCI_SET_EVENT_MASK                                0x0C01
#define HCI_RESET                                         0x0C03
#define HCI_READ_TRANSMIT_POWER                           0x0C2D
#define HCI_SET_CONTROLLER_TO_HOST_FLOW_CONTROL           0x0C31
#define HCI_HOST_BUFFER_SIZE                              0x0C33
#define HCI_HOST_NUM_COMPLETED_PACKETS                    0x0C35
#define HCI_SET_EVENT_MASK_PAGE_2                         0x0C63
#define HCI_READ_AUTH_PAYLOAD_TIMEOUT                     0x0C7B
#define HCI_WRITE_AUTH_PAYLOAD_TIMEOUT                    0x0C7C

// Information Parameters
#define HCI_READ_LOCAL_VERSION_INFO                       0x1001
#define HCI_READ_LOCAL_SUPPORTED_COMMANDS                 0x1002
#define HCI_READ_LOCAL_SUPPORTED_FEATURES                 0x1003
#define HCI_READ_BDADDR                                   0x1009

// Status Parameters
#define HCI_READ_RSSI                                     0x1405

// LE Commands
// V4.0
#define HCI_LE_SET_EVENT_MASK                             0x2001
#define HCI_LE_READ_BUFFER_SIZE                           0x2002
#define HCI_LE_READ_LOCAL_SUPPORTED_FEATURES              0x2003
#define HCI_LE_SET_RANDOM_ADDR                            0x2005
#define HCI_LE_SET_ADV_PARAM                              0x2006
#define HCI_LE_READ_ADV_CHANNEL_TX_POWER                  0x2007
#define HCI_LE_SET_ADV_DATA                               0x2008
#define HCI_LE_SET_SCAN_RSP_DATA                          0x2009
#define HCI_LE_SET_ADV_ENABLE                             0x200A
#define HCI_LE_SET_SCAN_PARAM                             0x200B
#define HCI_LE_SET_SCAN_ENABLE                            0x200C
#define HCI_LE_CREATE_CONNECTION                          0x200D
#define HCI_LE_CREATE_CONNECTION_CANCEL                   0x200E
#define HCI_LE_READ_WHITE_LIST_SIZE                       0x200F
#define HCI_LE_CLEAR_WHITE_LIST                           0x2010
#define HCI_LE_ADD_WHITE_LIST                             0x2011
#define HCI_LE_REMOVE_WHITE_LIST                          0x2012
#define HCI_LE_CONNECTION_UPDATE                          0x2013
#define HCI_LE_SET_HOST_CHANNEL_CLASSIFICATION            0x2014
#define HCI_LE_READ_CHANNEL_MAP                           0x2015
#define HCI_LE_READ_REMOTE_USED_FEATURES                  0x2016
#define HCI_LE_ENCRYPT                                    0x2017
#define HCI_LE_RAND                                       0x2018
#define HCI_LE_START_ENCRYPTION                           0x2019
#define HCI_LE_LTK_REQ_REPLY                              0x201A
#define HCI_LE_LTK_REQ_NEG_REPLY                          0x201B
#define HCI_LE_READ_SUPPORTED_STATES                      0x201C
#define HCI_LE_RECEIVER_TEST                              0x201D
#define HCI_LE_TRANSMITTER_TEST                           0x201E
#define HCI_LE_TEST_END                                   0x201F
// V4.1
#define HCI_LE_REMOTE_CONN_PARAM_REQ_REPLY                0x2020
#define HCI_LE_REMOTE_CONN_PARAM_REQ_NEG_REPLY            0x2021
// V4.2
#define HCI_LE_SET_DATA_LENGTH                            0x2022
#define HCI_LE_READ_SUGGESTED_DEFAULT_DATA_LENGTH         0x2023
#define HCI_LE_WRITE_SUGGESTED_DEFAULT_DATA_LENGTH        0x2024
#define HCI_LE_READ_LOCAL_P256_PUBLIC_KEY                 0x2025
#define HCI_LE_GENERATE_DHKEY                             0x2026
#define HCI_LE_ADD_DEVICE_TO_RESOLVING_LIST               0x2027
#define HCI_LE_REMOVE_DEVICE_FROM_RESOLVING_LIST          0x2028
#define HCI_LE_CLEAR_RESOLVING_LIST                       0x2029
#define HCI_LE_READ_RESOLVING_LIST_SIZE                   0x202A
#define HCI_LE_READ_PEER_RESOLVABLE_ADDRESS               0x202B
#define HCI_LE_READ_LOCAL_RESOLVABLE_ADDRESS              0x202C
#define HCI_LE_SET_ADDRESS_RESOLUTION_ENABLE              0x202D
#define HCI_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT     0x202E
#define HCI_LE_READ_MAX_DATA_LENGTH                       0x202F
// V5.0
#define HCI_LE_READ_PHY                                   0x2030
#define HCI_LE_SET_DEFAULT_PHY                            0x2031
#define HCI_LE_SET_PHY                                    0x2032
#define HCI_LE_ENHANCED_RECEIVER_TEST                     0x2033
#define HCI_LE_ENHANCED_TRANSMITTER_TEST                  0x2034

// LE Vendor Specific LL Extension Commands
#define HCI_EXT_SET_RX_GAIN                               0xFC00
#define HCI_EXT_SET_TX_POWER                              0xFC01
#define HCI_EXT_ONE_PKT_PER_EVT                           0xFC02
#define HCI_EXT_CLK_DIVIDE_ON_HALT                        0xFC03
#define HCI_EXT_DECLARE_NV_USAGE                          0xFC04
#define HCI_EXT_DECRYPT                                   0xFC05
#define HCI_EXT_SET_LOCAL_SUPPORTED_FEATURES              0xFC06
#define HCI_EXT_SET_FAST_TX_RESP_TIME                     0xFC07
#define HCI_EXT_MODEM_TEST_TX                             0xFC08
#define HCI_EXT_MODEM_HOP_TEST_TX                         0xFC09
#define HCI_EXT_MODEM_TEST_RX                             0xFC0A
#define HCI_EXT_END_MODEM_TEST                            0xFC0B
#define HCI_EXT_SET_BDADDR                                0xFC0C
#define HCI_EXT_SET_SCA                                   0xFC0D
#define HCI_EXT_ENABLE_PTM                                0xFC0E // Not a supported HCI command! Application only.
#define HCI_EXT_SET_FREQ_TUNE                             0xFC0F
#define HCI_EXT_SAVE_FREQ_TUNE                            0xFC10
#define HCI_EXT_SET_MAX_DTM_TX_POWER                      0xFC11
#define HCI_EXT_MAP_PM_IO_PORT                            0xFC12
#define HCI_EXT_DISCONNECT_IMMED                          0xFC13
#define HCI_EXT_PER                                       0xFC14
#define HCI_EXT_PER_BY_CHAN                               0xFC15 // Not a supported HCI command! Application only.
#define HCI_EXT_EXTEND_RF_RANGE                           0xFC16
#define HCI_EXT_ADV_EVENT_NOTICE                          0xFC17 // Not a supported HCI command! Application only.
#define HCI_EXT_CONN_EVENT_NOTICE                         0xFC18 // Not a supported HCI command! Application only.
#define HCI_EXT_HALT_DURING_RF                            0xFC19
#define HCI_EXT_OVERRIDE_SL                               0xFC1A
#define HCI_EXT_BUILD_REVISION                            0xFC1B
#define HCI_EXT_DELAY_SLEEP                               0xFC1C
#define HCI_EXT_RESET_SYSTEM                              0xFC1D
#define HCI_EXT_OVERLAPPED_PROCESSING                     0xFC1E
#define HCI_EXT_NUM_COMPLETED_PKTS_LIMIT                  0xFC1F
#define HCI_EXT_GET_CONNECTION_INFO                       0xFC20
#define HCI_EXT_SET_MAX_DATA_LENGTH                       0xFC21
#define HCI_EXT_SCAN_EVENT_NOTICE                         0xFC22 // Not a supported HCI command! Application only.
#define HCI_EXT_SCAN_REQ_REPORT                           0xFC23
#
#define HCI_EXT_LL_TEST_MODE                              0xFC70

/*
** HCI Event Codes
*/

// BT Events
#define HCI_DISCONNECTION_COMPLETE_EVENT_CODE             0x05 
#define HCI_ENCRYPTION_CHANGE_EVENT_CODE                  0x08 
#define HCI_READ_REMOTE_INFO_COMPLETE_EVENT_CODE          0x0C 
#define HCI_COMMAND_COMPLETE_EVENT_CODE                   0x0E 
#define HCI_COMMAND_STATUS_EVENT_CODE                     0x0F 
#define HCI_BLE_HARDWARE_ERROR_EVENT_CODE                 0x10 
#define HCI_NUM_OF_COMPLETED_PACKETS_EVENT_CODE           0x13 
#define HCI_DATA_BUFFER_OVERFLOW_EVENT                    0x1A 
#define HCI_KEY_REFRESH_COMPLETE_EVENT_CODE               0x30 
#define HCI_APTO_EXPIRED_EVENT_CODE                       0x57 

// LE Event Code (for LE Meta Events)
#define HCI_LE_EVENT_CODE                                 0x3E

// LE Meta Event Codes
#define HCI_BLE_CONNECTION_COMPLETE_EVENT                 0x01
#define HCI_BLE_ADV_REPORT_EVENT                          0x02
#define HCI_BLE_CONN_UPDATE_COMPLETE_EVENT                0x03
#define HCI_BLE_READ_REMOTE_FEATURE_COMPLETE_EVENT        0x04
#define HCI_BLE_LTK_REQUESTED_EVENT                       0x05
// V4.1
#define HCI_BLE_REMOTE_CONN_PARAM_REQUEST_EVENT           0x06
// V4.2
#define HCI_BLE_DATA_LENGTH_CHANGE_EVENT                  0x07
#define HCI_BLE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE_EVENT 0x08
#define HCI_BLE_GENERATE_DHKEY_COMPLETE_EVENT             0x09
#define HCI_BLE_ENHANCED_CONNECTION_COMPLETE_EVENT        0x0A
#define HCI_BLE_DIRECT_ADVERTISING_REPORT_EVENT           0x0B
// V5.0
#define HCI_BLE_PHY_UPDATE_COMPLETE_EVENT                 0x0C
// VS Meta Event Codes - Texas Instruments Inc specific!
#define HCI_BLE_SCAN_REQ_REPORT_EVENT                     0x80

// Vendor Specific Event Code
#define HCI_VE_EVENT_CODE                                 0xFF

// LE Vendor Specific LL Extension Events
#define HCI_EXT_SET_RX_GAIN_EVENT                         0x0400
#define HCI_EXT_SET_TX_POWER_EVENT                        0x0401
#define HCI_EXT_ONE_PKT_PER_EVT_EVENT                     0x0402
#define HCI_EXT_CLK_DIVIDE_ON_HALT_EVENT                  0x0403
#define HCI_EXT_DECLARE_NV_USAGE_EVENT                    0x0404
#define HCI_EXT_DECRYPT_EVENT                             0x0405
#define HCI_EXT_SET_LOCAL_SUPPORTED_FEATURES_EVENT        0x0406
#define HCI_EXT_SET_FAST_TX_RESP_TIME_EVENT               0x0407
#define HCI_EXT_MODEM_TEST_TX_EVENT                       0x0408
#define HCI_EXT_MODEM_HOP_TEST_TX_EVENT                   0x0409
#define HCI_EXT_MODEM_TEST_RX_EVENT                       0x040A
#define HCI_EXT_END_MODEM_TEST_EVENT                      0x040B
#define HCI_EXT_SET_BDADDR_EVENT                          0x040C
#define HCI_EXT_SET_SCA_EVENT                             0x040D
#define HCI_EXT_ENABLE_PTM_EVENT                          0x040E // Not a supported HCI command! Application only.
#define HCI_EXT_SET_FREQ_TUNE_EVENT                       0x040F
#define HCI_EXT_SAVE_FREQ_TUNE_EVENT                      0x0410
#define HCI_EXT_SET_MAX_DTM_TX_POWER_EVENT                0x0411
#define HCI_EXT_MAP_PM_IO_PORT_EVENT                      0x0412
#define HCI_EXT_DISCONNECT_IMMED_EVENT                    0x0413
#define HCI_EXT_PER_EVENT                                 0x0414
#define HCI_EXT_PER_BY_CHAN_EVENT                         0x0415 // Not a supported HCI command! Application only.
#define HCI_EXT_EXTEND_RF_RANGE_EVENT                     0x0416
#define HCI_EXT_ADV_EVENT_NOTICE_EVENT                    0x0417 // Not a supported HCI command! Application only.
#define HCI_EXT_CONN_EVENT_NOTICE_EVENT                   0x0418 // Not a supported HCI command! Application only.
#define HCI_EXT_HALT_DURING_RF_EVENT                      0x0419
#define HCI_EXT_OVERRIDE_SL_EVENT                         0x041A
#define HCI_EXT_BUILD_REVISION_EVENT                      0x041B
#define HCI_EXT_DELAY_SLEEP_EVENT                         0x041C
#define HCI_EXT_RESET_SYSTEM_EVENT                        0x041D
#define HCI_EXT_OVERLAPPED_PROCESSING_EVENT               0x041E
#define HCI_EXT_NUM_COMPLETED_PKTS_LIMIT_EVENT            0x041F
#define HCI_EXT_GET_CONNECTION_INFO_EVENT                 0x0420
#define HCI_EXT_SET_MAX_DATA_LENGTH_EVENT                 0x0421
#define HCI_EXT_SCAN_EVENT_NOTICE_EVENT                   0x0422 // Not a supported HCI command! Application only.
#define HCI_EXT_SCAN_REQ_REPORT_EVENT                     0x0423
#
#define HCI_EXT_LL_TEST_MODE_EVENT                        0x0470

 // end of HCI_Constants

/*******************************************************************************
 * TYPEDEFS
 */

/*******************************************************************************
 * LOCAL VARIABLES
 */

/*******************************************************************************
 * GLOBAL VARIABLES
 */

/*
** HCI OSAL API
*/

/*******************************************************************************
 * @fn          HCI_Init
 *
 * @brief       This is the HCI OSAL task initialization routine.
 *
 * input parameters
 *
 * @param       taskID - The HCI OSAL task identifier.
 *
 * output parameters
 *
 * @param       None.
 *
 * @return      None.
 */
extern void HCI_Init( uint8 taskID );


/*******************************************************************************
 * @fn          HCI_TL_getCmdResponderID
 *
 * @brief       Used by application to intercept and handle HCI TL events and
 *              messages
 *
 * input parameters
 *
 * @param       taskID - The HCI OSAL task identifier.
 *
 * output parameters
 *
 * @param       None.
 *
 * @return      None.
 */
extern void HCI_TL_getCmdResponderID( uint8 taskID );


/*******************************************************************************
 * @fn          HCI_ProcessEvent
 *
 * @brief       This is the HCI OSAL task process event handler.
 *
 * input parameters
 *
 * @param       taskID - The HCI OSAL task identifier.
 * @param       events - HCI OSAL task events.
 *
 * output parameters
 *
 * @param       None.
 *
 * @return      Unprocessed events.
 */
extern uint16 HCI_ProcessEvent( uint8  task_id,
                                uint16 events );


#ifdef __cplusplus
}
#endif

#endif /* HCI_TL_H */