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 #define HFP_OK "OK" 162 #define HFP_ERROR "ERROR" 163 #define HFP_RING "RING" 164 165 // Codecs 166 #define HFP_CODEC_CVSD 0x01 167 #define HFP_CODEC_MSBC 0x02 168 #define HFP_CODEC_LC3_SWB 0x03 169 170 typedef enum { 171 HFP_ROLE_INVALID = 0, 172 HFP_ROLE_AG, 173 HFP_ROLE_HF, 174 } hfp_role_t; 175 176 typedef enum { 177 HFP_CMD_NONE = 0, 178 HFP_CMD_ERROR, 179 HFP_CMD_UNKNOWN, 180 HFP_CMD_OK, 181 HFP_CMD_RING, 182 HFP_CMD_SUPPORTED_FEATURES, // 5 183 HFP_CMD_AVAILABLE_CODECS, 184 HFP_CMD_RETRIEVE_AG_INDICATORS_GENERIC, 185 HFP_CMD_RETRIEVE_AG_INDICATORS, 186 HFP_CMD_RETRIEVE_AG_INDICATORS_STATUS, 187 HFP_CMD_ENABLE_INDICATOR_STATUS_UPDATE, // 10 188 HFP_CMD_ENABLE_INDIVIDUAL_AG_INDICATOR_STATUS_UPDATE, 189 HFP_CMD_SUPPORT_CALL_HOLD_AND_MULTIPARTY_SERVICES, 190 HFP_CMD_ENABLE_CLIP, 191 HFP_CMD_AG_SENT_CLIP_INFORMATION, 192 HFP_CMD_ENABLE_CALL_WAITING_NOTIFICATION, // 15 193 HFP_CMD_AG_SENT_CALL_WAITING_NOTIFICATION_UPDATE, 194 HFP_CMD_LIST_GENERIC_STATUS_INDICATORS, 195 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS, 196 HFP_CMD_RETRIEVE_GENERIC_STATUS_INDICATORS_STATE, 197 HFP_CMD_SET_GENERIC_STATUS_INDICATOR_STATUS, // 20 198 HFP_CMD_TRANSFER_AG_INDICATOR_STATUS, 199 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME, 200 HFP_CMD_QUERY_OPERATOR_SELECTION_NAME_FORMAT, 201 HFP_CMD_ENABLE_EXTENDED_AUDIO_GATEWAY_ERROR, 202 HFP_CMD_EXTENDED_AUDIO_GATEWAY_ERROR, // 25 203 HFP_CMD_TRIGGER_CODEC_CONNECTION_SETUP, 204 HFP_CMD_AG_SEND_COMMON_CODEC, 205 HFP_CMD_AG_SUGGESTED_CODEC, 206 HFP_CMD_HF_CONFIRMED_CODEC, 207 HFP_CMD_CALL_ANSWERED, // 30 208 HFP_CMD_CALL_HOLD, 209 HFP_CMD_HANG_UP_CALL, 210 HFP_CMD_CHANGE_IN_BAND_RING_TONE_SETTING, 211 HFP_CMD_CALL_PHONE_NUMBER, 212 HFP_CMD_REDIAL_LAST_NUMBER, // 35 213 HFP_CMD_TURN_OFF_EC_AND_NR, 214 HFP_CMD_AG_ACTIVATE_VOICE_RECOGNITION, // 37 215 HFP_CMD_HF_ACTIVATE_VOICE_RECOGNITION, 216 HFP_CMD_HF_REQUEST_PHONE_NUMBER, 217 HFP_CMD_AG_SENT_PHONE_NUMBER, 218 HFP_CMD_TRANSMIT_DTMF_CODES, 219 HFP_CMD_SET_MICROPHONE_GAIN, 220 HFP_CMD_SET_SPEAKER_GAIN, 221 HFP_CMD_GET_SUBSCRIBER_NUMBER_INFORMATION, 222 HFP_CMD_LIST_CURRENT_CALLS, 223 HFP_CMD_RESPONSE_AND_HOLD_QUERY, 224 HFP_CMD_RESPONSE_AND_HOLD_COMMAND, 225 HFP_CMD_RESPONSE_AND_HOLD_STATUS, 226 HFP_CMD_HF_INDICATOR_STATUS, 227 HFP_CMD_CUSTOM_MESSAGE 228 } hfp_command_t; 229 230 231 typedef enum { 232 HFP_CME_ERROR_AG_FAILURE = 0, 233 HFP_CME_ERROR_NO_CONNECTION_TO_PHONE, 234 HFP_CME_ERROR_2, 235 HFP_CME_ERROR_OPERATION_NOT_ALLOWED, 236 HFP_CME_ERROR_OPERATION_NOT_SUPPORTED, 237 HFP_CME_ERROR_PH_SIM_PIN_REQUIRED, 238 HFP_CME_ERROR_6, 239 HFP_CME_ERROR_7, 240 HFP_CME_ERROR_8, 241 HFP_CME_ERROR_9, 242 HFP_CME_ERROR_SIM_NOT_INSERTED, 243 HFP_CME_ERROR_SIM_PIN_REQUIRED, 244 HFP_CME_ERROR_SIM_PUK_REQUIRED, 245 HFP_CME_ERROR_SIM_FAILURE, 246 HFP_CME_ERROR_SIM_BUSY, 247 HFP_CME_ERROR_15, 248 HFP_CME_ERROR_INCORRECT_PASSWORD, 249 HFP_CME_ERROR_SIM_PIN2_REQUIRED, 250 HFP_CME_ERROR_SIM_PUK2_REQUIRED, 251 HFP_CME_ERROR_19, 252 HFP_CME_ERROR_MEMORY_FULL, 253 HFP_CME_ERROR_INVALID_INDEX, 254 HFP_CME_ERROR_22, 255 HFP_CME_ERROR_MEMORY_FAILURE, 256 HFP_CME_ERROR_TEXT_STRING_TOO_LONG, 257 HFP_CME_ERROR_INVALID_CHARACTERS_IN_TEXT_STRING, 258 HFP_CME_ERROR_DIAL_STRING_TOO_LONG, 259 HFP_CME_ERROR_INVALID_CHARACTERS_IN_DIAL_STRING, 260 HFP_CME_ERROR_28, 261 HFP_CME_ERROR_29, 262 HFP_CME_ERROR_NO_NETWORK_SERVICE, 263 HFP_CME_ERROR_NETWORK_TIMEOUT, 264 HFP_CME_ERROR_NETWORK_NOT_ALLOWED_EMERGENCY_CALLS_ONLY 265 } hfp_cme_error_t; 266 267 typedef enum { 268 HFP_CALL_STATUS_NO_HELD_OR_ACTIVE_CALLS = 0, 269 HFP_CALL_STATUS_ACTIVE_OR_HELD_CALL_IS_PRESENT 270 } hfp_call_status_t; 271 272 typedef enum { 273 HFP_CALLSETUP_STATUS_NO_CALL_SETUP_IN_PROGRESS = 0, 274 HFP_CALLSETUP_STATUS_INCOMING_CALL_SETUP_IN_PROGRESS, 275 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_DIALING_STATE, 276 HFP_CALLSETUP_STATUS_OUTGOING_CALL_SETUP_IN_ALERTING_STATE 277 } hfp_callsetup_status_t; 278 279 typedef enum { 280 HFP_CALLHELD_STATUS_NO_CALLS_HELD = 0, 281 HFP_CALLHELD_STATUS_CALL_ON_HOLD_OR_SWAPPED, 282 HFP_CALLHELD_STATUS_CALL_ON_HOLD_AND_NO_ACTIVE_CALLS 283 } hfp_callheld_status_t; 284 285 286 typedef enum { 287 HFP_AG_INCOMING_CALL, 288 HFP_AG_INCOMING_CALL_ACCEPTED_BY_AG, 289 HFP_AG_INCOMING_CALL_ACCEPTED_BY_HF, 290 HFP_AG_AUDIO_CONNECTION_ESTABLISHED, 291 HFP_AG_OUTGOING_CALL_INITIATED_BY_AG, 292 HFP_AG_OUTGOING_CALL_INITIATED_BY_HF, 293 HFP_AG_OUTGOING_CALL_REJECTED, 294 HFP_AG_OUTGOING_CALL_ACCEPTED, 295 HFP_AG_OUTGOING_CALL_RINGING, 296 HFP_AG_OUTGOING_CALL_ESTABLISHED, 297 HFP_AG_OUTGOING_REDIAL_INITIATED, 298 HFP_AG_HELD_CALL_JOINED_BY_AG, 299 HFP_AG_TERMINATE_CALL_BY_AG, 300 HFP_AG_TERMINATE_CALL_BY_HF, 301 HFP_AG_CALL_DROPPED, 302 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_AG, 303 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_AG, 304 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_AG, 305 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_INCOMING_CALL_BY_HF, 306 HFP_AG_RESPONSE_AND_HOLD_ACCEPT_HELD_CALL_BY_HF, 307 HFP_AG_RESPONSE_AND_HOLD_REJECT_HELD_CALL_BY_HF, 308 HFP_AG_CALL_HOLD_USER_BUSY, 309 HFP_AG_CALL_HOLD_RELEASE_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 310 HFP_AG_CALL_HOLD_PARK_ACTIVE_ACCEPT_HELD_OR_WAITING_CALL, 311 HFP_AG_CALL_HOLD_ADD_HELD_CALL, 312 HFP_AG_CALL_HOLD_EXIT_AND_JOIN_CALLS, 313 HFP_AG_SET_CLIP 314 } hfp_ag_call_event_t; 315 316 317 typedef enum { 318 HFP_PARSER_CMD_HEADER = 0, 319 HFP_PARSER_CMD_SEQUENCE, 320 HFP_PARSER_SECOND_ITEM, 321 HFP_PARSER_THIRD_ITEM, 322 HFP_PARSER_CUSTOM_COMMAND 323 } hfp_parser_state_t; 324 325 typedef enum { 326 HFP_VOICE_RECOGNITION_STATE_AG_READY = 0, 327 HFP_VOICE_RECOGNITION_STATE_AG_READY_TO_ACCEPT_AUDIO_INPUT = 1, 328 HFP_VOICE_RECOGNITION_STATE_AG_IS_STARTING_SOUND = 2, 329 HFP_VOICE_RECOGNITION_STATE_AG_IS_PROCESSING_AUDIO_INPUT = 4 330 } hfp_voice_recognition_state_t; 331 332 typedef enum { 333 HFP_TEXT_TYPE_RECOGNISED_FROM_HF_AUDIO = 0, 334 HFP_TEXT_TYPE_MESSAGE_FROM_AG, 335 HFP_TEXT_TYPE_QUESTION_FROM_AG, 336 HFP_TEXT_TYPE_ERROR_FROM_AG 337 } hfp_text_type_t; 338 339 typedef enum { 340 HFP_TEXT_OPERATION_NEW_TEXT = 1, 341 HFP_TEXT_OPERATION_REPLACE, 342 HFP_TEXT_OPERATION_APPEND 343 } hfp_text_operation_t; 344 345 typedef enum { 346 HFP_IDLE = 0, //0 347 HFP_SDP_QUERY_RFCOMM_CHANNEL, 348 HFP_W2_SEND_SDP_QUERY, 349 HFP_W4_SDP_QUERY_COMPLETE, 350 HFP_W4_RFCOMM_CONNECTED, 351 352 HFP_EXCHANGE_SUPPORTED_FEATURES, // 5 353 HFP_W4_EXCHANGE_SUPPORTED_FEATURES, 354 355 HFP_NOTIFY_ON_CODECS, 356 HFP_W4_NOTIFY_ON_CODECS, 357 358 HFP_RETRIEVE_INDICATORS, 359 HFP_W4_RETRIEVE_INDICATORS, // 10 360 361 HFP_RETRIEVE_INDICATORS_STATUS, 362 HFP_W4_RETRIEVE_INDICATORS_STATUS, 363 364 HFP_ENABLE_INDICATORS_STATUS_UPDATE, 365 HFP_W4_ENABLE_INDICATORS_STATUS_UPDATE, 366 367 HFP_RETRIEVE_CAN_HOLD_CALL, // 15 368 HFP_W4_RETRIEVE_CAN_HOLD_CALL, 369 370 HFP_LIST_GENERIC_STATUS_INDICATORS, 371 HFP_W4_LIST_GENERIC_STATUS_INDICATORS, 372 373 HFP_RETRIEVE_GENERIC_STATUS_INDICATORS, 374 HFP_W4_RETRIEVE_GENERIC_STATUS_INDICATORS, //20 375 376 HFP_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 377 HFP_W4_RETRIEVE_INITITAL_STATE_GENERIC_STATUS_INDICATORS, 378 379 HFP_SERVICE_LEVEL_CONNECTION_ESTABLISHED, //23 380 381 HFP_W2_CONNECT_SCO, 382 HFP_W4_SCO_CONNECTED, 383 384 HFP_AUDIO_CONNECTION_ESTABLISHED, 385 386 387 HFP_W2_DISCONNECT_SCO, 388 HFP_W4_SCO_DISCONNECTED, 389 HFP_W4_SCO_DISCONNECTED_TO_SHUTDOWN, 390 HFP_W4_WBS_SHUTDOWN, 391 392 HFP_W2_DISCONNECT_RFCOMM, 393 HFP_W4_RFCOMM_DISCONNECTED, 394 HFP_W4_RFCOMM_DISCONNECTED_AND_RESTART, 395 HFP_W4_CONNECTION_ESTABLISHED_TO_SHUTDOWN 396 } hfp_state_t; 397 398 399 typedef enum { 400 // shared between normal voice recognition and enhanced one 401 HFP_VRA_VOICE_RECOGNITION_OFF, 402 403 HFP_VRA_W2_SEND_VOICE_RECOGNITION_OFF, 404 HFP_VRA_W4_VOICE_RECOGNITION_OFF, 405 406 HFP_VRA_W2_SEND_VOICE_RECOGNITION_ACTIVATED, 407 HFP_VRA_W4_VOICE_RECOGNITION_ACTIVATED, 408 HFP_VRA_VOICE_RECOGNITION_ACTIVATED, 409 410 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 411 HFP_VRA_W4_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 412 HFP_VRA_ENHANCED_VOICE_RECOGNITION_READY_FOR_AUDIO, 413 414 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_STATUS, 415 HFP_VRA_W2_SEND_ENHANCED_VOICE_RECOGNITION_MSG 416 } hfp_voice_recognition_activation_status_t; 417 418 typedef struct { 419 uint16_t text_id; 420 hfp_text_type_t text_type; 421 hfp_text_operation_t text_operation; 422 const char * text; 423 } hfp_voice_recognition_message_t; 424 425 typedef enum { 426 HFP_CODECS_IDLE, 427 HFP_CODECS_RECEIVED_LIST, 428 HFP_CODECS_RECEIVED_TRIGGER_CODEC_EXCHANGE, 429 HFP_CODECS_W4_AG_COMMON_CODEC, 430 HFP_CODECS_AG_SENT_COMMON_CODEC, 431 HFP_CODECS_AG_RESEND_COMMON_CODEC, 432 HFP_CODECS_HF_CONFIRMED_CODEC, 433 HFP_CODECS_EXCHANGED, 434 HFP_CODECS_ERROR 435 } hfp_codecs_state_t; 436 437 typedef enum { 438 HFP_CALL_IDLE, 439 HFP_CALL_TRIGGER_AUDIO_CONNECTION, 440 HFP_CALL_W4_AUDIO_CONNECTION_FOR_IN_BAND_RING, 441 HFP_CALL_INCOMING_RINGING, 442 HFP_CALL_W4_AUDIO_CONNECTION_FOR_ACTIVE, 443 HFP_CALL_ACTIVE, 444 HFP_CALL_W2_SEND_CALL_WAITING, 445 HFP_CALL_W4_CHLD, 446 HFP_CALL_OUTGOING_INITIATED, 447 HFP_CALL_OUTGOING_DIALING, 448 HFP_CALL_OUTGOING_RINGING 449 } hfp_call_state_t; 450 451 typedef enum{ 452 HFP_ENHANCED_CALL_DIR_OUTGOING, 453 HFP_ENHANCED_CALL_DIR_INCOMING 454 } hfp_enhanced_call_dir_t; 455 456 typedef enum{ 457 HFP_ENHANCED_CALL_STATUS_ACTIVE, 458 HFP_ENHANCED_CALL_STATUS_HELD, 459 HFP_ENHANCED_CALL_STATUS_OUTGOING_DIALING, 460 HFP_ENHANCED_CALL_STATUS_OUTGOING_ALERTING, 461 HFP_ENHANCED_CALL_STATUS_INCOMING, 462 HFP_ENHANCED_CALL_STATUS_INCOMING_WAITING, 463 HFP_ENHANCED_CALL_STATUS_CALL_HELD_BY_RESPONSE_AND_HOLD 464 } hfp_enhanced_call_status_t; 465 466 typedef enum{ 467 HFP_ENHANCED_CALL_MODE_VOICE, 468 HFP_ENHANCED_CALL_MODE_DATA, 469 HFP_ENHANCED_CALL_MODE_FAX 470 } hfp_enhanced_call_mode_t; 471 472 typedef enum{ 473 HFP_ENHANCED_CALL_MPTY_NOT_A_CONFERENCE_CALL, 474 HFP_ENHANCED_CALL_MPTY_CONFERENCE_CALL 475 } hfp_enhanced_call_mpty_t; 476 477 typedef enum { 478 HFP_RESPONSE_AND_HOLD_INCOMING_ON_HOLD = 0, 479 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_ACCEPTED, 480 HFP_RESPONSE_AND_HOLD_HELD_INCOMING_REJECTED 481 } hfp_response_and_hold_state_t; 482 483 typedef enum { 484 HFP_HF_QUERY_OPERATOR_FORMAT_NOT_SET = 0, 485 HFP_HF_QUERY_OPERATOR_SET_FORMAT, 486 HFP_HF_QUERY_OPERATOR_W4_SET_FORMAT_OK, 487 HFP_HF_QUERY_OPERATOR_FORMAT_SET, 488 HFP_HF_QUERY_OPERATOR_SEND_QUERY, 489 HPF_HF_QUERY_OPERATOR_W4_RESULT 490 } hfp_hf_query_operator_state_t; 491 492 typedef enum { 493 HFP_LINK_SETTINGS_D0 = 0, 494 HFP_LINK_SETTINGS_D1, 495 HFP_LINK_SETTINGS_S1, 496 HFP_LINK_SETTINGS_S2, 497 HFP_LINK_SETTINGS_S3, 498 HFP_LINK_SETTINGS_S4, 499 HFP_LINK_SETTINGS_T1, 500 HFP_LINK_SETTINGS_T2, 501 HFP_LINK_SETTINGS_NONE, 502 } hfp_link_settings_t; 503 504 typedef enum{ 505 HFP_NONE_SM, 506 HFP_SLC_SM, 507 HFP_SLC_QUERIES_SM, 508 HFP_CODECS_CONNECTION_SM, 509 HFP_AUDIO_CONNECTION_SM, 510 HFP_CALL_SM 511 } hfp_state_machine_t; 512 513 typedef struct{ 514 uint16_t uuid; 515 uint8_t state; // enabled 516 } hfp_generic_status_indicator_t; 517 518 typedef struct{ 519 uint8_t index; 520 char name[HFP_MAX_INDICATOR_DESC_SIZE]; 521 uint8_t min_range; 522 uint8_t max_range; 523 uint8_t status; 524 uint8_t mandatory; 525 uint8_t enabled; 526 uint8_t status_changed; 527 } hfp_ag_indicator_t; 528 529 typedef struct{ 530 char name[HFP_CALL_SERVICE_SIZE]; 531 } hfp_call_service_t; 532 533 534 typedef struct{ 535 uint8_t mode; 536 uint8_t format; 537 char name[HFP_MAX_NETWORK_OPERATOR_NAME_SIZE]; // enabled 538 } hfp_network_opearator_t; 539 540 541 typedef struct hfp_connection { 542 btstack_linked_item_t item; 543 544 // local role: HF or AG 545 hfp_role_t local_role; 546 547 bd_addr_t remote_addr; 548 hci_con_handle_t acl_handle; 549 hci_con_handle_t sco_handle; 550 uint16_t packet_types; 551 uint8_t rfcomm_channel_nr; 552 uint16_t rfcomm_cid; 553 uint16_t rfcomm_mtu; 554 555 hfp_state_machine_t state_machine; 556 hfp_call_state_t call_state; 557 hfp_state_t state; 558 hfp_codecs_state_t codecs_state; 559 560 // needed for reestablishing connection - service uuid of the remote 561 uint16_t service_uuid; 562 563 // used during service level connection establishment 564 hfp_command_t command; 565 hfp_parser_state_t parser_state; 566 int parser_item_index; 567 int parser_indicator_index; 568 uint32_t parser_indicator_value; 569 bool parser_quoted; 570 571 // line buffer is always \0 terminated 572 uint8_t line_buffer[HFP_MAX_VR_TEXT_SIZE]; 573 int line_size; 574 575 uint32_t remote_supported_features; 576 577 uint16_t remote_codecs_nr; 578 uint8_t remote_codecs[HFP_MAX_NUM_CODECS]; 579 580 uint16_t ag_indicators_nr; 581 hfp_ag_indicator_t ag_indicators[HFP_MAX_NUM_INDICATORS]; 582 uint32_t ag_indicators_status_update_bitmap; 583 uint8_t enable_status_update_for_ag_indicators; 584 585 uint16_t remote_call_services_index; 586 hfp_call_service_t remote_call_services[HFP_MAX_NUM_CALL_SERVICES]; 587 588 // TODO: use bitmap. 589 uint16_t generic_status_indicators_nr; 590 uint32_t generic_status_update_bitmap; 591 hfp_generic_status_indicator_t generic_status_indicators[HFP_MAX_NUM_INDICATORS]; 592 593 hfp_network_opearator_t network_operator; 594 595 // Retrieved during service level connection establishment, not used yet 596 uint8_t negotiated_codec; 597 598 // HF -> AG configuration 599 uint8_t clip_enabled; 600 uint8_t call_waiting_notification_enabled; 601 602 // TODO: put these bit flags in a bitmap 603 uint8_t ok_pending; 604 uint8_t send_error; 605 606 bool found_equal_sign; 607 uint8_t ignore_value; 608 609 uint8_t change_status_update_for_individual_ag_indicators; 610 uint8_t operator_name_changed; 611 612 uint8_t enable_extended_audio_gateway_error_report; 613 uint8_t extended_audio_gateway_error_value; 614 uint8_t extended_audio_gateway_error; 615 616 // establish codecs connection 617 uint8_t suggested_codec; 618 uint8_t codec_confirmed; 619 uint8_t sco_for_msbc_failed; 620 uint8_t trigger_codec_exchange; 621 622 // establish audio connection 623 hfp_link_settings_t link_setting; 624 uint8_t accept_sco; // 1 = SCO, 2 = eSCO 625 626 uint8_t establish_audio_connection; 627 uint8_t release_audio_connection; 628 uint8_t release_slc_connection; 629 630 uint8_t microphone_gain; 631 uint8_t send_microphone_gain; 632 633 uint8_t speaker_gain; 634 uint8_t send_speaker_gain; 635 636 uint8_t send_phone_number_for_voice_tag; 637 uint8_t send_ag_status_indicators; 638 uint8_t send_ag_indicators_segment; 639 uint8_t send_response_and_hold_status; // 0 - don't send. BRTH:0 == 1, .. 640 641 // HF: AT Command, AG: Unsolicited Result Code 642 const char * send_custom_message; 643 644 // HF: Unsolicited Result Code, AG: AT Command 645 uint16_t custom_at_command_id; 646 647 bool emit_vra_enabled_after_audio_established; 648 // AG only 649 uint8_t change_in_band_ring_tone_setting; 650 uint8_t ag_ring; 651 uint8_t ag_send_clip; 652 uint8_t ag_echo_and_noise_reduction; 653 // used by AG: HFP parser stores here the activation value issued by HF 654 uint8_t ag_activate_voice_recognition_value; 655 bool ag_audio_connection_opened_before_vra; 656 657 uint8_t ag_notify_incoming_call_waiting; 658 uint8_t send_subscriber_number; 659 uint8_t next_subscriber_number_to_send; 660 uint8_t ag_call_hold_action; 661 uint8_t ag_response_and_hold_action; 662 uint8_t ag_dtmf_code; 663 bool ag_in_band_ring_tone_active; 664 bool ag_send_no_carrier; 665 bool ag_vra_send_command; 666 bool ag_send_in_band_ring_tone_setting; 667 bool ag_send_common_codec; 668 bool ag_vra_requested_by_hf; 669 670 int send_status_of_current_calls; 671 int next_call_index; 672 673 // HF only 674 // HF: track command for which ok/error response need to be received 675 hfp_command_t response_pending_for_command; 676 677 hfp_hf_query_operator_state_t hf_query_operator_state; 678 uint8_t hf_answer_incoming_call; 679 uint8_t hf_initiate_outgoing_call; 680 uint8_t hf_initiate_memory_dialing; 681 uint8_t hf_initiate_redial_last_number; 682 bool hf_send_codec_confirm; 683 bool hf_send_supported_codecs; 684 685 int memory_id; 686 687 uint8_t hf_send_clip_enable; 688 uint8_t hf_send_chup; 689 uint8_t hf_send_chld_0; 690 uint8_t hf_send_chld_1; 691 uint8_t hf_send_chld_2; 692 uint8_t hf_send_chld_3; 693 uint8_t hf_send_chld_4; 694 uint8_t hf_send_chld_x; 695 uint8_t hf_send_chld_x_index; 696 char hf_send_dtmf_code; 697 uint8_t hf_send_binp; 698 uint8_t hf_send_clcc; 699 uint8_t hf_send_rrh; 700 char hf_send_rrh_command; 701 uint8_t hf_send_cnum; 702 703 uint8_t hf_activate_call_waiting_notification; 704 uint8_t hf_deactivate_call_waiting_notification; 705 706 uint8_t hf_activate_calling_line_notification; 707 uint8_t hf_deactivate_calling_line_notification; 708 uint8_t hf_deactivate_echo_canceling_and_noise_reduction; 709 710 hfp_call_status_t hf_call_status; 711 hfp_callsetup_status_t hf_callsetup_status; 712 hfp_callheld_status_t hf_callheld_status; 713 714 hfp_voice_recognition_activation_status_t vra_state; 715 hfp_voice_recognition_activation_status_t vra_state_requested; 716 bool deactivate_voice_recognition; 717 bool activate_voice_recognition; 718 bool enhanced_voice_recognition_enabled; 719 720 // ih HF, used by parser, in AG used for commands 721 uint8_t ag_vra_status; 722 hfp_voice_recognition_state_t ag_vra_state; 723 hfp_voice_recognition_message_t ag_msg; 724 uint16_t ag_vra_msg_length; 725 726 uint8_t clcc_idx; 727 uint8_t clcc_dir; 728 uint8_t clcc_status; 729 uint8_t clcc_mode; 730 uint8_t clcc_mpty; 731 732 uint8_t call_index; 733 // also used for CLCC, CCWA, CLIP if set 734 uint8_t bnip_type; // 0 == not set 735 char bnip_number[HFP_BNEP_NUM_MAX_SIZE]; // 736 bool clip_have_alpha; 737 738 #ifdef ENABLE_CC256X_ASSISTED_HFP 739 bool cc256x_send_write_codec_config; 740 bool cc256x_send_wbs_associate; 741 bool cc256x_send_wbs_disassociate; 742 #endif 743 #ifdef ENABLE_BCM_PCM_WBS 744 bool bcm_send_enable_wbs; 745 bool bcm_send_disable_wbs; 746 bool bcm_send_write_i2spcm_interface_param; 747 #endif 748 #ifdef ENABLE_RTK_PCM_WBS 749 bool rtk_send_sco_config; 750 #endif 751 #ifdef ENABLE_NXP_PCM_WBS 752 hci_con_handle_t nxp_start_audio_handle; 753 hci_con_handle_t nxp_stop_audio_handle; 754 #endif 755 } hfp_connection_t; 756 757 /** 758 * @brief Struct to register custom AT Command. 759 */ 760 typedef struct { 761 btstack_linked_item_t * next; 762 const char * command; 763 uint16_t command_id; 764 } hfp_custom_at_command_t; 765 766 // UTILS_START : TODO move to utils 767 int send_str_over_rfcomm(uint16_t cid, const char * command); 768 int join(char * buffer, int buffer_size, uint8_t * values, int values_nr); 769 int join_bitmap(char * buffer, int buffer_size, uint32_t values, int values_nr); 770 int get_bit(uint16_t bitmap, int position); 771 int store_bit(uint32_t bitmap, int position, uint8_t value); 772 // UTILS_END 773 774 #define HFP_H2_SYNC_FRAME_SIZE 60 775 // HFP H2 Synchronization 776 typedef struct { 777 // callback returns true if data was valid 778 bool (*callback)(bool bad_frame, const uint8_t * frame_data, uint16_t frame_len); 779 uint8_t frame_data[HFP_H2_SYNC_FRAME_SIZE]; 780 uint16_t frame_len; 781 uint16_t dropped_bytes; 782 } hfp_h2_sync_t; 783 784 /** 785 * @brief Init HFP H2 Sync state 786 * @param hfp_h2_sync 787 * @param callback 788 */ 789 void hfp_h2_sync_init(hfp_h2_sync_t * hfp_h2_sync, 790 bool (*callback)(bool bad_frame, const uint8_t * frame_data, uint16_t frame_len)); 791 /** 792 * @brief Process H2 data and execute callback for frames with valid H2 header 793 * @param hfp_h2_sync 794 * @param bad_frame 795 * @param frame_data 796 * @param frame_len 797 */ 798 void hfp_h2_sync_process(hfp_h2_sync_t *hfp_h2_sync, bool bad_frame, const uint8_t *frame_data, uint16_t frame_len); 799 800 801 // other 802 803 void hfp_finalize_connection_context(hfp_connection_t * hfp_connection); 804 void hfp_emit_sco_connection_established(hfp_connection_t *hfp_connection, uint8_t status, uint8_t negotiated_codec, 805 uint16_t rx_packet_length, uint16_t tx_packet_length); 806 807 void hfp_set_ag_callback(btstack_packet_handler_t callback); 808 void hfp_set_ag_rfcomm_packet_handler(btstack_packet_handler_t handler); 809 810 void hfp_set_hf_callback(btstack_packet_handler_t callback); 811 void hfp_set_hf_rfcomm_packet_handler(btstack_packet_handler_t handler); 812 void hfp_set_hf_indicators(uint8_t indicators_nr, const uint8_t * indicators); 813 814 void hfp_init(void); 815 void hfp_deinit(void); 816 817 void hfp_register_custom_ag_command(hfp_custom_at_command_t * at_command); 818 void hfp_register_custom_hf_command(hfp_custom_at_command_t * at_command); 819 820 void hfp_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t service_uuid, int rfcomm_channel_nr, const char * name); 821 void hfp_handle_hci_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 822 void hfp_handle_rfcomm_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, hfp_role_t local_role); 823 void hfp_emit_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, uint8_t value); 824 void hfp_emit_simple_event(hfp_connection_t * hfp_connection, uint8_t event_subtype); 825 void hfp_emit_string_event(hfp_connection_t * hfp_connection, uint8_t event_subtype, const char * value); 826 void hfp_emit_slc_connection_event(hfp_role_t local_role, uint8_t status, hci_con_handle_t con_handle, bd_addr_t addr); 827 828 /** 829 * @brief Emit HFP_SUBEVENT_VOICE_RECOGNITION_ENABLED event 830 * @param hfp_connection 831 * @param status ERROR_CODE_SUCCESS if successful, otherwise ERROR_CODE_COMMAND_DISALLOWED 832 */ 833 void hfp_emit_voice_recognition_enabled(hfp_connection_t * hfp_connection, uint8_t status); 834 835 /** 836 * @brief Emit HFP_SUBEVENT_VOICE_RECOGNITION_DISABLED event 837 * @param hfp_connection 838 * @param status ERROR_CODE_SUCCESS if successful, otherwise ERROR_CODE_COMMAND_DISALLOWED 839 */ 840 void hfp_emit_voice_recognition_disabled(hfp_connection_t * hfp_connection, uint8_t status); 841 842 void hfp_emit_enhanced_voice_recognition_hf_ready_for_audio_event(hfp_connection_t * hfp_connection, uint8_t status); 843 void hfp_emit_enhanced_voice_recognition_state_event(hfp_connection_t * hfp_connection, uint8_t status); 844 845 hfp_connection_t * get_hfp_connection_context_for_rfcomm_cid(uint16_t cid); 846 hfp_connection_t * get_hfp_connection_context_for_bd_addr(bd_addr_t bd_addr, hfp_role_t hfp_role); 847 hfp_connection_t * get_hfp_connection_context_for_sco_handle(uint16_t handle, hfp_role_t hfp_role); 848 hfp_connection_t * get_hfp_connection_context_for_acl_handle(uint16_t handle, hfp_role_t hfp_role); 849 850 btstack_linked_list_t * hfp_get_connections(void); 851 void hfp_parse(hfp_connection_t * connection, uint8_t byte, int isHandsFree); 852 void hfp_parser_reset_line_buffer(hfp_connection_t *hfp_connection); 853 854 /** 855 * @brief Establish RFCOMM connection, and perform service level connection agreement: 856 * @param bd_addr 857 * @param service_uuid 858 * @param local_role 859 * @return status ERROR_CODE_SUCCESS if successful, otherwise: 860 * - ERROR_CODE_COMMAND_DISALLOWED if connection already exists, or 861 * - BTSTACK_MEMORY_ALLOC_FAILED 862 */ 863 uint8_t hfp_establish_service_level_connection(bd_addr_t bd_addr, uint16_t service_uuid, hfp_role_t local_role); 864 865 /** 866 * @brief Prepare connection for audio and SLC connections release 867 * @param hfp_connection 868 */ 869 void hfp_trigger_release_service_level_connection(hfp_connection_t * hfp_connection); 870 871 /** 872 * @brief Prepare connection for audio connection release 873 * @param hfp_connection 874 */ 875 uint8_t hfp_trigger_release_audio_connection(hfp_connection_t * hfp_connection); 876 877 void hfp_reset_context_flags(hfp_connection_t * hfp_connection); 878 879 // @returns if an SCO setup is active in either role 880 bool hfp_sco_setup_active(void); 881 882 void hfp_setup_synchronous_connection(hfp_connection_t * hfp_connection); 883 void hfp_accept_synchronous_connection(hfp_connection_t * hfp_connection, bool incoming_eSCO); 884 885 int hfp_supports_codec(uint8_t codec, int codecs_nr, uint8_t * codecs); 886 void hfp_hf_drop_mSBC_if_eSCO_not_supported(uint8_t * codecs, uint8_t * codecs_nr); 887 void hfp_init_link_settings(hfp_connection_t * hfp_connection, uint8_t eSCO_S4_supported); 888 hfp_link_settings_t hfp_next_link_setting(hfp_link_settings_t current_setting, uint16_t local_sco_packet_types, 889 uint16_t remote_sco_packet_types, bool eSCO_s4_supported, 890 uint8_t negotiated_codec); 891 hfp_link_settings_t hfp_safe_settings_for_context(bool use_eSCO, uint8_t negotiated_codec, bool secure_connection_in_use); 892 893 const char * hfp_hf_feature(int index); 894 const char * hfp_ag_feature(int index); 895 896 void hfp_log_rfcomm_message(const char * tag, uint8_t * packet, uint16_t size); 897 898 const char * hfp_enhanced_call_dir2str(uint16_t index); 899 const char * hfp_enhanced_call_status2str(uint16_t index); 900 const char * hfp_enhanced_call_mode2str(uint16_t index); 901 const char * hfp_enhanced_call_mpty2str(uint16_t index); 902 903 /** 904 * @brief Prepare for immediate SCO connection. 905 * Triggers sending of vendor-specific commands to enable mSBC Codec in Controller 906 * @param hfp_connection 907 */ 908 void hfp_prepare_for_sco(hfp_connection_t * hfp_connection); 909 910 #ifdef ENABLE_BCM_PCM_WBS 911 void hfp_bcm_write_i2spcm_interface_param (hfp_connection_t * hfp_connection); 912 #endif 913 914 /** 915 * @brief Set packet types for SCO connections 916 * @param common single packet_types: HFP_SCO_PACKET_TYPES_* 917 */ 918 void hfp_set_sco_packet_types(uint16_t packet_types); 919 920 /** 921 * @brief Get packet types for SCO connections 922 * @return packet_types 923 */ 924 uint16_t hfp_get_sco_packet_types(void); 925 926 #if defined __cplusplus 927 } 928 #endif 929 930 #endif // BTSTACK_HFP_H 931