COMMON IO-BLE v1.0.0
Hardware abstraction layer for Bluetooth
 
Loading...
Searching...
No Matches
Enumerated Types

Enumerated types of the BT_HAL. More...

Enumerations

enum  BTAvConnectionState_t { eBTAvsrcConnectionStateDisconnected = 0 , eBTAvsrcConnectionStateConnecting = 1 , eBTAvsrcConnectionStateConnected = 2 , eBTAvsrcConnectionStateDisconnecting = 3 }
 Bluetooth AV connection states. More...
 
enum  BTAvAudioState_t { eBTAvsrcAudioStateRemoteSuspend = 0 , eBTAvsrcAudioStateStopped = 1 , eBTAvsrcAudioStateStarted = 2 }
 Bluetooth AV data path states. More...
 
enum  BTAvsrcAclPriority_t { eBTAvsrcAclPriorityLow = 0 , eBTAvsrcAclPriorityHigh = 1 }
 Bluetooth AV ACL Priority. More...
 
enum  BTGattcError_t {
  eBTGattcCommandSuccess = 0 , eBTGattcCommandStarted = 1 , eBTGattcCommandBusy = 2 , eBTGattcCommandStored = 3 ,
  eBTGattcNoResources = 4 , eBTGattcModeUnsupported = 5 , eBTGattcIllegalValue = 6 , eBTGattcIncorrectState = 7 ,
  eBTGattcUnknownAddr = 8 , eBTGattcDeviceTimeout = 9 , eBTGattcInvalidControllerOutput = 10 , eBTGattcSecurityError = 11 ,
  eBTGattcDelayedEncryptionCheck = 12 , eBTGattcErrProcessing = 13
}
 BT GATT client error codes. More...
 
enum  BTRspErrorStatus_t {
  eBTRspErrorNone = 0 , eBTRspErrorNo_mitm = 1 , eBTRspErrorMitm = 2 , eBTRspErrorSignedNoMitm = 3 ,
  eBTRspErrorSignedMitm = 4
}
 Error status sent inside response to a read or write from the client. More...
 
enum  BTGattStatus_t {
  eBTGattStatusSuccess = 0x00 , eBTInvalidHandle = 0x01 , eBTGattStatusReadNotPermitted = 0x02 , eBTGattStatusWriteNotPermitted = 0x03 ,
  eBTGattStatusInvalidPDU = 0x04 , eBTGattStatusInsufficientAuthentication = 0x05 , eBTGattStatusRequestNotSupported = 0x06 , eBTGattStatusInvalidOffset = 0x07 ,
  eBTGattStatusInsufficientAuthorization = 0x08 , eBTGattStatusPrepareQueueFull = 0x09 , eBTGattStatusAttributeNotFound = 0x0A , eBTGattStatusAttributeNotLong = 0x0B ,
  eBTGattStatusInsufficientKeySize = 0x0C , eBTGattStatusInvalidAttributeLength = 0x0D , eBTGattStatusUnlikelyError = 0x0E , eBTGattStatusInsufficientEncryption = 0x0F ,
  eBTGattStatusUnsupportedGroupType = 0x10 , eBTGattStatusInsufficientResources = 0x11 , eBTGattStatusInternalError = 0x81 , eBTGattStatusError = 0x85 ,
  eBTGattStatusConnectionCongested = 0x8f , eBTGattStatusErrorConnEstFail = 0x93 , eBTGattStatusErrorConnTimeout = 0x94 , eBTGattStatusLocalHostTerminatedConnection = 0x99
}
 GATT Status Codes. More...
 
enum  {
  eBTPropNone = 0x0000 , eBTPropBroadcast = 0x0001 , eBTPropRead = 0x0002 , eBTPropWriteNoResponse = 0x0004 ,
  eBTPropWrite = 0x0008 , eBTPropNotify = 0x0010 , eBTPropIndicate = 0x0020 , eBTPropSignedWrite = 0x0040 ,
  eBTPropExtendedProps = 0x0080
}
 GATT Characteristic property. More...
 
enum  {
  eBTPermNone = 0x0000 , eBTPermRead = 0x0001 , eBTPermReadEncrypted = 0x0002 , eBTPermReadEncryptedMitm = 0x0004 ,
  eBTPermWrite = 0x0010 , eBTPermWriteEncrypted = 0x0020 , eBTPermWriteEncryptedMitm = 0x0040 , eBTPermWriteSigned = 0x0080 ,
  eBTPermWriteSignedMitm = 0x0100
}
 GATT permissions. More...
 
enum  BTAttrWriteRequests_t { eBTWriteTypeNoResponse = 0x0001 , eBTWriteTypeDefault = 0x0002 , eBTWriteTypePrepare = 0x0003 , eBTWriteTypeSigned = 0x0004 }
 Write request type. More...
 
enum  BTGattServiceTypes_t { eBTServiceTypePrimary , eBTServiceTypeSecondary }
 GATT Service types. More...
 
enum  BTDbAttributeType_t {
  eBTDbPrimaryService , eBTDbSecondaryService , eBTDbIncludedService , eBTDbCharacteristicDecl ,
  eBTDbCharacteristic , eBTDbDescriptor
}
 Attribute types. More...
 
