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