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