1238438Sdteske// SPDX-License-Identifier: GPL-2.0-only 2238438Sdteske/* 3249746Sdteske * Driver for Cirrus Logic EP93xx SPI controller. 4252980Sdteske * 5238438Sdteske * Copyright (C) 2010-2011 Mika Westerberg 6238438Sdteske * 7238438Sdteske * Explicit FIFO handling code was inspired by amba-pl022 driver. 8238438Sdteske * 9238438Sdteske * Chip select support using other than built-in GPIOs by H. Hartley Sweeten. 10238438Sdteske * 11238438Sdteske * For more information about the SPI controller see documentation on Cirrus 12238438Sdteske * Logic web site: 13238438Sdteske * https://www.cirrus.com/en/pubs/manual/EP93xx_Users_Guide_UM1.pdf 14238438Sdteske */ 15238438Sdteske 16252987Sdteske#include <linux/io.h> 17238438Sdteske#include <linux/clk.h> 18238438Sdteske#include <linux/err.h> 19238438Sdteske#include <linux/delay.h> 20252987Sdteske#include <linux/device.h> 21238438Sdteske#include <linux/dmaengine.h> 22238438Sdteske#include <linux/bitops.h> 23238438Sdteske#include <linux/interrupt.h> 24238438Sdteske#include <linux/module.h> 25238438Sdteske#include <linux/platform_device.h> 26238438Sdteske#include <linux/sched.h> 27238438Sdteske#include <linux/scatterlist.h> 28238438Sdteske#include <linux/spi/spi.h> 29238438Sdteske 30238438Sdteske#include <linux/platform_data/dma-ep93xx.h> 31240684Sdteske#include <linux/platform_data/spi-ep93xx.h> 32240684Sdteske 33244675Sdteske#define SSPCR0 0x0000 34240684Sdteske#define SSPCR0_SPO BIT(6) 35240684Sdteske#define SSPCR0_SPH BIT(7) 36240684Sdteske#define SSPCR0_SCR_SHIFT 8 37238438Sdteske 38240684Sdteske#define SSPCR1 0x0004 39238438Sdteske#define SSPCR1_RIE BIT(0) 40238438Sdteske#define SSPCR1_TIE BIT(1) 41259054Sdteske#define SSPCR1_RORIE BIT(2) 42259054Sdteske#define SSPCR1_LBM BIT(3) 43238438Sdteske#define SSPCR1_SSE BIT(4) 44238438Sdteske#define SSPCR1_MS BIT(5) 45238438Sdteske#define SSPCR1_SOD BIT(6) 46238438Sdteske 47238438Sdteske#define SSPDR 0x0008 48238438Sdteske 49238438Sdteske#define SSPSR 0x000c 50238438Sdteske#define SSPSR_TFE BIT(0) 51238438Sdteske#define SSPSR_TNF BIT(1) 52238438Sdteske#define SSPSR_RNE BIT(2) 53238438Sdteske#define SSPSR_RFF BIT(3) 54238438Sdteske#define SSPSR_BSY BIT(4) 55238438Sdteske#define SSPCPSR 0x0010 56238438Sdteske 57238438Sdteske#define SSPIIR 0x0014 58238438Sdteske#define SSPIIR_RIS BIT(0) 59238438Sdteske#define SSPIIR_TIS BIT(1) 60238438Sdteske#define SSPIIR_RORIS BIT(2) 61238438Sdteske#define SSPICR SSPIIR 62238438Sdteske 63238438Sdteske/* timeout in milliseconds */ 64238438Sdteske#define SPI_TIMEOUT 5 65238438Sdteske/* maximum depth of RX/TX FIFO */ 66238438Sdteske#define SPI_FIFO_SIZE 8 67238438Sdteske 68238438Sdteske/** 69238438Sdteske * struct ep93xx_spi - EP93xx SPI controller structure 70238438Sdteske * @clk: clock for the controller 71238438Sdteske * @mmio: pointer to ioremap()'d registers 72238438Sdteske * @sspdr_phys: physical address of the SSPDR register 73238438Sdteske * @tx: current byte in transfer to transmit 74238438Sdteske * @rx: current byte in transfer to receive 75238438Sdteske * @fifo_level: how full is FIFO (%0..%SPI_FIFO_SIZE - %1). Receiving one 76238438Sdteske * frame decreases this level and sending one frame increases it. 77238438Sdteske * @dma_rx: RX DMA channel 78238438Sdteske * @dma_tx: TX DMA channel 79238438Sdteske * @dma_rx_data: RX parameters passed to the DMA engine 80251264Sdteske * @dma_tx_data: TX parameters passed to the DMA engine 81251264Sdteske * @rx_sgt: sg table for RX transfers 82238438Sdteske * @tx_sgt: sg table for TX transfers 83238438Sdteske * @zeropage: dummy page used as RX buffer when only TX buffer is passed in by 84238438Sdteske * the client 85238438Sdteske */ 86238438Sdteskestruct ep93xx_spi { 87238438Sdteske struct clk *clk; 88238438Sdteske void __iomem *mmio; 89238438Sdteske unsigned long sspdr_phys; 90238438Sdteske size_t tx; 91238438Sdteske size_t rx; 92238438Sdteske size_t fifo_level; 93238438Sdteske struct dma_chan *dma_rx; 94238438Sdteske struct dma_chan *dma_tx; 95238438Sdteske struct ep93xx_dma_data dma_rx_data; 96238438Sdteske struct ep93xx_dma_data dma_tx_data; 97238438Sdteske struct sg_table rx_sgt; 98238438Sdteske struct sg_table tx_sgt; 99238438Sdteske void *zeropage; 100238438Sdteske}; 101238438Sdteske 102238438Sdteske/* converts bits per word to CR0.DSS value */ 103238438Sdteske#define bits_per_word_to_dss(bpw) ((bpw) - 1) 104238438Sdteske 105238438Sdteske/** 106238438Sdteske * ep93xx_spi_calc_divisors() - calculates SPI clock divisors 107238438Sdteske * @host: SPI host 108238438Sdteske * @rate: desired SPI output clock rate 109238438Sdteske * @div_cpsr: pointer to return the cpsr (pre-scaler) divider 110238438Sdteske * @div_scr: pointer to return the scr divider 111238438Sdteske */ 112238438Sdteskestatic int ep93xx_spi_calc_divisors(struct spi_controller *host, 113251190Sdteske u32 rate, u8 *div_cpsr, u8 *div_scr) 114251190Sdteske{ 115251190Sdteske struct ep93xx_spi *espi = spi_controller_get_devdata(host); 116251190Sdteske unsigned long spi_clk_rate = clk_get_rate(espi->clk); 117251190Sdteske int cpsr, scr; 118251190Sdteske 119251190Sdteske /* 120238438Sdteske * Make sure that max value is between values supported by the 121249751Sdteske * controller. 122251904Sdteske */ 123251904Sdteske rate = clamp(rate, host->min_speed_hz, host->max_speed_hz); 124251904Sdteske 125251904Sdteske /* 126251904Sdteske * Calculate divisors so that we can get speed according the 127251904Sdteske * following formula: 128251904Sdteske * rate = spi_clock_rate / (cpsr * (1 + scr)) 129251904Sdteske * 130251904Sdteske * cpsr must be even number and starts from 2, scr can be any number 131251904Sdteske * between 0 and 255. 132251904Sdteske */ 133251904Sdteske for (cpsr = 2; cpsr <= 254; cpsr += 2) { 134251904Sdteske for (scr = 0; scr <= 255; scr++) { 135251904Sdteske if ((spi_clk_rate / (cpsr * (scr + 1))) <= rate) { 136251904Sdteske *div_scr = (u8)scr; 137251904Sdteske *div_cpsr = (u8)cpsr; 138251904Sdteske return 0; 139251904Sdteske } 140251904Sdteske } 141251904Sdteske } 142251904Sdteske 143251904Sdteske return -EINVAL; 144251904Sdteske} 145251904Sdteske 146251904Sdteskestatic int ep93xx_spi_chip_setup(struct spi_controller *host, 147251904Sdteske struct spi_device *spi, 148251904Sdteske struct spi_transfer *xfer) 149251904Sdteske{ 150251904Sdteske struct ep93xx_spi *espi = spi_controller_get_devdata(host); 151251904Sdteske u8 dss = bits_per_word_to_dss(xfer->bits_per_word); 152251904Sdteske u8 div_cpsr = 0; 153251904Sdteske u8 div_scr = 0; 154251904Sdteske u16 cr0; 155251904Sdteske int err; 156251904Sdteske 157251904Sdteske err = ep93xx_spi_calc_divisors(host, xfer->speed_hz, 158251904Sdteske &div_cpsr, &div_scr); 159251904Sdteske if (err) 160251904Sdteske return err; 161251904Sdteske 162251904Sdteske cr0 = div_scr << SSPCR0_SCR_SHIFT; 163251904Sdteske if (spi->mode & SPI_CPOL) 164251904Sdteske cr0 |= SSPCR0_SPO; 165251904Sdteske if (spi->mode & SPI_CPHA) 166251904Sdteske cr0 |= SSPCR0_SPH; 167251904Sdteske cr0 |= dss; 168251904Sdteske 169251904Sdteske dev_dbg(&host->dev, "setup: mode %d, cpsr %d, scr %d, dss %d\n", 170251904Sdteske spi->mode, div_cpsr, div_scr, dss); 171251904Sdteske dev_dbg(&host->dev, "setup: cr0 %#x\n", cr0); 172251904Sdteske 173251904Sdteske writel(div_cpsr, espi->mmio + SSPCPSR); 174251904Sdteske writel(cr0, espi->mmio + SSPCR0); 175251904Sdteske 176251904Sdteske return 0; 177251904Sdteske} 178251904Sdteske 179251904Sdteskestatic void ep93xx_do_write(struct spi_controller *host) 180251904Sdteske{ 181251904Sdteske struct ep93xx_spi *espi = spi_controller_get_devdata(host); 182249751Sdteske struct spi_transfer *xfer = host->cur_msg->state; 183249751Sdteske u32 val = 0; 184249751Sdteske 185249751Sdteske if (xfer->bits_per_word > 8) { 186249751Sdteske if (xfer->tx_buf) 187249751Sdteske val = ((u16 *)xfer->tx_buf)[espi->tx]; 188249751Sdteske espi->tx += 2; 189249751Sdteske } else { 190249751Sdteske if (xfer->tx_buf) 191249751Sdteske val = ((u8 *)xfer->tx_buf)[espi->tx]; 192249751Sdteske espi->tx += 1; 193249751Sdteske } 194249751Sdteske writel(val, espi->mmio + SSPDR); 195249751Sdteske} 196251236Sdteske 197251236Sdteskestatic void ep93xx_do_read(struct spi_controller *host) 198249751Sdteske{ 199238438Sdteske struct ep93xx_spi *espi = spi_controller_get_devdata(host); 200238438Sdteske struct spi_transfer *xfer = host->cur_msg->state; 201238438Sdteske u32 val; 202238438Sdteske 203249751Sdteske val = readl(espi->mmio + SSPDR); 204251190Sdteske if (xfer->bits_per_word > 8) { 205251190Sdteske if (xfer->rx_buf) 206238438Sdteske ((u16 *)xfer->rx_buf)[espi->rx] = val; 207240768Sdteske espi->rx += 2; 208240768Sdteske } else { 209240768Sdteske if (xfer->rx_buf) 210251236Sdteske ((u8 *)xfer->rx_buf)[espi->rx] = val; 211240768Sdteske espi->rx += 1; 212238438Sdteske } 213238438Sdteske} 214238438Sdteske 215238438Sdteske/** 216238438Sdteske * ep93xx_spi_read_write() - perform next RX/TX transfer 217238438Sdteske * @host: SPI host 218238438Sdteske * 219238438Sdteske * This function transfers next bytes (or half-words) to/from RX/TX FIFOs. If 220238438Sdteske * called several times, the whole transfer will be completed. Returns 221238438Sdteske * %-EINPROGRESS when current transfer was not yet completed otherwise %0. 222250633Sdteske * 223238438Sdteske * When this function is finished, RX FIFO should be empty and TX FIFO should be 224252178Sdteske * full. 225238438Sdteske */ 226238438Sdteskestatic int ep93xx_spi_read_write(struct spi_controller *host) 227238438Sdteske{ 228238438Sdteske struct ep93xx_spi *espi = spi_controller_get_devdata(host); 229238438Sdteske struct spi_transfer *xfer = host->cur_msg->state; 230238438Sdteske 231238438Sdteske /* read as long as RX FIFO has frames in it */ 232238438Sdteske while ((readl(espi->mmio + SSPSR) & SSPSR_RNE)) { 233238438Sdteske ep93xx_do_read(host); 234238438Sdteske espi->fifo_level--; 235238438Sdteske } 236238438Sdteske 237238438Sdteske /* write as long as TX FIFO has room */ 238238438Sdteske while (espi->fifo_level < SPI_FIFO_SIZE && espi->tx < xfer->len) { 239238438Sdteske ep93xx_do_write(host); 240251236Sdteske espi->fifo_level++; 241251236Sdteske } 242238438Sdteske 243238438Sdteske if (espi->rx == xfer->len) 244238438Sdteske return 0; 245238438Sdteske 246238438Sdteske return -EINPROGRESS; 247238438Sdteske} 248238438Sdteske 249259054Sdteskestatic enum dma_transfer_direction 250259054Sdteskeep93xx_dma_data_to_trans_dir(enum dma_data_direction dir) 251238438Sdteske{ 252238438Sdteske switch (dir) { 253238438Sdteske case DMA_TO_DEVICE: 254238438Sdteske return DMA_MEM_TO_DEV; 255251905Sdteske case DMA_FROM_DEVICE: 256238438Sdteske return DMA_DEV_TO_MEM; 257251905Sdteske default: 258251905Sdteske return DMA_TRANS_NONE; 259251905Sdteske } 260251905Sdteske} 261251905Sdteske 262251905Sdteske/** 263251905Sdteske * ep93xx_spi_dma_prepare() - prepares a DMA transfer 264251905Sdteske * @host: SPI host 265251905Sdteske * @dir: DMA transfer direction 266251905Sdteske * 267251905Sdteske * Function configures the DMA, maps the buffer and prepares the DMA 268251905Sdteske * descriptor. Returns a valid DMA descriptor in case of success and ERR_PTR 269251905Sdteske * in case of failure. 270251905Sdteske */ 271251905Sdteskestatic struct dma_async_tx_descriptor * 272251905Sdteskeep93xx_spi_dma_prepare(struct spi_controller *host, 273251905Sdteske enum dma_data_direction dir) 274251905Sdteske{ 275251905Sdteske struct ep93xx_spi *espi = spi_controller_get_devdata(host); 276251905Sdteske struct spi_transfer *xfer = host->cur_msg->state; 277251905Sdteske struct dma_async_tx_descriptor *txd; 278251905Sdteske enum dma_slave_buswidth buswidth; 279251905Sdteske struct dma_slave_config conf; 280251905Sdteske struct scatterlist *sg; 281251905Sdteske struct sg_table *sgt; 282251905Sdteske struct dma_chan *chan; 283251905Sdteske const void *buf, *pbuf; 284251905Sdteske size_t len = xfer->len; 285251905Sdteske int i, ret, nents; 286251905Sdteske 287251905Sdteske if (xfer->bits_per_word > 8) 288251905Sdteske buswidth = DMA_SLAVE_BUSWIDTH_2_BYTES; 289251905Sdteske else 290251905Sdteske buswidth = DMA_SLAVE_BUSWIDTH_1_BYTE; 291251905Sdteske 292251905Sdteske memset(&conf, 0, sizeof(conf)); 293251905Sdteske conf.direction = ep93xx_dma_data_to_trans_dir(dir); 294251905Sdteske 295251905Sdteske if (dir == DMA_FROM_DEVICE) { 296251905Sdteske chan = espi->dma_rx; 297251905Sdteske buf = xfer->rx_buf; 298251905Sdteske sgt = &espi->rx_sgt; 299251905Sdteske 300251905Sdteske conf.src_addr = espi->sspdr_phys; 301251905Sdteske conf.src_addr_width = buswidth; 302251905Sdteske } else { 303251905Sdteske chan = espi->dma_tx; 304251905Sdteske buf = xfer->tx_buf; 305251905Sdteske sgt = &espi->tx_sgt; 306251905Sdteske 307251905Sdteske conf.dst_addr = espi->sspdr_phys; 308251905Sdteske conf.dst_addr_width = buswidth; 309251905Sdteske } 310251905Sdteske 311251905Sdteske ret = dmaengine_slave_config(chan, &conf); 312251905Sdteske if (ret) 313251905Sdteske return ERR_PTR(ret); 314251905Sdteske 315251905Sdteske /* 316251905Sdteske * We need to split the transfer into PAGE_SIZE'd chunks. This is 317238438Sdteske * because we are using @espi->zeropage to provide a zero RX buffer 318251905Sdteske * for the TX transfers and we have only allocated one page for that. 319251905Sdteske * 320259054Sdteske * For performance reasons we allocate a new sg_table only when 321259054Sdteske * needed. Otherwise we will re-use the current one. Eventually the 322251905Sdteske * last sg_table is released in ep93xx_spi_release_dma(). 323251905Sdteske */ 324251907Sdteske 325251905Sdteske nents = DIV_ROUND_UP(len, PAGE_SIZE); 326238438Sdteske if (nents != sgt->nents) { 327238438Sdteske sg_free_table(sgt); 328238438Sdteske 329238438Sdteske ret = sg_alloc_table(sgt, nents, GFP_KERNEL); 330238438Sdteske if (ret) 331238438Sdteske return ERR_PTR(ret); 332238438Sdteske } 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)) { 351 dev_warn(&host->dev, "len = %zu expected 0!\n", len); 352 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 359 txd = dmaengine_prep_slave_sg(chan, sgt->sgl, nents, conf.direction, 360 DMA_CTRL_ACK); 361 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 370 * @host: SPI host 371 * @dir: DMA transfer direction 372 * 373 * Function finishes with the DMA transfer. After this, the DMA buffer is 374 * unmapped. 375 */ 376static void ep93xx_spi_dma_finish(struct spi_controller *host, 377 enum dma_data_direction dir) 378{ 379 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 380 struct dma_chan *chan; 381 struct sg_table *sgt; 382 383 if (dir == DMA_FROM_DEVICE) { 384 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{ 396 struct spi_controller *host = callback_param; 397 398 ep93xx_spi_dma_finish(host, DMA_TO_DEVICE); 399 ep93xx_spi_dma_finish(host, DMA_FROM_DEVICE); 400 401 spi_finalize_current_transfer(host); 402} 403 404static int ep93xx_spi_dma_transfer(struct spi_controller *host) 405{ 406 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 407 struct dma_async_tx_descriptor *rxd, *txd; 408 409 rxd = ep93xx_spi_dma_prepare(host, DMA_FROM_DEVICE); 410 if (IS_ERR(rxd)) { 411 dev_err(&host->dev, "DMA RX failed: %ld\n", PTR_ERR(rxd)); 412 return PTR_ERR(rxd); 413 } 414 415 txd = ep93xx_spi_dma_prepare(host, DMA_TO_DEVICE); 416 if (IS_ERR(txd)) { 417 ep93xx_spi_dma_finish(host, DMA_FROM_DEVICE); 418 dev_err(&host->dev, "DMA TX failed: %ld\n", PTR_ERR(txd)); 419 return PTR_ERR(txd); 420 } 421 422 /* We are ready when RX is done */ 423 rxd->callback = ep93xx_spi_dma_callback; 424 rxd->callback_param = host; 425 426 /* Now submit both descriptors and start DMA */ 427 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 433 /* signal that we need to wait for completion */ 434 return 1; 435} 436 437static irqreturn_t ep93xx_spi_interrupt(int irq, void *dev_id) 438{ 439 struct spi_controller *host = dev_id; 440 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 441 u32 val; 442 443 /* 444 * If we got ROR (receive overrun) interrupt we know that something is 445 * wrong. Just abort the message. 446 */ 447 if (readl(espi->mmio + SSPIIR) & SSPIIR_RORIS) { 448 /* clear the overrun interrupt */ 449 writel(0, espi->mmio + SSPICR); 450 dev_warn(&host->dev, 451 "receive overrun, aborting the message\n"); 452 host->cur_msg->status = -EIO; 453 } else { 454 /* 455 * Interrupt is either RX (RIS) or TX (TIS). For both cases we 456 * simply execute next data transfer. 457 */ 458 if (ep93xx_spi_read_write(host)) { 459 /* 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 */ 473 val = readl(espi->mmio + SSPCR1); 474 val &= ~(SSPCR1_RORIE | SSPCR1_TIE | SSPCR1_RIE); 475 writel(val, espi->mmio + SSPCR1); 476 477 spi_finalize_current_transfer(host); 478 479 return IRQ_HANDLED; 480} 481 482static int ep93xx_spi_transfer_one(struct spi_controller *host, 483 struct spi_device *spi, 484 struct spi_transfer *xfer) 485{ 486 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 487 u32 val; 488 int ret; 489 490 ret = ep93xx_spi_chip_setup(host, spi, xfer); 491 if (ret) { 492 dev_err(&host->dev, "failed to setup chip for transfer\n"); 493 return ret; 494 } 495 496 host->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(host); 507 508 /* Using PIO so prime the TX FIFO and enable interrupts */ 509 ep93xx_spi_read_write(host); 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_controller *host, 520 struct spi_message *msg) 521{ 522 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 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(&host->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 547static int ep93xx_spi_prepare_hardware(struct spi_controller *host) 548{ 549 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 550 u32 val; 551 int ret; 552 553 ret = clk_prepare_enable(espi->clk); 554 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_controller *host) 565{ 566 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 567 u32 val; 568 569 val = readl(espi->mmio + SSPCR1); 570 val &= ~SSPCR1_SSE; 571 writel(val, espi->mmio + SSPCR1); 572 573 clk_disable_unprepare(espi->clk); 574 575 return 0; 576} 577 578static 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; 600 espi->dma_rx_data.direction = DMA_DEV_TO_MEM; 601 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; 611 espi->dma_tx_data.direction = DMA_MEM_TO_DEV; 612 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 647static int ep93xx_spi_probe(struct platform_device *pdev) 648{ 649 struct spi_controller *host; 650 struct ep93xx_spi_info *info; 651 struct ep93xx_spi *espi; 652 struct resource *res; 653 int irq; 654 int error; 655 656 info = dev_get_platdata(&pdev->dev); 657 if (!info) { 658 dev_err(&pdev->dev, "missing platform data\n"); 659 return -EINVAL; 660 } 661 662 irq = platform_get_irq(pdev, 0); 663 if (irq < 0) 664 return irq; 665 666 host = spi_alloc_host(&pdev->dev, sizeof(*espi)); 667 if (!host) 668 return -ENOMEM; 669 670 host->use_gpio_descriptors = true; 671 host->prepare_transfer_hardware = ep93xx_spi_prepare_hardware; 672 host->unprepare_transfer_hardware = ep93xx_spi_unprepare_hardware; 673 host->prepare_message = ep93xx_spi_prepare_message; 674 host->transfer_one = ep93xx_spi_transfer_one; 675 host->bus_num = pdev->id; 676 host->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH; 677 host->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16); 678 /* 679 * The SPI core will count the number of GPIO descriptors to figure 680 * out the number of chip selects available on the platform. 681 */ 682 host->num_chipselect = 0; 683 684 platform_set_drvdata(pdev, host); 685 686 espi = spi_controller_get_devdata(host); 687 688 espi->clk = devm_clk_get(&pdev->dev, NULL); 689 if (IS_ERR(espi->clk)) { 690 dev_err(&pdev->dev, "unable to get spi clock\n"); 691 error = PTR_ERR(espi->clk); 692 goto fail_release_host; 693 } 694 695 /* 696 * Calculate maximum and minimum supported clock rates 697 * for the controller. 698 */ 699 host->max_speed_hz = clk_get_rate(espi->clk) / 2; 700 host->min_speed_hz = clk_get_rate(espi->clk) / (254 * 256); 701 702 espi->mmio = devm_platform_get_and_ioremap_resource(pdev, 0, &res); 703 if (IS_ERR(espi->mmio)) { 704 error = PTR_ERR(espi->mmio); 705 goto fail_release_host; 706 } 707 espi->sspdr_phys = res->start + SSPDR; 708 709 error = devm_request_irq(&pdev->dev, irq, ep93xx_spi_interrupt, 710 0, "ep93xx-spi", host); 711 if (error) { 712 dev_err(&pdev->dev, "failed to request irq\n"); 713 goto fail_release_host; 714 } 715 716 if (info->use_dma && ep93xx_spi_setup_dma(espi)) 717 dev_warn(&pdev->dev, "DMA setup failed. Falling back to PIO\n"); 718 719 /* make sure that the hardware is disabled */ 720 writel(0, espi->mmio + SSPCR1); 721 722 error = devm_spi_register_controller(&pdev->dev, host); 723 if (error) { 724 dev_err(&pdev->dev, "failed to register SPI host\n"); 725 goto fail_free_dma; 726 } 727 728 dev_info(&pdev->dev, "EP93xx SPI Controller at 0x%08lx irq %d\n", 729 (unsigned long)res->start, irq); 730 731 return 0; 732 733fail_free_dma: 734 ep93xx_spi_release_dma(espi); 735fail_release_host: 736 spi_controller_put(host); 737 738 return error; 739} 740 741static void ep93xx_spi_remove(struct platform_device *pdev) 742{ 743 struct spi_controller *host = platform_get_drvdata(pdev); 744 struct ep93xx_spi *espi = spi_controller_get_devdata(host); 745 746 ep93xx_spi_release_dma(espi); 747} 748 749static struct platform_driver ep93xx_spi_driver = { 750 .driver = { 751 .name = "ep93xx-spi", 752 }, 753 .probe = ep93xx_spi_probe, 754 .remove_new = ep93xx_spi_remove, 755}; 756module_platform_driver(ep93xx_spi_driver); 757 758MODULE_DESCRIPTION("EP93xx SPI Controller driver"); 759MODULE_AUTHOR("Mika Westerberg <mika.westerberg@iki.fi>"); 760MODULE_LICENSE("GPL"); 761MODULE_ALIAS("platform:ep93xx-spi"); 762