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