enum  { eBTSecLevelNoSecurity = 0x01 , eBTSecLevelUnauthenticatedPairing = 0x02 , eBTSecLevelAuthenticatedPairing = 0x03 , eBTSecLevelSecureConnect = 0x04 }
 Security Level. More...
 
enum  { eBTAuthReqBonding = 0x01 , eBTAuthReqMitm = 0x03 , eBTAuthReqSecureConnect = 0x04 , eBTAuthReqKeyPress = 0x05 }
 Authentication requirement. More...
 
enum  BTTransport_t { BTTransportAuto = 0 , BTTransportBredr = 1 , BTTransportLe = 2 }
 Preferred physical Transport for GATT connection . More...
 
enum  BTState_t { eBTstateOff , eBTstateOn }
 Bluetooth power State. More...
 
enum  BTAuthFailureReason_t {
  eBTauthSuccess = 0x00 , eBTauthFailLmpRespTimeout = 0x01 , eBTauthFailKeyMissing = 0x02 , eBTauthFailEncrypMode = 0x03 ,
  eBTauthFailUnitKey = 0x04 , eBTauthFailSmpCfrmValue = 0x05 , eBTauthFailSmpEnc = 0x06 , eBTauthFailSmpTimeout = 0x07 ,
  eBTauthFailPageTimeout = 0x08 , eBTauthFailSmpPasskeyFail = 0x09 , eBTauthFailSmpOobFail = 0x0A , eBTauthFailSmpFail = 0x0B ,
  eBTauthFailConnTimeout = 0x0C , eBTauthFailSmp = 0x0D , eBTauthFailSmpPairNotSupport = 0x0E , eBTauthFailSmpUnknownIo = 0x0F ,
  eBTauthFailSmpUnknown = 0x10 , eBTauthFailHostRejectSecurity = 0x11 , eBTauthFailInsuffSecurity = 0x12 , eBTauthFailPeerUser = 0x13 ,
  eBTauthFailUnspecified = 0x14 , eBTauthFailSmpAuthReqFail = 0x15 , eBTauthFailSmpEncKeySize = 0x16 , eBTauthFailSmpCmdNotSupport = 0x17 ,
  eBTauthFailSmpRepeatedAttempt = 0x18 , eBTauthFailSmpInvalidParameters = 0x19 , eBTauthFailSmpDhkeyCheckFail = 0x1A , eBTauthFailSmpNumericComparFail = 0x1B ,
  eBTauthFailSmpBrPairInProg = 0x1C , eBTauthFailSmpXtransDeriveNotAllow = 0x1D , eBTauthFailStackErr = 0x100 , eBTauthFailHciErr = 0x200
}
 Authentication failure reasons. More...
 
enum  BTPropertyType_t {
  eBTpropertyBdname = 0x1 , eBTpropertyBdaddr , eBTpropertyTypeOfDevice , eBTpropertyAdapterBondedDevices ,
  eBTpropertyRemoteFriendlyName , eBTpropertyRemoteRssi , eBTpropertyRemoteVersionInfo , eBTpropertyLocalMTUSize ,
  eBTpropertyBondable , eBTpropertyIO , eBTpropertyConnectable , eBTpropertySecureConnectionOnly
}
 Bluetooth local device and Remote Device property types. Properties common to both adapter and remote device. More...
 
enum  BTDeviceType_t { eBTdeviceDevtypeBredr = 0x1 , eBTdeviceDevtypeBle , eBTdeviceDevtypeDual }
 Bluetooth Device Type. More...
 
enum  BTBondState_t { eBTbondStateNone , eBTbondStateBonding , eBTbondStateBonded }
 Bluetooth Bond state. More...
 
enum  BTSspVariant_t { eBTsspVariantPasskeyConfirmation , eBTsspVariantPasskeyEntry , eBTsspVariantConsent , eBTsspVariantPasskeyNotification }
 Bluetooth SSP Bonding Variant. More...
 
enum  BTAclState_t { eBTaclConnected = 0 , eBTaclDisconnected = 1 }
 Bluetooth ACL connection state. More...
 
