1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * @title PBAP Client 40 * 41 */ 42 43 #ifndef PBAP_CLIENT_H 44 #define PBAP_CLIENT_H 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 #include "btstack_config.h" 51 #include "yxml.h" 52 #include <stdint.h> 53 54 // max len of phone number used for lookup in pbap_lookup_by_number 55 #define PBAP_MAX_PHONE_NUMBER_LEN 32 56 57 // max len of name reported in PBAP_SUBEVENT_CARD_RESULT 58 #define PBAP_MAX_NAME_LEN 32 59 // max len of vcard handle reported in PBAP_SUBEVENT_CARD_RESULT 60 #define PBAP_MAX_HANDLE_LEN 16 61 62 63 typedef enum { 64 PBAP_CLIENT_INIT = 0, 65 PBAP_CLIENT_W4_GOEP_CONNECTION, 66 PBAP_CLIENT_W2_SEND_CONNECT_REQUEST, 67 PBAP_CLIENT_W4_CONNECT_RESPONSE, 68 PBAP_CLIENT_W4_USER_AUTHENTICATION, 69 PBAP_CLIENT_W2_SEND_AUTHENTICATED_CONNECT, 70 PBAP_CLIENT_CONNECTED, 71 // 72 PBAP_CLIENT_W2_SEND_DISCONNECT_REQUEST, 73 PBAP_CLIENT_W4_DISCONNECT_RESPONSE, 74 // 75 PBAP_CLIENT_W2_PULL_PHONEBOOK, 76 PBAP_CLIENT_W4_PHONEBOOK, 77 PBAP_CLIENT_W2_SET_PATH_ROOT, 78 PBAP_CLIENT_W4_SET_PATH_ROOT_COMPLETE, 79 PBAP_CLIENT_W2_SET_PATH_ELEMENT, 80 PBAP_CLIENT_W4_SET_PATH_ELEMENT_COMPLETE, 81 PBAP_CLIENT_W2_GET_PHONEBOOK_SIZE, 82 PBAP_CLIENT_W4_GET_PHONEBOOK_SIZE_COMPLETE, 83 // - pull vacard liast 84 PBAP_CLIENT_W2_GET_CARD_LIST, 85 PBAP_CLIENT_W4_GET_CARD_LIST_COMPLETE, 86 // - pull vcard entry 87 PBAP_CLIENT_W2_GET_CARD_ENTRY, 88 PBAP_CLIENT_W4_GET_CARD_ENTRY_COMPLETE, 89 // abort operation 90 PBAP_CLIENT_W4_ABORT_COMPLETE, 91 92 } pbap_client_state_t; 93 94 typedef enum { 95 PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_TYPE = 0, 96 PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_LEN, 97 PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_W4_VALUE, 98 PBAP_CLIENT_PHONEBOOK_SIZE_PARSER_STATE_INVALID, 99 } pbap_client_phonebook_size_parser_state_t; 100 101 typedef struct { 102 // parsing 103 pbap_client_phonebook_size_parser_state_t state; 104 uint8_t type; 105 uint8_t len; 106 uint8_t pos; 107 // data 108 bool have_size; 109 uint8_t size_buffer[2]; 110 } pbap_client_phonebook_size_parser_t; 111 112 typedef enum { 113 PBAP_CLIENT_SRM_DISABLED, 114 PBAP_CLIENT_SRM_W4_CONFIRM, 115 PBAP_CLIENT_SRM_ENABLED_BUT_WAITING, 116 PBAP_CLIENT_SRM_ENABLED 117 } pbap_client_obex_srm_state_t; 118 119 typedef struct { 120 pbap_client_obex_srm_state_t srm_state; 121 122 uint8_t srm_value; 123 uint8_t srmp_value; 124 } pbap_client_obex_srm_t; 125 126 typedef enum { 127 OBEX_AUTH_PARSER_STATE_W4_TYPE = 0, 128 OBEX_AUTH_PARSER_STATE_W4_LEN, 129 OBEX_AUTH_PARSER_STATE_W4_VALUE, 130 OBEX_AUTH_PARSER_STATE_INVALID, 131 } pbap_client_obex_auth_parser_state_t; 132 133 typedef struct { 134 // parsing 135 pbap_client_obex_auth_parser_state_t state; 136 uint8_t type; 137 uint8_t len; 138 uint8_t pos; 139 // data 140 uint8_t authentication_options; 141 uint16_t authentication_nonce[16]; 142 } pbap_client_obex_auth_parser_t; 143 144 typedef struct pbap_client { 145 // pbap client linked list 146 btstack_linked_item_t item; 147 148 // goep client linked list 149 goep_client_t goep_client; 150 151 pbap_client_state_t state; 152 bd_addr_t bd_addr; 153 hci_con_handle_t con_handle; 154 uint16_t goep_cid; 155 btstack_packet_handler_t client_handler; 156 int request_number; 157 const char * current_folder; 158 const char * phone_number; 159 const char * phonebook_path; 160 const char * vcard_name; 161 uint16_t set_path_offset; 162 /* vcard selector / operator */ 163 uint32_t vcard_selector; 164 uint8_t vcard_selector_operator; 165 uint8_t vcard_selector_supported; 166 /* property selector */ 167 uint32_t property_selector; 168 uint16_t list_start_offset; 169 uint16_t max_list_count; 170 /* abort */ 171 uint8_t abort_operation; 172 /* obex parser */ 173 bool obex_parser_waiting_for_response; 174 obex_parser_t obex_parser; 175 uint8_t obex_header_buffer[4]; 176 /* authentication */ 177 pbap_client_obex_auth_parser_t obex_auth_parser; 178 const char * authentication_password; 179 /* xml parser */ 180 yxml_t xml_parser; 181 uint8_t xml_buffer[50]; 182 /* vcard listing parser */ 183 bool parser_card_found; 184 bool parser_name_found; 185 bool parser_handle_found; 186 char parser_name[PBAP_MAX_NAME_LEN]; 187 char parser_handle[PBAP_MAX_HANDLE_LEN]; 188 /* phonebook size */ 189 pbap_client_phonebook_size_parser_t phonebook_size_parser; 190 /* flow control mode */ 191 uint8_t flow_control_enabled; 192 uint8_t flow_next_triggered; 193 bool flow_wait_for_user; 194 /* srm */ 195 pbap_client_obex_srm_t obex_srm; 196 } pbap_client_t; 197 198 /* API_START */ 199 200 /** 201 * Setup PhoneBook Access Client 202 */ 203 void pbap_client_init(void); 204 205 /** 206 * @brief Create PBAP connection to a Phone Book Server (PSE) server on a remote device. 207 * If the server requires authentication, a PBAP_SUBEVENT_AUTHENTICATION_REQUEST is emitted, which 208 * can be answered with pbap_authentication_password(..). 209 * The status of PBAP connection establishment is reported via PBAP_SUBEVENT_CONNECTION_OPENED event, 210 * i.e. on success status field is set to ERROR_CODE_SUCCESS. 211 * 212 * This function allows for multiple parallel connections. 213 * 214 * @param client storage for connection state. Must stay valid until connection closes 215 * @param l2cap_ertm_config 216 * @param l2cap_ertm_buffer_size 217 * @param l2cap_ertm_buffer 218 * @param handler 219 * @param addr 220 * @param out_cid to use for further commands 221 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_MEMORY_ALLOC_FAILED if PBAP or GOEP connection already exists. 222 */ 223 224 uint8_t pbap_client_connect(pbap_client_t * client, l2cap_ertm_config_t *l2cap_ertm_config, uint8_t *l2cap_ertm_buffer, 225 uint16_t l2cap_ertm_buffer_size, btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid); 226 227 /** 228 * @brief Create PBAP connection to a Phone Book Server (PSE) server on a remote device. 229 * If the server requires authentication, a PBAP_SUBEVENT_AUTHENTICATION_REQUEST is emitted, which 230 * can be answered with pbap_authentication_password(..). 231 * The status of PBAP connection establishment is reported via PBAP_SUBEVENT_CONNECTION_OPENED event, 232 * i.e. on success status field is set to ERROR_CODE_SUCCESS. 233 * 234 * This function uses a single pbap_client_t and l2cap ertm buffer instance and can only be used for a single connection. 235 * Fur multiple parallel connections, use pbap_client_connect. 236 * 237 * @param handler 238 * @param addr 239 * @param out_cid to use for further commands 240 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_MEMORY_ALLOC_FAILED if PBAP or GOEP connection already exists. 241 */ 242 uint8_t pbap_connect(btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid); 243 244 /** 245 * @brief Provide password for OBEX Authentication after receiving PBAP_SUBEVENT_AUTHENTICATION_REQUEST. 246 * The status of PBAP connection establishment is reported via PBAP_SUBEVENT_CONNECTION_OPENED event, 247 * i.e. on success status field is set to ERROR_CODE_SUCCESS. 248 * 249 * @param pbap_cid 250 * @param password (null terminated string) - not copied, needs to stay valid until connection completed 251 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 252 */ 253 uint8_t pbap_authentication_password(uint16_t pbap_cid, const char * password); 254 255 /** 256 * @brief Disconnects PBAP connection with given identifier. 257 * Event PBAP_SUBEVENT_CONNECTION_CLOSED indicates that PBAP connection is closed. 258 * 259 * @param pbap_cid 260 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 261 */ 262 uint8_t pbap_disconnect(uint16_t pbap_cid); 263 264 /** 265 * @brief Set current folder on PSE. The status is reported via PBAP_SUBEVENT_OPERATION_COMPLETED event. 266 * 267 * @param pbap_cid 268 * @param path - note: path is not copied 269 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 270 */ 271 uint8_t pbap_set_phonebook(uint16_t pbap_cid, const char * path); 272 273 /** 274 * @brief Set vCard Selector for get/pull phonebook. No event is emitted. 275 * 276 * @param pbap_cid 277 * @param vcard_selector - combination of PBAP_PROPERTY_MASK_* properties 278 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 279 */ 280 uint8_t pbap_set_vcard_selector(uint16_t pbap_cid, uint32_t vcard_selector); 281 282 /** 283 * @brief Set vCard Selector for get/pull phonebook. No event is emitted. 284 * 285 * @param pbap_cid 286 * @param vcard_selector_operator - PBAP_VCARD_SELECTOR_OPERATOR_OR (default) or PBAP_VCARD_SELECTOR_OPERATOR_AND 287 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 288 */ 289 uint8_t pbap_set_vcard_selector_operator(uint16_t pbap_cid, int vcard_selector_operator); 290 291 /** 292 * @brief Set Property Selector. No event is emitted. 293 * @param pbap_cid 294 * @param property_selector - combination of PBAP_PROPERTY_MASK_* properties 295 * @return 296 */ 297 uint8_t pbap_set_property_selector(uint16_t pbap_cid, uint32_t property_selector); 298 299 /** 300 * @brief Set number of items returned by pull phonebook. 301 * @param pbap_cid 302 * @param max_list_count 303 * @return 304 */ 305 uint8_t pbap_set_max_list_count(uint16_t pbap_cid, uint16_t max_list_count); 306 307 /** 308 * @bbrief Set start offset for pull phonebook 309 * @param pbap_cid 310 * @param list_start_offset 311 * @return 312 */ 313 uint8_t pbap_set_list_start_offset(uint16_t pbap_cid, uint16_t list_start_offset); 314 315 /** 316 * @brief Get size of phone book from PSE. The result is reported via PBAP_SUBEVENT_PHONEBOOK_SIZE event. 317 * 318 * @param pbap_cid 319 * @param path - note: path is not copied, common path 'telecom/pb.vcf' 320 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 321 */ 322 uint8_t pbap_get_phonebook_size(uint16_t pbap_cid, const char * path); 323 324 /** 325 * @brief Pull phone book from PSE. The result is reported via registered packet handler (see pbap_connect function), 326 * with packet type set to PBAP_DATA_PACKET. Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of the phone book. 327 * 328 * @param pbap_cid 329 * @param path - note: path is not copied, common path 'telecom/pb.vcf' 330 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 331 */ 332 uint8_t pbap_pull_phonebook(uint16_t pbap_cid, const char * path); 333 334 /** 335 * @brief Pull vCard listing. vCard data is emitted via PBAP_SUBEVENT_CARD_RESULT event. 336 * Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of vCard listing. 337 * 338 * @param pbap_cid 339 * @param path 340 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 341 */ 342 uint8_t pbap_pull_vcard_listing(uint16_t pbap_cid, const char * path); 343 344 /** 345 * @brief Pull vCard entry. The result is reported via callback (see pbap_connect function), 346 * with packet type set to PBAP_DATA_PACKET. 347 * Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of the vCard entry. 348 * 349 * @param pbap_cid 350 * @param path 351 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 352 */ 353 uint8_t pbap_pull_vcard_entry(uint16_t pbap_cid, const char * path); 354 355 /** 356 * @brief Lookup contact(s) by phone number. vCard data is emitted via PBAP_SUBEVENT_CARD_RESULT event. 357 * Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of the lookup. 358 * 359 * @param pbap_cid 360 * @param phone_number 361 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 362 */ 363 uint8_t pbap_lookup_by_number(uint16_t pbap_cid, const char * phone_number); 364 365 /** 366 * @brief Abort current operation. No event is emitted. 367 * 368 * @param pbap_cid 369 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 370 */ 371 uint8_t pbap_abort(uint16_t pbap_cid); 372 373 374 /** 375 * @brief Set flow control mode - default is off. No event is emitted. 376 * @note When enabled, pbap_next_packet needs to be called after a packet was processed to receive the next one 377 * 378 * @param pbap_cid 379 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 380 */ 381 uint8_t pbap_set_flow_control_mode(uint16_t pbap_cid, int enable); 382 383 /** 384 * @brief Trigger next packet from PSE when Flow Control Mode is enabled. 385 * @param pbap_cid 386 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 387 */ 388 uint8_t pbap_next_packet(uint16_t pbap_cid); 389 390 /** 391 * @brief De-Init PBAP Client 392 */ 393 void pbap_client_deinit(void); 394 395 /* API_END */ 396 397 #if defined __cplusplus 398 } 399 #endif 400 #endif 401