Blame view

drivers/spi/spi-cadence.c 20.7 KB
59899843f   Thomas Gleixner   treewide: Replace...
1
  // SPDX-License-Identifier: GPL-2.0-or-later
c474b3866   Harini Katakam   spi: Add driver f...
2
3
4
5
6
7
  /*
   * Cadence SPI controller driver (master mode only)
   *
   * Copyright (C) 2008 - 2014 Xilinx, Inc.
   *
   * based on Blackfin On-Chip SPI Driver (spi_bfin5xx.c)
c474b3866   Harini Katakam   spi: Add driver f...
8
9
10
11
   */
  
  #include <linux/clk.h>
  #include <linux/delay.h>
cfeefa79d   Linus Walleij   spi: cadence: Con...
12
  #include <linux/gpio/consumer.h>
c474b3866   Harini Katakam   spi: Add driver f...
13
14
15
16
17
18
  #include <linux/interrupt.h>
  #include <linux/io.h>
  #include <linux/module.h>
  #include <linux/of_irq.h>
  #include <linux/of_address.h>
  #include <linux/platform_device.h>
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
19
  #include <linux/pm_runtime.h>
c474b3866   Harini Katakam   spi: Add driver f...
20
21
22
23
24
25
  #include <linux/spi/spi.h>
  
  /* Name of this driver */
  #define CDNS_SPI_NAME		"cdns-spi"
  
  /* Register offset definitions */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
26
27
28
29
30
31
32
33
34
35
36
  #define CDNS_SPI_CR	0x00 /* Configuration  Register, RW */
  #define CDNS_SPI_ISR	0x04 /* Interrupt Status Register, RO */
  #define CDNS_SPI_IER	0x08 /* Interrupt Enable Register, WO */
  #define CDNS_SPI_IDR	0x0c /* Interrupt Disable Register, WO */
  #define CDNS_SPI_IMR	0x10 /* Interrupt Enabled Mask Register, RO */
  #define CDNS_SPI_ER	0x14 /* Enable/Disable Register, RW */
  #define CDNS_SPI_DR	0x18 /* Delay Register, RW */
  #define CDNS_SPI_TXD	0x1C /* Data Transmit Register, WO */
  #define CDNS_SPI_RXD	0x20 /* Data Receive Register, RO */
  #define CDNS_SPI_SICR	0x24 /* Slave Idle Count Register, RW */
  #define CDNS_SPI_THLD	0x28 /* Transmit FIFO Watermark Register,RW */
c474b3866   Harini Katakam   spi: Add driver f...
37

d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
38
  #define SPI_AUTOSUSPEND_TIMEOUT		3000
c474b3866   Harini Katakam   spi: Add driver f...
39
40
41
42
43
44
  /*
   * SPI Configuration Register bit Masks
   *
   * This register contains various control bits that affect the operation
   * of the SPI controller
   */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
45
46
47
48
49
50
51
52
53
54
55
56
57
58
  #define CDNS_SPI_CR_MANSTRT	0x00010000 /* Manual TX Start */
  #define CDNS_SPI_CR_CPHA		0x00000004 /* Clock Phase Control */
  #define CDNS_SPI_CR_CPOL		0x00000002 /* Clock Polarity Control */
  #define CDNS_SPI_CR_SSCTRL		0x00003C00 /* Slave Select Mask */
  #define CDNS_SPI_CR_PERI_SEL	0x00000200 /* Peripheral Select Decode */
  #define CDNS_SPI_CR_BAUD_DIV	0x00000038 /* Baud Rate Divisor Mask */
  #define CDNS_SPI_CR_MSTREN		0x00000001 /* Master Enable Mask */
  #define CDNS_SPI_CR_MANSTRTEN	0x00008000 /* Manual TX Enable Mask */
  #define CDNS_SPI_CR_SSFORCE	0x00004000 /* Manual SS Enable Mask */
  #define CDNS_SPI_CR_BAUD_DIV_4	0x00000008 /* Default Baud Div Mask */
  #define CDNS_SPI_CR_DEFAULT	(CDNS_SPI_CR_MSTREN | \
  					CDNS_SPI_CR_SSCTRL | \
  					CDNS_SPI_CR_SSFORCE | \
  					CDNS_SPI_CR_BAUD_DIV_4)
