1 /* 2 * Copyright (C) 2021-2022 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef BLUETOOTH_DEF_H 17 #define BLUETOOTH_DEF_H 18 19 #include <string> 20 #include <vector> 21 #include <cstdint> 22 23 namespace OHOS { 24 namespace Bluetooth { 25 // Defined here are various status codes 26 /********************************************* 27 * 28 * Interface Return Value Macro Define 29 * 30 *********************************************/ 31 constexpr int RET_NO_ERROR = 0; 32 constexpr int RET_NO_SUPPORT = -1; 33 constexpr int RET_BAD_PARAM = -2; 34 constexpr int RET_BAD_STATUS = -3; 35 constexpr int RET_NO_SPACE = -4; 36 37 /********************************************* 38 * 39 * Bluetoot UUID Macro Define 40 * 41 *********************************************/ 42 constexpr const char *BLUETOOTH_UUID_BASE_UUID = "00000000-0000-1000-8000-00805F9B34FB"; 43 constexpr const char *BLUETOOTH_UUID_A2DP_SINK = "0000110B-0000-1000-8000-00805F9B34FB"; 44 constexpr const char *BLUETOOTH_UUID_A2DP_SRC = "0000110A-0000-1000-8000-00805F9B34FB"; 45 constexpr const char *BLUETOOTH_UUID_GATT = "00001801-0000-1000-8000-00805F9B34FB"; 46 constexpr const char *BLUETOOTH_UUID_AVRCP_CT = "0000110E-0000-1000-8000-00805F9B34FB"; 47 constexpr const char *BLUETOOTH_UUID_AVRCP_TG = "0000110C-0000-1000-8000-00805F9B34FB"; 48 constexpr const char *BLUETOOTH_UUID_HFP_AG = "0000111F-0000-1000-8000-00805F9B34FB"; 49 constexpr const char *BLUETOOTH_UUID_HFP_HF = "0000111E-0000-1000-8000-00805F9B34FB"; 50 constexpr const char *BLUETOOTH_UUID_PBAP_PCE = "0000112E-0000-1000-8000-00805F9B34FB"; 51 constexpr const char *BLUETOOTH_UUID_PBAP_PSE = "0000112F-0000-1000-8000-00805F9B34FB"; 52 constexpr const char *BLUETOOTH_UUID_SPP = "00001101-0000-1000-8000-00805F9B34FB"; 53 constexpr const char *BLUETOOTH_UUID_PNP = "00001200-0000-1000-8000-00805F9B34FB"; 54 55 /********************************************* 56 * 57 * Adapter Macro Define 58 * 59 *********************************************/ 60 /** 61 * @brief bt transport define 62 * use to GetRemoteDevice(),GetPairedDevices()... 63 */ 64 enum BTTransport { 65 ADAPTER_BREDR = 0, 66 ADAPTER_BLE, 67 }; 68 /** 69 * @brief bt adapter/profile state define 70 * use to GetBtConnectionState(),GetBtProfileConnState(),... 71 */ 72 enum BTStateID { 73 STATE_TURNING_ON, 74 STATE_TURN_ON, 75 STATE_TURNING_OFF, 76 STATE_TURN_OFF, 77 }; 78 79 /** 80 * @brief bluetooth state define 81 * use to GetBluetoothState() 82 * 83 * @since 14 84 */ 85 enum class BluetoothState { 86 /** Indicates the local Bluetooth is off */ 87 STATE_OFF = 0, 88 /** Indicates the local Bluetooth is turning on */ 89 STATE_TURNING_ON = 1, 90 /** Indicates the local Bluetooth is on, and ready for use */ 91 STATE_ON = 2, 92 /** Indicates the local Bluetooth is turning off */ 93 STATE_TURNING_OFF = 3, 94 /** Indicates the local Bluetooth is turning LE mode on */ 95 STATE_BLE_TURNING_ON = 4, 96 /** Indicates the local Bluetooth is in LE only mode */ 97 STATE_BLE_ON = 5, 98 /** Indicates the local Bluetooth is turning off LE only mode */ 99 STATE_BLE_TURNING_OFF = 6 100 }; 101 102 /** 103 * @brief connect state define 104 * use to ConnectionState()... 105 */ 106 enum class BTConnectState : int { 107 CONNECTING, 108 CONNECTED, 109 DISCONNECTING, 110 DISCONNECTED, 111 }; 112 113 /** 114 * @brief hdap connect state define 115 * use to HdapConnectionState()... 116 */ 117 enum class BTHdapConnectState : int { 118 CONNECTED, 119 DISCONNECTED, 120 UPDATE_CODEC, 121 }; 122 123 enum class ConnChangeCause : int { 124 CONNECT_CHANGE_COMMON_CAUSE = 0, // Common connect change cause. 125 DISCONNECT_CAUSE_USER_DISCONNECT = 0, // User disconnect device. 126 DISCONNECT_CAUSE_CONNECT_FROM_KEYBOARD = 1, // The connection needs to be initiated from the keyboard side. 127 DISCONNECT_CAUSE_CONNECT_FROM_MOUSE = 2, // The connection needs to be initiated from the mouse side. 128 DISCONNECT_CAUSE_CONNECT_FROM_CAR = 3, // The connection needs to be initiated from the car side. 129 DISCONNECT_TOO_MANY_CONNECTED_DEVICES = 4, // Too many devices are currently connected. 130 DISCONNECT_CAUSE_CONNECT_FAIL_INTERNAL = 5, // Connection failed due to an internal error. 131 }; 132 /** 133 * @brief access permission define 134 * use to 135 * Get/SetPhonebookPermission(),Get/SetMessagePermission() 136 */ 137 enum class BTPermissionType : int { 138 ACCESS_UNKNOWN, 139 ACCESS_ALLOWED, 140 ACCESS_FORBIDDEN, 141 }; 142 /** 143 * @brief connection strategy define 144 * use to 145 * SetConnectionStrategy(),GetConnectionStrategy() 146 */ 147 enum class BTStrategyType : int { 148 CONNECTION_UNKNOWN, 149 CONNECTION_ALLOWED, 150 CONNECTION_FORBIDDEN, 151 }; 152 /** 153 * @brief the type of the call 154 * use to 155 * ConnectSco(),DisconnectSco() 156 */ 157 enum class BTCallType : uint8_t { 158 CALL_TYPE_CELLULAR = 0, 159 CALL_TYPE_VIRTUAL = 1, 160 CALL_TYPE_RECOGNITION = 2, 161 }; 162 163 enum class SaManagerStatus : int8_t { 164 WAIT_NOTIFY = 0, 165 LOAD_FAIL = -1, 166 LOAD_SUCCESS = 1, 167 }; 168 169 /** 170 * @brief profile id define 171 * use to 172 * GetBtProfileConnState(),GetProfileList() 173 */ 174 const uint32_t PROFILE_ID_GATT_CLIENT = 0x00000001; 175 const uint32_t PROFILE_ID_GATT_SERVER = 0x00000002; 176 const uint32_t PROFILE_ID_A2DP_SRC = 0x00000004; 177 const uint32_t PROFILE_ID_A2DP_SINK = 0x00000008; 178 const uint32_t PROFILE_ID_AVRCP_CT = 0x00000010; 179 const uint32_t PROFILE_ID_AVRCP_TG = 0x00000020; 180 const uint32_t PROFILE_ID_HFP_AG = 0x00000040; 181 const uint32_t PROFILE_ID_HFP_HF = 0x00000080; 182 const uint32_t PROFILE_ID_MAP_MCE = 0x00000100; 183 const uint32_t PROFILE_ID_MAP_MSE = 0x00000200; 184 const uint32_t PROFILE_ID_PBAP_PCE = 0x00000400; 185 const uint32_t PROFILE_ID_PBAP_PSE = 0x00000800; 186 const uint32_t PROFILE_ID_SPP = 0x00001000; 187 const uint32_t PROFILE_ID_DI = 0x00002000; 188 const uint32_t PROFILE_ID_BLE_ADVERTISER = 0x00004000; 189 const uint32_t PROFILE_ID_BLE_CENTRAL_MANAGER_SERVER = 0x00008000; 190 const uint32_t PROFILE_ID_BLE_GATT_MANAGER = 0x00010000; 191 const uint32_t PROFILE_ID_HID_HOST = 0x00020000; 192 const uint32_t PROFILE_ID_OPP = 0x00040000; 193 const uint32_t PROFILE_ID_PAN = 0x00080000; 194 const uint32_t PROFILE_ID_HOST = 0x00100000; 195 196 /** 197 * @brief default value 198 * use to 199 * initialize mac address, name or other values. 200 */ 201 constexpr const char *INVALID_MAC_ADDRESS = "00:00:00:00:00:00"; 202 constexpr const char *INVALID_NAME = ""; 203 const uint32_t INVALID_CONTROL_TYPE = 0xFFFFFFFF; 204 const uint32_t INVALID_CONTROL_TYPE_VAL = 0xFFFFFFFF; 205 const uint32_t INVALID_CONTROL_OBJECT = 0xFFFFFFFF; 206 const int INVALID_VALUE = 0; 207 const int INVALID_TYPE = -1; 208 const int ADDRESS_LENGTH = 17; 209 const int ADDRESS_COLON_INDEX = 2; 210 const int ADDRESS_SEPARATOR_UNIT = 3; 211 212 /** 213 * @brief discovery state 214 * use to 215 * GetBtScanMode(), SetBtScanMode() 216 */ 217 const int DISCOVERY_STARTED = 0x01; 218 const int DISCOVERYING = 0x02; 219 const int DISCOVERY_STOPED = 0x03; 220 221 /** 222 * @brief pairing result 223 * use to 224 * OnPairStatusChanged() 225 */ 226 const int PAIR_NONE = 0x01; 227 const int PAIR_PAIRING = 0x02; 228 const int PAIR_PAIRED = 0x03; 229 enum UnbondCause : int { 230 PAIR_COMMON_BOND_CAUSE = 0, // Common bond cause value. 231 UNBOND_CAUSE_USER_REMOVED = 0, // User proactively removed device. 232 UNBOND_CAUSE_REMOTE_DEVICE_DOWN = 1, // Remote device shut down. 233 UNBOND_CAUSE_AUTH_FAILURE = 2, // Wrong PIN code. 234 UNBOND_CAUSE_AUTH_REJECTED = 3, // Remote device rejected. 235 UNBOND_CAUSE_INTERNAL_ERROR = 4, // Internal error. 236 }; 237 238 /** 239 * @brief discoverable mode and connect mode 240 * use to 241 * GetBtScanMode(), SetBtScanMode() 242 */ 243 const int SCAN_MODE_NONE = 0x00; 244 const int SCAN_MODE_CONNECTABLE = 0x01; 245 const int SCAN_MODE_GENERAL_DISCOVERABLE = 0x02; 246 const int SCAN_MODE_LIMITED_DISCOVERABLE = 0x03; 247 const int SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE = 0x04; 248 const int SCAN_MODE_CONNECTABLE_LIMITED_DISCOVERABLE = 0x05; 249 250 /** 251 * @brief bondable mode define 252 * use to 253 * GetBondableMode(), SetBondableMode() 254 */ 255 const int BONDABLE_MODE_OFF = 0x00; 256 const int BONDABLE_MODE_ON = 0x01; 257 258 /** 259 * @brief remote device's transport type 260 * use to 261 * GetTransportType() 262 */ 263 const int BT_TRANSPORT_NONE = -1; 264 const int BT_TRANSPORT_BREDR = 0; 265 const int BT_TRANSPORT_BLE = 1; 266 267 /** 268 * @brief remote device type 269 * use to 270 * GetDeviceType 271 */ 272 const int DEVICE_TYPE_UNKNOWN = -1; 273 const int DEVICE_TYPE_BREDR = 0; 274 const int DEVICE_TYPE_LE = 1; 275 const int DEVICE_TYPE_DUAL_MONO = 2; 276 /********************************************* 277 * 278 * GATT Macro Define 279 * 280 *********************************************/ 281 282 constexpr uint8_t GATT_TRANSPORT_TYPE_AUTO = 0x0; 283 constexpr uint8_t GATT_TRANSPORT_TYPE_LE = 0x1; 284 constexpr uint8_t GATT_TRANSPORT_TYPE_CLASSIC = 0x2; 285 286 /** 287 * @brief user confirm type during paring process. 288 * use to 289 * OnPairConfirmed() 290 */ 291 enum PinType { 292 PIN_TYPE_ENTER_PIN_CODE = 0, // enter the pin code displayed on the peer device 293 PIN_TYPE_ENTER_PASSKEY = 1, // enter the passkey displayed on the peer device 294 PIN_TYPE_CONFIRM_PASSKEY = 2, // confirm the passkey displayed on the local device 295 PIN_TYPE_NO_PASSKEY_CONSENT = 3, // accept or deny the pairing request 296 PIN_TYPE_NOTIFY_PASSKEY = 4, // enter the passkey displayed on the local device on the peer device 297 PIN_TYPE_DISPLAY_PIN_CODE = 5, // enter the pin code displayed on the peer device, used for bluetooth 2.0 298 PIN_TYPE_OOB_CONSENT = 6, // accept or deny the OOB pairing request, not suppport now 299 PIN_TYPE_PIN_16_DIGITS = 7, // enter the 16-digit pin code displayed on the peer device 300 }; 301 302 /** A GATT Attribute Permission. 303 * Define GATT Attribute permissions. 304 */ 305 enum class GattPermission : uint16_t { 306 READABLE = 1 << 0, /**< readable */ 307 READ_ENCRYPTED = 1 << 1, 308 READ_ENCRYPTED_MITM = 1 << 2, 309 WRITEABLE = 1 << 4, 310 WRITE_ENCRYPTED = 1 << 5, 311 WRITE_ENCRYPTED_MITM = 1 << 6, 312 WRITE_SIGNED = 1 << 7, 313 WRITE_SIGNED_MITM = 1 << 8, 314 }; 315 316 enum class GattConnectionPriority : int { 317 BALANCED, 318 HIGH, 319 LOW_POWER 320 }; 321 322 enum GattStatus { 323 INVALID_REMOTE_DEVICE = -29, 324 INCLUDE_SERVICE_NOT_FOUND, 325 REFERENCED_BY_OTHER_SERVICE, 326 INVALID_CHARACTERISTIC, 327 INVALID_CHARACTERISTIC_DATA, 328 INVALID_CHARACTERISTIC_DESCRIPTOR, 329 INVALID_CHARACTERISTIC_DESCRIPTOR_DATA, 330 NOT_ENOUGH_HANDLES, 331 HANDLE_NOT_FOUND, 332 INVALID_PARAMETER, 333 INTERNAL_ERROR, 334 REQUEST_NOT_SUPPORT, 335 REMOTE_DEVICE_BUSY, 336 MAX_CONNECTIONS, 337 MAX_APPLICATIONS, 338 DEVICE_ALREADY_BIND, 339 INVALID_HANDLE, 340 INVALID_OFFSET, 341 READ_NOT_PERMITTED, 342 WRITE_NOT_PERMITTED, 343 INSUFFICIENT_ENCRYPTION, 344 INSUFFICIENT_AUTHENTICATION, 345 INSUFFICIENT_AUTHORIZATION, 346 INSUFFICIENT_ENCRYPTION_KEY_SIZE, 347 PREPARE_QUEUE_FULL, 348 ATTRIBUTE_NOT_LONG, 349 INVALID_ATTRIBUTE_VALUE_LENGTH, 350 WRITE_REQUEST_REJECTED, 351 GATT_FAILURE, 352 GATT_SUCCESS 353 }; 354 355 enum BtStatus { 356 BT_SUCCESS = 0, 357 BT_FAILURE = -1, 358 }; 359 360 /********************************************* 361 * 362 * BLE Macro Define 363 * 364 *********************************************/ 365 // Minimum value for advertising interval. 366 const int BLE_ADV_MIN_INTERVAL = 0x0020; 367 // Maximum value for advertising interval. 368 const int BLE_ADV_MAX_INTERVAL = 0x4000; 369 // Default value for advertising interval. 370 const int BLE_ADV_DEFAULT_INTERVAL = 0x03E8; 371 372 // Special advertising set handle used for the legacy advertising set. 373 const uint8_t BLE_LEGACY_ADVERTISING_HANDLE = 0x00; 374 // Special advertising set handle used as return or parameter to signify an invalid handle. 375 const uint8_t BLE_INVALID_ADVERTISING_HANDLE = 0xFF; 376 377 // Report delay millis default value 378 const int BLE_REPORT_DELAY_MILLIS = 5000; 379 380 // Definitions for UUID length constants. 381 const int BLE_UUID_LEN_16 = 2; 382 const int BLE_UUID_LEN_32 = 4; 383 const int BLE_UUID_LEN_128 = 16; 384 const int DEVICE_NAME_MAX_LEN = 26; 385 386 const uint32_t BLE_ADV_PER_FIELD_OVERHEAD_LENGTH = 2; 387 const uint32_t BLE_ADV_MANUFACTURER_ID_LENGTH = 2; 388 const uint32_t BLE_ADV_FLAGS_FIELD_LENGTH = 3; 389 const uint32_t BLE_ADV_MAX_LEGACY_ADVERTISING_DATA_BYTES = 31; 390 391 // BLE acl connect status 392 const int BLE_CONNECTION_STATE_DISCONNECTED = 0x00; 393 const int BLE_CONNECTION_STATE_CONNECTED = 0x01; 394 const int BLE_CONNECTION_STATE_ENCRYPTED_BREDR = 0x02; 395 const int BLE_CONNECTION_STATE_ENCRYPTED_LE = 0x04; 396 397 const int BLE_PAIR_NONE = 0x01; 398 const int BLE_PAIR_PAIRING = 0x02; 399 const int BLE_PAIR_PAIRED = 0x03; 400 const int BLE_PAIR_CANCELING = 0x04; 401 402 const int BLE_ADV_DEFAULT_OP_CODE = 0x00; 403 const int BLE_ADV_STOP_COMPLETE_OP_CODE = 0x01; 404 const int BLE_ADV_START_FAILED_OP_CODE = 0x02; 405 406 const uint8_t BLE_ADV_DATA_BYTE_FIELD_LEN = 3; 407 const uint8_t BLE_ADV_DATA_FIELD_TYPE_AND_LEN = 2; 408 const uint8_t BLE_ONE_BYTE_LEN = 8; 409 410 const int8_t BLE_ADV_TX_POWER_ULTRA_LOW_VALUE = -21; 411 const int8_t BLE_ADV_TX_POWER_LOW_VALUE = -15; 412 const int8_t BLE_ADV_TX_POWER_MEDIUM_VALUE = -7; 413 const int8_t BLE_ADV_TX_POWER_HIGH_VALUE = 1; 414 const int8_t BLE_ADV_TX_POWER_MIN_VALUE = -127; 415 const int8_t BLE_ADV_TX_POWER_MAX_VALUE = 20; 416 417 // Entended Advertising PHY 418 const uint8_t BLE_ADVERTISEMENT_PHY_NONE = 0x00; 419 const uint8_t BLE_ADVERTISEMENT_PHY_1M = 0x01; 420 const uint8_t BLE_ADVERTISEMENT_PHY_2M = 0x02; 421 const uint8_t BLE_ADVERTISEMENT_PHY_CODED = 0x03; 422 423 const uint8_t BLE_LEGACY_ADV_IND_WITH_EX_ADV = 0x13; 424 const uint8_t BLE_LEGACY_ADV_NONCONN_IND_WITH_EX_ADV = 0x10; 425 426 // Incomplete, more data to come 427 const uint8_t BLE_EX_SCAN_DATE_STATUS_INCOMPLETE_MORE = 0x20; 428 // Incomplete, data truncated, no more to come 429 const uint8_t BLE_EX_SCAN_DATE_STATUS_INCOMPLETE_NO_MORE = 0x40; 430 431 // Scan mode 432 typedef enum { 433 SCAN_MODE_LOW_POWER = 0x00, 434 SCAN_MODE_BALANCED = 0x01, 435 SCAN_MODE_LOW_LATENCY = 0x02, 436 SCAN_MODE_OP_P2_60_3000 = 0x03, 437 SCAN_MODE_OP_P10_60_600 = 0x04, 438 SCAN_MODE_OP_P25_60_240 = 0x05, 439 SCAN_MODE_OP_P100_1000_1000 = 0x06, 440 SCAN_MODE_OP_P50_100_200 = 0x07, 441 SCAN_MODE_OP_P10_30_300 = 0x08, 442 SCAN_MODE_OP_P2_30_1500 = 0x09, 443 SCAN_MODE_OP_P75_30_40 = 0x0A, 444 SCAN_MODE_OP_P50_30_60 = 0x0B, 445 SCAN_MODE_INVALID 446 } SCAN_MODE; 447 448 // Scan callback type 449 constexpr uint8_t BLE_SCAN_CALLBACK_TYPE_ALL_MATCH = 1; 450 constexpr uint8_t BLE_SCAN_CALLBACK_TYPE_FIRST_MATCH = 2; 451 constexpr uint8_t BLE_SCAN_CALLBACK_TYPE_LOST_MATCH = 4; 452 constexpr uint8_t BLE_SCAN_CALLBACK_TYPE_FIRST_AND_LOST_MATCH = 6; 453 454 // Sensitivity mode for Bluetooth LE scan 455 typedef enum { SENSITIVITY_MODE_HIGH = 1, SENSITIVITY_MODE_LOW = 2 } SENSITIVITY_MODE; 456 457 // Determines total number of advertisers to track per filter 458 typedef enum { ONE_MATCH_TRACK_ADV = 1, FEW_MATCH_TRACK_ADV = 2, MAX_MATCH_TRACK_ADV = 3 } MATCH_TRACK_ADV_TYPE; 459 460 // Phy type 461 typedef enum { PHY_LE_1M = 1, PHY_LE_2M = 2, PHY_LE_CODED = 3, PHY_LE_ALL_SUPPORTED = 255 } PHY_TYPE; 462 463 // BLE advertiser TX power level. 464 typedef enum { 465 BLE_ADV_TX_POWER_ULTRA_LOW = 0x00, 466 BLE_ADV_TX_POWER_LOW = 0x01, 467 BLE_ADV_TX_POWER_MEDIUM = 0x02, 468 BLE_ADV_TX_POWER_HIGH = 0x03 469 } BLE_ADV_TX_POWER_LEVEL; 470 471 // BLE advertiser flag 472 const uint8_t BLE_ADV_FLAG_NON_LIMIT_DISC = 0x00; 473 const uint8_t BLE_ADV_FLAG_LIMIT_DISC = 0x01 << 0; 474 const uint8_t BLE_ADV_FLAG_GEN_DISC = 0x01 << 1; 475 const uint8_t BLE_ADV_FLAG_BREDR_NOT_SPT = 0x01 << 2; 476 const uint8_t BLE_ADV_FLAG_DMT_CONTROLLER_SPT = 0x01 << 3; 477 const uint8_t BLE_ADV_FLAG_DMT_HOST_SPT = 0x01 << 4; 478 479 // Bluetooth device type 480 typedef enum { 481 BLE_BT_DEVICE_TYPE_UNKNOWN = -1, 482 BLE_BT_DEVICE_TYPE_BREDR = 0, 483 BLE_BT_DEVICE_TYPE_BLE = 1, 484 BLE_BT_DEVICE_TYPE_DUMO = 2, 485 } BLE_BT_DEV_TYPE; 486 487 // BLE device address type 488 typedef enum { 489 BLE_ADDR_TYPE_PUBLIC = 0x00, 490 BLE_ADDR_TYPE_RANDOM = 0x01, 491 BLE_ADDR_TYPE_NON_RPA = 0x02, 492 BLE_ADDR_TYPE_RPA = 0x03, 493 BLE_ADDR_TYPE_UNKNOWN = 0xFE, 494 BLE_ADDR_TYPE_ANONYMOUS = 0xFF, 495 } BLE_ADDR_TYPE; 496 497 typedef enum { 498 BLE_IO_CAP_OUT = 0x00, // DisplayOnly 499 BLE_IO_CAP_IO = 0x01, // DisplayYesNo 500 BLE_IO_CAP_IN = 0x02, // KeyboardOnly 501 BLE_IO_CAP_NONE = 0x03, // NoInputNoOutput 502 BLE_IO_CAP_KBDISP = 0x04 // Keyboard display 503 } BLE_IO_CAP; 504 505 // Adv state 506 typedef enum { 507 BLE_ADV_STATE_IDLE, 508 BLE_ADV_STATE_ADVERTISING, 509 } Ble_AdvState; 510 511 // The type of advertising data(not adv_type) 512 typedef enum { 513 BLE_AD_TYPE_FLAG = 0x01, 514 BLE_AD_TYPE_16SRV_PART = 0x02, 515 BLE_AD_TYPE_16SRV_CMPL = 0x03, 516 BLE_AD_TYPE_32SRV_PART = 0x04, 517 BLE_AD_TYPE_32SRV_CMPL = 0x05, 518 BLE_AD_TYPE_128SRV_PART = 0x06, 519 BLE_AD_TYPE_128SRV_CMPL = 0x07, 520 BLE_AD_TYPE_NAME_SHORT = 0x08, 521 BLE_AD_TYPE_NAME_CMPL = 0x09, 522 BLE_AD_TYPE_TX_PWR = 0x0A, 523 BLE_AD_TYPE_DEV_CLASS = 0x0D, 524 BLE_AD_TYPE_SM_TK = 0x10, 525 BLE_AD_TYPE_SM_OOB_FLAG = 0x11, 526 BLE_AD_TYPE_INT_RANGE = 0x12, 527 BLE_AD_TYPE_SOL_SRV_UUID = 0x14, 528 BLE_AD_TYPE_128SOL_SRV_UUID = 0x15, 529 BLE_AD_TYPE_SERVICE_DATA = 0x16, 530 BLE_AD_TYPE_PUBLIC_TARGET = 0x17, 531 BLE_AD_TYPE_RANDOM_TARGET = 0x18, 532 BLE_AD_TYPE_APPEARANCE = 0x19, 533 BLE_AD_TYPE_ADV_INT = 0x1A, 534 BLE_AD_TYPE_LE_DEV_ADDR = 0x1b, 535 BLE_AD_TYPE_LE_ROLE = 0x1c, 536 BLE_AD_TYPE_SPAIR_C256 = 0x1d, 537 BLE_AD_TYPE_SPAIR_R256 = 0x1e, 538 BLE_AD_TYPE_32SOL_SRV_UUID = 0x1f, 539 BLE_AD_TYPE_32SERVICE_DATA = 0x20, 540 BLE_AD_TYPE_128SERVICE_DATA = 0x21, 541 BLE_AD_TYPE_LE_SECURE_CONFIRM = 0x22, 542 BLE_AD_TYPE_LE_SECURE_RANDOM = 0x23, 543 BLE_AD_TYPE_URI = 0x24, 544 BLE_AD_TYPE_INDOOR_POSITION = 0x25, 545 BLE_AD_TYPE_TRANS_DISC_DATA = 0x26, 546 BLE_AD_TYPE_LE_SUPPORT_FEATURE = 0x27, 547 BLE_AD_TYPE_CHAN_MAP_UPDATE = 0x28, 548 BLE_AD_MANUFACTURER_SPECIFIC_TYPE = 0xFF, 549 } BLE_ADV_DATA_TYPE; 550 551 /********************************************* 552 * 553 * Map Define 554 * 555 *********************************************/ 556 // Map Message Type 557 enum class MapMessageType : int { 558 EMAIL = 0, 559 SMS_GSM = 1, 560 SMS_CDMA = 2, 561 MMS = 3, 562 IM = 4, 563 INVALID = 5 564 }; // IM only support in bmessage ver1.1 565 566 // Map Message Status 567 enum class MapMessageStatus : int { READ, UNREAD, INVALID }; // default UNREAD 568 569 // Map BoolType , YES_TYPE or NO_TYPE 570 enum class MapBoolType : int { YES_TYPE, NO_TYPE, INVALID }; // default NO_TYPE 571 572 // Map Message ReceptionStatus 573 enum class MapMsgReceptionStatus : int { COMPLETE, FRACTIONED, NOTIFICATION, INVALID }; 574 575 // Map MsgDeliveryStatus 576 enum class MapMsgDeliveryStatus : int { DELIVERED, SENT, UNKNOWN, INVALID }; 577 578 // Map MsgDirection 579 enum class MapMsgDirection : int { INCOMING, OUTGOING, OUTGOINGDRAFT, OUTGOINGPENDING, INVALID }; 580 581 // Map FractionDeliverType 582 enum class MapFractionDeliverType : int { MORE, LAST, INVALID }; 583 584 // Map FractionRequest Type 585 enum class MapFractionRequestType : uint8_t { FIRST = 0x00, NEXT = 0x01, INVALID = 0x02 }; 586 587 // Map OnOff Type 588 enum class MapOnOffType : uint8_t { OFF = 0, ON = 1, INVALID = 3 }; 589 590 // Map Charset Type 591 enum class MapCharsetType : uint8_t { NATIVE = 0x00, UTF_8 = 0x01, INVALID = 0x02 }; 592 593 // Attachment Type 594 enum class MapAttachmentType : uint8_t { NO_TYPE = 0x00, HAVE = 0x01, INVALID = 0x02 }; 595 596 // Map StatusIndicator Type 597 enum class MapStatusIndicatorType : uint8_t { 598 READ_STATUS = 0x00, 599 DELETED_STATUS = 0x01, 600 SET_EXTENDED_DATA = 0x02, 601 INVALID = 0x03 602 }; 603 604 // Map StatusValue Type 605 enum class MapStatusValueType : uint8_t { NO_TYPE = 0x00, YES_TYPE = 0x01 }; 606 607 // Map ModifyText Type 608 enum class MapModifyTextType : uint8_t { REPLACE = 0x00, PREPEND = 0x01, INVALID = 0x02 }; 609 610 // Map Action Type 611 enum class MapActionType : int { 612 GET_UNREAD_MESSAGES, 613 GET_SUPPORTED_FEATURES, 614 SEND_MESSAGE, 615 SET_NOTIFICATION_FILTER, 616 GET_MESSAGES_LISTING, 617 GET_MESSAGE, 618 UPDATE_INBOX, 619 GET_CONVERSATION_LISTING, 620 SET_MESSAGE_STATUS, 621 SET_OWNER_STATUS, 622 GET_OWNER_STATUS, 623 GET_MAS_INSTANCE_INFO 624 }; 625 626 // Map ExecuteStatus Type 627 enum class MapExecuteStatus : int { 628 SUCCEED = 0, 629 CONTINUE = 1, 630 BAD_PARAM = (-1), 631 BAD_STATUS = (-2), 632 NOT_SUPPORT = (-3) 633 }; 634 635 // Supported Message Types 636 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_EMAIL 0x01 637 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_SMS_GSM 0x02 638 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_SMS_CDMA 0x04 639 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_MMS 0x08 640 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_IM 0x10 641 #define MAP_MCE_SUPPORTED_MESSAGE_TYPE_ALL 0x01F 642 643 // Api: MapClient::GetMessagesListing Application Parameters Mask defines 644 // FilterMessageType Mask, 1 is "filter out this type", 0 is "no filtering, get this type" 645 #define MAP_FILTER_MESSAGE_MASK_SMS_GSM 0b00000001 646 #define MAP_FILTER_MESSAGE_MASK_SMS_CDMA 0b00000010 647 #define MAP_FILTER_MESSAGE_MASK_EMAIL 0b00000100 648 #define MAP_FILTER_MESSAGE_MASK_MMS 0b00001000 649 #define MAP_FILTER_MESSAGE_MASK_IM 0b00010000 650 #define MAP_FILTER_MESSAGE_MASK_NO_FILTERING 0b00000000 651 // FilterReadStatus, 0b00000001 is get unread messages only, 652 // 0b00000010 is get read messages only 653 #define MAP_FILTER_READ_STATUS_MASK_UNREAD 0b00000001 654 #define MAP_FILTER_READ_STATUS_MASK_READ 0b00000010 655 #define MAP_FILTER_READ_STATUS_MASK_NO_FILTERING 0b00000000 656 // FilterPriority, 0b00000001 is get high priority messages only, 657 // 0b00000010 is get non-high priority messages only 658 #define MAP_FILTER_PRIORITY_MASK_HIGH 0b00000001 659 #define MAP_FILTER_PRIORITY_MASK_NO_HIGH 0b00000010 660 #define MAP_FILTER_PRIORITY_MASK_NO_FILTERING 0b00000000 661 // ParameterMask , Bits 0-20 has been used , Bits 21–31 Reserved for Future Use 662 #define MAP_GETMESSAGELIST_PARAMETER_MASK_REQUIRED 0b000000000000000000000000 663 #define MAP_GETMESSAGELIST_PARAMETER_MASK_PRESENT_ALL 0b000111111111111111111111 664 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SUBJECT 0b000000000000000000000001 665 #define MAP_GETMESSAGELIST_PARAMETER_MASK_DATETIME 0b000000000000000000000010 666 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SENDER_NAME 0b000000000000000000000100 667 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SENDER_ADDRESSING 0b000000000000000000001000 668 #define MAP_GETMESSAGELIST_PARAMETER_MASK_RECIPIENT_NAME 0b000000000000000000010000 669 #define MAP_GETMESSAGELIST_PARAMETER_MASK_RECIPIENT_ADDRESSING 0b000000000000000000100000 670 #define MAP_GETMESSAGELIST_PARAMETER_MASK_TYPE 0b000000000000000001000000 671 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SIZE 0b000000000000000010000000 672 #define MAP_GETMESSAGELIST_PARAMETER_MASK_RECEPTION_STATUS 0b000000000000000100000000 673 #define MAP_GETMESSAGELIST_PARAMETER_MASK_TEXT 0b000000000000001000000000 674 #define MAP_GETMESSAGELIST_PARAMETER_MASK_ATTACHMENT_SIZE 0b000000000000010000000000 675 #define MAP_GETMESSAGELIST_PARAMETER_MASK_PRIORITY 0b000000000000100000000000 676 #define MAP_GETMESSAGELIST_PARAMETER_MASK_READ 0b000000000001000000000000 677 #define MAP_GETMESSAGELIST_PARAMETER_MASK_SENT 0b000000000010000000000000 678 #define MAP_GETMESSAGELIST_PARAMETER_MASK_PROTECTED 0b000000000100000000000000 679 #define MAP_GETMESSAGELIST_PARAMETER_MASK_REPLYTO_ADDRESSING 0b000000001000000000000000 680 #define MAP_GETMESSAGELIST_PARAMETER_MASK_DELIVERY_STATUS 0b000000010000000000000000 681 #define MAP_GETMESSAGELIST_PARAMETER_MASK_CONVERSATION_ID 0b000000100000000000000000 682 #define MAP_GETMESSAGELIST_PARAMETER_MASK_CONVERSATION_NAME 0b000001000000000000000000 683 #define MAP_GETMESSAGELIST_PARAMETER_MASK_DIRECTION 0b000010000000000000000000 684 #define MAP_GETMESSAGELIST_PARAMETER_MASK_ATTACHMENT_MIME 0b000100000000000000000000 685 686 // Api: MapClient::GetConversationListing Application Parameters Mask defines 687 // ConvParameterMask , Bits 0-14 has been used, Bits 15–31 Reserved for Future Use 688 // Bit i is 1 indicates that the parameter related to Bit i shall be present in the requested Conversation-Listing. 689 // The reserved bits shall be set to 0 by the MCE and discarded by the MSE. 690 // If Bit 5 has the value 0, the Conversation-Listing in the response shall not contain any participant element 691 // and therefore the Bits 6–14 do not have any impact. 692 // If Bit 5 has the value 1, then at least one of the Bits 6–14 shall also have the value 1. 693 // If any of the Bits 6–14 has the value 1, Bit 5 shall have the value 1. 694 #define MAP_GETCONV_PARAMETER_MASK_ALL_ON 0b000000000111111111111111 695 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_NAME 0b000000000000000000000001 696 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_LAST_ACTIVITY 0b000000000000000000000010 697 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_READ_STATUS 0b000000000000000000000100 698 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_VERSION_COUNTER 0b000000000000000000001000 699 #define MAP_GETCONV_PARAMETER_MASK_CONVERSATION_SUMMARY 0b000000000000000000010000 700 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANTS 0b000000000000000000100000 701 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_UCI 0b000000000000000001000000 702 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_DISPLAY_NAME 0b000000000000000010000000 703 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_CHAT_STATE 0b000000000000000100000000 704 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_LAST_ACTIVITY 0b000000000000001000000000 705 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_X_BT_UID 0b000000000000010000000000 706 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_NAME 0b000000000000100000000000 707 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_PRESENCE_AVAILABILITY 0b000000000001000000000000 708 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_PRESENCE_TEXT 0b000000000010000000000000 709 #define MAP_GETCONV_PARAMETER_MASK_PARTICIPANT_PRIORITY 0b000000000100000000000000 710 711 // Api: MapClient::SetNotificationFilter input param mask defines 712 // Bit i is 0 indicates that the MSE shall not send the notification related to bit i for the current MAS. 713 // NotificationFilterMask ,Bits 0-14 has been used, Bits 15–31 Reserved for Future Use 714 #define MAP_NOTIFICATION_FILTER_MASK_ALL_OFF 0b000000000000000000000000 715 #define MAP_NOTIFICATION_FILTER_MASK_ALL_ON 0b000000000111111111111111 716 #define MAP_NOTIFICATION_FILTER_MASK_NEW_MESSAGE 0b000000000000000000000001 717 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_DELETED 0b000000000000000000000010 718 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_SHIFT 0b000000000000000000000100 719 #define MAP_NOTIFICATION_FILTER_MASK_SENDING_SUCCESS 0b000000000000000000001000 720 #define MAP_NOTIFICATION_FILTER_MASK_SENDING_FAILURE 0b000000000000000000010000 721 #define MAP_NOTIFICATION_FILTER_MASK_DELIVERY_SUCCESS 0b000000000000000000100000 722 #define MAP_NOTIFICATION_FILTER_MASK_DELIVERY_FAILURE 0b000000000000000001000000 723 #define MAP_NOTIFICATION_FILTER_MASK_MEMORY_FULL 0b000000000000000010000000 724 #define MAP_NOTIFICATION_FILTER_MASK_MEMORY_AVAILABLE 0b000000000000000100000000 725 #define MAP_NOTIFICATION_FILTER_MASK_READ_STATUS_CHANGED 0b000000000000001000000000 726 #define MAP_NOTIFICATION_FILTER_MASK_CONVERSATION_CHANGED 0b000000000000010000000000 727 #define MAP_NOTIFICATION_FILTER_MASK_PARTICIPANT_PRESENCE_CHANGED 0b000000000000100000000000 728 #define MAP_NOTIFICATION_FILTER_MASK_PARTICIPANT_CHAT_STATE_CHANGED 0b000000000001000000000000 729 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_EXTENDED_DATA_CHANGED 0b000000000010000000000000 730 #define MAP_NOTIFICATION_FILTER_MASK_MESSAGE_REMOVED 0b000000000100000000000000 731 732 // Api: MapClient::GetSupportedFeatures action complete param mask defines 733 // Map Supported features mask 734 #define MAP_SUPPORTED_FEATURES_NOTIFICATION_REGISTRATION 0x00000001 735 #define MAP_SUPPORTED_FEATURES_NOTIFICATION_FEATURE 0x00000002 736 #define MAP_SUPPORTED_FEATURES_BROWSING 0x00000004 737 #define MAP_SUPPORTED_FEATURES_UPLOADING 0x00000008 738 #define MAP_SUPPORTED_FEATURES_DELETE_FEATURE 0x00000010 739 #define MAP_SUPPORTED_FEATURES_INSTANCE_INFO_FEATURE 0x00000020 740 #define MAP_SUPPORTED_FEATURES_EVENT_REPORT_1_1 0x00000040 741 #define MAP_SUPPORTED_FEATURES_EVENT_REPORT_1_2 0x00000080 742 #define MAP_SUPPORTED_FEATURES_MESSAGE_FORMAT_1_1 0x00000100 743 #define MAP_SUPPORTED_FEATURES_MESSAGELIST_FORMAT_1_1 0x00000200 744 #define MAP_SUPPORTED_FEATURES_PERSISTENT_MESSAGE_HANDLE 0x00000400 745 #define MAP_SUPPORTED_FEATURES_DATABASE_IDENTIFIER 0x00000800 746 #define MAP_SUPPORTED_FEATURES_FOLDOR_VERSION_COUNTER 0x00001000 747 #define MAP_SUPPORTED_FEATURES_CONVERSATION_VERSION_COUNTER 0x00002000 748 #define MAP_SUPPORTED_FEATURES_PARTICIPANT_PRESENCE_CHANGE_NOTIFICATION 0x00004000 749 #define MAP_SUPPORTED_FEATURES_PARTICIPANT_CHAT_STATE_CHANGE_NOTIFICATION 0x00008000 750 #define MAP_SUPPORTED_FEATURES_PBAP_CONTACT_CROSS_REFERENCE 0x00010000 751 #define MAP_SUPPORTED_FEATURES_NOTIFICATION_FILTER 0x00020000 752 #define MAP_SUPPORTED_FEATURES_UTC_OFFSET_TIMESTAMP_FORMAT 0x00040000 753 #define MAP_SUPPORTED_FEATURES_MAPSUPPORTED_FEATURES 0x00080000 754 #define MAP_SUPPORTED_FEATURES_CONVERSATION_LISTING 0x00100000 755 #define MAP_SUPPORTED_FEATURES_OWNER_STATUS 0x00200000 756 #define MAP_SUPPORTED_FEATURES_MESSAGE_FORWARDING 0x00400000 757 758 /********************************************* 759 * 760 * AVRCP Macro Define 761 * 762 *********************************************/ 763 764 // The default label. The valid range is 0x00 ~ 0x0F. 765 #define AVRC_DEFAULT_LABEL (0x00) 766 // The invalid label. 767 #define AVRC_INVALID_LABEL (0x10) 768 769 /** 770 * @brief This enumeration declares the types of the methods. 771 * 772 * @since 6 773 */ 774 enum AvrcCtActionType : uint8_t { 775 AVRC_ACTION_TYPE_INVALID = 0x00, 776 AVRC_ACTION_TYPE_PRESS_BUTTON, 777 AVRC_ACTION_TYPE_RELEASE_BUTTON, 778 AVRC_ACTION_TYPE_SET_ADDRESSED_PLAYER, 779 AVRC_ACTION_TYPE_SET_BROWSED_PLAYER, 780 AVRC_ACTION_TYPE_GET_CAPABILITIES, 781 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_ATTRIBUTES, 782 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_VALUES, 783 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_CURRENT_VALUE, 784 AVRC_ACTION_TYPE_SET_PLAYER_APP_SETTING_CURRENT_VALUE, 785 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_ATTRIBUTE_TEXT, 786 AVRC_ACTION_TYPE_GET_PLAYER_APP_SETTING_VALUE_TEXT, 787 AVRC_ACTION_TYPE_GET_ELEMENT_ATTRIBUTES, 788 AVRC_ACTION_TYPE_GET_PLAY_STATUS, 789 AVRC_ACTION_TYPE_PLAY_ITEM, 790 AVRC_ACTION_TYPE_ADD_TO_NOW_PLAYING, 791 AVRC_ACTION_TYPE_CHANGE_PATH, 792 AVRC_ACTION_TYPE_GET_FOLDER_ITEMS, 793 AVRC_ACTION_TYPE_GET_ITEM_ATTRIBUTES, 794 AVRC_ACTION_TYPE_GET_TOTAL_NUMBER_OF_ITEMS, 795 AVRC_ACTION_TYPE_SET_ABSOLUTE_VOLUME, 796 AVRC_ACTION_TYPE_NOTIFY_PLAYBACK_STATUS_CHANGED, 797 AVRC_ACTION_TYPE_NOTIFY_TRACK_CHANGED, 798 AVRC_ACTION_TYPE_NOTIFY_TRACK_REACHED_END, 799 AVRC_ACTION_TYPE_NOTIFY_TRACK_REACHED_START, 800 AVRC_ACTION_TYPE_NOTIFY_PLAYBACK_POS_CHANGED, 801 AVRC_ACTION_TYPE_NOTIFY_PLAYER_APPLICATION_SETTING_CHANGED, 802 AVRC_ACTION_TYPE_NOTIFY_NOW_PLAYING_CONTENT_CHANGED, 803 AVRC_ACTION_TYPE_NOTIFY_AVAILABLE_PLAYERS_CHANGED, 804 AVRC_ACTION_TYPE_NOTIFY_ADDRESSED_PLAYER_CHANGED, 805 AVRC_ACTION_TYPE_NOTIFY_UIDS_CHANGED, 806 AVRC_ACTION_TYPE_NOTIFY_VOLUME_CHANGED, 807 AVRC_ACTION_TYPE_GET_MEDIA_PLAYER_LIST, 808 }; 809 810 /** 811 * @brief This enumeration declares the values of the supported button. 812 * @see AV/C Panel Subunit Specification 1.23 Section 9.4 PASS THROUGH control command Table 9.21 - Operation id List 813 * 814 * @since 6 815 */ 816 enum AvrcKeyOperation : uint8_t { 817 AVRC_KEY_OPERATION_VOLUME_UP = 0x41, // Volume up. 818 AVRC_KEY_OPERATION_VOLUME_DOWN = 0x42, // Volume down. 819 AVRC_KEY_OPERATION_MUTE = 0x43, // Mute. 820 AVRC_KEY_OPERATION_PLAY = 0x44, // Play. 821 AVRC_KEY_OPERATION_STOP = 0x45, // Stop. 822 AVRC_KEY_OPERATION_PAUSE = 0x46, // Pause. 823 AVRC_KEY_OPERATION_REWIND = 0x48, // Rewind. 824 AVRC_KEY_OPERATION_FAST_FORWARD = 0x49, // Fast forward. 825 AVRC_KEY_OPERATION_FORWARD = 0x4B, // Forward. 826 AVRC_KEY_OPERATION_BACKWARD = 0x4C, // Backward. 827 AVRC_KEY_OPERATION_INVALID = 0x7F, 828 }; 829 830 /** 831 * @brief This enumeration declares the values of the key state. 832 * 833 * @since 6 834 */ 835 enum AvrcTgKeyState : uint8_t { 836 AVRC_KEY_STATE_PRESS = 0x00, // The key is pushed. 837 AVRC_KEY_STATE_RELEASE = 0x01, // The key is released. 838 AVRC_KEY_STATE_INVALID, // Invalid key state. 839 }; 840 841 /** 842 * @brief This enumeration declares the values of the player application setting attributes. 843 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 844 * 845 * @since 6 846 */ 847 enum AvrcPlayerAttribute : uint8_t { 848 AVRC_PLAYER_ATTRIBUTE_ILLEGAL = 0x00, // Illegal , Should not be used. 849 AVRC_PLAYER_ATTRIBUTE_EQUALIZER = 0x01, // Equalizer ON / OFF status. 850 AVRC_PLAYER_ATTRIBUTE_REPEAT = 0x02, // Repeat Mode status. 851 AVRC_PLAYER_ATTRIBUTE_SHUFFLE = 0x03, // Shuffle ON/OFF status. 852 AVRC_PLAYER_ATTRIBUTE_SCAN = 0x04, // Scan ON/OFF status. 853 AVRC_PLAYER_ATTRIBUTE_RESERVED_MIN = 0x05, // Reserved for future use. 0x05 - 0x7F 854 AVRC_PLAYER_ATTRIBUTE_RESERVED_MAX = 0x7F, // Reserved for future use. 0x05 - 0x7F 855 AVRC_PLAYER_ATTRIBUTE_EXTENSION = 0x80, // Provided for TG driven static media player menu extension. 856 // Range: 0x80 - 0xFF 857 }; 858 859 /** 860 * @brief This enumeration declares the values of the Equalizer ON/OFF status. 861 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 862 * 863 * @since 6 864 */ 865 enum AvrcEqualizer : uint8_t { 866 AVRC_EQUALIZER_OFF = 0x01, 867 AVRC_EQUALIZER_ON, 868 AVRC_EQUALIZER_INVALID, 869 }; 870 871 /** 872 * @brief This enumeration declares the values of the Repeat Mode status. 873 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 874 * 875 * @since 6 876 */ 877 enum AvrcRepeat : uint8_t { 878 AVRC_REPEAT_OFF = 0x01, 879 AVRC_REPEAT_SINGLE_TRACK, 880 AVRC_REPEAT_ALL_TRACK, 881 AVRC_REPEAT_GROUP, 882 AVRC_REPEAT_INVALID, 883 }; 884 885 /** 886 * @brief This enumeration declares the values of the Shuffle ON/OFF status. 887 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 888 * 889 * @since 6 890 */ 891 enum AvrcShuffle : uint8_t { 892 AVRC_SHUFFLE_OFF = 0x01, 893 AVRC_SHUFFLE_ALL_TRACKS, 894 AVRC_SHUFFLE_GROUP, 895 AVRC_SHUFFLE_INVALID, 896 }; 897 898 /** 899 * @brief This enumeration declares the values of the Scan ON/OFF status. 900 * @see Audio/Video Remote Control 1.6.2 Section 27 Appendix F: list of defined player application settings and values. 901 * 902 * @since 6 903 */ 904 enum AvrcScan : uint8_t { 905 AVRC_SCAN_OFF = 0x01, 906 AVRC_SCAN_ALL_TRACKS, 907 AVRC_SCAN_GROUP, 908 AVRC_SCAN_INVALID, 909 }; 910 911 /** 912 * @brief This enumeration declares the values of the play status. 913 * 914 * @since 6 915 */ 916 enum AvrcPlayStatus : uint32_t { 917 AVRC_PLAY_STATUS_STOPPED = 0x00, // Stopped. 918 AVRC_PLAY_STATUS_PLAYING, // Playing. 919 AVRC_PLAY_STATUS_PAUSED, // Paused. 920 AVRC_PLAY_STATUS_FWD_SEEK, // Fwd seek. 921 AVRC_PLAY_STATUS_REV_SEEK, // Rev seek. 922 AVRC_PLAY_STATUS_RESERVED_MIN = 0x05, // Reserved for future use. 923 AVRC_PLAY_STATUS_RESERVED_MAX = 0xFE, // Reserved for future use. 924 AVRC_PLAY_STATUS_ERROR = 0xFF, // Error. 925 AVRC_PLAY_STATUS_INVALID_SONG_LENGTH = 0xFFFFFFFF, // If TG does not support, then TG shall return 0xFFFFFFFF. 926 AVRC_PLAY_STATUS_INVALID_SONG_POSITION = 0xFFFFFFFF, // If TG does not support, then TG shall return 0xFFFFFFFF. 927 }; 928 929 /** 930 * @brief This enumeration declares the values of folder direction. 931 * 932 * @since 6 933 */ 934 enum AvrcFolderDirection : uint8_t { 935 AVRC_FOLDER_DIRECTION_UP = 0x00, // Folder up. 936 AVRC_FOLDER_DIRECTION_DOWN = 0x01, // Folder down. 937 AVRC_FOLDER_DIRECTION_INVALID = 0x02, // Reserved. 938 }; 939 940 /** 941 * @brief This enumeration declares the values of the scope in which the UID of the media element item or folder item. 942 * @see Audio/Video Remote Control 1.6.2 Section 6.10.1 Scope. 943 * 944 * @since 6 945 */ 946 enum AvrcMediaScope : uint8_t { 947 AVRC_MEDIA_SCOPE_PLAYER_LIST = 0x00, // Contains all available media players. 948 AVRC_MEDIA_SCOPE_VIRTUAL_FILE_SYSTEM, // Contains the media content of the browsed player. 949 AVRC_MEDIA_SCOPE_SEARCH, // The results of a search operation on the browsed player. 950 AVRC_MEDIA_SCOPE_NOW_PLAYING, // The Now Playing list (or queue) of the addressed player. 951 AVRC_MEDIA_SCOPE_INVALID, 952 }; 953 954 /** 955 * @brief This enumeration declares the values of the browseable items. 956 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2 Browseable items. 957 * 958 * @since 6 959 */ 960 enum AvrcMediaType : uint8_t { 961 AVRC_MEDIA_TYPE_MEDIA_PLAYER_ITEM = 0x01, 962 AVRC_MEDIA_TYPE_FOLDER_ITEM, 963 AVRC_MEDIA_TYPE_MEDIA_ELEMENT_ITEM, 964 AVRC_MEDIA_TYPE_INVALID, 965 }; 966 967 /** 968 * @brief This enumeration declares the values of the attribute count. 969 * @see Audio/Video Remote Control 1.6.2 Section 6.10.4.2 GetFolderItems - Attribute Count. 970 * 971 * @since 6 972 */ 973 enum AvrcAttributeCount { 974 AVRC_ATTRIBUTE_COUNT_ALL = 0x00, 975 AVRC_ATTRIBUTE_COUNT_NO = 0xFF, 976 }; 977 978 /** 979 * @brief This enumeration declares the values of the media attribute. These values are used to uniquely identify media 980 * information. 981 * @see Audio/Video Remote Control 1.6.2 Section 26 Appendix E: list of media attributes. 982 * 983 * @since 6 984 */ 985 enum AvrcMediaAttribute : uint8_t { 986 // Not used. 987 AVRC_MEDIA_ATTRIBUTE_NOT_USED = 0x00, 988 // Text field representing the title, song name or content description coded per specified character set. 989 AVRC_MEDIA_ATTRIBUTE_TITLE, 990 // Text field representing artist(s), performer(s) or group coded per specified character set. 991 AVRC_MEDIA_ATTRIBUTE_ARTIST_NAME, 992 // Text field representing the title of the recording(source) from which the audio in the file is taken. 993 AVRC_MEDIA_ATTRIBUTE_ALBUM_NAME, 994 // Numeric ASCII string containing the order number of the audio - file on its original recording.O 0x5 Total 995 // Number of Tracks. 996 AVRC_MEDIA_ATTRIBUTE_TRACK_NUMBER, 997 // Numeric ASCII string containing the total number of tracks or elements on the original recording. 998 AVRC_MEDIA_ATTRIBUTE_TOTAL_NUMBER_OF_TRACKS, 999 // Text field representing the category of the composition characterized by a particular style. 1000 AVRC_MEDIA_ATTRIBUTE_GENRE, 1001 // Numeric ASCII string containing the length of the audio file in milliseconds.(E.g .02 : 30 = 150000) 1002 AVRC_MEDIA_ATTRIBUTE_PLAYING_TIME, 1003 // BIP Image Handle. 1004 AVRC_MEDIA_ATTRIBUTE_DEFAULT_COVER_ART, 1005 // Reserved for future use. 1006 AVRC_MEDIA_ATTRIBUTE_RESERVED, 1007 }; 1008 1009 /** 1010 * @brief This enumeration declares the values of the major player type. 1011 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.1 Media player item - Major Player Type 1012 * 1013 * @since 6 1014 */ 1015 enum AvrcMediaMajorPlayerType : uint8_t { 1016 AVRC_MEDIA_MAJOR_PLAYER_TYPE_AUDIO = 0x01, // Audio. 1017 AVRC_MEDIA_MAJOR_PLAYER_TYPE_VIDEO = 0x02, // Video. 1018 AVRC_MEDIA_MAJOR_PLAYER_TYPE_BROADCASTING_AUDIO = 0x04, // Broadcasting Audio. 1019 AVRC_MEDIA_MAJOR_PLAYER_TYPE_BROADCASTING_VIDEO = 0x08, // Broadcasting Video. 1020 AVRC_MEDIA_MAJOR_PLAYER_TYPE_RESERVED = 0x10 // Reserved for future use. 1021 }; 1022 1023 /** 1024 * @brief This enumeration declares the values of the major player type. 1025 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.1 Media player item - Player Sub Type 1026 * 1027 * @since 6 1028 */ 1029 enum AvrcMediaPlayerSubType : uint32_t { 1030 AVRC_MEDIA_PLAYER_SUB_TYPE_AUDIO_BOOK = 0x00000001, // Audio Book. 1031 AVRC_MEDIA_PLAYER_SUB_TYPE_PODCAST = 0x00000002, // Pod cast. 1032 AVRC_MEDIA_PLAYER_SUB_TYPE_RESERVED = 0x00000004 // Reserved for future use. 1033 }; 1034 1035 /** 1036 * @brief This enumeration declares the values of character set. 1037 * 1038 * @since 6 1039 */ 1040 enum AvrcMediaCharacterSet : uint16_t { 1041 AVRC_MEDIA_CHARACTER_SET_UTF8 = 0x006A, // The value of UTF-8 as defined in IANA character set document. 1042 }; 1043 1044 /** 1045 * @brief This enumeration declares the values of the folder type. 1046 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.2 Folder item - Folder Type 1047 * 1048 * @since 6 1049 */ 1050 enum AvrcMediaFolderType : uint8_t { 1051 AVRC_MEDIA_FOLDER_TYPE_MIXED = 0x00, // Mixed. 1052 AVRC_MEDIA_FOLDER_TYPE_TITLES, // Titles. 1053 AVRC_MEDIA_FOLDER_TYPE_ALBUMS, // Albums. 1054 AVRC_MEDIA_FOLDER_TYPE_ARTISTS, // Artists. 1055 AVRC_MEDIA_FOLDER_TYPE_GENRES, // Genres. 1056 AVRC_MEDIA_FOLDER_TYPE_PLAY_LISTS, // Play lists. 1057 AVRC_MEDIA_FOLDER_TYPE_YEARS, // Years. 1058 AVRC_MEDIA_FOLDER_TYPE_RESERVED, // Reserved for future use. 1059 }; 1060 1061 /** 1062 * @brief This enumeration declares the values of the is playable. 1063 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.2 Folder item - Is Playable 1064 * 1065 * @since 6 1066 */ 1067 enum AvrcMediaFolderPlayable : uint8_t { 1068 // The folder cannot be played. This means that the folder UID shall not be passed to either the PlayItem or 1069 // AddToNowPlaying commands. 1070 AVRC_MEDIA_FOLDER_PLAYABLE_NO = 0x00, 1071 // The folder can be played. The folder UID may be passed to the PlayItem and AddToNowPlaying(if supported) 1072 // commands. The media player behavior on playing a folder should be same as on the local user interface. 1073 AVRC_MEDIA_FOLDER_PLAYABLE_YES, 1074 AVRC_MEDIA_FOLDER_PLAYABLE_RESERVED, // Reserved for future use. 1075 }; 1076 1077 /** 1078 * @brief This enumeration declares the values of the media type. 1079 * @see Audio/Video Remote Control 1.6.2 Section 6.10.2.3 Media element item - Media Type 1080 * 1081 * @since 6 1082 */ 1083 enum AvrcMediaElementType : uint8_t { 1084 AVRC_MEDIA_ELEMENT_TYPE_AUDIO = 0x00, // Audio. 1085 AVRC_MEDIA_ELEMENT_TYPE_VIDEO, // Video. 1086 AVRC_MEDIA_ELEMENT_TYPE_RESERVED, // Reserved for future use. 1087 }; 1088 1089 /** 1090 * @brief This enumeration declares the values of the media type. 1091 * 1092 * @details An Absolute Volume is represented in one octet. The top bit (bit 7) is reserved for future addition (RFA). 1093 * The volume is specified as a percentage of the maximum. The value 0x0 corresponds to 0%. The value 0x7F corresponds 1094 * to 100%. Scaling should be applied to achieve values between these two. The existence of this scale does not impose 1095 * any restriction on the granularity of the volume control scale on the TG. 1096 * @see Audio/Video Remote Control 1.6.2 Section 6.13.1 Absolute Volume 1097 * 1098 * @since 6 1099 */ 1100 enum AvrcAbsoluteVolume : uint8_t { 1101 AVRC_ABSOLUTE_VOLUME_PERCENTAGE_0 = 0x00, // 0% 1102 AVRC_ABSOLUTE_VOLUME_PERCENTAGE_100 = 0x7F, // 100% 1103 AVRC_ABSOLUTE_VOLUME_INVALID = 0x80, 1104 }; 1105 1106 enum DeviceAbsVolumeAbility { 1107 DEVICE_ABSVOL_CLOSE = 0, 1108 DEVICE_ABSVOL_OPEN = 1, 1109 DEVICE_ABSVOL_UNSUPPORT = 2, 1110 DEVICE_ABSVOL_BUTT 1111 }; 1112 1113 /** 1114 * @brief This enumeration declares the values of the "EVENT ID". 1115 * @see Audio/Video Remote Control 1.6.2 Section 28 Appendix H: list of defined notification events. 1116 * 1117 * @since 6 1118 */ 1119 enum AvrcEventId : uint8_t { 1120 AVRC_EVENT_ID_PLAYBACK_STATUS_CHANGED = 0x01, // Change in playback status of the current track. 1121 AVRC_EVENT_ID_TRACK_CHANGED, // Change of current track. 1122 AVRC_EVENT_ID_TRACK_REACHED_END, // Reached end of a track. 1123 AVRC_EVENT_ID_TRACK_REACHED_START, // Reached start of a track. 1124 // Change in playback position. Returned after the specified playback notification change notification interval. 1125 AVRC_EVENT_ID_PLAYBACK_POS_CHANGED, 1126 AVRC_EVENT_ID_BATT_STATUS_CHANGED, // Change in battery status. 1127 AVRC_EVENT_ID_SYSTEM_STATUS_CHANGED, // Change in system status. 1128 AVRC_EVENT_ID_PLAYER_APPLICATION_SETTING_CHANGED, // Change in player application setting. 1129 AVRC_EVENT_ID_NOW_PLAYING_CONTENT_CHANGED, // The content of the Now Playing list has changed. 1130 AVRC_EVENT_ID_AVAILABLE_PLAYERS_CHANGED, // The available players have changed 1131 AVRC_EVENT_ID_ADDRESSED_PLAYER_CHANGED, // The Addressed Player has been changed. 1132 AVRC_EVENT_ID_UIDS_CHANGED, // The UIDs have changed. 1133 AVRC_EVENT_ID_VOLUME_CHANGED, // The volume has been changed locally on the TG. 1134 AVRC_EVENT_ID_RESERVED = 0x0E, 1135 }; 1136 1137 /** 1138 * @bUnique identifier to identify an element on TG 1139 * 1140 * @since 6 1141 */ 1142 enum AvrcElementIdentifier : uint64_t { 1143 AVRC_ELEMENT_ATTRIBUTES_IDENTIFIER_PLAYING = 1144 0x0000000000000000, // attribute information for the element which is current track in the TG device. 1145 AVRC_ELEMENT_ATTRIBUTES_IDENTIFIER_RESERVED = 1146 0x0000000000000001, // All other values other than 0x0 are currently reserved. 1147 }; 1148 1149 /** 1150 * @brief This enumeration declares the allowed values for GetCapabilities Command. 1151 * 1152 * @since 6 1153 */ 1154 enum AvrcCapabilityId : uint8_t { 1155 AVRC_CAPABILITY_COMPANYID = 0x02, // The list of CompanyID supported by TG. 1156 AVRC_CAPABILITY_EVENTID = 0x03, // EventIDs defined in this specification to be supported by TG. 1157 }; 1158 1159 /** 1160 * @brief This enumeration declares the values of playback interval in seconds. 1161 * 1162 * @since 6 1163 */ 1164 enum AvrcPlaybackInterval : uint8_t { 1165 AVRC_PLAYBACK_INTERVAL_1_SEC = 0x01, 1166 AVRC_PLAYBACK_INTERVAL_5_SEC = 0x05, 1167 AVRC_PLAYBACK_INTERVAL_10_SEC = 0x0A, 1168 AVRC_PLAYBACK_INTERVAL_15_SEC = 0x0F, 1169 AVRC_PLAYBACK_INTERVAL_20_SEC = 0x14, 1170 AVRC_PLAYBACK_INTERVAL_25_SEC = 0x19, 1171 AVRC_PLAYBACK_INTERVAL_30_SEC = 0x1E, 1172 }; 1173 1174 /** 1175 * @brief This enumeration declares the error / status code of the vendor dependent command frame and the browsing 1176 * command frame. 1177 * 1178 * @since 6 1179 */ 1180 enum AvrcEsCode : uint8_t { 1181 AVRC_ES_CODE_INVALID = 0xFF, // Reserved. 1182 // Invalid command, sent if TG received a PDU that it did not understand. 1183 AVRC_ES_CODE_INVALID_COMMAND = 0x00, 1184 // Invalid parameter, sent if the TG received a PDU with a parameter ID that it did not understand. This error code 1185 // applies to the following identifiers : 1186 // PDU ID. 1187 // Capability ID. 1188 // Event ID. 1189 // Player Application Setting Attribute ID. 1190 // Player Application Setting Value ID. 1191 // Element Attribute ID. 1192 AVRC_ES_CODE_INVALID_PARAMETER = 0x01, 1193 // Parameter content error.Sent if the parameter ID is understood, but content is wrong or corrupted. 1194 AVRC_ES_CODE_PARAMETER_CONTENT_ERROR = 0x02, 1195 // Internal Error - sent if there are error conditions not covered by a more specific error code. 1196 AVRC_ES_CODE_INTERNAL_ERROR = 0x03, 1197 // Operation completed without error.This is the status that should be returned if the operation was successful. 1198 AVRC_ES_CODE_NO_ERROR = 0x04, 1199 // UID Changed - The UIDs on the device have changed. 1200 AVRC_ES_CODE_UID_CHANGED = 0x05, 1201 // Reserved. 1202 AVRC_ES_CODE_RESERVED = 0x06, 1203 // Invalid Direction - The Direction parameter is invalid. 1204 AVRC_ES_CODE_INVALID_DIRECTION = 0x07, 1205 // Not a Directory - The UID provided does not refer to a folder item. 1206 AVRC_ES_CODE_NOT_A_DIRECTORY = 0x08, 1207 // Does Not Exist - The UID provided does not refer to any currently valid item. 1208 AVRC_ES_CODE_DOES_NOT_EXIST = 0x09, 1209 // Invalid Scope - The scope parameter is invalid. 1210 AVRC_ES_CODE_INVALID_SCOPE = 0x0A, 1211 // Range Out of Bounds - The start of range provided is not valid. 1212 AVRC_ES_CODE_RANGE_OUT_OF_BOUNDS = 0x0B, 1213 // Folder Item is not playable - The UID provided refers to a folder item which cannot be handled by this media 1214 // player. 1215 AVRC_ES_CODE_FOLDER_ITEM_IS_NOT_PLAYABLE = 0x0C, 1216 // Media in Use - The media is not able to be used for this operation at this time. 1217 AVRC_ES_CODE_MEDIA_IN_USE = 0x0D, 1218 // Now Playing List Full - No more items can be added to the Now Playing List. 1219 AVRC_ES_CODE_NOW_PLAYING_LIST_FULL = 0x0E, 1220 // Search Not Supported - The Browsed Media Player does not support search. 1221 AVRC_ES_CODE_SEARCH_NOT_SUPPORTED = 0x0F, 1222 // Search in Progress - A search operation is already in progress. 1223 AVRC_ES_CODE_SEARCH_IN_PROGRESS = 0x10, 1224 // Invalid Player Id - The specified Player Id does not refer to a valid player. 1225 AVRC_ES_CODE_INVALID_PLAYER_ID = 0x11, 1226 // Player Not Browsable - The Player Id supplied refers to a Media Player which does not support browsing. 1227 AVRC_ES_CODE_PLAYER_NOT_BROWSABLE = 0x12, 1228 // Player Not Addressed.The Player Id supplied refers to a player which is not currently addressed, and the command 1229 // is not able to be performed if the player is not set as addressed. 1230 AVRC_ES_CODE_PLAYER_NOT_ADDRESSED = 0x13, 1231 // No valid Search Results - The Search result list does not contain valid entries, e.g.after being invalidated due 1232 // to change of browsed player. 1233 AVRC_ES_CODE_NO_VALID_SEARCH_RESULTS = 0x14, 1234 // No available players. 1235 AVRC_ES_CODE_NO_AVAILABLE_PLAYERS = 0x15, 1236 // Addressed Player Changed. 1237 AVRC_ES_CODE_ADDRESSED_PLAYER_CHANGED = 0x16, 1238 1239 // User custom error code. 1240 AVRC_ES_CODE_NOTIFICATION_CHANGED = 0xFF, 1241 }; 1242 1243 /********************************************* 1244 * 1245 * HFP Definitions 1246 * 1247 *********************************************/ 1248 /** 1249 * @brief sco connect state define 1250 * use to notify sco connection observers. 1251 */ 1252 enum class HfpScoConnectState : int { SCO_DISCONNECTED = 3, SCO_CONNECTING, SCO_DISCONNECTING, SCO_CONNECTED }; 1253 1254 /********************************************* 1255 * 1256 * A2DP Definitions 1257 * 1258 *********************************************/ 1259 1260 /** 1261 * @brief a2dp optional codec support state define 1262 * 1263 * @since 6 1264 */ 1265 enum A2DP_OPTIONAL_SUPPORT_STATE { 1266 A2DP_OPTIONAL_NOT_SUPPORT, 1267 A2DP_OPTIONAL_SUPPORT, 1268 A2DP_OPTIONAL_SUPPORT_UNKNOWN, 1269 }; 1270 1271 /** 1272 * @brief a2dp optional codec enable state define 1273 * 1274 * @since 6 1275 */ 1276 enum A2DP_OPTIONAL_ENABLE_STATE { A2DP_OPTIONAL_DISABLE, A2DP_OPTIONAL_ENABLE, A2DP_OPTIONAL_ENABLE_UNKNOWN }; 1277 1278 /** 1279 * @brief a2dp playing state define 1280 * 1281 * @since 6 1282 */ 1283 enum A2DP_PLAYING_STATE { A2DP_NOT_PLAYING, A2DP_IS_PLAYING }; 1284 1285 /** 1286 * @brief A2dp codec type enum. 1287 * 1288 * @since 6 1289 1290 */ 1291 enum A2dpUserCodecType : uint8_t { 1292 A2DP_CODEC_TYPE_SBC_USER = 0, 1293 A2DP_CODEC_TYPE_MPEG1_USER = 0x01, 1294 A2DP_CODEC_TYPE_AAC_USER = 0x01 << 1, 1295 A2DP_CODEC_TYPE_ATRAC_USER = 0x01 << 2, 1296 A2DP_CODEC_TYPE_L2HCV2_USER = 0x0A, 1297 A2DP_CODEC_TYPE_L2HCST_USER = 0x0B, 1298 A2DP_CODEC_TYPE_LDAC_USER = 0x10, 1299 A2DP_CODEC_TYPE_NONA2DP_USER = 0xFF 1300 }; 1301 1302 /** 1303 * @brief A2dp codec priority enum. 1304 * 1305 * @since 6 1306 */ 1307 enum A2dpUserCodecPriority : uint32_t { 1308 A2DP_CODEC_PRIORITY_DISABLED_USER = 0, 1309 A2DP_CODEC_PRIORITY_DEFAULT_USER, 1310 A2DP_CODEC_PRIORITY_SBC_USER = 1001, 1311 A2DP_CODEC_PRIORITY_AAC_USER = 2001, 1312 A2DP_CODEC_PRIORITY_LDAC_USER = 5001, 1313 A2DP_CODEC_PRIORITY_L2HCV2_USER = 8001, 1314 A2DP_CODEC_PRIORITY_HIGHEST_USER = 1000 * 1000, 1315 }; 1316 1317 /** 1318 * @brief A2dp codec sample rate enum. 1319 * 1320 * @since 6 1321 */ 1322 enum A2dpUserCodecSampleRate : uint32_t { 1323 A2DP_SAMPLE_RATE_NONE_USER = 0x0, 1324 A2DP_SBC_SAMPLE_RATE_48000_USER = 0x1 << 4, /* octet0 b4 */ 1325 A2DP_SBC_SAMPLE_RATE_44100_USER = 0x1 << 5, /* octet0 b5 */ 1326 A2DP_SBC_SAMPLE_RATE_32000_USER = 0x1 << 6, /* octet0 b6 */ 1327 A2DP_SBC_SAMPLE_RATE_16000_USER = 0x1 << 7, /* octet0 b7 */ 1328 A2DP_SBC_SAMPLE_RATE_MSK_USER = 0xF0, 1329 A2DP_AAC_SAMPLE_RATE_OCTET1_44100_USER = 0x01, 1330 A2DP_AAC_SAMPLE_RATE_OCTET1_32000_USER = 0x01 << 1, 1331 A2DP_AAC_SAMPLE_RATE_OCTET1_24000_USER = 0x01 << 2, 1332 A2DP_AAC_SAMPLE_RATE_OCTET1_22050_USER = 0x01 << 3, 1333 A2DP_AAC_SAMPLE_RATE_OCTET1_16000_USER = 0x01 << 4, 1334 A2DP_AAC_SAMPLE_RATE_OCTET1_12000_USER = 0x01 << 5, 1335 A2DP_AAC_SAMPLE_RATE_OCTET1_11025_USER = 0x01 << 6, 1336 A2DP_AAC_SAMPLE_RATE_OCTET1_8000_USER = 0x01 << 7, 1337 A2DP_AAC_SAMPLE_RATE_OCTET1_MSK_USER = 0xFF, 1338 A2DP_AAC_SAMPLE_RATE_OCTET2_96000_USER = 0x01 << 12, 1339 A2DP_AAC_SAMPLE_RATE_OCTET2_88200_USER = 0x01 << 13, 1340 A2DP_AAC_SAMPLE_RATE_OCTET2_64000_USER = 0x01 << 14, 1341 A2DP_AAC_SAMPLE_RATE_OCTET2_48000_USER = 0x01 << 15, 1342 A2DP_AAC_SAMPLE_RATE_OCTET2_MSK_USER = 0xF0, 1343 A2DP_L2HCV2_SAMPLE_RATE_48000_USER = 0x01 << 1, 1344 A2DP_L2HCV2_SAMPLE_RATE_96000_USER = 0x01 << 3, 1345 A2DP_L2HCV2_SAMPLE_RATE_ALL_MSK_USER = 0x0A, 1346 }; 1347 1348 /** 1349 * @brief A2dp codec channel mode enum. 1350 * 1351 * @since 6 1352 */ 1353 enum A2dpUserCodecChannelMode : uint8_t { 1354 A2DP_CHANNEL_MODE_NONE_USER = 0x0, 1355 A2DP_SBC_CHANNEL_MODE_JOINT_STEREO_USER = 0x1, /* octet0 b0 */ 1356 A2DP_SBC_CHANNEL_MODE_STEREO_USER = 0x1 << 1, /* octet0 b1 */ 1357 A2DP_SBC_CHANNEL_MODE_DUAL_USER = 0x1 << 2, /* octet0 b2 */ 1358 A2DP_SBC_CHANNEL_MODE_MONO_USER = 0x1 << 3, /* octet0 b3 */ 1359 A2DP_SBC_CHANNEL_MODE_MONO_STEREO_USER = 0x0A, 1360 A2DP_SBC_CHANNEL_MODE_MSK_USER = 0x0F, 1361 A2DP_AAC_CHANNEL_MODE_OCTET2_DOUBLE_USER = 0x01 << 2, /* octet2 b2 */ 1362 A2DP_AAC_CHANNEL_MODE_OCTET2_SINGLE_USER = 0x01 << 3, /* octet2 b3 */ 1363 A2DP_AAC_CHANNEL_MODE_OCTET2_MSK_USER = 0x0C, 1364 }; 1365 1366 /** 1367 * @brief A2dp codec bits per sample enum. 1368 * 1369 * @since 6 1370 */ 1371 enum A2dpUserCodecBitsPerSample : uint8_t { 1372 A2DP_SAMPLE_BITS_NONE_USER = 0x0, 1373 A2DP_SAMPLE_BITS_16_USER = 0x1 << 0, 1374 A2DP_SAMPLE_BITS_24_USER = 0x1 << 1, 1375 A2DP_SAMPLE_BITS_32_USER = 0x1 << 2, 1376 A2DP_SAMPLE_BITS_MSK_USER = 0x06, 1377 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT0_USER = 0x01, /* octet3 b0 */ 1378 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT1_USER = 0x01 << 1, /* octet3 b1 */ 1379 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT2_USER = 0x01 << 2, /* octet3 b2 */ 1380 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT3_USER = 0x01 << 3, /* octet3 b3 */ 1381 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT4_USER = 0x01 << 4, /* octet3 b4 */ 1382 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT5_USER = 0x01 << 5, /* octet3 b5 */ 1383 A2DP_AAC_SAMPLE_BITS_OCTET3_BIT6_USER = 0x01 << 6, /* octet3 b6 */ 1384 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT0_USER = 0x01, /* octet4 b0 */ 1385 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT1_USER = 0x01 << 1, /* octet4 b1 */ 1386 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT2_USER = 0x01 << 2, /* octet4 b2 */ 1387 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT3_USER = 0x01 << 3, /* octet4 b3 */ 1388 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT4_USER = 0x01 << 4, /* octet4 b4 */ 1389 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT5_USER = 0x01 << 5, /* octet4 b5 */ 1390 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT6_USER = 0x01 << 6, /* octet4 b6 */ 1391 A2DP_AAC_SAMPLE_BITS_OCTET4_BIT7_USER = 0x01 << 7, /* octet4 b6 */ 1392 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT0_USER = 0x01, /* octet5 b0 */ 1393 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT1_USER = 0x01 << 1, /* octet5 b1 */ 1394 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT2_USER = 0x01 << 2, /* octet5 b2 */ 1395 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT3_USER = 0x01 << 3, /* octet5 b3 */ 1396 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT4_USER = 0x01 << 4, /* octet5 b4 */ 1397 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT5_USER = 0x01 << 5, /* octet5 b5 */ 1398 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT6_USER = 0x01 << 6, /* octet5 b6 */ 1399 A2DP_AAC_SAMPLE_BITS_OCTET5_BIT7_USER = 0x01 << 7, /* octet5 b6 */ 1400 }; 1401 1402 /** 1403 * @brief Pbap action Type. 1404 * 1405 * @since 6 1406 */ 1407 enum PbapActionType : uint16_t { 1408 PBAP_ACTION_PULLPHONEBOOKSIZE, // pull phonebooksize 1409 PBAP_ACTION_PULLPHONEBOOK, // pull phonebook 1410 PBAP_ACTION_SETPHONEBOOK, // set phonebook 1411 PBAP_ACTION_PULLVCARDLISTINGSIZE, // pull vcard listing size 1412 PBAP_ACTION_PULLVCARDLISTING, // pull vcard listing 1413 PBAP_ACTION_PULLVCARDENTRY, // pull vcard entry 1414 PBAP_ACTION_ABORT, // abort downloading 1415 }; 1416 1417 // PBAP_PHONEBOOK_NAME 1418 #define PBAP_PHONEBOOK_PB u"/telecom/pb.vcf" 1419 #define PBAP_PHONEBOOK_ICH u"/telecom/ich.vcf" 1420 #define PBAP_PHONEBOOK_OCH u"/telecom/och.vcf" 1421 #define PBAP_PHONEBOOK_MCH u"/telecom/mch.vcf" 1422 #define PBAP_PHONEBOOK_CCH u"/telecom/cch.vcf" 1423 #define PBAP_PHONEBOOK_SPD u"/telecom/spd.vcf" 1424 #define PBAP_PHONEBOOK_FAV u"/telecom/fav.vcf" 1425 #define PBAP_PHONEBOOK_PB1 u"/SIM1/telecom/pb.vcf" 1426 #define PBAP_PHONEBOOK_ICH1 u"/SIM1/telecom/ich.vcf" 1427 #define PBAP_PHONEBOOK_OCH1 u"/SIM1/telecom/och.vcf" 1428 #define PBAP_PHONEBOOK_MCH1 u"/SIM1/telecom/mch.vcf" 1429 #define PBAP_PHONEBOOK_CCH1 u"/SIM1/telecom/cch.vcf" 1430 1431 enum PbapOrderType : uint8_t { 1432 PBAP_ORDER_INDEXED = 0x00, // indexed order 1433 PBAP_ORDER_ALPHANUMERIC = 0x01, // alphabetical order 1434 PBAP_ORDER_PHONETIC = 0x02, // phonetic order 1435 }; 1436 1437 enum PbapFormatType : uint8_t { 1438 PBAP_FORMAT_VCARD2_1 = 0x00, // vCard Version 1439 PBAP_FORMAT_VCARD3_0 = 0x01, // vCard Version 1440 }; 1441 1442 // 5.1.4.1 PropertySelector {PropertyMask (64-bit value)} 1443 #define PBAP_PROPERTY_VERSION (1ULL << 0) // vCard Version 1444 #define PBAP_PROPERTY_FN (1ULL << 1) // Formatted Name 1445 #define PBAP_PROPERTY_N (1ULL << 2) // Structured Presentation of Name 1446 #define PBAP_PROPERTY_PHOTO (1ULL << 3) // Associated Image or Photo 1447 #define PBAP_PROPERTY_BDAY (1ULL << 4) // Birthday 1448 #define PBAP_PROPERTY_ADR (1ULL << 5) // Delivery Address 1449 #define PBAP_PROPERTY_LABEL (1ULL << 6) // Delivery 1450 #define PBAP_PROPERTY_TEL (1ULL << 7) // Telephone Number 1451 #define PBAP_PROPERTY_EMAIL (1ULL << 8) // Electronic Mail Address 1452 #define PBAP_PROPERTY_MAILER (1ULL << 9) // Electronic Mail 1453 #define PBAP_PROPERTY_TZ (1ULL << 10) // Time Zone 1454 #define PBAP_PROPERTY_GEO (1ULL << 11) // Geographic Position 1455 #define PBAP_PROPERTY_TITLE (1ULL << 12) // Job 1456 #define PBAP_PROPERTY_ROLE (1ULL << 13) // Role within the Organization 1457 #define PBAP_PROPERTY_LOGO (1ULL << 14) // Organization Logo 1458 #define PBAP_PROPERTY_AGENT (1ULL << 15) // vCard of Person Representing 1459 #define PBAP_PROPERTY_ORG (1ULL << 16) // Name of Organization 1460 #define PBAP_PROPERTY_NOTE (1ULL << 17) // Comments 1461 #define PBAP_PROPERTY_REV (1ULL << 18) // Revision 1462 #define PBAP_PROPERTY_SOUND (1ULL << 19) // Pronunciation of Name 1463 #define PBAP_PROPERTY_URL (1ULL << 20) // Uniform Resource Locator 1464 #define PBAP_PROPERTY_UID (1ULL << 21) // Unique ID 1465 #define PBAP_PROPERTY_KEY (1ULL << 22) // Public Encryption Key 1466 #define PBAP_PROPERTY_NICKNAME (1ULL << 23) // Nickname 1467 #define PBAP_PROPERTY_CATEGORIES (1ULL << 24) // Categories 1468 #define PBAP_PROPERTY_PROID (1ULL << 25) // Product ID 1469 #define PBAP_PROPERTY_CLASS (1ULL << 26) // Class information 1470 #define PBAP_PROPERTY_SORT_STRING (1ULL << 27) // String used for sorting operations 1471 #define PBAP_PROPERTY_X_IRMC_CALL_DATETIME (1ULL << 28) // Time stamp 1472 #define PBAP_PROPERTY_X_BT_SPEEDDIALKEY (1ULL << 29) // Speed-dial shortcut 1473 #define PBAP_PROPERTY_X_BT_UCI (1ULL << 30) // Uniform Caller Identifier 1474 #define PBAP_PROPERTY_X_BT_UID (1ULL << 31) // Bluetooth Contact Unique Identifier 1475 #define PBAP_PROPERTY_PROPRIENTARY_FILTER (1ULL << 39) // Bluetooth Proprientary 1476 1477 enum PbapSelectorOperatorType : uint8_t { 1478 PBAP_SELECTOR_OPERATOR_OR = 0x00, // SelectorOperator Or 1479 PBAP_SELECTOR_OPERATOR_AND = 0x01, // SelectorOperator And 1480 }; 1481 1482 enum PbapSearchPropertyType : uint8_t { 1483 PBAP_SEARCH_PROPERTY_NAME = 0x00, // name 1484 PBAP_SEARCH_PROPERTY_NUMBER = 0x01, // number 1485 PBAP_SEARCH_PROPERTY_SOUND = 0x02, // sound 1486 }; 1487 1488 const uint8_t PBAP_FLAG_GO_TO_ROOT = 0x02; // go back to root 1489 const uint8_t PBAP_FLAG_GO_DOWN = 0x02; // go down 1490 const uint8_t PBAP_FLAG_GO_UP = 0x03; // go up 1491 1492 enum PbapResponseCode : uint8_t { 1493 PBAP_CONTINUE = 0x90, // 100 Continue 1494 PBAP_SUCCESS = 0xA0, // 200 OK, Success 1495 PBAP_CREATED = 0xA1, // 201 Created 1496 PBAP_PBAP_ACCEPTED = 0xA2, // 202 Accepted 1497 PBAP_NON_AUTH = 0xA3, // 203 Non-Authoritative Information 1498 PBAP_NO_CONTENT = 0xA4, // 204 No Content 1499 PBAP_RESET_CONTENT = 0xA5, // 205 Reset Content 1500 PBAP_PARTIAL_CONTENT = 0xA6, // 206 Partial Content 1501 PBAP_MULTIPLE_CHOICES = 0xB0, // 300 Multiple Choices 1502 PBAP_MOVED_PERMANENTLY = 0xB1, // 301 Moved Permanently 1503 PBAP_MOVED_TEMPORARILY = 0xB2, // 302 Moved temporarily 1504 PBAP_SEE_OTHER = 0xB3, // 303 See Other 1505 PBAP_NOT_MODIFIED = 0xB4, // 304 Not modified 1506 PBAP_USE_PROXY = 0xB5, // 305 Use Proxy 1507 PBAP_BAD_REQUEST = 0xC0, // 400 Bad Request - server couldn’t understand request 1508 PBAP_UNAUTHORIZED = 0xC1, // 401 Unauthorized 1509 PBAP_PAYMENT_REQUIRED = 0xC2, // 402 Payment required 1510 PBAP_FORBIDDEN = 0xC3, // 403 Forbidden - operation is understood but refused 1511 PBAP_NOT_FOUND = 0xC4, // 404 Not Found 1512 PBAP_METHOD_NOT_ALLOWED = 0xC5, // 405 Method not allowed 1513 PBAP_NOT_ACCEPTABLE = 0xC6, // 406 Not Acceptable 1514 PBAP_PROXY_AUTH_REQUIRED = 0xC7, // 407 Proxy Authentication required 1515 PBAP_REQUEST_TIME_OUT = 0xC8, // 408 Request Time Out 1516 PBAP_CONFLICT = 0xC9, // 409 Conflict 1517 PBAP_GONE = 0xCA, // 410 Gone 1518 PBAP_LENGTH_REQUIRED = 0xCB, // 411 Length Required 1519 PBAP_PRECONDITION_FAILED = 0xCC, // 412 Precondition failed 1520 PBAP_REQUESTED_ENTITY_TOO_LARGE = 0xCD, // 413 Requested entity too large 1521 PBAP_REQUEST_URL_TOO_LARGE = 0xCE, // 414 Request URL too large 1522 PBAP_UNSUPPORTED_MEDIA_TYPE = 0xCF, // 415 Unsupported media type 1523 PBAP_INTERNAL_SERVER_ERROR = 0xD0, // 500 Internal Server Error 1524 PBAP_NOT_IMPLEMENTED = 0xD1, // 501 Not Implemented 1525 PBAP_BAD_GATEWAY = 0xD2, // 502 Bad Gateway 1526 PBAP_SERVICE_UNAVAILABLE = 0xD3, // 503 Service Unavailable 1527 PBAP_GATEWAY_TIMEOUT = 0xD4, // 504 Gateway Timeout 1528 PBAP_HTTP_VERSION_NOT_SUPPORTED = 0xD5, // 505 HTTP version not supported 1529 PBAP_DATABASE_FULL = 0xE0, // Database Full 1530 PBAP_DATABASE_LOCKED = 0xE1 // Database Locked 1531 }; 1532 1533 struct CocUpdateSocketParam { 1534 std::string addr; 1535 int32_t minInterval; 1536 int32_t maxInterval; 1537 int32_t peripheralLatency; 1538 int32_t supervisionTimeout; 1539 int32_t minConnEventLen; 1540 int32_t maxConnEventLen; 1541 }; 1542 1543 enum UpdateOutputStackAction { 1544 ACTION_WEAR = 0, 1545 ACTION_UNWEAR = 1, 1546 ACTION_ENABLE_FROM_REMOTE = 2, 1547 ACTION_DISABLE_FROM_REMOTE = 3, 1548 ACTION_ENABLE_WEAR_DETECTION = 4, 1549 ACTION_DISABLE_WEAR_DETECTION = 5, 1550 ACTION_USER_OPERATION = 6, 1551 ACTION_STOP_VIRTUAL_CALL = 7, 1552 ACTION_UPDATE_DEVICE_TYPE = 8, 1553 }; 1554 1555 enum HfpAgScoStateChangeReason { 1556 HFP_AG_SCO_INVALID = 0, 1557 HFP_AG_SCO_LOCAL_USER_TERMINATED = 1, 1558 HFP_AG_SCO_REMOTE_USER_TERMINATED = 2, 1559 HFP_AG_SCO_LOCAL_USER_SET_UP = 3, 1560 HFP_AG_SCO_REMOTE_USER_SET_UP = 4, 1561 }; 1562 1563 enum DeviceType { 1564 DEVICE_TYPE_DEFAULT = 0, 1565 DEVICE_TYPE_CAR = 1, 1566 DEVICE_TYPE_HEADSET = 2, 1567 DEVICE_TYPE_HEARING = 3, 1568 DEVICE_TYPE_GLASSES = 4, 1569 DEVICE_TYPE_WATCH = 5, 1570 DEVICE_TYPE_SPEAKER = 6, 1571 DEVICE_TYPE_OTHERS = 7, 1572 }; 1573 1574 enum ControlType { 1575 PLAY = 0, 1576 VIBRATE = 1, 1577 FLASH = 2, 1578 LOCK = 3, 1579 ERASE = 4, 1580 }; 1581 1582 enum ControlTypeVal { 1583 DISABLE = 0, 1584 ENABLE = 1, 1585 QUERY = 2, 1586 }; 1587 1588 enum ControlObject { 1589 LEFT_EAR = 0, 1590 RIGHT_EAR = 1, 1591 LEFT_RIGHT_EAR = 2, 1592 }; 1593 1594 constexpr int BLE_LPDEVICE_SCAN_SETTING_VALID_BIT = 0x01; 1595 constexpr int BLE_LPDEVICE_SCAN_FILTER_VALID_BIT = 0x02; 1596 constexpr int BLE_LPDEVICE_ADV_SETTING_VALID_BIT = 0x04; 1597 constexpr int BLE_LPDEVICE_ADVDATA_VALID_BIT = 0x08; 1598 constexpr int BLE_LPDEVICE_RESPDATA_VALID_BIT = 0x10; 1599 constexpr int BLE_LPDEVICE_ADV_DEVICEINFO_VALID_BIT = 0x20; 1600 constexpr int32_t BLE_SCAN_INVALID_ID = 0; 1601 1602 #define IS_BT_ENABLED() (BluetoothHost::GetDefaultHost().IsBrEnabled()) 1603 1604 #define IS_BLE_ENABLED() (BluetoothHost::GetDefaultHost().IsBleEnabled()) 1605 1606 struct SensingInfo { 1607 std::string addr_; 1608 std::string uuid_; 1609 uint32_t resourceId_; 1610 std::string pkgName_; 1611 bool isServer_; 1612 uint16_t interval_; 1613 bool connectable_; 1614 int payloadLen_; 1615 std::string bussinessType_; 1616 int scanMode_; 1617 }; 1618 1619 enum class SATELLITE_CONTROL_MODE { 1620 ANTENNA = 0, 1621 BLUETOOTH_SWITCH = 1, 1622 }; 1623 1624 struct TrustPairDeviceParam { 1625 std::string sn_; 1626 std::string deviceType_; 1627 std::string modelId_; 1628 std::string manufactory_; 1629 std::string productId_; 1630 std::string hiLinkVersion_; 1631 std::string macAddress_; 1632 std::string serviceType_; 1633 std::string serviceId_; 1634 std::string deviceName_; 1635 std::vector<std::string> uuids_; 1636 int32_t bluetoothClass_; 1637 std::vector<uint8_t> token_; 1638 int64_t deviceNameTime_; 1639 std::vector<uint8_t> secureAdvertisingInfo_; 1640 int32_t pairState_; 1641 }; 1642 1643 enum class RandomDeviceIdCommand { 1644 ADD = 1, 1645 DELETE, 1646 GET, 1647 IS_VALID 1648 }; 1649 1650 #ifdef BLUETOOTH_EXPORT 1651 #define BLUETOOTH_API __attribute__((visibility("default"))) 1652 #else 1653 #define BLUETOOTH_API 1654 #endif 1655 } // namespace Bluetooth 1656 } // namespace OHOS 1657 #endif // BLUETOOTH_DEF_H