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