c474b3866   Harini Katakam   spi: Add driver f...
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
  
  /*
   * SPI Configuration Register - Baud rate and slave select
   *
   * These are the values used in the calculation of baud rate divisor and
   * setting the slave select.
   */
  
  #define CDNS_SPI_BAUD_DIV_MAX		7 /* Baud rate divisor maximum */
  #define CDNS_SPI_BAUD_DIV_MIN		1 /* Baud rate divisor minimum */
  #define CDNS_SPI_BAUD_DIV_SHIFT		3 /* Baud rate divisor shift in CR */
  #define CDNS_SPI_SS_SHIFT		10 /* Slave Select field shift in CR */
  #define CDNS_SPI_SS0			0x1 /* Slave Select zero */
  
  /*
   * SPI Interrupt Registers bit Masks
   *
   * All the four interrupt registers (Status/Mask/Enable/Disable) have the same
   * bit definitions.
   */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
79
80
81
82
83
84
85
  #define CDNS_SPI_IXR_TXOW	0x00000004 /* SPI TX FIFO Overwater */
  #define CDNS_SPI_IXR_MODF	0x00000002 /* SPI Mode Fault */
  #define CDNS_SPI_IXR_RXNEMTY 0x00000010 /* SPI RX FIFO Not Empty */
  #define CDNS_SPI_IXR_DEFAULT	(CDNS_SPI_IXR_TXOW | \
  					CDNS_SPI_IXR_MODF)
  #define CDNS_SPI_IXR_TXFULL	0x00000008 /* SPI TX Full */
  #define CDNS_SPI_IXR_ALL	0x0000007F /* SPI all interrupts */
c474b3866   Harini Katakam   spi: Add driver f...
86
87
88
89
90
91
  
  /*
   * SPI Enable Register bit Masks
   *
   * This register is used to enable or disable the SPI controller
   */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
92
93
  #define CDNS_SPI_ER_ENABLE	0x00000001 /* SPI Enable Bit Mask */
  #define CDNS_SPI_ER_DISABLE	0x0 /* SPI Disable Bit Mask */
c474b3866   Harini Katakam   spi: Add driver f...
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
  
  /* SPI FIFO depth in bytes */
  #define CDNS_SPI_FIFO_DEPTH	128
  
  /* Default number of chip select lines */
  #define CDNS_SPI_DEFAULT_NUM_CS		4
  
  /**
   * struct cdns_spi - This definition defines spi driver instance
   * @regs:		Virtual address of the SPI controller registers
   * @ref_clk:		Pointer to the peripheral clock
   * @pclk:		Pointer to the APB clock
   * @speed_hz:		Current SPI bus clock speed in Hz
   * @txbuf:		Pointer	to the TX buffer
   * @rxbuf:		Pointer to the RX buffer
   * @tx_bytes:		Number of bytes left to transfer
   * @rx_bytes:		Number of bytes requested
   * @dev_busy:		Device busy flag
   * @is_decoded_cs:	Flag for decoder property set or not
   */
  struct cdns_spi {
  	void __iomem *regs;
  	struct clk *ref_clk;
  	struct clk *pclk;
  	u32 speed_hz;
  	const u8 *txbuf;
  	u8 *rxbuf;
  	int tx_bytes;
  	int rx_bytes;
  	u8 dev_busy;
  	u32 is_decoded_cs;
  };
  
  /* Macros for the SPI controller read/write */
  static inline u32 cdns_spi_read(struct cdns_spi *xspi, u32 offset)
  {
  	return readl_relaxed(xspi->regs + offset);
  }
  
  static inline void cdns_spi_write(struct cdns_spi *xspi, u32 offset, u32 val)
  {
  	writel_relaxed(val, xspi->regs + offset);
  }
  
  /**
   * cdns_spi_init_hw - Initialize the hardware and configure the SPI controller
   * @xspi:	Pointer to the cdns_spi structure
   *
   * On reset the SPI controller is configured to be in master mode, baud rate
   * divisor is set to 4, threshold value for TX FIFO not full interrupt is set
   * to 1 and size of the word to be transferred as 8 bit.
   * This function initializes the SPI controller to disable and clear all the
   * interrupts, enable manual slave select and manual start, deselect all the
   * chip select lines, and enable the SPI controller.
   */
  static void cdns_spi_init_hw(struct cdns_spi *xspi)
  {
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
151
  	u32 ctrl_reg = CDNS_SPI_CR_DEFAULT;
ee0ebe810   Lars-Peter Clausen   spi: cadence: Fix...
152
153
  
  	if (xspi->is_decoded_cs)
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
154
  		ctrl_reg |= CDNS_SPI_CR_PERI_SEL;
ee0ebe810   Lars-Peter Clausen   spi: cadence: Fix...
155

24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
156
157
  	cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
  	cdns_spi_write(xspi, CDNS_SPI_IDR, CDNS_SPI_IXR_ALL);
c474b3866   Harini Katakam   spi: Add driver f...
158
159
  
  	/* Clear the RX FIFO */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
160
161
162
163
164
165
  	while (cdns_spi_read(xspi, CDNS_SPI_ISR) & CDNS_SPI_IXR_RXNEMTY)
  		cdns_spi_read(xspi, CDNS_SPI_RXD);
  
  	cdns_spi_write(xspi, CDNS_SPI_ISR, CDNS_SPI_IXR_ALL);
  	cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
  	cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
c474b3866   Harini Katakam   spi: Add driver f...
166
167
168
169
170
  }
  
  /**
   * cdns_spi_chipselect - Select or deselect the chip select line
   * @spi:	Pointer to the spi_device structure
dba56969c   Charles Keepax   spi: cadence: Cor...
171
   * @is_high:	Select(0) or deselect (1) the chip select line
c474b3866   Harini Katakam   spi: Add driver f...
172
   */
