2
* Wireless USB Host Controller
3
* sysfs glue, wusbcore module support and life cycle management
6
* Copyright (C) 2005-2006 Intel Corporation
7
* Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
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.
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.
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
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}).
28
* This is so because usb_add_hcd() will start the HC, and thus, all
29
* the HC specific stuff has to be already initialized (like sysfs
32
#include <linux/device.h>
33
#include <linux/module.h>
37
* Extract the wusbhc that corresponds to a USB Host Controller class device
39
* WARNING! Apply only if @dev is that of a
40
* wusbhc.usb_hcd.self->class_dev; otherwise, you loose.
42
static struct wusbhc *usbhc_dev_to_wusbhc(struct device *dev)
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);
50
* Show & store the current WUSB trust timeout
52
* We don't do locking--it is an 'atomic' value.
54
* The units that we store/show are always MILLISECONDS. However, the
55
* value of trust_timeout is jiffies.
57
static ssize_t wusb_trust_timeout_show(struct device *dev,
58
struct device_attribute *attr, char *buf)
60
struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
62
return scnprintf(buf, PAGE_SIZE, "%u\n", wusbhc->trust_timeout);
65
static ssize_t wusb_trust_timeout_store(struct device *dev,
66
struct device_attribute *attr,
67
const char *buf, size_t size)
69
struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
70
ssize_t result = -ENOSYS;
71
unsigned trust_timeout;
73
result = sscanf(buf, "%u", &trust_timeout);
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);
85
return result < 0 ? result : size;
87
static DEVICE_ATTR(wusb_trust_timeout, 0644, wusb_trust_timeout_show,
88
wusb_trust_timeout_store);
91
* Show the current WUSB CHID.
93
static ssize_t wusb_chid_show(struct device *dev,
94
struct device_attribute *attr, char *buf)
96
struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
97
const struct wusb_ckhdid *chid;
100
if (wusbhc->wuie_host_info != NULL)
101
chid = &wusbhc->wuie_host_info->CHID;
103
chid = &wusb_ckhdid_zero;
105
result += ckhdid_printf(buf, PAGE_SIZE, chid);
106
result += sprintf(buf + result, "\n");
114
* - Write an all zeros CHID and it will stop the controller
115
* - Write a non-zero CHID and it will start it.
117
* See wusbhc_chid_set() for more info.
119
static ssize_t wusb_chid_store(struct device *dev,
120
struct device_attribute *attr,
121
const char *buf, size_t size)
123
struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
124
struct wusb_ckhdid chid;
128
"%02hhx %02hhx %02hhx %02hhx "
129
"%02hhx %02hhx %02hhx %02hhx "
130
"%02hhx %02hhx %02hhx %02hhx "
131
"%02hhx %02hhx %02hhx %02hhx\n",
132
&chid.data[0] , &chid.data[1] ,
133
&chid.data[2] , &chid.data[3] ,
134
&chid.data[4] , &chid.data[5] ,
135
&chid.data[6] , &chid.data[7] ,
136
&chid.data[8] , &chid.data[9] ,
137
&chid.data[10], &chid.data[11],
138
&chid.data[12], &chid.data[13],
139
&chid.data[14], &chid.data[15]);
141
dev_err(dev, "Unrecognized CHID (need 16 8-bit hex digits): "
142
"%d\n", (int)result);
145
result = wusbhc_chid_set(wusbhc, &chid);
146
return result < 0 ? result : size;
148
static DEVICE_ATTR(wusb_chid, 0644, wusb_chid_show, wusb_chid_store);
151
static ssize_t wusb_phy_rate_show(struct device *dev,
152
struct device_attribute *attr,
155
struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
157
return sprintf(buf, "%d\n", wusbhc->phy_rate);
160
static ssize_t wusb_phy_rate_store(struct device *dev,
161
struct device_attribute *attr,
162
const char *buf, size_t size)
164
struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
168
result = sscanf(buf, "%hhu", &phy_rate);
171
if (phy_rate >= UWB_PHY_RATE_INVALID)
174
wusbhc->phy_rate = phy_rate;
177
static DEVICE_ATTR(wusb_phy_rate, 0644, wusb_phy_rate_show, wusb_phy_rate_store);
179
/* Group all the WUSBHC attributes */
180
static struct attribute *wusbhc_attrs[] = {
181
&dev_attr_wusb_trust_timeout.attr,
182
&dev_attr_wusb_chid.attr,
183
&dev_attr_wusb_phy_rate.attr,
187
static struct attribute_group wusbhc_attr_group = {
188
.name = NULL, /* we want them in the same directory */
189
.attrs = wusbhc_attrs,
193
* Create a wusbhc instance
197
* - assumes *wusbhc has been zeroed and wusbhc->usb_hcd has been
198
* initialized but not added.
200
* - fill out ports_max, mmcies_max and mmcie_{add,rm} before calling.
202
* - fill out wusbhc->uwb_rc and refcount it before calling
203
* - fill out the wusbhc->sec_modes array
205
int wusbhc_create(struct wusbhc *wusbhc)
209
wusbhc->trust_timeout = WUSB_TRUST_TIMEOUT_MS;
210
wusbhc->phy_rate = UWB_PHY_RATE_INVALID - 1;
212
mutex_init(&wusbhc->mutex);
213
result = wusbhc_mmcie_create(wusbhc);
215
goto error_mmcie_create;
216
result = wusbhc_devconnect_create(wusbhc);
218
goto error_devconnect_create;
219
result = wusbhc_rh_create(wusbhc);
221
goto error_rh_create;
222
result = wusbhc_sec_create(wusbhc);
224
goto error_sec_create;
228
wusbhc_rh_destroy(wusbhc);
230
wusbhc_devconnect_destroy(wusbhc);
231
error_devconnect_create:
232
wusbhc_mmcie_destroy(wusbhc);
236
EXPORT_SYMBOL_GPL(wusbhc_create);
238
static inline struct kobject *wusbhc_kobj(struct wusbhc *wusbhc)
240
return &wusbhc->usb_hcd.self.controller->kobj;
244
* Phase B of a wusbhc instance creation
246
* Creates fields that depend on wusbhc->usb_hcd having been
247
* added. This is where we create the sysfs files in
248
* /sys/class/usb_host/usb_hostX/.
250
* NOTE: Assumes wusbhc->usb_hcd has been already added by the upper
251
* layer (hwahc or whci)
253
int wusbhc_b_create(struct wusbhc *wusbhc)
256
struct device *dev = wusbhc->usb_hcd.self.controller;
258
result = sysfs_create_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
260
dev_err(dev, "Cannot register WUSBHC attributes: %d\n", result);
261
goto error_create_attr_group;
264
result = wusbhc_pal_register(wusbhc);
266
goto error_pal_register;
270
sysfs_remove_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
271
error_create_attr_group:
274
EXPORT_SYMBOL_GPL(wusbhc_b_create);
276
void wusbhc_b_destroy(struct wusbhc *wusbhc)
278
wusbhc_pal_unregister(wusbhc);
279
sysfs_remove_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
281
EXPORT_SYMBOL_GPL(wusbhc_b_destroy);
283
void wusbhc_destroy(struct wusbhc *wusbhc)
285
wusbhc_sec_destroy(wusbhc);
286
wusbhc_rh_destroy(wusbhc);
287
wusbhc_devconnect_destroy(wusbhc);
288
wusbhc_mmcie_destroy(wusbhc);
290
EXPORT_SYMBOL_GPL(wusbhc_destroy);
292
struct workqueue_struct *wusbd;
293
EXPORT_SYMBOL_GPL(wusbd);
296
* WUSB Cluster ID allocation map
298
* Each WUSB bus in a channel is identified with a Cluster Id in the
299
* unauth address pace (WUSB1.0[4.3]). We take the range 0xe0 to 0xff
300
* (that's space for 31 WUSB controllers, as 0xff can't be taken). We
301
* start taking from 0xff, 0xfe, 0xfd... (hence the += or -= 0xff).
303
* For each one we taken, we pin it in the bitap
305
#define CLUSTER_IDS 32
306
static DECLARE_BITMAP(wusb_cluster_id_table, CLUSTER_IDS);
307
static DEFINE_SPINLOCK(wusb_cluster_ids_lock);
310
* Get a WUSB Cluster ID
312
* Need to release with wusb_cluster_id_put() when done w/ it.
314
/* FIXME: coordinate with the choose_addres() from the USB stack */
315
/* we want to leave the top of the 128 range for cluster addresses and
316
* the bottom for device addresses (as we map them one on one with
318
u8 wusb_cluster_id_get(void)
321
spin_lock(&wusb_cluster_ids_lock);
322
id = find_first_zero_bit(wusb_cluster_id_table, CLUSTER_IDS);
323
if (id >= CLUSTER_IDS) {
327
set_bit(id, wusb_cluster_id_table);
330
spin_unlock(&wusb_cluster_ids_lock);
334
EXPORT_SYMBOL_GPL(wusb_cluster_id_get);
337
* Release a WUSB Cluster ID
339
* Obtained it with wusb_cluster_id_get()
341
void wusb_cluster_id_put(u8 id)
344
BUG_ON(id >= CLUSTER_IDS);
345
spin_lock(&wusb_cluster_ids_lock);
346
WARN_ON(!test_bit(id, wusb_cluster_id_table));
347
clear_bit(id, wusb_cluster_id_table);
348
spin_unlock(&wusb_cluster_ids_lock);
350
EXPORT_SYMBOL_GPL(wusb_cluster_id_put);
353
* wusbhc_giveback_urb - return an URB to the USB core
354
* @wusbhc: the host controller the URB is from.
356
* @status: the URB's status.
358
* Return an URB to the USB core doing some additional WUSB specific
361
* - After a successful transfer, update the trust timeout timestamp
362
* for the WUSB device.
364
* - [WUSB] sections 4.13 and 7.5.1 specifies the stop retrasmittion
365
* condition for the WCONNECTACK_IE is that the host has observed
366
* the associated device responding to a control transfer.
368
void wusbhc_giveback_urb(struct wusbhc *wusbhc, struct urb *urb, int status)
370
struct wusb_dev *wusb_dev = __wusb_dev_get_by_usb_dev(wusbhc, urb->dev);
372
if (status == 0 && wusb_dev) {
373
wusb_dev->entry_ts = jiffies;
375
/* wusbhc_devconnect_acked() can't be called from
376
atomic context so defer it to a work queue. */
377
if (!list_empty(&wusb_dev->cack_node))
378
queue_work(wusbd, &wusb_dev->devconnect_acked_work);
380
wusb_dev_put(wusb_dev);
383
usb_hcd_giveback_urb(&wusbhc->usb_hcd, urb, status);
385
EXPORT_SYMBOL_GPL(wusbhc_giveback_urb);
388
* wusbhc_reset_all - reset the HC hardware
389
* @wusbhc: the host controller to reset.
391
* Request a full hardware reset of the chip. This will also reset
392
* the radio controller and any other PALs.
394
void wusbhc_reset_all(struct wusbhc *wusbhc)
396
uwb_rc_reset_all(wusbhc->uwb_rc);
398
EXPORT_SYMBOL_GPL(wusbhc_reset_all);
400
static struct notifier_block wusb_usb_notifier = {
401
.notifier_call = wusb_usb_ncb,
402
.priority = INT_MAX /* Need to be called first of all */
405
static int __init wusbcore_init(void)
408
result = wusb_crypto_init();
410
goto error_crypto_init;
411
/* WQ is singlethread because we need to serialize notifications */
412
wusbd = create_singlethread_workqueue("wusbd");
415
printk(KERN_ERR "WUSB-core: Cannot create wusbd workqueue\n");
416
goto error_wusbd_create;
418
usb_register_notify(&wusb_usb_notifier);
419
bitmap_zero(wusb_cluster_id_table, CLUSTER_IDS);
420
set_bit(0, wusb_cluster_id_table); /* reserve Cluster ID 0xff */
429
module_init(wusbcore_init);
431
static void __exit wusbcore_exit(void)
433
clear_bit(0, wusb_cluster_id_table);
434
if (!bitmap_empty(wusb_cluster_id_table, CLUSTER_IDS)) {
436
bitmap_scnprintf(buf, sizeof(buf), wusb_cluster_id_table,
438
printk(KERN_ERR "BUG: WUSB Cluster IDs not released "
439
"on exit: %s\n", buf);
442
usb_unregister_notify(&wusb_usb_notifier);
443
destroy_workqueue(wusbd);
446
module_exit(wusbcore_exit);
448
MODULE_AUTHOR("Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>");
449
MODULE_DESCRIPTION("Wireless USB core");
450
MODULE_LICENSE("GPL");