enum  BTAclDisconnectReason_t {
  eBTaclSuccess = 0x00 , eBTaclIllegalCommand = 0x01 , eBTaclNoConnection = 0x02 , eBTaclHwFailure = 0x03 ,
  eBTaclPageTimeout = 0x04 , eBTaclAuthFailure = 0x05 , eBTaclKeyMissing = 0x06 , eBTaclMemFull = 0x07 ,
  eBTaclConnectionTimeout = 0x08 , eBTaclMaxNumOfConnections = 0x09 , eBTaclMaxNumOfScos = 0x0A , eBTaclConnectionExists = 0x0B ,
  eBTaclCommandDisallowed = 0x0C , eBTaclHostRejectResource = 0x0D , eBTaclHostRejectSecurity = 0x0E , eBTaclHostRejectDevice = 0x0F ,
  eBTaclHostTimeout = 0x10 , eBTaclUnsupportedValue = 0x11 , eBTaclIllegalParameterFmt = 0x12 , eBTaclPeerUser = 0x13 ,
  eBTaclPeerLowResources = 0x14 , eBTaclPeerPowerOff = 0x15 , eBTaclHostUser = 0x16 , eBTaclRepeatedAttempts = 0x17 ,
  eBTaclPairingNotAllowed = 0x18 , eBTaclUnknownLmpPdu = 0x19 , eBTaclUnsupportedRemFeature = 0x1A , eBTaclScoOffsetRejected = 0x1B ,
  eBTaclScoIntervalRejected = 0x1C , eBTaclScoAirRejected = 0x1D , eBTaclInvalidLmpParam = 0x1E , eBTaclUnspecified = 0x1F ,
  eBTaclUnsupportedLmpFeature = 0x20 , eBTaclRoleChangeNotAllowed = 0x21 , eBTaclLmpResponseTimeout = 0x22 , eBTaclLmpErrTransCollision = 0x23 ,
  eBTaclLmpPduNotAllowed = 0x24 , eBTaclEncryModeNotAcceptable = 0x25 , eBTaclUnitKeyUsed = 0x26 , eBTaclQosNotSupported = 0x27 ,
  eBTaclInstantPassed = 0x28 , eBTaclPairingWithUnitKeyNotSupported = 0x29 , eBTaclDiffTransactionCollision = 0x2A , eBTaclQosUnacceptableParam = 0x2C ,
  eBTaclQosRejected = 0x2D , eBTaclChanClassifNotSupported = 0x2E , eBTaclInsuffcientSecurity = 0x2F , eBTaclParamOutOfRange = 0x30 ,
  eBTaclRoleSwitchPending = 0x32 , eBTaclReservedSlotViolation = 0x34 , eBTaclRoleSwitchFailed = 0x35 , eBTaclInqRspDataTooLarge = 0x36 ,
  eBTaclSimplePairingNotSupported = 0x37 , eBTaclHostBusyPairing = 0x38 , eBTaclRejNoSuitableChannel = 0x39 , eBTaclControllerBusy = 0x3A ,
  eBTaclUnacceptConnInterval = 0x3B , eBTaclDirectedAdvertisingTimeout = 0x3C , eBTaclConnToutDueToMicFailure = 0x3D , eBTaclConnFailedEstablishment = 0x3E ,
  eBTaclMacConnectionFailed = 0x3F
}
 Bluetooth ACL Disconnect Reason From Bluetooth Core Spec 5.0 Vol 2, Part D Error Codes Unknown disconnect reason will be treated as eBTaclUnspecified. More...
 
enum  BTAddrType_t { BTAddrTypePublic , BTAddrTypeRandom , BTAddrTypeStaticRandom , BTAddrTypeResolvable }
 Advertising Address Type.
 
enum  BTAdvProperties_t { BTAdvInd , BTAdvDirectInd , BTAdvNonconnInd }
 Advertising Type.
 
enum  BTBlePropertyType_t { eBTPropertyLocalLeFeatures }
 BLE device property type. More...
 
enum  BTScanMode_t { eBTScanModeNone = 0 , eBTScanModeConnectable = 1 , eBTScanModeConnectableDiscoverable = 2 }
 Bluetooth Adapter Visibility Modes. More...
 
enum  BTScanParam_t { eBTPageScanInterval220ms = 0 , eBTPageScanInterval1280ms = 1 }
 Bluetooth scan parameters. More...
 
enum  BTDiscoveryState_t { eBTDiscoveryStopped = 0 , eBTDiscoveryStarted = 1 }
 Bluetooth Adapter Discovery state. More...
 
enum  BTaclState_t { eBTaclStateConnected = 0 , eBTaclStateDisconnected = 1 }
 Bluetooth ACL connection state. More...
 
enum  BTScanType_t { eBTScanTypeStandard = 0 , eBTScanTypeInterlaced = 1 }
 Bluetooth Scan types. More...
 
enum  BTClassicPropertyType_t {
  eBTPropertyBdname = 0x1 , eBTPropertyBdaddr = 0x2 , eBTPropertyTypeOfDevice = 0x3 , eBTPropertyUUIDS = 0x4 ,
  eBTPropertyClassOfDevice = 0x5 , eBTPropertyServiceRecord = 0x6 , eBTPropertyAdapterDiscoveryTimeout = 0x7 , eBTPropertyAdapterScanMode = 0x8 ,
  eBTPropertyEIRManfInfo = 0xFE , eBTPropertyAdapterScanParam = 0x100 , eBTPropertyConnectability = 0x101 , eBTPropertyScanType = 0x102 ,
  eBTPropertyGadgetEIRManfInfo = 0x103
}
 Classic Device Property Types. More...
 
enum  BTuuidType_t { eBTuuidType16 = 1 , eBTuuidType32 = 2 , eBTuuidType128 = 3 }
 UUID types. More...
 
