if_usb.c 26 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063
  1. /**
  2. * This file contains functions used in USB interface module.
  3. */
  4. #include <linux/delay.h>
  5. #include <linux/moduleparam.h>
  6. #include <linux/firmware.h>
  7. #include <linux/netdevice.h>
  8. #include <linux/list.h>
  9. #include <linux/usb.h>
  10. #define DRV_NAME "usb8xxx"
  11. #include "host.h"
  12. #include "decl.h"
  13. #include "defs.h"
  14. #include "dev.h"
  15. #include "if_usb.h"
  16. #include "decl.h"
  17. #define MESSAGE_HEADER_LEN 4
  18. static const char usbdriver_name[] = "usb8xxx";
  19. static u8 *default_fw_name = "usb8388.bin";
  20. static char *libertas_fw_name = NULL;
  21. module_param_named(fw_name, libertas_fw_name, charp, 0644);
  22. /*
  23. * We need to send a RESET command to all USB devices before
  24. * we tear down the USB connection. Otherwise we would not
  25. * be able to re-init device the device if the module gets
  26. * loaded again. This is a list of all initialized USB devices,
  27. * for the reset code see if_usb_reset_device()
  28. */
  29. static LIST_HEAD(usb_devices);
  30. static struct usb_device_id if_usb_table[] = {
  31. /* Enter the device signature inside */
  32. { USB_DEVICE(0x1286, 0x2001) },
  33. { USB_DEVICE(0x05a3, 0x8388) },
  34. {} /* Terminating entry */
  35. };
  36. MODULE_DEVICE_TABLE(usb, if_usb_table);
  37. static void if_usb_receive(struct urb *urb);
  38. static void if_usb_receive_fwload(struct urb *urb);
  39. static int if_usb_prog_firmware(struct usb_card_rec *cardp);
  40. static int if_usb_host_to_card(wlan_private * priv, u8 type, u8 * payload, u16 nb);
  41. static int if_usb_get_int_status(wlan_private * priv, u8 *);
  42. static int if_usb_read_event_cause(wlan_private *);
  43. static int usb_tx_block(struct usb_card_rec *cardp, u8 *payload, u16 nb);
  44. static void if_usb_free(struct usb_card_rec *cardp);
  45. static int if_usb_submit_rx_urb(struct usb_card_rec *cardp);
  46. static int if_usb_reset_device(struct usb_card_rec *cardp);
  47. /**
  48. * @brief call back function to handle the status of the URB
  49. * @param urb pointer to urb structure
  50. * @return N/A
  51. */
  52. static void if_usb_write_bulk_callback(struct urb *urb)
  53. {
  54. struct usb_card_rec *cardp = (struct usb_card_rec *) urb->context;
  55. /* handle the transmission complete validations */
  56. if (urb->status == 0) {
  57. wlan_private *priv = cardp->priv;
  58. /*
  59. lbs_deb_usbd(&urb->dev->dev, "URB status is successfull\n");
  60. lbs_deb_usbd(&urb->dev->dev, "Actual length transmitted %d\n",
  61. urb->actual_length);
  62. */
  63. /* Used for both firmware TX and regular TX. priv isn't
  64. * valid at firmware load time.
  65. */
  66. if (priv) {
  67. wlan_adapter *adapter = priv->adapter;
  68. struct net_device *dev = priv->dev;
  69. priv->dnld_sent = DNLD_RES_RECEIVED;
  70. /* Wake main thread if commands are pending */
  71. if (!adapter->cur_cmd)
  72. wake_up_interruptible(&priv->waitq);
  73. if ((adapter->connect_status == LIBERTAS_CONNECTED)) {
  74. netif_wake_queue(dev);
  75. netif_wake_queue(priv->mesh_dev);
  76. }
  77. }
  78. } else {
  79. /* print the failure status number for debug */
  80. lbs_pr_info("URB in failure status: %d\n", urb->status);
  81. }
  82. return;
  83. }
  84. /**
  85. * @brief free tx/rx urb, skb and rx buffer
  86. * @param cardp pointer usb_card_rec
  87. * @return N/A
  88. */
  89. static void if_usb_free(struct usb_card_rec *cardp)
  90. {
  91. lbs_deb_enter(LBS_DEB_USB);
  92. /* Unlink tx & rx urb */
  93. usb_kill_urb(cardp->tx_urb);
  94. usb_kill_urb(cardp->rx_urb);
  95. usb_free_urb(cardp->tx_urb);
  96. cardp->tx_urb = NULL;
  97. usb_free_urb(cardp->rx_urb);
  98. cardp->rx_urb = NULL;
  99. kfree(cardp->bulk_out_buffer);
  100. cardp->bulk_out_buffer = NULL;
  101. lbs_deb_leave(LBS_DEB_USB);
  102. }
  103. /**
  104. * @brief sets the configuration values
  105. * @param ifnum interface number
  106. * @param id pointer to usb_device_id
  107. * @return 0 on success, error code on failure
  108. */
  109. static int if_usb_probe(struct usb_interface *intf,
  110. const struct usb_device_id *id)
  111. {
  112. struct usb_device *udev;
  113. struct usb_host_interface *iface_desc;
  114. struct usb_endpoint_descriptor *endpoint;
  115. wlan_private *priv;
  116. struct usb_card_rec *cardp;
  117. int i;
  118. udev = interface_to_usbdev(intf);
  119. cardp = kzalloc(sizeof(struct usb_card_rec), GFP_KERNEL);
  120. if (!cardp) {
  121. lbs_pr_err("Out of memory allocating private data.\n");
  122. goto error;
  123. }
  124. cardp->udev = udev;
  125. iface_desc = intf->cur_altsetting;
  126. lbs_deb_usbd(&udev->dev, "bcdUSB = 0x%X bDeviceClass = 0x%X"
  127. " bDeviceSubClass = 0x%X, bDeviceProtocol = 0x%X\n",
  128. le16_to_cpu(udev->descriptor.bcdUSB),
  129. udev->descriptor.bDeviceClass,
  130. udev->descriptor.bDeviceSubClass,
  131. udev->descriptor.bDeviceProtocol);
  132. for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
  133. endpoint = &iface_desc->endpoint[i].desc;
  134. if ((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
  135. && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  136. USB_ENDPOINT_XFER_BULK)) {
  137. /* we found a bulk in endpoint */
  138. lbs_deb_usbd(&udev->dev, "Bulk in size is %d\n",
  139. le16_to_cpu(endpoint->wMaxPacketSize));
  140. if (!(cardp->rx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
  141. lbs_deb_usbd(&udev->dev,
  142. "Rx URB allocation failed\n");
  143. goto dealloc;
  144. }
  145. cardp->rx_urb_recall = 0;
  146. cardp->bulk_in_size =
  147. le16_to_cpu(endpoint->wMaxPacketSize);
  148. cardp->bulk_in_endpointAddr =
  149. (endpoint->
  150. bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
  151. lbs_deb_usbd(&udev->dev, "in_endpoint = %d\n",
  152. endpoint->bEndpointAddress);
  153. }
  154. if (((endpoint->
  155. bEndpointAddress & USB_ENDPOINT_DIR_MASK) ==
  156. USB_DIR_OUT)
  157. && ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  158. USB_ENDPOINT_XFER_BULK)) {
  159. /* We found bulk out endpoint */
  160. if (!(cardp->tx_urb = usb_alloc_urb(0, GFP_KERNEL))) {
  161. lbs_deb_usbd(&udev->dev,
  162. "Tx URB allocation failed\n");
  163. goto dealloc;
  164. }
  165. cardp->bulk_out_size =
  166. le16_to_cpu(endpoint->wMaxPacketSize);
  167. lbs_deb_usbd(&udev->dev,
  168. "Bulk out size is %d\n",
  169. le16_to_cpu(endpoint->wMaxPacketSize));
  170. cardp->bulk_out_endpointAddr =
  171. endpoint->bEndpointAddress;
  172. lbs_deb_usbd(&udev->dev, "out_endpoint = %d\n",
  173. endpoint->bEndpointAddress);
  174. cardp->bulk_out_buffer =
  175. kmalloc(MRVDRV_ETH_TX_PACKET_BUFFER_SIZE,
  176. GFP_KERNEL);
  177. if (!cardp->bulk_out_buffer) {
  178. lbs_deb_usbd(&udev->dev,
  179. "Could not allocate buffer\n");
  180. goto dealloc;
  181. }
  182. }
  183. }
  184. /* Upload firmware */
  185. cardp->rinfo.cardp = cardp;
  186. if (if_usb_prog_firmware(cardp)) {
  187. lbs_deb_usbd(&udev->dev, "FW upload failed");
  188. goto err_prog_firmware;
  189. }
  190. if (!(priv = libertas_add_card(cardp, &udev->dev)))
  191. goto err_prog_firmware;
  192. cardp->priv = priv;
  193. if (libertas_add_mesh(priv, &udev->dev))
  194. goto err_add_mesh;
  195. cardp->eth_dev = priv->dev;
  196. priv->hw_host_to_card = if_usb_host_to_card;
  197. priv->hw_get_int_status = if_usb_get_int_status;
  198. priv->hw_read_event_cause = if_usb_read_event_cause;
  199. priv->boot2_version = udev->descriptor.bcdDevice;
  200. /* Delay 200 ms to waiting for the FW ready */
  201. if_usb_submit_rx_urb(cardp);
  202. msleep_interruptible(200);
  203. priv->adapter->fw_ready = 1;
  204. if (libertas_start_card(priv))
  205. goto err_start_card;
  206. list_add_tail(&cardp->list, &usb_devices);
  207. usb_get_dev(udev);
  208. usb_set_intfdata(intf, cardp);
  209. return 0;
  210. err_start_card:
  211. libertas_remove_mesh(priv);
  212. err_add_mesh:
  213. libertas_remove_card(priv);
  214. err_prog_firmware:
  215. if_usb_reset_device(cardp);
  216. dealloc:
  217. if_usb_free(cardp);
  218. error:
  219. return -ENOMEM;
  220. }
  221. /**
  222. * @brief free resource and cleanup
  223. * @param intf USB interface structure
  224. * @return N/A
  225. */
  226. static void if_usb_disconnect(struct usb_interface *intf)
  227. {
  228. struct usb_card_rec *cardp = usb_get_intfdata(intf);
  229. wlan_private *priv = (wlan_private *) cardp->priv;
  230. lbs_deb_enter(LBS_DEB_MAIN);
  231. /* Update Surprise removed to TRUE */
  232. cardp->surprise_removed = 1;
  233. list_del(&cardp->list);
  234. if (priv) {
  235. wlan_adapter *adapter = priv->adapter;
  236. adapter->surpriseremoved = 1;
  237. libertas_stop_card(priv);
  238. libertas_remove_mesh(priv);
  239. libertas_remove_card(priv);
  240. }
  241. /* Unlink and free urb */
  242. if_usb_free(cardp);
  243. usb_set_intfdata(intf, NULL);
  244. usb_put_dev(interface_to_usbdev(intf));
  245. lbs_deb_leave(LBS_DEB_MAIN);
  246. }
  247. /**
  248. * @brief This function download FW
  249. * @param priv pointer to wlan_private
  250. * @return 0
  251. */
  252. static int if_prog_firmware(struct usb_card_rec *cardp)
  253. {
  254. struct FWData *fwdata;
  255. struct fwheader *fwheader;
  256. u8 *firmware = cardp->fw->data;
  257. fwdata = kmalloc(sizeof(struct FWData), GFP_ATOMIC);
  258. if (!fwdata)
  259. return -1;
  260. fwheader = &fwdata->fwheader;
  261. if (!cardp->CRC_OK) {
  262. cardp->totalbytes = cardp->fwlastblksent;
  263. cardp->fwseqnum = cardp->lastseqnum - 1;
  264. }
  265. /*
  266. lbs_deb_usbd(&cardp->udev->dev, "totalbytes = %d\n",
  267. cardp->totalbytes);
  268. */
  269. memcpy(fwheader, &firmware[cardp->totalbytes],
  270. sizeof(struct fwheader));
  271. cardp->fwlastblksent = cardp->totalbytes;
  272. cardp->totalbytes += sizeof(struct fwheader);
  273. /* lbs_deb_usbd(&cardp->udev->dev,"Copy Data\n"); */
  274. memcpy(fwdata->data, &firmware[cardp->totalbytes],
  275. le32_to_cpu(fwdata->fwheader.datalength));
  276. /*
  277. lbs_deb_usbd(&cardp->udev->dev,
  278. "Data length = %d\n", le32_to_cpu(fwdata->fwheader.datalength));
  279. */
  280. cardp->fwseqnum = cardp->fwseqnum + 1;
  281. fwdata->seqnum = cpu_to_le32(cardp->fwseqnum);
  282. cardp->lastseqnum = cardp->fwseqnum;
  283. cardp->totalbytes += le32_to_cpu(fwdata->fwheader.datalength);
  284. if (fwheader->dnldcmd == cpu_to_le32(FW_HAS_DATA_TO_RECV)) {
  285. /*
  286. lbs_deb_usbd(&cardp->udev->dev, "There are data to follow\n");
  287. lbs_deb_usbd(&cardp->udev->dev,
  288. "seqnum = %d totalbytes = %d\n", cardp->fwseqnum,
  289. cardp->totalbytes);
  290. */
  291. memcpy(cardp->bulk_out_buffer, fwheader, FW_DATA_XMIT_SIZE);
  292. usb_tx_block(cardp, cardp->bulk_out_buffer, FW_DATA_XMIT_SIZE);
  293. } else if (fwdata->fwheader.dnldcmd == cpu_to_le32(FW_HAS_LAST_BLOCK)) {
  294. /*
  295. lbs_deb_usbd(&cardp->udev->dev,
  296. "Host has finished FW downloading\n");
  297. lbs_deb_usbd(&cardp->udev->dev,
  298. "Donwloading FW JUMP BLOCK\n");
  299. */
  300. memcpy(cardp->bulk_out_buffer, fwheader, FW_DATA_XMIT_SIZE);
  301. usb_tx_block(cardp, cardp->bulk_out_buffer, FW_DATA_XMIT_SIZE);
  302. cardp->fwfinalblk = 1;
  303. }
  304. /*
  305. lbs_deb_usbd(&cardp->udev->dev,
  306. "The firmware download is done size is %d\n",
  307. cardp->totalbytes);
  308. */
  309. kfree(fwdata);
  310. return 0;
  311. }
  312. static int if_usb_reset_device(struct usb_card_rec *cardp)
  313. {
  314. int ret;
  315. wlan_private * priv = cardp->priv;
  316. lbs_deb_enter(LBS_DEB_USB);
  317. /* Try a USB port reset first, if that fails send the reset
  318. * command to the firmware.
  319. */
  320. ret = usb_reset_device(cardp->udev);
  321. if (!ret && priv) {
  322. msleep(10);
  323. ret = libertas_reset_device(priv);
  324. msleep(10);
  325. }
  326. lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
  327. return ret;
  328. }
  329. /**
  330. * @brief This function transfer the data to the device.
  331. * @param priv pointer to wlan_private
  332. * @param payload pointer to payload data
  333. * @param nb data length
  334. * @return 0 or -1
  335. */
  336. static int usb_tx_block(struct usb_card_rec *cardp, u8 * payload, u16 nb)
  337. {
  338. int ret = -1;
  339. /* check if device is removed */
  340. if (cardp->surprise_removed) {
  341. lbs_deb_usbd(&cardp->udev->dev, "Device removed\n");
  342. goto tx_ret;
  343. }
  344. usb_fill_bulk_urb(cardp->tx_urb, cardp->udev,
  345. usb_sndbulkpipe(cardp->udev,
  346. cardp->bulk_out_endpointAddr),
  347. payload, nb, if_usb_write_bulk_callback, cardp);
  348. cardp->tx_urb->transfer_flags |= URB_ZERO_PACKET;
  349. if ((ret = usb_submit_urb(cardp->tx_urb, GFP_ATOMIC))) {
  350. /* transfer failed */
  351. lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb failed\n");
  352. ret = -1;
  353. } else {
  354. /* lbs_deb_usbd(&cardp->udev->dev, "usb_submit_urb success\n"); */
  355. ret = 0;
  356. }
  357. tx_ret:
  358. return ret;
  359. }
  360. static int __if_usb_submit_rx_urb(struct usb_card_rec *cardp,
  361. void (*callbackfn)(struct urb *urb))
  362. {
  363. struct sk_buff *skb;
  364. struct read_cb_info *rinfo = &cardp->rinfo;
  365. int ret = -1;
  366. if (!(skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE))) {
  367. lbs_pr_err("No free skb\n");
  368. goto rx_ret;
  369. }
  370. rinfo->skb = skb;
  371. /* Fill the receive configuration URB and initialise the Rx call back */
  372. usb_fill_bulk_urb(cardp->rx_urb, cardp->udev,
  373. usb_rcvbulkpipe(cardp->udev,
  374. cardp->bulk_in_endpointAddr),
  375. (void *) (skb->tail + (size_t) IPFIELD_ALIGN_OFFSET),
  376. MRVDRV_ETH_RX_PACKET_BUFFER_SIZE, callbackfn,
  377. rinfo);
  378. cardp->rx_urb->transfer_flags |= URB_ZERO_PACKET;
  379. /* lbs_deb_usbd(&cardp->udev->dev, "Pointer for rx_urb %p\n", cardp->rx_urb); */
  380. if ((ret = usb_submit_urb(cardp->rx_urb, GFP_ATOMIC))) {
  381. /* handle failure conditions */
  382. lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB failed\n");
  383. ret = -1;
  384. } else {
  385. /* lbs_deb_usbd(&cardp->udev->dev, "Submit Rx URB success\n"); */
  386. ret = 0;
  387. }
  388. rx_ret:
  389. return ret;
  390. }
  391. static int if_usb_submit_rx_urb_fwload(struct usb_card_rec *cardp)
  392. {
  393. return __if_usb_submit_rx_urb(cardp, &if_usb_receive_fwload);
  394. }
  395. static int if_usb_submit_rx_urb(struct usb_card_rec *cardp)
  396. {
  397. return __if_usb_submit_rx_urb(cardp, &if_usb_receive);
  398. }
  399. static void if_usb_receive_fwload(struct urb *urb)
  400. {
  401. struct read_cb_info *rinfo = (struct read_cb_info *)urb->context;
  402. struct sk_buff *skb = rinfo->skb;
  403. struct usb_card_rec *cardp = (struct usb_card_rec *)rinfo->cardp;
  404. struct fwsyncheader *syncfwheader;
  405. struct bootcmdrespStr bootcmdresp;
  406. if (urb->status) {
  407. lbs_deb_usbd(&cardp->udev->dev,
  408. "URB status is failed during fw load\n");
  409. kfree_skb(skb);
  410. return;
  411. }
  412. if (cardp->bootcmdresp == 0) {
  413. memcpy (&bootcmdresp, skb->data + IPFIELD_ALIGN_OFFSET,
  414. sizeof(bootcmdresp));
  415. if (le16_to_cpu(cardp->udev->descriptor.bcdDevice) < 0x3106) {
  416. kfree_skb(skb);
  417. if_usb_submit_rx_urb_fwload(cardp);
  418. cardp->bootcmdresp = 1;
  419. lbs_deb_usbd(&cardp->udev->dev,
  420. "Received valid boot command response\n");
  421. return;
  422. }
  423. if (bootcmdresp.u32magicnumber != cpu_to_le32(BOOT_CMD_MAGIC_NUMBER)) {
  424. lbs_pr_info(
  425. "boot cmd response wrong magic number (0x%x)\n",
  426. le32_to_cpu(bootcmdresp.u32magicnumber));
  427. } else if (bootcmdresp.u8cmd_tag != BOOT_CMD_FW_BY_USB) {
  428. lbs_pr_info(
  429. "boot cmd response cmd_tag error (%d)\n",
  430. bootcmdresp.u8cmd_tag);
  431. } else if (bootcmdresp.u8result != BOOT_CMD_RESP_OK) {
  432. lbs_pr_info(
  433. "boot cmd response result error (%d)\n",
  434. bootcmdresp.u8result);
  435. } else {
  436. cardp->bootcmdresp = 1;
  437. lbs_deb_usbd(&cardp->udev->dev,
  438. "Received valid boot command response\n");
  439. }
  440. kfree_skb(skb);
  441. if_usb_submit_rx_urb_fwload(cardp);
  442. return;
  443. }
  444. syncfwheader = kmalloc(sizeof(struct fwsyncheader), GFP_ATOMIC);
  445. if (!syncfwheader) {
  446. lbs_deb_usbd(&cardp->udev->dev, "Failure to allocate syncfwheader\n");
  447. kfree_skb(skb);
  448. return;
  449. }
  450. memcpy(syncfwheader, skb->data + IPFIELD_ALIGN_OFFSET,
  451. sizeof(struct fwsyncheader));
  452. if (!syncfwheader->cmd) {
  453. /*
  454. lbs_deb_usbd(&cardp->udev->dev,
  455. "FW received Blk with correct CRC\n");
  456. lbs_deb_usbd(&cardp->udev->dev,
  457. "FW received Blk seqnum = %d\n",
  458. syncfwheader->seqnum);
  459. */
  460. cardp->CRC_OK = 1;
  461. } else {
  462. lbs_deb_usbd(&cardp->udev->dev,
  463. "FW received Blk with CRC error\n");
  464. cardp->CRC_OK = 0;
  465. }
  466. kfree_skb(skb);
  467. if (cardp->fwfinalblk) {
  468. cardp->fwdnldover = 1;
  469. goto exit;
  470. }
  471. if_prog_firmware(cardp);
  472. if_usb_submit_rx_urb_fwload(cardp);
  473. exit:
  474. kfree(syncfwheader);
  475. return;
  476. }
  477. #define MRVDRV_MIN_PKT_LEN 30
  478. static inline void process_cmdtypedata(int recvlength, struct sk_buff *skb,
  479. struct usb_card_rec *cardp,
  480. wlan_private *priv)
  481. {
  482. if (recvlength > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE +
  483. MESSAGE_HEADER_LEN || recvlength < MRVDRV_MIN_PKT_LEN) {
  484. lbs_deb_usbd(&cardp->udev->dev,
  485. "Packet length is Invalid\n");
  486. kfree_skb(skb);
  487. return;
  488. }
  489. skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
  490. skb_put(skb, recvlength);
  491. skb_pull(skb, MESSAGE_HEADER_LEN);
  492. libertas_process_rxed_packet(priv, skb);
  493. priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
  494. }
  495. static inline void process_cmdrequest(int recvlength, u8 *recvbuff,
  496. struct sk_buff *skb,
  497. struct usb_card_rec *cardp,
  498. wlan_private *priv)
  499. {
  500. u8 *cmdbuf;
  501. if (recvlength > MRVDRV_SIZE_OF_CMD_BUFFER) {
  502. lbs_deb_usbd(&cardp->udev->dev,
  503. "The receive buffer is too large\n");
  504. kfree_skb(skb);
  505. return;
  506. }
  507. if (!in_interrupt())
  508. BUG();
  509. spin_lock(&priv->adapter->driver_lock);
  510. /* take care of cur_cmd = NULL case by reading the
  511. * data to clear the interrupt */
  512. if (!priv->adapter->cur_cmd) {
  513. cmdbuf = priv->upld_buf;
  514. priv->adapter->hisregcpy &= ~MRVDRV_CMD_UPLD_RDY;
  515. } else
  516. cmdbuf = priv->adapter->cur_cmd->bufvirtualaddr;
  517. cardp->usb_int_cause |= MRVDRV_CMD_UPLD_RDY;
  518. priv->upld_len = (recvlength - MESSAGE_HEADER_LEN);
  519. memcpy(cmdbuf, recvbuff + MESSAGE_HEADER_LEN,
  520. priv->upld_len);
  521. kfree_skb(skb);
  522. libertas_interrupt(priv->dev);
  523. spin_unlock(&priv->adapter->driver_lock);
  524. lbs_deb_usbd(&cardp->udev->dev,
  525. "Wake up main thread to handle cmd response\n");
  526. return;
  527. }
  528. /**
  529. * @brief This function reads of the packet into the upload buff,
  530. * wake up the main thread and initialise the Rx callack.
  531. *
  532. * @param urb pointer to struct urb
  533. * @return N/A
  534. */
  535. static void if_usb_receive(struct urb *urb)
  536. {
  537. struct read_cb_info *rinfo = (struct read_cb_info *)urb->context;
  538. struct sk_buff *skb = rinfo->skb;
  539. struct usb_card_rec *cardp = (struct usb_card_rec *) rinfo->cardp;
  540. wlan_private * priv = cardp->priv;
  541. int recvlength = urb->actual_length;
  542. u8 *recvbuff = NULL;
  543. u32 recvtype = 0;
  544. lbs_deb_enter(LBS_DEB_USB);
  545. if (recvlength) {
  546. __le32 tmp;
  547. if (urb->status) {
  548. lbs_deb_usbd(&cardp->udev->dev,
  549. "URB status is failed\n");
  550. kfree_skb(skb);
  551. goto setup_for_next;
  552. }
  553. recvbuff = skb->data + IPFIELD_ALIGN_OFFSET;
  554. memcpy(&tmp, recvbuff, sizeof(u32));
  555. recvtype = le32_to_cpu(tmp);
  556. lbs_deb_usbd(&cardp->udev->dev,
  557. "Recv length = 0x%x, Recv type = 0x%X\n",
  558. recvlength, recvtype);
  559. } else if (urb->status)
  560. goto rx_exit;
  561. switch (recvtype) {
  562. case CMD_TYPE_DATA:
  563. process_cmdtypedata(recvlength, skb, cardp, priv);
  564. break;
  565. case CMD_TYPE_REQUEST:
  566. process_cmdrequest(recvlength, recvbuff, skb, cardp, priv);
  567. break;
  568. case CMD_TYPE_INDICATION:
  569. /* Event cause handling */
  570. spin_lock(&priv->adapter->driver_lock);
  571. cardp->usb_event_cause = le32_to_cpu(*(__le32 *) (recvbuff + MESSAGE_HEADER_LEN));
  572. lbs_deb_usbd(&cardp->udev->dev,"**EVENT** 0x%X\n",
  573. cardp->usb_event_cause);
  574. if (cardp->usb_event_cause & 0xffff0000) {
  575. libertas_send_tx_feedback(priv);
  576. spin_unlock(&priv->adapter->driver_lock);
  577. break;
  578. }
  579. cardp->usb_event_cause <<= 3;
  580. cardp->usb_int_cause |= MRVDRV_CARDEVENT;
  581. kfree_skb(skb);
  582. libertas_interrupt(priv->dev);
  583. spin_unlock(&priv->adapter->driver_lock);
  584. goto rx_exit;
  585. default:
  586. lbs_deb_usbd(&cardp->udev->dev, "Unknown command type 0x%X\n",
  587. recvtype);
  588. kfree_skb(skb);
  589. break;
  590. }
  591. setup_for_next:
  592. if_usb_submit_rx_urb(cardp);
  593. rx_exit:
  594. lbs_deb_leave(LBS_DEB_USB);
  595. }
  596. /**
  597. * @brief This function downloads data to FW
  598. * @param priv pointer to wlan_private structure
  599. * @param type type of data
  600. * @param buf pointer to data buffer
  601. * @param len number of bytes
  602. * @return 0 or -1
  603. */
  604. static int if_usb_host_to_card(wlan_private * priv, u8 type, u8 * payload, u16 nb)
  605. {
  606. struct usb_card_rec *cardp = (struct usb_card_rec *)priv->card;
  607. lbs_deb_usbd(&cardp->udev->dev,"*** type = %u\n", type);
  608. lbs_deb_usbd(&cardp->udev->dev,"size after = %d\n", nb);
  609. if (type == MVMS_CMD) {
  610. __le32 tmp = cpu_to_le32(CMD_TYPE_REQUEST);
  611. priv->dnld_sent = DNLD_CMD_SENT;
  612. memcpy(cardp->bulk_out_buffer, (u8 *) & tmp,
  613. MESSAGE_HEADER_LEN);
  614. } else {
  615. __le32 tmp = cpu_to_le32(CMD_TYPE_DATA);
  616. priv->dnld_sent = DNLD_DATA_SENT;
  617. memcpy(cardp->bulk_out_buffer, (u8 *) & tmp,
  618. MESSAGE_HEADER_LEN);
  619. }
  620. memcpy((cardp->bulk_out_buffer + MESSAGE_HEADER_LEN), payload, nb);
  621. return usb_tx_block(cardp, cardp->bulk_out_buffer,
  622. nb + MESSAGE_HEADER_LEN);
  623. }
  624. /* called with adapter->driver_lock held */
  625. static int if_usb_get_int_status(wlan_private * priv, u8 * ireg)
  626. {
  627. struct usb_card_rec *cardp = priv->card;
  628. *ireg = cardp->usb_int_cause;
  629. cardp->usb_int_cause = 0;
  630. lbs_deb_usbd(&cardp->udev->dev,"Int cause is 0x%X\n", *ireg);
  631. return 0;
  632. }
  633. static int if_usb_read_event_cause(wlan_private * priv)
  634. {
  635. struct usb_card_rec *cardp = priv->card;
  636. priv->adapter->eventcause = cardp->usb_event_cause;
  637. /* Re-submit rx urb here to avoid event lost issue */
  638. if_usb_submit_rx_urb(cardp);
  639. return 0;
  640. }
  641. /**
  642. * @brief This function issues Boot command to the Boot2 code
  643. * @param ivalue 1:Boot from FW by USB-Download
  644. * 2:Boot from FW in EEPROM
  645. * @return 0
  646. */
  647. static int if_usb_issue_boot_command(struct usb_card_rec *cardp, int ivalue)
  648. {
  649. struct bootcmdstr sbootcmd;
  650. int i;
  651. /* Prepare command */
  652. sbootcmd.u32magicnumber = cpu_to_le32(BOOT_CMD_MAGIC_NUMBER);
  653. sbootcmd.u8cmd_tag = ivalue;
  654. for (i=0; i<11; i++)
  655. sbootcmd.au8dumy[i]=0x00;
  656. memcpy(cardp->bulk_out_buffer, &sbootcmd, sizeof(struct bootcmdstr));
  657. /* Issue command */
  658. usb_tx_block(cardp, cardp->bulk_out_buffer, sizeof(struct bootcmdstr));
  659. return 0;
  660. }
  661. /**
  662. * @brief This function checks the validity of Boot2/FW image.
  663. *
  664. * @param data pointer to image
  665. * len image length
  666. * @return 0 or -1
  667. */
  668. static int check_fwfile_format(u8 *data, u32 totlen)
  669. {
  670. u32 bincmd, exit;
  671. u32 blksize, offset, len;
  672. int ret;
  673. ret = 1;
  674. exit = len = 0;
  675. do {
  676. struct fwheader *fwh = (void *)data;
  677. bincmd = le32_to_cpu(fwh->dnldcmd);
  678. blksize = le32_to_cpu(fwh->datalength);
  679. switch (bincmd) {
  680. case FW_HAS_DATA_TO_RECV:
  681. offset = sizeof(struct fwheader) + blksize;
  682. data += offset;
  683. len += offset;
  684. if (len >= totlen)
  685. exit = 1;
  686. break;
  687. case FW_HAS_LAST_BLOCK:
  688. exit = 1;
  689. ret = 0;
  690. break;
  691. default:
  692. exit = 1;
  693. break;
  694. }
  695. } while (!exit);
  696. if (ret)
  697. lbs_pr_err("firmware file format check FAIL\n");
  698. else
  699. lbs_deb_fw("firmware file format check PASS\n");
  700. return ret;
  701. }
  702. static int if_usb_prog_firmware(struct usb_card_rec *cardp)
  703. {
  704. int i = 0;
  705. static int reset_count = 10;
  706. int ret = 0;
  707. lbs_deb_enter(LBS_DEB_USB);
  708. if ((ret = request_firmware(&cardp->fw, libertas_fw_name,
  709. &cardp->udev->dev)) < 0) {
  710. lbs_pr_err("request_firmware() failed with %#x\n", ret);
  711. lbs_pr_err("firmware %s not found\n", libertas_fw_name);
  712. goto done;
  713. }
  714. if (check_fwfile_format(cardp->fw->data, cardp->fw->size))
  715. goto release_fw;
  716. restart:
  717. if (if_usb_submit_rx_urb_fwload(cardp) < 0) {
  718. lbs_deb_usbd(&cardp->udev->dev, "URB submission is failed\n");
  719. ret = -1;
  720. goto release_fw;
  721. }
  722. cardp->bootcmdresp = 0;
  723. do {
  724. int j = 0;
  725. i++;
  726. /* Issue Boot command = 1, Boot from Download-FW */
  727. if_usb_issue_boot_command(cardp, BOOT_CMD_FW_BY_USB);
  728. /* wait for command response */
  729. do {
  730. j++;
  731. msleep_interruptible(100);
  732. } while (cardp->bootcmdresp == 0 && j < 10);
  733. } while (cardp->bootcmdresp == 0 && i < 5);
  734. if (cardp->bootcmdresp == 0) {
  735. if (--reset_count >= 0) {
  736. if_usb_reset_device(cardp);
  737. goto restart;
  738. }
  739. return -1;
  740. }
  741. i = 0;
  742. cardp->totalbytes = 0;
  743. cardp->fwlastblksent = 0;
  744. cardp->CRC_OK = 1;
  745. cardp->fwdnldover = 0;
  746. cardp->fwseqnum = -1;
  747. cardp->totalbytes = 0;
  748. cardp->fwfinalblk = 0;
  749. if_prog_firmware(cardp);
  750. do {
  751. lbs_deb_usbd(&cardp->udev->dev,"Wlan sched timeout\n");
  752. i++;
  753. msleep_interruptible(100);
  754. if (cardp->surprise_removed || i >= 20)
  755. break;
  756. } while (!cardp->fwdnldover);
  757. if (!cardp->fwdnldover) {
  758. lbs_pr_info("failed to load fw, resetting device!\n");
  759. if (--reset_count >= 0) {
  760. if_usb_reset_device(cardp);
  761. goto restart;
  762. }
  763. lbs_pr_info("FW download failure, time = %d ms\n", i * 100);
  764. ret = -1;
  765. goto release_fw;
  766. }
  767. release_fw:
  768. release_firmware(cardp->fw);
  769. cardp->fw = NULL;
  770. done:
  771. lbs_deb_leave_args(LBS_DEB_USB, "ret %d", ret);
  772. return ret;
  773. }
  774. #ifdef CONFIG_PM
  775. static int if_usb_suspend(struct usb_interface *intf, pm_message_t message)
  776. {
  777. struct usb_card_rec *cardp = usb_get_intfdata(intf);
  778. wlan_private *priv = cardp->priv;
  779. lbs_deb_enter(LBS_DEB_USB);
  780. if (priv->adapter->psstate != PS_STATE_FULL_POWER)
  781. return -1;
  782. if (priv->mesh_dev && !priv->mesh_autostart_enabled) {
  783. /* Mesh autostart must be activated while sleeping
  784. * On resume it will go back to the current state
  785. */
  786. struct cmd_ds_mesh_access mesh_access;
  787. memset(&mesh_access, 0, sizeof(mesh_access));
  788. mesh_access.data[0] = cpu_to_le32(1);
  789. libertas_prepare_and_send_command(priv,
  790. CMD_MESH_ACCESS,
  791. CMD_ACT_MESH_SET_AUTOSTART_ENABLED,
  792. CMD_OPTION_WAITFORRSP, 0, (void *)&mesh_access);
  793. }
  794. netif_device_detach(cardp->eth_dev);
  795. netif_device_detach(priv->mesh_dev);
  796. /* Unlink tx & rx urb */
  797. usb_kill_urb(cardp->tx_urb);
  798. usb_kill_urb(cardp->rx_urb);
  799. cardp->rx_urb_recall = 1;
  800. lbs_deb_leave(LBS_DEB_USB);
  801. return 0;
  802. }
  803. static int if_usb_resume(struct usb_interface *intf)
  804. {
  805. struct usb_card_rec *cardp = usb_get_intfdata(intf);
  806. wlan_private *priv = cardp->priv;
  807. lbs_deb_enter(LBS_DEB_USB);
  808. cardp->rx_urb_recall = 0;
  809. if_usb_submit_rx_urb(cardp->priv);
  810. netif_device_attach(cardp->eth_dev);
  811. netif_device_attach(priv->mesh_dev);
  812. if (priv->mesh_dev && !priv->mesh_autostart_enabled) {
  813. /* Mesh autostart was activated while sleeping
  814. * Disable it if appropriate
  815. */
  816. struct cmd_ds_mesh_access mesh_access;
  817. memset(&mesh_access, 0, sizeof(mesh_access));
  818. mesh_access.data[0] = cpu_to_le32(0);
  819. libertas_prepare_and_send_command(priv,
  820. CMD_MESH_ACCESS,
  821. CMD_ACT_MESH_SET_AUTOSTART_ENABLED,
  822. CMD_OPTION_WAITFORRSP, 0, (void *)&mesh_access);
  823. }
  824. lbs_deb_leave(LBS_DEB_USB);
  825. return 0;
  826. }
  827. #else
  828. #define if_usb_suspend NULL
  829. #define if_usb_resume NULL
  830. #endif
  831. static struct usb_driver if_usb_driver = {
  832. /* driver name */
  833. .name = usbdriver_name,
  834. /* probe function name */
  835. .probe = if_usb_probe,
  836. /* disconnect function name */
  837. .disconnect = if_usb_disconnect,
  838. /* device signature table */
  839. .id_table = if_usb_table,
  840. .suspend = if_usb_suspend,
  841. .resume = if_usb_resume,
  842. };
  843. static int if_usb_init_module(void)
  844. {
  845. int ret = 0;
  846. lbs_deb_enter(LBS_DEB_MAIN);
  847. if (libertas_fw_name == NULL) {
  848. libertas_fw_name = default_fw_name;
  849. }
  850. ret = usb_register(&if_usb_driver);
  851. lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
  852. return ret;
  853. }
  854. static void if_usb_exit_module(void)
  855. {
  856. struct usb_card_rec *cardp, *cardp_temp;
  857. lbs_deb_enter(LBS_DEB_MAIN);
  858. list_for_each_entry_safe(cardp, cardp_temp, &usb_devices, list) {
  859. libertas_prepare_and_send_command(cardp->priv, CMD_802_11_RESET,
  860. CMD_ACT_HALT, 0, 0, NULL);
  861. }
  862. /* API unregisters the driver from USB subsystem */
  863. usb_deregister(&if_usb_driver);
  864. lbs_deb_leave(LBS_DEB_MAIN);
  865. }
  866. module_init(if_usb_init_module);
  867. module_exit(if_usb_exit_module);
  868. MODULE_DESCRIPTION("8388 USB WLAN Driver");
  869. MODULE_AUTHOR("Marvell International Ltd.");
  870. MODULE_LICENSE("GPL");