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