enum  BTStatus_t {
  eBTStatusSuccess = 0 , eBTStatusFail = 1 , eBTStatusNotReady = 2 , eBTStatusNoMem = 3 ,
  eBTStatusBusy = 4 , eBTStatusDone = 5 , eBTStatusUnsupported = 6 , eBTStatusParamInvalid = 7 ,
  eBTStatusUnHandled = 8 , eBTStatusAuthFailure = 9 , eBTStatusRMTDevDown = 10 , eBTStatusAuthRejected = 11 ,
  eBTStatusWakeLockError = 12 , eBTStatusLinkLoss = 13
}
 Bluetooth Error Status . More...
 
enum  BTProfile_t {
  eProfileHeadset = 0 , eBTProfileA2DP = 1 , eBTProfileAVRCPTarget = 2 , eBTProfileA2DPSink = 3 ,
  eBTProfileAVRCPController = 4 , eBTProfileInputDevice = 5 , eBTProfileHeadsetClient = 6 , eBTProfileGATT = 7 ,
  eBTProfileSock = 8 , eBTProfileMaxID = 9
}
 Bluetooth Profile . More...
 
enum  BTIOtypes_t {
  eBTIONone = 0 , eBTIODisplayOnly = 1 , eBTIODisplayYesNo = 2 , eBTIOKeyboardOnly = 3 ,
  eBTIOKeyboardDisplay = 4
}
 Input Output device type. More...
 

Detailed Description

Enumerated types of the BT_HAL.

Enumeration Type Documentation

◆ BTAvConnectionState_t

Bluetooth AV connection states.

Enumerator
eBTAvsrcConnectionStateDisconnected 

Disconnected

eBTAvsrcConnectionStateConnecting 

Connecting

eBTAvsrcConnectionStateConnected 

Connected

eBTAvsrcConnectionStateDisconnecting 

Disconnecting

◆ BTAvAudioState_t

Bluetooth AV data path states.

Enumerator
eBTAvsrcAudioStateRemoteSuspend 

Audio Suspended

eBTAvsrcAudioStateStopped 

Audio Stopped

eBTAvsrcAudioStateStarted 

Audio Started

◆ BTAvsrcAclPriority_t

Bluetooth AV ACL Priority.

Enumerator
eBTAvsrcAclPriorityLow 

ACL Low Priority

eBTAvsrcAclPriorityHigh 

ACL High Priority

◆ BTGattcError_t

BT GATT client error codes.

Enumerator
eBTGattcCommandSuccess 

Command succeeded.

eBTGattcCommandStarted 

Command started OK.

eBTGattcCommandBusy 

Device busy with another command.

eBTGattcCommandStored 

Request is stored in control block.

eBTGattcNoResources 

No resources to issue command.

eBTGattcModeUnsupported 

Request for 1 or more unsupported modes.

eBTGattcIllegalValue 

Illegal command/parameter value.

eBTGattcIncorrectState 

Device in wrong state for request.

eBTGattcUnknownAddr 

Unknown remote BD address.

eBTGattcDeviceTimeout 

Device timeout.

eBTGattcInvalidControllerOutput 

An incorrect value was received from HCI.

eBTGattcSecurityError 

Authorization or security failure or not authorized.

eBTGattcDelayedEncryptionCheck 

Delayed encryption check.

eBTGattcErrProcessing 

Generic error.

◆ BTRspErrorStatus_t

Error status sent inside response to a read or write from the client.

Enumerator
eBTRspErrorNone 

No error.

eBTRspErrorNo_mitm 

Require simple encryption.

eBTRspErrorMitm 

Require simple encryption + authentication.

eBTRspErrorSignedNoMitm 

Require simple signed data.

eBTRspErrorSignedMitm 

Require simple signed data + authentication.

◆ BTGattStatus_t

GATT Status Codes.

See also
BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part F, 3.4.1.1 Error Response
Enumerator
eBTGattStatusSuccess 

Success

eBTInvalidHandle 

Invalid handle

eBTGattStatusReadNotPermitted 

Characteristic does not support read

eBTGattStatusWriteNotPermitted 

Characteristic does not support write

eBTGattStatusInvalidPDU 

Invalid PDU

eBTGattStatusInsufficientAuthentication 

Link is not properly Authenticated

eBTGattStatusRequestNotSupported 

Operation not supported

eBTGattStatusInvalidOffset 

Invalid offset (long writes/reads)

eBTGattStatusInsufficientAuthorization 

Link is not properly authorized

eBTGattStatusPrepareQueueFull 

Too many prepare writes queued

eBTGattStatusAttributeNotFound 

No attribute found within handle range

eBTGattStatusAttributeNotLong 

Cannot be read with Read Blob Request

eBTGattStatusInsufficientKeySize 

Link is not properly Encrypted

eBTGattStatusInvalidAttributeLength 

Bad Attribute Length

eBTGattStatusUnlikelyError 

Encountered an unlikeley error

eBTGattStatusInsufficientEncryption 

Link is not properly Encrypted

eBTGattStatusUnsupportedGroupType 

Unsupported grouping attribute

eBTGattStatusInsufficientResources 

Insufficient Resources

eBTGattStatusInternalError 

Internal GATT Error

eBTGattStatusError 

Generic GATT Error

eBTGattStatusConnectionCongested 

