2 * This file is part of wl1271
4 * Copyright (C) 2008-2009 Nokia Corporation
6 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
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
24 #include <linux/irq.h>
25 #include <linux/module.h>
26 #include <linux/crc7.h>
27 #include <linux/spi/spi.h>
28 #include <linux/wl12xx.h>
29 #include <linux/slab.h>
32 #include "wl12xx_80211.h"
37 #define WSPI_CMD_READ 0x40000000
38 #define WSPI_CMD_WRITE 0x00000000
39 #define WSPI_CMD_FIXED 0x20000000
40 #define WSPI_CMD_BYTE_LENGTH 0x1FFE0000
41 #define WSPI_CMD_BYTE_LENGTH_OFFSET 17
42 #define WSPI_CMD_BYTE_ADDR 0x0001FFFF
44 #define WSPI_INIT_CMD_CRC_LEN 5
46 #define WSPI_INIT_CMD_START 0x00
47 #define WSPI_INIT_CMD_TX 0x40
48 /* the extra bypass bit is sampled by the TNET as '1' */
49 #define WSPI_INIT_CMD_BYPASS_BIT 0x80
50 #define WSPI_INIT_CMD_FIXEDBUSY_LEN 0x07
51 #define WSPI_INIT_CMD_EN_FIXEDBUSY 0x80
52 #define WSPI_INIT_CMD_DIS_FIXEDBUSY 0x00
53 #define WSPI_INIT_CMD_IOD 0x40
54 #define WSPI_INIT_CMD_IP 0x20
55 #define WSPI_INIT_CMD_CS 0x10
56 #define WSPI_INIT_CMD_WS 0x08
57 #define WSPI_INIT_CMD_WSPI 0x01
58 #define WSPI_INIT_CMD_END 0x01
60 #define WSPI_INIT_CMD_LEN 8
62 #define HW_ACCESS_WSPI_FIXED_BUSY_LEN \
63 ((WL1271_BUSY_WORD_LEN - 4) / sizeof(u32))
64 #define HW_ACCESS_WSPI_INIT_CMD_MASK 0
66 /* HW limitation: maximum possible chunk size is 4095 bytes */
67 #define WSPI_MAX_CHUNK_SIZE 4092
69 #define WSPI_MAX_NUM_OF_CHUNKS (WL1271_AGGR_BUFFER_SIZE / WSPI_MAX_CHUNK_SIZE)
71 static inline struct spi_device *wl_to_spi(struct wl1271 *wl)
76 static struct device *wl1271_spi_wl_to_dev(struct wl1271 *wl)
78 return &(wl_to_spi(wl)->dev);
81 static void wl1271_spi_disable_interrupts(struct wl1271 *wl)
86 static void wl1271_spi_enable_interrupts(struct wl1271 *wl)
91 static void wl1271_spi_reset(struct wl1271 *wl)
94 struct spi_transfer t;
97 cmd = kzalloc(WSPI_INIT_CMD_LEN, GFP_KERNEL);
99 wl1271_error("could not allocate cmd for spi reset");
103 memset(&t, 0, sizeof(t));
104 spi_message_init(&m);
106 memset(cmd, 0xff, WSPI_INIT_CMD_LEN);
109 t.len = WSPI_INIT_CMD_LEN;
110 spi_message_add_tail(&t, &m);
112 spi_sync(wl_to_spi(wl), &m);
115 wl1271_dump(DEBUG_SPI, "spi reset -> ", cmd, WSPI_INIT_CMD_LEN);
118 static void wl1271_spi_init(struct wl1271 *wl)
120 u8 crc[WSPI_INIT_CMD_CRC_LEN], *cmd;
121 struct spi_transfer t;
122 struct spi_message m;
124 cmd = kzalloc(WSPI_INIT_CMD_LEN, GFP_KERNEL);
126 wl1271_error("could not allocate cmd for spi init");
130 memset(crc, 0, sizeof(crc));
131 memset(&t, 0, sizeof(t));
132 spi_message_init(&m);
135 * Set WSPI_INIT_COMMAND
136 * the data is being send from the MSB to LSB
140 cmd[1] = WSPI_INIT_CMD_START | WSPI_INIT_CMD_TX;
143 cmd[6] |= HW_ACCESS_WSPI_INIT_CMD_MASK << 3;
144 cmd[6] |= HW_ACCESS_WSPI_FIXED_BUSY_LEN & WSPI_INIT_CMD_FIXEDBUSY_LEN;
146 if (HW_ACCESS_WSPI_FIXED_BUSY_LEN == 0)
147 cmd[5] |= WSPI_INIT_CMD_DIS_FIXEDBUSY;
149 cmd[5] |= WSPI_INIT_CMD_EN_FIXEDBUSY;
151 cmd[5] |= WSPI_INIT_CMD_IOD | WSPI_INIT_CMD_IP | WSPI_INIT_CMD_CS
152 | WSPI_INIT_CMD_WSPI | WSPI_INIT_CMD_WS;
160 cmd[4] |= crc7(0, crc, WSPI_INIT_CMD_CRC_LEN) << 1;
161 cmd[4] |= WSPI_INIT_CMD_END;
164 t.len = WSPI_INIT_CMD_LEN;
165 spi_message_add_tail(&t, &m);
167 spi_sync(wl_to_spi(wl), &m);
168 wl1271_dump(DEBUG_SPI, "spi init -> ", cmd, WSPI_INIT_CMD_LEN);
172 #define WL1271_BUSY_WORD_TIMEOUT 1000
174 static int wl1271_spi_read_busy(struct wl1271 *wl)
176 struct spi_transfer t[1];
177 struct spi_message m;
179 int num_busy_bytes = 0;
182 * Read further busy words from SPI until a non-busy word is
183 * encountered, then read the data itself into the buffer.
186 num_busy_bytes = WL1271_BUSY_WORD_TIMEOUT;
187 busy_buf = wl->buffer_busyword;
188 while (num_busy_bytes) {
190 spi_message_init(&m);
191 memset(t, 0, sizeof(t));
192 t[0].rx_buf = busy_buf;
193 t[0].len = sizeof(u32);
194 t[0].cs_change = true;
195 spi_message_add_tail(&t[0], &m);
196 spi_sync(wl_to_spi(wl), &m);
202 /* The SPI bus is unresponsive, the read failed. */
203 wl1271_error("SPI read busy-word timeout!\n");
207 static void wl1271_spi_raw_read(struct wl1271 *wl, int addr, void *buf,
208 size_t len, bool fixed)
210 struct spi_transfer t[2];
211 struct spi_message m;
217 chunk_len = min((size_t)WSPI_MAX_CHUNK_SIZE, len);
219 cmd = &wl->buffer_cmd;
220 busy_buf = wl->buffer_busyword;
223 *cmd |= WSPI_CMD_READ;
224 *cmd |= (chunk_len << WSPI_CMD_BYTE_LENGTH_OFFSET) &
225 WSPI_CMD_BYTE_LENGTH;
226 *cmd |= addr & WSPI_CMD_BYTE_ADDR;
229 *cmd |= WSPI_CMD_FIXED;
231 spi_message_init(&m);
232 memset(t, 0, sizeof(t));
236 t[0].cs_change = true;
237 spi_message_add_tail(&t[0], &m);
239 /* Busy and non busy words read */
240 t[1].rx_buf = busy_buf;
241 t[1].len = WL1271_BUSY_WORD_LEN;
242 t[1].cs_change = true;
243 spi_message_add_tail(&t[1], &m);
245 spi_sync(wl_to_spi(wl), &m);
247 if (!(busy_buf[WL1271_BUSY_WORD_CNT - 1] & 0x1) &&
248 wl1271_spi_read_busy(wl)) {
249 memset(buf, 0, chunk_len);
253 spi_message_init(&m);
254 memset(t, 0, sizeof(t));
257 t[0].len = chunk_len;
258 t[0].cs_change = true;
259 spi_message_add_tail(&t[0], &m);
261 spi_sync(wl_to_spi(wl), &m);
263 wl1271_dump(DEBUG_SPI, "spi_read cmd -> ", cmd, sizeof(*cmd));
264 wl1271_dump(DEBUG_SPI, "spi_read buf <- ", buf, chunk_len);
273 static void wl1271_spi_raw_write(struct wl1271 *wl, int addr, void *buf,
274 size_t len, bool fixed)
276 struct spi_transfer t[2 * WSPI_MAX_NUM_OF_CHUNKS];
277 struct spi_message m;
278 u32 commands[WSPI_MAX_NUM_OF_CHUNKS];
283 WARN_ON(len > WL1271_AGGR_BUFFER_SIZE);
285 spi_message_init(&m);
286 memset(t, 0, sizeof(t));
291 chunk_len = min((size_t)WSPI_MAX_CHUNK_SIZE, len);
294 *cmd |= WSPI_CMD_WRITE;
295 *cmd |= (chunk_len << WSPI_CMD_BYTE_LENGTH_OFFSET) &
296 WSPI_CMD_BYTE_LENGTH;
297 *cmd |= addr & WSPI_CMD_BYTE_ADDR;
300 *cmd |= WSPI_CMD_FIXED;
303 t[i].len = sizeof(*cmd);
304 spi_message_add_tail(&t[i++], &m);
307 t[i].len = chunk_len;
308 spi_message_add_tail(&t[i++], &m);
310 wl1271_dump(DEBUG_SPI, "spi_write cmd -> ", cmd, sizeof(*cmd));
311 wl1271_dump(DEBUG_SPI, "spi_write buf -> ", buf, chunk_len);
320 spi_sync(wl_to_spi(wl), &m);
323 static irqreturn_t wl1271_irq(int irq, void *cookie)
328 wl1271_debug(DEBUG_IRQ, "IRQ");
332 /* complete the ELP completion */
333 spin_lock_irqsave(&wl->wl_lock, flags);
335 complete(wl->elp_compl);
336 wl->elp_compl = NULL;
339 if (!test_and_set_bit(WL1271_FLAG_IRQ_RUNNING, &wl->flags))
340 ieee80211_queue_work(wl->hw, &wl->irq_work);
341 set_bit(WL1271_FLAG_IRQ_PENDING, &wl->flags);
342 spin_unlock_irqrestore(&wl->wl_lock, flags);
347 static int wl1271_spi_set_power(struct wl1271 *wl, bool enable)
350 wl->set_power(enable);
355 static struct wl1271_if_operations spi_ops = {
356 .read = wl1271_spi_raw_read,
357 .write = wl1271_spi_raw_write,
358 .reset = wl1271_spi_reset,
359 .init = wl1271_spi_init,
360 .power = wl1271_spi_set_power,
361 .dev = wl1271_spi_wl_to_dev,
362 .enable_irq = wl1271_spi_enable_interrupts,
363 .disable_irq = wl1271_spi_disable_interrupts
366 static int __devinit wl1271_probe(struct spi_device *spi)
368 struct wl12xx_platform_data *pdata;
369 struct ieee80211_hw *hw;
373 pdata = spi->dev.platform_data;
375 wl1271_error("no platform data");
379 hw = wl1271_alloc_hw();
385 dev_set_drvdata(&spi->dev, wl);
388 wl->if_ops = &spi_ops;
390 /* This is the only SPI value that we need to set here, the rest
391 * comes from the board-peripherals file */
392 spi->bits_per_word = 32;
394 ret = spi_setup(spi);
396 wl1271_error("spi_setup failed");
400 wl->set_power = pdata->set_power;
401 if (!wl->set_power) {
402 wl1271_error("set power function missing in platform data");
407 wl->ref_clock = pdata->board_ref_clock;
411 wl1271_error("irq missing in platform data");
416 ret = request_irq(wl->irq, wl1271_irq, 0, DRIVER_NAME, wl);
418 wl1271_error("request_irq() failed: %d", ret);
422 set_irq_type(wl->irq, IRQ_TYPE_EDGE_RISING);
424 disable_irq(wl->irq);
426 ret = wl1271_init_ieee80211(wl);
430 ret = wl1271_register_hw(wl);
434 wl1271_notice("initialized");
439 free_irq(wl->irq, wl);
447 static int __devexit wl1271_remove(struct spi_device *spi)
449 struct wl1271 *wl = dev_get_drvdata(&spi->dev);
451 wl1271_unregister_hw(wl);
452 free_irq(wl->irq, wl);
459 static struct spi_driver wl1271_spi_driver = {
461 .name = "wl1271_spi",
462 .bus = &spi_bus_type,
463 .owner = THIS_MODULE,
466 .probe = wl1271_probe,
467 .remove = __devexit_p(wl1271_remove),
470 static int __init wl1271_init(void)
474 ret = spi_register_driver(&wl1271_spi_driver);
476 wl1271_error("failed to register spi driver: %d", ret);
484 static void __exit wl1271_exit(void)
486 spi_unregister_driver(&wl1271_spi_driver);
488 wl1271_notice("unloaded");
491 module_init(wl1271_init);
492 module_exit(wl1271_exit);
494 MODULE_LICENSE("GPL");
495 MODULE_AUTHOR("Luciano Coelho <luciano.coelho@nokia.com>");
496 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
497 MODULE_FIRMWARE(WL1271_FW_NAME);
498 MODULE_ALIAS("spi:wl1271");