if_cs.c 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932
  1. /*
  2. Driver for the Marvell 8385 based compact flash WLAN cards.
  3. (C) 2007 by Holger Schurig <hs4233@mail.mn-solutions.de>
  4. This program is free software; you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation; either version 2 of the License, or
  7. (at your option) any later version.
  8. This program is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. GNU General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with this program; see the file COPYING. If not, write to
  14. the Free Software Foundation, Inc., 51 Franklin Steet, Fifth Floor,
  15. Boston, MA 02110-1301, USA.
  16. */
  17. #include <linux/module.h>
  18. #include <linux/delay.h>
  19. #include <linux/moduleparam.h>
  20. #include <linux/firmware.h>
  21. #include <linux/netdevice.h>
  22. #include <pcmcia/cs_types.h>
  23. #include <pcmcia/cs.h>
  24. #include <pcmcia/cistpl.h>
  25. #include <pcmcia/ds.h>
  26. #include <linux/io.h>
  27. #define DRV_NAME "libertas_cs"
  28. #include "decl.h"
  29. #include "defs.h"
  30. #include "dev.h"
  31. /********************************************************************/
  32. /* Module stuff */
  33. /********************************************************************/
  34. MODULE_AUTHOR("Holger Schurig <hs4233@mail.mn-solutions.de>");
  35. MODULE_DESCRIPTION("Driver for Marvell 83xx compact flash WLAN cards");
  36. MODULE_LICENSE("GPL");
  37. /********************************************************************/
  38. /* Data structures */
  39. /********************************************************************/
  40. struct if_cs_card {
  41. struct pcmcia_device *p_dev;
  42. struct lbs_private *priv;
  43. void __iomem *iobase;
  44. };
  45. /********************************************************************/
  46. /* Hardware access */
  47. /********************************************************************/
  48. /* This define enables wrapper functions which allow you
  49. to dump all register accesses. You normally won't this,
  50. except for development */
  51. /* #define DEBUG_IO */
  52. #ifdef DEBUG_IO
  53. static int debug_output = 0;
  54. #else
  55. /* This way the compiler optimizes the printk's away */
  56. #define debug_output 0
  57. #endif
  58. static inline unsigned int if_cs_read8(struct if_cs_card *card, uint reg)
  59. {
  60. unsigned int val = ioread8(card->iobase + reg);
  61. if (debug_output)
  62. printk(KERN_INFO "inb %08x<%02x\n", reg, val);
  63. return val;
  64. }
  65. static inline unsigned int if_cs_read16(struct if_cs_card *card, uint reg)
  66. {
  67. unsigned int val = ioread16(card->iobase + reg);
  68. if (debug_output)
  69. printk(KERN_INFO "inw %08x<%04x\n", reg, val);
  70. return val;
  71. }
  72. static inline void if_cs_read16_rep(
  73. struct if_cs_card *card,
  74. uint reg,
  75. void *buf,
  76. unsigned long count)
  77. {
  78. if (debug_output)
  79. printk(KERN_INFO "insw %08x<(0x%lx words)\n",
  80. reg, count);
  81. ioread16_rep(card->iobase + reg, buf, count);
  82. }
  83. static inline void if_cs_write8(struct if_cs_card *card, uint reg, u8 val)
  84. {
  85. if (debug_output)
  86. printk(KERN_INFO "outb %08x>%02x\n", reg, val);
  87. iowrite8(val, card->iobase + reg);
  88. }
  89. static inline void if_cs_write16(struct if_cs_card *card, uint reg, u16 val)
  90. {
  91. if (debug_output)
  92. printk(KERN_INFO "outw %08x>%04x\n", reg, val);
  93. iowrite16(val, card->iobase + reg);
  94. }
  95. static inline void if_cs_write16_rep(
  96. struct if_cs_card *card,
  97. uint reg,
  98. void *buf,
  99. unsigned long count)
  100. {
  101. if (debug_output)
  102. printk(KERN_INFO "outsw %08x>(0x%lx words)\n",
  103. reg, count);
  104. iowrite16_rep(card->iobase + reg, buf, count);
  105. }
  106. /*
  107. * I know that polling/delaying is frowned upon. However, this procedure
  108. * with polling is needed while downloading the firmware. At this stage,
  109. * the hardware does unfortunately not create any interrupts.
  110. *
  111. * Fortunately, this function is never used once the firmware is in
  112. * the card. :-)
  113. *
  114. * As a reference, see the "Firmware Specification v5.1", page 18
  115. * and 19. I did not follow their suggested timing to the word,
  116. * but this works nice & fast anyway.
  117. */
  118. static int if_cs_poll_while_fw_download(struct if_cs_card *card, uint addr, u8 reg)
  119. {
  120. int i;
  121. for (i = 0; i < 1000; i++) {
  122. u8 val = if_cs_read8(card, addr);
  123. if (val == reg)
  124. return i;
  125. udelay(500);
  126. }
  127. return -ETIME;
  128. }
  129. /* Host control registers and their bit definitions */
  130. #define IF_CS_H_STATUS 0x00000000
  131. #define IF_CS_H_STATUS_TX_OVER 0x0001
  132. #define IF_CS_H_STATUS_RX_OVER 0x0002
  133. #define IF_CS_H_STATUS_DNLD_OVER 0x0004
  134. #define IF_CS_H_INT_CAUSE 0x00000002
  135. #define IF_CS_H_IC_TX_OVER 0x0001
  136. #define IF_CS_H_IC_RX_OVER 0x0002
  137. #define IF_CS_H_IC_DNLD_OVER 0x0004
  138. #define IF_CS_H_IC_POWER_DOWN 0x0008
  139. #define IF_CS_H_IC_HOST_EVENT 0x0010
  140. #define IF_CS_H_IC_MASK 0x001f
  141. #define IF_CS_H_INT_MASK 0x00000004
  142. #define IF_CS_H_IM_MASK 0x001f
  143. #define IF_CS_H_WRITE_LEN 0x00000014
  144. #define IF_CS_H_WRITE 0x00000016
  145. #define IF_CS_H_CMD_LEN 0x00000018
  146. #define IF_CS_H_CMD 0x0000001A
  147. #define IF_CS_C_READ_LEN 0x00000024
  148. #define IF_CS_H_READ 0x00000010
  149. /* Card control registers and their bit definitions */
  150. #define IF_CS_C_STATUS 0x00000020
  151. #define IF_CS_C_S_TX_DNLD_RDY 0x0001
  152. #define IF_CS_C_S_RX_UPLD_RDY 0x0002
  153. #define IF_CS_C_S_CMD_DNLD_RDY 0x0004
  154. #define IF_CS_C_S_CMD_UPLD_RDY 0x0008
  155. #define IF_CS_C_S_CARDEVENT 0x0010
  156. #define IF_CS_C_S_MASK 0x001f
  157. #define IF_CS_C_S_STATUS_MASK 0x7f00
  158. #define IF_CS_C_INT_CAUSE 0x00000022
  159. #define IF_CS_C_IC_MASK 0x001f
  160. #define IF_CS_C_SQ_READ_LOW 0x00000028
  161. #define IF_CS_C_SQ_HELPER_OK 0x10
  162. #define IF_CS_C_CMD_LEN 0x00000030
  163. #define IF_CS_C_CMD 0x00000012
  164. #define IF_CS_SCRATCH 0x0000003F
  165. /********************************************************************/
  166. /* I/O */
  167. /********************************************************************/
  168. /*
  169. * Called from if_cs_host_to_card to send a command to the hardware
  170. */
  171. static int if_cs_send_cmd(struct lbs_private *priv, u8 *buf, u16 nb)
  172. {
  173. struct if_cs_card *card = (struct if_cs_card *)priv->card;
  174. int ret = -1;
  175. int loops = 0;
  176. lbs_deb_enter(LBS_DEB_CS);
  177. /* Is hardware ready? */
  178. while (1) {
  179. u16 val = if_cs_read16(card, IF_CS_C_STATUS);
  180. if (val & IF_CS_C_S_CMD_DNLD_RDY)
  181. break;
  182. if (++loops > 100) {
  183. lbs_pr_err("card not ready for commands\n");
  184. goto done;
  185. }
  186. mdelay(1);
  187. }
  188. if_cs_write16(card, IF_CS_H_CMD_LEN, nb);
  189. if_cs_write16_rep(card, IF_CS_H_CMD, buf, nb / 2);
  190. /* Are we supposed to transfer an odd amount of bytes? */
  191. if (nb & 1)
  192. if_cs_write8(card, IF_CS_H_CMD, buf[nb-1]);
  193. /* "Assert the download over interrupt command in the Host
  194. * status register" */
  195. if_cs_write16(card, IF_CS_H_STATUS, IF_CS_H_STATUS_DNLD_OVER);
  196. /* "Assert the download over interrupt command in the Card
  197. * interrupt case register" */
  198. if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_DNLD_OVER);
  199. ret = 0;
  200. done:
  201. lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
  202. return ret;
  203. }
  204. /*
  205. * Called from if_cs_host_to_card to send a data to the hardware
  206. */
  207. static void if_cs_send_data(struct lbs_private *priv, u8 *buf, u16 nb)
  208. {
  209. struct if_cs_card *card = (struct if_cs_card *)priv->card;
  210. lbs_deb_enter(LBS_DEB_CS);
  211. if_cs_write16(card, IF_CS_H_WRITE_LEN, nb);
  212. /* write even number of bytes, then odd byte if necessary */
  213. if_cs_write16_rep(card, IF_CS_H_WRITE, buf, nb / 2);
  214. if (nb & 1)
  215. if_cs_write8(card, IF_CS_H_WRITE, buf[nb-1]);
  216. if_cs_write16(card, IF_CS_H_STATUS, IF_CS_H_STATUS_TX_OVER);
  217. if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_STATUS_TX_OVER);
  218. lbs_deb_leave(LBS_DEB_CS);
  219. }
  220. /*
  221. * Get the command result out of the card.
  222. */
  223. static int if_cs_receive_cmdres(struct lbs_private *priv, u8 *data, u32 *len)
  224. {
  225. unsigned long flags;
  226. int ret = -1;
  227. u16 val;
  228. lbs_deb_enter(LBS_DEB_CS);
  229. /* is hardware ready? */
  230. val = if_cs_read16(priv->card, IF_CS_C_STATUS);
  231. if ((val & IF_CS_C_S_CMD_UPLD_RDY) == 0) {
  232. lbs_pr_err("card not ready for CMD\n");
  233. goto out;
  234. }
  235. *len = if_cs_read16(priv->card, IF_CS_C_CMD_LEN);
  236. if ((*len == 0) || (*len > LBS_CMD_BUFFER_SIZE)) {
  237. lbs_pr_err("card cmd buffer has invalid # of bytes (%d)\n", *len);
  238. goto out;
  239. }
  240. /* read even number of bytes, then odd byte if necessary */
  241. if_cs_read16_rep(priv->card, IF_CS_C_CMD, data, *len/sizeof(u16));
  242. if (*len & 1)
  243. data[*len-1] = if_cs_read8(priv->card, IF_CS_C_CMD);
  244. /* This is a workaround for a firmware that reports too much
  245. * bytes */
  246. *len -= 8;
  247. ret = 0;
  248. /* Clear this flag again */
  249. spin_lock_irqsave(&priv->driver_lock, flags);
  250. priv->dnld_sent = DNLD_RES_RECEIVED;
  251. spin_unlock_irqrestore(&priv->driver_lock, flags);
  252. out:
  253. lbs_deb_leave_args(LBS_DEB_CS, "ret %d, len %d", ret, *len);
  254. return ret;
  255. }
  256. static struct sk_buff *if_cs_receive_data(struct lbs_private *priv)
  257. {
  258. struct sk_buff *skb = NULL;
  259. u16 len;
  260. u8 *data;
  261. lbs_deb_enter(LBS_DEB_CS);
  262. len = if_cs_read16(priv->card, IF_CS_C_READ_LEN);
  263. if (len == 0 || len > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
  264. lbs_pr_err("card data buffer has invalid # of bytes (%d)\n", len);
  265. priv->stats.rx_dropped++;
  266. goto dat_err;
  267. }
  268. skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + 2);
  269. if (!skb)
  270. goto out;
  271. skb_put(skb, len);
  272. skb_reserve(skb, 2);/* 16 byte align */
  273. data = skb->data;
  274. /* read even number of bytes, then odd byte if necessary */
  275. if_cs_read16_rep(priv->card, IF_CS_H_READ, data, len/sizeof(u16));
  276. if (len & 1)
  277. data[len-1] = if_cs_read8(priv->card, IF_CS_H_READ);
  278. dat_err:
  279. if_cs_write16(priv->card, IF_CS_H_STATUS, IF_CS_H_STATUS_RX_OVER);
  280. if_cs_write16(priv->card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_RX_OVER);
  281. out:
  282. lbs_deb_leave_args(LBS_DEB_CS, "ret %p", skb);
  283. return skb;
  284. }
  285. /********************************************************************/
  286. /* Interrupts */
  287. /********************************************************************/
  288. static inline void if_cs_enable_ints(struct if_cs_card *card)
  289. {
  290. lbs_deb_enter(LBS_DEB_CS);
  291. if_cs_write16(card, IF_CS_H_INT_MASK, 0);
  292. }
  293. static inline void if_cs_disable_ints(struct if_cs_card *card)
  294. {
  295. lbs_deb_enter(LBS_DEB_CS);
  296. if_cs_write16(card, IF_CS_H_INT_MASK, IF_CS_H_IM_MASK);
  297. }
  298. static irqreturn_t if_cs_interrupt(int irq, void *data)
  299. {
  300. struct if_cs_card *card = data;
  301. struct lbs_private *priv = card->priv;
  302. u16 cause;
  303. lbs_deb_enter(LBS_DEB_CS);
  304. cause = if_cs_read16(card, IF_CS_C_INT_CAUSE);
  305. if_cs_write16(card, IF_CS_C_INT_CAUSE, cause & IF_CS_C_IC_MASK);
  306. lbs_deb_cs("cause 0x%04x\n", cause);
  307. if (cause == 0) {
  308. /* Not for us */
  309. return IRQ_NONE;
  310. }
  311. if (cause == 0xffff) {
  312. /* Read in junk, the card has probably been removed */
  313. card->priv->surpriseremoved = 1;
  314. return IRQ_HANDLED;
  315. }
  316. /* TODO: I'm not sure what the best ordering is */
  317. cause = if_cs_read16(card, IF_CS_C_STATUS) & IF_CS_C_S_MASK;
  318. if (cause & IF_CS_C_S_RX_UPLD_RDY) {
  319. struct sk_buff *skb;
  320. lbs_deb_cs("rx packet\n");
  321. skb = if_cs_receive_data(priv);
  322. if (skb)
  323. lbs_process_rxed_packet(priv, skb);
  324. }
  325. if (cause & IF_CS_H_IC_TX_OVER) {
  326. lbs_deb_cs("tx over\n");
  327. lbs_host_to_card_done(priv);
  328. }
  329. if (cause & IF_CS_C_S_CMD_UPLD_RDY) {
  330. unsigned long flags;
  331. u8 i;
  332. lbs_deb_cs("cmd upload ready\n");
  333. spin_lock_irqsave(&priv->driver_lock, flags);
  334. i = (priv->resp_idx == 0) ? 1 : 0;
  335. spin_unlock_irqrestore(&priv->driver_lock, flags);
  336. BUG_ON(priv->resp_len[i]);
  337. if_cs_receive_cmdres(priv, priv->resp_buf[i],
  338. &priv->resp_len[i]);
  339. spin_lock_irqsave(&priv->driver_lock, flags);
  340. lbs_notify_command_response(priv, i);
  341. spin_unlock_irqrestore(&priv->driver_lock, flags);
  342. }
  343. if (cause & IF_CS_H_IC_HOST_EVENT) {
  344. u16 event = if_cs_read16(priv->card, IF_CS_C_STATUS)
  345. & IF_CS_C_S_STATUS_MASK;
  346. if_cs_write16(priv->card, IF_CS_H_INT_CAUSE,
  347. IF_CS_H_IC_HOST_EVENT);
  348. lbs_deb_cs("eventcause 0x%04x\n", event);
  349. lbs_queue_event(priv, event >> 8 & 0xff);
  350. }
  351. return IRQ_HANDLED;
  352. }
  353. /********************************************************************/
  354. /* Firmware */
  355. /********************************************************************/
  356. /*
  357. * Tries to program the helper firmware.
  358. *
  359. * Return 0 on success
  360. */
  361. static int if_cs_prog_helper(struct if_cs_card *card)
  362. {
  363. int ret = 0;
  364. int sent = 0;
  365. u8 scratch;
  366. const struct firmware *fw;
  367. lbs_deb_enter(LBS_DEB_CS);
  368. scratch = if_cs_read8(card, IF_CS_SCRATCH);
  369. /* "If the value is 0x5a, the firmware is already
  370. * downloaded successfully"
  371. */
  372. if (scratch == 0x5a)
  373. goto done;
  374. /* "If the value is != 00, it is invalid value of register */
  375. if (scratch != 0x00) {
  376. ret = -ENODEV;
  377. goto done;
  378. }
  379. /* TODO: make firmware file configurable */
  380. ret = request_firmware(&fw, "libertas_cs_helper.fw",
  381. &handle_to_dev(card->p_dev));
  382. if (ret) {
  383. lbs_pr_err("can't load helper firmware\n");
  384. ret = -ENODEV;
  385. goto done;
  386. }
  387. lbs_deb_cs("helper size %td\n", fw->size);
  388. /* "Set the 5 bytes of the helper image to 0" */
  389. /* Not needed, this contains an ARM branch instruction */
  390. for (;;) {
  391. /* "the number of bytes to send is 256" */
  392. int count = 256;
  393. int remain = fw->size - sent;
  394. if (remain < count)
  395. count = remain;
  396. /* "write the number of bytes to be sent to the I/O Command
  397. * write length register" */
  398. if_cs_write16(card, IF_CS_H_CMD_LEN, count);
  399. /* "write this to I/O Command port register as 16 bit writes */
  400. if (count)
  401. if_cs_write16_rep(card, IF_CS_H_CMD,
  402. &fw->data[sent],
  403. count >> 1);
  404. /* "Assert the download over interrupt command in the Host
  405. * status register" */
  406. if_cs_write8(card, IF_CS_H_STATUS, IF_CS_H_STATUS_DNLD_OVER);
  407. /* "Assert the download over interrupt command in the Card
  408. * interrupt case register" */
  409. if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_DNLD_OVER);
  410. /* "The host polls the Card Status register ... for 50 ms before
  411. declaring a failure */
  412. ret = if_cs_poll_while_fw_download(card, IF_CS_C_STATUS,
  413. IF_CS_C_S_CMD_DNLD_RDY);
  414. if (ret < 0) {
  415. lbs_pr_err("can't download helper at 0x%x, ret %d\n",
  416. sent, ret);
  417. goto done;
  418. }
  419. if (count == 0)
  420. break;
  421. sent += count;
  422. }
  423. release_firmware(fw);
  424. ret = 0;
  425. done:
  426. lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
  427. return ret;
  428. }
  429. static int if_cs_prog_real(struct if_cs_card *card)
  430. {
  431. const struct firmware *fw;
  432. int ret = 0;
  433. int retry = 0;
  434. int len = 0;
  435. int sent;
  436. lbs_deb_enter(LBS_DEB_CS);
  437. /* TODO: make firmware file configurable */
  438. ret = request_firmware(&fw, "libertas_cs.fw",
  439. &handle_to_dev(card->p_dev));
  440. if (ret) {
  441. lbs_pr_err("can't load firmware\n");
  442. ret = -ENODEV;
  443. goto done;
  444. }
  445. lbs_deb_cs("fw size %td\n", fw->size);
  446. ret = if_cs_poll_while_fw_download(card, IF_CS_C_SQ_READ_LOW, IF_CS_C_SQ_HELPER_OK);
  447. if (ret < 0) {
  448. lbs_pr_err("helper firmware doesn't answer\n");
  449. goto err_release;
  450. }
  451. for (sent = 0; sent < fw->size; sent += len) {
  452. len = if_cs_read16(card, IF_CS_C_SQ_READ_LOW);
  453. if (len & 1) {
  454. retry++;
  455. lbs_pr_info("odd, need to retry this firmware block\n");
  456. } else {
  457. retry = 0;
  458. }
  459. if (retry > 20) {
  460. lbs_pr_err("could not download firmware\n");
  461. ret = -ENODEV;
  462. goto err_release;
  463. }
  464. if (retry) {
  465. sent -= len;
  466. }
  467. if_cs_write16(card, IF_CS_H_CMD_LEN, len);
  468. if_cs_write16_rep(card, IF_CS_H_CMD,
  469. &fw->data[sent],
  470. (len+1) >> 1);
  471. if_cs_write8(card, IF_CS_H_STATUS, IF_CS_H_STATUS_DNLD_OVER);
  472. if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_DNLD_OVER);
  473. ret = if_cs_poll_while_fw_download(card, IF_CS_C_STATUS,
  474. IF_CS_C_S_CMD_DNLD_RDY);
  475. if (ret < 0) {
  476. lbs_pr_err("can't download firmware at 0x%x\n", sent);
  477. goto err_release;
  478. }
  479. }
  480. ret = if_cs_poll_while_fw_download(card, IF_CS_SCRATCH, 0x5a);
  481. if (ret < 0) {
  482. lbs_pr_err("firmware download failed\n");
  483. goto err_release;
  484. }
  485. ret = 0;
  486. goto done;
  487. err_release:
  488. release_firmware(fw);
  489. done:
  490. lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
  491. return ret;
  492. }
  493. /********************************************************************/
  494. /* Callback functions for libertas.ko */
  495. /********************************************************************/
  496. /* Send commands or data packets to the card */
  497. static int if_cs_host_to_card(struct lbs_private *priv,
  498. u8 type,
  499. u8 *buf,
  500. u16 nb)
  501. {
  502. int ret = -1;
  503. lbs_deb_enter_args(LBS_DEB_CS, "type %d, bytes %d", type, nb);
  504. switch (type) {
  505. case MVMS_DAT:
  506. priv->dnld_sent = DNLD_DATA_SENT;
  507. if_cs_send_data(priv, buf, nb);
  508. ret = 0;
  509. break;
  510. case MVMS_CMD:
  511. priv->dnld_sent = DNLD_CMD_SENT;
  512. ret = if_cs_send_cmd(priv, buf, nb);
  513. break;
  514. default:
  515. lbs_pr_err("%s: unsupported type %d\n", __FUNCTION__, type);
  516. }
  517. lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
  518. return ret;
  519. }
  520. /********************************************************************/
  521. /* Card Services */
  522. /********************************************************************/
  523. /*
  524. * After a card is removed, if_cs_release() will unregister the
  525. * device, and release the PCMCIA configuration. If the device is
  526. * still open, this will be postponed until it is closed.
  527. */
  528. static void if_cs_release(struct pcmcia_device *p_dev)
  529. {
  530. struct if_cs_card *card = p_dev->priv;
  531. lbs_deb_enter(LBS_DEB_CS);
  532. free_irq(p_dev->irq.AssignedIRQ, card);
  533. pcmcia_disable_device(p_dev);
  534. if (card->iobase)
  535. ioport_unmap(card->iobase);
  536. lbs_deb_leave(LBS_DEB_CS);
  537. }
  538. /*
  539. * This creates an "instance" of the driver, allocating local data
  540. * structures for one device. The device is registered with Card
  541. * Services.
  542. *
  543. * The dev_link structure is initialized, but we don't actually
  544. * configure the card at this point -- we wait until we receive a card
  545. * insertion event.
  546. */
  547. static int if_cs_probe(struct pcmcia_device *p_dev)
  548. {
  549. int ret = -ENOMEM;
  550. struct lbs_private *priv;
  551. struct if_cs_card *card;
  552. /* CIS parsing */
  553. tuple_t tuple;
  554. cisparse_t parse;
  555. cistpl_cftable_entry_t *cfg = &parse.cftable_entry;
  556. cistpl_io_t *io = &cfg->io;
  557. u_char buf[64];
  558. lbs_deb_enter(LBS_DEB_CS);
  559. card = kzalloc(sizeof(struct if_cs_card), GFP_KERNEL);
  560. if (!card) {
  561. lbs_pr_err("error in kzalloc\n");
  562. goto out;
  563. }
  564. card->p_dev = p_dev;
  565. p_dev->priv = card;
  566. p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
  567. p_dev->irq.Handler = NULL;
  568. p_dev->irq.IRQInfo1 = IRQ_INFO2_VALID | IRQ_LEVEL_ID;
  569. p_dev->conf.Attributes = 0;
  570. p_dev->conf.IntType = INT_MEMORY_AND_IO;
  571. tuple.Attributes = 0;
  572. tuple.TupleData = buf;
  573. tuple.TupleDataMax = sizeof(buf);
  574. tuple.TupleOffset = 0;
  575. tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
  576. if ((ret = pcmcia_get_first_tuple(p_dev, &tuple)) != 0 ||
  577. (ret = pcmcia_get_tuple_data(p_dev, &tuple)) != 0 ||
  578. (ret = pcmcia_parse_tuple(p_dev, &tuple, &parse)) != 0)
  579. {
  580. lbs_pr_err("error in pcmcia_get_first_tuple etc\n");
  581. goto out1;
  582. }
  583. p_dev->conf.ConfigIndex = cfg->index;
  584. /* Do we need to allocate an interrupt? */
  585. if (cfg->irq.IRQInfo1) {
  586. p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
  587. }
  588. /* IO window settings */
  589. if (cfg->io.nwin != 1) {
  590. lbs_pr_err("wrong CIS (check number of IO windows)\n");
  591. ret = -ENODEV;
  592. goto out1;
  593. }
  594. p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
  595. p_dev->io.BasePort1 = io->win[0].base;
  596. p_dev->io.NumPorts1 = io->win[0].len;
  597. /* This reserves IO space but doesn't actually enable it */
  598. ret = pcmcia_request_io(p_dev, &p_dev->io);
  599. if (ret) {
  600. lbs_pr_err("error in pcmcia_request_io\n");
  601. goto out1;
  602. }
  603. /*
  604. * Allocate an interrupt line. Note that this does not assign
  605. * a handler to the interrupt, unless the 'Handler' member of
  606. * the irq structure is initialized.
  607. */
  608. if (p_dev->conf.Attributes & CONF_ENABLE_IRQ) {
  609. ret = pcmcia_request_irq(p_dev, &p_dev->irq);
  610. if (ret) {
  611. lbs_pr_err("error in pcmcia_request_irq\n");
  612. goto out1;
  613. }
  614. }
  615. /* Initialize io access */
  616. card->iobase = ioport_map(p_dev->io.BasePort1, p_dev->io.NumPorts1);
  617. if (!card->iobase) {
  618. lbs_pr_err("error in ioport_map\n");
  619. ret = -EIO;
  620. goto out1;
  621. }
  622. /*
  623. * This actually configures the PCMCIA socket -- setting up
  624. * the I/O windows and the interrupt mapping, and putting the
  625. * card and host interface into "Memory and IO" mode.
  626. */
  627. ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
  628. if (ret) {
  629. lbs_pr_err("error in pcmcia_request_configuration\n");
  630. goto out2;
  631. }
  632. /* Finally, report what we've done */
  633. lbs_deb_cs("irq %d, io 0x%04x-0x%04x\n",
  634. p_dev->irq.AssignedIRQ, p_dev->io.BasePort1,
  635. p_dev->io.BasePort1 + p_dev->io.NumPorts1 - 1);
  636. /* Load the firmware early, before calling into libertas.ko */
  637. ret = if_cs_prog_helper(card);
  638. if (ret == 0)
  639. ret = if_cs_prog_real(card);
  640. if (ret)
  641. goto out2;
  642. /* Make this card known to the libertas driver */
  643. priv = lbs_add_card(card, &p_dev->dev);
  644. if (!priv) {
  645. ret = -ENOMEM;
  646. goto out2;
  647. }
  648. /* Finish setting up fields in lbs_private */
  649. card->priv = priv;
  650. priv->card = card;
  651. priv->hw_host_to_card = if_cs_host_to_card;
  652. priv->fw_ready = 1;
  653. /* Now actually get the IRQ */
  654. ret = request_irq(p_dev->irq.AssignedIRQ, if_cs_interrupt,
  655. IRQF_SHARED, DRV_NAME, card);
  656. if (ret) {
  657. lbs_pr_err("error in request_irq\n");
  658. goto out3;
  659. }
  660. /* Clear any interrupt cause that happend while sending
  661. * firmware/initializing card */
  662. if_cs_write16(card, IF_CS_C_INT_CAUSE, IF_CS_C_IC_MASK);
  663. if_cs_enable_ints(card);
  664. /* And finally bring the card up */
  665. if (lbs_start_card(priv) != 0) {
  666. lbs_pr_err("could not activate card\n");
  667. goto out3;
  668. }
  669. /* The firmware for the CF card supports powersave */
  670. priv->ps_supported = 1;
  671. ret = 0;
  672. goto out;
  673. out3:
  674. lbs_remove_card(priv);
  675. out2:
  676. ioport_unmap(card->iobase);
  677. out1:
  678. pcmcia_disable_device(p_dev);
  679. out:
  680. lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
  681. return ret;
  682. }
  683. /*
  684. * This deletes a driver "instance". The device is de-registered with
  685. * Card Services. If it has been released, all local data structures
  686. * are freed. Otherwise, the structures will be freed when the device
  687. * is released.
  688. */
  689. static void if_cs_detach(struct pcmcia_device *p_dev)
  690. {
  691. struct if_cs_card *card = p_dev->priv;
  692. lbs_deb_enter(LBS_DEB_CS);
  693. lbs_stop_card(card->priv);
  694. lbs_remove_card(card->priv);
  695. if_cs_disable_ints(card);
  696. if_cs_release(p_dev);
  697. kfree(card);
  698. lbs_deb_leave(LBS_DEB_CS);
  699. }
  700. /********************************************************************/
  701. /* Module initialization */
  702. /********************************************************************/
  703. static struct pcmcia_device_id if_cs_ids[] = {
  704. PCMCIA_DEVICE_MANF_CARD(0x02df, 0x8103),
  705. PCMCIA_DEVICE_NULL,
  706. };
  707. MODULE_DEVICE_TABLE(pcmcia, if_cs_ids);
  708. static struct pcmcia_driver lbs_driver = {
  709. .owner = THIS_MODULE,
  710. .drv = {
  711. .name = DRV_NAME,
  712. },
  713. .probe = if_cs_probe,
  714. .remove = if_cs_detach,
  715. .id_table = if_cs_ids,
  716. };
  717. static int __init if_cs_init(void)
  718. {
  719. int ret;
  720. lbs_deb_enter(LBS_DEB_CS);
  721. ret = pcmcia_register_driver(&lbs_driver);
  722. lbs_deb_leave(LBS_DEB_CS);
  723. return ret;
  724. }
  725. static void __exit if_cs_exit(void)
  726. {
  727. lbs_deb_enter(LBS_DEB_CS);
  728. pcmcia_unregister_driver(&lbs_driver);
  729. lbs_deb_leave(LBS_DEB_CS);
  730. }
  731. module_init(if_cs_init);
  732. module_exit(if_cs_exit);