xref: /btstack/src/ble/att_dispatch.c (revision 9eba80a6c98d2cf231292a3e49aae38898f95aaa)
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     can_send_now_pending = false;
70     uint16_t l2cap_cid = l2cap_event_can_send_now_get_local_cid(packet);
71     for (i = 0u; i < ATT_MAX; i++){
72         index = (att_round_robin + i) & 1u;
73         if ( (subscriptions[index].packet_handler != NULL) && subscriptions[index].waiting_for_can_send){
74             subscriptions[index].waiting_for_can_send = false;
75             subscriptions[index].packet_handler(HCI_EVENT_PACKET, l2cap_cid, packet, size);
76             // fairness: prioritize next service
77             att_round_robin = (index + 1u) % ATT_MAX;
78             // stop if client cannot send anymore
79             if (!hci_can_send_acl_le_packet_now()) break;
80         }
81     }
82     // check if more can send now events are needed
83     if (!can_send_now_pending){
84         for (i = 0u; i < ATT_MAX; i++){
85             if ((subscriptions[i].packet_handler != NULL) && subscriptions[i].waiting_for_can_send){
86                 can_send_now_pending = true;
87                 // note: con_handle is not used, so we can pass in anything
88                 l2cap_request_can_send_fix_channel_now_event(0, L2CAP_CID_ATTRIBUTE_PROTOCOL);
89                 break;
90             }
91         }
92     }
93 }
94 
95 static void att_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
96     uint8_t opcode;
97     uint8_t method;
98     bool for_server;
99     bool invalid;
100     uint8_t index;
101     switch (packet_type){
102         case ATT_DATA_PACKET:
103             // parse opcode
104             opcode  = packet[0u];
105             method  = opcode & 0x03fu;
106             invalid = method > ATT_MULTIPLE_HANDLE_VALUE_NTF;
107             // odd PDUs are sent from server to client - even PDUs are sent from client to server, also let server handle invalid ones
108             for_server = ((method & 1u) == 0u) || invalid;
109             index = for_server ? ATT_SERVER : ATT_CLIENT;
110             if (!subscriptions[index].packet_handler) return;
111             subscriptions[index].packet_handler(packet_type, channel, packet, size);
112             break;
113         case HCI_EVENT_PACKET:
114             switch (hci_event_packet_get_type(packet)) {
115                 case L2CAP_EVENT_CAN_SEND_NOW:
116                     att_dispatch_handle_can_send_now(packet, size);
117                     break;
118                 default:
119                     break;
120             }
121             break;
122         default:
123             break;
124     }
125 }
126 
127 void att_dispatch_register_client(btstack_packet_handler_t packet_handler){
128     subscriptions[ATT_CLIENT].packet_handler = packet_handler;
129     l2cap_register_fixed_channel(att_packet_handler, L2CAP_CID_ATTRIBUTE_PROTOCOL);
130 }
131 
132 void att_dispatch_register_server(btstack_packet_handler_t packet_handler){
133     subscriptions[ATT_SERVER].packet_handler = packet_handler;
134     l2cap_register_fixed_channel(att_packet_handler, L2CAP_CID_ATTRIBUTE_PROTOCOL);
135 }
136 
137 #ifdef ENABLE_GATT_OVER_CLASSIC
138 static uint16_t att_dispatch_classic_get_l2cap_cid(hci_con_handle_t con_handle){
139     // get l2cap_cid from att_server in hci_connection
140     hci_connection_t * hci_connection = hci_connection_for_handle(con_handle);
141     if (hci_connection != NULL) {
142         return hci_connection->att_server.l2cap_cid;
143     } else {
144         return 0;
145     }
146 }
147 #endif
148 
149 
150 static bool att_dispatch_can_send_now(hci_con_handle_t con_handle) {
151 #ifdef ENABLE_GATT_OVER_CLASSIC
152     uint16_t l2cap_cid = att_dispatch_classic_get_l2cap_cid(con_handle);
153     if (l2cap_cid != 0){
154         return l2cap_can_send_packet_now(l2cap_cid);
155     }
156 #endif
157     return l2cap_can_send_fixed_channel_packet_now(con_handle, L2CAP_CID_ATTRIBUTE_PROTOCOL);
158 }
159 
160 bool att_dispatch_client_can_send_now(hci_con_handle_t con_handle){
161     return att_dispatch_can_send_now(con_handle);
162 }
163 
164 bool att_dispatch_server_can_send_now(hci_con_handle_t con_handle){
165     return att_dispatch_can_send_now(con_handle);
166 }
167 
168 static void att_dispatch_request_can_send_now_event(hci_con_handle_t con_handle, uint8_t type) {
169 #ifdef ENABLE_GATT_OVER_CLASSIC
170     hci_connection_t * hci_connection = hci_connection_for_handle(con_handle);
171     if (hci_connection != NULL) {
172         att_server_t * att_server = &hci_connection->att_server;
173         if (att_server->l2cap_cid != 0){
174             bool send_request_pending = att_server->send_requests[ATT_CLIENT]
175                                      || att_server->send_requests[ATT_SERVER];
176             att_server->send_requests[type] = true;
177             if (send_request_pending == false){
178                 l2cap_request_can_send_now_event(att_server->l2cap_cid);
179             }
180             return;
181         }
182     }
183 #endif
184     subscriptions[type].waiting_for_can_send = true;
185     if (can_send_now_pending == false) {
186         can_send_now_pending = true;
187         l2cap_request_can_send_fix_channel_now_event(con_handle, L2CAP_CID_ATTRIBUTE_PROTOCOL);
188     }
189 }
190 
191 void att_dispatch_client_request_can_send_now_event(hci_con_handle_t con_handle){
192     att_dispatch_request_can_send_now_event(con_handle, ATT_CLIENT);
193 }
194 
195 void att_dispatch_server_request_can_send_now_event(hci_con_handle_t con_handle){
196     att_dispatch_request_can_send_now_event(con_handle, ATT_SERVER);
197 }
198 
199 static void emit_mtu_exchange_complete(btstack_packet_handler_t packet_handler, hci_con_handle_t con_handle, uint16_t new_mtu){
200     if (!packet_handler) return;
201     uint8_t packet[6];
202     packet[0] = ATT_EVENT_MTU_EXCHANGE_COMPLETE;
203     packet[1] = sizeof(packet) - 2u;
204     little_endian_store_16(packet, 2, con_handle);
205     little_endian_store_16(packet, 4, new_mtu);
206     packet_handler(HCI_EVENT_PACKET, con_handle, packet, 6);
207 }
208 
209 void att_dispatch_server_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu){
210     emit_mtu_exchange_complete(subscriptions[ATT_CLIENT].packet_handler, con_handle, new_mtu);
211 }
212 
213 void att_dispatch_client_mtu_exchanged(hci_con_handle_t con_handle, uint16_t new_mtu){
214     emit_mtu_exchange_complete(subscriptions[ATT_SERVER].packet_handler, con_handle, new_mtu);
215 }
216