blob: 5896a7b2fade0ca204ec2d6ddc912176ef4fd007 [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:
Alexander A. Klimov3ea4eac2020-07-08 21:44:00 +020013 * https://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
Jungseung Lee61249ce2020-04-02 21:10:22 +090034#define SSPCR0_SPO BIT(6)
35#define SSPCR0_SPH BIT(7)
Mika Westerberg011f23a2010-05-06 04:47:04 +000036#define SSPCR0_SCR_SHIFT 8
37
38#define SSPCR1 0x0004
39#define SSPCR1_RIE BIT(0)
40#define SSPCR1_TIE BIT(1)
41#define SSPCR1_RORIE BIT(2)
42#define SSPCR1_LBM BIT(3)
43#define SSPCR1_SSE BIT(4)
44#define SSPCR1_MS BIT(5)
45#define SSPCR1_SOD BIT(6)
46
47#define SSPDR 0x0008
48
49#define SSPSR 0x000c
50#define SSPSR_TFE BIT(0)
51#define SSPSR_TNF BIT(1)
52#define SSPSR_RNE BIT(2)
53#define SSPSR_RFF BIT(3)
54#define SSPSR_BSY BIT(4)
55#define SSPCPSR 0x0010
56
57#define SSPIIR 0x0014
58#define SSPIIR_RIS BIT(0)
59#define SSPIIR_TIS BIT(1)
60#define SSPIIR_RORIS BIT(2)
61#define SSPICR SSPIIR
62
63/* timeout in milliseconds */
64#define SPI_TIMEOUT 5
65/* maximum depth of RX/TX FIFO */
66#define SPI_FIFO_SIZE 8
67
68/**
69 * struct ep93xx_spi - EP93xx SPI controller structure
Mika Westerberg011f23a2010-05-06 04:47:04 +000070 * @clk: clock for the controller
H Hartley Sweeten12329782017-08-09 08:51:25 +120071 * @mmio: pointer to ioremap()'d registers
Mika Westerberg626a96d2011-05-29 13:10:06 +030072 * @sspdr_phys: physical address of the SSPDR register
Mika Westerberg011f23a2010-05-06 04:47:04 +000073 * @tx: current byte in transfer to transmit
74 * @rx: current byte in transfer to receive
75 * @fifo_level: how full is FIFO (%0..%SPI_FIFO_SIZE - %1). Receiving one
76 * frame decreases this level and sending one frame increases it.
Mika Westerberg626a96d2011-05-29 13:10:06 +030077 * @dma_rx: RX DMA channel
78 * @dma_tx: TX DMA channel
79 * @dma_rx_data: RX parameters passed to the DMA engine
80 * @dma_tx_data: TX parameters passed to the DMA engine
81 * @rx_sgt: sg table for RX transfers
82 * @tx_sgt: sg table for TX transfers
83 * @zeropage: dummy page used as RX buffer when only TX buffer is passed in by
84 * the client
Mika Westerberg011f23a2010-05-06 04:47:04 +000085 */
86struct ep93xx_spi {
Mika Westerberg011f23a2010-05-06 04:47:04 +000087 struct clk *clk;
H Hartley Sweeten12329782017-08-09 08:51:25 +120088 void __iomem *mmio;
Mika Westerberg626a96d2011-05-29 13:10:06 +030089 unsigned long sspdr_phys;
Mika Westerberg011f23a2010-05-06 04:47:04 +000090 size_t tx;
91 size_t rx;
92 size_t fifo_level;
Mika Westerberg626a96d2011-05-29 13:10:06 +030093 struct dma_chan *dma_rx;
94 struct dma_chan *dma_tx;
95 struct ep93xx_dma_data dma_rx_data;
96 struct ep93xx_dma_data dma_tx_data;
97 struct sg_table rx_sgt;
98 struct sg_table tx_sgt;
99 void *zeropage;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000100};
101
Mika Westerberg011f23a2010-05-06 04:47:04 +0000102/* converts bits per word to CR0.DSS value */
103#define bits_per_word_to_dss(bpw) ((bpw) - 1)
104
Mika Westerberg011f23a2010-05-06 04:47:04 +0000105/**
106 * ep93xx_spi_calc_divisors() - calculates SPI clock divisors
H Hartley Sweeten48738832017-08-09 08:51:29 +1200107 * @master: SPI master
Mika Westerberg011f23a2010-05-06 04:47:04 +0000108 * @rate: desired SPI output clock rate
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700109 * @div_cpsr: pointer to return the cpsr (pre-scaler) divider
110 * @div_scr: pointer to return the scr divider
Mika Westerberg011f23a2010-05-06 04:47:04 +0000111 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200112static int ep93xx_spi_calc_divisors(struct spi_master *master,
Axel Lin56fc0b42014-02-08 23:52:26 +0800113 u32 rate, u8 *div_cpsr, u8 *div_scr)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000114{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200115 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000116 unsigned long spi_clk_rate = clk_get_rate(espi->clk);
117 int cpsr, scr;
118
119 /*
120 * Make sure that max value is between values supported by the
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200121 * controller.
Mika Westerberg011f23a2010-05-06 04:47:04 +0000122 */
Axel Lin56fc0b42014-02-08 23:52:26 +0800123 rate = clamp(rate, master->min_speed_hz, master->max_speed_hz);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000124
125 /*
126 * Calculate divisors so that we can get speed according the
127 * following formula:
128 * rate = spi_clock_rate / (cpsr * (1 + scr))
129 *
130 * cpsr must be even number and starts from 2, scr can be any number
131 * between 0 and 255.
132 */
133 for (cpsr = 2; cpsr <= 254; cpsr += 2) {
134 for (scr = 0; scr <= 255; scr++) {
135 if ((spi_clk_rate / (cpsr * (scr + 1))) <= rate) {
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700136 *div_scr = (u8)scr;
137 *div_cpsr = (u8)cpsr;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000138 return 0;
139 }
140 }
141 }
142
143 return -EINVAL;
144}
145
H Hartley Sweeten48738832017-08-09 08:51:29 +1200146static int ep93xx_spi_chip_setup(struct spi_master *master,
H Hartley Sweeten55f0cd3f2017-02-16 13:07:37 -0700147 struct spi_device *spi,
148 struct spi_transfer *xfer)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000149{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200150 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweeten55f0cd3f2017-02-16 13:07:37 -0700151 u8 dss = bits_per_word_to_dss(xfer->bits_per_word);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700152 u8 div_cpsr = 0;
153 u8 div_scr = 0;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000154 u16 cr0;
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700155 int err;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000156
H Hartley Sweeten48738832017-08-09 08:51:29 +1200157 err = ep93xx_spi_calc_divisors(master, xfer->speed_hz,
H Hartley Sweeten55f0cd3f2017-02-16 13:07:37 -0700158 &div_cpsr, &div_scr);
H Hartley Sweetenf7ef1da2013-07-02 10:10:29 -0700159 if (err)
160 return err;
161
162 cr0 = div_scr << SSPCR0_SCR_SHIFT;
Jungseung Lee61249ce2020-04-02 21:10:22 +0900163 if (spi->mode & SPI_CPOL)
164 cr0 |= SSPCR0_SPO;
165 if (spi->mode & SPI_CPHA)
166 cr0 |= SSPCR0_SPH;
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 Sweeten55f0cd3f2017-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
Lee Jonesdfa51f62020-07-17 14:54:14 +0100217 * @master: SPI master
Mika Westerberg011f23a2010-05-06 04:47:04 +0000218 *
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
Nathan Chancellora1108c72018-10-08 11:08:47 -0700249static enum dma_transfer_direction
250ep93xx_dma_data_to_trans_dir(enum dma_data_direction dir)
251{
252 switch (dir) {
253 case DMA_TO_DEVICE:
254 return DMA_MEM_TO_DEV;
255 case DMA_FROM_DEVICE:
256 return DMA_DEV_TO_MEM;
257 default:
258 return DMA_TRANS_NONE;
259 }
260}
261
Mika Westerberg626a96d2011-05-29 13:10:06 +0300262/**
263 * ep93xx_spi_dma_prepare() - prepares a DMA transfer
H Hartley Sweeten48738832017-08-09 08:51:29 +1200264 * @master: SPI master
Mika Westerberg626a96d2011-05-29 13:10:06 +0300265 * @dir: DMA transfer direction
266 *
267 * Function configures the DMA, maps the buffer and prepares the DMA
268 * descriptor. Returns a valid DMA descriptor in case of success and ERR_PTR
269 * in case of failure.
270 */
271static struct dma_async_tx_descriptor *
H Hartley Sweeten48738832017-08-09 08:51:29 +1200272ep93xx_spi_dma_prepare(struct spi_master *master,
Nathan Chancellora1108c72018-10-08 11:08:47 -0700273 enum dma_data_direction dir)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300274{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200275 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200276 struct spi_transfer *xfer = master->cur_msg->state;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300277 struct dma_async_tx_descriptor *txd;
278 enum dma_slave_buswidth buswidth;
279 struct dma_slave_config conf;
280 struct scatterlist *sg;
281 struct sg_table *sgt;
282 struct dma_chan *chan;
283 const void *buf, *pbuf;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200284 size_t len = xfer->len;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300285 int i, ret, nents;
286
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200287 if (xfer->bits_per_word > 8)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300288 buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES;
289 else
290 buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE;
291
292 memset(&conf, 0, sizeof(conf));
Nathan Chancellora1108c72018-10-08 11:08:47 -0700293 conf.direction = ep93xx_dma_data_to_trans_dir(dir);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300294
Nathan Chancellora1108c72018-10-08 11:08:47 -0700295 if (dir == DMA_FROM_DEVICE) {
Mika Westerberg626a96d2011-05-29 13:10:06 +0300296 chan = espi->dma_rx;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200297 buf = xfer->rx_buf;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300298 sgt = &espi->rx_sgt;
299
300 conf.src_addr = espi->sspdr_phys;
301 conf.src_addr_width = buswidth;
302 } else {
303 chan = espi->dma_tx;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200304 buf = xfer->tx_buf;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300305 sgt = &espi->tx_sgt;
306
307 conf.dst_addr = espi->sspdr_phys;
308 conf.dst_addr_width = buswidth;
309 }
310
311 ret = dmaengine_slave_config(chan, &conf);
312 if (ret)
313 return ERR_PTR(ret);
314
315 /*
316 * We need to split the transfer into PAGE_SIZE'd chunks. This is
317 * because we are using @espi->zeropage to provide a zero RX buffer
318 * for the TX transfers and we have only allocated one page for that.
319 *
320 * For performance reasons we allocate a new sg_table only when
321 * needed. Otherwise we will re-use the current one. Eventually the
322 * last sg_table is released in ep93xx_spi_release_dma().
323 */
324
325 nents = DIV_ROUND_UP(len, PAGE_SIZE);
326 if (nents != sgt->nents) {
327 sg_free_table(sgt);
328
329 ret = sg_alloc_table(sgt, nents, GFP_KERNEL);
330 if (ret)
331 return ERR_PTR(ret);
332 }
333
334 pbuf = buf;
335 for_each_sg(sgt->sgl, sg, sgt->nents, i) {
336 size_t bytes = min_t(size_t, len, PAGE_SIZE);
337
338 if (buf) {
339 sg_set_page(sg, virt_to_page(pbuf), bytes,
340 offset_in_page(pbuf));
341 } else {
342 sg_set_page(sg, virt_to_page(espi->zeropage),
343 bytes, 0);
344 }
345
346 pbuf += bytes;
347 len -= bytes;
348 }
349
350 if (WARN_ON(len)) {
H Hartley Sweeten48738832017-08-09 08:51:29 +1200351 dev_warn(&master->dev, "len = %zu expected 0!\n", len);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300352 return ERR_PTR(-EINVAL);
353 }
354
355 nents = dma_map_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
356 if (!nents)
357 return ERR_PTR(-ENOMEM);
358
Nathan Chancellora1108c72018-10-08 11:08:47 -0700359 txd = dmaengine_prep_slave_sg(chan, sgt->sgl, nents, conf.direction,
360 DMA_CTRL_ACK);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300361 if (!txd) {
362 dma_unmap_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
363 return ERR_PTR(-ENOMEM);
364 }
365 return txd;
366}
367
368/**
369 * ep93xx_spi_dma_finish() - finishes with a DMA transfer
H Hartley Sweeten48738832017-08-09 08:51:29 +1200370 * @master: SPI master
Mika Westerberg626a96d2011-05-29 13:10:06 +0300371 * @dir: DMA transfer direction
372 *
373 * Function finishes with the DMA transfer. After this, the DMA buffer is
374 * unmapped.
375 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200376static void ep93xx_spi_dma_finish(struct spi_master *master,
Nathan Chancellora1108c72018-10-08 11:08:47 -0700377 enum dma_data_direction dir)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300378{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200379 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300380 struct dma_chan *chan;
381 struct sg_table *sgt;
382
Nathan Chancellora1108c72018-10-08 11:08:47 -0700383 if (dir == DMA_FROM_DEVICE) {
Mika Westerberg626a96d2011-05-29 13:10:06 +0300384 chan = espi->dma_rx;
385 sgt = &espi->rx_sgt;
386 } else {
387 chan = espi->dma_tx;
388 sgt = &espi->tx_sgt;
389 }
390
391 dma_unmap_sg(chan->device->dev, sgt->sgl, sgt->nents, dir);
392}
393
394static void ep93xx_spi_dma_callback(void *callback_param)
395{
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200396 struct spi_master *master = callback_param;
397
Nathan Chancellora1108c72018-10-08 11:08:47 -0700398 ep93xx_spi_dma_finish(master, DMA_TO_DEVICE);
399 ep93xx_spi_dma_finish(master, DMA_FROM_DEVICE);
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200400
401 spi_finalize_current_transfer(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300402}
403
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200404static int ep93xx_spi_dma_transfer(struct spi_master *master)
Mika Westerberg626a96d2011-05-29 13:10:06 +0300405{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200406 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300407 struct dma_async_tx_descriptor *rxd, *txd;
408
Nathan Chancellora1108c72018-10-08 11:08:47 -0700409 rxd = ep93xx_spi_dma_prepare(master, DMA_FROM_DEVICE);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300410 if (IS_ERR(rxd)) {
H Hartley Sweeten48738832017-08-09 08:51:29 +1200411 dev_err(&master->dev, "DMA RX failed: %ld\n", PTR_ERR(rxd));
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200412 return PTR_ERR(rxd);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300413 }
414
Nathan Chancellora1108c72018-10-08 11:08:47 -0700415 txd = ep93xx_spi_dma_prepare(master, DMA_TO_DEVICE);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300416 if (IS_ERR(txd)) {
Nathan Chancellora1108c72018-10-08 11:08:47 -0700417 ep93xx_spi_dma_finish(master, DMA_FROM_DEVICE);
H Hartley Sweeten48738832017-08-09 08:51:29 +1200418 dev_err(&master->dev, "DMA TX failed: %ld\n", PTR_ERR(txd));
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200419 return PTR_ERR(txd);
Mika Westerberg626a96d2011-05-29 13:10:06 +0300420 }
421
422 /* We are ready when RX is done */
423 rxd->callback = ep93xx_spi_dma_callback;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200424 rxd->callback_param = master;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300425
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200426 /* Now submit both descriptors and start DMA */
Mika Westerberg626a96d2011-05-29 13:10:06 +0300427 dmaengine_submit(rxd);
428 dmaengine_submit(txd);
429
430 dma_async_issue_pending(espi->dma_rx);
431 dma_async_issue_pending(espi->dma_tx);
432
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200433 /* signal that we need to wait for completion */
434 return 1;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000435}
436
437static irqreturn_t ep93xx_spi_interrupt(int irq, void *dev_id)
438{
H Hartley Sweeten48738832017-08-09 08:51:29 +1200439 struct spi_master *master = dev_id;
440 struct ep93xx_spi *espi = spi_master_get_devdata(master);
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200441 u32 val;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000442
443 /*
444 * If we got ROR (receive overrun) interrupt we know that something is
445 * wrong. Just abort the message.
446 */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200447 if (readl(espi->mmio + SSPIIR) & SSPIIR_RORIS) {
Mika Westerberg011f23a2010-05-06 04:47:04 +0000448 /* clear the overrun interrupt */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200449 writel(0, espi->mmio + SSPICR);
H Hartley Sweeten48738832017-08-09 08:51:29 +1200450 dev_warn(&master->dev,
Mika Westerberg011f23a2010-05-06 04:47:04 +0000451 "receive overrun, aborting the message\n");
H Hartley Sweetenc7a909c2017-08-09 08:51:30 +1200452 master->cur_msg->status = -EIO;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000453 } else {
454 /*
455 * Interrupt is either RX (RIS) or TX (TIS). For both cases we
456 * simply execute next data transfer.
457 */
H Hartley Sweeten48738832017-08-09 08:51:29 +1200458 if (ep93xx_spi_read_write(master)) {
Mika Westerberg011f23a2010-05-06 04:47:04 +0000459 /*
460 * In normal case, there still is some processing left
461 * for current transfer. Let's wait for the next
462 * interrupt then.
463 */
464 return IRQ_HANDLED;
465 }
466 }
467
468 /*
469 * Current transfer is finished, either with error or with success. In
470 * any case we disable interrupts and notify the worker to handle
471 * any post-processing of the message.
472 */
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200473 val = readl(espi->mmio + SSPCR1);
474 val &= ~(SSPCR1_RORIE | SSPCR1_TIE | SSPCR1_RIE);
475 writel(val, espi->mmio + SSPCR1);
476
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200477 spi_finalize_current_transfer(master);
H Hartley Sweetenac8d06d2017-08-09 08:51:28 +1200478
Mika Westerberg011f23a2010-05-06 04:47:04 +0000479 return IRQ_HANDLED;
480}
481
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200482static int ep93xx_spi_transfer_one(struct spi_master *master,
483 struct spi_device *spi,
484 struct spi_transfer *xfer)
485{
486 struct ep93xx_spi *espi = spi_master_get_devdata(master);
487 u32 val;
488 int ret;
489
490 ret = ep93xx_spi_chip_setup(master, spi, xfer);
491 if (ret) {
492 dev_err(&master->dev, "failed to setup chip for transfer\n");
493 return ret;
494 }
495
496 master->cur_msg->state = xfer;
497 espi->rx = 0;
498 espi->tx = 0;
499
500 /*
501 * There is no point of setting up DMA for the transfers which will
502 * fit into the FIFO and can be transferred with a single interrupt.
503 * So in these cases we will be using PIO and don't bother for DMA.
504 */
505 if (espi->dma_rx && xfer->len > SPI_FIFO_SIZE)
506 return ep93xx_spi_dma_transfer(master);
507
508 /* Using PIO so prime the TX FIFO and enable interrupts */
509 ep93xx_spi_read_write(master);
510
511 val = readl(espi->mmio + SSPCR1);
512 val |= (SSPCR1_RORIE | SSPCR1_TIE | SSPCR1_RIE);
513 writel(val, espi->mmio + SSPCR1);
514
515 /* signal that we need to wait for completion */
516 return 1;
517}
518
519static int ep93xx_spi_prepare_message(struct spi_master *master,
520 struct spi_message *msg)
521{
522 struct ep93xx_spi *espi = spi_master_get_devdata(master);
523 unsigned long timeout;
524
525 /*
526 * Just to be sure: flush any data from RX FIFO.
527 */
528 timeout = jiffies + msecs_to_jiffies(SPI_TIMEOUT);
529 while (readl(espi->mmio + SSPSR) & SSPSR_RNE) {
530 if (time_after(jiffies, timeout)) {
531 dev_warn(&master->dev,
532 "timeout while flushing RX FIFO\n");
533 return -ETIMEDOUT;
534 }
535 readl(espi->mmio + SSPDR);
536 }
537
538 /*
539 * We explicitly handle FIFO level. This way we don't have to check TX
540 * FIFO status using %SSPSR_TNF bit which may cause RX FIFO overruns.
541 */
542 espi->fifo_level = 0;
543
544 return 0;
545}
546
H Hartley Sweeten16779622017-08-09 08:51:27 +1200547static int ep93xx_spi_prepare_hardware(struct spi_master *master)
548{
549 struct ep93xx_spi *espi = spi_master_get_devdata(master);
550 u32 val;
551 int ret;
552
Alexander Sverdlin7c72dc52021-07-26 16:59:50 +0300553 ret = clk_prepare_enable(espi->clk);
H Hartley Sweeten16779622017-08-09 08:51:27 +1200554 if (ret)
555 return ret;
556
557 val = readl(espi->mmio + SSPCR1);
558 val |= SSPCR1_SSE;
559 writel(val, espi->mmio + SSPCR1);
560
561 return 0;
562}
563
564static int ep93xx_spi_unprepare_hardware(struct spi_master *master)
565{
566 struct ep93xx_spi *espi = spi_master_get_devdata(master);
567 u32 val;
568
569 val = readl(espi->mmio + SSPCR1);
570 val &= ~SSPCR1_SSE;
571 writel(val, espi->mmio + SSPCR1);
572
Alexander Sverdlin7c72dc52021-07-26 16:59:50 +0300573 clk_disable_unprepare(espi->clk);
H Hartley Sweeten16779622017-08-09 08:51:27 +1200574
575 return 0;
576}
577
Mika Westerberg626a96d2011-05-29 13:10:06 +0300578static bool ep93xx_spi_dma_filter(struct dma_chan *chan, void *filter_param)
579{
580 if (ep93xx_dma_chan_is_m2p(chan))
581 return false;
582
583 chan->private = filter_param;
584 return true;
585}
586
587static int ep93xx_spi_setup_dma(struct ep93xx_spi *espi)
588{
589 dma_cap_mask_t mask;
590 int ret;
591
592 espi->zeropage = (void *)get_zeroed_page(GFP_KERNEL);
593 if (!espi->zeropage)
594 return -ENOMEM;
595
596 dma_cap_zero(mask);
597 dma_cap_set(DMA_SLAVE, mask);
598
599 espi->dma_rx_data.port = EP93XX_DMA_SSP;
Vinod Koula485df42011-10-14 10:47:38 +0530600 espi->dma_rx_data.direction = DMA_DEV_TO_MEM;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300601 espi->dma_rx_data.name = "ep93xx-spi-rx";
602
603 espi->dma_rx = dma_request_channel(mask, ep93xx_spi_dma_filter,
604 &espi->dma_rx_data);
605 if (!espi->dma_rx) {
606 ret = -ENODEV;
607 goto fail_free_page;
608 }
609
610 espi->dma_tx_data.port = EP93XX_DMA_SSP;
Vinod Koula485df42011-10-14 10:47:38 +0530611 espi->dma_tx_data.direction = DMA_MEM_TO_DEV;
Mika Westerberg626a96d2011-05-29 13:10:06 +0300612 espi->dma_tx_data.name = "ep93xx-spi-tx";
613
614 espi->dma_tx = dma_request_channel(mask, ep93xx_spi_dma_filter,
615 &espi->dma_tx_data);
616 if (!espi->dma_tx) {
617 ret = -ENODEV;
618 goto fail_release_rx;
619 }
620
621 return 0;
622
623fail_release_rx:
624 dma_release_channel(espi->dma_rx);
625 espi->dma_rx = NULL;
626fail_free_page:
627 free_page((unsigned long)espi->zeropage);
628
629 return ret;
630}
631
632static void ep93xx_spi_release_dma(struct ep93xx_spi *espi)
633{
634 if (espi->dma_rx) {
635 dma_release_channel(espi->dma_rx);
636 sg_free_table(&espi->rx_sgt);
637 }
638 if (espi->dma_tx) {
639 dma_release_channel(espi->dma_tx);
640 sg_free_table(&espi->tx_sgt);
641 }
642
643 if (espi->zeropage)
644 free_page((unsigned long)espi->zeropage);
645}
646
Grant Likelyfd4a3192012-12-07 16:57:14 +0000647static int ep93xx_spi_probe(struct platform_device *pdev)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000648{
649 struct spi_master *master;
650 struct ep93xx_spi_info *info;
651 struct ep93xx_spi *espi;
652 struct resource *res;
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300653 int irq;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000654 int error;
655
Jingoo Han8074cf02013-07-30 16:58:59 +0900656 info = dev_get_platdata(&pdev->dev);
H Hartley Sweeten55f0cd3f2017-02-16 13:07:37 -0700657 if (!info) {
658 dev_err(&pdev->dev, "missing platform data\n");
659 return -EINVAL;
660 }
Mika Westerberg011f23a2010-05-06 04:47:04 +0000661
H Hartley Sweeten48a77762013-07-02 10:07:53 -0700662 irq = platform_get_irq(pdev, 0);
Stephen Boyd6b8ac102019-07-30 11:15:41 -0700663 if (irq < 0)
H Hartley Sweeten48a77762013-07-02 10:07:53 -0700664 return -EBUSY;
H Hartley Sweeten48a77762013-07-02 10:07:53 -0700665
666 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
667 if (!res) {
668 dev_err(&pdev->dev, "unable to get iomem resource\n");
669 return -ENODEV;
670 }
671
Mika Westerberg011f23a2010-05-06 04:47:04 +0000672 master = spi_alloc_master(&pdev->dev, sizeof(*espi));
H Hartley Sweetenb2d185e2013-07-02 10:08:59 -0700673 if (!master)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000674 return -ENOMEM;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000675
Linus Walleij1dfbf332019-04-20 13:05:59 +0200676 master->use_gpio_descriptors = true;
H Hartley Sweeten16779622017-08-09 08:51:27 +1200677 master->prepare_transfer_hardware = ep93xx_spi_prepare_hardware;
678 master->unprepare_transfer_hardware = ep93xx_spi_unprepare_hardware;
H Hartley Sweetend9a01772017-08-09 08:51:31 +1200679 master->prepare_message = ep93xx_spi_prepare_message;
680 master->transfer_one = ep93xx_spi_transfer_one;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000681 master->bus_num = pdev->id;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000682 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
Stephen Warren24778be2013-05-21 20:36:35 -0600683 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16);
Linus Walleij1dfbf332019-04-20 13:05:59 +0200684 /*
685 * The SPI core will count the number of GPIO descriptors to figure
686 * out the number of chip selects available on the platform.
687 */
688 master->num_chipselect = 0;
H Hartley Sweeten55f0cd3f2017-02-16 13:07:37 -0700689
Mika Westerberg011f23a2010-05-06 04:47:04 +0000690 platform_set_drvdata(pdev, master);
691
692 espi = spi_master_get_devdata(master);
693
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700694 espi->clk = devm_clk_get(&pdev->dev, NULL);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000695 if (IS_ERR(espi->clk)) {
696 dev_err(&pdev->dev, "unable to get spi clock\n");
697 error = PTR_ERR(espi->clk);
698 goto fail_release_master;
699 }
700
Mika Westerberg011f23a2010-05-06 04:47:04 +0000701 /*
702 * Calculate maximum and minimum supported clock rates
703 * for the controller.
704 */
Axel Lin56fc0b42014-02-08 23:52:26 +0800705 master->max_speed_hz = clk_get_rate(espi->clk) / 2;
706 master->min_speed_hz = clk_get_rate(espi->clk) / (254 * 256);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000707
Mika Westerberg626a96d2011-05-29 13:10:06 +0300708 espi->sspdr_phys = res->start + SSPDR;
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300709
H Hartley Sweeten12329782017-08-09 08:51:25 +1200710 espi->mmio = devm_ioremap_resource(&pdev->dev, res);
711 if (IS_ERR(espi->mmio)) {
712 error = PTR_ERR(espi->mmio);
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700713 goto fail_release_master;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000714 }
715
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300716 error = devm_request_irq(&pdev->dev, irq, ep93xx_spi_interrupt,
H Hartley Sweeten48738832017-08-09 08:51:29 +1200717 0, "ep93xx-spi", master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000718 if (error) {
719 dev_err(&pdev->dev, "failed to request irq\n");
H Hartley Sweetene6eb8d92013-07-02 10:08:21 -0700720 goto fail_release_master;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000721 }
722
Mika Westerberg626a96d2011-05-29 13:10:06 +0300723 if (info->use_dma && ep93xx_spi_setup_dma(espi))
724 dev_warn(&pdev->dev, "DMA setup failed. Falling back to PIO\n");
725
Mika Westerberg011f23a2010-05-06 04:47:04 +0000726 /* make sure that the hardware is disabled */
H Hartley Sweeten8447e472017-08-09 08:51:26 +1200727 writel(0, espi->mmio + SSPCR1);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000728
Jingoo Han434eaf32013-09-24 13:30:41 +0900729 error = devm_spi_register_master(&pdev->dev, master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000730 if (error) {
731 dev_err(&pdev->dev, "failed to register SPI master\n");
H Hartley Sweeten84ddb3c2013-07-08 09:12:37 -0700732 goto fail_free_dma;
Mika Westerberg011f23a2010-05-06 04:47:04 +0000733 }
734
735 dev_info(&pdev->dev, "EP93xx SPI Controller at 0x%08lx irq %d\n",
Hannu Heikkinen6d6467e2012-05-09 17:26:26 +0300736 (unsigned long)res->start, irq);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000737
738 return 0;
739
Mika Westerberg626a96d2011-05-29 13:10:06 +0300740fail_free_dma:
741 ep93xx_spi_release_dma(espi);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000742fail_release_master:
743 spi_master_put(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000744
745 return error;
746}
747
Grant Likelyfd4a3192012-12-07 16:57:14 +0000748static int ep93xx_spi_remove(struct platform_device *pdev)
Mika Westerberg011f23a2010-05-06 04:47:04 +0000749{
750 struct spi_master *master = platform_get_drvdata(pdev);
751 struct ep93xx_spi *espi = spi_master_get_devdata(master);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000752
Mika Westerberg626a96d2011-05-29 13:10:06 +0300753 ep93xx_spi_release_dma(espi);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000754
Mika Westerberg011f23a2010-05-06 04:47:04 +0000755 return 0;
756}
757
758static struct platform_driver ep93xx_spi_driver = {
759 .driver = {
760 .name = "ep93xx-spi",
Mika Westerberg011f23a2010-05-06 04:47:04 +0000761 },
Grant Likely940ab882011-10-05 11:29:49 -0600762 .probe = ep93xx_spi_probe,
Grant Likelyfd4a3192012-12-07 16:57:14 +0000763 .remove = ep93xx_spi_remove,
Mika Westerberg011f23a2010-05-06 04:47:04 +0000764};
Grant Likely940ab882011-10-05 11:29:49 -0600765module_platform_driver(ep93xx_spi_driver);
Mika Westerberg011f23a2010-05-06 04:47:04 +0000766
767MODULE_DESCRIPTION("EP93xx SPI Controller driver");
768MODULE_AUTHOR("Mika Westerberg <mika.westerberg@iki.fi>");
769MODULE_LICENSE("GPL");
770MODULE_ALIAS("platform:ep93xx-spi");