1 /******************************************************************************
2  *
3  *  Copyright (C) 1999-2012 Broadcom Corporation
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at:
8  *
9  *  http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  ******************************************************************************/
18 
19 #ifndef L2CDEFS_H
20 #define L2CDEFS_H
21 
22 /* L2CAP command codes
23 */
24 #define L2CAP_CMD_REJECT                    0x01
25 #define L2CAP_CMD_CONN_REQ                  0x02
26 #define L2CAP_CMD_CONN_RSP                  0x03
27 #define L2CAP_CMD_CONFIG_REQ                0x04
28 #define L2CAP_CMD_CONFIG_RSP                0x05
29 #define L2CAP_CMD_DISC_REQ                  0x06
30 #define L2CAP_CMD_DISC_RSP                  0x07
31 #define L2CAP_CMD_ECHO_REQ                  0x08
32 #define L2CAP_CMD_ECHO_RSP                  0x09
33 #define L2CAP_CMD_INFO_REQ                  0x0A
34 #define L2CAP_CMD_INFO_RSP                  0x0B
35 #define L2CAP_CMD_AMP_CONN_REQ              0x0C
36 #define L2CAP_CMD_AMP_CONN_RSP              0x0D
37 #define L2CAP_CMD_AMP_MOVE_REQ              0x0E
38 #define L2CAP_CMD_AMP_MOVE_RSP              0x0F
39 #define L2CAP_CMD_AMP_MOVE_CFM              0x10
40 #define L2CAP_CMD_AMP_MOVE_CFM_RSP          0x11
41 
42 #define L2CAP_CMD_BLE_UPDATE_REQ            0x12
43 #define L2CAP_CMD_BLE_UPDATE_RSP            0x13
44 #define L2CAP_CMD_BLE_CREDIT_BASED_CONN_REQ 0x14
45 #define L2CAP_CMD_BLE_CREDIT_BASED_CONN_RES 0x15
46 #define L2CAP_CMD_BLE_FLOW_CTRL_CREDIT      0x16
47 
48 
49 
50 /* Define some packet and header lengths
51 */
52 #define L2CAP_PKT_OVERHEAD      4           /* Length and CID                       */
53 #define L2CAP_CMD_OVERHEAD      4           /* Cmd code, Id and length              */
54 #define L2CAP_CMD_REJECT_LEN    2           /* Reason (data is optional)            */
55 #define L2CAP_CONN_REQ_LEN      4           /* PSM and source CID                   */
56 #define L2CAP_CONN_RSP_LEN      8           /* Dest CID, source CID, reason, status */
57 #define L2CAP_CONFIG_REQ_LEN    4           /* Dest CID, flags (data is optional)   */
58 #define L2CAP_CONFIG_RSP_LEN    6           /* Dest CID, flags, result,data optional*/
59 #define L2CAP_DISC_REQ_LEN      4           /* Dest CID, source CID                 */
60 #define L2CAP_DISC_RSP_LEN      4           /* Dest CID, source CID                 */
61 #define L2CAP_ECHO_REQ_LEN      0           /* Data is optional                     */
62 #define L2CAP_ECHO_RSP_LEN      0           /* Data is optional                     */
63 #define L2CAP_INFO_REQ_LEN      2           /* Info type                            */
64 #define L2CAP_INFO_RSP_LEN      4           /* Info type, result (data is optional) */
65 #define L2CAP_BCST_OVERHEAD     2           /* Additional broadcast packet overhead */
66 #define L2CAP_UCD_OVERHEAD      2           /* Additional connectionless packet overhead */
67 
68 #define L2CAP_AMP_CONN_REQ_LEN  5           /* PSM, CID, and remote controller ID   */
69 #define L2CAP_AMP_MOVE_REQ_LEN  3           /* CID and remote controller ID         */
70 #define L2CAP_AMP_MOVE_RSP_LEN  4           /* CID and result                       */
71 #define L2CAP_AMP_MOVE_CFM_LEN  4           /* CID and result                       */
72 #define L2CAP_AMP_MOVE_CFM_RSP_LEN  2       /* CID                                  */
73 
74 #define L2CAP_CMD_BLE_UPD_REQ_LEN   8       /* Min and max interval, latency, tout  */
75 #define L2CAP_CMD_BLE_UPD_RSP_LEN   2       /* Result                               */
76 
77 #define L2CAP_CMD_BLE_CREDIT_BASED_CONN_REQ_LEN 10 /* LE_PSM, SCID, MTU, MPS, Init Credit */
78 #define L2CAP_CMD_BLE_CREDIT_BASED_CONN_RES_LEN 10 /* DCID, MTU, MPS, Init credit, Result */
79 #define L2CAP_CMD_BLE_FLOW_CTRL_CREDIT_LEN      4  /* CID, Credit */
80 
81 
82 
83 /* Define the packet boundary flags
84 */
85 #if (L2CAP_NON_FLUSHABLE_PB_INCLUDED == TRUE)
86 #define L2CAP_PKT_START_FLUSHABLE       2
87 #define L2CAP_PKT_START_NON_FLUSHABLE   0
88 #endif
89 #define L2CAP_COMPLETE_AMP_PKT          3       /* complete L2CAP packet on AMP HCI */
90 #define L2CAP_PKT_START                 2
91 #define L2CAP_PKT_CONTINUE              1
92 #define L2CAP_MASK_FLAG            0x0FFF
93 #define L2CAP_PKT_TYPE_SHIFT            12
94 #define L2CAP_PKT_TYPE_MASK             3
95 
96 
97 /* Define the L2CAP connection result codes
98 */
99 #define L2CAP_CONN_OK                0
100 #define L2CAP_CONN_PENDING           1
101 #define L2CAP_CONN_NO_PSM            2
102 #define L2CAP_CONN_SECURITY_BLOCK    3
103 #define L2CAP_CONN_NO_RESOURCES      4
104 #define L2CAP_CONN_BAD_CTLR_ID       5              /* AMP related */
105 #define L2CAP_CONN_TIMEOUT           0xEEEE
106 #define L2CAP_CONN_AMP_FAILED        254
107 #define L2CAP_CONN_NO_LINK           255        /* Add a couple of our own for internal use */
108 #define L2CAP_CONN_CANCEL            256        /* L2CAP connection cancelled */
109 
110 
111 /* Define L2CAP Move Channel Response result codes
112 */
113 #define L2CAP_MOVE_OK                   0
114 #define L2CAP_MOVE_PENDING              1
115 #define L2CAP_MOVE_CTRL_ID_NOT_SUPPORT  2
116 #define L2CAP_MOVE_SAME_CTRLR_ID        3
117 #define L2CAP_MOVE_CONFIG_NOT_SUPPORTED 4
118 #define L2CAP_MOVE_CHAN_COLLISION       5
119 #define L2CAP_MOVE_NOT_ALLOWED          6
120 
121 
122 /* Define L2CAP Move Channel Confirmation result codes
123 */
124 #define L2CAP_MOVE_CFM_OK               0
125 #define L2CAP_MOVE_CFM_REFUSED          1
126 
127 
128 /* Define the L2CAP command reject reason codes
129 */
130 #define L2CAP_CMD_REJ_NOT_UNDERSTOOD    0
131 #define L2CAP_CMD_REJ_MTU_EXCEEDED      1
132 #define L2CAP_CMD_REJ_INVALID_CID       2
133 
134 
135 /* L2CAP Predefined CIDs
136 */
137 #define L2CAP_SIGNALLING_CID            1
138 #define L2CAP_CONNECTIONLESS_CID        2
139 #define L2CAP_AMP_CID                   3
140 #define L2CAP_ATT_CID                   4
141 #define L2CAP_BLE_SIGNALLING_CID        5
142 #define L2CAP_SMP_CID                   6
143 #define L2CAP_SMP_BR_CID                7
144 #define L2CAP_AMP_TEST_CID              0x003F
145 #define L2CAP_BASE_APPL_CID             0x0040
146 #define L2CAP_BLE_CONN_MAX_CID          0x007F
147 
148 /* Fixed Channels mask bits */
149 
150 /* Signal channel supported (Mandatory) */
151 #define L2CAP_FIXED_CHNL_SIG_BIT     (1 << L2CAP_SIGNALLING_CID)
152 
153 /* Connectionless reception */
154 #define L2CAP_FIXED_CHNL_CNCTLESS_BIT (1 << L2CAP_CONNECTIONLESS_CID)
155 
156 /* AMP Manager supported */
157 #define L2CAP_FIXED_CHNL_AMP_BIT      (1 << L2CAP_AMP_CID)
158 
159 /* Attribute protocol supported */
160 #define L2CAP_FIXED_CHNL_ATT_BIT      (1 << L2CAP_ATT_CID)
161 
162 /* BLE Signalling supported */
163 #define L2CAP_FIXED_CHNL_BLE_SIG_BIT  (1 << L2CAP_BLE_SIGNALLING_CID)
164 
165 /* BLE Security Mgr supported */
166 #define L2CAP_FIXED_CHNL_SMP_BIT      (1 << L2CAP_SMP_CID)
167 
168 /* Security Mgr over BR supported */
169 #define L2CAP_FIXED_CHNL_SMP_BR_BIT   (1 << L2CAP_SMP_BR_CID)
170 
171 
172 
173 /* Define the L2CAP configuration result codes
174 */
175 #define L2CAP_CFG_OK                    0
176 #define L2CAP_CFG_UNACCEPTABLE_PARAMS   1
177 #define L2CAP_CFG_FAILED_NO_REASON      2
178 #define L2CAP_CFG_UNKNOWN_OPTIONS       3
179 #define L2CAP_CFG_PENDING               4
180 #define L2CAP_CFG_FLOW_SPEC_REJECTED    5
181 
182 
183 /* Define the L2CAP configuration option types
184 */
185 #define L2CAP_CFG_TYPE_MTU              0x01
186 #define L2CAP_CFG_TYPE_FLUSH_TOUT       0x02
187 #define L2CAP_CFG_TYPE_QOS              0x03
188 #define L2CAP_CFG_TYPE_FCR              0x04
189 #define L2CAP_CFG_TYPE_FCS              0x05
190 #define L2CAP_CFG_TYPE_EXT_FLOW         0x06
191 #define L2CAP_CFG_TYPE_EXT_WIN_SIZE     0x07
192 
193 #define L2CAP_CFG_MTU_OPTION_LEN        2           /* MTU option length    */
194 #define L2CAP_CFG_FLUSH_OPTION_LEN      2           /* Flush option len     */
195 #define L2CAP_CFG_QOS_OPTION_LEN        22          /* QOS option length    */
196 #define L2CAP_CFG_FCR_OPTION_LEN        9           /* FCR option length    */
197 #define L2CAP_CFG_FCS_OPTION_LEN        1           /* FCR option length    */
198 #define L2CAP_CFG_EXT_FLOW_OPTION_LEN   16          /* Extended Flow Spec   */
199 #define L2CAP_CFG_EXT_WIN_SIZE_LEN      2           /* Ext window size length */
200 #define L2CAP_CFG_OPTION_OVERHEAD       2           /* Type and length      */
201 
202 /* Configuration Cmd/Rsp Flags mask
203 */
204 #define L2CAP_CFG_FLAGS_MASK_CONT       0x0001      /* Flags mask: Continuation */
205 
206 /* FCS Check Option values
207 */
208 #define L2CAP_CFG_FCS_BYPASS            0       /* Bypass the FCS in streaming or ERTM modes */
209 #define L2CAP_CFG_FCS_USE               1       /* Use the FCS in streaming or ERTM modes [default] */
210 
211 /* Default values for configuration
212 */
213 #define L2CAP_NO_AUTOMATIC_FLUSH        0xFFFF
214 #define L2CAP_NO_RETRANSMISSION         0x0001
215 
216 #define L2CAP_DEFAULT_MTU               (672)
217 #define L2CAP_DEFAULT_FLUSH_TO          L2CAP_NO_AUTOMATIC_FLUSH
218 #define L2CAP_DEFAULT_SERV_TYPE         1
219 #define L2CAP_DEFAULT_TOKEN_RATE        0
220 #define L2CAP_DEFAULT_BUCKET_SIZE       0
221 #define L2CAP_DEFAULT_PEAK_BANDWIDTH    0
222 #define L2CAP_DEFAULT_LATENCY           0xFFFFFFFF
223 #define L2CAP_DEFAULT_DELAY             0xFFFFFFFF
224 #define L2CAP_DEFAULT_FCS               L2CAP_CFG_FCS_USE
225 
226 
227 /* Define the L2CAP disconnect result codes
228 */
229 #define L2CAP_DISC_OK                   0
230 #define L2CAP_DISC_TIMEOUT              0xEEEE
231 
232 /* Define the L2CAP info resp result codes
233 */
234 #define L2CAP_INFO_RESP_RESULT_SUCCESS          0
235 #define L2CAP_INFO_RESP_RESULT_NOT_SUPPORTED    1
236 
237 /* Define the info-type fields of information request & response
238 */
239 #define L2CAP_CONNLESS_MTU_INFO_TYPE      0x0001
240 #define L2CAP_EXTENDED_FEATURES_INFO_TYPE 0x0002    /* Used in Information Req/Response */
241 #define L2CAP_FIXED_CHANNELS_INFO_TYPE    0x0003    /* Used in AMP                      */
242 
243 #define L2CAP_CONNLESS_MTU_INFO_SIZE           2    /* Connectionless MTU size          */
244 #define L2CAP_EXTENDED_FEATURES_ARRAY_SIZE     4    /* Extended features array size     */
245 #define L2CAP_FIXED_CHNL_ARRAY_SIZE            8    /* Fixed channel array size         */
246 
247 /* Extended features mask bits
248 */
249 #define L2CAP_EXTFEA_RTRANS         0x00000001    /* Retransmission Mode (Not Supported)    */
250 #define L2CAP_EXTFEA_FC             0x00000002    /* Flow Control Mode   (Not Supported)    */
251 #define L2CAP_EXTFEA_QOS            0x00000004
252 #define L2CAP_EXTFEA_ENH_RETRANS    0x00000008    /* Enhanced retransmission mode           */
253 #define L2CAP_EXTFEA_STREAM_MODE    0x00000010    /* Streaming Mode                         */
254 #define L2CAP_EXTFEA_NO_CRC         0x00000020    /* Optional FCS (if set No FCS desired)   */
255 #define L2CAP_EXTFEA_EXT_FLOW_SPEC  0x00000040    /* Extended flow spec                     */
256 #define L2CAP_EXTFEA_FIXED_CHNLS    0x00000080    /* Fixed channels                         */
257 #define L2CAP_EXTFEA_EXT_WINDOW     0x00000100    /* Extended Window Size                   */
258 #define L2CAP_EXTFEA_UCD_RECEPTION  0x00000200    /* Unicast Connectionless Data Reception  */
259 
260 /* Mask for LE supported features used in Information Response (default to none) */
261 #ifndef L2CAP_BLE_EXTFEA_MASK
262 #define L2CAP_BLE_EXTFEA_MASK 0
263 #endif
264 
265 /* Define a value that tells L2CAP to use the default HCI ACL buffer size */
266 #define L2CAP_INVALID_ERM_BUF_SIZE      0
267 
268 /* Define a value that tells L2CAP to use the default MPS */
269 #define L2CAP_DEFAULT_ERM_MPS           0x0000
270 
271 #define L2CAP_FCR_OVERHEAD         2   /* Control word                 */
272 #define L2CAP_FCS_LEN              2   /* FCS takes 2 bytes */
273 #define L2CAP_SDU_LEN_OVERHEAD     2   /* SDU length field is 2 bytes */
274 #define L2CAP_SDU_LEN_OFFSET       2   /* SDU length offset is 2 bytes */
275 #define L2CAP_EXT_CONTROL_OVERHEAD 4   /* Extended Control Field       */
276 #define L2CAP_MAX_HEADER_FCS       (L2CAP_PKT_OVERHEAD + L2CAP_EXT_CONTROL_OVERHEAD + L2CAP_SDU_LEN_OVERHEAD + L2CAP_FCS_LEN)
277 /* length(2), channel(2), control(4), SDU length(2) FCS(2) */
278 /* To optimize this, it must be a multiplum of the L2CAP PDU length AND match the 3DH5 air
279  * including the l2cap headers in each packet - to match the latter - the -5 is added
280  */
281 #define L2CAP_MAX_SDU_LENGTH     (8080 + 26 - (L2CAP_MIN_OFFSET + 6))
282 #define L2CAP_MAX_BUF_SIZE       (10240 + 24)
283 
284 /* Part of L2CAP_MIN_OFFSET that is not part of L2CAP
285 */
286 #define L2CAP_OFFSET_WO_L2HDR  (L2CAP_MIN_OFFSET-(L2CAP_PKT_OVERHEAD+L2CAP_FCR_OVERHEAD))
287 
288 /* SAR bits in the control word
289 */
290 #define L2CAP_FCR_UNSEG_SDU    0x0000   /* Control word to begin with for unsegmented PDU*/
291 #define L2CAP_FCR_START_SDU    0x4000   /* ...for Starting PDU of a semented SDU */
292 #define L2CAP_FCR_END_SDU      0x8000   /* ...for ending PDU of a segmented SDU */
293 #define L2CAP_FCR_CONT_SDU     0xc000   /* ...for continuation PDU of a segmented SDU */
294 
295 /* Supervisory frame types
296 */
297 #define L2CAP_FCR_SUP_RR        0x0000   /* Supervisory frame - RR                          */
298 #define L2CAP_FCR_SUP_REJ       0x0001   /* Supervisory frame - REJ                         */
299 #define L2CAP_FCR_SUP_RNR       0x0002   /* Supervisory frame - RNR                         */
300 #define L2CAP_FCR_SUP_SREJ      0x0003   /* Supervisory frame - SREJ                        */
301 
302 #define L2CAP_FCR_SAR_BITS           0xC000    /* Mask to get the SAR bits from control word */
303 #define L2CAP_FCR_SAR_BITS_SHIFT     14        /* Bits to shift right to get the SAR bits from ctrl-word */
304 
305 #define L2CAP_FCR_S_FRAME_BIT         0x0001   /* Mask to check if a PDU is S-frame */
306 #define L2CAP_FCR_REQ_SEQ_BITS        0x3F00   /* Mask to get the req-seq from control word */
307 #define L2CAP_FCR_REQ_SEQ_BITS_SHIFT  8        /* Bits to shift right to get the req-seq from ctrl-word */
308 #define L2CAP_FCR_TX_SEQ_BITS         0x007E   /* Mask on get the tx-seq from control word */
309 #define L2CAP_FCR_TX_SEQ_BITS_SHIFT   1        /* Bits to shift right to get the tx-seq from ctrl-word */
310 
311 #define L2CAP_FCR_F_BIT               0x0080   /* F-bit in the control word (Sup and I frames)  */
312 #define L2CAP_FCR_P_BIT               0x0010   /* P-bit in the control word (Sup frames only)   */
313 
314 #define L2CAP_FCR_F_BIT_SHIFT         7
315 #define L2CAP_FCR_P_BIT_SHIFT         4
316 
317 #define L2CAP_FCR_SEG_BITS            0xC000   /* Mask to get the segmentation bits from ctrl-word */
318 #define L2CAP_FCR_SUP_SHIFT           2        /* Bits to shift right to get the S-bits from ctrl-word */
319 #define L2CAP_FCR_SUP_BITS            0x000C   /* Mask to get the supervisory bits from ctrl-word */
320 
321 #define L2CAP_FCR_INIT_CRC            0   /* Initial state of the CRC register */
322 #define L2CAP_FCR_SEQ_MODULO          0x3F     /* Mask for sequence numbers (range 0 - 63) */
323 
324 #define L2CAP_LE_RESULT_CONN_OK     0
325 #define L2CAP_LE_RESULT_NO_PSM      2
326 #define L2CAP_LE_RESULT_NO_RESOURCES 4
327 #define L2CAP_LE_RESULT_INSUFFICIENT_AUTHENTICATION 5
328 #define L2CAP_LE_RESULT_INSUFFICIENT_AUTHORIZATION 6
329 #define L2CAP_LE_RESULT_INSUFFICIENT_ENCRY_KEY_SIZE 7
330 #define L2CAP_LE_RESULT_INSUFFICIENT_ENCRY 8
331 #define L2CAP_LE_RESULT_INVALID_SOURCE_CID 9
332 #define L2CAP_LE_RESULT_SOURCE_CID_ALREADY_ALLOCATED 0x0A
333 #define L2CAP_LE_RESULT_UNACCEPTABLE_PARAMETERS 0x0B
334 #define L2CAP_LE_RESULT_INVALID_PARAMETERS 0x0C
335 
336 #endif
337