Congested connection

eBTGattStatusErrorConnEstFail 

Failed to establish gatt connection

eBTGattStatusErrorConnTimeout 

Connection Timed out

eBTGattStatusLocalHostTerminatedConnection 

Disconnect from Local Host

◆ anonymous enum

anonymous enum

GATT Characteristic property.

See also
BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part G, 3.3.1.1 Characteristic Properties

◆ anonymous enum

anonymous enum

GATT permissions.

See also
BLUETOOTH SPECIFICATION Version 5.0 | Vol 3, Part F, 3.2.5 Attribute Permissions
Enumerator
eBTPermRead 

Readable, Encryption not required, No Authentication Required.

eBTPermReadEncrypted 

Readable, Encryption required, No Authentication Required.

eBTPermReadEncryptedMitm 

Readable, Encryption required, Authentication Required.

eBTPermWrite 

Writable, Encryption not required, No Authentication Required.

eBTPermWriteEncrypted 

Writable, Encryption required, No Authentication Required.

eBTPermWriteEncryptedMitm 

Writable, Encryption required, Authentication Required.

eBTPermWriteSigned 

Writable, Signed required, No Authentication Required.

eBTPermWriteSignedMitm 

Writable, Signed required, Authentication Required.

◆ BTAttrWriteRequests_t

Write request type.

Enumerator
eBTWriteTypeNoResponse 

Write request, do not need response.

eBTWriteTypeDefault 

Write request, need a response.

eBTWriteTypePrepare 

Prepared Write request

eBTWriteTypeSigned 

Signed Write request, need a response.

◆ BTGattServiceTypes_t

GATT Service types.

Enumerator
eBTServiceTypePrimary 

Primary service.

eBTServiceTypeSecondary 

Secondary service.

◆ BTDbAttributeType_t

Attribute types.

Enumerator
eBTDbPrimaryService 

Primary service.

eBTDbSecondaryService 

Secondary service.

eBTDbIncludedService 

Included service.

eBTDbCharacteristicDecl 

Characteristic declaration.

eBTDbCharacteristic 

Characteristic.

eBTDbDescriptor 

Characteristic descriptor.

◆ anonymous enum

anonymous enum

Security Level.

Enumerator
eBTSecLevelNoSecurity 

Mode 1 level 1, No security (No authentication and no encryption).

eBTSecLevelUnauthenticatedPairing 

Mode 1 level 2, Unauthenticated pairing with encryption.

eBTSecLevelAuthenticatedPairing 

Mode 1 level 3, Authenticated pairing with encryption.

eBTSecLevelSecureConnect 

Mode 1 level 4, Authenticated LE Secure Connections pairing with encryption using a 128-bit strength encryption key.

◆ anonymous enum

anonymous enum

Authentication requirement.

Enumerator
eBTAuthReqBonding 

Set bonding request.

eBTAuthReqMitm 

MITM protection.

eBTAuthReqSecureConnect 

Authenticated encryption.

◆ BTTransport_t

Preferred physical Transport for GATT connection .

Enumerator
BTTransportAuto 

BTTransportAuto

BTTransportBredr 

BTTransportBredr

BTTransportLe 

BTTransportLe

◆ BTState_t

enum BTState_t

Bluetooth power State.

Enumerator
eBTstateOff 

Off mode

eBTstateOn 

On mode

◆ BTAuthFailureReason_t

Authentication failure reasons.

Enumerator
eBTauthSuccess 

Authentication Success.

eBTauthFailLmpRespTimeout 

LMP Response Timeout.

eBTauthFailKeyMissing 

Authentication Key Missing.

eBTauthFailEncrypMode 

Encryption Failure.

eBTauthFailUnitKey 

Unit Key Failure.

eBTauthFailSmpCfrmValue 

Smp Confirm Value failed. (Core Spec v5.2: 0x04 - Confirm Value Failed)

eBTauthFailSmpEnc 

Smp Encryption Failure.

eBTauthFailSmpTimeout 

Smp Connection Timeout.

eBTauthFailPageTimeout 

Authentication Page Timeout.

eBTauthFailSmpPasskeyFail 

Smp Pass Key Failure. (Core Spec v5.2: 0x01 - Passkey Entry Failed)

eBTauthFailSmpOobFail 

Smp OOB Failure. (Core Spec v5.2: 0x02 - OOB Not Available)

eBTauthFailSmpFail 

Smp Failure.

eBTauthFailConnTimeout 

Authentication Connection Timeout.

eBTauthFailSmp 

Smp Failure.

eBTauthFailSmpPairNotSupport 

Smp Pairing Not Supported. (Core Spec v5.2: 0x05 - Pairing Not Supported)

eBTauthFailSmpUnknownIo 

Smp IO Failure.

eBTauthFailSmpUnknown 

Smp Unknown Failure.

eBTauthFailHostRejectSecurity 

Host Reject Security.

eBTauthFailInsuffSecurity 

Insufficient Security.

eBTauthFailPeerUser 

Peer User Failure.

eBTauthFailUnspecified 

Unspecified Failure. (Core Spec v5.2: 0x08 - Unspecified Reason)

