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/spi/libertas_spi.h>
28 #include <linux/spi/spi.h>
37 struct spi_device
*spi
;
38 struct lbs_private
*priv
;
39 struct libertas_spi_platform_data
*pdata
;
41 char helper_fw_name
[IF_SPI_FW_NAME_MAX
];
42 char main_fw_name
[IF_SPI_FW_NAME_MAX
];
44 /* The card ID and card revision, as reported by the hardware. */
48 /* The last time that we initiated an SPU operation */
49 unsigned long prev_xfer_time
;
52 unsigned long spu_port_delay
;
53 unsigned long spu_reg_delay
;
55 /* Handles all SPI communication (except for FW load) */
56 struct task_struct
*spi_thread
;
59 /* Used to wake up the spi_thread */
60 struct semaphore spi_ready
;
61 struct semaphore spi_thread_terminated
;
63 u8 cmd_buffer
[IF_SPI_CMD_BUF_SIZE
];
66 static void free_if_spi_card(struct if_spi_card
*card
)
68 spi_set_drvdata(card
->spi
, NULL
);
72 static struct chip_ident chip_id_to_device_name
[] = {
73 { .chip_id
= 0x04, .name
= 8385 },
74 { .chip_id
= 0x0b, .name
= 8686 },
78 * SPI Interface Unit Routines
80 * The SPU sits between the host and the WLAN module.
81 * All communication with the firmware is through SPU transactions.
83 * First we have to put a SPU register name on the bus. Then we can
84 * either read from or write to that register.
88 static void spu_transaction_init(struct if_spi_card
*card
)
90 if (!time_after(jiffies
, card
->prev_xfer_time
+ 1)) {
91 /* Unfortunately, the SPU requires a delay between successive
92 * transactions. If our last transaction was more than a jiffy
93 * ago, we have obviously already delayed enough.
94 * If not, we have to busy-wait to be on the safe side. */
99 static void spu_transaction_finish(struct if_spi_card
*card
)
101 card
->prev_xfer_time
= jiffies
;
104 /* Write out a byte buffer to an SPI register,
105 * using a series of 16-bit transfers. */
106 static int spu_write(struct if_spi_card
*card
, u16 reg
, const u8
*buf
, int len
)
109 __le16 reg_out
= cpu_to_le16(reg
| IF_SPI_WRITE_OPERATION_MASK
);
110 struct spi_message m
;
111 struct spi_transfer reg_trans
;
112 struct spi_transfer data_trans
;
114 spi_message_init(&m
);
115 memset(®_trans
, 0, sizeof(reg_trans
));
116 memset(&data_trans
, 0, sizeof(data_trans
));
118 /* You must give an even number of bytes to the SPU, even if it
119 * doesn't care about the last one. */
122 spu_transaction_init(card
);
124 /* write SPU register index */
125 reg_trans
.tx_buf
= ®_out
;
126 reg_trans
.len
= sizeof(reg_out
);
128 data_trans
.tx_buf
= buf
;
129 data_trans
.len
= len
;
131 spi_message_add_tail(®_trans
, &m
);
132 spi_message_add_tail(&data_trans
, &m
);
134 err
= spi_sync(card
->spi
, &m
);
135 spu_transaction_finish(card
);
139 static inline int spu_write_u16(struct if_spi_card
*card
, u16 reg
, u16 val
)
143 buff
= cpu_to_le16(val
);
144 return spu_write(card
, reg
, (u8
*)&buff
, sizeof(u16
));
147 static inline int spu_reg_is_port_reg(u16 reg
)
150 case IF_SPI_IO_RDWRPORT_REG
:
151 case IF_SPI_CMD_RDWRPORT_REG
:
152 case IF_SPI_DATA_RDWRPORT_REG
:
159 static int spu_read(struct if_spi_card
*card
, u16 reg
, u8
*buf
, int len
)
163 __le16 reg_out
= cpu_to_le16(reg
| IF_SPI_READ_OPERATION_MASK
);
164 struct spi_message m
;
165 struct spi_transfer reg_trans
;
166 struct spi_transfer dummy_trans
;
167 struct spi_transfer data_trans
;
169 /* You must take an even number of bytes from the SPU, even if you
170 * don't care about the last one. */
173 spu_transaction_init(card
);
175 spi_message_init(&m
);
176 memset(®_trans
, 0, sizeof(reg_trans
));
177 memset(&dummy_trans
, 0, sizeof(dummy_trans
));
178 memset(&data_trans
, 0, sizeof(data_trans
));
180 /* write SPU register index */
181 reg_trans
.tx_buf
= ®_out
;
182 reg_trans
.len
= sizeof(reg_out
);
183 spi_message_add_tail(®_trans
, &m
);
185 delay
= spu_reg_is_port_reg(reg
) ? card
->spu_port_delay
:
187 if (card
->use_dummy_writes
) {
188 /* Clock in dummy cycles while the SPU fills the FIFO */
189 dummy_trans
.len
= delay
/ 8;
190 spi_message_add_tail(&dummy_trans
, &m
);
192 /* Busy-wait while the SPU fills the FIFO */
193 reg_trans
.delay_usecs
=
194 DIV_ROUND_UP((100 + (delay
* 10)), 1000);
198 data_trans
.rx_buf
= buf
;
199 data_trans
.len
= len
;
200 spi_message_add_tail(&data_trans
, &m
);
202 err
= spi_sync(card
->spi
, &m
);
203 spu_transaction_finish(card
);
207 /* Read 16 bits from an SPI register */
208 static inline int spu_read_u16(struct if_spi_card
*card
, u16 reg
, u16
*val
)
213 ret
= spu_read(card
, reg
, (u8
*)&buf
, sizeof(buf
));
215 *val
= le16_to_cpup(&buf
);
219 /* Read 32 bits from an SPI register.
220 * The low 16 bits are read first. */
221 static int spu_read_u32(struct if_spi_card
*card
, u16 reg
, u32
*val
)
226 err
= spu_read(card
, reg
, (u8
*)&buf
, sizeof(buf
));
228 *val
= le32_to_cpup(&buf
);
232 /* Keep reading 16 bits from an SPI register until you get the correct result.
234 * If mask = 0, the correct result is any non-zero number.
235 * If mask != 0, the correct result is any number where
236 * number & target_mask == target
238 * Returns -ETIMEDOUT if a second passes without the correct result. */
239 static int spu_wait_for_u16(struct if_spi_card
*card
, u16 reg
,
240 u16 target_mask
, u16 target
)
243 unsigned long timeout
= jiffies
+ 5*HZ
;
246 err
= spu_read_u16(card
, reg
, &val
);
250 if ((val
& target_mask
) == target
)
257 if (time_after(jiffies
, timeout
)) {
258 lbs_pr_err("%s: timeout with val=%02x, "
259 "target_mask=%02x, target=%02x\n",
260 __func__
, val
, target_mask
, target
);
266 /* Read 16 bits from an SPI register until you receive a specific value.
267 * Returns -ETIMEDOUT if a 4 tries pass without success. */
268 static int spu_wait_for_u32(struct if_spi_card
*card
, u32 reg
, u32 target
)
271 for (try = 0; try < 4; ++try) {
273 err
= spu_read_u32(card
, reg
, &val
);
283 static int spu_set_interrupt_mode(struct if_spi_card
*card
,
284 int suppress_host_int
,
289 /* We can suppress a host interrupt by clearing the appropriate
290 * bit in the "host interrupt status mask" register */
291 if (suppress_host_int
) {
292 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_MASK_REG
, 0);
296 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_MASK_REG
,
297 IF_SPI_HISM_TX_DOWNLOAD_RDY
|
298 IF_SPI_HISM_RX_UPLOAD_RDY
|
299 IF_SPI_HISM_CMD_DOWNLOAD_RDY
|
300 IF_SPI_HISM_CARDEVENT
|
301 IF_SPI_HISM_CMD_UPLOAD_RDY
);
306 /* If auto-interrupts are on, the completion of certain transactions
307 * will trigger an interrupt automatically. If auto-interrupts
308 * are off, we need to set the "Card Interrupt Cause" register to
309 * trigger a card interrupt. */
311 err
= spu_write_u16(card
, IF_SPI_HOST_INT_CTRL_REG
,
312 IF_SPI_HICT_TX_DOWNLOAD_OVER_AUTO
|
313 IF_SPI_HICT_RX_UPLOAD_OVER_AUTO
|
314 IF_SPI_HICT_CMD_DOWNLOAD_OVER_AUTO
|
315 IF_SPI_HICT_CMD_UPLOAD_OVER_AUTO
);
319 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_MASK_REG
, 0);
326 static int spu_get_chip_revision(struct if_spi_card
*card
,
327 u16
*card_id
, u8
*card_rev
)
331 err
= spu_read_u32(card
, IF_SPI_DEVICEID_CTRL_REG
, &dev_ctrl
);
334 *card_id
= IF_SPI_DEVICEID_CTRL_REG_TO_CARD_ID(dev_ctrl
);
335 *card_rev
= IF_SPI_DEVICEID_CTRL_REG_TO_CARD_REV(dev_ctrl
);
339 static int spu_set_bus_mode(struct if_spi_card
*card
, u16 mode
)
344 err
= spu_write_u16(card
, IF_SPI_SPU_BUS_MODE_REG
, mode
);
347 /* Check that we were able to read back what we just wrote. */
348 err
= spu_read_u16(card
, IF_SPI_SPU_BUS_MODE_REG
, &rval
);
351 if ((rval
& 0xF) != mode
) {
352 lbs_pr_err("Can't read bus mode register.\n");
358 static int spu_init(struct if_spi_card
*card
, int use_dummy_writes
)
363 /* We have to start up in timed delay mode so that we can safely
364 * read the Delay Read Register. */
365 card
->use_dummy_writes
= 0;
366 err
= spu_set_bus_mode(card
,
367 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING
|
368 IF_SPI_BUS_MODE_DELAY_METHOD_TIMED
|
369 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA
);
372 card
->spu_port_delay
= 1000;
373 card
->spu_reg_delay
= 1000;
374 err
= spu_read_u32(card
, IF_SPI_DELAY_READ_REG
, &delay
);
377 card
->spu_port_delay
= delay
& 0x0000ffff;
378 card
->spu_reg_delay
= (delay
& 0xffff0000) >> 16;
380 /* If dummy clock delay mode has been requested, switch to it now */
381 if (use_dummy_writes
) {
382 card
->use_dummy_writes
= 1;
383 err
= spu_set_bus_mode(card
,
384 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING
|
385 IF_SPI_BUS_MODE_DELAY_METHOD_DUMMY_CLOCK
|
386 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA
);
391 lbs_deb_spi("Initialized SPU unit. "
392 "spu_port_delay=0x%04lx, spu_reg_delay=0x%04lx\n",
393 card
->spu_port_delay
, card
->spu_reg_delay
);
401 static int if_spi_prog_helper_firmware(struct if_spi_card
*card
)
404 const struct firmware
*firmware
= NULL
;
407 u8 temp
[HELPER_FW_LOAD_CHUNK_SZ
];
408 struct spi_device
*spi
= card
->spi
;
410 lbs_deb_enter(LBS_DEB_SPI
);
412 err
= spu_set_interrupt_mode(card
, 1, 0);
415 /* Get helper firmware image */
416 err
= request_firmware(&firmware
, card
->helper_fw_name
, &spi
->dev
);
418 lbs_pr_err("request_firmware failed with err = %d\n", err
);
421 bytes_remaining
= firmware
->size
;
424 /* Load helper firmware image */
425 while (bytes_remaining
> 0) {
426 /* Scratch pad 1 should contain the number of bytes we
427 * want to download to the firmware */
428 err
= spu_write_u16(card
, IF_SPI_SCRATCH_1_REG
,
429 HELPER_FW_LOAD_CHUNK_SZ
);
431 goto release_firmware
;
433 err
= spu_wait_for_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
434 IF_SPI_HIST_CMD_DOWNLOAD_RDY
,
435 IF_SPI_HIST_CMD_DOWNLOAD_RDY
);
437 goto release_firmware
;
439 /* Feed the data into the command read/write port reg
440 * in chunks of 64 bytes */
441 memset(temp
, 0, sizeof(temp
));
443 min(bytes_remaining
, HELPER_FW_LOAD_CHUNK_SZ
));
445 err
= spu_write(card
, IF_SPI_CMD_RDWRPORT_REG
,
446 temp
, HELPER_FW_LOAD_CHUNK_SZ
);
448 goto release_firmware
;
450 /* Interrupt the boot code */
451 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
, 0);
453 goto release_firmware
;
454 err
= spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
,
455 IF_SPI_CIC_CMD_DOWNLOAD_OVER
);
457 goto release_firmware
;
458 bytes_remaining
-= HELPER_FW_LOAD_CHUNK_SZ
;
459 fw
+= HELPER_FW_LOAD_CHUNK_SZ
;
462 /* Once the helper / single stage firmware download is complete,
463 * write 0 to scratch pad 1 and interrupt the
464 * bootloader. This completes the helper download. */
465 err
= spu_write_u16(card
, IF_SPI_SCRATCH_1_REG
, FIRMWARE_DNLD_OK
);
467 goto release_firmware
;
468 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
, 0);
470 goto release_firmware
;
471 err
= spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
,
472 IF_SPI_CIC_CMD_DOWNLOAD_OVER
);
473 goto release_firmware
;
475 lbs_deb_spi("waiting for helper to boot...\n");
478 release_firmware(firmware
);
481 lbs_pr_err("failed to load helper firmware (err=%d)\n", err
);
482 lbs_deb_leave_args(LBS_DEB_SPI
, "err %d", err
);
486 /* Returns the length of the next packet the firmware expects us to send
487 * Sets crc_err if the previous transfer had a CRC error. */
488 static int if_spi_prog_main_firmware_check_len(struct if_spi_card
*card
,
494 /* wait until the host interrupt status register indicates
495 * that we are ready to download */
496 err
= spu_wait_for_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
497 IF_SPI_HIST_CMD_DOWNLOAD_RDY
,
498 IF_SPI_HIST_CMD_DOWNLOAD_RDY
);
500 lbs_pr_err("timed out waiting for host_int_status\n");
504 /* Ask the device how many bytes of firmware it wants. */
505 err
= spu_read_u16(card
, IF_SPI_SCRATCH_1_REG
, &len
);
509 if (len
> IF_SPI_CMD_BUF_SIZE
) {
510 lbs_pr_err("firmware load device requested a larger "
511 "tranfer than we are prepared to "
512 "handle. (len = %d)\n", len
);
516 lbs_deb_spi("%s: crc error\n", __func__
);
525 static int if_spi_prog_main_firmware(struct if_spi_card
*card
)
528 int bytes
, crc_err
= 0, err
= 0;
529 const struct firmware
*firmware
= NULL
;
531 struct spi_device
*spi
= card
->spi
;
534 lbs_deb_enter(LBS_DEB_SPI
);
536 err
= spu_set_interrupt_mode(card
, 1, 0);
540 /* Get firmware image */
541 err
= request_firmware(&firmware
, card
->main_fw_name
, &spi
->dev
);
543 lbs_pr_err("%s: can't get firmware '%s' from kernel. "
544 "err = %d\n", __func__
, card
->main_fw_name
, err
);
548 err
= spu_wait_for_u16(card
, IF_SPI_SCRATCH_1_REG
, 0, 0);
550 lbs_pr_err("%s: timed out waiting for initial "
551 "scratch reg = 0\n", __func__
);
552 goto release_firmware
;
557 bytes
= firmware
->size
;
559 while ((len
= if_spi_prog_main_firmware_check_len(card
, &crc_err
))) {
562 goto release_firmware
;
565 /* If there are no more bytes left, we would normally
566 * expect to have terminated with len = 0 */
567 lbs_pr_err("Firmware load wants more bytes "
568 "than we have to offer.\n");
572 /* Previous transfer failed. */
573 if (++num_crc_errs
> MAX_MAIN_FW_LOAD_CRC_ERR
) {
574 lbs_pr_err("Too many CRC errors encountered "
575 "in firmware load.\n");
577 goto release_firmware
;
580 /* Previous transfer succeeded. Advance counters. */
585 memset(card
->cmd_buffer
, 0, len
);
586 memcpy(card
->cmd_buffer
, fw
, bytes
);
588 memcpy(card
->cmd_buffer
, fw
, len
);
590 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
, 0);
592 goto release_firmware
;
593 err
= spu_write(card
, IF_SPI_CMD_RDWRPORT_REG
,
594 card
->cmd_buffer
, len
);
596 goto release_firmware
;
597 err
= spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
,
598 IF_SPI_CIC_CMD_DOWNLOAD_OVER
);
600 goto release_firmware
;
603 if (bytes
> prev_len
) {
604 lbs_pr_err("firmware load wants fewer bytes than "
605 "we have to offer.\n");
608 /* Confirm firmware download */
609 err
= spu_wait_for_u32(card
, IF_SPI_SCRATCH_4_REG
,
610 SUCCESSFUL_FW_DOWNLOAD_MAGIC
);
612 lbs_pr_err("failed to confirm the firmware download\n");
613 goto release_firmware
;
617 release_firmware(firmware
);
621 lbs_pr_err("failed to load firmware (err=%d)\n", err
);
622 lbs_deb_leave_args(LBS_DEB_SPI
, "err %d", err
);
627 * SPI Transfer Thread
629 * The SPI thread handles all SPI transfers, so there is no need for a lock.
632 /* Move a command from the card to the host */
633 static int if_spi_c2h_cmd(struct if_spi_card
*card
)
635 struct lbs_private
*priv
= card
->priv
;
641 /* We need a buffer big enough to handle whatever people send to
643 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE
< LBS_CMD_BUFFER_SIZE
);
644 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE
< LBS_UPLD_SIZE
);
646 /* It's just annoying if the buffer size isn't a multiple of 4, because
647 * then we might have len < IF_SPI_CMD_BUF_SIZE but
648 * ALIGN(len, 4) > IF_SPI_CMD_BUF_SIZE */
649 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE
% 4 != 0);
651 lbs_deb_enter(LBS_DEB_SPI
);
653 /* How many bytes are there to read? */
654 err
= spu_read_u16(card
, IF_SPI_SCRATCH_2_REG
, &len
);
658 lbs_pr_err("%s: error: card has no data for host\n",
662 } else if (len
> IF_SPI_CMD_BUF_SIZE
) {
663 lbs_pr_err("%s: error: response packet too large: "
664 "%d bytes, but maximum is %d\n",
665 __func__
, len
, IF_SPI_CMD_BUF_SIZE
);
670 /* Read the data from the WLAN module into our command buffer */
671 err
= spu_read(card
, IF_SPI_CMD_RDWRPORT_REG
,
672 card
->cmd_buffer
, ALIGN(len
, 4));
676 spin_lock_irqsave(&priv
->driver_lock
, flags
);
677 i
= (priv
->resp_idx
== 0) ? 1 : 0;
678 BUG_ON(priv
->resp_len
[i
]);
679 priv
->resp_len
[i
] = len
;
680 memcpy(priv
->resp_buf
[i
], card
->cmd_buffer
, len
);
681 lbs_notify_command_response(priv
, i
);
682 spin_unlock_irqrestore(&priv
->driver_lock
, flags
);
686 lbs_pr_err("%s: err=%d\n", __func__
, err
);
687 lbs_deb_leave(LBS_DEB_SPI
);
691 /* Move data from the card to the host */
692 static int if_spi_c2h_data(struct if_spi_card
*card
)
699 lbs_deb_enter(LBS_DEB_SPI
);
701 /* How many bytes are there to read? */
702 err
= spu_read_u16(card
, IF_SPI_SCRATCH_1_REG
, &len
);
706 lbs_pr_err("%s: error: card has no data for host\n",
710 } else if (len
> MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
) {
711 lbs_pr_err("%s: error: card has %d bytes of data, but "
712 "our maximum skb size is %zu\n",
713 __func__
, len
, MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
);
718 /* TODO: should we allocate a smaller skb if we have less data? */
719 skb
= dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
);
724 skb_reserve(skb
, IPFIELD_ALIGN_OFFSET
);
725 data
= skb_put(skb
, len
);
727 /* Read the data from the WLAN module into our skb... */
728 err
= spu_read(card
, IF_SPI_DATA_RDWRPORT_REG
, data
, ALIGN(len
, 4));
732 /* pass the SKB to libertas */
733 err
= lbs_process_rxed_packet(card
->priv
, skb
);
744 lbs_pr_err("%s: err=%d\n", __func__
, err
);
745 lbs_deb_leave(LBS_DEB_SPI
);
749 /* Inform the host about a card event */
750 static void if_spi_e2h(struct if_spi_card
*card
)
754 struct lbs_private
*priv
= card
->priv
;
756 err
= spu_read_u32(card
, IF_SPI_SCRATCH_3_REG
, &cause
);
760 /* re-enable the card event interrupt */
761 spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
762 ~IF_SPI_HICU_CARD_EVENT
);
764 /* generate a card interrupt */
765 spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
, IF_SPI_CIC_HOST_EVENT
);
767 lbs_queue_event(priv
, cause
& 0xff);
770 lbs_pr_err("%s: error %d\n", __func__
, err
);
773 static int lbs_spi_thread(void *data
)
776 struct if_spi_card
*card
= data
;
780 /* Wait to be woken up by one of two things. First, our ISR
781 * could tell us that something happened on the WLAN.
782 * Secondly, libertas could call hw_host_to_card with more
783 * data, which we might be able to send.
786 err
= down_interruptible(&card
->spi_ready
);
787 if (!card
->run_thread
) {
788 up(&card
->spi_thread_terminated
);
791 } while (err
== EINTR
);
793 /* Read the host interrupt status register to see what we
795 err
= spu_read_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
798 lbs_pr_err("I/O error\n");
802 if (hiStatus
& IF_SPI_HIST_CMD_UPLOAD_RDY
)
803 err
= if_spi_c2h_cmd(card
);
806 if (hiStatus
& IF_SPI_HIST_RX_UPLOAD_RDY
)
807 err
= if_spi_c2h_data(card
);
811 /* workaround: in PS mode, the card does not set the Command
812 * Download Ready bit, but it sets TX Download Ready. */
813 if (hiStatus
& IF_SPI_HIST_CMD_DOWNLOAD_RDY
||
814 (card
->priv
->psstate
!= PS_STATE_FULL_POWER
&&
815 (hiStatus
& IF_SPI_HIST_TX_DOWNLOAD_RDY
))) {
816 lbs_host_to_card_done(card
->priv
);
819 if (hiStatus
& IF_SPI_HIST_CARD_EVENT
)
824 lbs_pr_err("%s: got error %d\n", __func__
, err
);
828 /* Block until lbs_spi_thread thread has terminated */
829 static void if_spi_terminate_spi_thread(struct if_spi_card
*card
)
831 /* It would be nice to use kthread_stop here, but that function
832 * can't wake threads waiting for a semaphore. */
833 card
->run_thread
= 0;
834 up(&card
->spi_ready
);
835 down(&card
->spi_thread_terminated
);
841 * Called from Libertas to transfer some data to the WLAN device
842 * We can't sleep here. */
843 static int if_spi_host_to_card(struct lbs_private
*priv
,
844 u8 type
, u8
*buf
, u16 nb
)
847 struct if_spi_card
*card
= priv
->card
;
849 lbs_deb_enter_args(LBS_DEB_SPI
, "type %d, bytes %d", type
, nb
);
855 err
= spu_write(card
, IF_SPI_CMD_RDWRPORT_REG
, buf
, nb
);
858 err
= spu_write(card
, IF_SPI_DATA_RDWRPORT_REG
, buf
, nb
);
861 lbs_pr_err("can't transfer buffer of type %d", type
);
866 lbs_deb_leave_args(LBS_DEB_SPI
, "err=%d", err
);
873 * Service incoming interrupts from the WLAN device. We can't sleep here, so
874 * don't try to talk on the SPI bus, just wake up the SPI thread.
876 static irqreturn_t
if_spi_host_interrupt(int irq
, void *dev_id
)
878 struct if_spi_card
*card
= dev_id
;
880 up(&card
->spi_ready
);
888 static int if_spi_calculate_fw_names(u16 card_id
,
889 char *helper_fw
, char *main_fw
)
892 for (i
= 0; i
< ARRAY_SIZE(chip_id_to_device_name
); ++i
) {
893 if (card_id
== chip_id_to_device_name
[i
].chip_id
)
896 if (i
== ARRAY_SIZE(chip_id_to_device_name
)) {
897 lbs_pr_err("Unsupported chip_id: 0x%02x\n", card_id
);
898 return -EAFNOSUPPORT
;
900 snprintf(helper_fw
, IF_SPI_FW_NAME_MAX
, "libertas/gspi%d_hlp.bin",
901 chip_id_to_device_name
[i
].name
);
902 snprintf(main_fw
, IF_SPI_FW_NAME_MAX
, "libertas/gspi%d.bin",
903 chip_id_to_device_name
[i
].name
);
906 MODULE_FIRMWARE("libertas/gspi8385_hlp.bin");
907 MODULE_FIRMWARE("libertas/gspi8385.bin");
908 MODULE_FIRMWARE("libertas/gspi8686_hlp.bin");
909 MODULE_FIRMWARE("libertas/gspi8686.bin");
911 static int __devinit
if_spi_probe(struct spi_device
*spi
)
913 struct if_spi_card
*card
;
914 struct lbs_private
*priv
= NULL
;
915 struct libertas_spi_platform_data
*pdata
= spi
->dev
.platform_data
;
918 struct sched_param param
= { .sched_priority
= 1 };
920 lbs_deb_enter(LBS_DEB_SPI
);
928 err
= pdata
->setup(spi
);
933 /* Allocate card structure to represent this specific device */
934 card
= kzalloc(sizeof(struct if_spi_card
), GFP_KERNEL
);
939 spi_set_drvdata(spi
, card
);
942 card
->prev_xfer_time
= jiffies
;
944 sema_init(&card
->spi_ready
, 0);
945 sema_init(&card
->spi_thread_terminated
, 0);
947 /* Initialize the SPI Interface Unit */
948 err
= spu_init(card
, pdata
->use_dummy_writes
);
951 err
= spu_get_chip_revision(card
, &card
->card_id
, &card
->card_rev
);
956 err
= spu_read_u32(card
, IF_SPI_SCRATCH_4_REG
, &scratch
);
959 if (scratch
== SUCCESSFUL_FW_DOWNLOAD_MAGIC
)
960 lbs_deb_spi("Firmware is already loaded for "
961 "Marvell WLAN 802.11 adapter\n");
963 err
= if_spi_calculate_fw_names(card
->card_id
,
964 card
->helper_fw_name
, card
->main_fw_name
);
968 lbs_deb_spi("Initializing FW for Marvell WLAN 802.11 adapter "
969 "(chip_id = 0x%04x, chip_rev = 0x%02x) "
970 "attached to SPI bus_num %d, chip_select %d. "
971 "spi->max_speed_hz=%d\n",
972 card
->card_id
, card
->card_rev
,
973 spi
->master
->bus_num
, spi
->chip_select
,
975 err
= if_spi_prog_helper_firmware(card
);
978 err
= if_spi_prog_main_firmware(card
);
981 lbs_deb_spi("loaded FW for Marvell WLAN 802.11 adapter\n");
984 err
= spu_set_interrupt_mode(card
, 0, 1);
988 /* Register our card with libertas.
989 * This will call alloc_etherdev */
990 priv
= lbs_add_card(card
, &spi
->dev
);
997 priv
->hw_host_to_card
= if_spi_host_to_card
;
998 priv
->enter_deep_sleep
= NULL
;
999 priv
->exit_deep_sleep
= NULL
;
1000 priv
->reset_deep_sleep_wakeup
= NULL
;
1003 /* Initialize interrupt handling stuff. */
1004 card
->run_thread
= 1;
1005 card
->spi_thread
= kthread_run(lbs_spi_thread
, card
, "lbs_spi_thread");
1006 if (IS_ERR(card
->spi_thread
)) {
1007 card
->run_thread
= 0;
1008 err
= PTR_ERR(card
->spi_thread
);
1009 lbs_pr_err("error creating SPI thread: err=%d\n", err
);
1012 if (sched_setscheduler(card
->spi_thread
, SCHED_FIFO
, ¶m
))
1013 lbs_pr_err("Error setting scheduler, using default.\n");
1015 err
= request_irq(spi
->irq
, if_spi_host_interrupt
,
1016 IRQF_TRIGGER_FALLING
, "libertas_spi", card
);
1018 lbs_pr_err("can't get host irq line-- request_irq failed\n");
1019 goto terminate_thread
;
1022 /* poke the IRQ handler so that we don't miss the first interrupt */
1023 up(&card
->spi_ready
);
1026 * This will call register_netdev, and we'll start
1027 * getting interrupts... */
1028 err
= lbs_start_card(priv
);
1032 lbs_deb_spi("Finished initializing WLAN module.\n");
1034 /* successful exit */
1038 free_irq(spi
->irq
, card
);
1040 if_spi_terminate_spi_thread(card
);
1042 lbs_remove_card(priv
); /* will call free_netdev */
1044 free_if_spi_card(card
);
1046 lbs_deb_leave_args(LBS_DEB_SPI
, "err %d\n", err
);
1050 static int __devexit
libertas_spi_remove(struct spi_device
*spi
)
1052 struct if_spi_card
*card
= spi_get_drvdata(spi
);
1053 struct lbs_private
*priv
= card
->priv
;
1055 lbs_deb_spi("libertas_spi_remove\n");
1056 lbs_deb_enter(LBS_DEB_SPI
);
1058 lbs_stop_card(priv
);
1059 lbs_remove_card(priv
); /* will call free_netdev */
1061 priv
->surpriseremoved
= 1;
1062 free_irq(spi
->irq
, card
);
1063 if_spi_terminate_spi_thread(card
);
1064 if (card
->pdata
->teardown
)
1065 card
->pdata
->teardown(spi
);
1066 free_if_spi_card(card
);
1067 lbs_deb_leave(LBS_DEB_SPI
);
1071 static struct spi_driver libertas_spi_driver
= {
1072 .probe
= if_spi_probe
,
1073 .remove
= __devexit_p(libertas_spi_remove
),
1075 .name
= "libertas_spi",
1076 .bus
= &spi_bus_type
,
1077 .owner
= THIS_MODULE
,
1085 static int __init
if_spi_init_module(void)
1088 lbs_deb_enter(LBS_DEB_SPI
);
1089 printk(KERN_INFO
"libertas_spi: Libertas SPI driver\n");
1090 ret
= spi_register_driver(&libertas_spi_driver
);
1091 lbs_deb_leave(LBS_DEB_SPI
);
1095 static void __exit
if_spi_exit_module(void)
1097 lbs_deb_enter(LBS_DEB_SPI
);
1098 spi_unregister_driver(&libertas_spi_driver
);
1099 lbs_deb_leave(LBS_DEB_SPI
);
1102 module_init(if_spi_init_module
);
1103 module_exit(if_spi_exit_module
);
1105 MODULE_DESCRIPTION("Libertas SPI WLAN Driver");
1106 MODULE_AUTHOR("Andrey Yurovsky <andrey@cozybit.com>, "
1107 "Colin McCabe <colin@cozybit.com>");
1108 MODULE_LICENSE("GPL");
1109 MODULE_ALIAS("spi:libertas_spi");