if_sdio.c 31 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390
  1. /*
  2. * linux/drivers/net/wireless/libertas/if_sdio.c
  3. *
  4. * Copyright 2007-2008 Pierre Ossman
  5. *
  6. * Inspired by if_cs.c, Copyright 2007 Holger Schurig
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2 of the License, or (at
  11. * your option) any later version.
  12. *
  13. * This hardware has more or less no CMD53 support, so all registers
  14. * must be accessed using sdio_readb()/sdio_writeb().
  15. *
  16. * Transfers must be in one transaction or the firmware goes bonkers.
  17. * This means that the transfer must either be small enough to do a
  18. * byte based transfer or it must be padded to a multiple of the
  19. * current block size.
  20. *
  21. * As SDIO is still new to the kernel, it is unfortunately common with
  22. * bugs in the host controllers related to that. One such bug is that
  23. * controllers cannot do transfers that aren't a multiple of 4 bytes.
  24. * If you don't have time to fix the host controller driver, you can
  25. * work around the problem by modifying if_sdio_host_to_card() and
  26. * if_sdio_card_to_host() to pad the data.
  27. */
  28. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  29. #include <linux/kernel.h>
  30. #include <linux/module.h>
  31. #include <linux/slab.h>
  32. #include <linux/firmware.h>
  33. #include <linux/netdevice.h>
  34. #include <linux/delay.h>
  35. #include <linux/mmc/card.h>
  36. #include <linux/mmc/sdio_func.h>
  37. #include <linux/mmc/sdio_ids.h>
  38. #include <linux/mmc/sdio.h>
  39. #include <linux/mmc/host.h>
  40. #include <linux/pm_runtime.h>
  41. #include "host.h"
  42. #include "decl.h"
  43. #include "defs.h"
  44. #include "dev.h"
  45. #include "cmd.h"
  46. #include "if_sdio.h"
  47. static void if_sdio_interrupt(struct sdio_func *func);
  48. /* The if_sdio_remove() callback function is called when
  49. * user removes this module from kernel space or ejects
  50. * the card from the slot. The driver handles these 2 cases
  51. * differently for SD8688 combo chip.
  52. * If the user is removing the module, the FUNC_SHUTDOWN
  53. * command for SD8688 is sent to the firmware.
  54. * If the card is removed, there is no need to send this command.
  55. *
  56. * The variable 'user_rmmod' is used to distinguish these two
  57. * scenarios. This flag is initialized as FALSE in case the card
  58. * is removed, and will be set to TRUE for module removal when
  59. * module_exit function is called.
  60. */
  61. static u8 user_rmmod;
  62. static const struct sdio_device_id if_sdio_ids[] = {
  63. { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  64. SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
  65. { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  66. SDIO_DEVICE_ID_MARVELL_8688WLAN) },
  67. { /* end: all zeroes */ },
  68. };
  69. MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
  70. #define MODEL_8385 0x04
  71. #define MODEL_8686 0x0b
  72. #define MODEL_8688 0x10
  73. static const struct lbs_fw_table fw_table[] = {
  74. { MODEL_8385, "libertas/sd8385_helper.bin", "libertas/sd8385.bin" },
  75. { MODEL_8385, "sd8385_helper.bin", "sd8385.bin" },
  76. { MODEL_8686, "libertas/sd8686_v9_helper.bin", "libertas/sd8686_v9.bin" },
  77. { MODEL_8686, "libertas/sd8686_v8_helper.bin", "libertas/sd8686_v8.bin" },
  78. { MODEL_8686, "sd8686_helper.bin", "sd8686.bin" },
  79. { MODEL_8688, "libertas/sd8688_helper.bin", "libertas/sd8688.bin" },
  80. { MODEL_8688, "sd8688_helper.bin", "sd8688.bin" },
  81. { 0, NULL, NULL }
  82. };
  83. MODULE_FIRMWARE("libertas/sd8385_helper.bin");
  84. MODULE_FIRMWARE("libertas/sd8385.bin");
  85. MODULE_FIRMWARE("sd8385_helper.bin");
  86. MODULE_FIRMWARE("sd8385.bin");
  87. MODULE_FIRMWARE("libertas/sd8686_v9_helper.bin");
  88. MODULE_FIRMWARE("libertas/sd8686_v9.bin");
  89. MODULE_FIRMWARE("libertas/sd8686_v8_helper.bin");
  90. MODULE_FIRMWARE("libertas/sd8686_v8.bin");
  91. MODULE_FIRMWARE("sd8686_helper.bin");
  92. MODULE_FIRMWARE("sd8686.bin");
  93. MODULE_FIRMWARE("libertas/sd8688_helper.bin");
  94. MODULE_FIRMWARE("libertas/sd8688.bin");
  95. MODULE_FIRMWARE("sd8688_helper.bin");
  96. MODULE_FIRMWARE("sd8688.bin");
  97. struct if_sdio_packet {
  98. struct if_sdio_packet *next;
  99. u16 nb;
  100. u8 buffer[0] __attribute__((aligned(4)));
  101. };
  102. struct if_sdio_card {
  103. struct sdio_func *func;
  104. struct lbs_private *priv;
  105. int model;
  106. unsigned long ioport;
  107. unsigned int scratch_reg;
  108. u8 buffer[65536] __attribute__((aligned(4)));
  109. spinlock_t lock;
  110. struct if_sdio_packet *packets;
  111. struct workqueue_struct *workqueue;
  112. struct work_struct packet_worker;
  113. u8 rx_unit;
  114. };
  115. /********************************************************************/
  116. /* I/O */
  117. /********************************************************************/
  118. /*
  119. * For SD8385/SD8686, this function reads firmware status after
  120. * the image is downloaded, or reads RX packet length when
  121. * interrupt (with IF_SDIO_H_INT_UPLD bit set) is received.
  122. * For SD8688, this function reads firmware status only.
  123. */
  124. static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
  125. {
  126. int ret;
  127. u16 scratch;
  128. scratch = sdio_readb(card->func, card->scratch_reg, &ret);
  129. if (!ret)
  130. scratch |= sdio_readb(card->func, card->scratch_reg + 1,
  131. &ret) << 8;
  132. if (err)
  133. *err = ret;
  134. if (ret)
  135. return 0xffff;
  136. return scratch;
  137. }
  138. static u8 if_sdio_read_rx_unit(struct if_sdio_card *card)
  139. {
  140. int ret;
  141. u8 rx_unit;
  142. rx_unit = sdio_readb(card->func, IF_SDIO_RX_UNIT, &ret);
  143. if (ret)
  144. rx_unit = 0;
  145. return rx_unit;
  146. }
  147. static u16 if_sdio_read_rx_len(struct if_sdio_card *card, int *err)
  148. {
  149. int ret;
  150. u16 rx_len;
  151. switch (card->model) {
  152. case MODEL_8385:
  153. case MODEL_8686:
  154. rx_len = if_sdio_read_scratch(card, &ret);
  155. break;
  156. case MODEL_8688:
  157. default: /* for newer chipsets */
  158. rx_len = sdio_readb(card->func, IF_SDIO_RX_LEN, &ret);
  159. if (!ret)
  160. rx_len <<= card->rx_unit;
  161. else
  162. rx_len = 0xffff; /* invalid length */
  163. break;
  164. }
  165. if (err)
  166. *err = ret;
  167. return rx_len;
  168. }
  169. static int if_sdio_handle_cmd(struct if_sdio_card *card,
  170. u8 *buffer, unsigned size)
  171. {
  172. struct lbs_private *priv = card->priv;
  173. int ret;
  174. unsigned long flags;
  175. u8 i;
  176. lbs_deb_enter(LBS_DEB_SDIO);
  177. if (size > LBS_CMD_BUFFER_SIZE) {
  178. lbs_deb_sdio("response packet too large (%d bytes)\n",
  179. (int)size);
  180. ret = -E2BIG;
  181. goto out;
  182. }
  183. spin_lock_irqsave(&priv->driver_lock, flags);
  184. i = (priv->resp_idx == 0) ? 1 : 0;
  185. BUG_ON(priv->resp_len[i]);
  186. priv->resp_len[i] = size;
  187. memcpy(priv->resp_buf[i], buffer, size);
  188. lbs_notify_command_response(priv, i);
  189. spin_unlock_irqrestore(&card->priv->driver_lock, flags);
  190. ret = 0;
  191. out:
  192. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  193. return ret;
  194. }
  195. static int if_sdio_handle_data(struct if_sdio_card *card,
  196. u8 *buffer, unsigned size)
  197. {
  198. int ret;
  199. struct sk_buff *skb;
  200. char *data;
  201. lbs_deb_enter(LBS_DEB_SDIO);
  202. if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
  203. lbs_deb_sdio("response packet too large (%d bytes)\n",
  204. (int)size);
  205. ret = -E2BIG;
  206. goto out;
  207. }
  208. skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
  209. if (!skb) {
  210. ret = -ENOMEM;
  211. goto out;
  212. }
  213. skb_reserve(skb, NET_IP_ALIGN);
  214. data = skb_put(skb, size);
  215. memcpy(data, buffer, size);
  216. lbs_process_rxed_packet(card->priv, skb);
  217. ret = 0;
  218. out:
  219. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  220. return ret;
  221. }
  222. static int if_sdio_handle_event(struct if_sdio_card *card,
  223. u8 *buffer, unsigned size)
  224. {
  225. int ret;
  226. u32 event;
  227. lbs_deb_enter(LBS_DEB_SDIO);
  228. if (card->model == MODEL_8385) {
  229. event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
  230. if (ret)
  231. goto out;
  232. /* right shift 3 bits to get the event id */
  233. event >>= 3;
  234. } else {
  235. if (size < 4) {
  236. lbs_deb_sdio("event packet too small (%d bytes)\n",
  237. (int)size);
  238. ret = -EINVAL;
  239. goto out;
  240. }
  241. event = buffer[3] << 24;
  242. event |= buffer[2] << 16;
  243. event |= buffer[1] << 8;
  244. event |= buffer[0] << 0;
  245. }
  246. lbs_queue_event(card->priv, event & 0xFF);
  247. ret = 0;
  248. out:
  249. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  250. return ret;
  251. }
  252. static int if_sdio_wait_status(struct if_sdio_card *card, const u8 condition)
  253. {
  254. u8 status;
  255. unsigned long timeout;
  256. int ret = 0;
  257. timeout = jiffies + HZ;
  258. while (1) {
  259. status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
  260. if (ret)
  261. return ret;
  262. if ((status & condition) == condition)
  263. break;
  264. if (time_after(jiffies, timeout))
  265. return -ETIMEDOUT;
  266. mdelay(1);
  267. }
  268. return ret;
  269. }
  270. static int if_sdio_card_to_host(struct if_sdio_card *card)
  271. {
  272. int ret;
  273. u16 size, type, chunk;
  274. lbs_deb_enter(LBS_DEB_SDIO);
  275. size = if_sdio_read_rx_len(card, &ret);
  276. if (ret)
  277. goto out;
  278. if (size < 4) {
  279. lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
  280. (int)size);
  281. ret = -EINVAL;
  282. goto out;
  283. }
  284. ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
  285. if (ret)
  286. goto out;
  287. /*
  288. * The transfer must be in one transaction or the firmware
  289. * goes suicidal. There's no way to guarantee that for all
  290. * controllers, but we can at least try.
  291. */
  292. chunk = sdio_align_size(card->func, size);
  293. ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
  294. if (ret)
  295. goto out;
  296. chunk = card->buffer[0] | (card->buffer[1] << 8);
  297. type = card->buffer[2] | (card->buffer[3] << 8);
  298. lbs_deb_sdio("packet of type %d and size %d bytes\n",
  299. (int)type, (int)chunk);
  300. if (chunk > size) {
  301. lbs_deb_sdio("packet fragment (%d > %d)\n",
  302. (int)chunk, (int)size);
  303. ret = -EINVAL;
  304. goto out;
  305. }
  306. if (chunk < size) {
  307. lbs_deb_sdio("packet fragment (%d < %d)\n",
  308. (int)chunk, (int)size);
  309. }
  310. switch (type) {
  311. case MVMS_CMD:
  312. ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
  313. if (ret)
  314. goto out;
  315. break;
  316. case MVMS_DAT:
  317. ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
  318. if (ret)
  319. goto out;
  320. break;
  321. case MVMS_EVENT:
  322. ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
  323. if (ret)
  324. goto out;
  325. break;
  326. default:
  327. lbs_deb_sdio("invalid type (%d) from firmware\n",
  328. (int)type);
  329. ret = -EINVAL;
  330. goto out;
  331. }
  332. out:
  333. if (ret)
  334. pr_err("problem fetching packet from firmware\n");
  335. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  336. return ret;
  337. }
  338. static void if_sdio_host_to_card_worker(struct work_struct *work)
  339. {
  340. struct if_sdio_card *card;
  341. struct if_sdio_packet *packet;
  342. int ret;
  343. unsigned long flags;
  344. lbs_deb_enter(LBS_DEB_SDIO);
  345. card = container_of(work, struct if_sdio_card, packet_worker);
  346. while (1) {
  347. spin_lock_irqsave(&card->lock, flags);
  348. packet = card->packets;
  349. if (packet)
  350. card->packets = packet->next;
  351. spin_unlock_irqrestore(&card->lock, flags);
  352. if (!packet)
  353. break;
  354. sdio_claim_host(card->func);
  355. ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
  356. if (ret == 0) {
  357. ret = sdio_writesb(card->func, card->ioport,
  358. packet->buffer, packet->nb);
  359. }
  360. if (ret)
  361. pr_err("error %d sending packet to firmware\n", ret);
  362. sdio_release_host(card->func);
  363. kfree(packet);
  364. }
  365. lbs_deb_leave(LBS_DEB_SDIO);
  366. }
  367. /********************************************************************/
  368. /* Firmware */
  369. /********************************************************************/
  370. #define FW_DL_READY_STATUS (IF_SDIO_IO_RDY | IF_SDIO_DL_RDY)
  371. static int if_sdio_prog_helper(struct if_sdio_card *card,
  372. const struct firmware *fw)
  373. {
  374. int ret;
  375. unsigned long timeout;
  376. u8 *chunk_buffer;
  377. u32 chunk_size;
  378. const u8 *firmware;
  379. size_t size;
  380. lbs_deb_enter(LBS_DEB_SDIO);
  381. chunk_buffer = kzalloc(64, GFP_KERNEL);
  382. if (!chunk_buffer) {
  383. ret = -ENOMEM;
  384. goto out;
  385. }
  386. sdio_claim_host(card->func);
  387. ret = sdio_set_block_size(card->func, 32);
  388. if (ret)
  389. goto release;
  390. firmware = fw->data;
  391. size = fw->size;
  392. while (size) {
  393. ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
  394. if (ret)
  395. goto release;
  396. /* On some platforms (like Davinci) the chip needs more time
  397. * between helper blocks.
  398. */
  399. mdelay(2);
  400. chunk_size = min(size, (size_t)60);
  401. *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
  402. memcpy(chunk_buffer + 4, firmware, chunk_size);
  403. /*
  404. lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
  405. */
  406. ret = sdio_writesb(card->func, card->ioport,
  407. chunk_buffer, 64);
  408. if (ret)
  409. goto release;
  410. firmware += chunk_size;
  411. size -= chunk_size;
  412. }
  413. /* an empty block marks the end of the transfer */
  414. memset(chunk_buffer, 0, 4);
  415. ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
  416. if (ret)
  417. goto release;
  418. lbs_deb_sdio("waiting for helper to boot...\n");
  419. /* wait for the helper to boot by looking at the size register */
  420. timeout = jiffies + HZ;
  421. while (1) {
  422. u16 req_size;
  423. req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
  424. if (ret)
  425. goto release;
  426. req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
  427. if (ret)
  428. goto release;
  429. if (req_size != 0)
  430. break;
  431. if (time_after(jiffies, timeout)) {
  432. ret = -ETIMEDOUT;
  433. goto release;
  434. }
  435. msleep(10);
  436. }
  437. ret = 0;
  438. release:
  439. sdio_release_host(card->func);
  440. kfree(chunk_buffer);
  441. out:
  442. if (ret)
  443. pr_err("failed to load helper firmware\n");
  444. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  445. return ret;
  446. }
  447. static int if_sdio_prog_real(struct if_sdio_card *card,
  448. const struct firmware *fw)
  449. {
  450. int ret;
  451. unsigned long timeout;
  452. u8 *chunk_buffer;
  453. u32 chunk_size;
  454. const u8 *firmware;
  455. size_t size, req_size;
  456. lbs_deb_enter(LBS_DEB_SDIO);
  457. chunk_buffer = kzalloc(512, GFP_KERNEL);
  458. if (!chunk_buffer) {
  459. ret = -ENOMEM;
  460. goto out;
  461. }
  462. sdio_claim_host(card->func);
  463. ret = sdio_set_block_size(card->func, 32);
  464. if (ret)
  465. goto release;
  466. firmware = fw->data;
  467. size = fw->size;
  468. while (size) {
  469. ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
  470. if (ret)
  471. goto release;
  472. req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
  473. if (ret)
  474. goto release;
  475. req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
  476. if (ret)
  477. goto release;
  478. /*
  479. lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
  480. */
  481. if (req_size == 0) {
  482. lbs_deb_sdio("firmware helper gave up early\n");
  483. ret = -EIO;
  484. goto release;
  485. }
  486. if (req_size & 0x01) {
  487. lbs_deb_sdio("firmware helper signalled error\n");
  488. ret = -EIO;
  489. goto release;
  490. }
  491. if (req_size > size)
  492. req_size = size;
  493. while (req_size) {
  494. chunk_size = min(req_size, (size_t)512);
  495. memcpy(chunk_buffer, firmware, chunk_size);
  496. /*
  497. lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
  498. chunk_size, (chunk_size + 31) / 32 * 32);
  499. */
  500. ret = sdio_writesb(card->func, card->ioport,
  501. chunk_buffer, roundup(chunk_size, 32));
  502. if (ret)
  503. goto release;
  504. firmware += chunk_size;
  505. size -= chunk_size;
  506. req_size -= chunk_size;
  507. }
  508. }
  509. ret = 0;
  510. lbs_deb_sdio("waiting for firmware to boot...\n");
  511. /* wait for the firmware to boot */
  512. timeout = jiffies + HZ;
  513. while (1) {
  514. u16 scratch;
  515. scratch = if_sdio_read_scratch(card, &ret);
  516. if (ret)
  517. goto release;
  518. if (scratch == IF_SDIO_FIRMWARE_OK)
  519. break;
  520. if (time_after(jiffies, timeout)) {
  521. ret = -ETIMEDOUT;
  522. goto release;
  523. }
  524. msleep(10);
  525. }
  526. ret = 0;
  527. release:
  528. sdio_release_host(card->func);
  529. kfree(chunk_buffer);
  530. out:
  531. if (ret)
  532. pr_err("failed to load firmware\n");
  533. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  534. return ret;
  535. }
  536. static int if_sdio_prog_firmware(struct if_sdio_card *card)
  537. {
  538. int ret;
  539. u16 scratch;
  540. const struct firmware *helper = NULL;
  541. const struct firmware *mainfw = NULL;
  542. lbs_deb_enter(LBS_DEB_SDIO);
  543. /*
  544. * Disable interrupts
  545. */
  546. sdio_claim_host(card->func);
  547. sdio_writeb(card->func, 0x00, IF_SDIO_H_INT_MASK, &ret);
  548. sdio_release_host(card->func);
  549. sdio_claim_host(card->func);
  550. scratch = if_sdio_read_scratch(card, &ret);
  551. sdio_release_host(card->func);
  552. lbs_deb_sdio("firmware status = %#x\n", scratch);
  553. lbs_deb_sdio("scratch ret = %d\n", ret);
  554. if (ret)
  555. goto out;
  556. /*
  557. * The manual clearly describes that FEDC is the right code to use
  558. * to detect firmware presence, but for SD8686 it is not that simple.
  559. * Scratch is also used to store the RX packet length, so we lose
  560. * the FEDC value early on. So we use a non-zero check in order
  561. * to validate firmware presence.
  562. * Additionally, the SD8686 in the Gumstix always has the high scratch
  563. * bit set, even when the firmware is not loaded. So we have to
  564. * exclude that from the test.
  565. */
  566. if (scratch == IF_SDIO_FIRMWARE_OK) {
  567. lbs_deb_sdio("firmware already loaded\n");
  568. goto success;
  569. } else if ((card->model == MODEL_8686) && (scratch & 0x7fff)) {
  570. lbs_deb_sdio("firmware may be running\n");
  571. goto success;
  572. }
  573. ret = lbs_get_firmware(&card->func->dev, card->model, &fw_table[0],
  574. &helper, &mainfw);
  575. if (ret) {
  576. pr_err("failed to find firmware (%d)\n", ret);
  577. goto out;
  578. }
  579. ret = if_sdio_prog_helper(card, helper);
  580. if (ret)
  581. goto out;
  582. lbs_deb_sdio("Helper firmware loaded\n");
  583. ret = if_sdio_prog_real(card, mainfw);
  584. if (ret)
  585. goto out;
  586. lbs_deb_sdio("Firmware loaded\n");
  587. success:
  588. sdio_claim_host(card->func);
  589. sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
  590. sdio_release_host(card->func);
  591. ret = 0;
  592. out:
  593. release_firmware(helper);
  594. release_firmware(mainfw);
  595. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  596. return ret;
  597. }
  598. /********************************************************************/
  599. /* Power management */
  600. /********************************************************************/
  601. static int if_sdio_power_on(struct if_sdio_card *card)
  602. {
  603. struct sdio_func *func = card->func;
  604. struct lbs_private *priv = card->priv;
  605. struct mmc_host *host = func->card->host;
  606. int ret;
  607. sdio_claim_host(func);
  608. ret = sdio_enable_func(func);
  609. if (ret)
  610. goto release;
  611. /* For 1-bit transfers to the 8686 model, we need to enable the
  612. * interrupt flag in the CCCR register. Set the MMC_QUIRK_LENIENT_FN0
  613. * bit to allow access to non-vendor registers. */
  614. if ((card->model == MODEL_8686) &&
  615. (host->caps & MMC_CAP_SDIO_IRQ) &&
  616. (host->ios.bus_width == MMC_BUS_WIDTH_1)) {
  617. u8 reg;
  618. func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
  619. reg = sdio_f0_readb(func, SDIO_CCCR_IF, &ret);
  620. if (ret)
  621. goto disable;
  622. reg |= SDIO_BUS_ECSI;
  623. sdio_f0_writeb(func, reg, SDIO_CCCR_IF, &ret);
  624. if (ret)
  625. goto disable;
  626. }
  627. card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
  628. if (ret)
  629. goto disable;
  630. card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
  631. if (ret)
  632. goto disable;
  633. card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
  634. if (ret)
  635. goto disable;
  636. sdio_release_host(func);
  637. ret = if_sdio_prog_firmware(card);
  638. sdio_claim_host(func);
  639. if (ret)
  640. goto disable;
  641. /*
  642. * Get rx_unit if the chip is SD8688 or newer.
  643. * SD8385 & SD8686 do not have rx_unit.
  644. */
  645. if ((card->model != MODEL_8385)
  646. && (card->model != MODEL_8686))
  647. card->rx_unit = if_sdio_read_rx_unit(card);
  648. else
  649. card->rx_unit = 0;
  650. /*
  651. * Set up the interrupt handler late.
  652. *
  653. * If we set it up earlier, the (buggy) hardware generates a spurious
  654. * interrupt, even before the interrupt has been enabled, with
  655. * CCCR_INTx = 0.
  656. *
  657. * We register the interrupt handler late so that we can handle any
  658. * spurious interrupts, and also to avoid generation of that known
  659. * spurious interrupt in the first place.
  660. */
  661. ret = sdio_claim_irq(func, if_sdio_interrupt);
  662. if (ret)
  663. goto disable;
  664. /*
  665. * Enable interrupts now that everything is set up
  666. */
  667. sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
  668. if (ret)
  669. goto release_irq;
  670. sdio_release_host(func);
  671. /*
  672. * FUNC_INIT is required for SD8688 WLAN/BT multiple functions
  673. */
  674. if (card->model == MODEL_8688) {
  675. struct cmd_header cmd;
  676. memset(&cmd, 0, sizeof(cmd));
  677. lbs_deb_sdio("send function INIT command\n");
  678. if (__lbs_cmd(priv, CMD_FUNC_INIT, &cmd, sizeof(cmd),
  679. lbs_cmd_copyback, (unsigned long) &cmd))
  680. netdev_alert(priv->dev, "CMD_FUNC_INIT cmd failed\n");
  681. }
  682. priv->fw_ready = 1;
  683. return 0;
  684. release_irq:
  685. sdio_release_irq(func);
  686. disable:
  687. sdio_disable_func(func);
  688. release:
  689. sdio_release_host(func);
  690. return ret;
  691. }
  692. static int if_sdio_power_off(struct if_sdio_card *card)
  693. {
  694. struct sdio_func *func = card->func;
  695. struct lbs_private *priv = card->priv;
  696. priv->fw_ready = 0;
  697. sdio_claim_host(func);
  698. sdio_release_irq(func);
  699. sdio_disable_func(func);
  700. sdio_release_host(func);
  701. return 0;
  702. }
  703. /*******************************************************************/
  704. /* Libertas callbacks */
  705. /*******************************************************************/
  706. static int if_sdio_host_to_card(struct lbs_private *priv,
  707. u8 type, u8 *buf, u16 nb)
  708. {
  709. int ret;
  710. struct if_sdio_card *card;
  711. struct if_sdio_packet *packet, *cur;
  712. u16 size;
  713. unsigned long flags;
  714. lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
  715. card = priv->card;
  716. if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
  717. ret = -EINVAL;
  718. goto out;
  719. }
  720. /*
  721. * The transfer must be in one transaction or the firmware
  722. * goes suicidal. There's no way to guarantee that for all
  723. * controllers, but we can at least try.
  724. */
  725. size = sdio_align_size(card->func, nb + 4);
  726. packet = kzalloc(sizeof(struct if_sdio_packet) + size,
  727. GFP_ATOMIC);
  728. if (!packet) {
  729. ret = -ENOMEM;
  730. goto out;
  731. }
  732. packet->next = NULL;
  733. packet->nb = size;
  734. /*
  735. * SDIO specific header.
  736. */
  737. packet->buffer[0] = (nb + 4) & 0xff;
  738. packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
  739. packet->buffer[2] = type;
  740. packet->buffer[3] = 0;
  741. memcpy(packet->buffer + 4, buf, nb);
  742. spin_lock_irqsave(&card->lock, flags);
  743. if (!card->packets)
  744. card->packets = packet;
  745. else {
  746. cur = card->packets;
  747. while (cur->next)
  748. cur = cur->next;
  749. cur->next = packet;
  750. }
  751. switch (type) {
  752. case MVMS_CMD:
  753. priv->dnld_sent = DNLD_CMD_SENT;
  754. break;
  755. case MVMS_DAT:
  756. priv->dnld_sent = DNLD_DATA_SENT;
  757. break;
  758. default:
  759. lbs_deb_sdio("unknown packet type %d\n", (int)type);
  760. }
  761. spin_unlock_irqrestore(&card->lock, flags);
  762. queue_work(card->workqueue, &card->packet_worker);
  763. ret = 0;
  764. out:
  765. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  766. return ret;
  767. }
  768. static int if_sdio_enter_deep_sleep(struct lbs_private *priv)
  769. {
  770. int ret = -1;
  771. struct cmd_header cmd;
  772. memset(&cmd, 0, sizeof(cmd));
  773. lbs_deb_sdio("send DEEP_SLEEP command\n");
  774. ret = __lbs_cmd(priv, CMD_802_11_DEEP_SLEEP, &cmd, sizeof(cmd),
  775. lbs_cmd_copyback, (unsigned long) &cmd);
  776. if (ret)
  777. netdev_err(priv->dev, "DEEP_SLEEP cmd failed\n");
  778. mdelay(200);
  779. return ret;
  780. }
  781. static int if_sdio_exit_deep_sleep(struct lbs_private *priv)
  782. {
  783. struct if_sdio_card *card = priv->card;
  784. int ret = -1;
  785. lbs_deb_enter(LBS_DEB_SDIO);
  786. sdio_claim_host(card->func);
  787. sdio_writeb(card->func, HOST_POWER_UP, CONFIGURATION_REG, &ret);
  788. if (ret)
  789. netdev_err(priv->dev, "sdio_writeb failed!\n");
  790. sdio_release_host(card->func);
  791. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  792. return ret;
  793. }
  794. static int if_sdio_reset_deep_sleep_wakeup(struct lbs_private *priv)
  795. {
  796. struct if_sdio_card *card = priv->card;
  797. int ret = -1;
  798. lbs_deb_enter(LBS_DEB_SDIO);
  799. sdio_claim_host(card->func);
  800. sdio_writeb(card->func, 0, CONFIGURATION_REG, &ret);
  801. if (ret)
  802. netdev_err(priv->dev, "sdio_writeb failed!\n");
  803. sdio_release_host(card->func);
  804. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  805. return ret;
  806. }
  807. static struct mmc_host *reset_host;
  808. static void if_sdio_reset_card_worker(struct work_struct *work)
  809. {
  810. /*
  811. * The actual reset operation must be run outside of lbs_thread. This
  812. * is because mmc_remove_host() will cause the device to be instantly
  813. * destroyed, and the libertas driver then needs to end lbs_thread,
  814. * leading to a deadlock.
  815. *
  816. * We run it in a workqueue totally independent from the if_sdio_card
  817. * instance for that reason.
  818. */
  819. pr_info("Resetting card...");
  820. mmc_remove_host(reset_host);
  821. mmc_add_host(reset_host);
  822. }
  823. static DECLARE_WORK(card_reset_work, if_sdio_reset_card_worker);
  824. static void if_sdio_reset_card(struct lbs_private *priv)
  825. {
  826. struct if_sdio_card *card = priv->card;
  827. if (work_pending(&card_reset_work))
  828. return;
  829. reset_host = card->func->card->host;
  830. schedule_work(&card_reset_work);
  831. }
  832. static int if_sdio_power_save(struct lbs_private *priv)
  833. {
  834. struct if_sdio_card *card = priv->card;
  835. int ret;
  836. flush_workqueue(card->workqueue);
  837. ret = if_sdio_power_off(card);
  838. /* Let runtime PM know the card is powered off */
  839. pm_runtime_put_sync(&card->func->dev);
  840. return ret;
  841. }
  842. static int if_sdio_power_restore(struct lbs_private *priv)
  843. {
  844. struct if_sdio_card *card = priv->card;
  845. /* Make sure the card will not be powered off by runtime PM */
  846. pm_runtime_get_sync(&card->func->dev);
  847. return if_sdio_power_on(card);
  848. }
  849. /*******************************************************************/
  850. /* SDIO callbacks */
  851. /*******************************************************************/
  852. static void if_sdio_interrupt(struct sdio_func *func)
  853. {
  854. int ret;
  855. struct if_sdio_card *card;
  856. u8 cause;
  857. lbs_deb_enter(LBS_DEB_SDIO);
  858. card = sdio_get_drvdata(func);
  859. cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
  860. if (ret || !cause)
  861. goto out;
  862. lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
  863. sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
  864. if (ret)
  865. goto out;
  866. /*
  867. * Ignore the define name, this really means the card has
  868. * successfully received the command.
  869. */
  870. card->priv->is_activity_detected = 1;
  871. if (cause & IF_SDIO_H_INT_DNLD)
  872. lbs_host_to_card_done(card->priv);
  873. if (cause & IF_SDIO_H_INT_UPLD) {
  874. ret = if_sdio_card_to_host(card);
  875. if (ret)
  876. goto out;
  877. }
  878. ret = 0;
  879. out:
  880. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  881. }
  882. static int if_sdio_probe(struct sdio_func *func,
  883. const struct sdio_device_id *id)
  884. {
  885. struct if_sdio_card *card;
  886. struct lbs_private *priv;
  887. int ret, i;
  888. unsigned int model;
  889. struct if_sdio_packet *packet;
  890. lbs_deb_enter(LBS_DEB_SDIO);
  891. for (i = 0;i < func->card->num_info;i++) {
  892. if (sscanf(func->card->info[i],
  893. "802.11 SDIO ID: %x", &model) == 1)
  894. break;
  895. if (sscanf(func->card->info[i],
  896. "ID: %x", &model) == 1)
  897. break;
  898. if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
  899. model = MODEL_8385;
  900. break;
  901. }
  902. }
  903. if (i == func->card->num_info) {
  904. pr_err("unable to identify card model\n");
  905. return -ENODEV;
  906. }
  907. card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
  908. if (!card)
  909. return -ENOMEM;
  910. card->func = func;
  911. card->model = model;
  912. switch (card->model) {
  913. case MODEL_8385:
  914. card->scratch_reg = IF_SDIO_SCRATCH_OLD;
  915. break;
  916. case MODEL_8686:
  917. card->scratch_reg = IF_SDIO_SCRATCH;
  918. break;
  919. case MODEL_8688:
  920. default: /* for newer chipsets */
  921. card->scratch_reg = IF_SDIO_FW_STATUS;
  922. break;
  923. }
  924. spin_lock_init(&card->lock);
  925. card->workqueue = create_workqueue("libertas_sdio");
  926. INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
  927. /* Check if we support this card */
  928. for (i = 0; i < ARRAY_SIZE(fw_table); i++) {
  929. if (card->model == fw_table[i].model)
  930. break;
  931. }
  932. if (i == ARRAY_SIZE(fw_table)) {
  933. pr_err("unknown card model 0x%x\n", card->model);
  934. ret = -ENODEV;
  935. goto free;
  936. }
  937. sdio_set_drvdata(func, card);
  938. lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
  939. "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
  940. func->class, func->vendor, func->device,
  941. model, (unsigned)card->ioport);
  942. priv = lbs_add_card(card, &func->dev);
  943. if (!priv) {
  944. ret = -ENOMEM;
  945. goto free;
  946. }
  947. card->priv = priv;
  948. priv->card = card;
  949. priv->hw_host_to_card = if_sdio_host_to_card;
  950. priv->enter_deep_sleep = if_sdio_enter_deep_sleep;
  951. priv->exit_deep_sleep = if_sdio_exit_deep_sleep;
  952. priv->reset_deep_sleep_wakeup = if_sdio_reset_deep_sleep_wakeup;
  953. priv->reset_card = if_sdio_reset_card;
  954. priv->power_save = if_sdio_power_save;
  955. priv->power_restore = if_sdio_power_restore;
  956. ret = if_sdio_power_on(card);
  957. if (ret)
  958. goto err_activate_card;
  959. ret = lbs_start_card(priv);
  960. if_sdio_power_off(card);
  961. if (ret)
  962. goto err_activate_card;
  963. /* Tell PM core that we don't need the card to be powered now */
  964. pm_runtime_put_noidle(&func->dev);
  965. out:
  966. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  967. return ret;
  968. err_activate_card:
  969. flush_workqueue(card->workqueue);
  970. lbs_remove_card(priv);
  971. free:
  972. destroy_workqueue(card->workqueue);
  973. while (card->packets) {
  974. packet = card->packets;
  975. card->packets = card->packets->next;
  976. kfree(packet);
  977. }
  978. kfree(card);
  979. goto out;
  980. }
  981. static void if_sdio_remove(struct sdio_func *func)
  982. {
  983. struct if_sdio_card *card;
  984. struct if_sdio_packet *packet;
  985. lbs_deb_enter(LBS_DEB_SDIO);
  986. card = sdio_get_drvdata(func);
  987. /* Undo decrement done above in if_sdio_probe */
  988. pm_runtime_get_noresume(&func->dev);
  989. if (user_rmmod && (card->model == MODEL_8688)) {
  990. /*
  991. * FUNC_SHUTDOWN is required for SD8688 WLAN/BT
  992. * multiple functions
  993. */
  994. struct cmd_header cmd;
  995. memset(&cmd, 0, sizeof(cmd));
  996. lbs_deb_sdio("send function SHUTDOWN command\n");
  997. if (__lbs_cmd(card->priv, CMD_FUNC_SHUTDOWN,
  998. &cmd, sizeof(cmd), lbs_cmd_copyback,
  999. (unsigned long) &cmd))
  1000. pr_alert("CMD_FUNC_SHUTDOWN cmd failed\n");
  1001. }
  1002. lbs_deb_sdio("call remove card\n");
  1003. lbs_stop_card(card->priv);
  1004. lbs_remove_card(card->priv);
  1005. flush_workqueue(card->workqueue);
  1006. destroy_workqueue(card->workqueue);
  1007. while (card->packets) {
  1008. packet = card->packets;
  1009. card->packets = card->packets->next;
  1010. kfree(packet);
  1011. }
  1012. lbs_deb_leave(LBS_DEB_SDIO);
  1013. }
  1014. static int if_sdio_suspend(struct device *dev)
  1015. {
  1016. struct sdio_func *func = dev_to_sdio_func(dev);
  1017. int ret;
  1018. struct if_sdio_card *card = sdio_get_drvdata(func);
  1019. mmc_pm_flag_t flags = sdio_get_host_pm_caps(func);
  1020. dev_info(dev, "%s: suspend: PM flags = 0x%x\n",
  1021. sdio_func_id(func), flags);
  1022. /* If we aren't being asked to wake on anything, we should bail out
  1023. * and let the SD stack power down the card.
  1024. */
  1025. if (card->priv->wol_criteria == EHS_REMOVE_WAKEUP) {
  1026. dev_info(dev, "Suspend without wake params -- powering down card\n");
  1027. return -ENOSYS;
  1028. }
  1029. if (!(flags & MMC_PM_KEEP_POWER)) {
  1030. dev_err(dev, "%s: cannot remain alive while host is suspended\n",
  1031. sdio_func_id(func));
  1032. return -ENOSYS;
  1033. }
  1034. ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
  1035. if (ret)
  1036. return ret;
  1037. ret = lbs_suspend(card->priv);
  1038. if (ret)
  1039. return ret;
  1040. return sdio_set_host_pm_flags(func, MMC_PM_WAKE_SDIO_IRQ);
  1041. }
  1042. static int if_sdio_resume(struct device *dev)
  1043. {
  1044. struct sdio_func *func = dev_to_sdio_func(dev);
  1045. struct if_sdio_card *card = sdio_get_drvdata(func);
  1046. int ret;
  1047. dev_info(dev, "%s: resume: we're back\n", sdio_func_id(func));
  1048. ret = lbs_resume(card->priv);
  1049. return ret;
  1050. }
  1051. static const struct dev_pm_ops if_sdio_pm_ops = {
  1052. .suspend = if_sdio_suspend,
  1053. .resume = if_sdio_resume,
  1054. };
  1055. static struct sdio_driver if_sdio_driver = {
  1056. .name = "libertas_sdio",
  1057. .id_table = if_sdio_ids,
  1058. .probe = if_sdio_probe,
  1059. .remove = if_sdio_remove,
  1060. .drv = {
  1061. .pm = &if_sdio_pm_ops,
  1062. },
  1063. };
  1064. /*******************************************************************/
  1065. /* Module functions */
  1066. /*******************************************************************/
  1067. static int __init if_sdio_init_module(void)
  1068. {
  1069. int ret = 0;
  1070. lbs_deb_enter(LBS_DEB_SDIO);
  1071. printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
  1072. printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
  1073. ret = sdio_register_driver(&if_sdio_driver);
  1074. /* Clear the flag in case user removes the card. */
  1075. user_rmmod = 0;
  1076. lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
  1077. return ret;
  1078. }
  1079. static void __exit if_sdio_exit_module(void)
  1080. {
  1081. lbs_deb_enter(LBS_DEB_SDIO);
  1082. /* Set the flag as user is removing this module. */
  1083. user_rmmod = 1;
  1084. cancel_work_sync(&card_reset_work);
  1085. sdio_unregister_driver(&if_sdio_driver);
  1086. lbs_deb_leave(LBS_DEB_SDIO);
  1087. }
  1088. module_init(if_sdio_init_module);
  1089. module_exit(if_sdio_exit_module);
  1090. MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
  1091. MODULE_AUTHOR("Pierre Ossman");
  1092. MODULE_LICENSE("GPL");