eBTauthFailSmpAuthReqFail 

Authentication Requirements Failure. (Core Spec v5.2: 0x03 - Authentication Requirements)

eBTauthFailSmpEncKeySize 

Encryption Key Size Failure. (Core Spec v5.2: 0x06 - Encryption Key Size)

eBTauthFailSmpCmdNotSupport 

Requested Command Not Supported. (Core Spec v5.2: 0x07 - Command Not Supported)

eBTauthFailSmpRepeatedAttempt 

Repeated Attempts Failure. (Core Spec v5.2: 0x09 - Repeated Attempts)

eBTauthFailSmpInvalidParameters 

Invalid Parameters.(Core Spec v5.2: 0x0A - Invalid Parameters)

eBTauthFailSmpDhkeyCheckFail 

Dhkey Check Failed.(Core Spec v5.2: 0x0B - DHKey Check Failed)

eBTauthFailSmpNumericComparFail 

Numeric Comparison Failed.(Core Spec v5.2: 0x0C - Numeric Comparison Failed)

eBTauthFailSmpBrPairInProg 

Classic Pairing in Progress. (Core Spec v5.2: 0x0D - BR/EDR pairing in progress)

eBTauthFailSmpXtransDeriveNotAllow 

Keys referenced betn BR/EDR and LE transport. (Core Spec v5.2: 0x0E - Cross-transport Key Derivation/Generation not allowed)

eBTauthFailStackErr 

Add Vendor defined authentication failures to this base.

eBTauthFailHciErr 

Add HCI Error codes (From Bluetooth Core Specification v5.2, Vol 1, Part F) to this base.

◆ BTPropertyType_t

Bluetooth local device and Remote Device property types. Properties common to both adapter and remote device.

Enumerator
eBTpropertyBdname 

Description - Bluetooth Device Name Access mode - Adapter name can be GET/SET. Remote device can be GET Data type - BTBdname_t eBTpropertyBdname

eBTpropertyBdaddr 

Description - Bluetooth Device Address Access mode - Only GET. Data type - BTBdaddr_t eBTpropertyBdaddr

eBTpropertyTypeOfDevice 

Description - Device Type - BREDR, BLE or DUAL Mode Access mode - Only GET. Data type - BTDeviceType_t eBTpropertyTypeOfDevice

eBTpropertyAdapterBondedDevices 

Description - List of bonded devices Access mode - Only GET. Data type - Array of BTBdaddr_t of the bonded remote devices (Array size inferred from property length). eBTpropertyAdapterBondedDevices

eBTpropertyRemoteFriendlyName 

Description - User defined friendly name of the remote device Access mode - GET and SET Data type - BTBdname_t. eBTpropertyRemoteFriendlyName

eBTpropertyRemoteRssi 

Description - RSSI value of the inquired remote device Access mode - Only GET. Data type - int32_t. eBTpropertyRemoteRssi

eBTpropertyRemoteVersionInfo 

Description - Remote version info Access mode - SET/GET. Data type - BTRemoteVersion_t. eBTpropertyRemoteVersionInfo

eBTpropertyLocalMTUSize 

Description - MTU size Access mode - SET/GET. Data type - uint32_t eBTpropertyLocalMTUSize

eBTpropertyBondable 

Description - Bondable flag Access mode - SET/GET Data type - bool (true for bondable) eBTpropertyBondable

eBTpropertyIO 

Description - I/O flag.

Warning
: eBTpropertyIO has a dependency on the property eBTpropertySecureConnectionOnly. Only I/O yes/no is compatible with eBTpropertySecureConnectionOnly = 1

Access mode - SET/GET Data type - BTIOtypes_t eBTpropertyIO

eBTpropertyConnectable 

Description - Connectable mode flag Access mode - SET/GET Data type - bool eBTpropertyConnectable Sets connectable mode.

eBTpropertySecureConnectionOnly 

Description - Secure only mode flag.

Warning
: Secure connections only has a dependency on the property eBTpropertyIO. Only I/O yes/no is compatible with eBTpropertySecureConnectionOnly = 1

Access mode - SET/GET Data type - bool eBTpropertySecureOnly Sets secure connection only mode.

◆ BTDeviceType_t

Bluetooth Device Type.

Enumerator
eBTdeviceDevtypeBredr 

Bluetooth classic device only.

eBTdeviceDevtypeBle 

BLE device only.

eBTdeviceDevtypeDual 

Device with BLE and BT classic.

◆ BTBondState_t

Bluetooth Bond state.

Enumerator
eBTbondStateNone 

None Bond State.

eBTbondStateBonding 

Bonding State.

eBTbondStateBonded 

Bonded State.

◆ BTSspVariant_t

Bluetooth SSP Bonding Variant.

Enumerator
eBTsspVariantPasskeyConfirmation 

eBTsspVariantPasskeyConfirmation

eBTsspVariantPasskeyEntry 

eBTsspVariantPasskeyEntry

eBTsspVariantConsent 

eBTsspVariantConsent

eBTsspVariantPasskeyNotification 

eBTsspVariantPasskeyNotification

