blob: e5cc07357746afd20c55c75ae3a407d35c2d14d0 [file] [log] [blame]
Mika Westerberg011f23a2010-05-06 04:47:04 +00001/*
2 * Driver for Cirrus Logic EP93xx SPI controller.
3 *
Mika Westerberg626a96d2011-05-29 13:10:06 +03004 * Copyright (C) 2010-2011 Mika Westerberg
Mika Westerberg011f23a2010-05-06 04:47:04 +00005 *
6 * Explicit FIFO handling code was inspired by amba-pl022 driver.
7 *
8 * Chip select support using other than built-in GPIOs by H. Hartley Sweeten.
9 *
10 * For more information about the SPI controller see documentation on Cirrus
11 * Logic web site:
12 * http://www.cirrus.com/en/pubs/manual/EP93xx_Users_Guide_UM1.pdf
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
17 */
18
19#include <linux/io.h>
20#include <linux/clk.h>
21#include <linux/err.h>
22#include <linux/delay.h>
23#include <linux/device.h>
Mika Westerberg626a96d2011-05-29 13:10:06 +030024#include <linux/dmaengine.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000025#include <linux/bitops.h>
26#include <linux/interrupt.h>
Mika Westerberg5bdb76132011-10-15 21:40:09 +030027#include <linux/module.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000028#include <linux/platform_device.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000029#include <linux/sched.h>
Mika Westerberg626a96d2011-05-29 13:10:06 +030030#include <linux/scatterlist.h>
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -070031#include <linux/gpio.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000032#include <linux/spi/spi.h>
33
Arnd Bergmanna3b292452012-08-24 15:12:11 +020034#include <linux/platform_data/dma-ep93xx.h>
35#include <linux/platform_data/spi-ep93xx.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000036
37#define SSPCR0 0x0000
38#define SSPCR0_MODE_SHIFT 6
39#define SSPCR0_SCR_SHIFT 8
40
41#define SSPCR1 0x0004
42#define SSPCR1_RIE BIT(0)
43#define SSPCR1_TIE BIT(1)
44#define SSPCR1_RORIE BIT(2)
45#define SSPCR1_LBM BIT(3)
46#define SSPCR1_SSE BIT(4)
47#define SSPCR1_MS BIT(5)
48#define SSPCR1_SOD BIT(6)
49
50#define SSPDR 0x0008
51
52#define SSPSR 0x000c
53#define SSPSR_TFE BIT(0)
54#define SSPSR_TNF BIT(1)
55#define SSPSR_RNE BIT(2)
56#define SSPSR_RFF BIT(3)
57#define SSPSR_BSY BIT(4)
58#define SSPCPSR 0x0010
59
60#define SSPIIR 0x0014
61#define SSPIIR_RIS BIT(0)
62#define SSPIIR_TIS BIT(1)
63#define SSPIIR_RORIS BIT(2)
64#define SSPICR SSPIIR
65
66/* timeout in milliseconds */
67#define SPI_TIMEOUT 5
68/* maximum depth of RX/TX FIFO */
69#define SPI_FIFO_SIZE 8
70
71/**
72 * struct ep93xx_spi - EP93xx SPI controller structure
Mika Westerberg011f23a2010-05-06 04:47:04 +000073 * @clk: clock for the controller
H Hartley Sweeten12329782017-08-09 08:51:25 +120074 * @mmio: pointer to ioremap()'d registers
Mika Westerberg626a96d2011-05-29 13:10:06 +030075 * @sspdr_phys: physical address of the SSPDR register
Mika Westerberg011f23a2010-05-06 04:47:04 +000076 * @tx: current byte in transfer to transmit
77 * @rx: current byte in transfer to receive
78 * @fifo_level: how full is FIFO (%0..%SPI_FIFO_SIZE - %1). Receiving one
79 * frame decreases this level and sending one frame increases it.
Mika Westerberg626a96d2011-05-29 13:10:06 +030080 * @dma_rx: RX DMA channel
81 * @dma_tx: TX DMA channel
82 * @dma_rx_data: RX parameters passed to the DMA engine
83 * @dma_tx_data: TX parameters passed to the DMA engine
84 * @rx_sgt: sg table for RX transfers
85 * @tx_sgt: sg table for TX transfers
86 * @zeropage: dummy page used as RX buffer when only TX buffer is passed in by
87 * the client
Mika Westerberg011f23a2010-05-06 04:47:04 +000088 */
89struct ep93xx_spi {
Mika Westerberg011f23a2010-05-06 04:47:04 +000090 struct clk *clk;
H Hartley Sweeten12329782017-08-09 08:51:25 +120091 void __iomem *mmio;
Mika Westerberg626a96d2011-05-29 13:10:06 +030092 unsigned long sspdr_phys;
Mika Westerberg011f23a2010-05-06 04:47:04 +000093 size_t tx;
94 size_t rx;
95 size_t fifo_level;
Mika Westerberg626a96d2011-05-29 13:10:06 +030096 struct dma_chan *dma_rx;
97 struct dma_chan *dma_tx;
98 struct ep93xx_dma_data dma_rx_data;
99 struct ep93xx_dma_data dma_tx_data;
100 struct sg_table rx_sgt;
101 struct sg_table tx_sgt;
102 void *zeropage;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000103};
104
Mika Westerberg011f23a2010-05-06 04:47:04 +0000105/* converts bits per word to CR0.DSS value */
106#define bits_per_word_to_dss(bpw) ((bpw) - 1)
107
Mika Westerberg011f23a2010-05-06 04:47:04 +0000108/**
109 * ep93xx_spi_calc_divisors() - calculates SPI clock divisors
H Hartley Sweeten48738832017-08-09 08:51:29 +1200110 * @master: SPI master
Mika Westerberg011f23a2010-05-06 04:47:04 +0000111 * @rate: desired SPI output clock rate
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700112 * @div_cpsr: pointer to return the cpsr (pre-scaler) divider
113 * @div_scr: pointer to return the scr divider
Mika Westerberg011f23a2010-05-06 04:47:04 +0000114 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200115static int ep93xx_spi_calc_divisors(struct spi_master *master,
Axel Lin56fc0b42014-02-08 23:52:26 +0800116 u32 rate, u8 *div_cpsr, u8 *div_scr)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000117{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200118 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000119 unsigned long spi_clk_rate = clk_get_rate(espi->clk);
120 int cpsr, scr;
121
122 /*
123 * Make sure that max value is between values supported by the
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200124 * controller.
Mika Westerberg011f23a2010-05-06 04:47:04 +0000125 */
Axel Lin56fc0b42014-02-08 23:52:26 +0800126 rate = clamp(rate, master->min_speed_hz, master->max_speed_hz);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000127
128 /*
129 * Calculate divisors so that we can get speed according the
130 * following formula:
131 * rate = spi_clock_rate / (cpsr * (1 + scr))
132 *
133 * cpsr must be even number and starts from 2, scr can be any number
134 * between 0 and 255.
135 */
136 for (cpsr = 2; cpsr <= 254; cpsr += 2) {
137 for (scr = 0; scr <= 255; scr++) {
138 if ((spi_clk_rate / (cpsr * (scr + 1))) <= rate) {
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700139 *div_scr = (u8)scr;
140 *div_cpsr = (u8)cpsr;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000141 return 0;
142 }
143 }
144 }
145
146 return -EINVAL;
147}
148
H Hartley Sweeten48738832017-08-09 08:51:29 +1200149static int ep93xx_spi_chip_setup(struct spi_master *master,
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700150 struct spi_device *spi,
151 struct spi_transfer *xfer)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000152{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200153 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700154 u8 dss = bits_per_word_to_dss(xfer->bits_per_word);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700155 u8 div_cpsr = 0;
156 u8 div_scr = 0;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000157 u16 cr0;
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700158 int err;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000159
H Hartley Sweeten48738832017-08-09 08:51:29 +1200160 err = ep93xx_spi_calc_divisors(master, xfer->speed_hz,
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700161 &div_cpsr, &div_scr);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700162 if (err)
163 return err;
164
165 cr0 = div_scr << SSPCR0_SCR_SHIFT;
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700166 cr0 |= (spi->mode & (SPI_CPHA | SPI_CPOL)) << SSPCR0_MODE_SHIFT;
H Hartley Sweetend9b65df2013-07-02 10:09:29 -0700167 cr0 |= dss;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000168
H Hartley Sweeten48738832017-08-09 08:51:29 +1200169 dev_dbg(&master->dev, "setup: mode %d, cpsr %d, scr %d, dss %d\n",
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700170 spi->mode, div_cpsr, div_scr, dss);
H Hartley Sweeten48738832017-08-09 08:51:29 +1200171 dev_dbg(&master->dev, "setup: cr0 %#x\n", cr0);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000172
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200173 writel(div_cpsr, espi->mmio + SSPCPSR);
174 writel(cr0, espi->mmio + SSPCR0);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700175
176 return 0;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000177}
178
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200179static void ep93xx_do_write(struct spi_master *master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000180{
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200181 struct ep93xx_spi *espi = spi_master_get_devdata(master);
182 struct spi_transfer *xfer = master->cur_msg->state;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200183 u32 val = 0;
184
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200185 if (xfer->bits_per_word > 8) {
186 if (xfer->tx_buf)
187 val = ((u16 *)xfer->tx_buf)[espi->tx];
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200188 espi->tx += 2;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000189 } else {
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200190 if (xfer->tx_buf)
191 val = ((u8 *)xfer->tx_buf)[espi->tx];
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200192 espi->tx += 1;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000193 }
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200194 writel(val, espi->mmio + SSPDR);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000195}
196
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200197static void ep93xx_do_read(struct spi_master *master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000198{
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200199 struct ep93xx_spi *espi = spi_master_get_devdata(master);
200 struct spi_transfer *xfer = master->cur_msg->state;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200201 u32 val;
202
203 val = readl(espi->mmio + SSPDR);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200204 if (xfer->bits_per_word > 8) {
205 if (xfer->rx_buf)
206 ((u16 *)xfer->rx_buf)[espi->rx] = val;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200207 espi->rx += 2;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000208 } else {
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200209 if (xfer->rx_buf)
210 ((u8 *)xfer->rx_buf)[espi->rx] = val;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200211 espi->rx += 1;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000212 }
213}
214
215/**
216 * ep93xx_spi_read_write() - perform next RX/TX transfer
217 * @espi: ep93xx SPI controller struct
218 *
219 * This function transfers next bytes (or half-words) to/from RX/TX FIFOs. If
220 * called several times, the whole transfer will be completed. Returns
221 * %-EINPROGRESS when current transfer was not yet completed otherwise %0.
222 *
223 * When this function is finished, RX FIFO should be empty and TX FIFO should be
224 * full.
225 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200226static int ep93xx_spi_read_write(struct spi_master *master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000227{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200228 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200229 struct spi_transfer *xfer = master->cur_msg->state;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000230
231 /* read as long as RX FIFO has frames in it */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200232 while ((readl(espi->mmio + SSPSR) & SSPSR_RNE)) {
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200233 ep93xx_do_read(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000234 espi->fifo_level--;
235 }
236
237 /* write as long as TX FIFO has room */
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200238 while (espi->fifo_level < SPI_FIFO_SIZE && espi->tx < xfer->len) {
239 ep93xx_do_write(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000240 espi->fifo_level++;
241 }
242
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200243 if (espi->rx == xfer->len)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000244 return 0;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000245
246 return -EINPROGRESS;
247}
248
Mika Westerberg626a96d2011-05-29 13:10:06 +0300249/**
250 * ep93xx_spi_dma_prepare() - prepares a DMA transfer
H Hartley Sweeten48738832017-08-09 08:51:29 +1200251 * @master: SPI master
Mika Westerberg626a96d2011-05-29 13:10:06 +0300252 * @dir: DMA transfer direction
253 *
254 * Function configures the DMA, maps the buffer and prepares the DMA
255 * descriptor. Returns a valid DMA descriptor in case of success and ERR_PTR
256 * in case of failure.
257 */
258static struct dma_async_tx_descriptor *
H Hartley Sweeten48738832017-08-09 08:51:29 +1200259ep93xx_spi_dma_prepare(struct spi_master *master,
260 enum dma_transfer_direction dir)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300261{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200262 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200263 struct spi_transfer *xfer = master->cur_msg->state;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300264 struct dma_async_tx_descriptor *txd;
265 enum dma_slave_buswidth buswidth;
266 struct dma_slave_config conf;
267 struct scatterlist *sg;
268 struct sg_table *sgt;
269 struct dma_chan *chan;
270 const void *buf, *pbuf;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200271 size_t len = xfer->len;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300272 int i, ret, nents;
273
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200274 if (xfer->bits_per_word > 8)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300275 buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
276 else
277 buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE;
278
279 memset(&conf, 0, sizeof(conf));
280 conf.direction = dir;
281
H Hartley Sweetend4b9b572012-04-17 18:46:36 -0700282 if (dir == DMA_DEV_TO_MEM) {
Mika Westerberg626a96d2011-05-29 13:10:06 +0300283 chan = espi->dma_rx;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200284 buf = xfer->rx_buf;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300285 sgt = &espi->rx_sgt;
286
287 conf.src_addr = espi->sspdr_phys;
288 conf.src_addr_width = buswidth;
289 } else {
290 chan = espi->dma_tx;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200291 buf = xfer->tx_buf;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300292 sgt = &espi->tx_sgt;
293
294 conf.dst_addr = espi->sspdr_phys;
295 conf.dst_addr_width = buswidth;
296 }
297
298 ret = dmaengine_slave_config(chan, &conf);
299 if (ret)
300 return ERR_PTR(ret);
301
302 /*
303 * We need to split the transfer into PAGE_SIZE'd chunks. This is
304 * because we are using @espi->zeropage to provide a zero RX buffer
305 * for the TX transfers and we have only allocated one page for that.
306 *
307 * For performance reasons we allocate a new sg_table only when
308 * needed. Otherwise we will re-use the current one. Eventually the
309 * last sg_table is released in ep93xx_spi_release_dma().
310 */
311
312 nents = DIV_ROUND_UP(len, PAGE_SIZE);
313 if (nents != sgt->nents) {
314 sg_free_table(sgt);
315
316 ret = sg_alloc_table(sgt, nents, GFP_KERNEL);
317 if (ret)
318 return ERR_PTR(ret);
319 }
320
321 pbuf = buf;
322 for_each_sg(sgt->sgl, sg, sgt->nents, i) {
323 size_t bytes = min_t(size_t, len, PAGE_SIZE);
324
325 if (buf) {
326 sg_set_page(sg, virt_to_page(pbuf), bytes,
327 offset_in_page(pbuf));
328 } else {
329 sg_set_page(sg, virt_to_page(espi->zeropage),
330 bytes, 0);
331 }
332
333 pbuf += bytes;
334 len -= bytes;
335 }
336
337 if (WARN_ON(len)) {
H Hartley Sweeten48738832017-08-09 08:51:29 +1200338 dev_warn(&master->dev, "len = %zu expected 0!\n", len);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300339 return ERR_PTR(-EINVAL);
340 }
341
342 nents = dma_map_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
343 if (!nents)
344 return ERR_PTR(-ENOMEM);
345
H Hartley Sweetend4b9b572012-04-17 18:46:36 -0700346 txd = dmaengine_prep_slave_sg(chan, sgt->sgl, nents, dir, DMA_CTRL_ACK);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300347 if (!txd) {
348 dma_unmap_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
349 return ERR_PTR(-ENOMEM);
350 }
351 return txd;
352}
353
354/**
355 * ep93xx_spi_dma_finish() - finishes with a DMA transfer
H Hartley Sweeten48738832017-08-09 08:51:29 +1200356 * @master: SPI master
Mika Westerberg626a96d2011-05-29 13:10:06 +0300357 * @dir: DMA transfer direction
358 *
359 * Function finishes with the DMA transfer. After this, the DMA buffer is
360 * unmapped.
361 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200362static void ep93xx_spi_dma_finish(struct spi_master *master,
H Hartley Sweetend4b9b572012-04-17 18:46:36 -0700363 enum dma_transfer_direction dir)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300364{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200365 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300366 struct dma_chan *chan;
367 struct sg_table *sgt;
368
H Hartley Sweetend4b9b572012-04-17 18:46:36 -0700369 if (dir == DMA_DEV_TO_MEM) {
Mika Westerberg626a96d2011-05-29 13:10:06 +0300370 chan = espi->dma_rx;
371 sgt = &espi->rx_sgt;
372 } else {
373 chan = espi->dma_tx;
374 sgt = &espi->tx_sgt;
375 }
376
377 dma_unmap_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
378}
379
380static void ep93xx_spi_dma_callback(void *callback_param)
381{
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200382 struct spi_master *master = callback_param;
383
384 ep93xx_spi_dma_finish(master, DMA_MEM_TO_DEV);
385 ep93xx_spi_dma_finish(master, DMA_DEV_TO_MEM);
386
387 spi_finalize_current_transfer(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300388}
389
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200390static int ep93xx_spi_dma_transfer(struct spi_master *master)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300391{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200392 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300393 struct dma_async_tx_descriptor *rxd, *txd;
394
H Hartley Sweeten48738832017-08-09 08:51:29 +1200395 rxd = ep93xx_spi_dma_prepare(master, DMA_DEV_TO_MEM);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300396 if (IS_ERR(rxd)) {
H Hartley Sweeten48738832017-08-09 08:51:29 +1200397 dev_err(&master->dev, "DMA RX failed: %ld\n", PTR_ERR(rxd));
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200398 return PTR_ERR(rxd);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300399 }
400
H Hartley Sweeten48738832017-08-09 08:51:29 +1200401 txd = ep93xx_spi_dma_prepare(master, DMA_MEM_TO_DEV);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300402 if (IS_ERR(txd)) {
H Hartley Sweeten48738832017-08-09 08:51:29 +1200403 ep93xx_spi_dma_finish(master, DMA_DEV_TO_MEM);
404 dev_err(&master->dev, "DMA TX failed: %ld\n", PTR_ERR(txd));
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200405 return PTR_ERR(txd);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300406 }
407
408 /* We are ready when RX is done */
409 rxd->callback = ep93xx_spi_dma_callback;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200410 rxd->callback_param = master;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300411
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200412 /* Now submit both descriptors and start DMA */
Mika Westerberg626a96d2011-05-29 13:10:06 +0300413 dmaengine_submit(rxd);
414 dmaengine_submit(txd);
415
416 dma_async_issue_pending(espi->dma_rx);
417 dma_async_issue_pending(espi->dma_tx);
418
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200419 /* signal that we need to wait for completion */
420 return 1;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000421}
422
423static irqreturn_t ep93xx_spi_interrupt(int irq, void *dev_id)
424{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200425 struct spi_master *master = dev_id;
426 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200427 u32 val;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000428
429 /*
430 * If we got ROR (receive overrun) interrupt we know that something is
431 * wrong. Just abort the message.
432 */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200433 if (readl(espi->mmio + SSPIIR) & SSPIIR_RORIS) {
Mika Westerberg011f23a2010-05-06 04:47:04 +0000434 /* clear the overrun interrupt */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200435 writel(0, espi->mmio + SSPICR);
H Hartley Sweeten48738832017-08-09 08:51:29 +1200436 dev_warn(&master->dev,
Mika Westerberg011f23a2010-05-06 04:47:04 +0000437 "receive overrun, aborting the message\n");
H Hartley Sweetenc7a909c2017-08-09 08:51:30 +1200438 master->cur_msg->status = -EIO;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000439 } else {
440 /*
441 * Interrupt is either RX (RIS) or TX (TIS). For both cases we
442 * simply execute next data transfer.
443 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200444 if (ep93xx_spi_read_write(master)) {
Mika Westerberg011f23a2010-05-06 04:47:04 +0000445 /*
446 * In normal case, there still is some processing left
447 * for current transfer. Let's wait for the next
448 * interrupt then.
449 */
450 return IRQ_HANDLED;
451 }
452 }
453
454 /*
455 * Current transfer is finished, either with error or with success. In
456 * any case we disable interrupts and notify the worker to handle
457 * any post-processing of the message.
458 */
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200459 val = readl(espi->mmio + SSPCR1);
460 val &= ~(SSPCR1_RORIE | SSPCR1_TIE | SSPCR1_RIE);
461 writel(val, espi->mmio + SSPCR1);
462
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200463 spi_finalize_current_transfer(master);
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200464
Mika Westerberg011f23a2010-05-06 04:47:04 +0000465 return IRQ_HANDLED;
466}
467
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200468static int ep93xx_spi_transfer_one(struct spi_master *master,
469 struct spi_device *spi,
470 struct spi_transfer *xfer)
471{
472 struct ep93xx_spi *espi = spi_master_get_devdata(master);
473 u32 val;
474 int ret;
475
476 ret = ep93xx_spi_chip_setup(master, spi, xfer);
477 if (ret) {
478 dev_err(&master->dev, "failed to setup chip for transfer\n");
479 return ret;
480 }
481
482 master->cur_msg->state = xfer;
483 espi->rx = 0;
484 espi->tx = 0;
485
486 /*
487 * There is no point of setting up DMA for the transfers which will
488 * fit into the FIFO and can be transferred with a single interrupt.
489 * So in these cases we will be using PIO and don't bother for DMA.
490 */
491 if (espi->dma_rx && xfer->len > SPI_FIFO_SIZE)
492 return ep93xx_spi_dma_transfer(master);
493
494 /* Using PIO so prime the TX FIFO and enable interrupts */
495 ep93xx_spi_read_write(master);
496
497 val = readl(espi->mmio + SSPCR1);
498 val |= (SSPCR1_RORIE | SSPCR1_TIE | SSPCR1_RIE);
499 writel(val, espi->mmio + SSPCR1);
500
501 /* signal that we need to wait for completion */
502 return 1;
503}
504
505static int ep93xx_spi_prepare_message(struct spi_master *master,
506 struct spi_message *msg)
507{
508 struct ep93xx_spi *espi = spi_master_get_devdata(master);
509 unsigned long timeout;
510
511 /*
512 * Just to be sure: flush any data from RX FIFO.
513 */
514 timeout = jiffies + msecs_to_jiffies(SPI_TIMEOUT);
515 while (readl(espi->mmio + SSPSR) & SSPSR_RNE) {
516 if (time_after(jiffies, timeout)) {
517 dev_warn(&master->dev,
518 "timeout while flushing RX FIFO\n");
519 return -ETIMEDOUT;
520 }
521 readl(espi->mmio + SSPDR);
522 }
523
524 /*
525 * We explicitly handle FIFO level. This way we don't have to check TX
526 * FIFO status using %SSPSR_TNF bit which may cause RX FIFO overruns.
527 */
528 espi->fifo_level = 0;
529
530 return 0;
531}
532
H Hartley Sweeten16779622017-08-09 08:51:27 +1200533static int ep93xx_spi_prepare_hardware(struct spi_master *master)
534{
535 struct ep93xx_spi *espi = spi_master_get_devdata(master);
536 u32 val;
537 int ret;
538
539 ret = clk_enable(espi->clk);
540 if (ret)
541 return ret;
542
543 val = readl(espi->mmio + SSPCR1);
544 val |= SSPCR1_SSE;
545 writel(val, espi->mmio + SSPCR1);
546
547 return 0;
548}
549
550static int ep93xx_spi_unprepare_hardware(struct spi_master *master)
551{
552 struct ep93xx_spi *espi = spi_master_get_devdata(master);
553 u32 val;
554
555 val = readl(espi->mmio + SSPCR1);
556 val &= ~SSPCR1_SSE;
557 writel(val, espi->mmio + SSPCR1);
558
559 clk_disable(espi->clk);
560
561 return 0;
562}
563
Mika Westerberg626a96d2011-05-29 13:10:06 +0300564static bool ep93xx_spi_dma_filter(struct dma_chan *chan, void *filter_param)
565{
566 if (ep93xx_dma_chan_is_m2p(chan))
567 return false;
568
569 chan->private = filter_param;
570 return true;
571}
572
573static int ep93xx_spi_setup_dma(struct ep93xx_spi *espi)
574{
575 dma_cap_mask_t mask;
576 int ret;
577
578 espi->zeropage = (void *)get_zeroed_page(GFP_KERNEL);
579 if (!espi->zeropage)
580 return -ENOMEM;
581
582 dma_cap_zero(mask);
583 dma_cap_set(DMA_SLAVE, mask);
584
585 espi->dma_rx_data.port = EP93XX_DMA_SSP;
Vinod Koula485df42011-10-14 10:47:38 +0530586 espi->dma_rx_data.direction = DMA_DEV_TO_MEM;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300587 espi->dma_rx_data.name = "ep93xx-spi-rx";
588
589 espi->dma_rx = dma_request_channel(mask, ep93xx_spi_dma_filter,
590 &espi->dma_rx_data);
591 if (!espi->dma_rx) {
592 ret = -ENODEV;
593 goto fail_free_page;
594 }
595
596 espi->dma_tx_data.port = EP93XX_DMA_SSP;
Vinod Koula485df42011-10-14 10:47:38 +0530597 espi->dma_tx_data.direction = DMA_MEM_TO_DEV;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300598 espi->dma_tx_data.name = "ep93xx-spi-tx";
599
600 espi->dma_tx = dma_request_channel(mask, ep93xx_spi_dma_filter,
601 &espi->dma_tx_data);
602 if (!espi->dma_tx) {
603 ret = -ENODEV;
604 goto fail_release_rx;
605 }
606
607 return 0;
608
609fail_release_rx:
610 dma_release_channel(espi->dma_rx);
611 espi->dma_rx = NULL;
612fail_free_page:
613 free_page((unsigned long)espi->zeropage);
614
615 return ret;
616}
617
618static void ep93xx_spi_release_dma(struct ep93xx_spi *espi)
619{
620 if (espi->dma_rx) {
621 dma_release_channel(espi->dma_rx);
622 sg_free_table(&espi->rx_sgt);
623 }
624 if (espi->dma_tx) {
625 dma_release_channel(espi->dma_tx);
626 sg_free_table(&espi->tx_sgt);
627 }
628
629 if (espi->zeropage)
630 free_page((unsigned long)espi->zeropage);
631}
632
Grant Likelyfd4a3192012-12-07 16:57:14 +0000633static int ep93xx_spi_probe(struct platform_device *pdev)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000634{
635 struct spi_master *master;
636 struct ep93xx_spi_info *info;
637 struct ep93xx_spi *espi;
638 struct resource *res;
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300639 int irq;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000640 int error;
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700641 int i;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000642
Jingoo Han8074cf02013-07-30 16:58:59 +0900643 info = dev_get_platdata(&pdev->dev);
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700644 if (!info) {
645 dev_err(&pdev->dev, "missing platform data\n");
646 return -EINVAL;
647 }
Mika Westerberg011f23a2010-05-06 04:47:04 +0000648
H Hartley Sweeten48a77762013-07-02 10:07:53 -0700649 irq = platform_get_irq(pdev, 0);
650 if (irq < 0) {
651 dev_err(&pdev->dev, "failed to get irq resources\n");
652 return -EBUSY;
653 }
654
655 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
656 if (!res) {
657 dev_err(&pdev->dev, "unable to get iomem resource\n");
658 return -ENODEV;
659 }
660
Mika Westerberg011f23a2010-05-06 04:47:04 +0000661 master = spi_alloc_master(&pdev->dev, sizeof(*espi));
H Hartley Sweetenb2d185e2013-07-02 10:08:59 -0700662 if (!master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000663 return -ENOMEM;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000664
H Hartley Sweeten16779622017-08-09 08:51:27 +1200665 master->prepare_transfer_hardware = ep93xx_spi_prepare_hardware;
666 master->unprepare_transfer_hardware = ep93xx_spi_unprepare_hardware;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200667 master->prepare_message = ep93xx_spi_prepare_message;
668 master->transfer_one = ep93xx_spi_transfer_one;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000669 master->bus_num = pdev->id;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000670 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
Stephen Warren24778be2013-05-21 20:36:35 -0600671 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000672
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700673 master->num_chipselect = info->num_chipselect;
674 master->cs_gpios = devm_kzalloc(&master->dev,
675 sizeof(int) * master->num_chipselect,
676 GFP_KERNEL);
677 if (!master->cs_gpios) {
678 error = -ENOMEM;
679 goto fail_release_master;
680 }
681
682 for (i = 0; i < master->num_chipselect; i++) {
683 master->cs_gpios[i] = info->chipselect[i];
684
685 if (!gpio_is_valid(master->cs_gpios[i]))
686 continue;
687
688 error = devm_gpio_request_one(&pdev->dev, master->cs_gpios[i],
689 GPIOF_OUT_INIT_HIGH,
690 "ep93xx-spi");
691 if (error) {
692 dev_err(&pdev->dev, "could not request cs gpio %d\n",
693 master->cs_gpios[i]);
694 goto fail_release_master;
695 }
696 }
697
Mika Westerberg011f23a2010-05-06 04:47:04 +0000698 platform_set_drvdata(pdev, master);
699
700 espi = spi_master_get_devdata(master);
701
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700702 espi->clk = devm_clk_get(&pdev->dev, NULL);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000703 if (IS_ERR(espi->clk)) {
704 dev_err(&pdev->dev, "unable to get spi clock\n");
705 error = PTR_ERR(espi->clk);
706 goto fail_release_master;
707 }
708
Mika Westerberg011f23a2010-05-06 04:47:04 +0000709 /*
710 * Calculate maximum and minimum supported clock rates
711 * for the controller.
712 */
Axel Lin56fc0b42014-02-08 23:52:26 +0800713 master->max_speed_hz = clk_get_rate(espi->clk) / 2;
714 master->min_speed_hz = clk_get_rate(espi->clk) / (254 * 256);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000715
Mika Westerberg626a96d2011-05-29 13:10:06 +0300716 espi->sspdr_phys = res->start + SSPDR;
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300717
H Hartley Sweeten12329782017-08-09 08:51:25 +1200718 espi->mmio = devm_ioremap_resource(&pdev->dev, res);
719 if (IS_ERR(espi->mmio)) {
720 error = PTR_ERR(espi->mmio);
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700721 goto fail_release_master;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000722 }
723
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300724 error = devm_request_irq(&pdev->dev, irq, ep93xx_spi_interrupt,
H Hartley Sweeten48738832017-08-09 08:51:29 +1200725 0, "ep93xx-spi", master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000726 if (error) {
727 dev_err(&pdev->dev, "failed to request irq\n");
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700728 goto fail_release_master;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000729 }
730
Mika Westerberg626a96d2011-05-29 13:10:06 +0300731 if (info->use_dma && ep93xx_spi_setup_dma(espi))
732 dev_warn(&pdev->dev, "DMA setup failed. Falling back to PIO\n");
733
Mika Westerberg011f23a2010-05-06 04:47:04 +0000734 /* make sure that the hardware is disabled */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200735 writel(0, espi->mmio + SSPCR1);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000736
Jingoo Han434eaf32013-09-24 13:30:41 +0900737 error = devm_spi_register_master(&pdev->dev, master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000738 if (error) {
739 dev_err(&pdev->dev, "failed to register SPI master\n");
H Hartley Sweeten84ddb3c2013-07-08 09:12:37 -0700740 goto fail_free_dma;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000741 }
742
743 dev_info(&pdev->dev, "EP93xx SPI Controller at 0x%08lx irq %d\n",
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300744 (unsigned long)res->start, irq);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000745
746 return 0;
747
Mika Westerberg626a96d2011-05-29 13:10:06 +0300748fail_free_dma:
749 ep93xx_spi_release_dma(espi);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000750fail_release_master:
751 spi_master_put(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000752
753 return error;
754}
755
Grant Likelyfd4a3192012-12-07 16:57:14 +0000756static int ep93xx_spi_remove(struct platform_device *pdev)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000757{
758 struct spi_master *master = platform_get_drvdata(pdev);
759 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000760
Mika Westerberg626a96d2011-05-29 13:10:06 +0300761 ep93xx_spi_release_dma(espi);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000762
Mika Westerberg011f23a2010-05-06 04:47:04 +0000763 return 0;
764}
765
766static struct platform_driver ep93xx_spi_driver = {
767 .driver = {
768 .name = "ep93xx-spi",
Mika Westerberg011f23a2010-05-06 04:47:04 +0000769 },
Grant Likely940ab882011-10-05 11:29:49 -0600770 .probe = ep93xx_spi_probe,
Grant Likelyfd4a3192012-12-07 16:57:14 +0000771 .remove = ep93xx_spi_remove,
Mika Westerberg011f23a2010-05-06 04:47:04 +0000772};
Grant Likely940ab882011-10-05 11:29:49 -0600773module_platform_driver(ep93xx_spi_driver);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000774
775MODULE_DESCRIPTION("EP93xx SPI Controller driver");
776MODULE_AUTHOR("Mika Westerberg <mika.westerberg@iki.fi>");
777MODULE_LICENSE("GPL");
778MODULE_ALIAS("platform:ep93xx-spi");