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>
34 #include "p54spi_eeprom.h"
39 MODULE_FIRMWARE("3826.arm");
40 MODULE_ALIAS("stlc45xx");
43 * gpios should be handled in board files and provided via platform data,
44 * but because it's currently impossible for p54spi to have a header file
45 * in include/linux, let's use module paramaters for now
48 static int p54spi_gpio_power = 97;
49 module_param(p54spi_gpio_power, int, 0444);
50 MODULE_PARM_DESC(p54spi_gpio_power, "gpio number for power line");
52 static int p54spi_gpio_irq = 87;
53 module_param(p54spi_gpio_irq, int, 0444);
54 MODULE_PARM_DESC(p54spi_gpio_irq, "gpio number for irq line");
56 static void p54spi_spi_read(struct p54s_priv *priv, u8 address,
57 void *buf, size_t len)
59 struct spi_transfer t[2];
63 /* We first push the address */
64 addr = cpu_to_le16(address << 8 | SPI_ADRS_READ_BIT_15);
67 memset(t, 0, sizeof(t));
70 t[0].len = sizeof(addr);
71 spi_message_add_tail(&t[0], &m);
75 spi_message_add_tail(&t[1], &m);
77 spi_sync(priv->spi, &m);
81 static void p54spi_spi_write(struct p54s_priv *priv, u8 address,
82 const void *buf, size_t len)
84 struct spi_transfer t[3];
88 /* We first push the address */
89 addr = cpu_to_le16(address << 8);
92 memset(t, 0, sizeof(t));
95 t[0].len = sizeof(addr);
96 spi_message_add_tail(&t[0], &m);
100 spi_message_add_tail(&t[1], &m);
104 last_word = cpu_to_le16(((u8 *)buf)[len - 1]);
106 t[2].tx_buf = &last_word;
107 t[2].len = sizeof(last_word);
108 spi_message_add_tail(&t[2], &m);
111 spi_sync(priv->spi, &m);
114 static u16 p54spi_read16(struct p54s_priv *priv, u8 addr)
118 p54spi_spi_read(priv, addr, &val, sizeof(val));
120 return le16_to_cpu(val);
123 static u32 p54spi_read32(struct p54s_priv *priv, u8 addr)
127 p54spi_spi_read(priv, addr, &val, sizeof(val));
129 return le32_to_cpu(val);
132 static inline void p54spi_write16(struct p54s_priv *priv, u8 addr, __le16 val)
134 p54spi_spi_write(priv, addr, &val, sizeof(val));
137 static inline void p54spi_write32(struct p54s_priv *priv, u8 addr, __le32 val)
139 p54spi_spi_write(priv, addr, &val, sizeof(val));
142 struct p54spi_spi_reg {
143 u16 address; /* __le16 ? */
148 static const struct p54spi_spi_reg p54spi_registers_array[] =
150 { SPI_ADRS_ARM_INTERRUPTS, 32, "ARM_INT " },
151 { SPI_ADRS_ARM_INT_EN, 32, "ARM_INT_ENA " },
152 { SPI_ADRS_HOST_INTERRUPTS, 32, "HOST_INT " },
153 { SPI_ADRS_HOST_INT_EN, 32, "HOST_INT_ENA" },
154 { SPI_ADRS_HOST_INT_ACK, 32, "HOST_INT_ACK" },
155 { SPI_ADRS_GEN_PURP_1, 32, "GP1_COMM " },
156 { SPI_ADRS_GEN_PURP_2, 32, "GP2_COMM " },
157 { SPI_ADRS_DEV_CTRL_STAT, 32, "DEV_CTRL_STA" },
158 { SPI_ADRS_DMA_DATA, 16, "DMA_DATA " },
159 { SPI_ADRS_DMA_WRITE_CTRL, 16, "DMA_WR_CTRL " },
160 { SPI_ADRS_DMA_WRITE_LEN, 16, "DMA_WR_LEN " },
161 { SPI_ADRS_DMA_WRITE_BASE, 32, "DMA_WR_BASE " },
162 { SPI_ADRS_DMA_READ_CTRL, 16, "DMA_RD_CTRL " },
163 { SPI_ADRS_DMA_READ_LEN, 16, "DMA_RD_LEN " },
164 { SPI_ADRS_DMA_WRITE_BASE, 32, "DMA_RD_BASE " }
167 static int p54spi_wait_bit(struct p54s_priv *priv, u16 reg, u32 bits)
171 for (i = 0; i < 2000; i++) {
172 u32 buffer = p54spi_read32(priv, reg);
173 if ((buffer & bits) == bits)
179 static int p54spi_spi_write_dma(struct p54s_priv *priv, __le32 base,
180 const void *buf, size_t len)
182 if (!p54spi_wait_bit(priv, SPI_ADRS_DMA_WRITE_CTRL, HOST_ALLOWED)) {
183 dev_err(&priv->spi->dev, "spi_write_dma not allowed "
188 p54spi_write16(priv, SPI_ADRS_DMA_WRITE_CTRL,
189 cpu_to_le16(SPI_DMA_WRITE_CTRL_ENABLE));
191 p54spi_write16(priv, SPI_ADRS_DMA_WRITE_LEN, cpu_to_le16(len));
192 p54spi_write32(priv, SPI_ADRS_DMA_WRITE_BASE, base);
193 p54spi_spi_write(priv, SPI_ADRS_DMA_DATA, buf, len);
197 static int p54spi_request_firmware(struct ieee80211_hw *dev)
199 struct p54s_priv *priv = dev->priv;
202 /* FIXME: should driver use it's own struct device? */
203 ret = request_firmware(&priv->firmware, "3826.arm", &priv->spi->dev);
206 dev_err(&priv->spi->dev, "request_firmware() failed: %d", ret);
210 ret = p54_parse_firmware(dev, priv->firmware);
212 release_firmware(priv->firmware);
219 static int p54spi_request_eeprom(struct ieee80211_hw *dev)
221 struct p54s_priv *priv = dev->priv;
222 const struct firmware *eeprom;
226 * allow users to customize their eeprom.
229 ret = request_firmware(&eeprom, "3826.eeprom", &priv->spi->dev);
231 dev_info(&priv->spi->dev, "loading default eeprom...\n");
232 ret = p54_parse_eeprom(dev, (void *) p54spi_eeprom,
233 sizeof(p54spi_eeprom));
235 dev_info(&priv->spi->dev, "loading user eeprom...\n");
236 ret = p54_parse_eeprom(dev, (void *) eeprom->data,
238 release_firmware(eeprom);
243 static int p54spi_upload_firmware(struct ieee80211_hw *dev)
245 struct p54s_priv *priv = dev->priv;
246 unsigned long fw_len, _fw_len;
247 unsigned int offset = 0;
251 fw_len = priv->firmware->size;
252 fw = kmemdup(priv->firmware->data, fw_len, GFP_KERNEL);
256 /* stop the device */
257 p54spi_write16(priv, SPI_ADRS_DEV_CTRL_STAT, cpu_to_le16(
258 SPI_CTRL_STAT_HOST_OVERRIDE | SPI_CTRL_STAT_HOST_RESET |
259 SPI_CTRL_STAT_START_HALTED));
261 msleep(TARGET_BOOT_SLEEP);
263 p54spi_write16(priv, SPI_ADRS_DEV_CTRL_STAT, cpu_to_le16(
264 SPI_CTRL_STAT_HOST_OVERRIDE |
265 SPI_CTRL_STAT_START_HALTED));
267 msleep(TARGET_BOOT_SLEEP);
270 _fw_len = min_t(long, fw_len, SPI_MAX_PACKET_SIZE);
272 err = p54spi_spi_write_dma(priv, cpu_to_le32(
273 ISL38XX_DEV_FIRMWARE_ADDR + offset),
274 (fw + offset), _fw_len);
284 /* enable host interrupts */
285 p54spi_write32(priv, SPI_ADRS_HOST_INT_EN,
286 cpu_to_le32(SPI_HOST_INTS_DEFAULT));
288 /* boot the device */
289 p54spi_write16(priv, SPI_ADRS_DEV_CTRL_STAT, cpu_to_le16(
290 SPI_CTRL_STAT_HOST_OVERRIDE | SPI_CTRL_STAT_HOST_RESET |
291 SPI_CTRL_STAT_RAM_BOOT));
293 msleep(TARGET_BOOT_SLEEP);
295 p54spi_write16(priv, SPI_ADRS_DEV_CTRL_STAT, cpu_to_le16(
296 SPI_CTRL_STAT_HOST_OVERRIDE | SPI_CTRL_STAT_RAM_BOOT));
297 msleep(TARGET_BOOT_SLEEP);
304 static void p54spi_power_off(struct p54s_priv *priv)
306 disable_irq(gpio_to_irq(p54spi_gpio_irq));
307 gpio_set_value(p54spi_gpio_power, 0);
310 static void p54spi_power_on(struct p54s_priv *priv)
312 gpio_set_value(p54spi_gpio_power, 1);
313 enable_irq(gpio_to_irq(p54spi_gpio_irq));
316 * need to wait a while before device can be accessed, the lenght
322 static inline void p54spi_int_ack(struct p54s_priv *priv, u32 val)
324 p54spi_write32(priv, SPI_ADRS_HOST_INT_ACK, cpu_to_le32(val));
327 static int p54spi_wakeup(struct p54s_priv *priv)
330 p54spi_write32(priv, SPI_ADRS_ARM_INTERRUPTS,
331 cpu_to_le32(SPI_TARGET_INT_WAKEUP));
333 /* And wait for the READY interrupt */
334 if (!p54spi_wait_bit(priv, SPI_ADRS_HOST_INTERRUPTS,
335 SPI_HOST_INT_READY)) {
336 dev_err(&priv->spi->dev, "INT_READY timeout\n");
340 p54spi_int_ack(priv, SPI_HOST_INT_READY);
344 static inline void p54spi_sleep(struct p54s_priv *priv)
346 p54spi_write32(priv, SPI_ADRS_ARM_INTERRUPTS,
347 cpu_to_le32(SPI_TARGET_INT_SLEEP));
350 static void p54spi_int_ready(struct p54s_priv *priv)
352 p54spi_write32(priv, SPI_ADRS_HOST_INT_EN, cpu_to_le32(
353 SPI_HOST_INT_UPDATE | SPI_HOST_INT_SW_UPDATE));
355 switch (priv->fw_state) {
356 case FW_STATE_BOOTING:
357 priv->fw_state = FW_STATE_READY;
358 complete(&priv->fw_comp);
360 case FW_STATE_RESETTING:
361 priv->fw_state = FW_STATE_READY;
362 /* TODO: reinitialize state */
369 static int p54spi_rx(struct p54s_priv *priv)
374 #define READAHEAD_SZ (sizeof(rx_head)-sizeof(u16))
376 if (p54spi_wakeup(priv) < 0)
379 /* Read data size and first data word in one SPI transaction
380 * This is workaround for firmware/DMA bug,
381 * when first data word gets lost under high load.
383 p54spi_spi_read(priv, SPI_ADRS_DMA_DATA, rx_head, sizeof(rx_head));
388 dev_err(&priv->spi->dev, "rx request of zero bytes\n");
392 /* Firmware may insert up to 4 padding bytes after the lmac header,
393 * but it does not amend the size of SPI data transfer.
394 * Such packets has correct data size in header, thus referencing
395 * past the end of allocated skb. Reserve extra 4 bytes for this case */
396 skb = dev_alloc_skb(len + 4);
399 dev_err(&priv->spi->dev, "could not alloc skb");
403 if (len <= READAHEAD_SZ) {
404 memcpy(skb_put(skb, len), rx_head + 1, len);
406 memcpy(skb_put(skb, READAHEAD_SZ), rx_head + 1, READAHEAD_SZ);
407 p54spi_spi_read(priv, SPI_ADRS_DMA_DATA,
408 skb_put(skb, len - READAHEAD_SZ),
412 /* Put additional bytes to compensate for the possible
413 * alignment-caused truncation */
416 if (p54_rx(priv->hw, skb) == 0)
423 static irqreturn_t p54spi_interrupt(int irq, void *config)
425 struct spi_device *spi = config;
426 struct p54s_priv *priv = dev_get_drvdata(&spi->dev);
428 queue_work(priv->hw->workqueue, &priv->work);
433 static int p54spi_tx_frame(struct p54s_priv *priv, struct sk_buff *skb)
435 struct p54_hdr *hdr = (struct p54_hdr *) skb->data;
438 if (p54spi_wakeup(priv) < 0)
441 ret = p54spi_spi_write_dma(priv, hdr->req_id, skb->data, skb->len);
445 if (!p54spi_wait_bit(priv, SPI_ADRS_HOST_INTERRUPTS,
446 SPI_HOST_INT_WR_READY)) {
447 dev_err(&priv->spi->dev, "WR_READY timeout\n");
452 p54spi_int_ack(priv, SPI_HOST_INT_WR_READY);
454 if (FREE_AFTER_TX(skb))
455 p54_free_skb(priv->hw, skb);
461 static int p54spi_wq_tx(struct p54s_priv *priv)
463 struct p54s_tx_info *entry;
465 struct ieee80211_tx_info *info;
466 struct p54_tx_info *minfo;
467 struct p54s_tx_info *dinfo;
471 spin_lock_irqsave(&priv->tx_lock, flags);
473 while (!list_empty(&priv->tx_pending)) {
474 entry = list_entry(priv->tx_pending.next,
475 struct p54s_tx_info, tx_list);
477 list_del_init(&entry->tx_list);
479 spin_unlock_irqrestore(&priv->tx_lock, flags);
481 dinfo = container_of((void *) entry, struct p54s_tx_info,
483 minfo = container_of((void *) dinfo, struct p54_tx_info,
485 info = container_of((void *) minfo, struct ieee80211_tx_info,
487 skb = container_of((void *) info, struct sk_buff, cb);
489 ret = p54spi_tx_frame(priv, skb);
492 p54_free_skb(priv->hw, skb);
496 spin_lock_irqsave(&priv->tx_lock, flags);
498 spin_unlock_irqrestore(&priv->tx_lock, flags);
502 static void p54spi_op_tx(struct ieee80211_hw *dev, struct sk_buff *skb)
504 struct p54s_priv *priv = dev->priv;
505 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
506 struct p54_tx_info *mi = (struct p54_tx_info *) info->rate_driver_data;
507 struct p54s_tx_info *di = (struct p54s_tx_info *) mi->data;
510 BUILD_BUG_ON(sizeof(*di) > sizeof((mi->data)));
512 spin_lock_irqsave(&priv->tx_lock, flags);
513 list_add_tail(&di->tx_list, &priv->tx_pending);
514 spin_unlock_irqrestore(&priv->tx_lock, flags);
516 queue_work(priv->hw->workqueue, &priv->work);
519 static void p54spi_work(struct work_struct *work)
521 struct p54s_priv *priv = container_of(work, struct p54s_priv, work);
525 mutex_lock(&priv->mutex);
527 if (priv->fw_state == FW_STATE_OFF)
530 ints = p54spi_read32(priv, SPI_ADRS_HOST_INTERRUPTS);
532 if (ints & SPI_HOST_INT_READY) {
533 p54spi_int_ready(priv);
534 p54spi_int_ack(priv, SPI_HOST_INT_READY);
537 if (priv->fw_state != FW_STATE_READY)
540 if (ints & SPI_HOST_INT_UPDATE) {
541 p54spi_int_ack(priv, SPI_HOST_INT_UPDATE);
542 ret = p54spi_rx(priv);
546 if (ints & SPI_HOST_INT_SW_UPDATE) {
547 p54spi_int_ack(priv, SPI_HOST_INT_SW_UPDATE);
548 ret = p54spi_rx(priv);
553 ret = p54spi_wq_tx(priv);
555 mutex_unlock(&priv->mutex);
558 static int p54spi_op_start(struct ieee80211_hw *dev)
560 struct p54s_priv *priv = dev->priv;
561 unsigned long timeout;
564 if (mutex_lock_interruptible(&priv->mutex)) {
569 priv->fw_state = FW_STATE_BOOTING;
571 p54spi_power_on(priv);
573 ret = p54spi_upload_firmware(dev);
575 p54spi_power_off(priv);
579 mutex_unlock(&priv->mutex);
581 timeout = msecs_to_jiffies(2000);
582 timeout = wait_for_completion_interruptible_timeout(&priv->fw_comp,
585 dev_err(&priv->spi->dev, "firmware boot failed");
586 p54spi_power_off(priv);
591 if (mutex_lock_interruptible(&priv->mutex)) {
593 p54spi_power_off(priv);
597 WARN_ON(priv->fw_state != FW_STATE_READY);
600 mutex_unlock(&priv->mutex);
606 static void p54spi_op_stop(struct ieee80211_hw *dev)
608 struct p54s_priv *priv = dev->priv;
611 if (mutex_lock_interruptible(&priv->mutex)) {
612 /* FIXME: how to handle this error? */
616 WARN_ON(priv->fw_state != FW_STATE_READY);
618 cancel_work_sync(&priv->work);
620 p54spi_power_off(priv);
621 spin_lock_irqsave(&priv->tx_lock, flags);
622 INIT_LIST_HEAD(&priv->tx_pending);
623 spin_unlock_irqrestore(&priv->tx_lock, flags);
625 priv->fw_state = FW_STATE_OFF;
626 mutex_unlock(&priv->mutex);
629 static int __devinit p54spi_probe(struct spi_device *spi)
631 struct p54s_priv *priv = NULL;
632 struct ieee80211_hw *hw;
635 hw = p54_init_common(sizeof(*priv));
637 dev_err(&priv->spi->dev, "could not alloc ieee80211_hw");
643 dev_set_drvdata(&spi->dev, priv);
646 spi->bits_per_word = 16;
647 spi->max_speed_hz = 24000000;
649 ret = spi_setup(spi);
651 dev_err(&priv->spi->dev, "spi_setup failed");
652 goto err_free_common;
655 ret = gpio_request(p54spi_gpio_power, "p54spi power");
657 dev_err(&priv->spi->dev, "power GPIO request failed: %d", ret);
658 goto err_free_common;
661 ret = gpio_request(p54spi_gpio_irq, "p54spi irq");
663 dev_err(&priv->spi->dev, "irq GPIO request failed: %d", ret);
664 goto err_free_common;
667 gpio_direction_output(p54spi_gpio_power, 0);
668 gpio_direction_input(p54spi_gpio_irq);
670 ret = request_irq(gpio_to_irq(p54spi_gpio_irq),
671 p54spi_interrupt, IRQF_DISABLED, "p54spi",
674 dev_err(&priv->spi->dev, "request_irq() failed");
675 goto err_free_common;
678 set_irq_type(gpio_to_irq(p54spi_gpio_irq),
679 IRQ_TYPE_EDGE_RISING);
681 disable_irq(gpio_to_irq(p54spi_gpio_irq));
683 INIT_WORK(&priv->work, p54spi_work);
684 init_completion(&priv->fw_comp);
685 INIT_LIST_HEAD(&priv->tx_pending);
686 mutex_init(&priv->mutex);
687 SET_IEEE80211_DEV(hw, &spi->dev);
688 priv->common.open = p54spi_op_start;
689 priv->common.stop = p54spi_op_stop;
690 priv->common.tx = p54spi_op_tx;
692 ret = p54spi_request_firmware(hw);
694 goto err_free_common;
696 ret = p54spi_request_eeprom(hw);
698 goto err_free_common;
700 ret = p54_register_common(hw, &priv->spi->dev);
702 goto err_free_common;
707 p54_free_common(priv->hw);
711 static int __devexit p54spi_remove(struct spi_device *spi)
713 struct p54s_priv *priv = dev_get_drvdata(&spi->dev);
715 p54_unregister_common(priv->hw);
717 free_irq(gpio_to_irq(p54spi_gpio_irq), spi);
719 gpio_free(p54spi_gpio_power);
720 gpio_free(p54spi_gpio_irq);
721 release_firmware(priv->firmware);
723 mutex_destroy(&priv->mutex);
725 p54_free_common(priv->hw);
731 static struct spi_driver p54spi_driver = {
733 /* use cx3110x name because board-n800.c uses that for the
736 .bus = &spi_bus_type,
737 .owner = THIS_MODULE,
740 .probe = p54spi_probe,
741 .remove = __devexit_p(p54spi_remove),
744 static int __init p54spi_init(void)
748 ret = spi_register_driver(&p54spi_driver);
750 printk(KERN_ERR "failed to register SPI driver: %d", ret);
758 static void __exit p54spi_exit(void)
760 spi_unregister_driver(&p54spi_driver);
763 module_init(p54spi_init);
764 module_exit(p54spi_exit);
766 MODULE_LICENSE("GPL");
767 MODULE_AUTHOR("Christian Lamparter <chunkeey@web.de>");