drivers/spi/spi-mt65xx.c

   1 /*
   2  * Copyright (c) 2015 MediaTek Inc.
   3  * Author: Leilk Liu <leilk.liu@mediatek.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 #include <linux/clk.h>
  16 #include <linux/device.h>
  17 #include <linux/err.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/io.h>
  20 #include <linux/ioport.h>
  21 #include <linux/module.h>
  22 #include <linux/of.h>
  23 #include <linux/of_gpio.h>
  24 #include <linux/platform_device.h>
  25 #include <linux/platform_data/spi-mt65xx.h>
  26 #include <linux/pm_runtime.h>
  27 #include <linux/spi/spi.h>
  28
  29 #define SPI_CFG0_REG                      0x0000
  30 #define SPI_CFG1_REG                      0x0004
  31 #define SPI_TX_SRC_REG                    0x0008
  32 #define SPI_RX_DST_REG                    0x000c
  33 #define SPI_TX_DATA_REG                   0x0010
  34 #define SPI_RX_DATA_REG                   0x0014
  35 #define SPI_CMD_REG                       0x0018
  36 #define SPI_STATUS0_REG                   0x001c
  37 #define SPI_PAD_SEL_REG                   0x0024
  38
  39 #define SPI_CFG0_SCK_HIGH_OFFSET          0
  40 #define SPI_CFG0_SCK_LOW_OFFSET           8
  41 #define SPI_CFG0_CS_HOLD_OFFSET           16
  42 #define SPI_CFG0_CS_SETUP_OFFSET          24
  43
  44 #define SPI_CFG1_CS_IDLE_OFFSET           0
  45 #define SPI_CFG1_PACKET_LOOP_OFFSET       8
  46 #define SPI_CFG1_PACKET_LENGTH_OFFSET     16
  47 #define SPI_CFG1_GET_TICK_DLY_OFFSET      30
  48
  49 #define SPI_CFG1_CS_IDLE_MASK             0xff
  50 #define SPI_CFG1_PACKET_LOOP_MASK         0xff00
  51 #define SPI_CFG1_PACKET_LENGTH_MASK       0x3ff0000
  52
  53 #define SPI_CMD_ACT                  BIT(0)
  54 #define SPI_CMD_RESUME               BIT(1)
  55 #define SPI_CMD_RST                  BIT(2)
  56 #define SPI_CMD_PAUSE_EN             BIT(4)
  57 #define SPI_CMD_DEASSERT             BIT(5)
  58 #define SPI_CMD_CPHA                 BIT(8)
  59 #define SPI_CMD_CPOL                 BIT(9)
  60 #define SPI_CMD_RX_DMA               BIT(10)
  61 #define SPI_CMD_TX_DMA               BIT(11)
  62 #define SPI_CMD_TXMSBF               BIT(12)
  63 #define SPI_CMD_RXMSBF               BIT(13)
  64 #define SPI_CMD_RX_ENDIAN            BIT(14)
  65 #define SPI_CMD_TX_ENDIAN            BIT(15)
  66 #define SPI_CMD_FINISH_IE            BIT(16)
  67 #define SPI_CMD_PAUSE_IE             BIT(17)
  68
  69 #define MT8173_SPI_MAX_PAD_SEL 3
  70
  71 #define MTK_SPI_PAUSE_INT_STATUS 0x2
  72
  73 #define MTK_SPI_IDLE 0
  74 #define MTK_SPI_PAUSED 1
  75
  76 #define MTK_SPI_MAX_FIFO_SIZE 32
  77 #define MTK_SPI_PACKET_SIZE 1024
  78
  79 struct mtk_spi_compatible {
  80         bool need_pad_sel;
  81         /* Must explicitly send dummy Tx bytes to do Rx only transfer */
  82         bool must_tx;
  83 };
  84
  85 struct mtk_spi {
  86         void __iomem *base;
  87         u32 state;
  88         int pad_num;
  89         u32 *pad_sel;
  90         struct clk *parent_clk, *sel_clk, *spi_clk;
  91         struct spi_transfer *cur_transfer;
  92         u32 xfer_len;
  93         struct scatterlist *tx_sgl, *rx_sgl;
  94         u32 tx_sgl_len, rx_sgl_len;
  95         const struct mtk_spi_compatible *dev_comp;
  96 };
  97
  98 static const struct mtk_spi_compatible mtk_common_compat;
  99 static const struct mtk_spi_compatible mt8173_compat = {
 100         .need_pad_sel = true,
 101         .must_tx = true,
 102 };
 103
 104 /*
 105  * A piece of default chip info unless the platform
 106  * supplies it.
 107  */
 108 static const struct mtk_chip_config mtk_default_chip_info = {
 109         .rx_mlsb = 1,
 110         .tx_mlsb = 1,
 111 };
 112
 113 static const struct of_device_id mtk_spi_of_match[] = {
 114         { .compatible = "mediatek,mt2701-spi",
 115                 .data = (void *)&mtk_common_compat,
 116         },
 117         { .compatible = "mediatek,mt6589-spi",
 118                 .data = (void *)&mtk_common_compat,
 119         },
 120         { .compatible = "mediatek,mt8135-spi",
 121                 .data = (void *)&mtk_common_compat,
 122         },
 123         { .compatible = "mediatek,mt8173-spi",
 124                 .data = (void *)&mt8173_compat,
 125         },
 126         {}
 127 };
 128 MODULE_DEVICE_TABLE(of, mtk_spi_of_match);
 129
 130 static void mtk_spi_reset(struct mtk_spi *mdata)
 131 {
 132         u32 reg_val;
 133
 134         /* set the software reset bit in SPI_CMD_REG. */
 135         reg_val = readl(mdata->base + SPI_CMD_REG);
 136         reg_val |= SPI_CMD_RST;
 137         writel(reg_val, mdata->base + SPI_CMD_REG);
 138
 139         reg_val = readl(mdata->base + SPI_CMD_REG);
 140         reg_val &= ~SPI_CMD_RST;
 141         writel(reg_val, mdata->base + SPI_CMD_REG);
 142 }
 143
 144 static int mtk_spi_prepare_message(struct spi_master *master,
 145                                    struct spi_message *msg)
 146 {
 147         u16 cpha, cpol;
 148         u32 reg_val;
 149         struct spi_device *spi = msg->spi;
 150         struct mtk_chip_config *chip_config = spi->controller_data;
 151         struct mtk_spi *mdata = spi_master_get_devdata(master);
 152
 153         cpha = spi->mode & SPI_CPHA ? 1 : 0;
 154         cpol = spi->mode & SPI_CPOL ? 1 : 0;
 155
 156         reg_val = readl(mdata->base + SPI_CMD_REG);
 157         if (cpha)
 158                 reg_val |= SPI_CMD_CPHA;
 159         else
 160                 reg_val &= ~SPI_CMD_CPHA;
 161         if (cpol)
 162                 reg_val |= SPI_CMD_CPOL;
 163         else
 164                 reg_val &= ~SPI_CMD_CPOL;
 165
 166         /* set the mlsbx and mlsbtx */
 167         if (chip_config->tx_mlsb)
 168                 reg_val |= SPI_CMD_TXMSBF;
 169         else
 170                 reg_val &= ~SPI_CMD_TXMSBF;
 171         if (chip_config->rx_mlsb)
 172                 reg_val |= SPI_CMD_RXMSBF;
 173         else
 174                 reg_val &= ~SPI_CMD_RXMSBF;
 175
 176         /* set the tx/rx endian */
 177 #ifdef __LITTLE_ENDIAN
 178         reg_val &= ~SPI_CMD_TX_ENDIAN;
 179         reg_val &= ~SPI_CMD_RX_ENDIAN;
 180 #else
 181         reg_val |= SPI_CMD_TX_ENDIAN;
 182         reg_val |= SPI_CMD_RX_ENDIAN;
 183 #endif
 184
 185         /* set finish and pause interrupt always enable */
 186         reg_val |= SPI_CMD_FINISH_IE | SPI_CMD_PAUSE_IE;
 187
 188         /* disable dma mode */
 189         reg_val &= ~(SPI_CMD_TX_DMA | SPI_CMD_RX_DMA);
 190
 191         /* disable deassert mode */
 192         reg_val &= ~SPI_CMD_DEASSERT;
 193
 194         writel(reg_val, mdata->base + SPI_CMD_REG);
 195
 196         /* pad select */
 197         if (mdata->dev_comp->need_pad_sel)
 198                 writel(mdata->pad_sel[spi->chip_select],
 199                        mdata->base + SPI_PAD_SEL_REG);
 200
 201         return 0;
 202 }
 203
 204 static void mtk_spi_set_cs(struct spi_device *spi, bool enable)
 205 {
 206         u32 reg_val;
 207         struct mtk_spi *mdata = spi_master_get_devdata(spi->master);
 208
 209         reg_val = readl(mdata->base + SPI_CMD_REG);
 210         if (!enable) {
 211                 reg_val |= SPI_CMD_PAUSE_EN;
 212                 writel(reg_val, mdata->base + SPI_CMD_REG);
 213         } else {
 214                 reg_val &= ~SPI_CMD_PAUSE_EN;
 215                 writel(reg_val, mdata->base + SPI_CMD_REG);
 216                 mdata->state = MTK_SPI_IDLE;
 217                 mtk_spi_reset(mdata);
 218         }
 219 }
 220
 221 static void mtk_spi_prepare_transfer(struct spi_master *master,
 222                                      struct spi_transfer *xfer)
 223 {
 224         u32 spi_clk_hz, div, sck_time, cs_time, reg_val = 0;
 225         struct mtk_spi *mdata = spi_master_get_devdata(master);
 226
 227         spi_clk_hz = clk_get_rate(mdata->spi_clk);
 228         if (xfer->speed_hz < spi_clk_hz / 2)
 229                 div = DIV_ROUND_UP(spi_clk_hz, xfer->speed_hz);
 230         else
 231                 div = 1;
 232
 233         sck_time = (div + 1) / 2;
 234         cs_time = sck_time * 2;
 235
 236         reg_val |= (((sck_time - 1) & 0xff) << SPI_CFG0_SCK_HIGH_OFFSET);
 237         reg_val |= (((sck_time - 1) & 0xff) << SPI_CFG0_SCK_LOW_OFFSET);
 238         reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG0_CS_HOLD_OFFSET);
 239         reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG0_CS_SETUP_OFFSET);
 240         writel(reg_val, mdata->base + SPI_CFG0_REG);
 241
 242         reg_val = readl(mdata->base + SPI_CFG1_REG);
 243         reg_val &= ~SPI_CFG1_CS_IDLE_MASK;
 244         reg_val |= (((cs_time - 1) & 0xff) << SPI_CFG1_CS_IDLE_OFFSET);
 245         writel(reg_val, mdata->base + SPI_CFG1_REG);
 246 }
 247
 248 static void mtk_spi_setup_packet(struct spi_master *master)
 249 {
 250         u32 packet_size, packet_loop, reg_val;
 251         struct mtk_spi *mdata = spi_master_get_devdata(master);
 252
 253         packet_size = min_t(u32, mdata->xfer_len, MTK_SPI_PACKET_SIZE);
 254         packet_loop = mdata->xfer_len / packet_size;
 255
 256         reg_val = readl(mdata->base + SPI_CFG1_REG);
 257         reg_val &= ~(SPI_CFG1_PACKET_LENGTH_MASK | SPI_CFG1_PACKET_LOOP_MASK);
 258         reg_val |= (packet_size - 1) << SPI_CFG1_PACKET_LENGTH_OFFSET;
 259         reg_val |= (packet_loop - 1) << SPI_CFG1_PACKET_LOOP_OFFSET;
 260         writel(reg_val, mdata->base + SPI_CFG1_REG);
 261 }
 262
 263 static void mtk_spi_enable_transfer(struct spi_master *master)
 264 {
 265         u32 cmd;
 266         struct mtk_spi *mdata = spi_master_get_devdata(master);
 267
 268         cmd = readl(mdata->base + SPI_CMD_REG);
 269         if (mdata->state == MTK_SPI_IDLE)
 270                 cmd |= SPI_CMD_ACT;
 271         else
 272                 cmd |= SPI_CMD_RESUME;
 273         writel(cmd, mdata->base + SPI_CMD_REG);
 274 }
 275
 276 static int mtk_spi_get_mult_delta(u32 xfer_len)
 277 {
 278         u32 mult_delta;
 279
 280         if (xfer_len > MTK_SPI_PACKET_SIZE)
 281                 mult_delta = xfer_len % MTK_SPI_PACKET_SIZE;
 282         else
 283                 mult_delta = 0;
 284
 285         return mult_delta;
 286 }
 287
 288 static void mtk_spi_update_mdata_len(struct spi_master *master)
 289 {
 290         int mult_delta;
 291         struct mtk_spi *mdata = spi_master_get_devdata(master);
 292
 293         if (mdata->tx_sgl_len && mdata->rx_sgl_len) {
 294                 if (mdata->tx_sgl_len > mdata->rx_sgl_len) {
 295                         mult_delta = mtk_spi_get_mult_delta(mdata->rx_sgl_len);
 296                         mdata->xfer_len = mdata->rx_sgl_len - mult_delta;
 297                         mdata->rx_sgl_len = mult_delta;
 298                         mdata->tx_sgl_len -= mdata->xfer_len;
 299                 } else {
 300                         mult_delta = mtk_spi_get_mult_delta(mdata->tx_sgl_len);
 301                         mdata->xfer_len = mdata->tx_sgl_len - mult_delta;
 302                         mdata->tx_sgl_len = mult_delta;
 303                         mdata->rx_sgl_len -= mdata->xfer_len;
 304                 }
 305         } else if (mdata->tx_sgl_len) {
 306                 mult_delta = mtk_spi_get_mult_delta(mdata->tx_sgl_len);
 307                 mdata->xfer_len = mdata->tx_sgl_len - mult_delta;
 308                 mdata->tx_sgl_len = mult_delta;
 309         } else if (mdata->rx_sgl_len) {
 310                 mult_delta = mtk_spi_get_mult_delta(mdata->rx_sgl_len);
 311                 mdata->xfer_len = mdata->rx_sgl_len - mult_delta;
 312                 mdata->rx_sgl_len = mult_delta;
 313         }
 314 }
 315
 316 static void mtk_spi_setup_dma_addr(struct spi_master *master,
 317                                    struct spi_transfer *xfer)
 318 {
 319         struct mtk_spi *mdata = spi_master_get_devdata(master);
 320
 321         if (mdata->tx_sgl)
 322                 writel(xfer->tx_dma, mdata->base + SPI_TX_SRC_REG);
 323         if (mdata->rx_sgl)
 324                 writel(xfer->rx_dma, mdata->base + SPI_RX_DST_REG);
 325 }
 326
 327 static int mtk_spi_fifo_transfer(struct spi_master *master,
 328                                  struct spi_device *spi,
 329                                  struct spi_transfer *xfer)
 330 {
 331         int cnt, remainder;
 332         u32 reg_val;
 333         struct mtk_spi *mdata = spi_master_get_devdata(master);
 334
 335         mdata->cur_transfer = xfer;
 336         mdata->xfer_len = xfer->len;
 337         mtk_spi_prepare_transfer(master, xfer);
 338         mtk_spi_setup_packet(master);
 339
 340         if (xfer->tx_buf) {
 341                 cnt = xfer->len / 4;
 342                 iowrite32_rep(mdata->base + SPI_TX_DATA_REG, xfer->tx_buf, cnt);
 343                 remainder = xfer->len % 4;
 344                 if (remainder > 0) {
 345                         reg_val = 0;
 346                         memcpy(&reg_val, xfer->tx_buf + (cnt * 4), remainder);
 347                         writel(reg_val, mdata->base + SPI_TX_DATA_REG);
 348                 }
 349         }
 350
 351         mtk_spi_enable_transfer(master);
 352
 353         return 1;
 354 }
 355
 356 static int mtk_spi_dma_transfer(struct spi_master *master,
 357                                 struct spi_device *spi,
 358                                 struct spi_transfer *xfer)
 359 {
 360         int cmd;
 361         struct mtk_spi *mdata = spi_master_get_devdata(master);
 362
 363         mdata->tx_sgl = NULL;
 364         mdata->rx_sgl = NULL;
 365         mdata->tx_sgl_len = 0;
 366         mdata->rx_sgl_len = 0;
 367         mdata->cur_transfer = xfer;
 368
 369         mtk_spi_prepare_transfer(master, xfer);
 370
 371         cmd = readl(mdata->base + SPI_CMD_REG);
 372         if (xfer->tx_buf)
 373                 cmd |= SPI_CMD_TX_DMA;
 374         if (xfer->rx_buf)
 375                 cmd |= SPI_CMD_RX_DMA;
 376         writel(cmd, mdata->base + SPI_CMD_REG);
 377
 378         if (xfer->tx_buf)
 379                 mdata->tx_sgl = xfer->tx_sg.sgl;
 380         if (xfer->rx_buf)
 381                 mdata->rx_sgl = xfer->rx_sg.sgl;
 382
 383         if (mdata->tx_sgl) {
 384                 xfer->tx_dma = sg_dma_address(mdata->tx_sgl);
 385                 mdata->tx_sgl_len = sg_dma_len(mdata->tx_sgl);
 386         }
 387         if (mdata->rx_sgl) {
 388                 xfer->rx_dma = sg_dma_address(mdata->rx_sgl);
 389                 mdata->rx_sgl_len = sg_dma_len(mdata->rx_sgl);
 390         }
 391
 392         mtk_spi_update_mdata_len(master);
 393         mtk_spi_setup_packet(master);
 394         mtk_spi_setup_dma_addr(master, xfer);
 395         mtk_spi_enable_transfer(master);
 396
 397         return 1;
 398 }
 399
 400 static int mtk_spi_transfer_one(struct spi_master *master,
 401                                 struct spi_device *spi,
 402                                 struct spi_transfer *xfer)
 403 {
 404         if (master->can_dma(master, spi, xfer))
 405                 return mtk_spi_dma_transfer(master, spi, xfer);
 406         else
 407                 return mtk_spi_fifo_transfer(master, spi, xfer);
 408 }
 409
 410 static bool mtk_spi_can_dma(struct spi_master *master,
 411                             struct spi_device *spi,
 412                             struct spi_transfer *xfer)
 413 {
 414         return xfer->len > MTK_SPI_MAX_FIFO_SIZE;
 415 }
 416
 417 static int mtk_spi_setup(struct spi_device *spi)
 418 {
 419         struct mtk_spi *mdata = spi_master_get_devdata(spi->master);
 420
 421         if (!spi->controller_data)
 422                 spi->controller_data = (void *)&mtk_default_chip_info;
 423
 424         if (mdata->dev_comp->need_pad_sel && gpio_is_valid(spi->cs_gpio))
 425                 gpio_direction_output(spi->cs_gpio, !(spi->mode & SPI_CS_HIGH));
 426
 427         return 0;
 428 }
 429
 430 static irqreturn_t mtk_spi_interrupt(int irq, void *dev_id)
 431 {
 432         u32 cmd, reg_val, cnt, remainder;
 433         struct spi_master *master = dev_id;
 434         struct mtk_spi *mdata = spi_master_get_devdata(master);
 435         struct spi_transfer *trans = mdata->cur_transfer;
 436
 437         reg_val = readl(mdata->base + SPI_STATUS0_REG);
 438         if (reg_val & MTK_SPI_PAUSE_INT_STATUS)
 439                 mdata->state = MTK_SPI_PAUSED;
 440         else
 441                 mdata->state = MTK_SPI_IDLE;
 442
 443         if (!master->can_dma(master, NULL, trans)) {
 444                 if (trans->rx_buf) {
 445                         cnt = mdata->xfer_len / 4;
 446                         ioread32_rep(mdata->base + SPI_RX_DATA_REG,
 447                                      trans->rx_buf, cnt);
 448                         remainder = mdata->xfer_len % 4;
 449                         if (remainder > 0) {
 450                                 reg_val = readl(mdata->base + SPI_RX_DATA_REG);
 451                                 memcpy(trans->rx_buf + (cnt * 4),
 452                                         &reg_val, remainder);
 453                         }
 454                 }
 455                 spi_finalize_current_transfer(master);
 456                 return IRQ_HANDLED;
 457         }
 458
 459         if (mdata->tx_sgl)
 460                 trans->tx_dma += mdata->xfer_len;
 461         if (mdata->rx_sgl)
 462                 trans->rx_dma += mdata->xfer_len;
 463
 464         if (mdata->tx_sgl && (mdata->tx_sgl_len == 0)) {
 465                 mdata->tx_sgl = sg_next(mdata->tx_sgl);
 466                 if (mdata->tx_sgl) {
 467                         trans->tx_dma = sg_dma_address(mdata->tx_sgl);
 468                         mdata->tx_sgl_len = sg_dma_len(mdata->tx_sgl);
 469                 }
 470         }
 471         if (mdata->rx_sgl && (mdata->rx_sgl_len == 0)) {
 472                 mdata->rx_sgl = sg_next(mdata->rx_sgl);
 473                 if (mdata->rx_sgl) {
 474                         trans->rx_dma = sg_dma_address(mdata->rx_sgl);
 475                         mdata->rx_sgl_len = sg_dma_len(mdata->rx_sgl);
 476                 }
 477         }
 478
 479         if (!mdata->tx_sgl && !mdata->rx_sgl) {
 480                 /* spi disable dma */
 481                 cmd = readl(mdata->base + SPI_CMD_REG);
 482                 cmd &= ~SPI_CMD_TX_DMA;
 483                 cmd &= ~SPI_CMD_RX_DMA;
 484                 writel(cmd, mdata->base + SPI_CMD_REG);
 485
 486                 spi_finalize_current_transfer(master);
 487                 return IRQ_HANDLED;
 488         }
 489
 490         mtk_spi_update_mdata_len(master);
 491         mtk_spi_setup_packet(master);
 492         mtk_spi_setup_dma_addr(master, trans);
 493         mtk_spi_enable_transfer(master);
 494
 495         return IRQ_HANDLED;
 496 }
 497
 498 static int mtk_spi_probe(struct platform_device *pdev)
 499 {
 500         struct spi_master *master;
 501         struct mtk_spi *mdata;
 502         const struct of_device_id *of_id;
 503         struct resource *res;
 504         int i, irq, ret;
 505
 506         master = spi_alloc_master(&pdev->dev, sizeof(*mdata));
 507         if (!master) {
 508                 dev_err(&pdev->dev, "failed to alloc spi master\n");
 509                 return -ENOMEM;
 510         }
 511
 512         master->auto_runtime_pm = true;
 513         master->dev.of_node = pdev->dev.of_node;
 514         master->mode_bits = SPI_CPOL | SPI_CPHA;
 515
 516         master->set_cs = mtk_spi_set_cs;
 517         master->prepare_message = mtk_spi_prepare_message;
 518         master->transfer_one = mtk_spi_transfer_one;
 519         master->can_dma = mtk_spi_can_dma;
 520         master->setup = mtk_spi_setup;
 521
 522         of_id = of_match_node(mtk_spi_of_match, pdev->dev.of_node);
 523         if (!of_id) {
 524                 dev_err(&pdev->dev, "failed to probe of_node\n");
 525                 ret = -EINVAL;
 526                 goto err_put_master;
 527         }
 528
 529         mdata = spi_master_get_devdata(master);
 530         mdata->dev_comp = of_id->data;
 531         if (mdata->dev_comp->must_tx)
 532                 master->flags = SPI_MASTER_MUST_TX;
 533
 534         if (mdata->dev_comp->need_pad_sel) {
 535                 mdata->pad_num = of_property_count_u32_elems(
 536                         pdev->dev.of_node,
 537                         "mediatek,pad-select");
 538                 if (mdata->pad_num < 0) {
 539                         dev_err(&pdev->dev,
 540                                 "No 'mediatek,pad-select' property\n");
 541                         ret = -EINVAL;
 542                         goto err_put_master;
 543                 }
 544
 545                 mdata->pad_sel = devm_kmalloc_array(&pdev->dev, mdata->pad_num,
 546                                                     sizeof(u32), GFP_KERNEL);
 547                 if (!mdata->pad_sel) {
 548                         ret = -ENOMEM;
 549                         goto err_put_master;
 550                 }
 551
 552                 for (i = 0; i < mdata->pad_num; i++) {
 553                         of_property_read_u32_index(pdev->dev.of_node,
 554                                                    "mediatek,pad-select",
 555                                                    i, &mdata->pad_sel[i]);
 556                         if (mdata->pad_sel[i] > MT8173_SPI_MAX_PAD_SEL) {
 557                                 dev_err(&pdev->dev, "wrong pad-sel[%d]: %u\n",
 558                                         i, mdata->pad_sel[i]);
 559                                 ret = -EINVAL;
 560                                 goto err_put_master;
 561                         }
 562                 }
 563         }
 564
 565         platform_set_drvdata(pdev, master);
 566
 567         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 568         if (!res) {
 569                 ret = -ENODEV;
 570                 dev_err(&pdev->dev, "failed to determine base address\n");
 571                 goto err_put_master;
 572         }
 573
 574         mdata->base = devm_ioremap_resource(&pdev->dev, res);
 575         if (IS_ERR(mdata->base)) {
 576                 ret = PTR_ERR(mdata->base);
 577                 goto err_put_master;
 578         }
 579
 580         irq = platform_get_irq(pdev, 0);
 581         if (irq < 0) {
 582                 dev_err(&pdev->dev, "failed to get irq (%d)\n", irq);
 583                 ret = irq;
 584                 goto err_put_master;
 585         }
 586
 587         if (!pdev->dev.dma_mask)
 588                 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
 589
 590         ret = devm_request_irq(&pdev->dev, irq, mtk_spi_interrupt,
 591                                IRQF_TRIGGER_NONE, dev_name(&pdev->dev), master);
 592         if (ret) {
 593                 dev_err(&pdev->dev, "failed to register irq (%d)\n", ret);
 594                 goto err_put_master;
 595         }
 596
 597         mdata->parent_clk = devm_clk_get(&pdev->dev, "parent-clk");
 598         if (IS_ERR(mdata->parent_clk)) {
 599                 ret = PTR_ERR(mdata->parent_clk);
 600                 dev_err(&pdev->dev, "failed to get parent-clk: %d\n", ret);
 601                 goto err_put_master;
 602         }
 603
 604         mdata->sel_clk = devm_clk_get(&pdev->dev, "sel-clk");
 605         if (IS_ERR(mdata->sel_clk)) {
 606                 ret = PTR_ERR(mdata->sel_clk);
 607                 dev_err(&pdev->dev, "failed to get sel-clk: %d\n", ret);
 608                 goto err_put_master;
 609         }
 610
 611         mdata->spi_clk = devm_clk_get(&pdev->dev, "spi-clk");
 612         if (IS_ERR(mdata->spi_clk)) {
 613                 ret = PTR_ERR(mdata->spi_clk);
 614                 dev_err(&pdev->dev, "failed to get spi-clk: %d\n", ret);
 615                 goto err_put_master;
 616         }
 617
 618         ret = clk_prepare_enable(mdata->spi_clk);
 619         if (ret < 0) {
 620                 dev_err(&pdev->dev, "failed to enable spi_clk (%d)\n", ret);
 621                 goto err_put_master;
 622         }
 623
 624         ret = clk_set_parent(mdata->sel_clk, mdata->parent_clk);
 625         if (ret < 0) {
 626                 dev_err(&pdev->dev, "failed to clk_set_parent (%d)\n", ret);
 627                 clk_disable_unprepare(mdata->spi_clk);
 628                 goto err_put_master;
 629         }
 630
 631         clk_disable_unprepare(mdata->spi_clk);
 632
 633         pm_runtime_enable(&pdev->dev);
 634
 635         ret = devm_spi_register_master(&pdev->dev, master);
 636         if (ret) {
 637                 dev_err(&pdev->dev, "failed to register master (%d)\n", ret);
 638                 goto err_disable_runtime_pm;
 639         }
 640
 641         if (mdata->dev_comp->need_pad_sel) {
 642                 if (mdata->pad_num != master->num_chipselect) {
 643                         dev_err(&pdev->dev,
 644                                 "pad_num does not match num_chipselect(%d != %d)\n",
 645                                 mdata->pad_num, master->num_chipselect);
 646                         ret = -EINVAL;
 647                         goto err_disable_runtime_pm;
 648                 }
 649
 650                 if (!master->cs_gpios && master->num_chipselect > 1) {
 651                         dev_err(&pdev->dev,
 652                                 "cs_gpios not specified and num_chipselect > 1\n");
 653                         ret = -EINVAL;
 654                         goto err_disable_runtime_pm;
 655                 }
 656
 657                 if (master->cs_gpios) {
 658                         for (i = 0; i < master->num_chipselect; i++) {
 659                                 ret = devm_gpio_request(&pdev->dev,
 660                                                         master->cs_gpios[i],
 661                                                         dev_name(&pdev->dev));
 662                                 if (ret) {
 663                                         dev_err(&pdev->dev,
 664                                                 "can't get CS GPIO %i\n", i);
 665                                         goto err_disable_runtime_pm;
 666                                 }
 667                         }
 668                 }
 669         }
 670
 671         return 0;
 672
 673 err_disable_runtime_pm:
 674         pm_runtime_disable(&pdev->dev);
 675 err_put_master:
 676         spi_master_put(master);
 677
 678         return ret;
 679 }
 680
 681 static int mtk_spi_remove(struct platform_device *pdev)
 682 {
 683         struct spi_master *master = platform_get_drvdata(pdev);
 684         struct mtk_spi *mdata = spi_master_get_devdata(master);
 685
 686         pm_runtime_disable(&pdev->dev);
 687
 688         mtk_spi_reset(mdata);
 689
 690         return 0;
 691 }
 692
 693 #ifdef CONFIG_PM_SLEEP
 694 static int mtk_spi_suspend(struct device *dev)
 695 {
 696         int ret;
 697         struct spi_master *master = dev_get_drvdata(dev);
 698         struct mtk_spi *mdata = spi_master_get_devdata(master);
 699
 700         ret = spi_master_suspend(master);
 701         if (ret)
 702                 return ret;
 703
 704         if (!pm_runtime_suspended(dev))
 705                 clk_disable_unprepare(mdata->spi_clk);
 706
 707         return ret;
 708 }
 709
 710 static int mtk_spi_resume(struct device *dev)
 711 {
 712         int ret;
 713         struct spi_master *master = dev_get_drvdata(dev);
 714         struct mtk_spi *mdata = spi_master_get_devdata(master);
 715
 716         if (!pm_runtime_suspended(dev)) {
 717                 ret = clk_prepare_enable(mdata->spi_clk);
 718                 if (ret < 0) {
 719                         dev_err(dev, "failed to enable spi_clk (%d)\n", ret);
 720                         return ret;
 721                 }
 722         }
 723
 724         ret = spi_master_resume(master);
 725         if (ret < 0)
 726                 clk_disable_unprepare(mdata->spi_clk);
 727
 728         return ret;
 729 }
 730 #endif /* CONFIG_PM_SLEEP */
 731
 732 #ifdef CONFIG_PM
 733 static int mtk_spi_runtime_suspend(struct device *dev)
 734 {
 735         struct spi_master *master = dev_get_drvdata(dev);
 736         struct mtk_spi *mdata = spi_master_get_devdata(master);
 737
 738         clk_disable_unprepare(mdata->spi_clk);
 739
 740         return 0;
 741 }
 742
 743 static int mtk_spi_runtime_resume(struct device *dev)
 744 {
 745         struct spi_master *master = dev_get_drvdata(dev);
 746         struct mtk_spi *mdata = spi_master_get_devdata(master);
 747         int ret;
 748
 749         ret = clk_prepare_enable(mdata->spi_clk);
 750         if (ret < 0) {
 751                 dev_err(dev, "failed to enable spi_clk (%d)\n", ret);
 752                 return ret;
 753         }
 754
 755         return 0;
 756 }
 757 #endif /* CONFIG_PM */
 758
 759 static const struct dev_pm_ops mtk_spi_pm = {
 760         SET_SYSTEM_SLEEP_PM_OPS(mtk_spi_suspend, mtk_spi_resume)
 761         SET_RUNTIME_PM_OPS(mtk_spi_runtime_suspend,
 762                            mtk_spi_runtime_resume, NULL)
 763 };
 764
 765 static struct platform_driver mtk_spi_driver = {
 766         .driver = {
 767                 .name = "mtk-spi",
 768                 .pm     = &mtk_spi_pm,
 769                 .of_match_table = mtk_spi_of_match,
 770         },
 771         .probe = mtk_spi_probe,
 772         .remove = mtk_spi_remove,
 773 };
 774
 775 module_platform_driver(mtk_spi_driver);
 776
 777 MODULE_DESCRIPTION("MTK SPI Controller driver");
 778 MODULE_AUTHOR("Leilk Liu <leilk.liu@mediatek.com>");
 779 MODULE_LICENSE("GPL v2");
 780 MODULE_ALIAS("platform:mtk-spi");