dba56969c   Charles Keepax   spi: cadence: Cor...
173
  static void cdns_spi_chipselect(struct spi_device *spi, bool is_high)
c474b3866   Harini Katakam   spi: Add driver f...
174
175
176
  {
  	struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
  	u32 ctrl_reg;
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
177
  	ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
c474b3866   Harini Katakam   spi: Add driver f...
178

dba56969c   Charles Keepax   spi: cadence: Cor...
179
  	if (is_high) {
c474b3866   Harini Katakam   spi: Add driver f...
180
  		/* Deselect the slave */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
181
  		ctrl_reg |= CDNS_SPI_CR_SSCTRL;
c474b3866   Harini Katakam   spi: Add driver f...
182
183
  	} else {
  		/* Select the slave */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
184
  		ctrl_reg &= ~CDNS_SPI_CR_SSCTRL;
c474b3866   Harini Katakam   spi: Add driver f...
185
186
187
  		if (!(xspi->is_decoded_cs))
  			ctrl_reg |= ((~(CDNS_SPI_SS0 << spi->chip_select)) <<
  				     CDNS_SPI_SS_SHIFT) &
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
188
  				     CDNS_SPI_CR_SSCTRL;
c474b3866   Harini Katakam   spi: Add driver f...
189
190
  		else
  			ctrl_reg |= (spi->chip_select << CDNS_SPI_SS_SHIFT) &
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
191
  				     CDNS_SPI_CR_SSCTRL;
c474b3866   Harini Katakam   spi: Add driver f...
192
  	}
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
193
  	cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
c474b3866   Harini Katakam   spi: Add driver f...
194
195
196
197
198
199
200
201
202
203
204
  }
  
  /**
   * cdns_spi_config_clock_mode - Sets clock polarity and phase
   * @spi:	Pointer to the spi_device structure
   *
   * Sets the requested clock polarity and phase.
   */
  static void cdns_spi_config_clock_mode(struct spi_device *spi)
  {
  	struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
a39e65e9c   Lars-Peter Clausen   spi: cadence: Mak...
205
  	u32 ctrl_reg, new_ctrl_reg;
c474b3866   Harini Katakam   spi: Add driver f...
206

57bb1369d   Shubhrajyoti Datta   spi: cadence: Fix...
207
208
  	new_ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
  	ctrl_reg = new_ctrl_reg;
c474b3866   Harini Katakam   spi: Add driver f...
209
210
  
  	/* Set the SPI clock phase and clock polarity */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
211
  	new_ctrl_reg &= ~(CDNS_SPI_CR_CPHA | CDNS_SPI_CR_CPOL);
c474b3866   Harini Katakam   spi: Add driver f...
212
  	if (spi->mode & SPI_CPHA)
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
213
  		new_ctrl_reg |= CDNS_SPI_CR_CPHA;
c474b3866   Harini Katakam   spi: Add driver f...
214
  	if (spi->mode & SPI_CPOL)
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
215
  		new_ctrl_reg |= CDNS_SPI_CR_CPOL;
a39e65e9c   Lars-Peter Clausen   spi: cadence: Mak...
216
217
218
219
220
221
222
223
  
  	if (new_ctrl_reg != ctrl_reg) {
  		/*
  		 * Just writing the CR register does not seem to apply the clock
  		 * setting changes. This is problematic when changing the clock
  		 * polarity as it will cause the SPI slave to see spurious clock
  		 * transitions. To workaround the issue toggle the ER register.
  		 */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
224
225
226
  		cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
  		cdns_spi_write(xspi, CDNS_SPI_CR, new_ctrl_reg);
  		cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
a39e65e9c   Lars-Peter Clausen   spi: cadence: Mak...
227
  	}
c474b3866   Harini Katakam   spi: Add driver f...
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  }
  
  /**
   * cdns_spi_config_clock_freq - Sets clock frequency
   * @spi:	Pointer to the spi_device structure
   * @transfer:	Pointer to the spi_transfer structure which provides
   *		information about next transfer setup parameters
   *
   * Sets the requested clock frequency.
   * Note: If the requested frequency is not an exact match with what can be
   * obtained using the prescalar value the driver sets the clock frequency which
   * is lower than the requested frequency (maximum lower) for the transfer. If
   * the requested frequency is higher or lower than that is supported by the SPI
   * controller the driver will set the highest or lowest frequency supported by
   * controller.
   */
  static void cdns_spi_config_clock_freq(struct spi_device *spi,
57bb1369d   Shubhrajyoti Datta   spi: cadence: Fix...
245
  				       struct spi_transfer *transfer)
