2 * Copyright (C) 2008 Christian Lamparter <chunkeey@web.de>
3 * Copyright 2008 Johannes Berg <johannes@sipsolutions.net>
5 * This driver is a port from stlc45xx:
6 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/interrupt.h>
26 #include <linux/firmware.h>
27 #include <linux/delay.h>
28 #include <linux/irq.h>
29 #include <linux/spi/spi.h>
30 #include <linux/etherdevice.h>
31 #include <linux/gpio.h>
32 #include <linux/slab.h>
39 #ifdef CONFIG_P54_SPI_DEFAULT_EEPROM
40 #include "p54spi_eeprom.h"
41 #endif /* CONFIG_P54_SPI_DEFAULT_EEPROM */
43 MODULE_FIRMWARE("3826.arm");
46 * gpios should be handled in board files and provided via platform data,
47 * but because it's currently impossible for p54spi to have a header file
48 * in include/linux, let's use module paramaters for now
51 static int p54spi_gpio_power
= 97;
52 module_param(p54spi_gpio_power
, int, 0444);
53 MODULE_PARM_DESC(p54spi_gpio_power
, "gpio number for power line");
55 static int p54spi_gpio_irq
= 87;
56 module_param(p54spi_gpio_irq
, int, 0444);
57 MODULE_PARM_DESC(p54spi_gpio_irq
, "gpio number for irq line");
59 static void p54spi_spi_read(struct p54s_priv
*priv
, u8 address
,
60 void *buf
, size_t len
)
62 struct spi_transfer t
[2];
66 /* We first push the address */
67 addr
= cpu_to_le16(address
<< 8 | SPI_ADRS_READ_BIT_15
);
70 memset(t
, 0, sizeof(t
));
73 t
[0].len
= sizeof(addr
);
74 spi_message_add_tail(&t
[0], &m
);
78 spi_message_add_tail(&t
[1], &m
);
80 spi_sync(priv
->spi
, &m
);
84 static void p54spi_spi_write(struct p54s_priv
*priv
, u8 address
,
85 const void *buf
, size_t len
)
87 struct spi_transfer t
[3];
91 /* We first push the address */
92 addr
= cpu_to_le16(address
<< 8);
95 memset(t
, 0, sizeof(t
));
98 t
[0].len
= sizeof(addr
);
99 spi_message_add_tail(&t
[0], &m
);
103 spi_message_add_tail(&t
[1], &m
);
107 last_word
= cpu_to_le16(((u8
*)buf
)[len
- 1]);
109 t
[2].tx_buf
= &last_word
;
110 t
[2].len
= sizeof(last_word
);
111 spi_message_add_tail(&t
[2], &m
);
114 spi_sync(priv
->spi
, &m
);
117 static u32
p54spi_read32(struct p54s_priv
*priv
, u8 addr
)
121 p54spi_spi_read(priv
, addr
, &val
, sizeof(val
));
123 return le32_to_cpu(val
);
126 static inline void p54spi_write16(struct p54s_priv
*priv
, u8 addr
, __le16 val
)
128 p54spi_spi_write(priv
, addr
, &val
, sizeof(val
));
131 static inline void p54spi_write32(struct p54s_priv
*priv
, u8 addr
, __le32 val
)
133 p54spi_spi_write(priv
, addr
, &val
, sizeof(val
));
136 static int p54spi_wait_bit(struct p54s_priv
*priv
, u16 reg
, u32 bits
)
140 for (i
= 0; i
< 2000; i
++) {
141 u32 buffer
= p54spi_read32(priv
, reg
);
142 if ((buffer
& bits
) == bits
)
148 static int p54spi_spi_write_dma(struct p54s_priv
*priv
, __le32 base
,
149 const void *buf
, size_t len
)
151 if (!p54spi_wait_bit(priv
, SPI_ADRS_DMA_WRITE_CTRL
, HOST_ALLOWED
)) {
152 dev_err(&priv
->spi
->dev
, "spi_write_dma not allowed "
157 p54spi_write16(priv
, SPI_ADRS_DMA_WRITE_CTRL
,
158 cpu_to_le16(SPI_DMA_WRITE_CTRL_ENABLE
));
160 p54spi_write16(priv
, SPI_ADRS_DMA_WRITE_LEN
, cpu_to_le16(len
));
161 p54spi_write32(priv
, SPI_ADRS_DMA_WRITE_BASE
, base
);
162 p54spi_spi_write(priv
, SPI_ADRS_DMA_DATA
, buf
, len
);
166 static int p54spi_request_firmware(struct ieee80211_hw
*dev
)
168 struct p54s_priv
*priv
= dev
->priv
;
171 /* FIXME: should driver use it's own struct device? */
172 ret
= request_firmware(&priv
->firmware
, "3826.arm", &priv
->spi
->dev
);
175 dev_err(&priv
->spi
->dev
, "request_firmware() failed: %d", ret
);
179 ret
= p54_parse_firmware(dev
, priv
->firmware
);
181 release_firmware(priv
->firmware
);
188 static int p54spi_request_eeprom(struct ieee80211_hw
*dev
)
190 struct p54s_priv
*priv
= dev
->priv
;
191 const struct firmware
*eeprom
;
195 * allow users to customize their eeprom.
198 ret
= request_firmware(&eeprom
, "3826.eeprom", &priv
->spi
->dev
);
200 #ifdef CONFIG_P54_SPI_DEFAULT_EEPROM
201 dev_info(&priv
->spi
->dev
, "loading default eeprom...\n");
202 ret
= p54_parse_eeprom(dev
, (void *) p54spi_eeprom
,
203 sizeof(p54spi_eeprom
));
205 dev_err(&priv
->spi
->dev
, "Failed to request user eeprom\n");
206 #endif /* CONFIG_P54_SPI_DEFAULT_EEPROM */
208 dev_info(&priv
->spi
->dev
, "loading user eeprom...\n");
209 ret
= p54_parse_eeprom(dev
, (void *) eeprom
->data
,
211 release_firmware(eeprom
);
216 static int p54spi_upload_firmware(struct ieee80211_hw
*dev
)
218 struct p54s_priv
*priv
= dev
->priv
;
219 unsigned long fw_len
, _fw_len
;
220 unsigned int offset
= 0;
224 fw_len
= priv
->firmware
->size
;
225 fw
= kmemdup(priv
->firmware
->data
, fw_len
, GFP_KERNEL
);
229 /* stop the device */
230 p54spi_write16(priv
, SPI_ADRS_DEV_CTRL_STAT
, cpu_to_le16(
231 SPI_CTRL_STAT_HOST_OVERRIDE
| SPI_CTRL_STAT_HOST_RESET
|
232 SPI_CTRL_STAT_START_HALTED
));
234 msleep(TARGET_BOOT_SLEEP
);
236 p54spi_write16(priv
, SPI_ADRS_DEV_CTRL_STAT
, cpu_to_le16(
237 SPI_CTRL_STAT_HOST_OVERRIDE
|
238 SPI_CTRL_STAT_START_HALTED
));
240 msleep(TARGET_BOOT_SLEEP
);
243 _fw_len
= min_t(long, fw_len
, SPI_MAX_PACKET_SIZE
);
245 err
= p54spi_spi_write_dma(priv
, cpu_to_le32(
246 ISL38XX_DEV_FIRMWARE_ADDR
+ offset
),
247 (fw
+ offset
), _fw_len
);
257 /* enable host interrupts */
258 p54spi_write32(priv
, SPI_ADRS_HOST_INT_EN
,
259 cpu_to_le32(SPI_HOST_INTS_DEFAULT
));
261 /* boot the device */
262 p54spi_write16(priv
, SPI_ADRS_DEV_CTRL_STAT
, cpu_to_le16(
263 SPI_CTRL_STAT_HOST_OVERRIDE
| SPI_CTRL_STAT_HOST_RESET
|
264 SPI_CTRL_STAT_RAM_BOOT
));
266 msleep(TARGET_BOOT_SLEEP
);
268 p54spi_write16(priv
, SPI_ADRS_DEV_CTRL_STAT
, cpu_to_le16(
269 SPI_CTRL_STAT_HOST_OVERRIDE
| SPI_CTRL_STAT_RAM_BOOT
));
270 msleep(TARGET_BOOT_SLEEP
);
277 static void p54spi_power_off(struct p54s_priv
*priv
)
279 disable_irq(gpio_to_irq(p54spi_gpio_irq
));
280 gpio_set_value(p54spi_gpio_power
, 0);
283 static void p54spi_power_on(struct p54s_priv
*priv
)
285 gpio_set_value(p54spi_gpio_power
, 1);
286 enable_irq(gpio_to_irq(p54spi_gpio_irq
));
289 * need to wait a while before device can be accessed, the length
295 static inline void p54spi_int_ack(struct p54s_priv
*priv
, u32 val
)
297 p54spi_write32(priv
, SPI_ADRS_HOST_INT_ACK
, cpu_to_le32(val
));
300 static int p54spi_wakeup(struct p54s_priv
*priv
)
303 p54spi_write32(priv
, SPI_ADRS_ARM_INTERRUPTS
,
304 cpu_to_le32(SPI_TARGET_INT_WAKEUP
));
306 /* And wait for the READY interrupt */
307 if (!p54spi_wait_bit(priv
, SPI_ADRS_HOST_INTERRUPTS
,
308 SPI_HOST_INT_READY
)) {
309 dev_err(&priv
->spi
->dev
, "INT_READY timeout\n");
313 p54spi_int_ack(priv
, SPI_HOST_INT_READY
);
317 static inline void p54spi_sleep(struct p54s_priv
*priv
)
319 p54spi_write32(priv
, SPI_ADRS_ARM_INTERRUPTS
,
320 cpu_to_le32(SPI_TARGET_INT_SLEEP
));
323 static void p54spi_int_ready(struct p54s_priv
*priv
)
325 p54spi_write32(priv
, SPI_ADRS_HOST_INT_EN
, cpu_to_le32(
326 SPI_HOST_INT_UPDATE
| SPI_HOST_INT_SW_UPDATE
));
328 switch (priv
->fw_state
) {
329 case FW_STATE_BOOTING
:
330 priv
->fw_state
= FW_STATE_READY
;
331 complete(&priv
->fw_comp
);
333 case FW_STATE_RESETTING
:
334 priv
->fw_state
= FW_STATE_READY
;
335 /* TODO: reinitialize state */
342 static int p54spi_rx(struct p54s_priv
*priv
)
347 #define READAHEAD_SZ (sizeof(rx_head)-sizeof(u16))
349 if (p54spi_wakeup(priv
) < 0)
352 /* Read data size and first data word in one SPI transaction
353 * This is workaround for firmware/DMA bug,
354 * when first data word gets lost under high load.
356 p54spi_spi_read(priv
, SPI_ADRS_DMA_DATA
, rx_head
, sizeof(rx_head
));
361 dev_err(&priv
->spi
->dev
, "rx request of zero bytes\n");
365 /* Firmware may insert up to 4 padding bytes after the lmac header,
366 * but it does not amend the size of SPI data transfer.
367 * Such packets has correct data size in header, thus referencing
368 * past the end of allocated skb. Reserve extra 4 bytes for this case */
369 skb
= dev_alloc_skb(len
+ 4);
372 dev_err(&priv
->spi
->dev
, "could not alloc skb");
376 if (len
<= READAHEAD_SZ
) {
377 memcpy(skb_put(skb
, len
), rx_head
+ 1, len
);
379 memcpy(skb_put(skb
, READAHEAD_SZ
), rx_head
+ 1, READAHEAD_SZ
);
380 p54spi_spi_read(priv
, SPI_ADRS_DMA_DATA
,
381 skb_put(skb
, len
- READAHEAD_SZ
),
385 /* Put additional bytes to compensate for the possible
386 * alignment-caused truncation */
389 if (p54_rx(priv
->hw
, skb
) == 0)
396 static irqreturn_t
p54spi_interrupt(int irq
, void *config
)
398 struct spi_device
*spi
= config
;
399 struct p54s_priv
*priv
= dev_get_drvdata(&spi
->dev
);
401 ieee80211_queue_work(priv
->hw
, &priv
->work
);
406 static int p54spi_tx_frame(struct p54s_priv
*priv
, struct sk_buff
*skb
)
408 struct p54_hdr
*hdr
= (struct p54_hdr
*) skb
->data
;
411 if (p54spi_wakeup(priv
) < 0)
414 ret
= p54spi_spi_write_dma(priv
, hdr
->req_id
, skb
->data
, skb
->len
);
418 if (!p54spi_wait_bit(priv
, SPI_ADRS_HOST_INTERRUPTS
,
419 SPI_HOST_INT_WR_READY
)) {
420 dev_err(&priv
->spi
->dev
, "WR_READY timeout\n");
425 p54spi_int_ack(priv
, SPI_HOST_INT_WR_READY
);
427 if (FREE_AFTER_TX(skb
))
428 p54_free_skb(priv
->hw
, skb
);
434 static int p54spi_wq_tx(struct p54s_priv
*priv
)
436 struct p54s_tx_info
*entry
;
438 struct ieee80211_tx_info
*info
;
439 struct p54_tx_info
*minfo
;
440 struct p54s_tx_info
*dinfo
;
444 spin_lock_irqsave(&priv
->tx_lock
, flags
);
446 while (!list_empty(&priv
->tx_pending
)) {
447 entry
= list_entry(priv
->tx_pending
.next
,
448 struct p54s_tx_info
, tx_list
);
450 list_del_init(&entry
->tx_list
);
452 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
454 dinfo
= container_of((void *) entry
, struct p54s_tx_info
,
456 minfo
= container_of((void *) dinfo
, struct p54_tx_info
,
458 info
= container_of((void *) minfo
, struct ieee80211_tx_info
,
460 skb
= container_of((void *) info
, struct sk_buff
, cb
);
462 ret
= p54spi_tx_frame(priv
, skb
);
465 p54_free_skb(priv
->hw
, skb
);
469 spin_lock_irqsave(&priv
->tx_lock
, flags
);
471 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
475 static void p54spi_op_tx(struct ieee80211_hw
*dev
, struct sk_buff
*skb
)
477 struct p54s_priv
*priv
= dev
->priv
;
478 struct ieee80211_tx_info
*info
= IEEE80211_SKB_CB(skb
);
479 struct p54_tx_info
*mi
= (struct p54_tx_info
*) info
->rate_driver_data
;
480 struct p54s_tx_info
*di
= (struct p54s_tx_info
*) mi
->data
;
483 BUILD_BUG_ON(sizeof(*di
) > sizeof((mi
->data
)));
485 spin_lock_irqsave(&priv
->tx_lock
, flags
);
486 list_add_tail(&di
->tx_list
, &priv
->tx_pending
);
487 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
489 ieee80211_queue_work(priv
->hw
, &priv
->work
);
492 static void p54spi_work(struct work_struct
*work
)
494 struct p54s_priv
*priv
= container_of(work
, struct p54s_priv
, work
);
498 mutex_lock(&priv
->mutex
);
500 if (priv
->fw_state
== FW_STATE_OFF
)
503 ints
= p54spi_read32(priv
, SPI_ADRS_HOST_INTERRUPTS
);
505 if (ints
& SPI_HOST_INT_READY
) {
506 p54spi_int_ready(priv
);
507 p54spi_int_ack(priv
, SPI_HOST_INT_READY
);
510 if (priv
->fw_state
!= FW_STATE_READY
)
513 if (ints
& SPI_HOST_INT_UPDATE
) {
514 p54spi_int_ack(priv
, SPI_HOST_INT_UPDATE
);
515 ret
= p54spi_rx(priv
);
519 if (ints
& SPI_HOST_INT_SW_UPDATE
) {
520 p54spi_int_ack(priv
, SPI_HOST_INT_SW_UPDATE
);
521 ret
= p54spi_rx(priv
);
526 ret
= p54spi_wq_tx(priv
);
528 mutex_unlock(&priv
->mutex
);
531 static int p54spi_op_start(struct ieee80211_hw
*dev
)
533 struct p54s_priv
*priv
= dev
->priv
;
534 unsigned long timeout
;
537 if (mutex_lock_interruptible(&priv
->mutex
)) {
542 priv
->fw_state
= FW_STATE_BOOTING
;
544 p54spi_power_on(priv
);
546 ret
= p54spi_upload_firmware(dev
);
548 p54spi_power_off(priv
);
552 mutex_unlock(&priv
->mutex
);
554 timeout
= msecs_to_jiffies(2000);
555 timeout
= wait_for_completion_interruptible_timeout(&priv
->fw_comp
,
558 dev_err(&priv
->spi
->dev
, "firmware boot failed");
559 p54spi_power_off(priv
);
564 if (mutex_lock_interruptible(&priv
->mutex
)) {
566 p54spi_power_off(priv
);
570 WARN_ON(priv
->fw_state
!= FW_STATE_READY
);
573 mutex_unlock(&priv
->mutex
);
579 static void p54spi_op_stop(struct ieee80211_hw
*dev
)
581 struct p54s_priv
*priv
= dev
->priv
;
584 if (mutex_lock_interruptible(&priv
->mutex
)) {
585 /* FIXME: how to handle this error? */
589 WARN_ON(priv
->fw_state
!= FW_STATE_READY
);
591 p54spi_power_off(priv
);
592 spin_lock_irqsave(&priv
->tx_lock
, flags
);
593 INIT_LIST_HEAD(&priv
->tx_pending
);
594 spin_unlock_irqrestore(&priv
->tx_lock
, flags
);
596 priv
->fw_state
= FW_STATE_OFF
;
597 mutex_unlock(&priv
->mutex
);
599 cancel_work_sync(&priv
->work
);
602 static int __devinit
p54spi_probe(struct spi_device
*spi
)
604 struct p54s_priv
*priv
= NULL
;
605 struct ieee80211_hw
*hw
;
608 hw
= p54_init_common(sizeof(*priv
));
610 dev_err(&spi
->dev
, "could not alloc ieee80211_hw");
616 dev_set_drvdata(&spi
->dev
, priv
);
619 spi
->bits_per_word
= 16;
620 spi
->max_speed_hz
= 24000000;
622 ret
= spi_setup(spi
);
624 dev_err(&priv
->spi
->dev
, "spi_setup failed");
625 goto err_free_common
;
628 ret
= gpio_request(p54spi_gpio_power
, "p54spi power");
630 dev_err(&priv
->spi
->dev
, "power GPIO request failed: %d", ret
);
631 goto err_free_common
;
634 ret
= gpio_request(p54spi_gpio_irq
, "p54spi irq");
636 dev_err(&priv
->spi
->dev
, "irq GPIO request failed: %d", ret
);
637 goto err_free_common
;
640 gpio_direction_output(p54spi_gpio_power
, 0);
641 gpio_direction_input(p54spi_gpio_irq
);
643 ret
= request_irq(gpio_to_irq(p54spi_gpio_irq
),
644 p54spi_interrupt
, IRQF_DISABLED
, "p54spi",
647 dev_err(&priv
->spi
->dev
, "request_irq() failed");
648 goto err_free_common
;
651 irq_set_irq_type(gpio_to_irq(p54spi_gpio_irq
), IRQ_TYPE_EDGE_RISING
);
653 disable_irq(gpio_to_irq(p54spi_gpio_irq
));
655 INIT_WORK(&priv
->work
, p54spi_work
);
656 init_completion(&priv
->fw_comp
);
657 INIT_LIST_HEAD(&priv
->tx_pending
);
658 mutex_init(&priv
->mutex
);
659 spin_lock_init(&priv
->tx_lock
);
660 SET_IEEE80211_DEV(hw
, &spi
->dev
);
661 priv
->common
.open
= p54spi_op_start
;
662 priv
->common
.stop
= p54spi_op_stop
;
663 priv
->common
.tx
= p54spi_op_tx
;
665 ret
= p54spi_request_firmware(hw
);
667 goto err_free_common
;
669 ret
= p54spi_request_eeprom(hw
);
671 goto err_free_common
;
673 ret
= p54_register_common(hw
, &priv
->spi
->dev
);
675 goto err_free_common
;
680 p54_free_common(priv
->hw
);
684 static int __devexit
p54spi_remove(struct spi_device
*spi
)
686 struct p54s_priv
*priv
= dev_get_drvdata(&spi
->dev
);
688 p54_unregister_common(priv
->hw
);
690 free_irq(gpio_to_irq(p54spi_gpio_irq
), spi
);
692 gpio_free(p54spi_gpio_power
);
693 gpio_free(p54spi_gpio_irq
);
694 release_firmware(priv
->firmware
);
696 mutex_destroy(&priv
->mutex
);
698 p54_free_common(priv
->hw
);
704 static struct spi_driver p54spi_driver
= {
707 .bus
= &spi_bus_type
,
708 .owner
= THIS_MODULE
,
711 .probe
= p54spi_probe
,
712 .remove
= __devexit_p(p54spi_remove
),
715 static int __init
p54spi_init(void)
719 ret
= spi_register_driver(&p54spi_driver
);
721 printk(KERN_ERR
"failed to register SPI driver: %d", ret
);
729 static void __exit
p54spi_exit(void)
731 spi_unregister_driver(&p54spi_driver
);
734 module_init(p54spi_init
);
735 module_exit(p54spi_exit
);
737 MODULE_LICENSE("GPL");
738 MODULE_AUTHOR("Christian Lamparter <chunkeey@web.de>");
739 MODULE_ALIAS("spi:cx3110x");
740 MODULE_ALIAS("spi:p54spi");
741 MODULE_ALIAS("spi:stlc45xx");