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 MATTHIAS 24 * RINGWALD 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 #ifndef __ATT_SERVER_H 38 #define __ATT_SERVER_H 39 40 #include <stdint.h> 41 #include "ble/att_db.h" 42 #include "btstack_defines.h" 43 44 #if defined __cplusplus 45 extern "C" { 46 #endif 47 48 /* API_START */ 49 /* 50 * @brief setup ATT server 51 * @param db attribute database created by compile-gatt.ph 52 * @param read_callback, see att_db.h, can be NULL 53 * @param write_callback, see attl.h, can be NULL 54 */ 55 void att_server_init(uint8_t const * db, att_read_callback_t read_callback, att_write_callback_t write_callback); 56 57 /* 58 * @brief register packet handler for ATT server events: 59 * - ATT_EVENT_CAN_SEND_NOW 60 * - ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE 61 * - ATT_EVENT_MTU_EXCHANGE_COMPLETE 62 * @param handler 63 */ 64 void att_server_register_packet_handler(btstack_packet_handler_t handler); 65 66 /** 67 * @brief register read/write callbacks for specific handle range 68 * @param att_service_handler_t 69 */ 70 void att_server_register_service_handler(att_service_handler_t * handler); 71 72 // the following functions will be removed soon 73 74 /* 75 * @brief tests if a notification or indication can be send right now 76 * @param con_handle 77 * @return 1, if packet can be sent 78 */ 79 int att_server_can_send_packet_now(hci_con_handle_t con_handle); 80 81 /** 82 * @brief Request emission of ATT_EVENT_CAN_SEND_NOW as soon as possible 83 * @note ATT_EVENT_CAN_SEND_NOW might be emitted during call to this function 84 * so packet handler should be ready to handle it 85 * @param con_handle 86 */ 87 void att_server_request_can_send_now_event(hci_con_handle_t con_handle); 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 int att_server_register_can_send_now_callback(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 97 98 // end of deprecated functions 99 100 /** 101 * @brief Request callback when sending notifcation is possible 102 * @note callback might happend during call to this function 103 * @param callback_registration to point to callback function and context information 104 * @param con_handle 105 * @return 0 if ok, error otherwise 106 */ 107 int att_server_request_to_send_notification(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 108 109 /** 110 * @brief Request callback when sending indication is possible 111 * @note callback might happend during call to this function 112 * @param callback_registration to point to callback function and context information 113 * @param con_handle 114 * @return 0 if ok, error otherwise 115 */ 116 int att_server_request_to_send_indication(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 117 118 /* 119 * @brief notify client about attribute value change 120 * @param con_handle 121 * @param attribute_handle 122 * @param value 123 * @param value_len 124 * @return 0 if ok, error otherwise 125 */ 126 int att_server_notify(hci_con_handle_t con_handle, uint16_t attribute_handle, uint8_t *value, uint16_t value_len); 127 128 /* 129 * @brief indicate value change to client. client is supposed to reply with an indication_response 130 * @param con_handle 131 * @param attribute_handle 132 * @param value 133 * @param value_len 134 * @return 0 if ok, error otherwise 135 */ 136 int att_server_indicate(hci_con_handle_t con_handle, uint16_t attribute_handle, uint8_t *value, uint16_t value_len); 137 138 #ifdef ENABLE_ATT_DELAYED_READ_RESPONSE 139 /* 140 * @brief read response ready - called after returning ATT_READ_RESPONSE_PENDING in an att_read_callback before 141 * @nore The ATT Server will retry handling the current ATT request 142 * @param con_handle 143 * @return 0 if ok, error otherwise 144 */ 145 int att_server_read_response_ready(hci_con_handle_t con_handle); 146 #endif 147 148 /* API_END */ 149 150 #if defined __cplusplus 151 } 152 #endif 153 154 #endif // __ATT_SERVER_H 155