xref: /btstack/src/classic/pbap_client.c (revision 07c6cfd449f24a521b71398b4720f79585fba51d)
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 #define BTSTACK_FILE__ "pbap_client.c"
39 
40 #include "btstack_config.h"
41 
42 #include <stdint.h>
43 #include <string.h>
44 
45 #include "hci_cmd.h"
46 #include "btstack_run_loop.h"
47 #include "btstack_debug.h"
48 #include "hci.h"
49 #include "btstack_memory.h"
50 #include "hci_dump.h"
51 #include "l2cap.h"
52 #include "bluetooth_sdp.h"
53 #include "classic/sdp_client_rfcomm.h"
54 #include "btstack_event.h"
55 #include "md5.h"
56 
57 #include "classic/obex.h"
58 #include "classic/obex_parser.h"
59 #include "classic/goep_client.h"
60 #include "classic/pbap.h"
61 #include "classic/pbap_client.h"
62 
63 // 796135f0-f0c5-11d8-0966- 0800200c9a66
64 static const uint8_t pbap_uuid[] = { 0x79, 0x61, 0x35, 0xf0, 0xf0, 0xc5, 0x11, 0xd8, 0x09, 0x66, 0x08, 0x00, 0x20, 0x0c, 0x9a, 0x66};
65 
66 const char * pbap_phonebook_type     = "x-bt/phonebook";
67 const char * pbap_vcard_listing_type = "x-bt/vcard-listing";
68 const char * pbap_vcard_entry_type   = "x-bt/vcard";
69 
70 const char * pbap_vcard_listing_name = "pb";
71 
72 // used for MD5
73 static const uint8_t colon = (uint8_t) ':';
74 
75 static uint32_t pbap_client_supported_features;
76 
77 static bool pbap_client_singleton_used;
78 
79 static btstack_linked_list_t pbap_clients;
80 
81 // emit events
82 static void pbap_client_emit_connected_event(pbap_client_t * context, uint8_t status){
83     uint8_t event[15];
84     int pos = 0;
85     event[pos++] = HCI_EVENT_PBAP_META;
86     pos++;  // skip len
87     event[pos++] = PBAP_SUBEVENT_CONNECTION_OPENED;
88     little_endian_store_16(event,pos,context->goep_cid);
89     pos+=2;
90     event[pos++] = status;
91     (void)memcpy(&event[pos], context->bd_addr, 6);
92     pos += 6;
93     little_endian_store_16(event,pos,context->con_handle);
94     pos += 2;
95     event[pos++] = 0;
96     event[1] = pos - 2;
97     if (pos != sizeof(event)) log_error("goep_client_emit_connected_event size %u", pos);
98     context->client_handler(HCI_EVENT_PACKET, context->goep_cid, &event[0], pos);
99 }
100 
101 static void pbap_client_emit_connection_closed_event(pbap_client_t * context){
102     uint8_t event[5];
103     int pos = 0;
104     event[pos++] = HCI_EVENT_PBAP_META;
105     pos++;  // skip len
106     event[pos++] = PBAP_SUBEVENT_CONNECTION_CLOSED;
107     little_endian_store_16(event,pos,context->goep_cid);
108     pos+=2;
109     event[1] = pos - 2;
110     if (pos != sizeof(event)) log_error("pbap_client_emit_connection_closed_event size %u", pos);
111     context->client_handler(HCI_EVENT_PACKET, context->goep_cid, &event[0], pos);
112 }
113 
114 static void pbap_client_emit_operation_complete_event(pbap_client_t * context, uint8_t status){
115     uint8_t event[6];
116     int pos = 0;
117     event[pos++] = HCI_EVENT_PBAP_META;
118     pos++;  // skip len
119     event[pos++] = PBAP_SUBEVENT_OPERATION_COMPLETED;
120     little_endian_store_16(event,pos,context->goep_cid);
121     pos+=2;
122     event[pos++]= status;
123     event[1] = pos - 2;
124     if (pos != sizeof(event)) log_error("pbap_client_emit_can_send_now_event size %u", pos);
125     context->client_handler(HCI_EVENT_PACKET, context->goep_cid, &event[0], pos);
126 }
127 
128 static void pbap_client_emit_phonebook_size_event(pbap_client_t * context, uint8_t status, uint16_t phonebook_size){
129     uint8_t event[8];
130     int pos = 0;
131     event[pos++] = HCI_EVENT_PBAP_META;
132     pos++;  // skip len
133     event[pos++] = PBAP_SUBEVENT_PHONEBOOK_SIZE;
134     little_endian_store_16(event,pos,context->goep_cid);
135     pos+=2;
136     event[pos++] = status;
137     little_endian_store_16(event,pos, phonebook_size);
138     pos+=2;
139     event[1] = pos - 2;
140     if (pos != sizeof(event)) log_error("pbap_client_emit_phonebook_size_event size %u", pos);
141     context->client_handler(HCI_EVENT_PACKET, context->goep_cid, &event[0], pos);
142 }
143 
144 static void pbap_client_emit_authentication_event(pbap_client_t * context, uint8_t options){
145     // split options
146     uint8_t user_id_required = (options & 1) ? 1 : 0;
147     uint8_t full_access      = (options & 2) ? 1 : 0;
148 
149     uint8_t event[7];
150     int pos = 0;
151     event[pos++] = HCI_EVENT_PBAP_META;
152     pos++;  // skip len
153     event[pos++] = PBAP_SUBEVENT_AUTHENTICATION_REQUEST;
154     little_endian_store_16(event,pos,context->goep_cid);
155     pos+=2;
156     event[pos++] = user_id_required;
157     event[pos++] = full_access;
158     if (pos != sizeof(event)) log_error("pbap_client_emit_authentication_event size %u", pos);
159     context->client_handler(HCI_EVENT_PACKET, context->goep_cid, &event[0], pos);
160 }
161 
162 static void pbap_client_emit_card_result_event(pbap_client_t * context, const char * name, const char * handle){
163     uint8_t event[5 + PBAP_MAX_NAME_LEN + PBAP_MAX_HANDLE_LEN];
164     int pos = 0;
165     event[pos++] = HCI_EVENT_PBAP_META;
166     pos++;  // skip len
167     event[pos++] = PBAP_SUBEVENT_CARD_RESULT;
168     little_endian_store_16(event,pos,context->goep_cid);
169     pos+=2;
170     int name_len = btstack_min(PBAP_MAX_NAME_LEN, (uint16_t) strlen(name));
171     event[pos++] = name_len;
172     (void)memcpy(&event[pos], name, name_len);
173     pos += name_len;
174     int handle_len = btstack_min(PBAP_MAX_HANDLE_LEN, (uint16_t) strlen(handle));
175     event[pos++] = handle_len;
176     (void)memcpy(&event[pos], handle, handle_len);
177     pos += handle_len;
178     event[1] = pos - 2;
179     context->client_handler(HCI_EVENT_PACKET, context->goep_cid, &event[0], pos);
180 }
181 
182 static pbap_client_t * pbap_client_for_cid(uint16_t cid){
183     btstack_linked_list_iterator_t it;
184     btstack_linked_list_iterator_init(&it, &pbap_clients);
185     while (btstack_linked_list_iterator_has_next(&it)){
186         pbap_client_t * client = (pbap_client_t *) btstack_linked_list_iterator_next(&it);
187         if (client->goep_cid == cid){
188             return client;
189         }
190     }
191     return NULL;
192 }
193 
194 static void pbap_client_finalize(pbap_client_t *client) {
195     client->state = PBAP_CLIENT_INIT;
196     btstack_linked_list_remove(&pbap_clients, (btstack_linked_item_t*) client);
197 }
198 
199 static void pbap_client_vcard_listing_init_parser(pbap_client_t * client){
200     yxml_init(&client->xml_parser, client->xml_buffer, sizeof(client->xml_buffer));
201     client->parser_card_found = false;
202     client->parser_name_found = false;
203     client->parser_handle_found = false;
204 }
205 
206 static void pbap_client_phonebook_size_parser_init(pbap_client_phonebook_size_parser_t * phonebook_size_parer){
207     memset(phonebook_size_parer, 0, sizeof(pbap_client_phonebook_size_parser_t));
208 }
209 
210 static void pbap_client_phonebook_size_parser_process_data(pbap_client_phonebook_size_parser_t * phonebook_size_parser, const uint8_t * data_buffer, uint16_t data_len){
211     while (data_len){
212         uint16_t bytes_to_consume = 1;
213         switch(phonebook_size_parser->state){
214             case PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_INVALID:
215                 return;
216             case PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_TYPE:
217                 phonebook_size_parser->type = *data_buffer;
218                 phonebook_size_parser->state = PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_LEN;
219                 break;
220             case PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_LEN:
221                 phonebook_size_parser->len = *data_buffer;
222                 phonebook_size_parser->state = PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_VALUE;
223                 switch (phonebook_size_parser->type){
224                     case PBAP_APPLICATION_PARAMETER_PHONEBOOK_SIZE:
225                         if (phonebook_size_parser->len != 2){
226                             phonebook_size_parser->state = PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_INVALID;
227                             return;
228                         }
229                         break;
230                     default:
231                         break;
232                     }
233                 break;
234             case PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_VALUE:
235                 bytes_to_consume = btstack_min(phonebook_size_parser->len - phonebook_size_parser->pos, data_len);
236                 switch (phonebook_size_parser->type){
237                     case PBAP_APPLICATION_PARAMETER_PHONEBOOK_SIZE:
238                         memcpy(&phonebook_size_parser->size_buffer[phonebook_size_parser->pos], data_buffer, bytes_to_consume);
239                         break;
240                     default:
241                         // ignore data
242                         break;
243                 }
244                 phonebook_size_parser->pos += bytes_to_consume;
245                 if (phonebook_size_parser->pos == phonebook_size_parser->len){
246                     phonebook_size_parser->state = PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_TYPE;
247                     switch (phonebook_size_parser->type){
248                         case PBAP_APPLICATION_PARAMETER_PHONEBOOK_SIZE:
249                             phonebook_size_parser->have_size = true;
250                             break;
251                         default:
252                             break;
253                     }
254                 }
255                 break;
256             default:
257                 break;
258         }
259         data_buffer += bytes_to_consume;
260         data_len    -= bytes_to_consume;
261     }
262 }
263 
264 static void obex_auth_parser_init(pbap_client_obex_auth_parser_t * auth_parser){
265     memset(auth_parser, 0, sizeof(pbap_client_obex_auth_parser_t));
266 }
267 
268 static void obex_auth_parser_process_data(pbap_client_obex_auth_parser_t * auth_parser, const uint8_t * data_buffer, uint16_t data_len){
269     while (data_len){
270         uint16_t bytes_to_consume = 1;
271         switch(auth_parser->state){
272             case OBEX_AUTH_PARSER_STATE_INVALID:
273                 return;
274             case OBEX_AUTH_PARSER_STATE_W4_TYPE:
275                 auth_parser->type = *data_buffer;
276                 auth_parser->state = OBEX_AUTH_PARSER_STATE_W4_LEN;
277                 break;
278             case OBEX_AUTH_PARSER_STATE_W4_LEN:
279                 auth_parser->len = *data_buffer;
280                 switch (auth_parser->type){
281                     case 0:
282                         if (auth_parser->len != 0x10){
283                             auth_parser->state = OBEX_AUTH_PARSER_STATE_INVALID;
284                             return;
285                         }
286                         break;
287                     case 1:
288                         if (auth_parser->len != 0x01){
289                             auth_parser->state = OBEX_AUTH_PARSER_STATE_INVALID;
290                             return;
291                         }
292                         break;
293                     case 2:
294                         // TODO: handle charset
295                         // charset_code = challenge_data[i];
296                         break;
297                     default:
298                         break;
299                 }
300                 auth_parser->state = OBEX_AUTH_PARSER_STATE_W4_VALUE;
301                 break;
302             case OBEX_AUTH_PARSER_STATE_W4_VALUE:
303                 bytes_to_consume = btstack_min(auth_parser->len - auth_parser->pos, data_len);
304                 switch (auth_parser->type){
305                     case 0:
306                         memcpy(&auth_parser->authentication_nonce[auth_parser->pos], data_buffer, bytes_to_consume);
307                         break;
308                     case 1:
309                         auth_parser->authentication_options = *data_buffer;
310                         break;
311                     default:
312                         // ignore
313                         break;
314                 }
315                 auth_parser->pos += bytes_to_consume;
316                 if (auth_parser->pos == auth_parser->len){
317                     auth_parser->state = OBEX_AUTH_PARSER_STATE_W4_TYPE;
318                 }
319                 break;
320             default:
321                 btstack_unreachable();
322                 break;
323         }
324         data_buffer += bytes_to_consume;
325         data_len    -= bytes_to_consume;
326     }
327 }
328 
329 static void pbap_client_yml_append_character(yxml_t * xml_parser, char * buffer, uint16_t buffer_size){
330     // "In UTF-8, characters from the U+0000..U+10FFFF range (the UTF-16 accessible range) are encoded using sequences of 1 to 4 octets."
331     uint16_t char_len = (uint16_t) strlen(xml_parser->data);
332     btstack_assert(char_len <= 4);
333     uint16_t dest_len = (uint16_t) strlen(buffer);
334     uint16_t zero_pos = dest_len + char_len;
335     if (zero_pos >= buffer_size) return;
336     memcpy(&buffer[dest_len], xml_parser->data, char_len);
337     buffer[zero_pos] = '\0';
338 }
339 
340 static void pbap_client_process_vcard_list_body(pbap_client_t *client, const uint8_t *data, uint16_t data_len) {
341 
342     while (data_len--) {
343         yxml_ret_t r = yxml_parse(&client->xml_parser, *data++);
344         switch (r) {
345             case YXML_ELEMSTART:
346                 client->parser_card_found = strcmp("card", client->xml_parser.elem) == 0;
347                 break;
348             case YXML_ELEMEND:
349                 if (client->parser_card_found) {
350                     pbap_client_emit_card_result_event(client, client->parser_name,
351                                                        client->parser_handle);
352                 }
353                 client->parser_card_found = false;
354                 break;
355             case YXML_ATTRSTART:
356                 if (!client->parser_card_found) break;
357                 if (strcmp("name", client->xml_parser.attr) == 0) {
358                     client->parser_name_found = true;
359                     client->parser_name[0] = 0;
360                     break;
361                 }
362                 if (strcmp("handle", client->xml_parser.attr) == 0) {
363                     client->parser_handle_found = true;
364                     client->parser_handle[0] = 0;
365                     break;
366                 }
367                 break;
368             case YXML_ATTRVAL:
369                 if (client->parser_name_found) {
370                     pbap_client_yml_append_character(&client->xml_parser,
371                                                      client->parser_name,
372                                                      sizeof(client->parser_name));
373                     break;
374                 }
375                 if (client->parser_handle_found) {
376                     pbap_client_yml_append_character(&client->xml_parser,
377                                                      client->parser_handle,
378                                                      sizeof(client->parser_handle));
379                     break;
380                 }
381                 break;
382             case YXML_ATTREND:
383                 client->parser_name_found = false;
384                 client->parser_handle_found = false;
385                 break;
386             default:
387                 break;
388         }
389     }
390 }
391 
392 static void pbap_client_parser_callback_connect(void * user_data, uint8_t header_id, uint16_t total_len, uint16_t data_offset, const uint8_t * data_buffer, uint16_t data_len){
393     pbap_client_t * client = (pbap_client_t *) user_data;
394     switch (header_id){
395         case OBEX_HEADER_CONNECTION_ID:
396             if (obex_parser_header_store(client->obex_header_buffer, sizeof(client->obex_header_buffer), total_len, data_offset, data_buffer, data_len) == OBEX_PARSER_HEADER_COMPLETE){
397                 goep_client_set_connection_id(client->goep_cid, big_endian_read_32(client->obex_header_buffer, 0));
398             }
399             break;
400         case OBEX_HEADER_AUTHENTICATION_CHALLENGE:
401             obex_auth_parser_process_data(&client->obex_auth_parser, data_buffer, data_len);
402             break;
403         default:
404             break;
405     }
406 }
407 
408 static void pbap_client_parser_callback_get_phonebook_size(void * user_data, uint8_t header_id, uint16_t total_len, uint16_t data_offset, const uint8_t * data_buffer, uint16_t data_len){
409     UNUSED(total_len);
410     UNUSED(data_offset);
411     pbap_client_t *client = (pbap_client_t *) user_data;
412     switch (header_id) {
413         case OBEX_HEADER_APPLICATION_PARAMETERS:
414             pbap_client_phonebook_size_parser_process_data(&client->phonebook_size_parser, data_buffer, data_len);
415             break;
416         default:
417             break;
418     }
419 }
420 
421 static void pbap_client_parser_callback_get_operation(void * user_data, uint8_t header_id, uint16_t total_len, uint16_t data_offset, const uint8_t * data_buffer, uint16_t data_len){
422     pbap_client_t *client = (pbap_client_t *) user_data;
423     switch (header_id) {
424         case OBEX_HEADER_SINGLE_RESPONSE_MODE:
425             obex_parser_header_store(&client->obex_srm.srm_value, 1, total_len, data_offset, data_buffer, data_len);
426             break;
427         case OBEX_HEADER_SINGLE_RESPONSE_MODE_PARAMETER:
428             obex_parser_header_store(&client->obex_srm.srmp_value, 1, total_len, data_offset, data_buffer, data_len);
429             break;
430         case OBEX_HEADER_BODY:
431         case OBEX_HEADER_END_OF_BODY:
432             switch(client->state){
433                 case PBAP_CLIENT_W4_PHONEBOOK:
434                 case PBAP_CLIENT_W4_GET_CARD_ENTRY_COMPLETE:
435                     client->client_handler(PBAP_DATA_PACKET, client->goep_cid, (uint8_t *) data_buffer, data_len);
436                     if (data_offset + data_len == total_len){
437                         client->flow_wait_for_user = true;
438                     }
439                     break;
440                 case PBAP_CLIENT_W4_GET_CARD_LIST_COMPLETE:
441                     pbap_client_process_vcard_list_body(client, data_buffer, data_len);
442                     break;
443                 default:
444                     btstack_unreachable();
445                     break;
446             }
447             break;
448         default:
449             // ignore other headers
450             break;
451     }
452 }
453 
454 static uint16_t pbap_client_application_params_add_vcard_selector(const pbap_client_t * client, uint8_t * application_parameters){
455     uint16_t pos = 0;
456     if (client->vcard_selector_supported){
457         // vCard Selector
458         if (client->vcard_selector){
459             application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR;
460             application_parameters[pos++] = 8;
461             memset(&application_parameters[pos], 0, 4);
462             pos += 4;
463             big_endian_store_32(application_parameters, pos, client->vcard_selector);
464             pos += 4;
465         }
466         // vCard Selector Operator
467         if (client->vcard_selector_operator != PBAP_VCARD_SELECTOR_OPERATOR_OR){
468             application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR_OPERATOR;
469             application_parameters[pos++] = 1;
470             application_parameters[pos++] = client->vcard_selector_operator;
471         }
472     }
473     return pos;
474 }
475 
476 static uint16_t pbap_client_application_params_add_max_list_count(const pbap_client_t * client, uint8_t * application_parameters, uint16_t max_count){
477     UNUSED(client);
478     uint16_t pos = 0;
479     application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_MAX_LIST_COUNT;
480     application_parameters[pos++] = 2;
481     big_endian_store_16(application_parameters, 2, max_count);
482     pos += 2;
483     return pos;
484 }
485 
486 static uint16_t pbap_client_application_params_add_list_start_offset(const pbap_client_t * client, uint8_t * application_parameters, uint16_t list_start_offset){
487     uint16_t pos = 0;
488     if (client->list_start_offset != 0){
489         application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_LIST_START_OFFSET;
490         application_parameters[pos++] = 2;
491         big_endian_store_16(application_parameters, 2, list_start_offset);
492         pos += 2;
493     }
494     return pos;
495 }
496 
497 // max size: PBAP_MAX_PHONE_NUMBER_LEN + 5
498 static uint16_t pbap_client_application_params_add_phone_number(const pbap_client_t * client, uint8_t * application_parameters){
499     uint16_t pos = 0;
500     if (client->phone_number){
501         // Search by phone number
502         uint16_t phone_number_len = btstack_min(PBAP_MAX_PHONE_NUMBER_LEN, (uint16_t) strlen(client->phone_number));
503         application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_SEARCH_VALUE;
504 		btstack_assert(phone_number_len <= 255);
505         application_parameters[pos++] = (uint8_t) phone_number_len;
506         (void)memcpy(&application_parameters[pos],
507                      client->phone_number, phone_number_len);
508         pos += phone_number_len;
509         application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_SEARCH_PROPERTY;
510         application_parameters[pos++] = 1;
511         application_parameters[pos++] = 0x01; // Number
512     }
513     return pos;
514 }
515 
516 static uint16_t pbap_client_application_params_add_property_selector(const pbap_client_t * client, uint8_t * application_parameters){
517     // TODO: support format
518     uint16_t pos = 0;
519     uint32_t property_selector_lower = client->property_selector;
520     if (client->vcard_name != NULL){
521         if (strncmp(client->vcard_name, "X-BT-UID:", 9) == 0) {
522             property_selector_lower |= 1U << 31;
523         }
524         if (strncmp(client->vcard_name, "X-BT-UCI:", 9) == 0) {
525             property_selector_lower |= 1U << 30;
526         }
527     }
528     if (property_selector_lower != 0){
529         application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_PROPERTY_SELECTOR;
530         application_parameters[pos++] = 8;
531         big_endian_store_32(application_parameters, pos, 0);    // upper 32-bits are reserved/unused so far
532         pos += 4;
533         big_endian_store_32(application_parameters, pos, property_selector_lower);
534         pos += 4;
535     }
536     return pos;
537 }
538 
539 // Mandatory if the PSE advertises a PbapSupportedFeatures attribute in its SDP record, else excluded.
540 static uint16_t pbap_client_application_parameters_add_supported_features(const pbap_client_t * client, uint8_t *application_parameters) {
541     uint16_t pos = 0;
542     if (goep_client_get_pbap_supported_features(client->goep_cid) != PBAP_FEATURES_NOT_PRESENT){
543         application_parameters[pos++] = PBAP_APPLICATION_PARAMETER_PBAP_SUPPORTED_FEATURES;
544         application_parameters[pos++] = 4;
545         big_endian_store_32(application_parameters, 2, pbap_client_supported_features);
546         pos += 4;
547     }
548     return pos;
549 }
550 
551 static void pbap_client_add_application_parameters(const pbap_client_t * client, uint8_t * application_parameters, uint16_t len){
552     if (len > 0){
553         goep_client_header_add_application_parameters(client->goep_cid, &application_parameters[0], len);
554     }
555 }
556 
557 static void pbap_client_prepare_srm_header(pbap_client_t * client){
558     if (client->flow_control_enabled == false){
559         obex_srm_client_prepare_header(&client->obex_srm, client->goep_cid);
560     }
561 }
562 
563 static void pbap_client_prepare_get_operation(pbap_client_t * client){
564     obex_parser_init_for_response(&client->obex_parser, OBEX_OPCODE_GET, pbap_client_parser_callback_get_operation, client);
565     obex_srm_client_init(&client->obex_srm);
566     client->obex_parser_waiting_for_response = true;
567 }
568 
569 static void pbap_handle_can_send_now(pbap_client_t *pbap_client) {
570     uint16_t path_element_start;
571     uint16_t path_element_len;
572     const char * path_element;
573     uint8_t  application_parameters[PBAP_MAX_PHONE_NUMBER_LEN + 10];
574     uint8_t  challenge_response[36];
575     uint16_t pos;
576 
577     MD5_CTX md5_ctx;
578 
579     if (pbap_client->abort_operation){
580         pbap_client->abort_operation = 0;
581         // prepare request
582         goep_client_request_create_abort(pbap_client->goep_cid);
583         // state
584         pbap_client->state = PBAP_CLIENT_W4_ABORT_COMPLETE;
585         // prepare response
586         obex_parser_init_for_response(&pbap_client->obex_parser, OBEX_OPCODE_ABORT, NULL, pbap_client);
587         obex_srm_client_init(&pbap_client->obex_srm);
588         pbap_client->obex_parser_waiting_for_response = true;
589         // send packet
590         goep_client_execute(pbap_client->goep_cid);
591         return;
592     }
593 
594     switch (pbap_client->state){
595         case PBAP_CLIENT_W2_SEND_CONNECT_REQUEST:
596             // prepare request
597             goep_client_request_create_connect(pbap_client->goep_cid, OBEX_VERSION, 0, OBEX_MAX_PACKETLEN_DEFAULT);
598             goep_client_header_add_target(pbap_client->goep_cid, pbap_uuid, 16);
599             pos = 0;
600             pos += pbap_client_application_parameters_add_supported_features(pbap_client, &application_parameters[pos]);
601             pbap_client_add_application_parameters(pbap_client, application_parameters, pos);
602             // state
603             pbap_client->state = PBAP_CLIENT_W4_CONNECT_RESPONSE;
604             // prepare response
605             obex_parser_init_for_response(&pbap_client->obex_parser, OBEX_OPCODE_CONNECT, pbap_client_parser_callback_connect, pbap_client);
606             obex_auth_parser_init(&pbap_client->obex_auth_parser);
607             obex_srm_client_init(&pbap_client->obex_srm);
608             pbap_client->obex_parser_waiting_for_response = true;
609             // send packet
610             goep_client_execute(pbap_client->goep_cid);
611             break;
612         case PBAP_CLIENT_W2_SEND_AUTHENTICATED_CONNECT:
613             // prepare request
614             goep_client_request_create_connect(pbap_client->goep_cid, OBEX_VERSION, 0, OBEX_MAX_PACKETLEN_DEFAULT);
615             goep_client_header_add_target(pbap_client->goep_cid, pbap_uuid, 16);
616             // setup authentication challenge response
617             pos = 0;
618             challenge_response[pos++] = 0;  // Tag Digest
619             challenge_response[pos++] = 16; // Len
620             // calculate md5
621             MD5_Init(&md5_ctx);
622             MD5_Update(&md5_ctx, pbap_client->obex_auth_parser.authentication_nonce, 16);
623             MD5_Update(&md5_ctx, &colon, 1);
624             MD5_Update(&md5_ctx, pbap_client->authentication_password, (uint16_t) strlen(pbap_client->authentication_password));
625             MD5_Final(&challenge_response[pos], &md5_ctx);
626             pos += 16;
627             challenge_response[pos++] = 2;  // Tag Nonce
628             challenge_response[pos++] = 16; // Len
629             (void)memcpy(&challenge_response[pos], pbap_client->obex_auth_parser.authentication_nonce, 16);
630             pos += 16;
631             goep_client_header_add_challenge_response(pbap_client->goep_cid, challenge_response, pos);
632             // state
633             pbap_client->state = PBAP_CLIENT_W4_CONNECT_RESPONSE;
634             // prepare response
635             obex_parser_init_for_response(&pbap_client->obex_parser, OBEX_OPCODE_CONNECT, pbap_client_parser_callback_connect, pbap_client);
636             obex_srm_client_init(&pbap_client->obex_srm);
637             pbap_client->obex_parser_waiting_for_response = true;
638             // send packet
639             goep_client_execute(pbap_client->goep_cid);
640             break;
641         case PBAP_CLIENT_W2_SEND_DISCONNECT_REQUEST:
642             // prepare request
643             goep_client_request_create_disconnect(pbap_client->goep_cid);
644             // state
645             pbap_client->state = PBAP_CLIENT_W4_DISCONNECT_RESPONSE;
646             // prepare response
647             obex_parser_init_for_response(&pbap_client->obex_parser, OBEX_OPCODE_DISCONNECT, NULL, pbap_client);
648             obex_srm_client_init(&pbap_client->obex_srm);
649             pbap_client->obex_parser_waiting_for_response = true;
650             // send packet
651             goep_client_execute(pbap_client->goep_cid);
652             return;
653         case PBAP_CLIENT_W2_GET_PHONEBOOK_SIZE:
654             // prepare request
655             goep_client_request_create_get(pbap_client->goep_cid);
656             pbap_client_prepare_srm_header(pbap_client);
657             goep_client_header_add_name(pbap_client->goep_cid, pbap_client->phonebook_path);
658             goep_client_header_add_type(pbap_client->goep_cid, pbap_phonebook_type);
659 
660             pos = 0;
661             pos += pbap_client_application_params_add_vcard_selector(pbap_client, &application_parameters[pos]);
662             // just get size
663             pos += pbap_client_application_params_add_max_list_count(pbap_client, &application_parameters[pos], 0);
664             pbap_client_add_application_parameters(pbap_client, application_parameters, pos);
665 
666             // state
667             pbap_client->state = PBAP_CLIENT_W4_GET_PHONEBOOK_SIZE_COMPLETE;
668             // prepare response
669             obex_parser_init_for_response(&pbap_client->obex_parser, OBEX_OPCODE_GET, pbap_client_parser_callback_get_phonebook_size, pbap_client);
670             obex_srm_client_init(&pbap_client->obex_srm);
671             pbap_client_phonebook_size_parser_init(&pbap_client->phonebook_size_parser);
672             pbap_client->obex_parser_waiting_for_response = true;
673             // send packet
674             goep_client_execute(pbap_client->goep_cid);
675             break;
676         case PBAP_CLIENT_W2_PULL_PHONEBOOK:
677             // prepare request
678             goep_client_request_create_get(pbap_client->goep_cid);
679             if (pbap_client->request_number == 0){
680                 pbap_client_prepare_srm_header(pbap_client);
681                 goep_client_header_add_name(pbap_client->goep_cid, pbap_client->phonebook_path);
682                 goep_client_header_add_type(pbap_client->goep_cid, pbap_phonebook_type);
683 
684                 pos = 0;
685                 pos += pbap_client_application_params_add_property_selector(pbap_client, &application_parameters[pos]);
686                 if (pbap_client->max_list_count){
687                     pos += pbap_client_application_params_add_max_list_count(pbap_client, &application_parameters[pos], pbap_client->max_list_count);
688                 }
689                 pos += pbap_client_application_params_add_list_start_offset (pbap_client, &application_parameters[pos], pbap_client->list_start_offset);
690                 pos += pbap_client_application_params_add_vcard_selector(pbap_client, &application_parameters[pos]);
691                 pbap_client_add_application_parameters(pbap_client, application_parameters, pos);
692             }
693             // state
694             pbap_client->state = PBAP_CLIENT_W4_PHONEBOOK;
695             pbap_client->flow_next_triggered = 0;
696             pbap_client->flow_wait_for_user = 0;
697             // prepare response
698             pbap_client_prepare_get_operation(pbap_client);
699             // send packet
700             pbap_client->request_number++;
701             goep_client_execute(pbap_client->goep_cid);
702             break;
703         case PBAP_CLIENT_W2_GET_CARD_LIST:
704             // prepare request
705             goep_client_request_create_get(pbap_client->goep_cid);
706             if (pbap_client->request_number == 0){
707                 pbap_client_prepare_srm_header(pbap_client);
708                 goep_client_header_add_name(pbap_client->goep_cid, pbap_client->phonebook_path);
709                 goep_client_header_add_type(pbap_client->goep_cid, pbap_vcard_listing_type);
710 
711                 pos = 0;
712                 pos += pbap_client_application_params_add_vcard_selector(pbap_client, &application_parameters[pos]);
713                 pos += pbap_client_application_params_add_phone_number(pbap_client, &application_parameters[pos]);
714                 pbap_client_add_application_parameters(pbap_client, application_parameters, pos);
715             }
716             // state
717             pbap_client->state = PBAP_CLIENT_W4_GET_CARD_LIST_COMPLETE;
718             // prepare response
719             pbap_client_prepare_get_operation(pbap_client);
720             // send packet
721             pbap_client->request_number++;
722             goep_client_execute(pbap_client->goep_cid);
723             break;
724         case PBAP_CLIENT_W2_GET_CARD_ENTRY:
725             // prepare request
726             goep_client_request_create_get(pbap_client->goep_cid);
727             if (pbap_client->request_number == 0){
728                 pbap_client_prepare_srm_header(pbap_client);
729                 goep_client_header_add_name(pbap_client->goep_cid, pbap_client->vcard_name);
730                 goep_client_header_add_type(pbap_client->goep_cid, pbap_vcard_entry_type);
731 
732                 pos = 0;
733                 pos += pbap_client_application_params_add_property_selector(pbap_client, &application_parameters[pos]);
734                 pbap_client_add_application_parameters(pbap_client, application_parameters, pos);
735             }
736             // state
737             pbap_client->state = PBAP_CLIENT_W4_GET_CARD_ENTRY_COMPLETE;
738             // prepare response
739             pbap_client_prepare_get_operation(pbap_client);
740             // send packet
741             pbap_client->request_number++;
742             goep_client_execute(pbap_client->goep_cid);
743             break;
744         case PBAP_CLIENT_W2_SET_PATH_ROOT:
745             // prepare request
746             goep_client_request_create_set_path(pbap_client->goep_cid, 1 << 1); // Don’t create directory
747             goep_client_header_add_name(pbap_client->goep_cid, "");
748             // state
749             pbap_client->state = PBAP_CLIENT_W4_SET_PATH_ROOT_COMPLETE;
750             // prepare response
751             obex_parser_init_for_response(&pbap_client->obex_parser, OBEX_OPCODE_SETPATH, NULL, pbap_client);
752             obex_srm_client_init(&pbap_client->obex_srm);
753             pbap_client->obex_parser_waiting_for_response = true;
754             // send packet
755             goep_client_execute(pbap_client->goep_cid);
756             break;
757         case PBAP_CLIENT_W2_SET_PATH_ELEMENT:
758             // prepare request
759             // find '/' or '\0'
760             path_element_start = pbap_client->set_path_offset;
761             while ((pbap_client->current_folder[pbap_client->set_path_offset] != '\0') &&
762                 (pbap_client->current_folder[pbap_client->set_path_offset] != '/')){
763                 pbap_client->set_path_offset++;
764             }
765             path_element_len = pbap_client->set_path_offset-path_element_start;
766             path_element = (const char *) &pbap_client->current_folder[path_element_start];
767 
768             // skip /
769             if (pbap_client->current_folder[pbap_client->set_path_offset] == '/'){
770                 pbap_client->set_path_offset++;
771             }
772 
773             goep_client_request_create_set_path(pbap_client->goep_cid, 1 << 1); // Don’t create directory
774             goep_client_header_add_name_prefix(pbap_client->goep_cid, path_element, path_element_len); // next element
775             // state
776             pbap_client->state = PBAP_CLIENT_W4_SET_PATH_ELEMENT_COMPLETE;
777             // prepare response
778             obex_parser_init_for_response(&pbap_client->obex_parser, OBEX_OPCODE_SETPATH, NULL, pbap_client);
779             obex_srm_client_init(&pbap_client->obex_srm);
780             pbap_client->obex_parser_waiting_for_response = true;
781             // send packet
782             goep_client_execute(pbap_client->goep_cid);
783             break;
784         default:
785             break;
786     }
787 }
788 
789 static void pbap_packet_handler_hci(uint8_t *packet, uint16_t size){
790     UNUSED(size);
791     uint8_t status;
792 
793     pbap_client_t * client;
794 
795     switch (hci_event_packet_get_type(packet)) {
796         case HCI_EVENT_GOEP_META:
797             switch (hci_event_goep_meta_get_subevent_code(packet)){
798                 case GOEP_SUBEVENT_CONNECTION_OPENED:
799                     client = pbap_client_for_cid(goep_subevent_connection_opened_get_goep_cid(packet));
800                     btstack_assert(client != NULL);
801                     status = goep_subevent_connection_opened_get_status(packet);
802                     goep_subevent_connection_opened_get_bd_addr(packet, client->bd_addr);
803                     if (status){
804                         log_info("pbap: connection failed %u", status);
805                         pbap_client_finalize(client);
806                         pbap_client_emit_connected_event(client, status);
807                     } else {
808                         log_info("pbap: connection established");
809                         client->con_handle = goep_subevent_connection_opened_get_con_handle(packet);
810                         client->state = PBAP_CLIENT_W2_SEND_CONNECT_REQUEST;
811                         goep_client_request_can_send_now(client->goep_cid);
812                     }
813                     break;
814                 case GOEP_SUBEVENT_CONNECTION_CLOSED:
815                     client = pbap_client_for_cid(goep_subevent_connection_closed_get_goep_cid(packet));
816                     btstack_assert(client != NULL);
817                     if (client->state > PBAP_CLIENT_CONNECTED){
818                         pbap_client_emit_operation_complete_event(client, OBEX_DISCONNECTED);
819                     }
820                     pbap_client_finalize(client);
821                     pbap_client_emit_connection_closed_event(client);
822                     break;
823                 case GOEP_SUBEVENT_CAN_SEND_NOW:
824                     client = pbap_client_for_cid(goep_subevent_can_send_now_get_goep_cid(packet));
825                     btstack_assert(client != NULL);
826                     pbap_handle_can_send_now(client);
827                     break;
828                 default:
829                     break;
830             }
831             break;
832         default:
833             break;
834     }
835 }
836 
837 static void pbap_packet_handler_goep(pbap_client_t *client, uint8_t *packet, uint16_t size) {
838 
839     if (client->obex_parser_waiting_for_response == false) return;
840 
841     obex_parser_object_state_t parser_state;
842     parser_state = obex_parser_process_data(&client->obex_parser, packet, size);
843     if (parser_state == OBEX_PARSER_OBJECT_STATE_COMPLETE){
844         client->obex_parser_waiting_for_response = false;
845         obex_parser_operation_info_t op_info;
846         obex_parser_get_operation_info(&client->obex_parser, &op_info);
847         switch (client->state){
848             case PBAP_CLIENT_W4_CONNECT_RESPONSE:
849                 switch (op_info.response_code) {
850                     case OBEX_RESP_SUCCESS:
851                         client->state = PBAP_CLIENT_CONNECTED;
852                         client->vcard_selector_supported = pbap_client_supported_features & goep_client_get_pbap_supported_features(client->goep_cid) & PBAP_SUPPORTED_FEATURES_VCARD_SELECTING;
853                         pbap_client_emit_connected_event(client, ERROR_CODE_SUCCESS);
854                         break;
855                     case OBEX_RESP_UNAUTHORIZED:
856                         client->state = PBAP_CLIENT_W4_USER_AUTHENTICATION;
857                         pbap_client_emit_authentication_event(client, client->obex_auth_parser.authentication_options);
858                         break;
859                     default:
860                         log_info("pbap: obex connect failed, result 0x%02x", packet[0]);
861                         client->state = PBAP_CLIENT_INIT;
862                         pbap_client_emit_connected_event(client, OBEX_CONNECT_FAILED);
863                         break;
864                 }
865                 break;
866             case PBAP_CLIENT_W4_DISCONNECT_RESPONSE:
867                 client->state = PBAP_CLIENT_CONNECTED;
868                 goep_client_disconnect(client->goep_cid);
869                 break;
870             case PBAP_CLIENT_W4_SET_PATH_ROOT_COMPLETE:
871             case PBAP_CLIENT_W4_SET_PATH_ELEMENT_COMPLETE:
872                 switch (op_info.response_code) {
873                     case OBEX_RESP_SUCCESS:
874                         // more path?
875                         if (client->current_folder[client->set_path_offset]) {
876                             client->state = PBAP_CLIENT_W2_SET_PATH_ELEMENT;
877                             goep_client_request_can_send_now(client->goep_cid);
878                         } else {
879                             client->current_folder = NULL;
880                             client->state = PBAP_CLIENT_CONNECTED;
881                             pbap_client_emit_operation_complete_event(client, ERROR_CODE_SUCCESS);
882                         }
883                         break;
884                     case OBEX_RESP_NOT_FOUND:
885                         client->state = PBAP_CLIENT_CONNECTED;
886                         pbap_client_emit_operation_complete_event(client, OBEX_NOT_FOUND);
887                         break;
888                     default:
889                         client->state = PBAP_CLIENT_CONNECTED;
890                         pbap_client_emit_operation_complete_event(client, OBEX_UNKNOWN_ERROR);
891                         break;
892                 }
893                 break;
894             case PBAP_CLIENT_W4_PHONEBOOK:
895                 switch (op_info.response_code) {
896                     case OBEX_RESP_CONTINUE:
897                         obex_srm_client_handle_headers(&client->obex_srm);
898                         if (client->obex_srm.srm_state == OBEX_SRM_CLIENT_STATE_ENABLED) {
899                             // prepare response
900                             pbap_client_prepare_get_operation(client);
901                             break;
902                         }
903                         client->state = PBAP_CLIENT_W2_PULL_PHONEBOOK;
904                         if (!client->flow_control_enabled || !client->flow_wait_for_user ||
905                             client->flow_next_triggered) {
906                             goep_client_request_can_send_now(client->goep_cid);
907                         }
908                         break;
909                     case OBEX_RESP_SUCCESS:
910                         client->state = PBAP_CLIENT_CONNECTED;
911                         pbap_client_emit_operation_complete_event(client, ERROR_CODE_SUCCESS);
912                         break;
913                     default:
914                         log_info("unexpected response 0x%02x", packet[0]);
915                         client->state = PBAP_CLIENT_CONNECTED;
916                         pbap_client_emit_operation_complete_event(client, OBEX_UNKNOWN_ERROR);
917                         break;
918                 }
919                 break;
920             case PBAP_CLIENT_W4_GET_PHONEBOOK_SIZE_COMPLETE:
921                 switch (op_info.response_code) {
922                     case OBEX_RESP_SUCCESS:
923                         if (client->phonebook_size_parser.have_size) {
924                             uint16_t phonebook_size = big_endian_read_16(client->phonebook_size_parser.size_buffer, 0);
925                             client->state = PBAP_CLIENT_CONNECTED;
926                             pbap_client_emit_phonebook_size_event(client, 0, phonebook_size);
927                             break;
928                         }
929                         /* fall through */
930                     default:
931                         client->state = PBAP_CLIENT_CONNECTED;
932                         pbap_client_emit_phonebook_size_event(client, OBEX_UNKNOWN_ERROR, 0);
933                         break;
934                 }
935                 break;
936             case PBAP_CLIENT_W4_GET_CARD_LIST_COMPLETE:
937                 switch (op_info.response_code) {
938                     case OBEX_RESP_CONTINUE:
939                         // handle continue
940                         obex_srm_client_handle_headers(&client->obex_srm);
941                         if (client->obex_srm.srm_state == OBEX_SRM_CLIENT_STATE_ENABLED) {
942                             // prepare response
943                             pbap_client_prepare_get_operation(client);
944                             break;
945                         }
946                         client->state = PBAP_CLIENT_W2_GET_CARD_LIST;
947                         goep_client_request_can_send_now(client->goep_cid);
948                         break;
949                     case OBEX_RESP_SUCCESS:
950                         // done
951                         client->state = PBAP_CLIENT_CONNECTED;
952                         pbap_client_emit_operation_complete_event(client, ERROR_CODE_SUCCESS);
953                         break;
954                     case OBEX_RESP_NOT_ACCEPTABLE:
955                         client->state = PBAP_CLIENT_CONNECTED;
956                         pbap_client_emit_operation_complete_event(client, OBEX_NOT_ACCEPTABLE);
957                         break;
958                     default:
959                         log_info("unexpected response 0x%02x", packet[0]);
960                         client->state = PBAP_CLIENT_CONNECTED;
961                         pbap_client_emit_operation_complete_event(client, OBEX_UNKNOWN_ERROR);
962                         break;
963                 }
964                 break;
965             case PBAP_CLIENT_W4_GET_CARD_ENTRY_COMPLETE:
966                 switch (op_info.response_code) {
967                     case OBEX_RESP_CONTINUE:
968                         obex_srm_client_handle_headers(&client->obex_srm);
969                         if (client->obex_srm.srm_state == OBEX_SRM_CLIENT_STATE_ENABLED) {
970                             // prepare response
971                             pbap_client_prepare_get_operation(client);
972                             break;
973                         }
974                         client->state = PBAP_CLIENT_W2_GET_CARD_ENTRY;
975                         goep_client_request_can_send_now(client->goep_cid);
976                         break;
977                     case OBEX_RESP_SUCCESS:
978                         client->state = PBAP_CLIENT_CONNECTED;
979                         pbap_client_emit_operation_complete_event(client, ERROR_CODE_SUCCESS);
980                         break;
981                     case OBEX_RESP_NOT_ACCEPTABLE:
982                         client->state = PBAP_CLIENT_CONNECTED;
983                         pbap_client_emit_operation_complete_event(client, OBEX_NOT_ACCEPTABLE);
984                         break;
985                     default:
986                         log_info("unexpected response 0x%02x", packet[0]);
987                         client->state = PBAP_CLIENT_CONNECTED;
988                         pbap_client_emit_operation_complete_event(client, OBEX_UNKNOWN_ERROR);
989                         break;
990                 }
991                 break;
992             case PBAP_CLIENT_W4_ABORT_COMPLETE:
993                 client->state = PBAP_CLIENT_CONNECTED;
994                 pbap_client_emit_operation_complete_event(client, OBEX_ABORTED);
995                 break;
996             default:
997                 btstack_unreachable();
998                 break;
999         }
1000     }
1001 }
1002 
1003 static void pbap_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
1004     UNUSED(channel); // ok: there is no channel
1005     UNUSED(size);    // ok: handling own geop events
1006 
1007     pbap_client_t * client;
1008 
1009     switch (packet_type){
1010         case HCI_EVENT_PACKET:
1011             pbap_packet_handler_hci(packet, size);
1012             break;
1013         case GOEP_DATA_PACKET:
1014             client = pbap_client_for_cid(channel);
1015             btstack_assert(client != NULL);
1016             pbap_packet_handler_goep(client, packet, size);
1017             break;
1018         default:
1019             break;
1020     }
1021 }
1022 
1023 void pbap_client_init(void){
1024     pbap_client_supported_features =
1025             PBAP_SUPPORTED_FEATURES_DOWNLOAD |
1026             PBAP_SUPPORTED_FEATURES_BROWSING |
1027             PBAP_SUPPORTED_FEATURES_DATABASE_IDENTIFIER |
1028             PBAP_SUPPORTED_FEATURES_FOLDER_VERSION_COUNTERS |
1029             PBAP_SUPPORTED_FEATURES_VCARD_SELECTING |
1030             PBAP_SUPPORTED_FEATURES_ENHANCED_MISSED_CALLS |
1031             PBAP_SUPPORTED_FEATURES_DEFAULT_CONTACT_IMAGE_FORMAT |
1032             PBAP_SUPPORTED_FEATURES_X_BT_UCI_VCARD_PROPERTY |
1033             PBAP_SUPPORTED_FEATURES_X_BT_UID_VCARD_PROPERTY |
1034             PBAP_SUPPORTED_FEATURES_CONTACT_REFERENCING;
1035 
1036     pbap_client_singleton_used = false;
1037 }
1038 
1039 void pbap_client_deinit(void){
1040 }
1041 
1042 uint8_t pbap_client_connect(pbap_client_t * client, l2cap_ertm_config_t *l2cap_ertm_config, uint8_t *l2cap_ertm_buffer,
1043                             uint16_t l2cap_ertm_buffer_size, btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid) {
1044     client->state = PBAP_CLIENT_W4_GOEP_CONNECTION;
1045     client->client_handler = handler;
1046     client->vcard_selector = 0;
1047     client->vcard_selector_operator = PBAP_VCARD_SELECTOR_OPERATOR_OR;
1048 
1049     btstack_linked_list_add(&pbap_clients, (btstack_linked_item_t*) client);
1050 
1051     uint8_t status = goep_client_connect(&client->goep_client, l2cap_ertm_config, l2cap_ertm_buffer, l2cap_ertm_buffer_size,
1052                                          &pbap_packet_handler, addr, BLUETOOTH_SERVICE_CLASS_PHONEBOOK_ACCESS_PSE, 0, &client->goep_cid);
1053     *out_cid = client->goep_cid;
1054 
1055     if (status) {
1056         pbap_client_finalize(client);
1057     }
1058     return status;
1059 }
1060 
1061 uint8_t pbap_connect(btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid){
1062     static pbap_client_t pbap_client_singleton;
1063 
1064     l2cap_ertm_config_t *l2cap_ertm_config = NULL;
1065     uint8_t *l2cap_ertm_buffer = NULL;
1066     uint16_t l2cap_ertm_buffer_size = 0;
1067 
1068 #ifdef ENABLE_GOEP_L2CAP
1069 // singleton instance
1070     static uint8_t pbap_client_singleton_ertm_buffer[1000];
1071     static l2cap_ertm_config_t pbap_client_singleton_ertm_config = {
1072             1,  // ertm mandatory
1073             2,  // max transmit, some tests require > 1
1074             2000,
1075             12000,
1076             512,    // l2cap ertm mtu
1077             2,
1078             2,
1079             1,      // 16-bit FCS
1080     };
1081 
1082     l2cap_ertm_config = &pbap_client_singleton_ertm_config;
1083     l2cap_ertm_buffer = pbap_client_singleton_ertm_buffer;
1084     l2cap_ertm_buffer_size = sizeof(pbap_client_singleton_ertm_buffer);
1085 #endif
1086 
1087     if (pbap_client_singleton_used && pbap_client_singleton.state != PBAP_CLIENT_INIT){
1088         return BTSTACK_MEMORY_ALLOC_FAILED;
1089     }
1090 
1091     pbap_client_singleton_used = true;
1092 
1093     memset(&pbap_client_singleton, 0, sizeof(pbap_client_t));
1094     return pbap_client_connect(&pbap_client_singleton, l2cap_ertm_config, l2cap_ertm_buffer, l2cap_ertm_buffer_size, handler, addr, out_cid);
1095 }
1096 
1097 uint8_t pbap_disconnect(uint16_t pbap_cid){
1098     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1099     if (pbap_client == NULL){
1100         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1101     }
1102     if (pbap_client->state < PBAP_CLIENT_CONNECTED){
1103         return BTSTACK_BUSY;
1104     }
1105     pbap_client->state = PBAP_CLIENT_W2_SEND_DISCONNECT_REQUEST;
1106     goep_client_request_can_send_now(pbap_client->goep_cid);
1107     return ERROR_CODE_SUCCESS;
1108 }
1109 
1110 uint8_t pbap_get_phonebook_size(uint16_t pbap_cid, const char * path){
1111     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1112     if (pbap_client == NULL){
1113         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1114     }
1115     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1116         return BTSTACK_BUSY;
1117     }
1118     pbap_client->state = PBAP_CLIENT_W2_GET_PHONEBOOK_SIZE;
1119     pbap_client->phonebook_path = path;
1120     pbap_client->request_number = 0;
1121     goep_client_request_can_send_now(pbap_client->goep_cid);
1122     return ERROR_CODE_SUCCESS;
1123 }
1124 
1125 uint8_t pbap_pull_phonebook(uint16_t pbap_cid, const char * path){
1126     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1127     if (pbap_client == NULL){
1128         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1129     }
1130     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1131         return BTSTACK_BUSY;
1132     }
1133     pbap_client->state = PBAP_CLIENT_W2_PULL_PHONEBOOK;
1134     pbap_client->phonebook_path = path;
1135     pbap_client->vcard_name = NULL;
1136     pbap_client->request_number = 0;
1137     goep_client_request_can_send_now(pbap_client->goep_cid);
1138     return ERROR_CODE_SUCCESS;
1139 }
1140 
1141 uint8_t pbap_set_phonebook(uint16_t pbap_cid, const char * path){
1142     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1143     if (pbap_client == NULL){
1144         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1145     }
1146     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1147         return BTSTACK_BUSY;
1148     }
1149     pbap_client->state = PBAP_CLIENT_W2_SET_PATH_ROOT;
1150     pbap_client->current_folder = path;
1151     pbap_client->set_path_offset = 0;
1152     goep_client_request_can_send_now(pbap_client->goep_cid);
1153     return ERROR_CODE_SUCCESS;
1154 }
1155 
1156 uint8_t pbap_authentication_password(uint16_t pbap_cid, const char * password){
1157     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1158     if (pbap_client == NULL){
1159         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1160     }
1161     if (pbap_client->state != PBAP_CLIENT_W4_USER_AUTHENTICATION){
1162         return BTSTACK_BUSY;
1163     }
1164     pbap_client->state = PBAP_CLIENT_W2_SEND_AUTHENTICATED_CONNECT;
1165     pbap_client->authentication_password = password;
1166     goep_client_request_can_send_now(pbap_client->goep_cid);
1167     return ERROR_CODE_SUCCESS;
1168 }
1169 
1170 uint8_t pbap_pull_vcard_listing(uint16_t pbap_cid, const char * path){
1171     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1172     if (pbap_client == NULL){
1173         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1174     }
1175     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1176         return BTSTACK_BUSY;
1177     }
1178     pbap_client->state = PBAP_CLIENT_W2_GET_CARD_LIST;
1179     pbap_client->phonebook_path = path;
1180     pbap_client->phone_number = NULL;
1181     pbap_client->request_number = 0;
1182     pbap_client_vcard_listing_init_parser(pbap_client);
1183     goep_client_request_can_send_now(pbap_client->goep_cid);
1184     return ERROR_CODE_SUCCESS;
1185 }
1186 
1187 uint8_t pbap_pull_vcard_entry(uint16_t pbap_cid, const char * path){
1188     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1189     if (pbap_client == NULL){
1190         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1191     }
1192     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1193         return BTSTACK_BUSY;
1194     }
1195     pbap_client->state = PBAP_CLIENT_W2_GET_CARD_ENTRY;
1196     // pbap_client->phonebook_path = NULL;
1197     // pbap_client->phone_number = NULL;
1198     pbap_client->vcard_name = path;
1199     pbap_client->request_number = 0;
1200     goep_client_request_can_send_now(pbap_client->goep_cid);
1201     return ERROR_CODE_SUCCESS;
1202 }
1203 
1204 uint8_t pbap_lookup_by_number(uint16_t pbap_cid, const char * phone_number){
1205     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1206     if (pbap_client == NULL){
1207         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1208     }
1209     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1210         return BTSTACK_BUSY;
1211     }
1212     pbap_client->state = PBAP_CLIENT_W2_GET_CARD_LIST;
1213     pbap_client->phonebook_path = pbap_vcard_listing_name;
1214     pbap_client->phone_number   = phone_number;
1215     pbap_client->request_number = 0;
1216     pbap_client_vcard_listing_init_parser(pbap_client);
1217     goep_client_request_can_send_now(pbap_client->goep_cid);
1218     return ERROR_CODE_SUCCESS;
1219 }
1220 
1221 uint8_t pbap_abort(uint16_t pbap_cid){
1222     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1223     if (pbap_client == NULL){
1224         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1225     }
1226     if ((pbap_client->state < PBAP_CLIENT_CONNECTED) || (pbap_client->abort_operation != 0)){
1227         return ERROR_CODE_COMMAND_DISALLOWED;
1228     }
1229     log_info("abort current operation, state 0x%02x", pbap_client->state);
1230     pbap_client->abort_operation = 1;
1231     return ERROR_CODE_SUCCESS;
1232 }
1233 
1234 uint8_t pbap_next_packet(uint16_t pbap_cid){
1235     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1236     if (pbap_client == NULL){
1237         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1238     }
1239     if (!pbap_client->flow_control_enabled){
1240         return ERROR_CODE_SUCCESS;
1241     }
1242     switch (pbap_client->state){
1243         case PBAP_CLIENT_W2_PULL_PHONEBOOK:
1244             goep_client_request_can_send_now(pbap_client->goep_cid);
1245             break;
1246         case PBAP_CLIENT_W4_PHONEBOOK:
1247             pbap_client->flow_next_triggered = 1;
1248             break;
1249         default:
1250             break;
1251     }
1252     return ERROR_CODE_SUCCESS;
1253 }
1254 
1255 uint8_t pbap_set_flow_control_mode(uint16_t pbap_cid, int enable){
1256     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1257     if (pbap_client == NULL){
1258         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1259     }
1260     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1261         return BTSTACK_BUSY;
1262     }
1263     pbap_client->flow_control_enabled = enable;
1264     return ERROR_CODE_SUCCESS;
1265 }
1266 
1267 uint8_t pbap_set_vcard_selector(uint16_t pbap_cid, uint32_t vcard_selector){
1268     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1269     if (pbap_client == NULL){
1270         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1271     }
1272     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1273         return BTSTACK_BUSY;
1274     }
1275     pbap_client->vcard_selector = vcard_selector;
1276     return ERROR_CODE_SUCCESS;
1277 }
1278 
1279 uint8_t pbap_set_vcard_selector_operator(uint16_t pbap_cid, int vcard_selector_operator){
1280     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1281     if (pbap_client == NULL){
1282         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1283     }
1284     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1285         return BTSTACK_BUSY;
1286     }
1287     pbap_client->vcard_selector_operator = vcard_selector_operator;
1288     return ERROR_CODE_SUCCESS;
1289 }
1290 
1291 uint8_t pbap_set_property_selector(uint16_t pbap_cid, uint32_t property_selector){
1292     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1293     if (pbap_client == NULL){
1294         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1295     }
1296     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1297         return BTSTACK_BUSY;
1298     }
1299     pbap_client->property_selector  = property_selector;
1300     return ERROR_CODE_SUCCESS;
1301 }
1302 
1303 uint8_t pbap_set_max_list_count(uint16_t pbap_cid, uint16_t max_list_count){
1304     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1305     if (pbap_client == NULL){
1306         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1307     }
1308     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1309         return BTSTACK_BUSY;
1310     }
1311     pbap_client->max_list_count = max_list_count;
1312     return ERROR_CODE_SUCCESS;
1313 }
1314 
1315 uint8_t pbap_set_list_start_offset(uint16_t pbap_cid, uint16_t list_start_offset){
1316     pbap_client_t * pbap_client = pbap_client_for_cid(pbap_cid);
1317     if (pbap_client == NULL){
1318         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
1319     }
1320     if (pbap_client->state != PBAP_CLIENT_CONNECTED){
1321         return BTSTACK_BUSY;
1322     }
1323     pbap_client->list_start_offset = list_start_offset;
1324     return ERROR_CODE_SUCCESS;
1325 }
1326