c474b3866   Harini Katakam   spi: Add driver f...
246
247
248
249
250
251
  {
  	struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
  	u32 ctrl_reg, baud_rate_val;
  	unsigned long frequency;
  
  	frequency = clk_get_rate(xspi->ref_clk);
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
252
  	ctrl_reg = cdns_spi_read(xspi, CDNS_SPI_CR);
c474b3866   Harini Katakam   spi: Add driver f...
253
254
255
256
257
258
259
260
  
  	/* Set the clock frequency */
  	if (xspi->speed_hz != transfer->speed_hz) {
  		/* first valid value is 1 */
  		baud_rate_val = CDNS_SPI_BAUD_DIV_MIN;
  		while ((baud_rate_val < CDNS_SPI_BAUD_DIV_MAX) &&
  		       (frequency / (2 << baud_rate_val)) > transfer->speed_hz)
  			baud_rate_val++;
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
261
  		ctrl_reg &= ~CDNS_SPI_CR_BAUD_DIV;
c474b3866   Harini Katakam   spi: Add driver f...
262
263
264
265
  		ctrl_reg |= baud_rate_val << CDNS_SPI_BAUD_DIV_SHIFT;
  
  		xspi->speed_hz = frequency / (2 << baud_rate_val);
  	}
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
266
  	cdns_spi_write(xspi, CDNS_SPI_CR, ctrl_reg);
c474b3866   Harini Katakam   spi: Add driver f...
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
  }
  
  /**
   * cdns_spi_setup_transfer - Configure SPI controller for specified transfer
   * @spi:	Pointer to the spi_device structure
   * @transfer:	Pointer to the spi_transfer structure which provides
   *		information about next transfer setup parameters
   *
   * Sets the operational mode of SPI controller for the next SPI transfer and
   * sets the requested clock frequency.
   *
   * Return:	Always 0
   */
  static int cdns_spi_setup_transfer(struct spi_device *spi,
  				   struct spi_transfer *transfer)
  {
  	struct cdns_spi *xspi = spi_master_get_devdata(spi->master);
  
  	cdns_spi_config_clock_freq(spi, transfer);
  
  	dev_dbg(&spi->dev, "%s, mode %d, %u bits/w, %u clock speed
  ",
  		__func__, spi->mode, spi->bits_per_word,
  		xspi->speed_hz);
  
  	return 0;
  }
  
  /**
   * cdns_spi_fill_tx_fifo - Fills the TX FIFO with as many bytes as possible
   * @xspi:	Pointer to the cdns_spi structure
   */
  static void cdns_spi_fill_tx_fifo(struct cdns_spi *xspi)
  {
  	unsigned long trans_cnt = 0;
  
  	while ((trans_cnt < CDNS_SPI_FIFO_DEPTH) &&
  	       (xspi->tx_bytes > 0)) {
49530e641   sxauwsk   spi: cadence: Add...
305
306
307
308
309
310
  
  		/* When xspi in busy condition, bytes may send failed,
  		 * then spi control did't work thoroughly, add one byte delay
  		 */
  		if (cdns_spi_read(xspi, CDNS_SPI_ISR) &
  		    CDNS_SPI_IXR_TXFULL)
931c4e9a7   Janek Kotas   spi: cadence: Cha...
311
  			udelay(10);
49530e641   sxauwsk   spi: cadence: Add...
312

c474b3866   Harini Katakam   spi: Add driver f...
313
  		if (xspi->txbuf)
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
314
  			cdns_spi_write(xspi, CDNS_SPI_TXD, *xspi->txbuf++);
c474b3866   Harini Katakam   spi: Add driver f...
315
  		else
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
316
  			cdns_spi_write(xspi, CDNS_SPI_TXD, 0);
c474b3866   Harini Katakam   spi: Add driver f...
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
  
  		xspi->tx_bytes--;
  		trans_cnt++;
  	}
  }
  
  /**
   * cdns_spi_irq - Interrupt service routine of the SPI controller
   * @irq:	IRQ number
   * @dev_id:	Pointer to the xspi structure
   *
   * This function handles TX empty and Mode Fault interrupts only.
   * On TX empty interrupt this function reads the received data from RX FIFO and
   * fills the TX FIFO if there is any data remaining to be transferred.
   * On Mode Fault interrupt this function indicates that transfer is completed,
   * the SPI subsystem will identify the error as the remaining bytes to be
   * transferred is non-zero.
   *
   * Return:	IRQ_HANDLED when handled; IRQ_NONE otherwise.
   */
  static irqreturn_t cdns_spi_irq(int irq, void *dev_id)
  {
  	struct spi_master *master = dev_id;
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
  	u32 intr_status, status;
  
  	status = IRQ_NONE;
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
344
345
  	intr_status = cdns_spi_read(xspi, CDNS_SPI_ISR);
  	cdns_spi_write(xspi, CDNS_SPI_ISR, intr_status);
c474b3866   Harini Katakam   spi: Add driver f...
346

24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
347
  	if (intr_status & CDNS_SPI_IXR_MODF) {
c474b3866   Harini Katakam   spi: Add driver f...
348
349
350
351
  		/* Indicate that transfer is completed, the SPI subsystem will
  		 * identify the error as the remaining bytes to be
  		 * transferred is non-zero
  		 */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
352
  		cdns_spi_write(xspi, CDNS_SPI_IDR, CDNS_SPI_IXR_DEFAULT);
c474b3866   Harini Katakam   spi: Add driver f...
353
354
  		spi_finalize_current_transfer(master);
  		status = IRQ_HANDLED;
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
355
  	} else if (intr_status & CDNS_SPI_IXR_TXOW) {
c474b3866   Harini Katakam   spi: Add driver f...
356
357
358
359
360
361
362
  		unsigned long trans_cnt;
  
  		trans_cnt = xspi->rx_bytes - xspi->tx_bytes;
  
  		/* Read out the data from the RX FIFO */
  		while (trans_cnt) {
  			u8 data;
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
363
  			data = cdns_spi_read(xspi, CDNS_SPI_RXD);
c474b3866   Harini Katakam   spi: Add driver f...
364
365
366
367
368
369
370
371
372
373
374
375
  			if (xspi->rxbuf)
  				*xspi->rxbuf++ = data;
  
  			xspi->rx_bytes--;
  			trans_cnt--;
  		}
  
  		if (xspi->tx_bytes) {
  			/* There is more data to send */
  			cdns_spi_fill_tx_fifo(xspi);
  		} else {
  			/* Transfer is completed */
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
376
377
  			cdns_spi_write(xspi, CDNS_SPI_IDR,
  				       CDNS_SPI_IXR_DEFAULT);
c474b3866   Harini Katakam   spi: Add driver f...
378
379
380
381
382
383
384
  			spi_finalize_current_transfer(master);
  		}
  		status = IRQ_HANDLED;
  	}
  
  	return status;
  }
