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 * 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 54 /* HF Supported Features: 55 0: EC and/or NR function 56 1: Three-way calling 57 2: CLI presentation capability 58 3: Voice recognition activation 59 4: Remote volume control 60 5: Enhanced call status 61 6: Enhanced call control 62 7: Codec negotiation 63 8: HF Indicators 64 9: eSCO S4 (and T2) Settings Supported 65 10-31: Reserved for future definition 66 */ 67 #define HFP_HFSF_EC_NR_FUNCTION 0 68 #define HFP_HFSF_THREE_WAY_CALLING 1 69 #define HFP_HFSF_CLI_PRESENTATION_CAPABILITY 2 70 #define HFP_HFSF_VOICE_RECOGNITION_FUNCTION 3 71 #define HFP_HFSF_REMOTE_VOLUME_CONTROL 4 72 #define HFP_HFSF_ENHANCED_CALL_STATUS 5 73 #define HFP_HFSF_ENHANCED_CALL_CONTROL 6 74 #define HFP_HFSF_CODEC_NEGOTIATION 7 75 #define HFP_HFSF_HF_INDICATORS 8 76 #define HFP_HFSF_ESCO_S4 9 77 #define HFP_HFSF_ENHANCED_VOICE_RECOGNITION_STATUS 10 78 #define HFP_HFSF_VOICE_RECOGNITION_TEXT 11 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 #define HFP_AGSF_ENHANCED_VOICE_RECOGNITION_STATUS 12 108 #define HFP_AGSF_VOICE_RECOGNITION_TEXT 13 109 110 #define HFP_DEFAULT_HF_SUPPORTED_FEATURES 0x0000 111 #define HFP_DEFAULT_AG_SUPPORTED_FEATURES 0x0009 112 113 #define HFP_MAX_NUM_INDICATORS 10 114 #define HFP_MAX_NUM_CALL_SERVICES 20 115 #define HFP_CALL_SERVICE_SIZE 3 116 #define HFP_MAX_NUM_CODECS 10 117 118 #define HFP_MAX_INDICATOR_DESC_SIZE 20 119 #define HFP_MAX_VR_TEXT_SIZE 100 120 #define HFP_MAX_NETWORK_OPERATOR_NAME_SIZE 17 121 122 #define HFP_HF_INDICATOR_UUID_ENHANCED_SAFETY 0x0001 // 0 - disabled, 1 - enabled 123 #define HFP_HF_INDICATOR_UUID_BATTERY_LEVEL 0X0002 // 0-100 remaining level of battery 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, // 30 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, // 35 207 HFP_CMD_TURN_OFF_EC_AND_NR, 208 HFP_CMD_AG_ACTIVATE_VOICE_RECOGNITION, // 37 209 HFP_CMD_HF_ACTIVATE_VOICE_RECOGNITION, 210 HFP_CMD_HF_REQUEST_PHONE_NUMBER, 211 HFP_CMD_AG_SENT_PHONE_NUMBER, 212 HFP_CMD_TRANSMIT_DTMF_CODES, 213 HFP_CMD_SET_MICROPHONE_GAIN, 214 HFP_CMD_SET_SPEAKER_GAIN, 215 HFP_CMD_GET_SUBSCRIBER_NUMBER_INFORMATION, 216 HFP_CMD_LIST_CURRENT_CALLS, 217 HFP_CMD_RESPONSE_AND_HOLD_QUERY, 218 HFP_CMD_RESPONSE_AND_HOLD_COMMAND, 219 HFP_CMD_RESPONSE_AND_HOLD_STATUS, 220 HFP_CMD_HF_INDICATOR_STATUS 221 } hfp_command_t; 222 223 224 typedef enum { 225 HFP_CME_ERROR_AG_FAILURE = 0, 226 HFP_CME_ERROR_NO_CONNECTION_TO_PHONE, 227 HFP_CME_ERROR_2, 228 HFP_CME_ERROR_OPERATION_NOT_ALLOWED, 229 HFP_CME_ERROR_OPERATION_NOT_SUPPORTED, 230 HFP_CME_ERROR_PH_SIM_PIN_REQUIRED, 231 HFP_CME_ERROR_6, 232 HFP_CME_ERROR_7, 233 HFP_CME_ERROR_8, 234 HFP_CME_ERROR_9, 235 HFP_CME_ERROR_SIM_NOT_INSERTED, 236 HFP_CME_ERROR_SIM_PIN_REQUIRED, 237 HFP_CME_ERROR_SIM_PUK_REQUIRED, 238 HFP_CME_ERROR_SIM_FAILURE, 239 HFP_CME_ERROR_SIM_BUSY, 240 HFP_CME_ERROR_15, 241 HFP_CME_ERROR_INCORRECT_PASSWORD, 242 HFP_CME_ERROR_SIM_PIN2_REQUIRED, 243 HFP_CME_ERROR_SIM_PUK2_REQUIRED, 244 HFP_CME_ERROR_19, 245 HFP_CME_ERROR_MEMORY_FULL, 246 HFP_CME_ERROR_INVALID_INDEX, 247 HFP_CME_ERROR_22, 248 HFP_CME_ERROR_MEMORY_FAILURE, 249 HFP_CME_ERROR_TEXT_STRING_TOO_LONG, 250 HFP_CME_ERROR_INVALID_CHARACTERS_IN_TEXT_STRING, 251 HFP_CME_ERROR_DIAL_STRING_TOO_LONG, 252 HFP_CME_ERROR_INVALID_CHARACTERS_IN_DIAL_STRING, 253 HFP_CME_ERROR_28, 254 HFP_CME_ERROR_29, 255 HFP_CME_ERROR_NO_NETWORK_SERVICE, 256 HFP_CME_ERROR_NETWORK_TIMEOUT, 257 HFP_CME_ERROR_NETWORK_NOT_ALLOWED_EMERGENCY_CALLS_ONLY 258 } hfp_cme_error_t; 259 260 typedef enum { 261 HFP_CALL_STATUS_NO_HELD_OR_ACTIVE_CALLS = 0, 262 HFP_CALL_STATUS_ACTIVE_OR_HELD_CALL_IS_PRESENT 263 } hfp_call_status_t; 264 265 typedef enum { 266 HFP_CALLSETUP_STATUS_NO_CALL_SETUP_IN_PROGRESS = 0, 267 HFP_CALLSETUP_STATUS_INCOMING_CALL_SETUP_IN_PROGRESS, 268 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_DIALING_STATE, 269 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_ALERTING_STATE 270 } hfp_callsetup_status_t; 271 272 typedef enum { 273 HFP_CALLHELD_STATUS_NO_CALLS_HELD = 0, 274 HFP_CALLHELD_STATUS_CALL_ON_HOLD_OR_SWAPPED, 275 HFP_CALLHELD_STATUS_CALL_ON_HOLD_AND_NO_ACTIVE_CALLS 276 } hfp_callheld_status_t; 277 278 279 typedef enum { 280 HFP_AG_INCOMING_CALL, 281 HFP_AG_INCOMING_CALL_ACCEPTED_BY_AG, 282 HFP_AG_INCOMING_CALL_ACCEPTED_BY_HF, 283 HFP_AG_AUDIO_CONNECTION_ESTABLISHED, 284 HFP_AG_OUTGOING_CALL_INITIATED_BY_AG, 285 HFP_AG_OUTGOING_CALL_INITIATED_BY_HF, 286 HFP_AG_OUTGOING_CALL_REJECTED, 287 HFP_AG_OUTGOING_CALL_ACCEPTED, 288 HFP_AG_OUTGOING_CALL_RINGING, 289 HFP_AG_OUTGOING_CALL_ESTABLISHED, 290 HFP_AG_OUTGOING_REDIAL_INITIATED, 291 HFP_AG_HELD_CALL_JOINED_BY_AG, 292 HFP_AG_TERMINATE_CALL_BY_AG, 293 HFP_AG_TERMINATE_CALL_BY_HF, 294 HFP_AG_CALL_DROPPED, 295 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_AG, 296 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_AG, 297 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_AG, 298 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_HF, 299 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_HF, 300 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_HF, 301 HFP_AG_CALL_HOLD_USER_BUSY, 302 HFP_AG_CALL_HOLD_RELEASE_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 303 HFP_AG_CALL_HOLD_PARK_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 304 HFP_AG_CALL_HOLD_ADD_HELD_CALL, 305 HFP_AG_CALL_HOLD_EXIT_AND_JOIN_CALLS, 306 HFP_AG_SET_CLIP 307 } hfp_ag_call_event_t; 308 309 310 typedef enum { 311 HFP_PARSER_CMD_HEADER = 0, 312 HFP_PARSER_CMD_SEQUENCE, 313 HFP_PARSER_SECOND_ITEM, 314 HFP_PARSER_THIRD_ITEM 315 } hfp_parser_state_t; 316 317 typedef enum { 318 HFP_VOICE_RECOGNITION_STATE_AG_READY = 0, 319 HFP_VOICE_RECOGNITION_STATE_AG_READY_TO_ACCEPT_AUDIO_INPUT = 1, 320 HFP_VOICE_RECOGNITION_STATE_AG_IS_STARTING_SOUND = 2, 321 HFP_VOICE_RECOGNITION_STATE_AG_IS_PROCESSING_AUDIO_INPUT = 4 322 } hfp_voice_recognition_state_t; 323 324 typedef enum { 325 HFP_TEXT_TYPE_RECOGNISED_FROM_HF_AUDIO = 0, 326 HFP_TEXT_TYPE_MESSAGE_FROM_AG, 327 HFP_TEXT_TYPE_QUESTION_FROM_AG, 328 HFP_TEXT_TYPE_ERROR_FROM_AG 329 } hfp_text_type_t; 330 331 typedef enum { 332 HFP_TEXT_OPERATION_NEW_TEXT = 1, 333 HFP_TEXT_OPERATION_REPLACE, 334 HFP_TEXT_OPERATION_APPEND 335 } hfp_text_operation_t; 336 337 typedef enum { 338 HFP_IDLE = 0, //0 339 HFP_SDP_QUERY_RFCOMM_CHANNEL, 340 HFP_W2_SEND_SDP_QUERY, 341 HFP_W4_SDP_QUERY_COMPLETE, 342 HFP_W4_RFCOMM_CONNECTED, 343 344 HFP_EXCHANGE_SUPPORTED_FEATURES, // 5 345 HFP_W4_EXCHANGE_SUPPORTED_FEATURES, 346 347 HFP_NOTIFY_ON_CODECS, 348 HFP_W4_NOTIFY_ON_CODECS, 349 350 HFP_RETRIEVE_INDICATORS, 351 HFP_W4_RETRIEVE_INDICATORS, // 10 352 353 HFP_RETRIEVE_INDICATORS_STATUS, 354 HFP_W4_RETRIEVE_INDICATORS_STATUS, 355 356 HFP_ENABLE_INDICATORS_STATUS_UPDATE, 357 HFP_W4_ENABLE_INDICATORS_STATUS_UPDATE, 358 359 HFP_RETRIEVE_CAN_HOLD_CALL, // 15 360 HFP_W4_RETRIEVE_CAN_HOLD_CALL, 361 362 HFP_LIST_GENERIC_STATUS_INDICATORS, 363 HFP_W4_LIST_GENERIC_STATUS_INDICATORS, 364 365 HFP_RETRIEVE_GENERIC_STATUS_INDICATORS, 366 HFP_W4_RETRIEVE_GENERIC_STATUS_INDICATORS, //20 367 368 HFP_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 369 HFP_W4_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 370 371 HFP_SERVICE_LEVEL_CONNECTION_ESTABLISHED, //23 372 373 HFP_W2_CONNECT_SCO, 374 HFP_W4_SCO_CONNECTED, 375 376 HFP_AUDIO_CONNECTION_ESTABLISHED, 377 378 379 HFP_W2_DISCONNECT_SCO, 380 HFP_W4_SCO_DISCONNECTED, 381 HFP_W4_SCO_DISCONNECTED_TO_SHUTDOWN, 382 HFP_W4_WBS_SHUTDOWN, 383 384 HFP_W2_DISCONNECT_RFCOMM, 385 HFP_W4_RFCOMM_DISCONNECTED, 386 HFP_W4_RFCOMM_DISCONNECTED_AND_RESTART, 387 HFP_W4_CONNECTION_ESTABLISHED_TO_SHUTDOWN 388 } hfp_state_t; 389 390 391 typedef enum { 392 // shared between normal voice recognition and enhanced one 393 HFP_VRA_VOICE_RECOGNITION_OFF, 394 395 HFP_VRA_W2_SEND_VOICE_RECOGNITION_OFF, 396 HFP_VRA_W4_VOICE_RECOGNITION_OFF, 397 398 HFP_VRA_W2_SEND_VOICE_RECOGNITION_ACTIVATED, 399 HFP_VRA_W4_VOICE_RECOGNITION_ACTIVATED, 400 HFP_VRA_VOICE_RECOGNITION_ACTIVATED, 401 402 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 403 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 404 HFP_VRA_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 405 406 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_STATUS, 407 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_MSG 408 } hfp_voice_recognition_activation_status_t; 409 410 typedef struct { 411 uint16_t text_id; 412 hfp_text_type_t text_type; 413 hfp_text_operation_t text_operation; 414 const char * text; 415 } hfp_voice_recognition_message_t; 416 417 typedef enum { 418 HFP_CODECS_IDLE, 419 HFP_CODECS_RECEIVED_LIST, 420 HFP_CODECS_RECEIVED_TRIGGER_CODEC_EXCHANGE, 421 HFP_CODECS_W4_AG_COMMON_CODEC, 422 HFP_CODECS_AG_SENT_COMMON_CODEC, 423 HFP_CODECS_AG_RESEND_COMMON_CODEC, 424 HFP_CODECS_HF_CONFIRMED_CODEC, 425 HFP_CODECS_EXCHANGED, 426 HFP_CODECS_ERROR 427 } hfp_codecs_state_t; 428 429 typedef enum { 430 HFP_CALL_IDLE, 431 HFP_CALL_TRIGGER_AUDIO_CONNECTION, 432 HFP_CALL_W4_AUDIO_CONNECTION_FOR_IN_BAND_RING, 433 HFP_CALL_RINGING, 434 HFP_CALL_W4_AUDIO_CONNECTION_FOR_ACTIVE, 435 HFP_CALL_ACTIVE, 436 HFP_CALL_W2_SEND_CALL_WAITING, 437 HFP_CALL_W4_CHLD, 438 HFP_CALL_OUTGOING_INITIATED, 439 HFP_CALL_OUTGOING_DIALING, 440 HFP_CALL_OUTGOING_RINGING 441 } hfp_call_state_t; 442 443 typedef enum{ 444 HFP_ENHANCED_CALL_DIR_OUTGOING, 445 HFP_ENHANCED_CALL_DIR_INCOMING 446 } hfp_enhanced_call_dir_t; 447 448 typedef enum{ 449 HFP_ENHANCED_CALL_STATUS_ACTIVE, 450 HFP_ENHANCED_CALL_STATUS_HELD, 451 HFP_ENHANCED_CALL_STATUS_OUTGOING_DIALING, 452 HFP_ENHANCED_CALL_STATUS_OUTGOING_ALERTING, 453 HFP_ENHANCED_CALL_STATUS_INCOMING, 454 HFP_ENHANCED_CALL_STATUS_INCOMING_WAITING, 455 HFP_ENHANCED_CALL_STATUS_CALL_HELD_BY_RESPONSE_AND_HOLD 456 } hfp_enhanced_call_status_t; 457 458 typedef enum{ 459 HFP_ENHANCED_CALL_MODE_VOICE, 460 HFP_ENHANCED_CALL_MODE_DATA, 461 HFP_ENHANCED_CALL_MODE_FAX 462 } hfp_enhanced_call_mode_t; 463 464 typedef enum{ 465 HFP_ENHANCED_CALL_MPTY_NOT_A_CONFERENCE_CALL, 466 HFP_ENHANCED_CALL_MPTY_CONFERENCE_CALL 467 } hfp_enhanced_call_mpty_t; 468 469 typedef enum { 470 HFP_RESPONSE_AND_HOLD_INCOMING_ON_HOLD = 0, 471 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_ACCEPTED, 472 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_REJECTED 473 } hfp_response_and_hold_state_t; 474 475 typedef enum { 476 HFP_HF_QUERY_OPERATOR_FORMAT_NOT_SET = 0, 477 HFP_HF_QUERY_OPERATOR_SET_FORMAT, 478 HFP_HF_QUERY_OPERATOR_W4_SET_FORMAT_OK, 479 HFP_HF_QUERY_OPERATOR_FORMAT_SET, 480 HFP_HF_QUERY_OPERATOR_SEND_QUERY, 481 HPF_HF_QUERY_OPERATOR_W4_RESULT 482 } hfp_hf_query_operator_state_t; 483 484 typedef enum { 485 HFP_LINK_SETTINGS_D0 = 0, 486 HFP_LINK_SETTINGS_D1, 487 HFP_LINK_SETTINGS_S1, 488 HFP_LINK_SETTINGS_S2, 489 HFP_LINK_SETTINGS_S3, 490 HFP_LINK_SETTINGS_S4, 491 HFP_LINK_SETTINGS_T1, 492 HFP_LINK_SETTINGS_T2, 493 HFP_LINK_SETTINGS_NONE, 494 } hfp_link_settings_t; 495 496 typedef enum{ 497 HFP_NONE_SM, 498 HFP_SLC_SM, 499 HFP_SLC_QUERIES_SM, 500 HFP_CODECS_CONNECTION_SM, 501 HFP_AUDIO_CONNECTION_SM, 502 HFP_CALL_SM 503 } hfp_state_machine_t; 504 505 typedef struct{ 506 uint16_t uuid; 507 uint8_t state; // enabled 508 } hfp_generic_status_indicator_t; 509 510 typedef struct{ 511 uint8_t index; 512 char name[HFP_MAX_INDICATOR_DESC_SIZE]; 513 uint8_t min_range; 514 uint8_t max_range; 515 uint8_t status; 516 uint8_t mandatory; 517 uint8_t enabled; 518 uint8_t status_changed; 519 } hfp_ag_indicator_t; 520 521 typedef struct{ 522 char name[HFP_CALL_SERVICE_SIZE]; 523 } hfp_call_service_t; 524 525 526 typedef struct{ 527 uint8_t mode; 528 uint8_t format; 529 char name[HFP_MAX_NETWORK_OPERATOR_NAME_SIZE]; // enabled 530 } hfp_network_opearator_t; 531 532 533 typedef struct hfp_connection { 534 btstack_linked_item_t item; 535 536 // local role: HF or AG 537 hfp_role_t local_role; 538 539 bd_addr_t remote_addr; 540 hci_con_handle_t acl_handle; 541 hci_con_handle_t sco_handle; 542 uint16_t rfcomm_channel_nr; 543 uint16_t rfcomm_cid; 544 545 hfp_state_machine_t state_machine; 546 hfp_call_state_t call_state; 547 hfp_state_t state; 548 hfp_codecs_state_t codecs_state; 549 550 // needed for reestablishing connection - service uuid of the remote 551 uint16_t service_uuid; 552 553 // used during service level connection establishment 554 hfp_command_t command; 555 hfp_parser_state_t parser_state; 556 int parser_item_index; 557 int parser_indicator_index; 558 uint32_t parser_indicator_value; 559 bool parser_quoted; 560 uint8_t line_buffer[HFP_MAX_VR_TEXT_SIZE]; 561 int line_size; 562 563 uint32_t remote_supported_features; 564 565 uint16_t remote_codecs_nr; 566 uint8_t remote_codecs[HFP_MAX_NUM_CODECS]; 567 568 uint16_t ag_indicators_nr; 569 hfp_ag_indicator_t ag_indicators[HFP_MAX_NUM_INDICATORS]; 570 uint32_t ag_indicators_status_update_bitmap; 571 uint8_t enable_status_update_for_ag_indicators; 572 573 uint16_t remote_call_services_index; 574 hfp_call_service_t remote_call_services[HFP_MAX_NUM_CALL_SERVICES]; 575 576 // TODO: use bitmap. 577 uint16_t generic_status_indicators_nr; 578 uint32_t generic_status_update_bitmap; 579 hfp_generic_status_indicator_t generic_status_indicators[HFP_MAX_NUM_INDICATORS]; 580 581 hfp_network_opearator_t network_operator; 582 583 // Retrieved during service level connection establishment, not used yet 584 uint8_t negotiated_codec; 585 586 // HF -> AG configuration 587 uint8_t clip_enabled; 588 uint8_t call_waiting_notification_enabled; 589 590 // TODO: put these bit flags in a bitmap 591 uint8_t ok_pending; 592 uint8_t send_error; 593 594 bool found_equal_sign; 595 uint8_t ignore_value; 596 597 uint8_t change_status_update_for_individual_ag_indicators; 598 uint8_t operator_name_changed; 599 600 uint8_t enable_extended_audio_gateway_error_report; 601 uint8_t extended_audio_gateway_error_value; 602 uint8_t extended_audio_gateway_error; 603 604 // establish codecs connection 605 uint8_t suggested_codec; 606 uint8_t codec_confirmed; 607 uint8_t sco_for_msbc_failed; 608 uint8_t trigger_codec_exchange; 609 610 // establish audio connection 611 hfp_link_settings_t link_setting; 612 uint8_t accept_sco; // 1 = SCO, 2 = eSCO 613 614 uint8_t establish_audio_connection; 615 uint8_t release_audio_connection; 616 uint8_t release_slc_connection; 617 618 btstack_timer_source_t hfp_timeout; 619 620 uint8_t microphone_gain; 621 uint8_t send_microphone_gain; 622 623 uint8_t speaker_gain; 624 uint8_t send_speaker_gain; 625 626 uint8_t send_phone_number_for_voice_tag; 627 uint8_t send_ag_status_indicators; 628 uint8_t send_ag_indicators_segment; 629 uint8_t send_response_and_hold_status; // 0 - don't send. BRTH:0 == 1, .. 630 631 // AG only 632 uint8_t change_in_band_ring_tone_setting; 633 uint8_t ag_ring; 634 uint8_t ag_send_clip; 635 uint8_t ag_echo_and_noise_reduction; 636 // used by AG: HFP parser stores here the activation value issued by HF 637 uint8_t ag_activate_voice_recognition_value; 638 bool ag_audio_connection_opened_before_vra; 639 640 uint8_t ag_notify_incoming_call_waiting; 641 uint8_t send_subscriber_number; 642 uint8_t next_subscriber_number_to_send; 643 uint8_t ag_call_hold_action; 644 uint8_t ag_response_and_hold_action; 645 uint8_t ag_dtmf_code; 646 bool ag_send_no_carrier; 647 648 int send_status_of_current_calls; 649 int next_call_index; 650 651 // HF only 652 // HF: track command for which ok/error response need to be received 653 hfp_command_t response_pending_for_command; 654 655 hfp_hf_query_operator_state_t hf_query_operator_state; 656 uint8_t hf_answer_incoming_call; 657 uint8_t hf_initiate_outgoing_call; 658 uint8_t hf_initiate_memory_dialing; 659 uint8_t hf_initiate_redial_last_number; 660 bool hf_send_codec_confirm; 661 bool hf_send_supported_codecs; 662 663 int memory_id; 664 665 uint8_t hf_send_clip_enable; 666 uint8_t hf_send_chup; 667 uint8_t hf_send_chld_0; 668 uint8_t hf_send_chld_1; 669 uint8_t hf_send_chld_2; 670 uint8_t hf_send_chld_3; 671 uint8_t hf_send_chld_4; 672 uint8_t hf_send_chld_x; 673 uint8_t hf_send_chld_x_index; 674 char hf_send_dtmf_code; 675 uint8_t hf_send_binp; 676 uint8_t hf_send_clcc; 677 uint8_t hf_send_rrh; 678 char hf_send_rrh_command; 679 uint8_t hf_send_cnum; 680 681 uint8_t hf_activate_call_waiting_notification; 682 uint8_t hf_deactivate_call_waiting_notification; 683 684 uint8_t hf_activate_calling_line_notification; 685 uint8_t hf_deactivate_calling_line_notification; 686 uint8_t hf_deactivate_echo_canceling_and_noise_reduction; 687 688 hfp_voice_recognition_activation_status_t vra_state; 689 hfp_voice_recognition_activation_status_t vra_state_requested; 690 bool deactivate_voice_recognition; 691 bool activate_voice_recognition; 692 bool enhanced_voice_recognition_enabled; 693 694 // ih HF, used by parser, in AG used for commands 695 uint8_t ag_vra_status; 696 hfp_voice_recognition_state_t ag_vra_state; 697 hfp_voice_recognition_message_t ag_msg; 698 uint16_t ag_vra_msg_length; 699 700 uint8_t clcc_idx; 701 uint8_t clcc_dir; 702 uint8_t clcc_status; 703 uint8_t clcc_mode; 704 uint8_t clcc_mpty; 705 706 uint8_t call_index; 707 // also used for CLCC, CCWA, CLIP if set 708 uint8_t bnip_type; // 0 == not set 709 char bnip_number[25]; // 710 711 #ifdef ENABLE_CC256X_ASSISTED_HFP 712 bool cc256x_send_write_codec_config; 713 bool cc256x_send_wbs_associate; 714 bool cc256x_send_wbs_disassociate; 715 #endif 716 #ifdef ENABLE_BCM_PCM_WBS 717 bool bcm_send_enable_wbs; 718 bool bcm_send_disable_wbs; 719 bool bcm_send_write_i2spcm_interface_param; 720 #endif 721 } hfp_connection_t; 722 723 // UTILS_START : TODO move to utils 724 int send_str_over_rfcomm(uint16_t cid, char * command); 725 int join(char * buffer, int buffer_size, uint8_t * values, int values_nr); 726 int join_bitmap(char * buffer, int buffer_size, uint32_t values, int values_nr); 727 int get_bit(uint16_t bitmap, int position); 728 int store_bit(uint32_t bitmap, int position, uint8_t value); 729 // UTILS_END 730 731 void hfp_finalize_connection_context(hfp_connection_t * hfp_connection); 732 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); 733 734 void hfp_set_ag_callback(btstack_packet_handler_t callback); 735 void hfp_set_ag_rfcomm_packet_handler(btstack_packet_handler_t handler); 736 737 void hfp_set_hf_callback(btstack_packet_handler_t callback); 738 void hfp_set_hf_rfcomm_packet_handler(btstack_packet_handler_t handler); 739 740 void hfp_init(void); 741 void hfp_deinit(void); 742 743 void hfp_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t service_uuid, int rfcomm_channel_nr, const char * name); 744 void hfp_handle_hci_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 745 void hfp_handle_rfcomm_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 746 void hfp_emit_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, uint8_t value); 747 void hfp_emit_simple_event(hfp_connection_t * hfp_connection, uint8_t event_subtype); 748 void hfp_emit_string_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, const char * value); 749 void hfp_emit_slc_connection_event(hfp_connection_t * hfp_connection, uint8_t status, hci_con_handle_t con_handle, bd_addr_t addr); 750 751 /** 752 * @brief Emit HFP_SUBEVENT_VOICE_RECOGNITION_STATUS event 753 * @param hfp_connection 754 * @param status ERROR_CODE_SUCCESS if successful, otherwise ERROR_CODE_COMMAND_DISALLOWED 755 * @param state 0 if deactivated, 1 if activated 756 */ 757 void hfp_emit_voice_recognition_state_event(hfp_connection_t * hfp_connection, uint8_t status); 758 void hfp_emit_enhanced_voice_recognition_hf_ready_for_audio_event(hfp_connection_t * hfp_connection, uint8_t status); 759 void hfp_emit_enhanced_voice_recognition_state_event(hfp_connection_t * hfp_connection, uint8_t status); 760 761 hfp_connection_t * get_hfp_connection_context_for_rfcomm_cid(uint16_t cid); 762 hfp_connection_t * get_hfp_connection_context_for_bd_addr(bd_addr_t bd_addr, hfp_role_t hfp_role); 763 hfp_connection_t * get_hfp_connection_context_for_sco_handle(uint16_t handle, hfp_role_t hfp_role); 764 hfp_connection_t * get_hfp_connection_context_for_acl_handle(uint16_t handle, hfp_role_t hfp_role); 765 766 btstack_linked_list_t * hfp_get_connections(void); 767 void hfp_parse(hfp_connection_t * connection, uint8_t byte, int isHandsFree); 768 769 /** 770 * @brief Establish RFCOMM connection, and perform service level connection agreement: 771 * @param bd_addr 772 * @param service_uuid 773 * @param local_role 774 * @return status ERROR_CODE_SUCCESS if successful, otherwise: 775 * - ERROR_CODE_COMMAND_DISALLOWED if connection already exists, or 776 * - BTSTACK_MEMORY_ALLOC_FAILED 777 */ 778 uint8_t hfp_establish_service_level_connection(bd_addr_t bd_addr, uint16_t service_uuid, hfp_role_t local_role); 779 780 /** 781 * @brief Prepare connection for audio and SLC connections release 782 * @param hfp_connection 783 */ 784 void hfp_trigger_release_service_level_connection(hfp_connection_t * hfp_connection); 785 786 /** 787 * @brief Prepare connection for audio connection release 788 * @param hfp_connection 789 */ 790 uint8_t hfp_trigger_release_audio_connection(hfp_connection_t * hfp_connection); 791 792 void hfp_reset_context_flags(hfp_connection_t * hfp_connection); 793 794 void hfp_setup_synchronous_connection(hfp_connection_t * hfp_connection); 795 void hfp_accept_synchronous_connection(hfp_connection_t * hfp_connection, bool incoming_eSCO); 796 int hfp_supports_codec(uint8_t codec, int codecs_nr, uint8_t * codecs); 797 void hfp_hf_drop_mSBC_if_eSCO_not_supported(uint8_t * codecs, uint8_t * codecs_nr); 798 void hfp_init_link_settings(hfp_connection_t * hfp_connection, uint8_t eSCO_S4_supported); 799 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); 800 801 const char * hfp_hf_feature(int index); 802 const char * hfp_ag_feature(int index); 803 804 void hfp_log_rfcomm_message(const char * tag, uint8_t * packet, uint16_t size); 805 806 const char * hfp_enhanced_call_dir2str(uint16_t index); 807 const char * hfp_enhanced_call_status2str(uint16_t index); 808 const char * hfp_enhanced_call_mode2str(uint16_t index); 809 const char * hfp_enhanced_call_mpty2str(uint16_t index); 810 811 #ifdef ENABLE_CC256X_ASSISTED_HFP 812 void hfp_cc256x_prepare_for_sco(hfp_connection_t * hfp_connection); 813 void hfp_cc256x_write_codec_config(hfp_connection_t * hfp_connection); 814 #endif 815 #ifdef ENABLE_BCM_PCM_WBS 816 void hfp_bcm_prepare_for_sco(hfp_connection_t * hfp_connection); 817 void hfp_bcm_write_i2spcm_interface_param (hfp_connection_t * hfp_connection); 818 #endif 819 820 /** 821 * @brief Set packet types for SCO connections 822 * @param common single packet_types: HFP_SCO_PACKET_TYPES_* 823 */ 824 void hfp_set_sco_packet_types(uint16_t packet_types); 825 826 /** 827 * @brief Get packet types for SCO connections 828 * @returns packet_types 829 */ 830 uint16_t hfp_get_sco_packet_types(void); 831 832 #if defined __cplusplus 833 } 834 #endif 835 836 #endif // BTSTACK_HFP_H 837