kernel/drivers/spi/spi-sh-msiof.c

   1 /*
   2  * SuperH MSIOF SPI Master Interface
   3  *
   4  * Copyright (c) 2009 Magnus Damm
   5  * Copyright (C) 2014 Glider bvba
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  *
  11  */
  12
  13 #include <linux/bitmap.h>
  14 #include <linux/clk.h>
  15 #include <linux/completion.h>
  16 #include <linux/delay.h>
  17 #include <linux/dma-mapping.h>
  18 #include <linux/dmaengine.h>
  19 #include <linux/err.h>
  20 #include <linux/gpio.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/io.h>
  23 #include <linux/kernel.h>
  24 #include <linux/module.h>
  25 #include <linux/of.h>
  26 #include <linux/of_device.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/pm_runtime.h>
  29 #include <linux/sh_dma.h>
  30
  31 #include <linux/spi/sh_msiof.h>
  32 #include <linux/spi/spi.h>
  33
  34 #include <asm/unaligned.h>
  35
  36
  37 struct sh_msiof_chipdata {
  38         u16 tx_fifo_size;
  39         u16 rx_fifo_size;
  40         u16 master_flags;
  41 };
  42
  43 struct sh_msiof_spi_priv {
  44         struct spi_master *master;
  45         void __iomem *mapbase;
  46         struct clk *clk;
  47         struct platform_device *pdev;
  48         const struct sh_msiof_chipdata *chipdata;
  49         struct sh_msiof_spi_info *info;
  50         struct completion done;
  51         unsigned int tx_fifo_size;
  52         unsigned int rx_fifo_size;
  53         void *tx_dma_page;
  54         void *rx_dma_page;
  55         dma_addr_t tx_dma_addr;
  56         dma_addr_t rx_dma_addr;
  57 };
  58
  59 #define TMDR1   0x00    /* Transmit Mode Register 1 */
  60 #define TMDR2   0x04    /* Transmit Mode Register 2 */
  61 #define TMDR3   0x08    /* Transmit Mode Register 3 */
  62 #define RMDR1   0x10    /* Receive Mode Register 1 */
  63 #define RMDR2   0x14    /* Receive Mode Register 2 */
  64 #define RMDR3   0x18    /* Receive Mode Register 3 */
  65 #define TSCR    0x20    /* Transmit Clock Select Register */
  66 #define RSCR    0x22    /* Receive Clock Select Register (SH, A1, APE6) */
  67 #define CTR     0x28    /* Control Register */
  68 #define FCTR    0x30    /* FIFO Control Register */
  69 #define STR     0x40    /* Status Register */
  70 #define IER     0x44    /* Interrupt Enable Register */
  71 #define TDR1    0x48    /* Transmit Control Data Register 1 (SH, A1) */
  72 #define TDR2    0x4c    /* Transmit Control Data Register 2 (SH, A1) */
  73 #define TFDR    0x50    /* Transmit FIFO Data Register */
  74 #define RDR1    0x58    /* Receive Control Data Register 1 (SH, A1) */
  75 #define RDR2    0x5c    /* Receive Control Data Register 2 (SH, A1) */
  76 #define RFDR    0x60    /* Receive FIFO Data Register */
  77
  78 /* TMDR1 and RMDR1 */
  79 #define MDR1_TRMD        0x80000000 /* Transfer Mode (1 = Master mode) */
  80 #define MDR1_SYNCMD_MASK 0x30000000 /* SYNC Mode */
  81 #define MDR1_SYNCMD_SPI  0x20000000 /*   Level mode/SPI */
  82 #define MDR1_SYNCMD_LR   0x30000000 /*   L/R mode */
  83 #define MDR1_SYNCAC_SHIFT        25 /* Sync Polarity (1 = Active-low) */
  84 #define MDR1_BITLSB_SHIFT        24 /* MSB/LSB First (1 = LSB first) */
  85 #define MDR1_DTDL_SHIFT          20 /* Data Pin Bit Delay for MSIOF_SYNC */
  86 #define MDR1_SYNCDL_SHIFT        16 /* Frame Sync Signal Timing Delay */
  87 #define MDR1_FLD_MASK    0x0000000c /* Frame Sync Signal Interval (0-3) */
  88 #define MDR1_FLD_SHIFT            2
  89 #define MDR1_XXSTP       0x00000001 /* Transmission/Reception Stop on FIFO */
  90 /* TMDR1 */
  91 #define TMDR1_PCON       0x40000000 /* Transfer Signal Connection */
  92
  93 /* TMDR2 and RMDR2 */
  94 #define MDR2_BITLEN1(i) (((i) - 1) << 24) /* Data Size (8-32 bits) */
  95 #define MDR2_WDLEN1(i)  (((i) - 1) << 16) /* Word Count (1-64/256 (SH, A1))) */
  96 #define MDR2_GRPMASK1   0x00000001 /* Group Output Mask 1 (SH, A1) */
  97
  98 /* TSCR and RSCR */
  99 #define SCR_BRPS_MASK       0x1f00 /* Prescaler Setting (1-32) */
 100 #define SCR_BRPS(i)     (((i) - 1) << 8)
 101 #define SCR_BRDV_MASK       0x0007 /* Baud Rate Generator's Division Ratio */
 102 #define SCR_BRDV_DIV_2      0x0000
 103 #define SCR_BRDV_DIV_4      0x0001
 104 #define SCR_BRDV_DIV_8      0x0002
 105 #define SCR_BRDV_DIV_16     0x0003
 106 #define SCR_BRDV_DIV_32     0x0004
 107 #define SCR_BRDV_DIV_1      0x0007
 108
 109 /* CTR */
 110 #define CTR_TSCKIZ_MASK 0xc0000000 /* Transmit Clock I/O Polarity Select */
 111 #define CTR_TSCKIZ_SCK  0x80000000 /*   Disable SCK when TX disabled */
 112 #define CTR_TSCKIZ_POL_SHIFT    30 /*   Transmit Clock Polarity */
 113 #define CTR_RSCKIZ_MASK 0x30000000 /* Receive Clock Polarity Select */
 114 #define CTR_RSCKIZ_SCK  0x20000000 /*   Must match CTR_TSCKIZ_SCK */
 115 #define CTR_RSCKIZ_POL_SHIFT    28 /*   Receive Clock Polarity */
 116 #define CTR_TEDG_SHIFT          27 /* Transmit Timing (1 = falling edge) */
 117 #define CTR_REDG_SHIFT          26 /* Receive Timing (1 = falling edge) */
 118 #define CTR_TXDIZ_MASK  0x00c00000 /* Pin Output When TX is Disabled */
 119 #define CTR_TXDIZ_LOW   0x00000000 /*   0 */
 120 #define CTR_TXDIZ_HIGH  0x00400000 /*   1 */
 121 #define CTR_TXDIZ_HIZ   0x00800000 /*   High-impedance */
 122 #define CTR_TSCKE       0x00008000 /* Transmit Serial Clock Output Enable */
 123 #define CTR_TFSE        0x00004000 /* Transmit Frame Sync Signal Output Enable */
 124 #define CTR_TXE         0x00000200 /* Transmit Enable */
 125 #define CTR_RXE         0x00000100 /* Receive Enable */
 126
 127 /* FCTR */
 128 #define FCTR_TFWM_MASK  0xe0000000 /* Transmit FIFO Watermark */
 129 #define FCTR_TFWM_64    0x00000000 /*  Transfer Request when 64 empty stages */
 130 #define FCTR_TFWM_32    0x20000000 /*  Transfer Request when 32 empty stages */
 131 #define FCTR_TFWM_24    0x40000000 /*  Transfer Request when 24 empty stages */
 132 #define FCTR_TFWM_16    0x60000000 /*  Transfer Request when 16 empty stages */
 133 #define FCTR_TFWM_12    0x80000000 /*  Transfer Request when 12 empty stages */
 134 #define FCTR_TFWM_8     0xa0000000 /*  Transfer Request when 8 empty stages */
 135 #define FCTR_TFWM_4     0xc0000000 /*  Transfer Request when 4 empty stages */
 136 #define FCTR_TFWM_1     0xe0000000 /*  Transfer Request when 1 empty stage */
 137 #define FCTR_TFUA_MASK  0x07f00000 /* Transmit FIFO Usable Area */
 138 #define FCTR_TFUA_SHIFT         20
 139 #define FCTR_TFUA(i)    ((i) << FCTR_TFUA_SHIFT)
 140 #define FCTR_RFWM_MASK  0x0000e000 /* Receive FIFO Watermark */
 141 #define FCTR_RFWM_1     0x00000000 /*  Transfer Request when 1 valid stages */
 142 #define FCTR_RFWM_4     0x00002000 /*  Transfer Request when 4 valid stages */
 143 #define FCTR_RFWM_8     0x00004000 /*  Transfer Request when 8 valid stages */
 144 #define FCTR_RFWM_16    0x00006000 /*  Transfer Request when 16 valid stages */
 145 #define FCTR_RFWM_32    0x00008000 /*  Transfer Request when 32 valid stages */
 146 #define FCTR_RFWM_64    0x0000a000 /*  Transfer Request when 64 valid stages */
 147 #define FCTR_RFWM_128   0x0000c000 /*  Transfer Request when 128 valid stages */
 148 #define FCTR_RFWM_256   0x0000e000 /*  Transfer Request when 256 valid stages */
 149 #define FCTR_RFUA_MASK  0x00001ff0 /* Receive FIFO Usable Area (0x40 = full) */
 150 #define FCTR_RFUA_SHIFT          4
 151 #define FCTR_RFUA(i)    ((i) << FCTR_RFUA_SHIFT)
 152
 153 /* STR */
 154 #define STR_TFEMP       0x20000000 /* Transmit FIFO Empty */
 155 #define STR_TDREQ       0x10000000 /* Transmit Data Transfer Request */
 156 #define STR_TEOF        0x00800000 /* Frame Transmission End */
 157 #define STR_TFSERR      0x00200000 /* Transmit Frame Synchronization Error */
 158 #define STR_TFOVF       0x00100000 /* Transmit FIFO Overflow */
 159 #define STR_TFUDF       0x00080000 /* Transmit FIFO Underflow */
 160 #define STR_RFFUL       0x00002000 /* Receive FIFO Full */
 161 #define STR_RDREQ       0x00001000 /* Receive Data Transfer Request */
 162 #define STR_REOF        0x00000080 /* Frame Reception End */
 163 #define STR_RFSERR      0x00000020 /* Receive Frame Synchronization Error */
 164 #define STR_RFUDF       0x00000010 /* Receive FIFO Underflow */
 165 #define STR_RFOVF       0x00000008 /* Receive FIFO Overflow */
 166
 167 /* IER */
 168 #define IER_TDMAE       0x80000000 /* Transmit Data DMA Transfer Req. Enable */
 169 #define IER_TFEMPE      0x20000000 /* Transmit FIFO Empty Enable */
 170 #define IER_TDREQE      0x10000000 /* Transmit Data Transfer Request Enable */
 171 #define IER_TEOFE       0x00800000 /* Frame Transmission End Enable */
 172 #define IER_TFSERRE     0x00200000 /* Transmit Frame Sync Error Enable */
 173 #define IER_TFOVFE      0x00100000 /* Transmit FIFO Overflow Enable */
 174 #define IER_TFUDFE      0x00080000 /* Transmit FIFO Underflow Enable */
 175 #define IER_RDMAE       0x00008000 /* Receive Data DMA Transfer Req. Enable */
 176 #define IER_RFFULE      0x00002000 /* Receive FIFO Full Enable */
 177 #define IER_RDREQE      0x00001000 /* Receive Data Transfer Request Enable */
 178 #define IER_REOFE       0x00000080 /* Frame Reception End Enable */
 179 #define IER_RFSERRE     0x00000020 /* Receive Frame Sync Error Enable */
 180 #define IER_RFUDFE      0x00000010 /* Receive FIFO Underflow Enable */
 181 #define IER_RFOVFE      0x00000008 /* Receive FIFO Overflow Enable */
 182
 183
 184 static u32 sh_msiof_read(struct sh_msiof_spi_priv *p, int reg_offs)
 185 {
 186         switch (reg_offs) {
 187         case TSCR:
 188         case RSCR:
 189                 return ioread16(p->mapbase + reg_offs);
 190         default:
 191                 return ioread32(p->mapbase + reg_offs);
 192         }
 193 }
 194
 195 static void sh_msiof_write(struct sh_msiof_spi_priv *p, int reg_offs,
 196                            u32 value)
 197 {
 198         switch (reg_offs) {
 199         case TSCR:
 200         case RSCR:
 201                 iowrite16(value, p->mapbase + reg_offs);
 202                 break;
 203         default:
 204                 iowrite32(value, p->mapbase + reg_offs);
 205                 break;
 206         }
 207 }
 208
 209 static int sh_msiof_modify_ctr_wait(struct sh_msiof_spi_priv *p,
 210                                     u32 clr, u32 set)
 211 {
 212         u32 mask = clr | set;
 213         u32 data;
 214         int k;
 215
 216         data = sh_msiof_read(p, CTR);
 217         data &= ~clr;
 218         data |= set;
 219         sh_msiof_write(p, CTR, data);
 220
 221         for (k = 100; k > 0; k--) {
 222                 if ((sh_msiof_read(p, CTR) & mask) == set)
 223                         break;
 224
 225                 udelay(10);
 226         }
 227
 228         return k > 0 ? 0 : -ETIMEDOUT;
 229 }
 230
 231 static irqreturn_t sh_msiof_spi_irq(int irq, void *data)
 232 {
 233         struct sh_msiof_spi_priv *p = data;
 234
 235         /* just disable the interrupt and wake up */
 236         sh_msiof_write(p, IER, 0);
 237         complete(&p->done);
 238
 239         return IRQ_HANDLED;
 240 }
 241
 242 static struct {
 243         unsigned short div;
 244         unsigned short brdv;
 245 } const sh_msiof_spi_div_table[] = {
 246         { 1,    SCR_BRDV_DIV_1 },
 247         { 2,    SCR_BRDV_DIV_2 },
 248         { 4,    SCR_BRDV_DIV_4 },
 249         { 8,    SCR_BRDV_DIV_8 },
 250         { 16,   SCR_BRDV_DIV_16 },
 251         { 32,   SCR_BRDV_DIV_32 },
 252 };
 253
 254 static void sh_msiof_spi_set_clk_regs(struct sh_msiof_spi_priv *p,
 255                                       unsigned long parent_rate, u32 spi_hz)
 256 {
 257         unsigned long div = 1024;
 258         u32 brps, scr;
 259         size_t k;
 260
 261         if (!WARN_ON(!spi_hz || !parent_rate))
 262                 div = DIV_ROUND_UP(parent_rate, spi_hz);
 263
 264         for (k = 0; k < ARRAY_SIZE(sh_msiof_spi_div_table); k++) {
 265                 brps = DIV_ROUND_UP(div, sh_msiof_spi_div_table[k].div);
 266                 /* SCR_BRDV_DIV_1 is valid only if BRPS is x 1/1 or x 1/2 */
 267                 if (sh_msiof_spi_div_table[k].div == 1 && brps > 2)
 268                         continue;
 269                 if (brps <= 32) /* max of brdv is 32 */
 270                         break;
 271         }
 272
 273         k = min_t(int, k, ARRAY_SIZE(sh_msiof_spi_div_table) - 1);
 274
 275         scr = sh_msiof_spi_div_table[k].brdv | SCR_BRPS(brps);
 276         sh_msiof_write(p, TSCR, scr);
 277         if (!(p->chipdata->master_flags & SPI_MASTER_MUST_TX))
 278                 sh_msiof_write(p, RSCR, scr);
 279 }
 280
 281 static u32 sh_msiof_get_delay_bit(u32 dtdl_or_syncdl)
 282 {
 283         /*
 284          * DTDL/SYNCDL bit      : p->info->dtdl or p->info->syncdl
 285          * b'000                : 0
 286          * b'001                : 100
 287          * b'010                : 200
 288          * b'011 (SYNCDL only)  : 300
 289          * b'101                : 50
 290          * b'110                : 150
 291          */
 292         if (dtdl_or_syncdl % 100)
 293                 return dtdl_or_syncdl / 100 + 5;
 294         else
 295                 return dtdl_or_syncdl / 100;
 296 }
 297
 298 static u32 sh_msiof_spi_get_dtdl_and_syncdl(struct sh_msiof_spi_priv *p)
 299 {
 300         u32 val;
 301
 302         if (!p->info)
 303                 return 0;
 304
 305         /* check if DTDL and SYNCDL is allowed value */
 306         if (p->info->dtdl > 200 || p->info->syncdl > 300) {
 307                 dev_warn(&p->pdev->dev, "DTDL or SYNCDL is too large\n");
 308                 return 0;
 309         }
 310
 311         /* check if the sum of DTDL and SYNCDL becomes an integer value  */
 312         if ((p->info->dtdl + p->info->syncdl) % 100) {
 313                 dev_warn(&p->pdev->dev, "the sum of DTDL/SYNCDL is not good\n");
 314                 return 0;
 315         }
 316
 317         val = sh_msiof_get_delay_bit(p->info->dtdl) << MDR1_DTDL_SHIFT;
 318         val |= sh_msiof_get_delay_bit(p->info->syncdl) << MDR1_SYNCDL_SHIFT;
 319
 320         return val;
 321 }
 322
 323 static void sh_msiof_spi_set_pin_regs(struct sh_msiof_spi_priv *p,
 324                                       u32 cpol, u32 cpha,
 325                                       u32 tx_hi_z, u32 lsb_first, u32 cs_high)
 326 {
 327         u32 tmp;
 328         int edge;
 329
 330         /*
 331          * CPOL CPHA     TSCKIZ RSCKIZ TEDG REDG
 332          *    0    0         10     10    1    1
 333          *    0    1         10     10    0    0
 334          *    1    0         11     11    0    0
 335          *    1    1         11     11    1    1
 336          */
 337         tmp = MDR1_SYNCMD_SPI | 1 << MDR1_FLD_SHIFT | MDR1_XXSTP;
 338         tmp |= !cs_high << MDR1_SYNCAC_SHIFT;
 339         tmp |= lsb_first << MDR1_BITLSB_SHIFT;
 340         tmp |= sh_msiof_spi_get_dtdl_and_syncdl(p);
 341         sh_msiof_write(p, TMDR1, tmp | MDR1_TRMD | TMDR1_PCON);
 342         if (p->chipdata->master_flags & SPI_MASTER_MUST_TX) {
 343                 /* These bits are reserved if RX needs TX */
 344                 tmp &= ~0x0000ffff;
 345         }
 346         sh_msiof_write(p, RMDR1, tmp);
 347
 348         tmp = 0;
 349         tmp |= CTR_TSCKIZ_SCK | cpol << CTR_TSCKIZ_POL_SHIFT;
 350         tmp |= CTR_RSCKIZ_SCK | cpol << CTR_RSCKIZ_POL_SHIFT;
 351
 352         edge = cpol ^ !cpha;
 353
 354         tmp |= edge << CTR_TEDG_SHIFT;
 355         tmp |= edge << CTR_REDG_SHIFT;
 356         tmp |= tx_hi_z ? CTR_TXDIZ_HIZ : CTR_TXDIZ_LOW;
 357         sh_msiof_write(p, CTR, tmp);
 358 }
 359
 360 static void sh_msiof_spi_set_mode_regs(struct sh_msiof_spi_priv *p,
 361                                        const void *tx_buf, void *rx_buf,
 362                                        u32 bits, u32 words)
 363 {
 364         u32 dr2 = MDR2_BITLEN1(bits) | MDR2_WDLEN1(words);
 365
 366         if (tx_buf || (p->chipdata->master_flags & SPI_MASTER_MUST_TX))
 367                 sh_msiof_write(p, TMDR2, dr2);
 368         else
 369                 sh_msiof_write(p, TMDR2, dr2 | MDR2_GRPMASK1);
 370
 371         if (rx_buf)
 372                 sh_msiof_write(p, RMDR2, dr2);
 373 }
 374
 375 static void sh_msiof_reset_str(struct sh_msiof_spi_priv *p)
 376 {
 377         sh_msiof_write(p, STR, sh_msiof_read(p, STR));
 378 }
 379
 380 static void sh_msiof_spi_write_fifo_8(struct sh_msiof_spi_priv *p,
 381                                       const void *tx_buf, int words, int fs)
 382 {
 383         const u8 *buf_8 = tx_buf;
 384         int k;
 385
 386         for (k = 0; k < words; k++)
 387                 sh_msiof_write(p, TFDR, buf_8[k] << fs);
 388 }
 389
 390 static void sh_msiof_spi_write_fifo_16(struct sh_msiof_spi_priv *p,
 391                                        const void *tx_buf, int words, int fs)
 392 {
 393         const u16 *buf_16 = tx_buf;
 394         int k;
 395
 396         for (k = 0; k < words; k++)
 397                 sh_msiof_write(p, TFDR, buf_16[k] << fs);
 398 }
 399
 400 static void sh_msiof_spi_write_fifo_16u(struct sh_msiof_spi_priv *p,
 401                                         const void *tx_buf, int words, int fs)
 402 {
 403         const u16 *buf_16 = tx_buf;
 404         int k;
 405
 406         for (k = 0; k < words; k++)
 407                 sh_msiof_write(p, TFDR, get_unaligned(&buf_16[k]) << fs);
 408 }
 409
 410 static void sh_msiof_spi_write_fifo_32(struct sh_msiof_spi_priv *p,
 411                                        const void *tx_buf, int words, int fs)
 412 {
 413         const u32 *buf_32 = tx_buf;
 414         int k;
 415
 416         for (k = 0; k < words; k++)
 417                 sh_msiof_write(p, TFDR, buf_32[k] << fs);
 418 }
 419
 420 static void sh_msiof_spi_write_fifo_32u(struct sh_msiof_spi_priv *p,
 421                                         const void *tx_buf, int words, int fs)
 422 {
 423         const u32 *buf_32 = tx_buf;
 424         int k;
 425
 426         for (k = 0; k < words; k++)
 427                 sh_msiof_write(p, TFDR, get_unaligned(&buf_32[k]) << fs);
 428 }
 429
 430 static void sh_msiof_spi_write_fifo_s32(struct sh_msiof_spi_priv *p,
 431                                         const void *tx_buf, int words, int fs)
 432 {
 433         const u32 *buf_32 = tx_buf;
 434         int k;
 435
 436         for (k = 0; k < words; k++)
 437                 sh_msiof_write(p, TFDR, swab32(buf_32[k] << fs));
 438 }
 439
 440 static void sh_msiof_spi_write_fifo_s32u(struct sh_msiof_spi_priv *p,
 441                                          const void *tx_buf, int words, int fs)
 442 {
 443         const u32 *buf_32 = tx_buf;
 444         int k;
 445
 446         for (k = 0; k < words; k++)
 447                 sh_msiof_write(p, TFDR, swab32(get_unaligned(&buf_32[k]) << fs));
 448 }
 449
 450 static void sh_msiof_spi_read_fifo_8(struct sh_msiof_spi_priv *p,
 451                                      void *rx_buf, int words, int fs)
 452 {
 453         u8 *buf_8 = rx_buf;
 454         int k;
 455
 456         for (k = 0; k < words; k++)
 457                 buf_8[k] = sh_msiof_read(p, RFDR) >> fs;
 458 }
 459
 460 static void sh_msiof_spi_read_fifo_16(struct sh_msiof_spi_priv *p,
 461                                       void *rx_buf, int words, int fs)
 462 {
 463         u16 *buf_16 = rx_buf;
 464         int k;
 465
 466         for (k = 0; k < words; k++)
 467                 buf_16[k] = sh_msiof_read(p, RFDR) >> fs;
 468 }
 469
 470 static void sh_msiof_spi_read_fifo_16u(struct sh_msiof_spi_priv *p,
 471                                        void *rx_buf, int words, int fs)
 472 {
 473         u16 *buf_16 = rx_buf;
 474         int k;
 475
 476         for (k = 0; k < words; k++)
 477                 put_unaligned(sh_msiof_read(p, RFDR) >> fs, &buf_16[k]);
 478 }
 479
 480 static void sh_msiof_spi_read_fifo_32(struct sh_msiof_spi_priv *p,
 481                                       void *rx_buf, int words, int fs)
 482 {
 483         u32 *buf_32 = rx_buf;
 484         int k;
 485
 486         for (k = 0; k < words; k++)
 487                 buf_32[k] = sh_msiof_read(p, RFDR) >> fs;
 488 }
 489
 490 static void sh_msiof_spi_read_fifo_32u(struct sh_msiof_spi_priv *p,
 491                                        void *rx_buf, int words, int fs)
 492 {
 493         u32 *buf_32 = rx_buf;
 494         int k;
 495
 496         for (k = 0; k < words; k++)
 497                 put_unaligned(sh_msiof_read(p, RFDR) >> fs, &buf_32[k]);
 498 }
 499
 500 static void sh_msiof_spi_read_fifo_s32(struct sh_msiof_spi_priv *p,
 501                                        void *rx_buf, int words, int fs)
 502 {
 503         u32 *buf_32 = rx_buf;
 504         int k;
 505
 506         for (k = 0; k < words; k++)
 507                 buf_32[k] = swab32(sh_msiof_read(p, RFDR) >> fs);
 508 }
 509
 510 static void sh_msiof_spi_read_fifo_s32u(struct sh_msiof_spi_priv *p,
 511                                        void *rx_buf, int words, int fs)
 512 {
 513         u32 *buf_32 = rx_buf;
 514         int k;
 515
 516         for (k = 0; k < words; k++)
 517                 put_unaligned(swab32(sh_msiof_read(p, RFDR) >> fs), &buf_32[k]);
 518 }
 519
 520 static int sh_msiof_spi_setup(struct spi_device *spi)
 521 {
 522         struct device_node      *np = spi->master->dev.of_node;
 523         struct sh_msiof_spi_priv *p = spi_master_get_devdata(spi->master);
 524
 525         pm_runtime_get_sync(&p->pdev->dev);
 526
 527         if (!np) {
 528                 /*
 529                  * Use spi->controller_data for CS (same strategy as spi_gpio),
 530                  * if any. otherwise let HW control CS
 531                  */
 532                 spi->cs_gpio = (uintptr_t)spi->controller_data;
 533         }
 534
 535         /* Configure pins before deasserting CS */
 536         sh_msiof_spi_set_pin_regs(p, !!(spi->mode & SPI_CPOL),
 537                                   !!(spi->mode & SPI_CPHA),
 538                                   !!(spi->mode & SPI_3WIRE),
 539                                   !!(spi->mode & SPI_LSB_FIRST),
 540                                   !!(spi->mode & SPI_CS_HIGH));
 541
 542         if (spi->cs_gpio >= 0)
 543                 gpio_set_value(spi->cs_gpio, !(spi->mode & SPI_CS_HIGH));
 544
 545
 546         pm_runtime_put(&p->pdev->dev);
 547
 548         return 0;
 549 }
 550
 551 static int sh_msiof_prepare_message(struct spi_master *master,
 552                                     struct spi_message *msg)
 553 {
 554         struct sh_msiof_spi_priv *p = spi_master_get_devdata(master);
 555         const struct spi_device *spi = msg->spi;
 556
 557         /* Configure pins before asserting CS */
 558         sh_msiof_spi_set_pin_regs(p, !!(spi->mode & SPI_CPOL),
 559                                   !!(spi->mode & SPI_CPHA),
 560                                   !!(spi->mode & SPI_3WIRE),
 561                                   !!(spi->mode & SPI_LSB_FIRST),
 562                                   !!(spi->mode & SPI_CS_HIGH));
 563         return 0;
 564 }
 565
 566 static int sh_msiof_spi_start(struct sh_msiof_spi_priv *p, void *rx_buf)
 567 {
 568         int ret;
 569
 570         /* setup clock and rx/tx signals */
 571         ret = sh_msiof_modify_ctr_wait(p, 0, CTR_TSCKE);
 572         if (rx_buf && !ret)
 573                 ret = sh_msiof_modify_ctr_wait(p, 0, CTR_RXE);
 574         if (!ret)
 575                 ret = sh_msiof_modify_ctr_wait(p, 0, CTR_TXE);
 576
 577         /* start by setting frame bit */
 578         if (!ret)
 579                 ret = sh_msiof_modify_ctr_wait(p, 0, CTR_TFSE);
 580
 581         return ret;
 582 }
 583
 584 static int sh_msiof_spi_stop(struct sh_msiof_spi_priv *p, void *rx_buf)
 585 {
 586         int ret;
 587
 588         /* shut down frame, rx/tx and clock signals */
 589         ret = sh_msiof_modify_ctr_wait(p, CTR_TFSE, 0);
 590         if (!ret)
 591                 ret = sh_msiof_modify_ctr_wait(p, CTR_TXE, 0);
 592         if (rx_buf && !ret)
 593                 ret = sh_msiof_modify_ctr_wait(p, CTR_RXE, 0);
 594         if (!ret)
 595                 ret = sh_msiof_modify_ctr_wait(p, CTR_TSCKE, 0);
 596
 597         return ret;
 598 }
 599
 600 static int sh_msiof_spi_txrx_once(struct sh_msiof_spi_priv *p,
 601                                   void (*tx_fifo)(struct sh_msiof_spi_priv *,
 602                                                   const void *, int, int),
 603                                   void (*rx_fifo)(struct sh_msiof_spi_priv *,
 604                                                   void *, int, int),
 605                                   const void *tx_buf, void *rx_buf,
 606                                   int words, int bits)
 607 {
 608         int fifo_shift;
 609         int ret;
 610
 611         /* limit maximum word transfer to rx/tx fifo size */
 612         if (tx_buf)
 613                 words = min_t(int, words, p->tx_fifo_size);
 614         if (rx_buf)
 615                 words = min_t(int, words, p->rx_fifo_size);
 616
 617         /* the fifo contents need shifting */
 618         fifo_shift = 32 - bits;
 619
 620         /* default FIFO watermarks for PIO */
 621         sh_msiof_write(p, FCTR, 0);
 622
 623         /* setup msiof transfer mode registers */
 624         sh_msiof_spi_set_mode_regs(p, tx_buf, rx_buf, bits, words);
 625         sh_msiof_write(p, IER, IER_TEOFE | IER_REOFE);
 626
 627         /* write tx fifo */
 628         if (tx_buf)
 629                 tx_fifo(p, tx_buf, words, fifo_shift);
 630
 631         reinit_completion(&p->done);
 632
 633         ret = sh_msiof_spi_start(p, rx_buf);
 634         if (ret) {
 635                 dev_err(&p->pdev->dev, "failed to start hardware\n");
 636                 goto stop_ier;
 637         }
 638
 639         /* wait for tx fifo to be emptied / rx fifo to be filled */
 640         if (!wait_for_completion_timeout(&p->done, HZ)) {
 641                 dev_err(&p->pdev->dev, "PIO timeout\n");
 642                 ret = -ETIMEDOUT;
 643                 goto stop_reset;
 644         }
 645
 646         /* read rx fifo */
 647         if (rx_buf)
 648                 rx_fifo(p, rx_buf, words, fifo_shift);
 649
 650         /* clear status bits */
 651         sh_msiof_reset_str(p);
 652
 653         ret = sh_msiof_spi_stop(p, rx_buf);
 654         if (ret) {
 655                 dev_err(&p->pdev->dev, "failed to shut down hardware\n");
 656                 return ret;
 657         }
 658
 659         return words;
 660
 661 stop_reset:
 662         sh_msiof_reset_str(p);
 663         sh_msiof_spi_stop(p, rx_buf);
 664 stop_ier:
 665         sh_msiof_write(p, IER, 0);
 666         return ret;
 667 }
 668
 669 static void sh_msiof_dma_complete(void *arg)
 670 {
 671         struct sh_msiof_spi_priv *p = arg;
 672
 673         sh_msiof_write(p, IER, 0);
 674         complete(&p->done);
 675 }
 676
 677 static int sh_msiof_dma_once(struct sh_msiof_spi_priv *p, const void *tx,
 678                              void *rx, unsigned int len)
 679 {
 680         u32 ier_bits = 0;
 681         struct dma_async_tx_descriptor *desc_tx = NULL, *desc_rx = NULL;
 682         dma_cookie_t cookie;
 683         int ret;
 684
 685         /* First prepare and submit the DMA request(s), as this may fail */
 686         if (rx) {
 687                 ier_bits |= IER_RDREQE | IER_RDMAE;
 688                 desc_rx = dmaengine_prep_slave_single(p->master->dma_rx,
 689                                         p->rx_dma_addr, len, DMA_FROM_DEVICE,
 690                                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 691                 if (!desc_rx)
 692                         return -EAGAIN;
 693
 694                 desc_rx->callback = sh_msiof_dma_complete;
 695                 desc_rx->callback_param = p;
 696                 cookie = dmaengine_submit(desc_rx);
 697                 if (dma_submit_error(cookie))
 698                         return cookie;
 699         }
 700
 701         if (tx) {
 702                 ier_bits |= IER_TDREQE | IER_TDMAE;
 703                 dma_sync_single_for_device(p->master->dma_tx->device->dev,
 704                                            p->tx_dma_addr, len, DMA_TO_DEVICE);
 705                 desc_tx = dmaengine_prep_slave_single(p->master->dma_tx,
 706                                         p->tx_dma_addr, len, DMA_TO_DEVICE,
 707                                         DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 708                 if (!desc_tx) {
 709                         ret = -EAGAIN;
 710                         goto no_dma_tx;
 711                 }
 712
 713                 if (rx) {
 714                         /* No callback */
 715                         desc_tx->callback = NULL;
 716                 } else {
 717                         desc_tx->callback = sh_msiof_dma_complete;
 718                         desc_tx->callback_param = p;
 719                 }
 720                 cookie = dmaengine_submit(desc_tx);
 721                 if (dma_submit_error(cookie)) {
 722                         ret = cookie;
 723                         goto no_dma_tx;
 724                 }
 725         }
 726
 727         /* 1 stage FIFO watermarks for DMA */
 728         sh_msiof_write(p, FCTR, FCTR_TFWM_1 | FCTR_RFWM_1);
 729
 730         /* setup msiof transfer mode registers (32-bit words) */
 731         sh_msiof_spi_set_mode_regs(p, tx, rx, 32, len / 4);
 732
 733         sh_msiof_write(p, IER, ier_bits);
 734
 735         reinit_completion(&p->done);
 736
 737         /* Now start DMA */
 738         if (rx)
 739                 dma_async_issue_pending(p->master->dma_rx);
 740         if (tx)
 741                 dma_async_issue_pending(p->master->dma_tx);
 742
 743         ret = sh_msiof_spi_start(p, rx);
 744         if (ret) {
 745                 dev_err(&p->pdev->dev, "failed to start hardware\n");
 746                 goto stop_dma;
 747         }
 748
 749         /* wait for tx fifo to be emptied / rx fifo to be filled */
 750         if (!wait_for_completion_timeout(&p->done, HZ)) {
 751                 dev_err(&p->pdev->dev, "DMA timeout\n");
 752                 ret = -ETIMEDOUT;
 753                 goto stop_reset;
 754         }
 755
 756         /* clear status bits */
 757         sh_msiof_reset_str(p);
 758
 759         ret = sh_msiof_spi_stop(p, rx);
 760         if (ret) {
 761                 dev_err(&p->pdev->dev, "failed to shut down hardware\n");
 762                 return ret;
 763         }
 764
 765         if (rx)
 766                 dma_sync_single_for_cpu(p->master->dma_rx->device->dev,
 767                                         p->rx_dma_addr, len,
 768                                         DMA_FROM_DEVICE);
 769
 770         return 0;
 771
 772 stop_reset:
 773         sh_msiof_reset_str(p);
 774         sh_msiof_spi_stop(p, rx);
 775 stop_dma:
 776         if (tx)
 777                 dmaengine_terminate_all(p->master->dma_tx);
 778 no_dma_tx:
 779         if (rx)
 780                 dmaengine_terminate_all(p->master->dma_rx);
 781         sh_msiof_write(p, IER, 0);
 782         return ret;
 783 }
 784
 785 static void copy_bswap32(u32 *dst, const u32 *src, unsigned int words)
 786 {
 787         /* src or dst can be unaligned, but not both */
 788         if ((unsigned long)src & 3) {
 789                 while (words--) {
 790                         *dst++ = swab32(get_unaligned(src));
 791                         src++;
 792                 }
 793         } else if ((unsigned long)dst & 3) {
 794                 while (words--) {
 795                         put_unaligned(swab32(*src++), dst);
 796                         dst++;
 797                 }
 798         } else {
 799                 while (words--)
 800                         *dst++ = swab32(*src++);
 801         }
 802 }
 803
 804 static void copy_wswap32(u32 *dst, const u32 *src, unsigned int words)
 805 {
 806         /* src or dst can be unaligned, but not both */
 807         if ((unsigned long)src & 3) {
 808                 while (words--) {
 809                         *dst++ = swahw32(get_unaligned(src));
 810                         src++;
 811                 }
 812         } else if ((unsigned long)dst & 3) {
 813                 while (words--) {
 814                         put_unaligned(swahw32(*src++), dst);
 815                         dst++;
 816                 }
 817         } else {
 818                 while (words--)
 819                         *dst++ = swahw32(*src++);
 820         }
 821 }
 822
 823 static void copy_plain32(u32 *dst, const u32 *src, unsigned int words)
 824 {
 825         memcpy(dst, src, words * 4);
 826 }
 827
 828 static int sh_msiof_transfer_one(struct spi_master *master,
 829                                  struct spi_device *spi,
 830                                  struct spi_transfer *t)
 831 {
 832         struct sh_msiof_spi_priv *p = spi_master_get_devdata(master);
 833         void (*copy32)(u32 *, const u32 *, unsigned int);
 834         void (*tx_fifo)(struct sh_msiof_spi_priv *, const void *, int, int);
 835         void (*rx_fifo)(struct sh_msiof_spi_priv *, void *, int, int);
 836         const void *tx_buf = t->tx_buf;
 837         void *rx_buf = t->rx_buf;
 838         unsigned int len = t->len;
 839         unsigned int bits = t->bits_per_word;
 840         unsigned int bytes_per_word;
 841         unsigned int words;
 842         int n;
 843         bool swab;
 844         int ret;
 845
 846         /* setup clocks (clock already enabled in chipselect()) */
 847         sh_msiof_spi_set_clk_regs(p, clk_get_rate(p->clk), t->speed_hz);
 848
 849         while (master->dma_tx && len > 15) {
 850                 /*
 851                  *  DMA supports 32-bit words only, hence pack 8-bit and 16-bit
 852                  *  words, with byte resp. word swapping.
 853                  */
 854                 unsigned int l = 0;
 855
 856                 if (tx_buf)
 857                         l = min(len, p->tx_fifo_size * 4);
 858                 if (rx_buf)
 859                         l = min(len, p->rx_fifo_size * 4);
 860
 861                 if (bits <= 8) {
 862                         if (l & 3)
 863                                 break;
 864                         copy32 = copy_bswap32;
 865                 } else if (bits <= 16) {
 866                         if (l & 1)
 867                                 break;
 868                         copy32 = copy_wswap32;
 869                 } else {
 870                         copy32 = copy_plain32;
 871                 }
 872
 873                 if (tx_buf)
 874                         copy32(p->tx_dma_page, tx_buf, l / 4);
 875
 876                 ret = sh_msiof_dma_once(p, tx_buf, rx_buf, l);
 877                 if (ret == -EAGAIN) {
 878                         pr_warn_once("%s %s: DMA not available, falling back to PIO\n",
 879                                      dev_driver_string(&p->pdev->dev),
 880                                      dev_name(&p->pdev->dev));
 881                         break;
 882                 }
 883                 if (ret)
 884                         return ret;
 885
 886                 if (rx_buf) {
 887                         copy32(rx_buf, p->rx_dma_page, l / 4);
 888                         rx_buf += l;
 889                 }
 890                 if (tx_buf)
 891                         tx_buf += l;
 892
 893                 len -= l;
 894                 if (!len)
 895                         return 0;
 896         }
 897
 898         if (bits <= 8 && len > 15 && !(len & 3)) {
 899                 bits = 32;
 900                 swab = true;
 901         } else {
 902                 swab = false;
 903         }
 904
 905         /* setup bytes per word and fifo read/write functions */
 906         if (bits <= 8) {
 907                 bytes_per_word = 1;
 908                 tx_fifo = sh_msiof_spi_write_fifo_8;
 909                 rx_fifo = sh_msiof_spi_read_fifo_8;
 910         } else if (bits <= 16) {
 911                 bytes_per_word = 2;
 912                 if ((unsigned long)tx_buf & 0x01)
 913                         tx_fifo = sh_msiof_spi_write_fifo_16u;
 914                 else
 915                         tx_fifo = sh_msiof_spi_write_fifo_16;
 916
 917                 if ((unsigned long)rx_buf & 0x01)
 918                         rx_fifo = sh_msiof_spi_read_fifo_16u;
 919                 else
 920                         rx_fifo = sh_msiof_spi_read_fifo_16;
 921         } else if (swab) {
 922                 bytes_per_word = 4;
 923                 if ((unsigned long)tx_buf & 0x03)
 924                         tx_fifo = sh_msiof_spi_write_fifo_s32u;
 925                 else
 926                         tx_fifo = sh_msiof_spi_write_fifo_s32;
 927
 928                 if ((unsigned long)rx_buf & 0x03)
 929                         rx_fifo = sh_msiof_spi_read_fifo_s32u;
 930                 else
 931                         rx_fifo = sh_msiof_spi_read_fifo_s32;
 932         } else {
 933                 bytes_per_word = 4;
 934                 if ((unsigned long)tx_buf & 0x03)
 935                         tx_fifo = sh_msiof_spi_write_fifo_32u;
 936                 else
 937                         tx_fifo = sh_msiof_spi_write_fifo_32;
 938
 939                 if ((unsigned long)rx_buf & 0x03)
 940                         rx_fifo = sh_msiof_spi_read_fifo_32u;
 941                 else
 942                         rx_fifo = sh_msiof_spi_read_fifo_32;
 943         }
 944
 945         /* transfer in fifo sized chunks */
 946         words = len / bytes_per_word;
 947
 948         while (words > 0) {
 949                 n = sh_msiof_spi_txrx_once(p, tx_fifo, rx_fifo, tx_buf, rx_buf,
 950                                            words, bits);
 951                 if (n < 0)
 952                         return n;
 953
 954                 if (tx_buf)
 955                         tx_buf += n * bytes_per_word;
 956                 if (rx_buf)
 957                         rx_buf += n * bytes_per_word;
 958                 words -= n;
 959         }
 960
 961         return 0;
 962 }
 963
 964 static const struct sh_msiof_chipdata sh_data = {
 965         .tx_fifo_size = 64,
 966         .rx_fifo_size = 64,
 967         .master_flags = 0,
 968 };
 969
 970 static const struct sh_msiof_chipdata r8a779x_data = {
 971         .tx_fifo_size = 64,
 972         .rx_fifo_size = 64,
 973         .master_flags = SPI_MASTER_MUST_TX,
 974 };
 975
 976 static const struct of_device_id sh_msiof_match[] = {
 977         { .compatible = "renesas,sh-msiof",        .data = &sh_data },
 978         { .compatible = "renesas,sh-mobile-msiof", .data = &sh_data },
 979         { .compatible = "renesas,msiof-r8a7790",   .data = &r8a779x_data },
 980         { .compatible = "renesas,msiof-r8a7791",   .data = &r8a779x_data },
 981         { .compatible = "renesas,msiof-r8a7792",   .data = &r8a779x_data },
 982         { .compatible = "renesas,msiof-r8a7793",   .data = &r8a779x_data },
 983         { .compatible = "renesas,msiof-r8a7794",   .data = &r8a779x_data },
 984         {},
 985 };
 986 MODULE_DEVICE_TABLE(of, sh_msiof_match);
 987
 988 #ifdef CONFIG_OF
 989 static struct sh_msiof_spi_info *sh_msiof_spi_parse_dt(struct device *dev)
 990 {
 991         struct sh_msiof_spi_info *info;
 992         struct device_node *np = dev->of_node;
 993         u32 num_cs = 1;
 994
 995         info = devm_kzalloc(dev, sizeof(struct sh_msiof_spi_info), GFP_KERNEL);
 996         if (!info)
 997                 return NULL;
 998
 999         /* Parse the MSIOF properties */
1000         of_property_read_u32(np, "num-cs", &num_cs);
1001         of_property_read_u32(np, "renesas,tx-fifo-size",
1002                                         &info->tx_fifo_override);
1003         of_property_read_u32(np, "renesas,rx-fifo-size",
1004                                         &info->rx_fifo_override);
1005         of_property_read_u32(np, "renesas,dtdl", &info->dtdl);
1006         of_property_read_u32(np, "renesas,syncdl", &info->syncdl);
1007
1008         info->num_chipselect = num_cs;
1009
1010         return info;
1011 }
1012 #else
1013 static struct sh_msiof_spi_info *sh_msiof_spi_parse_dt(struct device *dev)
1014 {
1015         return NULL;
1016 }
1017 #endif
1018
1019 static struct dma_chan *sh_msiof_request_dma_chan(struct device *dev,
1020         enum dma_transfer_direction dir, unsigned int id, dma_addr_t port_addr)
1021 {
1022         dma_cap_mask_t mask;
1023         struct dma_chan *chan;
1024         struct dma_slave_config cfg;
1025         int ret;
1026
1027         dma_cap_zero(mask);
1028         dma_cap_set(DMA_SLAVE, mask);
1029
1030         chan = dma_request_slave_channel_compat(mask, shdma_chan_filter,
1031                                 (void *)(unsigned long)id, dev,
1032                                 dir == DMA_MEM_TO_DEV ? "tx" : "rx");
1033         if (!chan) {
1034                 dev_warn(dev, "dma_request_slave_channel_compat failed\n");
1035                 return NULL;
1036         }
1037
1038         memset(&cfg, 0, sizeof(cfg));
1039         cfg.direction = dir;
1040         if (dir == DMA_MEM_TO_DEV) {
1041                 cfg.dst_addr = port_addr;
1042                 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
1043         } else {
1044                 cfg.src_addr = port_addr;
1045                 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
1046         }
1047
1048         ret = dmaengine_slave_config(chan, &cfg);
1049         if (ret) {
1050                 dev_warn(dev, "dmaengine_slave_config failed %d\n", ret);
1051                 dma_release_channel(chan);
1052                 return NULL;
1053         }
1054
1055         return chan;
1056 }
1057
1058 static int sh_msiof_request_dma(struct sh_msiof_spi_priv *p)
1059 {
1060         struct platform_device *pdev = p->pdev;
1061         struct device *dev = &pdev->dev;
1062         const struct sh_msiof_spi_info *info = dev_get_platdata(dev);
1063         unsigned int dma_tx_id, dma_rx_id;
1064         const struct resource *res;
1065         struct spi_master *master;
1066         struct device *tx_dev, *rx_dev;
1067
1068         if (dev->of_node) {
1069                 /* In the OF case we will get the slave IDs from the DT */
1070                 dma_tx_id = 0;
1071                 dma_rx_id = 0;
1072         } else if (info && info->dma_tx_id && info->dma_rx_id) {
1073                 dma_tx_id = info->dma_tx_id;
1074                 dma_rx_id = info->dma_rx_id;
1075         } else {
1076                 /* The driver assumes no error */
1077                 return 0;
1078         }
1079
1080         /* The DMA engine uses the second register set, if present */
1081         res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1082         if (!res)
1083                 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1084
1085         master = p->master;
1086         master->dma_tx = sh_msiof_request_dma_chan(dev, DMA_MEM_TO_DEV,
1087                                                    dma_tx_id,
1088                                                    res->start + TFDR);
1089         if (!master->dma_tx)
1090                 return -ENODEV;
1091
1092         master->dma_rx = sh_msiof_request_dma_chan(dev, DMA_DEV_TO_MEM,
1093                                                    dma_rx_id,
1094                                                    res->start + RFDR);
1095         if (!master->dma_rx)
1096                 goto free_tx_chan;
1097
1098         p->tx_dma_page = (void *)__get_free_page(GFP_KERNEL | GFP_DMA);
1099         if (!p->tx_dma_page)
1100                 goto free_rx_chan;
1101
1102         p->rx_dma_page = (void *)__get_free_page(GFP_KERNEL | GFP_DMA);
1103         if (!p->rx_dma_page)
1104                 goto free_tx_page;
1105
1106         tx_dev = master->dma_tx->device->dev;
1107         p->tx_dma_addr = dma_map_single(tx_dev, p->tx_dma_page, PAGE_SIZE,
1108                                         DMA_TO_DEVICE);
1109         if (dma_mapping_error(tx_dev, p->tx_dma_addr))
1110                 goto free_rx_page;
1111
1112         rx_dev = master->dma_rx->device->dev;
1113         p->rx_dma_addr = dma_map_single(rx_dev, p->rx_dma_page, PAGE_SIZE,
1114                                         DMA_FROM_DEVICE);
1115         if (dma_mapping_error(rx_dev, p->rx_dma_addr))
1116                 goto unmap_tx_page;
1117
1118         dev_info(dev, "DMA available");
1119         return 0;
1120
1121 unmap_tx_page:
1122         dma_unmap_single(tx_dev, p->tx_dma_addr, PAGE_SIZE, DMA_TO_DEVICE);
1123 free_rx_page:
1124         free_page((unsigned long)p->rx_dma_page);
1125 free_tx_page:
1126         free_page((unsigned long)p->tx_dma_page);
1127 free_rx_chan:
1128         dma_release_channel(master->dma_rx);
1129 free_tx_chan:
1130         dma_release_channel(master->dma_tx);
1131         master->dma_tx = NULL;
1132         return -ENODEV;
1133 }
1134
1135 static void sh_msiof_release_dma(struct sh_msiof_spi_priv *p)
1136 {
1137         struct spi_master *master = p->master;
1138         struct device *dev;
1139
1140         if (!master->dma_tx)
1141                 return;
1142
1143         dev = &p->pdev->dev;
1144         dma_unmap_single(master->dma_rx->device->dev, p->rx_dma_addr,
1145                          PAGE_SIZE, DMA_FROM_DEVICE);
1146         dma_unmap_single(master->dma_tx->device->dev, p->tx_dma_addr,
1147                          PAGE_SIZE, DMA_TO_DEVICE);
1148         free_page((unsigned long)p->rx_dma_page);
1149         free_page((unsigned long)p->tx_dma_page);
1150         dma_release_channel(master->dma_rx);
1151         dma_release_channel(master->dma_tx);
1152 }
1153
1154 static int sh_msiof_spi_probe(struct platform_device *pdev)
1155 {
1156         struct resource *r;
1157         struct spi_master *master;
1158         const struct of_device_id *of_id;
1159         struct sh_msiof_spi_priv *p;
1160         int i;
1161         int ret;
1162
1163         master = spi_alloc_master(&pdev->dev, sizeof(struct sh_msiof_spi_priv));
1164         if (master == NULL) {
1165                 dev_err(&pdev->dev, "failed to allocate spi master\n");
1166                 return -ENOMEM;
1167         }
1168
1169         p = spi_master_get_devdata(master);
1170
1171         platform_set_drvdata(pdev, p);
1172         p->master = master;
1173
1174         of_id = of_match_device(sh_msiof_match, &pdev->dev);
1175         if (of_id) {
1176                 p->chipdata = of_id->data;
1177                 p->info = sh_msiof_spi_parse_dt(&pdev->dev);
1178         } else {
1179                 p->chipdata = (const void *)pdev->id_entry->driver_data;
1180                 p->info = dev_get_platdata(&pdev->dev);
1181         }
1182
1183         if (!p->info) {
1184                 dev_err(&pdev->dev, "failed to obtain device info\n");
1185                 ret = -ENXIO;
1186                 goto err1;
1187         }
1188
1189         init_completion(&p->done);
1190
1191         p->clk = devm_clk_get(&pdev->dev, NULL);
1192         if (IS_ERR(p->clk)) {
1193                 dev_err(&pdev->dev, "cannot get clock\n");
1194                 ret = PTR_ERR(p->clk);
1195                 goto err1;
1196         }
1197
1198         i = platform_get_irq(pdev, 0);
1199         if (i < 0) {
1200                 dev_err(&pdev->dev, "cannot get platform IRQ\n");
1201                 ret = -ENOENT;
1202                 goto err1;
1203         }
1204
1205         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1206         p->mapbase = devm_ioremap_resource(&pdev->dev, r);
1207         if (IS_ERR(p->mapbase)) {
1208                 ret = PTR_ERR(p->mapbase);
1209                 goto err1;
1210         }
1211
1212         ret = devm_request_irq(&pdev->dev, i, sh_msiof_spi_irq, 0,
1213                                dev_name(&pdev->dev), p);
1214         if (ret) {
1215                 dev_err(&pdev->dev, "unable to request irq\n");
1216                 goto err1;
1217         }
1218
1219         p->pdev = pdev;
1220         pm_runtime_enable(&pdev->dev);
1221
1222         /* Platform data may override FIFO sizes */
1223         p->tx_fifo_size = p->chipdata->tx_fifo_size;
1224         p->rx_fifo_size = p->chipdata->rx_fifo_size;
1225         if (p->info->tx_fifo_override)
1226                 p->tx_fifo_size = p->info->tx_fifo_override;
1227         if (p->info->rx_fifo_override)
1228                 p->rx_fifo_size = p->info->rx_fifo_override;
1229
1230         /* init master code */
1231         master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
1232         master->mode_bits |= SPI_LSB_FIRST | SPI_3WIRE;
1233         master->flags = p->chipdata->master_flags;
1234         master->bus_num = pdev->id;
1235         master->dev.of_node = pdev->dev.of_node;
1236         master->num_chipselect = p->info->num_chipselect;
1237         master->setup = sh_msiof_spi_setup;
1238         master->prepare_message = sh_msiof_prepare_message;
1239         master->bits_per_word_mask = SPI_BPW_RANGE_MASK(8, 32);
1240         master->auto_runtime_pm = true;
1241         master->transfer_one = sh_msiof_transfer_one;
1242
1243         ret = sh_msiof_request_dma(p);
1244         if (ret < 0)
1245                 dev_warn(&pdev->dev, "DMA not available, using PIO\n");
1246
1247         ret = devm_spi_register_master(&pdev->dev, master);
1248         if (ret < 0) {
1249                 dev_err(&pdev->dev, "spi_register_master error.\n");
1250                 goto err2;
1251         }
1252
1253         return 0;
1254
1255  err2:
1256         sh_msiof_release_dma(p);
1257         pm_runtime_disable(&pdev->dev);
1258  err1:
1259         spi_master_put(master);
1260         return ret;
1261 }
1262
1263 static int sh_msiof_spi_remove(struct platform_device *pdev)
1264 {
1265         struct sh_msiof_spi_priv *p = platform_get_drvdata(pdev);
1266
1267         sh_msiof_release_dma(p);
1268         pm_runtime_disable(&pdev->dev);
1269         return 0;
1270 }
1271
1272 static const struct platform_device_id spi_driver_ids[] = {
1273         { "spi_sh_msiof",       (kernel_ulong_t)&sh_data },
1274         {},
1275 };
1276 MODULE_DEVICE_TABLE(platform, spi_driver_ids);
1277
1278 static struct platform_driver sh_msiof_spi_drv = {
1279         .probe          = sh_msiof_spi_probe,
1280         .remove         = sh_msiof_spi_remove,
1281         .id_table       = spi_driver_ids,
1282         .driver         = {
1283                 .name           = "spi_sh_msiof",
1284                 .of_match_table = of_match_ptr(sh_msiof_match),
1285         },
1286 };
1287 module_platform_driver(sh_msiof_spi_drv);
1288
1289 MODULE_DESCRIPTION("SuperH MSIOF SPI Master Interface Driver");
1290 MODULE_AUTHOR("Magnus Damm");
1291 MODULE_LICENSE("GPL v2");
1292 MODULE_ALIAS("platform:spi_sh_msiof");