drivers/spi/spi-cadence.c

   1 /*
   2  * Cadence SPI controller driver (master mode only)
   3  *
   4  * Copyright (C) 2008 - 2014 Xilinx, Inc.
   5  *
   6  * based on Blackfin On-Chip SPI Driver (spi_bfin5xx.c)
   7  *
   8  * This program is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU General Public License version 2 as published by the
  10  * Free Software Foundation; either version 2 of the License, or (at your
  11  * option) any later version.
  12  */
  13
  14 #include <linux/clk.h>
  15 #include <linux/delay.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/io.h>
  18 #include <linux/module.h>
  19 #include <linux/of_irq.h>
  20 #include <linux/of_address.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/pm_runtime.h>
  23 #include <linux/spi/spi.h>
  24
  25 /* Name of this driver */
  26 #define CDNS_SPI_NAME           "cdns-spi"
  27
  28 /* Register offset definitions */
  29 #define CDNS_SPI_CR     0x00 /* Configuration  Register, RW */
  30 #define CDNS_SPI_ISR    0x04 /* Interrupt Status Register, RO */
  31 #define CDNS_SPI_IER    0x08 /* Interrupt Enable Register, WO */
  32 #define CDNS_SPI_IDR    0x0c /* Interrupt Disable Register, WO */
  33 #define CDNS_SPI_IMR    0x10 /* Interrupt Enabled Mask Register, RO */
  34 #define CDNS_SPI_ER     0x14 /* Enable/Disable Register, RW */
  35 #define CDNS_SPI_DR     0x18 /* Delay Register, RW */
  36 #define CDNS_SPI_TXD    0x1C /* Data Transmit Register, WO */
  37 #define CDNS_SPI_RXD    0x20 /* Data Receive Register, RO */
  38 #define CDNS_SPI_SICR   0x24 /* Slave Idle Count Register, RW */
  39 #define CDNS_SPI_THLD   0x28 /* Transmit FIFO Watermark Register,RW */
  40
  41 #define SPI_AUTOSUSPEND_TIMEOUT         3000
  42 /*
  43  * SPI Configuration Register bit Masks
  44  *
  45  * This register contains various control bits that affect the operation
  46  * of the SPI controller
  47  */
  48 #define CDNS_SPI_CR_MANSTRT     0x00010000 /* Manual TX Start */
  49 #define CDNS_SPI_CR_CPHA                0x00000004 /* Clock Phase Control */
  50 #define CDNS_SPI_CR_CPOL                0x00000002 /* Clock Polarity Control */
  51 #define CDNS_SPI_CR_SSCTRL              0x00003C00 /* Slave Select Mask */
  52 #define CDNS_SPI_CR_PERI_SEL    0x00000200 /* Peripheral Select Decode */
  53 #define CDNS_SPI_CR_BAUD_DIV    0x00000038 /* Baud Rate Divisor Mask */
  54 #define CDNS_SPI_CR_MSTREN              0x00000001 /* Master Enable Mask */
  55 #define CDNS_SPI_CR_MANSTRTEN   0x00008000 /* Manual TX Enable Mask */
  56 #define CDNS_SPI_CR_SSFORCE     0x00004000 /* Manual SS Enable Mask */
  57 #define CDNS_SPI_CR_BAUD_DIV_4  0x00000008 /* Default Baud Div Mask */
  58 #define CDNS_SPI_CR_DEFAULT     (CDNS_SPI_CR_MSTREN | \
  59                                         CDNS_SPI_CR_SSCTRL | \
  60                                         CDNS_SPI_CR_SSFORCE | \
  61                                         CDNS_SPI_CR_BAUD_DIV_4)
  62
  63 /*
  64  * SPI Configuration Register - Baud rate and slave select
  65  *
  66  * These are the values used in the calculation of baud rate divisor and
  67  * setting the slave select.
  68  */
  69
  70 #define CDNS_SPI_BAUD_DIV_MAX           7 /* Baud rate divisor maximum */
  71 #define CDNS_SPI_BAUD_DIV_MIN           1 /* Baud rate divisor minimum */
  72 #define CDNS_SPI_BAUD_DIV_SHIFT         3 /* Baud rate divisor shift in CR */
  73 #define CDNS_SPI_SS_SHIFT               10 /* Slave Select field shift in CR */
  74 #define CDNS_SPI_SS0                    0x1 /* Slave Select zero */
  75
  76 /*
  77  * SPI Interrupt Registers bit Masks
  78  *
  79  * All the four interrupt registers (Status/Mask/Enable/Disable) have the same
  80  * bit definitions.
  81  */
  82 #define CDNS_SPI_IXR_TXOW       0x00000004 /* SPI TX FIFO Overwater */
  83 #define CDNS_SPI_IXR_MODF       0x00000002 /* SPI Mode Fault */
  84 #define CDNS_SPI_IXR_RXNEMTY 0x00000010 /* SPI RX FIFO Not Empty */
  85 #define CDNS_SPI_IXR_DEFAULT    (CDNS_SPI_IXR_TXOW | \
  86                                         CDNS_SPI_IXR_MODF)
  87 #define CDNS_SPI_IXR_TXFULL     0x00000008 /* SPI TX Full */
  88 #define CDNS_SPI_IXR_ALL        0x0000007F /* SPI all interrupts */
  89
  90 /*
  91  * SPI Enable Register bit Masks
  92  *
  93  * This register is used to enable or disable the SPI controller
  94  */
  95 #define CDNS_SPI_ER_ENABLE      0x00000001 /* SPI Enable Bit Mask */
  96 #define CDNS_SPI_ER_DISABLE     0x0 /* SPI Disable Bit Mask */
  97
  98 /* SPI FIFO depth in bytes */
  99 #define CDNS_SPI_FIFO_DEPTH     128
 100
 101 /* Default number of chip select lines */
 102 #define CDNS_SPI_DEFAULT_NUM_CS         4
 103
 104 /**
 105  * struct cdns_spi - This definition defines spi driver instance
 106  * @regs:               Virtual address of the SPI controller registers
 107  * @ref_clk:            Pointer to the peripheral clock
 108  * @pclk:               Pointer to the APB clock
 109  * @speed_hz:           Current SPI bus clock speed in Hz
 110  * @txbuf:              Pointer to the TX buffer
 111  * @rxbuf:              Pointer to the RX buffer
 112  * @tx_bytes:           Number of bytes left to transfer
 113  * @rx_bytes:           Number of bytes requested
 114  * @dev_busy:           Device busy flag
 115  * @is_decoded_cs:      Flag for decoder property set or not
 116  */
 117 struct cdns_spi {
 118         void __iomem *regs;
 119         struct clk *ref_clk;
 120         struct clk *pclk;
 121         u32 speed_hz;
 122         const u8 *txbuf;
 123         u8 *rxbuf;
 124         int tx_bytes;
 125         int rx_bytes;
 126         u8 dev_busy;
 127         u32 is_decoded_cs;
 128 };
 129
 130 /* Macros for the SPI controller read/write */
 131 static inline u32 cdns_spi_read(struct cdns_spi *xspi, u32 offset)
 132 {
 133         return readl_relaxed(xspi->regs + offset);
 134 }
 135
 136 static inline void cdns_spi_write(struct cdns_spi *xspi, u32 offset, u32 val)
 137 {
 138         writel_relaxed(val, xspi->regs + offset);
 139 }
 140
 141 /**
 142  * cdns_spi_init_hw - Initialize the hardware and configure the SPI controller
 143  * @xspi:       Pointer to the cdns_spi structure
 144  *
 145  * On reset the SPI controller is configured to be in master mode, baud rate
 146  * divisor is set to 4, threshold value for TX FIFO not full interrupt is set
 147  * to 1 and size of the word to be transferred as 8 bit.
 148  * This function initializes the SPI controller to disable and clear all the
 149  * interrupts, enable manual slave select and manual start, deselect all the
 150  * chip select lines, and enable the SPI controller.
 151  */
 152 static void cdns_spi_init_hw(struct cdns_spi *xspi)
 153 {
 154         u32 ctrl_reg = CDNS_SPI_CR_DEFAULT;
 155
 156         if (xspi->is_decoded_cs)
 157                 ctrl_reg |= CDNS_SPI_CR_PERI_SEL;
 158
 159         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 160         cdns_spi_write(xspi, CDNS_SPI_IDR, CDNS_SPI_IXR_ALL);
 161
 162         /* Clear the RX FIFO */
 163         while (cdns_spi_read(xspi, CDNS_SPI_ISR) & CDNS_SPI_IXR_RXNEMTY)
 164                 cdns_spi_read(xspi, CDNS_SPI_RXD);
 165
 166         cdns_spi_write(xspi, CDNS_SPI_ISR, CDNS_SPI_IXR_ALL);
 167         cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
 168         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
 169 }
 170
 171 /**
 172  * cdns_spi_chipselect - Select or deselect the chip select line
 173  * @spi:        Pointer to the spi_device structure
 174  * @is_high:    Select(0) or deselect (1) the chip select line
 175  */
 176 static void cdns_spi_chipselect(struct spi_device *spi, bool is_high)
 177 {
 178         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 179         u32 ctrl_reg;
 180
 181         ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
 182
 183         if (is_high) {
 184                 /* Deselect the slave */
 185                 ctrl_reg |= CDNS_SPI_CR_SSCTRL;
 186         } else {
 187                 /* Select the slave */
 188                 ctrl_reg &= ~CDNS_SPI_CR_SSCTRL;
 189                 if (!(xspi->is_decoded_cs))
 190                         ctrl_reg |= ((~(CDNS_SPI_SS0 << spi->chip_select)) <<
 191                                      CDNS_SPI_SS_SHIFT) &
 192                                      CDNS_SPI_CR_SSCTRL;
 193                 else
 194                         ctrl_reg |= (spi->chip_select << CDNS_SPI_SS_SHIFT) &
 195                                      CDNS_SPI_CR_SSCTRL;
 196         }
 197
 198         cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
 199 }
 200
 201 /**
 202  * cdns_spi_config_clock_mode - Sets clock polarity and phase
 203  * @spi:        Pointer to the spi_device structure
 204  *
 205  * Sets the requested clock polarity and phase.
 206  */
 207 static void cdns_spi_config_clock_mode(struct spi_device *spi)
 208 {
 209         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 210         u32 ctrl_reg, new_ctrl_reg;
 211
 212         new_ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
 213         ctrl_reg = new_ctrl_reg;
 214
 215         /* Set the SPI clock phase and clock polarity */
 216         new_ctrl_reg &= ~(CDNS_SPI_CR_CPHA | CDNS_SPI_CR_CPOL);
 217         if (spi->mode & SPI_CPHA)
 218                 new_ctrl_reg |= CDNS_SPI_CR_CPHA;
 219         if (spi->mode & SPI_CPOL)
 220                 new_ctrl_reg |= CDNS_SPI_CR_CPOL;
 221
 222         if (new_ctrl_reg != ctrl_reg) {
 223                 /*
 224                  * Just writing the CR register does not seem to apply the clock
 225                  * setting changes. This is problematic when changing the clock
 226                  * polarity as it will cause the SPI slave to see spurious clock
 227                  * transitions. To workaround the issue toggle the ER register.
 228                  */
 229                 cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 230                 cdns_spi_write(xspi, CDNS_SPI_CR, new_ctrl_reg);
 231                 cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
 232         }
 233 }
 234
 235 /**
 236  * cdns_spi_config_clock_freq - Sets clock frequency
 237  * @spi:        Pointer to the spi_device structure
 238  * @transfer:   Pointer to the spi_transfer structure which provides
 239  *              information about next transfer setup parameters
 240  *
 241  * Sets the requested clock frequency.
 242  * Note: If the requested frequency is not an exact match with what can be
 243  * obtained using the prescalar value the driver sets the clock frequency which
 244  * is lower than the requested frequency (maximum lower) for the transfer. If
 245  * the requested frequency is higher or lower than that is supported by the SPI
 246  * controller the driver will set the highest or lowest frequency supported by
 247  * controller.
 248  */
 249 static void cdns_spi_config_clock_freq(struct spi_device *spi,
 250                                        struct spi_transfer *transfer)
 251 {
 252         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 253         u32 ctrl_reg, baud_rate_val;
 254         unsigned long frequency;
 255
 256         frequency = clk_get_rate(xspi->ref_clk);
 257
 258         ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
 259
 260         /* Set the clock frequency */
 261         if (xspi->speed_hz != transfer->speed_hz) {
 262                 /* first valid value is 1 */
 263                 baud_rate_val = CDNS_SPI_BAUD_DIV_MIN;
 264                 while ((baud_rate_val < CDNS_SPI_BAUD_DIV_MAX) &&
 265                        (frequency / (2 << baud_rate_val)) > transfer->speed_hz)
 266                         baud_rate_val++;
 267
 268                 ctrl_reg &= ~CDNS_SPI_CR_BAUD_DIV;
 269                 ctrl_reg |= baud_rate_val << CDNS_SPI_BAUD_DIV_SHIFT;
 270
 271                 xspi->speed_hz = frequency / (2 << baud_rate_val);
 272         }
 273         cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
 274 }
 275
 276 /**
 277  * cdns_spi_setup_transfer - Configure SPI controller for specified transfer
 278  * @spi:        Pointer to the spi_device structure
 279  * @transfer:   Pointer to the spi_transfer structure which provides
 280  *              information about next transfer setup parameters
 281  *
 282  * Sets the operational mode of SPI controller for the next SPI transfer and
 283  * sets the requested clock frequency.
 284  *
 285  * Return:      Always 0
 286  */
 287 static int cdns_spi_setup_transfer(struct spi_device *spi,
 288                                    struct spi_transfer *transfer)
 289 {
 290         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 291
 292         cdns_spi_config_clock_freq(spi, transfer);
 293
 294         dev_dbg(&spi->dev, "%s, mode %d, %u bits/w, %u clock speed\n",
 295                 __func__, spi->mode, spi->bits_per_word,
 296                 xspi->speed_hz);
 297
 298         return 0;
 299 }
 300
 301 /**
 302  * cdns_spi_fill_tx_fifo - Fills the TX FIFO with as many bytes as possible
 303  * @xspi:       Pointer to the cdns_spi structure
 304  */
 305 static void cdns_spi_fill_tx_fifo(struct cdns_spi *xspi)
 306 {
 307         unsigned long trans_cnt = 0;
 308
 309         while ((trans_cnt < CDNS_SPI_FIFO_DEPTH) &&
 310                (xspi->tx_bytes > 0)) {
 311                 if (xspi->txbuf)
 312                         cdns_spi_write(xspi, CDNS_SPI_TXD, *xspi->txbuf++);
 313                 else
 314                         cdns_spi_write(xspi, CDNS_SPI_TXD, 0);
 315
 316                 xspi->tx_bytes--;
 317                 trans_cnt++;
 318         }
 319 }
 320
 321 /**
 322  * cdns_spi_irq - Interrupt service routine of the SPI controller
 323  * @irq:        IRQ number
 324  * @dev_id:     Pointer to the xspi structure
 325  *
 326  * This function handles TX empty and Mode Fault interrupts only.
 327  * On TX empty interrupt this function reads the received data from RX FIFO and
 328  * fills the TX FIFO if there is any data remaining to be transferred.
 329  * On Mode Fault interrupt this function indicates that transfer is completed,
 330  * the SPI subsystem will identify the error as the remaining bytes to be
 331  * transferred is non-zero.
 332  *
 333  * Return:      IRQ_HANDLED when handled; IRQ_NONE otherwise.
 334  */
 335 static irqreturn_t cdns_spi_irq(int irq, void *dev_id)
 336 {
 337         struct spi_master *master = dev_id;
 338         struct cdns_spi *xspi = spi_master_get_devdata(master);
 339         u32 intr_status, status;
 340
 341         status = IRQ_NONE;
 342         intr_status = cdns_spi_read(xspi, CDNS_SPI_ISR);
 343         cdns_spi_write(xspi, CDNS_SPI_ISR, intr_status);
 344
 345         if (intr_status & CDNS_SPI_IXR_MODF) {
 346                 /* Indicate that transfer is completed, the SPI subsystem will
 347                  * identify the error as the remaining bytes to be
 348                  * transferred is non-zero
 349                  */
 350                 cdns_spi_write(xspi, CDNS_SPI_IDR, CDNS_SPI_IXR_DEFAULT);
 351                 spi_finalize_current_transfer(master);
 352                 status = IRQ_HANDLED;
 353         } else if (intr_status & CDNS_SPI_IXR_TXOW) {
 354                 unsigned long trans_cnt;
 355
 356                 trans_cnt = xspi->rx_bytes - xspi->tx_bytes;
 357
 358                 /* Read out the data from the RX FIFO */
 359                 while (trans_cnt) {
 360                         u8 data;
 361
 362                         data = cdns_spi_read(xspi, CDNS_SPI_RXD);
 363                         if (xspi->rxbuf)
 364                                 *xspi->rxbuf++ = data;
 365
 366                         xspi->rx_bytes--;
 367                         trans_cnt--;
 368                 }
 369
 370                 if (xspi->tx_bytes) {
 371                         /* There is more data to send */
 372                         cdns_spi_fill_tx_fifo(xspi);
 373                 } else {
 374                         /* Transfer is completed */
 375                         cdns_spi_write(xspi, CDNS_SPI_IDR,
 376                                        CDNS_SPI_IXR_DEFAULT);
 377                         spi_finalize_current_transfer(master);
 378                 }
 379                 status = IRQ_HANDLED;
 380         }
 381
 382         return status;
 383 }
 384
 385 static int cdns_prepare_message(struct spi_master *master,
 386                                 struct spi_message *msg)
 387 {
 388         cdns_spi_config_clock_mode(msg->spi);
 389         return 0;
 390 }
 391
 392 /**
 393  * cdns_transfer_one - Initiates the SPI transfer
 394  * @master:     Pointer to spi_master structure
 395  * @spi:        Pointer to the spi_device structure
 396  * @transfer:   Pointer to the spi_transfer structure which provides
 397  *              information about next transfer parameters
 398  *
 399  * This function fills the TX FIFO, starts the SPI transfer and
 400  * returns a positive transfer count so that core will wait for completion.
 401  *
 402  * Return:      Number of bytes transferred in the last transfer
 403  */
 404 static int cdns_transfer_one(struct spi_master *master,
 405                              struct spi_device *spi,
 406                              struct spi_transfer *transfer)
 407 {
 408         struct cdns_spi *xspi = spi_master_get_devdata(master);
 409
 410         xspi->txbuf = transfer->tx_buf;
 411         xspi->rxbuf = transfer->rx_buf;
 412         xspi->tx_bytes = transfer->len;
 413         xspi->rx_bytes = transfer->len;
 414
 415         cdns_spi_setup_transfer(spi, transfer);
 416
 417         cdns_spi_fill_tx_fifo(xspi);
 418
 419         cdns_spi_write(xspi, CDNS_SPI_IER, CDNS_SPI_IXR_DEFAULT);
 420         return transfer->len;
 421 }
 422
 423 /**
 424  * cdns_prepare_transfer_hardware - Prepares hardware for transfer.
 425  * @master:     Pointer to the spi_master structure which provides
 426  *              information about the controller.
 427  *
 428  * This function enables SPI master controller.
 429  *
 430  * Return:      0 always
 431  */
 432 static int cdns_prepare_transfer_hardware(struct spi_master *master)
 433 {
 434         struct cdns_spi *xspi = spi_master_get_devdata(master);
 435
 436         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
 437
 438         return 0;
 439 }
 440
 441 /**
 442  * cdns_unprepare_transfer_hardware - Relaxes hardware after transfer
 443  * @master:     Pointer to the spi_master structure which provides
 444  *              information about the controller.
 445  *
 446  * This function disables the SPI master controller.
 447  *
 448  * Return:      0 always
 449  */
 450 static int cdns_unprepare_transfer_hardware(struct spi_master *master)
 451 {
 452         struct cdns_spi *xspi = spi_master_get_devdata(master);
 453
 454         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 455
 456         return 0;
 457 }
 458
 459 /**
 460  * cdns_spi_probe - Probe method for the SPI driver
 461  * @pdev:       Pointer to the platform_device structure
 462  *
 463  * This function initializes the driver data structures and the hardware.
 464  *
 465  * Return:      0 on success and error value on error
 466  */
 467 static int cdns_spi_probe(struct platform_device *pdev)
 468 {
 469         int ret = 0, irq;
 470         struct spi_master *master;
 471         struct cdns_spi *xspi;
 472         struct resource *res;
 473         u32 num_cs;
 474
 475         master = spi_alloc_master(&pdev->dev, sizeof(*xspi));
 476         if (!master)
 477                 return -ENOMEM;
 478
 479         xspi = spi_master_get_devdata(master);
 480         master->dev.of_node = pdev->dev.of_node;
 481         platform_set_drvdata(pdev, master);
 482
 483         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 484         xspi->regs = devm_ioremap_resource(&pdev->dev, res);
 485         if (IS_ERR(xspi->regs)) {
 486                 ret = PTR_ERR(xspi->regs);
 487                 goto remove_master;
 488         }
 489
 490         xspi->pclk = devm_clk_get(&pdev->dev, "pclk");
 491         if (IS_ERR(xspi->pclk)) {
 492                 dev_err(&pdev->dev, "pclk clock not found.\n");
 493                 ret = PTR_ERR(xspi->pclk);
 494                 goto remove_master;
 495         }
 496
 497         xspi->ref_clk = devm_clk_get(&pdev->dev, "ref_clk");
 498         if (IS_ERR(xspi->ref_clk)) {
 499                 dev_err(&pdev->dev, "ref_clk clock not found.\n");
 500                 ret = PTR_ERR(xspi->ref_clk);
 501                 goto remove_master;
 502         }
 503
 504         ret = clk_prepare_enable(xspi->pclk);
 505         if (ret) {
 506                 dev_err(&pdev->dev, "Unable to enable APB clock.\n");
 507                 goto remove_master;
 508         }
 509
 510         ret = clk_prepare_enable(xspi->ref_clk);
 511         if (ret) {
 512                 dev_err(&pdev->dev, "Unable to enable device clock.\n");
 513                 goto clk_dis_apb;
 514         }
 515
 516         pm_runtime_enable(&pdev->dev);
 517         pm_runtime_use_autosuspend(&pdev->dev);
 518         pm_runtime_set_autosuspend_delay(&pdev->dev, SPI_AUTOSUSPEND_TIMEOUT);
 519         pm_runtime_set_active(&pdev->dev);
 520
 521         ret = of_property_read_u32(pdev->dev.of_node, "num-cs", &num_cs);
 522         if (ret < 0)
 523                 master->num_chipselect = CDNS_SPI_DEFAULT_NUM_CS;
 524         else
 525                 master->num_chipselect = num_cs;
 526
 527         ret = of_property_read_u32(pdev->dev.of_node, "is-decoded-cs",
 528                                    &xspi->is_decoded_cs);
 529         if (ret < 0)
 530                 xspi->is_decoded_cs = 0;
 531
 532         /* SPI controller initializations */
 533         cdns_spi_init_hw(xspi);
 534
 535         pm_runtime_mark_last_busy(&pdev->dev);
 536         pm_runtime_put_autosuspend(&pdev->dev);
 537
 538         irq = platform_get_irq(pdev, 0);
 539         if (irq <= 0) {
 540                 ret = -ENXIO;
 541                 dev_err(&pdev->dev, "irq number is invalid\n");
 542                 goto clk_dis_all;
 543         }
 544
 545         ret = devm_request_irq(&pdev->dev, irq, cdns_spi_irq,
 546                                0, pdev->name, master);
 547         if (ret != 0) {
 548                 ret = -ENXIO;
 549                 dev_err(&pdev->dev, "request_irq failed\n");
 550                 goto clk_dis_all;
 551         }
 552
 553         master->prepare_transfer_hardware = cdns_prepare_transfer_hardware;
 554         master->prepare_message = cdns_prepare_message;
 555         master->transfer_one = cdns_transfer_one;
 556         master->unprepare_transfer_hardware = cdns_unprepare_transfer_hardware;
 557         master->set_cs = cdns_spi_chipselect;
 558         master->auto_runtime_pm = true;
 559         master->mode_bits = SPI_CPOL | SPI_CPHA;
 560
 561         /* Set to default valid value */
 562         master->max_speed_hz = clk_get_rate(xspi->ref_clk) / 4;
 563         xspi->speed_hz = master->max_speed_hz;
 564
 565         master->bits_per_word_mask = SPI_BPW_MASK(8);
 566
 567         ret = spi_register_master(master);
 568         if (ret) {
 569                 dev_err(&pdev->dev, "spi_register_master failed\n");
 570                 goto clk_dis_all;
 571         }
 572
 573         return ret;
 574
 575 clk_dis_all:
 576         pm_runtime_set_suspended(&pdev->dev);
 577         pm_runtime_disable(&pdev->dev);
 578         clk_disable_unprepare(xspi->ref_clk);
 579 clk_dis_apb:
 580         clk_disable_unprepare(xspi->pclk);
 581 remove_master:
 582         spi_master_put(master);
 583         return ret;
 584 }
 585
 586 /**
 587  * cdns_spi_remove - Remove method for the SPI driver
 588  * @pdev:       Pointer to the platform_device structure
 589  *
 590  * This function is called if a device is physically removed from the system or
 591  * if the driver module is being unloaded. It frees all resources allocated to
 592  * the device.
 593  *
 594  * Return:      0 on success and error value on error
 595  */
 596 static int cdns_spi_remove(struct platform_device *pdev)
 597 {
 598         struct spi_master *master = platform_get_drvdata(pdev);
 599         struct cdns_spi *xspi = spi_master_get_devdata(master);
 600
 601         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 602
 603         clk_disable_unprepare(xspi->ref_clk);
 604         clk_disable_unprepare(xspi->pclk);
 605         pm_runtime_set_suspended(&pdev->dev);
 606         pm_runtime_disable(&pdev->dev);
 607
 608         spi_unregister_master(master);
 609
 610         return 0;
 611 }
 612
 613 /**
 614  * cdns_spi_suspend - Suspend method for the SPI driver
 615  * @dev:        Address of the platform_device structure
 616  *
 617  * This function disables the SPI controller and
 618  * changes the driver state to "suspend"
 619  *
 620  * Return:      0 on success and error value on error
 621  */
 622 static int __maybe_unused cdns_spi_suspend(struct device *dev)
 623 {
 624         struct platform_device *pdev = to_platform_device(dev);
 625         struct spi_master *master = platform_get_drvdata(pdev);
 626
 627         return spi_master_suspend(master);
 628 }
 629
 630 /**
 631  * cdns_spi_resume - Resume method for the SPI driver
 632  * @dev:        Address of the platform_device structure
 633  *
 634  * This function changes the driver state to "ready"
 635  *
 636  * Return:      0 on success and error value on error
 637  */
 638 static int __maybe_unused cdns_spi_resume(struct device *dev)
 639 {
 640         struct platform_device *pdev = to_platform_device(dev);
 641         struct spi_master *master = platform_get_drvdata(pdev);
 642
 643         return spi_master_resume(master);
 644 }
 645
 646 /**
 647  * cdns_spi_runtime_resume - Runtime resume method for the SPI driver
 648  * @dev:        Address of the platform_device structure
 649  *
 650  * This function enables the clocks
 651  *
 652  * Return:      0 on success and error value on error
 653  */
 654 static int __maybe_unused cnds_runtime_resume(struct device *dev)
 655 {
 656         struct spi_master *master = dev_get_drvdata(dev);
 657         struct cdns_spi *xspi = spi_master_get_devdata(master);
 658         int ret;
 659
 660         ret = clk_prepare_enable(xspi->pclk);
 661         if (ret) {
 662                 dev_err(dev, "Cannot enable APB clock.\n");
 663                 return ret;
 664         }
 665
 666         ret = clk_prepare_enable(xspi->ref_clk);
 667         if (ret) {
 668                 dev_err(dev, "Cannot enable device clock.\n");
 669                 clk_disable(xspi->pclk);
 670                 return ret;
 671         }
 672         return 0;
 673 }
 674
 675 /**
 676  * cdns_spi_runtime_suspend - Runtime suspend method for the SPI driver
 677  * @dev:        Address of the platform_device structure
 678  *
 679  * This function disables the clocks
 680  *
 681  * Return:      Always 0
 682  */
 683 static int __maybe_unused cnds_runtime_suspend(struct device *dev)
 684 {
 685         struct spi_master *master = dev_get_drvdata(dev);
 686         struct cdns_spi *xspi = spi_master_get_devdata(master);
 687
 688         clk_disable_unprepare(xspi->ref_clk);
 689         clk_disable_unprepare(xspi->pclk);
 690
 691         return 0;
 692 }
 693
 694 static const struct dev_pm_ops cdns_spi_dev_pm_ops = {
 695         SET_RUNTIME_PM_OPS(cnds_runtime_suspend,
 696                            cnds_runtime_resume, NULL)
 697         SET_SYSTEM_SLEEP_PM_OPS(cdns_spi_suspend, cdns_spi_resume)
 698 };
 699
 700 static const struct of_device_id cdns_spi_of_match[] = {
 701         { .compatible = "xlnx,zynq-spi-r1p6" },
 702         { .compatible = "cdns,spi-r1p6" },
 703         { /* end of table */ }
 704 };
 705 MODULE_DEVICE_TABLE(of, cdns_spi_of_match);
 706
 707 /* cdns_spi_driver - This structure defines the SPI subsystem platform driver */
 708 static struct platform_driver cdns_spi_driver = {
 709         .probe  = cdns_spi_probe,
 710         .remove = cdns_spi_remove,
 711         .driver = {
 712                 .name = CDNS_SPI_NAME,
 713                 .of_match_table = cdns_spi_of_match,
 714                 .pm = &cdns_spi_dev_pm_ops,
 715         },
 716 };
 717
 718 module_platform_driver(cdns_spi_driver);
 719
 720 MODULE_AUTHOR("Xilinx, Inc.");
 721 MODULE_DESCRIPTION("Cadence SPI driver");
 722 MODULE_LICENSE("GPL");