57bb1369d   Shubhrajyoti Datta   spi: cadence: Fix...
385

b48b9488e   Lars-Peter Clausen   spi: cadence: Con...
386
387
388
389
390
391
  static int cdns_prepare_message(struct spi_master *master,
  				struct spi_message *msg)
  {
  	cdns_spi_config_clock_mode(msg->spi);
  	return 0;
  }
c474b3866   Harini Katakam   spi: Add driver f...
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
  
  /**
   * cdns_transfer_one - Initiates the SPI transfer
   * @master:	Pointer to spi_master structure
   * @spi:	Pointer to the spi_device structure
   * @transfer:	Pointer to the spi_transfer structure which provides
   *		information about next transfer parameters
   *
   * This function fills the TX FIFO, starts the SPI transfer and
   * returns a positive transfer count so that core will wait for completion.
   *
   * Return:	Number of bytes transferred in the last transfer
   */
  static int cdns_transfer_one(struct spi_master *master,
  			     struct spi_device *spi,
  			     struct spi_transfer *transfer)
  {
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
  
  	xspi->txbuf = transfer->tx_buf;
  	xspi->rxbuf = transfer->rx_buf;
  	xspi->tx_bytes = transfer->len;
  	xspi->rx_bytes = transfer->len;
  
  	cdns_spi_setup_transfer(spi, transfer);
  
  	cdns_spi_fill_tx_fifo(xspi);
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
419
  	cdns_spi_write(xspi, CDNS_SPI_IER, CDNS_SPI_IXR_DEFAULT);
c474b3866   Harini Katakam   spi: Add driver f...
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
  	return transfer->len;
  }
  
  /**
   * cdns_prepare_transfer_hardware - Prepares hardware for transfer.
   * @master:	Pointer to the spi_master structure which provides
   *		information about the controller.
   *
   * This function enables SPI master controller.
   *
   * Return:	0 always
   */
  static int cdns_prepare_transfer_hardware(struct spi_master *master)
  {
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
435
  	cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_ENABLE);
