blob: 4034e3ec0ba2a8f23bbfc248f1c70e8906df803a [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001// SPDX-License-Identifier: GPL-2.0-only
Mika Westerberg011f23a2010-05-06 04:47:04 +00002/*
3 * Driver for Cirrus Logic EP93xx SPI controller.
4 *
Mika Westerberg626a96d2011-05-29 13:10:06 +03005 * Copyright (C) 2010-2011 Mika Westerberg
Mika Westerberg011f23a2010-05-06 04:47:04 +00006 *
7 * Explicit FIFO handling code was inspired by amba-pl022 driver.
8 *
9 * Chip select support using other than built-in GPIOs by H. Hartley Sweeten.
10 *
11 * For more information about the SPI controller see documentation on Cirrus
12 * Logic web site:
13 * http://www.cirrus.com/en/pubs/manual/EP93xx_Users_Guide_UM1.pdf
Mika Westerberg011f23a2010-05-06 04:47:04 +000014 */
15
16#include <linux/io.h>
17#include <linux/clk.h>
18#include <linux/err.h>
19#include <linux/delay.h>
20#include <linux/device.h>
Mika Westerberg626a96d2011-05-29 13:10:06 +030021#include <linux/dmaengine.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000022#include <linux/bitops.h>
23#include <linux/interrupt.h>
Mika Westerberg5bdb76132011-10-15 21:40:09 +030024#include <linux/module.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000025#include <linux/platform_device.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000026#include <linux/sched.h>
Mika Westerberg626a96d2011-05-29 13:10:06 +030027#include <linux/scatterlist.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000028#include <linux/spi/spi.h>
29
Arnd Bergmanna3b29242012-08-24 15:12:11 +020030#include <linux/platform_data/dma-ep93xx.h>
31#include <linux/platform_data/spi-ep93xx.h>
Mika Westerberg011f23a2010-05-06 04:47:04 +000032
33#define SSPCR0 0x0000
34#define SSPCR0_MODE_SHIFT 6
35#define SSPCR0_SCR_SHIFT 8
36
37#define SSPCR1 0x0004
38#define SSPCR1_RIE BIT(0)
39#define SSPCR1_TIE BIT(1)
40#define SSPCR1_RORIE BIT(2)
41#define SSPCR1_LBM BIT(3)
42#define SSPCR1_SSE BIT(4)
43#define SSPCR1_MS BIT(5)
44#define SSPCR1_SOD BIT(6)
45
46#define SSPDR 0x0008
47
48#define SSPSR 0x000c
49#define SSPSR_TFE BIT(0)
50#define SSPSR_TNF BIT(1)
51#define SSPSR_RNE BIT(2)
52#define SSPSR_RFF BIT(3)
53#define SSPSR_BSY BIT(4)
54#define SSPCPSR 0x0010
55
56#define SSPIIR 0x0014
57#define SSPIIR_RIS BIT(0)
58#define SSPIIR_TIS BIT(1)
59#define SSPIIR_RORIS BIT(2)
60#define SSPICR SSPIIR
61
62/* timeout in milliseconds */
63#define SPI_TIMEOUT 5
64/* maximum depth of RX/TX FIFO */
65#define SPI_FIFO_SIZE 8
66
67/**
68 * struct ep93xx_spi - EP93xx SPI controller structure
Mika Westerberg011f23a2010-05-06 04:47:04 +000069 * @clk: clock for the controller
H Hartley Sweeten12329782017-08-09 08:51:25 +120070 * @mmio: pointer to ioremap()'d registers
Mika Westerberg626a96d2011-05-29 13:10:06 +030071 * @sspdr_phys: physical address of the SSPDR register
Mika Westerberg011f23a2010-05-06 04:47:04 +000072 * @tx: current byte in transfer to transmit
73 * @rx: current byte in transfer to receive
74 * @fifo_level: how full is FIFO (%0..%SPI_FIFO_SIZE - %1). Receiving one
75 * frame decreases this level and sending one frame increases it.
Mika Westerberg626a96d2011-05-29 13:10:06 +030076 * @dma_rx: RX DMA channel
77 * @dma_tx: TX DMA channel
78 * @dma_rx_data: RX parameters passed to the DMA engine
79 * @dma_tx_data: TX parameters passed to the DMA engine
80 * @rx_sgt: sg table for RX transfers
81 * @tx_sgt: sg table for TX transfers
82 * @zeropage: dummy page used as RX buffer when only TX buffer is passed in by
83 * the client
Mika Westerberg011f23a2010-05-06 04:47:04 +000084 */
85struct ep93xx_spi {
Mika Westerberg011f23a2010-05-06 04:47:04 +000086 struct clk *clk;
H Hartley Sweeten12329782017-08-09 08:51:25 +120087 void __iomem *mmio;
Mika Westerberg626a96d2011-05-29 13:10:06 +030088 unsigned long sspdr_phys;
Mika Westerberg011f23a2010-05-06 04:47:04 +000089 size_t tx;
90 size_t rx;
91 size_t fifo_level;
Mika Westerberg626a96d2011-05-29 13:10:06 +030092 struct dma_chan *dma_rx;
93 struct dma_chan *dma_tx;
94 struct ep93xx_dma_data dma_rx_data;
95 struct ep93xx_dma_data dma_tx_data;
96 struct sg_table rx_sgt;
97 struct sg_table tx_sgt;
98 void *zeropage;
Mika Westerberg011f23a2010-05-06 04:47:04 +000099};
100
Mika Westerberg011f23a2010-05-06 04:47:04 +0000101/* converts bits per word to CR0.DSS value */
102#define bits_per_word_to_dss(bpw) ((bpw) - 1)
103
Mika Westerberg011f23a2010-05-06 04:47:04 +0000104/**
105 * ep93xx_spi_calc_divisors() - calculates SPI clock divisors
H Hartley Sweeten48738832017-08-09 08:51:29 +1200106 * @master: SPI master
Mika Westerberg011f23a2010-05-06 04:47:04 +0000107 * @rate: desired SPI output clock rate
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700108 * @div_cpsr: pointer to return the cpsr (pre-scaler) divider
109 * @div_scr: pointer to return the scr divider
Mika Westerberg011f23a2010-05-06 04:47:04 +0000110 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200111static int ep93xx_spi_calc_divisors(struct spi_master *master,
Axel Lin56fc0b42014-02-08 23:52:26 +0800112 u32 rate, u8 *div_cpsr, u8 *div_scr)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000113{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200114 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000115 unsigned long spi_clk_rate = clk_get_rate(espi->clk);
116 int cpsr, scr;
117
118 /*
119 * Make sure that max value is between values supported by the
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200120 * controller.
Mika Westerberg011f23a2010-05-06 04:47:04 +0000121 */
Axel Lin56fc0b42014-02-08 23:52:26 +0800122 rate = clamp(rate, master->min_speed_hz, master->max_speed_hz);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000123
124 /*
125 * Calculate divisors so that we can get speed according the
126 * following formula:
127 * rate = spi_clock_rate / (cpsr * (1 + scr))
128 *
129 * cpsr must be even number and starts from 2, scr can be any number
130 * between 0 and 255.
131 */
132 for (cpsr = 2; cpsr <= 254; cpsr += 2) {
133 for (scr = 0; scr <= 255; scr++) {
134 if ((spi_clk_rate / (cpsr * (scr + 1))) <= rate) {
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700135 *div_scr = (u8)scr;
136 *div_cpsr = (u8)cpsr;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000137 return 0;
138 }
139 }
140 }
141
142 return -EINVAL;
143}
144
H Hartley Sweeten48738832017-08-09 08:51:29 +1200145static int ep93xx_spi_chip_setup(struct spi_master *master,
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700146 struct spi_device *spi,
147 struct spi_transfer *xfer)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000148{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200149 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700150 u8 dss = bits_per_word_to_dss(xfer->bits_per_word);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700151 u8 div_cpsr = 0;
152 u8 div_scr = 0;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000153 u16 cr0;
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700154 int err;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000155
H Hartley Sweeten48738832017-08-09 08:51:29 +1200156 err = ep93xx_spi_calc_divisors(master, xfer->speed_hz,
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700157 &div_cpsr, &div_scr);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700158 if (err)
159 return err;
160
161 cr0 = div_scr << SSPCR0_SCR_SHIFT;
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700162 cr0 |= (spi->mode & (SPI_CPHA | SPI_CPOL)) << SSPCR0_MODE_SHIFT;
H Hartley Sweetend9b65df2013-07-02 10:09:29 -0700163 cr0 |= dss;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000164
H Hartley Sweeten48738832017-08-09 08:51:29 +1200165 dev_dbg(&master->dev, "setup: mode %d, cpsr %d, scr %d, dss %d\n",
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700166 spi->mode, div_cpsr, div_scr, dss);
H Hartley Sweeten48738832017-08-09 08:51:29 +1200167 dev_dbg(&master->dev, "setup: cr0 %#x\n", cr0);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000168
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200169 writel(div_cpsr, espi->mmio + SSPCPSR);
170 writel(cr0, espi->mmio + SSPCR0);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700171
172 return 0;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000173}
174
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200175static void ep93xx_do_write(struct spi_master *master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000176{
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200177 struct ep93xx_spi *espi = spi_master_get_devdata(master);
178 struct spi_transfer *xfer = master->cur_msg->state;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200179 u32 val = 0;
180
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200181 if (xfer->bits_per_word > 8) {
182 if (xfer->tx_buf)
183 val = ((u16 *)xfer->tx_buf)[espi->tx];
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200184 espi->tx += 2;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000185 } else {
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200186 if (xfer->tx_buf)
187 val = ((u8 *)xfer->tx_buf)[espi->tx];
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200188 espi->tx += 1;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000189 }
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200190 writel(val, espi->mmio + SSPDR);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000191}
192
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200193static void ep93xx_do_read(struct spi_master *master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000194{
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200195 struct ep93xx_spi *espi = spi_master_get_devdata(master);
196 struct spi_transfer *xfer = master->cur_msg->state;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200197 u32 val;
198
199 val = readl(espi->mmio + SSPDR);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200200 if (xfer->bits_per_word > 8) {
201 if (xfer->rx_buf)
202 ((u16 *)xfer->rx_buf)[espi->rx] = val;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200203 espi->rx += 2;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000204 } else {
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200205 if (xfer->rx_buf)
206 ((u8 *)xfer->rx_buf)[espi->rx] = val;
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200207 espi->rx += 1;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000208 }
209}
210
211/**
212 * ep93xx_spi_read_write() - perform next RX/TX transfer
213 * @espi: ep93xx SPI controller struct
214 *
215 * This function transfers next bytes (or half-words) to/from RX/TX FIFOs. If
216 * called several times, the whole transfer will be completed. Returns
217 * %-EINPROGRESS when current transfer was not yet completed otherwise %0.
218 *
219 * When this function is finished, RX FIFO should be empty and TX FIFO should be
220 * full.
221 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200222static int ep93xx_spi_read_write(struct spi_master *master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000223{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200224 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200225 struct spi_transfer *xfer = master->cur_msg->state;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000226
227 /* read as long as RX FIFO has frames in it */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200228 while ((readl(espi->mmio + SSPSR) & SSPSR_RNE)) {
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200229 ep93xx_do_read(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000230 espi->fifo_level--;
231 }
232
233 /* write as long as TX FIFO has room */
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200234 while (espi->fifo_level < SPI_FIFO_SIZE && espi->tx < xfer->len) {
235 ep93xx_do_write(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000236 espi->fifo_level++;
237 }
238
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200239 if (espi->rx == xfer->len)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000240 return 0;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000241
242 return -EINPROGRESS;
243}
244
Nathan Chancellora1108c72018-10-08 11:08:47 -0700245static enum dma_transfer_direction
246ep93xx_dma_data_to_trans_dir(enum dma_data_direction dir)
247{
248 switch (dir) {
249 case DMA_TO_DEVICE:
250 return DMA_MEM_TO_DEV;
251 case DMA_FROM_DEVICE:
252 return DMA_DEV_TO_MEM;
253 default:
254 return DMA_TRANS_NONE;
255 }
256}
257
Mika Westerberg626a96d2011-05-29 13:10:06 +0300258/**
259 * ep93xx_spi_dma_prepare() - prepares a DMA transfer
H Hartley Sweeten48738832017-08-09 08:51:29 +1200260 * @master: SPI master
Mika Westerberg626a96d2011-05-29 13:10:06 +0300261 * @dir: DMA transfer direction
262 *
263 * Function configures the DMA, maps the buffer and prepares the DMA
264 * descriptor. Returns a valid DMA descriptor in case of success and ERR_PTR
265 * in case of failure.
266 */
267static struct dma_async_tx_descriptor *
H Hartley Sweeten48738832017-08-09 08:51:29 +1200268ep93xx_spi_dma_prepare(struct spi_master *master,
Nathan Chancellora1108c72018-10-08 11:08:47 -0700269 enum dma_data_direction dir)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300270{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200271 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200272 struct spi_transfer *xfer = master->cur_msg->state;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300273 struct dma_async_tx_descriptor *txd;
274 enum dma_slave_buswidth buswidth;
275 struct dma_slave_config conf;
276 struct scatterlist *sg;
277 struct sg_table *sgt;
278 struct dma_chan *chan;
279 const void *buf, *pbuf;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200280 size_t len = xfer->len;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300281 int i, ret, nents;
282
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200283 if (xfer->bits_per_word > 8)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300284 buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
285 else
286 buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE;
287
288 memset(&conf, 0, sizeof(conf));
Nathan Chancellora1108c72018-10-08 11:08:47 -0700289 conf.direction = ep93xx_dma_data_to_trans_dir(dir);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300290
Nathan Chancellora1108c72018-10-08 11:08:47 -0700291 if (dir == DMA_FROM_DEVICE) {
Mika Westerberg626a96d2011-05-29 13:10:06 +0300292 chan = espi->dma_rx;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200293 buf = xfer->rx_buf;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300294 sgt = &espi->rx_sgt;
295
296 conf.src_addr = espi->sspdr_phys;
297 conf.src_addr_width = buswidth;
298 } else {
299 chan = espi->dma_tx;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200300 buf = xfer->tx_buf;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300301 sgt = &espi->tx_sgt;
302
303 conf.dst_addr = espi->sspdr_phys;
304 conf.dst_addr_width = buswidth;
305 }
306
307 ret = dmaengine_slave_config(chan, &conf);
308 if (ret)
309 return ERR_PTR(ret);
310
311 /*
312 * We need to split the transfer into PAGE_SIZE'd chunks. This is
313 * because we are using @espi->zeropage to provide a zero RX buffer
314 * for the TX transfers and we have only allocated one page for that.
315 *
316 * For performance reasons we allocate a new sg_table only when
317 * needed. Otherwise we will re-use the current one. Eventually the
318 * last sg_table is released in ep93xx_spi_release_dma().
319 */
320
321 nents = DIV_ROUND_UP(len, PAGE_SIZE);
322 if (nents != sgt->nents) {
323 sg_free_table(sgt);
324
325 ret = sg_alloc_table(sgt, nents, GFP_KERNEL);
326 if (ret)
327 return ERR_PTR(ret);
328 }
329
330 pbuf = buf;
331 for_each_sg(sgt->sgl, sg, sgt->nents, i) {
332 size_t bytes = min_t(size_t, len, PAGE_SIZE);
333
334 if (buf) {
335 sg_set_page(sg, virt_to_page(pbuf), bytes,
336 offset_in_page(pbuf));
337 } else {
338 sg_set_page(sg, virt_to_page(espi->zeropage),
339 bytes, 0);
340 }
341
342 pbuf += bytes;
343 len -= bytes;
344 }
345
346 if (WARN_ON(len)) {
H Hartley Sweeten48738832017-08-09 08:51:29 +1200347 dev_warn(&master->dev, "len = %zu expected 0!\n", len);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300348 return ERR_PTR(-EINVAL);
349 }
350
351 nents = dma_map_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
352 if (!nents)
353 return ERR_PTR(-ENOMEM);
354
Nathan Chancellora1108c72018-10-08 11:08:47 -0700355 txd = dmaengine_prep_slave_sg(chan, sgt->sgl, nents, conf.direction,
356 DMA_CTRL_ACK);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300357 if (!txd) {
358 dma_unmap_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
359 return ERR_PTR(-ENOMEM);
360 }
361 return txd;
362}
363
364/**
365 * ep93xx_spi_dma_finish() - finishes with a DMA transfer
H Hartley Sweeten48738832017-08-09 08:51:29 +1200366 * @master: SPI master
Mika Westerberg626a96d2011-05-29 13:10:06 +0300367 * @dir: DMA transfer direction
368 *
369 * Function finishes with the DMA transfer. After this, the DMA buffer is
370 * unmapped.
371 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200372static void ep93xx_spi_dma_finish(struct spi_master *master,
Nathan Chancellora1108c72018-10-08 11:08:47 -0700373 enum dma_data_direction dir)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300374{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200375 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300376 struct dma_chan *chan;
377 struct sg_table *sgt;
378
Nathan Chancellora1108c72018-10-08 11:08:47 -0700379 if (dir == DMA_FROM_DEVICE) {
Mika Westerberg626a96d2011-05-29 13:10:06 +0300380 chan = espi->dma_rx;
381 sgt = &espi->rx_sgt;
382 } else {
383 chan = espi->dma_tx;
384 sgt = &espi->tx_sgt;
385 }
386
387 dma_unmap_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
388}
389
390static void ep93xx_spi_dma_callback(void *callback_param)
391{
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200392 struct spi_master *master = callback_param;
393
Nathan Chancellora1108c72018-10-08 11:08:47 -0700394 ep93xx_spi_dma_finish(master, DMA_TO_DEVICE);
395 ep93xx_spi_dma_finish(master, DMA_FROM_DEVICE);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200396
397 spi_finalize_current_transfer(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300398}
399
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200400static int ep93xx_spi_dma_transfer(struct spi_master *master)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300401{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200402 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300403 struct dma_async_tx_descriptor *rxd, *txd;
404
Nathan Chancellora1108c72018-10-08 11:08:47 -0700405 rxd = ep93xx_spi_dma_prepare(master, DMA_FROM_DEVICE);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300406 if (IS_ERR(rxd)) {
H Hartley Sweeten48738832017-08-09 08:51:29 +1200407 dev_err(&master->dev, "DMA RX failed: %ld\n", PTR_ERR(rxd));
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200408 return PTR_ERR(rxd);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300409 }
410
Nathan Chancellora1108c72018-10-08 11:08:47 -0700411 txd = ep93xx_spi_dma_prepare(master, DMA_TO_DEVICE);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300412 if (IS_ERR(txd)) {
Nathan Chancellora1108c72018-10-08 11:08:47 -0700413 ep93xx_spi_dma_finish(master, DMA_FROM_DEVICE);
H Hartley Sweeten48738832017-08-09 08:51:29 +1200414 dev_err(&master->dev, "DMA TX failed: %ld\n", PTR_ERR(txd));
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200415 return PTR_ERR(txd);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300416 }
417
418 /* We are ready when RX is done */
419 rxd->callback = ep93xx_spi_dma_callback;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200420 rxd->callback_param = master;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300421
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200422 /* Now submit both descriptors and start DMA */
Mika Westerberg626a96d2011-05-29 13:10:06 +0300423 dmaengine_submit(rxd);
424 dmaengine_submit(txd);
425
426 dma_async_issue_pending(espi->dma_rx);
427 dma_async_issue_pending(espi->dma_tx);
428
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200429 /* signal that we need to wait for completion */
430 return 1;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000431}
432
433static irqreturn_t ep93xx_spi_interrupt(int irq, void *dev_id)
434{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200435 struct spi_master *master = dev_id;
436 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200437 u32 val;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000438
439 /*
440 * If we got ROR (receive overrun) interrupt we know that something is
441 * wrong. Just abort the message.
442 */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200443 if (readl(espi->mmio + SSPIIR) & SSPIIR_RORIS) {
Mika Westerberg011f23a2010-05-06 04:47:04 +0000444 /* clear the overrun interrupt */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200445 writel(0, espi->mmio + SSPICR);
H Hartley Sweeten48738832017-08-09 08:51:29 +1200446 dev_warn(&master->dev,
Mika Westerberg011f23a2010-05-06 04:47:04 +0000447 "receive overrun, aborting the message\n");
H Hartley Sweetenc7a909c2017-08-09 08:51:30 +1200448 master->cur_msg->status = -EIO;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000449 } else {
450 /*
451 * Interrupt is either RX (RIS) or TX (TIS). For both cases we
452 * simply execute next data transfer.
453 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200454 if (ep93xx_spi_read_write(master)) {
Mika Westerberg011f23a2010-05-06 04:47:04 +0000455 /*
456 * In normal case, there still is some processing left
457 * for current transfer. Let's wait for the next
458 * interrupt then.
459 */
460 return IRQ_HANDLED;
461 }
462 }
463
464 /*
465 * Current transfer is finished, either with error or with success. In
466 * any case we disable interrupts and notify the worker to handle
467 * any post-processing of the message.
468 */
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200469 val = readl(espi->mmio + SSPCR1);
470 val &= ~(SSPCR1_RORIE | SSPCR1_TIE | SSPCR1_RIE);
471 writel(val, espi->mmio + SSPCR1);
472
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200473 spi_finalize_current_transfer(master);
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200474
Mika Westerberg011f23a2010-05-06 04:47:04 +0000475 return IRQ_HANDLED;
476}
477
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200478static int ep93xx_spi_transfer_one(struct spi_master *master,
479 struct spi_device *spi,
480 struct spi_transfer *xfer)
481{
482 struct ep93xx_spi *espi = spi_master_get_devdata(master);
483 u32 val;
484 int ret;
485
486 ret = ep93xx_spi_chip_setup(master, spi, xfer);
487 if (ret) {
488 dev_err(&master->dev, "failed to setup chip for transfer\n");
489 return ret;
490 }
491
492 master->cur_msg->state = xfer;
493 espi->rx = 0;
494 espi->tx = 0;
495
496 /*
497 * There is no point of setting up DMA for the transfers which will
498 * fit into the FIFO and can be transferred with a single interrupt.
499 * So in these cases we will be using PIO and don't bother for DMA.
500 */
501 if (espi->dma_rx && xfer->len > SPI_FIFO_SIZE)
502 return ep93xx_spi_dma_transfer(master);
503
504 /* Using PIO so prime the TX FIFO and enable interrupts */
505 ep93xx_spi_read_write(master);
506
507 val = readl(espi->mmio + SSPCR1);
508 val |= (SSPCR1_RORIE | SSPCR1_TIE | SSPCR1_RIE);
509 writel(val, espi->mmio + SSPCR1);
510
511 /* signal that we need to wait for completion */
512 return 1;
513}
514
515static int ep93xx_spi_prepare_message(struct spi_master *master,
516 struct spi_message *msg)
517{
518 struct ep93xx_spi *espi = spi_master_get_devdata(master);
519 unsigned long timeout;
520
521 /*
522 * Just to be sure: flush any data from RX FIFO.
523 */
524 timeout = jiffies + msecs_to_jiffies(SPI_TIMEOUT);
525 while (readl(espi->mmio + SSPSR) & SSPSR_RNE) {
526 if (time_after(jiffies, timeout)) {
527 dev_warn(&master->dev,
528 "timeout while flushing RX FIFO\n");
529 return -ETIMEDOUT;
530 }
531 readl(espi->mmio + SSPDR);
532 }
533
534 /*
535 * We explicitly handle FIFO level. This way we don't have to check TX
536 * FIFO status using %SSPSR_TNF bit which may cause RX FIFO overruns.
537 */
538 espi->fifo_level = 0;
539
540 return 0;
541}
542
H Hartley Sweeten16779622017-08-09 08:51:27 +1200543static int ep93xx_spi_prepare_hardware(struct spi_master *master)
544{
545 struct ep93xx_spi *espi = spi_master_get_devdata(master);
546 u32 val;
547 int ret;
548
549 ret = clk_enable(espi->clk);
550 if (ret)
551 return ret;
552
553 val = readl(espi->mmio + SSPCR1);
554 val |= SSPCR1_SSE;
555 writel(val, espi->mmio + SSPCR1);
556
557 return 0;
558}
559
560static int ep93xx_spi_unprepare_hardware(struct spi_master *master)
561{
562 struct ep93xx_spi *espi = spi_master_get_devdata(master);
563 u32 val;
564
565 val = readl(espi->mmio + SSPCR1);
566 val &= ~SSPCR1_SSE;
567 writel(val, espi->mmio + SSPCR1);
568
569 clk_disable(espi->clk);
570
571 return 0;
572}
573
Mika Westerberg626a96d2011-05-29 13:10:06 +0300574static bool ep93xx_spi_dma_filter(struct dma_chan *chan, void *filter_param)
575{
576 if (ep93xx_dma_chan_is_m2p(chan))
577 return false;
578
579 chan->private = filter_param;
580 return true;
581}
582
583static int ep93xx_spi_setup_dma(struct ep93xx_spi *espi)
584{
585 dma_cap_mask_t mask;
586 int ret;
587
588 espi->zeropage = (void *)get_zeroed_page(GFP_KERNEL);
589 if (!espi->zeropage)
590 return -ENOMEM;
591
592 dma_cap_zero(mask);
593 dma_cap_set(DMA_SLAVE, mask);
594
595 espi->dma_rx_data.port = EP93XX_DMA_SSP;
Vinod Koula485df42011-10-14 10:47:38 +0530596 espi->dma_rx_data.direction = DMA_DEV_TO_MEM;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300597 espi->dma_rx_data.name = "ep93xx-spi-rx";
598
599 espi->dma_rx = dma_request_channel(mask, ep93xx_spi_dma_filter,
600 &espi->dma_rx_data);
601 if (!espi->dma_rx) {
602 ret = -ENODEV;
603 goto fail_free_page;
604 }
605
606 espi->dma_tx_data.port = EP93XX_DMA_SSP;
Vinod Koula485df42011-10-14 10:47:38 +0530607 espi->dma_tx_data.direction = DMA_MEM_TO_DEV;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300608 espi->dma_tx_data.name = "ep93xx-spi-tx";
609
610 espi->dma_tx = dma_request_channel(mask, ep93xx_spi_dma_filter,
611 &espi->dma_tx_data);
612 if (!espi->dma_tx) {
613 ret = -ENODEV;
614 goto fail_release_rx;
615 }
616
617 return 0;
618
619fail_release_rx:
620 dma_release_channel(espi->dma_rx);
621 espi->dma_rx = NULL;
622fail_free_page:
623 free_page((unsigned long)espi->zeropage);
624
625 return ret;
626}
627
628static void ep93xx_spi_release_dma(struct ep93xx_spi *espi)
629{
630 if (espi->dma_rx) {
631 dma_release_channel(espi->dma_rx);
632 sg_free_table(&espi->rx_sgt);
633 }
634 if (espi->dma_tx) {
635 dma_release_channel(espi->dma_tx);
636 sg_free_table(&espi->tx_sgt);
637 }
638
639 if (espi->zeropage)
640 free_page((unsigned long)espi->zeropage);
641}
642
Grant Likelyfd4a3192012-12-07 16:57:14 +0000643static int ep93xx_spi_probe(struct platform_device *pdev)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000644{
645 struct spi_master *master;
646 struct ep93xx_spi_info *info;
647 struct ep93xx_spi *espi;
648 struct resource *res;
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300649 int irq;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000650 int error;
651
Jingoo Han8074cf02013-07-30 16:58:59 +0900652 info = dev_get_platdata(&pdev->dev);
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700653 if (!info) {
654 dev_err(&pdev->dev, "missing platform data\n");
655 return -EINVAL;
656 }
Mika Westerberg011f23a2010-05-06 04:47:04 +0000657
H Hartley Sweeten48a77762013-07-02 10:07:53 -0700658 irq = platform_get_irq(pdev, 0);
659 if (irq < 0) {
660 dev_err(&pdev->dev, "failed to get irq resources\n");
661 return -EBUSY;
662 }
663
664 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
665 if (!res) {
666 dev_err(&pdev->dev, "unable to get iomem resource\n");
667 return -ENODEV;
668 }
669
Mika Westerberg011f23a2010-05-06 04:47:04 +0000670 master = spi_alloc_master(&pdev->dev, sizeof(*espi));
H Hartley Sweetenb2d185e2013-07-02 10:08:59 -0700671 if (!master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000672 return -ENOMEM;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000673
Linus Walleij1dfbf332019-04-20 13:05:59 +0200674 master->use_gpio_descriptors = true;
H Hartley Sweeten16779622017-08-09 08:51:27 +1200675 master->prepare_transfer_hardware = ep93xx_spi_prepare_hardware;
676 master->unprepare_transfer_hardware = ep93xx_spi_unprepare_hardware;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200677 master->prepare_message = ep93xx_spi_prepare_message;
678 master->transfer_one = ep93xx_spi_transfer_one;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000679 master->bus_num = pdev->id;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000680 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
Stephen Warren24778be2013-05-21 20:36:35 -0600681 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16);
Linus Walleij1dfbf332019-04-20 13:05:59 +0200682 /*
683 * The SPI core will count the number of GPIO descriptors to figure
684 * out the number of chip selects available on the platform.
685 */
686 master->num_chipselect = 0;
H Hartley Sweeten55f0cd32017-02-16 13:07:37 -0700687
Mika Westerberg011f23a2010-05-06 04:47:04 +0000688 platform_set_drvdata(pdev, master);
689
690 espi = spi_master_get_devdata(master);
691
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700692 espi->clk = devm_clk_get(&pdev->dev, NULL);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000693 if (IS_ERR(espi->clk)) {
694 dev_err(&pdev->dev, "unable to get spi clock\n");
695 error = PTR_ERR(espi->clk);
696 goto fail_release_master;
697 }
698
Mika Westerberg011f23a2010-05-06 04:47:04 +0000699 /*
700 * Calculate maximum and minimum supported clock rates
701 * for the controller.
702 */
Axel Lin56fc0b42014-02-08 23:52:26 +0800703 master->max_speed_hz = clk_get_rate(espi->clk) / 2;
704 master->min_speed_hz = clk_get_rate(espi->clk) / (254 * 256);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000705
Mika Westerberg626a96d2011-05-29 13:10:06 +0300706 espi->sspdr_phys = res->start + SSPDR;
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300707
H Hartley Sweeten12329782017-08-09 08:51:25 +1200708 espi->mmio = devm_ioremap_resource(&pdev->dev, res);
709 if (IS_ERR(espi->mmio)) {
710 error = PTR_ERR(espi->mmio);
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700711 goto fail_release_master;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000712 }
713
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300714 error = devm_request_irq(&pdev->dev, irq, ep93xx_spi_interrupt,
H Hartley Sweeten48738832017-08-09 08:51:29 +1200715 0, "ep93xx-spi", master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000716 if (error) {
717 dev_err(&pdev->dev, "failed to request irq\n");
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700718 goto fail_release_master;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000719 }
720
Mika Westerberg626a96d2011-05-29 13:10:06 +0300721 if (info->use_dma && ep93xx_spi_setup_dma(espi))
722 dev_warn(&pdev->dev, "DMA setup failed. Falling back to PIO\n");
723
Mika Westerberg011f23a2010-05-06 04:47:04 +0000724 /* make sure that the hardware is disabled */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200725 writel(0, espi->mmio + SSPCR1);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000726
Jingoo Han434eaf32013-09-24 13:30:41 +0900727 error = devm_spi_register_master(&pdev->dev, master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000728 if (error) {
729 dev_err(&pdev->dev, "failed to register SPI master\n");
H Hartley Sweeten84ddb3c2013-07-08 09:12:37 -0700730 goto fail_free_dma;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000731 }
732
733 dev_info(&pdev->dev, "EP93xx SPI Controller at 0x%08lx irq %d\n",
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300734 (unsigned long)res->start, irq);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000735
736 return 0;
737
Mika Westerberg626a96d2011-05-29 13:10:06 +0300738fail_free_dma:
739 ep93xx_spi_release_dma(espi);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000740fail_release_master:
741 spi_master_put(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000742
743 return error;
744}
745
Grant Likelyfd4a3192012-12-07 16:57:14 +0000746static int ep93xx_spi_remove(struct platform_device *pdev)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000747{
748 struct spi_master *master = platform_get_drvdata(pdev);
749 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000750
Mika Westerberg626a96d2011-05-29 13:10:06 +0300751 ep93xx_spi_release_dma(espi);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000752
Mika Westerberg011f23a2010-05-06 04:47:04 +0000753 return 0;
754}
755
756static struct platform_driver ep93xx_spi_driver = {
757 .driver = {
758 .name = "ep93xx-spi",
Mika Westerberg011f23a2010-05-06 04:47:04 +0000759 },
Grant Likely940ab882011-10-05 11:29:49 -0600760 .probe = ep93xx_spi_probe,
Grant Likelyfd4a3192012-12-07 16:57:14 +0000761 .remove = ep93xx_spi_remove,
Mika Westerberg011f23a2010-05-06 04:47:04 +0000762};
Grant Likely940ab882011-10-05 11:29:49 -0600763module_platform_driver(ep93xx_spi_driver);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000764
765MODULE_DESCRIPTION("EP93xx SPI Controller driver");
766MODULE_AUTHOR("Mika Westerberg <mika.westerberg@iki.fi>");
767MODULE_LICENSE("GPL");
768MODULE_ALIAS("platform:ep93xx-spi");