xref: /btstack/src/ble/att_server.h (revision bc37f7b0d0a3eaa5763a873c5730bc14b849aaa0)
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_MTU_EXCHANGE_COMPLETE
60  *        - ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE
61  * @param handler
62  */
63 void att_server_register_packet_handler(btstack_packet_handler_t handler);
64 
65 /*
66  * @brief tests if a notification or indication can be send right now
67  * @param con_handle
68  * @return 1, if packet can be sent
69  */
70 int  att_server_can_send_packet_now(hci_con_handle_t con_handle);
71 
72 /**
73  * @brief Request emission of ATT_EVENT_CAN_SEND_NOW as soon as possible
74  * @note ATT_EVENT_CAN_SEND_NOW might be emitted during call to this function
75  *       so packet handler should be ready to handle it
76  * @param con_handle
77  */
78 void att_server_request_can_send_now_event(hci_con_handle_t con_handle);
79 
80 /*
81  * @brief notify client about attribute value change
82  * @param con_handle
83  * @param attribute_handle
84  * @param value
85  * @param value_len
86  * @return 0 if ok, error otherwise
87  */
88 int att_server_notify(hci_con_handle_t con_handle, uint16_t attribute_handle, uint8_t *value, uint16_t value_len);
89 
90 /*
91  * @brief indicate value change to client. client is supposed to reply with an indication_response
92  * @param con_handle
93  * @param attribute_handle
94  * @param value
95  * @param value_len
96  * @return 0 if ok, error otherwise
97  */
98 int att_server_indicate(hci_con_handle_t con_handle, uint16_t attribute_handle, uint8_t *value, uint16_t value_len);
99 
100 /* API_END */
101 
102 #if defined __cplusplus
103 }
104 #endif
105 
106 #endif // __ATT_SERVER_H
107