c474b3866   Harini Katakam   spi: Add driver f...
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
  
  	return 0;
  }
  
  /**
   * cdns_unprepare_transfer_hardware - Relaxes hardware after transfer
   * @master:	Pointer to the spi_master structure which provides
   *		information about the controller.
   *
   * This function disables the SPI master controller.
   *
   * Return:	0 always
   */
  static int cdns_unprepare_transfer_hardware(struct spi_master *master)
  {
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
452
  	cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
c474b3866   Harini Katakam   spi: Add driver f...
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
  
  	return 0;
  }
  
  /**
   * cdns_spi_probe - Probe method for the SPI driver
   * @pdev:	Pointer to the platform_device structure
   *
   * This function initializes the driver data structures and the hardware.
   *
   * Return:	0 on success and error value on error
   */
  static int cdns_spi_probe(struct platform_device *pdev)
  {
  	int ret = 0, irq;
  	struct spi_master *master;
  	struct cdns_spi *xspi;
c474b3866   Harini Katakam   spi: Add driver f...
470
471
472
  	u32 num_cs;
  
  	master = spi_alloc_master(&pdev->dev, sizeof(*xspi));
15a1c5030   Shubhrajyoti Datta   spi: cadence: Fix...
473
  	if (!master)
c474b3866   Harini Katakam   spi: Add driver f...
474
475
476
477
478
  		return -ENOMEM;
  
  	xspi = spi_master_get_devdata(master);
  	master->dev.of_node = pdev->dev.of_node;
  	platform_set_drvdata(pdev, master);
4585bb92a   YueHaibing   spi: cadence: use...
479
  	xspi->regs = devm_platform_ioremap_resource(pdev, 0);
c474b3866   Harini Katakam   spi: Add driver f...
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
  	if (IS_ERR(xspi->regs)) {
  		ret = PTR_ERR(xspi->regs);
  		goto remove_master;
  	}
  
  	xspi->pclk = devm_clk_get(&pdev->dev, "pclk");
  	if (IS_ERR(xspi->pclk)) {
  		dev_err(&pdev->dev, "pclk clock not found.
  ");
  		ret = PTR_ERR(xspi->pclk);
  		goto remove_master;
  	}
  
  	xspi->ref_clk = devm_clk_get(&pdev->dev, "ref_clk");
  	if (IS_ERR(xspi->ref_clk)) {
  		dev_err(&pdev->dev, "ref_clk clock not found.
  ");
  		ret = PTR_ERR(xspi->ref_clk);
  		goto remove_master;
  	}
  
  	ret = clk_prepare_enable(xspi->pclk);
  	if (ret) {
  		dev_err(&pdev->dev, "Unable to enable APB clock.
  ");
  		goto remove_master;
  	}
  
  	ret = clk_prepare_enable(xspi->ref_clk);
  	if (ret) {
  		dev_err(&pdev->dev, "Unable to enable device clock.
  ");
  		goto clk_dis_apb;
  	}
3cc291061   Paul Cercueil   spi: cadence: Ini...
514
515
516
517
518
519
520
521
522
523
  	ret = of_property_read_u32(pdev->dev.of_node, "num-cs", &num_cs);
  	if (ret < 0)
  		master->num_chipselect = CDNS_SPI_DEFAULT_NUM_CS;
  	else
  		master->num_chipselect = num_cs;
  
  	ret = of_property_read_u32(pdev->dev.of_node, "is-decoded-cs",
  				   &xspi->is_decoded_cs);
  	if (ret < 0)
  		xspi->is_decoded_cs = 0;
c474b3866   Harini Katakam   spi: Add driver f...
524
525
  	/* SPI controller initializations */
  	cdns_spi_init_hw(xspi);
734882a8b   Charles Keepax   spi: cadence: Cor...
526
527
528
529
  	pm_runtime_set_active(&pdev->dev);
  	pm_runtime_enable(&pdev->dev);
  	pm_runtime_use_autosuspend(&pdev->dev);
  	pm_runtime_set_autosuspend_delay(&pdev->dev, SPI_AUTOSUSPEND_TIMEOUT);
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
530

c474b3866   Harini Katakam   spi: Add driver f...
531
532
533
  	irq = platform_get_irq(pdev, 0);
  	if (irq <= 0) {
  		ret = -ENXIO;
50ac697ba   Shubhrajyoti Datta   spi: cadence: Fix...
534
  		goto clk_dis_all;
c474b3866   Harini Katakam   spi: Add driver f...
535
536
537
538
539
540
541
542
  	}
  
  	ret = devm_request_irq(&pdev->dev, irq, cdns_spi_irq,
  			       0, pdev->name, master);
  	if (ret != 0) {
  		ret = -ENXIO;
  		dev_err(&pdev->dev, "request_irq failed
  ");
50ac697ba   Shubhrajyoti Datta   spi: cadence: Fix...
543
  		goto clk_dis_all;
c474b3866   Harini Katakam   spi: Add driver f...
544
  	}
cfeefa79d   Linus Walleij   spi: cadence: Con...
545
  	master->use_gpio_descriptors = true;
c474b3866   Harini Katakam   spi: Add driver f...
546
  	master->prepare_transfer_hardware = cdns_prepare_transfer_hardware;
b48b9488e   Lars-Peter Clausen   spi: cadence: Con...
547
  	master->prepare_message = cdns_prepare_message;
c474b3866   Harini Katakam   spi: Add driver f...
548
549
550
  	master->transfer_one = cdns_transfer_one;
  	master->unprepare_transfer_hardware = cdns_unprepare_transfer_hardware;
  	master->set_cs = cdns_spi_chipselect;
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
551
  	master->auto_runtime_pm = true;
c474b3866   Harini Katakam   spi: Add driver f...
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
  	master->mode_bits = SPI_CPOL | SPI_CPHA;
  
  	/* Set to default valid value */
  	master->max_speed_hz = clk_get_rate(xspi->ref_clk) / 4;
  	xspi->speed_hz = master->max_speed_hz;
  
  	master->bits_per_word_mask = SPI_BPW_MASK(8);
  
  	ret = spi_register_master(master);
  	if (ret) {
  		dev_err(&pdev->dev, "spi_register_master failed
  ");
  		goto clk_dis_all;
  	}
  
  	return ret;
  
  clk_dis_all:
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
570
571
  	pm_runtime_set_suspended(&pdev->dev);
  	pm_runtime_disable(&pdev->dev);
c474b3866   Harini Katakam   spi: Add driver f...
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
  	clk_disable_unprepare(xspi->ref_clk);
  clk_dis_apb:
  	clk_disable_unprepare(xspi->pclk);
  remove_master:
  	spi_master_put(master);
  	return ret;
  }
  
  /**
   * cdns_spi_remove - Remove method for the SPI driver
   * @pdev:	Pointer to the platform_device structure
   *
   * This function is called if a device is physically removed from the system or
   * if the driver module is being unloaded. It frees all resources allocated to
   * the device.
   *
   * Return:	0 on success and error value on error
   */
  static int cdns_spi_remove(struct platform_device *pdev)
  {
  	struct spi_master *master = platform_get_drvdata(pdev);
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
24746675f   Shubhrajyoti Datta   spi: cadence: Rem...
594
  	cdns_spi_write(xspi, CDNS_SPI_ER, CDNS_SPI_ER_DISABLE);
c474b3866   Harini Katakam   spi: Add driver f...
595
596
597
  
  	clk_disable_unprepare(xspi->ref_clk);
  	clk_disable_unprepare(xspi->pclk);
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
598
599
  	pm_runtime_set_suspended(&pdev->dev);
  	pm_runtime_disable(&pdev->dev);
c474b3866   Harini Katakam   spi: Add driver f...
600
601
602
603
604
605
606
607
608
609
610
611
612
  
  	spi_unregister_master(master);
  
  	return 0;
  }
  
  /**
   * cdns_spi_suspend - Suspend method for the SPI driver
   * @dev:	Address of the platform_device structure
   *
   * This function disables the SPI controller and
   * changes the driver state to "suspend"
   *
6fe9b67db   Shubhrajyoti Datta   spi: cadence: Ret...
613
   * Return:	0 on success and error value on error
c474b3866   Harini Katakam   spi: Add driver f...
614
615
616
   */
  static int __maybe_unused cdns_spi_suspend(struct device *dev)
  {
e1f16b049   Wolfram Sang   spi: simplify get...
617
  	struct spi_master *master = dev_get_drvdata(dev);
c474b3866   Harini Katakam   spi: Add driver f...
618

6fe9b67db   Shubhrajyoti Datta   spi: cadence: Ret...
619
  	return spi_master_suspend(master);
c474b3866   Harini Katakam   spi: Add driver f...
620
621
622
623
624
625
626
627
628
629
630
631
  }
  
  /**
   * cdns_spi_resume - Resume method for the SPI driver
   * @dev:	Address of the platform_device structure
   *
   * This function changes the driver state to "ready"
   *
   * Return:	0 on success and error value on error
   */
  static int __maybe_unused cdns_spi_resume(struct device *dev)
  {
e1f16b049   Wolfram Sang   spi: simplify get...
632
  	struct spi_master *master = dev_get_drvdata(dev);
802740890   Shubhrajyoti Datta   spi: cadence: Add...
633
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
c474b3866   Harini Katakam   spi: Add driver f...
634

802740890   Shubhrajyoti Datta   spi: cadence: Add...
635
  	cdns_spi_init_hw(xspi);
6fe9b67db   Shubhrajyoti Datta   spi: cadence: Ret...
636
  	return spi_master_resume(master);
c474b3866   Harini Katakam   spi: Add driver f...
637
  }
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
638
639
640
641
642
643
644
645
  /**
   * cdns_spi_runtime_resume - Runtime resume method for the SPI driver
   * @dev:	Address of the platform_device structure
   *
   * This function enables the clocks
   *
   * Return:	0 on success and error value on error
   */
148b1eb93   Arnd Bergmann   spi: cadence: mar...
646
  static int __maybe_unused cnds_runtime_resume(struct device *dev)
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
  {
  	struct spi_master *master = dev_get_drvdata(dev);
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
  	int ret;
  
  	ret = clk_prepare_enable(xspi->pclk);
  	if (ret) {
  		dev_err(dev, "Cannot enable APB clock.
  ");
  		return ret;
  	}
  
  	ret = clk_prepare_enable(xspi->ref_clk);
  	if (ret) {
  		dev_err(dev, "Cannot enable device clock.
  ");
2ba87a9bc   Wei Yongjun   spi: cadence: Fix...
663
  		clk_disable_unprepare(xspi->pclk);
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
664
665
666
667
668
669
670
671
672
673
674
675
676
  		return ret;
  	}
  	return 0;
  }
  
  /**
   * cdns_spi_runtime_suspend - Runtime suspend method for the SPI driver
   * @dev:	Address of the platform_device structure
   *
   * This function disables the clocks
   *
   * Return:	Always 0
   */
148b1eb93   Arnd Bergmann   spi: cadence: mar...
677
  static int __maybe_unused cnds_runtime_suspend(struct device *dev)
d36ccd9f7   Shubhrajyoti Datta   spi: cadence: Run...
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
  {
  	struct spi_master *master = dev_get_drvdata(dev);
  	struct cdns_spi *xspi = spi_master_get_devdata(master);
  
  	clk_disable_unprepare(xspi->ref_clk);
  	clk_disable_unprepare(xspi->pclk);
  
  	return 0;
  }
  
  static const struct dev_pm_ops cdns_spi_dev_pm_ops = {
  	SET_RUNTIME_PM_OPS(cnds_runtime_suspend,
  			   cnds_runtime_resume, NULL)
  	SET_SYSTEM_SLEEP_PM_OPS(cdns_spi_suspend, cdns_spi_resume)
  };
c474b3866   Harini Katakam   spi: Add driver f...
693

f7f994a4c   Jingoo Han   spi: cadence: Mak...
694
  static const struct of_device_id cdns_spi_of_match[] = {
c474b3866   Harini Katakam   spi: Add driver f...
695
696
697
698
699
700
701
702
703
704
705
706
  	{ .compatible = "xlnx,zynq-spi-r1p6" },
  	{ .compatible = "cdns,spi-r1p6" },
  	{ /* end of table */ }
  };
  MODULE_DEVICE_TABLE(of, cdns_spi_of_match);
  
  /* cdns_spi_driver - This structure defines the SPI subsystem platform driver */
  static struct platform_driver cdns_spi_driver = {
  	.probe	= cdns_spi_probe,
  	.remove	= cdns_spi_remove,
  	.driver = {
  		.name = CDNS_SPI_NAME,
c474b3866   Harini Katakam   spi: Add driver f...
707
708
709
710
711
712
713
714
715
716
  		.of_match_table = cdns_spi_of_match,
  		.pm = &cdns_spi_dev_pm_ops,
  	},
  };
  
  module_platform_driver(cdns_spi_driver);
  
  MODULE_AUTHOR("Xilinx, Inc.");
  MODULE_DESCRIPTION("Cadence SPI driver");
  MODULE_LICENSE("GPL");