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