2 * Copyright (C) 2009 Samsung Electronics Ltd.
3 * Jaswinder Singh <jassi.brar@samsung.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/workqueue.h>
23 #include <linux/interrupt.h>
24 #include <linux/delay.h>
25 #include <linux/clk.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/platform_device.h>
28 #include <linux/pm_runtime.h>
29 #include <linux/spi/spi.h>
32 #include <plat/s3c64xx-spi.h>
34 /* Registers and bit-fields */
36 #define S3C64XX_SPI_CH_CFG 0x00
37 #define S3C64XX_SPI_CLK_CFG 0x04
38 #define S3C64XX_SPI_MODE_CFG 0x08
39 #define S3C64XX_SPI_SLAVE_SEL 0x0C
40 #define S3C64XX_SPI_INT_EN 0x10
41 #define S3C64XX_SPI_STATUS 0x14
42 #define S3C64XX_SPI_TX_DATA 0x18
43 #define S3C64XX_SPI_RX_DATA 0x1C
44 #define S3C64XX_SPI_PACKET_CNT 0x20
45 #define S3C64XX_SPI_PENDING_CLR 0x24
46 #define S3C64XX_SPI_SWAP_CFG 0x28
47 #define S3C64XX_SPI_FB_CLK 0x2C
49 #define S3C64XX_SPI_CH_HS_EN (1<<6) /* High Speed Enable */
50 #define S3C64XX_SPI_CH_SW_RST (1<<5)
51 #define S3C64XX_SPI_CH_SLAVE (1<<4)
52 #define S3C64XX_SPI_CPOL_L (1<<3)
53 #define S3C64XX_SPI_CPHA_B (1<<2)
54 #define S3C64XX_SPI_CH_RXCH_ON (1<<1)
55 #define S3C64XX_SPI_CH_TXCH_ON (1<<0)
57 #define S3C64XX_SPI_CLKSEL_SRCMSK (3<<9)
58 #define S3C64XX_SPI_CLKSEL_SRCSHFT 9
59 #define S3C64XX_SPI_ENCLK_ENABLE (1<<8)
60 #define S3C64XX_SPI_PSR_MASK 0xff
62 #define S3C64XX_SPI_MODE_CH_TSZ_BYTE (0<<29)
63 #define S3C64XX_SPI_MODE_CH_TSZ_HALFWORD (1<<29)
64 #define S3C64XX_SPI_MODE_CH_TSZ_WORD (2<<29)
65 #define S3C64XX_SPI_MODE_CH_TSZ_MASK (3<<29)
66 #define S3C64XX_SPI_MODE_BUS_TSZ_BYTE (0<<17)
67 #define S3C64XX_SPI_MODE_BUS_TSZ_HALFWORD (1<<17)
68 #define S3C64XX_SPI_MODE_BUS_TSZ_WORD (2<<17)
69 #define S3C64XX_SPI_MODE_BUS_TSZ_MASK (3<<17)
70 #define S3C64XX_SPI_MODE_RXDMA_ON (1<<2)
71 #define S3C64XX_SPI_MODE_TXDMA_ON (1<<1)
72 #define S3C64XX_SPI_MODE_4BURST (1<<0)
74 #define S3C64XX_SPI_SLAVE_AUTO (1<<1)
75 #define S3C64XX_SPI_SLAVE_SIG_INACT (1<<0)
77 #define S3C64XX_SPI_ACT(c) writel(0, (c)->regs + S3C64XX_SPI_SLAVE_SEL)
79 #define S3C64XX_SPI_DEACT(c) writel(S3C64XX_SPI_SLAVE_SIG_INACT, \
80 (c)->regs + S3C64XX_SPI_SLAVE_SEL)
82 #define S3C64XX_SPI_INT_TRAILING_EN (1<<6)
83 #define S3C64XX_SPI_INT_RX_OVERRUN_EN (1<<5)
84 #define S3C64XX_SPI_INT_RX_UNDERRUN_EN (1<<4)
85 #define S3C64XX_SPI_INT_TX_OVERRUN_EN (1<<3)
86 #define S3C64XX_SPI_INT_TX_UNDERRUN_EN (1<<2)
87 #define S3C64XX_SPI_INT_RX_FIFORDY_EN (1<<1)
88 #define S3C64XX_SPI_INT_TX_FIFORDY_EN (1<<0)
90 #define S3C64XX_SPI_ST_RX_OVERRUN_ERR (1<<5)
91 #define S3C64XX_SPI_ST_RX_UNDERRUN_ERR (1<<4)
92 #define S3C64XX_SPI_ST_TX_OVERRUN_ERR (1<<3)
93 #define S3C64XX_SPI_ST_TX_UNDERRUN_ERR (1<<2)
94 #define S3C64XX_SPI_ST_RX_FIFORDY (1<<1)
95 #define S3C64XX_SPI_ST_TX_FIFORDY (1<<0)
97 #define S3C64XX_SPI_PACKET_CNT_EN (1<<16)
99 #define S3C64XX_SPI_PND_TX_UNDERRUN_CLR (1<<4)
100 #define S3C64XX_SPI_PND_TX_OVERRUN_CLR (1<<3)
101 #define S3C64XX_SPI_PND_RX_UNDERRUN_CLR (1<<2)
102 #define S3C64XX_SPI_PND_RX_OVERRUN_CLR (1<<1)
103 #define S3C64XX_SPI_PND_TRAILING_CLR (1<<0)
105 #define S3C64XX_SPI_SWAP_RX_HALF_WORD (1<<7)
106 #define S3C64XX_SPI_SWAP_RX_BYTE (1<<6)
107 #define S3C64XX_SPI_SWAP_RX_BIT (1<<5)
108 #define S3C64XX_SPI_SWAP_RX_EN (1<<4)
109 #define S3C64XX_SPI_SWAP_TX_HALF_WORD (1<<3)
110 #define S3C64XX_SPI_SWAP_TX_BYTE (1<<2)
111 #define S3C64XX_SPI_SWAP_TX_BIT (1<<1)
112 #define S3C64XX_SPI_SWAP_TX_EN (1<<0)
114 #define S3C64XX_SPI_FBCLK_MSK (3<<0)
116 #define S3C64XX_SPI_ST_TRLCNTZ(v, i) ((((v) >> (i)->rx_lvl_offset) & \
117 (((i)->fifo_lvl_mask + 1))) \
120 #define S3C64XX_SPI_ST_TX_DONE(v, i) (((v) & (1 << (i)->tx_st_done)) ? 1 : 0)
121 #define TX_FIFO_LVL(v, i) (((v) >> 6) & (i)->fifo_lvl_mask)
122 #define RX_FIFO_LVL(v, i) (((v) >> (i)->rx_lvl_offset) & (i)->fifo_lvl_mask)
124 #define S3C64XX_SPI_MAX_TRAILCNT 0x3ff
125 #define S3C64XX_SPI_TRAILCNT_OFF 19
127 #define S3C64XX_SPI_TRAILCNT S3C64XX_SPI_MAX_TRAILCNT
129 #define msecs_to_loops(t) (loops_per_jiffy / 1000 * HZ * t)
131 #define SUSPND (1<<0)
132 #define SPIBUSY (1<<1)
133 #define RXBUSY (1<<2)
134 #define TXBUSY (1<<3)
136 struct s3c64xx_spi_dma_data {
138 enum dma_data_direction direction;
143 * struct s3c64xx_spi_driver_data - Runtime info holder for SPI driver.
144 * @clk: Pointer to the spi clock.
145 * @src_clk: Pointer to the clock used to generate SPI signals.
146 * @master: Pointer to the SPI Protocol master.
147 * @workqueue: Work queue for the SPI xfer requests.
148 * @cntrlr_info: Platform specific data for the controller this driver manages.
149 * @tgl_spi: Pointer to the last CS left untoggled by the cs_change hint.
151 * @queue: To log SPI xfer requests.
152 * @lock: Controller specific lock.
153 * @state: Set of FLAGS to indicate status.
154 * @rx_dmach: Controller's DMA channel for Rx.
155 * @tx_dmach: Controller's DMA channel for Tx.
156 * @sfr_start: BUS address of SPI controller regs.
157 * @regs: Pointer to ioremap'ed controller registers.
159 * @xfer_completion: To indicate completion of xfer task.
160 * @cur_mode: Stores the active configuration of the controller.
161 * @cur_bpw: Stores the active bits per word settings.
162 * @cur_speed: Stores the active xfer clock speed.
164 struct s3c64xx_spi_driver_data {
168 struct platform_device *pdev;
169 struct spi_master *master;
170 struct workqueue_struct *workqueue;
171 struct s3c64xx_spi_info *cntrlr_info;
172 struct spi_device *tgl_spi;
173 struct work_struct work;
174 struct list_head queue;
176 unsigned long sfr_start;
177 struct completion xfer_completion;
179 unsigned cur_mode, cur_bpw;
181 struct s3c64xx_spi_dma_data rx_dma;
182 struct s3c64xx_spi_dma_data tx_dma;
183 struct samsung_dma_ops *ops;
186 static struct s3c2410_dma_client s3c64xx_spi_dma_client = {
187 .name = "samsung-spi-dma",
190 static void flush_fifo(struct s3c64xx_spi_driver_data *sdd)
192 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
193 void __iomem *regs = sdd->regs;
197 writel(0, regs + S3C64XX_SPI_PACKET_CNT);
199 val = readl(regs + S3C64XX_SPI_CH_CFG);
200 val |= S3C64XX_SPI_CH_SW_RST;
201 val &= ~S3C64XX_SPI_CH_HS_EN;
202 writel(val, regs + S3C64XX_SPI_CH_CFG);
205 loops = msecs_to_loops(1);
207 val = readl(regs + S3C64XX_SPI_STATUS);
208 } while (TX_FIFO_LVL(val, sci) && loops--);
211 dev_warn(&sdd->pdev->dev, "Timed out flushing TX FIFO\n");
214 loops = msecs_to_loops(1);
216 val = readl(regs + S3C64XX_SPI_STATUS);
217 if (RX_FIFO_LVL(val, sci))
218 readl(regs + S3C64XX_SPI_RX_DATA);
224 dev_warn(&sdd->pdev->dev, "Timed out flushing RX FIFO\n");
226 val = readl(regs + S3C64XX_SPI_CH_CFG);
227 val &= ~S3C64XX_SPI_CH_SW_RST;
228 writel(val, regs + S3C64XX_SPI_CH_CFG);
230 val = readl(regs + S3C64XX_SPI_MODE_CFG);
231 val &= ~(S3C64XX_SPI_MODE_TXDMA_ON | S3C64XX_SPI_MODE_RXDMA_ON);
232 writel(val, regs + S3C64XX_SPI_MODE_CFG);
234 val = readl(regs + S3C64XX_SPI_CH_CFG);
235 val &= ~(S3C64XX_SPI_CH_RXCH_ON | S3C64XX_SPI_CH_TXCH_ON);
236 writel(val, regs + S3C64XX_SPI_CH_CFG);
239 static void s3c64xx_spi_dmacb(void *data)
241 struct s3c64xx_spi_driver_data *sdd;
242 struct s3c64xx_spi_dma_data *dma = data;
245 if (dma->direction == DMA_FROM_DEVICE)
246 sdd = container_of(data,
247 struct s3c64xx_spi_driver_data, rx_dma);
249 sdd = container_of(data,
250 struct s3c64xx_spi_driver_data, tx_dma);
252 spin_lock_irqsave(&sdd->lock, flags);
254 if (dma->direction == DMA_FROM_DEVICE) {
255 sdd->state &= ~RXBUSY;
256 if (!(sdd->state & TXBUSY))
257 complete(&sdd->xfer_completion);
259 sdd->state &= ~TXBUSY;
260 if (!(sdd->state & RXBUSY))
261 complete(&sdd->xfer_completion);
264 spin_unlock_irqrestore(&sdd->lock, flags);
267 static void prepare_dma(struct s3c64xx_spi_dma_data *dma,
268 unsigned len, dma_addr_t buf)
270 struct s3c64xx_spi_driver_data *sdd;
271 struct samsung_dma_prep_info info;
273 if (dma->direction == DMA_FROM_DEVICE)
274 sdd = container_of((void *)dma,
275 struct s3c64xx_spi_driver_data, rx_dma);
277 sdd = container_of((void *)dma,
278 struct s3c64xx_spi_driver_data, tx_dma);
280 info.cap = DMA_SLAVE;
282 info.fp = s3c64xx_spi_dmacb;
284 info.direction = dma->direction;
287 sdd->ops->prepare(dma->ch, &info);
288 sdd->ops->trigger(dma->ch);
291 static int acquire_dma(struct s3c64xx_spi_driver_data *sdd)
293 struct samsung_dma_info info;
295 sdd->ops = samsung_dma_get_ops();
297 info.cap = DMA_SLAVE;
298 info.client = &s3c64xx_spi_dma_client;
299 info.width = sdd->cur_bpw / 8;
301 info.direction = sdd->rx_dma.direction;
302 info.fifo = sdd->sfr_start + S3C64XX_SPI_RX_DATA;
303 sdd->rx_dma.ch = sdd->ops->request(sdd->rx_dma.dmach, &info);
304 info.direction = sdd->tx_dma.direction;
305 info.fifo = sdd->sfr_start + S3C64XX_SPI_TX_DATA;
306 sdd->tx_dma.ch = sdd->ops->request(sdd->tx_dma.dmach, &info);
311 static void enable_datapath(struct s3c64xx_spi_driver_data *sdd,
312 struct spi_device *spi,
313 struct spi_transfer *xfer, int dma_mode)
315 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
316 void __iomem *regs = sdd->regs;
319 modecfg = readl(regs + S3C64XX_SPI_MODE_CFG);
320 modecfg &= ~(S3C64XX_SPI_MODE_TXDMA_ON | S3C64XX_SPI_MODE_RXDMA_ON);
322 chcfg = readl(regs + S3C64XX_SPI_CH_CFG);
323 chcfg &= ~S3C64XX_SPI_CH_TXCH_ON;
326 chcfg &= ~S3C64XX_SPI_CH_RXCH_ON;
328 /* Always shift in data in FIFO, even if xfer is Tx only,
329 * this helps setting PCKT_CNT value for generating clocks
332 chcfg |= S3C64XX_SPI_CH_RXCH_ON;
333 writel(((xfer->len * 8 / sdd->cur_bpw) & 0xffff)
334 | S3C64XX_SPI_PACKET_CNT_EN,
335 regs + S3C64XX_SPI_PACKET_CNT);
338 if (xfer->tx_buf != NULL) {
339 sdd->state |= TXBUSY;
340 chcfg |= S3C64XX_SPI_CH_TXCH_ON;
342 modecfg |= S3C64XX_SPI_MODE_TXDMA_ON;
343 prepare_dma(&sdd->tx_dma, xfer->len, xfer->tx_dma);
345 switch (sdd->cur_bpw) {
347 iowrite32_rep(regs + S3C64XX_SPI_TX_DATA,
348 xfer->tx_buf, xfer->len / 4);
351 iowrite16_rep(regs + S3C64XX_SPI_TX_DATA,
352 xfer->tx_buf, xfer->len / 2);
355 iowrite8_rep(regs + S3C64XX_SPI_TX_DATA,
356 xfer->tx_buf, xfer->len);
362 if (xfer->rx_buf != NULL) {
363 sdd->state |= RXBUSY;
365 if (sci->high_speed && sdd->cur_speed >= 30000000UL
366 && !(sdd->cur_mode & SPI_CPHA))
367 chcfg |= S3C64XX_SPI_CH_HS_EN;
370 modecfg |= S3C64XX_SPI_MODE_RXDMA_ON;
371 chcfg |= S3C64XX_SPI_CH_RXCH_ON;
372 writel(((xfer->len * 8 / sdd->cur_bpw) & 0xffff)
373 | S3C64XX_SPI_PACKET_CNT_EN,
374 regs + S3C64XX_SPI_PACKET_CNT);
375 prepare_dma(&sdd->rx_dma, xfer->len, xfer->rx_dma);
379 writel(modecfg, regs + S3C64XX_SPI_MODE_CFG);
380 writel(chcfg, regs + S3C64XX_SPI_CH_CFG);
383 static inline void enable_cs(struct s3c64xx_spi_driver_data *sdd,
384 struct spi_device *spi)
386 struct s3c64xx_spi_csinfo *cs;
388 if (sdd->tgl_spi != NULL) { /* If last device toggled after mssg */
389 if (sdd->tgl_spi != spi) { /* if last mssg on diff device */
390 /* Deselect the last toggled device */
391 cs = sdd->tgl_spi->controller_data;
392 cs->set_level(cs->line,
393 spi->mode & SPI_CS_HIGH ? 0 : 1);
398 cs = spi->controller_data;
399 cs->set_level(cs->line, spi->mode & SPI_CS_HIGH ? 1 : 0);
402 static int wait_for_xfer(struct s3c64xx_spi_driver_data *sdd,
403 struct spi_transfer *xfer, int dma_mode)
405 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
406 void __iomem *regs = sdd->regs;
410 /* millisecs to xfer 'len' bytes @ 'cur_speed' */
411 ms = xfer->len * 8 * 1000 / sdd->cur_speed;
412 ms += 10; /* some tolerance */
415 val = msecs_to_jiffies(ms) + 10;
416 val = wait_for_completion_timeout(&sdd->xfer_completion, val);
419 val = msecs_to_loops(ms);
421 status = readl(regs + S3C64XX_SPI_STATUS);
422 } while (RX_FIFO_LVL(status, sci) < xfer->len && --val);
432 * DmaTx returns after simply writing data in the FIFO,
433 * w/o waiting for real transmission on the bus to finish.
434 * DmaRx returns only after Dma read data from FIFO which
435 * needs bus transmission to finish, so we don't worry if
436 * Xfer involved Rx(with or without Tx).
438 if (xfer->rx_buf == NULL) {
439 val = msecs_to_loops(10);
440 status = readl(regs + S3C64XX_SPI_STATUS);
441 while ((TX_FIFO_LVL(status, sci)
442 || !S3C64XX_SPI_ST_TX_DONE(status, sci))
445 status = readl(regs + S3C64XX_SPI_STATUS);
452 /* If it was only Tx */
453 if (xfer->rx_buf == NULL) {
454 sdd->state &= ~TXBUSY;
458 switch (sdd->cur_bpw) {
460 ioread32_rep(regs + S3C64XX_SPI_RX_DATA,
461 xfer->rx_buf, xfer->len / 4);
464 ioread16_rep(regs + S3C64XX_SPI_RX_DATA,
465 xfer->rx_buf, xfer->len / 2);
468 ioread8_rep(regs + S3C64XX_SPI_RX_DATA,
469 xfer->rx_buf, xfer->len);
472 sdd->state &= ~RXBUSY;
478 static inline void disable_cs(struct s3c64xx_spi_driver_data *sdd,
479 struct spi_device *spi)
481 struct s3c64xx_spi_csinfo *cs = spi->controller_data;
483 if (sdd->tgl_spi == spi)
486 cs->set_level(cs->line, spi->mode & SPI_CS_HIGH ? 0 : 1);
489 static void s3c64xx_spi_config(struct s3c64xx_spi_driver_data *sdd)
491 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
492 void __iomem *regs = sdd->regs;
496 if (sci->clk_from_cmu) {
497 clk_disable(sdd->src_clk);
499 val = readl(regs + S3C64XX_SPI_CLK_CFG);
500 val &= ~S3C64XX_SPI_ENCLK_ENABLE;
501 writel(val, regs + S3C64XX_SPI_CLK_CFG);
504 /* Set Polarity and Phase */
505 val = readl(regs + S3C64XX_SPI_CH_CFG);
506 val &= ~(S3C64XX_SPI_CH_SLAVE |
510 if (sdd->cur_mode & SPI_CPOL)
511 val |= S3C64XX_SPI_CPOL_L;
513 if (sdd->cur_mode & SPI_CPHA)
514 val |= S3C64XX_SPI_CPHA_B;
516 writel(val, regs + S3C64XX_SPI_CH_CFG);
518 /* Set Channel & DMA Mode */
519 val = readl(regs + S3C64XX_SPI_MODE_CFG);
520 val &= ~(S3C64XX_SPI_MODE_BUS_TSZ_MASK
521 | S3C64XX_SPI_MODE_CH_TSZ_MASK);
523 switch (sdd->cur_bpw) {
525 val |= S3C64XX_SPI_MODE_BUS_TSZ_WORD;
526 val |= S3C64XX_SPI_MODE_CH_TSZ_WORD;
529 val |= S3C64XX_SPI_MODE_BUS_TSZ_HALFWORD;
530 val |= S3C64XX_SPI_MODE_CH_TSZ_HALFWORD;
533 val |= S3C64XX_SPI_MODE_BUS_TSZ_BYTE;
534 val |= S3C64XX_SPI_MODE_CH_TSZ_BYTE;
538 writel(val, regs + S3C64XX_SPI_MODE_CFG);
540 if (sci->clk_from_cmu) {
541 /* Configure Clock */
542 /* There is half-multiplier before the SPI */
543 clk_set_rate(sdd->src_clk, sdd->cur_speed * 2);
545 clk_enable(sdd->src_clk);
547 /* Configure Clock */
548 val = readl(regs + S3C64XX_SPI_CLK_CFG);
549 val &= ~S3C64XX_SPI_PSR_MASK;
550 val |= ((clk_get_rate(sdd->src_clk) / sdd->cur_speed / 2 - 1)
551 & S3C64XX_SPI_PSR_MASK);
552 writel(val, regs + S3C64XX_SPI_CLK_CFG);
555 val = readl(regs + S3C64XX_SPI_CLK_CFG);
556 val |= S3C64XX_SPI_ENCLK_ENABLE;
557 writel(val, regs + S3C64XX_SPI_CLK_CFG);
561 #define XFER_DMAADDR_INVALID DMA_BIT_MASK(32)
563 static int s3c64xx_spi_map_mssg(struct s3c64xx_spi_driver_data *sdd,
564 struct spi_message *msg)
566 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
567 struct device *dev = &sdd->pdev->dev;
568 struct spi_transfer *xfer;
570 if (msg->is_dma_mapped)
573 /* First mark all xfer unmapped */
574 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
575 xfer->rx_dma = XFER_DMAADDR_INVALID;
576 xfer->tx_dma = XFER_DMAADDR_INVALID;
579 /* Map until end or first fail */
580 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
582 if (xfer->len <= ((sci->fifo_lvl_mask >> 1) + 1))
585 if (xfer->tx_buf != NULL) {
586 xfer->tx_dma = dma_map_single(dev,
587 (void *)xfer->tx_buf, xfer->len,
589 if (dma_mapping_error(dev, xfer->tx_dma)) {
590 dev_err(dev, "dma_map_single Tx failed\n");
591 xfer->tx_dma = XFER_DMAADDR_INVALID;
596 if (xfer->rx_buf != NULL) {
597 xfer->rx_dma = dma_map_single(dev, xfer->rx_buf,
598 xfer->len, DMA_FROM_DEVICE);
599 if (dma_mapping_error(dev, xfer->rx_dma)) {
600 dev_err(dev, "dma_map_single Rx failed\n");
601 dma_unmap_single(dev, xfer->tx_dma,
602 xfer->len, DMA_TO_DEVICE);
603 xfer->tx_dma = XFER_DMAADDR_INVALID;
604 xfer->rx_dma = XFER_DMAADDR_INVALID;
613 static void s3c64xx_spi_unmap_mssg(struct s3c64xx_spi_driver_data *sdd,
614 struct spi_message *msg)
616 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
617 struct device *dev = &sdd->pdev->dev;
618 struct spi_transfer *xfer;
620 if (msg->is_dma_mapped)
623 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
625 if (xfer->len <= ((sci->fifo_lvl_mask >> 1) + 1))
628 if (xfer->rx_buf != NULL
629 && xfer->rx_dma != XFER_DMAADDR_INVALID)
630 dma_unmap_single(dev, xfer->rx_dma,
631 xfer->len, DMA_FROM_DEVICE);
633 if (xfer->tx_buf != NULL
634 && xfer->tx_dma != XFER_DMAADDR_INVALID)
635 dma_unmap_single(dev, xfer->tx_dma,
636 xfer->len, DMA_TO_DEVICE);
640 static void handle_msg(struct s3c64xx_spi_driver_data *sdd,
641 struct spi_message *msg)
643 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
644 struct spi_device *spi = msg->spi;
645 struct s3c64xx_spi_csinfo *cs = spi->controller_data;
646 struct spi_transfer *xfer;
647 int status = 0, cs_toggle = 0;
651 /* If Master's(controller) state differs from that needed by Slave */
652 if (sdd->cur_speed != spi->max_speed_hz
653 || sdd->cur_mode != spi->mode
654 || sdd->cur_bpw != spi->bits_per_word) {
655 sdd->cur_bpw = spi->bits_per_word;
656 sdd->cur_speed = spi->max_speed_hz;
657 sdd->cur_mode = spi->mode;
658 s3c64xx_spi_config(sdd);
661 /* Map all the transfers if needed */
662 if (s3c64xx_spi_map_mssg(sdd, msg)) {
664 "Xfer: Unable to map message buffers!\n");
669 /* Configure feedback delay */
670 writel(cs->fb_delay & 0x3, sdd->regs + S3C64XX_SPI_FB_CLK);
672 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
677 INIT_COMPLETION(sdd->xfer_completion);
679 /* Only BPW and Speed may change across transfers */
680 bpw = xfer->bits_per_word ? : spi->bits_per_word;
681 speed = xfer->speed_hz ? : spi->max_speed_hz;
683 if (xfer->len % (bpw / 8)) {
685 "Xfer length(%u) not a multiple of word size(%u)\n",
691 if (bpw != sdd->cur_bpw || speed != sdd->cur_speed) {
693 sdd->cur_speed = speed;
694 s3c64xx_spi_config(sdd);
697 /* Polling method for xfers not bigger than FIFO capacity */
698 if (xfer->len <= ((sci->fifo_lvl_mask >> 1) + 1))
703 spin_lock_irqsave(&sdd->lock, flags);
705 /* Pending only which is to be done */
706 sdd->state &= ~RXBUSY;
707 sdd->state &= ~TXBUSY;
709 enable_datapath(sdd, spi, xfer, use_dma);
714 /* Start the signals */
715 S3C64XX_SPI_ACT(sdd);
717 spin_unlock_irqrestore(&sdd->lock, flags);
719 status = wait_for_xfer(sdd, xfer, use_dma);
721 /* Quiese the signals */
722 S3C64XX_SPI_DEACT(sdd);
725 dev_err(&spi->dev, "I/O Error: "
726 "rx-%d tx-%d res:rx-%c tx-%c len-%d\n",
727 xfer->rx_buf ? 1 : 0, xfer->tx_buf ? 1 : 0,
728 (sdd->state & RXBUSY) ? 'f' : 'p',
729 (sdd->state & TXBUSY) ? 'f' : 'p',
733 if (xfer->tx_buf != NULL
734 && (sdd->state & TXBUSY))
735 sdd->ops->stop(sdd->tx_dma.ch);
736 if (xfer->rx_buf != NULL
737 && (sdd->state & RXBUSY))
738 sdd->ops->stop(sdd->rx_dma.ch);
744 if (xfer->delay_usecs)
745 udelay(xfer->delay_usecs);
747 if (xfer->cs_change) {
748 /* Hint that the next mssg is gonna be
749 for the same device */
750 if (list_is_last(&xfer->transfer_list,
754 disable_cs(sdd, spi);
757 msg->actual_length += xfer->len;
763 if (!cs_toggle || status)
764 disable_cs(sdd, spi);
768 s3c64xx_spi_unmap_mssg(sdd, msg);
770 msg->status = status;
773 msg->complete(msg->context);
776 static void s3c64xx_spi_work(struct work_struct *work)
778 struct s3c64xx_spi_driver_data *sdd = container_of(work,
779 struct s3c64xx_spi_driver_data, work);
782 /* Acquire DMA channels */
783 while (!acquire_dma(sdd))
786 pm_runtime_get_sync(&sdd->pdev->dev);
788 spin_lock_irqsave(&sdd->lock, flags);
790 while (!list_empty(&sdd->queue)
791 && !(sdd->state & SUSPND)) {
793 struct spi_message *msg;
795 msg = container_of(sdd->queue.next, struct spi_message, queue);
797 list_del_init(&msg->queue);
799 /* Set Xfer busy flag */
800 sdd->state |= SPIBUSY;
802 spin_unlock_irqrestore(&sdd->lock, flags);
804 handle_msg(sdd, msg);
806 spin_lock_irqsave(&sdd->lock, flags);
808 sdd->state &= ~SPIBUSY;
811 spin_unlock_irqrestore(&sdd->lock, flags);
813 /* Free DMA channels */
814 sdd->ops->release(sdd->rx_dma.ch, &s3c64xx_spi_dma_client);
815 sdd->ops->release(sdd->tx_dma.ch, &s3c64xx_spi_dma_client);
817 pm_runtime_put(&sdd->pdev->dev);
820 static int s3c64xx_spi_transfer(struct spi_device *spi,
821 struct spi_message *msg)
823 struct s3c64xx_spi_driver_data *sdd;
826 sdd = spi_master_get_devdata(spi->master);
828 spin_lock_irqsave(&sdd->lock, flags);
830 if (sdd->state & SUSPND) {
831 spin_unlock_irqrestore(&sdd->lock, flags);
835 msg->status = -EINPROGRESS;
836 msg->actual_length = 0;
838 list_add_tail(&msg->queue, &sdd->queue);
840 queue_work(sdd->workqueue, &sdd->work);
842 spin_unlock_irqrestore(&sdd->lock, flags);
848 * Here we only check the validity of requested configuration
849 * and save the configuration in a local data-structure.
850 * The controller is actually configured only just before we
851 * get a message to transfer.
853 static int s3c64xx_spi_setup(struct spi_device *spi)
855 struct s3c64xx_spi_csinfo *cs = spi->controller_data;
856 struct s3c64xx_spi_driver_data *sdd;
857 struct s3c64xx_spi_info *sci;
858 struct spi_message *msg;
862 if (cs == NULL || cs->set_level == NULL) {
863 dev_err(&spi->dev, "No CS for SPI(%d)\n", spi->chip_select);
867 sdd = spi_master_get_devdata(spi->master);
868 sci = sdd->cntrlr_info;
870 spin_lock_irqsave(&sdd->lock, flags);
872 list_for_each_entry(msg, &sdd->queue, queue) {
873 /* Is some mssg is already queued for this device */
874 if (msg->spi == spi) {
876 "setup: attempt while mssg in queue!\n");
877 spin_unlock_irqrestore(&sdd->lock, flags);
882 if (sdd->state & SUSPND) {
883 spin_unlock_irqrestore(&sdd->lock, flags);
885 "setup: SPI-%d not active!\n", spi->master->bus_num);
889 spin_unlock_irqrestore(&sdd->lock, flags);
891 if (spi->bits_per_word != 8
892 && spi->bits_per_word != 16
893 && spi->bits_per_word != 32) {
894 dev_err(&spi->dev, "setup: %dbits/wrd not supported!\n",
900 pm_runtime_get_sync(&sdd->pdev->dev);
902 /* Check if we can provide the requested rate */
903 if (!sci->clk_from_cmu) {
907 speed = clk_get_rate(sdd->src_clk) / 2 / (0 + 1);
909 if (spi->max_speed_hz > speed)
910 spi->max_speed_hz = speed;
912 psr = clk_get_rate(sdd->src_clk) / 2 / spi->max_speed_hz - 1;
913 psr &= S3C64XX_SPI_PSR_MASK;
914 if (psr == S3C64XX_SPI_PSR_MASK)
917 speed = clk_get_rate(sdd->src_clk) / 2 / (psr + 1);
918 if (spi->max_speed_hz < speed) {
919 if (psr+1 < S3C64XX_SPI_PSR_MASK) {
927 speed = clk_get_rate(sdd->src_clk) / 2 / (psr + 1);
928 if (spi->max_speed_hz >= speed)
929 spi->max_speed_hz = speed;
934 pm_runtime_put(&sdd->pdev->dev);
938 /* setup() returns with device de-selected */
939 disable_cs(sdd, spi);
944 static irqreturn_t s3c64xx_spi_irq(int irq, void *data)
946 struct s3c64xx_spi_driver_data *sdd = data;
947 struct spi_master *spi = sdd->master;
950 val = readl(sdd->regs + S3C64XX_SPI_PENDING_CLR);
952 val &= S3C64XX_SPI_PND_RX_OVERRUN_CLR |
953 S3C64XX_SPI_PND_RX_UNDERRUN_CLR |
954 S3C64XX_SPI_PND_TX_OVERRUN_CLR |
955 S3C64XX_SPI_PND_TX_UNDERRUN_CLR;
957 writel(val, sdd->regs + S3C64XX_SPI_PENDING_CLR);
959 if (val & S3C64XX_SPI_PND_RX_OVERRUN_CLR)
960 dev_err(&spi->dev, "RX overrun\n");
961 if (val & S3C64XX_SPI_PND_RX_UNDERRUN_CLR)
962 dev_err(&spi->dev, "RX underrun\n");
963 if (val & S3C64XX_SPI_PND_TX_OVERRUN_CLR)
964 dev_err(&spi->dev, "TX overrun\n");
965 if (val & S3C64XX_SPI_PND_TX_UNDERRUN_CLR)
966 dev_err(&spi->dev, "TX underrun\n");
971 static void s3c64xx_spi_hwinit(struct s3c64xx_spi_driver_data *sdd, int channel)
973 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
974 void __iomem *regs = sdd->regs;
979 S3C64XX_SPI_DEACT(sdd);
981 /* Disable Interrupts - we use Polling if not DMA mode */
982 writel(0, regs + S3C64XX_SPI_INT_EN);
984 if (!sci->clk_from_cmu)
985 writel(sci->src_clk_nr << S3C64XX_SPI_CLKSEL_SRCSHFT,
986 regs + S3C64XX_SPI_CLK_CFG);
987 writel(0, regs + S3C64XX_SPI_MODE_CFG);
988 writel(0, regs + S3C64XX_SPI_PACKET_CNT);
990 /* Clear any irq pending bits */
991 writel(readl(regs + S3C64XX_SPI_PENDING_CLR),
992 regs + S3C64XX_SPI_PENDING_CLR);
994 writel(0, regs + S3C64XX_SPI_SWAP_CFG);
996 val = readl(regs + S3C64XX_SPI_MODE_CFG);
997 val &= ~S3C64XX_SPI_MODE_4BURST;
998 val &= ~(S3C64XX_SPI_MAX_TRAILCNT << S3C64XX_SPI_TRAILCNT_OFF);
999 val |= (S3C64XX_SPI_TRAILCNT << S3C64XX_SPI_TRAILCNT_OFF);
1000 writel(val, regs + S3C64XX_SPI_MODE_CFG);
1005 static int __init s3c64xx_spi_probe(struct platform_device *pdev)
1007 struct resource *mem_res, *dmatx_res, *dmarx_res;
1008 struct s3c64xx_spi_driver_data *sdd;
1009 struct s3c64xx_spi_info *sci;
1010 struct spi_master *master;
1016 "Invalid platform device id-%d\n", pdev->id);
1020 if (pdev->dev.platform_data == NULL) {
1021 dev_err(&pdev->dev, "platform_data missing!\n");
1025 sci = pdev->dev.platform_data;
1027 /* Check for availability of necessary resource */
1029 dmatx_res = platform_get_resource(pdev, IORESOURCE_DMA, 0);
1030 if (dmatx_res == NULL) {
1031 dev_err(&pdev->dev, "Unable to get SPI-Tx dma resource\n");
1035 dmarx_res = platform_get_resource(pdev, IORESOURCE_DMA, 1);
1036 if (dmarx_res == NULL) {
1037 dev_err(&pdev->dev, "Unable to get SPI-Rx dma resource\n");
1041 mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1042 if (mem_res == NULL) {
1043 dev_err(&pdev->dev, "Unable to get SPI MEM resource\n");
1047 irq = platform_get_irq(pdev, 0);
1049 dev_warn(&pdev->dev, "Failed to get IRQ: %d\n", irq);
1053 master = spi_alloc_master(&pdev->dev,
1054 sizeof(struct s3c64xx_spi_driver_data));
1055 if (master == NULL) {
1056 dev_err(&pdev->dev, "Unable to allocate SPI Master\n");
1060 platform_set_drvdata(pdev, master);
1062 sdd = spi_master_get_devdata(master);
1063 sdd->master = master;
1064 sdd->cntrlr_info = sci;
1066 sdd->sfr_start = mem_res->start;
1067 sdd->tx_dma.dmach = dmatx_res->start;
1068 sdd->tx_dma.direction = DMA_TO_DEVICE;
1069 sdd->rx_dma.dmach = dmarx_res->start;
1070 sdd->rx_dma.direction = DMA_FROM_DEVICE;
1074 master->bus_num = pdev->id;
1075 master->setup = s3c64xx_spi_setup;
1076 master->transfer = s3c64xx_spi_transfer;
1077 master->num_chipselect = sci->num_cs;
1078 master->dma_alignment = 8;
1079 /* the spi->mode bits understood by this driver: */
1080 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
1082 if (request_mem_region(mem_res->start,
1083 resource_size(mem_res), pdev->name) == NULL) {
1084 dev_err(&pdev->dev, "Req mem region failed\n");
1089 sdd->regs = ioremap(mem_res->start, resource_size(mem_res));
1090 if (sdd->regs == NULL) {
1091 dev_err(&pdev->dev, "Unable to remap IO\n");
1096 if (sci->cfg_gpio == NULL || sci->cfg_gpio(pdev)) {
1097 dev_err(&pdev->dev, "Unable to config gpio\n");
1103 sdd->clk = clk_get(&pdev->dev, "spi");
1104 if (IS_ERR(sdd->clk)) {
1105 dev_err(&pdev->dev, "Unable to acquire clock 'spi'\n");
1106 ret = PTR_ERR(sdd->clk);
1110 if (clk_enable(sdd->clk)) {
1111 dev_err(&pdev->dev, "Couldn't enable clock 'spi'\n");
1116 sprintf(clk_name, "spi_busclk%d", sci->src_clk_nr);
1117 sdd->src_clk = clk_get(&pdev->dev, clk_name);
1118 if (IS_ERR(sdd->src_clk)) {
1120 "Unable to acquire clock '%s'\n", clk_name);
1121 ret = PTR_ERR(sdd->src_clk);
1125 if (clk_enable(sdd->src_clk)) {
1126 dev_err(&pdev->dev, "Couldn't enable clock '%s'\n", clk_name);
1131 sdd->workqueue = create_singlethread_workqueue(
1132 dev_name(master->dev.parent));
1133 if (sdd->workqueue == NULL) {
1134 dev_err(&pdev->dev, "Unable to create workqueue\n");
1139 /* Setup Deufult Mode */
1140 s3c64xx_spi_hwinit(sdd, pdev->id);
1142 spin_lock_init(&sdd->lock);
1143 init_completion(&sdd->xfer_completion);
1144 INIT_WORK(&sdd->work, s3c64xx_spi_work);
1145 INIT_LIST_HEAD(&sdd->queue);
1147 ret = request_irq(irq, s3c64xx_spi_irq, 0, "spi-s3c64xx", sdd);
1149 dev_err(&pdev->dev, "Failed to request IRQ %d: %d\n",
1154 writel(S3C64XX_SPI_INT_RX_OVERRUN_EN | S3C64XX_SPI_INT_RX_UNDERRUN_EN |
1155 S3C64XX_SPI_INT_TX_OVERRUN_EN | S3C64XX_SPI_INT_TX_UNDERRUN_EN,
1156 sdd->regs + S3C64XX_SPI_INT_EN);
1158 if (spi_register_master(master)) {
1159 dev_err(&pdev->dev, "cannot register SPI master\n");
1164 dev_dbg(&pdev->dev, "Samsung SoC SPI Driver loaded for Bus SPI-%d "
1165 "with %d Slaves attached\n",
1166 pdev->id, master->num_chipselect);
1167 dev_dbg(&pdev->dev, "\tIOmem=[0x%x-0x%x]\tDMA=[Rx-%d, Tx-%d]\n",
1168 mem_res->end, mem_res->start,
1169 sdd->rx_dma.dmach, sdd->tx_dma.dmach);
1171 pm_runtime_enable(&pdev->dev);
1178 destroy_workqueue(sdd->workqueue);
1180 clk_disable(sdd->src_clk);
1182 clk_put(sdd->src_clk);
1184 clk_disable(sdd->clk);
1189 iounmap((void *) sdd->regs);
1191 release_mem_region(mem_res->start, resource_size(mem_res));
1193 platform_set_drvdata(pdev, NULL);
1194 spi_master_put(master);
1199 static int s3c64xx_spi_remove(struct platform_device *pdev)
1201 struct spi_master *master = spi_master_get(platform_get_drvdata(pdev));
1202 struct s3c64xx_spi_driver_data *sdd = spi_master_get_devdata(master);
1203 struct resource *mem_res;
1204 unsigned long flags;
1206 pm_runtime_disable(&pdev->dev);
1208 spin_lock_irqsave(&sdd->lock, flags);
1209 sdd->state |= SUSPND;
1210 spin_unlock_irqrestore(&sdd->lock, flags);
1212 while (sdd->state & SPIBUSY)
1215 spi_unregister_master(master);
1217 writel(0, sdd->regs + S3C64XX_SPI_INT_EN);
1219 free_irq(platform_get_irq(pdev, 0), sdd);
1221 destroy_workqueue(sdd->workqueue);
1223 clk_disable(sdd->src_clk);
1224 clk_put(sdd->src_clk);
1226 clk_disable(sdd->clk);
1229 iounmap((void *) sdd->regs);
1231 mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1232 if (mem_res != NULL)
1233 release_mem_region(mem_res->start, resource_size(mem_res));
1235 platform_set_drvdata(pdev, NULL);
1236 spi_master_put(master);
1242 static int s3c64xx_spi_suspend(struct device *dev)
1244 struct spi_master *master = spi_master_get(dev_get_drvdata(dev));
1245 struct s3c64xx_spi_driver_data *sdd = spi_master_get_devdata(master);
1246 unsigned long flags;
1248 spin_lock_irqsave(&sdd->lock, flags);
1249 sdd->state |= SUSPND;
1250 spin_unlock_irqrestore(&sdd->lock, flags);
1252 while (sdd->state & SPIBUSY)
1255 /* Disable the clock */
1256 clk_disable(sdd->src_clk);
1257 clk_disable(sdd->clk);
1259 sdd->cur_speed = 0; /* Output Clock is stopped */
1264 static int s3c64xx_spi_resume(struct device *dev)
1266 struct platform_device *pdev = to_platform_device(dev);
1267 struct spi_master *master = spi_master_get(dev_get_drvdata(dev));
1268 struct s3c64xx_spi_driver_data *sdd = spi_master_get_devdata(master);
1269 struct s3c64xx_spi_info *sci = sdd->cntrlr_info;
1270 unsigned long flags;
1272 sci->cfg_gpio(pdev);
1274 /* Enable the clock */
1275 clk_enable(sdd->src_clk);
1276 clk_enable(sdd->clk);
1278 s3c64xx_spi_hwinit(sdd, pdev->id);
1280 spin_lock_irqsave(&sdd->lock, flags);
1281 sdd->state &= ~SUSPND;
1282 spin_unlock_irqrestore(&sdd->lock, flags);
1286 #endif /* CONFIG_PM */
1288 #ifdef CONFIG_PM_RUNTIME
1289 static int s3c64xx_spi_runtime_suspend(struct device *dev)
1291 struct spi_master *master = spi_master_get(dev_get_drvdata(dev));
1292 struct s3c64xx_spi_driver_data *sdd = spi_master_get_devdata(master);
1294 clk_disable(sdd->clk);
1295 clk_disable(sdd->src_clk);
1300 static int s3c64xx_spi_runtime_resume(struct device *dev)
1302 struct spi_master *master = spi_master_get(dev_get_drvdata(dev));
1303 struct s3c64xx_spi_driver_data *sdd = spi_master_get_devdata(master);
1305 clk_enable(sdd->src_clk);
1306 clk_enable(sdd->clk);
1310 #endif /* CONFIG_PM_RUNTIME */
1312 static const struct dev_pm_ops s3c64xx_spi_pm = {
1313 SET_SYSTEM_SLEEP_PM_OPS(s3c64xx_spi_suspend, s3c64xx_spi_resume)
1314 SET_RUNTIME_PM_OPS(s3c64xx_spi_runtime_suspend,
1315 s3c64xx_spi_runtime_resume, NULL)
1318 static struct platform_driver s3c64xx_spi_driver = {
1320 .name = "s3c64xx-spi",
1321 .owner = THIS_MODULE,
1322 .pm = &s3c64xx_spi_pm,
1324 .remove = s3c64xx_spi_remove,
1326 MODULE_ALIAS("platform:s3c64xx-spi");
1328 static int __init s3c64xx_spi_init(void)
1330 return platform_driver_probe(&s3c64xx_spi_driver, s3c64xx_spi_probe);
1332 subsys_initcall(s3c64xx_spi_init);
1334 static void __exit s3c64xx_spi_exit(void)
1336 platform_driver_unregister(&s3c64xx_spi_driver);
1338 module_exit(s3c64xx_spi_exit);
1340 MODULE_AUTHOR("Jaswinder Singh <jassi.brar@samsung.com>");
1341 MODULE_DESCRIPTION("S3C64XX SPI Controller Driver");
1342 MODULE_LICENSE("GPL");