xref: /btstack/src/ble/att_dispatch.h (revision 08a78038ba366a6a2a2df8fea05d5123880fdff2)
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 /**
40  * @title ATT Dispatch
41  *
42  * Dispatcher for independent implementation of ATT client and server.
43  *
44  */
45 
46 #ifndef ATT_DISPATCH_H
47 #define ATT_DISPATCH_H
48 
49 #include "btstack_util.h"
50 
51 #if defined __cplusplus
52 extern "C" {
53 #endif
54 
55 /**
56  * @brief Register packet handler for ATT Client PDUs
57  * @param packet_handler
58  */
59 void att_dispatch_register_client(btstack_packet_handler_t packet_handler);
60 
61 /**
62  * @brief Register packet handler for ATT Server PDUs
63  * @param packet_handler
64  */
65 void att_dispatch_register_server(btstack_packet_handler_t packet_handler);
66 
67 /**
68  * @brief Register L2CAP ATT Service with fixed PSM
69  * @note requires ENABLE_GATT_OVER_CLASSIC
70  */
71 void att_dispatch_classic_register_service(void);
72 
73 /**
74  * @brief Create L2CAP ATT Connection
75  * @note ENABLE_GATT_OVER_CLASSIC
76  * @param address
77  * @param l2cap_psm
78  */
79 uint8_t att_dispatch_classic_connect(bd_addr_t address, uint16_t l2cap_psm, uint16_t *out_cid);
80 
81 /**
82  * @brief can send packet for client
83  * @param con_handle
84  */
85 bool att_dispatch_client_can_send_now(hci_con_handle_t con_handle);
86 
87 /**
88  * @brief can send packet for server
89  * @param con_handle
90  */
91 bool att_dispatch_server_can_send_now(hci_con_handle_t con_handle);
92 
93 /**
94  * @brief Request emission of L2CAP_EVENT_CAN_SEND_NOW as soon as possible for client
95  * @note L2CAP_EVENT_CAN_SEND_NOW might be emitted during call to this function
96  *       so packet handler should be ready to handle it
97  * @param con_handle
98  */
99 void att_dispatch_client_request_can_send_now_event(hci_con_handle_t con_handle);
100 
101 /**
102  * @brief Request emission of L2CAP_EVENT_CAN_SEND_NOW as soon as possible for server
103  * @note L2CAP_EVENT_CAN_SEND_NOW might be emitted during call to this function
104  *       so packet handler should be ready to handle it
105  * @param con_handle
106  */
107 void att_dispatch_server_request_can_send_now_event(hci_con_handle_t con_handle);
108 
109 /**
110 * @brief Used for propogating a updated MTU from att_server to gatt_client
111 * @param con_handle
112 * @param mtu
113 */
114 void att_dispatch_server_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu);
115 
116 /**
117 * @brief Used for propogating a updated MTU from gatt_client to att_server
118 * @param con_handle
119 * @param mtu
120 */
121 void att_dispatch_client_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu);
122 
123 #if defined __cplusplus
124 }
125 #endif
126 
127 #endif // ATT_DISPATCH_H
128