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         unsigned int clk_rate;
 122         u32 speed_hz;
 123         const u8 *txbuf;
 124         u8 *rxbuf;
 125         int tx_bytes;
 126         int rx_bytes;
 127         u8 dev_busy;
 128         u32 is_decoded_cs;
 129 };
 130
 131 /* Macros for the SPI controller read/write */
 132 static inline u32 cdns_spi_read(struct cdns_spi *xspi, u32 offset)
 133 {
 134         return readl_relaxed(xspi->regs + offset);
 135 }
 136
 137 static inline void cdns_spi_write(struct cdns_spi *xspi, u32 offset, u32 val)
 138 {
 139         writel_relaxed(val, xspi->regs + offset);
 140 }
 141
 142 /**
 143  * cdns_spi_init_hw - Initialize the hardware and configure the SPI controller
 144  * @xspi:       Pointer to the cdns_spi structure
 145  *
 146  * On reset the SPI controller is configured to be in master mode, baud rate
 147  * divisor is set to 4, threshold value for TX FIFO not full interrupt is set
 148  * to 1 and size of the word to be transferred as 8 bit.
 149  * This function initializes the SPI controller to disable and clear all the
 150  * interrupts, enable manual slave select and manual start, deselect all the
 151  * chip select lines, and enable the SPI controller.
 152  */
 153 static void cdns_spi_init_hw(struct cdns_spi *xspi)
 154 {
 155         u32 ctrl_reg = CDNS_SPI_CR_DEFAULT;
 156
 157         if (xspi->is_decoded_cs)
 158                 ctrl_reg |= CDNS_SPI_CR_PERI_SEL;
 159
 160         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 161         cdns_spi_write(xspi, CDNS_SPI_IDR, CDNS_SPI_IXR_ALL);
 162
 163         /* Clear the RX FIFO */
 164         while (cdns_spi_read(xspi, CDNS_SPI_ISR) & CDNS_SPI_IXR_RXNEMTY)
 165                 cdns_spi_read(xspi, CDNS_SPI_RXD);
 166
 167         cdns_spi_write(xspi, CDNS_SPI_ISR, CDNS_SPI_IXR_ALL);
 168         cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
 169         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
 170 }
 171
 172 /**
 173  * cdns_spi_chipselect - Select or deselect the chip select line
 174  * @spi:        Pointer to the spi_device structure
 175  * @is_high:    Select(0) or deselect (1) the chip select line
 176  */
 177 static void cdns_spi_chipselect(struct spi_device *spi, bool is_high)
 178 {
 179         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 180         u32 ctrl_reg;
 181
 182         ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
 183
 184         if (is_high) {
 185                 /* Deselect the slave */
 186                 ctrl_reg |= CDNS_SPI_CR_SSCTRL;
 187         } else {
 188                 /* Select the slave */
 189                 ctrl_reg &= ~CDNS_SPI_CR_SSCTRL;
 190                 if (!(xspi->is_decoded_cs))
 191                         ctrl_reg |= ((~(CDNS_SPI_SS0 << spi->chip_select)) <<
 192                                      CDNS_SPI_SS_SHIFT) &
 193                                      CDNS_SPI_CR_SSCTRL;
 194                 else
 195                         ctrl_reg |= (spi->chip_select << CDNS_SPI_SS_SHIFT) &
 196                                      CDNS_SPI_CR_SSCTRL;
 197         }
 198
 199         cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
 200 }
 201
 202 /**
 203  * cdns_spi_config_clock_mode - Sets clock polarity and phase
 204  * @spi:        Pointer to the spi_device structure
 205  *
 206  * Sets the requested clock polarity and phase.
 207  */
 208 static void cdns_spi_config_clock_mode(struct spi_device *spi)
 209 {
 210         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 211         u32 ctrl_reg, new_ctrl_reg;
 212
 213         new_ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
 214         ctrl_reg = new_ctrl_reg;
 215
 216         /* Set the SPI clock phase and clock polarity */
 217         new_ctrl_reg &= ~(CDNS_SPI_CR_CPHA | CDNS_SPI_CR_CPOL);
 218         if (spi->mode & SPI_CPHA)
 219                 new_ctrl_reg |= CDNS_SPI_CR_CPHA;
 220         if (spi->mode & SPI_CPOL)
 221                 new_ctrl_reg |= CDNS_SPI_CR_CPOL;
 222
 223         if (new_ctrl_reg != ctrl_reg) {
 224                 /*
 225                  * Just writing the CR register does not seem to apply the clock
 226                  * setting changes. This is problematic when changing the clock
 227                  * polarity as it will cause the SPI slave to see spurious clock
 228                  * transitions. To workaround the issue toggle the ER register.
 229                  */
 230                 cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 231                 cdns_spi_write(xspi, CDNS_SPI_CR, new_ctrl_reg);
 232                 cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
 233         }
 234 }
 235
 236 /**
 237  * cdns_spi_config_clock_freq - Sets clock frequency
 238  * @spi:        Pointer to the spi_device structure
 239  * @transfer:   Pointer to the spi_transfer structure which provides
 240  *              information about next transfer setup parameters
 241  *
 242  * Sets the requested clock frequency.
 243  * Note: If the requested frequency is not an exact match with what can be
 244  * obtained using the prescalar value the driver sets the clock frequency which
 245  * is lower than the requested frequency (maximum lower) for the transfer. If
 246  * the requested frequency is higher or lower than that is supported by the SPI
 247  * controller the driver will set the highest or lowest frequency supported by
 248  * controller.
 249  */
 250 static void cdns_spi_config_clock_freq(struct spi_device *spi,
 251                                        struct spi_transfer *transfer)
 252 {
 253         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 254         u32 ctrl_reg, baud_rate_val;
 255         unsigned long frequency;
 256
 257         frequency = xspi->clk_rate;
 258
 259         ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
 260
 261         /* Set the clock frequency */
 262         if (xspi->speed_hz != transfer->speed_hz) {
 263                 /* first valid value is 1 */
 264                 baud_rate_val = CDNS_SPI_BAUD_DIV_MIN;
 265                 while ((baud_rate_val < CDNS_SPI_BAUD_DIV_MAX) &&
 266                        (frequency / (2 << baud_rate_val)) > transfer->speed_hz)
 267                         baud_rate_val++;
 268
 269                 ctrl_reg &= ~CDNS_SPI_CR_BAUD_DIV;
 270                 ctrl_reg |= baud_rate_val << CDNS_SPI_BAUD_DIV_SHIFT;
 271
 272                 xspi->speed_hz = frequency / (2 << baud_rate_val);
 273         }
 274         cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
 275 }
 276
 277 /**
 278  * cdns_spi_setup_transfer - Configure SPI controller for specified transfer
 279  * @spi:        Pointer to the spi_device structure
 280  * @transfer:   Pointer to the spi_transfer structure which provides
 281  *              information about next transfer setup parameters
 282  *
 283  * Sets the operational mode of SPI controller for the next SPI transfer and
 284  * sets the requested clock frequency.
 285  *
 286  * Return:      Always 0
 287  */
 288 static int cdns_spi_setup_transfer(struct spi_device *spi,
 289                                    struct spi_transfer *transfer)
 290 {
 291         struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
 292
 293         cdns_spi_config_clock_freq(spi, transfer);
 294
 295         dev_dbg(&spi->dev, "%s, mode %d, %u bits/w, %u clock speed\n",
 296                 __func__, spi->mode, spi->bits_per_word,
 297                 xspi->speed_hz);
 298
 299         return 0;
 300 }
 301
 302 /**
 303  * cdns_spi_fill_tx_fifo - Fills the TX FIFO with as many bytes as possible
 304  * @xspi:       Pointer to the cdns_spi structure
 305  */
 306 static void cdns_spi_fill_tx_fifo(struct cdns_spi *xspi)
 307 {
 308         unsigned long trans_cnt = 0;
 309
 310         while ((trans_cnt < CDNS_SPI_FIFO_DEPTH) &&
 311                (xspi->tx_bytes > 0)) {
 312                 if (xspi->txbuf)
 313                         cdns_spi_write(xspi, CDNS_SPI_TXD, *xspi->txbuf++);
 314                 else
 315                         cdns_spi_write(xspi, CDNS_SPI_TXD, 0);
 316
 317                 xspi->tx_bytes--;
 318                 trans_cnt++;
 319         }
 320 }
 321
 322 /**
 323  * cdns_spi_irq - Interrupt service routine of the SPI controller
 324  * @irq:        IRQ number
 325  * @dev_id:     Pointer to the xspi structure
 326  *
 327  * This function handles TX empty and Mode Fault interrupts only.
 328  * On TX empty interrupt this function reads the received data from RX FIFO and
 329  * fills the TX FIFO if there is any data remaining to be transferred.
 330  * On Mode Fault interrupt this function indicates that transfer is completed,
 331  * the SPI subsystem will identify the error as the remaining bytes to be
 332  * transferred is non-zero.
 333  *
 334  * Return:      IRQ_HANDLED when handled; IRQ_NONE otherwise.
 335  */
 336 static irqreturn_t cdns_spi_irq(int irq, void *dev_id)
 337 {
 338         struct spi_master *master = dev_id;
 339         struct cdns_spi *xspi = spi_master_get_devdata(master);
 340         u32 intr_status, status;
 341
 342         status = IRQ_NONE;
 343         intr_status = cdns_spi_read(xspi, CDNS_SPI_ISR);
 344         cdns_spi_write(xspi, CDNS_SPI_ISR, intr_status);
 345
 346         if (intr_status & CDNS_SPI_IXR_MODF) {
 347                 /* Indicate that transfer is completed, the SPI subsystem will
 348                  * identify the error as the remaining bytes to be
 349                  * transferred is non-zero
 350                  */
 351                 cdns_spi_write(xspi, CDNS_SPI_IDR, CDNS_SPI_IXR_DEFAULT);
 352                 spi_finalize_current_transfer(master);
 353                 status = IRQ_HANDLED;
 354         } else if (intr_status & CDNS_SPI_IXR_TXOW) {
 355                 unsigned long trans_cnt;
 356
 357                 trans_cnt = xspi->rx_bytes - xspi->tx_bytes;
 358
 359                 /* Read out the data from the RX FIFO */
 360                 while (trans_cnt) {
 361                         u8 data;
 362
 363                         data = cdns_spi_read(xspi, CDNS_SPI_RXD);
 364                         if (xspi->rxbuf)
 365                                 *xspi->rxbuf++ = data;
 366
 367                         xspi->rx_bytes--;
 368                         trans_cnt--;
 369                 }
 370
 371                 if (xspi->tx_bytes) {
 372                         /* There is more data to send */
 373                         cdns_spi_fill_tx_fifo(xspi);
 374                 } else {
 375                         /* Transfer is completed */
 376                         cdns_spi_write(xspi, CDNS_SPI_IDR,
 377                                        CDNS_SPI_IXR_DEFAULT);
 378                         spi_finalize_current_transfer(master);
 379                 }
 380                 status = IRQ_HANDLED;
 381         }
 382
 383         return status;
 384 }
 385
 386 static int cdns_prepare_message(struct spi_master *master,
 387                                 struct spi_message *msg)
 388 {
 389         cdns_spi_config_clock_mode(msg->spi);
 390         return 0;
 391 }
 392
 393 /**
 394  * cdns_transfer_one - Initiates the SPI transfer
 395  * @master:     Pointer to spi_master structure
 396  * @spi:        Pointer to the spi_device structure
 397  * @transfer:   Pointer to the spi_transfer structure which provides
 398  *              information about next transfer parameters
 399  *
 400  * This function fills the TX FIFO, starts the SPI transfer and
 401  * returns a positive transfer count so that core will wait for completion.
 402  *
 403  * Return:      Number of bytes transferred in the last transfer
 404  */
 405 static int cdns_transfer_one(struct spi_master *master,
 406                              struct spi_device *spi,
 407                              struct spi_transfer *transfer)
 408 {
 409         struct cdns_spi *xspi = spi_master_get_devdata(master);
 410
 411         xspi->txbuf = transfer->tx_buf;
 412         xspi->rxbuf = transfer->rx_buf;
 413         xspi->tx_bytes = transfer->len;
 414         xspi->rx_bytes = transfer->len;
 415
 416         cdns_spi_setup_transfer(spi, transfer);
 417
 418         cdns_spi_fill_tx_fifo(xspi);
 419
 420         cdns_spi_write(xspi, CDNS_SPI_IER, CDNS_SPI_IXR_DEFAULT);
 421         return transfer->len;
 422 }
 423
 424 /**
 425  * cdns_prepare_transfer_hardware - Prepares hardware for transfer.
 426  * @master:     Pointer to the spi_master structure which provides
 427  *              information about the controller.
 428  *
 429  * This function enables SPI master controller.
 430  *
 431  * Return:      0 always
 432  */
 433 static int cdns_prepare_transfer_hardware(struct spi_master *master)
 434 {
 435         struct cdns_spi *xspi = spi_master_get_devdata(master);
 436
 437         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
 438
 439         return 0;
 440 }
 441
 442 /**
 443  * cdns_unprepare_transfer_hardware - Relaxes hardware after transfer
 444  * @master:     Pointer to the spi_master structure which provides
 445  *              information about the controller.
 446  *
 447  * This function disables the SPI master controller.
 448  *
 449  * Return:      0 always
 450  */
 451 static int cdns_unprepare_transfer_hardware(struct spi_master *master)
 452 {
 453         struct cdns_spi *xspi = spi_master_get_devdata(master);
 454
 455         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 456
 457         return 0;
 458 }
 459
 460 /**
 461  * cdns_spi_probe - Probe method for the SPI driver
 462  * @pdev:       Pointer to the platform_device structure
 463  *
 464  * This function initializes the driver data structures and the hardware.
 465  *
 466  * Return:      0 on success and error value on error
 467  */
 468 static int cdns_spi_probe(struct platform_device *pdev)
 469 {
 470         int ret = 0, irq;
 471         struct spi_master *master;
 472         struct cdns_spi *xspi;
 473         struct resource *res;
 474         u32 num_cs;
 475
 476         master = spi_alloc_master(&pdev->dev, sizeof(*xspi));
 477         if (!master)
 478                 return -ENOMEM;
 479
 480         xspi = spi_master_get_devdata(master);
 481         master->dev.of_node = pdev->dev.of_node;
 482         platform_set_drvdata(pdev, master);
 483
 484         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 485         xspi->regs = devm_ioremap_resource(&pdev->dev, res);
 486         if (IS_ERR(xspi->regs)) {
 487                 ret = PTR_ERR(xspi->regs);
 488                 goto remove_master;
 489         }
 490
 491         xspi->pclk = devm_clk_get(&pdev->dev, "pclk");
 492         if (IS_ERR(xspi->pclk)) {
 493                 dev_err(&pdev->dev, "pclk clock not found.\n");
 494                 ret = PTR_ERR(xspi->pclk);
 495                 goto remove_master;
 496         }
 497
 498         xspi->ref_clk = devm_clk_get(&pdev->dev, "ref_clk");
 499         if (IS_ERR(xspi->ref_clk)) {
 500                 dev_err(&pdev->dev, "ref_clk clock not found.\n");
 501                 ret = PTR_ERR(xspi->ref_clk);
 502                 goto remove_master;
 503         }
 504
 505         ret = clk_prepare_enable(xspi->pclk);
 506         if (ret) {
 507                 dev_err(&pdev->dev, "Unable to enable APB clock.\n");
 508                 goto remove_master;
 509         }
 510
 511         ret = clk_prepare_enable(xspi->ref_clk);
 512         if (ret) {
 513                 dev_err(&pdev->dev, "Unable to enable device clock.\n");
 514                 goto clk_dis_apb;
 515         }
 516
 517         pm_runtime_enable(&pdev->dev);
 518         pm_runtime_use_autosuspend(&pdev->dev);
 519         pm_runtime_set_autosuspend_delay(&pdev->dev, SPI_AUTOSUSPEND_TIMEOUT);
 520         pm_runtime_set_active(&pdev->dev);
 521
 522         ret = of_property_read_u32(pdev->dev.of_node, "num-cs", &num_cs);
 523         if (ret < 0)
 524                 master->num_chipselect = CDNS_SPI_DEFAULT_NUM_CS;
 525         else
 526                 master->num_chipselect = num_cs;
 527
 528         ret = of_property_read_u32(pdev->dev.of_node, "is-decoded-cs",
 529                                    &xspi->is_decoded_cs);
 530         if (ret < 0)
 531                 xspi->is_decoded_cs = 0;
 532
 533         /* SPI controller initializations */
 534         cdns_spi_init_hw(xspi);
 535
 536         pm_runtime_mark_last_busy(&pdev->dev);
 537         pm_runtime_put_autosuspend(&pdev->dev);
 538
 539         irq = platform_get_irq(pdev, 0);
 540         if (irq <= 0) {
 541                 ret = -ENXIO;
 542                 dev_err(&pdev->dev, "irq number is invalid\n");
 543                 goto clk_dis_all;
 544         }
 545
 546         ret = devm_request_irq(&pdev->dev, irq, cdns_spi_irq,
 547                                0, pdev->name, master);
 548         if (ret != 0) {
 549                 ret = -ENXIO;
 550                 dev_err(&pdev->dev, "request_irq failed\n");
 551                 goto clk_dis_all;
 552         }
 553
 554         master->prepare_transfer_hardware = cdns_prepare_transfer_hardware;
 555         master->prepare_message = cdns_prepare_message;
 556         master->transfer_one = cdns_transfer_one;
 557         master->unprepare_transfer_hardware = cdns_unprepare_transfer_hardware;
 558         master->set_cs = cdns_spi_chipselect;
 559         master->auto_runtime_pm = true;
 560         master->mode_bits = SPI_CPOL | SPI_CPHA;
 561
 562         xspi->clk_rate = clk_get_rate(xspi->ref_clk);
 563         /* Set to default valid value */
 564         master->max_speed_hz = xspi->clk_rate / 4;
 565         xspi->speed_hz = master->max_speed_hz;
 566
 567         master->bits_per_word_mask = SPI_BPW_MASK(8);
 568
 569         ret = spi_register_master(master);
 570         if (ret) {
 571                 dev_err(&pdev->dev, "spi_register_master failed\n");
 572                 goto clk_dis_all;
 573         }
 574
 575         return ret;
 576
 577 clk_dis_all:
 578         pm_runtime_set_suspended(&pdev->dev);
 579         pm_runtime_disable(&pdev->dev);
 580         clk_disable_unprepare(xspi->ref_clk);
 581 clk_dis_apb:
 582         clk_disable_unprepare(xspi->pclk);
 583 remove_master:
 584         spi_master_put(master);
 585         return ret;
 586 }
 587
 588 /**
 589  * cdns_spi_remove - Remove method for the SPI driver
 590  * @pdev:       Pointer to the platform_device structure
 591  *
 592  * This function is called if a device is physically removed from the system or
 593  * if the driver module is being unloaded. It frees all resources allocated to
 594  * the device.
 595  *
 596  * Return:      0 on success and error value on error
 597  */
 598 static int cdns_spi_remove(struct platform_device *pdev)
 599 {
 600         struct spi_master *master = platform_get_drvdata(pdev);
 601         struct cdns_spi *xspi = spi_master_get_devdata(master);
 602
 603         cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
 604
 605         clk_disable_unprepare(xspi->ref_clk);
 606         clk_disable_unprepare(xspi->pclk);
 607         pm_runtime_set_suspended(&pdev->dev);
 608         pm_runtime_disable(&pdev->dev);
 609
 610         spi_unregister_master(master);
 611
 612         return 0;
 613 }
 614
 615 /**
 616  * cdns_spi_suspend - Suspend method for the SPI driver
 617  * @dev:        Address of the platform_device structure
 618  *
 619  * This function disables the SPI controller and
 620  * changes the driver state to "suspend"
 621  *
 622  * Return:      0 on success and error value on error
 623  */
 624 static int __maybe_unused cdns_spi_suspend(struct device *dev)
 625 {
 626         struct platform_device *pdev = to_platform_device(dev);
 627         struct spi_master *master = platform_get_drvdata(pdev);
 628
 629         return spi_master_suspend(master);
 630 }
 631
 632 /**
 633  * cdns_spi_resume - Resume method for the SPI driver
 634  * @dev:        Address of the platform_device structure
 635  *
 636  * This function changes the driver state to "ready"
 637  *
 638  * Return:      0 on success and error value on error
 639  */
 640 static int __maybe_unused cdns_spi_resume(struct device *dev)
 641 {
 642         struct platform_device *pdev = to_platform_device(dev);
 643         struct spi_master *master = platform_get_drvdata(pdev);
 644
 645         return spi_master_resume(master);
 646 }
 647
 648 /**
 649  * cdns_spi_runtime_resume - Runtime resume method for the SPI driver
 650  * @dev:        Address of the platform_device structure
 651  *
 652  * This function enables the clocks
 653  *
 654  * Return:      0 on success and error value on error
 655  */
 656 static int __maybe_unused cnds_runtime_resume(struct device *dev)
 657 {
 658         struct spi_master *master = dev_get_drvdata(dev);
 659         struct cdns_spi *xspi = spi_master_get_devdata(master);
 660         int ret;
 661
 662         ret = clk_prepare_enable(xspi->pclk);
 663         if (ret) {
 664                 dev_err(dev, "Cannot enable APB clock.\n");
 665                 return ret;
 666         }
 667
 668         ret = clk_prepare_enable(xspi->ref_clk);
 669         if (ret) {
 670                 dev_err(dev, "Cannot enable device clock.\n");
 671                 clk_disable(xspi->pclk);
 672                 return ret;
 673         }
 674         return 0;
 675 }
 676
 677 /**
 678  * cdns_spi_runtime_suspend - Runtime suspend method for the SPI driver
 679  * @dev:        Address of the platform_device structure
 680  *
 681  * This function disables the clocks
 682  *
 683  * Return:      Always 0
 684  */
 685 static int __maybe_unused cnds_runtime_suspend(struct device *dev)
 686 {
 687         struct spi_master *master = dev_get_drvdata(dev);
 688         struct cdns_spi *xspi = spi_master_get_devdata(master);
 689
 690         clk_disable_unprepare(xspi->ref_clk);
 691         clk_disable_unprepare(xspi->pclk);
 692
 693         return 0;
 694 }
 695
 696 static const struct dev_pm_ops cdns_spi_dev_pm_ops = {
 697         SET_RUNTIME_PM_OPS(cnds_runtime_suspend,
 698                            cnds_runtime_resume, NULL)
 699         SET_SYSTEM_SLEEP_PM_OPS(cdns_spi_suspend, cdns_spi_resume)
 700 };
 701
 702 static const struct of_device_id cdns_spi_of_match[] = {
 703         { .compatible = "xlnx,zynq-spi-r1p6" },
 704         { .compatible = "cdns,spi-r1p6" },
 705         { /* end of table */ }
 706 };
 707 MODULE_DEVICE_TABLE(of, cdns_spi_of_match);
 708
 709 /* cdns_spi_driver - This structure defines the SPI subsystem platform driver */
 710 static struct platform_driver cdns_spi_driver = {
 711         .probe  = cdns_spi_probe,
 712         .remove = cdns_spi_remove,
 713         .driver = {
 714                 .name = CDNS_SPI_NAME,
 715                 .of_match_table = cdns_spi_of_match,
 716                 .pm = &cdns_spi_dev_pm_ops,
 717         },
 718 };
 719
 720 module_platform_driver(cdns_spi_driver);
 721
 722 MODULE_AUTHOR("Xilinx, Inc.");
 723 MODULE_DESCRIPTION("Cadence SPI driver");
 724 MODULE_LICENSE("GPL");