TI BLE5-Stack API Documentation  2.02.07.00
Modules | Enumerations
GAP Constants

Modules

 GAP Advertisement Data Types
 
 GAP Appearance Values
 
 GAP Privacy Modes
 
 GAP Profile Roles
 
 GAP State Flags
 
 Masks for setting and getting ID type
 
 Random Address bit-field mask and types
 

Enumerations

enum  GAP_Addr_Modes_t { ADDRMODE_PUBLIC = 0x00, ADDRMODE_RANDOM = 0x01, ADDRMODE_RP_WITH_PUBLIC_ID = 0x02, ADDRMODE_RP_WITH_RANDOM_ID = 0x03 }
 Address modes to initialize the local device. More...
 
enum  GAP_Addr_Types_t {
  ADDRTYPE_PUBLIC = 0x00, ADDRTYPE_RANDOM = 0x01, ADDRTYPE_PUBLIC_ID = 0x02, ADDRTYPE_RANDOM_ID = 0x03,
  ADDRTYPE_RANDOM_NR = 0xFE, ADDRTYPE_NONE = 0xFF
}
 Address types used for identifying peer address type. More...
 
enum  GAP_CB_Action_t { GAP_CB_REGISTER, GAP_CB_UNREGISTER }
 
enum  GAP_CB_Event_e { GAP_CB_EVENT_INVALID = 0x00, GAP_CB_CONN_ESTABLISHED = 0x01, GAP_CB_PHY_UPDATE = 0x02, GAP_CB_CONN_EVENT_ALL = 0xFF }
 
enum  GAP_ConnEvtPhy_t { GAP_CONN_EVT_PHY_1MBPS = 1, GAP_CONN_EVT_PHY_2MBPS = 2, GAP_CONN_EVT_PHY_CODED = 4 }
 
enum  GAP_ConnEvtStat_t { GAP_CONN_EVT_STAT_SUCCESS = LL_CONN_EVT_STAT_SUCCESS, GAP_CONN_EVT_STAT_CRC_ERROR = LL_CONN_EVT_STAT_CRC_ERROR, GAP_CONN_EVT_STAT_MISSED = LL_CONN_EVT_STAT_MISSED }
 
enum  GAP_ConnEvtTaskType_t {
  GAP_CONN_EVT_TASK_TYPE_ADV = LL_TASK_ID_ADVERTISER, GAP_CONN_EVT_TASK_TYPE_INIT = LL_TASK_ID_INITIATOR, GAP_CONN_EVT_TASK_TYPE_SLAVE = LL_TASK_ID_SLAVE, GAP_CONN_EVT_TASK_TYPE_SCAN = LL_TASK_ID_SCANNER,
  GAP_CONN_EVT_TASK_TYPE_MASTER = LL_TASK_ID_MASTER, GAP_CONN_EVT_TASK_TYPE_NONE = LL_TASK_ID_NONE
}
 
enum  GAP_Peer_Addr_Types_t { PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID = 0x00, PEER_ADDRTYPE_RANDOM_OR_RANDOM_ID = 0x01 }
 Address types used for specifying peer address type. More...
 
enum  Gap_updateDecision_t { GAP_UPDATE_REQ_ACCEPT_ALL, GAP_UPDATE_REQ_DENY_ALL, GAP_UPDATE_REQ_PASS_TO_APP }
 

Detailed Description

Other defines used in the GAP layer

Enumeration Type Documentation

§ GAP_Addr_Modes_t

Address modes to initialize the local device.

Enumerator
ADDRMODE_PUBLIC 

Always Use Public Address.

ADDRMODE_RANDOM 

Always Use Random Static Address

ADDRMODE_RP_WITH_PUBLIC_ID 

Always Use Resolvable Private Address with Public Identity Address.

ADDRMODE_RP_WITH_RANDOM_ID 

Always Use Resolvable Private Address with Random Identity Address.

§ GAP_Addr_Types_t

Address types used for identifying peer address type.

Enumerator
ADDRTYPE_PUBLIC 

Public Device Address.

ADDRTYPE_RANDOM 

Random Device Address

ADDRTYPE_PUBLIC_ID 

Public Identity Address (corresponds to peer's RPA)

ADDRTYPE_RANDOM_ID 

Random (static) Identity Address (corresponds to peer's RPA)

ADDRTYPE_RANDOM_NR 

Random Device Address (controller unable to resolve)

ADDRTYPE_NONE 

No address provided.

§ GAP_CB_Action_t

Action to take for callback registration API's

Enumerator
GAP_CB_REGISTER 

Register a callback.

GAP_CB_UNREGISTER 

Unregister a callback

§ GAP_CB_Event_e

Connection Event type to register

Enumerator
GAP_CB_EVENT_INVALID 

Invalid event type.

GAP_CB_CONN_ESTABLISHED 

Connection established, procedure 0.

GAP_CB_PHY_UPDATE 

PHY was updated, procedure 1.

GAP_CB_CONN_EVENT_ALL 

All connection Events.

§ GAP_ConnEvtPhy_t

Connection Event Notice PHY's

Enumerator
GAP_CONN_EVT_PHY_1MBPS 

1 MBPS

GAP_CONN_EVT_PHY_2MBPS 

2 MBPS

GAP_CONN_EVT_PHY_CODED 

Coded-S2 or Coded-S8.

§ GAP_ConnEvtStat_t

Status of connection events returned via pfnGapConnEvtCB_t

Enumerator
GAP_CONN_EVT_STAT_SUCCESS 

Connection event occurred successfully.

GAP_CONN_EVT_STAT_CRC_ERROR 

Connection event failed because all packets had CRC errors.

GAP_CONN_EVT_STAT_MISSED 

No data was received during connection event.

§ GAP_ConnEvtTaskType_t

Task type for next scheduled BLE task

Enumerator
GAP_CONN_EVT_TASK_TYPE_ADV 

Advertiser.

GAP_CONN_EVT_TASK_TYPE_INIT 

Initiating a connection.

GAP_CONN_EVT_TASK_TYPE_SLAVE 

Connection event in slave role.

GAP_CONN_EVT_TASK_TYPE_SCAN 

Scanner.

GAP_CONN_EVT_TASK_TYPE_MASTER 

Connection event in master role.

§ GAP_Peer_Addr_Types_t

Address types used for specifying peer address type.

Enumerator
PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID 

Public or Public ID Address.

PEER_ADDRTYPE_RANDOM_OR_RANDOM_ID 

Random or Random ID Address.

§ Gap_updateDecision_t

Options for responding to connection parameter update requests

These are used by GAP_PARAM_LINK_UPDATE_DECISION

Enumerator
GAP_UPDATE_REQ_ACCEPT_ALL 

Accept all parameter update requests.

GAP_UPDATE_REQ_DENY_ALL 

Deny all parameter update requests.

GAP_UPDATE_REQ_PASS_TO_APP 

Pass a GAP_UPDATE_LINK_PARAM_REQ_EVENT to the app for it to decide by responding with GAP_UpdateLinkParamReqReply

© Copyright 1995-2022, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale