Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Error Code

Detailed Description

Typedefs

typedef uint16_t ble_status_t
 ble_status_t is the type that indicates the API result or the BLE status . More...
 

Enumerations

enum  {
  BLE_SUCCESS = 0x0000,
  BLE_ERR_INVALID_PTR = 0x0001,
  BLE_ERR_INVALID_DATA = 0x0002,
  BLE_ERR_INVALID_ARG = 0x0003,
  BLE_ERR_INVALID_FUNC = 0x0004,
  BLE_ERR_INVALID_CHAN = 0x0005,
  BLE_ERR_INVALID_MODE = 0x0006,
  BLE_ERR_UNSUPPORTED = 0x0007,
  BLE_ERR_INVALID_STATE = 0x0008,
  BLE_ERR_INVALID_OPERATION = 0x0009,
  BLE_ERR_ALREADY_IN_PROGRESS = 0x000A,
  BLE_ERR_CONTEXT_FULL = 0x000B,
  BLE_ERR_MEM_ALLOC_FAILED = 0x000C,
  BLE_ERR_NOT_FOUND = 0x000D,
  BLE_ERR_INVALID_HDL = 0x000E,
  BLE_ERR_DISCONNECTED = 0x000F,
  BLE_ERR_LIMIT_EXCEEDED = 0x0010,
  BLE_ERR_RSP_TIMEOUT = 0x0011,
  BLE_ERR_NOT_YET_READY = 0x0012,
  BLE_ERR_UNSPECIFIED = 0x0013,
  BLE_ERR_HC_UNKNOWN_HCI_CMD = 0x1001,
  BLE_ERR_HC_NO_CONN = 0x1002,
  BLE_ERR_HC_HW_FAIL = 0x1003,
  BLE_ERR_HC_PAGE_TO = 0x1004,
  BLE_ERR_HC_AUTH_FAIL = 0x1005,
  BLE_ERR_HC_KEY_MISSING = 0x1006,
  BLE_ERR_HC_MEM_FULL = 0x1007,
  BLE_ERR_HC_CONN_TO = 0x1008,
  BLE_ERR_HC_MAX_NUM_OF_CONN = 0x1009,
  BLE_ERR_HC_MAX_NUM_OF_SCO_CONN = 0x100A,
  BLE_ERR_HC_ACL_CONN_ALREADY_EXISTS = 0x100B,
  BLE_ERR_HC_CMD_DISALLOWED = 0x100C,
  BLE_ERR_HC_HOST_REJ_LIMITED_RESRC = 0x100D,
  BLE_ERR_HC_HOST_REJ_SEC_REASONS = 0x100E,
  BLE_ERR_HC_HOST_REJ_PERSONAL_DEV = 0x100F,
  BLE_ERR_HC_HOST_TO = 0x1010,
  BLE_ERR_HC_UNSPRT_FEAT_OR_PARAM = 0x1011,
  BLE_ERR_HC_INVALID_HCI_CMD_PARAM = 0x1012,
  BLE_ERR_HC_OTHER_END_TERM_USER = 0x1013,
  BLE_ERR_HC_OTHER_END_TERM_LOW_RESRC = 0x1014,
  BLE_ERR_HC_OTHER_END_TERM_PW_OFF = 0x1015,
  BLE_ERR_HC_CONN_TERM_BY_LOCAL_HOST = 0x1016,
  BLE_ERR_HC_REPEATED_ATTEMPTS = 0x1017,
  BLE_ERR_HC_PAIRING_NOT_ALLOWED = 0x1018,
  BLE_ERR_HC_UNKNOWN_LMP_PDU = 0x1019,
  BLE_ERR_HC_UNSPRT_REM_FEAT = 0x101A,
  BLE_ERR_HC_SCO_OFFSET_REJ = 0x101B,
  BLE_ERR_HC_SCO_INTERVAL_REJ = 0x101C,
  BLE_ERR_HC_SCO_AIR_MODE_REJ = 0x101D,
  BLE_ERR_HC_INVALID_LMP_PARAM = 0x101E,
  BLE_ERR_HC_UNSPECIFIED_ERR = 0x101F,
  BLE_ERR_HC_UNSPRT_LMP_PARAM_VAL = 0x1020,
  BLE_ERR_HC_ROLE_CHANGE_NOT_ALLOWED = 0x1021,
  BLE_ERR_HC_LMP_RSP_TO = 0x1022,
  BLE_ERR_HC_LMP_ERR_TX_COLLISION = 0x1023,
  BLE_ERR_HC_LMP_PDU_NOT_ALLOWED = 0x1024,
  BLE_ERR_HC_ENC_MODE_NOT_ACCEPTABLE = 0x1025,
  BLE_ERR_HC_UNIT_KEY_USED = 0x1026,
  BLE_ERR_HC_QOS_IS_NOT_SPRT = 0x1027,
  BLE_ERR_HC_INSTANT_PASSED = 0x1028,
  BLE_ERR_HC_PAIRING_UNIT_KEY_NOT_SPRT = 0x1029,
  BLE_ERR_HC_DIFF_TRANSACTION_COLLISION = 0x102A,
  BLE_ERR_HC_QOS_UNACCEPTABLE_PARAM = 0x102C,
  BLE_ERR_HC_QOS_REJ = 0x102D,
  BLE_ERR_HC_CH_CLASSIFICATION_NOT_SPRT = 0x102E,
  BLE_ERR_HC_INSUFFICIENT_SEC = 0x102F,
  BLE_ERR_HC_PARAM_OUT_OF_MANDATORY_RANGE = 0x1030,
  BLE_ERR_HC_ROLE_SWITCH_PENDING = 0x1032,
  BLE_ERR_HC_RESERVED_SLOT_VIOLATION = 0x1034,
  BLE_ERR_HC_ROLE_SWITCH_FAIL = 0x1035,
  BLE_ERR_HC_EXT_INQUIRY_RSP_TOO_LARGE = 0x1036,
  BLE_ERR_HC_SSP_NOT_SPRT_BY_HOST = 0x1037,
  BLE_ERR_HC_HOST_BUSY_PAIRING = 0x1038,
  BLE_ERR_HC_CONN_REJ_NO_SUIT_CH_FOUND = 0x1039,
  BLE_ERR_HC_CTRL_BUSY = 0x103A,
  BLE_ERR_HC_UNACCEPTEBALE_CONN_INTERVAL = 0x103B,
  BLE_ERR_HC_ADV_TO = 0x103C,
  BLE_ERR_HC_CONN_TREM_DUE_TO_MIC_FAIL = 0x103D,
  BLE_ERR_HC_CONN_FAIL_TO_BE_EST = 0x103E,
  BLE_ERR_HC_MAC_CONN_FAIL = 0x103F,
  BLE_ERR_HC_COARSE_CLK_ADJUST_REJ = 0x1040,
  BLE_ERR_HC_TYPE0_SUBMAP_NOT_DEFINED = 0x1041,
  BLE_ERR_HC_UNKNOWN_ADV_ID = 0x1042,
  BLE_ERR_HC_LIMIT_REACHED = 0x1043,
  BLE_ERR_HC_OP_CANCELLED_BY_HOST = 0x1044,
  BLE_ERR_SMP_LE_PASSKEY_ENTRY_FAIL = 0x2001,
  BLE_ERR_SMP_LE_OOB_DATA_NOT_AVAILABLE = 0x2002,
  BLE_ERR_SMP_LE_AUTH_REQ_NOT_MET = 0x2003,
  BLE_ERR_SMP_LE_CONFIRM_VAL_NOT_MATCH = 0x2004,
  BLE_ERR_SMP_LE_PAIRING_NOT_SPRT = 0x2005,
  BLE_ERR_SMP_LE_INSUFFICIENT_ENC_KEY_SIZE = 0x2006,
  BLE_ERR_SMP_LE_CMD_NOT_SPRT = 0x2007,
  BLE_ERR_SMP_LE_UNSPECIFIED_REASON = 0x2008,
  BLE_ERR_SMP_LE_REPEATED_ATTEMTS = 0x2009,
  BLE_ERR_SMP_LE_INVALID_PARAM = 0x200A,
  BLE_ERR_SMP_LE_DHKEY_CHECK_FAIL = 0x200B,
  BLE_ERR_SMP_LE_NUM_COMP_FAIL = 0x200C,
  BLE_ERR_SMP_LE_BREDR_PAIRING_IN_PROGRESS = 0x200D,
  BLE_ERR_SMP_LE_CT_KEY_GEN_NOT_ALLOWED = 0x200E,
  BLE_ERR_SMP_LE_DISCONNECTED = 0x200F,
  BLE_ERR_SMP_LE_TO = 0x2011,
  BLE_ERR_GATT_INVALID_HANDLE = 0x3001,
  BLE_ERR_GATT_READ_NOT_PERMITTED = 0x3002,
  BLE_ERR_GATT_WRITE_NOT_PERMITTED = 0x3003,
  BLE_ERR_GATT_INVALID_PDU = 0x3004,
  BLE_ERR_GATT_INSUFFICIENT_AUTHENTICATION = 0x3005,
  BLE_ERR_GATT_REQUEST_NOT_SUPPORTED = 0x3006,
  BLE_ERR_GATT_INVALID_OFFSET = 0x3007,
  BLE_ERR_GATT_INSUFFICIENT_AUTHORIZATION = 0x3008,
  BLE_ERR_GATT_PREPARE_WRITE_QUEUE_FULL = 0x3009,
  BLE_ERR_GATT_ATTRIBUTE_NOT_FOUND = 0x300A,
  BLE_ERR_GATT_ATTRIBUTE_NOT_LONG = 0x300B,
  BLE_ERR_GATT_INSUFFICIENT_ENC_KEY_SIZE = 0x300C,
  BLE_ERR_GATT_INVALID_ATTRIBUTE_LEN = 0x300D,
  BLE_ERR_GATT_UNLIKELY_ERROR = 0x300E,
  BLE_ERR_GATT_INSUFFICIENT_ENCRYPTION = 0x300F,
  BLE_ERR_GATT_UNSUPPORTED_GROUP_TYPE = 0x3010,
  BLE_ERR_GATT_INSUFFICIENT_RESOURCES = 0x3011,
  BLE_ERR_GATT_WRITE_REQ_REJECTED = 0x30FC,
  BLE_ERR_GATT_CCCD_IMPROPERLY_CFG = 0x30FD,
  BLE_ERR_GATT_PROC_ALREADY_IN_PROGRESS = 0x30FE,
  BLE_ERR_GATT_OUT_OF_RANGE = 0x30FF,
  BLE_ERR_L2CAP_PSM_NOT_SUPPORTED = 0x4002,
  BLE_ERR_L2CAP_NO_RESOURCE = 0x4004,
  BLE_ERR_L2CAP_INSUF_AUTHEN = 0x4005,
  BLE_ERR_L2CAP_INSUF_AUTHOR = 0x4006,
  BLE_ERR_L2CAP_INSUF_ENC_KEY_SIZE = 0x4007,
  BLE_ERR_L2CAP_REFUSE_INSUF_ENC = 0x4008,
  BLE_ERR_L2CAP_REFUSE_INVALID_SCID = 0x4009,
  BLE_ERR_L2CAP_REFUSE_SCID_ALREADY_ALLOC = 0x400A,
  BLE_ERR_L2CAP_REFUSE_UNACCEPTABLE_PARAM = 0x400B
}
 

Typedef Documentation

◆ ble_status_t

ble_status_t is the type that indicates the API result or the BLE status .

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
BLE_SUCCESS 

Success.

BLE_ERR_INVALID_PTR 

A pointer has been specified as NULL.

BLE_ERR_INVALID_DATA 

Invalid data has been input.

BLE_ERR_INVALID_ARG 

Invalid argument has been input.

BLE_ERR_INVALID_FUNC 

Invalid address has been input for a callback function.

BLE_ERR_INVALID_CHAN 

A channel that does not exist was input.

BLE_ERR_INVALID_MODE 

Invalid mode was required.

BLE_ERR_UNSUPPORTED 

The required operation does not support in the API.

BLE_ERR_INVALID_STATE 

Invalid state.

BLE_ERR_INVALID_OPERATION 

An API function was executed in the state not permitted.

BLE_ERR_ALREADY_IN_PROGRESS 

While an API was in progress, the API has been called.

BLE_ERR_CONTEXT_FULL 

A new content could not be registered because there was not enough area to register it.

BLE_ERR_MEM_ALLOC_FAILED 

The allocation of the memory failed.

BLE_ERR_NOT_FOUND 

Not found.

BLE_ERR_INVALID_HDL 

Invalid ID.

BLE_ERR_DISCONNECTED 

