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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22 #include <linux/hardirq.h>
23 #include <linux/interrupt.h>
24 #include <linux/module.h>
25 #include <linux/firmware.h>
26 #include <linux/jiffies.h>
27 #include <linux/list.h>
28 #include <linux/netdevice.h>
29 #include <linux/slab.h>
30 #include <linux/spi/libertas_spi.h>
31 #include <linux/spi/spi.h>
39 struct if_spi_packet
{
40 struct list_head list
;
42 u8 buffer
[0] __attribute__((aligned(4)));
46 struct spi_device
*spi
;
47 struct lbs_private
*priv
;
48 struct libertas_spi_platform_data
*pdata
;
50 /* The card ID and card revision, as reported by the hardware. */
54 /* The last time that we initiated an SPU operation */
55 unsigned long prev_xfer_time
;
58 unsigned long spu_port_delay
;
59 unsigned long spu_reg_delay
;
61 /* Handles all SPI communication (except for FW load) */
62 struct workqueue_struct
*workqueue
;
63 struct work_struct packet_work
;
64 struct work_struct resume_work
;
66 u8 cmd_buffer
[IF_SPI_CMD_BUF_SIZE
];
68 /* A buffer of incoming packets from libertas core.
69 * Since we can't sleep in hw_host_to_card, we have to buffer
71 struct list_head cmd_packet_list
;
72 struct list_head data_packet_list
;
74 /* Protects cmd_packet_list and data_packet_list */
75 spinlock_t buffer_lock
;
77 /* True is card suspended */
81 static void free_if_spi_card(struct if_spi_card
*card
)
83 struct list_head
*cursor
, *next
;
84 struct if_spi_packet
*packet
;
86 list_for_each_safe(cursor
, next
, &card
->cmd_packet_list
) {
87 packet
= container_of(cursor
, struct if_spi_packet
, list
);
88 list_del(&packet
->list
);
91 list_for_each_safe(cursor
, next
, &card
->data_packet_list
) {
92 packet
= container_of(cursor
, struct if_spi_packet
, list
);
93 list_del(&packet
->list
);
99 #define MODEL_8385 0x04
100 #define MODEL_8686 0x0b
101 #define MODEL_8688 0x10
103 static const struct lbs_fw_table fw_table
[] = {
104 { MODEL_8385
, "libertas/gspi8385_helper.bin", "libertas/gspi8385.bin" },
105 { MODEL_8385
, "libertas/gspi8385_hlp.bin", "libertas/gspi8385.bin" },
106 { MODEL_8686
, "libertas/gspi8686_v9_helper.bin", "libertas/gspi8686_v9.bin" },
107 { MODEL_8686
, "libertas/gspi8686_hlp.bin", "libertas/gspi8686.bin" },
108 { MODEL_8688
, "libertas/gspi8688_helper.bin", "libertas/gspi8688.bin" },
111 MODULE_FIRMWARE("libertas/gspi8385_helper.bin");
112 MODULE_FIRMWARE("libertas/gspi8385_hlp.bin");
113 MODULE_FIRMWARE("libertas/gspi8385.bin");
114 MODULE_FIRMWARE("libertas/gspi8686_v9_helper.bin");
115 MODULE_FIRMWARE("libertas/gspi8686_v9.bin");
116 MODULE_FIRMWARE("libertas/gspi8686_hlp.bin");
117 MODULE_FIRMWARE("libertas/gspi8686.bin");
118 MODULE_FIRMWARE("libertas/gspi8688_helper.bin");
119 MODULE_FIRMWARE("libertas/gspi8688.bin");
123 * SPI Interface Unit Routines
125 * The SPU sits between the host and the WLAN module.
126 * All communication with the firmware is through SPU transactions.
128 * First we have to put a SPU register name on the bus. Then we can
129 * either read from or write to that register.
133 static void spu_transaction_init(struct if_spi_card
*card
)
135 if (!time_after(jiffies
, card
->prev_xfer_time
+ 1)) {
136 /* Unfortunately, the SPU requires a delay between successive
137 * transactions. If our last transaction was more than a jiffy
138 * ago, we have obviously already delayed enough.
139 * If not, we have to busy-wait to be on the safe side. */
144 static void spu_transaction_finish(struct if_spi_card
*card
)
146 card
->prev_xfer_time
= jiffies
;
150 * Write out a byte buffer to an SPI register,
151 * using a series of 16-bit transfers.
153 static int spu_write(struct if_spi_card
*card
, u16 reg
, const u8
*buf
, int len
)
156 __le16 reg_out
= cpu_to_le16(reg
| IF_SPI_WRITE_OPERATION_MASK
);
157 struct spi_message m
;
158 struct spi_transfer reg_trans
;
159 struct spi_transfer data_trans
;
161 spi_message_init(&m
);
162 memset(®_trans
, 0, sizeof(reg_trans
));
163 memset(&data_trans
, 0, sizeof(data_trans
));
165 /* You must give an even number of bytes to the SPU, even if it
166 * doesn't care about the last one. */
169 spu_transaction_init(card
);
171 /* write SPU register index */
172 reg_trans
.tx_buf
= ®_out
;
173 reg_trans
.len
= sizeof(reg_out
);
175 data_trans
.tx_buf
= buf
;
176 data_trans
.len
= len
;
178 spi_message_add_tail(®_trans
, &m
);
179 spi_message_add_tail(&data_trans
, &m
);
181 err
= spi_sync(card
->spi
, &m
);
182 spu_transaction_finish(card
);
186 static inline int spu_write_u16(struct if_spi_card
*card
, u16 reg
, u16 val
)
190 buff
= cpu_to_le16(val
);
191 return spu_write(card
, reg
, (u8
*)&buff
, sizeof(u16
));
194 static inline int spu_reg_is_port_reg(u16 reg
)
197 case IF_SPI_IO_RDWRPORT_REG
:
198 case IF_SPI_CMD_RDWRPORT_REG
:
199 case IF_SPI_DATA_RDWRPORT_REG
:
206 static int spu_read(struct if_spi_card
*card
, u16 reg
, u8
*buf
, int len
)
210 __le16 reg_out
= cpu_to_le16(reg
| IF_SPI_READ_OPERATION_MASK
);
211 struct spi_message m
;
212 struct spi_transfer reg_trans
;
213 struct spi_transfer dummy_trans
;
214 struct spi_transfer data_trans
;
217 * You must take an even number of bytes from the SPU, even if you
218 * don't care about the last one.
222 spu_transaction_init(card
);
224 spi_message_init(&m
);
225 memset(®_trans
, 0, sizeof(reg_trans
));
226 memset(&dummy_trans
, 0, sizeof(dummy_trans
));
227 memset(&data_trans
, 0, sizeof(data_trans
));
229 /* write SPU register index */
230 reg_trans
.tx_buf
= ®_out
;
231 reg_trans
.len
= sizeof(reg_out
);
232 spi_message_add_tail(®_trans
, &m
);
234 delay
= spu_reg_is_port_reg(reg
) ? card
->spu_port_delay
:
236 if (card
->use_dummy_writes
) {
237 /* Clock in dummy cycles while the SPU fills the FIFO */
238 dummy_trans
.len
= delay
/ 8;
239 spi_message_add_tail(&dummy_trans
, &m
);
241 /* Busy-wait while the SPU fills the FIFO */
242 reg_trans
.delay_usecs
=
243 DIV_ROUND_UP((100 + (delay
* 10)), 1000);
247 data_trans
.rx_buf
= buf
;
248 data_trans
.len
= len
;
249 spi_message_add_tail(&data_trans
, &m
);
251 err
= spi_sync(card
->spi
, &m
);
252 spu_transaction_finish(card
);
256 /* Read 16 bits from an SPI register */
257 static inline int spu_read_u16(struct if_spi_card
*card
, u16 reg
, u16
*val
)
262 ret
= spu_read(card
, reg
, (u8
*)&buf
, sizeof(buf
));
264 *val
= le16_to_cpup(&buf
);
269 * Read 32 bits from an SPI register.
270 * The low 16 bits are read first.
272 static int spu_read_u32(struct if_spi_card
*card
, u16 reg
, u32
*val
)
277 err
= spu_read(card
, reg
, (u8
*)&buf
, sizeof(buf
));
279 *val
= le32_to_cpup(&buf
);
284 * Keep reading 16 bits from an SPI register until you get the correct result.
286 * If mask = 0, the correct result is any non-zero number.
287 * If mask != 0, the correct result is any number where
288 * number & target_mask == target
290 * Returns -ETIMEDOUT if a second passes without the correct result.
292 static int spu_wait_for_u16(struct if_spi_card
*card
, u16 reg
,
293 u16 target_mask
, u16 target
)
296 unsigned long timeout
= jiffies
+ 5*HZ
;
299 err
= spu_read_u16(card
, reg
, &val
);
303 if ((val
& target_mask
) == target
)
310 if (time_after(jiffies
, timeout
)) {
311 pr_err("%s: timeout with val=%02x, target_mask=%02x, target=%02x\n",
312 __func__
, val
, target_mask
, target
);
319 * Read 16 bits from an SPI register until you receive a specific value.
320 * Returns -ETIMEDOUT if a 4 tries pass without success.
322 static int spu_wait_for_u32(struct if_spi_card
*card
, u32 reg
, u32 target
)
325 for (try = 0; try < 4; ++try) {
327 err
= spu_read_u32(card
, reg
, &val
);
337 static int spu_set_interrupt_mode(struct if_spi_card
*card
,
338 int suppress_host_int
,
344 * We can suppress a host interrupt by clearing the appropriate
345 * bit in the "host interrupt status mask" register
347 if (suppress_host_int
) {
348 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_MASK_REG
, 0);
352 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_MASK_REG
,
353 IF_SPI_HISM_TX_DOWNLOAD_RDY
|
354 IF_SPI_HISM_RX_UPLOAD_RDY
|
355 IF_SPI_HISM_CMD_DOWNLOAD_RDY
|
356 IF_SPI_HISM_CARDEVENT
|
357 IF_SPI_HISM_CMD_UPLOAD_RDY
);
363 * If auto-interrupts are on, the completion of certain transactions
364 * will trigger an interrupt automatically. If auto-interrupts
365 * are off, we need to set the "Card Interrupt Cause" register to
366 * trigger a card interrupt.
369 err
= spu_write_u16(card
, IF_SPI_HOST_INT_CTRL_REG
,
370 IF_SPI_HICT_TX_DOWNLOAD_OVER_AUTO
|
371 IF_SPI_HICT_RX_UPLOAD_OVER_AUTO
|
372 IF_SPI_HICT_CMD_DOWNLOAD_OVER_AUTO
|
373 IF_SPI_HICT_CMD_UPLOAD_OVER_AUTO
);
377 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_MASK_REG
, 0);
384 static int spu_get_chip_revision(struct if_spi_card
*card
,
385 u16
*card_id
, u8
*card_rev
)
389 err
= spu_read_u32(card
, IF_SPI_DEVICEID_CTRL_REG
, &dev_ctrl
);
392 *card_id
= IF_SPI_DEVICEID_CTRL_REG_TO_CARD_ID(dev_ctrl
);
393 *card_rev
= IF_SPI_DEVICEID_CTRL_REG_TO_CARD_REV(dev_ctrl
);
397 static int spu_set_bus_mode(struct if_spi_card
*card
, u16 mode
)
402 err
= spu_write_u16(card
, IF_SPI_SPU_BUS_MODE_REG
, mode
);
405 /* Check that we were able to read back what we just wrote. */
406 err
= spu_read_u16(card
, IF_SPI_SPU_BUS_MODE_REG
, &rval
);
409 if ((rval
& 0xF) != mode
) {
410 pr_err("Can't read bus mode register\n");
416 static int spu_init(struct if_spi_card
*card
, int use_dummy_writes
)
422 * We have to start up in timed delay mode so that we can safely
423 * read the Delay Read Register.
425 card
->use_dummy_writes
= 0;
426 err
= spu_set_bus_mode(card
,
427 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING
|
428 IF_SPI_BUS_MODE_DELAY_METHOD_TIMED
|
429 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA
);
432 card
->spu_port_delay
= 1000;
433 card
->spu_reg_delay
= 1000;
434 err
= spu_read_u32(card
, IF_SPI_DELAY_READ_REG
, &delay
);
437 card
->spu_port_delay
= delay
& 0x0000ffff;
438 card
->spu_reg_delay
= (delay
& 0xffff0000) >> 16;
440 /* If dummy clock delay mode has been requested, switch to it now */
441 if (use_dummy_writes
) {
442 card
->use_dummy_writes
= 1;
443 err
= spu_set_bus_mode(card
,
444 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING
|
445 IF_SPI_BUS_MODE_DELAY_METHOD_DUMMY_CLOCK
|
446 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA
);
451 lbs_deb_spi("Initialized SPU unit. "
452 "spu_port_delay=0x%04lx, spu_reg_delay=0x%04lx\n",
453 card
->spu_port_delay
, card
->spu_reg_delay
);
461 static int if_spi_prog_helper_firmware(struct if_spi_card
*card
,
462 const struct firmware
*firmware
)
467 u8 temp
[HELPER_FW_LOAD_CHUNK_SZ
];
469 lbs_deb_enter(LBS_DEB_SPI
);
471 err
= spu_set_interrupt_mode(card
, 1, 0);
475 bytes_remaining
= firmware
->size
;
478 /* Load helper firmware image */
479 while (bytes_remaining
> 0) {
481 * Scratch pad 1 should contain the number of bytes we
482 * want to download to the firmware
484 err
= spu_write_u16(card
, IF_SPI_SCRATCH_1_REG
,
485 HELPER_FW_LOAD_CHUNK_SZ
);
489 err
= spu_wait_for_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
490 IF_SPI_HIST_CMD_DOWNLOAD_RDY
,
491 IF_SPI_HIST_CMD_DOWNLOAD_RDY
);
496 * Feed the data into the command read/write port reg
497 * in chunks of 64 bytes
499 memset(temp
, 0, sizeof(temp
));
501 min(bytes_remaining
, HELPER_FW_LOAD_CHUNK_SZ
));
503 err
= spu_write(card
, IF_SPI_CMD_RDWRPORT_REG
,
504 temp
, HELPER_FW_LOAD_CHUNK_SZ
);
508 /* Interrupt the boot code */
509 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
, 0);
512 err
= spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
,
513 IF_SPI_CIC_CMD_DOWNLOAD_OVER
);
516 bytes_remaining
-= HELPER_FW_LOAD_CHUNK_SZ
;
517 fw
+= HELPER_FW_LOAD_CHUNK_SZ
;
521 * Once the helper / single stage firmware download is complete,
522 * write 0 to scratch pad 1 and interrupt the
523 * bootloader. This completes the helper download.
525 err
= spu_write_u16(card
, IF_SPI_SCRATCH_1_REG
, FIRMWARE_DNLD_OK
);
528 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
, 0);
531 err
= spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
,
532 IF_SPI_CIC_CMD_DOWNLOAD_OVER
);
535 pr_err("failed to load helper firmware (err=%d)\n", err
);
536 lbs_deb_leave_args(LBS_DEB_SPI
, "err %d", err
);
541 * Returns the length of the next packet the firmware expects us to send.
542 * Sets crc_err if the previous transfer had a CRC error.
544 static int if_spi_prog_main_firmware_check_len(struct if_spi_card
*card
,
551 * wait until the host interrupt status register indicates
552 * that we are ready to download
554 err
= spu_wait_for_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
555 IF_SPI_HIST_CMD_DOWNLOAD_RDY
,
556 IF_SPI_HIST_CMD_DOWNLOAD_RDY
);
558 pr_err("timed out waiting for host_int_status\n");
562 /* Ask the device how many bytes of firmware it wants. */
563 err
= spu_read_u16(card
, IF_SPI_SCRATCH_1_REG
, &len
);
567 if (len
> IF_SPI_CMD_BUF_SIZE
) {
568 pr_err("firmware load device requested a larger transfer than we are prepared to handle (len = %d)\n",
573 lbs_deb_spi("%s: crc error\n", __func__
);
582 static int if_spi_prog_main_firmware(struct if_spi_card
*card
,
583 const struct firmware
*firmware
)
585 struct lbs_private
*priv
= card
->priv
;
587 int bytes
, crc_err
= 0, err
= 0;
591 lbs_deb_enter(LBS_DEB_SPI
);
593 err
= spu_set_interrupt_mode(card
, 1, 0);
597 err
= spu_wait_for_u16(card
, IF_SPI_SCRATCH_1_REG
, 0, 0);
599 netdev_err(priv
->dev
,
600 "%s: timed out waiting for initial scratch reg = 0\n",
607 bytes
= firmware
->size
;
609 while ((len
= if_spi_prog_main_firmware_check_len(card
, &crc_err
))) {
616 * If there are no more bytes left, we would normally
617 * expect to have terminated with len = 0
619 netdev_err(priv
->dev
,
620 "Firmware load wants more bytes than we have to offer.\n");
624 /* Previous transfer failed. */
625 if (++num_crc_errs
> MAX_MAIN_FW_LOAD_CRC_ERR
) {
626 pr_err("Too many CRC errors encountered in firmware load.\n");
631 /* Previous transfer succeeded. Advance counters. */
636 memset(card
->cmd_buffer
, 0, len
);
637 memcpy(card
->cmd_buffer
, fw
, bytes
);
639 memcpy(card
->cmd_buffer
, fw
, len
);
641 err
= spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
, 0);
644 err
= spu_write(card
, IF_SPI_CMD_RDWRPORT_REG
,
645 card
->cmd_buffer
, len
);
648 err
= spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
,
649 IF_SPI_CIC_CMD_DOWNLOAD_OVER
);
654 if (bytes
> prev_len
) {
655 pr_err("firmware load wants fewer bytes than we have to offer\n");
658 /* Confirm firmware download */
659 err
= spu_wait_for_u32(card
, IF_SPI_SCRATCH_4_REG
,
660 SUCCESSFUL_FW_DOWNLOAD_MAGIC
);
662 pr_err("failed to confirm the firmware download\n");
668 pr_err("failed to load firmware (err=%d)\n", err
);
669 lbs_deb_leave_args(LBS_DEB_SPI
, "err %d", err
);
674 * SPI Transfer Thread
676 * The SPI worker handles all SPI transfers, so there is no need for a lock.
679 /* Move a command from the card to the host */
680 static int if_spi_c2h_cmd(struct if_spi_card
*card
)
682 struct lbs_private
*priv
= card
->priv
;
689 * We need a buffer big enough to handle whatever people send to
692 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE
< LBS_CMD_BUFFER_SIZE
);
693 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE
< LBS_UPLD_SIZE
);
696 * It's just annoying if the buffer size isn't a multiple of 4, because
697 * then we might have len < IF_SPI_CMD_BUF_SIZE but
698 * ALIGN(len, 4) > IF_SPI_CMD_BUF_SIZE
700 BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE
% 4 != 0);
702 lbs_deb_enter(LBS_DEB_SPI
);
704 /* How many bytes are there to read? */
705 err
= spu_read_u16(card
, IF_SPI_SCRATCH_2_REG
, &len
);
709 netdev_err(priv
->dev
, "%s: error: card has no data for host\n",
713 } else if (len
> IF_SPI_CMD_BUF_SIZE
) {
714 netdev_err(priv
->dev
,
715 "%s: error: response packet too large: %d bytes, but maximum is %d\n",
716 __func__
, len
, IF_SPI_CMD_BUF_SIZE
);
721 /* Read the data from the WLAN module into our command buffer */
722 err
= spu_read(card
, IF_SPI_CMD_RDWRPORT_REG
,
723 card
->cmd_buffer
, ALIGN(len
, 4));
727 spin_lock_irqsave(&priv
->driver_lock
, flags
);
728 i
= (priv
->resp_idx
== 0) ? 1 : 0;
729 BUG_ON(priv
->resp_len
[i
]);
730 priv
->resp_len
[i
] = len
;
731 memcpy(priv
->resp_buf
[i
], card
->cmd_buffer
, len
);
732 lbs_notify_command_response(priv
, i
);
733 spin_unlock_irqrestore(&priv
->driver_lock
, flags
);
737 netdev_err(priv
->dev
, "%s: err=%d\n", __func__
, err
);
738 lbs_deb_leave(LBS_DEB_SPI
);
742 /* Move data from the card to the host */
743 static int if_spi_c2h_data(struct if_spi_card
*card
)
745 struct lbs_private
*priv
= card
->priv
;
751 lbs_deb_enter(LBS_DEB_SPI
);
753 /* How many bytes are there to read? */
754 err
= spu_read_u16(card
, IF_SPI_SCRATCH_1_REG
, &len
);
758 netdev_err(priv
->dev
, "%s: error: card has no data for host\n",
762 } else if (len
> MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
) {
763 netdev_err(priv
->dev
,
764 "%s: error: card has %d bytes of data, but our maximum skb size is %zu\n",
765 __func__
, len
, MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
);
770 /* TODO: should we allocate a smaller skb if we have less data? */
771 skb
= dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE
);
776 skb_reserve(skb
, IPFIELD_ALIGN_OFFSET
);
777 data
= skb_put(skb
, len
);
779 /* Read the data from the WLAN module into our skb... */
780 err
= spu_read(card
, IF_SPI_DATA_RDWRPORT_REG
, data
, ALIGN(len
, 4));
784 /* pass the SKB to libertas */
785 err
= lbs_process_rxed_packet(card
->priv
, skb
);
796 netdev_err(priv
->dev
, "%s: err=%d\n", __func__
, err
);
797 lbs_deb_leave(LBS_DEB_SPI
);
801 /* Move data or a command from the host to the card. */
802 static void if_spi_h2c(struct if_spi_card
*card
,
803 struct if_spi_packet
*packet
, int type
)
805 struct lbs_private
*priv
= card
->priv
;
807 u16 int_type
, port_reg
;
811 int_type
= IF_SPI_CIC_TX_DOWNLOAD_OVER
;
812 port_reg
= IF_SPI_DATA_RDWRPORT_REG
;
815 int_type
= IF_SPI_CIC_CMD_DOWNLOAD_OVER
;
816 port_reg
= IF_SPI_CMD_RDWRPORT_REG
;
819 netdev_err(priv
->dev
, "can't transfer buffer of type %d\n",
825 /* Write the data to the card */
826 err
= spu_write(card
, port_reg
, packet
->buffer
, packet
->blen
);
834 netdev_err(priv
->dev
, "%s: error %d\n", __func__
, err
);
837 /* Inform the host about a card event */
838 static void if_spi_e2h(struct if_spi_card
*card
)
842 struct lbs_private
*priv
= card
->priv
;
844 err
= spu_read_u32(card
, IF_SPI_SCRATCH_3_REG
, &cause
);
848 /* re-enable the card event interrupt */
849 spu_write_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
850 ~IF_SPI_HICU_CARD_EVENT
);
852 /* generate a card interrupt */
853 spu_write_u16(card
, IF_SPI_CARD_INT_CAUSE_REG
, IF_SPI_CIC_HOST_EVENT
);
855 lbs_queue_event(priv
, cause
& 0xff);
858 netdev_err(priv
->dev
, "%s: error %d\n", __func__
, err
);
861 static void if_spi_host_to_card_worker(struct work_struct
*work
)
864 struct if_spi_card
*card
;
867 struct if_spi_packet
*packet
;
868 struct lbs_private
*priv
;
870 card
= container_of(work
, struct if_spi_card
, packet_work
);
873 lbs_deb_enter(LBS_DEB_SPI
);
876 * Read the host interrupt status register to see what we
879 err
= spu_read_u16(card
, IF_SPI_HOST_INT_STATUS_REG
,
882 netdev_err(priv
->dev
, "I/O error\n");
886 if (hiStatus
& IF_SPI_HIST_CMD_UPLOAD_RDY
) {
887 err
= if_spi_c2h_cmd(card
);
891 if (hiStatus
& IF_SPI_HIST_RX_UPLOAD_RDY
) {
892 err
= if_spi_c2h_data(card
);
898 * workaround: in PS mode, the card does not set the Command
899 * Download Ready bit, but it sets TX Download Ready.
901 if (hiStatus
& IF_SPI_HIST_CMD_DOWNLOAD_RDY
||
902 (card
->priv
->psstate
!= PS_STATE_FULL_POWER
&&
903 (hiStatus
& IF_SPI_HIST_TX_DOWNLOAD_RDY
))) {
905 * This means two things. First of all,
906 * if there was a previous command sent, the card has
907 * successfully received it.
908 * Secondly, it is now ready to download another
911 lbs_host_to_card_done(card
->priv
);
913 /* Do we have any command packets from the host to send? */
915 spin_lock_irqsave(&card
->buffer_lock
, flags
);
916 if (!list_empty(&card
->cmd_packet_list
)) {
917 packet
= (struct if_spi_packet
*)(card
->
918 cmd_packet_list
.next
);
919 list_del(&packet
->list
);
921 spin_unlock_irqrestore(&card
->buffer_lock
, flags
);
924 if_spi_h2c(card
, packet
, MVMS_CMD
);
926 if (hiStatus
& IF_SPI_HIST_TX_DOWNLOAD_RDY
) {
927 /* Do we have any data packets from the host to send? */
929 spin_lock_irqsave(&card
->buffer_lock
, flags
);
930 if (!list_empty(&card
->data_packet_list
)) {
931 packet
= (struct if_spi_packet
*)(card
->
932 data_packet_list
.next
);
933 list_del(&packet
->list
);
935 spin_unlock_irqrestore(&card
->buffer_lock
, flags
);
938 if_spi_h2c(card
, packet
, MVMS_DAT
);
940 if (hiStatus
& IF_SPI_HIST_CARD_EVENT
)
945 netdev_err(priv
->dev
, "%s: got error %d\n", __func__
, err
);
947 lbs_deb_leave(LBS_DEB_SPI
);
953 * Called from Libertas to transfer some data to the WLAN device
954 * We can't sleep here.
956 static int if_spi_host_to_card(struct lbs_private
*priv
,
957 u8 type
, u8
*buf
, u16 nb
)
961 struct if_spi_card
*card
= priv
->card
;
962 struct if_spi_packet
*packet
;
965 lbs_deb_enter_args(LBS_DEB_SPI
, "type %d, bytes %d", type
, nb
);
968 netdev_err(priv
->dev
, "%s: invalid size requested: %d\n",
974 packet
= kzalloc(sizeof(struct if_spi_packet
) + blen
, GFP_ATOMIC
);
980 memcpy(packet
->buffer
, buf
, nb
);
981 memset(packet
->buffer
+ nb
, 0, blen
- nb
);
985 priv
->dnld_sent
= DNLD_CMD_SENT
;
986 spin_lock_irqsave(&card
->buffer_lock
, flags
);
987 list_add_tail(&packet
->list
, &card
->cmd_packet_list
);
988 spin_unlock_irqrestore(&card
->buffer_lock
, flags
);
991 priv
->dnld_sent
= DNLD_DATA_SENT
;
992 spin_lock_irqsave(&card
->buffer_lock
, flags
);
993 list_add_tail(&packet
->list
, &card
->data_packet_list
);
994 spin_unlock_irqrestore(&card
->buffer_lock
, flags
);
998 netdev_err(priv
->dev
, "can't transfer buffer of type %d\n",
1004 /* Queue spi xfer work */
1005 queue_work(card
->workqueue
, &card
->packet_work
);
1007 lbs_deb_leave_args(LBS_DEB_SPI
, "err=%d", err
);
1014 * Service incoming interrupts from the WLAN device. We can't sleep here, so
1015 * don't try to talk on the SPI bus, just queue the SPI xfer work.
1017 static irqreturn_t
if_spi_host_interrupt(int irq
, void *dev_id
)
1019 struct if_spi_card
*card
= dev_id
;
1021 queue_work(card
->workqueue
, &card
->packet_work
);
1030 static int if_spi_init_card(struct if_spi_card
*card
)
1032 struct lbs_private
*priv
= card
->priv
;
1035 const struct firmware
*helper
= NULL
;
1036 const struct firmware
*mainfw
= NULL
;
1038 lbs_deb_enter(LBS_DEB_SPI
);
1040 err
= spu_init(card
, card
->pdata
->use_dummy_writes
);
1043 err
= spu_get_chip_revision(card
, &card
->card_id
, &card
->card_rev
);
1047 err
= spu_read_u32(card
, IF_SPI_SCRATCH_4_REG
, &scratch
);
1050 if (scratch
== SUCCESSFUL_FW_DOWNLOAD_MAGIC
)
1051 lbs_deb_spi("Firmware is already loaded for "
1052 "Marvell WLAN 802.11 adapter\n");
1054 /* Check if we support this card */
1055 for (i
= 0; i
< ARRAY_SIZE(fw_table
); i
++) {
1056 if (card
->card_id
== fw_table
[i
].model
)
1059 if (i
== ARRAY_SIZE(fw_table
)) {
1060 netdev_err(priv
->dev
, "Unsupported chip_id: 0x%02x\n",
1066 err
= lbs_get_firmware(&card
->spi
->dev
, card
->card_id
,
1067 &fw_table
[0], &helper
, &mainfw
);
1069 netdev_err(priv
->dev
, "failed to find firmware (%d)\n",
1074 lbs_deb_spi("Initializing FW for Marvell WLAN 802.11 adapter "
1075 "(chip_id = 0x%04x, chip_rev = 0x%02x) "
1076 "attached to SPI bus_num %d, chip_select %d. "
1077 "spi->max_speed_hz=%d\n",
1078 card
->card_id
, card
->card_rev
,
1079 card
->spi
->master
->bus_num
,
1080 card
->spi
->chip_select
,
1081 card
->spi
->max_speed_hz
);
1082 err
= if_spi_prog_helper_firmware(card
, helper
);
1085 err
= if_spi_prog_main_firmware(card
, mainfw
);
1088 lbs_deb_spi("loaded FW for Marvell WLAN 802.11 adapter\n");
1091 err
= spu_set_interrupt_mode(card
, 0, 1);
1096 lbs_deb_leave_args(LBS_DEB_SPI
, "err %d\n", err
);
1100 static void if_spi_resume_worker(struct work_struct
*work
)
1102 struct if_spi_card
*card
;
1104 card
= container_of(work
, struct if_spi_card
, resume_work
);
1106 if (card
->suspended
) {
1107 if (card
->pdata
->setup
)
1108 card
->pdata
->setup(card
->spi
);
1111 if_spi_init_card(card
);
1113 enable_irq(card
->spi
->irq
);
1115 /* And resume it ... */
1116 lbs_resume(card
->priv
);
1118 card
->suspended
= 0;
1122 static int if_spi_probe(struct spi_device
*spi
)
1124 struct if_spi_card
*card
;
1125 struct lbs_private
*priv
= NULL
;
1126 struct libertas_spi_platform_data
*pdata
= dev_get_platdata(&spi
->dev
);
1129 lbs_deb_enter(LBS_DEB_SPI
);
1137 err
= pdata
->setup(spi
);
1142 /* Allocate card structure to represent this specific device */
1143 card
= kzalloc(sizeof(struct if_spi_card
), GFP_KERNEL
);
1148 spi_set_drvdata(spi
, card
);
1149 card
->pdata
= pdata
;
1151 card
->prev_xfer_time
= jiffies
;
1153 INIT_LIST_HEAD(&card
->cmd_packet_list
);
1154 INIT_LIST_HEAD(&card
->data_packet_list
);
1155 spin_lock_init(&card
->buffer_lock
);
1157 /* Initialize the SPI Interface Unit */
1160 err
= if_spi_init_card(card
);
1165 * Register our card with libertas.
1166 * This will call alloc_etherdev.
1168 priv
= lbs_add_card(card
, &spi
->dev
);
1174 priv
->setup_fw_on_resume
= 1;
1176 priv
->hw_host_to_card
= if_spi_host_to_card
;
1177 priv
->enter_deep_sleep
= NULL
;
1178 priv
->exit_deep_sleep
= NULL
;
1179 priv
->reset_deep_sleep_wakeup
= NULL
;
1182 /* Initialize interrupt handling stuff. */
1183 card
->workqueue
= create_workqueue("libertas_spi");
1184 INIT_WORK(&card
->packet_work
, if_spi_host_to_card_worker
);
1185 INIT_WORK(&card
->resume_work
, if_spi_resume_worker
);
1187 err
= request_irq(spi
->irq
, if_spi_host_interrupt
,
1188 IRQF_TRIGGER_FALLING
, "libertas_spi", card
);
1190 pr_err("can't get host irq line-- request_irq failed\n");
1191 goto terminate_workqueue
;
1196 * This will call register_netdev, and we'll start
1197 * getting interrupts...
1199 err
= lbs_start_card(priv
);
1203 lbs_deb_spi("Finished initializing WLAN module.\n");
1205 /* successful exit */
1209 free_irq(spi
->irq
, card
);
1210 terminate_workqueue
:
1211 flush_workqueue(card
->workqueue
);
1212 destroy_workqueue(card
->workqueue
);
1213 lbs_remove_card(priv
); /* will call free_netdev */
1215 free_if_spi_card(card
);
1217 if (pdata
->teardown
)
1218 pdata
->teardown(spi
);
1220 lbs_deb_leave_args(LBS_DEB_SPI
, "err %d\n", err
);
1224 static int libertas_spi_remove(struct spi_device
*spi
)
1226 struct if_spi_card
*card
= spi_get_drvdata(spi
);
1227 struct lbs_private
*priv
= card
->priv
;
1229 lbs_deb_spi("libertas_spi_remove\n");
1230 lbs_deb_enter(LBS_DEB_SPI
);
1232 cancel_work_sync(&card
->resume_work
);
1234 lbs_stop_card(priv
);
1235 lbs_remove_card(priv
); /* will call free_netdev */
1237 free_irq(spi
->irq
, card
);
1238 flush_workqueue(card
->workqueue
);
1239 destroy_workqueue(card
->workqueue
);
1240 if (card
->pdata
->teardown
)
1241 card
->pdata
->teardown(spi
);
1242 free_if_spi_card(card
);
1243 lbs_deb_leave(LBS_DEB_SPI
);
1247 static int if_spi_suspend(struct device
*dev
)
1249 struct spi_device
*spi
= to_spi_device(dev
);
1250 struct if_spi_card
*card
= spi_get_drvdata(spi
);
1252 if (!card
->suspended
) {
1253 lbs_suspend(card
->priv
);
1254 flush_workqueue(card
->workqueue
);
1255 disable_irq(spi
->irq
);
1257 if (card
->pdata
->teardown
)
1258 card
->pdata
->teardown(spi
);
1259 card
->suspended
= 1;
1265 static int if_spi_resume(struct device
*dev
)
1267 struct spi_device
*spi
= to_spi_device(dev
);
1268 struct if_spi_card
*card
= spi_get_drvdata(spi
);
1270 /* Schedule delayed work */
1271 schedule_work(&card
->resume_work
);
1276 static const struct dev_pm_ops if_spi_pm_ops
= {
1277 .suspend
= if_spi_suspend
,
1278 .resume
= if_spi_resume
,
1281 static struct spi_driver libertas_spi_driver
= {
1282 .probe
= if_spi_probe
,
1283 .remove
= libertas_spi_remove
,
1285 .name
= "libertas_spi",
1286 .pm
= &if_spi_pm_ops
,
1294 static int __init
if_spi_init_module(void)
1297 lbs_deb_enter(LBS_DEB_SPI
);
1298 printk(KERN_INFO
"libertas_spi: Libertas SPI driver\n");
1299 ret
= spi_register_driver(&libertas_spi_driver
);
1300 lbs_deb_leave(LBS_DEB_SPI
);
1304 static void __exit
if_spi_exit_module(void)
1306 lbs_deb_enter(LBS_DEB_SPI
);
1307 spi_unregister_driver(&libertas_spi_driver
);
1308 lbs_deb_leave(LBS_DEB_SPI
);
1311 module_init(if_spi_init_module
);
1312 module_exit(if_spi_exit_module
);
1314 MODULE_DESCRIPTION("Libertas SPI WLAN Driver");
1315 MODULE_AUTHOR("Andrey Yurovsky <andrey@cozybit.com>, "
1316 "Colin McCabe <colin@cozybit.com>");
1317 MODULE_LICENSE("GPL");
1318 MODULE_ALIAS("spi:libertas_spi");