xref: /btstack/src/ble/att_dispatch.c (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 #define BTSTACK_FILE__ "att_dispatch.c"
39 
40 
41 /**
42  * Dispatcher for independent implementation of ATT client and server
43  */
44 
45 #include "ble/att_dispatch.h"
46 #include "ble/core.h"
47 #include "btstack_debug.h"
48 #include "l2cap.h"
49 #include "btstack_event.h"
50 
51 #define ATT_SERVER 0u
52 #define ATT_CLIENT 1u
53 #define ATT_MAX    2u
54 
55 struct {
56     btstack_packet_handler_t packet_handler;
57     bool                  waiting_for_can_send;
58 } subscriptions[ATT_MAX];
59 
60 // index of subscription that will get can send now first if waiting for it
61 static uint8_t att_round_robin;
62 
63 // track can send now requests
64 static bool can_send_now_pending;
65 
66 static void att_dispatch_handle_can_send_now(uint8_t *packet, uint16_t size){
67     uint8_t i;
68     uint8_t index;
69     uint16_t l2cap_cid = l2cap_event_can_send_now_get_local_cid(packet);
70 #ifdef ENABLE_GATT_OVER_CLASSIC
71     if (l2cap_cid != L2CAP_CID_ATTRIBUTE_PROTOCOL){
72         // lookup att_server in hci_connection for l2cap_cid
73         btstack_linked_list_iterator_t it;
74         hci_connections_get_iterator(&it);
75         while(btstack_linked_list_iterator_has_next(&it)) {
76             hci_connection_t *hci_connection = (hci_connection_t *) btstack_linked_list_iterator_next(&it);
77             att_server_t * att_server = &hci_connection->att_server;
78             if (att_server->l2cap_cid == l2cap_cid){
79                 for (i = 0u; i < ATT_MAX; i++) {
80                     index = (att_round_robin + i) & 1u;
81                     if (att_server->send_requests[index]) {
82                         att_server->send_requests[index] = false;
83                         // registered packet handlers from Unenhanced LE
84                         subscriptions[index].packet_handler(HCI_EVENT_PACKET, l2cap_cid, packet, size);
85                         // fairness: prioritize next service
86                         att_round_robin = (index + 1u) % ATT_MAX;
87                         // stop if client cannot send anymore
88                         if (!l2cap_can_send_packet_now(l2cap_cid)) break;
89                     }
90                 }
91                 // check if more can send now events are needed
92                 bool send_request_pending = att_server->send_requests[ATT_CLIENT]
93                                             || att_server->send_requests[ATT_SERVER];
94                 if (send_request_pending){
95                     l2cap_request_can_send_now_event(att_server->l2cap_cid);
96                 }
97                 return;
98             }
99         }
100     }
101 #endif
102     can_send_now_pending = false;
103     for (i = 0u; i < ATT_MAX; i++){
104         index = (att_round_robin + i) & 1u;
105         if ( (subscriptions[index].packet_handler != NULL) && subscriptions[index].waiting_for_can_send){
106             subscriptions[index].waiting_for_can_send = false;
107             subscriptions[index].packet_handler(HCI_EVENT_PACKET, l2cap_cid, packet, size);
108             // fairness: prioritize next service
109             att_round_robin = (index + 1u) % ATT_MAX;
110             // stop if client cannot send anymore
111             if (!hci_can_send_acl_le_packet_now()) break;
112         }
113     }
114     // check if more can send now events are needed
115     if (!can_send_now_pending){
116         for (i = 0u; i < ATT_MAX; i++){
117             if ((subscriptions[i].packet_handler != NULL) && subscriptions[i].waiting_for_can_send){
118                 can_send_now_pending = true;
119                 // note: con_handle is not used, so we can pass in anything
120                 l2cap_request_can_send_fix_channel_now_event(0, L2CAP_CID_ATTRIBUTE_PROTOCOL);
121                 break;
122             }
123         }
124     }
125 }
126 
127 static void att_dispatch_handle_att_pdu(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
128     uint8_t index;
129     uint8_t opcode;
130     uint8_t method;
131     bool for_server;
132     bool invalid;
133 
134     // parse opcode
135     opcode  = packet[0u];
136     method  = opcode & 0x03fu;
137     invalid = method > ATT_MULTIPLE_HANDLE_VALUE_NTF;
138     // odd PDUs are sent from server to client - even PDUs are sent from client to server, also let server handle invalid ones
139     for_server = ((method & 1u) == 0u) || invalid;
140     index = for_server ? ATT_SERVER : ATT_CLIENT;
141     if (!subscriptions[index].packet_handler) return;
142     subscriptions[index].packet_handler(packet_type, channel, packet, size);
143 }
144 
145 static void att_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
146 #ifdef ENABLE_GATT_OVER_CLASSIC
147     hci_connection_t * hci_connection;
148     hci_con_handle_t con_handle;
149     bool outgoing_active;
150     uint8_t index;
151 #endif
152 #if defined(ENABLE_GATT_OVER_CLASSIC) || defined(ENABLE_GATT_OVER_EATT)
153     bd_addr_t address;
154     uint16_t l2cap_cid;
155     uint8_t  status;
156 #endif
157     switch (packet_type){
158         case ATT_DATA_PACKET:
159             att_dispatch_handle_att_pdu(packet_type, channel, packet, size);
160             break;
161 #ifdef ENABLE_GATT_OVER_CLASSIC
162         case L2CAP_DATA_PACKET:
163             att_dispatch_handle_att_pdu(packet_type, channel, packet, size);
164             break;
165 #endif
166         case HCI_EVENT_PACKET:
167             switch (hci_event_packet_get_type(packet)) {
168                 case L2CAP_EVENT_CAN_SEND_NOW:
169                     att_dispatch_handle_can_send_now(packet, size);
170                     break;
171 #ifdef ENABLE_GATT_OVER_CLASSIC
172                 case L2CAP_EVENT_INCOMING_CONNECTION:
173                     l2cap_event_incoming_connection_get_address(packet, address);
174                     l2cap_cid = l2cap_event_incoming_connection_get_local_cid(packet);
175                     // reject if outgoing l2cap connection active, L2CAP/TIM/BV-01-C
176                     con_handle = l2cap_event_incoming_connection_get_handle(packet);
177                     hci_connection = hci_connection_for_handle(con_handle);
178                     btstack_assert(hci_connection != NULL);
179                     outgoing_active = hci_connection->att_server.l2cap_cid != 0;
180                     if (outgoing_active) {
181                         hci_connection->att_server.incoming_connection_request = true;
182                         l2cap_decline_connection(l2cap_cid);
183                         log_info("Decline incoming connection from %s", bd_addr_to_str(address));
184                     } else {
185                         l2cap_accept_connection(l2cap_cid);
186                         log_info("Accept incoming connection from %s", bd_addr_to_str(address));
187                     }
188                     break;
189                 case L2CAP_EVENT_CHANNEL_OPENED:
190                     // store l2cap_cid in att_server
191                     status = l2cap_event_channel_opened_get_status(packet);
192                     con_handle = l2cap_event_channel_opened_get_handle(packet);
193                     hci_connection = hci_connection_for_handle(con_handle);
194                     if (status == ERROR_CODE_SUCCESS){
195                         btstack_assert(hci_connection != NULL);
196                         hci_connection->att_server.l2cap_cid = l2cap_event_channel_opened_get_local_cid(packet);
197                     } else {
198                         if (hci_connection != NULL){
199                             hci_connection->att_server.l2cap_cid = 0;
200                         }
201                     }
202                     // dispatch to all roles
203                     for (index = 0; index < ATT_MAX; index++){
204                         if (subscriptions[index].packet_handler != NULL){
205                             subscriptions[index].packet_handler(packet_type, channel, packet, size);
206                         }
207                     }
208                     break;
209                 case L2CAP_EVENT_CHANNEL_CLOSED:
210                     // clear l2cap cid in hci_connection->att_server
211                     con_handle = l2cap_event_incoming_connection_get_handle(packet);
212                     hci_connection = hci_connection_for_handle(con_handle);
213                     hci_connection->att_server.l2cap_cid = 0;
214                     // dispatch to all roles
215                     for (index = 0; index < ATT_MAX; index++){
216                         if (subscriptions[index].packet_handler != NULL){
217                             subscriptions[index].packet_handler(packet_type, channel, packet, size);
218                         }
219                     }
220                     break;
221 #endif
222                 default:
223                     break;
224             }
225             break;
226         default:
227             break;
228     }
229 }
230 
231 void att_dispatch_register_client(btstack_packet_handler_t packet_handler){
232     subscriptions[ATT_CLIENT].packet_handler = packet_handler;
233     l2cap_register_fixed_channel(att_packet_handler, L2CAP_CID_ATTRIBUTE_PROTOCOL);
234 }
235 
236 void att_dispatch_register_server(btstack_packet_handler_t packet_handler){
237     subscriptions[ATT_SERVER].packet_handler = packet_handler;
238     l2cap_register_fixed_channel(att_packet_handler, L2CAP_CID_ATTRIBUTE_PROTOCOL);
239 }
240 
241 #ifdef ENABLE_GATT_OVER_CLASSIC
242 static uint16_t att_dispatch_classic_get_l2cap_cid(hci_con_handle_t con_handle){
243     // get l2cap_cid from att_server in hci_connection
244     hci_connection_t * hci_connection = hci_connection_for_handle(con_handle);
245     if (hci_connection != NULL) {
246         return hci_connection->att_server.l2cap_cid;
247     } else {
248         return 0;
249     }
250 }
251 #endif
252 
253 
254 static bool att_dispatch_can_send_now(hci_con_handle_t con_handle) {
255 #ifdef ENABLE_GATT_OVER_CLASSIC
256     uint16_t l2cap_cid = att_dispatch_classic_get_l2cap_cid(con_handle);
257     if (l2cap_cid != 0){
258         return l2cap_can_send_packet_now(l2cap_cid);
259     }
260 #endif
261     return l2cap_can_send_fixed_channel_packet_now(con_handle, L2CAP_CID_ATTRIBUTE_PROTOCOL);
262 }
263 
264 bool att_dispatch_client_can_send_now(hci_con_handle_t con_handle){
265     return att_dispatch_can_send_now(con_handle);
266 }
267 
268 bool att_dispatch_server_can_send_now(hci_con_handle_t con_handle){
269     return att_dispatch_can_send_now(con_handle);
270 }
271 
272 static void att_dispatch_request_can_send_now_event(hci_con_handle_t con_handle, uint8_t type) {
273 #ifdef ENABLE_GATT_OVER_CLASSIC
274     hci_connection_t * hci_connection = hci_connection_for_handle(con_handle);
275     if (hci_connection != NULL) {
276         att_server_t * att_server = &hci_connection->att_server;
277         if (att_server->l2cap_cid != 0){
278             bool send_request_pending = att_server->send_requests[ATT_CLIENT]
279                                      || att_server->send_requests[ATT_SERVER];
280             att_server->send_requests[type] = true;
281             if (send_request_pending == false){
282                 l2cap_request_can_send_now_event(att_server->l2cap_cid);
283             }
284             return;
285         }
286     }
287 #endif
288     subscriptions[type].waiting_for_can_send = true;
289     if (can_send_now_pending == false) {
290         can_send_now_pending = true;
291         l2cap_request_can_send_fix_channel_now_event(con_handle, L2CAP_CID_ATTRIBUTE_PROTOCOL);
292     }
293 }
294 
295 void att_dispatch_client_request_can_send_now_event(hci_con_handle_t con_handle){
296     att_dispatch_request_can_send_now_event(con_handle, ATT_CLIENT);
297 }
298 
299 void att_dispatch_server_request_can_send_now_event(hci_con_handle_t con_handle){
300     att_dispatch_request_can_send_now_event(con_handle, ATT_SERVER);
301 }
302 
303 static void emit_mtu_exchange_complete(btstack_packet_handler_t packet_handler, hci_con_handle_t con_handle, uint16_t new_mtu){
304     if (!packet_handler) return;
305     uint8_t packet[6];
306     packet[0] = ATT_EVENT_MTU_EXCHANGE_COMPLETE;
307     packet[1] = sizeof(packet) - 2u;
308     little_endian_store_16(packet, 2, con_handle);
309     little_endian_store_16(packet, 4, new_mtu);
310     packet_handler(HCI_EVENT_PACKET, con_handle, packet, 6);
311 }
312 
313 void att_dispatch_server_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu){
314     emit_mtu_exchange_complete(subscriptions[ATT_CLIENT].packet_handler, con_handle, new_mtu);
315 }
316 
317 void att_dispatch_client_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu){
318     emit_mtu_exchange_complete(subscriptions[ATT_SERVER].packet_handler, con_handle, new_mtu);
319 }
320 
321 #ifdef ENABLE_GATT_OVER_CLASSIC
322 void att_dispatch_classic_register_service(void){
323     l2cap_register_service(&att_packet_handler, PSM_ATT, 0xffff, gap_get_security_level());
324 }
325 uint8_t att_dispatch_classic_connect(bd_addr_t address, uint16_t l2cap_psm, uint16_t *out_cid) {
326     uint16_t l2cap_cid;
327     uint8_t status = l2cap_create_channel(&att_packet_handler, address, l2cap_psm, 0xffff, &l2cap_cid);
328     // store l2cap_cid in hci_connection
329     if (status == ERROR_CODE_SUCCESS){
330         hci_connection_t * hci_connection = hci_connection_for_bd_addr_and_type(address, BD_ADDR_TYPE_ACL);
331         if (hci_connection != NULL) {
332             hci_connection->att_server.l2cap_cid = l2cap_cid;
333             hci_connection->att_server.incoming_connection_request = false;
334         }
335     }
336     *out_cid = l2cap_cid;
337     return status;
338 }
339 
340 #endif
341