1149b1e59c865c4bc9ec3d3e49c485207944ed3c
[linux-2.6.git] / drivers / usb / wusbcore / wusbhc.c
1 /*
2  * Wireless USB Host Controller
3  * sysfs glue, wusbcore module support and life cycle management
4  *
5  *
6  * Copyright (C) 2005-2006 Intel Corporation
7  * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License version
11  * 2 as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21  * 02110-1301, USA.
22  *
23  *
24  * Creation/destruction of wusbhc is split in two parts; that that
25  * doesn't require the HCD to be added (wusbhc_{create,destroy}) and
26  * the one that requires (phase B, wusbhc_b_{create,destroy}).
27  *
28  * This is so because usb_add_hcd() will start the HC, and thus, all
29  * the HC specific stuff has to be already initialiazed (like sysfs
30  * thingies).
31  */
32 #include <linux/device.h>
33 #include <linux/module.h>
34 #include "wusbhc.h"
35
36 /**
37  * Extract the wusbhc that corresponds to a USB Host Controller class device
38  *
39  * WARNING! Apply only if @dev is that of a
40  *          wusbhc.usb_hcd.self->class_dev; otherwise, you loose.
41  */
42 static struct wusbhc *usbhc_dev_to_wusbhc(struct device *dev)
43 {
44         struct usb_bus *usb_bus = dev_get_drvdata(dev);
45         struct usb_hcd *usb_hcd = bus_to_hcd(usb_bus);
46         return usb_hcd_to_wusbhc(usb_hcd);
47 }
48
49 /*
50  * Show & store the current WUSB trust timeout
51  *
52  * We don't do locking--it is an 'atomic' value.
53  *
54  * The units that we store/show are always MILLISECONDS. However, the
55  * value of trust_timeout is jiffies.
56  */
57 static ssize_t wusb_trust_timeout_show(struct device *dev,
58                                        struct device_attribute *attr, char *buf)
59 {
60         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
61
62         return scnprintf(buf, PAGE_SIZE, "%u\n", wusbhc->trust_timeout);
63 }
64
65 static ssize_t wusb_trust_timeout_store(struct device *dev,
66                                         struct device_attribute *attr,
67                                         const char *buf, size_t size)
68 {
69         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
70         ssize_t result = -ENOSYS;
71         unsigned trust_timeout;
72
73         result = sscanf(buf, "%u", &trust_timeout);
74         if (result != 1) {
75                 result = -EINVAL;
76                 goto out;
77         }
78         /* FIXME: maybe we should check for range validity? */
79         wusbhc->trust_timeout = trust_timeout;
80         cancel_delayed_work(&wusbhc->keep_alive_timer);
81         flush_workqueue(wusbd);
82         queue_delayed_work(wusbd, &wusbhc->keep_alive_timer,
83                            (trust_timeout * CONFIG_HZ)/1000/2);
84 out:
85         return result < 0 ? result : size;
86 }
87 static DEVICE_ATTR(wusb_trust_timeout, 0644, wusb_trust_timeout_show,
88                                              wusb_trust_timeout_store);
89
90 /*
91  * Show & store the current WUSB CHID
92  */
93 static ssize_t wusb_chid_show(struct device *dev,
94                               struct device_attribute *attr, char *buf)
95 {
96         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
97         ssize_t result = 0;
98
99         if (wusbhc->wuie_host_info != NULL)
100                 result += ckhdid_printf(buf, PAGE_SIZE,
101                                         &wusbhc->wuie_host_info->CHID);
102         return result;
103 }
104
105 /*
106  * Store a new CHID
107  *
108  * This will (FIXME) trigger many changes.
109  *
110  * - Send an all zeros CHID and it will stop the controller
111  * - Send a non-zero CHID and it will start it
112  *   (unless it was started, it will just change the CHID,
113  *   diconnecting all devices first).
114  *
115  * So first we scan the MMC we are sent and then we act on it.  We
116  * read it in the same format as we print it, an ASCII string of 16
117  * hex bytes.
118  *
119  * See wusbhc_chid_set() for more info.
120  */
121 static ssize_t wusb_chid_store(struct device *dev,
122                                struct device_attribute *attr,
123                                const char *buf, size_t size)
124 {
125         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
126         struct wusb_ckhdid chid;
127         ssize_t result;
128
129         result = sscanf(buf,
130                         "%02hhx %02hhx %02hhx %02hhx "
131                         "%02hhx %02hhx %02hhx %02hhx "
132                         "%02hhx %02hhx %02hhx %02hhx "
133                         "%02hhx %02hhx %02hhx %02hhx\n",
134                         &chid.data[0] , &chid.data[1] ,
135                         &chid.data[2] , &chid.data[3] ,
136                         &chid.data[4] , &chid.data[5] ,
137                         &chid.data[6] , &chid.data[7] ,
138                         &chid.data[8] , &chid.data[9] ,
139                         &chid.data[10], &chid.data[11],
140                         &chid.data[12], &chid.data[13],
141                         &chid.data[14], &chid.data[15]);
142         if (result != 16) {
143                 dev_err(dev, "Unrecognized CHID (need 16 8-bit hex digits): "
144                         "%d\n", (int)result);
145                 return -EINVAL;
146         }
147         result = wusbhc_chid_set(wusbhc, &chid);
148         return result < 0 ? result : size;
149 }
150 static DEVICE_ATTR(wusb_chid, 0644, wusb_chid_show, wusb_chid_store);
151
152 /* Group all the WUSBHC attributes */
153 static struct attribute *wusbhc_attrs[] = {
154                 &dev_attr_wusb_trust_timeout.attr,
155                 &dev_attr_wusb_chid.attr,
156                 NULL,
157 };
158
159 static struct attribute_group wusbhc_attr_group = {
160         .name = NULL,   /* we want them in the same directory */
161         .attrs = wusbhc_attrs,
162 };
163
164 /*
165  * Create a wusbhc instance
166  *
167  * NOTEs:
168  *
169  *  - assumes *wusbhc has been zeroed and wusbhc->usb_hcd has been
170  *    initialized but not added.
171  *
172  *  - fill out ports_max, mmcies_max and mmcie_{add,rm} before calling.
173  *
174  *  - fill out wusbhc->uwb_rc and refcount it before calling
175  *  - fill out the wusbhc->sec_modes array
176  */
177 int wusbhc_create(struct wusbhc *wusbhc)
178 {
179         int result = 0;
180
181         wusbhc->trust_timeout = WUSB_TRUST_TIMEOUT_MS;
182         mutex_init(&wusbhc->mutex);
183         result = wusbhc_mmcie_create(wusbhc);
184         if (result < 0)
185                 goto error_mmcie_create;
186         result = wusbhc_devconnect_create(wusbhc);
187         if (result < 0)
188                 goto error_devconnect_create;
189         result = wusbhc_rh_create(wusbhc);
190         if (result < 0)
191                 goto error_rh_create;
192         result = wusbhc_sec_create(wusbhc);
193         if (result < 0)
194                 goto error_sec_create;
195         result = wusbhc_pal_register(wusbhc);
196         if (result < 0)
197                 goto error_pal_register;
198         return 0;
199
200 error_pal_register:
201         wusbhc_sec_destroy(wusbhc);
202 error_sec_create:
203         wusbhc_rh_destroy(wusbhc);
204 error_rh_create:
205         wusbhc_devconnect_destroy(wusbhc);
206 error_devconnect_create:
207         wusbhc_mmcie_destroy(wusbhc);
208 error_mmcie_create:
209         return result;
210 }
211 EXPORT_SYMBOL_GPL(wusbhc_create);
212
213 static inline struct kobject *wusbhc_kobj(struct wusbhc *wusbhc)
214 {
215         return &wusbhc->usb_hcd.self.controller->kobj;
216 }
217
218 /*
219  * Phase B of a wusbhc instance creation
220  *
221  * Creates fields that depend on wusbhc->usb_hcd having been
222  * added. This is where we create the sysfs files in
223  * /sys/class/usb_host/usb_hostX/.
224  *
225  * NOTE: Assumes wusbhc->usb_hcd has been already added by the upper
226  *       layer (hwahc or whci)
227  */
228 int wusbhc_b_create(struct wusbhc *wusbhc)
229 {
230         int result = 0;
231         struct device *dev = wusbhc->usb_hcd.self.controller;
232
233         result = sysfs_create_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
234         if (result < 0) {
235                 dev_err(dev, "Cannot register WUSBHC attributes: %d\n", result);
236                 goto error_create_attr_group;
237         }
238         /* Yep, I plan to add stuff here... */
239 error_create_attr_group:
240         return result;
241 }
242 EXPORT_SYMBOL_GPL(wusbhc_b_create);
243
244 void wusbhc_b_destroy(struct wusbhc *wusbhc)
245 {
246         sysfs_remove_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
247 }
248 EXPORT_SYMBOL_GPL(wusbhc_b_destroy);
249
250 void wusbhc_destroy(struct wusbhc *wusbhc)
251 {
252         wusbhc_pal_unregister(wusbhc);
253         wusbhc_sec_destroy(wusbhc);
254         wusbhc_rh_destroy(wusbhc);
255         wusbhc_devconnect_destroy(wusbhc);
256         wusbhc_mmcie_destroy(wusbhc);
257 }
258 EXPORT_SYMBOL_GPL(wusbhc_destroy);
259
260 struct workqueue_struct *wusbd;
261 EXPORT_SYMBOL_GPL(wusbd);
262
263 /*
264  * WUSB Cluster ID allocation map
265  *
266  * Each WUSB bus in a channel is identified with a Cluster Id in the
267  * unauth address pace (WUSB1.0[4.3]). We take the range 0xe0 to 0xff
268  * (that's space for 31 WUSB controllers, as 0xff can't be taken). We
269  * start taking from 0xff, 0xfe, 0xfd... (hence the += or -= 0xff).
270  *
271  * For each one we taken, we pin it in the bitap
272  */
273 #define CLUSTER_IDS 32
274 static DECLARE_BITMAP(wusb_cluster_id_table, CLUSTER_IDS);
275 static DEFINE_SPINLOCK(wusb_cluster_ids_lock);
276
277 /*
278  * Get a WUSB Cluster ID
279  *
280  * Need to release with wusb_cluster_id_put() when done w/ it.
281  */
282 /* FIXME: coordinate with the choose_addres() from the USB stack */
283 /* we want to leave the top of the 128 range for cluster addresses and
284  * the bottom for device addresses (as we map them one on one with
285  * ports). */
286 u8 wusb_cluster_id_get(void)
287 {
288         u8 id;
289         spin_lock(&wusb_cluster_ids_lock);
290         id = find_first_zero_bit(wusb_cluster_id_table, CLUSTER_IDS);
291         if (id > CLUSTER_IDS) {
292                 id = 0;
293                 goto out;
294         }
295         set_bit(id, wusb_cluster_id_table);
296         id = (u8) 0xff - id;
297 out:
298         spin_unlock(&wusb_cluster_ids_lock);
299         return id;
300
301 }
302 EXPORT_SYMBOL_GPL(wusb_cluster_id_get);
303
304 /*
305  * Release a WUSB Cluster ID
306  *
307  * Obtained it with wusb_cluster_id_get()
308  */
309 void wusb_cluster_id_put(u8 id)
310 {
311         id = 0xff - id;
312         BUG_ON(id >= CLUSTER_IDS);
313         spin_lock(&wusb_cluster_ids_lock);
314         WARN_ON(!test_bit(id, wusb_cluster_id_table));
315         clear_bit(id, wusb_cluster_id_table);
316         spin_unlock(&wusb_cluster_ids_lock);
317 }
318 EXPORT_SYMBOL_GPL(wusb_cluster_id_put);
319
320 /**
321  * wusbhc_giveback_urb - return an URB to the USB core
322  * @wusbhc: the host controller the URB is from.
323  * @urb:    the URB.
324  * @status: the URB's status.
325  *
326  * Return an URB to the USB core doing some additional WUSB specific
327  * processing.
328  *
329  *  - After a successful transfer, update the trust timeout timestamp
330  *    for the WUSB device.
331  *
332  *  - [WUSB] sections 4.13 and 7.5.1 specifies the stop retrasmittion
333  *    condition for the WCONNECTACK_IE is that the host has observed
334  *    the associated device responding to a control transfer.
335  */
336 void wusbhc_giveback_urb(struct wusbhc *wusbhc, struct urb *urb, int status)
337 {
338         struct wusb_dev *wusb_dev = __wusb_dev_get_by_usb_dev(wusbhc, urb->dev);
339
340         if (status == 0) {
341                 wusb_dev->entry_ts = jiffies;
342
343                 /* wusbhc_devconnect_acked() can't be called from from
344                    atomic context so defer it to a work queue. */
345                 if (!list_empty(&wusb_dev->cack_node))
346                         queue_work(wusbd, &wusb_dev->devconnect_acked_work);
347         }
348
349         usb_hcd_giveback_urb(&wusbhc->usb_hcd, urb, status);
350 }
351 EXPORT_SYMBOL_GPL(wusbhc_giveback_urb);
352
353 /**
354  * wusbhc_reset_all - reset the HC hardware
355  * @wusbhc: the host controller to reset.
356  *
357  * Request a full hardware reset of the chip.  This will also reset
358  * the radio controller and any other PALs.
359  */
360 void wusbhc_reset_all(struct wusbhc *wusbhc)
361 {
362         uwb_rc_reset_all(wusbhc->uwb_rc);
363 }
364 EXPORT_SYMBOL_GPL(wusbhc_reset_all);
365
366 static struct notifier_block wusb_usb_notifier = {
367         .notifier_call = wusb_usb_ncb,
368         .priority = INT_MAX     /* Need to be called first of all */
369 };
370
371 static int __init wusbcore_init(void)
372 {
373         int result;
374         result = wusb_crypto_init();
375         if (result < 0)
376                 goto error_crypto_init;
377         /* WQ is singlethread because we need to serialize notifications */
378         wusbd = create_singlethread_workqueue("wusbd");
379         if (wusbd == NULL) {
380                 result = -ENOMEM;
381                 printk(KERN_ERR "WUSB-core: Cannot create wusbd workqueue\n");
382                 goto error_wusbd_create;
383         }
384         usb_register_notify(&wusb_usb_notifier);
385         bitmap_zero(wusb_cluster_id_table, CLUSTER_IDS);
386         set_bit(0, wusb_cluster_id_table);      /* reserve Cluster ID 0xff */
387         return 0;
388
389 error_wusbd_create:
390         wusb_crypto_exit();
391 error_crypto_init:
392         return result;
393
394 }
395 module_init(wusbcore_init);
396
397 static void __exit wusbcore_exit(void)
398 {
399         clear_bit(0, wusb_cluster_id_table);
400         if (!bitmap_empty(wusb_cluster_id_table, CLUSTER_IDS)) {
401                 char buf[256];
402                 bitmap_scnprintf(buf, sizeof(buf), wusb_cluster_id_table,
403                                  CLUSTER_IDS);
404                 printk(KERN_ERR "BUG: WUSB Cluster IDs not released "
405                        "on exit: %s\n", buf);
406                 WARN_ON(1);
407         }
408         usb_unregister_notify(&wusb_usb_notifier);
409         destroy_workqueue(wusbd);
410         wusb_crypto_exit();
411 }
412 module_exit(wusbcore_exit);
413
414 MODULE_AUTHOR("Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>");
415 MODULE_DESCRIPTION("Wireless USB core");
416 MODULE_LICENSE("GPL");