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 MATTHIAS 24 * RINGWALD 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 // 40 // HFP Hands-Free (HF) unit and Audio Gateway Commons 41 // 42 // ***************************************************************************** 43 44 45 #ifndef BTSTACK_HFP_H 46 #define BTSTACK_HFP_H 47 48 #include "hci.h" 49 #include "classic/sdp_client_rfcomm.h" 50 51 #if defined __cplusplus 52 extern "C" { 53 #endif 54 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 120 #define HFP_MAX_INDICATOR_DESC_SIZE 20 121 #define HFP_MAX_VR_TEXT_SIZE 100 122 #define HFP_MAX_NETWORK_OPERATOR_NAME_SIZE 17 123 124 125 #define HFP_SUPPORTED_FEATURES "+BRSF" 126 #define HFP_AVAILABLE_CODECS "+BAC" 127 #define HFP_INDICATOR "+CIND" 128 #define HFP_ENABLE_STATUS_UPDATE_FOR_AG_INDICATORS "+CMER" 129 #define HFP_ENABLE_CLIP "+CLIP" 130 #define HFP_ENABLE_CALL_WAITING_NOTIFICATION "+CCWA" 131 #define HFP_UPDATE_ENABLE_STATUS_FOR_INDIVIDUAL_AG_INDICATORS "+BIA" // +BIA:<enabled>,,<enabled>,,,<enabled> 132 #define HFP_SUPPORT_CALL_HOLD_AND_MULTIPARTY_SERVICES "+CHLD" 133 #define HFP_GENERIC_STATUS_INDICATOR "+BIND" 134 #define HFP_TRANSFER_AG_INDICATOR_STATUS "+CIEV" // +CIEV: <index>,<value> 135 #define HFP_TRANSFER_HF_INDICATOR_STATUS "+BIEV" // +BIEC: <index>,<value> 136 #define HFP_QUERY_OPERATOR_SELECTION "+COPS" // +COPS: <mode>,0,<opearator> 137 #define HFP_ENABLE_EXTENDED_AUDIO_GATEWAY_ERROR "+CMEE" 138 #define HFP_EXTENDED_AUDIO_GATEWAY_ERROR "+CME ERROR" 139 #define HFP_TRIGGER_CODEC_CONNECTION_SETUP "+BCC" 140 #define HFP_CONFIRM_COMMON_CODEC "+BCS" 141 #define HFP_ANSWER_CALL "ATA" 142 #define HFP_HANG_UP_CALL "+CHUP" 143 #define HFP_CHANGE_IN_BAND_RING_TONE_SETTING "+BSIR" 144 #define HFP_CALL_PHONE_NUMBER "ATD" 145 #define HFP_REDIAL_LAST_NUMBER "+BLDN" 146 #define HFP_TURN_OFF_EC_AND_NR "+NREC" // EC (Echo CAnceling), NR (Noise Reduction) 147 #define HFP_ACTIVATE_VOICE_RECOGNITION "+BVRA" // Voice Recognition 148 #define HFP_SET_MICROPHONE_GAIN "+VGM" 149 #define HFP_SET_SPEAKER_GAIN "+VGS" 150 #define HFP_PHONE_NUMBER_FOR_VOICE_TAG "+BINP" 151 #define HFP_TRANSMIT_DTMF_CODES "+VTS" 152 #define HFP_SUBSCRIBER_NUMBER_INFORMATION "+CNUM" 153 #define HFP_LIST_CURRENT_CALLS "+CLCC" 154 #define HFP_RESPONSE_AND_HOLD "+BTRH" 155 156 #define HFP_OK "OK" 157 #define HFP_ERROR "ERROR" 158 #define HFP_RING "RING" 159 160 // Codecs 161 #define HFP_CODEC_CVSD 0x01 162 #define HFP_CODEC_MSBC 0x02 163 164 typedef enum { 165 HFP_ROLE_INVALID = 0, 166 HFP_ROLE_AG, 167 HFP_ROLE_HF, 168 } hfp_role_t; 169 170 typedef enum { 171 HFP_CMD_NONE = 0, 172 HFP_CMD_ERROR, 173 HFP_CMD_UNKNOWN, 174 HFP_CMD_OK, 175 HFP_CMD_RING, 176 HFP_CMD_SUPPORTED_FEATURES, // 5 177 HFP_CMD_AVAILABLE_CODECS, 178 HFP_CMD_RETRIEVE_AG_INDICATORS_GENERIC, 179 HFP_CMD_RETRIEVE_AG_INDICATORS, 180 HFP_CMD_RETRIEVE_AG_INDICATORS_STATUS, 181 HFP_CMD_ENABLE_INDICATOR_STATUS_UPDATE, // 10 182 HFP_CMD_ENABLE_INDIVIDUAL_AG_INDICATOR_STATUS_UPDATE, 183 HFP_CMD_SUPPORT_CALL_HOLD_AND_MULTIPARTY_SERVICES, 184 HFP_CMD_ENABLE_CLIP, 185 HFP_CMD_AG_SENT_CLIP_INFORMATION, 186 HFP_CMD_ENABLE_CALL_WAITING_NOTIFICATION, // 15 187 HFP_CMD_AG_SENT_CALL_WAITING_NOTIFICATION_UPDATE, 188 HFP_CMD_LIST_GENERIC_STATUS_INDICATORS, 189 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS, 190 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS_STATE, 191 HFP_CMD_SET_GENERIC_STATUS_INDICATOR_STATUS, // 20 192 HFP_CMD_TRANSFER_AG_INDICATOR_STATUS, 193 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME, 194 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME_FORMAT, 195 HFP_CMD_ENABLE_EXTENDED_AUDIO_GATEWAY_ERROR, 196 HFP_CMD_EXTENDED_AUDIO_GATEWAY_ERROR, // 25 197 HFP_CMD_TRIGGER_CODEC_CONNECTION_SETUP, 198 HFP_CMD_AG_SEND_COMMON_CODEC, 199 HFP_CMD_AG_SUGGESTED_CODEC, 200 HFP_CMD_HF_CONFIRMED_CODEC, 201 HFP_CMD_CALL_ANSWERED, 202 HFP_CMD_CALL_HOLD, 203 HFP_CMD_HANG_UP_CALL, 204 HFP_CMD_CHANGE_IN_BAND_RING_TONE_SETTING, 205 HFP_CMD_CALL_PHONE_NUMBER, 206 HFP_CMD_REDIAL_LAST_NUMBER, 207 HFP_CMD_TURN_OFF_EC_AND_NR, 208 HFP_CMD_AG_ACTIVATE_VOICE_RECOGNITION, 209 HFP_CMD_HF_ACTIVATE_VOICE_RECOGNITION, 210 HFP_CMD_AG_ACTIVATE_ENHANCED_VOICE_RECOGNITION, 211 HFP_CMD_HF_REQUEST_PHONE_NUMBER, 212 HFP_CMD_AG_SENT_PHONE_NUMBER, 213 HFP_CMD_TRANSMIT_DTMF_CODES, 214 HFP_CMD_SET_MICROPHONE_GAIN, 215 HFP_CMD_SET_SPEAKER_GAIN, 216 HFP_CMD_GET_SUBSCRIBER_NUMBER_INFORMATION, 217 HFP_CMD_LIST_CURRENT_CALLS, 218 HFP_CMD_RESPONSE_AND_HOLD_QUERY, 219 HFP_CMD_RESPONSE_AND_HOLD_COMMAND, 220 HFP_CMD_RESPONSE_AND_HOLD_STATUS, 221 HFP_CMD_HF_INDICATOR_STATUS 222 } hfp_command_t; 223 224 225 typedef enum { 226 HFP_CME_ERROR_AG_FAILURE = 0, 227 HFP_CME_ERROR_NO_CONNECTION_TO_PHONE, 228 HFP_CME_ERROR_2, 229 HFP_CME_ERROR_OPERATION_NOT_ALLOWED, 230 HFP_CME_ERROR_OPERATION_NOT_SUPPORTED, 231 HFP_CME_ERROR_PH_SIM_PIN_REQUIRED, 232 HFP_CME_ERROR_6, 233 HFP_CME_ERROR_7, 234 HFP_CME_ERROR_8, 235 HFP_CME_ERROR_9, 236 HFP_CME_ERROR_SIM_NOT_INSERTED, 237 HFP_CME_ERROR_SIM_PIN_REQUIRED, 238 HFP_CME_ERROR_SIM_PUK_REQUIRED, 239 HFP_CME_ERROR_SIM_FAILURE, 240 HFP_CME_ERROR_SIM_BUSY, 241 HFP_CME_ERROR_15, 242 HFP_CME_ERROR_INCORRECT_PASSWORD, 243 HFP_CME_ERROR_SIM_PIN2_REQUIRED, 244 HFP_CME_ERROR_SIM_PUK2_REQUIRED, 245 HFP_CME_ERROR_19, 246 HFP_CME_ERROR_MEMORY_FULL, 247 HFP_CME_ERROR_INVALID_INDEX, 248 HFP_CME_ERROR_22, 249 HFP_CME_ERROR_MEMORY_FAILURE, 250 HFP_CME_ERROR_TEXT_STRING_TOO_LONG, 251 HFP_CME_ERROR_INVALID_CHARACTERS_IN_TEXT_STRING, 252 HFP_CME_ERROR_DIAL_STRING_TOO_LONG, 253 HFP_CME_ERROR_INVALID_CHARACTERS_IN_DIAL_STRING, 254 HFP_CME_ERROR_28, 255 HFP_CME_ERROR_29, 256 HFP_CME_ERROR_NO_NETWORK_SERVICE, 257 HFP_CME_ERROR_NETWORK_TIMEOUT, 258 HFP_CME_ERROR_NETWORK_NOT_ALLOWED_EMERGENCY_CALLS_ONLY 259 } hfp_cme_error_t; 260 261 typedef enum { 262 HFP_CALL_STATUS_NO_HELD_OR_ACTIVE_CALLS = 0, 263 HFP_CALL_STATUS_ACTIVE_OR_HELD_CALL_IS_PRESENT 264 } hfp_call_status_t; 265 266 typedef enum { 267 HFP_CALLSETUP_STATUS_NO_CALL_SETUP_IN_PROGRESS = 0, 268 HFP_CALLSETUP_STATUS_INCOMING_CALL_SETUP_IN_PROGRESS, 269 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_DIALING_STATE, 270 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_ALERTING_STATE 271 } hfp_callsetup_status_t; 272 273 typedef enum { 274 HFP_CALLHELD_STATUS_NO_CALLS_HELD = 0, 275 HFP_CALLHELD_STATUS_CALL_ON_HOLD_OR_SWAPPED, 276 HFP_CALLHELD_STATUS_CALL_ON_HOLD_AND_NO_ACTIVE_CALLS 277 } hfp_callheld_status_t; 278 279 280 typedef enum { 281 HFP_AG_INCOMING_CALL, 282 HFP_AG_INCOMING_CALL_ACCEPTED_BY_AG, 283 HFP_AG_INCOMING_CALL_ACCEPTED_BY_HF, 284 HFP_AG_AUDIO_CONNECTION_ESTABLISHED, 285 HFP_AG_OUTGOING_CALL_INITIATED_BY_AG, 286 HFP_AG_OUTGOING_CALL_INITIATED_BY_HF, 287 HFP_AG_OUTGOING_CALL_REJECTED, 288 HFP_AG_OUTGOING_CALL_ACCEPTED, 289 HFP_AG_OUTGOING_CALL_RINGING, 290 HFP_AG_OUTGOING_CALL_ESTABLISHED, 291 HFP_AG_OUTGOING_REDIAL_INITIATED, 292 HFP_AG_HELD_CALL_JOINED_BY_AG, 293 HFP_AG_TERMINATE_CALL_BY_AG, 294 HFP_AG_TERMINATE_CALL_BY_HF, 295 HFP_AG_CALL_DROPPED, 296 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_AG, 297 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_AG, 298 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_AG, 299 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_HF, 300 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_HF, 301 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_HF, 302 HFP_AG_CALL_HOLD_USER_BUSY, 303 HFP_AG_CALL_HOLD_RELEASE_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 304 HFP_AG_CALL_HOLD_PARK_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 305 HFP_AG_CALL_HOLD_ADD_HELD_CALL, 306 HFP_AG_CALL_HOLD_EXIT_AND_JOIN_CALLS, 307 HFP_AG_SET_CLIP 308 } hfp_ag_call_event_t; 309 310 311 typedef enum { 312 HFP_PARSER_CMD_HEADER = 0, 313 HFP_PARSER_CMD_SEQUENCE, 314 HFP_PARSER_SECOND_ITEM, 315 HFP_PARSER_THIRD_ITEM 316 } hfp_parser_state_t; 317 318 typedef enum { 319 HFP_VOICE_RECOGNITION_STATE_AG_READY = 0, 320 HFP_VOICE_RECOGNITION_STATE_AG_READY_TO_ACCEPT_AUDIO_INPUT = 1, 321 HFP_VOICE_RECOGNITION_STATE_AG_IS_SENDING_AUDIO_TO_HF = 2, 322 HFP_VOICE_RECOGNITION_STATE_AG_IS_PROCESSING_AUDIO_INPUT = 4 323 } hfp_voice_recognition_state_t; 324 325 typedef enum { 326 HFP_TEXT_TYPE_RECOGNISED_FROM_HF_AUDIO = 0, 327 HFP_TEXT_TYPE_MESSAGE_FROM_AG, 328 HFP_TEXT_TYPE_QUESTION_FROM_AG, 329 HFP_TEXT_TYPE_ERROR_FROM_AG 330 } hfp_text_type_t; 331 332 typedef enum { 333 HFP_TEXT_OPERATION_NEW_TEXT = 1, 334 HFP_TEXT_OPERATION_REPLACE, 335 HFP_TEXT_OPERATION_APPEND 336 } hfp_text_operation_t; 337 338 typedef enum { 339 HFP_IDLE = 0, //0 340 HFP_SDP_QUERY_RFCOMM_CHANNEL, 341 HFP_W2_SEND_SDP_QUERY, 342 HFP_W4_SDP_QUERY_COMPLETE, 343 HFP_W4_RFCOMM_CONNECTED, 344 345 HFP_EXCHANGE_SUPPORTED_FEATURES, // 5 346 HFP_W4_EXCHANGE_SUPPORTED_FEATURES, 347 348 HFP_NOTIFY_ON_CODECS, 349 HFP_W4_NOTIFY_ON_CODECS, 350 351 HFP_RETRIEVE_INDICATORS, 352 HFP_W4_RETRIEVE_INDICATORS, // 10 353 354 HFP_RETRIEVE_INDICATORS_STATUS, 355 HFP_W4_RETRIEVE_INDICATORS_STATUS, 356 357 HFP_ENABLE_INDICATORS_STATUS_UPDATE, 358 HFP_W4_ENABLE_INDICATORS_STATUS_UPDATE, 359 360 HFP_RETRIEVE_CAN_HOLD_CALL, // 15 361 HFP_W4_RETRIEVE_CAN_HOLD_CALL, 362 363 HFP_LIST_GENERIC_STATUS_INDICATORS, 364 HFP_W4_LIST_GENERIC_STATUS_INDICATORS, 365 366 HFP_RETRIEVE_GENERIC_STATUS_INDICATORS, 367 HFP_W4_RETRIEVE_GENERIC_STATUS_INDICATORS, //20 368 369 HFP_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 370 HFP_W4_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 371 372 HFP_SERVICE_LEVEL_CONNECTION_ESTABLISHED, 373 374 HFP_W2_CONNECT_SCO, 375 HFP_W4_SCO_CONNECTED, 376 377 HFP_AUDIO_CONNECTION_ESTABLISHED, 378 379 380 HFP_W2_DISCONNECT_SCO, 381 HFP_W4_SCO_DISCONNECTED, 382 HFP_W4_SCO_DISCONNECTED_TO_SHUTDOWN, 383 HFP_W4_WBS_SHUTDOWN, 384 385 HFP_W2_DISCONNECT_RFCOMM, 386 HFP_W4_RFCOMM_DISCONNECTED, 387 HFP_W4_RFCOMM_DISCONNECTED_AND_RESTART, 388 HFP_W4_CONNECTION_ESTABLISHED_TO_SHUTDOWN 389 } hfp_state_t; 390 391 392 typedef enum { 393 HFP_VRA_VOICE_RECOGNITION_OFF, 394 395 HFP_VRA_W4_VOICE_RECOGNITION_OFF, 396 HFP_VRA_W4_VOICE_RECOGNITION_ACTIVATED, 397 HFP_VRA_VOICE_RECOGNITION_ACTIVATED, 398 399 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_OFF, 400 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_ACTIVATED, 401 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_STATUS, 402 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_MSG, 403 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_NEW_SESSION, 404 HFP_VRA_ENHANCED_VOICE_RECOGNITION_ACTIVATED 405 } hfp_voice_recognition_activation_status_t; 406 407 typedef struct { 408 uint16_t text_id; 409 hfp_text_type_t text_type; 410 hfp_text_operation_t text_operation; 411 uint8_t * text; 412 } hfp_voice_recognition_message_t; 413 414 typedef enum { 415 HFP_CODECS_IDLE, 416 HFP_CODECS_RECEIVED_LIST, 417 HFP_CODECS_RECEIVED_TRIGGER_CODEC_EXCHANGE, 418 HFP_CODECS_W4_AG_COMMON_CODEC, 419 HFP_CODECS_AG_SENT_COMMON_CODEC, 420 HFP_CODECS_AG_RESEND_COMMON_CODEC, 421 HFP_CODECS_HF_CONFIRMED_CODEC, 422 HFP_CODECS_EXCHANGED, 423 HFP_CODECS_ERROR 424 } hfp_codecs_state_t; 425 426 typedef enum { 427 HFP_CALL_IDLE, 428 HFP_CALL_TRIGGER_AUDIO_CONNECTION, 429 HFP_CALL_W4_AUDIO_CONNECTION_FOR_IN_BAND_RING, 430 HFP_CALL_RINGING, 431 HFP_CALL_W4_AUDIO_CONNECTION_FOR_ACTIVE, 432 HFP_CALL_ACTIVE, 433 HFP_CALL_W2_SEND_CALL_WAITING, 434 HFP_CALL_W4_CHLD, 435 HFP_CALL_OUTGOING_INITIATED, 436 HFP_CALL_OUTGOING_DIALING, 437 HFP_CALL_OUTGOING_RINGING 438 } hfp_call_state_t; 439 440 typedef enum{ 441 HFP_ENHANCED_CALL_DIR_OUTGOING, 442 HFP_ENHANCED_CALL_DIR_INCOMING 443 } hfp_enhanced_call_dir_t; 444 445 typedef enum{ 446 HFP_ENHANCED_CALL_STATUS_ACTIVE, 447 HFP_ENHANCED_CALL_STATUS_HELD, 448 HFP_ENHANCED_CALL_STATUS_OUTGOING_DIALING, 449 HFP_ENHANCED_CALL_STATUS_OUTGOING_ALERTING, 450 HFP_ENHANCED_CALL_STATUS_INCOMING, 451 HFP_ENHANCED_CALL_STATUS_INCOMING_WAITING, 452 HFP_ENHANCED_CALL_STATUS_CALL_HELD_BY_RESPONSE_AND_HOLD 453 } hfp_enhanced_call_status_t; 454 455 typedef enum{ 456 HFP_ENHANCED_CALL_MODE_VOICE, 457 HFP_ENHANCED_CALL_MODE_DATA, 458 HFP_ENHANCED_CALL_MODE_FAX 459 } hfp_enhanced_call_mode_t; 460 461 typedef enum{ 462 HFP_ENHANCED_CALL_MPTY_NOT_A_CONFERENCE_CALL, 463 HFP_ENHANCED_CALL_MPTY_CONFERENCE_CALL 464 } hfp_enhanced_call_mpty_t; 465 466 typedef enum { 467 HFP_RESPONSE_AND_HOLD_INCOMING_ON_HOLD = 0, 468 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_ACCEPTED, 469 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_REJECTED 470 } hfp_response_and_hold_state_t; 471 472 typedef enum { 473 HFP_HF_QUERY_OPERATOR_FORMAT_NOT_SET = 0, 474 HFP_HF_QUERY_OPERATOR_SET_FORMAT, 475 HFP_HF_QUERY_OPERATOR_W4_SET_FORMAT_OK, 476 HFP_HF_QUERY_OPERATOR_FORMAT_SET, 477 HFP_HF_QUERY_OPERATOR_SEND_QUERY, 478 HPF_HF_QUERY_OPERATOR_W4_RESULT 479 } hfp_hf_query_operator_state_t; 480 481 typedef enum { 482 HFP_LINK_SETTINGS_D0 = 0, 483 HFP_LINK_SETTINGS_D1, 484 HFP_LINK_SETTINGS_S1, 485 HFP_LINK_SETTINGS_S2, 486 HFP_LINK_SETTINGS_S3, 487 HFP_LINK_SETTINGS_S4, 488 HFP_LINK_SETTINGS_T1, 489 HFP_LINK_SETTINGS_T2, 490 HFP_LINK_SETTINGS_NONE, 491 } hfp_link_settings_t; 492 493 typedef enum{ 494 HFP_NONE_SM, 495 HFP_SLC_SM, 496 HFP_SLC_QUERIES_SM, 497 HFP_CODECS_CONNECTION_SM, 498 HFP_AUDIO_CONNECTION_SM, 499 HFP_CALL_SM 500 } hfp_state_machine_t; 501 502 typedef struct{ 503 uint16_t uuid; 504 uint8_t state; // enabled 505 } hfp_generic_status_indicator_t; 506 507 typedef struct{ 508 uint8_t index; 509 char name[HFP_MAX_INDICATOR_DESC_SIZE]; 510 uint8_t min_range; 511 uint8_t max_range; 512 uint8_t status; 513 uint8_t mandatory; 514 uint8_t enabled; 515 uint8_t status_changed; 516 } hfp_ag_indicator_t; 517 518 typedef struct{ 519 char name[HFP_CALL_SERVICE_SIZE]; 520 } hfp_call_service_t; 521 522 523 typedef struct{ 524 uint8_t mode; 525 uint8_t format; 526 char name[HFP_MAX_NETWORK_OPERATOR_NAME_SIZE]; // enabled 527 } hfp_network_opearator_t; 528 529 530 typedef struct hfp_connection { 531 btstack_linked_item_t item; 532 533 // local role: HF or AG 534 hfp_role_t local_role; 535 536 bd_addr_t remote_addr; 537 hci_con_handle_t acl_handle; 538 hci_con_handle_t sco_handle; 539 uint16_t rfcomm_channel_nr; 540 uint16_t rfcomm_cid; 541 542 hfp_state_machine_t state_machine; 543 hfp_call_state_t call_state; 544 hfp_state_t state; 545 hfp_codecs_state_t codecs_state; 546 547 // needed for reestablishing connection - service uuid of the remote 548 uint16_t service_uuid; 549 550 // used during service level connection establishment 551 hfp_command_t command; 552 hfp_parser_state_t parser_state; 553 int parser_item_index; 554 int parser_indicator_index; 555 uint32_t parser_indicator_value; 556 bool parser_quoted; 557 uint8_t line_buffer[HFP_MAX_VR_TEXT_SIZE]; 558 int line_size; 559 560 uint32_t remote_supported_features; 561 562 uint16_t remote_codecs_nr; 563 uint8_t remote_codecs[HFP_MAX_NUM_CODECS]; 564 565 uint16_t ag_indicators_nr; 566 hfp_ag_indicator_t ag_indicators[HFP_MAX_NUM_INDICATORS]; 567 uint32_t ag_indicators_status_update_bitmap; 568 uint8_t enable_status_update_for_ag_indicators; 569 570 uint16_t remote_call_services_index; 571 hfp_call_service_t remote_call_services[HFP_MAX_NUM_CALL_SERVICES]; 572 573 // TODO: use bitmap. 574 uint16_t generic_status_indicators_nr; 575 uint32_t generic_status_update_bitmap; 576 hfp_generic_status_indicator_t generic_status_indicators[HFP_MAX_NUM_INDICATORS]; 577 578 hfp_network_opearator_t network_operator; 579 580 // Retrieved during service level connection establishment, not used yet 581 uint8_t negotiated_codec; 582 583 // HF -> AG configuration 584 uint8_t clip_enabled; 585 uint8_t call_waiting_notification_enabled; 586 587 // TODO: put these bit flags in a bitmap 588 uint8_t ok_pending; 589 // uint8_t send_ok; 590 uint8_t send_error; 591 592 bool found_equal_sign; 593 uint8_t ignore_value; 594 595 uint8_t change_status_update_for_individual_ag_indicators; 596 uint8_t operator_name_changed; 597 598 uint8_t enable_extended_audio_gateway_error_report; 599 uint8_t extended_audio_gateway_error_value; 600 uint8_t extended_audio_gateway_error; 601 602 // establish codecs connection 603 uint8_t suggested_codec; 604 uint8_t codec_confirmed; 605 uint8_t sco_for_msbc_failed; 606 uint8_t trigger_codec_exchange; 607 608 // establish audio connection 609 hfp_link_settings_t link_setting; 610 uint8_t accept_sco; // 1 = SCO, 2 = eSCO 611 612 uint8_t establish_audio_connection; 613 uint8_t release_audio_connection; 614 uint8_t release_slc_connection; 615 616 btstack_timer_source_t hfp_timeout; 617 618 uint8_t microphone_gain; 619 uint8_t send_microphone_gain; 620 621 uint8_t speaker_gain; 622 uint8_t send_speaker_gain; 623 624 uint8_t send_phone_number_for_voice_tag; 625 uint8_t send_ag_status_indicators; 626 uint8_t send_ag_indicators_segment; 627 uint8_t send_response_and_hold_status; // 0 - don't send. BRTH:0 == 1, .. 628 629 // AG only 630 uint8_t change_in_band_ring_tone_setting; 631 uint8_t ag_ring; 632 uint8_t ag_send_clip; 633 uint8_t ag_echo_and_noise_reduction; 634 uint8_t ag_activate_voice_recognition; 635 uint8_t ag_notify_incoming_call_waiting; 636 uint8_t send_subscriber_number; 637 uint8_t next_subscriber_number_to_send; 638 uint8_t ag_call_hold_action; 639 uint8_t ag_response_and_hold_action; 640 uint8_t ag_dtmf_code; 641 bool ag_send_no_carrier; 642 643 int send_status_of_current_calls; 644 int next_call_index; 645 646 // HF only 647 hfp_hf_query_operator_state_t hf_query_operator_state; 648 uint8_t hf_answer_incoming_call; 649 uint8_t hf_initiate_outgoing_call; 650 uint8_t hf_initiate_memory_dialing; 651 uint8_t hf_initiate_redial_last_number; 652 bool hf_send_codec_confirm; 653 bool hf_send_supported_codecs; 654 655 int memory_id; 656 657 uint8_t hf_send_clip_enable; 658 uint8_t hf_send_chup; 659 uint8_t hf_send_chld_0; 660 uint8_t hf_send_chld_1; 661 uint8_t hf_send_chld_2; 662 uint8_t hf_send_chld_3; 663 uint8_t hf_send_chld_4; 664 uint8_t hf_send_chld_x; 665 uint8_t hf_send_chld_x_index; 666 char hf_send_dtmf_code; 667 uint8_t hf_send_binp; 668 uint8_t hf_send_clcc; 669 uint8_t hf_send_rrh; 670 char hf_send_rrh_command; 671 uint8_t hf_send_cnum; 672 673 uint8_t hf_activate_call_waiting_notification; 674 uint8_t hf_deactivate_call_waiting_notification; 675 676 uint8_t hf_activate_calling_line_notification; 677 uint8_t hf_deactivate_calling_line_notification; 678 uint8_t hf_activate_echo_canceling_and_noise_reduction; 679 uint8_t hf_deactivate_echo_canceling_and_noise_reduction; 680 681 hfp_voice_recognition_activation_status_t vra_status; 682 683 hfp_voice_recognition_activation_status_t ag_vra_status; 684 hfp_voice_recognition_state_t ag_vra_state; 685 686 hfp_voice_recognition_message_t ag_msg; 687 688 uint8_t clcc_idx; 689 uint8_t clcc_dir; 690 uint8_t clcc_status; 691 uint8_t clcc_mode; 692 uint8_t clcc_mpty; 693 694 uint8_t call_index; 695 // also used for CLCC, CCWA, CLIP if set 696 uint8_t bnip_type; // 0 == not set 697 char bnip_number[25]; // 698 699 #ifdef ENABLE_CC256X_ASSISTED_HFP 700 bool cc256x_send_write_codec_config; 701 bool cc256x_send_wbs_associate; 702 bool cc256x_send_wbs_disassociate; 703 #endif 704 #ifdef ENABLE_BCM_PCM_WBS 705 bool bcm_send_enable_wbs; 706 bool bcm_send_disable_wbs; 707 bool bcm_send_write_i2spcm_interface_param; 708 #endif 709 } hfp_connection_t; 710 711 // UTILS_START : TODO move to utils 712 int send_str_over_rfcomm(uint16_t cid, char * command); 713 int join(char * buffer, int buffer_size, uint8_t * values, int values_nr); 714 int join_bitmap(char * buffer, int buffer_size, uint32_t values, int values_nr); 715 int get_bit(uint16_t bitmap, int position); 716 int store_bit(uint32_t bitmap, int position, uint8_t value); 717 // UTILS_END 718 719 void hfp_finalize_connection_context(hfp_connection_t * hfp_connection); 720 void hfp_emit_sco_event(hfp_connection_t * hfp_connection, uint8_t status, hci_con_handle_t con_handle, bd_addr_t addr, uint8_t negotiated_codec); 721 722 void hfp_set_ag_callback(btstack_packet_handler_t callback); 723 void hfp_set_ag_rfcomm_packet_handler(btstack_packet_handler_t handler); 724 725 void hfp_set_hf_callback(btstack_packet_handler_t callback); 726 void hfp_set_hf_rfcomm_packet_handler(btstack_packet_handler_t handler); 727 728 void hfp_init(void); 729 void hfp_deinit(void); 730 731 void hfp_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t service_uuid, int rfcomm_channel_nr, const char * name); 732 void hfp_handle_hci_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 733 void hfp_handle_rfcomm_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 734 void hfp_emit_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, uint8_t value); 735 void hfp_emit_simple_event(hfp_connection_t * hfp_connection, uint8_t event_subtype); 736 void hfp_emit_string_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, const char * value); 737 void hfp_emit_slc_connection_event(hfp_connection_t * hfp_connection, uint8_t status, hci_con_handle_t con_handle, bd_addr_t addr); 738 739 hfp_connection_t * get_hfp_connection_context_for_rfcomm_cid(uint16_t cid); 740 hfp_connection_t * get_hfp_connection_context_for_bd_addr(bd_addr_t bd_addr, hfp_role_t hfp_role); 741 hfp_connection_t * get_hfp_connection_context_for_sco_handle(uint16_t handle, hfp_role_t hfp_role); 742 hfp_connection_t * get_hfp_connection_context_for_acl_handle(uint16_t handle, hfp_role_t hfp_role); 743 744 btstack_linked_list_t * hfp_get_connections(void); 745 void hfp_parse(hfp_connection_t * connection, uint8_t byte, int isHandsFree); 746 747 void hfp_establish_service_level_connection(bd_addr_t bd_addr, uint16_t service_uuid, hfp_role_t local_role); 748 void hfp_release_service_level_connection(hfp_connection_t * connection); 749 void hfp_reset_context_flags(hfp_connection_t * connection); 750 751 void hfp_release_audio_connection(hfp_connection_t * connection); 752 753 void hfp_setup_synchronous_connection(hfp_connection_t * connection); 754 void hfp_accept_synchronous_connection(hfp_connection_t * hfp_connection, bool incoming_eSCO); 755 int hfp_supports_codec(uint8_t codec, int codecs_nr, uint8_t * codecs); 756 void hfp_hf_drop_mSBC_if_eSCO_not_supported(uint8_t * codecs, uint8_t * codecs_nr); 757 void hfp_init_link_settings(hfp_connection_t * hfp_connection, uint8_t eSCO_S4_supported); 758 hfp_link_settings_t hfp_next_link_setting(hfp_link_settings_t current_setting, bool local_eSCO_supported, bool remote_eSCO_supported, bool eSCO_s4_supported, uint8_t negotiated_codec); 759 760 const char * hfp_hf_feature(int index); 761 const char * hfp_ag_feature(int index); 762 763 void hfp_log_rfcomm_message(const char * tag, uint8_t * packet, uint16_t size); 764 765 const char * hfp_enhanced_call_dir2str(uint16_t index); 766 const char * hfp_enhanced_call_status2str(uint16_t index); 767 const char * hfp_enhanced_call_mode2str(uint16_t index); 768 const char * hfp_enhanced_call_mpty2str(uint16_t index); 769 770 #ifdef ENABLE_CC256X_ASSISTED_HFP 771 void hfp_cc256x_prepare_for_sco(hfp_connection_t * hfp_connection); 772 void hfp_cc256x_write_codec_config(hfp_connection_t * hfp_connection); 773 #endif 774 #ifdef ENABLE_BCM_PCM_WBS 775 void hfp_bcm_prepare_for_sco(hfp_connection_t * hfp_connection); 776 void hfp_bcm_write_i2spcm_interface_param (hfp_connection_t * hfp_connection); 777 #endif 778 779 /** 780 * @brief Set packet types for SCO connections 781 * @param common single packet_types: HFP_SCO_PACKET_TYPES_* 782 */ 783 void hfp_set_sco_packet_types(uint16_t packet_types); 784 785 /** 786 * @brief Get packet types for SCO connections 787 * @returns packet_types 788 */ 789 uint16_t hfp_get_sco_packet_types(void); 790 791 #if defined __cplusplus 792 } 793 #endif 794 795 #endif // BTSTACK_HFP_H 796