1 | /*
|
---|
2 | * Copyright (C) 2009-2012 by Matthias Ringwald
|
---|
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 MATTHIAS RINGWALD 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 btstack@ringwald.ch
|
---|
34 | *
|
---|
35 | */
|
---|
36 |
|
---|
37 | /*
|
---|
38 | * l2cap.h
|
---|
39 | *
|
---|
40 | * Logical Link Control and Adaption Protocl (L2CAP)
|
---|
41 | *
|
---|
42 | * Created by Matthias Ringwald on 5/16/09.
|
---|
43 | */
|
---|
44 |
|
---|
45 | #ifndef __L2CAP_H
|
---|
46 | #define __L2CAP_H
|
---|
47 |
|
---|
48 | #include "hci.h"
|
---|
49 | #include "l2cap_signaling.h"
|
---|
50 | #include <btstack/utils.h>
|
---|
51 | #include <btstack/btstack.h>
|
---|
52 |
|
---|
53 | #if defined __cplusplus
|
---|
54 | extern "C" {
|
---|
55 | #endif
|
---|
56 |
|
---|
57 | #define L2CAP_SIG_ID_INVALID 0
|
---|
58 |
|
---|
59 | #define L2CAP_HEADER_SIZE 4
|
---|
60 |
|
---|
61 | // size of HCI ACL + L2CAP Header for regular data packets (8)
|
---|
62 | #define COMPLETE_L2CAP_HEADER (HCI_ACL_HEADER_SIZE + L2CAP_HEADER_SIZE)
|
---|
63 |
|
---|
64 | // minimum signaling MTU
|
---|
65 | #define L2CAP_MINIMAL_MTU 48
|
---|
66 | #define L2CAP_DEFAULT_MTU 672
|
---|
67 |
|
---|
68 | // Minimum/default MTU
|
---|
69 | #define L2CAP_LE_DEFAULT_MTU 23
|
---|
70 |
|
---|
71 | // check L2CAP MTU
|
---|
72 | #if (L2CAP_MINIMAL_MTU + L2CAP_HEADER_SIZE) > HCI_ACL_PAYLOAD_SIZE
|
---|
73 | #error "HCI_ACL_PAYLOAD_SIZE too small for minimal L2CAP MTU of 48 bytes"
|
---|
74 | #endif
|
---|
75 |
|
---|
76 | // L2CAP Fixed Channel IDs
|
---|
77 | #define L2CAP_CID_SIGNALING 0x0001
|
---|
78 | #define L2CAP_CID_CONNECTIONLESS_CHANNEL 0x0002
|
---|
79 | #define L2CAP_CID_ATTRIBUTE_PROTOCOL 0x0004
|
---|
80 | #define L2CAP_CID_SIGNALING_LE 0x0005
|
---|
81 | #define L2CAP_CID_SECURITY_MANAGER_PROTOCOL 0x0006
|
---|
82 |
|
---|
83 | // L2CAP Configuration Result Codes
|
---|
84 | #define L2CAP_CONF_RESULT_UNKNOWN_OPTIONS 0x0003
|
---|
85 |
|
---|
86 | // L2CAP Reject Result Codes
|
---|
87 | #define L2CAP_REJ_CMD_UNKNOWN 0x0000
|
---|
88 |
|
---|
89 | // Response Timeout eXpired
|
---|
90 | #define L2CAP_RTX_TIMEOUT_MS 2000
|
---|
91 |
|
---|
92 | // Extended Response Timeout eXpired
|
---|
93 | #define L2CAP_ERTX_TIMEOUT_MS 120000
|
---|
94 |
|
---|
95 | // private structs
|
---|
96 | typedef enum {
|
---|
97 | L2CAP_STATE_CLOSED = 1, // no baseband
|
---|
98 | L2CAP_STATE_WILL_SEND_CREATE_CONNECTION,
|
---|
99 | L2CAP_STATE_WAIT_CONNECTION_COMPLETE,
|
---|
100 | L2CAP_STATE_WAIT_REMOTE_SUPPORTED_FEATURES,
|
---|
101 | L2CAP_STATE_WAIT_INCOMING_SECURITY_LEVEL_UPDATE,
|
---|
102 | L2CAP_STATE_WAIT_OUTGOING_SECURITY_LEVEL_UPDATE,
|
---|
103 | L2CAP_STATE_WAIT_CLIENT_ACCEPT_OR_REJECT,
|
---|
104 | L2CAP_STATE_WAIT_CONNECT_RSP, // from peer
|
---|
105 | L2CAP_STATE_CONFIG,
|
---|
106 | L2CAP_STATE_OPEN,
|
---|
107 | L2CAP_STATE_WAIT_DISCONNECT, // from application
|
---|
108 | L2CAP_STATE_WILL_SEND_CONNECTION_REQUEST,
|
---|
109 | L2CAP_STATE_WILL_SEND_CONNECTION_RESPONSE_INSUFFICIENT_SECURITY,
|
---|
110 | L2CAP_STATE_WILL_SEND_CONNECTION_RESPONSE_DECLINE,
|
---|
111 | L2CAP_STATE_WILL_SEND_CONNECTION_RESPONSE_ACCEPT,
|
---|
112 | L2CAP_STATE_WILL_SEND_DISCONNECT_REQUEST,
|
---|
113 | L2CAP_STATE_WILL_SEND_DISCONNECT_RESPONSE,
|
---|
114 | } L2CAP_STATE;
|
---|
115 |
|
---|
116 | typedef enum {
|
---|
117 | L2CAP_CHANNEL_STATE_VAR_NONE = 0,
|
---|
118 | L2CAP_CHANNEL_STATE_VAR_RCVD_CONF_REQ = 1 << 0,
|
---|
119 | L2CAP_CHANNEL_STATE_VAR_RCVD_CONF_RSP = 1 << 1,
|
---|
120 | L2CAP_CHANNEL_STATE_VAR_SEND_CONF_REQ = 1 << 2,
|
---|
121 | L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP = 1 << 3,
|
---|
122 | L2CAP_CHANNEL_STATE_VAR_SENT_CONF_REQ = 1 << 4,
|
---|
123 | L2CAP_CHANNEL_STATE_VAR_SENT_CONF_RSP = 1 << 5,
|
---|
124 | L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_MTU = 1 << 6, // in CONF RSP, add MTU field
|
---|
125 | L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_CONT = 1 << 7, // in CONF RSP, set CONTINUE flag
|
---|
126 | L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_INVALID = 1 << 8, // in CONF RSP, send UNKNOWN OPTIONS
|
---|
127 | L2CAP_CHANNEL_STATE_VAR_SEND_CMD_REJ_UNKNOWN = 1 << 9, // send CMD_REJ with reason unknown
|
---|
128 | L2CAP_CHANNEL_STATE_VAR_SEND_CONN_RESP_PEND = 1 << 10, // send Connection Respond with pending
|
---|
129 | } L2CAP_CHANNEL_STATE_VAR;
|
---|
130 |
|
---|
131 | // info regarding an actual coneection
|
---|
132 | typedef struct {
|
---|
133 | // linked list - assert: first field
|
---|
134 | linked_item_t item;
|
---|
135 |
|
---|
136 | L2CAP_STATE state;
|
---|
137 | L2CAP_CHANNEL_STATE_VAR state_var;
|
---|
138 |
|
---|
139 | bd_addr_t address;
|
---|
140 | hci_con_handle_t handle;
|
---|
141 |
|
---|
142 | uint8_t remote_sig_id; // used by other side, needed for delayed response
|
---|
143 | uint8_t local_sig_id; // own signaling identifier
|
---|
144 |
|
---|
145 | uint16_t local_cid;
|
---|
146 | uint16_t remote_cid;
|
---|
147 |
|
---|
148 | uint16_t local_mtu;
|
---|
149 | uint16_t remote_mtu;
|
---|
150 |
|
---|
151 | uint16_t flush_timeout; // default 0xffff
|
---|
152 |
|
---|
153 | uint16_t psm;
|
---|
154 |
|
---|
155 | gap_security_level_t required_security_level;
|
---|
156 |
|
---|
157 | uint8_t packets_granted; // number of L2CAP/ACL packets client is allowed to send
|
---|
158 |
|
---|
159 | uint8_t reason; // used in decline internal
|
---|
160 |
|
---|
161 | timer_source_t rtx; // also used for ertx
|
---|
162 |
|
---|
163 | // client connection
|
---|
164 | void * connection;
|
---|
165 |
|
---|
166 | // internal connection
|
---|
167 | btstack_packet_handler_t packet_handler;
|
---|
168 |
|
---|
169 | } l2cap_channel_t;
|
---|
170 |
|
---|
171 | // info regarding potential connections
|
---|
172 | typedef struct {
|
---|
173 | // linked list - assert: first field
|
---|
174 | linked_item_t item;
|
---|
175 |
|
---|
176 | // service id
|
---|
177 | uint16_t psm;
|
---|
178 |
|
---|
179 | // incoming MTU
|
---|
180 | uint16_t mtu;
|
---|
181 |
|
---|
182 | // client connection
|
---|
183 | void *connection;
|
---|
184 |
|
---|
185 | // internal connection
|
---|
186 | btstack_packet_handler_t packet_handler;
|
---|
187 |
|
---|
188 | // required security level
|
---|
189 | gap_security_level_t required_security_level;
|
---|
190 | } l2cap_service_t;
|
---|
191 |
|
---|
192 |
|
---|
193 | typedef struct l2cap_signaling_response {
|
---|
194 | hci_con_handle_t handle;
|
---|
195 | uint8_t sig_id;
|
---|
196 | uint8_t code;
|
---|
197 | uint16_t data; // infoType for INFORMATION REQUEST, result for CONNECTION request and command unknown
|
---|
198 | } l2cap_signaling_response_t;
|
---|
199 |
|
---|
200 |
|
---|
201 | void l2cap_block_new_credits(uint8_t blocked);
|
---|
202 |
|
---|
203 | int l2cap_can_send_packet_now(uint16_t local_cid); // non-blocking UART write
|
---|
204 |
|
---|
205 | int l2cap_can_send_fixed_channel_packet_now(uint16_t handle);
|
---|
206 |
|
---|
207 | // @deprecated use l2cap_can_send_fixed_channel_packet_now instead
|
---|
208 | int l2cap_can_send_connectionless_packet_now(void);
|
---|
209 |
|
---|
210 | int l2cap_reserve_packet_buffer(void);
|
---|
211 | void l2cap_release_packet_buffer(void);
|
---|
212 |
|
---|
213 | // get outgoing buffer and prepare data
|
---|
214 | uint8_t *l2cap_get_outgoing_buffer(void);
|
---|
215 |
|
---|
216 | int l2cap_send_prepared(uint16_t local_cid, uint16_t len);
|
---|
217 |
|
---|
218 | int l2cap_send_prepared_connectionless(uint16_t handle, uint16_t cid, uint16_t len);
|
---|
219 |
|
---|
220 | // Bluetooth 4.0 - allows to register handler for Attribute Protocol and Security Manager Protocol
|
---|
221 | void l2cap_register_fixed_channel(btstack_packet_handler_t packet_handler, uint16_t channel_id);
|
---|
222 |
|
---|
223 | uint16_t l2cap_max_mtu(void);
|
---|
224 | uint16_t l2cap_max_le_mtu(void);
|
---|
225 |
|
---|
226 | int l2cap_send_connectionless(uint16_t handle, uint16_t cid, uint8_t *data, uint16_t len);
|
---|
227 |
|
---|
228 | int l2cap_send_echo_request(uint16_t handle, uint8_t *data, uint16_t len);
|
---|
229 |
|
---|
230 | void l2cap_require_security_level_2_for_outgoing_sdp(void); // testing
|
---|
231 |
|
---|
232 | /** Embedded API **/
|
---|
233 |
|
---|
234 | // Set up L2CAP and register L2CAP with HCI layer.
|
---|
235 | void l2cap_init(void);
|
---|
236 |
|
---|
237 | // Registers a packet handler that handles HCI and general BTstack events.
|
---|
238 | void l2cap_register_packet_handler(void (*handler)(void * connection, uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size));
|
---|
239 |
|
---|
240 | // Creates L2CAP channel to the PSM of a remote device with baseband address. A new baseband connection will be initiated if necessary.
|
---|
241 | void l2cap_create_channel_internal(void * connection, btstack_packet_handler_t packet_handler, bd_addr_t address, uint16_t psm, uint16_t mtu);
|
---|
242 |
|
---|
243 | // Disconencts L2CAP channel with given identifier.
|
---|
244 | void l2cap_disconnect_internal(uint16_t local_cid, uint8_t reason);
|
---|
245 |
|
---|
246 | // Queries the maximal transfer unit (MTU) for L2CAP channel with given identifier.
|
---|
247 | uint16_t l2cap_get_remote_mtu_for_local_cid(uint16_t local_cid);
|
---|
248 |
|
---|
249 | // Sends L2CAP data packet to the channel with given identifier.
|
---|
250 | int l2cap_send_internal(uint16_t local_cid, uint8_t *data, uint16_t len);
|
---|
251 |
|
---|
252 | // Registers L2CAP service with given PSM and MTU, and assigns a packet handler. On embedded systems, use NULL for connection parameter.
|
---|
253 | void l2cap_register_service_internal(void *connection, btstack_packet_handler_t packet_handler, uint16_t psm, uint16_t mtu, gap_security_level_t security_level);
|
---|
254 |
|
---|
255 | // Unregisters L2CAP service with given PSM. On embedded systems, use NULL for connection parameter.
|
---|
256 | void l2cap_unregister_service_internal(void *connection, uint16_t psm);
|
---|
257 |
|
---|
258 | // Accepts/Deny incoming L2CAP connection.
|
---|
259 | void l2cap_accept_connection_internal(uint16_t local_cid);
|
---|
260 | void l2cap_decline_connection_internal(uint16_t local_cid, uint8_t reason);
|
---|
261 |
|
---|
262 |
|
---|
263 | // Request LE connection parameter update
|
---|
264 | int l2cap_le_request_connection_parameter_update(uint16_t handle, uint16_t interval_min, uint16_t interval_max, uint16_t slave_latency, uint16_t timeout_multiplier);
|
---|
265 |
|
---|
266 | #if defined __cplusplus
|
---|
267 | }
|
---|
268 | #endif
|
---|
269 |
|
---|
270 | #endif // __L2CAP_H
|
---|