blob: f557029370527b91cf312fc8161d354e1b2cc5c2 [file] [log] [blame]
Harini Katakamc474b382014-04-14 14:36:53 +05301/*
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/spi/spi.h>
23
24/* Name of this driver */
25#define CDNS_SPI_NAME "cdns-spi"
26
27/* Register offset definitions */
28#define CDNS_SPI_CR_OFFSET 0x00 /* Configuration Register, RW */
29#define CDNS_SPI_ISR_OFFSET 0x04 /* Interrupt Status Register, RO */
30#define CDNS_SPI_IER_OFFSET 0x08 /* Interrupt Enable Register, WO */
31#define CDNS_SPI_IDR_OFFSET 0x0c /* Interrupt Disable Register, WO */
32#define CDNS_SPI_IMR_OFFSET 0x10 /* Interrupt Enabled Mask Register, RO */
33#define CDNS_SPI_ER_OFFSET 0x14 /* Enable/Disable Register, RW */
34#define CDNS_SPI_DR_OFFSET 0x18 /* Delay Register, RW */
35#define CDNS_SPI_TXD_OFFSET 0x1C /* Data Transmit Register, WO */
36#define CDNS_SPI_RXD_OFFSET 0x20 /* Data Receive Register, RO */
37#define CDNS_SPI_SICR_OFFSET 0x24 /* Slave Idle Count Register, RW */
38#define CDNS_SPI_THLD_OFFSET 0x28 /* Transmit FIFO Watermark Register,RW */
39
40/*
41 * SPI Configuration Register bit Masks
42 *
43 * This register contains various control bits that affect the operation
44 * of the SPI controller
45 */
46#define CDNS_SPI_CR_MANSTRT_MASK 0x00010000 /* Manual TX Start */
47#define CDNS_SPI_CR_CPHA_MASK 0x00000004 /* Clock Phase Control */
48#define CDNS_SPI_CR_CPOL_MASK 0x00000002 /* Clock Polarity Control */
49#define CDNS_SPI_CR_SSCTRL_MASK 0x00003C00 /* Slave Select Mask */
50#define CDNS_SPI_CR_BAUD_DIV_MASK 0x00000038 /* Baud Rate Divisor Mask */
51#define CDNS_SPI_CR_MSTREN_MASK 0x00000001 /* Master Enable Mask */
52#define CDNS_SPI_CR_MANSTRTEN_MASK 0x00008000 /* Manual TX Enable Mask */
53#define CDNS_SPI_CR_SSFORCE_MASK 0x00004000 /* Manual SS Enable Mask */
54#define CDNS_SPI_CR_BAUD_DIV_4_MASK 0x00000008 /* Default Baud Div Mask */
55#define CDNS_SPI_CR_DEFAULT_MASK (CDNS_SPI_CR_MSTREN_MASK | \
56 CDNS_SPI_CR_SSCTRL_MASK | \
57 CDNS_SPI_CR_SSFORCE_MASK | \
58 CDNS_SPI_CR_BAUD_DIV_4_MASK)
59
60/*
61 * SPI Configuration Register - Baud rate and slave select
62 *
63 * These are the values used in the calculation of baud rate divisor and
64 * setting the slave select.
65 */
66
67#define CDNS_SPI_BAUD_DIV_MAX 7 /* Baud rate divisor maximum */
68#define CDNS_SPI_BAUD_DIV_MIN 1 /* Baud rate divisor minimum */
69#define CDNS_SPI_BAUD_DIV_SHIFT 3 /* Baud rate divisor shift in CR */
70#define CDNS_SPI_SS_SHIFT 10 /* Slave Select field shift in CR */
71#define CDNS_SPI_SS0 0x1 /* Slave Select zero */
72
73/*
74 * SPI Interrupt Registers bit Masks
75 *
76 * All the four interrupt registers (Status/Mask/Enable/Disable) have the same
77 * bit definitions.
78 */
79#define CDNS_SPI_IXR_TXOW_MASK 0x00000004 /* SPI TX FIFO Overwater */
80#define CDNS_SPI_IXR_MODF_MASK 0x00000002 /* SPI Mode Fault */
81#define CDNS_SPI_IXR_RXNEMTY_MASK 0x00000010 /* SPI RX FIFO Not Empty */
82#define CDNS_SPI_IXR_DEFAULT_MASK (CDNS_SPI_IXR_TXOW_MASK | \
83 CDNS_SPI_IXR_MODF_MASK)
84#define CDNS_SPI_IXR_TXFULL_MASK 0x00000008 /* SPI TX Full */
85#define CDNS_SPI_IXR_ALL_MASK 0x0000007F /* SPI all interrupts */
86
87/*
88 * SPI Enable Register bit Masks
89 *
90 * This register is used to enable or disable the SPI controller
91 */
92#define CDNS_SPI_ER_ENABLE_MASK 0x00000001 /* SPI Enable Bit Mask */
93#define CDNS_SPI_ER_DISABLE_MASK 0x0 /* SPI Disable Bit Mask */
94
95/* SPI FIFO depth in bytes */
96#define CDNS_SPI_FIFO_DEPTH 128
97
98/* Default number of chip select lines */
99#define CDNS_SPI_DEFAULT_NUM_CS 4
100
101/**
102 * struct cdns_spi - This definition defines spi driver instance
103 * @regs: Virtual address of the SPI controller registers
104 * @ref_clk: Pointer to the peripheral clock
105 * @pclk: Pointer to the APB clock
106 * @speed_hz: Current SPI bus clock speed in Hz
107 * @txbuf: Pointer to the TX buffer
108 * @rxbuf: Pointer to the RX buffer
109 * @tx_bytes: Number of bytes left to transfer
110 * @rx_bytes: Number of bytes requested
111 * @dev_busy: Device busy flag
112 * @is_decoded_cs: Flag for decoder property set or not
113 */
114struct cdns_spi {
115 void __iomem *regs;
116 struct clk *ref_clk;
117 struct clk *pclk;
118 u32 speed_hz;
119 const u8 *txbuf;
120 u8 *rxbuf;
121 int tx_bytes;
122 int rx_bytes;
123 u8 dev_busy;
124 u32 is_decoded_cs;
125};
126
127/* Macros for the SPI controller read/write */
128static inline u32 cdns_spi_read(struct cdns_spi *xspi, u32 offset)
129{
130 return readl_relaxed(xspi->regs + offset);
131}
132
133static inline void cdns_spi_write(struct cdns_spi *xspi, u32 offset, u32 val)
134{
135 writel_relaxed(val, xspi->regs + offset);
136}
137
138/**
139 * cdns_spi_init_hw - Initialize the hardware and configure the SPI controller
140 * @xspi: Pointer to the cdns_spi structure
141 *
142 * On reset the SPI controller is configured to be in master mode, baud rate
143 * divisor is set to 4, threshold value for TX FIFO not full interrupt is set
144 * to 1 and size of the word to be transferred as 8 bit.
145 * This function initializes the SPI controller to disable and clear all the
146 * interrupts, enable manual slave select and manual start, deselect all the
147 * chip select lines, and enable the SPI controller.
148 */
149static void cdns_spi_init_hw(struct cdns_spi *xspi)
150{
151 cdns_spi_write(xspi, CDNS_SPI_ER_OFFSET,
152 CDNS_SPI_ER_DISABLE_MASK);
153 cdns_spi_write(xspi, CDNS_SPI_IDR_OFFSET,
154 CDNS_SPI_IXR_ALL_MASK);
155
156 /* Clear the RX FIFO */
157 while (cdns_spi_read(xspi, CDNS_SPI_ISR_OFFSET) &
158 CDNS_SPI_IXR_RXNEMTY_MASK)
159 cdns_spi_read(xspi, CDNS_SPI_RXD_OFFSET);
160
161 cdns_spi_write(xspi, CDNS_SPI_ISR_OFFSET,
162 CDNS_SPI_IXR_ALL_MASK);
163 cdns_spi_write(xspi, CDNS_SPI_CR_OFFSET,
164 CDNS_SPI_CR_DEFAULT_MASK);
165 cdns_spi_write(xspi, CDNS_SPI_ER_OFFSET,
166 CDNS_SPI_ER_ENABLE_MASK);
167}
168
169/**
170 * cdns_spi_chipselect - Select or deselect the chip select line
171 * @spi: Pointer to the spi_device structure
172 * @is_on: Select(0) or deselect (1) the chip select line
173 */
174static void cdns_spi_chipselect(struct spi_device *spi, bool is_high)
175{
176 struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
177 u32 ctrl_reg;
178
179 ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR_OFFSET);
180
181 if (is_high) {
182 /* Deselect the slave */
183 ctrl_reg |= CDNS_SPI_CR_SSCTRL_MASK;
184 } else {
185 /* Select the slave */
186 ctrl_reg &= ~CDNS_SPI_CR_SSCTRL_MASK;
187 if (!(xspi->is_decoded_cs))
188 ctrl_reg |= ((~(CDNS_SPI_SS0 << spi->chip_select)) <<
189 CDNS_SPI_SS_SHIFT) &
190 CDNS_SPI_CR_SSCTRL_MASK;
191 else
192 ctrl_reg |= (spi->chip_select << CDNS_SPI_SS_SHIFT) &
193 CDNS_SPI_CR_SSCTRL_MASK;
194 }
195
196 cdns_spi_write(xspi, CDNS_SPI_CR_OFFSET, ctrl_reg);
197}
198
199/**
200 * cdns_spi_config_clock_mode - Sets clock polarity and phase
201 * @spi: Pointer to the spi_device structure
202 *
203 * Sets the requested clock polarity and phase.
204 */
205static void cdns_spi_config_clock_mode(struct spi_device *spi)
206{
207 struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
Lars-Peter Clausena39e65e2014-07-10 11:26:28 +0200208 u32 ctrl_reg, new_ctrl_reg;
Harini Katakamc474b382014-04-14 14:36:53 +0530209
Lars-Peter Clausena39e65e2014-07-10 11:26:28 +0200210 new_ctrl_reg = ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR_OFFSET);
Harini Katakamc474b382014-04-14 14:36:53 +0530211
212 /* Set the SPI clock phase and clock polarity */
Lars-Peter Clausena39e65e2014-07-10 11:26:28 +0200213 new_ctrl_reg &= ~(CDNS_SPI_CR_CPHA_MASK | CDNS_SPI_CR_CPOL_MASK);
Harini Katakamc474b382014-04-14 14:36:53 +0530214 if (spi->mode & SPI_CPHA)
Lars-Peter Clausena39e65e2014-07-10 11:26:28 +0200215 new_ctrl_reg |= CDNS_SPI_CR_CPHA_MASK;
Harini Katakamc474b382014-04-14 14:36:53 +0530216 if (spi->mode & SPI_CPOL)
Lars-Peter Clausena39e65e2014-07-10 11:26:28 +0200217 new_ctrl_reg |= CDNS_SPI_CR_CPOL_MASK;
Harini Katakamc474b382014-04-14 14:36:53 +0530218
Lars-Peter Clausena39e65e2014-07-10 11:26:28 +0200219 if (new_ctrl_reg != ctrl_reg) {
220 /*
221 * Just writing the CR register does not seem to apply the clock
222 * setting changes. This is problematic when changing the clock
223 * polarity as it will cause the SPI slave to see spurious clock
224 * transitions. To workaround the issue toggle the ER register.
225 */
226 cdns_spi_write(xspi, CDNS_SPI_ER_OFFSET,
227 CDNS_SPI_ER_DISABLE_MASK);
228 cdns_spi_write(xspi, CDNS_SPI_CR_OFFSET, new_ctrl_reg);
229 cdns_spi_write(xspi, CDNS_SPI_ER_OFFSET,
230 CDNS_SPI_ER_ENABLE_MASK);
231 }
Harini Katakamc474b382014-04-14 14:36:53 +0530232}
233
234/**
235 * cdns_spi_config_clock_freq - Sets clock frequency
236 * @spi: Pointer to the spi_device structure
237 * @transfer: Pointer to the spi_transfer structure which provides
238 * information about next transfer setup parameters
239 *
240 * Sets the requested clock frequency.
241 * Note: If the requested frequency is not an exact match with what can be
242 * obtained using the prescalar value the driver sets the clock frequency which
243 * is lower than the requested frequency (maximum lower) for the transfer. If
244 * the requested frequency is higher or lower than that is supported by the SPI
245 * controller the driver will set the highest or lowest frequency supported by
246 * controller.
247 */
248static void cdns_spi_config_clock_freq(struct spi_device *spi,
249 struct spi_transfer *transfer)
250{
251 struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
252 u32 ctrl_reg, baud_rate_val;
253 unsigned long frequency;
254
255 frequency = clk_get_rate(xspi->ref_clk);
256
257 ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR_OFFSET);
258
259 /* Set the clock frequency */
260 if (xspi->speed_hz != transfer->speed_hz) {
261 /* first valid value is 1 */
262 baud_rate_val = CDNS_SPI_BAUD_DIV_MIN;
263 while ((baud_rate_val < CDNS_SPI_BAUD_DIV_MAX) &&
264 (frequency / (2 << baud_rate_val)) > transfer->speed_hz)
265 baud_rate_val++;
266
267 ctrl_reg &= ~CDNS_SPI_CR_BAUD_DIV_MASK;
268 ctrl_reg |= baud_rate_val << CDNS_SPI_BAUD_DIV_SHIFT;
269
270 xspi->speed_hz = frequency / (2 << baud_rate_val);
271 }
272 cdns_spi_write(xspi, CDNS_SPI_CR_OFFSET, ctrl_reg);
273}
274
275/**
276 * cdns_spi_setup_transfer - Configure SPI controller for specified transfer
277 * @spi: Pointer to the spi_device structure
278 * @transfer: Pointer to the spi_transfer structure which provides
279 * information about next transfer setup parameters
280 *
281 * Sets the operational mode of SPI controller for the next SPI transfer and
282 * sets the requested clock frequency.
283 *
284 * Return: Always 0
285 */
286static int cdns_spi_setup_transfer(struct spi_device *spi,
287 struct spi_transfer *transfer)
288{
289 struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
290
291 cdns_spi_config_clock_freq(spi, transfer);
292
293 dev_dbg(&spi->dev, "%s, mode %d, %u bits/w, %u clock speed\n",
294 __func__, spi->mode, spi->bits_per_word,
295 xspi->speed_hz);
296
297 return 0;
298}
299
300/**
301 * cdns_spi_fill_tx_fifo - Fills the TX FIFO with as many bytes as possible
302 * @xspi: Pointer to the cdns_spi structure
303 */
304static void cdns_spi_fill_tx_fifo(struct cdns_spi *xspi)
305{
306 unsigned long trans_cnt = 0;
307
308 while ((trans_cnt < CDNS_SPI_FIFO_DEPTH) &&
309 (xspi->tx_bytes > 0)) {
310 if (xspi->txbuf)
311 cdns_spi_write(xspi, CDNS_SPI_TXD_OFFSET,
312 *xspi->txbuf++);
313 else
314 cdns_spi_write(xspi, CDNS_SPI_TXD_OFFSET, 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 */
335static 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_OFFSET);
343 cdns_spi_write(xspi, CDNS_SPI_ISR_OFFSET, intr_status);
344
345 if (intr_status & CDNS_SPI_IXR_MODF_MASK) {
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_OFFSET,
351 CDNS_SPI_IXR_DEFAULT_MASK);
352 spi_finalize_current_transfer(master);
353 status = IRQ_HANDLED;
354 } else if (intr_status & CDNS_SPI_IXR_TXOW_MASK) {
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_OFFSET);
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_OFFSET,
377 CDNS_SPI_IXR_DEFAULT_MASK);
378 spi_finalize_current_transfer(master);
379 }
380 status = IRQ_HANDLED;
381 }
382
383 return status;
384}
385
386/**
387 * cdns_transfer_one - Initiates the SPI transfer
388 * @master: Pointer to spi_master structure
389 * @spi: Pointer to the spi_device structure
390 * @transfer: Pointer to the spi_transfer structure which provides
391 * information about next transfer parameters
392 *
393 * This function fills the TX FIFO, starts the SPI transfer and
394 * returns a positive transfer count so that core will wait for completion.
395 *
396 * Return: Number of bytes transferred in the last transfer
397 */
398static int cdns_transfer_one(struct spi_master *master,
399 struct spi_device *spi,
400 struct spi_transfer *transfer)
401{
402 struct cdns_spi *xspi = spi_master_get_devdata(master);
403
404 xspi->txbuf = transfer->tx_buf;
405 xspi->rxbuf = transfer->rx_buf;
406 xspi->tx_bytes = transfer->len;
407 xspi->rx_bytes = transfer->len;
408
409 cdns_spi_setup_transfer(spi, transfer);
410
411 cdns_spi_fill_tx_fifo(xspi);
412
413 cdns_spi_write(xspi, CDNS_SPI_IER_OFFSET,
414 CDNS_SPI_IXR_DEFAULT_MASK);
415 return transfer->len;
416}
417
418/**
419 * cdns_prepare_transfer_hardware - Prepares hardware for transfer.
420 * @master: Pointer to the spi_master structure which provides
421 * information about the controller.
422 *
423 * This function enables SPI master controller.
424 *
425 * Return: 0 always
426 */
427static int cdns_prepare_transfer_hardware(struct spi_master *master)
428{
429 struct cdns_spi *xspi = spi_master_get_devdata(master);
430
431 cdns_spi_config_clock_mode(master->cur_msg->spi);
432
433 cdns_spi_write(xspi, CDNS_SPI_ER_OFFSET,
434 CDNS_SPI_ER_ENABLE_MASK);
435
436 return 0;
437}
438
439/**
440 * cdns_unprepare_transfer_hardware - Relaxes hardware after transfer
441 * @master: Pointer to the spi_master structure which provides
442 * information about the controller.
443 *
444 * This function disables the SPI master controller.
445 *
446 * Return: 0 always
447 */
448static int cdns_unprepare_transfer_hardware(struct spi_master *master)
449{
450 struct cdns_spi *xspi = spi_master_get_devdata(master);
451
452 cdns_spi_write(xspi, CDNS_SPI_ER_OFFSET,
453 CDNS_SPI_ER_DISABLE_MASK);
454
455 return 0;
456}
457
458/**
459 * cdns_spi_probe - Probe method for the SPI driver
460 * @pdev: Pointer to the platform_device structure
461 *
462 * This function initializes the driver data structures and the hardware.
463 *
464 * Return: 0 on success and error value on error
465 */
466static int cdns_spi_probe(struct platform_device *pdev)
467{
468 int ret = 0, irq;
469 struct spi_master *master;
470 struct cdns_spi *xspi;
471 struct resource *res;
472 u32 num_cs;
473
474 master = spi_alloc_master(&pdev->dev, sizeof(*xspi));
475 if (master == NULL)
476 return -ENOMEM;
477
478 xspi = spi_master_get_devdata(master);
479 master->dev.of_node = pdev->dev.of_node;
480 platform_set_drvdata(pdev, master);
481
482 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
483 xspi->regs = devm_ioremap_resource(&pdev->dev, res);
484 if (IS_ERR(xspi->regs)) {
485 ret = PTR_ERR(xspi->regs);
486 goto remove_master;
487 }
488
489 xspi->pclk = devm_clk_get(&pdev->dev, "pclk");
490 if (IS_ERR(xspi->pclk)) {
491 dev_err(&pdev->dev, "pclk clock not found.\n");
492 ret = PTR_ERR(xspi->pclk);
493 goto remove_master;
494 }
495
496 xspi->ref_clk = devm_clk_get(&pdev->dev, "ref_clk");
497 if (IS_ERR(xspi->ref_clk)) {
498 dev_err(&pdev->dev, "ref_clk clock not found.\n");
499 ret = PTR_ERR(xspi->ref_clk);
500 goto remove_master;
501 }
502
503 ret = clk_prepare_enable(xspi->pclk);
504 if (ret) {
505 dev_err(&pdev->dev, "Unable to enable APB clock.\n");
506 goto remove_master;
507 }
508
509 ret = clk_prepare_enable(xspi->ref_clk);
510 if (ret) {
511 dev_err(&pdev->dev, "Unable to enable device clock.\n");
512 goto clk_dis_apb;
513 }
514
515 /* SPI controller initializations */
516 cdns_spi_init_hw(xspi);
517
518 irq = platform_get_irq(pdev, 0);
519 if (irq <= 0) {
520 ret = -ENXIO;
521 dev_err(&pdev->dev, "irq number is invalid\n");
522 goto remove_master;
523 }
524
525 ret = devm_request_irq(&pdev->dev, irq, cdns_spi_irq,
526 0, pdev->name, master);
527 if (ret != 0) {
528 ret = -ENXIO;
529 dev_err(&pdev->dev, "request_irq failed\n");
530 goto remove_master;
531 }
532
533 ret = of_property_read_u32(pdev->dev.of_node, "num-cs", &num_cs);
534
535 if (ret < 0)
536 master->num_chipselect = CDNS_SPI_DEFAULT_NUM_CS;
537 else
538 master->num_chipselect = num_cs;
539
540 ret = of_property_read_u32(pdev->dev.of_node, "is-decoded-cs",
541 &xspi->is_decoded_cs);
542
543 if (ret < 0)
544 xspi->is_decoded_cs = 0;
545
546 master->prepare_transfer_hardware = cdns_prepare_transfer_hardware;
547 master->transfer_one = cdns_transfer_one;
548 master->unprepare_transfer_hardware = cdns_unprepare_transfer_hardware;
549 master->set_cs = cdns_spi_chipselect;
550 master->mode_bits = SPI_CPOL | SPI_CPHA;
551
552 /* Set to default valid value */
553 master->max_speed_hz = clk_get_rate(xspi->ref_clk) / 4;
554 xspi->speed_hz = master->max_speed_hz;
555
556 master->bits_per_word_mask = SPI_BPW_MASK(8);
557
558 ret = spi_register_master(master);
559 if (ret) {
560 dev_err(&pdev->dev, "spi_register_master failed\n");
561 goto clk_dis_all;
562 }
563
564 return ret;
565
566clk_dis_all:
567 clk_disable_unprepare(xspi->ref_clk);
568clk_dis_apb:
569 clk_disable_unprepare(xspi->pclk);
570remove_master:
571 spi_master_put(master);
572 return ret;
573}
574
575/**
576 * cdns_spi_remove - Remove method for the SPI driver
577 * @pdev: Pointer to the platform_device structure
578 *
579 * This function is called if a device is physically removed from the system or
580 * if the driver module is being unloaded. It frees all resources allocated to
581 * the device.
582 *
583 * Return: 0 on success and error value on error
584 */
585static int cdns_spi_remove(struct platform_device *pdev)
586{
587 struct spi_master *master = platform_get_drvdata(pdev);
588 struct cdns_spi *xspi = spi_master_get_devdata(master);
589
590 cdns_spi_write(xspi, CDNS_SPI_ER_OFFSET,
591 CDNS_SPI_ER_DISABLE_MASK);
592
593 clk_disable_unprepare(xspi->ref_clk);
594 clk_disable_unprepare(xspi->pclk);
595
596 spi_unregister_master(master);
597
598 return 0;
599}
600
601/**
602 * cdns_spi_suspend - Suspend method for the SPI driver
603 * @dev: Address of the platform_device structure
604 *
605 * This function disables the SPI controller and
606 * changes the driver state to "suspend"
607 *
608 * Return: Always 0
609 */
610static int __maybe_unused cdns_spi_suspend(struct device *dev)
611{
612 struct platform_device *pdev = container_of(dev,
613 struct platform_device, dev);
614 struct spi_master *master = platform_get_drvdata(pdev);
615 struct cdns_spi *xspi = spi_master_get_devdata(master);
616
617 spi_master_suspend(master);
618
619 clk_disable_unprepare(xspi->ref_clk);
620
621 clk_disable_unprepare(xspi->pclk);
622
623 return 0;
624}
625
626/**
627 * cdns_spi_resume - Resume method for the SPI driver
628 * @dev: Address of the platform_device structure
629 *
630 * This function changes the driver state to "ready"
631 *
632 * Return: 0 on success and error value on error
633 */
634static int __maybe_unused cdns_spi_resume(struct device *dev)
635{
636 struct platform_device *pdev = container_of(dev,
637 struct platform_device, dev);
638 struct spi_master *master = platform_get_drvdata(pdev);
639 struct cdns_spi *xspi = spi_master_get_devdata(master);
640 int ret = 0;
641
642 ret = clk_prepare_enable(xspi->pclk);
643 if (ret) {
644 dev_err(dev, "Cannot enable APB clock.\n");
645 return ret;
646 }
647
648 ret = clk_prepare_enable(xspi->ref_clk);
649 if (ret) {
650 dev_err(dev, "Cannot enable device clock.\n");
651 clk_disable(xspi->pclk);
652 return ret;
653 }
654 spi_master_resume(master);
655
656 return 0;
657}
658
659static SIMPLE_DEV_PM_OPS(cdns_spi_dev_pm_ops, cdns_spi_suspend,
660 cdns_spi_resume);
661
662static struct of_device_id cdns_spi_of_match[] = {
663 { .compatible = "xlnx,zynq-spi-r1p6" },
664 { .compatible = "cdns,spi-r1p6" },
665 { /* end of table */ }
666};
667MODULE_DEVICE_TABLE(of, cdns_spi_of_match);
668
669/* cdns_spi_driver - This structure defines the SPI subsystem platform driver */
670static struct platform_driver cdns_spi_driver = {
671 .probe = cdns_spi_probe,
672 .remove = cdns_spi_remove,
673 .driver = {
674 .name = CDNS_SPI_NAME,
675 .owner = THIS_MODULE,
676 .of_match_table = cdns_spi_of_match,
677 .pm = &cdns_spi_dev_pm_ops,
678 },
679};
680
681module_platform_driver(cdns_spi_driver);
682
683MODULE_AUTHOR("Xilinx, Inc.");
684MODULE_DESCRIPTION("Cadence SPI driver");
685MODULE_LICENSE("GPL");