blob: eeb28329fa3c9a17087834e2bb2f4d054757a005 [file] [log] [blame]
Inaky Perez-Gonzalezc7f73642008-09-17 16:34:22 +01001/*
2 * Wireless USB Standard Definitions
3 * Event Size Tables
4 *
5 * Copyright (C) 2005-2006 Intel Corporation
6 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20 * 02110-1301, USA.
21 *
22 *
23 * FIXME: docs
24 * FIXME: organize properly, group logically
25 *
26 * All the event structures are defined in uwb/spec.h, as they are
27 * common to the WHCI and WUSB radio control interfaces.
28 */
29
30#ifndef __WUSB_H__
31#define __WUSB_H__
32
33#include <linux/types.h>
34#include <linux/kernel.h>
35#include <linux/uwb/spec.h>
36#include <linux/usb/ch9.h>
37#include <linux/param.h>
38
39/**
40 * WUSB Information Element header
41 *
42 * I don't know why, they decided to make it different to the MBOA MAC
43 * IE Header; beats me.
44 */
45struct wuie_hdr {
46 u8 bLength;
47 u8 bIEIdentifier;
48} __attribute__((packed));
49
50enum {
51 WUIE_ID_WCTA = 0x80,
52 WUIE_ID_CONNECTACK,
53 WUIE_ID_HOST_INFO,
54 WUIE_ID_CHANGE_ANNOUNCE,
55 WUIE_ID_DEVICE_DISCONNECT,
56 WUIE_ID_HOST_DISCONNECT,
57 WUIE_ID_KEEP_ALIVE = 0x89,
58 WUIE_ID_ISOCH_DISCARD,
59 WUIE_ID_RESET_DEVICE,
60};
61
62/**
63 * Maximum number of array elements in a WUSB IE.
64 *
65 * WUSB1.0[7.5 before table 7-38] says that in WUSB IEs that
66 * are "arrays" have to limited to 4 elements. So we define it
67 * like that to ease up and submit only the neeed size.
68 */
69#define WUIE_ELT_MAX 4
70
71/**
72 * Wrapper for the data that defines a CHID, a CDID or a CK
73 *
74 * WUSB defines that CHIDs, CDIDs and CKs are a 16 byte string of
75 * data. In order to avoid confusion and enforce types, we wrap it.
76 *
Adam Buchbinder6070d812009-12-04 15:47:01 -050077 * Make it packed, as we use it in some hw definitions.
Inaky Perez-Gonzalezc7f73642008-09-17 16:34:22 +010078 */
79struct wusb_ckhdid {
80 u8 data[16];
81} __attribute__((packed));
82
Tobias Klauser39db4b82009-02-09 23:07:35 +010083static const struct wusb_ckhdid wusb_ckhdid_zero = { .data = { 0 } };
Inaky Perez-Gonzalezc7f73642008-09-17 16:34:22 +010084
85#define WUSB_CKHDID_STRSIZE (3 * sizeof(struct wusb_ckhdid) + 1)
86
87/**
88 * WUSB IE: Host Information (WUSB1.0[7.5.2])
89 *
90 * Used to provide information about the host to the Wireless USB
91 * devices in range (CHID can be used as an ASCII string).
92 */
93struct wuie_host_info {
94 struct wuie_hdr hdr;
95 __le16 attributes;
96 struct wusb_ckhdid CHID;
97} __attribute__((packed));
98
99/**
100 * WUSB IE: Connect Ack (WUSB1.0[7.5.1])
101 *
102 * Used to acknowledge device connect requests. See note for
103 * WUIE_ELT_MAX.
104 */
105struct wuie_connect_ack {
106 struct wuie_hdr hdr;
107 struct {
108 struct wusb_ckhdid CDID;
109 u8 bDeviceAddress; /* 0 means unused */
110 u8 bReserved;
111 } blk[WUIE_ELT_MAX];
112} __attribute__((packed));
113
114/**
115 * WUSB IE Host Information Element, Connect Availability
116 *
117 * WUSB1.0[7.5.2], bmAttributes description
118 */
119enum {
120 WUIE_HI_CAP_RECONNECT = 0,
121 WUIE_HI_CAP_LIMITED,
122 WUIE_HI_CAP_RESERVED,
123 WUIE_HI_CAP_ALL,
124};
125
126/**
127 * WUSB IE: Channel Stop (WUSB1.0[7.5.8])
128 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300129 * Tells devices the host is going to stop sending MMCs and will disappear.
Inaky Perez-Gonzalezc7f73642008-09-17 16:34:22 +0100130 */
131struct wuie_channel_stop {
132 struct wuie_hdr hdr;
133 u8 attributes;
134 u8 timestamp[3];
135} __attribute__((packed));
136
137/**
138 * WUSB IE: Keepalive (WUSB1.0[7.5.9])
139 *
140 * Ask device(s) to send keepalives.
141 */
142struct wuie_keep_alive {
143 struct wuie_hdr hdr;
144 u8 bDeviceAddress[WUIE_ELT_MAX];
145} __attribute__((packed));
146
147/**
148 * WUSB IE: Reset device (WUSB1.0[7.5.11])
149 *
150 * Tell device to reset; in all truth, we can fit 4 CDIDs, but we only
151 * use it for one at the time...
152 *
153 * In any case, this request is a wee bit silly: why don't they target
154 * by address??
155 */
156struct wuie_reset {
157 struct wuie_hdr hdr;
158 struct wusb_ckhdid CDID;
159} __attribute__((packed));
160
161/**
162 * WUSB IE: Disconnect device (WUSB1.0[7.5.11])
163 *
164 * Tell device to disconnect; we can fit 4 addresses, but we only use
165 * it for one at the time...
166 */
167struct wuie_disconnect {
168 struct wuie_hdr hdr;
169 u8 bDeviceAddress;
170 u8 padding;
171} __attribute__((packed));
172
173/**
174 * WUSB IE: Host disconnect ([WUSB] section 7.5.5)
175 *
176 * Tells all connected devices to disconnect.
177 */
178struct wuie_host_disconnect {
179 struct wuie_hdr hdr;
180} __attribute__((packed));
181
182/**
183 * WUSB Device Notification header (WUSB1.0[7.6])
184 */
185struct wusb_dn_hdr {
186 u8 bType;
187 u8 notifdata[];
188} __attribute__((packed));
189
190/** Device Notification codes (WUSB1.0[Table 7-54]) */
191enum WUSB_DN {
192 WUSB_DN_CONNECT = 0x01,
193 WUSB_DN_DISCONNECT = 0x02,
194 WUSB_DN_EPRDY = 0x03,
195 WUSB_DN_MASAVAILCHANGED = 0x04,
196 WUSB_DN_RWAKE = 0x05,
197 WUSB_DN_SLEEP = 0x06,
198 WUSB_DN_ALIVE = 0x07,
199};
200
201/** WUSB Device Notification Connect */
202struct wusb_dn_connect {
203 struct wusb_dn_hdr hdr;
204 __le16 attributes;
205 struct wusb_ckhdid CDID;
206} __attribute__((packed));
207
208static inline int wusb_dn_connect_prev_dev_addr(const struct wusb_dn_connect *dn)
209{
210 return le16_to_cpu(dn->attributes) & 0xff;
211}
212
213static inline int wusb_dn_connect_new_connection(const struct wusb_dn_connect *dn)
214{
215 return (le16_to_cpu(dn->attributes) >> 8) & 0x1;
216}
217
218static inline int wusb_dn_connect_beacon_behavior(const struct wusb_dn_connect *dn)
219{
220 return (le16_to_cpu(dn->attributes) >> 9) & 0x03;
221}
222
223/** Device is alive (aka: pong) (WUSB1.0[7.6.7]) */
224struct wusb_dn_alive {
225 struct wusb_dn_hdr hdr;
226} __attribute__((packed));
227
228/** Device is disconnecting (WUSB1.0[7.6.2]) */
229struct wusb_dn_disconnect {
230 struct wusb_dn_hdr hdr;
231} __attribute__((packed));
232
233/* General constants */
234enum {
235 WUSB_TRUST_TIMEOUT_MS = 4000, /* [WUSB] section 4.15.1 */
236};
237
238static inline size_t ckhdid_printf(char *pr_ckhdid, size_t size,
239 const struct wusb_ckhdid *ckhdid)
240{
241 return scnprintf(pr_ckhdid, size,
242 "%02hx %02hx %02hx %02hx %02hx %02hx %02hx %02hx "
243 "%02hx %02hx %02hx %02hx %02hx %02hx %02hx %02hx",
244 ckhdid->data[0], ckhdid->data[1],
245 ckhdid->data[2], ckhdid->data[3],
246 ckhdid->data[4], ckhdid->data[5],
247 ckhdid->data[6], ckhdid->data[7],
248 ckhdid->data[8], ckhdid->data[9],
249 ckhdid->data[10], ckhdid->data[11],
250 ckhdid->data[12], ckhdid->data[13],
251 ckhdid->data[14], ckhdid->data[15]);
252}
253
254/*
255 * WUSB Crypto stuff (WUSB1.0[6])
256 */
257
258extern const char *wusb_et_name(u8);
259
260/**
261 * WUSB key index WUSB1.0[7.3.2.4], for usage when setting keys for
262 * the host or the device.
263 */
264static inline u8 wusb_key_index(int index, int type, int originator)
265{
266 return (originator << 6) | (type << 4) | index;
267}
268
269#define WUSB_KEY_INDEX_TYPE_PTK 0 /* for HWA only */
270#define WUSB_KEY_INDEX_TYPE_ASSOC 1
271#define WUSB_KEY_INDEX_TYPE_GTK 2
272#define WUSB_KEY_INDEX_ORIGINATOR_HOST 0
273#define WUSB_KEY_INDEX_ORIGINATOR_DEVICE 1
Thomas Pugliese471e42a2013-12-02 15:39:45 -0600274/* bits 0-3 used for the key index. */
275#define WUSB_KEY_INDEX_MAX 15
Inaky Perez-Gonzalezc7f73642008-09-17 16:34:22 +0100276
277/* A CCM Nonce, defined in WUSB1.0[6.4.1] */
278struct aes_ccm_nonce {
279 u8 sfn[6]; /* Little Endian */
280 u8 tkid[3]; /* LE */
281 struct uwb_dev_addr dest_addr;
282 struct uwb_dev_addr src_addr;
283} __attribute__((packed));
284
285/* A CCM operation label, defined on WUSB1.0[6.5.x] */
286struct aes_ccm_label {
287 u8 data[14];
288} __attribute__((packed));
289
290/*
291 * Input to the key derivation sequence defined in
292 * WUSB1.0[6.5.1]. Rest of the data is in the CCM Nonce passed to the
293 * PRF function.
294 */
295struct wusb_keydvt_in {
296 u8 hnonce[16];
297 u8 dnonce[16];
298} __attribute__((packed));
299
300/*
301 * Output from the key derivation sequence defined in
302 * WUSB1.0[6.5.1].
303 */
304struct wusb_keydvt_out {
305 u8 kck[16];
306 u8 ptk[16];
307} __attribute__((packed));
308
309/* Pseudo Random Function WUSB1.0[6.5] */
310extern int wusb_crypto_init(void);
311extern void wusb_crypto_exit(void);
312extern ssize_t wusb_prf(void *out, size_t out_size,
313 const u8 key[16], const struct aes_ccm_nonce *_n,
314 const struct aes_ccm_label *a,
315 const void *b, size_t blen, size_t len);
316
317static inline int wusb_prf_64(void *out, size_t out_size, const u8 key[16],
318 const struct aes_ccm_nonce *n,
319 const struct aes_ccm_label *a,
320 const void *b, size_t blen)
321{
322 return wusb_prf(out, out_size, key, n, a, b, blen, 64);
323}
324
325static inline int wusb_prf_128(void *out, size_t out_size, const u8 key[16],
326 const struct aes_ccm_nonce *n,
327 const struct aes_ccm_label *a,
328 const void *b, size_t blen)
329{
330 return wusb_prf(out, out_size, key, n, a, b, blen, 128);
331}
332
333static inline int wusb_prf_256(void *out, size_t out_size, const u8 key[16],
334 const struct aes_ccm_nonce *n,
335 const struct aes_ccm_label *a,
336 const void *b, size_t blen)
337{
338 return wusb_prf(out, out_size, key, n, a, b, blen, 256);
339}
340
341/* Key derivation WUSB1.0[6.5.1] */
342static inline int wusb_key_derive(struct wusb_keydvt_out *keydvt_out,
343 const u8 key[16],
344 const struct aes_ccm_nonce *n,
345 const struct wusb_keydvt_in *keydvt_in)
346{
347 const struct aes_ccm_label a = { .data = "Pair-wise keys" };
348 return wusb_prf_256(keydvt_out, sizeof(*keydvt_out), key, n, &a,
349 keydvt_in, sizeof(*keydvt_in));
350}
351
352/*
353 * Out-of-band MIC Generation WUSB1.0[6.5.2]
354 *
355 * Compute the MIC over @key, @n and @hs and place it in @mic_out.
356 *
357 * @mic_out: Where to place the 8 byte MIC tag
358 * @key: KCK from the derivation process
359 * @n: CCM nonce, n->sfn == 0, TKID as established in the
360 * process.
361 * @hs: Handshake struct for phase 2 of the 4-way.
362 * hs->bStatus and hs->bReserved are zero.
363 * hs->bMessageNumber is 2 (WUSB1.0[7.3.2.5.2]
364 * hs->dest_addr is the device's USB address padded with 0
365 * hs->src_addr is the hosts's UWB device address
366 * hs->mic is ignored (as we compute that value).
367 */
368static inline int wusb_oob_mic(u8 mic_out[8], const u8 key[16],
369 const struct aes_ccm_nonce *n,
370 const struct usb_handshake *hs)
371{
372 const struct aes_ccm_label a = { .data = "out-of-bandMIC" };
373 return wusb_prf_64(mic_out, 8, key, n, &a,
374 hs, sizeof(*hs) - sizeof(hs->MIC));
375}
376
377#endif /* #ifndef __WUSB_H__ */