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 80 /* AG Supported Features: 81 0: Three-way calling 82 1: EC and/or NR function 83 2: Voice recognition function 84 3: In-band ring tone capability 85 4: Attach a number to a voice tag 86 5: Ability to reject a call 87 6: Enhanced call status 88 7: Enhanced call control 89 8: Extended Error Result Codes 90 9: Codec negotiation 91 10: HF Indicators 92 11: eSCO S4 (and T2) Settings Supported 93 12-31: Reserved for future definition 94 */ 95 #define HFP_AGSF_THREE_WAY_CALLING 0 96 #define HFP_AGSF_EC_NR_FUNCTION 1 97 #define HFP_AGSF_VOICE_RECOGNITION_FUNCTION 2 98 #define HFP_AGSF_IN_BAND_RING_TONE 3 99 #define HFP_AGSF_ATTACH_A_NUMBER_TO_A_VOICE_TAG 4 100 #define HFP_AGSF_ABILITY_TO_REJECT_A_CALL 5 101 #define HFP_AGSF_ENHANCED_CALL_STATUS 6 102 #define HFP_AGSF_ENHANCED_CALL_CONTROL 7 103 #define HFP_AGSF_EXTENDED_ERROR_RESULT_CODES 8 104 #define HFP_AGSF_CODEC_NEGOTIATION 9 105 #define HFP_AGSF_HF_INDICATORS 10 106 #define HFP_AGSF_ESCO_S4 11 107 108 #define HFP_DEFAULT_HF_SUPPORTED_FEATURES 0x0000 109 #define HFP_DEFAULT_AG_SUPPORTED_FEATURES 0x0009 110 111 #define HFP_MAX_NUM_CODECS 20 112 #define HFP_MAX_NUM_AG_INDICATORS 20 113 #define HFP_MAX_NUM_HF_INDICATORS 20 114 #define HFP_MAX_INDICATOR_DESC_SIZE 20 115 #define HFP_MAX_NETWORK_OPERATOR_NAME_SIZE 17 116 #define HFP_CALL_SERVICE_SIZE 3 117 118 #define HFP_SUPPORTED_FEATURES "+BRSF" 119 #define HFP_AVAILABLE_CODECS "+BAC" 120 #define HFP_INDICATOR "+CIND" 121 #define HFP_ENABLE_STATUS_UPDATE_FOR_AG_INDICATORS "+CMER" 122 #define HFP_ENABLE_CLIP "+CLIP" 123 #define HFP_ENABLE_CALL_WAITING_NOTIFICATION "+CCWA" 124 #define HFP_UPDATE_ENABLE_STATUS_FOR_INDIVIDUAL_AG_INDICATORS "+BIA" // +BIA:<enabled>,,<enabled>,,,<enabled> 125 #define HFP_SUPPORT_CALL_HOLD_AND_MULTIPARTY_SERVICES "+CHLD" 126 #define HFP_GENERIC_STATUS_INDICATOR "+BIND" 127 #define HFP_TRANSFER_AG_INDICATOR_STATUS "+CIEV" // +CIEV: <index>,<value> 128 #define HFP_TRANSFER_HF_INDICATOR_STATUS "+BIEV" // +BIEC: <index>,<value> 129 #define HFP_QUERY_OPERATOR_SELECTION "+COPS" // +COPS: <mode>,0,<opearator> 130 #define HFP_ENABLE_EXTENDED_AUDIO_GATEWAY_ERROR "+CMEE" 131 #define HFP_EXTENDED_AUDIO_GATEWAY_ERROR "+CME ERROR" 132 #define HFP_TRIGGER_CODEC_CONNECTION_SETUP "+BCC" 133 #define HFP_CONFIRM_COMMON_CODEC "+BCS" 134 #define HFP_CALL_ANSWERED "ATA" 135 #define HFP_HANG_UP_CALL "+CHUP" 136 #define HFP_CHANGE_IN_BAND_RING_TONE_SETTING "+BSIR" 137 #define HFP_CALL_PHONE_NUMBER "ATD" 138 #define HFP_REDIAL_LAST_NUMBER "+BLDN" 139 #define HFP_TURN_OFF_EC_AND_NR "+NREC" // EC (Echo CAnceling), NR (Noise Reduction) 140 #define HFP_ACTIVATE_VOICE_RECOGNITION "+BVRA" // EC (Echo CAnceling), NR (Noise Reduction) 141 #define HFP_SET_MICROPHONE_GAIN "+VGM" 142 #define HFP_SET_SPEAKER_GAIN "+VGS" 143 #define HFP_PHONE_NUMBER_FOR_VOICE_TAG "+BINP" 144 #define HFP_TRANSMIT_DTMF_CODES "+VTS" 145 #define HFP_SUBSCRIBER_NUMBER_INFORMATION "+CNUM" 146 #define HFP_LIST_CURRENT_CALLS "+CLCC" 147 #define HFP_RESPONSE_AND_HOLD "+BTRH" 148 149 #define HFP_OK "OK" 150 #define HFP_ERROR "ERROR" 151 #define HFP_RING "RING" 152 153 // Codecs 154 #define HFP_CODEC_CVSD 0x01 155 #define HFP_CODEC_MSBC 0x02 156 157 typedef enum { 158 HFP_CMD_NONE = 0, 159 HFP_CMD_ERROR, 160 HFP_CMD_UNKNOWN, 161 HFP_CMD_OK, 162 HFP_CMD_RING, 163 HFP_CMD_SUPPORTED_FEATURES, 164 HFP_CMD_AVAILABLE_CODECS, 165 166 HFP_CMD_RETRIEVE_AG_INDICATORS, 167 HFP_CMD_RETRIEVE_AG_INDICATORS_STATUS, 168 169 HFP_CMD_ENABLE_INDICATOR_STATUS_UPDATE, 170 HFP_CMD_ENABLE_INDIVIDUAL_AG_INDICATOR_STATUS_UPDATE, 171 HFP_CMD_SUPPORT_CALL_HOLD_AND_MULTIPARTY_SERVICES, 172 HFP_CMD_ENABLE_CLIP, 173 HFP_CMD_AG_SENT_CLIP_INFORMATION, 174 HFP_CMD_ENABLE_CALL_WAITING_NOTIFICATION, 175 HFP_CMD_AG_SENT_CALL_WAITING_NOTIFICATION_UPDATE, 176 177 HFP_CMD_LIST_GENERIC_STATUS_INDICATORS, 178 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS, 179 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS_STATE, 180 HFP_CMD_SET_GENERIC_STATUS_INDICATOR_STATUS, 181 182 HFP_CMD_TRANSFER_AG_INDICATOR_STATUS, 183 184 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME, 185 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME_FORMAT, 186 187 HFP_CMD_ENABLE_EXTENDED_AUDIO_GATEWAY_ERROR, 188 HFP_CMD_EXTENDED_AUDIO_GATEWAY_ERROR, 189 HFP_CMD_TRIGGER_CODEC_CONNECTION_SETUP, 190 HFP_CMD_AG_SEND_COMMON_CODEC, 191 HFP_CMD_AG_SUGGESTED_CODEC, 192 HFP_CMD_HF_CONFIRMED_CODEC, 193 HFP_CMD_CALL_ANSWERED, 194 HFP_CMD_CALL_HOLD, 195 HFP_CMD_AG_ANSWER_CALL, 196 HFP_CMD_HANG_UP_CALL, 197 HFP_CMD_CHANGE_IN_BAND_RING_TONE_SETTING, 198 HFP_CMD_CALL_PHONE_NUMBER, 199 HFP_CMD_REDIAL_LAST_NUMBER, 200 HFP_CMD_TURN_OFF_EC_AND_NR, 201 HFP_CMD_AG_ACTIVATE_VOICE_RECOGNITION, 202 HFP_CMD_HF_ACTIVATE_VOICE_RECOGNITION, 203 HFP_CMD_HF_REQUEST_PHONE_NUMBER, 204 HFP_CMD_AG_SENT_PHONE_NUMBER, 205 HFP_CMD_TRANSMIT_DTMF_CODES, 206 HFP_CMD_SET_MICROPHONE_GAIN, 207 HFP_CMD_SET_SPEAKER_GAIN, 208 HFP_CMD_GET_SUBSCRIBER_NUMBER_INFORMATION, 209 HFP_CMD_LIST_CURRENT_CALLS, 210 HFP_CMD_RESPONSE_AND_HOLD_QUERY, 211 HFP_CMD_RESPONSE_AND_HOLD_COMMAND, 212 HFP_CMD_RESPONSE_AND_HOLD_STATUS, 213 HFP_CMD_HF_INDICATOR_STATUS 214 } hfp_command_t; 215 216 217 typedef enum { 218 HFP_CME_ERROR_AG_FAILURE = 0, 219 HFP_CME_ERROR_NO_CONNECTION_TO_PHONE, 220 HFP_CME_ERROR_2, 221 HFP_CME_ERROR_OPERATION_NOT_ALLOWED, 222 HFP_CME_ERROR_OPERATION_NOT_SUPPORTED, 223 HFP_CME_ERROR_PH_SIM_PIN_REQUIRED, 224 HFP_CME_ERROR_6, 225 HFP_CME_ERROR_7, 226 HFP_CME_ERROR_8, 227 HFP_CME_ERROR_9, 228 HFP_CME_ERROR_SIM_NOT_INSERTED, 229 HFP_CME_ERROR_SIM_PIN_REQUIRED, 230 HFP_CME_ERROR_SIM_PUK_REQUIRED, 231 HFP_CME_ERROR_SIM_FAILURE, 232 HFP_CME_ERROR_SIM_BUSY, 233 HFP_CME_ERROR_15, 234 HFP_CME_ERROR_INCORRECT_PASSWORD, 235 HFP_CME_ERROR_SIM_PIN2_REQUIRED, 236 HFP_CME_ERROR_SIM_PUK2_REQUIRED, 237 HFP_CME_ERROR_19, 238 HFP_CME_ERROR_MEMORY_FULL, 239 HFP_CME_ERROR_INVALID_INDEX, 240 HFP_CME_ERROR_22, 241 HFP_CME_ERROR_MEMORY_FAILURE, 242 HFP_CME_ERROR_TEXT_STRING_TOO_LONG, 243 HFP_CME_ERROR_INVALID_CHARACTERS_IN_TEXT_STRING, 244 HFP_CME_ERROR_DIAL_STRING_TOO_LONG, 245 HFP_CME_ERROR_INVALID_CHARACTERS_IN_DIAL_STRING, 246 HFP_CME_ERROR_28, 247 HFP_CME_ERROR_29, 248 HFP_CME_ERROR_NO_NETWORK_SERVICE, 249 HFP_CME_ERROR_NETWORK_TIMEOUT, 250 HFP_CME_ERROR_NETWORK_NOT_ALLOWED_EMERGENCY_CALLS_ONLY 251 } hfp_cme_error_t; 252 253 typedef enum { 254 HFP_CALL_STATUS_NO_HELD_OR_ACTIVE_CALLS = 0, 255 HFP_CALL_STATUS_ACTIVE_OR_HELD_CALL_IS_PRESENT 256 } hfp_call_status_t; 257 258 typedef enum { 259 HFP_CALLSETUP_STATUS_NO_CALL_SETUP_IN_PROGRESS = 0, 260 HFP_CALLSETUP_STATUS_INCOMING_CALL_SETUP_IN_PROGRESS, 261 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_DIALING_STATE, 262 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_ALERTING_STATE 263 } hfp_callsetup_status_t; 264 265 typedef enum { 266 HFP_CALLHELD_STATUS_NO_CALLS_HELD = 0, 267 HFP_CALLHELD_STATUS_CALL_ON_HOLD_OR_SWAPPED, 268 HFP_CALLHELD_STATUS_CALL_ON_HOLD_AND_NO_ACTIVE_CALLS 269 } hfp_callheld_status_t; 270 271 272 typedef enum { 273 HFP_AG_INCOMING_CALL, 274 HFP_AG_INCOMING_CALL_ACCEPTED_BY_AG, 275 HFP_AG_INCOMING_CALL_ACCEPTED_BY_HF, 276 HFP_AG_AUDIO_CONNECTION_ESTABLISHED, 277 HFP_AG_OUTGOING_CALL_INITIATED, 278 HFP_AG_OUTGOING_CALL_REJECTED, 279 HFP_AG_OUTGOING_CALL_ACCEPTED, 280 HFP_AG_OUTGOING_CALL_RINGING, 281 HFP_AG_OUTGOING_CALL_ESTABLISHED, 282 HFP_AG_OUTGOING_REDIAL_INITIATED, 283 HFP_AG_HELD_CALL_JOINED_BY_AG, 284 HFP_AG_TERMINATE_CALL_BY_AG, 285 HFP_AG_TERMINATE_CALL_BY_HF, 286 HFP_AG_CALL_DROPPED, 287 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_AG, 288 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_AG, 289 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_AG, 290 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_HF, 291 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_HF, 292 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_HF, 293 HFP_AG_CALL_HOLD_USER_BUSY, 294 HFP_AG_CALL_HOLD_RELEASE_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 295 HFP_AG_CALL_HOLD_PARK_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 296 HFP_AG_CALL_HOLD_ADD_HELD_CALL, 297 HFP_AG_CALL_HOLD_EXIT_AND_JOIN_CALLS, 298 HFP_AG_SET_CLIP 299 } hfp_ag_call_event_t; 300 301 302 typedef enum { 303 HFP_PARSER_CMD_HEADER = 0, 304 HFP_PARSER_CMD_SEQUENCE, 305 HFP_PARSER_SECOND_ITEM, 306 HFP_PARSER_THIRD_ITEM 307 } hfp_parser_state_t; 308 309 310 typedef enum { 311 HFP_IDLE = 0, //0 312 HFP_SDP_QUERY_RFCOMM_CHANNEL, 313 HFP_W4_SDP_QUERY_COMPLETE, 314 HFP_W4_RFCOMM_CONNECTED, 315 316 HFP_EXCHANGE_SUPPORTED_FEATURES, 317 HFP_W4_EXCHANGE_SUPPORTED_FEATURES, // 5 318 319 HFP_NOTIFY_ON_CODECS, 320 HFP_W4_NOTIFY_ON_CODECS, 321 322 HFP_RETRIEVE_INDICATORS, 323 HFP_W4_RETRIEVE_INDICATORS, 324 325 HFP_RETRIEVE_INDICATORS_STATUS, // 10 326 HFP_W4_RETRIEVE_INDICATORS_STATUS, 327 328 HFP_ENABLE_INDICATORS_STATUS_UPDATE, 329 HFP_W4_ENABLE_INDICATORS_STATUS_UPDATE, 330 331 HFP_RETRIEVE_CAN_HOLD_CALL, 332 HFP_W4_RETRIEVE_CAN_HOLD_CALL, // 15 333 334 HFP_LIST_GENERIC_STATUS_INDICATORS, 335 HFP_W4_LIST_GENERIC_STATUS_INDICATORS, 336 337 HFP_RETRIEVE_GENERIC_STATUS_INDICATORS, 338 HFP_W4_RETRIEVE_GENERIC_STATUS_INDICATORS, 339 340 HFP_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 341 HFP_W4_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 342 343 HFP_SERVICE_LEVEL_CONNECTION_ESTABLISHED, 344 345 HFP_W2_CONNECT_SCO, 346 HFP_W4_SCO_CONNECTED, 347 348 HFP_AUDIO_CONNECTION_ESTABLISHED, 349 350 HFP_W2_DISCONNECT_SCO, 351 HFP_W4_SCO_DISCONNECTED, 352 353 HFP_W2_DISCONNECT_RFCOMM, 354 HFP_W4_RFCOMM_DISCONNECTED, 355 HFP_W4_RFCOMM_DISCONNECTED_AND_RESTART, 356 HFP_W4_CONNECTION_ESTABLISHED_TO_SHUTDOWN 357 } hfp_state_t; 358 359 typedef enum { 360 HFP_CODECS_IDLE, 361 HFP_CODECS_RECEIVED_LIST, 362 HFP_CODECS_RECEIVED_TRIGGER_CODEC_EXCHANGE, 363 HFP_CODECS_W4_AG_COMMON_CODEC, 364 HFP_CODECS_AG_SENT_COMMON_CODEC, 365 HFP_CODECS_AG_RESEND_COMMON_CODEC, 366 HFP_CODECS_HF_CONFIRMED_CODEC, 367 HFP_CODECS_EXCHANGED, 368 HFP_CODECS_ERROR 369 } hfp_codecs_state_t; 370 371 typedef enum { 372 HFP_CALL_IDLE, 373 HFP_CALL_TRIGGER_AUDIO_CONNECTION, 374 HFP_CALL_W4_AUDIO_CONNECTION_FOR_IN_BAND_RING, 375 HFP_CALL_RINGING, 376 HFP_CALL_W4_AUDIO_CONNECTION_FOR_ACTIVE, 377 HFP_CALL_ACTIVE, 378 HFP_CALL_W2_SEND_CALL_WAITING, 379 HFP_CALL_W4_CHLD, 380 HFP_CALL_OUTGOING_INITIATED, 381 HFP_CALL_OUTGOING_DIALING, 382 HFP_CALL_OUTGOING_RINGING 383 } hfp_call_state_t; 384 385 typedef enum{ 386 HFP_ENHANCED_CALL_DIR_OUTGOING, 387 HFP_ENHANCED_CALL_DIR_INCOMING 388 } hfp_enhanced_call_dir_t; 389 390 typedef enum{ 391 HFP_ENHANCED_CALL_STATUS_ACTIVE, 392 HFP_ENHANCED_CALL_STATUS_HELD, 393 HFP_ENHANCED_CALL_STATUS_OUTGOING_DIALING, 394 HFP_ENHANCED_CALL_STATUS_OUTGOING_ALERTING, 395 HFP_ENHANCED_CALL_STATUS_INCOMING, 396 HFP_ENHANCED_CALL_STATUS_INCOMING_WAITING, 397 HFP_ENHANCED_CALL_STATUS_CALL_HELD_BY_RESPONSE_AND_HOLD 398 } hfp_enhanced_call_status_t; 399 400 typedef enum{ 401 HFP_ENHANCED_CALL_MODE_VOICE, 402 HFP_ENHANCED_CALL_MODE_DATA, 403 HFP_ENHANCED_CALL_MODE_FAX 404 } hfp_enhanced_call_mode_t; 405 406 typedef enum{ 407 HFP_ENHANCED_CALL_MPTY_NOT_A_CONFERENCE_CALL, 408 HFP_ENHANCED_CALL_MPTY_CONFERENCE_CALL 409 } hfp_enhanced_call_mpty_t; 410 411 typedef enum { 412 HFP_RESPONSE_AND_HOLD_INCOMING_ON_HOLD = 0, 413 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_ACCEPTED, 414 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_REJECTED 415 } hfp_response_and_hold_state_t; 416 417 typedef enum { 418 HFP_HF_QUERY_OPERATOR_FORMAT_NOT_SET = 0, 419 HFP_HF_QUERY_OPERATOR_SET_FORMAT, 420 HFP_HF_QUERY_OPERATOR_W4_SET_FORMAT_OK, 421 HFP_HF_QUERY_OPERATOR_FORMAT_SET, 422 HFP_HF_QUERY_OPERATOR_SEND_QUERY, 423 HPF_HF_QUERY_OPERATOR_W4_RESULT 424 } hfp_hf_query_operator_state_t; 425 426 typedef enum { 427 HFP_LINK_SETTINGS_D0 = 0, 428 HFP_LINK_SETTINGS_D1, 429 HFP_LINK_SETTINGS_S1, 430 HFP_LINK_SETTINGS_S2, 431 HFP_LINK_SETTINGS_S3, 432 HFP_LINK_SETTINGS_S4, 433 HFP_LINK_SETTINGS_T1, 434 HFP_LINK_SETTINGS_T2 435 } hfp_link_setttings_t; 436 437 typedef enum{ 438 HFP_NONE_SM, 439 HFP_SLC_SM, 440 HFP_SLC_QUERIES_SM, 441 HFP_CODECS_CONNECTION_SM, 442 HFP_AUDIO_CONNECTION_SM, 443 HFP_CALL_SM 444 } hfp_state_machine_t; 445 446 typedef struct{ 447 uint16_t uuid; 448 uint8_t state; // enabled 449 } hfp_generic_status_indicator_t; 450 451 typedef struct{ 452 uint8_t index; 453 char name[HFP_MAX_INDICATOR_DESC_SIZE]; 454 uint8_t min_range; 455 uint8_t max_range; 456 uint8_t status; 457 uint8_t mandatory; 458 uint8_t enabled; 459 uint8_t status_changed; 460 } hfp_ag_indicator_t; 461 462 typedef struct{ 463 char name[HFP_CALL_SERVICE_SIZE]; 464 } hfp_call_service_t; 465 466 467 typedef struct{ 468 uint8_t mode; 469 uint8_t format; 470 char name[HFP_MAX_NETWORK_OPERATOR_NAME_SIZE]; // enabled 471 } hfp_network_opearator_t; 472 473 474 typedef struct hfp_connection { 475 btstack_linked_item_t item; 476 477 bd_addr_t remote_addr; 478 hci_con_handle_t acl_handle; 479 hci_con_handle_t sco_handle; 480 uint16_t rfcomm_channel_nr; 481 uint16_t rfcomm_cid; 482 483 hfp_state_machine_t state_machine; 484 hfp_call_state_t call_state; 485 hfp_state_t state; 486 hfp_codecs_state_t codecs_state; 487 488 // needed for reestablishing connection 489 uint16_t service_uuid; 490 491 // used during service level connection establishment 492 hfp_command_t command; 493 hfp_parser_state_t parser_state; 494 int parser_item_index; 495 int parser_indicator_index; 496 uint8_t line_buffer[HFP_MAX_INDICATOR_DESC_SIZE]; 497 int line_size; 498 499 uint32_t remote_supported_features; 500 501 // TODO: rename into hf_codecs_nr 502 int remote_codecs_nr; 503 uint8_t remote_codecs[HFP_MAX_INDICATOR_DESC_SIZE]; 504 505 int ag_indicators_nr; 506 hfp_ag_indicator_t ag_indicators[HFP_MAX_INDICATOR_DESC_SIZE]; 507 uint32_t ag_indicators_status_update_bitmap; 508 uint8_t enable_status_update_for_ag_indicators; 509 510 int remote_call_services_nr; 511 hfp_call_service_t remote_call_services[HFP_MAX_INDICATOR_DESC_SIZE]; 512 513 // TODO: use bitmap. 514 int generic_status_indicators_nr; 515 uint32_t generic_status_update_bitmap; 516 hfp_generic_status_indicator_t generic_status_indicators[HFP_MAX_INDICATOR_DESC_SIZE]; 517 518 hfp_network_opearator_t network_operator; 519 520 // Retrieved during service level connection establishment, not used yet 521 uint8_t negotiated_codec; 522 523 // HF -> AG configuration 524 uint8_t clip_enabled; 525 uint8_t call_waiting_notification_enabled; 526 527 // TODO: put these bit flags in a bitmap 528 uint8_t ok_pending; 529 // uint8_t send_ok; 530 uint8_t send_error; 531 532 uint8_t keep_byte; 533 uint8_t ignore_value; 534 uint8_t resolve_byte; 535 536 uint8_t change_status_update_for_individual_ag_indicators; 537 uint8_t operator_name_changed; 538 539 uint8_t enable_extended_audio_gateway_error_report; 540 uint8_t extended_audio_gateway_error_value; 541 uint8_t extended_audio_gateway_error; 542 543 // establish codecs connection 544 uint8_t suggested_codec; 545 uint8_t codec_confirmed; 546 uint8_t sco_for_msbc_failed; 547 548 hfp_link_setttings_t link_setting; 549 550 uint8_t trigger_codec_exchange; 551 uint8_t establish_audio_connection; 552 uint8_t release_audio_connection; 553 554 btstack_timer_source_t hfp_timeout; 555 556 uint8_t microphone_gain; 557 uint8_t send_microphone_gain; 558 559 uint8_t speaker_gain; 560 uint8_t send_speaker_gain; 561 562 uint8_t send_phone_number_for_voice_tag; 563 uint8_t send_ag_status_indicators; 564 uint8_t send_ag_indicators_segment; 565 uint8_t send_response_and_hold_status; // 0 - don't send. BRTH:0 == 1, .. 566 567 // AG only 568 uint8_t change_in_band_ring_tone_setting; 569 uint8_t ag_ring; 570 uint8_t ag_send_clip; 571 uint8_t ag_echo_and_noise_reduction; 572 uint8_t ag_activate_voice_recognition; 573 uint8_t ag_notify_incoming_call_waiting; 574 uint8_t send_subscriber_number; 575 uint8_t next_subscriber_number_to_send; 576 577 int send_status_of_current_calls; 578 int next_call_index; 579 580 // HF only 581 uint8_t hf_accept_sco; 582 hfp_hf_query_operator_state_t hf_query_operator_state; 583 uint8_t hf_answer_incoming_call; 584 uint8_t hf_initiate_outgoing_call; 585 uint8_t hf_initiate_memory_dialing; 586 uint8_t hf_initiate_redial_last_number; 587 int memory_id; 588 589 uint8_t hf_send_clip_enable; 590 uint8_t hf_send_chup; 591 uint8_t hf_send_chld_0; 592 uint8_t hf_send_chld_1; 593 uint8_t hf_send_chld_2; 594 uint8_t hf_send_chld_3; 595 uint8_t hf_send_chld_4; 596 uint8_t hf_send_chld_x; 597 uint8_t hf_send_chld_x_index; 598 char hf_send_dtmf_code; 599 uint8_t hf_send_binp; 600 uint8_t hf_send_clcc; 601 uint8_t hf_send_rrh; 602 char hf_send_rrh_command; 603 uint8_t hf_send_cnum; 604 605 uint8_t hf_activate_call_waiting_notification; 606 uint8_t hf_deactivate_call_waiting_notification; 607 608 uint8_t hf_activate_calling_line_notification; 609 uint8_t hf_deactivate_calling_line_notification; 610 uint8_t hf_activate_echo_canceling_and_noise_reduction; 611 uint8_t hf_deactivate_echo_canceling_and_noise_reduction; 612 uint8_t hf_activate_voice_recognition_notification; 613 uint8_t hf_deactivate_voice_recognition_notification; 614 615 uint8_t clcc_idx; 616 uint8_t clcc_dir; 617 uint8_t clcc_status; 618 uint8_t clcc_mode; 619 uint8_t clcc_mpty; 620 621 uint8_t call_index; 622 // also used for CLCC, CCWA, CLIP if set 623 uint8_t bnip_type; // 0 == not set 624 char bnip_number[25]; // 625 626 } hfp_connection_t; 627 628 // UTILS_START : TODO move to utils 629 int send_str_over_rfcomm(uint16_t cid, char * command); 630 int join(char * buffer, int buffer_size, uint8_t * values, int values_nr); 631 int join_bitmap(char * buffer, int buffer_size, uint32_t values, int values_nr); 632 int get_bit(uint16_t bitmap, int position); 633 int store_bit(uint32_t bitmap, int position, uint8_t value); 634 // UTILS_END 635 636 void hfp_set_callback(btstack_packet_handler_t callback); 637 638 void hfp_set_packet_handler_for_rfcomm_connections(btstack_packet_handler_t handler); 639 640 void hfp_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t service_uuid, int rfcomm_channel_nr, const char * name); 641 void hfp_handle_hci_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 642 void hfp_emit_event(btstack_packet_handler_t callback, uint8_t event_subtype, uint8_t value); 643 void hfp_emit_simple_event(btstack_packet_handler_t callback, uint8_t event_subtype); 644 void hfp_emit_string_event(btstack_packet_handler_t callback, uint8_t event_subtype, const char * value); 645 void hfp_emit_slc_connection_event(btstack_packet_handler_t callback, uint8_t status, hci_con_handle_t con_handle, bd_addr_t addr); 646 647 hfp_connection_t * get_hfp_connection_context_for_rfcomm_cid(uint16_t cid); 648 hfp_connection_t * get_hfp_connection_context_for_bd_addr(bd_addr_t bd_addr); 649 hfp_connection_t * get_hfp_connection_context_for_sco_handle(uint16_t handle); 650 hfp_connection_t * get_hfp_connection_context_for_acl_handle(uint16_t handle); 651 652 btstack_linked_list_t * hfp_get_connections(void); 653 void hfp_parse(hfp_connection_t * connection, uint8_t byte, int isHandsFree); 654 655 void hfp_establish_service_level_connection(bd_addr_t bd_addr, uint16_t service_uuid); 656 void hfp_release_service_level_connection(hfp_connection_t * connection); 657 void hfp_reset_context_flags(hfp_connection_t * connection); 658 659 void hfp_release_audio_connection(hfp_connection_t * connection); 660 661 void hfp_setup_synchronous_connection(hfp_connection_t * connection); 662 int hfp_supports_codec(uint8_t codec, int codecs_nr, uint8_t * codecs); 663 void hfp_hf_drop_mSBC_if_eSCO_not_supported(uint8_t * codecs, uint8_t * codecs_nr); 664 665 const char * hfp_hf_feature(int index); 666 const char * hfp_ag_feature(int index); 667 668 #if defined __cplusplus 669 } 670 #endif 671 672 #endif // __BTSTACK_HFP_H 673