1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * HFP Hands-Free (HF) unit and Audio Gateway Commons 40 * 41 */ 42 43 #ifndef BTSTACK_HFP_H 44 #define BTSTACK_HFP_H 45 46 #include "hci.h" 47 #include "classic/sdp_client_rfcomm.h" 48 49 #if defined __cplusplus 50 extern "C" { 51 #endif 52 53 // period AG will send RING messages 54 #define HFP_RING_PERIOD_MS 2000 55 56 /* HF Supported Features: 57 0: EC and/or NR function 58 1: Three-way calling 59 2: CLI presentation capability 60 3: Voice recognition activation 61 4: Remote volume control 62 5: Enhanced call status 63 6: Enhanced call control 64 7: Codec negotiation 65 8: HF Indicators 66 9: eSCO S4 (and T2) Settings Supported 67 10-31: Reserved for future definition 68 */ 69 #define HFP_HFSF_EC_NR_FUNCTION 0 70 #define HFP_HFSF_THREE_WAY_CALLING 1 71 #define HFP_HFSF_CLI_PRESENTATION_CAPABILITY 2 72 #define HFP_HFSF_VOICE_RECOGNITION_FUNCTION 3 73 #define HFP_HFSF_REMOTE_VOLUME_CONTROL 4 74 #define HFP_HFSF_ENHANCED_CALL_STATUS 5 75 #define HFP_HFSF_ENHANCED_CALL_CONTROL 6 76 #define HFP_HFSF_CODEC_NEGOTIATION 7 77 #define HFP_HFSF_HF_INDICATORS 8 78 #define HFP_HFSF_ESCO_S4 9 79 #define HFP_HFSF_ENHANCED_VOICE_RECOGNITION_STATUS 10 80 #define HFP_HFSF_VOICE_RECOGNITION_TEXT 11 81 82 /* AG Supported Features: 83 0: Three-way calling 84 1: EC and/or NR function 85 2: Voice recognition function 86 3: In-band ring tone capability 87 4: Attach a number to a voice tag 88 5: Ability to reject a call 89 6: Enhanced call status 90 7: Enhanced call control 91 8: Extended Error Result Codes 92 9: Codec negotiation 93 10: HF Indicators 94 11: eSCO S4 (and T2) Settings Supported 95 12-31: Reserved for future definition 96 */ 97 #define HFP_AGSF_THREE_WAY_CALLING 0 98 #define HFP_AGSF_EC_NR_FUNCTION 1 99 #define HFP_AGSF_VOICE_RECOGNITION_FUNCTION 2 100 #define HFP_AGSF_IN_BAND_RING_TONE 3 101 #define HFP_AGSF_ATTACH_A_NUMBER_TO_A_VOICE_TAG 4 102 #define HFP_AGSF_ABILITY_TO_REJECT_A_CALL 5 103 #define HFP_AGSF_ENHANCED_CALL_STATUS 6 104 #define HFP_AGSF_ENHANCED_CALL_CONTROL 7 105 #define HFP_AGSF_EXTENDED_ERROR_RESULT_CODES 8 106 #define HFP_AGSF_CODEC_NEGOTIATION 9 107 #define HFP_AGSF_HF_INDICATORS 10 108 #define HFP_AGSF_ESCO_S4 11 109 #define HFP_AGSF_ENHANCED_VOICE_RECOGNITION_STATUS 12 110 #define HFP_AGSF_VOICE_RECOGNITION_TEXT 13 111 112 #define HFP_DEFAULT_HF_SUPPORTED_FEATURES 0x0000 113 #define HFP_DEFAULT_AG_SUPPORTED_FEATURES 0x0009 114 115 #define HFP_MAX_NUM_INDICATORS 10 116 #define HFP_MAX_NUM_CALL_SERVICES 20 117 #define HFP_CALL_SERVICE_SIZE 3 118 #define HFP_MAX_NUM_CODECS 10 119 #define HFP_BNEP_NUM_MAX_SIZE 25 120 #define HFP_MAX_INDICATOR_DESC_SIZE 20 121 #define HFP_MAX_VR_TEXT_SIZE 100 122 #define HFP_VR_TEXT_HEADER_SIZE 27 // bytes needed for sending +BVRA message including quotes but excluding string length: 123 // \r\n+BVRA: <vrect>,<vrecstate>,<textID>,<textType>,<textOperation>,"<string>"\r\n 124 125 #define HFP_MAX_NETWORK_OPERATOR_NAME_SIZE 17 126 127 #define HFP_HF_INDICATOR_UUID_ENHANCED_SAFETY 0x0001 // 0 - disabled, 1 - enabled 128 #define HFP_HF_INDICATOR_UUID_BATTERY_LEVEL 0X0002 // 0-100 remaining level of battery 129 130 #define HFP_SUPPORTED_FEATURES "+BRSF" 131 #define HFP_AVAILABLE_CODECS "+BAC" 132 #define HFP_INDICATOR "+CIND" 133 #define HFP_ENABLE_STATUS_UPDATE_FOR_AG_INDICATORS "+CMER" 134 #define HFP_ENABLE_CLIP "+CLIP" 135 #define HFP_ENABLE_CALL_WAITING_NOTIFICATION "+CCWA" 136 #define HFP_UPDATE_ENABLE_STATUS_FOR_INDIVIDUAL_AG_INDICATORS "+BIA" // +BIA:<enabled>,,<enabled>,,,<enabled> 137 #define HFP_SUPPORT_CALL_HOLD_AND_MULTIPARTY_SERVICES "+CHLD" 138 #define HFP_GENERIC_STATUS_INDICATOR "+BIND" 139 #define HFP_TRANSFER_AG_INDICATOR_STATUS "+CIEV" // +CIEV: <index>,<value> 140 #define HFP_TRANSFER_HF_INDICATOR_STATUS "+BIEV" // +BIEC: <index>,<value> 141 #define HFP_QUERY_OPERATOR_SELECTION "+COPS" // +COPS: <mode>,0,<opearator> 142 #define HFP_ENABLE_EXTENDED_AUDIO_GATEWAY_ERROR "+CMEE" 143 #define HFP_EXTENDED_AUDIO_GATEWAY_ERROR "+CME ERROR" 144 #define HFP_TRIGGER_CODEC_CONNECTION_SETUP "+BCC" 145 #define HFP_CONFIRM_COMMON_CODEC "+BCS" 146 #define HFP_ANSWER_CALL "ATA" 147 #define HFP_HANG_UP_CALL "+CHUP" 148 #define HFP_CHANGE_IN_BAND_RING_TONE_SETTING "+BSIR" 149 #define HFP_CALL_PHONE_NUMBER "ATD" 150 #define HFP_REDIAL_LAST_NUMBER "+BLDN" 151 #define HFP_TURN_OFF_EC_AND_NR "+NREC" // EC (Echo CAnceling), NR (Noise Reduction) 152 #define HFP_ACTIVATE_VOICE_RECOGNITION "+BVRA" // Voice Recognition 153 #define HFP_SET_MICROPHONE_GAIN "+VGM" 154 #define HFP_SET_SPEAKER_GAIN "+VGS" 155 #define HFP_PHONE_NUMBER_FOR_VOICE_TAG "+BINP" 156 #define HFP_TRANSMIT_DTMF_CODES "+VTS" 157 #define HFP_SUBSCRIBER_NUMBER_INFORMATION "+CNUM" 158 #define HFP_LIST_CURRENT_CALLS "+CLCC" 159 #define HFP_RESPONSE_AND_HOLD "+BTRH" 160 161 // Apple Extensions 162 #define HFP_APPLE_ACCESSORY_INFORMATION "+XAPL" 163 #define HFP_APPLE_ACCESSORY_STATE "+IPHONEACCEV" 164 #define HFP_APPLE_SIRI_STATE "+APLSIRI" 165 #define HFP_APPLE_SIRI_EYES_FREE_MODE "+APLEFM" 166 167 #define HFP_OK "OK" 168 #define HFP_ERROR "ERROR" 169 #define HFP_RING "RING" 170 171 // Codecs 172 #define HFP_CODEC_CVSD 0x01 173 #define HFP_CODEC_MSBC 0x02 174 #define HFP_CODEC_LC3_SWB 0x03 175 176 typedef enum { 177 HFP_ROLE_INVALID = 0, 178 HFP_ROLE_AG, 179 HFP_ROLE_HF, 180 } hfp_role_t; 181 182 typedef enum { 183 HFP_CMD_NONE = 0, 184 HFP_CMD_ERROR, 185 HFP_CMD_UNKNOWN, 186 HFP_CMD_OK, 187 HFP_CMD_RING, 188 HFP_CMD_SUPPORTED_FEATURES, // 5 189 HFP_CMD_AVAILABLE_CODECS, 190 HFP_CMD_RETRIEVE_AG_INDICATORS_GENERIC, 191 HFP_CMD_RETRIEVE_AG_INDICATORS, 192 HFP_CMD_RETRIEVE_AG_INDICATORS_STATUS, 193 HFP_CMD_ENABLE_INDICATOR_STATUS_UPDATE, // 10 194 HFP_CMD_ENABLE_INDIVIDUAL_AG_INDICATOR_STATUS_UPDATE, 195 HFP_CMD_SUPPORT_CALL_HOLD_AND_MULTIPARTY_SERVICES, 196 HFP_CMD_ENABLE_CLIP, 197 HFP_CMD_AG_SENT_CLIP_INFORMATION, 198 HFP_CMD_ENABLE_CALL_WAITING_NOTIFICATION, // 15 199 HFP_CMD_AG_SENT_CALL_WAITING_NOTIFICATION_UPDATE, 200 HFP_CMD_LIST_GENERIC_STATUS_INDICATORS, 201 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS, 202 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS_STATE, 203 HFP_CMD_SET_GENERIC_STATUS_INDICATOR_STATUS, // 20 204 HFP_CMD_TRANSFER_AG_INDICATOR_STATUS, 205 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME, 206 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME_FORMAT, 207 HFP_CMD_ENABLE_EXTENDED_AUDIO_GATEWAY_ERROR, 208 HFP_CMD_EXTENDED_AUDIO_GATEWAY_ERROR, // 25 209 HFP_CMD_TRIGGER_CODEC_CONNECTION_SETUP, 210 HFP_CMD_AG_SEND_COMMON_CODEC, 211 HFP_CMD_AG_SUGGESTED_CODEC, 212 HFP_CMD_HF_CONFIRMED_CODEC, 213 HFP_CMD_CALL_ANSWERED, // 30 214 HFP_CMD_CALL_HOLD, 215 HFP_CMD_HANG_UP_CALL, 216 HFP_CMD_CHANGE_IN_BAND_RING_TONE_SETTING, 217 HFP_CMD_CALL_PHONE_NUMBER, 218 HFP_CMD_REDIAL_LAST_NUMBER, // 35 219 HFP_CMD_TURN_OFF_EC_AND_NR, 220 HFP_CMD_AG_ACTIVATE_VOICE_RECOGNITION, // 37 221 HFP_CMD_HF_ACTIVATE_VOICE_RECOGNITION, 222 HFP_CMD_HF_REQUEST_PHONE_NUMBER, 223 HFP_CMD_AG_SENT_PHONE_NUMBER, 224 HFP_CMD_TRANSMIT_DTMF_CODES, 225 HFP_CMD_SET_MICROPHONE_GAIN, 226 HFP_CMD_SET_SPEAKER_GAIN, 227 HFP_CMD_GET_SUBSCRIBER_NUMBER_INFORMATION, 228 HFP_CMD_LIST_CURRENT_CALLS, 229 HFP_CMD_RESPONSE_AND_HOLD_QUERY, 230 HFP_CMD_RESPONSE_AND_HOLD_COMMAND, 231 HFP_CMD_RESPONSE_AND_HOLD_STATUS, 232 HFP_CMD_HF_INDICATOR_STATUS, 233 HFP_CMD_APPLE_ACCESSORY_INFORMATION, 234 HFP_CMD_APPLE_ACCESSORY_STATE, 235 HFP_CMD_APPLE_DEVICE_INFORMATION, 236 HFP_CMD_CUSTOM_MESSAGE 237 } hfp_command_t; 238 239 240 typedef enum { 241 HFP_CME_ERROR_AG_FAILURE = 0, 242 HFP_CME_ERROR_NO_CONNECTION_TO_PHONE, 243 HFP_CME_ERROR_2, 244 HFP_CME_ERROR_OPERATION_NOT_ALLOWED, 245 HFP_CME_ERROR_OPERATION_NOT_SUPPORTED, 246 HFP_CME_ERROR_PH_SIM_PIN_REQUIRED, 247 HFP_CME_ERROR_6, 248 HFP_CME_ERROR_7, 249 HFP_CME_ERROR_8, 250 HFP_CME_ERROR_9, 251 HFP_CME_ERROR_SIM_NOT_INSERTED, 252 HFP_CME_ERROR_SIM_PIN_REQUIRED, 253 HFP_CME_ERROR_SIM_PUK_REQUIRED, 254 HFP_CME_ERROR_SIM_FAILURE, 255 HFP_CME_ERROR_SIM_BUSY, 256 HFP_CME_ERROR_15, 257 HFP_CME_ERROR_INCORRECT_PASSWORD, 258 HFP_CME_ERROR_SIM_PIN2_REQUIRED, 259 HFP_CME_ERROR_SIM_PUK2_REQUIRED, 260 HFP_CME_ERROR_19, 261 HFP_CME_ERROR_MEMORY_FULL, 262 HFP_CME_ERROR_INVALID_INDEX, 263 HFP_CME_ERROR_22, 264 HFP_CME_ERROR_MEMORY_FAILURE, 265 HFP_CME_ERROR_TEXT_STRING_TOO_LONG, 266 HFP_CME_ERROR_INVALID_CHARACTERS_IN_TEXT_STRING, 267 HFP_CME_ERROR_DIAL_STRING_TOO_LONG, 268 HFP_CME_ERROR_INVALID_CHARACTERS_IN_DIAL_STRING, 269 HFP_CME_ERROR_28, 270 HFP_CME_ERROR_29, 271 HFP_CME_ERROR_NO_NETWORK_SERVICE, 272 HFP_CME_ERROR_NETWORK_TIMEOUT, 273 HFP_CME_ERROR_NETWORK_NOT_ALLOWED_EMERGENCY_CALLS_ONLY 274 } hfp_cme_error_t; 275 276 typedef enum { 277 HFP_CALL_STATUS_NO_HELD_OR_ACTIVE_CALLS = 0, 278 HFP_CALL_STATUS_ACTIVE_OR_HELD_CALL_IS_PRESENT 279 } hfp_call_status_t; 280 281 typedef enum { 282 HFP_CALLSETUP_STATUS_NO_CALL_SETUP_IN_PROGRESS = 0, 283 HFP_CALLSETUP_STATUS_INCOMING_CALL_SETUP_IN_PROGRESS, 284 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_DIALING_STATE, 285 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_ALERTING_STATE 286 } hfp_callsetup_status_t; 287 288 typedef enum { 289 HFP_CALLHELD_STATUS_NO_CALLS_HELD = 0, 290 HFP_CALLHELD_STATUS_CALL_ON_HOLD_OR_SWAPPED, 291 HFP_CALLHELD_STATUS_CALL_ON_HOLD_AND_NO_ACTIVE_CALLS 292 } hfp_callheld_status_t; 293 294 295 typedef enum { 296 HFP_AG_INCOMING_CALL, 297 HFP_AG_INCOMING_CALL_ACCEPTED_BY_AG, 298 HFP_AG_INCOMING_CALL_ACCEPTED_BY_HF, 299 HFP_AG_AUDIO_CONNECTION_ESTABLISHED, 300 HFP_AG_OUTGOING_CALL_INITIATED_BY_AG, 301 HFP_AG_OUTGOING_CALL_INITIATED_BY_HF, 302 HFP_AG_OUTGOING_CALL_REJECTED, 303 HFP_AG_OUTGOING_CALL_ACCEPTED, 304 HFP_AG_OUTGOING_CALL_RINGING, 305 HFP_AG_OUTGOING_CALL_ESTABLISHED, 306 HFP_AG_OUTGOING_REDIAL_INITIATED, 307 HFP_AG_HELD_CALL_JOINED_BY_AG, 308 HFP_AG_TERMINATE_CALL_BY_AG, 309 HFP_AG_TERMINATE_CALL_BY_HF, 310 HFP_AG_CALL_DROPPED, 311 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_AG, 312 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_AG, 313 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_AG, 314 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_HF, 315 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_HF, 316 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_HF, 317 HFP_AG_CALL_HOLD_USER_BUSY, 318 HFP_AG_CALL_HOLD_RELEASE_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 319 HFP_AG_CALL_HOLD_PARK_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 320 HFP_AG_CALL_HOLD_ADD_HELD_CALL, 321 HFP_AG_CALL_HOLD_EXIT_AND_JOIN_CALLS, 322 HFP_AG_SET_CLIP 323 } hfp_ag_call_event_t; 324 325 326 typedef enum { 327 HFP_PARSER_CMD_HEADER = 0, 328 HFP_PARSER_CMD_SEQUENCE, 329 HFP_PARSER_SECOND_ITEM, 330 HFP_PARSER_THIRD_ITEM, 331 HFP_PARSER_CUSTOM_COMMAND 332 } hfp_parser_state_t; 333 334 typedef enum { 335 HFP_VOICE_RECOGNITION_STATE_AG_READY = 0, 336 HFP_VOICE_RECOGNITION_STATE_AG_READY_TO_ACCEPT_AUDIO_INPUT = 1, 337 HFP_VOICE_RECOGNITION_STATE_AG_IS_STARTING_SOUND = 2, 338 HFP_VOICE_RECOGNITION_STATE_AG_IS_PROCESSING_AUDIO_INPUT = 4 339 } hfp_voice_recognition_state_t; 340 341 typedef enum { 342 HFP_TEXT_TYPE_RECOGNISED_FROM_HF_AUDIO = 0, 343 HFP_TEXT_TYPE_MESSAGE_FROM_AG, 344 HFP_TEXT_TYPE_QUESTION_FROM_AG, 345 HFP_TEXT_TYPE_ERROR_FROM_AG 346 } hfp_text_type_t; 347 348 typedef enum { 349 HFP_TEXT_OPERATION_NEW_TEXT = 1, 350 HFP_TEXT_OPERATION_REPLACE, 351 HFP_TEXT_OPERATION_APPEND 352 } hfp_text_operation_t; 353 354 typedef enum { 355 HFP_IDLE = 0, //0 356 HFP_SDP_QUERY_RFCOMM_CHANNEL, 357 HFP_W2_SEND_SDP_QUERY, 358 HFP_W4_SDP_QUERY_COMPLETE, 359 HFP_W4_RFCOMM_CONNECTED, 360 361 HFP_EXCHANGE_SUPPORTED_FEATURES, // 5 362 HFP_W4_EXCHANGE_SUPPORTED_FEATURES, 363 364 HFP_NOTIFY_ON_CODECS, 365 HFP_W4_NOTIFY_ON_CODECS, 366 367 HFP_RETRIEVE_INDICATORS, 368 HFP_W4_RETRIEVE_INDICATORS, // 10 369 370 HFP_RETRIEVE_INDICATORS_STATUS, 371 HFP_W4_RETRIEVE_INDICATORS_STATUS, 372 373 HFP_ENABLE_INDICATORS_STATUS_UPDATE, 374 HFP_W4_ENABLE_INDICATORS_STATUS_UPDATE, 375 376 HFP_RETRIEVE_CAN_HOLD_CALL, // 15 377 HFP_W4_RETRIEVE_CAN_HOLD_CALL, 378 379 HFP_LIST_GENERIC_STATUS_INDICATORS, 380 HFP_W4_LIST_GENERIC_STATUS_INDICATORS, 381 382 HFP_RETRIEVE_GENERIC_STATUS_INDICATORS, 383 HFP_W4_RETRIEVE_GENERIC_STATUS_INDICATORS, //20 384 385 HFP_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 386 HFP_W4_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 387 388 HFP_SERVICE_LEVEL_CONNECTION_ESTABLISHED, //23 389 390 HFP_W2_CONNECT_SCO, 391 HFP_W4_SCO_CONNECTED, 392 393 HFP_AUDIO_CONNECTION_ESTABLISHED, 394 395 396 HFP_W2_DISCONNECT_SCO, 397 HFP_W4_SCO_DISCONNECTED, 398 HFP_W4_SCO_DISCONNECTED_TO_SHUTDOWN, 399 HFP_W4_WBS_SHUTDOWN, 400 401 HFP_W2_DISCONNECT_RFCOMM, 402 HFP_W4_RFCOMM_DISCONNECTED, 403 HFP_W4_RFCOMM_DISCONNECTED_AND_RESTART, 404 HFP_W4_CONNECTION_ESTABLISHED_TO_SHUTDOWN 405 } hfp_state_t; 406 407 408 typedef enum { 409 // shared between normal voice recognition and enhanced one 410 HFP_VRA_VOICE_RECOGNITION_OFF, 411 412 HFP_VRA_W2_SEND_VOICE_RECOGNITION_OFF, 413 HFP_VRA_W4_VOICE_RECOGNITION_OFF, 414 415 HFP_VRA_W2_SEND_VOICE_RECOGNITION_ACTIVATED, 416 HFP_VRA_W4_VOICE_RECOGNITION_ACTIVATED, 417 HFP_VRA_VOICE_RECOGNITION_ACTIVATED, 418 419 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 420 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 421 HFP_VRA_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 422 423 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_STATUS, 424 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_MSG 425 } hfp_voice_recognition_activation_status_t; 426 427 typedef struct { 428 uint16_t text_id; 429 hfp_text_type_t text_type; 430 hfp_text_operation_t text_operation; 431 const char * text; 432 } hfp_voice_recognition_message_t; 433 434 typedef enum { 435 HFP_CODECS_IDLE, 436 HFP_CODECS_RECEIVED_LIST, 437 HFP_CODECS_RECEIVED_TRIGGER_CODEC_EXCHANGE, 438 HFP_CODECS_W4_AG_COMMON_CODEC, 439 HFP_CODECS_AG_SENT_COMMON_CODEC, 440 HFP_CODECS_AG_RESEND_COMMON_CODEC, 441 HFP_CODECS_HF_CONFIRMED_CODEC, 442 HFP_CODECS_EXCHANGED, 443 HFP_CODECS_ERROR 444 } hfp_codecs_state_t; 445 446 typedef enum { 447 HFP_CALL_IDLE, 448 HFP_CALL_TRIGGER_AUDIO_CONNECTION, 449 HFP_CALL_W4_AUDIO_CONNECTION_FOR_IN_BAND_RING, 450 HFP_CALL_INCOMING_RINGING, 451 HFP_CALL_W4_AUDIO_CONNECTION_FOR_ACTIVE, 452 HFP_CALL_ACTIVE, 453 HFP_CALL_W2_SEND_CALL_WAITING, 454 HFP_CALL_W4_CHLD, 455 HFP_CALL_OUTGOING_INITIATED, 456 HFP_CALL_OUTGOING_DIALING, 457 HFP_CALL_OUTGOING_RINGING 458 } hfp_call_state_t; 459 460 typedef enum{ 461 HFP_ENHANCED_CALL_DIR_OUTGOING, 462 HFP_ENHANCED_CALL_DIR_INCOMING 463 } hfp_enhanced_call_dir_t; 464 465 typedef enum{ 466 HFP_ENHANCED_CALL_STATUS_ACTIVE, 467 HFP_ENHANCED_CALL_STATUS_HELD, 468 HFP_ENHANCED_CALL_STATUS_OUTGOING_DIALING, 469 HFP_ENHANCED_CALL_STATUS_OUTGOING_ALERTING, 470 HFP_ENHANCED_CALL_STATUS_INCOMING, 471 HFP_ENHANCED_CALL_STATUS_INCOMING_WAITING, 472 HFP_ENHANCED_CALL_STATUS_CALL_HELD_BY_RESPONSE_AND_HOLD 473 } hfp_enhanced_call_status_t; 474 475 typedef enum{ 476 HFP_ENHANCED_CALL_MODE_VOICE, 477 HFP_ENHANCED_CALL_MODE_DATA, 478 HFP_ENHANCED_CALL_MODE_FAX 479 } hfp_enhanced_call_mode_t; 480 481 typedef enum{ 482 HFP_ENHANCED_CALL_MPTY_NOT_A_CONFERENCE_CALL, 483 HFP_ENHANCED_CALL_MPTY_CONFERENCE_CALL 484 } hfp_enhanced_call_mpty_t; 485 486 typedef enum { 487 HFP_RESPONSE_AND_HOLD_INCOMING_ON_HOLD = 0, 488 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_ACCEPTED, 489 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_REJECTED 490 } hfp_response_and_hold_state_t; 491 492 typedef enum { 493 HFP_HF_QUERY_OPERATOR_FORMAT_NOT_SET = 0, 494 HFP_HF_QUERY_OPERATOR_SET_FORMAT, 495 HFP_HF_QUERY_OPERATOR_W4_SET_FORMAT_OK, 496 HFP_HF_QUERY_OPERATOR_FORMAT_SET, 497 HFP_HF_QUERY_OPERATOR_SEND_QUERY, 498 HPF_HF_QUERY_OPERATOR_W4_RESULT 499 } hfp_hf_query_operator_state_t; 500 501 typedef enum { 502 HFP_LINK_SETTINGS_D0 = 0, 503 HFP_LINK_SETTINGS_D1, 504 HFP_LINK_SETTINGS_S1, 505 HFP_LINK_SETTINGS_S2, 506 HFP_LINK_SETTINGS_S3, 507 HFP_LINK_SETTINGS_S4, 508 HFP_LINK_SETTINGS_T1, 509 HFP_LINK_SETTINGS_T2, 510 HFP_LINK_SETTINGS_NONE, 511 } hfp_link_settings_t; 512 513 typedef enum{ 514 HFP_NONE_SM, 515 HFP_SLC_SM, 516 HFP_SLC_QUERIES_SM, 517 HFP_CODECS_CONNECTION_SM, 518 HFP_AUDIO_CONNECTION_SM, 519 HFP_CALL_SM 520 } hfp_state_machine_t; 521 522 typedef struct{ 523 uint16_t uuid; 524 uint8_t state; // enabled 525 } hfp_generic_status_indicator_t; 526 527 typedef struct{ 528 uint8_t index; 529 char name[HFP_MAX_INDICATOR_DESC_SIZE]; 530 uint8_t min_range; 531 uint8_t max_range; 532 uint8_t status; 533 uint8_t mandatory; 534 uint8_t enabled; 535 uint8_t status_changed; 536 } hfp_ag_indicator_t; 537 538 typedef struct{ 539 char name[HFP_CALL_SERVICE_SIZE]; 540 } hfp_call_service_t; 541 542 543 typedef struct{ 544 uint8_t mode; 545 uint8_t format; 546 char name[HFP_MAX_NETWORK_OPERATOR_NAME_SIZE]; // enabled 547 } hfp_network_opearator_t; 548 549 550 typedef struct hfp_connection { 551 btstack_linked_item_t item; 552 553 // local role: HF or AG 554 hfp_role_t local_role; 555 556 bd_addr_t remote_addr; 557 hci_con_handle_t acl_handle; 558 hci_con_handle_t sco_handle; 559 uint16_t packet_types; 560 uint8_t rfcomm_channel_nr; 561 uint16_t rfcomm_cid; 562 uint16_t rfcomm_mtu; 563 564 hfp_state_machine_t state_machine; 565 hfp_call_state_t call_state; 566 hfp_state_t state; 567 hfp_codecs_state_t codecs_state; 568 569 // needed for reestablishing connection - service uuid of the remote 570 uint16_t service_uuid; 571 572 // used during service level connection establishment 573 hfp_command_t command; 574 hfp_parser_state_t parser_state; 575 int parser_item_index; 576 int parser_indicator_index; 577 uint32_t parser_indicator_value; 578 bool parser_quoted; 579 580 // line buffer is always \0 terminated 581 uint8_t line_buffer[HFP_MAX_VR_TEXT_SIZE]; 582 int line_size; 583 584 uint32_t remote_supported_features; 585 586 uint16_t remote_codecs_nr; 587 uint8_t remote_codecs[HFP_MAX_NUM_CODECS]; 588 589 uint16_t ag_indicators_nr; 590 hfp_ag_indicator_t ag_indicators[HFP_MAX_NUM_INDICATORS]; 591 uint32_t ag_indicators_status_update_bitmap; 592 uint8_t enable_status_update_for_ag_indicators; 593 594 uint16_t remote_call_services_index; 595 hfp_call_service_t remote_call_services[HFP_MAX_NUM_CALL_SERVICES]; 596 597 // TODO: use bitmap. 598 uint16_t generic_status_indicators_nr; 599 uint32_t generic_status_update_bitmap; 600 hfp_generic_status_indicator_t generic_status_indicators[HFP_MAX_NUM_INDICATORS]; 601 602 hfp_network_opearator_t network_operator; 603 604 // Retrieved during service level connection establishment, not used yet 605 uint8_t negotiated_codec; 606 607 // HF -> AG configuration 608 uint8_t clip_enabled; 609 uint8_t call_waiting_notification_enabled; 610 611 // TODO: put these bit flags in a bitmap 612 uint8_t ok_pending; 613 uint8_t send_error; 614 615 bool found_equal_sign; 616 uint8_t ignore_value; 617 618 uint8_t change_status_update_for_individual_ag_indicators; 619 uint8_t operator_name_changed; 620 621 uint8_t enable_extended_audio_gateway_error_report; 622 uint8_t extended_audio_gateway_error_value; 623 uint8_t extended_audio_gateway_error; 624 625 // establish codecs connection 626 uint8_t suggested_codec; 627 uint8_t codec_confirmed; 628 uint8_t sco_for_msbc_failed; 629 uint8_t trigger_codec_exchange; 630 631 // establish audio connection 632 hfp_link_settings_t link_setting; 633 uint8_t accept_sco; // 1 = SCO, 2 = eSCO 634 635 uint8_t establish_audio_connection; 636 uint8_t release_audio_connection; 637 uint8_t release_slc_connection; 638 639 uint8_t microphone_gain; 640 uint8_t send_microphone_gain; 641 642 uint8_t speaker_gain; 643 uint8_t send_speaker_gain; 644 645 uint8_t send_phone_number_for_voice_tag; 646 uint8_t send_ag_status_indicators; 647 uint8_t send_ag_indicators_segment; 648 uint8_t send_response_and_hold_status; // 0 - don't send. BRTH:0 == 1, .. 649 650 // Apple Accessory Support 651 bool send_apple_information; 652 bool apple_accessory_commands_supported; 653 // - HF to send 654 int8_t apple_accessory_battery_level; 655 int8_t apple_accessory_docked; 656 // - AG Parser 657 uint16_t apple_accessory_product_id; 658 uint16_t apple_accessory_vendor_id; 659 uint8_t apple_accessory_features; 660 uint8_t apple_accessory_key; 661 char apple_accessory_version[16]; 662 // HF: AT Command, AG: Unsolicited Result Code 663 const char * send_custom_message; 664 665 // HF: Unsolicited Result Code, AG: AT Command 666 uint16_t custom_at_command_id; 667 668 bool emit_vra_enabled_after_audio_established; 669 // AG only 670 uint8_t change_in_band_ring_tone_setting; 671 uint8_t ag_ring; 672 uint8_t ag_send_clip; 673 uint8_t ag_echo_and_noise_reduction; 674 // used by AG: HFP parser stores here the activation value issued by HF 675 uint8_t ag_activate_voice_recognition_value; 676 bool ag_audio_connection_opened_before_vra; 677 678 uint8_t ag_notify_incoming_call_waiting; 679 uint8_t send_subscriber_number; 680 uint8_t next_subscriber_number_to_send; 681 uint8_t ag_call_hold_action; 682 uint8_t ag_response_and_hold_action; 683 uint8_t ag_dtmf_code; 684 bool ag_in_band_ring_tone_active; 685 bool ag_send_no_carrier; 686 bool ag_vra_send_command; 687 bool ag_send_in_band_ring_tone_setting; 688 bool ag_send_common_codec; 689 bool ag_vra_requested_by_hf; 690 691 int send_status_of_current_calls; 692 int next_call_index; 693 694 // HF only 695 // HF: track command for which ok/error response need to be received 696 hfp_command_t response_pending_for_command; 697 698 hfp_hf_query_operator_state_t hf_query_operator_state; 699 uint8_t hf_answer_incoming_call; 700 uint8_t hf_initiate_outgoing_call; 701 uint8_t hf_initiate_memory_dialing; 702 uint8_t hf_initiate_redial_last_number; 703 bool hf_send_codec_confirm; 704 bool hf_send_supported_codecs; 705 706 int memory_id; 707 708 uint8_t hf_send_clip_enable; 709 uint8_t hf_send_chup; 710 uint8_t hf_send_chld_0; 711 uint8_t hf_send_chld_1; 712 uint8_t hf_send_chld_2; 713 uint8_t hf_send_chld_3; 714 uint8_t hf_send_chld_4; 715 uint8_t hf_send_chld_x; 716 uint8_t hf_send_chld_x_index; 717 char hf_send_dtmf_code; 718 uint8_t hf_send_binp; 719 uint8_t hf_send_clcc; 720 uint8_t hf_send_rrh; 721 char hf_send_rrh_command; 722 uint8_t hf_send_cnum; 723 724 uint8_t hf_activate_call_waiting_notification; 725 uint8_t hf_deactivate_call_waiting_notification; 726 727 uint8_t hf_activate_calling_line_notification; 728 uint8_t hf_deactivate_calling_line_notification; 729 uint8_t hf_deactivate_echo_canceling_and_noise_reduction; 730 731 hfp_call_status_t hf_call_status; 732 hfp_callsetup_status_t hf_callsetup_status; 733 hfp_callheld_status_t hf_callheld_status; 734 735 hfp_voice_recognition_activation_status_t vra_state; 736 hfp_voice_recognition_activation_status_t vra_state_requested; 737 bool deactivate_voice_recognition; 738 bool activate_voice_recognition; 739 bool enhanced_voice_recognition_enabled; 740 741 // ih HF, used by parser, in AG used for commands 742 uint8_t ag_vra_status; 743 hfp_voice_recognition_state_t ag_vra_state; 744 hfp_voice_recognition_message_t ag_msg; 745 uint16_t ag_vra_msg_length; 746 747 uint8_t clcc_idx; 748 uint8_t clcc_dir; 749 uint8_t clcc_status; 750 uint8_t clcc_mode; 751 uint8_t clcc_mpty; 752 753 uint8_t call_index; 754 // also used for CLCC, CCWA, CLIP if set 755 uint8_t bnip_type; // 0 == not set 756 char bnip_number[HFP_BNEP_NUM_MAX_SIZE]; // 757 bool clip_have_alpha; 758 759 #ifdef ENABLE_CC256X_ASSISTED_HFP 760 bool cc256x_send_write_codec_config; 761 bool cc256x_send_wbs_associate; 762 bool cc256x_send_wbs_disassociate; 763 #endif 764 #ifdef ENABLE_BCM_PCM_WBS 765 bool bcm_send_enable_wbs; 766 bool bcm_send_disable_wbs; 767 bool bcm_send_write_i2spcm_interface_param; 768 #endif 769 #ifdef ENABLE_RTK_PCM_WBS 770 bool rtk_send_sco_config; 771 #endif 772 #ifdef ENABLE_NXP_PCM_WBS 773 hci_con_handle_t nxp_start_audio_handle; 774 hci_con_handle_t nxp_stop_audio_handle; 775 #endif 776 } hfp_connection_t; 777 778 /** 779 * @brief Struct to register custom AT Command. 780 */ 781 typedef struct { 782 btstack_linked_item_t * next; 783 const char * command; 784 uint16_t command_id; 785 } hfp_custom_at_command_t; 786 787 // UTILS_START : TODO move to utils 788 int send_str_over_rfcomm(uint16_t cid, const char * command); 789 int join(char * buffer, int buffer_size, uint8_t * values, int values_nr); 790 int join_bitmap(char * buffer, int buffer_size, uint32_t values, int values_nr); 791 int get_bit(uint16_t bitmap, int position); 792 int store_bit(uint32_t bitmap, int position, uint8_t value); 793 // UTILS_END 794 795 #define HFP_H2_SYNC_FRAME_SIZE 60 796 // HFP H2 Synchronization 797 typedef struct { 798 // callback returns true if data was valid 799 bool (*callback)(bool bad_frame, const uint8_t * frame_data, uint16_t frame_len); 800 uint8_t frame_data[HFP_H2_SYNC_FRAME_SIZE]; 801 uint16_t frame_len; 802 uint16_t dropped_bytes; 803 } hfp_h2_sync_t; 804 805 /** 806 * @brief Init HFP H2 Sync state 807 * @param hfp_h2_sync 808 * @param callback 809 */ 810 void hfp_h2_sync_init(hfp_h2_sync_t * hfp_h2_sync, 811 bool (*callback)(bool bad_frame, const uint8_t * frame_data, uint16_t frame_len)); 812 /** 813 * @brief Process H2 data and execute callback for frames with valid H2 header 814 * @param hfp_h2_sync 815 * @param bad_frame 816 * @param frame_data 817 * @param frame_len 818 */ 819 void hfp_h2_sync_process(hfp_h2_sync_t *hfp_h2_sync, bool bad_frame, const uint8_t *frame_data, uint16_t frame_len); 820 821 822 // other 823 824 void hfp_finalize_connection_context(hfp_connection_t * hfp_connection); 825 void hfp_emit_sco_connection_established(hfp_connection_t *hfp_connection, uint8_t status, uint8_t negotiated_codec, 826 uint16_t rx_packet_length, uint16_t tx_packet_length); 827 828 void hfp_set_ag_callback(btstack_packet_handler_t callback); 829 void hfp_set_ag_rfcomm_packet_handler(btstack_packet_handler_t handler); 830 831 void hfp_set_hf_callback(btstack_packet_handler_t callback); 832 void hfp_set_hf_rfcomm_packet_handler(btstack_packet_handler_t handler); 833 void hfp_set_hf_indicators(uint8_t indicators_nr, const uint8_t * indicators); 834 835 void hfp_init(void); 836 void hfp_deinit(void); 837 838 void hfp_register_custom_ag_command(hfp_custom_at_command_t * at_command); 839 void hfp_register_custom_hf_command(hfp_custom_at_command_t * at_command); 840 841 void hfp_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t service_uuid, int rfcomm_channel_nr, const char * name); 842 void hfp_handle_hci_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 843 void hfp_handle_rfcomm_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 844 void hfp_emit_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, uint8_t value); 845 void hfp_emit_simple_event(hfp_connection_t * hfp_connection, uint8_t event_subtype); 846 void hfp_emit_string_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, const char * value); 847 void hfp_emit_slc_connection_event(hfp_role_t local_role, uint8_t status, hci_con_handle_t con_handle, bd_addr_t addr); 848 849 /** 850 * @brief Emit HFP_SUBEVENT_VOICE_RECOGNITION_ENABLED event 851 * @param hfp_connection 852 * @param status ERROR_CODE_SUCCESS if successful, otherwise ERROR_CODE_COMMAND_DISALLOWED 853 */ 854 void hfp_emit_voice_recognition_enabled(hfp_connection_t * hfp_connection, uint8_t status); 855 856 /** 857 * @brief Emit HFP_SUBEVENT_VOICE_RECOGNITION_DISABLED event 858 * @param hfp_connection 859 * @param status ERROR_CODE_SUCCESS if successful, otherwise ERROR_CODE_COMMAND_DISALLOWED 860 */ 861 void hfp_emit_voice_recognition_disabled(hfp_connection_t * hfp_connection, uint8_t status); 862 863 void hfp_emit_enhanced_voice_recognition_hf_ready_for_audio_event(hfp_connection_t * hfp_connection, uint8_t status); 864 void hfp_emit_enhanced_voice_recognition_state_event(hfp_connection_t * hfp_connection, uint8_t status); 865 866 hfp_connection_t * get_hfp_connection_context_for_rfcomm_cid(uint16_t cid); 867 hfp_connection_t * get_hfp_connection_context_for_bd_addr(bd_addr_t bd_addr, hfp_role_t hfp_role); 868 hfp_connection_t * get_hfp_connection_context_for_sco_handle(uint16_t handle, hfp_role_t hfp_role); 869 hfp_connection_t * get_hfp_connection_context_for_acl_handle(uint16_t handle, hfp_role_t hfp_role); 870 871 btstack_linked_list_t * hfp_get_connections(void); 872 void hfp_parse(hfp_connection_t * connection, uint8_t byte, int isHandsFree); 873 void hfp_parser_reset_line_buffer(hfp_connection_t *hfp_connection); 874 875 /** 876 * @brief Establish RFCOMM connection, and perform service level connection agreement: 877 * @param bd_addr 878 * @param service_uuid 879 * @param local_role 880 * @return status ERROR_CODE_SUCCESS if successful, otherwise: 881 * - ERROR_CODE_COMMAND_DISALLOWED if connection already exists, or 882 * - BTSTACK_MEMORY_ALLOC_FAILED 883 */ 884 uint8_t hfp_establish_service_level_connection(bd_addr_t bd_addr, uint16_t service_uuid, hfp_role_t local_role); 885 886 /** 887 * @brief Prepare connection for audio and SLC connections release 888 * @param hfp_connection 889 */ 890 void hfp_trigger_release_service_level_connection(hfp_connection_t * hfp_connection); 891 892 /** 893 * @brief Prepare connection for audio connection release 894 * @param hfp_connection 895 */ 896 uint8_t hfp_trigger_release_audio_connection(hfp_connection_t * hfp_connection); 897 898 void hfp_reset_context_flags(hfp_connection_t * hfp_connection); 899 900 // @returns if an SCO setup is active in either role 901 bool hfp_sco_setup_active(void); 902 903 void hfp_setup_synchronous_connection(hfp_connection_t * hfp_connection); 904 void hfp_accept_synchronous_connection(hfp_connection_t * hfp_connection, bool incoming_eSCO); 905 906 int hfp_supports_codec(uint8_t codec, int codecs_nr, uint8_t * codecs); 907 void hfp_hf_drop_mSBC_if_eSCO_not_supported(uint8_t * codecs, uint8_t * codecs_nr); 908 void hfp_init_link_settings(hfp_connection_t * hfp_connection, uint8_t eSCO_S4_supported); 909 hfp_link_settings_t hfp_next_link_setting(hfp_link_settings_t current_setting, uint16_t local_sco_packet_types, 910 uint16_t remote_sco_packet_types, bool eSCO_s4_supported, 911 uint8_t negotiated_codec); 912 hfp_link_settings_t hfp_safe_settings_for_context(bool use_eSCO, uint8_t negotiated_codec, bool secure_connection_in_use); 913 914 const char * hfp_hf_feature(int index); 915 const char * hfp_ag_feature(int index); 916 917 void hfp_log_rfcomm_message(const char * tag, uint8_t * packet, uint16_t size); 918 919 const char * hfp_enhanced_call_dir2str(uint16_t index); 920 const char * hfp_enhanced_call_status2str(uint16_t index); 921 const char * hfp_enhanced_call_mode2str(uint16_t index); 922 const char * hfp_enhanced_call_mpty2str(uint16_t index); 923 924 /** 925 * @brief Prepare for immediate SCO connection. 926 * Triggers sending of vendor-specific commands to enable mSBC Codec in Controller 927 * @param hfp_connection 928 */ 929 void hfp_prepare_for_sco(hfp_connection_t * hfp_connection); 930 931 #ifdef ENABLE_BCM_PCM_WBS 932 void hfp_bcm_write_i2spcm_interface_param (hfp_connection_t * hfp_connection); 933 #endif 934 935 /** 936 * @brief Set packet types for SCO connections 937 * @param common single packet_types: HFP_SCO_PACKET_TYPES_* 938 */ 939 void hfp_set_sco_packet_types(uint16_t packet_types); 940 941 /** 942 * @brief Get packet types for SCO connections 943 * @return packet_types 944 */ 945 uint16_t hfp_get_sco_packet_types(void); 946 947 #if defined __cplusplus 948 } 949 #endif 950 951 #endif // BTSTACK_HFP_H 952