btmrvl_sdio.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185
  1. /**
  2. * Marvell BT-over-SDIO driver: SDIO interface related functions.
  3. *
  4. * Copyright (C) 2009, Marvell International Ltd.
  5. *
  6. * This software file (the "File") is distributed by Marvell International
  7. * Ltd. under the terms of the GNU General Public License Version 2, June 1991
  8. * (the "License"). You may use, redistribute and/or modify this File in
  9. * accordance with the terms and conditions of the License, a copy of which
  10. * is available by writing to the Free Software Foundation, Inc.,
  11. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
  12. * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
  13. *
  14. *
  15. * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
  16. * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
  17. * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
  18. * this warranty disclaimer.
  19. **/
  20. #include <linux/firmware.h>
  21. #include <linux/slab.h>
  22. #include <linux/mmc/sdio_ids.h>
  23. #include <linux/mmc/sdio_func.h>
  24. #include <linux/module.h>
  25. #include <net/bluetooth/bluetooth.h>
  26. #include <net/bluetooth/hci_core.h>
  27. #include "btmrvl_drv.h"
  28. #include "btmrvl_sdio.h"
  29. #define VERSION "1.0"
  30. /* The btmrvl_sdio_remove() callback function is called
  31. * when user removes this module from kernel space or ejects
  32. * the card from the slot. The driver handles these 2 cases
  33. * differently.
  34. * If the user is removing the module, a MODULE_SHUTDOWN_REQ
  35. * command is sent to firmware and interrupt will be disabled.
  36. * If the card is removed, there is no need to send command
  37. * or disable interrupt.
  38. *
  39. * The variable 'user_rmmod' is used to distinguish these two
  40. * scenarios. This flag is initialized as FALSE in case the card
  41. * is removed, and will be set to TRUE for module removal when
  42. * module_exit function is called.
  43. */
  44. static u8 user_rmmod;
  45. static u8 sdio_ireg;
  46. static const struct btmrvl_sdio_card_reg btmrvl_reg_8688 = {
  47. .cfg = 0x03,
  48. .host_int_mask = 0x04,
  49. .host_intstatus = 0x05,
  50. .card_status = 0x20,
  51. .sq_read_base_addr_a0 = 0x10,
  52. .sq_read_base_addr_a1 = 0x11,
  53. .card_fw_status0 = 0x40,
  54. .card_fw_status1 = 0x41,
  55. .card_rx_len = 0x42,
  56. .card_rx_unit = 0x43,
  57. .io_port_0 = 0x00,
  58. .io_port_1 = 0x01,
  59. .io_port_2 = 0x02,
  60. };
  61. static const struct btmrvl_sdio_card_reg btmrvl_reg_87xx = {
  62. .cfg = 0x00,
  63. .host_int_mask = 0x02,
  64. .host_intstatus = 0x03,
  65. .card_status = 0x30,
  66. .sq_read_base_addr_a0 = 0x40,
  67. .sq_read_base_addr_a1 = 0x41,
  68. .card_revision = 0x5c,
  69. .card_fw_status0 = 0x60,
  70. .card_fw_status1 = 0x61,
  71. .card_rx_len = 0x62,
  72. .card_rx_unit = 0x63,
  73. .io_port_0 = 0x78,
  74. .io_port_1 = 0x79,
  75. .io_port_2 = 0x7a,
  76. };
  77. static const struct btmrvl_sdio_device btmrvl_sdio_sd8688 = {
  78. .helper = "sd8688_helper.bin",
  79. .firmware = "sd8688.bin",
  80. .reg = &btmrvl_reg_8688,
  81. .sd_blksz_fw_dl = 64,
  82. };
  83. static const struct btmrvl_sdio_device btmrvl_sdio_sd8787 = {
  84. .helper = NULL,
  85. .firmware = "mrvl/sd8787_uapsta.bin",
  86. .reg = &btmrvl_reg_87xx,
  87. .sd_blksz_fw_dl = 256,
  88. };
  89. static const struct btmrvl_sdio_device btmrvl_sdio_sd8797 = {
  90. .helper = NULL,
  91. .firmware = "mrvl/sd8797_uapsta.bin",
  92. .reg = &btmrvl_reg_87xx,
  93. .sd_blksz_fw_dl = 256,
  94. };
  95. static const struct sdio_device_id btmrvl_sdio_ids[] = {
  96. /* Marvell SD8688 Bluetooth device */
  97. { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x9105),
  98. .driver_data = (unsigned long) &btmrvl_sdio_sd8688 },
  99. /* Marvell SD8787 Bluetooth device */
  100. { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x911A),
  101. .driver_data = (unsigned long) &btmrvl_sdio_sd8787 },
  102. /* Marvell SD8787 Bluetooth AMP device */
  103. { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x911B),
  104. .driver_data = (unsigned long) &btmrvl_sdio_sd8787 },
  105. /* Marvell SD8797 Bluetooth device */
  106. { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL, 0x912A),
  107. .driver_data = (unsigned long) &btmrvl_sdio_sd8797 },
  108. { } /* Terminating entry */
  109. };
  110. MODULE_DEVICE_TABLE(sdio, btmrvl_sdio_ids);
  111. static int btmrvl_sdio_get_rx_unit(struct btmrvl_sdio_card *card)
  112. {
  113. u8 reg;
  114. int ret;
  115. reg = sdio_readb(card->func, card->reg->card_rx_unit, &ret);
  116. if (!ret)
  117. card->rx_unit = reg;
  118. return ret;
  119. }
  120. static int btmrvl_sdio_read_fw_status(struct btmrvl_sdio_card *card, u16 *dat)
  121. {
  122. u8 fws0, fws1;
  123. int ret;
  124. *dat = 0;
  125. fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
  126. if (ret)
  127. return -EIO;
  128. fws1 = sdio_readb(card->func, card->reg->card_fw_status1, &ret);
  129. if (ret)
  130. return -EIO;
  131. *dat = (((u16) fws1) << 8) | fws0;
  132. return 0;
  133. }
  134. static int btmrvl_sdio_read_rx_len(struct btmrvl_sdio_card *card, u16 *dat)
  135. {
  136. u8 reg;
  137. int ret;
  138. reg = sdio_readb(card->func, card->reg->card_rx_len, &ret);
  139. if (!ret)
  140. *dat = (u16) reg << card->rx_unit;
  141. return ret;
  142. }
  143. static int btmrvl_sdio_enable_host_int_mask(struct btmrvl_sdio_card *card,
  144. u8 mask)
  145. {
  146. int ret;
  147. sdio_writeb(card->func, mask, card->reg->host_int_mask, &ret);
  148. if (ret) {
  149. BT_ERR("Unable to enable the host interrupt!");
  150. ret = -EIO;
  151. }
  152. return ret;
  153. }
  154. static int btmrvl_sdio_disable_host_int_mask(struct btmrvl_sdio_card *card,
  155. u8 mask)
  156. {
  157. u8 host_int_mask;
  158. int ret;
  159. host_int_mask = sdio_readb(card->func, card->reg->host_int_mask, &ret);
  160. if (ret)
  161. return -EIO;
  162. host_int_mask &= ~mask;
  163. sdio_writeb(card->func, host_int_mask, card->reg->host_int_mask, &ret);
  164. if (ret < 0) {
  165. BT_ERR("Unable to disable the host interrupt!");
  166. return -EIO;
  167. }
  168. return 0;
  169. }
  170. static int btmrvl_sdio_poll_card_status(struct btmrvl_sdio_card *card, u8 bits)
  171. {
  172. unsigned int tries;
  173. u8 status;
  174. int ret;
  175. for (tries = 0; tries < MAX_POLL_TRIES * 1000; tries++) {
  176. status = sdio_readb(card->func, card->reg->card_status, &ret);
  177. if (ret)
  178. goto failed;
  179. if ((status & bits) == bits)
  180. return ret;
  181. udelay(1);
  182. }
  183. ret = -ETIMEDOUT;
  184. failed:
  185. BT_ERR("FAILED! ret=%d", ret);
  186. return ret;
  187. }
  188. static int btmrvl_sdio_verify_fw_download(struct btmrvl_sdio_card *card,
  189. int pollnum)
  190. {
  191. int ret = -ETIMEDOUT;
  192. u16 firmwarestat;
  193. unsigned int tries;
  194. /* Wait for firmware to become ready */
  195. for (tries = 0; tries < pollnum; tries++) {
  196. if (btmrvl_sdio_read_fw_status(card, &firmwarestat) < 0)
  197. continue;
  198. if (firmwarestat == FIRMWARE_READY) {
  199. ret = 0;
  200. break;
  201. } else {
  202. msleep(10);
  203. }
  204. }
  205. return ret;
  206. }
  207. static int btmrvl_sdio_download_helper(struct btmrvl_sdio_card *card)
  208. {
  209. const struct firmware *fw_helper = NULL;
  210. const u8 *helper = NULL;
  211. int ret;
  212. void *tmphlprbuf = NULL;
  213. int tmphlprbufsz, hlprblknow, helperlen;
  214. u8 *helperbuf;
  215. u32 tx_len;
  216. ret = request_firmware(&fw_helper, card->helper,
  217. &card->func->dev);
  218. if ((ret < 0) || !fw_helper) {
  219. BT_ERR("request_firmware(helper) failed, error code = %d",
  220. ret);
  221. ret = -ENOENT;
  222. goto done;
  223. }
  224. helper = fw_helper->data;
  225. helperlen = fw_helper->size;
  226. BT_DBG("Downloading helper image (%d bytes), block size %d bytes",
  227. helperlen, SDIO_BLOCK_SIZE);
  228. tmphlprbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
  229. tmphlprbuf = kzalloc(tmphlprbufsz, GFP_KERNEL);
  230. if (!tmphlprbuf) {
  231. BT_ERR("Unable to allocate buffer for helper."
  232. " Terminating download");
  233. ret = -ENOMEM;
  234. goto done;
  235. }
  236. helperbuf = (u8 *) ALIGN_ADDR(tmphlprbuf, BTSDIO_DMA_ALIGN);
  237. /* Perform helper data transfer */
  238. tx_len = (FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE)
  239. - SDIO_HEADER_LEN;
  240. hlprblknow = 0;
  241. do {
  242. ret = btmrvl_sdio_poll_card_status(card,
  243. CARD_IO_READY | DN_LD_CARD_RDY);
  244. if (ret < 0) {
  245. BT_ERR("Helper download poll status timeout @ %d",
  246. hlprblknow);
  247. goto done;
  248. }
  249. /* Check if there is more data? */
  250. if (hlprblknow >= helperlen)
  251. break;
  252. if (helperlen - hlprblknow < tx_len)
  253. tx_len = helperlen - hlprblknow;
  254. /* Little-endian */
  255. helperbuf[0] = ((tx_len & 0x000000ff) >> 0);
  256. helperbuf[1] = ((tx_len & 0x0000ff00) >> 8);
  257. helperbuf[2] = ((tx_len & 0x00ff0000) >> 16);
  258. helperbuf[3] = ((tx_len & 0xff000000) >> 24);
  259. memcpy(&helperbuf[SDIO_HEADER_LEN], &helper[hlprblknow],
  260. tx_len);
  261. /* Now send the data */
  262. ret = sdio_writesb(card->func, card->ioport, helperbuf,
  263. FIRMWARE_TRANSFER_NBLOCK * SDIO_BLOCK_SIZE);
  264. if (ret < 0) {
  265. BT_ERR("IO error during helper download @ %d",
  266. hlprblknow);
  267. goto done;
  268. }
  269. hlprblknow += tx_len;
  270. } while (true);
  271. BT_DBG("Transferring helper image EOF block");
  272. memset(helperbuf, 0x0, SDIO_BLOCK_SIZE);
  273. ret = sdio_writesb(card->func, card->ioport, helperbuf,
  274. SDIO_BLOCK_SIZE);
  275. if (ret < 0) {
  276. BT_ERR("IO error in writing helper image EOF block");
  277. goto done;
  278. }
  279. ret = 0;
  280. done:
  281. kfree(tmphlprbuf);
  282. release_firmware(fw_helper);
  283. return ret;
  284. }
  285. static int btmrvl_sdio_download_fw_w_helper(struct btmrvl_sdio_card *card)
  286. {
  287. const struct firmware *fw_firmware = NULL;
  288. const u8 *firmware = NULL;
  289. int firmwarelen, tmpfwbufsz, ret;
  290. unsigned int tries, offset;
  291. u8 base0, base1;
  292. void *tmpfwbuf = NULL;
  293. u8 *fwbuf;
  294. u16 len, blksz_dl = card->sd_blksz_fw_dl;
  295. int txlen = 0, tx_blocks = 0, count = 0;
  296. ret = request_firmware(&fw_firmware, card->firmware,
  297. &card->func->dev);
  298. if ((ret < 0) || !fw_firmware) {
  299. BT_ERR("request_firmware(firmware) failed, error code = %d",
  300. ret);
  301. ret = -ENOENT;
  302. goto done;
  303. }
  304. firmware = fw_firmware->data;
  305. firmwarelen = fw_firmware->size;
  306. BT_DBG("Downloading FW image (%d bytes)", firmwarelen);
  307. tmpfwbufsz = ALIGN_SZ(BTM_UPLD_SIZE, BTSDIO_DMA_ALIGN);
  308. tmpfwbuf = kzalloc(tmpfwbufsz, GFP_KERNEL);
  309. if (!tmpfwbuf) {
  310. BT_ERR("Unable to allocate buffer for firmware."
  311. " Terminating download");
  312. ret = -ENOMEM;
  313. goto done;
  314. }
  315. /* Ensure aligned firmware buffer */
  316. fwbuf = (u8 *) ALIGN_ADDR(tmpfwbuf, BTSDIO_DMA_ALIGN);
  317. /* Perform firmware data transfer */
  318. offset = 0;
  319. do {
  320. ret = btmrvl_sdio_poll_card_status(card,
  321. CARD_IO_READY | DN_LD_CARD_RDY);
  322. if (ret < 0) {
  323. BT_ERR("FW download with helper poll status"
  324. " timeout @ %d", offset);
  325. goto done;
  326. }
  327. /* Check if there is more data ? */
  328. if (offset >= firmwarelen)
  329. break;
  330. for (tries = 0; tries < MAX_POLL_TRIES; tries++) {
  331. base0 = sdio_readb(card->func,
  332. card->reg->sq_read_base_addr_a0, &ret);
  333. if (ret) {
  334. BT_ERR("BASE0 register read failed:"
  335. " base0 = 0x%04X(%d)."
  336. " Terminating download",
  337. base0, base0);
  338. ret = -EIO;
  339. goto done;
  340. }
  341. base1 = sdio_readb(card->func,
  342. card->reg->sq_read_base_addr_a1, &ret);
  343. if (ret) {
  344. BT_ERR("BASE1 register read failed:"
  345. " base1 = 0x%04X(%d)."
  346. " Terminating download",
  347. base1, base1);
  348. ret = -EIO;
  349. goto done;
  350. }
  351. len = (((u16) base1) << 8) | base0;
  352. if (len)
  353. break;
  354. udelay(10);
  355. }
  356. if (!len)
  357. break;
  358. else if (len > BTM_UPLD_SIZE) {
  359. BT_ERR("FW download failure @%d, invalid length %d",
  360. offset, len);
  361. ret = -EINVAL;
  362. goto done;
  363. }
  364. txlen = len;
  365. if (len & BIT(0)) {
  366. count++;
  367. if (count > MAX_WRITE_IOMEM_RETRY) {
  368. BT_ERR("FW download failure @%d, "
  369. "over max retry count", offset);
  370. ret = -EIO;
  371. goto done;
  372. }
  373. BT_ERR("FW CRC error indicated by the helper: "
  374. "len = 0x%04X, txlen = %d", len, txlen);
  375. len &= ~BIT(0);
  376. /* Set txlen to 0 so as to resend from same offset */
  377. txlen = 0;
  378. } else {
  379. count = 0;
  380. /* Last block ? */
  381. if (firmwarelen - offset < txlen)
  382. txlen = firmwarelen - offset;
  383. tx_blocks = (txlen + blksz_dl - 1) / blksz_dl;
  384. memcpy(fwbuf, &firmware[offset], txlen);
  385. }
  386. ret = sdio_writesb(card->func, card->ioport, fwbuf,
  387. tx_blocks * blksz_dl);
  388. if (ret < 0) {
  389. BT_ERR("FW download, writesb(%d) failed @%d",
  390. count, offset);
  391. sdio_writeb(card->func, HOST_CMD53_FIN,
  392. card->reg->cfg, &ret);
  393. if (ret)
  394. BT_ERR("writeb failed (CFG)");
  395. }
  396. offset += txlen;
  397. } while (true);
  398. BT_DBG("FW download over, size %d bytes", offset);
  399. ret = 0;
  400. done:
  401. kfree(tmpfwbuf);
  402. release_firmware(fw_firmware);
  403. return ret;
  404. }
  405. static int btmrvl_sdio_card_to_host(struct btmrvl_private *priv)
  406. {
  407. u16 buf_len = 0;
  408. int ret, buf_block_len, blksz;
  409. struct sk_buff *skb = NULL;
  410. u32 type;
  411. u8 *payload = NULL;
  412. struct hci_dev *hdev = priv->btmrvl_dev.hcidev;
  413. struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
  414. if (!card || !card->func) {
  415. BT_ERR("card or function is NULL!");
  416. ret = -EINVAL;
  417. goto exit;
  418. }
  419. /* Read the length of data to be transferred */
  420. ret = btmrvl_sdio_read_rx_len(card, &buf_len);
  421. if (ret < 0) {
  422. BT_ERR("read rx_len failed");
  423. ret = -EIO;
  424. goto exit;
  425. }
  426. blksz = SDIO_BLOCK_SIZE;
  427. buf_block_len = (buf_len + blksz - 1) / blksz;
  428. if (buf_len <= SDIO_HEADER_LEN
  429. || (buf_block_len * blksz) > ALLOC_BUF_SIZE) {
  430. BT_ERR("invalid packet length: %d", buf_len);
  431. ret = -EINVAL;
  432. goto exit;
  433. }
  434. /* Allocate buffer */
  435. skb = bt_skb_alloc(buf_block_len * blksz + BTSDIO_DMA_ALIGN,
  436. GFP_ATOMIC);
  437. if (skb == NULL) {
  438. BT_ERR("No free skb");
  439. goto exit;
  440. }
  441. if ((unsigned long) skb->data & (BTSDIO_DMA_ALIGN - 1)) {
  442. skb_put(skb, (unsigned long) skb->data &
  443. (BTSDIO_DMA_ALIGN - 1));
  444. skb_pull(skb, (unsigned long) skb->data &
  445. (BTSDIO_DMA_ALIGN - 1));
  446. }
  447. payload = skb->data;
  448. ret = sdio_readsb(card->func, payload, card->ioport,
  449. buf_block_len * blksz);
  450. if (ret < 0) {
  451. BT_ERR("readsb failed: %d", ret);
  452. ret = -EIO;
  453. goto exit;
  454. }
  455. /* This is SDIO specific header length: byte[2][1][0], type: byte[3]
  456. * (HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor)
  457. */
  458. buf_len = payload[0];
  459. buf_len |= (u16) payload[1] << 8;
  460. type = payload[3];
  461. switch (type) {
  462. case HCI_ACLDATA_PKT:
  463. case HCI_SCODATA_PKT:
  464. case HCI_EVENT_PKT:
  465. bt_cb(skb)->pkt_type = type;
  466. skb->dev = (void *)hdev;
  467. skb_put(skb, buf_len);
  468. skb_pull(skb, SDIO_HEADER_LEN);
  469. if (type == HCI_EVENT_PKT) {
  470. if (btmrvl_check_evtpkt(priv, skb))
  471. hci_recv_frame(skb);
  472. } else {
  473. hci_recv_frame(skb);
  474. }
  475. hdev->stat.byte_rx += buf_len;
  476. break;
  477. case MRVL_VENDOR_PKT:
  478. bt_cb(skb)->pkt_type = HCI_VENDOR_PKT;
  479. skb->dev = (void *)hdev;
  480. skb_put(skb, buf_len);
  481. skb_pull(skb, SDIO_HEADER_LEN);
  482. if (btmrvl_process_event(priv, skb))
  483. hci_recv_frame(skb);
  484. hdev->stat.byte_rx += buf_len;
  485. break;
  486. default:
  487. BT_ERR("Unknown packet type:%d", type);
  488. print_hex_dump_bytes("", DUMP_PREFIX_OFFSET, payload,
  489. blksz * buf_block_len);
  490. kfree_skb(skb);
  491. skb = NULL;
  492. break;
  493. }
  494. exit:
  495. if (ret) {
  496. hdev->stat.err_rx++;
  497. kfree_skb(skb);
  498. }
  499. return ret;
  500. }
  501. static int btmrvl_sdio_process_int_status(struct btmrvl_private *priv)
  502. {
  503. ulong flags;
  504. u8 ireg;
  505. struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
  506. spin_lock_irqsave(&priv->driver_lock, flags);
  507. ireg = sdio_ireg;
  508. sdio_ireg = 0;
  509. spin_unlock_irqrestore(&priv->driver_lock, flags);
  510. sdio_claim_host(card->func);
  511. if (ireg & DN_LD_HOST_INT_STATUS) {
  512. if (priv->btmrvl_dev.tx_dnld_rdy)
  513. BT_DBG("tx_done already received: "
  514. " int_status=0x%x", ireg);
  515. else
  516. priv->btmrvl_dev.tx_dnld_rdy = true;
  517. }
  518. if (ireg & UP_LD_HOST_INT_STATUS)
  519. btmrvl_sdio_card_to_host(priv);
  520. sdio_release_host(card->func);
  521. return 0;
  522. }
  523. static void btmrvl_sdio_interrupt(struct sdio_func *func)
  524. {
  525. struct btmrvl_private *priv;
  526. struct btmrvl_sdio_card *card;
  527. ulong flags;
  528. u8 ireg = 0;
  529. int ret;
  530. card = sdio_get_drvdata(func);
  531. if (!card || !card->priv) {
  532. BT_ERR("sbi_interrupt(%p) card or priv is "
  533. "NULL, card=%p\n", func, card);
  534. return;
  535. }
  536. priv = card->priv;
  537. ireg = sdio_readb(card->func, card->reg->host_intstatus, &ret);
  538. if (ret) {
  539. BT_ERR("sdio_readb: read int status register failed");
  540. return;
  541. }
  542. if (ireg != 0) {
  543. /*
  544. * DN_LD_HOST_INT_STATUS and/or UP_LD_HOST_INT_STATUS
  545. * Clear the interrupt status register and re-enable the
  546. * interrupt.
  547. */
  548. BT_DBG("ireg = 0x%x", ireg);
  549. sdio_writeb(card->func, ~(ireg) & (DN_LD_HOST_INT_STATUS |
  550. UP_LD_HOST_INT_STATUS),
  551. card->reg->host_intstatus, &ret);
  552. if (ret) {
  553. BT_ERR("sdio_writeb: clear int status register failed");
  554. return;
  555. }
  556. }
  557. spin_lock_irqsave(&priv->driver_lock, flags);
  558. sdio_ireg |= ireg;
  559. spin_unlock_irqrestore(&priv->driver_lock, flags);
  560. btmrvl_interrupt(priv);
  561. }
  562. static int btmrvl_sdio_register_dev(struct btmrvl_sdio_card *card)
  563. {
  564. struct sdio_func *func;
  565. u8 reg;
  566. int ret = 0;
  567. if (!card || !card->func) {
  568. BT_ERR("Error: card or function is NULL!");
  569. ret = -EINVAL;
  570. goto failed;
  571. }
  572. func = card->func;
  573. sdio_claim_host(func);
  574. ret = sdio_enable_func(func);
  575. if (ret) {
  576. BT_ERR("sdio_enable_func() failed: ret=%d", ret);
  577. ret = -EIO;
  578. goto release_host;
  579. }
  580. ret = sdio_claim_irq(func, btmrvl_sdio_interrupt);
  581. if (ret) {
  582. BT_ERR("sdio_claim_irq failed: ret=%d", ret);
  583. ret = -EIO;
  584. goto disable_func;
  585. }
  586. ret = sdio_set_block_size(card->func, SDIO_BLOCK_SIZE);
  587. if (ret) {
  588. BT_ERR("cannot set SDIO block size");
  589. ret = -EIO;
  590. goto release_irq;
  591. }
  592. reg = sdio_readb(func, card->reg->io_port_0, &ret);
  593. if (ret < 0) {
  594. ret = -EIO;
  595. goto release_irq;
  596. }
  597. card->ioport = reg;
  598. reg = sdio_readb(func, card->reg->io_port_1, &ret);
  599. if (ret < 0) {
  600. ret = -EIO;
  601. goto release_irq;
  602. }
  603. card->ioport |= (reg << 8);
  604. reg = sdio_readb(func, card->reg->io_port_2, &ret);
  605. if (ret < 0) {
  606. ret = -EIO;
  607. goto release_irq;
  608. }
  609. card->ioport |= (reg << 16);
  610. BT_DBG("SDIO FUNC%d IO port: 0x%x", func->num, card->ioport);
  611. sdio_set_drvdata(func, card);
  612. sdio_release_host(func);
  613. return 0;
  614. release_irq:
  615. sdio_release_irq(func);
  616. disable_func:
  617. sdio_disable_func(func);
  618. release_host:
  619. sdio_release_host(func);
  620. failed:
  621. return ret;
  622. }
  623. static int btmrvl_sdio_unregister_dev(struct btmrvl_sdio_card *card)
  624. {
  625. if (card && card->func) {
  626. sdio_claim_host(card->func);
  627. sdio_release_irq(card->func);
  628. sdio_disable_func(card->func);
  629. sdio_release_host(card->func);
  630. sdio_set_drvdata(card->func, NULL);
  631. }
  632. return 0;
  633. }
  634. static int btmrvl_sdio_enable_host_int(struct btmrvl_sdio_card *card)
  635. {
  636. int ret;
  637. if (!card || !card->func)
  638. return -EINVAL;
  639. sdio_claim_host(card->func);
  640. ret = btmrvl_sdio_enable_host_int_mask(card, HIM_ENABLE);
  641. btmrvl_sdio_get_rx_unit(card);
  642. sdio_release_host(card->func);
  643. return ret;
  644. }
  645. static int btmrvl_sdio_disable_host_int(struct btmrvl_sdio_card *card)
  646. {
  647. int ret;
  648. if (!card || !card->func)
  649. return -EINVAL;
  650. sdio_claim_host(card->func);
  651. ret = btmrvl_sdio_disable_host_int_mask(card, HIM_DISABLE);
  652. sdio_release_host(card->func);
  653. return ret;
  654. }
  655. static int btmrvl_sdio_host_to_card(struct btmrvl_private *priv,
  656. u8 *payload, u16 nb)
  657. {
  658. struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
  659. int ret = 0;
  660. int buf_block_len;
  661. int blksz;
  662. int i = 0;
  663. u8 *buf = NULL;
  664. void *tmpbuf = NULL;
  665. int tmpbufsz;
  666. if (!card || !card->func) {
  667. BT_ERR("card or function is NULL!");
  668. return -EINVAL;
  669. }
  670. buf = payload;
  671. if ((unsigned long) payload & (BTSDIO_DMA_ALIGN - 1)) {
  672. tmpbufsz = ALIGN_SZ(nb, BTSDIO_DMA_ALIGN);
  673. tmpbuf = kzalloc(tmpbufsz, GFP_KERNEL);
  674. if (!tmpbuf)
  675. return -ENOMEM;
  676. buf = (u8 *) ALIGN_ADDR(tmpbuf, BTSDIO_DMA_ALIGN);
  677. memcpy(buf, payload, nb);
  678. }
  679. blksz = SDIO_BLOCK_SIZE;
  680. buf_block_len = (nb + blksz - 1) / blksz;
  681. sdio_claim_host(card->func);
  682. do {
  683. /* Transfer data to card */
  684. ret = sdio_writesb(card->func, card->ioport, buf,
  685. buf_block_len * blksz);
  686. if (ret < 0) {
  687. i++;
  688. BT_ERR("i=%d writesb failed: %d", i, ret);
  689. print_hex_dump_bytes("", DUMP_PREFIX_OFFSET,
  690. payload, nb);
  691. ret = -EIO;
  692. if (i > MAX_WRITE_IOMEM_RETRY)
  693. goto exit;
  694. }
  695. } while (ret);
  696. priv->btmrvl_dev.tx_dnld_rdy = false;
  697. exit:
  698. sdio_release_host(card->func);
  699. kfree(tmpbuf);
  700. return ret;
  701. }
  702. static int btmrvl_sdio_download_fw(struct btmrvl_sdio_card *card)
  703. {
  704. int ret = 0;
  705. u8 fws0;
  706. int pollnum = MAX_POLL_TRIES;
  707. if (!card || !card->func) {
  708. BT_ERR("card or function is NULL!");
  709. return -EINVAL;
  710. }
  711. sdio_claim_host(card->func);
  712. if (!btmrvl_sdio_verify_fw_download(card, 1)) {
  713. BT_DBG("Firmware already downloaded!");
  714. goto done;
  715. }
  716. /* Check if other function driver is downloading the firmware */
  717. fws0 = sdio_readb(card->func, card->reg->card_fw_status0, &ret);
  718. if (ret) {
  719. BT_ERR("Failed to read FW downloading status!");
  720. ret = -EIO;
  721. goto done;
  722. }
  723. if (fws0) {
  724. BT_DBG("BT not the winner (%#x). Skip FW downloading", fws0);
  725. /* Give other function more time to download the firmware */
  726. pollnum *= 10;
  727. } else {
  728. if (card->helper) {
  729. ret = btmrvl_sdio_download_helper(card);
  730. if (ret) {
  731. BT_ERR("Failed to download helper!");
  732. ret = -EIO;
  733. goto done;
  734. }
  735. }
  736. if (btmrvl_sdio_download_fw_w_helper(card)) {
  737. BT_ERR("Failed to download firmware!");
  738. ret = -EIO;
  739. goto done;
  740. }
  741. }
  742. if (btmrvl_sdio_verify_fw_download(card, pollnum)) {
  743. BT_ERR("FW failed to be active in time!");
  744. ret = -ETIMEDOUT;
  745. goto done;
  746. }
  747. done:
  748. sdio_release_host(card->func);
  749. return ret;
  750. }
  751. static int btmrvl_sdio_wakeup_fw(struct btmrvl_private *priv)
  752. {
  753. struct btmrvl_sdio_card *card = priv->btmrvl_dev.card;
  754. int ret = 0;
  755. if (!card || !card->func) {
  756. BT_ERR("card or function is NULL!");
  757. return -EINVAL;
  758. }
  759. sdio_claim_host(card->func);
  760. sdio_writeb(card->func, HOST_POWER_UP, card->reg->cfg, &ret);
  761. sdio_release_host(card->func);
  762. BT_DBG("wake up firmware");
  763. return ret;
  764. }
  765. static int btmrvl_sdio_probe(struct sdio_func *func,
  766. const struct sdio_device_id *id)
  767. {
  768. int ret = 0;
  769. struct btmrvl_private *priv = NULL;
  770. struct btmrvl_sdio_card *card = NULL;
  771. BT_INFO("vendor=0x%x, device=0x%x, class=%d, fn=%d",
  772. id->vendor, id->device, id->class, func->num);
  773. card = devm_kzalloc(&func->dev, sizeof(*card), GFP_KERNEL);
  774. if (!card)
  775. return -ENOMEM;
  776. card->func = func;
  777. if (id->driver_data) {
  778. struct btmrvl_sdio_device *data = (void *) id->driver_data;
  779. card->helper = data->helper;
  780. card->firmware = data->firmware;
  781. card->reg = data->reg;
  782. card->sd_blksz_fw_dl = data->sd_blksz_fw_dl;
  783. }
  784. if (btmrvl_sdio_register_dev(card) < 0) {
  785. BT_ERR("Failed to register BT device!");
  786. return -ENODEV;
  787. }
  788. /* Disable the interrupts on the card */
  789. btmrvl_sdio_disable_host_int(card);
  790. if (btmrvl_sdio_download_fw(card)) {
  791. BT_ERR("Downloading firmware failed!");
  792. ret = -ENODEV;
  793. goto unreg_dev;
  794. }
  795. msleep(100);
  796. btmrvl_sdio_enable_host_int(card);
  797. priv = btmrvl_add_card(card);
  798. if (!priv) {
  799. BT_ERR("Initializing card failed!");
  800. ret = -ENODEV;
  801. goto disable_host_int;
  802. }
  803. card->priv = priv;
  804. /* Initialize the interface specific function pointers */
  805. priv->hw_host_to_card = btmrvl_sdio_host_to_card;
  806. priv->hw_wakeup_firmware = btmrvl_sdio_wakeup_fw;
  807. priv->hw_process_int_status = btmrvl_sdio_process_int_status;
  808. if (btmrvl_register_hdev(priv)) {
  809. BT_ERR("Register hdev failed!");
  810. ret = -ENODEV;
  811. goto disable_host_int;
  812. }
  813. priv->btmrvl_dev.psmode = 1;
  814. btmrvl_enable_ps(priv);
  815. priv->btmrvl_dev.gpio_gap = 0xffff;
  816. btmrvl_send_hscfg_cmd(priv);
  817. return 0;
  818. disable_host_int:
  819. btmrvl_sdio_disable_host_int(card);
  820. unreg_dev:
  821. btmrvl_sdio_unregister_dev(card);
  822. return ret;
  823. }
  824. static void btmrvl_sdio_remove(struct sdio_func *func)
  825. {
  826. struct btmrvl_sdio_card *card;
  827. if (func) {
  828. card = sdio_get_drvdata(func);
  829. if (card) {
  830. /* Send SHUTDOWN command & disable interrupt
  831. * if user removes the module.
  832. */
  833. if (user_rmmod) {
  834. btmrvl_send_module_cfg_cmd(card->priv,
  835. MODULE_SHUTDOWN_REQ);
  836. btmrvl_sdio_disable_host_int(card);
  837. }
  838. BT_DBG("unregester dev");
  839. btmrvl_sdio_unregister_dev(card);
  840. btmrvl_remove_card(card->priv);
  841. }
  842. }
  843. }
  844. static int btmrvl_sdio_suspend(struct device *dev)
  845. {
  846. struct sdio_func *func = dev_to_sdio_func(dev);
  847. struct btmrvl_sdio_card *card;
  848. struct btmrvl_private *priv;
  849. mmc_pm_flag_t pm_flags;
  850. struct hci_dev *hcidev;
  851. if (func) {
  852. pm_flags = sdio_get_host_pm_caps(func);
  853. BT_DBG("%s: suspend: PM flags = 0x%x", sdio_func_id(func),
  854. pm_flags);
  855. if (!(pm_flags & MMC_PM_KEEP_POWER)) {
  856. BT_ERR("%s: cannot remain alive while suspended",
  857. sdio_func_id(func));
  858. return -ENOSYS;
  859. }
  860. card = sdio_get_drvdata(func);
  861. if (!card || !card->priv) {
  862. BT_ERR("card or priv structure is not valid");
  863. return 0;
  864. }
  865. } else {
  866. BT_ERR("sdio_func is not specified");
  867. return 0;
  868. }
  869. priv = card->priv;
  870. if (priv->adapter->hs_state != HS_ACTIVATED) {
  871. if (btmrvl_enable_hs(priv)) {
  872. BT_ERR("HS not actived, suspend failed!");
  873. return -EBUSY;
  874. }
  875. }
  876. hcidev = priv->btmrvl_dev.hcidev;
  877. BT_DBG("%s: SDIO suspend", hcidev->name);
  878. hci_suspend_dev(hcidev);
  879. skb_queue_purge(&priv->adapter->tx_queue);
  880. priv->adapter->is_suspended = true;
  881. /* We will keep the power when hs enabled successfully */
  882. if (priv->adapter->hs_state == HS_ACTIVATED) {
  883. BT_DBG("suspend with MMC_PM_KEEP_POWER");
  884. return sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
  885. } else {
  886. BT_DBG("suspend without MMC_PM_KEEP_POWER");
  887. return 0;
  888. }
  889. }
  890. static int btmrvl_sdio_resume(struct device *dev)
  891. {
  892. struct sdio_func *func = dev_to_sdio_func(dev);
  893. struct btmrvl_sdio_card *card;
  894. struct btmrvl_private *priv;
  895. mmc_pm_flag_t pm_flags;
  896. struct hci_dev *hcidev;
  897. if (func) {
  898. pm_flags = sdio_get_host_pm_caps(func);
  899. BT_DBG("%s: resume: PM flags = 0x%x", sdio_func_id(func),
  900. pm_flags);
  901. card = sdio_get_drvdata(func);
  902. if (!card || !card->priv) {
  903. BT_ERR("card or priv structure is not valid");
  904. return 0;
  905. }
  906. } else {
  907. BT_ERR("sdio_func is not specified");
  908. return 0;
  909. }
  910. priv = card->priv;
  911. if (!priv->adapter->is_suspended) {
  912. BT_DBG("device already resumed");
  913. return 0;
  914. }
  915. priv->adapter->is_suspended = false;
  916. hcidev = priv->btmrvl_dev.hcidev;
  917. BT_DBG("%s: SDIO resume", hcidev->name);
  918. hci_resume_dev(hcidev);
  919. priv->hw_wakeup_firmware(priv);
  920. priv->adapter->hs_state = HS_DEACTIVATED;
  921. BT_DBG("%s: HS DEACTIVATED in resume!", hcidev->name);
  922. return 0;
  923. }
  924. static const struct dev_pm_ops btmrvl_sdio_pm_ops = {
  925. .suspend = btmrvl_sdio_suspend,
  926. .resume = btmrvl_sdio_resume,
  927. };
  928. static struct sdio_driver bt_mrvl_sdio = {
  929. .name = "btmrvl_sdio",
  930. .id_table = btmrvl_sdio_ids,
  931. .probe = btmrvl_sdio_probe,
  932. .remove = btmrvl_sdio_remove,
  933. .drv = {
  934. .owner = THIS_MODULE,
  935. .pm = &btmrvl_sdio_pm_ops,
  936. }
  937. };
  938. static int __init btmrvl_sdio_init_module(void)
  939. {
  940. if (sdio_register_driver(&bt_mrvl_sdio) != 0) {
  941. BT_ERR("SDIO Driver Registration Failed");
  942. return -ENODEV;
  943. }
  944. /* Clear the flag in case user removes the card. */
  945. user_rmmod = 0;
  946. return 0;
  947. }
  948. static void __exit btmrvl_sdio_exit_module(void)
  949. {
  950. /* Set the flag as user is removing this module. */
  951. user_rmmod = 1;
  952. sdio_unregister_driver(&bt_mrvl_sdio);
  953. }
  954. module_init(btmrvl_sdio_init_module);
  955. module_exit(btmrvl_sdio_exit_module);
  956. MODULE_AUTHOR("Marvell International Ltd.");
  957. MODULE_DESCRIPTION("Marvell BT-over-SDIO driver ver " VERSION);
  958. MODULE_VERSION(VERSION);
  959. MODULE_LICENSE("GPL v2");
  960. MODULE_FIRMWARE("sd8688_helper.bin");
  961. MODULE_FIRMWARE("sd8688.bin");
  962. MODULE_FIRMWARE("mrvl/sd8787_uapsta.bin");
  963. MODULE_FIRMWARE("mrvl/sd8797_uapsta.bin");