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 struct pbap_client { 113 // pbap client linked list 114 btstack_linked_item_t item; 115 116 // goep client linked list 117 goep_client_t goep_client; 118 119 uint16_t cid; 120 pbap_client_state_t state; 121 bd_addr_t bd_addr; 122 hci_con_handle_t con_handle; 123 uint8_t incoming; 124 uint16_t goep_cid; 125 btstack_packet_handler_t client_handler; 126 int request_number; 127 const char * current_folder; 128 const char * phone_number; 129 const char * phonebook_path; 130 const char * vcard_name; 131 uint16_t set_path_offset; 132 /* vcard selector / operator */ 133 uint32_t vcard_selector; 134 uint8_t vcard_selector_operator; 135 uint8_t vcard_selector_supported; 136 /* property selector */ 137 uint32_t property_selector; 138 uint16_t list_start_offset; 139 uint16_t max_list_count; 140 /* abort */ 141 uint8_t abort_operation; 142 /* obex parser */ 143 bool obex_parser_waiting_for_response; 144 obex_parser_t obex_parser; 145 uint8_t obex_header_buffer[4]; 146 /* authentication */ 147 obex_auth_parser_t obex_auth_parser; 148 const char * authentication_password; 149 /* xml parser */ 150 yxml_t xml_parser; 151 uint8_t xml_buffer[50]; 152 /* vcard listing parser */ 153 bool parser_card_found; 154 bool parser_name_found; 155 bool parser_handle_found; 156 char parser_name[PBAP_MAX_NAME_LEN]; 157 char parser_handle[PBAP_MAX_HANDLE_LEN]; 158 /* phonebook size */ 159 pbap_client_phonebook_size_parser_t phonebook_size_parser; 160 /* flow control mode */ 161 uint8_t flow_control_enabled; 162 uint8_t flow_next_triggered; 163 bool flow_wait_for_user; 164 /* srm */ 165 obex_srm_t obex_srm; 166 obex_srm_state_t srm_state; 167 } pbap_client_t; 168 169 /* API_START */ 170 171 /** 172 * Setup PhoneBook Access Client 173 */ 174 void pbap_client_init(void); 175 176 /** 177 * @brief Create PBAP connection to a Phone Book Server (PSE) server on a remote device. 178 * If the server requires authentication, a PBAP_SUBEVENT_AUTHENTICATION_REQUEST is emitted, which 179 * can be answered with pbap_authentication_password(..). 180 * The status of PBAP connection establishment is reported via PBAP_SUBEVENT_CONNECTION_OPENED event, 181 * i.e. on success status field is set to ERROR_CODE_SUCCESS. 182 * 183 * @param handler 184 * @param addr 185 * @param out_cid to use for further commands 186 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_MEMORY_ALLOC_FAILED if PBAP or GOEP connection already exists. 187 */ 188 uint8_t pbap_connect(btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid); 189 190 /** 191 * @brief Provide password for OBEX Authentication after receiving PBAP_SUBEVENT_AUTHENTICATION_REQUEST. 192 * The status of PBAP connection establishment is reported via PBAP_SUBEVENT_CONNECTION_OPENED event, 193 * i.e. on success status field is set to ERROR_CODE_SUCCESS. 194 * 195 * @param pbap_cid 196 * @param password (null terminated string) - not copied, needs to stay valid until connection completed 197 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 198 */ 199 uint8_t pbap_authentication_password(uint16_t pbap_cid, const char * password); 200 201 /** 202 * @brief Disconnects PBAP connection with given identifier. 203 * Event PBAP_SUBEVENT_CONNECTION_CLOSED indicates that PBAP connection is closed. 204 * 205 * @param pbap_cid 206 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 207 */ 208 uint8_t pbap_disconnect(uint16_t pbap_cid); 209 210 /** 211 * @brief Set current folder on PSE. The status is reported via PBAP_SUBEVENT_OPERATION_COMPLETED event. 212 * 213 * @param pbap_cid 214 * @param path - note: path is not copied 215 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 216 */ 217 uint8_t pbap_set_phonebook(uint16_t pbap_cid, const char * path); 218 219 /** 220 * @brief Set vCard Selector for get/pull phonebook. No event is emitted. 221 * 222 * @param pbap_cid 223 * @param vcard_selector - combination of PBAP_PROPERTY_MASK_* properties 224 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 225 */ 226 uint8_t pbap_set_vcard_selector(uint16_t pbap_cid, uint32_t vcard_selector); 227 228 /** 229 * @brief Set vCard Selector for get/pull phonebook. No event is emitted. 230 * 231 * @param pbap_cid 232 * @param vcard_selector_operator - PBAP_VCARD_SELECTOR_OPERATOR_OR (default) or PBAP_VCARD_SELECTOR_OPERATOR_AND 233 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 234 */ 235 uint8_t pbap_set_vcard_selector_operator(uint16_t pbap_cid, int vcard_selector_operator); 236 237 /** 238 * @brief Set Property Selector. No event is emitted. 239 * @param pbap_cid 240 * @param property_selector - combination of PBAP_PROPERTY_MASK_* properties 241 * @return 242 */ 243 uint8_t pbap_set_property_selector(uint16_t pbap_cid, uint32_t property_selector); 244 245 /** 246 * @brief Set number of items returned by pull phonebook. 247 * @param pbap_cid 248 * @param max_list_count 249 * @return 250 */ 251 uint8_t pbap_set_max_list_count(uint16_t pbap_cid, uint16_t max_list_count); 252 253 /** 254 * @bbrief Set start offset for pull phonebook 255 * @param pbap_cid 256 * @param list_start_offset 257 * @return 258 */ 259 uint8_t pbap_set_list_start_offset(uint16_t pbap_cid, uint16_t list_start_offset); 260 261 /** 262 * @brief Get size of phone book from PSE. The result is reported via PBAP_SUBEVENT_PHONEBOOK_SIZE event. 263 * 264 * @param pbap_cid 265 * @param path - note: path is not copied, common path 'telecom/pb.vcf' 266 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 267 */ 268 uint8_t pbap_get_phonebook_size(uint16_t pbap_cid, const char * path); 269 270 /** 271 * @brief Pull phone book from PSE. The result is reported via registered packet handler (see pbap_connect function), 272 * with packet type set to PBAP_DATA_PACKET. Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of the phone book. 273 * 274 * @param pbap_cid 275 * @param path - note: path is not copied, common path 'telecom/pb.vcf' 276 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 277 */ 278 uint8_t pbap_pull_phonebook(uint16_t pbap_cid, const char * path); 279 280 /** 281 * @brief Pull vCard listing. vCard data is emitted via PBAP_SUBEVENT_CARD_RESULT event. 282 * Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of vCard listing. 283 * 284 * @param pbap_cid 285 * @param path 286 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 287 */ 288 uint8_t pbap_pull_vcard_listing(uint16_t pbap_cid, const char * path); 289 290 /** 291 * @brief Pull vCard entry. The result is reported via callback (see pbap_connect function), 292 * with packet type set to PBAP_DATA_PACKET. 293 * Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of the vCard entry. 294 * 295 * @param pbap_cid 296 * @param path 297 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 298 */ 299 uint8_t pbap_pull_vcard_entry(uint16_t pbap_cid, const char * path); 300 301 /** 302 * @brief Lookup contact(s) by phone number. vCard data is emitted via PBAP_SUBEVENT_CARD_RESULT event. 303 * Event PBAP_SUBEVENT_OPERATION_COMPLETED marks the end of the lookup. 304 * 305 * @param pbap_cid 306 * @param phone_number 307 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 308 */ 309 uint8_t pbap_lookup_by_number(uint16_t pbap_cid, const char * phone_number); 310 311 /** 312 * @brief Abort current operation. No event is emitted. 313 * 314 * @param pbap_cid 315 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 316 */ 317 uint8_t pbap_abort(uint16_t pbap_cid); 318 319 320 /** 321 * @brief Set flow control mode - default is off. No event is emitted. 322 * @note When enabled, pbap_next_packet needs to be called after a packet was processed to receive the next one 323 * 324 * @param pbap_cid 325 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 326 */ 327 uint8_t pbap_set_flow_control_mode(uint16_t pbap_cid, int enable); 328 329 /** 330 * @brief Trigger next packet from PSE when Flow Control Mode is enabled. 331 * @param pbap_cid 332 * @return status ERROR_CODE_SUCCESS on success, otherwise BTSTACK_BUSY if in a wrong state. 333 */ 334 uint8_t pbap_next_packet(uint16_t pbap_cid); 335 336 /** 337 * @brief De-Init PBAP Client 338 */ 339 void pbap_client_deinit(void); 340 341 /* API_END */ 342 343 #if defined __cplusplus 344 } 345 #endif 346 #endif 347