Airoha M0 BLE API  1.0.5.4
ble_sm.h

Data Structures

struct  ble_sm_evt_passkey_display_t
 Event structure for BLE_SM_EVT_PASSKEY_DISPLAY. More...
 
struct  ble_sm_conn_sec_t
 Connection security modes. More...
 
struct  ble_sm_evt_auth_status_t
 Event structure for BLE_SM_EVT_AUTH_STATUS. More...
 
struct  ble_sm_evt_sec_request_t
 Event structure for BLE_SM_EVT_SEC_REQUEST. More...
 
struct  ble_sm_evt_conn_sec_update_t
 Event structure for BLE_SM_EVT_CONN_SEC_UPDATE. More...
 
struct  ble_sm_evt_auth_key_request_t
 Event structure for BLE_SM_EVT_AUTH_KEY_REQUEST. More...
 
struct  ble_lesc_oob_data_t
 LE SC OOB data structure. More...
 
struct  ble_sm_evt_t
 Event structure. More...
 

Enumerations

enum  ble_sm_event_id {
  BLE_SM_EVT_SET_SEC_PARAM_REQUEST = BT_EVENT_SM, BLE_SM_EVT_PASSKEY_DISPLAY, BLE_SM_EVT_AUTH_KEY_REQUEST, BLE_SM_EVT_CONN_SEC_UPDATE,
  BLE_SM_EVT_AUTH_STATUS, BLE_SM_EVT_SEC_REQUEST, BLE_SM_EVT_OOB_DATA_RESPONSE
}
 Security manager event ID. More...
 

Defined values

#define SM_PASSKEY_MAX_BYTE_LEN   3
 

BLE_SM_STATUS

#define BLE_SM_STATUS_SUCCESS   0x00
 
#define BLE_SM_STATUS_TIMEOUT   0x01
 
#define BLE_SM_STATUS_LINK_DISCONNECTED   0x02
 
#define BLE_SM_STATUS_LTK_NEGATIVE   0x03
 
#define BLE_SM_STATUS_RFU_RANGE1_BEGIN   0x04
 
#define BLE_SM_STATUS_RFU_RANGE1_END   0x80
 
#define BLE_SM_STATUS_PAIRING_FAIL_REASON_MASK   0x80
 
#define BLE_SM_STATUS_PASSKEY_ENTRY_FAILED   0x81
 
#define BLE_SM_STATUS_OOB_NOT_AVAILABLE   0x82
 
#define BLE_SM_STATUS_AUTHENTHICATION_REQUIREMENTS   0x83
 
#define BLE_SM_STATUS_CONFIRM_VALUE   0x84
 
#define BLE_SM_STATUS_PAIRING_NOT_SUPPORTED   0x85
 
#define BLE_SM_STATUS_ENCRYPTION_KEY_SIZE   0x86
 
#define BLE_SM_STATUS_COMMAND_NOT_SUPPORTED   0x87
 
#define BLE_SM_STATUS_UNSPECIFIED_REASON   0x88
 
#define BLE_SM_STATUS_REPEATED_ATTEMPTS   0x89
 
#define BLE_SM_STATUS_INVALID_PARAMETERS   0x8A
 
#define BLE_SM_DHKEY_CHECK_FAILED   0x8B
 
#define BLE_SM_NUMERIC_COMPARISON_FAILED   0x8C
 
#define BLE_SM_BR_EDR_PAIRING_IN_PROGRESS   0x8D
 
#define BLE_SM_CROSS_TRANSPORT_KEY_NOT_ALLOWED   0x8E
 
#define BLE_SM_STATUS_RFU_RANGE2_BEGIN   0x8F
 
#define BLE_SM_STATUS_RFU_RANGE2_END   0xFF
 

Key type

#define BLE_GAP_AUTH_KEY_TYPE_NONE   0x00
 
#define BLE_GAP_AUTH_KEY_TYPE_PASSKEY   0x01
 
#define BLE_GAP_AUTH_KEY_TYPE_OOB   0x02
 

Detailed Description

ble_sm.h

ble_sm.h provides security manger APIs as defined in BLE spec.

Enumeration Type Documentation

◆ ble_sm_event_id

Security manager event ID.

Enumerator
BLE_SM_EVT_SET_SEC_PARAM_REQUEST 

Event for requesting security parameter.

BLE_SM_EVT_PASSKEY_DISPLAY 

Event for passkey display.

BLE_SM_EVT_AUTH_KEY_REQUEST 

Event for requesting passkey or OOB data.

BLE_SM_EVT_CONN_SEC_UPDATE 

Event for updating security level of current connection.

BLE_SM_EVT_AUTH_STATUS 

Event for authorization status.

BLE_SM_EVT_SEC_REQUEST 

Event for requesting authorization.

BLE_SM_EVT_OOB_DATA_RESPONSE 

Event for response of OOB data.