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