1 /* 2 * Copyright (C) 2022 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 GOEP_SERVER_H 39 #define GOEP_SERVER_H 40 41 #if defined __cplusplus 42 extern "C" { 43 #endif 44 45 #include "btstack_config.h" 46 #include <stdint.h> 47 48 #ifdef ENABLE_GOEP_L2CAP 49 #ifndef GOEP_SERVER_ERTM_BUFFER 50 #define GOEP_SERVER_ERTM_BUFFER 1000 51 #endif 52 #endif 53 54 /* API_START */ 55 56 typedef enum { 57 GOEP_SERVER_IDLE, 58 GOEP_SERVER_W4_ACCEPT_REJECT, 59 GOEP_SERVER_W4_CONNECTED, 60 GOEP_SERVER_CONNECTED 61 } goep_server_state_t; 62 63 typedef enum { 64 GOEP_CONNECTION_RFCOMM = 0, 65 GOEP_CONNECTION_L2CAP, 66 } goep_connection_type_t; 67 68 typedef struct { 69 // linked list - assert: first field 70 btstack_linked_item_t item; 71 72 btstack_packet_handler_t callback; 73 uint8_t rfcomm_channel; 74 uint16_t l2cap_psm; 75 } goep_server_service_t; 76 77 // type 78 typedef struct { 79 // linked list - assert: first field 80 btstack_linked_item_t item; 81 82 uint16_t goep_cid; 83 goep_server_state_t state; 84 goep_connection_type_t type; 85 uint16_t bearer_cid; 86 uint16_t bearer_mtu; 87 btstack_packet_handler_t callback; 88 uint32_t obex_connection_id; 89 90 #ifdef ENABLE_GOEP_L2CAP 91 uint8_t ertm_buffer[GOEP_SERVER_ERTM_BUFFER]; 92 #endif 93 94 } goep_server_connection_t; 95 96 /** 97 * Init GOEP Server 98 */ 99 void goep_server_init(void); 100 101 102 /** 103 * Register OBEX Service 104 * @param packet_handler 105 * @param rfcomm_channel 106 * @param rfcomm_max_frame_size 107 * @param l2cap_psm 108 * @param l2cap_mtu 109 * @param security_level 110 * @return status 111 */ 112 uint8_t goep_server_register_service(btstack_packet_handler_t packet_handler, uint8_t rfcomm_channel, uint16_t rfcomm_max_frame_size, 113 uint16_t l2cap_psm, uint16_t l2cap_mtu, gap_security_level_t security_level); 114 115 /** 116 * @brief Accepts incoming GOEP connection. 117 * @param goep_cid 118 * @return status 119 */ 120 uint8_t goep_server_accept_connection(uint16_t goep_cid); 121 122 /** 123 * @brief Deny incoming GOEP connection. 124 * @param goep_cid 125 * @return status 126 */ 127 uint8_t goep_server_decline_connection(uint16_t goep_cid); 128 129 /** 130 * Request GOEP_SUBEVENT_CAN_SEND_NOW 131 * @param goep_cid 132 * @return status 133 */ 134 uint8_t goep_server_request_can_send_now(uint16_t goep_cid); 135 136 /** 137 * @brief Start Connect response 138 * @param goep_cid 139 * @param obex_version_number 140 * @param flags 141 * @param maximum_obex_packet_length 142 * @return status 143 */ 144 uint8_t goep_server_response_create_connect(uint16_t goep_cid, uint8_t obex_version_number, uint8_t flags, uint16_t maximum_obex_packet_length); 145 146 /** 147 * @brief Start General response 148 * @note response code is set by goep_server_execute 149 * @param goep_cid 150 * @param opcode 151 * @return status 152 */ 153 uint8_t goep_server_response_create_general(uint16_t goep_cid); 154 155 /** 156 * @brief Get max size of body data that can be added to current response with goep_server_header_add_end_of_body 157 * @param goep_cid 158 * @param data 159 * @param length 160 * @return size in bytes or 0 161 */ 162 uint16_t goep_server_response_get_max_body_size(uint16_t goep_cid); 163 164 /** 165 * @brief Add who header to current response 166 * @param goep_cid 167 * @param who - 16 bytes 168 * @return status 169 */ 170 uint8_t goep_server_header_add_who(uint16_t goep_cid, const uint8_t * who); 171 172 /** 173 * @brief Add end_of_body header to current response 174 * @param goep_cid 175 * @param end_of_body 176 * @param length 177 * @return status 178 */ 179 uint8_t goep_server_header_add_end_of_body(uint16_t goep_cid, const uint8_t * end_of_body, uint16_t length); 180 181 /** 182 * @brief Add SRM ENABLE header to current response 183 * @param goep_cid 184 * @return 185 */ 186 uint8_t goep_server_header_add_srm_enable(uint16_t goep_cid); 187 188 189 /** 190 * @brief Add application parameters header to current request 191 * @param goep_cid 192 * @param data 193 * @param length 194 * @return 195 */ 196 uint8_t goep_server_header_add_application_parameters(uint16_t goep_cid, const uint8_t * data, uint16_t length); 197 198 /** 199 * @brief Send prepared response 200 * @param goep_cid 201 * @param response_code 202 * @return status 203 */ 204 uint8_t goep_server_execute(uint16_t goep_cid, uint8_t response_code); 205 206 /** 207 * De-Init 208 */ 209 void geop_server_deinit(void); 210 211 /* API_END */ 212 213 #if defined __cplusplus 214 } 215 #endif 216 #endif 217