◆ BTAclState_t

Bluetooth ACL connection state.

Enumerator
eBTaclConnected 

ACL connected

eBTaclDisconnected 

ACL disconnected

◆ BTAclDisconnectReason_t

Bluetooth ACL Disconnect Reason From Bluetooth Core Spec 5.0 Vol 2, Part D Error Codes Unknown disconnect reason will be treated as eBTaclUnspecified.

Enumerator
eBTaclSuccess 

Success

eBTaclIllegalCommand 

Unknown HCI Command

eBTaclNoConnection 

Unknown Connection Identifier

eBTaclHwFailure 

Hardware Failure

eBTaclPageTimeout 

Page Timeout

eBTaclAuthFailure 

Authentication Failure

eBTaclKeyMissing 

PIN or Key Missing

eBTaclMemFull 

Memory Capacity Exceeded

eBTaclConnectionTimeout 

Connection Timeout

eBTaclMaxNumOfConnections 

Connection Limit Exceeded

eBTaclMaxNumOfScos 

Synchronous Connection Limit To A Device Exceeded

eBTaclConnectionExists 

Connection Already Exists

eBTaclCommandDisallowed 

Command Disallowed

eBTaclHostRejectResource 

Connection Rejected due to Limited Resources

eBTaclHostRejectSecurity 

Connection Rejected Due To Security Reasons

eBTaclHostRejectDevice 

Connection Rejected due to Unacceptable BD_ADDR

eBTaclHostTimeout 

Connection Accept Timeout Exceeded

eBTaclUnsupportedValue 

Unsupported Feature or Parameter Value

eBTaclIllegalParameterFmt 

Invalid HCI Command Parameters

eBTaclPeerUser 

Remote User Terminated Connection

eBTaclPeerLowResources 

Remote Device Terminated Connection due to Low Resources

eBTaclPeerPowerOff 

Remote Device Terminated Connection due to Power Off

eBTaclHostUser 

Connection Terminated By Local Host

eBTaclRepeatedAttempts 

Repeated Attempts

eBTaclPairingNotAllowed 

Pairing Not Allowed

eBTaclUnknownLmpPdu 

Unknown LMP PDU

eBTaclUnsupportedRemFeature 

Unsupported Remote Feature / Unsupported LMP Feature

eBTaclScoOffsetRejected 

SCO Offset Rejected

eBTaclScoIntervalRejected 

SCO Interval Rejected

eBTaclScoAirRejected 

SCO Air Mode Rejected

eBTaclInvalidLmpParam 

Invalid LMP Parameters / Invalid LL Parameters

eBTaclUnspecified 

Unspecified Error

eBTaclUnsupportedLmpFeature 

Unsupported LMP Parameter Value / Unsupported LL Parameter Value

eBTaclRoleChangeNotAllowed 

Role Change Not Allowed

eBTaclLmpResponseTimeout 

LMP Response Timeout / LL Response Timeout

eBTaclLmpErrTransCollision 

LMP Error Transaction Collision / LL Procedure Collision

eBTaclLmpPduNotAllowed 

LMP PDU Not Allowed

eBTaclEncryModeNotAcceptable 

Encryption Mode Not Acceptable

eBTaclUnitKeyUsed 

Link Key cannot be Changed

eBTaclQosNotSupported 

Requested QoS Not Supported

eBTaclInstantPassed 

Instant Passed

eBTaclPairingWithUnitKeyNotSupported 

Pairing With Unit Key Not Supported

eBTaclDiffTransactionCollision 

Different Transaction Collision

eBTaclQosUnacceptableParam 

QoS Unacceptable Parameter

eBTaclQosRejected 

QoS Rejected

eBTaclChanClassifNotSupported 

Channel Classification Not Supported

eBTaclInsuffcientSecurity 

Insufficient Security

eBTaclParamOutOfRange 

Parameter Out Of Mandatory Range

eBTaclRoleSwitchPending 

Role Switch Pending

eBTaclReservedSlotViolation 

Reserved Slot Violation

eBTaclRoleSwitchFailed 

Role Switch Failed

eBTaclInqRspDataTooLarge 

Extended Inquiry Response Too Large

eBTaclSimplePairingNotSupported 

Secure Simple Pairing Not Supported By Host

eBTaclHostBusyPairing 

Host Busy - Pairing

eBTaclRejNoSuitableChannel 

Connection Rejected due to No Suitable Channel Found

eBTaclControllerBusy 

Controller Busy

eBTaclUnacceptConnInterval 

Unacceptable Connection Parameters

eBTaclDirectedAdvertisingTimeout 

Advertising Timeout

eBTaclConnToutDueToMicFailure 

Connection Terminated due to MIC Failure

eBTaclConnFailedEstablishment 

Connection Failed to be Established

eBTaclMacConnectionFailed 

MAC Connection Failed

◆ BTBlePropertyType_t

BLE device property type.

Enumerator
eBTPropertyLocalLeFeatures 

Description - Local LE features Access mode - GET. Data type - bt_local_le_features_t.

◆ BTScanMode_t

Bluetooth Adapter Visibility Modes.

