1 /* 2 * Copyright (C) 2019 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 * OBEX Message Builder 40 * 41 */ 42 43 #ifndef OBEX_MESSAGE_BUILDER_H 44 #define OBEX_MESSAGE_BUILDER_H 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 #include <stdint.h> 51 #include <string.h> 52 53 #include "btstack_defines.h" 54 55 //------------------------------------------------------------------------------------------------------------ 56 // obex_message_builder.h 57 // 58 // Functions to incrementaly construct an OBEX message. The current length of the message is stored at 59 // offset 1 in the buffer. All functions return status code ERROR_CODE_MEMORY_CAPACITY_EXCEEDED id the 60 // buffer is too small. 61 62 /* API_START */ 63 /** 64 * @brief Get message lenght 65 * @param buffer 66 * @return buffer_length 67 */ 68 uint16_t obex_message_builder_get_message_length(uint8_t * buffer); 69 70 /** 71 * @brief Start Connect request 72 * @param buffer 73 * @param buffer_len 74 * @param obex_version_number 75 * @param flags 76 * @param maximum_obex_packet_length 77 * @return status 78 */ 79 uint8_t obex_message_builder_request_create_connect(uint8_t * buffer, uint16_t buffer_len, uint8_t obex_version_number, uint8_t flags, uint16_t maximum_obex_packet_length); 80 81 /** 82 * @brief Start Connect response 83 * @param buffer 84 * @param buffer_len 85 * @param obex_version_number 86 * @param flags 87 * @param maximum_obex_packet_length 88 * @param connection_id 89 * @return status 90 */ 91 uint8_t obex_message_builder_response_create_connect(uint8_t * buffer, uint16_t buffer_len, uint8_t obex_version_number, uint8_t flags, uint16_t maximum_obex_packet_length, uint32_t connection_id); 92 93 /** 94 * @brief Start General response with given response code 95 * @param buffer 96 * @param buffer_len 97 * @param response_code 98 * @return status 99 */ 100 uint8_t obex_message_builder_response_create_general(uint8_t * buffer, uint16_t buffer_len, uint8_t response_code); 101 102 /** 103 * @brief Update response code 104 * @param buffer 105 * @param buffer_len 106 * @param response_code 107 * @return status 108 */ 109 uint8_t obex_message_builder_response_update_code(uint8_t * buffer, uint16_t buffer_len, uint8_t response_code); 110 111 /** 112 * @brief Start Disconnect request 113 * @param buffer 114 * @param buffer_len 115 * @param connection_id 116 * @return status 117 */ 118 uint8_t obex_message_builder_request_create_disconnect(uint8_t * buffer, uint16_t buffer_len, uint32_t connection_id); 119 120 /** 121 * @brief Create Get request 122 * @param buffer 123 * @param buffer_len 124 * @param connection_id 125 * @return status 126 */ 127 uint8_t obex_message_builder_request_create_get(uint8_t * buffer, uint16_t buffer_len, uint32_t connection_id); 128 129 /** 130 * @brief Create Put request 131 * @param buffer 132 * @param buffer_len 133 * @param connection_id 134 * @return status 135 */ 136 uint8_t obex_message_builder_request_create_put(uint8_t * buffer, uint16_t buffer_len, uint32_t connection_id); 137 138 139 /** 140 * @brief Create Abort request 141 * @param buffer 142 * @param buffer_len 143 * @param connection_id 144 * @return status 145 */ 146 uint8_t obex_message_builder_request_create_abort(uint8_t * buffer, uint16_t buffer_len, uint32_t connection_id); 147 148 /** 149 * @brief Start Set Path request 150 * @param buffer 151 * @param buffer_len 152 * @param connection_id 153 * @return status 154 */ 155 uint8_t obex_message_builder_request_create_set_path(uint8_t * buffer, uint16_t buffer_len, uint8_t flags, uint32_t connection_id); 156 157 /** 158 * @brief Control the "final" bit 159 * @param buffer 160 * @param buffer_len 161 * @param final 162 * @return status 163 */ 164 uint8_t obex_message_builder_set_final_bit (uint8_t * buffer, uint16_t buffer_len, bool final); 165 166 /** 167 * @brief Add SRM Enable 168 * @param buffer 169 * @param buffer_len 170 * @return status 171 */ 172 uint8_t obex_message_builder_header_add_srm_enable(uint8_t * buffer, uint16_t buffer_len); 173 174 /** 175 * @brief Add SRMP wait header 176 * @param buffer 177 * @param buffer_len 178 * @return status 179 */ 180 uint8_t obex_message_builder_header_add_srmp_wait(uint8_t* buffer, uint16_t buffer_len); 181 182 183 /** 184 * @brief Add header with single byte value (8 bit) 185 * @param buffer 186 * @param buffer_len 187 * @param header_type 188 * @param value 189 * @return status 190 */ 191 uint8_t obex_message_builder_header_add_byte(uint8_t * buffer, uint16_t buffer_len, uint8_t header_type, uint8_t value); 192 193 /** 194 * @brief Add header with word value (32 bit) 195 * @param buffer 196 * @param buffer_len 197 * @param header_type 198 * @param value 199 * @return status 200 */ 201 uint8_t obex_message_builder_header_add_word(uint8_t * buffer, uint16_t buffer_len, uint8_t header_type, uint32_t value); 202 203 /** 204 * @brief Add header with variable size 205 * @param buffer 206 * @param buffer_len 207 * @param header_type 208 * @param header_data 209 * @param header_data_length 210 * @return status 211 */ 212 uint8_t obex_message_builder_header_add_variable(uint8_t * buffer, uint16_t buffer_len, uint8_t header_type, const uint8_t * header_data, uint16_t header_data_length); 213 214 /** 215 * @brief Add (partial) header with variable size 216 * @param buffer 217 * @param buffer_len 218 * @param header_type 219 * @param header_data 220 * @param header_data_length 221 * @param ret_length 222 * @return status 223 */ 224 uint8_t obex_message_builder_header_fillup_variable(uint8_t * buffer, uint16_t buffer_len, uint8_t header_type, const uint8_t * header_data, uint16_t header_data_length, uint32_t * ret_length); 225 226 227 /** 228 * @brief returns name header size in bytes from its string len 229 * @param name_len - use value returned by strlen 230 * @return header size in bytes 231 */ 232 uint8_t obex_message_builder_get_header_name_len_from_strlen(uint16_t name_len); 233 234 /** 235 * @brief Add name header to current request 236 * @param buffer 237 * @param buffer_len 238 * @param name with trailing '\0' 239 * @return status 240 */ 241 uint8_t obex_message_builder_header_add_name(uint8_t * buffer, uint16_t buffer_len, const char * name); 242 243 /** 244 * @brief Add name header to current request 245 * @param buffer 246 * @param buffer_len 247 * @param name 248 * @param name_len 249 * @return status 250 */ 251 uint8_t obex_message_builder_header_add_name_prefix(uint8_t * buffer, uint16_t buffer_len, const char * name, uint16_t name_len); 252 253 /** 254 * @brief Add string encoded in unicode to current request 255 * @param buffer 256 * @param buffer_len 257 * @param header_id 258 * @param string 259 * @param string_len 260 * @return status 261 */ 262 uint8_t obex_message_builder_header_add_unicode_prefix(uint8_t * buffer, uint16_t buffer_len, uint8_t header_id, const char * name, uint16_t name_len); 263 264 /** 265 * @brief Add target header to current request 266 * @param buffer 267 * @param buffer_len 268 * @param target 269 * @param length of target 270 * @return status 271 */ 272 uint8_t obex_message_builder_header_add_target(uint8_t * buffer, uint16_t buffer_len, const uint8_t * target, uint16_t length); 273 274 /** 275 * @brief Add target header to current request 276 * @param buffer 277 * @param buffer_len 278 * @param who fixed len of 16 bytes 279 * @return status 280 */ 281 uint8_t obex_message_builder_header_add_who(uint8_t * buffer, uint16_t buffer_len, const uint8_t * who); 282 283 /** 284 * @brief returns the length of the type header for string <type> 285 * @param type 286 * @return header len in bytes 287 */ 288 uint8_t obex_message_builder_get_header_type_len(char* type); 289 290 291 /** 292 * @brief Add type header to current request 293 * @param buffer 294 * @param buffer_len 295 * @param type 296 * @return status 297 */ 298 uint8_t obex_message_builder_header_add_type(uint8_t * buffer, uint16_t buffer_len, const char * type); 299 300 /** 301 * @brief Add count header to current request 302 * @param buffer 303 * @param buffer_len 304 * @param count 305 * @return status 306 */ 307 uint8_t obex_message_builder_header_add_count(uint8_t * buffer, uint16_t buffer_len, uint32_t count); 308 309 /** 310 * @brief Add length header to current request 311 * @param buffer 312 * @param buffer_len 313 * @param lenght 314 * @return status 315 */ 316 uint8_t obex_message_builder_header_add_length(uint8_t * buffer, uint16_t buffer_len, uint32_t length); 317 318 /** 319 * @brief Add application parameters header to current request 320 * @param buffer 321 * @param buffer_len 322 * @param data 323 * @param length of application parameters 324 * @return status 325 */ 326 uint8_t obex_message_builder_header_add_application_parameters(uint8_t * buffer, uint16_t buffer_len, const uint8_t * data, uint16_t length); 327 328 /** 329 * @brief Add application parameters header to current request 330 * @param buffer 331 * @param buffer_len 332 * @param data 333 * @param length of challenge response 334 * @return status 335 */ 336 uint8_t obex_message_builder_header_add_challenge_response(uint8_t * buffer, uint16_t buffer_len, const uint8_t * data, uint16_t length); 337 338 /** 339 * @brief Add body 340 * @param buffer 341 * @param buffer_len 342 * @param data 343 * @param length 344 * @return status 345 */ 346 uint8_t obex_message_builder_body_add_static(uint8_t * buffer, uint16_t buffer_len, const uint8_t * data, uint32_t length); 347 348 /** 349 * @brief Add body 350 * @param buffer 351 * @param buffer_len 352 * @param data 353 * @param length 354 * @param ret_length 355 * @return status 356 */ 357 uint8_t obex_message_builder_body_fillup_static(uint8_t * buffer, uint16_t buffer_len, const uint8_t * data, uint32_t length, uint32_t *ret_length); 358 359 /* API_END */ 360 361 // int obex_message_builder_body_add_dynamic(uint8_t * buffer, uint16_t buffer_len, uint32_t length, void (*data_callback)(uint32_t offset, uint8_t * buffer, uint32_t len)); 362 363 #if defined __cplusplus 364 } 365 #endif 366 #endif 367 368