2 * linux/drivers/net/wireless/libertas/if_spi.c
4 * Driver for Marvell SPI WLAN cards.
6 * Copyright 2008 Analog Devices Inc.
9 * Andrey Yurovsky <andrey@cozybit.com>
10 * Colin McCabe <colin@cozybit.com>
12 * Inspired by if_sdio.c, Copyright 2007-2008 Pierre Ossman
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
20 #include <linux/moduleparam.h>
21 #include <linux/firmware.h>
22 #include <linux/jiffies.h>
23 #include <linux/kthread.h>
24 #include <linux/list.h>
25 #include <linux/netdevice.h>
26 #include <linux/semaphore.h>
27 #include <linux/slab.h>
28 #include <linux/spi/libertas_spi.h>
29 #include <linux/spi/spi.h>
38 struct spi_device *spi;
39 struct lbs_private *priv;
40 struct libertas_spi_platform_data *pdata;
42 char helper_fw_name[IF_SPI_FW_NAME_MAX];
43 char main_fw_name[IF_SPI_FW_NAME_MAX];
45 /* The card ID and card revision, as reported by the hardware. */
49 /* The last time that we initiated an SPU operation */
50 unsigned long prev_xfer_time;
53 unsigned long spu_port_delay;
54 unsigned long spu_reg_delay;
56 /* Handles all SPI communication (except for FW load) */
57 struct task_struct *spi_thread;
60 /* Used to wake up the spi_thread */
61 struct semaphore spi_ready;
62 struct semaphore spi_thread_terminated;
64 u8 cmd_buffer[IF_SPI_CMD_BUF_SIZE];
67 static void free_if_spi_card(struct if_spi_card *card)
69 spi_set_drvdata(card->spi, NULL);
73 static struct chip_ident chip_id_to_device_name[] = {
74 { .chip_id = 0x04, .name = 8385 },
75 { .chip_id = 0x0b, .name = 8686 },
79 * SPI Interface Unit Routines
81 * The SPU sits between the host and the WLAN module.
82 * All communication with the firmware is through SPU transactions.
84 * First we have to put a SPU register name on the bus. Then we can
85 * either read from or write to that register.
89 static void spu_transaction_init(struct if_spi_card *card)
91 if (!time_after(jiffies, card->prev_xfer_time + 1)) {
92 /* Unfortunately, the SPU requires a delay between successive
93 * transactions. If our last transaction was more than a jiffy
94 * ago, we have obviously already delayed enough.
95 * If not, we have to busy-wait to be on the safe side. */
100 static void spu_transaction_finish(struct if_spi_card *card)
102 card->prev_xfer_time = jiffies;
105 /* Write out a byte buffer to an SPI register,
106 * using a series of 16-bit transfers. */
107 static int spu_write(struct if_spi_card *card, u16 reg, const u8 *buf, int len)
110 __le16 reg_out = cpu_to_le16(reg | IF_SPI_WRITE_OPERATION_MASK);
111 struct spi_message m;
112 struct spi_transfer reg_trans;
113 struct spi_transfer data_trans;
115 spi_message_init(&m);
116 memset(®_trans, 0, sizeof(reg_trans));
117 memset(&data_trans, 0, sizeof(data_trans));
119 /* You must give an even number of bytes to the SPU, even if it
120 * doesn't care about the last one. */
123 spu_transaction_init(card);
125 /* write SPU register index */
126 reg_trans.tx_buf = ®_out;
127 reg_trans.len = sizeof(reg_out);
129 data_trans.tx_buf = buf;
130 data_trans.len = len;
132 spi_message_add_tail(®_trans, &m);
133 spi_message_add_tail(&data_trans, &m);
135 err = spi_sync(card->spi, &m);
136 spu_transaction_finish(card);
140 static inline int spu_write_u16(struct if_spi_card *card, u16 reg, u16 val)
144 buff = cpu_to_le16(val);
145 return spu_write(card, reg, (u8 *)&buff, sizeof(u16));
148 static inline int spu_reg_is_port_reg(u16 reg)
151 case IF_SPI_IO_RDWRPORT_REG:
152 case IF_SPI_CMD_RDWRPORT_REG:
153 case IF_SPI_DATA_RDWRPORT_REG:
160 static int spu_read(struct if_spi_card *card, u16 reg, u8 *buf, int len)
164 __le16 reg_out = cpu_to_le16(reg | IF_SPI_READ_OPERATION_MASK);
165 struct spi_message m;
166 struct spi_transfer reg_trans;
167 struct spi_transfer dummy_trans;
168 struct spi_transfer data_trans;
170 /* You must take an even number of bytes from the SPU, even if you
171 * don't care about the last one. */
174 spu_transaction_init(card);
176 spi_message_init(&m);
177 memset(®_trans, 0, sizeof(reg_trans));
178 memset(&dummy_trans, 0, sizeof(dummy_trans));
179 memset(&data_trans, 0, sizeof(data_trans));
181 /* write SPU register index */
182 reg_trans.tx_buf = ®_out;
183 reg_trans.len = sizeof(reg_out);
184 spi_message_add_tail(®_trans, &m);
186 delay = spu_reg_is_port_reg(reg) ? card->spu_port_delay :
188 if (card->use_dummy_writes) {
189 /* Clock in dummy cycles while the SPU fills the FIFO */
190 dummy_trans.len = delay / 8;
191 spi_message_add_tail(&dummy_trans, &m);
193 /* Busy-wait while the SPU fills the FIFO */
194 reg_trans.delay_usecs =
195 DIV_ROUND_UP((100 + (delay * 10)), 1000);
199 data_trans.rx_buf = buf;
200 data_trans.len = len;
201 spi_message_add_tail(&data_trans, &m);
203 err = spi_sync(card->spi, &m);
204 spu_transaction_finish(card);
208 /* Read 16 bits from an SPI register */
209 static inline int spu_read_u16(struct if_spi_card *card, u16 reg, u16 *val)
214 ret = spu_read(card, reg, (u8 *)&buf, sizeof(buf));
216 *val = le16_to_cpup(&buf);
220 /* Read 32 bits from an SPI register.
221 * The low 16 bits are read first. */
222 static int spu_read_u32(struct if_spi_card *card, u16 reg, u32 *val)
227 err = spu_read(card, reg, (u8 *)&buf, sizeof(buf));
229 *val = le32_to_cpup(&buf);
233 /* Keep reading 16 bits from an SPI register until you get the correct result.
235 * If mask = 0, the correct result is any non-zero number.
236 * If mask != 0, the correct result is any number where
237 * number & target_mask == target
239 * Returns -ETIMEDOUT if a second passes without the correct result. */
240 static int spu_wait_for_u16(struct if_spi_card *card, u16 reg,
241 u16 target_mask, u16 target)
244 unsigned long timeout = jiffies + 5*HZ;
247 err = spu_read_u16(card, reg, &val);
251 if ((val & target_mask) == target)
258 if (time_after(jiffies, timeout)) {
259 lbs_pr_err("%s: timeout with val=%02x, "
260 "target_mask=%02x, target=%02x\n",
261 __func__, val, target_mask, target);
267 /* Read 16 bits from an SPI register until you receive a specific value.
268 * Returns -ETIMEDOUT if a 4 tries pass without success. */
269 static int spu_wait_for_u32(struct if_spi_card *card, u32 reg, u32 target)
272 for (try = 0; try < 4; ++try) {
274 err = spu_read_u32(card, reg, &val);
284 static int spu_set_interrupt_mode(struct if_spi_card *card,
285 int suppress_host_int,
290 /* We can suppress a host interrupt by clearing the appropriate
291 * bit in the "host interrupt status mask" register */
292 if (suppress_host_int) {
293 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_MASK_REG, 0);
297 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_MASK_REG,
298 IF_SPI_HISM_TX_DOWNLOAD_RDY |
299 IF_SPI_HISM_RX_UPLOAD_RDY |
300 IF_SPI_HISM_CMD_DOWNLOAD_RDY |
301 IF_SPI_HISM_CARDEVENT |
302 IF_SPI_HISM_CMD_UPLOAD_RDY);
307 /* If auto-interrupts are on, the completion of certain transactions
308 * will trigger an interrupt automatically. If auto-interrupts
309 * are off, we need to set the "Card Interrupt Cause" register to
310 * trigger a card interrupt. */
312 err = spu_write_u16(card, IF_SPI_HOST_INT_CTRL_REG,
313 IF_SPI_HICT_TX_DOWNLOAD_OVER_AUTO |
314 IF_SPI_HICT_RX_UPLOAD_OVER_AUTO |
315 IF_SPI_HICT_CMD_DOWNLOAD_OVER_AUTO |
316 IF_SPI_HICT_CMD_UPLOAD_OVER_AUTO);
320 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_MASK_REG, 0);
327 static int spu_get_chip_revision(struct if_spi_card *card,
328 u16 *card_id, u8 *card_rev)
332 err = spu_read_u32(card, IF_SPI_DEVICEID_CTRL_REG, &dev_ctrl);
335 *card_id = IF_SPI_DEVICEID_CTRL_REG_TO_CARD_ID(dev_ctrl);
336 *card_rev = IF_SPI_DEVICEID_CTRL_REG_TO_CARD_REV(dev_ctrl);
340 static int spu_set_bus_mode(struct if_spi_card *card, u16 mode)
345 err = spu_write_u16(card, IF_SPI_SPU_BUS_MODE_REG, mode);
348 /* Check that we were able to read back what we just wrote. */
349 err = spu_read_u16(card, IF_SPI_SPU_BUS_MODE_REG, &rval);
352 if ((rval & 0xF) != mode) {
353 lbs_pr_err("Can't read bus mode register.\n");
359 static int spu_init(struct if_spi_card *card, int use_dummy_writes)
364 /* We have to start up in timed delay mode so that we can safely
365 * read the Delay Read Register. */
366 card->use_dummy_writes = 0;
367 err = spu_set_bus_mode(card,
368 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING |
369 IF_SPI_BUS_MODE_DELAY_METHOD_TIMED |
370 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA);
373 card->spu_port_delay = 1000;
374 card->spu_reg_delay = 1000;
375 err = spu_read_u32(card, IF_SPI_DELAY_READ_REG, &delay);
378 card->spu_port_delay = delay & 0x0000ffff;
379 card->spu_reg_delay = (delay & 0xffff0000) >> 16;
381 /* If dummy clock delay mode has been requested, switch to it now */
382 if (use_dummy_writes) {
383 card->use_dummy_writes = 1;
384 err = spu_set_bus_mode(card,
385 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING |
386 IF_SPI_BUS_MODE_DELAY_METHOD_DUMMY_CLOCK |
387 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA);
392 lbs_deb_spi("Initialized SPU unit. "
393 "spu_port_delay=0x%04lx, spu_reg_delay=0x%04lx\n",
394 card->spu_port_delay, card->spu_reg_delay);
402 static int if_spi_prog_helper_firmware(struct if_spi_card *card)
405 const struct firmware *firmware = NULL;
408 u8 temp[HELPER_FW_LOAD_CHUNK_SZ];
409 struct spi_device *spi = card->spi;
411 lbs_deb_enter(LBS_DEB_SPI);
413 err = spu_set_interrupt_mode(card, 1, 0);
416 /* Get helper firmware image */
417 err = request_firmware(&firmware, card->helper_fw_name, &spi->dev);
419 lbs_pr_err("request_firmware failed with err = %d\n", err);
422 bytes_remaining = firmware->size;
425 /* Load helper firmware image */
426 while (bytes_remaining > 0) {
427 /* Scratch pad 1 should contain the number of bytes we
428 * want to download to the firmware */
429 err = spu_write_u16(card, IF_SPI_SCRATCH_1_REG,
430 HELPER_FW_LOAD_CHUNK_SZ);
432 goto release_firmware;
434 err = spu_wait_for_u16(card, IF_SPI_HOST_INT_STATUS_REG,
435 IF_SPI_HIST_CMD_DOWNLOAD_RDY,
436 IF_SPI_HIST_CMD_DOWNLOAD_RDY);
438 goto release_firmware;
440 /* Feed the data into the command read/write port reg
441 * in chunks of 64 bytes */
442 memset(temp, 0, sizeof(temp));
444 min(bytes_remaining, HELPER_FW_LOAD_CHUNK_SZ));
446 err = spu_write(card, IF_SPI_CMD_RDWRPORT_REG,
447 temp, HELPER_FW_LOAD_CHUNK_SZ);
449 goto release_firmware;
451 /* Interrupt the boot code */
452 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG, 0);
454 goto release_firmware;
455 err = spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG,
456 IF_SPI_CIC_CMD_DOWNLOAD_OVER);
458 goto release_firmware;
459 bytes_remaining -= HELPER_FW_LOAD_CHUNK_SZ;
460 fw += HELPER_FW_LOAD_CHUNK_SZ;
463 /* Once the helper / single stage firmware download is complete,
464 * write 0 to scratch pad 1 and interrupt the
465 * bootloader. This completes the helper download. */
466 err = spu_write_u16(card, IF_SPI_SCRATCH_1_REG, FIRMWARE_DNLD_OK);
468 goto release_firmware;
469 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG, 0);
471 goto release_firmware;
472 err = spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG,
473 IF_SPI_CIC_CMD_DOWNLOAD_OVER);
474 goto release_firmware;
476 lbs_deb_spi("waiting for helper to boot...\n");
479 release_firmware(firmware);
482 lbs_pr_err("failed to load helper firmware (err=%d)\n", err);
483 lbs_deb_leave_args(LBS_DEB_SPI, "err %d", err);
487 /* Returns the length of the next packet the firmware expects us to send
488 * Sets crc_err if the previous transfer had a CRC error. */
489 static int if_spi_prog_main_firmware_check_len(struct if_spi_card *card,
495 /* wait until the host interrupt status register indicates
496 * that we are ready to download */
497 err = spu_wait_for_u16(card, IF_SPI_HOST_INT_STATUS_REG,
498 IF_SPI_HIST_CMD_DOWNLOAD_RDY,
499 IF_SPI_HIST_CMD_DOWNLOAD_RDY);
501 lbs_pr_err("timed out waiting for host_int_status\n");
505 /* Ask the device how many bytes of firmware it wants. */
506 err = spu_read_u16(card, IF_SPI_SCRATCH_1_REG, &len);
510 if (len > IF_SPI_CMD_BUF_SIZE) {
511 lbs_pr_err("firmware load device requested a larger "
512 "tranfer than we are prepared to "
513 "handle. (len = %d)\n", len);
517 lbs_deb_spi("%s: crc error\n", __func__);
526 static int if_spi_prog_main_firmware(struct if_spi_card *card)
529 int bytes, crc_err = 0, err = 0;
530 const struct firmware *firmware = NULL;
532 struct spi_device *spi = card->spi;
535 lbs_deb_enter(LBS_DEB_SPI);
537 err = spu_set_interrupt_mode(card, 1, 0);
541 /* Get firmware image */
542 err = request_firmware(&firmware, card->main_fw_name, &spi->dev);
544 lbs_pr_err("%s: can't get firmware '%s' from kernel. "
545 "err = %d\n", __func__, card->main_fw_name, err);
549 err = spu_wait_for_u16(card, IF_SPI_SCRATCH_1_REG, 0, 0);
551 lbs_pr_err("%s: timed out waiting for initial "
552 "scratch reg = 0\n", __func__);
553 goto release_firmware;
558 bytes = firmware->size;
560 while ((len = if_spi_prog_main_firmware_check_len(card, &crc_err))) {
563 goto release_firmware;
566 /* If there are no more bytes left, we would normally
567 * expect to have terminated with len = 0 */
568 lbs_pr_err("Firmware load wants more bytes "
569 "than we have to offer.\n");
573 /* Previous transfer failed. */
574 if (++num_crc_errs > MAX_MAIN_FW_LOAD_CRC_ERR) {
575 lbs_pr_err("Too many CRC errors encountered "
576 "in firmware load.\n");
578 goto release_firmware;
581 /* Previous transfer succeeded. Advance counters. */
586 memset(card->cmd_buffer, 0, len);
587 memcpy(card->cmd_buffer, fw, bytes);
589 memcpy(card->cmd_buffer, fw, len);
591 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG, 0);
593 goto release_firmware;
594 err = spu_write(card, IF_SPI_CMD_RDWRPORT_REG,
595 card->cmd_buffer, len);
597 goto release_firmware;
598 err = spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG ,
599 IF_SPI_CIC_CMD_DOWNLOAD_OVER);
601 goto release_firmware;
604 if (bytes > prev_len) {
605 lbs_pr_err("firmware load wants fewer bytes than "
606 "we have to offer.\n");
609 /* Confirm firmware download */
610 err = spu_wait_for_u32(card, IF_SPI_SCRATCH_4_REG,
611 SUCCESSFUL_FW_DOWNLOAD_MAGIC);
613 lbs_pr_err("failed to confirm the firmware download\n");
614 goto release_firmware;
618 release_firmware(firmware);
622 lbs_pr_err("failed to load firmware (err=%d)\n", err);
623 lbs_deb_leave_args(LBS_DEB_SPI, "err %d", err);
628 * SPI Transfer Thread
630 * The SPI thread handles all SPI transfers, so there is no need for a lock.
633 /* Move a command from the card to the host */
634 static int if_spi_c2h_cmd(struct if_spi_card *card)
636 struct lbs_private *priv = card->priv;
642 /* We need a buffer big enough to handle whatever people send to
644 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE < LBS_CMD_BUFFER_SIZE);
645 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE < LBS_UPLD_SIZE);
647 /* It's just annoying if the buffer size isn't a multiple of 4, because
648 * then we might have len < IF_SPI_CMD_BUF_SIZE but
649 * ALIGN(len, 4) > IF_SPI_CMD_BUF_SIZE */
650 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE % 4 != 0);
652 lbs_deb_enter(LBS_DEB_SPI);
654 /* How many bytes are there to read? */
655 err = spu_read_u16(card, IF_SPI_SCRATCH_2_REG, &len);
659 lbs_pr_err("%s: error: card has no data for host\n",
663 } else if (len > IF_SPI_CMD_BUF_SIZE) {
664 lbs_pr_err("%s: error: response packet too large: "
665 "%d bytes, but maximum is %d\n",
666 __func__, len, IF_SPI_CMD_BUF_SIZE);
671 /* Read the data from the WLAN module into our command buffer */
672 err = spu_read(card, IF_SPI_CMD_RDWRPORT_REG,
673 card->cmd_buffer, ALIGN(len, 4));
677 spin_lock_irqsave(&priv->driver_lock, flags);
678 i = (priv->resp_idx == 0) ? 1 : 0;
679 BUG_ON(priv->resp_len[i]);
680 priv->resp_len[i] = len;
681 memcpy(priv->resp_buf[i], card->cmd_buffer, len);
682 lbs_notify_command_response(priv, i);
683 spin_unlock_irqrestore(&priv->driver_lock, flags);
687 lbs_pr_err("%s: err=%d\n", __func__, err);
688 lbs_deb_leave(LBS_DEB_SPI);
692 /* Move data from the card to the host */
693 static int if_spi_c2h_data(struct if_spi_card *card)
700 lbs_deb_enter(LBS_DEB_SPI);
702 /* How many bytes are there to read? */
703 err = spu_read_u16(card, IF_SPI_SCRATCH_1_REG, &len);
707 lbs_pr_err("%s: error: card has no data for host\n",
711 } else if (len > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
712 lbs_pr_err("%s: error: card has %d bytes of data, but "
713 "our maximum skb size is %zu\n",
714 __func__, len, MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);
719 /* TODO: should we allocate a smaller skb if we have less data? */
720 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);
725 skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
726 data = skb_put(skb, len);
728 /* Read the data from the WLAN module into our skb... */
729 err = spu_read(card, IF_SPI_DATA_RDWRPORT_REG, data, ALIGN(len, 4));
733 /* pass the SKB to libertas */
734 err = lbs_process_rxed_packet(card->priv, skb);
745 lbs_pr_err("%s: err=%d\n", __func__, err);
746 lbs_deb_leave(LBS_DEB_SPI);
750 /* Inform the host about a card event */
751 static void if_spi_e2h(struct if_spi_card *card)
755 struct lbs_private *priv = card->priv;
757 err = spu_read_u32(card, IF_SPI_SCRATCH_3_REG, &cause);
761 /* re-enable the card event interrupt */
762 spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG,
763 ~IF_SPI_HICU_CARD_EVENT);
765 /* generate a card interrupt */
766 spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG, IF_SPI_CIC_HOST_EVENT);
768 lbs_queue_event(priv, cause & 0xff);
771 lbs_pr_err("%s: error %d\n", __func__, err);
774 static int lbs_spi_thread(void *data)
777 struct if_spi_card *card = data;
781 /* Wait to be woken up by one of two things. First, our ISR
782 * could tell us that something happened on the WLAN.
783 * Secondly, libertas could call hw_host_to_card with more
784 * data, which we might be able to send.
787 err = down_interruptible(&card->spi_ready);
788 if (!card->run_thread) {
789 up(&card->spi_thread_terminated);
792 } while (err == EINTR);
794 /* Read the host interrupt status register to see what we
796 err = spu_read_u16(card, IF_SPI_HOST_INT_STATUS_REG,
799 lbs_pr_err("I/O error\n");
803 if (hiStatus & IF_SPI_HIST_CMD_UPLOAD_RDY) {
804 err = if_spi_c2h_cmd(card);
808 if (hiStatus & IF_SPI_HIST_RX_UPLOAD_RDY) {
809 err = if_spi_c2h_data(card);
814 /* workaround: in PS mode, the card does not set the Command
815 * Download Ready bit, but it sets TX Download Ready. */
816 if (hiStatus & IF_SPI_HIST_CMD_DOWNLOAD_RDY ||
817 (card->priv->psstate != PS_STATE_FULL_POWER &&
818 (hiStatus & IF_SPI_HIST_TX_DOWNLOAD_RDY))) {
819 lbs_host_to_card_done(card->priv);
822 if (hiStatus & IF_SPI_HIST_CARD_EVENT)
827 lbs_pr_err("%s: got error %d\n", __func__, err);
831 /* Block until lbs_spi_thread thread has terminated */
832 static void if_spi_terminate_spi_thread(struct if_spi_card *card)
834 /* It would be nice to use kthread_stop here, but that function
835 * can't wake threads waiting for a semaphore. */
836 card->run_thread = 0;
837 up(&card->spi_ready);
838 down(&card->spi_thread_terminated);
844 * Called from Libertas to transfer some data to the WLAN device
845 * We can't sleep here. */
846 static int if_spi_host_to_card(struct lbs_private *priv,
847 u8 type, u8 *buf, u16 nb)
850 struct if_spi_card *card = priv->card;
852 lbs_deb_enter_args(LBS_DEB_SPI, "type %d, bytes %d", type, nb);
858 err = spu_write(card, IF_SPI_CMD_RDWRPORT_REG, buf, nb);
861 err = spu_write(card, IF_SPI_DATA_RDWRPORT_REG, buf, nb);
864 lbs_pr_err("can't transfer buffer of type %d", type);
869 lbs_deb_leave_args(LBS_DEB_SPI, "err=%d", err);
876 * Service incoming interrupts from the WLAN device. We can't sleep here, so
877 * don't try to talk on the SPI bus, just wake up the SPI thread.
879 static irqreturn_t if_spi_host_interrupt(int irq, void *dev_id)
881 struct if_spi_card *card = dev_id;
883 up(&card->spi_ready);
891 static int if_spi_calculate_fw_names(u16 card_id,
892 char *helper_fw, char *main_fw)
895 for (i = 0; i < ARRAY_SIZE(chip_id_to_device_name); ++i) {
896 if (card_id == chip_id_to_device_name[i].chip_id)
899 if (i == ARRAY_SIZE(chip_id_to_device_name)) {
900 lbs_pr_err("Unsupported chip_id: 0x%02x\n", card_id);
901 return -EAFNOSUPPORT;
903 snprintf(helper_fw, IF_SPI_FW_NAME_MAX, "libertas/gspi%d_hlp.bin",
904 chip_id_to_device_name[i].name);
905 snprintf(main_fw, IF_SPI_FW_NAME_MAX, "libertas/gspi%d.bin",
906 chip_id_to_device_name[i].name);
909 MODULE_FIRMWARE("libertas/gspi8385_hlp.bin");
910 MODULE_FIRMWARE("libertas/gspi8385.bin");
911 MODULE_FIRMWARE("libertas/gspi8686_hlp.bin");
912 MODULE_FIRMWARE("libertas/gspi8686.bin");
914 static int __devinit if_spi_probe(struct spi_device *spi)
916 struct if_spi_card *card;
917 struct lbs_private *priv = NULL;
918 struct libertas_spi_platform_data *pdata = spi->dev.platform_data;
921 struct sched_param param = { .sched_priority = 1 };
923 lbs_deb_enter(LBS_DEB_SPI);
931 err = pdata->setup(spi);
936 /* Allocate card structure to represent this specific device */
937 card = kzalloc(sizeof(struct if_spi_card), GFP_KERNEL);
942 spi_set_drvdata(spi, card);
945 card->prev_xfer_time = jiffies;
947 sema_init(&card->spi_ready, 0);
948 sema_init(&card->spi_thread_terminated, 0);
950 /* Initialize the SPI Interface Unit */
951 err = spu_init(card, pdata->use_dummy_writes);
954 err = spu_get_chip_revision(card, &card->card_id, &card->card_rev);
959 err = spu_read_u32(card, IF_SPI_SCRATCH_4_REG, &scratch);
962 if (scratch == SUCCESSFUL_FW_DOWNLOAD_MAGIC)
963 lbs_deb_spi("Firmware is already loaded for "
964 "Marvell WLAN 802.11 adapter\n");
966 err = if_spi_calculate_fw_names(card->card_id,
967 card->helper_fw_name, card->main_fw_name);
971 lbs_deb_spi("Initializing FW for Marvell WLAN 802.11 adapter "
972 "(chip_id = 0x%04x, chip_rev = 0x%02x) "
973 "attached to SPI bus_num %d, chip_select %d. "
974 "spi->max_speed_hz=%d\n",
975 card->card_id, card->card_rev,
976 spi->master->bus_num, spi->chip_select,
978 err = if_spi_prog_helper_firmware(card);
981 err = if_spi_prog_main_firmware(card);
984 lbs_deb_spi("loaded FW for Marvell WLAN 802.11 adapter\n");
987 err = spu_set_interrupt_mode(card, 0, 1);
991 /* Register our card with libertas.
992 * This will call alloc_etherdev */
993 priv = lbs_add_card(card, &spi->dev);
1000 priv->hw_host_to_card = if_spi_host_to_card;
1001 priv->enter_deep_sleep = NULL;
1002 priv->exit_deep_sleep = NULL;
1003 priv->reset_deep_sleep_wakeup = NULL;
1006 /* Initialize interrupt handling stuff. */
1007 card->run_thread = 1;
1008 card->spi_thread = kthread_run(lbs_spi_thread, card, "lbs_spi_thread");
1009 if (IS_ERR(card->spi_thread)) {
1010 card->run_thread = 0;
1011 err = PTR_ERR(card->spi_thread);
1012 lbs_pr_err("error creating SPI thread: err=%d\n", err);
1015 if (sched_setscheduler(card->spi_thread, SCHED_FIFO, ¶m))
1016 lbs_pr_err("Error setting scheduler, using default.\n");
1018 err = request_irq(spi->irq, if_spi_host_interrupt,
1019 IRQF_TRIGGER_FALLING, "libertas_spi", card);
1021 lbs_pr_err("can't get host irq line-- request_irq failed\n");
1022 goto terminate_thread;
1025 /* poke the IRQ handler so that we don't miss the first interrupt */
1026 up(&card->spi_ready);
1029 * This will call register_netdev, and we'll start
1030 * getting interrupts... */
1031 err = lbs_start_card(priv);
1035 lbs_deb_spi("Finished initializing WLAN module.\n");
1037 /* successful exit */
1041 free_irq(spi->irq, card);
1043 if_spi_terminate_spi_thread(card);
1045 lbs_remove_card(priv); /* will call free_netdev */
1047 free_if_spi_card(card);
1049 lbs_deb_leave_args(LBS_DEB_SPI, "err %d\n", err);
1053 static int __devexit libertas_spi_remove(struct spi_device *spi)
1055 struct if_spi_card *card = spi_get_drvdata(spi);
1056 struct lbs_private *priv = card->priv;
1058 lbs_deb_spi("libertas_spi_remove\n");
1059 lbs_deb_enter(LBS_DEB_SPI);
1061 lbs_stop_card(priv);
1062 lbs_remove_card(priv); /* will call free_netdev */
1064 priv->surpriseremoved = 1;
1065 free_irq(spi->irq, card);
1066 if_spi_terminate_spi_thread(card);
1067 if (card->pdata->teardown)
1068 card->pdata->teardown(spi);
1069 free_if_spi_card(card);
1070 lbs_deb_leave(LBS_DEB_SPI);
1074 static struct spi_driver libertas_spi_driver = {
1075 .probe = if_spi_probe,
1076 .remove = __devexit_p(libertas_spi_remove),
1078 .name = "libertas_spi",
1079 .bus = &spi_bus_type,
1080 .owner = THIS_MODULE,
1088 static int __init if_spi_init_module(void)
1091 lbs_deb_enter(LBS_DEB_SPI);
1092 printk(KERN_INFO "libertas_spi: Libertas SPI driver\n");
1093 ret = spi_register_driver(&libertas_spi_driver);
1094 lbs_deb_leave(LBS_DEB_SPI);
1098 static void __exit if_spi_exit_module(void)
1100 lbs_deb_enter(LBS_DEB_SPI);
1101 spi_unregister_driver(&libertas_spi_driver);
1102 lbs_deb_leave(LBS_DEB_SPI);
1105 module_init(if_spi_init_module);
1106 module_exit(if_spi_exit_module);
1108 MODULE_DESCRIPTION("Libertas SPI WLAN Driver");
1109 MODULE_AUTHOR("Andrey Yurovsky <andrey@cozybit.com>, "
1110 "Colin McCabe <colin@cozybit.com>");
1111 MODULE_LICENSE("GPL");
1112 MODULE_ALIAS("spi:libertas_spi");