usb.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  1. /*
  2. * Intel Wireless WiMAX Connection 2400m
  3. * Linux driver model glue for USB device, reset & fw upload
  4. *
  5. *
  6. * Copyright (C) 2007-2008 Intel Corporation <linux-wimax@intel.com>
  7. * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
  8. * Yanir Lubetkin <yanirx.lubetkin@intel.com>
  9. *
  10. * This program is free software; you can redistribute it and/or
  11. * modify it under the terms of the GNU General Public License version
  12. * 2 as published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License
  20. * along with this program; if not, write to the Free Software
  21. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22. * 02110-1301, USA.
  23. *
  24. *
  25. * See i2400m-usb.h for a general description of this driver.
  26. *
  27. * This file implements driver model glue, and hook ups for the
  28. * generic driver to implement the bus-specific functions (device
  29. * communication setup/tear down, firmware upload and resetting).
  30. *
  31. * ROADMAP
  32. *
  33. * i2400mu_probe()
  34. * alloc_netdev()...
  35. * i2400mu_netdev_setup()
  36. * i2400mu_init()
  37. * i2400m_netdev_setup()
  38. * i2400m_setup()...
  39. *
  40. * i2400mu_disconnect
  41. * i2400m_release()
  42. * free_netdev()
  43. *
  44. * i2400mu_suspend()
  45. * i2400m_cmd_enter_powersave()
  46. * i2400mu_notification_release()
  47. *
  48. * i2400mu_resume()
  49. * i2400mu_notification_setup()
  50. *
  51. * i2400mu_bus_dev_start() Called by i2400m_dev_start() [who is
  52. * i2400mu_tx_setup() called by i2400m_setup()]
  53. * i2400mu_rx_setup()
  54. * i2400mu_notification_setup()
  55. *
  56. * i2400mu_bus_dev_stop() Called by i2400m_dev_stop() [who is
  57. * i2400mu_notification_release() called by i2400m_release()]
  58. * i2400mu_rx_release()
  59. * i2400mu_tx_release()
  60. *
  61. * i2400mu_bus_reset() Called by i2400m_reset
  62. * __i2400mu_reset()
  63. * __i2400mu_send_barker()
  64. * usb_reset_device()
  65. */
  66. #include "i2400m-usb.h"
  67. #include <linux/wimax/i2400m.h>
  68. #include <linux/debugfs.h>
  69. #define D_SUBMODULE usb
  70. #include "usb-debug-levels.h"
  71. static char i2400mu_debug_params[128];
  72. module_param_string(debug, i2400mu_debug_params, sizeof(i2400mu_debug_params),
  73. 0644);
  74. MODULE_PARM_DESC(debug,
  75. "String of space-separated NAME:VALUE pairs, where NAMEs "
  76. "are the different debug submodules and VALUE are the "
  77. "initial debug value to set.");
  78. /* Our firmware file name */
  79. static const char *i2400mu_bus_fw_names_5x50[] = {
  80. #define I2400MU_FW_FILE_NAME_v1_4 "i2400m-fw-usb-1.4.sbcf"
  81. I2400MU_FW_FILE_NAME_v1_4,
  82. NULL,
  83. };
  84. static const char *i2400mu_bus_fw_names_6050[] = {
  85. #define I6050U_FW_FILE_NAME_v1_5 "i6050-fw-usb-1.5.sbcf"
  86. I6050U_FW_FILE_NAME_v1_5,
  87. NULL,
  88. };
  89. static
  90. int i2400mu_bus_dev_start(struct i2400m *i2400m)
  91. {
  92. int result;
  93. struct i2400mu *i2400mu = container_of(i2400m, struct i2400mu, i2400m);
  94. struct device *dev = &i2400mu->usb_iface->dev;
  95. d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
  96. result = i2400mu_tx_setup(i2400mu);
  97. if (result < 0)
  98. goto error_usb_tx_setup;
  99. result = i2400mu_rx_setup(i2400mu);
  100. if (result < 0)
  101. goto error_usb_rx_setup;
  102. result = i2400mu_notification_setup(i2400mu);
  103. if (result < 0)
  104. goto error_notif_setup;
  105. d_fnend(3, dev, "(i2400m %p) = %d\n", i2400m, result);
  106. return result;
  107. error_notif_setup:
  108. i2400mu_rx_release(i2400mu);
  109. error_usb_rx_setup:
  110. i2400mu_tx_release(i2400mu);
  111. error_usb_tx_setup:
  112. d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
  113. return result;
  114. }
  115. static
  116. void i2400mu_bus_dev_stop(struct i2400m *i2400m)
  117. {
  118. struct i2400mu *i2400mu = container_of(i2400m, struct i2400mu, i2400m);
  119. struct device *dev = &i2400mu->usb_iface->dev;
  120. d_fnstart(3, dev, "(i2400m %p)\n", i2400m);
  121. i2400mu_notification_release(i2400mu);
  122. i2400mu_rx_release(i2400mu);
  123. i2400mu_tx_release(i2400mu);
  124. d_fnend(3, dev, "(i2400m %p) = void\n", i2400m);
  125. }
  126. /*
  127. * Sends a barker buffer to the device
  128. *
  129. * This helper will allocate a kmalloced buffer and use it to transmit
  130. * (then free it). Reason for this is that other arches cannot use
  131. * stack/vmalloc/text areas for DMA transfers.
  132. *
  133. * Error recovery here is simpler: anything is considered a hard error
  134. * and will move the reset code to use a last-resort bus-based reset.
  135. */
  136. static
  137. int __i2400mu_send_barker(struct i2400mu *i2400mu,
  138. const __le32 *barker,
  139. size_t barker_size,
  140. unsigned endpoint)
  141. {
  142. struct usb_endpoint_descriptor *epd = NULL;
  143. int pipe, actual_len, ret;
  144. struct device *dev = &i2400mu->usb_iface->dev;
  145. void *buffer;
  146. int do_autopm = 1;
  147. ret = usb_autopm_get_interface(i2400mu->usb_iface);
  148. if (ret < 0) {
  149. dev_err(dev, "RESET: can't get autopm: %d\n", ret);
  150. do_autopm = 0;
  151. }
  152. ret = -ENOMEM;
  153. buffer = kmalloc(barker_size, GFP_KERNEL);
  154. if (buffer == NULL)
  155. goto error_kzalloc;
  156. epd = usb_get_epd(i2400mu->usb_iface, endpoint);
  157. pipe = usb_sndbulkpipe(i2400mu->usb_dev, epd->bEndpointAddress);
  158. memcpy(buffer, barker, barker_size);
  159. retry:
  160. ret = usb_bulk_msg(i2400mu->usb_dev, pipe, buffer, barker_size,
  161. &actual_len, 200);
  162. switch (ret) {
  163. case 0:
  164. if (actual_len != barker_size) { /* Too short? drop it */
  165. dev_err(dev, "E: %s: short write (%d B vs %zu "
  166. "expected)\n",
  167. __func__, actual_len, barker_size);
  168. ret = -EIO;
  169. }
  170. break;
  171. case -EPIPE:
  172. /*
  173. * Stall -- maybe the device is choking with our
  174. * requests. Clear it and give it some time. If they
  175. * happen to often, it might be another symptom, so we
  176. * reset.
  177. *
  178. * No error handling for usb_clear_halt(0; if it
  179. * works, the retry works; if it fails, this switch
  180. * does the error handling for us.
  181. */
  182. if (edc_inc(&i2400mu->urb_edc,
  183. 10 * EDC_MAX_ERRORS, EDC_ERROR_TIMEFRAME)) {
  184. dev_err(dev, "E: %s: too many stalls in "
  185. "URB; resetting device\n", __func__);
  186. usb_queue_reset_device(i2400mu->usb_iface);
  187. /* fallthrough */
  188. } else {
  189. usb_clear_halt(i2400mu->usb_dev, pipe);
  190. msleep(10); /* give the device some time */
  191. goto retry;
  192. }
  193. case -EINVAL: /* while removing driver */
  194. case -ENODEV: /* dev disconnect ... */
  195. case -ENOENT: /* just ignore it */
  196. case -ESHUTDOWN: /* and exit */
  197. case -ECONNRESET:
  198. ret = -ESHUTDOWN;
  199. break;
  200. default: /* Some error? */
  201. if (edc_inc(&i2400mu->urb_edc,
  202. EDC_MAX_ERRORS, EDC_ERROR_TIMEFRAME)) {
  203. dev_err(dev, "E: %s: maximum errors in URB "
  204. "exceeded; resetting device\n",
  205. __func__);
  206. usb_queue_reset_device(i2400mu->usb_iface);
  207. } else {
  208. dev_warn(dev, "W: %s: cannot send URB: %d\n",
  209. __func__, ret);
  210. goto retry;
  211. }
  212. }
  213. kfree(buffer);
  214. error_kzalloc:
  215. if (do_autopm)
  216. usb_autopm_put_interface(i2400mu->usb_iface);
  217. return ret;
  218. }
  219. /*
  220. * Reset a device at different levels (warm, cold or bus)
  221. *
  222. * @i2400m: device descriptor
  223. * @reset_type: soft, warm or bus reset (I2400M_RT_WARM/SOFT/BUS)
  224. *
  225. * Warm and cold resets get a USB reset if they fail.
  226. *
  227. * Warm reset:
  228. *
  229. * The device will be fully reset internally, but won't be
  230. * disconnected from the USB bus (so no reenumeration will
  231. * happen). Firmware upload will be neccessary.
  232. *
  233. * The device will send a reboot barker in the notification endpoint
  234. * that will trigger the driver to reinitialize the state
  235. * automatically from notif.c:i2400m_notification_grok() into
  236. * i2400m_dev_bootstrap_delayed().
  237. *
  238. * Cold and bus (USB) reset:
  239. *
  240. * The device will be fully reset internally, disconnected from the
  241. * USB bus an a reenumeration will happen. Firmware upload will be
  242. * neccessary. Thus, we don't do any locking or struct
  243. * reinitialization, as we are going to be fully disconnected and
  244. * reenumerated.
  245. *
  246. * Note we need to return -ENODEV if a warm reset was requested and we
  247. * had to resort to a bus reset. See i2400m_op_reset(), wimax_reset()
  248. * and wimax_dev->op_reset.
  249. *
  250. * WARNING: no driver state saved/fixed
  251. */
  252. static
  253. int i2400mu_bus_reset(struct i2400m *i2400m, enum i2400m_reset_type rt)
  254. {
  255. int result;
  256. struct i2400mu *i2400mu =
  257. container_of(i2400m, struct i2400mu, i2400m);
  258. struct device *dev = i2400m_dev(i2400m);
  259. static const __le32 i2400m_WARM_BOOT_BARKER[4] = {
  260. cpu_to_le32(I2400M_WARM_RESET_BARKER),
  261. cpu_to_le32(I2400M_WARM_RESET_BARKER),
  262. cpu_to_le32(I2400M_WARM_RESET_BARKER),
  263. cpu_to_le32(I2400M_WARM_RESET_BARKER),
  264. };
  265. static const __le32 i2400m_COLD_BOOT_BARKER[4] = {
  266. cpu_to_le32(I2400M_COLD_RESET_BARKER),
  267. cpu_to_le32(I2400M_COLD_RESET_BARKER),
  268. cpu_to_le32(I2400M_COLD_RESET_BARKER),
  269. cpu_to_le32(I2400M_COLD_RESET_BARKER),
  270. };
  271. d_fnstart(3, dev, "(i2400m %p rt %u)\n", i2400m, rt);
  272. if (rt == I2400M_RT_WARM)
  273. result = __i2400mu_send_barker(
  274. i2400mu, i2400m_WARM_BOOT_BARKER,
  275. sizeof(i2400m_WARM_BOOT_BARKER),
  276. i2400mu->endpoint_cfg.bulk_out);
  277. else if (rt == I2400M_RT_COLD)
  278. result = __i2400mu_send_barker(
  279. i2400mu, i2400m_COLD_BOOT_BARKER,
  280. sizeof(i2400m_COLD_BOOT_BARKER),
  281. i2400mu->endpoint_cfg.reset_cold);
  282. else if (rt == I2400M_RT_BUS) {
  283. result = usb_reset_device(i2400mu->usb_dev);
  284. switch (result) {
  285. case 0:
  286. case -EINVAL: /* device is gone */
  287. case -ENODEV:
  288. case -ENOENT:
  289. case -ESHUTDOWN:
  290. result = 0;
  291. break; /* We assume the device is disconnected */
  292. default:
  293. dev_err(dev, "USB reset failed (%d), giving up!\n",
  294. result);
  295. }
  296. } else {
  297. result = -EINVAL; /* shut gcc up in certain arches */
  298. BUG();
  299. }
  300. if (result < 0
  301. && result != -EINVAL /* device is gone */
  302. && rt != I2400M_RT_BUS) {
  303. /*
  304. * Things failed -- resort to lower level reset, that
  305. * we queue in another context; the reason for this is
  306. * that the pre and post reset functionality requires
  307. * the i2400m->init_mutex; RT_WARM and RT_COLD can
  308. * come from areas where i2400m->init_mutex is taken.
  309. */
  310. dev_err(dev, "%s reset failed (%d); trying USB reset\n",
  311. rt == I2400M_RT_WARM ? "warm" : "cold", result);
  312. usb_queue_reset_device(i2400mu->usb_iface);
  313. result = -ENODEV;
  314. }
  315. d_fnend(3, dev, "(i2400m %p rt %u) = %d\n", i2400m, rt, result);
  316. return result;
  317. }
  318. static
  319. void i2400mu_netdev_setup(struct net_device *net_dev)
  320. {
  321. struct i2400m *i2400m = net_dev_to_i2400m(net_dev);
  322. struct i2400mu *i2400mu = container_of(i2400m, struct i2400mu, i2400m);
  323. i2400mu_init(i2400mu);
  324. i2400m_netdev_setup(net_dev);
  325. }
  326. /*
  327. * Debug levels control; see debug.h
  328. */
  329. struct d_level D_LEVEL[] = {
  330. D_SUBMODULE_DEFINE(usb),
  331. D_SUBMODULE_DEFINE(fw),
  332. D_SUBMODULE_DEFINE(notif),
  333. D_SUBMODULE_DEFINE(rx),
  334. D_SUBMODULE_DEFINE(tx),
  335. };
  336. size_t D_LEVEL_SIZE = ARRAY_SIZE(D_LEVEL);
  337. #define __debugfs_register(prefix, name, parent) \
  338. do { \
  339. result = d_level_register_debugfs(prefix, name, parent); \
  340. if (result < 0) \
  341. goto error; \
  342. } while (0)
  343. static
  344. int i2400mu_debugfs_add(struct i2400mu *i2400mu)
  345. {
  346. int result;
  347. struct device *dev = &i2400mu->usb_iface->dev;
  348. struct dentry *dentry = i2400mu->i2400m.wimax_dev.debugfs_dentry;
  349. struct dentry *fd;
  350. dentry = debugfs_create_dir("i2400m-usb", dentry);
  351. result = PTR_ERR(dentry);
  352. if (IS_ERR(dentry)) {
  353. if (result == -ENODEV)
  354. result = 0; /* No debugfs support */
  355. goto error;
  356. }
  357. i2400mu->debugfs_dentry = dentry;
  358. __debugfs_register("dl_", usb, dentry);
  359. __debugfs_register("dl_", fw, dentry);
  360. __debugfs_register("dl_", notif, dentry);
  361. __debugfs_register("dl_", rx, dentry);
  362. __debugfs_register("dl_", tx, dentry);
  363. /* Don't touch these if you don't know what you are doing */
  364. fd = debugfs_create_u8("rx_size_auto_shrink", 0600, dentry,
  365. &i2400mu->rx_size_auto_shrink);
  366. result = PTR_ERR(fd);
  367. if (IS_ERR(fd) && result != -ENODEV) {
  368. dev_err(dev, "Can't create debugfs entry "
  369. "rx_size_auto_shrink: %d\n", result);
  370. goto error;
  371. }
  372. fd = debugfs_create_size_t("rx_size", 0600, dentry,
  373. &i2400mu->rx_size);
  374. result = PTR_ERR(fd);
  375. if (IS_ERR(fd) && result != -ENODEV) {
  376. dev_err(dev, "Can't create debugfs entry "
  377. "rx_size: %d\n", result);
  378. goto error;
  379. }
  380. return 0;
  381. error:
  382. debugfs_remove_recursive(i2400mu->debugfs_dentry);
  383. return result;
  384. }
  385. static struct device_type i2400mu_type = {
  386. .name = "wimax",
  387. };
  388. /*
  389. * Probe a i2400m interface and register it
  390. *
  391. * @iface: USB interface to link to
  392. * @id: USB class/subclass/protocol id
  393. * @returns: 0 if ok, < 0 errno code on error.
  394. *
  395. * Alloc a net device, initialize the bus-specific details and then
  396. * calls the bus-generic initialization routine. That will register
  397. * the wimax and netdev devices, upload the firmware [using
  398. * _bus_bm_*()], call _bus_dev_start() to finalize the setup of the
  399. * communication with the device and then will start to talk to it to
  400. * finnish setting it up.
  401. */
  402. static
  403. int i2400mu_probe(struct usb_interface *iface,
  404. const struct usb_device_id *id)
  405. {
  406. int result;
  407. struct net_device *net_dev;
  408. struct device *dev = &iface->dev;
  409. struct i2400m *i2400m;
  410. struct i2400mu *i2400mu;
  411. struct usb_device *usb_dev = interface_to_usbdev(iface);
  412. if (usb_dev->speed != USB_SPEED_HIGH)
  413. dev_err(dev, "device not connected as high speed\n");
  414. /* Allocate instance [calls i2400m_netdev_setup() on it]. */
  415. result = -ENOMEM;
  416. net_dev = alloc_netdev(sizeof(*i2400mu), "wmx%d",
  417. i2400mu_netdev_setup);
  418. if (net_dev == NULL) {
  419. dev_err(dev, "no memory for network device instance\n");
  420. goto error_alloc_netdev;
  421. }
  422. SET_NETDEV_DEV(net_dev, dev);
  423. SET_NETDEV_DEVTYPE(net_dev, &i2400mu_type);
  424. i2400m = net_dev_to_i2400m(net_dev);
  425. i2400mu = container_of(i2400m, struct i2400mu, i2400m);
  426. i2400m->wimax_dev.net_dev = net_dev;
  427. i2400mu->usb_dev = usb_get_dev(usb_dev);
  428. i2400mu->usb_iface = iface;
  429. usb_set_intfdata(iface, i2400mu);
  430. i2400m->bus_tx_block_size = I2400MU_BLK_SIZE;
  431. i2400m->bus_pl_size_max = I2400MU_PL_SIZE_MAX;
  432. i2400m->bus_setup = NULL;
  433. i2400m->bus_dev_start = i2400mu_bus_dev_start;
  434. i2400m->bus_dev_stop = i2400mu_bus_dev_stop;
  435. i2400m->bus_release = NULL;
  436. i2400m->bus_tx_kick = i2400mu_bus_tx_kick;
  437. i2400m->bus_reset = i2400mu_bus_reset;
  438. i2400m->bus_bm_retries = I2400M_USB_BOOT_RETRIES;
  439. i2400m->bus_bm_cmd_send = i2400mu_bus_bm_cmd_send;
  440. i2400m->bus_bm_wait_for_ack = i2400mu_bus_bm_wait_for_ack;
  441. i2400m->bus_bm_mac_addr_impaired = 0;
  442. if (id->idProduct == USB_DEVICE_ID_I6050) {
  443. i2400m->bus_fw_names = i2400mu_bus_fw_names_6050;
  444. i2400mu->endpoint_cfg.bulk_out = 0;
  445. i2400mu->endpoint_cfg.notification = 3;
  446. i2400mu->endpoint_cfg.reset_cold = 2;
  447. i2400mu->endpoint_cfg.bulk_in = 1;
  448. } else {
  449. i2400m->bus_fw_names = i2400mu_bus_fw_names_5x50;
  450. i2400mu->endpoint_cfg.bulk_out = 0;
  451. i2400mu->endpoint_cfg.notification = 1;
  452. i2400mu->endpoint_cfg.reset_cold = 2;
  453. i2400mu->endpoint_cfg.bulk_in = 3;
  454. }
  455. #ifdef CONFIG_PM
  456. iface->needs_remote_wakeup = 1; /* autosuspend (15s delay) */
  457. device_init_wakeup(dev, 1);
  458. usb_dev->autosuspend_delay = 15 * HZ;
  459. usb_dev->autosuspend_disabled = 0;
  460. #endif
  461. result = i2400m_setup(i2400m, I2400M_BRI_MAC_REINIT);
  462. if (result < 0) {
  463. dev_err(dev, "cannot setup device: %d\n", result);
  464. goto error_setup;
  465. }
  466. result = i2400mu_debugfs_add(i2400mu);
  467. if (result < 0) {
  468. dev_err(dev, "Can't register i2400mu's debugfs: %d\n", result);
  469. goto error_debugfs_add;
  470. }
  471. return 0;
  472. error_debugfs_add:
  473. i2400m_release(i2400m);
  474. error_setup:
  475. usb_set_intfdata(iface, NULL);
  476. usb_put_dev(i2400mu->usb_dev);
  477. free_netdev(net_dev);
  478. error_alloc_netdev:
  479. return result;
  480. }
  481. /*
  482. * Disconect a i2400m from the system.
  483. *
  484. * i2400m_stop() has been called before, so al the rx and tx contexts
  485. * have been taken down already. Make sure the queue is stopped,
  486. * unregister netdev and i2400m, free and kill.
  487. */
  488. static
  489. void i2400mu_disconnect(struct usb_interface *iface)
  490. {
  491. struct i2400mu *i2400mu = usb_get_intfdata(iface);
  492. struct i2400m *i2400m = &i2400mu->i2400m;
  493. struct net_device *net_dev = i2400m->wimax_dev.net_dev;
  494. struct device *dev = &iface->dev;
  495. d_fnstart(3, dev, "(iface %p i2400m %p)\n", iface, i2400m);
  496. debugfs_remove_recursive(i2400mu->debugfs_dentry);
  497. i2400m_release(i2400m);
  498. usb_set_intfdata(iface, NULL);
  499. usb_put_dev(i2400mu->usb_dev);
  500. free_netdev(net_dev);
  501. d_fnend(3, dev, "(iface %p i2400m %p) = void\n", iface, i2400m);
  502. }
  503. /*
  504. * Get the device ready for USB port or system standby and hibernation
  505. *
  506. * USB port and system standby are handled the same.
  507. *
  508. * When the system hibernates, the USB device is powered down and then
  509. * up, so we don't really have to do much here, as it will be seen as
  510. * a reconnect. Still for simplicity we consider this case the same as
  511. * suspend, so that the device has a chance to do notify the base
  512. * station (if connected).
  513. *
  514. * So at the end, the three cases require common handling.
  515. *
  516. * If at the time of this call the device's firmware is not loaded,
  517. * nothing has to be done. Note we can be "loose" about not reading
  518. * i2400m->updown under i2400m->init_mutex. If it happens to change
  519. * inmediately, other parts of the call flow will fail and effectively
  520. * catch it.
  521. *
  522. * If the firmware is loaded, we need to:
  523. *
  524. * - tell the device to go into host interface power save mode, wait
  525. * for it to ack
  526. *
  527. * This is quite more interesting than it is; we need to execute a
  528. * command, but this time, we don't want the code in usb-{tx,rx}.c
  529. * to call the usb_autopm_get/put_interface() barriers as it'd
  530. * deadlock, so we need to decrement i2400mu->do_autopm, that acts
  531. * as a poor man's semaphore. Ugly, but it works.
  532. *
  533. * As well, the device might refuse going to sleep for whichever
  534. * reason. In this case we just fail. For system suspend/hibernate,
  535. * we *can't* fail. We check PM_EVENT_AUTO to see if the
  536. * suspend call comes from the USB stack or from the system and act
  537. * in consequence.
  538. *
  539. * - stop the notification endpoint polling
  540. */
  541. static
  542. int i2400mu_suspend(struct usb_interface *iface, pm_message_t pm_msg)
  543. {
  544. int result = 0;
  545. struct device *dev = &iface->dev;
  546. struct i2400mu *i2400mu = usb_get_intfdata(iface);
  547. unsigned is_autosuspend = 0;
  548. struct i2400m *i2400m = &i2400mu->i2400m;
  549. #ifdef CONFIG_PM
  550. if (pm_msg.event & PM_EVENT_AUTO)
  551. is_autosuspend = 1;
  552. #endif
  553. d_fnstart(3, dev, "(iface %p pm_msg %u)\n", iface, pm_msg.event);
  554. rmb(); /* see i2400m->updown's documentation */
  555. if (i2400m->updown == 0)
  556. goto no_firmware;
  557. if (i2400m->state == I2400M_SS_DATA_PATH_CONNECTED && is_autosuspend) {
  558. /* ugh -- the device is connected and this suspend
  559. * request is an autosuspend one (not a system standby
  560. * / hibernate).
  561. *
  562. * The only way the device can go to standby is if the
  563. * link with the base station is in IDLE mode; that
  564. * were the case, we'd be in status
  565. * I2400M_SS_CONNECTED_IDLE. But we are not.
  566. *
  567. * If we *tell* him to go power save now, it'll reset
  568. * as a precautionary measure, so if this is an
  569. * autosuspend thing, say no and it'll come back
  570. * later, when the link is IDLE
  571. */
  572. result = -EBADF;
  573. d_printf(1, dev, "fw up, link up, not-idle, autosuspend: "
  574. "not entering powersave\n");
  575. goto error_not_now;
  576. }
  577. d_printf(1, dev, "fw up: entering powersave\n");
  578. atomic_dec(&i2400mu->do_autopm);
  579. result = i2400m_cmd_enter_powersave(i2400m);
  580. atomic_inc(&i2400mu->do_autopm);
  581. if (result < 0 && !is_autosuspend) {
  582. /* System suspend, can't fail */
  583. dev_err(dev, "failed to suspend, will reset on resume\n");
  584. result = 0;
  585. }
  586. if (result < 0)
  587. goto error_enter_powersave;
  588. i2400mu_notification_release(i2400mu);
  589. d_printf(1, dev, "powersave requested\n");
  590. error_enter_powersave:
  591. error_not_now:
  592. no_firmware:
  593. d_fnend(3, dev, "(iface %p pm_msg %u) = %d\n",
  594. iface, pm_msg.event, result);
  595. return result;
  596. }
  597. static
  598. int i2400mu_resume(struct usb_interface *iface)
  599. {
  600. int ret = 0;
  601. struct device *dev = &iface->dev;
  602. struct i2400mu *i2400mu = usb_get_intfdata(iface);
  603. struct i2400m *i2400m = &i2400mu->i2400m;
  604. d_fnstart(3, dev, "(iface %p)\n", iface);
  605. rmb(); /* see i2400m->updown's documentation */
  606. if (i2400m->updown == 0) {
  607. d_printf(1, dev, "fw was down, no resume neeed\n");
  608. goto out;
  609. }
  610. d_printf(1, dev, "fw was up, resuming\n");
  611. i2400mu_notification_setup(i2400mu);
  612. /* USB has flow control, so we don't need to give it time to
  613. * come back; otherwise, we'd use something like a get-state
  614. * command... */
  615. out:
  616. d_fnend(3, dev, "(iface %p) = %d\n", iface, ret);
  617. return ret;
  618. }
  619. static
  620. int i2400mu_reset_resume(struct usb_interface *iface)
  621. {
  622. int result;
  623. struct device *dev = &iface->dev;
  624. struct i2400mu *i2400mu = usb_get_intfdata(iface);
  625. struct i2400m *i2400m = &i2400mu->i2400m;
  626. d_fnstart(3, dev, "(iface %p)\n", iface);
  627. result = i2400m_dev_reset_handle(i2400m, "device reset on resume");
  628. d_fnend(3, dev, "(iface %p) = %d\n", iface, result);
  629. return result < 0 ? result : 0;
  630. }
  631. /*
  632. * Another driver or user space is triggering a reset on the device
  633. * which contains the interface passed as an argument. Cease IO and
  634. * save any device state you need to restore.
  635. *
  636. * If you need to allocate memory here, use GFP_NOIO or GFP_ATOMIC, if
  637. * you are in atomic context.
  638. */
  639. static
  640. int i2400mu_pre_reset(struct usb_interface *iface)
  641. {
  642. struct i2400mu *i2400mu = usb_get_intfdata(iface);
  643. return i2400m_pre_reset(&i2400mu->i2400m);
  644. }
  645. /*
  646. * The reset has completed. Restore any saved device state and begin
  647. * using the device again.
  648. *
  649. * If you need to allocate memory here, use GFP_NOIO or GFP_ATOMIC, if
  650. * you are in atomic context.
  651. */
  652. static
  653. int i2400mu_post_reset(struct usb_interface *iface)
  654. {
  655. struct i2400mu *i2400mu = usb_get_intfdata(iface);
  656. return i2400m_post_reset(&i2400mu->i2400m);
  657. }
  658. static
  659. struct usb_device_id i2400mu_id_table[] = {
  660. { USB_DEVICE(0x8086, USB_DEVICE_ID_I6050) },
  661. { USB_DEVICE(0x8086, 0x0181) },
  662. { USB_DEVICE(0x8086, 0x1403) },
  663. { USB_DEVICE(0x8086, 0x1405) },
  664. { USB_DEVICE(0x8086, 0x0180) },
  665. { USB_DEVICE(0x8086, 0x0182) },
  666. { USB_DEVICE(0x8086, 0x1406) },
  667. { USB_DEVICE(0x8086, 0x1403) },
  668. { },
  669. };
  670. MODULE_DEVICE_TABLE(usb, i2400mu_id_table);
  671. static
  672. struct usb_driver i2400mu_driver = {
  673. .name = KBUILD_MODNAME,
  674. .suspend = i2400mu_suspend,
  675. .resume = i2400mu_resume,
  676. .reset_resume = i2400mu_reset_resume,
  677. .probe = i2400mu_probe,
  678. .disconnect = i2400mu_disconnect,
  679. .pre_reset = i2400mu_pre_reset,
  680. .post_reset = i2400mu_post_reset,
  681. .id_table = i2400mu_id_table,
  682. .supports_autosuspend = 1,
  683. };
  684. static
  685. int __init i2400mu_driver_init(void)
  686. {
  687. d_parse_params(D_LEVEL, D_LEVEL_SIZE, i2400mu_debug_params,
  688. "i2400m_usb.debug");
  689. return usb_register(&i2400mu_driver);
  690. }
  691. module_init(i2400mu_driver_init);
  692. static
  693. void __exit i2400mu_driver_exit(void)
  694. {
  695. flush_scheduled_work(); /* for the stuff we schedule from sysfs.c */
  696. usb_deregister(&i2400mu_driver);
  697. }
  698. module_exit(i2400mu_driver_exit);
  699. MODULE_AUTHOR("Intel Corporation <linux-wimax@intel.com>");
  700. MODULE_DESCRIPTION("Driver for USB based Intel Wireless WiMAX Connection 2400M "
  701. "(5x50 & 6050)");
  702. MODULE_LICENSE("GPL");
  703. MODULE_FIRMWARE(I2400MU_FW_FILE_NAME_v1_4);