1 /* 2 * Copyright (C) 2023 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 #ifndef OBEX_SRM_H 39 #define OBEX_SRM_H 40 41 #include <stdint.h> 42 43 #if defined __cplusplus 44 extern "C" { 45 #endif 46 47 typedef enum { 48 OBEX_SRM_STATE_DISABLED, 49 OBEX_SRM_STATE_SEND_CONFIRM, 50 OBEX_SRM_STATE_SEND_CONFIRM_WAIT, 51 OBEX_SRM_STATE_ENABLED, 52 OBEX_SRM_STATE_ENABLED_WAIT, 53 } obex_srm_server_state_t; 54 55 typedef struct { 56 obex_srm_server_state_t srm_state; 57 58 uint8_t srm_value; 59 uint8_t srmp_value; 60 } obex_srm_server_t; 61 62 /** 63 * Init SRM to disabled state 64 * SRM needs to be disabled for each new GET/PUT operation 65 * @param obex_srm 66 */ 67 void obex_srm_server_init (obex_srm_server_t *obex_srm); 68 69 /** 70 * Reset SRM/SRMP fields 71 * Needs to be called before parsing request 72 * @param obex_srm 73 */ 74 void obex_srm_server_reset_fields (obex_srm_server_t *obex_srm); 75 76 /** 77 * Store SRM or SRMP header field 78 * @param obex_srm 79 * @param header_id 80 * @param total_len 81 * @param data_offset 82 * @param data_buffer 83 * @param data_len 84 */ 85 void obex_srm_server_header_store (obex_srm_server_t *obex_srm, 86 uint8_t header_id, 87 uint16_t total_len, 88 uint16_t data_offset, 89 const uint8_t *data_buffer, 90 uint16_t data_len); 91 92 /** 93 * Update SRM state based on SRM headers 94 * @param obex_srm 95 */ 96 void obex_srm_server_handle_headers (obex_srm_server_t *obex_srm); 97 98 /** 99 * Add SRM headers to current response 100 * @param obex_srm 101 * @param goep_cid 102 */ 103 void obex_srm_server_add_srm_headers (obex_srm_server_t *obex_srm, 104 uint16_t goep_cid); 105 /** 106 * Check if SRM is active 107 * @param obex_srm 108 */ 109 bool obex_srm_server_is_srm_active (obex_srm_server_t *obex_srm); 110 111 #if defined __cplusplus 112 } 113 #endif 114 115 #endif 116