hwa-hc.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854
  1. /*
  2. * Host Wire Adapter:
  3. * Driver glue, HWA-specific functions, bridges to WAHC and WUSBHC
  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. * The HWA driver is a simple layer that forwards requests to the WAHC
  24. * (Wire Adater Host Controller) or WUSBHC (Wireless USB Host
  25. * Controller) layers.
  26. *
  27. * Host Wire Adapter is the 'WUSB 1.0 standard' name for Wireless-USB
  28. * Host Controller that is connected to your system via USB (a USB
  29. * dongle that implements a USB host...). There is also a Device Wired
  30. * Adaptor, DWA (Wireless USB hub) that uses the same mechanism for
  31. * transferring data (it is after all a USB host connected via
  32. * Wireless USB), we have a common layer called Wire Adapter Host
  33. * Controller that does all the hard work. The WUSBHC (Wireless USB
  34. * Host Controller) is the part common to WUSB Host Controllers, the
  35. * HWA and the PCI-based one, that is implemented following the WHCI
  36. * spec. All these layers are implemented in ../wusbcore.
  37. *
  38. * The main functions are hwahc_op_urb_{en,de}queue(), that pass the
  39. * job of converting a URB to a Wire Adapter
  40. *
  41. * Entry points:
  42. *
  43. * hwahc_driver_*() Driver initialization, registration and
  44. * teardown.
  45. *
  46. * hwahc_probe() New device came up, create an instance for
  47. * it [from device enumeration].
  48. *
  49. * hwahc_disconnect() Remove device instance [from device
  50. * enumeration].
  51. *
  52. * [__]hwahc_op_*() Host-Wire-Adaptor specific functions for
  53. * starting/stopping/etc (some might be made also
  54. * DWA).
  55. */
  56. #include <linux/kernel.h>
  57. #include <linux/init.h>
  58. #include <linux/module.h>
  59. #include <linux/workqueue.h>
  60. #include <linux/wait.h>
  61. #include <linux/completion.h>
  62. #include "../wusbcore/wa-hc.h"
  63. #include "../wusbcore/wusbhc.h"
  64. struct hwahc {
  65. struct wusbhc wusbhc; /* has to be 1st */
  66. struct wahc wa;
  67. };
  68. /*
  69. * FIXME should be wusbhc
  70. *
  71. * NOTE: we need to cache the Cluster ID because later...there is no
  72. * way to get it :)
  73. */
  74. static int __hwahc_set_cluster_id(struct hwahc *hwahc, u8 cluster_id)
  75. {
  76. int result;
  77. struct wusbhc *wusbhc = &hwahc->wusbhc;
  78. struct wahc *wa = &hwahc->wa;
  79. struct device *dev = &wa->usb_iface->dev;
  80. result = usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  81. WUSB_REQ_SET_CLUSTER_ID,
  82. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  83. cluster_id,
  84. wa->usb_iface->cur_altsetting->desc.bInterfaceNumber,
  85. NULL, 0, 1000 /* FIXME: arbitrary */);
  86. if (result < 0)
  87. dev_err(dev, "Cannot set WUSB Cluster ID to 0x%02x: %d\n",
  88. cluster_id, result);
  89. else
  90. wusbhc->cluster_id = cluster_id;
  91. dev_info(dev, "Wireless USB Cluster ID set to 0x%02x\n", cluster_id);
  92. return result;
  93. }
  94. static int __hwahc_op_set_num_dnts(struct wusbhc *wusbhc, u8 interval, u8 slots)
  95. {
  96. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  97. struct wahc *wa = &hwahc->wa;
  98. return usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  99. WUSB_REQ_SET_NUM_DNTS,
  100. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  101. interval << 8 | slots,
  102. wa->usb_iface->cur_altsetting->desc.bInterfaceNumber,
  103. NULL, 0, 1000 /* FIXME: arbitrary */);
  104. }
  105. /*
  106. * Reset a WUSB host controller and wait for it to complete doing it.
  107. *
  108. * @usb_hcd: Pointer to WUSB Host Controller instance.
  109. *
  110. */
  111. static int hwahc_op_reset(struct usb_hcd *usb_hcd)
  112. {
  113. int result;
  114. struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  115. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  116. struct device *dev = &hwahc->wa.usb_iface->dev;
  117. mutex_lock(&wusbhc->mutex);
  118. wa_nep_disarm(&hwahc->wa);
  119. result = __wa_set_feature(&hwahc->wa, WA_RESET);
  120. if (result < 0) {
  121. dev_err(dev, "error commanding HC to reset: %d\n", result);
  122. goto error_unlock;
  123. }
  124. result = __wa_wait_status(&hwahc->wa, WA_STATUS_RESETTING, 0);
  125. if (result < 0) {
  126. dev_err(dev, "error waiting for HC to reset: %d\n", result);
  127. goto error_unlock;
  128. }
  129. error_unlock:
  130. mutex_unlock(&wusbhc->mutex);
  131. return result;
  132. }
  133. /*
  134. * FIXME: break this function up
  135. */
  136. static int hwahc_op_start(struct usb_hcd *usb_hcd)
  137. {
  138. u8 addr;
  139. int result;
  140. struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  141. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  142. result = -ENOSPC;
  143. mutex_lock(&wusbhc->mutex);
  144. addr = wusb_cluster_id_get();
  145. if (addr == 0)
  146. goto error_cluster_id_get;
  147. result = __hwahc_set_cluster_id(hwahc, addr);
  148. if (result < 0)
  149. goto error_set_cluster_id;
  150. usb_hcd->uses_new_polling = 1;
  151. usb_hcd->poll_rh = 1;
  152. usb_hcd->state = HC_STATE_RUNNING;
  153. result = 0;
  154. out:
  155. mutex_unlock(&wusbhc->mutex);
  156. return result;
  157. error_set_cluster_id:
  158. wusb_cluster_id_put(wusbhc->cluster_id);
  159. error_cluster_id_get:
  160. goto out;
  161. }
  162. /*
  163. * No need to abort pipes, as when this is called, all the children
  164. * has been disconnected and that has done it [through
  165. * usb_disable_interface() -> usb_disable_endpoint() ->
  166. * hwahc_op_ep_disable() - >rpipe_ep_disable()].
  167. */
  168. static void hwahc_op_stop(struct usb_hcd *usb_hcd)
  169. {
  170. struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  171. mutex_lock(&wusbhc->mutex);
  172. wusb_cluster_id_put(wusbhc->cluster_id);
  173. mutex_unlock(&wusbhc->mutex);
  174. }
  175. static int hwahc_op_get_frame_number(struct usb_hcd *usb_hcd)
  176. {
  177. struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  178. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  179. dev_err(wusbhc->dev, "%s (%p [%p]) UNIMPLEMENTED\n", __func__,
  180. usb_hcd, hwahc);
  181. return -ENOSYS;
  182. }
  183. static int hwahc_op_urb_enqueue(struct usb_hcd *usb_hcd, struct urb *urb,
  184. gfp_t gfp)
  185. {
  186. struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  187. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  188. return wa_urb_enqueue(&hwahc->wa, urb->ep, urb, gfp);
  189. }
  190. static int hwahc_op_urb_dequeue(struct usb_hcd *usb_hcd, struct urb *urb,
  191. int status)
  192. {
  193. struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  194. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  195. return wa_urb_dequeue(&hwahc->wa, urb);
  196. }
  197. /*
  198. * Release resources allocated for an endpoint
  199. *
  200. * If there is an associated rpipe to this endpoint, go ahead and put it.
  201. */
  202. static void hwahc_op_endpoint_disable(struct usb_hcd *usb_hcd,
  203. struct usb_host_endpoint *ep)
  204. {
  205. struct wusbhc *wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  206. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  207. rpipe_ep_disable(&hwahc->wa, ep);
  208. }
  209. static int __hwahc_op_wusbhc_start(struct wusbhc *wusbhc)
  210. {
  211. int result;
  212. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  213. struct device *dev = &hwahc->wa.usb_iface->dev;
  214. result = __wa_set_feature(&hwahc->wa, WA_ENABLE);
  215. if (result < 0) {
  216. dev_err(dev, "error commanding HC to start: %d\n", result);
  217. goto error_stop;
  218. }
  219. result = __wa_wait_status(&hwahc->wa, WA_ENABLE, WA_ENABLE);
  220. if (result < 0) {
  221. dev_err(dev, "error waiting for HC to start: %d\n", result);
  222. goto error_stop;
  223. }
  224. result = wa_nep_arm(&hwahc->wa, GFP_KERNEL);
  225. if (result < 0) {
  226. dev_err(dev, "cannot listen to notifications: %d\n", result);
  227. goto error_stop;
  228. }
  229. return result;
  230. error_stop:
  231. __wa_clear_feature(&hwahc->wa, WA_ENABLE);
  232. return result;
  233. }
  234. static void __hwahc_op_wusbhc_stop(struct wusbhc *wusbhc, int delay)
  235. {
  236. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  237. struct wahc *wa = &hwahc->wa;
  238. u8 iface_no = wa->usb_iface->cur_altsetting->desc.bInterfaceNumber;
  239. int ret;
  240. ret = usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  241. WUSB_REQ_CHAN_STOP,
  242. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  243. delay * 1000,
  244. iface_no,
  245. NULL, 0, 1000 /* FIXME: arbitrary */);
  246. if (ret == 0)
  247. msleep(delay);
  248. wa_nep_disarm(&hwahc->wa);
  249. __wa_stop(&hwahc->wa);
  250. }
  251. /*
  252. * Set the UWB MAS allocation for the WUSB cluster
  253. *
  254. * @stream_index: stream to use (-1 for cancelling the allocation)
  255. * @mas: mas bitmap to use
  256. */
  257. static int __hwahc_op_bwa_set(struct wusbhc *wusbhc, s8 stream_index,
  258. const struct uwb_mas_bm *mas)
  259. {
  260. int result;
  261. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  262. struct wahc *wa = &hwahc->wa;
  263. struct device *dev = &wa->usb_iface->dev;
  264. u8 mas_le[UWB_NUM_MAS/8];
  265. /* Set the stream index */
  266. result = usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  267. WUSB_REQ_SET_STREAM_IDX,
  268. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  269. stream_index,
  270. wa->usb_iface->cur_altsetting->desc.bInterfaceNumber,
  271. NULL, 0, 1000 /* FIXME: arbitrary */);
  272. if (result < 0) {
  273. dev_err(dev, "Cannot set WUSB stream index: %d\n", result);
  274. goto out;
  275. }
  276. uwb_mas_bm_copy_le(mas_le, mas);
  277. /* Set the MAS allocation */
  278. result = usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  279. WUSB_REQ_SET_WUSB_MAS,
  280. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  281. 0, wa->usb_iface->cur_altsetting->desc.bInterfaceNumber,
  282. mas_le, 32, 1000 /* FIXME: arbitrary */);
  283. if (result < 0)
  284. dev_err(dev, "Cannot set WUSB MAS allocation: %d\n", result);
  285. out:
  286. return result;
  287. }
  288. /*
  289. * Add an IE to the host's MMC
  290. *
  291. * @interval: See WUSB1.0[8.5.3.1]
  292. * @repeat_cnt: See WUSB1.0[8.5.3.1]
  293. * @handle: See WUSB1.0[8.5.3.1]
  294. * @wuie: Pointer to the header of the WUSB IE data to add.
  295. * MUST BE allocated in a kmalloc buffer (no stack or
  296. * vmalloc).
  297. *
  298. * NOTE: the format of the WUSB IEs for MMCs are different to the
  299. * normal MBOA MAC IEs (IE Id + Length in MBOA MAC vs. Length +
  300. * Id in WUSB IEs). Standards...you gotta love'em.
  301. */
  302. static int __hwahc_op_mmcie_add(struct wusbhc *wusbhc, u8 interval,
  303. u8 repeat_cnt, u8 handle,
  304. struct wuie_hdr *wuie)
  305. {
  306. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  307. struct wahc *wa = &hwahc->wa;
  308. u8 iface_no = wa->usb_iface->cur_altsetting->desc.bInterfaceNumber;
  309. return usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  310. WUSB_REQ_ADD_MMC_IE,
  311. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  312. interval << 8 | repeat_cnt,
  313. handle << 8 | iface_no,
  314. wuie, wuie->bLength, 1000 /* FIXME: arbitrary */);
  315. }
  316. /*
  317. * Remove an IE to the host's MMC
  318. *
  319. * @handle: See WUSB1.0[8.5.3.1]
  320. */
  321. static int __hwahc_op_mmcie_rm(struct wusbhc *wusbhc, u8 handle)
  322. {
  323. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  324. struct wahc *wa = &hwahc->wa;
  325. u8 iface_no = wa->usb_iface->cur_altsetting->desc.bInterfaceNumber;
  326. return usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  327. WUSB_REQ_REMOVE_MMC_IE,
  328. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  329. 0, handle << 8 | iface_no,
  330. NULL, 0, 1000 /* FIXME: arbitrary */);
  331. }
  332. /*
  333. * Update device information for a given fake port
  334. *
  335. * @port_idx: Fake port to which device is connected (wusbhc index, not
  336. * USB port number).
  337. */
  338. static int __hwahc_op_dev_info_set(struct wusbhc *wusbhc,
  339. struct wusb_dev *wusb_dev)
  340. {
  341. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  342. struct wahc *wa = &hwahc->wa;
  343. u8 iface_no = wa->usb_iface->cur_altsetting->desc.bInterfaceNumber;
  344. struct hwa_dev_info *dev_info;
  345. int ret;
  346. /* fill out the Device Info buffer and send it */
  347. dev_info = kzalloc(sizeof(struct hwa_dev_info), GFP_KERNEL);
  348. if (!dev_info)
  349. return -ENOMEM;
  350. uwb_mas_bm_copy_le(dev_info->bmDeviceAvailability,
  351. &wusb_dev->availability);
  352. dev_info->bDeviceAddress = wusb_dev->addr;
  353. /*
  354. * If the descriptors haven't been read yet, use a default PHY
  355. * rate of 53.3 Mbit/s only. The correct value will be used
  356. * when this will be called again as part of the
  357. * authentication process (which occurs after the descriptors
  358. * have been read).
  359. */
  360. if (wusb_dev->wusb_cap_descr)
  361. dev_info->wPHYRates = wusb_dev->wusb_cap_descr->wPHYRates;
  362. else
  363. dev_info->wPHYRates = cpu_to_le16(USB_WIRELESS_PHY_53);
  364. ret = usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  365. WUSB_REQ_SET_DEV_INFO,
  366. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  367. 0, wusb_dev->port_idx << 8 | iface_no,
  368. dev_info, sizeof(struct hwa_dev_info),
  369. 1000 /* FIXME: arbitrary */);
  370. kfree(dev_info);
  371. return ret;
  372. }
  373. /*
  374. * Set host's idea of which encryption (and key) method to use when
  375. * talking to ad evice on a given port.
  376. *
  377. * If key is NULL, it means disable encryption for that "virtual port"
  378. * (used when we disconnect).
  379. */
  380. static int __hwahc_dev_set_key(struct wusbhc *wusbhc, u8 port_idx, u32 tkid,
  381. const void *key, size_t key_size,
  382. u8 key_idx)
  383. {
  384. int result = -ENOMEM;
  385. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  386. struct wahc *wa = &hwahc->wa;
  387. u8 iface_no = wa->usb_iface->cur_altsetting->desc.bInterfaceNumber;
  388. struct usb_key_descriptor *keyd;
  389. size_t keyd_len;
  390. keyd_len = sizeof(*keyd) + key_size;
  391. keyd = kzalloc(keyd_len, GFP_KERNEL);
  392. if (keyd == NULL)
  393. return -ENOMEM;
  394. keyd->bLength = keyd_len;
  395. keyd->bDescriptorType = USB_DT_KEY;
  396. keyd->tTKID[0] = (tkid >> 0) & 0xff;
  397. keyd->tTKID[1] = (tkid >> 8) & 0xff;
  398. keyd->tTKID[2] = (tkid >> 16) & 0xff;
  399. memcpy(keyd->bKeyData, key, key_size);
  400. result = usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  401. USB_REQ_SET_DESCRIPTOR,
  402. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  403. USB_DT_KEY << 8 | key_idx,
  404. port_idx << 8 | iface_no,
  405. keyd, keyd_len, 1000 /* FIXME: arbitrary */);
  406. kzfree(keyd); /* clear keys etc. */
  407. return result;
  408. }
  409. /*
  410. * Set host's idea of which encryption (and key) method to use when
  411. * talking to ad evice on a given port.
  412. *
  413. * If key is NULL, it means disable encryption for that "virtual port"
  414. * (used when we disconnect).
  415. */
  416. static int __hwahc_op_set_ptk(struct wusbhc *wusbhc, u8 port_idx, u32 tkid,
  417. const void *key, size_t key_size)
  418. {
  419. int result = -ENOMEM;
  420. struct hwahc *hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  421. struct wahc *wa = &hwahc->wa;
  422. u8 iface_no = wa->usb_iface->cur_altsetting->desc.bInterfaceNumber;
  423. u8 encryption_value;
  424. /* Tell the host which key to use to talk to the device */
  425. if (key) {
  426. u8 key_idx = wusb_key_index(0, WUSB_KEY_INDEX_TYPE_PTK,
  427. WUSB_KEY_INDEX_ORIGINATOR_HOST);
  428. result = __hwahc_dev_set_key(wusbhc, port_idx, tkid,
  429. key, key_size, key_idx);
  430. if (result < 0)
  431. goto error_set_key;
  432. encryption_value = wusbhc->ccm1_etd->bEncryptionValue;
  433. } else {
  434. /* FIXME: this should come from wusbhc->etd[UNSECURE].value */
  435. encryption_value = 0;
  436. }
  437. /* Set the encryption type for commmunicating with the device */
  438. result = usb_control_msg(wa->usb_dev, usb_sndctrlpipe(wa->usb_dev, 0),
  439. USB_REQ_SET_ENCRYPTION,
  440. USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  441. encryption_value, port_idx << 8 | iface_no,
  442. NULL, 0, 1000 /* FIXME: arbitrary */);
  443. if (result < 0)
  444. dev_err(wusbhc->dev, "Can't set host's WUSB encryption for "
  445. "port index %u to %s (value %d): %d\n", port_idx,
  446. wusb_et_name(wusbhc->ccm1_etd->bEncryptionType),
  447. wusbhc->ccm1_etd->bEncryptionValue, result);
  448. error_set_key:
  449. return result;
  450. }
  451. /*
  452. * Set host's GTK key
  453. */
  454. static int __hwahc_op_set_gtk(struct wusbhc *wusbhc, u32 tkid,
  455. const void *key, size_t key_size)
  456. {
  457. u8 key_idx = wusb_key_index(0, WUSB_KEY_INDEX_TYPE_GTK,
  458. WUSB_KEY_INDEX_ORIGINATOR_HOST);
  459. return __hwahc_dev_set_key(wusbhc, 0, tkid, key, key_size, key_idx);
  460. }
  461. /*
  462. * Get the Wire Adapter class-specific descriptor
  463. *
  464. * NOTE: this descriptor comes with the big bundled configuration
  465. * descriptor that includes the interfaces' and endpoints', so
  466. * we just look for it in the cached copy kept by the USB stack.
  467. *
  468. * NOTE2: We convert LE fields to CPU order.
  469. */
  470. static int wa_fill_descr(struct wahc *wa)
  471. {
  472. int result;
  473. struct device *dev = &wa->usb_iface->dev;
  474. char *itr;
  475. struct usb_device *usb_dev = wa->usb_dev;
  476. struct usb_descriptor_header *hdr;
  477. struct usb_wa_descriptor *wa_descr;
  478. size_t itr_size, actconfig_idx;
  479. actconfig_idx = (usb_dev->actconfig - usb_dev->config) /
  480. sizeof(usb_dev->config[0]);
  481. itr = usb_dev->rawdescriptors[actconfig_idx];
  482. itr_size = le16_to_cpu(usb_dev->actconfig->desc.wTotalLength);
  483. while (itr_size >= sizeof(*hdr)) {
  484. hdr = (struct usb_descriptor_header *) itr;
  485. dev_dbg(dev, "Extra device descriptor: "
  486. "type %02x/%u bytes @ %zu (%zu left)\n",
  487. hdr->bDescriptorType, hdr->bLength,
  488. (itr - usb_dev->rawdescriptors[actconfig_idx]),
  489. itr_size);
  490. if (hdr->bDescriptorType == USB_DT_WIRE_ADAPTER)
  491. goto found;
  492. itr += hdr->bLength;
  493. itr_size -= hdr->bLength;
  494. }
  495. dev_err(dev, "cannot find Wire Adapter Class descriptor\n");
  496. return -ENODEV;
  497. found:
  498. result = -EINVAL;
  499. if (hdr->bLength > itr_size) { /* is it available? */
  500. dev_err(dev, "incomplete Wire Adapter Class descriptor "
  501. "(%zu bytes left, %u needed)\n",
  502. itr_size, hdr->bLength);
  503. goto error;
  504. }
  505. if (hdr->bLength < sizeof(*wa->wa_descr)) {
  506. dev_err(dev, "short Wire Adapter Class descriptor\n");
  507. goto error;
  508. }
  509. wa->wa_descr = wa_descr = (struct usb_wa_descriptor *) hdr;
  510. /* Make LE fields CPU order */
  511. wa_descr->bcdWAVersion = le16_to_cpu(wa_descr->bcdWAVersion);
  512. wa_descr->wNumRPipes = le16_to_cpu(wa_descr->wNumRPipes);
  513. wa_descr->wRPipeMaxBlock = le16_to_cpu(wa_descr->wRPipeMaxBlock);
  514. if (wa_descr->bcdWAVersion > 0x0100)
  515. dev_warn(dev, "Wire Adapter v%d.%d newer than groked v1.0\n",
  516. wa_descr->bcdWAVersion & 0xff00 >> 8,
  517. wa_descr->bcdWAVersion & 0x00ff);
  518. result = 0;
  519. error:
  520. return result;
  521. }
  522. static struct hc_driver hwahc_hc_driver = {
  523. .description = "hwa-hcd",
  524. .product_desc = "Wireless USB HWA host controller",
  525. .hcd_priv_size = sizeof(struct hwahc) - sizeof(struct usb_hcd),
  526. .irq = NULL, /* FIXME */
  527. .flags = HCD_USB2, /* FIXME */
  528. .reset = hwahc_op_reset,
  529. .start = hwahc_op_start,
  530. .stop = hwahc_op_stop,
  531. .get_frame_number = hwahc_op_get_frame_number,
  532. .urb_enqueue = hwahc_op_urb_enqueue,
  533. .urb_dequeue = hwahc_op_urb_dequeue,
  534. .endpoint_disable = hwahc_op_endpoint_disable,
  535. .hub_status_data = wusbhc_rh_status_data,
  536. .hub_control = wusbhc_rh_control,
  537. .bus_suspend = wusbhc_rh_suspend,
  538. .bus_resume = wusbhc_rh_resume,
  539. .start_port_reset = wusbhc_rh_start_port_reset,
  540. };
  541. static int hwahc_security_create(struct hwahc *hwahc)
  542. {
  543. int result;
  544. struct wusbhc *wusbhc = &hwahc->wusbhc;
  545. struct usb_device *usb_dev = hwahc->wa.usb_dev;
  546. struct device *dev = &usb_dev->dev;
  547. struct usb_security_descriptor *secd;
  548. struct usb_encryption_descriptor *etd;
  549. void *itr, *top;
  550. size_t itr_size, needed, bytes;
  551. u8 index;
  552. char buf[64];
  553. /* Find the host's security descriptors in the config descr bundle */
  554. index = (usb_dev->actconfig - usb_dev->config) /
  555. sizeof(usb_dev->config[0]);
  556. itr = usb_dev->rawdescriptors[index];
  557. itr_size = le16_to_cpu(usb_dev->actconfig->desc.wTotalLength);
  558. top = itr + itr_size;
  559. result = __usb_get_extra_descriptor(usb_dev->rawdescriptors[index],
  560. le16_to_cpu(usb_dev->actconfig->desc.wTotalLength),
  561. USB_DT_SECURITY, (void **) &secd);
  562. if (result == -1) {
  563. dev_warn(dev, "BUG? WUSB host has no security descriptors\n");
  564. return 0;
  565. }
  566. needed = sizeof(*secd);
  567. if (top - (void *)secd < needed) {
  568. dev_err(dev, "BUG? Not enough data to process security "
  569. "descriptor header (%zu bytes left vs %zu needed)\n",
  570. top - (void *) secd, needed);
  571. return 0;
  572. }
  573. needed = le16_to_cpu(secd->wTotalLength);
  574. if (top - (void *)secd < needed) {
  575. dev_err(dev, "BUG? Not enough data to process security "
  576. "descriptors (%zu bytes left vs %zu needed)\n",
  577. top - (void *) secd, needed);
  578. return 0;
  579. }
  580. /* Walk over the sec descriptors and store CCM1's on wusbhc */
  581. itr = (void *) secd + sizeof(*secd);
  582. top = (void *) secd + le16_to_cpu(secd->wTotalLength);
  583. index = 0;
  584. bytes = 0;
  585. while (itr < top) {
  586. etd = itr;
  587. if (top - itr < sizeof(*etd)) {
  588. dev_err(dev, "BUG: bad host security descriptor; "
  589. "not enough data (%zu vs %zu left)\n",
  590. top - itr, sizeof(*etd));
  591. break;
  592. }
  593. if (etd->bLength < sizeof(*etd)) {
  594. dev_err(dev, "BUG: bad host encryption descriptor; "
  595. "descriptor is too short "
  596. "(%zu vs %zu needed)\n",
  597. (size_t)etd->bLength, sizeof(*etd));
  598. break;
  599. }
  600. itr += etd->bLength;
  601. bytes += snprintf(buf + bytes, sizeof(buf) - bytes,
  602. "%s (0x%02x) ",
  603. wusb_et_name(etd->bEncryptionType),
  604. etd->bEncryptionValue);
  605. wusbhc->ccm1_etd = etd;
  606. }
  607. dev_info(dev, "supported encryption types: %s\n", buf);
  608. if (wusbhc->ccm1_etd == NULL) {
  609. dev_err(dev, "E: host doesn't support CCM-1 crypto\n");
  610. return 0;
  611. }
  612. /* Pretty print what we support */
  613. return 0;
  614. }
  615. static void hwahc_security_release(struct hwahc *hwahc)
  616. {
  617. /* nothing to do here so far... */
  618. }
  619. static int hwahc_create(struct hwahc *hwahc, struct usb_interface *iface)
  620. {
  621. int result;
  622. struct device *dev = &iface->dev;
  623. struct wusbhc *wusbhc = &hwahc->wusbhc;
  624. struct wahc *wa = &hwahc->wa;
  625. struct usb_device *usb_dev = interface_to_usbdev(iface);
  626. wa->usb_dev = usb_get_dev(usb_dev); /* bind the USB device */
  627. wa->usb_iface = usb_get_intf(iface);
  628. wusbhc->dev = dev;
  629. wusbhc->uwb_rc = uwb_rc_get_by_grandpa(iface->dev.parent);
  630. if (wusbhc->uwb_rc == NULL) {
  631. result = -ENODEV;
  632. dev_err(dev, "Cannot get associated UWB Host Controller\n");
  633. goto error_rc_get;
  634. }
  635. result = wa_fill_descr(wa); /* Get the device descriptor */
  636. if (result < 0)
  637. goto error_fill_descriptor;
  638. if (wa->wa_descr->bNumPorts > USB_MAXCHILDREN) {
  639. dev_err(dev, "FIXME: USB_MAXCHILDREN too low for WUSB "
  640. "adapter (%u ports)\n", wa->wa_descr->bNumPorts);
  641. wusbhc->ports_max = USB_MAXCHILDREN;
  642. } else {
  643. wusbhc->ports_max = wa->wa_descr->bNumPorts;
  644. }
  645. wusbhc->mmcies_max = wa->wa_descr->bNumMMCIEs;
  646. wusbhc->start = __hwahc_op_wusbhc_start;
  647. wusbhc->stop = __hwahc_op_wusbhc_stop;
  648. wusbhc->mmcie_add = __hwahc_op_mmcie_add;
  649. wusbhc->mmcie_rm = __hwahc_op_mmcie_rm;
  650. wusbhc->dev_info_set = __hwahc_op_dev_info_set;
  651. wusbhc->bwa_set = __hwahc_op_bwa_set;
  652. wusbhc->set_num_dnts = __hwahc_op_set_num_dnts;
  653. wusbhc->set_ptk = __hwahc_op_set_ptk;
  654. wusbhc->set_gtk = __hwahc_op_set_gtk;
  655. result = hwahc_security_create(hwahc);
  656. if (result < 0) {
  657. dev_err(dev, "Can't initialize security: %d\n", result);
  658. goto error_security_create;
  659. }
  660. wa->wusb = wusbhc; /* FIXME: ugly, need to fix */
  661. result = wusbhc_create(&hwahc->wusbhc);
  662. if (result < 0) {
  663. dev_err(dev, "Can't create WUSB HC structures: %d\n", result);
  664. goto error_wusbhc_create;
  665. }
  666. result = wa_create(&hwahc->wa, iface);
  667. if (result < 0)
  668. goto error_wa_create;
  669. return 0;
  670. error_wa_create:
  671. wusbhc_destroy(&hwahc->wusbhc);
  672. error_wusbhc_create:
  673. /* WA Descr fill allocs no resources */
  674. error_security_create:
  675. error_fill_descriptor:
  676. uwb_rc_put(wusbhc->uwb_rc);
  677. error_rc_get:
  678. usb_put_intf(iface);
  679. usb_put_dev(usb_dev);
  680. return result;
  681. }
  682. static void hwahc_destroy(struct hwahc *hwahc)
  683. {
  684. struct wusbhc *wusbhc = &hwahc->wusbhc;
  685. mutex_lock(&wusbhc->mutex);
  686. __wa_destroy(&hwahc->wa);
  687. wusbhc_destroy(&hwahc->wusbhc);
  688. hwahc_security_release(hwahc);
  689. hwahc->wusbhc.dev = NULL;
  690. uwb_rc_put(wusbhc->uwb_rc);
  691. usb_put_intf(hwahc->wa.usb_iface);
  692. usb_put_dev(hwahc->wa.usb_dev);
  693. mutex_unlock(&wusbhc->mutex);
  694. }
  695. static void hwahc_init(struct hwahc *hwahc)
  696. {
  697. wa_init(&hwahc->wa);
  698. }
  699. static int hwahc_probe(struct usb_interface *usb_iface,
  700. const struct usb_device_id *id)
  701. {
  702. int result;
  703. struct usb_hcd *usb_hcd;
  704. struct wusbhc *wusbhc;
  705. struct hwahc *hwahc;
  706. struct device *dev = &usb_iface->dev;
  707. result = -ENOMEM;
  708. usb_hcd = usb_create_hcd(&hwahc_hc_driver, &usb_iface->dev, "wusb-hwa");
  709. if (usb_hcd == NULL) {
  710. dev_err(dev, "unable to allocate instance\n");
  711. goto error_alloc;
  712. }
  713. usb_hcd->wireless = 1;
  714. usb_hcd->flags |= HCD_FLAG_SAW_IRQ;
  715. wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  716. hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  717. hwahc_init(hwahc);
  718. result = hwahc_create(hwahc, usb_iface);
  719. if (result < 0) {
  720. dev_err(dev, "Cannot initialize internals: %d\n", result);
  721. goto error_hwahc_create;
  722. }
  723. result = usb_add_hcd(usb_hcd, 0, 0);
  724. if (result < 0) {
  725. dev_err(dev, "Cannot add HCD: %d\n", result);
  726. goto error_add_hcd;
  727. }
  728. result = wusbhc_b_create(&hwahc->wusbhc);
  729. if (result < 0) {
  730. dev_err(dev, "Cannot setup phase B of WUSBHC: %d\n", result);
  731. goto error_wusbhc_b_create;
  732. }
  733. return 0;
  734. error_wusbhc_b_create:
  735. usb_remove_hcd(usb_hcd);
  736. error_add_hcd:
  737. hwahc_destroy(hwahc);
  738. error_hwahc_create:
  739. usb_put_hcd(usb_hcd);
  740. error_alloc:
  741. return result;
  742. }
  743. static void hwahc_disconnect(struct usb_interface *usb_iface)
  744. {
  745. struct usb_hcd *usb_hcd;
  746. struct wusbhc *wusbhc;
  747. struct hwahc *hwahc;
  748. usb_hcd = usb_get_intfdata(usb_iface);
  749. wusbhc = usb_hcd_to_wusbhc(usb_hcd);
  750. hwahc = container_of(wusbhc, struct hwahc, wusbhc);
  751. wusbhc_b_destroy(&hwahc->wusbhc);
  752. usb_remove_hcd(usb_hcd);
  753. hwahc_destroy(hwahc);
  754. usb_put_hcd(usb_hcd);
  755. }
  756. static struct usb_device_id hwahc_id_table[] = {
  757. /* FIXME: use class labels for this */
  758. { USB_INTERFACE_INFO(0xe0, 0x02, 0x01), },
  759. {},
  760. };
  761. MODULE_DEVICE_TABLE(usb, hwahc_id_table);
  762. static struct usb_driver hwahc_driver = {
  763. .name = "hwa-hc",
  764. .probe = hwahc_probe,
  765. .disconnect = hwahc_disconnect,
  766. .id_table = hwahc_id_table,
  767. };
  768. static int __init hwahc_driver_init(void)
  769. {
  770. return usb_register(&hwahc_driver);
  771. }
  772. module_init(hwahc_driver_init);
  773. static void __exit hwahc_driver_exit(void)
  774. {
  775. usb_deregister(&hwahc_driver);
  776. }
  777. module_exit(hwahc_driver_exit);
  778. MODULE_AUTHOR("Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>");
  779. MODULE_DESCRIPTION("Host Wired Adapter USB Host Control Driver");
  780. MODULE_LICENSE("GPL");