1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef __GOEP_CLIENT_H 39 40 #if defined __cplusplus 41 extern "C" { 42 #endif 43 44 #include <stdint.h> 45 #include <stdio.h> 46 #include <stdlib.h> 47 #include <string.h> 48 49 #include "btstack_defines.h" 50 51 //------------------------------------------------------------------------------------------------------------ 52 // goep_client.h 53 // 54 // Communicate with remote OBEX server - General Object Exchange 55 // 56 57 /* API_START */ 58 59 // remote does not expose PBAP features in SDP record 60 #define PBAP_FEATURES_NOT_PRESENT ((uint32_t) -1) 61 62 /** 63 * Setup GOEP Client 64 */ 65 void goep_client_init(void); 66 67 /* 68 * @brief Create GOEP connection to a GEOP server with specified UUID on a remote deivce. 69 * @param handler 70 * @param addr 71 * @param uuid 72 * @param out_cid to use for further commands 73 * @result status 74 */ 75 uint8_t goep_client_create_connection(btstack_packet_handler_t handler, bd_addr_t addr, uint16_t uuid, uint16_t * out_cid); 76 77 /** 78 * @brief Disconnects GOEP connection with given identifier. 79 * @param gope_cid 80 * @return status 81 */ 82 uint8_t goep_client_disconnect(uint16_t goep_cid); 83 84 /** 85 * @brief Request emission of GOEP_SUBEVENT_CAN_SEND_NOW as soon as possible 86 * @note GOEP_SUBEVENT_CAN_SEND_NOW might be emitted during call to this function 87 * so packet handler should be ready to handle it 88 * @param goep_cid 89 */ 90 void goep_client_request_can_send_now(uint16_t goep_cid); 91 92 /** 93 * @brief Get Opcode from last created request, needed for parsing of OBEX response packet 94 * @param gope_cid 95 * @return opcode 96 */ 97 uint8_t goep_client_get_request_opcode(uint16_t goep_cid); 98 99 /** 100 * brief Get PBAP Supported Features found in SDP record during conenct 101 */ 102 uint32_t goep_client_get_pbap_supported_features(uint16_t goep_cid); 103 104 /** 105 * @brief Set Connection ID used for newly created requests 106 * @param gope_cid 107 */ 108 void goep_client_set_connection_id(uint16_t goep_cid, uint32_t connection_id); 109 110 /** 111 * @brief Start Connect request 112 * @param gope_cid 113 * @param obex_version_number 114 * @param flags 115 * @param maximum_obex_packet_length 116 */ 117 void goep_client_create_connect_request(uint16_t goep_cid, uint8_t obex_version_number, uint8_t flags, uint16_t maximum_obex_packet_length); 118 119 /** 120 * @brief Start Disconnect request 121 * @param gope_cid 122 */ 123 void goep_client_create_disconnect_request(uint16_t goep_cid); 124 125 /** 126 * @brief Create Get request 127 * @param gope_cid 128 */ 129 void goep_client_create_get_request(uint16_t goep_cid); 130 131 /** 132 * @brief Create Abort request 133 * @param gope_cid 134 */ 135 void goep_client_create_abort_request(uint16_t goep_cid); 136 137 /** 138 * @brief Add SRM Enable 139 * @param gope_cid 140 */ 141 void goep_client_add_header_srm_enable(uint16_t goep_cid); 142 143 /** 144 * @brief Start Set Path request 145 * @param gope_cid 146 */ 147 void goep_client_create_set_path_request(uint16_t goep_cid, uint8_t flags); 148 149 // not implemented yet 150 // void goep_client_create_put(uint16_t goep_cid); 151 152 /** 153 * @brief Add header with single byte value (8 bit) 154 * @param gope_cid 155 * @param header_type 156 * @param value 157 */ 158 void goep_client_add_byte_header(uint16_t goep_cid, uint8_t header_type, uint8_t value); 159 160 /** 161 * @brief Add header with word value (32 bit) 162 * @param gope_cid 163 * @param header_type 164 * @param value 165 */ 166 void goep_client_add_word_header(uint16_t goep_cid, uint8_t header_type, uint32_t value); 167 168 /** 169 * @brief Add header with variable size 170 * @param gope_cid 171 * @param header_type 172 * @param value 173 */ 174 void goep_client_add_variable_header(uint16_t goep_cid, uint8_t header_type, uint16_t header_data_length, const uint8_t * header_data); 175 176 /** 177 * @brief Add name header to current request 178 * @param goep_cid 179 * @param name 180 */ 181 void goep_client_add_header_name(uint16_t goep_cid, const char * name); 182 183 /** 184 * @brief Add target header to current request 185 * @param goep_cid 186 * @param target 187 */ 188 void goep_client_add_header_target(uint16_t goep_cid, uint16_t length, const uint8_t * target); 189 190 /** 191 * @brief Add type header to current request 192 * @param goep_cid 193 * @param type 194 */ 195 void goep_client_add_header_type(uint16_t goep_cid, const char * type); 196 197 /** 198 * @brief Add count header to current request 199 * @param goep_cid 200 * @param count 201 */ 202 void goep_client_add_header_count(uint16_t goep_cid, uint32_t count); 203 204 /** 205 * @brief Add application parameters header to current request 206 * @param goep_cid 207 * @param lenght of application parameters 208 * @param data 209 */ 210 void goep_client_add_header_application_parameters(uint16_t goep_cid, uint16_t length, const uint8_t * data); 211 212 /** 213 * @brief Add application parameters header to current request 214 * @param goep_cid 215 * @param lenght of challenge response 216 * @param data 217 */ 218 void goep_client_add_header_challenge_response(uint16_t goep_cid, uint16_t length, const uint8_t * data); 219 220 // int goep_client_add_body_static(uint16_t goep_cid, uint32_t length, uint8_t * data); 221 // int goep_client_add_body_dynamic(uint16_t goep_cid, uint32_t length, void (*data_callback)(uint32_t offset, uint8_t * buffer, uint32_t len)); 222 223 /** 224 * @brief Execute prepared request 225 * @param goep_cid 226 * @param daa 227 */ 228 int goep_client_execute(uint16_t goep_cid); 229 230 /* API_END */ 231 232 #if defined __cplusplus 233 } 234 #endif 235 #endif 236 237