During processing disconnection has been occurred.

BLE_ERR_LIMIT_EXCEEDED 

The resource exceeded the upper limit.

BLE_ERR_RSP_TIMEOUT 

The response has been received within a given time period.

BLE_ERR_NOT_YET_READY 

Not ready for the operation.

BLE_ERR_UNSPECIFIED 

Unspecified error has been occurred.

BLE_ERR_HC_UNKNOWN_HCI_CMD 

Unknown command received.

BLE_ERR_HC_NO_CONN 

Unknown connection ID specified.

BLE_ERR_HC_HW_FAIL 

Hardware error occurred.

BLE_ERR_HC_PAGE_TO 

Page timeout occurred.

BLE_ERR_HC_AUTH_FAIL 

Authentication failed.

BLE_ERR_HC_KEY_MISSING 

LTK is missing.

BLE_ERR_HC_MEM_FULL 

Memory capacity exceeded.

BLE_ERR_HC_CONN_TO 

Connection timeout occurred.

BLE_ERR_HC_MAX_NUM_OF_CONN 

Number of connected devices has reached the limit.

BLE_ERR_HC_MAX_NUM_OF_SCO_CONN 

The command is not permitted.

BLE_ERR_HC_ACL_CONN_ALREADY_EXISTS 

Connection rejected due to resource restriction.