Enumerator
eBTScanModeNone 

Not visible

eBTScanModeConnectable 

Connectable

eBTScanModeConnectableDiscoverable 

Connectable and Discoverable

◆ BTScanParam_t

Bluetooth scan parameters.

Enumerator
eBTPageScanInterval220ms 

220 ms page scan interval

eBTPageScanInterval1280ms 

1280 ms page scan interval

◆ BTDiscoveryState_t

Bluetooth Adapter Discovery state.

Enumerator
eBTDiscoveryStopped 

Discovery Stopped

eBTDiscoveryStarted 

Discovery Started

◆ BTaclState_t

Bluetooth ACL connection state.

Enumerator
eBTaclStateConnected 

ACL connected

eBTaclStateDisconnected 

ACL disconnected

◆ BTScanType_t

Bluetooth Scan types.

Enumerator
eBTScanTypeStandard 

Standard Scan Type

eBTScanTypeInterlaced 

Interlaced Scan Type

◆ BTClassicPropertyType_t

Classic Device Property Types.

Enumerator
eBTPropertyBdname 

Description - Bluetooth Device Name Access mode - Adapter name can be GET/SET. Remote device can be GET Data type - BTBdname_t

eBTPropertyBdaddr 

Description - Bluetooth Device Address Access mode - Only GET. Data type - BTBdaddr_t

eBTPropertyTypeOfDevice 

Description - Device Type - BREDR, BLE or DUAL Mode Access mode - Only GET. Data type - BTDeviceType_t.

eBTPropertyUUIDS 

Description - Bluetooth Service 128-bit UUIDs Access mode - Only GET. Data type - Array of BTUuid_t (Array size inferred from property length).

eBTPropertyClassOfDevice 

Description - Bluetooth Class of Device as found in Assigned Numbers Access mode - Only GET. Data type - uint32_t.

eBTPropertyServiceRecord 

Description - Bluetooth Service Record Access mode - Only GET. Data type - BTServiceRecord_t

eBTPropertyAdapterDiscoveryTimeout 

Description - Bluetooth Adapter Discovery timeout (in seconds) Access mode - GET and SET Data type - uint32_t

eBTPropertyAdapterScanMode 

Description - Bluetooth Adapter scan mode Access mode - GET and SET Data type - BTScanMode_t.

eBTPropertyEIRManfInfo 

Description - Manufacturer specific info on EIR Access mode - GET Data type - BTEirManfInfo_t.

eBTPropertyAdapterScanParam 

Description - Bluetooth Adapter scan parameters Access mode - SET Data type - BTScanParam_t.

eBTPropertyConnectability 

Description - Bluetooth Adapter's connectability Access mode - GET and SET Data type - 2 * uint32_t

eBTPropertyScanType 

Description - Bluetooth Adapter's scan type (Standard or Interlaced) Access mode - GET and SET Data type - BTScanType_t

eBTPropertyGadgetEIRManfInfo 

Description - Manufacturer gadget specific info on EIR Access mode - GET Data type - BTGadgetEirManfInfo_t.

◆ BTuuidType_t

UUID types.

Enumerator
eBTuuidType16 

16 bit UUID

eBTuuidType32 

32 bit UUID

eBTuuidType128 

128 bit UUID

◆ BTStatus_t

enum BTStatus_t

Bluetooth Error Status .

Enumerator
eBTStatusSuccess 

Success.

eBTStatusFail 

Generic fail.

eBTStatusNotReady 

Service/Driver/Peripheral not ready.

eBTStatusNoMem 

Failed to allocate memory.

eBTStatusBusy 

Service/Driver/Peripheral busy.

eBTStatusDone 

Request already completed.

eBTStatusUnsupported 

Unsupported request/call.

eBTStatusParamInvalid 

Invalid parameter.

eBTStatusUnHandled 

Unhandled

eBTStatusAuthFailure 

Authentication procedure failed.

eBTStatusRMTDevDown 

Remote Device Down

eBTStatusAuthRejected 

Authentication rejected.

eBTStatusWakeLockError 

Wake lock error

eBTStatusLinkLoss 

Link lost.

◆ BTProfile_t

Bluetooth Profile .

Enumerator
eProfileHeadset 

Headset and Handsfree profile.

eBTProfileA2DP 

A2DP Source profile.

eBTProfileAVRCPTarget 

AVRCP Target profile.

eBTProfileA2DPSink 

A2DP Sink profile.

eBTProfileAVRCPController 

AVRCP Controller profile.

eBTProfileInputDevice 

Human Input Device (HID) Host profile.

eBTProfileHeadsetClient 

Headset Client (HFP-HF role) profile.

eBTProfileGATT 

GATT profile

eBTProfileSock 

Socket profile

eBTProfileMaxID 

Max profile index

◆ BTIOtypes_t

Input Output device type.

Enumerator
eBTIONone 

No IO.

eBTIODisplayOnly 

No input, only display.

eBTIODisplayYesNo 

Display + yes/no input.

eBTIOKeyboardOnly 

Only input, keyboard.

eBTIOKeyboardDisplay 

Keyboard and Display.