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 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 * @title ATT Server 40 * 41 */ 42 43 #ifndef ATT_SERVER_H 44 #define ATT_SERVER_H 45 46 #include <stdint.h> 47 #include "ble/att_db.h" 48 #include "btstack_defines.h" 49 #include "btstack_config.h" 50 51 #if defined __cplusplus 52 extern "C" { 53 #endif 54 55 /* API_START */ 56 /* 57 * @brief setup ATT server 58 * @param db attribute database created by compile-gatt.ph 59 * @param read_callback, see att_db.h, can be NULL 60 * @param write_callback, see attl.h, can be NULL 61 */ 62 void att_server_init(uint8_t const * db, att_read_callback_t read_callback, att_write_callback_t write_callback); 63 64 /** 65 * @brief Enable support for Enhanced ATT bearer 66 * @note Requires ENABLE_GATT_OVER_EATT 67 * @param num_eatt_bearers 68 * @param storage_buffer 69 * @param storage_size 70 * @return 71 */ 72 uint8_t att_server_eatt_init(uint8_t num_eatt_bearers, uint8_t * storage_buffer, uint16_t storage_size); 73 74 /* 75 * @brief register packet handler for ATT server events: 76 * - ATT_EVENT_CAN_SEND_NOW 77 * - ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE 78 * - ATT_EVENT_MTU_EXCHANGE_COMPLETE 79 * @param handler 80 */ 81 void att_server_register_packet_handler(btstack_packet_handler_t handler); 82 83 /** 84 * @brief register read/write callbacks for specific handle range 85 * @param att_service_handler_t 86 */ 87 void att_server_register_service_handler(att_service_handler_t * handler); 88 89 /** 90 * @brief Request callback when sending is possible 91 * @note callback might happend during call to this function 92 * @param callback_registration to point to callback function and context information 93 * @param con_handle 94 * @return 0 if ok, error otherwise 95 */ 96 uint8_t att_server_register_can_send_now_callback(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 97 98 /** 99 * @brief Return ATT MTU 100 * @param con_handle 101 * @return mtu if ok, 0 otherwise 102 */ 103 uint16_t att_server_get_mtu(hci_con_handle_t con_handle); 104 105 /** 106 * @brief Request callback when sending notifcation is possible 107 * @note callback might happend during call to this function 108 * @param callback_registration to point to callback function and context information 109 * @param con_handle 110 * @return ERROR_CODE_SUCCESS if ok, ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if handle unknown, and ERROR_CODE_COMMAND_DISALLOWED if callback already registered 111 */ 112 uint8_t att_server_request_to_send_notification(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 113 114 /** 115 * @brief Request callback when sending indication is possible 116 * @note callback might happend during call to this function 117 * @param callback_registration to point to callback function and context information 118 * @param con_handle 119 * @return ERROR_CODE_SUCCESS if ok, ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if handle unknown, and ERROR_CODE_COMMAND_DISALLOWED if callback already registered 120 */ 121 uint8_t att_server_request_to_send_indication(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 122 123 /** 124 * @brief notify client about attribute value change 125 * @param con_handle 126 * @param attribute_handle 127 * @param value 128 * @param value_len 129 * @return 0 if ok, error otherwise 130 */ 131 uint8_t att_server_notify(hci_con_handle_t con_handle, uint16_t attribute_handle, const uint8_t *value, uint16_t value_len); 132 133 /** 134 * @brief indicate value change to client. client is supposed to reply with an indication_response 135 * @param con_handle 136 * @param attribute_handle 137 * @param value 138 * @param value_len 139 * @return 0 if ok, error otherwise 140 */ 141 uint8_t att_server_indicate(hci_con_handle_t con_handle, uint16_t attribute_handle, const uint8_t *value, uint16_t value_len); 142 143 #ifdef ENABLE_ATT_DELAYED_RESPONSE 144 /** 145 * @brief response ready - called after returning ATT_READ__RESPONSE_PENDING in an att_read_callback or 146 * ATT_ERROR_WRITE_REQUEST_PENDING IN att_write_callback before to trigger callback again and complete the transaction 147 * @nore The ATT Server will retry handling the current ATT request 148 * @param con_handle 149 * @return 0 if ok, error otherwise 150 */ 151 uint8_t att_server_response_ready(hci_con_handle_t con_handle); 152 #endif 153 154 /** 155 * De-Init ATT Server 156 */ 157 void att_server_deinit(void); 158 159 // the following functions will be removed soon 160 161 /** 162 * @brief tests if a notification or indication can be send right now 163 * @param con_handle 164 * @return 1, if packet can be sent 165 */ 166 int att_server_can_send_packet_now(hci_con_handle_t con_handle); 167 168 /** 169 * @brief Request emission of ATT_EVENT_CAN_SEND_NOW as soon as possible 170 * @note ATT_EVENT_CAN_SEND_NOW might be emitted during call to this function 171 * so packet handler should be ready to handle it 172 * @param con_handle 173 */ 174 void att_server_request_can_send_now_event(hci_con_handle_t con_handle); 175 // end of deprecated functions 176 177 /* API_END */ 178 179 #if defined __cplusplus 180 } 181 #endif 182 183 #endif // ATT_SERVER_H 184