BLE_ERR_HC_CMD_DISALLOWED 

The command is not permitted.

BLE_ERR_HC_HOST_REJ_LIMITED_RESRC 

Connection rejected due to resource restriction.

BLE_ERR_HC_HOST_REJ_SEC_REASONS 

Connection rejected due to security reasons.

BLE_ERR_HC_HOST_REJ_PERSONAL_DEV 

Connection rejected due to unacceptable BD address.

BLE_ERR_HC_HOST_TO 

Connection acceptance timeout occurred.

BLE_ERR_HC_UNSPRT_FEAT_OR_PARAM 

Unsupported feature.

BLE_ERR_HC_INVALID_HCI_CMD_PARAM 

Invalid parameter specified.

BLE_ERR_HC_OTHER_END_TERM_USER 

Disconnected by remote user.

BLE_ERR_HC_OTHER_END_TERM_LOW_RESRC 

Disconnected due to insufficient resources.

BLE_ERR_HC_OTHER_END_TERM_PW_OFF 

Remote device power is off.

BLE_ERR_HC_CONN_TERM_BY_LOCAL_HOST 

Disconnected by local host.

BLE_ERR_HC_REPEATED_ATTEMPTS 

Number of retries for pairing authentication has reached the limit.

BLE_ERR_HC_PAIRING_NOT_ALLOWED 

Pairing is not permitted.

BLE_ERR_HC_UNKNOWN_LMP_PDU 

Unknown LL PDU.

BLE_ERR_HC_UNSPRT_REM_FEAT 

Unsupported remote device.

