LiJie
/
MXC-A36-Demo
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
MXC-A36-Demo/MCU/components/btdm/include/me_api.h

4190 lines
161 KiB
C
Raw Normal View History

demo工程暂存 优化菜单界面UI和功能
2024-04-29 16:32:24 +08:00
#ifndef __ME_API_H
#define __ME_API_H
#include "btconfig.h"
#include "bt_types.h"
//#include "type_lib.h"
/*---------------------------------------------------------------------------
* Management Entity (ME) layer
*
* The Management Entity allows applications to inquire for
* remote devices, establish different types of connections, and
* control the access to this device by other devices.
*/
/****************************************************************************
*
* Constants
*
****************************************************************************/
/*---------------------------------------------------------------------------
* BT_INQ_TIME_GAP100 constant
* Time value specified by Generic Access Profile for the length
* of an Inquiry process.
*/
#define BT_INQ_TIME_GAP100 8
/*---------------------------------------------------------------------------
* BT_MAX_REM_DEV_NAME constant
*
* Maximum length of a Remote Device name (friendly name) allowed by
* Bluetooth. This does not include the null termination at the end.
*/
#define BT_MAX_REM_DEV_NAME 248
/*---------------------------------------------------------------------------
*
* The following are used to indicate the use of default values for Window
* and interval used in inquiry and page scanning. The default values are
* the default values of the radio module being used. These values should
* within the range defined by the Generic Access Profile.
*/
#define BT_DEFAULT_SCAN_INTERVAL 0x0000
#define BT_DEFAULT_SCAN_WINDOW 0x0000
/*---------------------------------------------------------------------------
* BT_INVALID_RSSI constant
*
* Indicates an invalid RSSI value (used when RSSI is not reported
* by the controller).
*/
#define BT_INVALID_RSSI 127
/****************************************************************************
*
* Types
*
****************************************************************************/
/*---------------------------------------------------------------------------
* BtEventType type
*
* All indications and confirmations are sent through a callback
* function. The event types are defined below.
*/
typedef uint8_t BtEventType;
/* Group: Global events sent to all handlers. These can be masked out if
* desired.
*/
/** A remote device is found. "p.inqResult" is valid. */
#define BTEVENT_INQUIRY_RESULT 1
/** The Inquiry process is completed. "errCode" is valid. */
#define BTEVENT_INQUIRY_COMPLETE 2
/** The Inquiry process is canceled. */
#define BTEVENT_INQUIRY_CANCELED 3
/** An incoming ACL connection. "p.remDev" is valid. */
#define BTEVENT_LINK_CONNECT_IND 4
/** An incoming SCO connection. "p.scoConnect" is valid. */
#define BTEVENT_SCO_CONNECT_IND 5
/** An ACL connection was disconnected. "p.disconnect" is valid, and
* "errCode" may be valid (see documentation for the "disconnect" union for
* details. */
#define BTEVENT_LINK_DISCONNECT 6
/* An outgoing ACL connection is up. "p.remDev" and "p.errCode" are valid. */
#define BTEVENT_LINK_CONNECT_CNF 7
/** A restricted connection is up. "p.remDev" is valid. */
#define BTEVENT_LINK_CON_RESTRICT 8
/** Indicates the mode of the link changed. "p.modeChange" is valid */
#define BTEVENT_MODE_CHANGE 9
/** Indicates that an accessibility change is complete. "errCode" and
* "p.aMode" are valid. */
#define BTEVENT_ACCESSIBLE_CHANGE 10
/** Indicates that a link has been authenticated. "p.remDev" is valid. */
#define BTEVENT_AUTHENTICATED 11
/** Encryption settings have changed. "p.encrypt" is valid. */
#define BTEVENT_ENCRYPTION_CHANGE 12
/** Security mode has changed. "p.secMode" is valid. */
#define BTEVENT_SECURITY_CHANGE 13
/** Indicates that a role change has occurred */
#define BTEVENT_ROLE_CHANGE 14
/** SCO link has been disconnected. "p.scoConnect" is valid. */
#define BTEVENT_SCO_DISCONNECT 15
/** An outgoing SCO link has been established. "p.scoConnect" is valid. */
#define BTEVENT_SCO_CONNECT_CNF 16
/** Simple Pairing Mode completed. "errCode" and "p.bdAddr"
* are valid */
#define BTEVENT_SIMPLE_PAIRING_COMPLETE 17
/** Returned after each ACL connection is established to a remote device
* "p.remoteFeatures" is valid.
*/
#define BTEVENT_REMOTE_FEATURES 18
/* Remote Host Supported Features. Returned by 2.1 (Lisbon) radios before
* each Remote Name Request response. Also, returned after each ACL
* connection is established to a remote device "p.remHostFeatures" is valid.
*/
#define BTEVENT_REM_HOST_FEATURES 19
/** Link Supervision Timeout Changed. "p.linkSupervision" is valid.
*/
#define BTEVENT_LINK_SUPERV_TIMEOUT_CHANGED 20
/** Sniff Subrating parameters have been set.
* "p.sniffSubrateParms" is valid. This event occurs as the
* result of a call to ME_SetSniffSubratingParms(). When Sniff
* Subrating is enabled on the connection, the
* BTEVENT_SNIFF_SUBRATE_INFO event will be received.
*/
#define BTEVENT_SET_SNIFF_SUBRATING_PARMS_CNF 21
/** Sniff Subrating has been enabled (or re-negotiated) on the
* specified connection. "p.sniffSubrateInfo" is valid.
*/
#define BTEVENT_SNIFF_SUBRATE_INFO 22
/** The inquiry mode has been set. "p.inqMode" is valid. */
#define BTEVENT_SET_INQUIRY_MODE_CNF 23
/** The inquiry TX power level has been set. "p.inqTxPwr" is valid.
*/
#define BTEVENT_SET_INQ_TX_PWR_LVL_CNF 24
/** The extended inquiry response has been set. */
#define BTEVENT_SET_EXT_INQUIRY_RESP_CNF 25
/** The erroneous data reporting state has been set */
#define BTEVENT_SET_ERR_DATA_REPORTING_CNF 26
/** A Keypress event was received during simple pairing. "p.keyPress" is
* valid.
*/
#define BTEVENT_KEY_PRESSED 27
/** A QOS Setup Complete event was received "p.qos" is valid */
#define BTEVENT_QOS_SETUP_COMPLETE 28
/* Group: The following events are global events but cannot be masked */
/** Indicates that an ACL connection has received an internal data transmit
* request while it is in hold, park or sniff mode. The data will still be
* passed to the radio in park and sniff modes. However, hold mode will
* block data transmit. It may be necessary to return the ACL to active
* mode to restore normal data transfer. "p.remDev" is valid.
*/
#define BTEVENT_ACL_DATA_NOT_ACTIVE 99
/** Indicates that the HCI failed to initialize. This implies that the
* Bluetooth radio is having problems or a radio may not exist.
* Events will be generated with an appropriate error code for any outstanding
* operations. All pending operations that use pointers to memory supplied by
* applications will have a corresponding event generated indicating the
* failure of the operation. Applications should not modify memory passed as
* part of operations until an event signaling the end of the operation
* has been received. The HCI and the radio will be reset. If the reset is
* successful then the BTEVENT_HCI_INITIALIZED event will be sent to all
* registered handlers.
*/
#define BTEVENT_HCI_INIT_ERROR 100
/** Indicates that the HCI initialization is successful. The ME will now
* accept commands again if an initialization error or fatal error
* has occurred. This event is sent whenever HCI is successfully initialized,
* including when the stack is first started.
*/
#define BTEVENT_HCI_INITIALIZED 101
/** Indicates that a fatal error has occurred in the radio or the HCI transport.
* The HCI and the radio will be reset. If the reset is successful then the
* BTEVENT_HCI_INITIALIZED event will be sent to all registered handlers.
*/
#define BTEVENT_HCI_FATAL_ERROR 102
/** Indicates that the HCI has been deinitialized. This can happen as the
* result of a call to ME_RadioShutdown, or if some fatal error was reported
* by the radio or HCI transport. For any pending operations, events will
* be received with proper error codes prior to receiving this event.
* All pending commands that used memory supplied by the application will
* result in an event, so the application should not modify that memory until
* the event has been received. If the HCI was deinitialized as the result of
* a radio or transport error, the HCI will be reset. If the reset is
* successful then the BTEVENT_HCI_INITIALIZED event will be sent to all
* registered handlers.
*/
#define BTEVENT_HCI_DEINITIALIZED 103
/** Indicates that the HCI cannot be initialized. This happens when
* the HCI has been reset BT_HCI_NUM_INIT_RETRIES without success or
* if some unrecoverable error occurs.
*/
#define BTEVENT_HCI_FAILED 104
/** Indicates that an HCI command has been sent to the radio. This
* event is intended for global handlers that would like to be informed
* of when certain radio processes are started. "p.hciCmd" is valid.
*/
#define BTEVENT_HCI_COMMAND_SENT 105
/* An outgoing create link has been canceled. "p.remDev" is valid. */
#define BTEVENT_LINK_CREATE_CANCEL 106
/* Group: These events are sent only to the handler that initiated the
* operation.
*/
/** Indicates the name of a remote device or cancellation of a name request.
* "p.meToken" is valid.
*/
#define BTEVENT_NAME_RESULT 30
/** Incoming SCO data has been received. Fields in "p.scoDataInd" are valid
* and describe the data received. This data is valid only for the duration
* of the callback.
*/
#define BTEVENT_SCO_DATA_IND 31
/** Outgoing SCO data has been sent and the packet is free for re-use by
* the application. "p.scoPacketHandled.scoPacket" and
* "p.scoPacketHandled.scoCon" are valid.
*/
#define BTEVENT_SCO_DATA_CNF 32
/** Incoming connection request. "p.remDev" is valid. */
#define BTEVENT_LINK_CONNECT_REQ 33
/** Incoming link accept complete. "p.remDev" is valid. */
#define BTEVENT_LINK_ACCEPT_RSP 34
/** Incoming link reject complete. "p.remDev" is valid. */
#define BTEVENT_LINK_REJECT_RSP 35
/** General command (async or sync) has completed. "p.meToken" is valid */
#define BTEVENT_COMMAND_COMPLETE 36
/** Incoming connection request. "p.scoConnect" is valid. The field
* "p.scoConnect.scoLinkType" indicates the SCO link type (BLT_SCO or
* BLT_ESCO.) When the link is of type BLT_ESCO, the fields
* p.scoConnect.scoTxParms and p.scoConnect.scoRxParms point to the
* associated eSCO connection parameters.
*/
#define BTEVENT_SCO_CONNECT_REQ 37
/** Set Audio/Voice settings complete. */
#define BTEVENT_SCO_VSET_COMPLETE 38
/** SCO link connection process started. */
#define BTEVENT_SCO_STARTED 39
/** Select Device operation complete, "p.select" is valid. */
#define BTEVENT_DEVICE_SELECTED 40
/** The eSCO connection has changed. "p.scoConnect" is valid.
* The structure "p.scoConnect.scoRxParms" contains the updated
* connection parameters.
*/
#define BTEVENT_SCO_CONN_CHNG 41
/* Group: Security-related events. */
/** Indicates access request is successful. "p.secToken" is valid. */
#define BTEVENT_ACCESS_APPROVED 50
/** Indicates access request failed. "p.secToken" is valid. */
#define BTEVENT_ACCESS_DENIED 51
/** Request authorization when "errCode" is BEC_NO_ERROR.
* "p.remDev" is valid.
*/
#define BTEVENT_AUTHORIZATION_REQ 52
/** Request a Pin for pairing when "errCode" is BEC_NO_ERROR.
* "p.pinReq" is valid. If p.pinReq.pinLen is > 0 then SEC_SetPin()
* must be called in response to this event with a pin length >=
* p.pinReq.pinLen.
*/
#define BTEVENT_PIN_REQ 53
/** Pairing operation is complete. When the pairing is complete, a link key
* is generated and received from the controller. This event includes
* information about the type of link key that was created. With Secure
* Simple Pairing, it is possible that an unauthenticated link key will be
* created when MITM protection was requested (depending on the IO
* capabilities of the remote device). Also, if Secure Simple Pairing is in
* debug mode (see SEC_SetSimplePairingDebugMode()), fixed private/public
* keys pairs are used, which present a security risk.
*
* The application can take the appropriate action when the link key is not
* as strong as required. If the link key type is not satisfactory, the
* application should disconnect the link with an BEC_AUTHENTICATE_FAILURE
* error code. The 'p.pairingInfo' parameter is valid during this event.
*/
#define BTEVENT_PAIRING_COMPLETE 54
/** Authentication operation complete. "p.remDev" is valid. */
#define BTEVENT_AUTHENTICATE_CNF 55
/** Encryption operation complete. "p.remDev" is valid. */
#define BTEVENT_ENCRYPT_COMPLETE 56
/** Security mode 3 operation complete. "p.secMode" is valid. */
#define BTEVENT_SECURITY3_COMPLETE 57
/** A link key is returned. "p.bdLinkKey" is valid. */
#define BTEVENT_RETURN_LINK_KEYS 58
/** Out of Band data has been received from the host controller. "p.oobData"
* is valid. This data should be transmitted to the remote device using an
* out of band mechanism. */
#define BTEVENT_LOCAL_OOB_DATA 59
/** Request a Pass Key for simple pairing when "errCode" is BEC_NO_ERROR. The
* application should call SEC_SetPassKey() to provide the passkey or reject
* the request, and optionally save the link key. "p.userIoReq" is valid.
*/
#define BTEVENT_PASS_KEY_REQ 60
/** Request a User Confirmation for simple pairing when "errCode" is
* BEC_NO_ERROR. The application should call SEC_UserConfirm() to confirm or
* reject this request, and optionally save the link key. "p.userIoReq" is
* valid.
*/
#define BTEVENT_CONFIRM_NUMERIC_REQ 61
/** Indicate that a numeric value must be displayed so that the
* remote device can enter it, or verify a provided numeric
* value. The application should display the numeric value
* provided and clear the display once authentication has
* completed. The link key is automatically saved when either
* device is in bonding mode. "p.userIoReq" is valid.
*/
#define BTEVENT_DISPLAY_NUMERIC_IND 62
/** Indicates that a connection packet type change event has occurred.
* "p.packetTypeChng" is valid */
#define BTEVENT_CONN_PACKET_TYPE_CHNG 63
/* Group: SDP Query related events. In all cases, the "p.token" parameter
* is valid.
*/
/** SDP query completed successfully. The token should be examined for further
* information about query results.
*/
#define SDEVENT_QUERY_RSP 70
/** SDP query completed with an error. The token's "errorCode" member
* describes the error.
*/
#define SDEVENT_QUERY_ERR 71
/** SDP query failed. "errCode" describes the reason for query failure. */
#define SDEVENT_QUERY_FAILED 72
/* Group: Device Selection monitor events. These events are only sent to
* the device selection handler.
*/
/** Request device selection, "p.select" is valid. The device selection
* monitor must call DS_SelectDeviceResult() to return the provided
* selection request when the selection process is complete.
*/
#define BTEVENT_SELECT_DEVICE_REQ 80
/** Device added to the device database, "p.device" is valid. Note that
* during a device inquiry, BTEVENT_DEVICE_ADDED event may not mirror
* BTEVENT_INQUIRY_RESULT events. This is because duplicate devices are
* not added to the device database and because the device database may
* reach capacity, preventing the addition of new devices.
*/
#define BTEVENT_DEVICE_ADDED 81
/** Device removed from the device database, "p.device" is valid. */
#define BTEVENT_DEVICE_DELETED 82
/* End of BtEventType */
/*---------------------------------------------------------------------------
* BtEventMask type
*
* All registered handlers can receive global events. Each handler has
* the ability to mask all or some of the events. A handler receives only
* events with the mask set. They can be ORed together.
*/
typedef uint32_t BtEventMask;
#define BEM_NO_EVENTS 0x00000000
#define BEM_INQUIRY_RESULT 0x00000001
#define BEM_INQUIRY_COMPLETE 0x00000002
#define BEM_INQUIRY_CANCELED 0x00000004
#define BEM_LINK_CONNECT_IND 0x00000008
#define BEM_SCO_CONNECT_IND 0x00000010
#define BEM_LINK_DISCONNECT 0x00000020
#define BEM_LINK_CONNECT_CNF 0x00000040
#define BEM_LINK_CON_RESTRICT 0x00000080
#define BEM_MODE_CHANGE 0x00000100
#define BEM_ACCESSIBLE_CHANGE 0x00000200
#define BEM_AUTHENTICATED 0x00000400
#define BEM_ENCRYPTION_CHANGE 0x00000800
#define BEM_SECURITY_CHANGE 0x00001000
#define BEM_ROLE_CHANGE 0x00002000
#define BEM_SCO_DISCONNECT 0x00004000
#define BEM_SCO_CONNECT_CNF 0x00008000
#define BEM_SIMPLE_PAIRING_COMPLETE 0x00010000
#define BEM_REMOTE_FEATURES 0x00020000
#define BEM_REM_HOST_FEATURES 0x00040000
#define BEM_LINK_SUPERV_TIMEOUT_CHANGED 0x00080000
#define BEM_SET_SNIFF_SUBR_PARMS 0x00100000
#define BEM_SNIFF_SUBRATE_INFO 0x00200000
#define BEM_SET_INQ_MODE 0x00400000
#define BEM_SET_INQ_RSP_TX_PWR 0x00800000
#define BEM_SET_EXT_INQ_RESP 0x01000000
#define BEM_SET_ERR_DATA_REP 0x02000000
#define BEM_KEY_PRESSED 0x04000000
#define BEM_CONN_PACKET_TYPE_CHNG 0x08000000
#define BEM_QOS_SETUP_COMPLETE 0x10000000
#define BEM_ALL_EVENTS 0xffffffff
/* End of BtEventMask */
/*---------------------------------------------------------------------------
* BtErrorCode type
*/
typedef uint8_t BtErrorCode;
#define BEC_NO_ERROR 0x00 /* No error */
#define BEC_UNKNOWN_HCI_CMD 0x01 /* Unknown HCI Command */
#define BEC_NO_CONNECTION 0x02 /* No connection */
#define BEC_HARDWARE_FAILURE 0x03 /* Hardware Failure */
#define BEC_PAGE_TIMEOUT 0x04 /* Page timeout */
#define BEC_AUTHENTICATE_FAILURE 0x05 /* Authentication failure */
#define BEC_MISSING_KEY 0x06 /* Missing key */
#define BEC_MEMORY_FULL 0x07 /* Memory full */
#define BEC_CONNECTION_TIMEOUT 0x08 /* Connection timeout */
#define BEC_MAX_CONNECTIONS 0x09 /* Max number of connections */
#define BEC_MAX_SCO_CONNECTIONS 0x0a /* Max number of SCO connections to a device */
#define BEC_ACL_ALREADY_EXISTS 0x0b /* The ACL connection already exists. */
#define BEC_COMMAND_DISALLOWED 0x0c /* Command disallowed */
#define BEC_LIMITED_RESOURCE 0x0d /* Host rejected due to limited resources */
#define BEC_SECURITY_ERROR 0x0e /* Host rejected due to security reasons */
#define BEC_PERSONAL_DEVICE 0x0f /* Host rejected (remote is personal device) */
#define BEC_HOST_TIMEOUT 0x10 /* Host timeout */
#define BEC_UNSUPPORTED_FEATURE 0x11 /* Unsupported feature or parameter value */
#define BEC_INVALID_HCI_PARM 0x12 /* Invalid HCI command parameters */
#define BEC_USER_TERMINATED 0x13 /* Other end terminated (user) */
#define BEC_LOW_RESOURCES 0x14 /* Other end terminated (low resources) */
#define BEC_POWER_OFF 0x15 /* Other end terminated (about to power off) */
#define BEC_LOCAL_TERMINATED 0x16 /* Terminated by local host */
#define BEC_REPEATED_ATTEMPTS 0x17 /* Repeated attempts */
#define BEC_PAIRING_NOT_ALLOWED 0x18 /* Pairing not allowed */
#define BEC_UNKNOWN_LMP_PDU 0x19 /* Unknown LMP PDU */
#define BEC_UNSUPPORTED_REMOTE 0x1a /* Unsupported Remote Feature */
#define BEC_SCO_OFFSET_REJECT 0x1b /* SCO Offset Rejected */
#define BEC_SCO_INTERVAL_REJECT 0x1c /* SCO Interval Rejected */
#define BEC_SCO_AIR_MODE_REJECT 0x1d /* SCO Air Mode Rejected */
#define BEC_INVALID_LMP_PARM 0x1e /* Invalid LMP Parameters */
#define BEC_UNSPECIFIED_ERR 0x1f /* Unspecified Error */
#define BEC_UNSUPPORTED_LMP_PARM 0x20 /* Unsupported LMP Parameter Value */
#define BEC_ROLE_CHG_NOT_ALLOWED 0x21 /* Role Change Not Allowed */
#define BEC_LMP_RESPONSE_TIMEOUT 0x22 /* LMP Response Timeout */
#define BEC_LMP_TRANS_COLLISION 0x23 /* LMP Error Transaction Collision */
#define BEC_LMP_PDU_NOT_ALLOWED 0x24 /* LMP PDU Not Allowed */
#define BEC_ENCRYP_MODE_NOT_ACC 0x25 /* Encryption Mode Not Acceptable */
#define BEC_UNIT_KEY_USED 0x26 /* Unit Key Used */
#define BEC_QOS_NOT_SUPPORTED 0x27 /* QoS is Not Supported */
#define BEC_INSTANT_PASSED 0x28 /* Instant Passed */
#define BEC_PAIR_UNITKEY_NO_SUPP 0x29 /* Pairing with Unit Key Not Supported */
#define BEC_NOT_FOUND 0xf1 /* Item not found */
#define BEC_REQUEST_CANCELLED 0xf2 /* Pending request cancelled */
/* Group: The following error codes are used when the
* SDEVENT_QUERY_FAILED event is sent.
*/
#define BEC_INVALID_SDP_PDU 0xd1 /* SDP response PDU is invalid */
#define BEC_SDP_DISCONNECT 0xd2 /* The SDP L2CAP channel or link disconnected */
#define BEC_SDP_NO_RESOURCES 0xd3 /* Not enough L2CAP resources */
#define BEC_SDP_INTERNAL_ERR 0xd4 /* Some type of internal stack error */
/* Group: The following error code is used when the
* BTEVENT_PAIRING_COMPLETE event is sent.
*/
#define BEC_STORE_LINK_KEY_ERR 0xe0
/* End of BtErrorCode */
/*---------------------------------------------------------------------------
* BtIac type
* Bluetooth Inquiry Access Codes are used to specify which types of
* devices should respond to inquiries. Currently there are only two
* defined.
*/
typedef uint32_t BtIac;
#define BT_IAC_GIAC 0x9E8B33 /* General/Unlimited Inquiry Access Code */
#define BT_IAC_LIAC 0x9E8B00 /* Limited Dedicated Inquiry Access Code */
/* End of BtIac */
/*---------------------------------------------------------------------------
* BtLinkType type
*
* Bluetooth Link type indicates the link type in the
* BtScoConnect link structure for SCO commands and operations.
*/
typedef uint8_t BtLinkType;
#define BLT_SCO 0x00
#define BLT_ACL 0x01
#define BLT_ESCO 0x02
/* End of BtLinkType */
/*---------------------------------------------------------------------------
* BtAclPacketType type
* Bluetooth ACL Packet types are the different packet types allowed on
* an ACL link. They can be ORed together.
*/
typedef uint16_t BtAclPacketType;
#define BAPT_NO_2_DH1 0x0002
#define BAPT_NO_3_DH1 0x0004
#define BAPT_DM1 0x0008
#define BAPT_DH1 0x0010
#define BAPT_NO_2_DH3 0x0100
#define BAPT_NO_3_DH3 0x0200
#define BAPT_DM3 0x0400
#define BAPT_DH3 0x0800
#define BAPT_NO_2_DH5 0x1000
#define BAPT_NO_3_DH5 0x2000
#define BAPT_DM5 0x4000
#define BAPT_DH5 0x8000
/* The set of packet types for a reliable link that follows the Serial port
* profile.
*/
#define BAPT_STANDARD (BAPT_DM1 | BAPT_DH1 | BAPT_DM3 | BAPT_DH3 |\
BAPT_DM5 | BAPT_DH5)
/* End of BtAclPacketType */
/*---------------------------------------------------------------------------
* BtQosServiceType type
*/
typedef uint8_t BtQosServiceType;
#define BQST_NO_TRAFFIC 0x00
#define BQST_BEST_EFFORT 0x01
#define BQST_GUARANTEED 0x02
/* End of BtQosServiceType */
/*---------------------------------------------------------------------------
* BtLinkPolicy type
*
* Bluetooth Link Policy specifies which Link modes the Link Manager
* can use for a given link. Multiple policies can be enabled by
* performing a bit wise OR operation.
*/
typedef uint16_t BtLinkPolicy;
#define BLP_DISABLE_ALL 0x0000
#define BLP_MASTER_SLAVE_SWITCH 0x0001
#define BLP_HOLD_MODE 0x0002
#define BLP_SNIFF_MODE 0x0004
#define BLP_PARK_MODE 0x0008
#define BLP_SCATTER_MODE 0x0010
/* Mask must be updated if new policy values are added */
#define BLP_MASK 0xfff0 /* Disables ScatterNet bit */
#define BLP_SCATTER_MASK 0xffe0 /* Enables ScatterNet bit */
/* End of BtLinkPolicy */
/*---------------------------------------------------------------------------
* BtAccessibleMode type
*
* Bluetooth Accessibility mode includes Discoverable and connectable
* modes.
*/
typedef uint8_t BtAccessibleMode;
#define BAM_NOT_ACCESSIBLE 0x00 /* Non-discoverable or connectable */
#define BAM_GENERAL_ACCESSIBLE 0x03 /* General discoverable and connectable */
#define BAM_LIMITED_ACCESSIBLE 0x13 /* Limited discoverable and connectable */
#define BAM_CONNECTABLE_ONLY 0x02 /* Connectable but not discoverable */
#define BAM_DISCOVERABLE_ONLY 0x01 /* Discoverable but not connectable */
#define BAM_NOT_SET 0xFF /* Access Mode has not been set */
/* End of BtAccessibleMode */
/*---------------------------------------------------------------------------
* BtLinkMode type
*/
typedef uint8_t BtLinkMode;
#define BLM_ACTIVE_MODE 0x00
#define BLM_HOLD_MODE 0x01
#define BLM_SNIFF_MODE 0x02
#define BLM_PARK_MODE 0x03
#define BLM_SCATTER_MODE 0x04
/* End of BtLinkMode */
/*---------------------------------------------------------------------------
* BtConnectionRole type
*
* Specifies the role of a ACL connection
*/
typedef uint8_t BtConnectionRole;
#define BCR_MASTER 0x00
#define BCR_SLAVE 0x01
#define BCR_ANY 0x02
#define BCR_UNKNOWN 0x03
/* === Internal use only === */
#define BCR_PSLAVE 0x04
#define BCR_PMASTER 0x05
/* End of BtConnectionRole */
/*---------------------------------------------------------------------------
* BtStackState type
*
* State of the Bluetooth protocol stack and radio.
*/
typedef uint8_t BtStackState;
/* The stack has completed initialization of the radio hardware. */
#define BTSS_NOT_INITIALIZED 0
/* The stack is initialized. */
#define BTSS_INITIALIZED 1
/* The stack has encountered an error while initializing the radio hardware. */
#define BTSS_INITIALIZE_ERR 2
/* The stack is deinitializing. */
#define BTSS_DEINITIALIZE 3
/* End of BtStackState */
/*---------------------------------------------------------------------------
* BtRadioFeature
*
* Codes for radio features as defined in LMP.
*/
typedef uint8_t BtRadioFeature;
/* Group: Extended Features Page 0 (Remote Supported Features) */
#define BRF_3_SLOT_PACKETS 0
#define BRF_5_SLOT_PACKETS 1
#define BRF_ENCRYPTION 2
#define BRF_SLOT_OFFSET 3
#define BRF_TIMING_ACCURACY 4
#define BRF_ROLE_SWITCH 5
#define BRF_HOLD_MODE 6
#define BRF_SNIFF_MODE 7
#define BRF_PARK_STATE 8
#define BRF_POWER_CONTROL_REQ 9
#define BRF_CQDDR 10
#define BRF_SCO_LINK 11
#define BRF_HV2_PACKETS 12
#define BRF_HV3_PACKETS 13
#define BRF_ULAW_SCO_DATA 14
#define BRF_ALAW_SCO_DATA 15
#define BRF_CVSD_SCO_DATA 16
#define BRF_PAGING_PARAM_NEG 17
#define BRF_POWER_CONTROL 18
#define BRF_TRANSPARENT_SCO_DATA 19
#define BRF_FLOW_CONTROL_LAG_1 20
#define BRF_FLOW_CONTROL_LAG_2 21
#define BRF_FLOW_CONTROL_LAG_3 22
#define BRF_BROADCAST_ENCRYPTION 23
#define BRF_EDR_2MBS 25
#define BRF_EDR_3MBS 26
#define BRF_ENHANCED_INQUIRY_SCAN 27
#define BRF_INTERLACED_INQUIRY_SCAN 28
#define BRF_INTERLACED_PAGE_SCAN 29
#define BRF_RSSI_WITH_INQUIRY_RESULTS 30
#define BRF_ESCO_EV3_PACKETS 31
#define BRF_ESCO_EV4_PACKETS 32
#define BRF_ESCO_EV5_PACKETS 33
#define BRF_AFH_CAPABLE_SLAVE 35
#define BRF_AFH_CLASSIFICATION_SLAVE 36
#define BRF_EDR_3_SLOTS 39
#define BRF_EDR_5_SLOTS 40
#define BRF_SNIFF_SUBRATING 41
#define BRF_PAUSE_ENCRYPTION 42
#define BRF_AFH_CAPABLE_MASTER 43
#define BRF_AFH_CLASSIFICATION_MASTER 44
#define BRF_EDR_ESCO_2MBS 45
#define BRF_EDR_ESCO_3MBS 46
#define BRF_EDR_ESCO_3_SLOTS 47
#define BRF_EXTENDED_INQUIRY 48
#define BRF_SECURE_SIMPLE_PAIRING 51
#define BRF_ENCAPSULATED_PDU 52
#define BRF_ERRONEOUS_DATA_REPORTING 53
#define BRF_NON_FLUSHABLE_PBF 54
#define BRF_LINK_SUPERV_TIMEOUT_EVENT 56
#define BRF_INQ_RSP_TX_POWER_LVL 57
#define BRF_EXTENDED_FEATURES 63
/* Group: Extended Features Page 1 (Remote Host Supported Features) */
#define BRF_HOST_SECURE_SIMPLE_PAIRING 64
/* End of BtRadioFeature */
/* Forward declaration of the callback parameters */
typedef struct _BtEvent BtEvent;
/* Forward declaration of the SCO connect structures */
typedef struct _BtScoConnect BtScoConnect;
typedef struct _BtScoTxParms BtScoTxParms;
typedef struct _BtScoRxParms BtScoRxParms;
/*---------------------------------------------------------------------------
* BtCallBack type
*
* A function of this type is called to indicate general Bluetooth and
* ME events.
*/
typedef void (*BtCallBack)(const BtEvent*);
/* End of BtCallBack */
/*---------------------------------------------------------------------------
* BtProtocolId type
*
* The protocol ID is a pointer to the protocol's security callback
* function. The user of the protocol ID should not use the protocol ID
* as a callback function since in the future it may be something else.
* The callback is a unique way to identify a protocol layer.
*/
typedef BtCallBack BtProtocolId;
/* End of BtProtocolId */
/*---------------------------------------------------------------------------
* BtClassOfDevice type
*
* Bit pattern representing the class of device along with the
* supported services. There can be more than one supported service.
* Service classes can be ORed together. The Device Class is composed
* of a major device class plus a minor device class. ORing together
* each service class plus one major device class plus one minor device
* class creates the class of device value. The minor device class is
* interpreted in the context of the major device class.
*/
typedef uint32_t BtClassOfDevice;
/* Group: Major Service Classes. Can be ORed together */
#define COD_LIMITED_DISCOVERABLE_MODE 0x00002000
#define COD_POSITIONING 0x00010000
#define COD_NETWORKING 0x00020000
#define COD_RENDERING 0x00040000
#define COD_CAPTURING 0x00080000
#define COD_OBJECT_TRANSFER 0x00100000
#define COD_AUDIO 0x00200000
#define COD_TELEPHONY 0x00400000
#define COD_INFORMATION 0x00800000
/* Group: Major Device Classes (Select one) */
#define COD_MAJOR_MISCELLANEOUS 0x00000000
#define COD_MAJOR_COMPUTER 0x00000100
#define COD_MAJOR_PHONE 0x00000200
#define COD_MAJOR_LAN_ACCESS_POINT 0x00000300
#define COD_MAJOR_AUDIO 0x00000400
#define COD_MAJOR_PERIPHERAL 0x00000500
#define COD_MAJOR_IMAGING 0x00000600
#define COD_MAJOR_UNCLASSIFIED 0x00001F00
/* Group: Minor Device Class - Computer Major class */
#define COD_MINOR_COMP_UNCLASSIFIED 0x00000000
#define COD_MINOR_COMP_DESKTOP 0x00000004
#define COD_MINOR_COMP_SERVER 0x00000008
#define COD_MINOR_COMP_LAPTOP 0x0000000C
#define COD_MINOR_COMP_HANDHELD 0x00000010
#define COD_MINOR_COMP_PALM 0x00000014
#define COD_MINOR_COMP_WEARABLE 0x00000018
/* Group: Minor Device Class - Phone Major class */
#define COD_MINOR_PHONE_UNCLASSIFIED 0x00000000
#define COD_MINOR_PHONE_CELLULAR 0x00000004
#define COD_MINOR_PHONE_CORDLESS 0x00000008
#define COD_MINOR_PHONE_SMART 0x0000000C
#define COD_MINOR_PHONE_MODEM 0x00000010
#define COD_MINOR_PHONE_ISDN 0x00000014
/* Group: Minor Device Class - LAN Access Point Major class */
#define COD_MINOR_LAN_0 0x00000000 /* fully available */
#define COD_MINOR_LAN_17 0x00000020 /* 1-17% utilized */
#define COD_MINOR_LAN_33 0x00000040 /* 17-33% utilized */
#define COD_MINOR_LAN_50 0x00000060 /* 33-50% utilized */
#define COD_MINOR_LAN_67 0x00000080 /* 50-67% utilized */
#define COD_MINOR_LAN_83 0x000000A0 /* 67-83% utilized */
#define COD_MINOR_LAN_99 0x000000C0 /* 83-99% utilized */
#define COD_MINOR_LAN_NO_SERVICE 0x000000E0 /* 100% utilized */
/* Group: Minor Device Class - Audio Major class */
#define COD_MINOR_AUDIO_UNCLASSIFIED 0x00000000
#define COD_MINOR_AUDIO_HEADSET 0x00000004
#define COD_MINOR_AUDIO_HANDSFREE 0x00000008
#define COD_MINOR_AUDIO_MICROPHONE 0x00000010
#define COD_MINOR_AUDIO_LOUDSPEAKER 0x00000014
#define COD_MINOR_AUDIO_HEADPHONES 0x00000018
#define COD_MINOR_AUDIO_PORTABLEAUDIO 0x0000001C
#define COD_MINOR_AUDIO_CARAUDIO 0x00000020
#define COD_MINOR_AUDIO_SETTOPBOX 0x00000024
#define COD_MINOR_AUDIO_HIFIAUDIO 0x00000028
#define COD_MINOR_AUDIO_VCR 0x0000002C
#define COD_MINOR_AUDIO_VIDEOCAMERA 0x00000030
#define COD_MINOR_AUDIO_CAMCORDER 0x00000034
#define COD_MINOR_AUDIO_VIDEOMONITOR 0x00000038
#define COD_MINOR_AUDIO_VIDEOSPEAKER 0x0000003C
#define COD_MINOR_AUDIO_CONFERENCING 0x00000040
#define COD_MINOR_AUDIO_GAMING 0x00000048
/* Group: Minor Device Class - Peripheral Major class */
#define COD_MINOR_PERIPH_KEYBOARD 0x00000040
#define COD_MINOR_PERIPH_POINTING 0x00000080
#define COD_MINOR_PERIPH_COMBOKEY 0x000000C0
/* Group: Minor Device Class - ORed with Peripheral Minor Device class */
#define COD_MINOR_PERIPH_UNCLASSIFIED 0x00000000
#define COD_MINOR_PERIPH_JOYSTICK 0x00000004
#define COD_MINOR_PERIPH_GAMEPAD 0x00000008
#define COD_MINOR_PERIPH_REMOTECTRL 0x0000000C
#define COD_MINOR_PERIPH_SENSING 0x00000010
#define COD_MINOR_PERIPH_DIGITIZER 0x00000014
#define COD_MINOR_PERIPH_CARD_RDR 0x00000018
/* Group: Minor Device Class - Imaging Major class */
#define COD_MINOR_IMAGE_UNCLASSIFIED 0x00000000
#define COD_MINOR_IMAGE_DISPLAY 0x00000010
#define COD_MINOR_IMAGE_CAMERA 0x00000020
#define COD_MINOR_IMAGE_SCANNER 0x00000040
#define COD_MINOR_IMAGE_PRINTER 0x00000080
/* Group: Masks used to isolate the class of device components */
#define COD_SERVICE_MASK 0x00ffC000 /* Less LIAC bit */
#define COD_MAJOR_MASK 0x00001F00
#define COD_MINOR_MASK 0x000000FC
#define COD_LIMITED_DISC_MASK 0x00002000 /* LIAC bit */
/* End of BtClassOfDevice */
/*---------------------------------------------------------------------------
* BtLinkKeyType type
*/
typedef uint8_t BtLinkKeyType;
#define COMBINATION_KEY 0x00
#define LOCAL_UNIT_KEY 0x01
#define REMOTE_UNIT_KEY 0x02
#define DEBUG_COMBINATION_KEY 0x03
#define UNAUTH_COMBINATION_KEY 0x04
#define AUTH_COMBINATION_KEY 0x05
#define CHANGED_COMBINATION_KEY 0x06
/* End of BtLinkKeyType */
/*---------------------------------------------------------------------------
* BtInquiryMode type
*
* Describes the format of the inquiry responses that will be received
* from the controller.
*/
typedef uint8_t BtInquiryMode;
#define INQ_MODE_NORMAL 0 /* Normal Inquiry Response format */
#define INQ_MODE_RSSI 1 /* RSSI Inquiry Response format */
#define INQ_MODE_EXTENDED 2 /* Extended or RSSI Inquiry Response format */
/* End of BtInquiryMode */
/*---------------------------------------------------------------------------
* BtInqRspTxPower
*
* Used to hold the value of an Inquiry Repsonse TX Power Level. The
* range of this value is from -70 to + 20 dBm.
*/
typedef int8_t BtInqRspTxPower;
#define BT_INVALID_TX_PWR 127
/* End of BtInqRspTxPower */
/*---------------------------------------------------------------------------
* BtInqTxPower
*
* Used to hold the value of an Inquiry TX Power Level. The range of
* this value is from -70 to + 20 dBm.
*/
typedef int8_t BtInqTxPower;
/* End of BtInqTxPower */
/*---------------------------------------------------------------------------
* BtErrDataReporting type
*
* Defines whether erroneous data reporting is enabled in the host
* controller.
*/
typedef uint8_t BtErrDataReporting;
#define EDR_DISABLED 0 /* Erroneous Data Reporting disabled */
#define EDR_ENABLED 1 /* Erroneous Data Reporting enabled */
/* End of BtErrDataReporting */
/*---------------------------------------------------------------------------
* BtScoErrFlags type
*
* When Erroneous Data Reporting is enabled, these flags are used in the
* "scoDataInd.errFlags" field of BtEvent, during a BTEVENT_SCO_DATA_IND
* event. They indicated any potential errors in the SCO data that was
* received.
*/
typedef uint8_t BtScoErrFlags;
#define BSE_NO_ERROR 0x00
#define BSE_PARTIAL_ERRORS 0x01
#define BSE_NO_DATA 0x10
#define BSE_PARTIAL_DATA 0x11
/* End of BtScoErrFlags */
/*---------------------------------------------------------------------------
* BtIoCapabilities
*
* Defines the I/O capabilities of a device. Simple Pairing will
* generate different events based on the capabilities of the device.
*/
typedef uint8_t BtIoCapabilities;
#define IO_DISPLAY_ONLY 0 /* The device is only capable of display */
#define IO_DISPLAY_YESNO 1 /* The device can display and accept input */
#define IO_KEYBOARD_ONLY 2 /* The device is a keyboard with no display */
#define IO_NO_IO 3 /* The device is not capable of I/O */
/* End of BtIoCapabilities */
/*---------------------------------------------------------------------------
* BtOobDataPresent
*
* Describes whether Out of Band data has been received from a remote
* device.
*/
typedef uint8_t BtOobDataPresent;
#define OOB_DATA_NOT_PRESENT 0 /* No Out of Band Data is present */
#define OOB_DATA_PRESENT 1 /* Out of Band Data is present */
/* End of BtOobDataPresent */
/*---------------------------------------------------------------------------
* BtAuthRequirements
*
* Describes whether Man in the Middle protection is required during
* simple pairing. If the remote device does not support simple pairing
* then MITM_PROTECT_REQUIRED specifies that authentication and
* encryption (BSL_SECURITY_L3_IN | BSL_SECURITY_L3_OUT) will be used
* if there is no BtSecurityRecord.
*/
typedef uint8_t BtAuthRequirements;
#define MITM_PROTECT_NOT_REQUIRED 0x00 /* No Man in the Middle protection */
#define MITM_PROTECT_REQUIRED 0x01 /* Man in the Middle protection req */
/* End of BtAuthRequirements */
/*---------------------------------------------------------------------------
* BtAuthorizeRequirements
*
* Describes whether Authorization is required when a service is accessed
* and no security record exists. AUTHORIZATION_REQUIRED specifies that
* authorization (BSL_AUTHORIZATION_IN | BSL_AUTHORIZATION_OUT) will be
* used if there is no BtSecurityRecord.
*/
typedef uint8_t BtAuthorizeRequirements;
#define AUTHORIZATION_NOT_REQUIRED 0x00 /* Authorization not required */
#define AUTHORIZATION_REQUIRED 0x01 /* Authorziation is required */
/* End of BtAuthorizeRequirements */
/*---------------------------------------------------------------------------
* BtBondingMode
*
* Describes the bonding mode of the device. Dedicated bonding implies
* that a device will connect for the express purpose of bonding, and
* then will disconnect. General bonding implies that a device will bond
* while connecting to a particular service.
*/
typedef uint8_t BtBondingMode;
#define BONDING_NOT_REQUIRED 0x00 /* Bonding is not required */
#define DEDICATED_BONDING 0x02 /* Dedicated bonding mode enabled */
#define GENERAL_BONDING 0x04 /* General bonding mode enabled */
#define BONDING_NOT_ALLOWED 0x10 /* Non-Bondable mode enabled. Bonding
* requests will be rejected.
*/
/* End of BtBondingMode */
/*---------------------------------------------------------------------------
* BtRemDevState type
*
* Indicates the current state of a Remote Device.
*/
typedef uint8_t BtRemDevState;
#define BDS_DISCONNECTED 0x00
#define BDS_OUT_CON 0x01 /* Starting an out going connection */
#define BDS_IN_CON 0x02 /* In process of incoming connection */
#define BDS_CONNECTED 0x03 /* Connected */
#define BDS_OUT_DISC 0x04 /* Starting an out going disconnect */
#define BDS_OUT_DISC2 0x05 /* Disconnect status received */
#define BDS_OUT_CON2 0x06 /* In SCO, used when connection request has
been sent */
/* End of BtRemDevState */
/*---------------------------------------------------------------------------
* BtEirDataType type
*
* Defines the data types in an extended inquiry response.
*/
typedef uint8_t BtEirDataType;
#define EIR_FLAGS 0x01
#define EIR_SRV_CLASS_16_PART 0x02
#define EIR_SRV_CLASS_16_WHOLE 0x03
#define EIR_SRV_CLASS_32_PART 0x04
#define EIR_SRV_CLASS_32_WHOLE 0x05
#define EIR_SRV_CLASS_128_PART 0x06
#define EIR_SRV_CLASS_128_WHOLE 0x07
#define EIR_REM_NAME_PART 0x08
#define EIR_REM_NAME_WHOLE 0x09
#define EIR_TX_POWER 0x0A
#define EIR_MAN_SPECIFIC 0xFF
/* End of BtEirDataType */
/*---------------------------------------------------------------------------
* BtKeyPress type
*
* Defines the keypress events during Secure Simple Pairing
*/
typedef uint8_t BtKeyPressParm;
#define PASSKEY_STARTED 0
#define PASSKEY_DIGIT_ENTERED 1
#define PASSKEY_DIGIT_ERASED 2
#define PASSKEY_CLEARED 3
#define PASSKEY_COMPLETED 4
/* End of BtKeyPressParm */
/****************************************************************************
*
* Data Structures
*
****************************************************************************/
/*---------------------------------------------------------------------------
* BtPageScanInfo structure
*/
typedef struct _BtPageScanInfo
{
uint8_t psRepMode;
uint8_t psMode;
uint16_t clockOffset;
} BtPageScanInfo;
/*---------------------------------------------------------------------------
* BtSniffInfo structure
*
* Identifies the sniff requirements during a ME_StartSniff request.
*/
typedef struct _BtSniffInfo
{
/* Maximum acceptable interval between each consecutive sniff period.
* May be any even number between 0x0002 and 0xFFFE, but the mandatory
* sniff interval range for controllers is between 0x0006 and 0x0540.
* The value is expressed in 0.625 ms increments (0x0006 = 3.75 ms).
*
* The actual interval selected by the radio will be returned in
* a BTEVENT_MODE_CHANGE event.
*/
uint16_t maxInterval;
/* Minimum acceptable interval between each consecutive sniff period.
* Must be an even number between 0x0002 and 0xFFFE, and be less than
* "maxInterval". Like maxInterval this value is expressed in
* 0.625 ms increments.
*/
uint16_t minInterval;
/* The number of master-to-slave transmission slots during which
* a device should listen for traffic (sniff attempt).
* Expressed in 0.625 ms increments. May be between 0x0001 and 0x7FFF.
*/
uint16_t attempt;
/* The amount of time before a sniff timeout occurs. Expressed in
* 1.25 ms increments. May be between 0x0000 and 0x7FFF, but the mandatory
* range for controllers is 0x0000 to 0x0028.
*/
uint16_t timeout;
} BtSniffInfo;
/*---------------------------------------------------------------------------
* BtSniffSubrateParms structure
*
* Identifies the sniff subrating requirements when enabling Sniff
* Subrating (ME_EnableSniffSubrating).
*/
typedef struct _BtSniffSubrateParms
{
/* The Maximum Latency parameter used to calculate the
* maximum sniff subrate that the remote device may use. May be any
* number between 0x0000 and 0xFFFE. The value is expressed in 0.625 ms
* increments.
*/
uint16_t maxLatency;
/* Minimum base sniff subrate timeout that the remote device may use.
* May be any number between 0x0000 and 0xFFFE. The value is expressed in
* 0.625 ms increments.
*/
uint16_t minRemoteTimeout;
/* Minimum base sniff subrate timeout that the local device may use.
* May be any number between 0x0000 and 0xFFFE. The value is expressed in
* 0.625 ms increments.
*/
uint16_t minLocalTimeout;
} BtSniffSubrateParms;
/*---------------------------------------------------------------------------
* BtAccessModeInfo structure
*/
typedef struct _BtAccessModeInfo
{
uint16_t inqInterval; /* Inquiry scan interval */
uint16_t inqWindow; /* Inquiry scan Window */
uint16_t pageInterval; /* Page scan interval */
uint16_t pageWindow; /* Page scan window */
} BtAccessModeInfo;
/*---------------------------------------------------------------------------
* BtInquiryResult structure
*
* Represents information about a single device found during an
* Inquiry process.
*/
typedef struct _BtInquiryResult
{
BD_ADDR bdAddr; /* Device Address */
BtPageScanInfo psi; /* Page scan info used for connecting */
uint8_t psPeriodMode;
BtClassOfDevice classOfDevice;
/* RSSI in dBm (-127 to +20). Only valid when controller reports RSSI with
* in inquiry results (also see ME_SetInquiryMode). Otherwise it will be
* set to BT_INVALID_RSSI.
*/
int8_t rssi;
/* Extended Inquiry response. Only valid when controller reports an
* extended inquiry (also see ME_SetInquiryMode). Otherwise it will be
* set to all 0's.
*/
uint8_t extInqResp[240];
/* Describes the format of the current inquiry result */
BtInquiryMode inqMode;
} BtInquiryResult;
/*---------------------------------------------------------------------------
* BtChannelClass structure
*
* Indicates channel classification for AFH with 79 1-bit fields in
* a 10-byte array. Each channel may be marked bad or unknown. The nth
* field (0 - 78) indicates the value for channel n. Bit 79 is unused.
*/
typedef struct _BtChannelClass
{
uint8_t map[10];
} BtChannelClass;
/*---------------------------------------------------------------------------
* BtHandler structure
*/
typedef struct _BtHandler
{
ListEntry node; /* For internal stack use only. */
BtCallBack callback; /* Pointer to callback function */
BtEventMask eMask; /* For internal stack use only. */
} BtHandler;
/* Internal types required for BtRemoteDevice structure */
typedef uint8_t BtAuthState;
typedef uint8_t BtEncryptState;
typedef uint8_t BtAuthorizeState;
typedef uint8_t BtSecAccessState;
typedef uint8_t BtLinkRxState;
typedef uint8_t BtOpType;
typedef struct _BtOperation {
ListEntry node;
BtOpType opType;
} BtOperation;
/*---------------------------------------------------------------------------
* BtRemoteDevice structure
*
* Represents a remote device. This structure is used to manage the ACL
* and SCO links to a remote device.
*/
typedef struct _BtRemoteDevice
{
BtOperation op; /* Used internally by the stack */
BtOperation policyOp; /* Used internally by the stack */
BtOperation cancelOp; /* Used internally by the stack */
BtOperation roleOp; /* Used internally by the stack */
BtOperation packetOp; /* Used internally by the stack */
BtOperation remFeaturesOp; /* Used internally by the stack */
BtOperation sniffSubrOp; /* Used internally by the stack */
/* Group: Access functions are provided for accessing these values. They
* should not be accessed directly by an application.
*/
BD_ADDR bdAddr; /* 48-bit address of the remote device */
BtConnectionRole role; /* The local device's role in this connection */
BtLinkMode mode; /* Current mode of the device */
BtClassOfDevice cod; /* COD of the device */
int initiator;
#if BT_SECURITY == XA_ENABLED
void *secRec; /* Current Security Record being processed */
/* Simple Pairing */
BtIoCapabilities ioCap; /* IO Capabilities of the remote device */
BtAuthRequirements remAuthRequirements; /* Authentication requirements of remote device */
int ioCapFlags;
#endif
/* Group: ME uses the following fields internally. */
ListEntry handlers; /* List of bound handlers */
ListEntry scoList; /* Head of list of SCO connections */
BtHandler *scoHandler; /* Handler for SCO event (1 per remDev) */
#if BT_SECURITY == XA_ENABLED
ListEntry secTokens; /* List of security tokens */
BtHandler *authHandler; /* Handler for authentication */
BtHandler *encryptHandler;/* Handler for encryption */
#endif
uint16_t hciHandle; /* Connection handle for HCI */
BtRemDevState state; /* State of the ACL link */
uint8_t restricted; /* TRUE indicates restricted link */
uint8_t discFlag; /* TRUE indicates disconnect request */
uint8_t discReason; /* Non-zero = disconnect reason */
BtAclPacketType aclPacketTypes; /* Current ACL packet types permitted */
BtAclPacketType tmpAclPacketTypes; /* ACL packet types attempting to be set */
uint8_t remoteFeatures[8];
uint8_t remoteExtFeatures[8];
int haveExtFeatures;
/* Group: The following are used internally for security */
#if BT_SECURITY == XA_ENABLED
int newLinkKey; /* TRUE means attempting to get a new link key */
BtSecAccessState secAccessState;
BtAuthState authState;
BtAuthorizeState authorizeState;
BtEncryptState encryptState;
uint8_t pairingType; /* Uses the BtPairingType type */
uint8_t pinLen; /* length of pin used in generating a key */
uint8_t ioType; /* Track the kind of I/O transaction */
uint32_t numeric; /* Numeric value to display */
BtOobDataPresent oobDataPresent; /* Out of band data present on the remote device */
BtAuthRequirements curAuthRequirements; /* Current auth requirements of local device */
BtLinkKeyType keyType; /* Type of link key for comparison */
#endif
/* Group: The following are parameters to me operations */
union {
/* Create connection operation */
struct {
BtPageScanInfo psi;
uint8_t allowRoleChange;
} con;
/* Park & Hold mode commands */
struct {
uint16_t max;
uint16_t min;
} mode;
BtSniffInfo sniff; /* Sniff command */
BtSniffSubrateParms sniffSubrateParms; /* Sniff subrating command */
BtConnectionRole acceptRole; /* Connection accept */
uint8_t rejectReason; /* Connection reject */
BtLinkPolicy policy; /* Write link policy */
} parms;
/* Group: L2CAP uses the following fields internally. */
int okToSend;
ListEntry txQueue;
uint16_t refCount;
BtLinkRxState rxState;
uint16_t rxBufferLen;
uint8_t *rxBuffer;
#if L2CAP_NUM_ENHANCED_CHANNELS > 0
uint8_t linkModes; /* L2capLinkMode defined in l2cap_bt.h */
uint8_t preCopyLen;
uint32_t extendedFeatures;
#endif /* L2CAP_NUM_ENHANCED_CHANNELS > 0 */
/* Group: The SDP client uses the following fields internally. */
uint16_t sdpClientChannel; /* L2CAP channel for SDP client */
ListEntry queryList; /* List of queries */
BtPacket sdpClientPacket; /* Packet for sending queries */
uint16_t transId; /* Current transaction ID */
uint8_t sdpClientState; /* State of the client */
uint8_t sdpKeepAlive; /* Keep-alive count */
struct _SdpQueryToken *curToken; /* The token currently being processed. */
/* Group: The SDP server uses the following field internally. */
struct _SdpServerInfo *sdpServInfo;
} BtRemoteDevice;
/*---------------------------------------------------------------------------
* BtRestrictedInfo structure
*
* Used to create a restricted link to a remote device. A restricted link
* has a specific Quality of service, link policy, and hold policy.
*/
typedef struct _BtRestrictedInfo
{
BtAclPacketType aclPacketType;
BtQosServiceType serviceType;
/* Range of flush time out is 0x0000 - 0x0EFF. 0xFFFF is used
* to indicate infinite - no automatic flush. Flush time out is
* the amount of time to wait until a transmit frame is flushed.
* Times are specified in 0.625 us units.
*/
uint16_t minRemoteFlushTo;
uint16_t minLocalFlushTo;
uint32_t tokenRate; /* Token rate in bytes per second */
uint32_t peakBandwidth; /* Peak bandwidth in bytes per second */
uint32_t latency; /* Latency in microseconds */
uint32_t delayVariation; /* Delay variation in microseconds */
BtLinkPolicy linkPolicy; /* Link policy */
} BtRestrictedInfo;
/*---------------------------------------------------------------------------
* BtDeviceRecord structure
*
* Represents a Bluetooth Device Database record as seen by the
* Security manager.
*/
typedef struct _BtDeviceRecord
{
BD_ADDR bdAddr;
int trusted;
uint8_t linkKey[16];
BtLinkKeyType keyType;
/* Length of pin used to generate key for pin generated keys */
uint8_t pinLen;
} BtDeviceRecord;
/*---------------------------------------------------------------------------
* BtDeviceLinkKey structure
*
* Represents a Bluetooth Device link key returned from an HCI
* ReadStoredLinkKey command.
*/
typedef struct _BtDeviceLinkKey
{
BD_ADDR bdAddr; /* Device Address */
uint8_t linkKey[16];
} BtDeviceLinkKey;
/*---------------------------------------------------------------------------
* MeRemoteNameRequest structure
*
* Used in an MeCommandToken when handling a "Remote Name Request"
* operation.
*/
typedef struct _MeRemoteNameRequest
{
/* Common for both input and output */
BD_ADDR bdAddr;
/* Input/Output parameters for the operation. Either the "in"
* or "out" parameters are valid, depending on when this structure
* is accessed.
*/
union {
/* Fields to fill before starting the operation. */
struct {
BtPageScanInfo psi; /* Page scan information */
} in;
/* Fields to read when the operation is complete. */
struct {
/* Length of string stored in "name". */
uint8_t len;
/* Remote device name in UTF-8 format */
uint8_t* name;
} out;
} io;
} MeRemoteNameRequest;
/*---------------------------------------------------------------------------
* MeGeneralHciCommand structure
*
* Used in an MeCommandToken when handling general and user defined
* HCI commands.
*/
typedef struct _MeGeneralHciCommand
{
/* Fields to be filled before starting the operation */
struct {
/* The hciCommand is composed of the OGF and the OCF. The OGF
* is the upper 6 bits while the OCF is the remaining 12 bits.
*/
uint16_t hciCommand; /* HCI command (see hci.h for commands) */
uint8_t parmLen; /* Length of the command parameters */
uint8_t *parms; /* Pointer to command parameters */
uint8_t event; /* Main event which signals end of operation */
} in;
/* Fields to read when the operation is complete */
struct {
/* The status must be checked to see if the remaining out parameters
* valid. If the status is BT_STATUS_SUCCESS then the rest of the
* out parameters are valid.
*/
BtStatus status;
uint8_t event; /* Event ending operation (see hci.h for event) */
uint8_t parmLen; /* Length of event parameters */
uint8_t *parms; /* Pointer to event parameters */
} out;
} MeGeneralHciCommand;
typedef uint16_t BtScoAudioSettings; /* This must match definition in mesco.h */
/*---------------------------------------------------------------------------
* MeCommandToken structure
*
* A token that represents a special HCI command, including
* user-defined HCI commands.
*/
typedef struct _MeCommandToken
{
BtOperation op; /* For internal use by the stack. */
BtOperation cancelOp;/* For internal use by the stack. */
BtRemoteDevice *remDev; /* For internal use by the stack. */
/* The caller must set the callback function. It is called
* when the command is complete.
*/
BtCallBack callback;
/* One of the fields in this union is used to store information
* about the operation.
*/
union {
/* Information about a "Remote Name Request" operation */
MeRemoteNameRequest name;
/* Information for the SCO Audio settings command */
BtScoAudioSettings vsettings;
/* Information used in general and user defined operations */
MeGeneralHciCommand general;
} p;
/* Group: The following field is for internal stack use only */
BtEventType eType;
uint8_t flags;
} MeCommandToken;
/*---------------------------------------------------------------------------
* BtEvent structure
*
* Used to pass information from the stack to the application. Not all
* fields are valid at any given time. The type of event determines which
* fields are valid.
*/
struct _BtEvent
{
/* Event causing callback. Always valid.*/
BtEventType eType;
/* Error code. See BtEventType for guidance on whether errCode is valid. */
BtErrorCode errCode;
/* Pointer to handler. Only valid for events directed to BtHandlers. */
BtHandler *handler;
/* Parameters */
union {
BtInquiryResult inqResult; /* Inquiry result */
BtDeviceLinkKey bdLinkKey; /* Returned Link Key */
BtAccessibleMode aMode; /* New access mode */
BtRemoteDevice *remDev; /* Pointer to remote device */
BD_ADDR bdAddr; /* Device Address */
MeCommandToken *meToken; /* Me command token */
uint8_t pMode; /* Simple Pairing Mode */
struct _BtSecurityToken *secToken; /* Security Token */
struct _SdpQueryToken *token;
/* Information for BTEVENT_PAIRING_COMPLETE */
struct {
BtRemoteDevice *remDev;
BtLinkKeyType keyType;
} pairingInfo;
/* Information for BTEVENT_PIN_REQ */
struct {
BtRemoteDevice *remDev;
/* If > 0 then the pin length returned in SEC_SetPin must be >= pinLen */
uint8_t pinLen;
} pinReq;
/* Information for BTEVENT_SET_INQUIRY_MODE_CNF */
BtInquiryMode inqMode;
/* Information for BTEVENT_SET_INQ_TX_PWR_LVL_CNF */
BtInqTxPower inqTxPwr;
/* Information for BTEVENT_REMOTE_FEATURES */
struct {
BD_ADDR bdAddr;
uint8_t features[8];
} remoteFeatures;
/* Information for BTEVENT_REM_HOST_FEATURES */
struct {
BD_ADDR bdAddr;
uint8_t features[8];
} remHostFeatures;
/* Information for BTEVENT_LINK_SUPERV_TIMEOUT_CHANGED */
struct {
BtRemoteDevice *remDev;
uint16_t timeout;
} linkSupervision;
/* Information for BTEVENT_QOS_SETUP_COMPLETE */
struct {
/* Reserved */
uint8_t flags;
/* Service Type: 0 = No Traffic, 1 = Best Effort, 2 Guaranteed */
BtQosServiceType serviceType;
/* Token Rate in octets per second */
uint32_t tokenRate;
/* Peak Bandwidth in octets per second */
uint32_t peakBandwidth;
/* Latency in microseconds */
uint32_t latency;
/* Delay Variation in microseconds */
uint32_t delayVariation;
} qos;
/* Result for BTEVENT_SET_SNIFF_SUBRATING_PARMS_CNF */
BtSniffSubrateParms *sniffSubrateParms;
/* Information for BTEVENT_SNIFF_SUBRATE_INFO */
struct {
/* Pointer to the remote device */
BtRemoteDevice *remDev;
/* Maximum latency for data being transmitted from the local
* device to the remote device.
*/
uint16_t maxTxLatency;
/* Maximum latency for data being received by the local
* device from the remote device.
*/
uint16_t maxRxLatency;
/* The base sniff subrate timeout in baseband slots that the
* remote device shall use.
*/
uint16_t minRemoteTimeout;
/* The base sniff subrate timeout in baseband slots that the
* local device will use.
*/
uint16_t minLocalTimeout;
} sniffSubrateInfo;
/* Result for BTEVENT_LOCAL_OOB_DATA */
struct {
/* Simple Pairing Hash C from the local device */
uint8_t hashC[16];
/* Simple Pairing Randomizer R the local device */
uint8_t randR[16];
} oobData;
/* Information for BTEVENT_CONFIRM_NUMERIC_REQ, BTEVENT_PASS_KEY_REQ,
* and BTEVENT_DISPLAY_NUMERIC_IND
*/
struct {
BtRemoteDevice *remDev; /* Pointer to the remote device */
uint32_t numeric; /* Numeric value received from Secure
* Simple Pairing (not valid for
* BTEVENT_PASS_KEY_REQ
*/
BtBondingMode bondingMode; /* Bonding has been requested */
} userIoReq;
/* Result for BTEVENT_ENCRYPTION_CHANGE event. */
struct {
BtRemoteDevice *remDev;
uint8_t mode; /* New encryption mode (uses the
* BtEncryptMode type) */
} encrypt;
/* Result for BTEVENT_KEY_PRESSED */
struct {
BD_ADDR bdAddr; /* Address of the device sending the keypress */
BtKeyPressParm parm; /* The value of the keypress parameter */
} keyPress;
struct {
BtRemoteDevice *remDev;
/* If disconnection was successful, contains BEC_NO_ERROR.
* errCode will contain the disconnect reason.
*
* Unsuccessful disconnections will contain an error code
* as generated by the radio. In this case, errCode can be
* ignored.
*/
BtErrorCode status;
} disconnect;
/* Result for the BTEVENT_SCO_DATA_CNF event */
struct {
BtRemoteDevice *remDev; /* Pointer to remote device */
BtScoConnect *scoCon; /* SCO connection */
BtPacket *scoPacket; /* SCO Packet Handled */
} scoPacketHandled;
/* Result for the BTEVENT_SCO_CONNECT_CNF && BTEVENT_SCO_CONNECT_IND
events.
*/
struct {
BtRemoteDevice *remDev; /* Pointer to remote device */
uint16_t scoHandle; /* SCO Connection handle for HCI */
BtScoConnect *scoCon; /* SCO connection */
BtLinkType scoLinkType;/* SCO link type */
BtScoTxParms *scoTxParms; /* Pointer to eSCO TX parameters */
BtScoRxParms *scoRxParms; /* Pointer to eSCO RX parameters */
} scoConnect;
/* Result for the BTEVENT_SCO_DATA_IND event */
struct {
BtRemoteDevice *remDev; /* Pointer to remote device */
uint16_t scoHandle; /* SCO Connection handle for HCI */
BtScoConnect *scoCon; /* SCO connection. */
uint8_t len; /* SCO data len */
uint8_t *ptr; /* SCO data ptr */
BtScoErrFlags errFlags; /* Erroneous Data Reporting */
} scoDataInd;
/* Result for the BTEVENT_SECURITY_CHANGE and
* BTEVENT_SECURITY3_COMPLETE events
*/
struct {
uint8_t mode; /* New security mode (uses the BtSecurityMode
* type). */
int encrypt; /* Indicate if encryption set or not */
} secMode;
/* Results for the BTEVENT_MODE_CHANGE event */
struct {
BtRemoteDevice *remDev;
BtLinkMode curMode;
uint16_t interval;
} modeChange;
/* Results for BTEVENT_ROLE_CHANGE */
struct {
BtRemoteDevice *remDev;
BtConnectionRole newRole; /* New role */
} roleChange;
/* Results for BTEVENT_CONN_PACKET_TYPE_CHNG */
struct {
BtRemoteDevice *remDev;
BtAclPacketType packetTypes; /* New packet types */
} packetTypeChng;
/* Informational BTEVENT_HCI_COMMAND_SENT event. */
struct {
/* "HciCommandType" values found in sys/hci.h.*/
uint16_t type;
/* Length of optional parameters */
uint8_t length;
/* Optional parameters to HCI command. Refer to Bluetooth HCI
* specification for command parameter descriptions.
*/
const uint8_t* parms;
} hciCmd;
/* Results for BTEVENT_DEVICE_SELECTED event. When received by
* the Device Selection monitor, it represents the selection query.
*/
struct _BtSelectDeviceToken* select;
/* BTEVENT_DEVICE_ADDED and BTEVENT_DEVICE_DELETED events. */
struct _BtDeviceContext* device;
/* Valid during BTEVENT_HCI_FATAL_ERROR */
uint8_t transError;
} p;
};
/*---------------------------------------------------------------------------
* BtDeviceStatus type
*
* The Bluetooth Device Status tracks the status of each device.
*/
typedef uint16_t BtDeviceStatus;
#define BDS_IN_RANGE 0x01
#define BDS_PAIRED 0x02
#define BDS_TRUSTED 0x04
/* End of BtDeviceStatus */
/*---------------------------------------------------------------------------
* MeHciFlowParms structure
*
* A structure used to hold the current HCI flow parameters. This
* structure contains the maximum size of ACL and SCO transmit packets,
* as well as the current number of available buffers on the Host
* Controller.
*/
typedef struct _MeHciFlowParms {
uint16_t aclTxPacketLen;
uint16_t aclTxPacketsLeft;
uint8_t scoTxPacketLen;
uint16_t scoTxPacketsLeft;
} MeHciFlowParms;
typedef struct _SdpClientParsingStateInfo
{
uint8_t state; /* Parsing state */
int noSkip; /* Need to skip the Current Attribute List */
int curAttribListEmpty; /* Current Attribute List is empty */
uint32_t curAttribListLen; /* Current Attribute List length */
uint32_t attribListsLen; /* Attribute Lists length */
uint16_t prevAttribId; /* Previous Attribute ID that was processed */
uint16_t attribByteCount; /* Attribute Byte Count length */
uint32_t attribListLen; /* Attribute List length */
uint16_t attribId; /* Attribute ID being processed */
uint32_t attribIdLen; /* Attribute Id List length */
uint32_t attribSkipLen; /* Attribute length being skipped */
uint32_t resultValueLen; /* Result length */
uint8_t storedBuff[17]; /* Stored buffer */
uint8_t storedLen; /* Stored buffer length */
uint8_t curStoredOff; /* Offset into the stored buffer */
uint8_t flags; /* For error checking */
} SdpClientParsingStateInfo;
/*---------------------------------------------------------------------------
* SdpQueryToken structure
*
* Defines a query and expresses its results.
*
* Pass this structure to SDP_Query to initiate a query and
* SDP_ParseAttributes to parse the query results. The query results
* are returned during the callback function with an event of
* SDEVENT_QUERY_RSP, SDEVENT_QUERY_ERR, or SDEVENT_QUERY_FAILED.
*/
typedef struct _SdpQueryToken
{
ListEntry node; /* For internal use only. */
/* Group: The following fields must be filled in before calling
* SDP_Query.
*/
BtRemoteDevice *rm; /* The remote device to query. An ACL
* connection must exist with this device
* before the query is started. */
uint8_t type; /* Type of query to send. */
const uint8_t *parms; /* Parameters to be sent with the query.
* The caller of SDP_Query must make sure
* that this buffer is composed correctly.
*/
uint16_t plen; /* Number of bytes in the "parms" buffer. */
BtCallBack callback; /* Function to call with results */
/* Group: The following fields must be filled in when calling
* SDP_Query with the BSQM_CONTINUE query mode. SDP_ParseAttributes
* will automatically fill in these fields if BT_STATUS_SDP_CONT_STATE
* was returned. However, if SDP_ParseAttributes is not used, these
* fields must be modified manually.
*/
uint8_t contState[17]; /* Continuation State information */
uint8_t contStateLen; /* Continuation State length. This value
* must range from 1-17 bytes.
*/
/* Group: The following fields are filled in by SDP after completion
* of the query. These fields should not be modified and are only
* valid during the SDEVENT_QUERY_RSP or SDEVENT_QUERY_ERR
* callbacks. After the callback returns, the fields are invalid.
*/
uint16_t errorCode; /* Error code if query failed. Invalid if
* the query succeeded.
*/
/* SDP_ParseAttributes uses these values when the BSPM_BEGINNING or
* BSPM_CONT_STATE parsing modes are used to parse current SDP
* response packet.
*/
uint8_t* results; /* Pointer to query result parameters. */
uint16_t rLen; /* Number of bytes in results buffer. */
/* Group: The following fields must be filled in before calling
* SDP_ParseAttributes.
*/
uint16_t attribId; /* Attribute ID to search for */
uint16_t uuid; /* UUID to search for (use 0 if unused) */
uint8_t mode; /* SDP parsing mode (see SdpParsingMode) */
/* Group: The following fields are filled in by SDP after
* completion of SDP_ParseAttributes.
*/
/* Valid when BT_STATUS_SUCCESS and possibly BT_STATUS_SDP_CONT_STATE are
* returned from SDP_ParseAttributes. Partial results may be returned,
* and therefore should not be evaluated until the entire result is
* received.
*/
uint32_t totalValueLen; /* Total length of the SDP result value */
uint16_t availValueLen; /* Available length of the SDP result value */
uint8_t *valueBuff; /* Pointer to the available SDP result value */
/* Valid when BT_STATUS_SUCCESS is returned from SDP_ParseAttributes.
* SDP_ParseAttributes uses these values when the BSPM_RESUME parsing mode
* is used to parse the remaining data in the current SDP response packet.
*/
uint8_t *remainBuff; /* Pointer to the remaining results buffer */
uint16_t remainLen; /* Length of the remaining results buffer */
/* Group: The following field is for internal use only. */
SdpClientParsingStateInfo parseData;
/* Group: The following fields are for internal use only. */
uint16_t transId;
EvmTimer queryTimer;
} SdpQueryToken;
typedef struct _XaBufferDesc {
ListEntry link; /* For Queuing, must be first */
uint8_t flags; /* Flag storage for use by callers */
uint16_t writeOffset; /* Write offset into buff */
uint16_t readOffset; /* Read offset into buff */
uint16_t buffSize; /* Maximum size of associated buffer */
uint8_t *buff;
} XaBufferDesc;
/*---------------------------------------------------------------------------
* BtDeviceQuality structure
*
* The Bluetooth Device Quality structure is used to provide a set of
* criteria for selecting a matching device. This structure is used with
* the DS_SelectDevice and DS_EnumDevicesByQuality functions. This
* structure is used to score each device; with the device receiving the
* highest score best matches the criteria.
*/
typedef struct _BtDeviceQuality {
/* Bitwise OR'd flags that indicate which fields of the structure
* have been supplied.
*/
uint8_t mask;
/* Bluetooth Service Class list. Multiple class' can be OR'd together.
* If at least one service class is found in both the query and the
* device, 2 points are scored.
*/
BtClassOfDevice serviceClass;
/* Bluetooth Major Device Class. Only one can be provided, minor class of
* device is ignored. If the class of device matches, 1 point is scored.
*/
BtClassOfDevice deviceClass;
/* The preferred status of the device. For each matching flag in the
* device status, 1 point is scored, for a maximum of 3 points.
*/
uint16_t status;
/* The SDP Service Class UUID to search for in the known services list.
* If the service is found, 4 points are scored.
*/
uint16_t serviceUuid;
} BtDeviceQuality;
/*---------------------------------------------------------------------------
* BtSelectDeviceToken structure
*
* The Select Device Token is used when requesting the Bluetooth
* device selection manager to select an appropriate device based
* on the device quality criteria.
*/
typedef struct _BtSelectDeviceToken {
ListEntry node; /* === Internal Use Only === */
/* The caller must set the callback function. It is called
* when the command is complete.
*/
BtCallBack callback;
/* The device quality criteria to use when selecting a device. The
* caller must set this.
*/
BtDeviceQuality quality;
/* The result field is available when the request is complete. If the
* errCode of the request indicated success, a pointer to the selected
* device is provided here.
*/
void *result;
/* === Internal Use Only === */
uint8_t state;
} BtSelectDeviceToken;
typedef struct _BtDeviceContext {
ListEntry node; /* Internal, do not use.*/
/* Group: The following fields are valid for all known devices */
/* The status of this device. */
BtDeviceStatus state;
/* The 48-bit Bluetooth device address of this device. */
BD_ADDR addr;
/* The Page Scan Information received during the most recent inquiry
* result from this device.
*/
BtPageScanInfo psi;
/* The Class of Device setting received during the most recent inquiry
* result or connection request from this device.
*/
BtClassOfDevice classOfDevice;
#if DS_NUM_SERVICES > 0
/* The list of Service Class UUIDs known to exist on this device. */
uint16_t services[DS_NUM_SERVICES];
#endif
/* If there is an active ACL connection to this device, this field
* contains a pointer to the matching remote device structure.
*/
BtRemoteDevice *link;
/* Reserved for use by the device selection monitor handler to
* store extended information about this device. The ME
* does not access or modify this field. This is the only field in
* this structure that may be modified outside of the ME.
*/
void *context;
/* === Internal Use Only === */
ListEntry active;
} BtDeviceContext;
/*---------------------------------------------------------------------------
* CmgrHandler structure
*
* Used to identify the handler for Connection Manager events.
*/
typedef struct _CmgrHandler {
ListEntry node; /* Internal use only */
/* Group: Read-only parameters */
void * callback; /* Callback function to receive events */
BtDeviceContext *bdc; /* Pointer to the device context */
BtErrorCode errCode; /* Error code - valid during callback */
BtRemoteDevice *remDev; /* Remote device on connect indication */
#if BT_SCO_HCI_DATA == XA_ENABLED
CmgrAudioData audioData; /* Audio data when enabled of HCI */
BtPacket *audioPacket;
#endif /* BT_SCO_HCI_DATA == XA_ENABLED */
/* === Internal use only === */
BtHandler btHandler;
BtScoConnect *scoConnect;
BtSelectDeviceToken devQuery;
uint8_t flags;
/* Sniff Mode Variables */
uint8_t sniffPolicy;
EvmTimer sniffTimer;
uint32_t sniffTimeout;
BtSniffInfo sniffInfo;
uint16_t sniffInterval;
}CmgrHandler;
/****************************************************************************
*
* Function Reference
*
****************************************************************************/
/*---------------------------------------------------------------------------
* ME_RegisterGlobalHandler()
*
* Register a callback handler with the Management Entity to
* receive global events. The protocol stack sends a number
* of global events to all registered handlers (who have the
* proper event mask set). Clients must register a handler
* in order to receive events. The list of global events for
* which the callback will be called are listed in the
* Callback section below. The event mask for the handler is
* initialized to BEM_NO_EVENTS.
*
* Parameters:
* handler - pointer to a BtHandler structure. The callback
* field of the handler must point to a valid callback function.
* The handler must be initialized using ME_InitHandler.
*
* Returns:
* BT_STATUS_SUCCESS - operation completed successfully.
*
* BT_STATUS_FAILED - the operation failed because the handle is
* already registered, the handle is not initialized properly.
*/
BtStatus ME_RegisterGlobalHandler(BtHandler *handler);
/*---------------------------------------------------------------------------
* ME_InitHandler()
*
* Initialize a handler. All global handlers must be initialized
* before they can be passed to ME functions. This function
* can be used or filling the contents of the handler with 0
* will also suffice. A handler should only need to be initialized
* once.
*
* Parameters:
* handler - pointer to a BtHandler structure.
*/
void ME_InitHandler(BtHandler *handler);
#define ME_InitHandler(h) InitializeListEntry(&((h)->node))
/*---------------------------------------------------------------------------
* ME_UnregisterGlobalHandler()
*
* Unregister a global handler. Upon successful completion of this
* function the handler is initialized and can be registered again
* without the need for calling ME_InitHandler.
*
* Parameters:
* handler - pointer to handler to unregister
*
* Returns
* BT_STATUS_SUCCESS - operation successful
*
* BT_STATUS_FAILED - operations failed because handler
* was not registered or 0 (error check only).
*/
BtStatus ME_UnregisterGlobalHandler(BtHandler *handler);
/*---------------------------------------------------------------------------
* ME_SetEventMask()
*
* Set the event mask for the global handler. The event mask
* is for global events.
*
* Parameters:
* handler - pointer to handler.
*
* mask - event mask.
*
* Returns
* BT_STATUS_SUCCESS - operation successful
*
* BT_STATUS_FAILED - operations failed because handler
* was not registered or 0 (error check only).
*/
BtStatus ME_SetEventMask(BtHandler *handler, BtEventMask mask);
/*---------------------------------------------------------------------------
* ME_GetEventMask()
*
* Get the event mask for the global handler. The event mask
* is for global events. This function does not check to
* see if the handler is valid.
*
* Parameters:
* handler - pointer to handler.
*
* Returns:
* The event mask
*/
BtEventMask ME_GetEventMask(BtHandler *handler);
#define ME_GetEventMask(h) ((h)->eMask)
/*---------------------------------------------------------------------------
* ME_SetInquiryMode()
*
* Set the type of inquiry response that will be used during the inquiry
* process. The inquiry result is received during the
* BTEVENT_INQUIRY_RESULT event. It can contain the default response, a
* response with RSSI information, or an extended inquiry response.
*
* Parameters:
* mode - Contains one of the desired inquiry mode.
*
* Returns:
* BT_STATUS_PENDING - The Inquiry Mode is being sent to the host
* controller. When complete, a BTEVENT_SET_INQUIRY_MODE_CNF event
* will be sent to all registered handlers.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*
* BT_STATUS_IN_PROGRESS - An operation of this type is already in
* progress. Only one operation can be in progress at a time. Keep
* track of the general events to see when the operation is complete.
*
* BT_STATUS_INVALID_PARM - The operation failed because the parameter
* was not properly initialized (XA_ERROR_CHECK only).
*/
BtStatus ME_SetInquiryMode(BtInquiryMode mode);
/*---------------------------------------------------------------------------
* ME_GetInquiryMode()
*
* Get the current inquiry mode.
*
* Returns:
* The current inquiry mode.
*/
BtInquiryMode ME_GetInquiryMode(void);
/*---------------------------------------------------------------------------
* ME_SetInqTxPowerLevel()
*
* Set the inquiry TX power level. The power level must be between
* -70 and +20 dBm.
*
* Returns:
* BT_STATUS_PENDING - The Inquiry TX Power Level is being
* sent to the host controller. When complete, a
* BTEVENT_SET_INQ_TX_PWR_LVL_CNF5 event will be sent to all
* registered handlers.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*
* BT_STATUS_INVALID_PARM - The operation failed because the
* parameter was not properly initialized (XA_ERROR_CHECK only).
*
* BT_STATUS_IN_PROGRESS - An operation of this type is already in
* progress. Only one operation can be in progress at a time. Keep
* track of the general events to see when the operation is complete.
*
* BT_STATUS_NOT_SUPPORTED - The feature is not supported by the host
* controller.
*/
BtStatus ME_SetInqTxPowerLevel(BtInqTxPower power);
/*---------------------------------------------------------------------------
* ME_GetInqRspTxPowerLevel()
*
* Get the inquiry response TX power level.
*
* Returns:
* The current power level.
*/
BtInqRspTxPower ME_GetInqRspTxPowerLevel(void);
/*---------------------------------------------------------------------------
* ME_AutoCreateExtInquiryRsp()
*
* Automatically creates an Extended Inquiry Response (EIR) from the
* currently registered SDP services, local device name, and inquiry
* response TX power level. This function will fill the buffer with as
* many Service Class UUIDs as possible, add the inquiry response TX
* power level (if valid), and then put in as much of the local device
* name as possible. Any remaining buffer space will be set to 0.
*
* It is possible to add other information at the end of the created EIR.
* Please see the Bluetooth specification for a description of vendor
* specific items and flags that can be added to the EIR.
*
* Once the inquiry response is assembled into the provided buffer, it
* can be registered with the controller by calling
* ME_SetExtInquiryRsp().
*
* Parameters
* outBuffer - A memory location where the EIR will be assembled.
*
* Length - Length of the buffer. An EIR can be no more than 240 bytes
* long, and no less than 5 bytes long.
*
* Returns:
* Length of the data in the buffer.
*/
uint8_t ME_AutoCreateExtInquiryRsp(uint8_t *outBuffer, uint8_t Length);
/*---------------------------------------------------------------------------
* ME_SetExtInquiryRsp()
*
* Set the extended inquiry response that will be used when extended inquiry
* mode is set.
*
* Parameters:
* Fec - Determines if FEC will be used with the extended inquiry
* response.
*
* extInqResp - Contains the extended inquiry response that will be used
* by the local device when a remote device performs an inquiry.
*
* Length - Contains the length of the extended inquiry response.
*
* Returns:
* BT_STATUS_PENDING - The Extended Inquiry Response is being sent
* to the host controller. When complete, a
* BTEVENT_SET_EXT_INQUIRY_RESP_CNF event will be sent to all
* registered handlers.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*
* BT_STATUS_IN_PROGRESS - An operation of this type is already in
* progress. Only one operation can be in progress at a time. Keep
* track of the general events to see when the operation is complete.
*
* BT_STATUS_INVALID_PARM - The operation failed because the token
* was not properly initialized (XA_ERROR_CHECK only).
*/
BtStatus ME_SetExtInquiryRsp(int Fec, uint8_t* extInqResp, uint8_t Length);
/*---------------------------------------------------------------------------
* ME_GetExtInqData()
*
* Search the extended inquiry result (EIR) for the specified EIR data
* type, and copy the EIR data into the provided buffer. Any extra buffer
* space will be initialized to 0. The length of the EIR data is assumed
* to be 240 bytes as defined in by the HCI specification.
*
* Parameters:
* Eir - Extended inquiry result received from the remote device.
*
* Type - The type of EIR data to search for.
*
* outBuffer - A buffer to receive the EIR data.
*
* Length - The length of the buffer that will receive the EIR data.
*
* Returns:
* The length of the EIR data.
*/
uint8_t ME_GetExtInqData(uint8_t *Eir, BtEirDataType Type, uint8_t *outBuffer, uint8_t Length);
/*---------------------------------------------------------------------------
* ME_GetExtInqRemoteDeviceName()
*
* Get the remote device name from an extended inquiry response (EIR).
* The name will be null terminated. The length of the EIR data is
* assumed to be 240 bytes as defined in by the HCI specification.
*
* Parameters:
* Eir - Extended inquiry result data received from the remote device.
*
* outBuffer - A buffer to receive the remote device name.
*
* Length - The length of the buffer that will receive the name
* (including terminating NULL).
*
* Partial - A intean value, which is set to TRUE if a partial name was
* found.
*
* Returns:
* The length of the remote device name.
*/
uint8_t ME_GetExtInqRemoteDeviceName(uint8_t *Eir, uint8_t *outBuffer, uint8_t Length, int *partial);
/*---------------------------------------------------------------------------
* ME_GetExtInqServiceClassList()
*
* Get the list of service class UUIDs from an extended inquiry response
* (EIR). Upon return, the outBuffer will be filled with UUIDs of the
* size specified by uuidSize. In the case of 2 byte and 4 byte UUIDs,
* they are returned in the host processor's format and can be accessed
* as uint16_t and uint32_t values. In the case of 16 byte UUIDs, they are
* returned in big-endian format as defined by the SDP protocol. The
* length of the EIR data is assumed to be 240 bytes as defined in by the
* HCI specification.
*
* Parameters:
* Eir - Extended inquiry result data received from the remote device.
*
* uuidSize - Size of the UUID in bytes. Must be 2, 4, or 16.
*
* outBuffer - A buffer to receive the remote device name.
*
* Length - The length of the buffer that will receive the name
* (including terminating NULL).
*
* Partial - A intean value, which is set to TRUE if a partial list was
* found.
*
* Returns:
* The number of UUIDs in the list.
*/
uint8_t ME_GetExtInqServiceClassList(uint8_t *Eir, uint8_t uuidSize, uint8_t *outBuffer, uint8_t Length, int *partial);
/*---------------------------------------------------------------------------
* ME_Inquiry()
*
* Start a Bluetooth Inquiry procedure. If BT_STATUS_PENDING is
* returned then the results of the operation will be returned
* to all clients with registered global handlers. The following
* events will be sent to all registered handlers:
*
* BTEVENT_INQUIRY_RESULT - indicates that a device was found. The
* "p.inqResult" field of the BtEvent contains the result.
*
* BTEVENT_INQUIRY_COMPLETE - indicates that the inquiry process is
* complete. The "errCode" field of the BtEvent indicates whether
* the operation completed without error.
*
* BTEVENT_INQUIRY_CANCELED - this will be returned if the inquiry
* operation is canceled. BTEVENT_INQUIRY_COMPLETE will not be
* returned.
*
* BTEVENT_HCI_FATAL_ERROR - indicates fatal radio or HCI
* transport error. Assume all pending operations have failed.
*
* Parameters:
* lap - LAP used for the Inquiry (General or Limited)
*
* length - Maximum amount of time before the Inquiry is
* halted. Range is 0x01 to 0x30. Time is length * 1.28 sec.
* The Generic Access profile specifies using the value
* BT_INQ_TIME_GAP100.
*
* maxResp - The maximum number of responses. Specify zero to receive
* an unlimited number of responses.
*
* Returns:
* BT_STATUS_PENDING - The Inquiry process is started results
* will be sent via the handler. A BTEVENT_HCI_FATAL_ERROR event
* indicates a fatal radio or HCI transport error and that all
* pending operations have failed.
*
* BT_STATUS_IN_PROGRESS - An inquiry process is already in
* progress. Only one Inquiry can be in progress at a time.
* Keep track of the general events to get the results from
* the current Inquiry or to see when it ends. If it has just
* ended then a cancel is also in progress so wait for
* the cancel to complete to start another inquiry.
*
* BT_STATUS_FAILED - The operation failed.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_Inquiry(BtIac lap, uint8_t Length, uint8_t maxResp);
/*---------------------------------------------------------------------------
* ME_CancelInquiry()
*
* Cancel the current Inquiry process. When the inquiry
* operation is canceled all registered handlers will
* receive the BTEVENT_INQUIRY_CANCELED event. The "errCode"
* field of the BtEvent indicates the status of the
* operation.
*
* Returns:
* BT_STATUS_PENDING - The cancel operation was started
* successfully. The results will be sent to all clients
* with registered handlers. A BTEVENT_HCI_FATAL_ERROR event
* indicates a fatal radio or HCI transport error and that all
* pending operations have failed.
*
* BT_STATUS_SUCCESS - The inquiry process was canceled
* immediately. It actually never was started.
* BTEVENT_INQUIRY_CANCELED event will be sent to all handlers
* before this function returns.
*
* BT_STATUS_IN_PROGRESS - A cancel Inquiry is already in
* progress. Only one cancel can be in progress at a time.
* Keep track of the general events to see when the cancel
* is complete.
*
* BT_STATUS_FAILED - The operation failed because an inquiry
* operation was not in progress.
*/
BtStatus ME_CancelInquiry(void);
/*---------------------------------------------------------------------------
* ME_GetRemoteDeviceName()
*
* Get the name of the remote device. If an ACL connection
* does not exist then a temporary one will be created to
* get the name. If this function returns BT_STATUS_PENDING
* then the result will be returned via the callback in the
* token with the BTEVENT_NAME_RESULT event. The "errCode" field
* indicates the status of the operation. "p.meToken" points
* to the token passed into the function. The output field of
* token contains the results if the status indicates success.
*
* If a request to the same remote device is already in progress
* only one request will be made. This token will receive the
* results of the request in progress.
*
* Parameters:
* token - pointer to token containing input parameters and
* storage for output parameters. The token must be initialized
* before calling this function as follows:
*
* "token.callback" must be set to the callback function.
*
* "token.p.name.bdAddr" must contain the 48-bit address of
* the remote device.
*
* "token.p.name.io.in.psi" must contain the page scan information.
* If the page scan information is not known then all fields should
* be 0.
*
* Returns:
* BT_STATUS_PENDING - Operation is started and results will
* be sent to the callback.
*
* BT_STATUS_FAILED - operation failed because the token was
* not properly initialized or already active (XA_ERROR_CHECK only).
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_GetRemoteDeviceName(MeCommandToken *token);
/*---------------------------------------------------------------------------
* ME_CancelGetRemoteDeviceName()
*
* Request cancellation of a pending ME_GetRemoteDeviceName request.
* If this function returns BT_STATUS_SUCCESS, then "token" is
* free and no further events will be returned. If this function
* returns BT_STATUS_PENDING, then the result will be returned
* via the callback in "p.meToken" with the BTEVENT_NAME_RESULT event.
* The "errCode" field will indicate a radio-specific error code,
* or BEC_NO_ERROR if the remote name was received before the cancel
* completed.
*
* Parameters:
* token - pointer to token passed in to ME_GetRemoteDeviceName.
*
* Returns:
* BT_STATUS_SUCCESS - the operation has completed successfully.
* The "token" is free and no further events will be returned.
*
* BT_STATUS_PENDING - Operation is started and results will
* be sent to the callback.
*
* BT_STATUS_FAILED - operation failed because the get remote
* device name request is no longer in progress.
*/
BtStatus ME_CancelGetRemoteDeviceName(MeCommandToken *token);
/*---------------------------------------------------------------------------
* ME_SetLocalDeviceName()
*
* Set the local device name. This is the name that other devices will
* get when performing a GetRemoteDeviceName to this device. The name
* is a UTF-8 encoded string. The name can be up to 248 bytes in length.
* If the name is less than 248 bytes it must be null-terminated.
*
* Parameters:
* name - pointer to a UTF-8 encoded string. The name will remain in use
* until the stack is deinitialized, or until this function is called
* with a different name. The name string should not be modified and
* the pointer must remain valid while it is in use.
*
* len - indicates the number of bytes in the name including the null
* termination byte if the name is less than 248 bytes.
*
* Returns:
* BT_STATUS_SUCCESS - The operation is successful.
*
* BT_STATUS_INVALID_PARM - The operation failed because the name or
* length were not properly initialized (XA_ERROR_CHECK only).
*/
BtStatus ME_SetLocalDeviceName(const uint8_t *name, uint8_t len);
/*---------------------------------------------------------------------------
* ME_ReadLocalBdAddr()
*
* Get the 48-bit Bluetooth device address of the local device. This
* request cannot be issued until the radio has been initialized. Check
* ME_GetStackInitState for BTSS_INITIALIZED. If it's not initialized
* wait for the BTEVENT_HCI_INITIALIZED event on a global handler.
*
* Parameters:
* Addr - Pointer to a BD_ADDR structure to receive the address.
*
* Returns:
* BT_STATUS_SUCCESS - Operation was successful.
*
* BT_STATUS_FAILED - Operation failed because the radio is not
* initialized yet. Monitor the global events to be notified
* when the radio is initialized (BTEVENT_HCI_INITIALIZED).
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_ReadLocalBdAddr(BD_ADDR *Addr);
/*---------------------------------------------------------------------------
* ME_SetClassOfDevice()
*
* Set the class of device. The class of device is sent out as part of
* the response to inquiry. The actual bit pattern that is sent out is
* a composite of the value set using this function and the service
* class information found in registered SDP records.
*
* Parameters:
* classOfDevice - A 32-bit integer where the lower 3 bytes represents
* the class of device. The most significant 8 bits are ignored.
*
* Returns:
* BT_STATUS_SUCCESS - Operation is successful.
*/
BtStatus ME_SetClassOfDevice(BtClassOfDevice classOfDevice);
/*---------------------------------------------------------------------------
* ME_FindRemoteDevice()
*
* Return a pointer to the BtRemoteDevice structure corresponding to
* the device with given BD_ADDR. 0 is returned if a match is not found.
*
* When this function returns successfully, the BtRemoteDevice structure
* returned always refers to a connected or connecting device. Use
* caution, as it will also return successfully if the device is in the
* process of disconnecting, but has not yet completed. This typically
* occurs if called during the notification of a link failure.
*
* Parameters:
* bdAddr - pointer to 48-bit address of the device
*
* Returns:
* Pointer to BtRemoteDevice structure if found. 0 is returned if the
* device is not found.
*/
BtRemoteDevice *ME_FindRemoteDevice(BD_ADDR *bdAddr);
/* Prototype for actual ME_FindRemoteDevice implementation */
BtRemoteDevice *ME_FindRemoteDeviceP(uint8_t* bdAddr);
#define ME_FindRemoteDevice(bd) (ME_FindRemoteDeviceP((bd)->addr))
/*---------------------------------------------------------------------------
* ME_CreateLink()
*
* Create an ACL link to the device specified by "bdAddr". If
* this function returns BT_STATUS_PENDING the results will be sent to
* the handler. When the operation is complete all registered global
* handlers will receive BTEVENT_LINK_CONNECT_CNF as will the handler
* passed to this function. The "errCode" field of the BtEvent will
* indicate if the operation was successful or not. If an incoming
* connection is in progress to this device then the handler will be
* bound and when the incoming connection is complete the handler will
* receive the BTEVENT_LINK_CONNECT_CNF event. In this case all global
* registered handlers will receive BTEVENT_LINK_CONNECT_IND instead of
* BTEVENT_LINK_CONNECT_CNF.
*
* If connections already exist to other devices, then ME will attempt
* to put all other connections on hold, then begin a connection
* to the specified device.
*
* If a connection already exists to the device indicated by bdAddr,
* this function will register the handler with the BtRemoteDevice
* and return BT_STATUS_SUCCESS immediately. In this way, many local
* handlers can be registered to the same connection. Be aware that
* ME_DisconnectLink will not take effect until it is called for
* ALL registered handlers of the BtRemoteDevice. To determine whether
* a connection already exists without registering a handler,
* use ME_FindRemoteDevice instead.
*
* A slave device does not need to use this API unless it needs
* to register a local handler or initiate a disconnection of the link
* (see ME_DisconnectLink).
*
* The type of connection created to the remote device uses
* the quality of service parameters necessary for the RFCOMM
* based profiles or profiles requiring reliable, non
* real-time critical links. For other types of connections, use
* ME_CreateRestrictedLink.
*
* Parameters:
* handler - pointer to an unregistered handler to receive
* events. This handler cannot be the global handler though
* they both can point to the same callback. The handler
* must be initialized using ME_InitHandler. The handler
* is in use until the link is disconnected and should not
* be modified while in use.
*
* bdAddr - pointer to address of remote device.
*
* psi - pointer to page scan information obtained during
* Inquiry. Initial links to a device should set this parameter
* to ensure a reliable connection. If the psi is not known, a
* default "psi" of 0 on an initial link will use clockOffset = 0,
* psMode = 0, and psRepMode = 1. If a client is binding to an
* existing remote device, then "psi" can be set to 0.
*
* remDev - pointer to memory to receive remote device pointer.
*
* Returns:
* BT_STATUS_PENDING - operation has started successfully
* result will be sent to handler.
*
* BT_STATUS_SUCCESS - client is successfully bound to the remote device.
*
* BT_STATUS_RESTRICTED - the operation failed because this remote
* device already has a restricted link. The handler is free.
*
* BT_STATUS_IN_PROGRESS - the operation failed because this remote
* device is in the process of being disconnected. The handler
* is free.
*
* BT_STATUS_NO_RESOURCES - the operation failed because
* the maximum number of connections already exist. The
* handler is free.
*
* BT_STATUS_FAILED - operation failed because the handler is 0, the
* callback is 0 or the handler is not initialized (XA_ERROR_CHECK
* only). The handler is free.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_CreateLink(BtHandler *handler, BD_ADDR *bdAddr,
BtPageScanInfo *psi, BtRemoteDevice **remDev);
/*---------------------------------------------------------------------------
* ME_CreateRestrictedLink()
*
* (Not implemented.)
*
* Create a restricted Link to a remote device. A restricted
* link is one where only the client specified by the handler
* is allowed to bind to the connection. The client also has
* the ability to specify the quality of service parameters
* so a time bounded link with specific latency and bandwidth
* can be created.
*
* If this function returns BT_STATUS_PENDING the results will be sent
* to the handler. When the operation is complete all registered global
* handlers will receive BTEVENT_LINK_CONNECT_CNF as will the handler
* passed to this function. The "errCode" field of the BtEvent will
* indicate if the operation was successful or not. If an incoming
* connection is in progress to this device then the handler will be
* bound and when the incoming connection is complete the handler will
* receive the BTEVENT_LINK_CONNECT_CNF event. In this case all global
* registered handlers will receive BTEVENT_LINK_CONNECT_IND instead of
* BTEVENT_LINK_CONNECT_CNF.
*
* If connections already exist to another devices then all
* existing connections will be put on hold while this operation
* takes place.
*
* Parameters:
* handler - pointer to registered handler to receive events.
*
* bdAddr - address of remote device.
*
* psi - pointer to page scan information obtained during
* Inquiry. If this information is not known then "psi" should be
* set to 0.
*
* Returns:
* BT_STATUS_PENDING - operation was started successfully and
* results will be sent to the handler.
*
* BT_STATUS_RESTRICTED - operation failed because this remote
* device already has a restricted link.
*
* BT_STATUS_IN_PROGRESS - the operation failed because this
* remote device is in the process of being disconnected.
*
* BT_STATUS_NO_RESOURCES - the operation failed because
* the maximum number of connections already exist. The
* handler is free.
*
* BT_STATUS_FAILED - operation failed because the handler
* is 0, the callback is 0 or the handler is not initialized
* (XA_ERROR_CHECK only). The handler is free.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_CreateRestrictedLink(BtHandler *handler, BD_ADDR *bdAddr,
BtPageScanInfo *psi,
BtRestrictedInfo *resInfo);
/*---------------------------------------------------------------------------
* ME_ForceDisconnectLinkWithReason()
*
* Force disconnection of the link regardless of registered handlers.
* See ME_DisconnectLink for additional information.
*
* Parameters:
* handler - pointer to registered handler (can be 0).
*
* remDev - pointer to the remote device to be disconnected.
*
* reason - disconnect reason. Must be one of: BEC_AUTHENTICATE_FAILURE,
* BEC_USER_TERMINATED, BEC_LOW_RESOURCES, BEC_POWER_OFF,
* BEC_UNSUPPORTED_REMOTE, or BEC_PAIR_UNITKEY_NO_SUPP.
*
* forceDisconnect - If TRUE, will attempt to disconnect regardless of
* whether other handlers are still registered. If FALSE, behaves as
* ME_DisconnectLinkWithReason.
*
* Returns:
* BT_STATUS_INVALID_PARM - the operation failed because the "reason"
* parameter is invalid for a disconnect link operation.
*
* See ME_DisconnectLink for additional returns.
*/
BtStatus ME_ForceDisconnectLinkWithReason(BtHandler *handler,
BtRemoteDevice *remDev,
BtErrorCode reason,
int forceDisconnect);
/*---------------------------------------------------------------------------
* ME_DisconnectLinkWithReason()
*
* Request disconnection of the link with a non-default reason code.
* See ME_DisconnectLink for additional information.
*
* Parameters:
* handler - pointer to registered handler.
*
* remDev - pointer to the remote device to be disconnected.
*
* reason - disconnect reason. If multiple handlers call this
* function or ME_DisconnectLink, the last handler's reason code
* will be used. If reason is BEC_POWER_OFF, disconnect is
* more forceful in that all the handlers need not have already
* been freed.
*
* Returns:
* BT_STATUS_INVALID_PARM - the operation failed because the "reason"
* parameter is invalid for a disconnect link operation.
*
* See ME_DisconnectLink for additional returns.
*/
BtStatus ME_DisconnectLinkWithReason(BtHandler* handler,
BtRemoteDevice* remDev,
BtErrorCode reason);
#define ME_DisconnectLinkWithReason(ha, rd, rs) \
(ME_ForceDisconnectLinkWithReason(ha, rd, rs, FALSE))
/*---------------------------------------------------------------------------
* ME_DisconnectLink()
*
* Request disconnection of the link, using the default reason code
* (BEC_USER_TERMINATED). This function also deregisters the
* specified handler, which was previously registered with ME_CreateLink
* or ME_CreateRestrictedLink.
*
* The link is actually closed only when all registered handlers have
* requested disconnection and all L2CAP connections are closed. If
* a device needs to know exactly when the disconnection occurs,
* it should use a global handler to monitor connection state. The
* handler specified in this API is freed by this function, so it
* will not be notified of any disconnection events.
*
* If the remote device initiated the connection, the local
* device may have no registered handler for the connection. In this
* case, the local device must call ME_CreateLink or
* ME_CreateRestrictedLink to register a handler, then call this function
* to request disconnection.
*
* Parameters:
* handler - pointer to registered handler.
*
* remDev - pointer to the remote device to be disconnected.
*
* Returns:
* BT_STATUS_SUCCESS - the operation has completed successfully.
* The caller's handler is unbound from the link. When the link
* is actually disconnected the BTEVENT_LINK_DISCONNECT event will
* be sent to all registered global handlers, unless the link had
* not actually come up yet, in which case no event will be
* generated. The handler is free upon return from this function.
*
* BT_STATUS_IN_PROGRESS - the operation failed because the
* link is the process of coming up. The connect request has
* been made by a remote device. Wait until the
* BTEVENT_LINK_CONNECT_CNF event has been received. The handler
* is not free.
*
* BT_STATUS_FAILED - the operation failed. The link is
* already disconnected, disconnect has already been
* issued for this handler, or the handler is not
* bound to the link (XA_ERROR_CHECK only).
*/
BtStatus ME_DisconnectLink(BtHandler* handler, BtRemoteDevice* remDev);
#define ME_DisconnectLink(ha, rd) \
(ME_ForceDisconnectLinkWithReason(ha, rd, BEC_USER_TERMINATED, FALSE))
/*---------------------------------------------------------------------------
* ME_CancelCreateLink()
*
* Request cancellation of the pending ME_CreateLink. This function
* also deregisters the specified handler, which was previously
* registered when the ME_CreateLink was initiated.
*
* Parameters:
* handler - pointer to registered handler.
*
* remDev - pointer to the remote device associated with the
* ME_CreateLink to be canceled.
*
* Returns:
* BT_STATUS_SUCCESS - the operation has completed successfully.
* The caller's handler is unbound from the link. If more than one
* handler is bound to the link, no further events will occur.
* Otherwise, the BTEVENT_LINK_CREATE_CANCEL event will be sent to
* all registered global handlers when the cancel completes. The
* global handler must still check the BtEvent "errCode" field
* in the event structure, as the cancel may fail and the link may
* require further maintenance. The handler is free upon return
* from this function.
*
* BT_STATUS_FAILED - the operation failed. The link is already
* connected or disconnected, or the handler is not bound to
* the link (XA_ERROR_CHECK only).
*/
BtStatus ME_CancelCreateLink(BtHandler* handler, BtRemoteDevice* remDev);
/*---------------------------------------------------------------------------
* ME_RegisterAcceptHandler()
*
* Register the handler that will accept incoming connections.
* If no handler is registered then the Management Entity will
* accept all incoming connections automatically. If the
* handler is set it will be responsible for accepting
* connections by calling ME_AcceptIncomingLink. The handler
* will be notified with the BTEVENT_LINK_CONNECT_REQ event. The
* p.remDev field of the btEvent will contain a pointer to the
* remote device.
*
* Parameters:
* handler - pointer to handler. This can be a registered global
* handler but does not have to be.
*
* Returns:
* Pointer to old handler.
*/
BtHandler *ME_RegisterAcceptHandler(BtHandler *handler);
/*---------------------------------------------------------------------------
* ME_AcceptIncomingLink()
*
* Accept an incoming link. The incoming link is signaled by
* a call to the accept handler with the event
* BTEVENT_LINK_CONNECT_REQ.
*
* Parameters:
* remDev - pointer to the remote device structure representing
* the incoming connection. This was passed in the
* "btEvent.p.remDev" field of the BTEVENT_LINK_CONNECT_REQ event.
*
* role - desired role. BCR_MASTER cause a master/slave switch
* with the local device becoming the master. BCR_SLAVE will
* cause the local device to remain the slave.
*
* Returns:
* BT_STATUS_PENDING - the operation was started successfully
* and the result will be sent to the accept handler via
* the BTEVENT_LINK_ACCEPT_RSP event. When complete all registered
* global handlers will receive the BTEVENT_LINK_CONNECT_IND event.
* The "errCode" field of the BtEvent will indicate the success.
*
* BT_STATUS_FAILED - the operation failed because the remote
* device is not in a state to accept an incoming connection.
*
* BT_STATUS_INVALID_PARM - the operation failed because the
* "remDev" parameter is invalid or 0, or the role parameter
* is invalid (XA_ERROR_CHECK only).
*
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_AcceptIncomingLink(BtRemoteDevice *remDev, BtConnectionRole role);
/*---------------------------------------------------------------------------
* ME_RejectIncomingLink()
*
* Reject an incoming link. The incoming link is signaled by
* a call to the accept handler with the event
* BTEVENT_LINK_CONNECT_REQ.
*
* Parameters:
* remDev - pointer to the remote device structure representing
* the incoming connection. This was passed in the
* "btEvent.p.remDev" field of the BTEVENT_LINK_CONNECT_REQ event.
*
* reason - reason for the rejection. The only reasons allowed
* are as follows:
*
* BEC_LIMITED_RESOURCE - Host rejected due to limited resources
*
* BEC_SECURITY_ERROR - Host rejected due to security reasons
*
* BEC_PERSONAL_DEVICE - Host rejected (remote is personal device)
*
*
* Returns:
* BT_STATUS_PENDING - the operation was started successfully
* and the result will be sent to the accept handler via
* the BTEVENT_LINK_REJECT_RSP event.
*
* BT_STATUS_FAILED - the operation failed because the remote
* device is not in a state to reject an incoming connection.
*
* BT_STATUS_INVALID_PARM - the operation failed because the
* "remDev" parameter is invalid or 0, or the reason is not
* valid (XA_ERROR_CHECK only).
*
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_RejectIncomingLink(BtRemoteDevice *remDev, BtErrorCode reason);
/*---------------------------------------------------------------------------
* ME_SetConnectionRole()
*
* Set the role that the local device prefers in both incoming
* and outgoing connections. This role applies only if there is no
* registered accept handler when the Management Entity automatically
* accepts incoming connections. The connection role applies to
* all future connections; it does not affect existing connections.
*
* Parameters:
* role - The desired role must be BCR_MASTER or BCR_ANY. When set to
* BCR_ANY, incoming connections default to slave role and outgoing
* connections default to master role, the remote device may
* change these roles. When set to BCR_MASTER, incoming connections
* force a role switch and outgoing connections do not permit a
* role switch. If the remote device refuses a master/slave switch,
* the connection will still succeed with role unchanged.
*
* Returns:
* The old role.
*/
BtConnectionRole ME_SetConnectionRole(BtConnectionRole role);
/*---------------------------------------------------------------------------
* ME_GetCurrentMode()
*
* Get the current mode of the link to the remote device. The
* value is meaningless if a connection does not exist to
* the remote device. This function does not check for a valid
* remDev pointer.
*
* Parameters:
* rm - pointer to remote device.
*
* Returns:
* The current mode if a link exists otherwise the value
* is meaningless.
*/
BtLinkMode ME_GetCurrentMode(BtRemoteDevice *rm);
#define ME_GetCurrentMode(r) ((r)->mode)
/*---------------------------------------------------------------------------
* ME_GetCurrentRole()
*
* Get the current role played by the local device. The
* value is meaningless if a connection does not exist to
* the remote device. This function does not check for a valid
* remDev pointer. When the role is currently being discovered,
* the role BCR_UNKNOWN will be returned. When the role discovery
* completes, the BTEVENT_ROLE_CHANGE event will be indicated.
*
* Parameters:
* rm - pointer to remote device.
*
* Returns:
* The current role if a link exists otherwise the value
* is meaningless.
*/
BtConnectionRole ME_GetCurrentRole(BtRemoteDevice *rm);
#define ME_GetCurrentRole(r) ((r)->role > BCR_UNKNOWN ? BCR_UNKNOWN : (r)->role)
/*---------------------------------------------------------------------------
* ME_StartSniff()
*
* Start sniff mode for the ACL link specified by "remDev".
*
* Parameters:
* remDev - pointer to remote device
*
* info - pointer to the sniff mode parameters. This structure may
* be freed after ME_StartSniff returns.
*
* Returns:
* BT_STATUS_PENDING - the operation was started successfully.
* All registered handlers and handlers bound to the remote device
* will receive the BTEVENT_MODE_CHANGE event. The "errCode" field
* of the BtEvent will indicate the success or failure of the mode
* change event. The "p.modeChange" field indicates for which remote
* Device the change has occurred along with the new mode and
* interval. It is possible that link is disconnected before the
* mode change has occurred. In that case the handlers will not
* receive BTEVENT_MODE_CHANGE but instead will receive
* BTEVENT_LINK_DISCONNECT.
*
* BT_STATUS_INVALID_PARM - Invalid parameter (XA_ERROR_CHECK only).
*
* BT_STATUS_IN_PROGRESS - the operation failed because a mode
* change or disconnect operation is already in progress.
*
* BT_STATUS_FAILED - the operation failed.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected. 9
*/
BtStatus ME_StartSniff(BtRemoteDevice *remDev, const BtSniffInfo *info);
/*---------------------------------------------------------------------------
* ME_StopSniff()
*
* Stop sniff mode and enter active mode for the ACL link
* specified by remDev.
*
* Parameters:
* remDev - pointer to remote device.
*
* Returns:
* BT_STATUS_PENDING - the operation was started successfully.
* All registered handlers and handlers bound to the remote device
* will receive the BTEVENT_MODE_CHANGE event. The "errCode" field
* of the BtEvent will indicate the success or failure of the mode
* change event. The "p.modeChange" field indicates for which remote
* Device the change has occurred along with the new mode and
* interval. It is possible that link is disconnected before the
* mode change has occurred. In that case the handlers will not
* receive BTEVENT_MODE_CHANGE but instead will receive
* BTEVENT_LINK_DISCONNECT.
*
* BT_STATUS_INVALID_PARM - the parameters are not valid
* (XA_ERROR_CHECK only).
*
* BT_STATUS_IN_PROGRESS - the operation failed because a mode
* change or disconnect operation is already in progress.
*
* BT_STATUS_FAILED - the operation failed. Device is not in
* sniff mode.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_StopSniff(BtRemoteDevice *remDev);
/*---------------------------------------------------------------------------
* ME_SetSniffSubratingParms()
*
* Set the Sniff Subrating Parameters for ACL link specified by "remDev".
*
* Parameters
* remDev - pointer to remote device
*
* info - pointer to the Sniff Subrating parameters. This structure may
* be freed after ME_SetSniffSubratingParms() returns.
*
* Returns:
* BT_STATUS_PENDING - the operation was started successfully.
* All registered handlers and handlers bound to the remote device
* will receive the BTEVENT_SET_SNIFF_SUBRATING_PARMS_CNF event.
* The "errCode" field of the BtEvent will indicate the success or
* failure of the command. The "p.sniffSubrateParms" field contains
* the parameters during the call. When Sniff Subrating is enabled
* or re-negotiated on the link, a BTEVENT_SNIFF_SUBRATE_INFO event
* will be received. These parameters are valid for the duration
* of the ACL link.
*
* BT_STATUS_INVALID_PARM - Invalid parameter (XA_ERROR_CHECK only).
*
* BT_STATUS_IN_PROGRESS - the operation failed because a mode
* change or disconnect operation is already in progress.
*
* BT_STATUS_FAILED - the operation failed.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_SetSniffSubratingParms(BtRemoteDevice *remDev, const BtSniffSubrateParms *parms);
/*---------------------------------------------------------------------------
* ME_SwitchRole()
*
* Switch the current role the device is performing for the ACL link
* specified by remDev. If the current role is slave then switch to
* master. If the current role is master then switch to slave. The
* current role can be found via remDev.role. The result of the
* operation will be returned via the BTEVENT_ROLE_CHANGE event.
*
* Parameters:
* remDev - pointer to remote device
*
* Returns:
* BT_STATUS_PENDING - the operation was started successfully.
* All registered handlers and handlers bound to the remote device
* will receive the BTEVENT_ROLE_CHANGE event. The "errCode" field
* of the BtEvent will indicate the success or failure of the role
* change event. The "p.roleChange" field indicates for which remote
* Device the change has occurred along with the new role. It is
* possible that link is disconnected before the role change has
* occurred. In that case the handlers will not receive
* BTEVENT_ROLE_CHANGE but instead will receive
* BTEVENT_LINK_DISCONNECT.
*
* BT_STATUS_INVALID_PARM - the parameters are not valid
* (XA_ERROR_CHECK only).
*
* BT_STATUS_IN_PROGRESS - the operation failed because a mode
* change or disconnect operation is already in progress.
*
* BT_STATUS_FAILED - the operation failed.
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_SwitchRole(BtRemoteDevice *remDev);
/*---------------------------------------------------------------------------
* ME_SetAccessibleModeNC()
*
* Set the accessibility mode when the device is not
* connected. If the mode is set to a value other than
* BAM_NOT_ACCESSIBLE and there are no connections then the
* Bluetooth radio will enter inquiry and/or page scan mode
* using the information passed in info. If info is 0 or the
* values in info are set to defaults (BT_DEFAULT_SCAN_INTERVAL
* and BT_DEFAULT_SCAN_WINDOW) the radio module default values
* are used. It is assumed that the macro defaults
* match the radio defaults (see BT_DEFAULT_PAGE_SCAN_WINDOW
* documentation.) So, the first call to ME_SetAccessibleModeNC
* with info set to 0 will not change the settings as the radio has
* already been initialized to its default settings. If there is
* a connection or a connection is in the process of being created
* then mode and info are saved and applied when all connections are
* disconnected.
*
* To keep other devices from finding and connecting to this
* device set the mode to BAM_NOT_ACCESSIBLE. The default mode when
* the stack is first loaded and initialized is controlled by
* BT_DEFAULT_ACCESS_MODE_NC.
*
* In setting the values for info. Both "inqWindow" and
* "inqInterval" must be set to defaults or to legitimate
* values. The range for values is 0x0012 to 0x1000. The time
* calculated by taking the value * 0.625ms. It is an error
* if one is a default and the other is not. This is also true
* for "pageInterval" and "pageWindow".
*
* Any time the scan interval or window is different from
* the current settings in the radio, the radio will be
* instructed to change to the new settings. This means that
* if there are different settings for the connected state
* versus the non-connected state, the radio module will be
* instructed to change the settings when the first connection
* comes up and when the last connection goes down
* (automatically). This also means that if different values
* for window and interval are set when going from any setting
* of accessible to non-accessible then the radio will be
* instructed to change. In most cases it is best to use
* the radio defaults. In this way the radio is never told
* to change the scan interval or window.
*
* Parameters:
* mode - desired accessibility mode
*
* info - pointer to structure containing the inquiry and page
* scan interval and window to use. If info is 0 then the
* defaults set by the radio module are used.
*
* Returns:
* BT_STATUS_PENDING - the mode is being set. All registered
* global handlers with the BEM_ACCESSIBLE_CHANGE mask set will
* receive BTEVENT_ACCESSIBLE_CHANGE event when the mode change
* actually takes affect or an error has occurred. The "errCode"
* field of the BtEvent indicates the status of the operation.
* If the operation is successful the "aMode" field of BtEvent
* indicates the new mode. A BTEVENT_HCI_FATAL_ERROR event
* indicates a fatal radio or HCI transport error and that all
* pending operations have failed.
*
* BT_STATUS_SUCCESS - Accessible mode is set. No event
* is sent out. This is returned if a connection exists and
* the values are only saved or info already matches the current
* setting.
*
* BT_STATUS_IN_PROGRESS - operation failed because a change
* is already in progress. Monitor the global events to
* determine when the change has taken place.
*
* BT_STATUS_INVALID_PARM - operation failed. The mode or info
* parameter contains bad values (XA_ERROR_CHECK only)
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_SetAccessibleModeNC(BtAccessibleMode mode, const BtAccessModeInfo *info);
/*---------------------------------------------------------------------------
* ME_GetAccessibleModeNC()
*
* Return the current accessibility mode that is used when no
* connections exist. This is not necessarily the current mode.
*
* Parameters:
* mode - pointer to memory to receive accessibility mode. If
* mode is 0 then mode is not returned. If the accessible mode
* has not yet been set, and therefore unknown, 0xff will be returned.
*
* info - pointer to structure to receive accessibility info.
* If info is 0 then info is not returned.
*
* Returns:
* BT_STATUS_SUCCESS - operation was successful
*
* BT_STATUS_IN_PROGRESS - operation failed because a change
* is in progress. Monitor the global events to determine when
* the change is finished.
*
* BT_STATUS_FAILED - operation failed.
*/
BtStatus ME_GetAccessibleModeNC(BtAccessibleMode *mode,
BtAccessModeInfo *info);
/*---------------------------------------------------------------------------
* ME_GetCurAccessibleMode()
*
* Return the current accessibility mode. This is the mode
* at the very instant that call is made. It may be about
* to change so it is important to check the global events.
*
* Parameters:
* mode - pointer to memory to receive accessibility mode. If
* mode is 0 then mode is not returned. If the accessible mode
* has not yet been set, and therefore unknown, 0xff will be returned.
*
* info - pointer to structure to receive accessibility info.
* If info is 0 then info is not returned.
*
* Returns:
* BT_STATUS_SUCCESS - operation was successful
*
* BT_STATUS_FAILED - operation failed.
*/
BtStatus ME_GetCurAccessibleMode(BtAccessibleMode *mode,
BtAccessModeInfo *info);
/*---------------------------------------------------------------------------
* ME_SetAccessibleModeC()
*
* Set the accessibility mode to be used when the device is
* connected to one or more devices. If the mode is set to a
* value other than BAM_NOT_ACCESSIBLE and there is a
* connection to one or more devices then the Bluetooth radio
* will enter inquiry and/or page scan mode using the
* information passed in info. If info is 0 or the values in
* info are set to defaults (BT_DEFAULT_SCAN_INTERVAL and
* BT_DEFAULT_SCAN_WINDOW) the radio module default values
* are used. It is assumed that the macro defaults
* match the radio defaults (see BT_DEFAULT_PAGE_SCAN_WINDOW
* documentation.) So, the first call to ME_SetAccessibleModeC
* with info set to 0 will not change the settings as the radio has
* already been initialized to its default settings. If there are
* no active connections then mode and info are saved and applied
* when the first connection comes up.
*
* To keep other devices from finding and connecting to this
* device when connected set the mode to BAM_NOT_ACCESSIBLE.
* The default mode when the stack is first loaded and initialized
* is controlled by BT_DEFAULT_ACCESS_MODE_C.
*
* In setting the values for info. Both "inqWindow" and
* "inqInterval" must be set to defaults or to legitimate
* values. The range for values is 0x0012 to 0x1000. The time
* is calculated by taking the value * 0.625ms. It is an error
* if one field (interval/window) is a default and the other is
* not. This also true for "pageInterval" and "pageWindow".
*
* Any time the scan interval or window is different from
* the current settings in the radio, the radio will be
* instructed to change to the new settings. This means that
* if there are different settings for the connected state
* versus the non-connected state, the radio module will be
* instructed to change the settings when the first connection
* comes up and when the last connection goes down
* (automatically). This also means that if different values
* for window and interval are set when going from any setting
* of accessible to non-accessible then the radio will be
* instructed to change. In most cases it is best to use
* the radio defaults. In this way the radio is never told
* to change the scan interval or window.
*
* Requires:
* BT_ALLOW_SCAN_WHILE_CON enabled.
*
* Parameters:
* mode - desired accessibility mode
*
* info - pointer to structure containing the inquiry and page
* scan interval and window to use. If info is 0 then the
* defaults set by the radio module are used.
*
* Returns:
* BT_STATUS_PENDING - the mode is being set. All registered
* global handlers with the BEM_ACCESSIBLE_CHANGE mask set will
* receive BTEVENT_ACCESSIBLE_CHANGE event when the mode change
* actually takes affect or an error has occurred. The "errCode"
* field of the BtEvent indicates the status of the operation.
* If the operation is successful the "aMode" field of BtEvent
* indicates the new mode. A BTEVENT_HCI_FATAL_ERROR event
* indicates a fatal radio or HCI transport error and that all
* pending operations have failed.
*
* BT_STATUS_SUCCESS - Accessible mode is set. No event
* is sent out. This is returned if no connections exist and
* the values are only saved or info already matches the current
* setting.
*
* BT_STATUS_IN_PROGRESS - operation failed because a change
* is already in progress. Monitor the global events to
* determine when the change has taken place.
*
* BT_STATUS_INVALID_PARM - operation failed. The mode or info
* parameter contains bad values (XA_ERROR_CHECK only)
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_SetAccessibleModeC(BtAccessibleMode mode, const BtAccessModeInfo *info);
/*---------------------------------------------------------------------------
* ME_GetAccessibleModeC()
*
* Return the current accessibility mode that is used when
* connections exist. This is not necessarily the current
* mode.
*
* Requires:
* BT_ALLOW_SCAN_WHILE_CON enabled.
*
* Parameters:
* mode - pointer to memory to receive accessibility mode. If
* mode is 0 then mode is not returned. If the accessible mode
* has not yet been set, and therefore unknown, 0xff will be returned.
*
* info - pointer to structure to receive accessibility info.
* If info is 0 then info is not returned.
*
* Returns:
* BT_STATUS_SUCCESS - operation was successful
*
* BT_STATUS_IN_PROGRESS - operation failed because a change
* is in progress. Monitor the global events to determine when
* the change is finished.
*
* BT_STATUS_FAILED - operation failed.
*/
BtStatus ME_GetAccessibleModeC(BtAccessibleMode *mode, BtAccessModeInfo *info);
/*---------------------------------------------------------------------------
* ME_SendHciCommandSync()
*
* Send an HCI command synchronously. This function is used to send HCI
* commands not handled directly by the ME and radio specific
* user defined commands. Synchronously means that the command will
* block other HCI commands until it is complete. Use ME_SendHciCommandSync
* for HCI operations that return with the "Command Complete" event
* or local operations that do not require communication with a remote device.
* The "Command Status" event with an error will also cause the operation
* to complete. If the function returns BT_STATUS_PENDING then the result
* will be returned via the callback in the token with the
* BTEVENT_COMMAND_COMPLETE event.
*
* The caller must fill in the "in" fields of the MeCommandToken.
* The "out" fields of the MeCommandToken will contain the result
* of the operation. The "errCode" field of the BtEvent is not valid
* since the "errCode" is part of the event and its location in "parms"
* varies.
*
* Parameters:
* token - pointer to token containing input parameters and
* storage for output parameters. The token must be initialized
* before calling this function as follows:
*
* "token.callback" must be set to the callback function.
*
* "token.p.general.in.hciCommand" must contain the desired command.
* The command can be one of the HCI commands defined in hci.h that
* is not supported by the ME or user defined commands.
*
* "token.p.general.in.parmLen" must contain the length of the
* parameter.
*
* "token.p.general.in.parms" must point to the command parameters.
* The memory pointed to by "parms" must be valid until the operation
* is complete.
*
* "token.p.general.in.event" must contain the event that is expected
* to signal completion of the operation. The most common event is
* "Command Complete". See hci.h for a list of events. The "Command
* Status" event is always checked. If a "Command Status" event is
* received with an error then the operation is considered complete.
* If a "Command Status" is received without an error then the command
* will finish when the event matches "token.p.general.in.event".
*
* Returns:
* BT_STATUS_PENDING - Operation is started and results will
* be sent to the callback. A BTEVENT_HCI_FATAL_ERROR event
* indicates a fatal radio or HCI transport error and all
* pending operations have failed.
*
* BT_STATUS_INVALID_TYPE - Operation failed because
* "token.p.general.in.hciCommand" is a command already handled by
* the ME or "token.p.general.in.event" is an asynchronous event
* already handled by the ME.
*
* BT_STATUS_INVALID_PARM - Operation failed because the parameter
* length exceeds HCI_CMD_PARM_LEN, the maximum allowed
* parameter size for an HCI command.
*
* BT_STATUS_FAILED - operation failed because the token was
* not properly initialized or already active (XA_ERROR_CHECK only).
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_SendHciCommandSync(MeCommandToken *token);
/*---------------------------------------------------------------------------
* ME_SendHciCommandAsync()
*
* Send an HCI command asynchronously. This function is used to send HCI
* commands not implemented explicitly by the ME and radio specific
* user defined commands. Asynchronously means that the command will not
* block other HCI commands. It will wait for a "Command Status" event
* but then will allow other HCI commands to execute as it waits for
* the asynchronous event signaling the completion of the operation.
* The result will be returned when the appropriate event as set in
* "token.p.general.in.event" is received. If the function returns
* BT_STATUS_PENDING then the result will be returned via the callback
* in the token with the BTEVENT_COMMAND_COMPLETE event.
*
* The caller must fill in the "in" fields of the MeCommandToken.
* The "out" fields of the MeCommandToken will contain the result
* of the operation. The "errCode" field of the BtEvent is not valid
* since the "errCode" is part of the event and its location in "parms"
* varies.
*
* Only one Async operation with the same event is allowed to
* execute at a time. Any additional requests are queued until the
* first command is complete.
*
* Parameters:
* token - pointer to token containing input parameters and
* storage for output parameters. The token must be initialized
* before calling this function as follows:
*
* "token.callback" must be set to the callback function.
*
* "token.p.general.in.hciCommand" must contain the desired command.
* The command can be one of the HCI commands defined in hci.h that
* is not supported by the ME or user defined commands.
*
* "token.p.general.in.parmLen" must contain the length of the
* parameter.
*
* "token.p.general.in.parms" must point to the command parameters.
* The memory pointed to by "parms" must be valid until the operation
* is complete.
*
* "token.p.general.in.event" must contain the event that is expected
* to signal completion of the operation. The "Command Status" event
* is always checked. If a "Command Status" event is returned
* with an error then the operation is considered complete. If a
* "Command Status" is returned without an error then the command
* will finish when the event matches "token.p.general.in.event".
*
* Returns:
* BT_STATUS_PENDING - Operation is started and results will
* be sent to the callback. A BTEVENT_HCI_FATAL_ERROR event
* indicates a fatal radio or HCI transport error and all
* pending operations have failed.
*
* BT_STATUS_INVALID_TYPE - Operation failed because
* "token.p.general.in.hciCommand" is a command already handled by
* the ME or "token.p.general.in.event" is an asynchronous event
* already handled by the ME.
*
* BT_STATUS_INVALID_PARM - Operation failed because the parameter
* length exceeds HCI_CMD_PARM_LEN, the maximum allowed
* parameter size for an HCI command.
*
* BT_STATUS_FAILED - operation failed because the token was
* not properly initialized or already active (XA_ERROR_CHECK only).
*
* BT_STATUS_HCI_INIT_ERR - operation failed because the HCI has
* an initialization error. Monitor the global events to
* be notified when the error has been corrected.
*/
BtStatus ME_SendHciCommandAsync(MeCommandToken *token);
/*---------------------------------------------------------------------------
* ME_SetDefaultLinkPolicy()
*
* Set the default link policy used on outgoing and incoming ACL
* connections. The link policy determines the behavior of the local
* link manager when it receives a request from a remote device or it
* determines itself to change the master-slave role or to enter hold,
* sniff, or park mode. The default if this function is not called
* is to disable all modes.
*
* Policy for incoming ACL connections is set independent of policy
* for outgoing connections. The default policy is applied immediately
* after the link comes up. An higher level Management Entity should
* use this function, not applications. It should be called before any
* ACL connections exist and does not effect existing
* ACL connections.
*
* If this function has not been called, the default link policy applied
* to both incoming and outgoing connections is BLP_DISABLE_ALL.
*
* Parameters:
* inACL - default link policy applied to all incoming ACL connections.
* Incoming ACL connections are those initiated by a remote device.
*
* outACL - default link policy applied to all outgoing ACL connections.
* Outgoing ACL connections are those initiated by the local device.
*
* Returns:
* BT_STATUS_SUCCESS - operation was successful.
*
* BT_STATUS_FAILED - operation failed because the policy settings are
* not valid (error checking only).
*/
BtStatus ME_SetDefaultLinkPolicy(BtLinkPolicy inACL, BtLinkPolicy outACL);
/*---------------------------------------------------------------------------
* ME_SetLinkPolicy()
*
* Set the link policy used on outgoing and incoming ACL
* connections. The link policy determines the behavior of the local
* link manager when it receives a request from a remote device or it
* determines itself to change the master-slave role or to enter hold,
* sniff, or park mode.
*
* Parameters:
* remDev - pointer to remote device
*
* policy - link policy applied to all ACL connections.
*
* Returns:
* BT_STATUS_SUCCESS - operation was successful.
*
* BT_STATUS_FAILED - operation failed because the policy settings are
* not valid (error checking only).
*/
BtStatus ME_SetLinkPolicy(BtRemoteDevice *remDev, BtLinkPolicy policy);
/*---------------------------------------------------------------------------
* ME_SetConnectionPacketType()
*
* Changes the allowed ACL packet types for the specified remote device.
* The result of the operation will be returned via the
* BTEVENT_CONN_PACKET_TYPE_CHNG event.
*
* Parameters:
* remDev - pointer to remote device
*
* packetTypes - allowed connection packet types.
*
* Returns:
* BT_STATUS_PENDING - the operation was started successfully.
* All registered handlers and handlers bound to the remote device
* will receive the BTEVENT_CONN_PACKET_TYPE_CHNG event. The
* "errCode" field of the BtEvent will indicate the success or
* failure of the connection packet type change event. The
* "p.packetTypeChng" field indicates for which remote
* Device the change has occurred along with the packet types.
* It is possible that link is disconnected before the connection
* packet type change has occurred so the handlers may not receive
* BTEVENT_CONN_PACKET_TYPE_CHNG but instead will receive
* BTEVENT_LINK_DISCONNECT.
*
* BT_STATUS_INVALID_PARM - The parameters are not valid
* (XA_ERROR_CHECK only).
*
* BT_STATUS_IN_PROGRESS - the operation failed because another
* operation is already in progress.
*
*/
BtStatus ME_SetConnectionPacketType(BtRemoteDevice *remDev,
BtAclPacketType packetTypes);
/*---------------------------------------------------------------------------
* ME_GetHciConnectionHandle()
*
* Get the HCI connection handle for the link to the remote device. The
* value is meaningless if a connection does not exist to the remote
* device.
*
* Parameters:
* rm - pointer to remote device.
*
* Returns:
* The HCI connection handle a link exists otherwise the value
* is meaningless.
*/
uint16_t ME_GetHciConnectionHandle(BtRemoteDevice *rm);
/*---------------------------------------------------------------------------
* ME_GetBdAddr()
*
* Get the 48-bit address of the remote device. The value is meaningless
* if a connection does not exist to the remote device.
*
* Parameters:
* rm - pointer to remote device.
*
* bdAddr - pointer to a BD_ADDR structure to receive the result.
*/
void ME_GetBdAddr(BtRemoteDevice *rm, BD_ADDR* bdAddr);
/*---------------------------------------------------------------------------
* ME_GetRemDevState()
*
* Get the connection state of the remote device. This function
* does not check for a valid remDev pointer.
*
* Parameters:
* remDev - pointer to remote device.
*
* Returns:
* BtRemDevState
*/
BtRemDevState ME_GetRemDevState(BtRemoteDevice *remDev);
#define ME_GetRemDevState(r) ((r)->state)
/*---------------------------------------------------------------------------
* ME_GetRemDevCOD()
*
* Get the Class of Device for the remote device. This function
* does not check for a valid remDev pointer.
*
* Parameters:
* remDev - pointer to remDev.
*
* Returns:
* BtClassOfDevice
*/
BtClassOfDevice ME_GetRemDevCOD(BtRemoteDevice *remDev);
#define ME_GetRemDevCOD(r) ((r)->cod)
/*---------------------------------------------------------------------------
* ME_GetRemDevEncryptState()
*
* Get the encryption state of the remote device. This function
* does not check for a valid remDev pointer.
*
* Parameters:
* remDev - pointer to remDev.
*
* Returns:
* Zero for no encryption, non-zero for encryption.
*/
BtEncryptState ME_GetRemDevEncryptState(BtRemoteDevice *remDev);
#define ME_GetRemDevEncryptState(r) ((r)->encryptState)
/*---------------------------------------------------------------------------
* ME_GetStackInitState()
*
* Reads the initialization state of the stack.
*
* Returns:
* BtStackState - If the value is BTSS_INITIALIZED the stack is
* initialized and ready.
*/
BtStackState ME_GetStackInitState(void);
/*---------------------------------------------------------------------------
* ME_GetBtVersion()
*
* Gets the Bluetooth version of the local radio.
*
* Returns:
* 0 for BT v1.0.
* 1 for BT v1.1.
* 2 for BT v1.2.
* 3 for BT v2.0.
* 4 for BT v2.1.
*/
uint8_t ME_GetBtVersion(void);
/*---------------------------------------------------------------------------
* ME_GetBtFeatures()
*
* Gets the value of the specified byte of the Bluetooth features
* bitmask from the local radio. See the Bluetooth specification for
* a description of the features bitmask.
*
* Parameters:
* byte - byte to retrieve. Must be between 0 and 7.
*
* Returns:
* Value of the specified byte of the BT features bitmask.
*/
uint8_t ME_GetBtFeatures(uint8_t byte);
/*---------------------------------------------------------------------------
* ME_GetRemoteFeatures()
*
* Gets the value of the specified byte of the Bluetooth features
* bitmask from the remote device. See the Bluetooth specification for
* a description of the features bitmask.
*
* Parameters:
* byte - byte to retrieve. Must be between 0 and 7.
*
* Returns:
* Value of the specified byte of the remote features bitmask.
*/
uint8_t ME_GetRemoteFeatures(BtRemoteDevice *remDev, uint8_t byte);
/*---------------------------------------------------------------------------
* ME_GetRemoteHostFeatures()
*
* Gets the value of the specified byte of page 1 of the Bluetooth
* extended features bitmask from the remote device. See the Bluetooth
* specification for a description of the extended features bitmask.
*
* Parameters:
* byte - byte to retrieve. Must be between 0 and 7.
*
* Returns:
* Value of the specified byte of the remote extended features bitmask.
*/
uint8_t ME_GetRemoteHostFeatures(BtRemoteDevice *remDev, uint8_t byte);
/*---------------------------------------------------------------------------
* ME_CheckRadioFeature()
*
* Indicates whether the local radio supports the specified feature.
*
* Parameters:
* feature - Feature code
*
* Returns:
* TRUE if radio indicates its support for the feature. FALSE if not.
*
*/
int ME_CheckRadioFeature(BtRadioFeature feature);
/*---------------------------------------------------------------------------
* ME_CheckRemoteFeature()
*
* Indicates whether the remote radio supports the specified feature.
*
* Parameters:
* feature - Feature code
*
* Returns:
* TRUE if remote radio indicates its support for the feature. FALSE if not.
*
*/
int ME_CheckRemoteFeature(BtRemoteDevice *remDev, BtRadioFeature feature);
/*---------------------------------------------------------------------------
* ME_CheckRemoteHostFeature()
*
* Indicates whether the remote host supports the specified feature.
*
* Parameters:
* feature - Feature code
*
* Returns:
* TRUE if remote host indicates its support for the feature. FALSE if not.
*
*/
int ME_CheckRemoteHostFeature(BtRemoteDevice *remDev, BtRadioFeature feature);
/*---------------------------------------------------------------------------
* ME_HasPendingTask()
*
* Checks for pending ME tasks. The ME task is set when an HCI command
* is sent to the controller. ME_HasPendingTask will return the event
* expected to complete the pending HCI command.
*
* Returns:
* Pending HCI event associated with the completion of the current
* task or 0 for no pending tasks. See HciEventType in hci.h for possible
* return values. If not enough information is available to determine the
* completion event, ME_HasPendingTask returns 0xFF00.
*/
uint16_t ME_HasPendingTask(void);
/*---------------------------------------------------------------------------
* ME_GetChannelClassification()
*
* Gets the channel classification currently stored in ME for Adaptive
* Frequency Hopping (AFH.) See ME_SetChannelClassification.
*
* Parameters:
* channelClass - BtChannelClass structure containing buffer to receive
* the stored channel classification.
*
* Returns:
* BT_STATUS_SUCCESS - The current channel classification has been
* copied to the BtChannelClass structure.
*/
BtStatus ME_GetChannelClassification(BtChannelClass *channelClass);
/*---------------------------------------------------------------------------
* ME_SetChannelClassification()
*
* Sets the channel classification for Adaptive Frequency Hopping (AFH.)
* Each of the 79 1-MHz channels in the Bluetooth 2.4-GHz band may be
* marked bad or unknown. The AFH controller will not use channels
* marked bad. The AFH controller will evaluate for use any channels
* marked unknown (if automatic classification mode is enabled.) Bad
* channels are indicated with a 0 value. Unknown channels are
* indicated with a 1 value in the bit-mask.
*
* Parameters:
* channelClass - 79 1-bit fields in a 10-byte array, indicating channels
* marked bad or unknown. The nth field (0 - 78) indicates the value
* for channel n. Bit 79 is unused and must be 0.
*
* autoMode - intean value indicating whether the controller should
* automatically determine channel classification for the channels
* marked unknown.
*
* Returns:
* BT_STATUS_SUCCESS - the channel classification has been sent to the
* controller.
*
* BT_STATUS_IN_PROGRESS - another ME_SetChannelClassification operation
* is currently in progress. Try again later.
*
* BT_STATUS_INVALID_PARM - The parameters are not valid
* (XA_ERROR_CHECK only).
*/
BtStatus ME_SetChannelClassification(BtChannelClass *channelClass, int autoMode);
/*---------------------------------------------------------------------------
* ME_MarkAfhChannels()
*
* Sets or clears the bits associated with the indicated range of
* channels in the BtChannelClass map. If the "initialize" parameter is
* TRUE, also initializes the BtChannelClass map to the "Unknown" state.
*
* Parameters:
* channelClass - BtChannelClass structure containing buffer to be
* modified.
*
* begin - the first channel (0 - 78) in the range to set.
*
* count - the number of channels to set starting at "begin".
*
* state - If TRUE, the Bluetooth channel will be set to the "Unknown"
* state. If FALSE, the Bluetooth channel will be set to the "Bad"
* state.
*
* initialize - If TRUE, the BtChannelClass structure will be initialized
* to the "Unknown" state. If FALSE, the structure will be left
* as is.
*
* Returns:
* BT_STATUS_SUCCESS - The channels have been marked successfully.
*/
BtStatus ME_MarkAfhChannels(BtChannelClass *channelClass, uint8_t begin, uint8_t count,
int state, int initialize);
/*---------------------------------------------------------------------------
* ME_MarkWiFiChannel()
*
* Sets or clears the bits associated with the indicated WiFi channel in
* the BtChannelClass map. If the "initialize" parameter is TRUE, also
* initializes the BtChannelClass map to the "Unknown" state.
*
* Parameters:
* channelClass - BtChannelClass structure containing buffer to be
* modified.
*
* wifiChannel - WiFi channel (1-14) to set.
*
* state - If TRUE, the WiFi channel will be set to the "Unknown"
* state. If FALSE, the WiFi channel will be set to the "Bad"
* state.
*
* initialize - If TRUE, the BtChannelClass structure will be initialized
* to the "Unknown" state and then set as indicated. If FALSE, the
* structure will be modified as is.
*
* Returns:
* BT_STATUS_SUCCESS - The channels have been marked successfully.
*/
BtStatus ME_MarkWiFiChannel(BtChannelClass *channelClass, uint8_t wifiChannel,
int state, int initialize);
/*---------------------------------------------------------------------------
* ME_GetHciFlowParms()
*
* Called to retrieve the negotiated flow control parameters of the
* HCI transport. This information may be useful for upper layers that
* wish to optimize the transmission of data in BtPackets. It is especially
* useful for the transmission of SCO/eSCO data, which should be sent in
* packets equal to the size advertised by the radio.
*
* Parameters:
* Parms - A pointer to a memory structure that will receive the flow
* control information.
*
* Returns:
* BT_STATUS_SUCCESS - The request was successful
*
* BT_STATUS_FAILED - The request failed because the parameters have
* not yet been negotiated.
*/
BtStatus ME_GetHciFlowParms(MeHciFlowParms *Parms);
/*---------------------------------------------------------------------------
* ME_SetHciScoPacketSize()
*
* Called to change the negotiated SCO packet size. The ability
* to change the SCO packet size is important when BT_SCO_HCI_DATA
* is enabled and the transport is USB. USB has very strict
* requirements for the packet size, and often radios do not
* advertise the appropriate size. In addition, the size should
* be changed if multiple SCO channels are used. This function should
* only be called if the HCI has completed initialization.
*
* Example USB packet sizes:
*
* 16 bit audio: Each SCO channel requires 48 byte packets.
* 8 bit audio: Each SCO channel requires 24 byte packets.
*
* Parameters:
* scoPacketLen - The new SCO packet size.
*
* Returns:
* BT_STATUS_SUCCESS - The request was successful
*
* BT_STATUS_FAILED - The request failed because the parameters have
* not yet been negotiated.
*/
BtStatus ME_SetHciScoPacketSize(uint8_t scoPacketLen);
/*---------------------------------------------------------------------------
* DS_DeleteDevice()
*
* Remove a device from the known device list. If the device is also in
* the security database, this function will not remove it from the
* security database. A successful call to this function will generate
* a BTEVENT_DEVICE_DELETED event to the device selection monitor handler.
*
* Parameters:
* addr - The 48-bit Bluetooth address of the device to remove.
*
* Returns:
* BT_STATUS_SUCCESS - The device was found and removed.
*
* BT_STATUS_NOT_FOUND - The device was not found.
*
* BT_STATUS_INVALID_PARM - The "addr" parameter was invalid.
*/
BtStatus DS_DeleteDevice(const BD_ADDR *Addr);
/*---------------------------------------------------------------------------
* ME_SetPageTimeout()
*
* Called to change the page timeout. This function should
* only be called if the HCI has completed initialization.
*
* Parameters:
* page_to - page timeout.
*
* Returns:
* BT_STATUS_SUCCESS - The request was successful
*
* BT_STATUS_FAILED - The request failed because hci is busy
*/
BtStatus ME_SetPageTimeout(uint16_t page_to);
/*---------------------------------------------------------------------------
* ME_ForceCancelCreateLink()
*
* Force cancellation of the pending create link actions.
*
* Parameters:
* NULL.
*
* Returns:
* BT_STATUS_SUCCESS - the operation has completed successfully.
*
* BT_STATUS_FAILED - the operation failed. The link is already
* connected or disconnected, or the handler is not bound to
* the link (XA_ERROR_CHECK only).
*/
BtStatus ME_ForceCancelCreateLink(void);
#endif /* __ME_H */