1 /* 2 * Copyright (C) 2024 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_CLIENT_H 39 #define OBEX_SRM_CLIENT_H 40 41 #include <stdint.h> 42 #include "btstack_bool.h" 43 44 #if defined __cplusplus 45 extern "C" { 46 #endif 47 48 typedef enum { 49 OBEX_SRM_CLIENT_STATE_DISABLED, 50 OBEX_SRM_CLIENT_STATE_W4_CONFIRM, 51 OBEX_SRM_CLIENT_STATE_ENABLED_BUT_WAITING, 52 OBEX_SRM_CLIENT_STATE_ENABLED 53 } obex_srm_client_state_t; 54 55 typedef struct { 56 obex_srm_client_state_t srm_state; 57 58 bool srmp_waiting; 59 60 uint8_t srm_value; 61 uint8_t srmp_value; 62 } obex_srm_client_t; 63 64 /** 65 * Init SRM to disabled state 66 * SRM needs to be disabled for each new GET/PUT operation 67 * @param obex_srm 68 */ 69 void obex_srm_client_init(obex_srm_client_t * obex_srm); 70 71 /** 72 * Control SRMP stata 73 * While waiting, SRMP header is added, effectively disabling SRM 74 * @param obex_srm 75 * @param waiting 76 */ 77 void obex_srm_client_set_waiting(obex_srm_client_t * obex_srm, bool waiting); 78 79 /** 80 * Reset SRM/SRMP fields 81 * Needs to be called before parsing response 82 * @param obex_srm 83 */ 84 void obex_srm_client_reset_fields(obex_srm_client_t * obex_srm); 85 86 /** 87 * Update SRM state based on SRM headers 88 * @param obex_srm 89 */ 90 void obex_srm_client_handle_headers(obex_srm_client_t *obex_srm); 91 92 /** 93 * Check if SRM is active 94 * @param obex_srm 95 */ 96 bool obex_srm_client_is_srm_active(obex_srm_client_t *obex_srm); 97 98 /** 99 * Add SRM headers if 100 * @param obex_srm 101 * @param goep_cid 102 */ 103 void obex_srm_client_prepare_header(obex_srm_client_t *obex_srm, uint16_t goep_cid); 104 105 #if defined __cplusplus 106 } 107 #endif 108 109 #endif 110