BLE_ERR_HC_INVALID_LMP_PARAM 

LL Control PDU parameters were invalid.

BLE_ERR_HC_UNSPECIFIED_ERR 

Unspecified Error.

BLE_ERR_HC_UNSPRT_LMP_PARAM_VAL 

Unsupported LL parameter value.

BLE_ERR_HC_LMP_RSP_TO 

LL response timed out.

BLE_ERR_HC_LMP_ERR_TX_COLLISION 

LL procedure has collided with the same transaction or procedure.

BLE_ERR_HC_LMP_PDU_NOT_ALLOWED 

Controller sent an LL PDU that was not allowed.

BLE_ERR_HC_ENC_MODE_NOT_ACCEPTABLE 

Requested encryption mode is not acceptable.

BLE_ERR_HC_QOS_IS_NOT_SPRT 

The requested Quality of Service is not supported.

BLE_ERR_HC_INSTANT_PASSED 

Execution time has elapsed.

BLE_ERR_HC_DIFF_TRANSACTION_COLLISION 

Multiple transactions collided.

BLE_ERR_HC_QOS_UNACCEPTABLE_PARAM 

The specified quality of service parameters could not be accepted at this time.

BLE_ERR_HC_QOS_REJ 

The specified quality of service parameters cannot be accepted and QoS negotiation should be terminated.

BLE_ERR_HC_CH_CLASSIFICATION_NOT_SPRT 

The Controller cannot perform channel assessment because it is not supported.

BLE_ERR_HC_INSUFFICIENT_SEC 

The HCI command or LL PDU sent is only possible on an encrypted link.

BLE_ERR_HC_PARAM_OUT_OF_MANDATORY_RANGE 

Parameter is out of mandatory range.

BLE_ERR_HC_HOST_BUSY_PAIRING 

Pairing busy because host is paired with another device.

BLE_ERR_HC_CTRL_BUSY 

The operation was rejected because the Controller was busy and unable to process the request.

BLE_ERR_HC_UNACCEPTEBALE_CONN_INTERVAL 

The specified connection parameter is unacceptable.

BLE_ERR_HC_ADV_TO 

Advertising for a fixed duration completed or, for directed advertising, that advertising completed without a connection being created.

BLE_ERR_HC_CONN_TREM_DUE_TO_MIC_FAIL 

The connection was terminated because the Message Integrity Check (MIC) failed on a received packet.

BLE_ERR_HC_CONN_FAIL_TO_BE_EST 

The LL initiated a connection or initiated synchronization to periodic advertising but the connection has failed to be established or the Link Layer failed to synchronize with the periodic advertising.

BLE_ERR_HC_UNKNOWN_ADV_ID 

A command was sent from the Host that should identify an Advertising or Sync handle, but the Advertising or Sync handle does not exist.

BLE_ERR_HC_LIMIT_REACHED 

Number of operations requested has been reached and has indicated the completion of the activity.

BLE_ERR_HC_OP_CANCELLED_BY_HOST 

A request to the Controller issued by the Host and still pending was successfully canceled.

BLE_ERR_SMP_LE_PASSKEY_ENTRY_FAIL 

PassKey Entry is failed.

BLE_ERR_SMP_LE_OOB_DATA_NOT_AVAILABLE 

OOB Data is not available.

BLE_ERR_SMP_LE_AUTH_REQ_NOT_MET 

The requested pairing cannot be performed because of IO Capability.

BLE_ERR_SMP_LE_CONFIRM_VAL_NOT_MATCH 

Confirmation value does not match.

BLE_ERR_SMP_LE_PAIRING_NOT_SPRT 

Pairing is not supported.

BLE_ERR_SMP_LE_INSUFFICIENT_ENC_KEY_SIZE 

Encryption Key Size is insufficient.

BLE_ERR_SMP_LE_CMD_NOT_SPRT 

The pairing command received is not supported.

BLE_ERR_SMP_LE_UNSPECIFIED_REASON 

