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 initialized (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,
  59                                         char *buf)
  60 {
  61         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
  62
  63         return scnprintf(buf, PAGE_SIZE, "%u\n", wusbhc->trust_timeout);
  64 }
  65
  66 static ssize_t wusb_trust_timeout_store(struct device *dev,
  67                                         struct device_attribute *attr,
  68                                         const char *buf, size_t size)
  69 {
  70         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
  71         ssize_t result = -ENOSYS;
  72         unsigned trust_timeout;
  73
  74         result = sscanf(buf, "%u", &trust_timeout);
  75         if (result != 1) {
  76                 result = -EINVAL;
  77                 goto out;
  78         }
  79         wusbhc->trust_timeout = min_t(unsigned, trust_timeout, 500);
  80         cancel_delayed_work(&wusbhc->keep_alive_timer);
  81         flush_workqueue(wusbd);
  82         queue_delayed_work(wusbd, &wusbhc->keep_alive_timer,
  83                            msecs_to_jiffies(wusbhc->trust_timeout / 2));
  84 out:
  85         return result < 0 ? result : size;
  86 }
  87 static DEVICE_ATTR_RW(wusb_trust_timeout);
  88
  89 /*
  90  * Show the current WUSB CHID.
  91  */
  92 static ssize_t wusb_chid_show(struct device *dev,
  93                               struct device_attribute *attr, char *buf)
  94 {
  95         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
  96         const struct wusb_ckhdid *chid;
  97         ssize_t result = 0;
  98
  99         if (wusbhc->wuie_host_info != NULL)
 100                 chid = &wusbhc->wuie_host_info->CHID;
 101         else
 102                 chid = &wusb_ckhdid_zero;
 103
 104         result += ckhdid_printf(buf, PAGE_SIZE, chid);
 105         result += sprintf(buf + result, "\n");
 106
 107         return result;
 108 }
 109
 110 /*
 111  * Store a new CHID.
 112  *
 113  * - Write an all zeros CHID and it will stop the controller
 114  * - Write a non-zero CHID and it will start it.
 115  *
 116  * See wusbhc_chid_set() for more info.
 117  */
 118 static ssize_t wusb_chid_store(struct device *dev,
 119                                struct device_attribute *attr,
 120                                const char *buf, size_t size)
 121 {
 122         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
 123         struct wusb_ckhdid chid;
 124         ssize_t result;
 125
 126         result = sscanf(buf,
 127                         "%02hhx %02hhx %02hhx %02hhx "
 128                         "%02hhx %02hhx %02hhx %02hhx "
 129                         "%02hhx %02hhx %02hhx %02hhx "
 130                         "%02hhx %02hhx %02hhx %02hhx\n",
 131                         &chid.data[0] , &chid.data[1] ,
 132                         &chid.data[2] , &chid.data[3] ,
 133                         &chid.data[4] , &chid.data[5] ,
 134                         &chid.data[6] , &chid.data[7] ,
 135                         &chid.data[8] , &chid.data[9] ,
 136                         &chid.data[10], &chid.data[11],
 137                         &chid.data[12], &chid.data[13],
 138                         &chid.data[14], &chid.data[15]);
 139         if (result != 16) {
 140                 dev_err(dev, "Unrecognized CHID (need 16 8-bit hex digits): "
 141                         "%d\n", (int)result);
 142                 return -EINVAL;
 143         }
 144         result = wusbhc_chid_set(wusbhc, &chid);
 145         return result < 0 ? result : size;
 146 }
 147 static DEVICE_ATTR_RW(wusb_chid);
 148
 149
 150 static ssize_t wusb_phy_rate_show(struct device *dev,
 151                                   struct device_attribute *attr,
 152                                   char *buf)
 153 {
 154         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
 155
 156         return sprintf(buf, "%d\n", wusbhc->phy_rate);
 157 }
 158
 159 static ssize_t wusb_phy_rate_store(struct device *dev,
 160                                    struct device_attribute *attr,
 161                                    const char *buf, size_t size)
 162 {
 163         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
 164         uint8_t phy_rate;
 165         ssize_t result;
 166
 167         result = sscanf(buf, "%hhu", &phy_rate);
 168         if (result != 1)
 169                 return -EINVAL;
 170         if (phy_rate >= UWB_PHY_RATE_INVALID)
 171                 return -EINVAL;
 172
 173         wusbhc->phy_rate = phy_rate;
 174         return size;
 175 }
 176 static DEVICE_ATTR_RW(wusb_phy_rate);
 177
 178 static ssize_t wusb_dnts_show(struct device *dev,
 179                                   struct device_attribute *attr,
 180                                   char *buf)
 181 {
 182         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
 183
 184         return sprintf(buf, "num slots: %d\ninterval: %dms\n",
 185                         wusbhc->dnts_num_slots, wusbhc->dnts_interval);
 186 }
 187
 188 static ssize_t wusb_dnts_store(struct device *dev,
 189                                    struct device_attribute *attr,
 190                                    const char *buf, size_t size)
 191 {
 192         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
 193         uint8_t num_slots, interval;
 194         ssize_t result;
 195
 196         result = sscanf(buf, "%hhu %hhu", &num_slots, &interval);
 197
 198         if (result != 2)
 199                 return -EINVAL;
 200
 201         wusbhc->dnts_num_slots = num_slots;
 202         wusbhc->dnts_interval = interval;
 203
 204         return size;
 205 }
 206 static DEVICE_ATTR_RW(wusb_dnts);
 207
 208 static ssize_t wusb_retry_count_show(struct device *dev,
 209                                   struct device_attribute *attr,
 210                                   char *buf)
 211 {
 212         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
 213
 214         return sprintf(buf, "%d\n", wusbhc->retry_count);
 215 }
 216
 217 static ssize_t wusb_retry_count_store(struct device *dev,
 218                                    struct device_attribute *attr,
 219                                    const char *buf, size_t size)
 220 {
 221         struct wusbhc *wusbhc = usbhc_dev_to_wusbhc(dev);
 222         uint8_t retry_count;
 223         ssize_t result;
 224
 225         result = sscanf(buf, "%hhu", &retry_count);
 226
 227         if (result != 1)
 228                 return -EINVAL;
 229
 230         wusbhc->retry_count = max_t(uint8_t, retry_count,
 231                                         WUSB_RETRY_COUNT_MAX);
 232
 233         return size;
 234 }
 235 static DEVICE_ATTR_RW(wusb_retry_count);
 236
 237 /* Group all the WUSBHC attributes */
 238 static struct attribute *wusbhc_attrs[] = {
 239                 &dev_attr_wusb_trust_timeout.attr,
 240                 &dev_attr_wusb_chid.attr,
 241                 &dev_attr_wusb_phy_rate.attr,
 242                 &dev_attr_wusb_dnts.attr,
 243                 &dev_attr_wusb_retry_count.attr,
 244                 NULL,
 245 };
 246
 247 static const struct attribute_group wusbhc_attr_group = {
 248         .name = NULL,   /* we want them in the same directory */
 249         .attrs = wusbhc_attrs,
 250 };
 251
 252 /*
 253  * Create a wusbhc instance
 254  *
 255  * NOTEs:
 256  *
 257  *  - assumes *wusbhc has been zeroed and wusbhc->usb_hcd has been
 258  *    initialized but not added.
 259  *
 260  *  - fill out ports_max, mmcies_max and mmcie_{add,rm} before calling.
 261  *
 262  *  - fill out wusbhc->uwb_rc and refcount it before calling
 263  *  - fill out the wusbhc->sec_modes array
 264  */
 265 int wusbhc_create(struct wusbhc *wusbhc)
 266 {
 267         int result = 0;
 268
 269         /* set defaults.  These can be overwritten using sysfs attributes. */
 270         wusbhc->trust_timeout = WUSB_TRUST_TIMEOUT_MS;
 271         wusbhc->phy_rate = UWB_PHY_RATE_INVALID - 1;
 272         wusbhc->dnts_num_slots = 4;
 273         wusbhc->dnts_interval = 2;
 274         wusbhc->retry_count = WUSB_RETRY_COUNT_INFINITE;
 275
 276         mutex_init(&wusbhc->mutex);
 277         result = wusbhc_mmcie_create(wusbhc);
 278         if (result < 0)
 279                 goto error_mmcie_create;
 280         result = wusbhc_devconnect_create(wusbhc);
 281         if (result < 0)
 282                 goto error_devconnect_create;
 283         result = wusbhc_rh_create(wusbhc);
 284         if (result < 0)
 285                 goto error_rh_create;
 286         result = wusbhc_sec_create(wusbhc);
 287         if (result < 0)
 288                 goto error_sec_create;
 289         return 0;
 290
 291 error_sec_create:
 292         wusbhc_rh_destroy(wusbhc);
 293 error_rh_create:
 294         wusbhc_devconnect_destroy(wusbhc);
 295 error_devconnect_create:
 296         wusbhc_mmcie_destroy(wusbhc);
 297 error_mmcie_create:
 298         return result;
 299 }
 300 EXPORT_SYMBOL_GPL(wusbhc_create);
 301
 302 static inline struct kobject *wusbhc_kobj(struct wusbhc *wusbhc)
 303 {
 304         return &wusbhc->usb_hcd.self.controller->kobj;
 305 }
 306
 307 /*
 308  * Phase B of a wusbhc instance creation
 309  *
 310  * Creates fields that depend on wusbhc->usb_hcd having been
 311  * added. This is where we create the sysfs files in
 312  * /sys/class/usb_host/usb_hostX/.
 313  *
 314  * NOTE: Assumes wusbhc->usb_hcd has been already added by the upper
 315  *       layer (hwahc or whci)
 316  */
 317 int wusbhc_b_create(struct wusbhc *wusbhc)
 318 {
 319         int result = 0;
 320         struct device *dev = wusbhc->usb_hcd.self.controller;
 321
 322         result = sysfs_create_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
 323         if (result < 0) {
 324                 dev_err(dev, "Cannot register WUSBHC attributes: %d\n",
 325                         result);
 326                 goto error_create_attr_group;
 327         }
 328
 329         return 0;
 330 error_create_attr_group:
 331         return result;
 332 }
 333 EXPORT_SYMBOL_GPL(wusbhc_b_create);
 334
 335 void wusbhc_b_destroy(struct wusbhc *wusbhc)
 336 {
 337         wusbhc_pal_unregister(wusbhc);
 338         sysfs_remove_group(wusbhc_kobj(wusbhc), &wusbhc_attr_group);
 339 }
 340 EXPORT_SYMBOL_GPL(wusbhc_b_destroy);
 341
 342 void wusbhc_destroy(struct wusbhc *wusbhc)
 343 {
 344         wusbhc_sec_destroy(wusbhc);
 345         wusbhc_rh_destroy(wusbhc);
 346         wusbhc_devconnect_destroy(wusbhc);
 347         wusbhc_mmcie_destroy(wusbhc);
 348 }
 349 EXPORT_SYMBOL_GPL(wusbhc_destroy);
 350
 351 struct workqueue_struct *wusbd;
 352 EXPORT_SYMBOL_GPL(wusbd);
 353
 354 /*
 355  * WUSB Cluster ID allocation map
 356  *
 357  * Each WUSB bus in a channel is identified with a Cluster Id in the
 358  * unauth address pace (WUSB1.0[4.3]). We take the range 0xe0 to 0xff
 359  * (that's space for 31 WUSB controllers, as 0xff can't be taken). We
 360  * start taking from 0xff, 0xfe, 0xfd... (hence the += or -= 0xff).
 361  *
 362  * For each one we taken, we pin it in the bitap
 363  */
 364 #define CLUSTER_IDS 32
 365 static DECLARE_BITMAP(wusb_cluster_id_table, CLUSTER_IDS);
 366 static DEFINE_SPINLOCK(wusb_cluster_ids_lock);
 367
 368 /*
 369  * Get a WUSB Cluster ID
 370  *
 371  * Need to release with wusb_cluster_id_put() when done w/ it.
 372  */
 373 /* FIXME: coordinate with the choose_addres() from the USB stack */
 374 /* we want to leave the top of the 128 range for cluster addresses and
 375  * the bottom for device addresses (as we map them one on one with
 376  * ports). */
 377 u8 wusb_cluster_id_get(void)
 378 {
 379         u8 id;
 380         spin_lock(&wusb_cluster_ids_lock);
 381         id = find_first_zero_bit(wusb_cluster_id_table, CLUSTER_IDS);
 382         if (id >= CLUSTER_IDS) {
 383                 id = 0;
 384                 goto out;
 385         }
 386         set_bit(id, wusb_cluster_id_table);
 387         id = (u8) 0xff - id;
 388 out:
 389         spin_unlock(&wusb_cluster_ids_lock);
 390         return id;
 391
 392 }
 393 EXPORT_SYMBOL_GPL(wusb_cluster_id_get);
 394
 395 /*
 396  * Release a WUSB Cluster ID
 397  *
 398  * Obtained it with wusb_cluster_id_get()
 399  */
 400 void wusb_cluster_id_put(u8 id)
 401 {
 402         id = 0xff - id;
 403         BUG_ON(id >= CLUSTER_IDS);
 404         spin_lock(&wusb_cluster_ids_lock);
 405         WARN_ON(!test_bit(id, wusb_cluster_id_table));
 406         clear_bit(id, wusb_cluster_id_table);
 407         spin_unlock(&wusb_cluster_ids_lock);
 408 }
 409 EXPORT_SYMBOL_GPL(wusb_cluster_id_put);
 410
 411 /**
 412  * wusbhc_giveback_urb - return an URB to the USB core
 413  * @wusbhc: the host controller the URB is from.
 414  * @urb:    the URB.
 415  * @status: the URB's status.
 416  *
 417  * Return an URB to the USB core doing some additional WUSB specific
 418  * processing.
 419  *
 420  *  - After a successful transfer, update the trust timeout timestamp
 421  *    for the WUSB device.
 422  *
 423  *  - [WUSB] sections 4.13 and 7.5.1 specify the stop retransmission
 424  *    condition for the WCONNECTACK_IE is that the host has observed
 425  *    the associated device responding to a control transfer.
 426  */
 427 void wusbhc_giveback_urb(struct wusbhc *wusbhc, struct urb *urb, int status)
 428 {
 429         struct wusb_dev *wusb_dev = __wusb_dev_get_by_usb_dev(wusbhc,
 430                                         urb->dev);
 431
 432         if (status == 0 && wusb_dev) {
 433                 wusb_dev->entry_ts = jiffies;
 434
 435                 /* wusbhc_devconnect_acked() can't be called from
 436                    atomic context so defer it to a work queue. */
 437                 if (!list_empty(&wusb_dev->cack_node))
 438                         queue_work(wusbd, &wusb_dev->devconnect_acked_work);
 439                 else
 440                         wusb_dev_put(wusb_dev);
 441         }
 442
 443         usb_hcd_giveback_urb(&wusbhc->usb_hcd, urb, status);
 444 }
 445 EXPORT_SYMBOL_GPL(wusbhc_giveback_urb);
 446
 447 /**
 448  * wusbhc_reset_all - reset the HC hardware
 449  * @wusbhc: the host controller to reset.
 450  *
 451  * Request a full hardware reset of the chip.  This will also reset
 452  * the radio controller and any other PALs.
 453  */
 454 void wusbhc_reset_all(struct wusbhc *wusbhc)
 455 {
 456         if (wusbhc->uwb_rc)
 457                 uwb_rc_reset_all(wusbhc->uwb_rc);
 458 }
 459 EXPORT_SYMBOL_GPL(wusbhc_reset_all);
 460
 461 static struct notifier_block wusb_usb_notifier = {
 462         .notifier_call = wusb_usb_ncb,
 463         .priority = INT_MAX     /* Need to be called first of all */
 464 };
 465
 466 static int __init wusbcore_init(void)
 467 {
 468         int result;
 469         result = wusb_crypto_init();
 470         if (result < 0)
 471                 goto error_crypto_init;
 472         /* WQ is singlethread because we need to serialize notifications */
 473         wusbd = create_singlethread_workqueue("wusbd");
 474         if (wusbd == NULL) {
 475                 result = -ENOMEM;
 476                 printk(KERN_ERR "WUSB-core: Cannot create wusbd workqueue\n");
 477                 goto error_wusbd_create;
 478         }
 479         usb_register_notify(&wusb_usb_notifier);
 480         bitmap_zero(wusb_cluster_id_table, CLUSTER_IDS);
 481         set_bit(0, wusb_cluster_id_table);      /* reserve Cluster ID 0xff */
 482         return 0;
 483
 484 error_wusbd_create:
 485         wusb_crypto_exit();
 486 error_crypto_init:
 487         return result;
 488
 489 }
 490 module_init(wusbcore_init);
 491
 492 static void __exit wusbcore_exit(void)
 493 {
 494         clear_bit(0, wusb_cluster_id_table);
 495         if (!bitmap_empty(wusb_cluster_id_table, CLUSTER_IDS)) {
 496                 printk(KERN_ERR "BUG: WUSB Cluster IDs not released on exit: %*pb\n",
 497                        CLUSTER_IDS, wusb_cluster_id_table);
 498                 WARN_ON(1);
 499         }
 500         usb_unregister_notify(&wusb_usb_notifier);
 501         destroy_workqueue(wusbd);
 502         wusb_crypto_exit();
 503 }
 504 module_exit(wusbcore_exit);
 505
 506 MODULE_AUTHOR("Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>");
 507 MODULE_DESCRIPTION("Wireless USB core");
 508 MODULE_LICENSE("GPL");