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