Pairing failed with an unspecified reason.

BLE_ERR_SMP_LE_REPEATED_ATTEMTS 

The number of repetitions exceeded the upper limit.

BLE_ERR_SMP_LE_INVALID_PARAM 

Invalid parameter is set.

BLE_ERR_SMP_LE_DHKEY_CHECK_FAIL 

DHKey Check error.

BLE_ERR_SMP_LE_NUM_COMP_FAIL 

Numeric Comparison failure.

BLE_ERR_SMP_LE_DISCONNECTED 

Disconnection in pairing.

BLE_ERR_SMP_LE_TO 

Failure due to timeout.

BLE_ERR_GATT_INVALID_HANDLE 

Invalid attribute handle.

BLE_ERR_GATT_READ_NOT_PERMITTED 

The attribute cannot be read.

BLE_ERR_GATT_WRITE_NOT_PERMITTED 

The attribute cannot be written.

BLE_ERR_GATT_INVALID_PDU 

Invalid GATT PDU.

BLE_ERR_GATT_INSUFFICIENT_AUTHENTICATION 

The authentication to access the attribute is insufficient.

BLE_ERR_GATT_REQUEST_NOT_SUPPORTED 

The request is not supported.

BLE_ERR_GATT_INVALID_OFFSET 

The specified offset is larger than the length of the attribute value.

BLE_ERR_GATT_INSUFFICIENT_AUTHORIZATION 

Authorization is required to access the attribute.

BLE_ERR_GATT_PREPARE_WRITE_QUEUE_FULL 

The Write Queue in the GATT Server is full.

BLE_ERR_GATT_ATTRIBUTE_NOT_FOUND 

The specified attribute is not found.

BLE_ERR_GATT_ATTRIBUTE_NOT_LONG 

The attribute cannot be read by Read Blob Request.

BLE_ERR_GATT_INSUFFICIENT_ENC_KEY_SIZE 

The Encryption Key Size is insufficient.

BLE_ERR_GATT_INVALID_ATTRIBUTE_LEN 

The length of the specified attribute is invalid.

BLE_ERR_GATT_UNLIKELY_ERROR 

Because an error has occurred, the process cannot be advanced.

BLE_ERR_GATT_INSUFFICIENT_ENCRYPTION 

Encryption is required to access the attribute.

BLE_ERR_GATT_UNSUPPORTED_GROUP_TYPE 

The type of the specified attribute is not supported.

BLE_ERR_GATT_INSUFFICIENT_RESOURCES 

The resource to complete the request is insufficient.

BLE_ERR_GATT_WRITE_REQ_REJECTED 

The Write Request has not been completed due to the reason other than Permission.

BLE_ERR_GATT_CCCD_IMPROPERLY_CFG 

The CCCD is set to be invalid.

BLE_ERR_GATT_PROC_ALREADY_IN_PROGRESS 

The request is now in progress.

BLE_ERR_GATT_OUT_OF_RANGE 

The attribute value is out of range.

BLE_ERR_L2CAP_PSM_NOT_SUPPORTED 

PSM specified by R_BLE_L2CAP_ReqCfConn() is not supported.

BLE_ERR_L2CAP_NO_RESOURCE 

No resource for connection.

BLE_ERR_L2CAP_INSUF_AUTHEN 

Insufficient authentication.

BLE_ERR_L2CAP_INSUF_AUTHOR 

Insufficient authorization.

BLE_ERR_L2CAP_INSUF_ENC_KEY_SIZE 

Insufficient encryption key size.

BLE_ERR_L2CAP_REFUSE_INSUF_ENC 

Insufficient encryption.

BLE_ERR_L2CAP_REFUSE_INVALID_SCID 

Invalid Source CID.

BLE_ERR_L2CAP_REFUSE_SCID_ALREADY_ALLOC 

Source CID already allocated.

BLE_ERR_L2CAP_REFUSE_UNACCEPTABLE_PARAM 

Unacceptable parameters.