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/interrupt.h>
25 #include <linux/irq.h>
26 #include <linux/module.h>
27 #include <linux/slab.h>
28 #include <linux/swab.h>
29 #include <linux/crc7.h>
30 #include <linux/spi/spi.h>
31 #include <linux/wl12xx.h>
32 #include <linux/platform_device.h>
33 #include <linux/of_irq.h>
34 #include <linux/regulator/consumer.h>
37 #include "wl12xx_80211.h"
40 #define WSPI_CMD_READ 0x40000000
41 #define WSPI_CMD_WRITE 0x00000000
42 #define WSPI_CMD_FIXED 0x20000000
43 #define WSPI_CMD_BYTE_LENGTH 0x1FFE0000
44 #define WSPI_CMD_BYTE_LENGTH_OFFSET 17
45 #define WSPI_CMD_BYTE_ADDR 0x0001FFFF
47 #define WSPI_INIT_CMD_CRC_LEN 5
49 #define WSPI_INIT_CMD_START 0x00
50 #define WSPI_INIT_CMD_TX 0x40
51 /* the extra bypass bit is sampled by the TNET as '1' */
52 #define WSPI_INIT_CMD_BYPASS_BIT 0x80
53 #define WSPI_INIT_CMD_FIXEDBUSY_LEN 0x07
54 #define WSPI_INIT_CMD_EN_FIXEDBUSY 0x80
55 #define WSPI_INIT_CMD_DIS_FIXEDBUSY 0x00
56 #define WSPI_INIT_CMD_IOD 0x40
57 #define WSPI_INIT_CMD_IP 0x20
58 #define WSPI_INIT_CMD_CS 0x10
59 #define WSPI_INIT_CMD_WS 0x08
60 #define WSPI_INIT_CMD_WSPI 0x01
61 #define WSPI_INIT_CMD_END 0x01
63 #define WSPI_INIT_CMD_LEN 8
65 #define HW_ACCESS_WSPI_FIXED_BUSY_LEN \
66 ((WL1271_BUSY_WORD_LEN - 4) / sizeof(u32))
67 #define HW_ACCESS_WSPI_INIT_CMD_MASK 0
69 /* HW limitation: maximum possible chunk size is 4095 bytes */
70 #define WSPI_MAX_CHUNK_SIZE 4092
73 * only support SPI for 12xx - this code should be reworked when 18xx
74 * support is introduced
76 #define SPI_AGGR_BUFFER_SIZE (4 * PAGE_SIZE)
78 /* Maximum number of SPI write chunks */
79 #define WSPI_MAX_NUM_OF_CHUNKS \
80 ((SPI_AGGR_BUFFER_SIZE / WSPI_MAX_CHUNK_SIZE) + 1)
83 struct wl12xx_spi_glue {
85 struct platform_device *core;
86 struct regulator *reg; /* Power regulator */
89 static void wl12xx_spi_reset(struct device *child)
91 struct wl12xx_spi_glue *glue = dev_get_drvdata(child->parent);
93 struct spi_transfer t;
96 cmd = kzalloc(WSPI_INIT_CMD_LEN, GFP_KERNEL);
98 dev_err(child->parent,
99 "could not allocate cmd for spi reset\n");
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(to_spi_device(glue->dev), &m);
117 static void wl12xx_spi_init(struct device *child)
119 struct wl12xx_spi_glue *glue = dev_get_drvdata(child->parent);
120 struct spi_transfer t;
121 struct spi_message m;
122 u8 *cmd = kzalloc(WSPI_INIT_CMD_LEN, GFP_KERNEL);
125 dev_err(child->parent,
126 "could not allocate cmd for spi init\n");
130 memset(&t, 0, sizeof(t));
131 spi_message_init(&m);
134 * Set WSPI_INIT_COMMAND
135 * the data is being send from the MSB to LSB
139 cmd[2] = WSPI_INIT_CMD_START | WSPI_INIT_CMD_TX;
142 cmd[5] = HW_ACCESS_WSPI_INIT_CMD_MASK << 3;
143 cmd[5] |= HW_ACCESS_WSPI_FIXED_BUSY_LEN & WSPI_INIT_CMD_FIXEDBUSY_LEN;
145 cmd[6] = WSPI_INIT_CMD_IOD | WSPI_INIT_CMD_IP | WSPI_INIT_CMD_CS
146 | WSPI_INIT_CMD_WSPI | WSPI_INIT_CMD_WS;
148 if (HW_ACCESS_WSPI_FIXED_BUSY_LEN == 0)
149 cmd[6] |= WSPI_INIT_CMD_DIS_FIXEDBUSY;
151 cmd[6] |= WSPI_INIT_CMD_EN_FIXEDBUSY;
153 cmd[7] = crc7_be(0, cmd+2, WSPI_INIT_CMD_CRC_LEN) | WSPI_INIT_CMD_END;
155 * The above is the logical order; it must actually be stored
156 * in the buffer byte-swapped.
158 __swab32s((u32 *)cmd);
159 __swab32s((u32 *)cmd+1);
162 t.len = WSPI_INIT_CMD_LEN;
163 spi_message_add_tail(&t, &m);
165 spi_sync(to_spi_device(glue->dev), &m);
169 #define WL1271_BUSY_WORD_TIMEOUT 1000
171 static int wl12xx_spi_read_busy(struct device *child)
173 struct wl12xx_spi_glue *glue = dev_get_drvdata(child->parent);
174 struct wl1271 *wl = dev_get_drvdata(child);
175 struct spi_transfer t[1];
176 struct spi_message m;
178 int num_busy_bytes = 0;
181 * Read further busy words from SPI until a non-busy word is
182 * encountered, then read the data itself into the buffer.
185 num_busy_bytes = WL1271_BUSY_WORD_TIMEOUT;
186 busy_buf = wl->buffer_busyword;
187 while (num_busy_bytes) {
189 spi_message_init(&m);
190 memset(t, 0, sizeof(t));
191 t[0].rx_buf = busy_buf;
192 t[0].len = sizeof(u32);
193 t[0].cs_change = true;
194 spi_message_add_tail(&t[0], &m);
195 spi_sync(to_spi_device(glue->dev), &m);
201 /* The SPI bus is unresponsive, the read failed. */
202 dev_err(child->parent, "SPI read busy-word timeout!\n");
206 static int __must_check wl12xx_spi_raw_read(struct device *child, int addr,
207 void *buf, size_t len, bool fixed)
209 struct wl12xx_spi_glue *glue = dev_get_drvdata(child->parent);
210 struct wl1271 *wl = dev_get_drvdata(child);
211 struct spi_transfer t[2];
212 struct spi_message m;
218 chunk_len = min_t(size_t, WSPI_MAX_CHUNK_SIZE, len);
220 cmd = &wl->buffer_cmd;
221 busy_buf = wl->buffer_busyword;
224 *cmd |= WSPI_CMD_READ;
225 *cmd |= (chunk_len << WSPI_CMD_BYTE_LENGTH_OFFSET) &
226 WSPI_CMD_BYTE_LENGTH;
227 *cmd |= addr & WSPI_CMD_BYTE_ADDR;
230 *cmd |= WSPI_CMD_FIXED;
232 spi_message_init(&m);
233 memset(t, 0, sizeof(t));
237 t[0].cs_change = true;
238 spi_message_add_tail(&t[0], &m);
240 /* Busy and non busy words read */
241 t[1].rx_buf = busy_buf;
242 t[1].len = WL1271_BUSY_WORD_LEN;
243 t[1].cs_change = true;
244 spi_message_add_tail(&t[1], &m);
246 spi_sync(to_spi_device(glue->dev), &m);
248 if (!(busy_buf[WL1271_BUSY_WORD_CNT - 1] & 0x1) &&
249 wl12xx_spi_read_busy(child)) {
250 memset(buf, 0, chunk_len);
254 spi_message_init(&m);
255 memset(t, 0, sizeof(t));
258 t[0].len = chunk_len;
259 t[0].cs_change = true;
260 spi_message_add_tail(&t[0], &m);
262 spi_sync(to_spi_device(glue->dev), &m);
273 static int __must_check wl12xx_spi_raw_write(struct device *child, int addr,
274 void *buf, size_t len, bool fixed)
276 struct wl12xx_spi_glue *glue = dev_get_drvdata(child->parent);
277 /* SPI write buffers - 2 for each chunk */
278 struct spi_transfer t[2 * WSPI_MAX_NUM_OF_CHUNKS];
279 struct spi_message m;
280 u32 commands[WSPI_MAX_NUM_OF_CHUNKS]; /* 1 command per chunk */
285 WARN_ON(len > SPI_AGGR_BUFFER_SIZE);
287 spi_message_init(&m);
288 memset(t, 0, sizeof(t));
293 chunk_len = min_t(size_t, WSPI_MAX_CHUNK_SIZE, len);
296 *cmd |= WSPI_CMD_WRITE;
297 *cmd |= (chunk_len << WSPI_CMD_BYTE_LENGTH_OFFSET) &
298 WSPI_CMD_BYTE_LENGTH;
299 *cmd |= addr & WSPI_CMD_BYTE_ADDR;
302 *cmd |= WSPI_CMD_FIXED;
305 t[i].len = sizeof(*cmd);
306 spi_message_add_tail(&t[i++], &m);
309 t[i].len = chunk_len;
310 spi_message_add_tail(&t[i++], &m);
319 spi_sync(to_spi_device(glue->dev), &m);
325 * wl12xx_spi_set_power - power on/off the wl12xx unit
326 * @child: wl12xx device handle.
327 * @enable: true/false to power on/off the unit.
329 * use the WiFi enable regulator to enable/disable the WiFi unit.
331 static int wl12xx_spi_set_power(struct device *child, bool enable)
334 struct wl12xx_spi_glue *glue = dev_get_drvdata(child->parent);
338 /* Update regulator state */
340 ret = regulator_enable(glue->reg);
342 dev_err(child, "Power enable failure\n");
344 ret = regulator_disable(glue->reg);
346 dev_err(child, "Power disable failure\n");
352 static struct wl1271_if_operations spi_ops = {
353 .read = wl12xx_spi_raw_read,
354 .write = wl12xx_spi_raw_write,
355 .reset = wl12xx_spi_reset,
356 .init = wl12xx_spi_init,
357 .power = wl12xx_spi_set_power,
358 .set_block_size = NULL,
361 static const struct of_device_id wlcore_spi_of_match_table[] = {
362 { .compatible = "ti,wl1271" },
365 MODULE_DEVICE_TABLE(of, wlcore_spi_of_match_table);
368 * wlcore_probe_of - DT node parsing.
369 * @spi: SPI slave device parameters.
370 * @res: resource parameters.
371 * @glue: wl12xx SPI bus to slave device glue parameters.
372 * @pdev_data: wlcore device parameters
374 static int wlcore_probe_of(struct spi_device *spi, struct wl12xx_spi_glue *glue,
375 struct wlcore_platdev_data *pdev_data)
377 struct device_node *dt_node = spi->dev.of_node;
380 if (of_find_property(dt_node, "clock-xtal", NULL))
381 pdev_data->ref_clock_xtal = true;
383 ret = of_property_read_u32(dt_node, "ref-clock-frequency",
384 &pdev_data->ref_clock_freq);
387 "can't get reference clock frequency (%d)\n", ret);
394 static int wl1271_probe(struct spi_device *spi)
396 struct wl12xx_spi_glue *glue;
397 struct wlcore_platdev_data pdev_data;
398 struct resource res[1];
401 memset(&pdev_data, 0x00, sizeof(pdev_data));
403 pdev_data.if_ops = &spi_ops;
405 glue = devm_kzalloc(&spi->dev, sizeof(*glue), GFP_KERNEL);
407 dev_err(&spi->dev, "can't allocate glue\n");
411 glue->dev = &spi->dev;
413 spi_set_drvdata(spi, glue);
415 /* This is the only SPI value that we need to set here, the rest
416 * comes from the board-peripherals file */
417 spi->bits_per_word = 32;
419 glue->reg = devm_regulator_get(&spi->dev, "vwlan");
420 if (PTR_ERR(glue->reg) == -EPROBE_DEFER)
421 return -EPROBE_DEFER;
422 if (IS_ERR(glue->reg)) {
423 dev_err(glue->dev, "can't get regulator\n");
424 return PTR_ERR(glue->reg);
427 ret = wlcore_probe_of(spi, glue, &pdev_data);
430 "can't get device tree parameters (%d)\n", ret);
434 ret = spi_setup(spi);
436 dev_err(glue->dev, "spi_setup failed\n");
440 glue->core = platform_device_alloc("wl12xx", PLATFORM_DEVID_AUTO);
442 dev_err(glue->dev, "can't allocate platform_device\n");
446 glue->core->dev.parent = &spi->dev;
448 memset(res, 0x00, sizeof(res));
450 res[0].start = spi->irq;
451 res[0].flags = IORESOURCE_IRQ | irq_get_trigger_type(spi->irq);
454 ret = platform_device_add_resources(glue->core, res, ARRAY_SIZE(res));
456 dev_err(glue->dev, "can't add resources\n");
460 ret = platform_device_add_data(glue->core, &pdev_data,
463 dev_err(glue->dev, "can't add platform data\n");
467 ret = platform_device_add(glue->core);
469 dev_err(glue->dev, "can't register platform device\n");
476 platform_device_put(glue->core);
480 static int wl1271_remove(struct spi_device *spi)
482 struct wl12xx_spi_glue *glue = spi_get_drvdata(spi);
484 platform_device_unregister(glue->core);
489 static struct spi_driver wl1271_spi_driver = {
491 .name = "wl1271_spi",
492 .of_match_table = of_match_ptr(wlcore_spi_of_match_table),
495 .probe = wl1271_probe,
496 .remove = wl1271_remove,
499 module_spi_driver(wl1271_spi_driver);
500 MODULE_LICENSE("GPL");
501 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
502 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
503 MODULE_ALIAS("spi:wl1271");