]>
Commit | Line | Data |
---|---|---|
67dca5e5 NSR |
1 | // SPDX-License-Identifier: GPL-2.0+ |
2 | /* | |
3 | * Copyright (C) 2019 Xilinx, Inc. | |
4 | * | |
5 | * Author: Naga Sureshkumar Relli <nagasure@xilinx.com> | |
6 | */ | |
7 | ||
8 | #include <linux/clk.h> | |
9 | #include <linux/delay.h> | |
67dca5e5 NSR |
10 | #include <linux/interrupt.h> |
11 | #include <linux/io.h> | |
12 | #include <linux/module.h> | |
13 | #include <linux/of_irq.h> | |
14 | #include <linux/of_address.h> | |
15 | #include <linux/platform_device.h> | |
16 | #include <linux/spi/spi.h> | |
17 | #include <linux/workqueue.h> | |
18 | #include <linux/spi/spi-mem.h> | |
19 | ||
20 | /* Register offset definitions */ | |
21 | #define ZYNQ_QSPI_CONFIG_OFFSET 0x00 /* Configuration Register, RW */ | |
22 | #define ZYNQ_QSPI_STATUS_OFFSET 0x04 /* Interrupt Status Register, RO */ | |
23 | #define ZYNQ_QSPI_IEN_OFFSET 0x08 /* Interrupt Enable Register, WO */ | |
24 | #define ZYNQ_QSPI_IDIS_OFFSET 0x0C /* Interrupt Disable Reg, WO */ | |
25 | #define ZYNQ_QSPI_IMASK_OFFSET 0x10 /* Interrupt Enabled Mask Reg,RO */ | |
26 | #define ZYNQ_QSPI_ENABLE_OFFSET 0x14 /* Enable/Disable Register, RW */ | |
27 | #define ZYNQ_QSPI_DELAY_OFFSET 0x18 /* Delay Register, RW */ | |
28 | #define ZYNQ_QSPI_TXD_00_00_OFFSET 0x1C /* Transmit 4-byte inst, WO */ | |
29 | #define ZYNQ_QSPI_TXD_00_01_OFFSET 0x80 /* Transmit 1-byte inst, WO */ | |
30 | #define ZYNQ_QSPI_TXD_00_10_OFFSET 0x84 /* Transmit 2-byte inst, WO */ | |
31 | #define ZYNQ_QSPI_TXD_00_11_OFFSET 0x88 /* Transmit 3-byte inst, WO */ | |
32 | #define ZYNQ_QSPI_RXD_OFFSET 0x20 /* Data Receive Register, RO */ | |
33 | #define ZYNQ_QSPI_SIC_OFFSET 0x24 /* Slave Idle Count Register, RW */ | |
34 | #define ZYNQ_QSPI_TX_THRESH_OFFSET 0x28 /* TX FIFO Watermark Reg, RW */ | |
35 | #define ZYNQ_QSPI_RX_THRESH_OFFSET 0x2C /* RX FIFO Watermark Reg, RW */ | |
36 | #define ZYNQ_QSPI_GPIO_OFFSET 0x30 /* GPIO Register, RW */ | |
37 | #define ZYNQ_QSPI_LINEAR_CFG_OFFSET 0xA0 /* Linear Adapter Config Ref, RW */ | |
38 | #define ZYNQ_QSPI_MOD_ID_OFFSET 0xFC /* Module ID Register, RO */ | |
39 | ||
40 | /* | |
41 | * QSPI Configuration Register bit Masks | |
42 | * | |
43 | * This register contains various control bits that effect the operation | |
44 | * of the QSPI controller | |
45 | */ | |
46 | #define ZYNQ_QSPI_CONFIG_IFMODE_MASK BIT(31) /* Flash Memory Interface */ | |
47 | #define ZYNQ_QSPI_CONFIG_MANSRT_MASK BIT(16) /* Manual TX Start */ | |
48 | #define ZYNQ_QSPI_CONFIG_MANSRTEN_MASK BIT(15) /* Enable Manual TX Mode */ | |
49 | #define ZYNQ_QSPI_CONFIG_SSFORCE_MASK BIT(14) /* Manual Chip Select */ | |
50 | #define ZYNQ_QSPI_CONFIG_BDRATE_MASK GENMASK(5, 3) /* Baud Rate Mask */ | |
51 | #define ZYNQ_QSPI_CONFIG_CPHA_MASK BIT(2) /* Clock Phase Control */ | |
52 | #define ZYNQ_QSPI_CONFIG_CPOL_MASK BIT(1) /* Clock Polarity Control */ | |
67dca5e5 NSR |
53 | #define ZYNQ_QSPI_CONFIG_FWIDTH_MASK GENMASK(7, 6) /* FIFO width */ |
54 | #define ZYNQ_QSPI_CONFIG_MSTREN_MASK BIT(0) /* Master Mode */ | |
55 | ||
56 | /* | |
57 | * QSPI Configuration Register - Baud rate and slave select | |
58 | * | |
59 | * These are the values used in the calculation of baud rate divisor and | |
60 | * setting the slave select. | |
61 | */ | |
941be723 MR |
62 | #define ZYNQ_QSPI_CONFIG_BAUD_DIV_MAX GENMASK(2, 0) /* Baud rate maximum */ |
63 | #define ZYNQ_QSPI_CONFIG_BAUD_DIV_SHIFT 3 /* Baud rate divisor shift */ | |
dffaf743 | 64 | #define ZYNQ_QSPI_CONFIG_PCS BIT(10) /* Peripheral Chip Select */ |
67dca5e5 NSR |
65 | |
66 | /* | |
67 | * QSPI Interrupt Registers bit Masks | |
68 | * | |
69 | * All the four interrupt registers (Status/Mask/Enable/Disable) have the same | |
70 | * bit definitions. | |
71 | */ | |
72 | #define ZYNQ_QSPI_IXR_RX_OVERFLOW_MASK BIT(0) /* QSPI RX FIFO Overflow */ | |
73 | #define ZYNQ_QSPI_IXR_TXNFULL_MASK BIT(2) /* QSPI TX FIFO Overflow */ | |
74 | #define ZYNQ_QSPI_IXR_TXFULL_MASK BIT(3) /* QSPI TX FIFO is full */ | |
75 | #define ZYNQ_QSPI_IXR_RXNEMTY_MASK BIT(4) /* QSPI RX FIFO Not Empty */ | |
76 | #define ZYNQ_QSPI_IXR_RXF_FULL_MASK BIT(5) /* QSPI RX FIFO is full */ | |
77 | #define ZYNQ_QSPI_IXR_TXF_UNDRFLOW_MASK BIT(6) /* QSPI TX FIFO Underflow */ | |
78 | #define ZYNQ_QSPI_IXR_ALL_MASK (ZYNQ_QSPI_IXR_RX_OVERFLOW_MASK | \ | |
79 | ZYNQ_QSPI_IXR_TXNFULL_MASK | \ | |
80 | ZYNQ_QSPI_IXR_TXFULL_MASK | \ | |
81 | ZYNQ_QSPI_IXR_RXNEMTY_MASK | \ | |
82 | ZYNQ_QSPI_IXR_RXF_FULL_MASK | \ | |
83 | ZYNQ_QSPI_IXR_TXF_UNDRFLOW_MASK) | |
84 | #define ZYNQ_QSPI_IXR_RXTX_MASK (ZYNQ_QSPI_IXR_TXNFULL_MASK | \ | |
85 | ZYNQ_QSPI_IXR_RXNEMTY_MASK) | |
86 | ||
87 | /* | |
88 | * QSPI Enable Register bit Masks | |
89 | * | |
90 | * This register is used to enable or disable the QSPI controller | |
91 | */ | |
92 | #define ZYNQ_QSPI_ENABLE_ENABLE_MASK BIT(0) /* QSPI Enable Bit Mask */ | |
93 | ||
94 | /* | |
95 | * QSPI Linear Configuration Register | |
96 | * | |
97 | * It is named Linear Configuration but it controls other modes when not in | |
98 | * linear mode also. | |
99 | */ | |
044ac826 MR |
100 | #define ZYNQ_QSPI_LCFG_TWO_MEM BIT(30) /* LQSPI Two memories */ |
101 | #define ZYNQ_QSPI_LCFG_SEP_BUS BIT(29) /* LQSPI Separate bus */ | |
102 | #define ZYNQ_QSPI_LCFG_U_PAGE BIT(28) /* LQSPI Upper Page */ | |
67dca5e5 NSR |
103 | |
104 | #define ZYNQ_QSPI_LCFG_DUMMY_SHIFT 8 | |
105 | ||
106 | #define ZYNQ_QSPI_FAST_READ_QOUT_CODE 0x6B /* read instruction code */ | |
107 | #define ZYNQ_QSPI_FIFO_DEPTH 63 /* FIFO depth in words */ | |
108 | #define ZYNQ_QSPI_RX_THRESHOLD 32 /* Rx FIFO threshold level */ | |
109 | #define ZYNQ_QSPI_TX_THRESHOLD 1 /* Tx FIFO threshold level */ | |
110 | ||
111 | /* | |
112 | * The modebits configurable by the driver to make the SPI support different | |
113 | * data formats | |
114 | */ | |
115 | #define ZYNQ_QSPI_MODEBITS (SPI_CPOL | SPI_CPHA) | |
116 | ||
d575c9b7 MR |
117 | /* Maximum number of chip selects */ |
118 | #define ZYNQ_QSPI_MAX_NUM_CS 2 | |
67dca5e5 NSR |
119 | |
120 | /** | |
121 | * struct zynq_qspi - Defines qspi driver instance | |
e867feec | 122 | * @dev: Pointer to the this device's information |
67dca5e5 NSR |
123 | * @regs: Virtual address of the QSPI controller registers |
124 | * @refclk: Pointer to the peripheral clock | |
125 | * @pclk: Pointer to the APB clock | |
126 | * @irq: IRQ number | |
127 | * @txbuf: Pointer to the TX buffer | |
128 | * @rxbuf: Pointer to the RX buffer | |
129 | * @tx_bytes: Number of bytes left to transfer | |
130 | * @rx_bytes: Number of bytes left to receive | |
131 | * @data_completion: completion structure | |
132 | */ | |
133 | struct zynq_qspi { | |
134 | struct device *dev; | |
135 | void __iomem *regs; | |
136 | struct clk *refclk; | |
137 | struct clk *pclk; | |
138 | int irq; | |
139 | u8 *txbuf; | |
140 | u8 *rxbuf; | |
141 | int tx_bytes; | |
142 | int rx_bytes; | |
143 | struct completion data_completion; | |
144 | }; | |
145 | ||
146 | /* | |
147 | * Inline functions for the QSPI controller read/write | |
148 | */ | |
149 | static inline u32 zynq_qspi_read(struct zynq_qspi *xqspi, u32 offset) | |
150 | { | |
151 | return readl_relaxed(xqspi->regs + offset); | |
152 | } | |
153 | ||
154 | static inline void zynq_qspi_write(struct zynq_qspi *xqspi, u32 offset, | |
155 | u32 val) | |
156 | { | |
157 | writel_relaxed(val, xqspi->regs + offset); | |
158 | } | |
159 | ||
160 | /** | |
161 | * zynq_qspi_init_hw - Initialize the hardware | |
162 | * @xqspi: Pointer to the zynq_qspi structure | |
d575c9b7 | 163 | * @num_cs: Number of connected CS (to enable dual memories if needed) |
67dca5e5 NSR |
164 | * |
165 | * The default settings of the QSPI controller's configurable parameters on | |
166 | * reset are | |
167 | * - Master mode | |
168 | * - Baud rate divisor is set to 2 | |
169 | * - Tx threshold set to 1l Rx threshold set to 32 | |
170 | * - Flash memory interface mode enabled | |
171 | * - Size of the word to be transferred as 8 bit | |
172 | * This function performs the following actions | |
173 | * - Disable and clear all the interrupts | |
174 | * - Enable manual slave select | |
175 | * - Enable manual start | |
176 | * - Deselect all the chip select lines | |
177 | * - Set the size of the word to be transferred as 32 bit | |
178 | * - Set the little endian mode of TX FIFO and | |
179 | * - Enable the QSPI controller | |
180 | */ | |
d575c9b7 | 181 | static void zynq_qspi_init_hw(struct zynq_qspi *xqspi, unsigned int num_cs) |
67dca5e5 NSR |
182 | { |
183 | u32 config_reg; | |
184 | ||
185 | zynq_qspi_write(xqspi, ZYNQ_QSPI_ENABLE_OFFSET, 0); | |
186 | zynq_qspi_write(xqspi, ZYNQ_QSPI_IDIS_OFFSET, ZYNQ_QSPI_IXR_ALL_MASK); | |
187 | ||
188 | /* Disable linear mode as the boot loader may have used it */ | |
d575c9b7 MR |
189 | config_reg = 0; |
190 | /* At the same time, enable dual mode if more than 1 CS is available */ | |
191 | if (num_cs > 1) | |
192 | config_reg |= ZYNQ_QSPI_LCFG_TWO_MEM; | |
193 | ||
194 | zynq_qspi_write(xqspi, ZYNQ_QSPI_LINEAR_CFG_OFFSET, config_reg); | |
67dca5e5 NSR |
195 | |
196 | /* Clear the RX FIFO */ | |
197 | while (zynq_qspi_read(xqspi, ZYNQ_QSPI_STATUS_OFFSET) & | |
198 | ZYNQ_QSPI_IXR_RXNEMTY_MASK) | |
199 | zynq_qspi_read(xqspi, ZYNQ_QSPI_RXD_OFFSET); | |
200 | ||
201 | zynq_qspi_write(xqspi, ZYNQ_QSPI_STATUS_OFFSET, ZYNQ_QSPI_IXR_ALL_MASK); | |
202 | config_reg = zynq_qspi_read(xqspi, ZYNQ_QSPI_CONFIG_OFFSET); | |
203 | config_reg &= ~(ZYNQ_QSPI_CONFIG_MSTREN_MASK | | |
204 | ZYNQ_QSPI_CONFIG_CPOL_MASK | | |
205 | ZYNQ_QSPI_CONFIG_CPHA_MASK | | |
206 | ZYNQ_QSPI_CONFIG_BDRATE_MASK | | |
207 | ZYNQ_QSPI_CONFIG_SSFORCE_MASK | | |
208 | ZYNQ_QSPI_CONFIG_MANSRTEN_MASK | | |
209 | ZYNQ_QSPI_CONFIG_MANSRT_MASK); | |
210 | config_reg |= (ZYNQ_QSPI_CONFIG_MSTREN_MASK | | |
211 | ZYNQ_QSPI_CONFIG_SSFORCE_MASK | | |
212 | ZYNQ_QSPI_CONFIG_FWIDTH_MASK | | |
213 | ZYNQ_QSPI_CONFIG_IFMODE_MASK); | |
214 | zynq_qspi_write(xqspi, ZYNQ_QSPI_CONFIG_OFFSET, config_reg); | |
215 | ||
216 | zynq_qspi_write(xqspi, ZYNQ_QSPI_RX_THRESH_OFFSET, | |
217 | ZYNQ_QSPI_RX_THRESHOLD); | |
218 | zynq_qspi_write(xqspi, ZYNQ_QSPI_TX_THRESH_OFFSET, | |
219 | ZYNQ_QSPI_TX_THRESHOLD); | |
220 | ||
221 | zynq_qspi_write(xqspi, ZYNQ_QSPI_ENABLE_OFFSET, | |
222 | ZYNQ_QSPI_ENABLE_ENABLE_MASK); | |
223 | } | |
224 | ||
225 | static bool zynq_qspi_supports_op(struct spi_mem *mem, | |
226 | const struct spi_mem_op *op) | |
227 | { | |
228 | if (!spi_mem_default_supports_op(mem, op)) | |
229 | return false; | |
230 | ||
231 | /* | |
232 | * The number of address bytes should be equal to or less than 3 bytes. | |
233 | */ | |
234 | if (op->addr.nbytes > 3) | |
235 | return false; | |
236 | ||
237 | return true; | |
238 | } | |
239 | ||
240 | /** | |
241 | * zynq_qspi_rxfifo_op - Read 1..4 bytes from RxFIFO to RX buffer | |
242 | * @xqspi: Pointer to the zynq_qspi structure | |
243 | * @size: Number of bytes to be read (1..4) | |
244 | */ | |
245 | static void zynq_qspi_rxfifo_op(struct zynq_qspi *xqspi, unsigned int size) | |
246 | { | |
247 | u32 data; | |
248 | ||
249 | data = zynq_qspi_read(xqspi, ZYNQ_QSPI_RXD_OFFSET); | |
250 | ||
251 | if (xqspi->rxbuf) { | |
252 | memcpy(xqspi->rxbuf, ((u8 *)&data) + 4 - size, size); | |
253 | xqspi->rxbuf += size; | |
254 | } | |
255 | ||
256 | xqspi->rx_bytes -= size; | |
257 | if (xqspi->rx_bytes < 0) | |
258 | xqspi->rx_bytes = 0; | |
259 | } | |
260 | ||
261 | /** | |
262 | * zynq_qspi_txfifo_op - Write 1..4 bytes from TX buffer to TxFIFO | |
263 | * @xqspi: Pointer to the zynq_qspi structure | |
264 | * @size: Number of bytes to be written (1..4) | |
265 | */ | |
266 | static void zynq_qspi_txfifo_op(struct zynq_qspi *xqspi, unsigned int size) | |
267 | { | |
268 | static const unsigned int offset[4] = { | |
269 | ZYNQ_QSPI_TXD_00_01_OFFSET, ZYNQ_QSPI_TXD_00_10_OFFSET, | |
270 | ZYNQ_QSPI_TXD_00_11_OFFSET, ZYNQ_QSPI_TXD_00_00_OFFSET }; | |
271 | u32 data; | |
272 | ||
273 | if (xqspi->txbuf) { | |
274 | data = 0xffffffff; | |
275 | memcpy(&data, xqspi->txbuf, size); | |
276 | xqspi->txbuf += size; | |
277 | } else { | |
278 | data = 0; | |
279 | } | |
280 | ||
281 | xqspi->tx_bytes -= size; | |
282 | zynq_qspi_write(xqspi, offset[size - 1], data); | |
283 | } | |
284 | ||
285 | /** | |
286 | * zynq_qspi_chipselect - Select or deselect the chip select line | |
287 | * @spi: Pointer to the spi_device structure | |
288 | * @assert: 1 for select or 0 for deselect the chip select line | |
289 | */ | |
290 | static void zynq_qspi_chipselect(struct spi_device *spi, bool assert) | |
291 | { | |
9b10fa36 MR |
292 | struct spi_controller *ctlr = spi->master; |
293 | struct zynq_qspi *xqspi = spi_controller_get_devdata(ctlr); | |
67dca5e5 NSR |
294 | u32 config_reg; |
295 | ||
d575c9b7 MR |
296 | /* Select the lower (CS0) or upper (CS1) memory */ |
297 | if (ctlr->num_chipselect > 1) { | |
298 | config_reg = zynq_qspi_read(xqspi, ZYNQ_QSPI_LINEAR_CFG_OFFSET); | |
299 | if (!spi->chip_select) | |
300 | config_reg &= ~ZYNQ_QSPI_LCFG_U_PAGE; | |
301 | else | |
302 | config_reg |= ZYNQ_QSPI_LCFG_U_PAGE; | |
303 | ||
304 | zynq_qspi_write(xqspi, ZYNQ_QSPI_LINEAR_CFG_OFFSET, config_reg); | |
305 | } | |
306 | ||
dffaf743 | 307 | /* Ground the line to assert the CS */ |
67dca5e5 | 308 | config_reg = zynq_qspi_read(xqspi, ZYNQ_QSPI_CONFIG_OFFSET); |
dffaf743 MR |
309 | if (assert) |
310 | config_reg &= ~ZYNQ_QSPI_CONFIG_PCS; | |
311 | else | |
312 | config_reg |= ZYNQ_QSPI_CONFIG_PCS; | |
67dca5e5 NSR |
313 | |
314 | zynq_qspi_write(xqspi, ZYNQ_QSPI_CONFIG_OFFSET, config_reg); | |
315 | } | |
316 | ||
317 | /** | |
318 | * zynq_qspi_config_op - Configure QSPI controller for specified transfer | |
319 | * @xqspi: Pointer to the zynq_qspi structure | |
e867feec | 320 | * @spi: Pointer to the spi_device structure |
67dca5e5 NSR |
321 | * |
322 | * Sets the operational mode of QSPI controller for the next QSPI transfer and | |
323 | * sets the requested clock frequency. | |
324 | * | |
325 | * Return: 0 on success and -EINVAL on invalid input parameter | |
326 | * | |
327 | * Note: If the requested frequency is not an exact match with what can be | |
328 | * obtained using the prescalar value, the driver sets the clock frequency which | |
329 | * is lower than the requested frequency (maximum lower) for the transfer. If | |
330 | * the requested frequency is higher or lower than that is supported by the QSPI | |
331 | * controller the driver will set the highest or lowest frequency supported by | |
332 | * controller. | |
333 | */ | |
334 | static int zynq_qspi_config_op(struct zynq_qspi *xqspi, struct spi_device *spi) | |
335 | { | |
336 | u32 config_reg, baud_rate_val = 0; | |
337 | ||
338 | /* | |
339 | * Set the clock frequency | |
340 | * The baud rate divisor is not a direct mapping to the value written | |
341 | * into the configuration register (config_reg[5:3]) | |
342 | * i.e. 000 - divide by 2 | |
343 | * 001 - divide by 4 | |
344 | * ---------------- | |
345 | * 111 - divide by 256 | |
346 | */ | |
941be723 | 347 | while ((baud_rate_val < ZYNQ_QSPI_CONFIG_BAUD_DIV_MAX) && |
67dca5e5 NSR |
348 | (clk_get_rate(xqspi->refclk) / (2 << baud_rate_val)) > |
349 | spi->max_speed_hz) | |
350 | baud_rate_val++; | |
351 | ||
352 | config_reg = zynq_qspi_read(xqspi, ZYNQ_QSPI_CONFIG_OFFSET); | |
353 | ||
354 | /* Set the QSPI clock phase and clock polarity */ | |
355 | config_reg &= (~ZYNQ_QSPI_CONFIG_CPHA_MASK) & | |
356 | (~ZYNQ_QSPI_CONFIG_CPOL_MASK); | |
357 | if (spi->mode & SPI_CPHA) | |
358 | config_reg |= ZYNQ_QSPI_CONFIG_CPHA_MASK; | |
359 | if (spi->mode & SPI_CPOL) | |
360 | config_reg |= ZYNQ_QSPI_CONFIG_CPOL_MASK; | |
361 | ||
362 | config_reg &= ~ZYNQ_QSPI_CONFIG_BDRATE_MASK; | |
941be723 | 363 | config_reg |= (baud_rate_val << ZYNQ_QSPI_CONFIG_BAUD_DIV_SHIFT); |
67dca5e5 NSR |
364 | zynq_qspi_write(xqspi, ZYNQ_QSPI_CONFIG_OFFSET, config_reg); |
365 | ||
366 | return 0; | |
367 | } | |
368 | ||
369 | /** | |
121271f0 | 370 | * zynq_qspi_setup_op - Configure the QSPI controller |
67dca5e5 NSR |
371 | * @spi: Pointer to the spi_device structure |
372 | * | |
373 | * Sets the operational mode of QSPI controller for the next QSPI transfer, baud | |
374 | * rate and divisor value to setup the requested qspi clock. | |
375 | * | |
376 | * Return: 0 on success and error value on failure | |
377 | */ | |
378 | static int zynq_qspi_setup_op(struct spi_device *spi) | |
379 | { | |
9b10fa36 MR |
380 | struct spi_controller *ctlr = spi->master; |
381 | struct zynq_qspi *qspi = spi_controller_get_devdata(ctlr); | |
67dca5e5 | 382 | |
9b10fa36 | 383 | if (ctlr->busy) |
67dca5e5 NSR |
384 | return -EBUSY; |
385 | ||
386 | clk_enable(qspi->refclk); | |
387 | clk_enable(qspi->pclk); | |
388 | zynq_qspi_write(qspi, ZYNQ_QSPI_ENABLE_OFFSET, | |
389 | ZYNQ_QSPI_ENABLE_ENABLE_MASK); | |
390 | ||
391 | return 0; | |
392 | } | |
393 | ||
394 | /** | |
395 | * zynq_qspi_write_op - Fills the TX FIFO with as many bytes as possible | |
396 | * @xqspi: Pointer to the zynq_qspi structure | |
397 | * @txcount: Maximum number of words to write | |
398 | * @txempty: Indicates that TxFIFO is empty | |
399 | */ | |
400 | static void zynq_qspi_write_op(struct zynq_qspi *xqspi, int txcount, | |
401 | bool txempty) | |
402 | { | |
403 | int count, len, k; | |
404 | ||
405 | len = xqspi->tx_bytes; | |
406 | if (len && len < 4) { | |
407 | /* | |
408 | * We must empty the TxFIFO between accesses to TXD0, | |
409 | * TXD1, TXD2, TXD3. | |
410 | */ | |
411 | if (txempty) | |
412 | zynq_qspi_txfifo_op(xqspi, len); | |
413 | ||
414 | return; | |
415 | } | |
416 | ||
417 | count = len / 4; | |
418 | if (count > txcount) | |
419 | count = txcount; | |
420 | ||
421 | if (xqspi->txbuf) { | |
ba3ce8cb NSR |
422 | iowrite32_rep(xqspi->regs + ZYNQ_QSPI_TXD_00_00_OFFSET, |
423 | xqspi->txbuf, count); | |
67dca5e5 NSR |
424 | xqspi->txbuf += count * 4; |
425 | } else { | |
426 | for (k = 0; k < count; k++) | |
427 | writel_relaxed(0, xqspi->regs + | |
428 | ZYNQ_QSPI_TXD_00_00_OFFSET); | |
429 | } | |
430 | ||
431 | xqspi->tx_bytes -= count * 4; | |
432 | } | |
433 | ||
434 | /** | |
435 | * zynq_qspi_read_op - Drains the RX FIFO by as many bytes as possible | |
436 | * @xqspi: Pointer to the zynq_qspi structure | |
437 | * @rxcount: Maximum number of words to read | |
438 | */ | |
439 | static void zynq_qspi_read_op(struct zynq_qspi *xqspi, int rxcount) | |
440 | { | |
441 | int count, len, k; | |
442 | ||
443 | len = xqspi->rx_bytes - xqspi->tx_bytes; | |
444 | count = len / 4; | |
445 | if (count > rxcount) | |
446 | count = rxcount; | |
447 | if (xqspi->rxbuf) { | |
ba3ce8cb NSR |
448 | ioread32_rep(xqspi->regs + ZYNQ_QSPI_RXD_OFFSET, |
449 | xqspi->rxbuf, count); | |
67dca5e5 NSR |
450 | xqspi->rxbuf += count * 4; |
451 | } else { | |
452 | for (k = 0; k < count; k++) | |
453 | readl_relaxed(xqspi->regs + ZYNQ_QSPI_RXD_OFFSET); | |
454 | } | |
455 | xqspi->rx_bytes -= count * 4; | |
456 | len -= count * 4; | |
457 | ||
458 | if (len && len < 4 && count < rxcount) | |
459 | zynq_qspi_rxfifo_op(xqspi, len); | |
460 | } | |
461 | ||
462 | /** | |
463 | * zynq_qspi_irq - Interrupt service routine of the QSPI controller | |
464 | * @irq: IRQ number | |
465 | * @dev_id: Pointer to the xqspi structure | |
466 | * | |
467 | * This function handles TX empty only. | |
468 | * On TX empty interrupt this function reads the received data from RX FIFO and | |
469 | * fills the TX FIFO if there is any data remaining to be transferred. | |
470 | * | |
471 | * Return: IRQ_HANDLED when interrupt is handled; IRQ_NONE otherwise. | |
472 | */ | |
473 | static irqreturn_t zynq_qspi_irq(int irq, void *dev_id) | |
474 | { | |
475 | u32 intr_status; | |
476 | bool txempty; | |
477 | struct zynq_qspi *xqspi = (struct zynq_qspi *)dev_id; | |
478 | ||
479 | intr_status = zynq_qspi_read(xqspi, ZYNQ_QSPI_STATUS_OFFSET); | |
480 | zynq_qspi_write(xqspi, ZYNQ_QSPI_STATUS_OFFSET, intr_status); | |
481 | ||
482 | if ((intr_status & ZYNQ_QSPI_IXR_TXNFULL_MASK) || | |
483 | (intr_status & ZYNQ_QSPI_IXR_RXNEMTY_MASK)) { | |
484 | /* | |
485 | * This bit is set when Tx FIFO has < THRESHOLD entries. | |
486 | * We have the THRESHOLD value set to 1, | |
487 | * so this bit indicates Tx FIFO is empty. | |
488 | */ | |
489 | txempty = !!(intr_status & ZYNQ_QSPI_IXR_TXNFULL_MASK); | |
490 | /* Read out the data from the RX FIFO */ | |
491 | zynq_qspi_read_op(xqspi, ZYNQ_QSPI_RX_THRESHOLD); | |
492 | if (xqspi->tx_bytes) { | |
493 | /* There is more data to send */ | |
494 | zynq_qspi_write_op(xqspi, ZYNQ_QSPI_RX_THRESHOLD, | |
495 | txempty); | |
496 | } else { | |
497 | /* | |
498 | * If transfer and receive is completed then only send | |
499 | * complete signal. | |
500 | */ | |
501 | if (!xqspi->rx_bytes) { | |
502 | zynq_qspi_write(xqspi, | |
503 | ZYNQ_QSPI_IDIS_OFFSET, | |
504 | ZYNQ_QSPI_IXR_RXTX_MASK); | |
505 | complete(&xqspi->data_completion); | |
506 | } | |
507 | } | |
508 | return IRQ_HANDLED; | |
509 | } | |
510 | ||
511 | return IRQ_NONE; | |
512 | } | |
513 | ||
514 | /** | |
515 | * zynq_qspi_exec_mem_op() - Initiates the QSPI transfer | |
516 | * @mem: the SPI memory | |
517 | * @op: the memory operation to execute | |
518 | * | |
519 | * Executes a memory operation. | |
520 | * | |
521 | * This function first selects the chip and starts the memory operation. | |
522 | * | |
523 | * Return: 0 in case of success, a negative error code otherwise. | |
524 | */ | |
525 | static int zynq_qspi_exec_mem_op(struct spi_mem *mem, | |
526 | const struct spi_mem_op *op) | |
527 | { | |
528 | struct zynq_qspi *xqspi = spi_controller_get_devdata(mem->spi->master); | |
529 | int err = 0, i; | |
530 | u8 *tmpbuf; | |
531 | ||
532 | dev_dbg(xqspi->dev, "cmd:%#x mode:%d.%d.%d.%d\n", | |
6d5ff8e6 | 533 | op->cmd.opcode, op->cmd.buswidth, op->addr.buswidth, |
67dca5e5 NSR |
534 | op->dummy.buswidth, op->data.buswidth); |
535 | ||
536 | zynq_qspi_chipselect(mem->spi, true); | |
537 | zynq_qspi_config_op(xqspi, mem->spi); | |
538 | ||
6d5ff8e6 | 539 | if (op->cmd.opcode) { |
67dca5e5 | 540 | reinit_completion(&xqspi->data_completion); |
6d5ff8e6 | 541 | xqspi->txbuf = (u8 *)&op->cmd.opcode; |
67dca5e5 | 542 | xqspi->rxbuf = NULL; |
caf72df4 PY |
543 | xqspi->tx_bytes = op->cmd.nbytes; |
544 | xqspi->rx_bytes = op->cmd.nbytes; | |
67dca5e5 NSR |
545 | zynq_qspi_write_op(xqspi, ZYNQ_QSPI_FIFO_DEPTH, true); |
546 | zynq_qspi_write(xqspi, ZYNQ_QSPI_IEN_OFFSET, | |
547 | ZYNQ_QSPI_IXR_RXTX_MASK); | |
548 | if (!wait_for_completion_interruptible_timeout(&xqspi->data_completion, | |
549 | msecs_to_jiffies(1000))) | |
550 | err = -ETIMEDOUT; | |
551 | } | |
552 | ||
553 | if (op->addr.nbytes) { | |
554 | for (i = 0; i < op->addr.nbytes; i++) { | |
555 | xqspi->txbuf[i] = op->addr.val >> | |
556 | (8 * (op->addr.nbytes - i - 1)); | |
557 | } | |
558 | ||
559 | reinit_completion(&xqspi->data_completion); | |
560 | xqspi->rxbuf = NULL; | |
561 | xqspi->tx_bytes = op->addr.nbytes; | |
562 | xqspi->rx_bytes = op->addr.nbytes; | |
563 | zynq_qspi_write_op(xqspi, ZYNQ_QSPI_FIFO_DEPTH, true); | |
564 | zynq_qspi_write(xqspi, ZYNQ_QSPI_IEN_OFFSET, | |
565 | ZYNQ_QSPI_IXR_RXTX_MASK); | |
566 | if (!wait_for_completion_interruptible_timeout(&xqspi->data_completion, | |
567 | msecs_to_jiffies(1000))) | |
568 | err = -ETIMEDOUT; | |
569 | } | |
570 | ||
571 | if (op->dummy.nbytes) { | |
572 | tmpbuf = kzalloc(op->dummy.nbytes, GFP_KERNEL); | |
573 | memset(tmpbuf, 0xff, op->dummy.nbytes); | |
574 | reinit_completion(&xqspi->data_completion); | |
575 | xqspi->txbuf = tmpbuf; | |
576 | xqspi->rxbuf = NULL; | |
577 | xqspi->tx_bytes = op->dummy.nbytes; | |
578 | xqspi->rx_bytes = op->dummy.nbytes; | |
579 | zynq_qspi_write_op(xqspi, ZYNQ_QSPI_FIFO_DEPTH, true); | |
580 | zynq_qspi_write(xqspi, ZYNQ_QSPI_IEN_OFFSET, | |
581 | ZYNQ_QSPI_IXR_RXTX_MASK); | |
582 | if (!wait_for_completion_interruptible_timeout(&xqspi->data_completion, | |
583 | msecs_to_jiffies(1000))) | |
584 | err = -ETIMEDOUT; | |
585 | ||
586 | kfree(tmpbuf); | |
587 | } | |
588 | ||
589 | if (op->data.nbytes) { | |
590 | reinit_completion(&xqspi->data_completion); | |
591 | if (op->data.dir == SPI_MEM_DATA_OUT) { | |
592 | xqspi->txbuf = (u8 *)op->data.buf.out; | |
593 | xqspi->tx_bytes = op->data.nbytes; | |
594 | xqspi->rxbuf = NULL; | |
595 | xqspi->rx_bytes = op->data.nbytes; | |
596 | } else { | |
597 | xqspi->txbuf = NULL; | |
598 | xqspi->rxbuf = (u8 *)op->data.buf.in; | |
599 | xqspi->rx_bytes = op->data.nbytes; | |
600 | xqspi->tx_bytes = op->data.nbytes; | |
601 | } | |
602 | ||
603 | zynq_qspi_write_op(xqspi, ZYNQ_QSPI_FIFO_DEPTH, true); | |
604 | zynq_qspi_write(xqspi, ZYNQ_QSPI_IEN_OFFSET, | |
605 | ZYNQ_QSPI_IXR_RXTX_MASK); | |
606 | if (!wait_for_completion_interruptible_timeout(&xqspi->data_completion, | |
607 | msecs_to_jiffies(1000))) | |
608 | err = -ETIMEDOUT; | |
609 | } | |
610 | zynq_qspi_chipselect(mem->spi, false); | |
611 | ||
612 | return err; | |
613 | } | |
614 | ||
615 | static const struct spi_controller_mem_ops zynq_qspi_mem_ops = { | |
616 | .supports_op = zynq_qspi_supports_op, | |
617 | .exec_op = zynq_qspi_exec_mem_op, | |
618 | }; | |
619 | ||
620 | /** | |
621 | * zynq_qspi_probe - Probe method for the QSPI driver | |
622 | * @pdev: Pointer to the platform_device structure | |
623 | * | |
624 | * This function initializes the driver data structures and the hardware. | |
625 | * | |
626 | * Return: 0 on success and error value on failure | |
627 | */ | |
628 | static int zynq_qspi_probe(struct platform_device *pdev) | |
629 | { | |
630 | int ret = 0; | |
631 | struct spi_controller *ctlr; | |
632 | struct device *dev = &pdev->dev; | |
633 | struct device_node *np = dev->of_node; | |
634 | struct zynq_qspi *xqspi; | |
67dca5e5 NSR |
635 | u32 num_cs; |
636 | ||
637 | ctlr = spi_alloc_master(&pdev->dev, sizeof(*xqspi)); | |
638 | if (!ctlr) | |
639 | return -ENOMEM; | |
640 | ||
641 | xqspi = spi_controller_get_devdata(ctlr); | |
642 | xqspi->dev = dev; | |
643 | platform_set_drvdata(pdev, xqspi); | |
ae91a439 | 644 | xqspi->regs = devm_platform_ioremap_resource(pdev, 0); |
67dca5e5 NSR |
645 | if (IS_ERR(xqspi->regs)) { |
646 | ret = PTR_ERR(xqspi->regs); | |
647 | goto remove_master; | |
648 | } | |
649 | ||
650 | xqspi->pclk = devm_clk_get(&pdev->dev, "pclk"); | |
651 | if (IS_ERR(xqspi->pclk)) { | |
652 | dev_err(&pdev->dev, "pclk clock not found.\n"); | |
653 | ret = PTR_ERR(xqspi->pclk); | |
654 | goto remove_master; | |
655 | } | |
656 | ||
657 | init_completion(&xqspi->data_completion); | |
658 | ||
659 | xqspi->refclk = devm_clk_get(&pdev->dev, "ref_clk"); | |
660 | if (IS_ERR(xqspi->refclk)) { | |
661 | dev_err(&pdev->dev, "ref_clk clock not found.\n"); | |
662 | ret = PTR_ERR(xqspi->refclk); | |
663 | goto remove_master; | |
664 | } | |
665 | ||
666 | ret = clk_prepare_enable(xqspi->pclk); | |
667 | if (ret) { | |
668 | dev_err(&pdev->dev, "Unable to enable APB clock.\n"); | |
669 | goto remove_master; | |
670 | } | |
671 | ||
672 | ret = clk_prepare_enable(xqspi->refclk); | |
673 | if (ret) { | |
674 | dev_err(&pdev->dev, "Unable to enable device clock.\n"); | |
675 | goto clk_dis_pclk; | |
676 | } | |
677 | ||
67dca5e5 NSR |
678 | xqspi->irq = platform_get_irq(pdev, 0); |
679 | if (xqspi->irq <= 0) { | |
680 | ret = -ENXIO; | |
67dca5e5 NSR |
681 | goto remove_master; |
682 | } | |
683 | ret = devm_request_irq(&pdev->dev, xqspi->irq, zynq_qspi_irq, | |
684 | 0, pdev->name, xqspi); | |
685 | if (ret != 0) { | |
686 | ret = -ENXIO; | |
687 | dev_err(&pdev->dev, "request_irq failed\n"); | |
688 | goto remove_master; | |
689 | } | |
690 | ||
691 | ret = of_property_read_u32(np, "num-cs", | |
692 | &num_cs); | |
087622d0 | 693 | if (ret < 0) { |
d575c9b7 MR |
694 | ctlr->num_chipselect = 1; |
695 | } else if (num_cs > ZYNQ_QSPI_MAX_NUM_CS) { | |
696 | dev_err(&pdev->dev, "only 2 chip selects are available\n"); | |
087622d0 MR |
697 | goto remove_master; |
698 | } else { | |
67dca5e5 | 699 | ctlr->num_chipselect = num_cs; |
087622d0 | 700 | } |
67dca5e5 NSR |
701 | |
702 | ctlr->mode_bits = SPI_RX_DUAL | SPI_RX_QUAD | | |
703 | SPI_TX_DUAL | SPI_TX_QUAD; | |
704 | ctlr->mem_ops = &zynq_qspi_mem_ops; | |
705 | ctlr->setup = zynq_qspi_setup_op; | |
706 | ctlr->max_speed_hz = clk_get_rate(xqspi->refclk) / 2; | |
707 | ctlr->dev.of_node = np; | |
8f16292d MR |
708 | |
709 | /* QSPI controller initializations */ | |
d575c9b7 | 710 | zynq_qspi_init_hw(xqspi, ctlr->num_chipselect); |
8f16292d | 711 | |
8eb2fd00 | 712 | ret = devm_spi_register_controller(&pdev->dev, ctlr); |
67dca5e5 NSR |
713 | if (ret) { |
714 | dev_err(&pdev->dev, "spi_register_master failed\n"); | |
715 | goto clk_dis_all; | |
716 | } | |
717 | ||
718 | return ret; | |
719 | ||
720 | clk_dis_all: | |
721 | clk_disable_unprepare(xqspi->refclk); | |
722 | clk_dis_pclk: | |
723 | clk_disable_unprepare(xqspi->pclk); | |
724 | remove_master: | |
725 | spi_controller_put(ctlr); | |
726 | ||
727 | return ret; | |
728 | } | |
729 | ||
730 | /** | |
731 | * zynq_qspi_remove - Remove method for the QSPI driver | |
732 | * @pdev: Pointer to the platform_device structure | |
733 | * | |
734 | * This function is called if a device is physically removed from the system or | |
735 | * if the driver module is being unloaded. It frees all resources allocated to | |
736 | * the device. | |
737 | * | |
738 | * Return: 0 on success and error value on failure | |
739 | */ | |
740 | static int zynq_qspi_remove(struct platform_device *pdev) | |
741 | { | |
742 | struct zynq_qspi *xqspi = platform_get_drvdata(pdev); | |
743 | ||
744 | zynq_qspi_write(xqspi, ZYNQ_QSPI_ENABLE_OFFSET, 0); | |
745 | ||
746 | clk_disable_unprepare(xqspi->refclk); | |
747 | clk_disable_unprepare(xqspi->pclk); | |
748 | ||
749 | return 0; | |
750 | } | |
751 | ||
752 | static const struct of_device_id zynq_qspi_of_match[] = { | |
753 | { .compatible = "xlnx,zynq-qspi-1.0", }, | |
754 | { /* end of table */ } | |
755 | }; | |
756 | ||
757 | MODULE_DEVICE_TABLE(of, zynq_qspi_of_match); | |
758 | ||
759 | /* | |
760 | * zynq_qspi_driver - This structure defines the QSPI platform driver | |
761 | */ | |
762 | static struct platform_driver zynq_qspi_driver = { | |
763 | .probe = zynq_qspi_probe, | |
764 | .remove = zynq_qspi_remove, | |
765 | .driver = { | |
766 | .name = "zynq-qspi", | |
767 | .of_match_table = zynq_qspi_of_match, | |
768 | }, | |
769 | }; | |
770 | ||
771 | module_platform_driver(zynq_qspi_driver); | |
772 | ||
773 | MODULE_AUTHOR("Xilinx, Inc."); | |
774 | MODULE_DESCRIPTION("Xilinx Zynq QSPI driver"); | |
775 | MODULE_LICENSE("GPL"); |