2 * Copyright (C) 2012 Altera Corporation <www.altera.com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * - Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * - Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * - Neither the name of the Altera Corporation nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL ALTERA CORPORATION BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <linux/errno.h>
34 #include "cadence_qspi.h"
36 #define CQSPI_REG_POLL_US 1 /* 1us */
37 #define CQSPI_REG_RETRY 10000
38 #define CQSPI_POLL_IDLE_RETRY 3
41 #define CQSPI_INST_TYPE_SINGLE 0
42 #define CQSPI_INST_TYPE_DUAL 1
43 #define CQSPI_INST_TYPE_QUAD 2
45 #define CQSPI_STIG_DATA_LEN_MAX 8
47 #define CQSPI_DUMMY_CLKS_PER_BYTE 8
48 #define CQSPI_DUMMY_BYTES_MAX 4
50 /****************************************************************************
51 * Controller's configuration and status register (offset from QSPI_BASE)
52 ****************************************************************************/
53 #define CQSPI_REG_CONFIG 0x00
54 #define CQSPI_REG_CONFIG_ENABLE BIT(0)
55 #define CQSPI_REG_CONFIG_CLK_POL BIT(1)
56 #define CQSPI_REG_CONFIG_CLK_PHA BIT(2)
57 #define CQSPI_REG_CONFIG_DIRECT BIT(7)
58 #define CQSPI_REG_CONFIG_DECODE BIT(9)
59 #define CQSPI_REG_CONFIG_XIP_IMM BIT(18)
60 #define CQSPI_REG_CONFIG_CHIPSELECT_LSB 10
61 #define CQSPI_REG_CONFIG_BAUD_LSB 19
62 #define CQSPI_REG_CONFIG_IDLE_LSB 31
63 #define CQSPI_REG_CONFIG_CHIPSELECT_MASK 0xF
64 #define CQSPI_REG_CONFIG_BAUD_MASK 0xF
66 #define CQSPI_REG_RD_INSTR 0x04
67 #define CQSPI_REG_RD_INSTR_OPCODE_LSB 0
68 #define CQSPI_REG_RD_INSTR_TYPE_INSTR_LSB 8
69 #define CQSPI_REG_RD_INSTR_TYPE_ADDR_LSB 12
70 #define CQSPI_REG_RD_INSTR_TYPE_DATA_LSB 16
71 #define CQSPI_REG_RD_INSTR_MODE_EN_LSB 20
72 #define CQSPI_REG_RD_INSTR_DUMMY_LSB 24
73 #define CQSPI_REG_RD_INSTR_TYPE_INSTR_MASK 0x3
74 #define CQSPI_REG_RD_INSTR_TYPE_ADDR_MASK 0x3
75 #define CQSPI_REG_RD_INSTR_TYPE_DATA_MASK 0x3
76 #define CQSPI_REG_RD_INSTR_DUMMY_MASK 0x1F
78 #define CQSPI_REG_WR_INSTR 0x08
79 #define CQSPI_REG_WR_INSTR_OPCODE_LSB 0
81 #define CQSPI_REG_DELAY 0x0C
82 #define CQSPI_REG_DELAY_TSLCH_LSB 0
83 #define CQSPI_REG_DELAY_TCHSH_LSB 8
84 #define CQSPI_REG_DELAY_TSD2D_LSB 16
85 #define CQSPI_REG_DELAY_TSHSL_LSB 24
86 #define CQSPI_REG_DELAY_TSLCH_MASK 0xFF
87 #define CQSPI_REG_DELAY_TCHSH_MASK 0xFF
88 #define CQSPI_REG_DELAY_TSD2D_MASK 0xFF
89 #define CQSPI_REG_DELAY_TSHSL_MASK 0xFF
91 #define CQSPI_REG_RD_DATA_CAPTURE 0x10
92 #define CQSPI_REG_RD_DATA_CAPTURE_BYPASS BIT(0)
93 #define CQSPI_REG_RD_DATA_CAPTURE_DELAY_LSB 1
94 #define CQSPI_REG_RD_DATA_CAPTURE_DELAY_MASK 0xF
96 #define CQSPI_REG_SIZE 0x14
97 #define CQSPI_REG_SIZE_ADDRESS_LSB 0
98 #define CQSPI_REG_SIZE_PAGE_LSB 4
99 #define CQSPI_REG_SIZE_BLOCK_LSB 16
100 #define CQSPI_REG_SIZE_ADDRESS_MASK 0xF
101 #define CQSPI_REG_SIZE_PAGE_MASK 0xFFF
102 #define CQSPI_REG_SIZE_BLOCK_MASK 0x3F
104 #define CQSPI_REG_SRAMPARTITION 0x18
105 #define CQSPI_REG_INDIRECTTRIGGER 0x1C
107 #define CQSPI_REG_REMAP 0x24
108 #define CQSPI_REG_MODE_BIT 0x28
110 #define CQSPI_REG_SDRAMLEVEL 0x2C
111 #define CQSPI_REG_SDRAMLEVEL_RD_LSB 0
112 #define CQSPI_REG_SDRAMLEVEL_WR_LSB 16
113 #define CQSPI_REG_SDRAMLEVEL_RD_MASK 0xFFFF
114 #define CQSPI_REG_SDRAMLEVEL_WR_MASK 0xFFFF
116 #define CQSPI_REG_IRQSTATUS 0x40
117 #define CQSPI_REG_IRQMASK 0x44
119 #define CQSPI_REG_INDIRECTRD 0x60
120 #define CQSPI_REG_INDIRECTRD_START BIT(0)
121 #define CQSPI_REG_INDIRECTRD_CANCEL BIT(1)
122 #define CQSPI_REG_INDIRECTRD_INPROGRESS BIT(2)
123 #define CQSPI_REG_INDIRECTRD_DONE BIT(5)
125 #define CQSPI_REG_INDIRECTRDWATERMARK 0x64
126 #define CQSPI_REG_INDIRECTRDSTARTADDR 0x68
127 #define CQSPI_REG_INDIRECTRDBYTES 0x6C
129 #define CQSPI_REG_CMDCTRL 0x90
130 #define CQSPI_REG_CMDCTRL_EXECUTE BIT(0)
131 #define CQSPI_REG_CMDCTRL_INPROGRESS BIT(1)
132 #define CQSPI_REG_CMDCTRL_DUMMY_LSB 7
133 #define CQSPI_REG_CMDCTRL_WR_BYTES_LSB 12
134 #define CQSPI_REG_CMDCTRL_WR_EN_LSB 15
135 #define CQSPI_REG_CMDCTRL_ADD_BYTES_LSB 16
136 #define CQSPI_REG_CMDCTRL_ADDR_EN_LSB 19
137 #define CQSPI_REG_CMDCTRL_RD_BYTES_LSB 20
138 #define CQSPI_REG_CMDCTRL_RD_EN_LSB 23
139 #define CQSPI_REG_CMDCTRL_OPCODE_LSB 24
140 #define CQSPI_REG_CMDCTRL_DUMMY_MASK 0x1F
141 #define CQSPI_REG_CMDCTRL_WR_BYTES_MASK 0x7
142 #define CQSPI_REG_CMDCTRL_ADD_BYTES_MASK 0x3
143 #define CQSPI_REG_CMDCTRL_RD_BYTES_MASK 0x7
144 #define CQSPI_REG_CMDCTRL_OPCODE_MASK 0xFF
146 #define CQSPI_REG_INDIRECTWR 0x70
147 #define CQSPI_REG_INDIRECTWR_START BIT(0)
148 #define CQSPI_REG_INDIRECTWR_CANCEL BIT(1)
149 #define CQSPI_REG_INDIRECTWR_INPROGRESS BIT(2)
150 #define CQSPI_REG_INDIRECTWR_DONE BIT(5)
152 #define CQSPI_REG_INDIRECTWRWATERMARK 0x74
153 #define CQSPI_REG_INDIRECTWRSTARTADDR 0x78
154 #define CQSPI_REG_INDIRECTWRBYTES 0x7C
156 #define CQSPI_REG_CMDADDRESS 0x94
157 #define CQSPI_REG_CMDREADDATALOWER 0xA0
158 #define CQSPI_REG_CMDREADDATAUPPER 0xA4
159 #define CQSPI_REG_CMDWRITEDATALOWER 0xA8
160 #define CQSPI_REG_CMDWRITEDATAUPPER 0xAC
162 #define CQSPI_REG_IS_IDLE(base) \
163 ((readl(base + CQSPI_REG_CONFIG) >> \
164 CQSPI_REG_CONFIG_IDLE_LSB) & 0x1)
166 #define CQSPI_GET_RD_SRAM_LEVEL(reg_base) \
167 (((readl(reg_base + CQSPI_REG_SDRAMLEVEL)) >> \
168 CQSPI_REG_SDRAMLEVEL_RD_LSB) & CQSPI_REG_SDRAMLEVEL_RD_MASK)
170 #define CQSPI_GET_WR_SRAM_LEVEL(reg_base) \
171 (((readl(reg_base + CQSPI_REG_SDRAMLEVEL)) >> \
172 CQSPI_REG_SDRAMLEVEL_WR_LSB) & CQSPI_REG_SDRAMLEVEL_WR_MASK)
174 static unsigned int cadence_qspi_apb_cmd2addr(const unsigned char *addr_buf
,
175 unsigned int addr_width
)
179 addr
= (addr_buf
[0] << 16) | (addr_buf
[1] << 8) | addr_buf
[2];
182 addr
= (addr
<< 8) | addr_buf
[3];
187 void cadence_qspi_apb_controller_enable(void *reg_base
)
190 reg
= readl(reg_base
+ CQSPI_REG_CONFIG
);
191 reg
|= CQSPI_REG_CONFIG_ENABLE
;
192 writel(reg
, reg_base
+ CQSPI_REG_CONFIG
);
195 void cadence_qspi_apb_controller_disable(void *reg_base
)
198 reg
= readl(reg_base
+ CQSPI_REG_CONFIG
);
199 reg
&= ~CQSPI_REG_CONFIG_ENABLE
;
200 writel(reg
, reg_base
+ CQSPI_REG_CONFIG
);
203 /* Return 1 if idle, otherwise return 0 (busy). */
204 static unsigned int cadence_qspi_wait_idle(void *reg_base
)
206 unsigned int start
, count
= 0;
207 /* timeout in unit of ms */
208 unsigned int timeout
= 5000;
210 start
= get_timer(0);
211 for ( ; get_timer(start
) < timeout
; ) {
212 if (CQSPI_REG_IS_IDLE(reg_base
))
217 * Ensure the QSPI controller is in true idle state after
218 * reading back the same idle status consecutively
220 if (count
>= CQSPI_POLL_IDLE_RETRY
)
224 /* Timeout, still in busy mode. */
225 printf("QSPI: QSPI is still busy after poll for %d times.\n",
230 void cadence_qspi_apb_readdata_capture(void *reg_base
,
231 unsigned int bypass
, unsigned int delay
)
234 cadence_qspi_apb_controller_disable(reg_base
);
236 reg
= readl(reg_base
+ CQSPI_REG_RD_DATA_CAPTURE
);
239 reg
|= CQSPI_REG_RD_DATA_CAPTURE_BYPASS
;
241 reg
&= ~CQSPI_REG_RD_DATA_CAPTURE_BYPASS
;
243 reg
&= ~(CQSPI_REG_RD_DATA_CAPTURE_DELAY_MASK
244 << CQSPI_REG_RD_DATA_CAPTURE_DELAY_LSB
);
246 reg
|= (delay
& CQSPI_REG_RD_DATA_CAPTURE_DELAY_MASK
)
247 << CQSPI_REG_RD_DATA_CAPTURE_DELAY_LSB
;
249 writel(reg
, reg_base
+ CQSPI_REG_RD_DATA_CAPTURE
);
251 cadence_qspi_apb_controller_enable(reg_base
);
254 void cadence_qspi_apb_config_baudrate_div(void *reg_base
,
255 unsigned int ref_clk_hz
, unsigned int sclk_hz
)
260 cadence_qspi_apb_controller_disable(reg_base
);
261 reg
= readl(reg_base
+ CQSPI_REG_CONFIG
);
262 reg
&= ~(CQSPI_REG_CONFIG_BAUD_MASK
<< CQSPI_REG_CONFIG_BAUD_LSB
);
265 * The baud_div field in the config reg is 4 bits, and the ref clock is
266 * divided by 2 * (baud_div + 1). Round up the divider to ensure the
267 * SPI clock rate is less than or equal to the requested clock rate.
269 div
= DIV_ROUND_UP(ref_clk_hz
, sclk_hz
* 2) - 1;
271 /* ensure the baud rate doesn't exceed the max value */
272 if (div
> CQSPI_REG_CONFIG_BAUD_MASK
)
273 div
= CQSPI_REG_CONFIG_BAUD_MASK
;
275 debug("%s: ref_clk %dHz sclk %dHz Div 0x%x, actual %dHz\n", __func__
,
276 ref_clk_hz
, sclk_hz
, div
, ref_clk_hz
/ (2 * (div
+ 1)));
278 reg
|= (div
<< CQSPI_REG_CONFIG_BAUD_LSB
);
279 writel(reg
, reg_base
+ CQSPI_REG_CONFIG
);
281 cadence_qspi_apb_controller_enable(reg_base
);
284 void cadence_qspi_apb_set_clk_mode(void *reg_base
, uint mode
)
288 cadence_qspi_apb_controller_disable(reg_base
);
289 reg
= readl(reg_base
+ CQSPI_REG_CONFIG
);
290 reg
&= ~(CQSPI_REG_CONFIG_CLK_POL
| CQSPI_REG_CONFIG_CLK_PHA
);
293 reg
|= CQSPI_REG_CONFIG_CLK_POL
;
295 reg
|= CQSPI_REG_CONFIG_CLK_PHA
;
297 writel(reg
, reg_base
+ CQSPI_REG_CONFIG
);
299 cadence_qspi_apb_controller_enable(reg_base
);
302 void cadence_qspi_apb_chipselect(void *reg_base
,
303 unsigned int chip_select
, unsigned int decoder_enable
)
307 cadence_qspi_apb_controller_disable(reg_base
);
309 debug("%s : chipselect %d decode %d\n", __func__
, chip_select
,
312 reg
= readl(reg_base
+ CQSPI_REG_CONFIG
);
314 if (decoder_enable
) {
315 reg
|= CQSPI_REG_CONFIG_DECODE
;
317 reg
&= ~CQSPI_REG_CONFIG_DECODE
;
318 /* Convert CS if without decoder.
324 chip_select
= 0xF & ~(1 << chip_select
);
327 reg
&= ~(CQSPI_REG_CONFIG_CHIPSELECT_MASK
328 << CQSPI_REG_CONFIG_CHIPSELECT_LSB
);
329 reg
|= (chip_select
& CQSPI_REG_CONFIG_CHIPSELECT_MASK
)
330 << CQSPI_REG_CONFIG_CHIPSELECT_LSB
;
331 writel(reg
, reg_base
+ CQSPI_REG_CONFIG
);
333 cadence_qspi_apb_controller_enable(reg_base
);
336 void cadence_qspi_apb_delay(void *reg_base
,
337 unsigned int ref_clk
, unsigned int sclk_hz
,
338 unsigned int tshsl_ns
, unsigned int tsd2d_ns
,
339 unsigned int tchsh_ns
, unsigned int tslch_ns
)
341 unsigned int ref_clk_ns
;
342 unsigned int sclk_ns
;
343 unsigned int tshsl
, tchsh
, tslch
, tsd2d
;
346 cadence_qspi_apb_controller_disable(reg_base
);
349 ref_clk_ns
= DIV_ROUND_UP(1000000000, ref_clk
);
352 sclk_ns
= DIV_ROUND_UP(1000000000, sclk_hz
);
354 /* The controller adds additional delay to that programmed in the reg */
355 if (tshsl_ns
>= sclk_ns
+ ref_clk_ns
)
356 tshsl_ns
-= sclk_ns
+ ref_clk_ns
;
357 if (tchsh_ns
>= sclk_ns
+ 3 * ref_clk_ns
)
358 tchsh_ns
-= sclk_ns
+ 3 * ref_clk_ns
;
359 tshsl
= DIV_ROUND_UP(tshsl_ns
, ref_clk_ns
);
360 tchsh
= DIV_ROUND_UP(tchsh_ns
, ref_clk_ns
);
361 tslch
= DIV_ROUND_UP(tslch_ns
, ref_clk_ns
);
362 tsd2d
= DIV_ROUND_UP(tsd2d_ns
, ref_clk_ns
);
364 reg
= ((tshsl
& CQSPI_REG_DELAY_TSHSL_MASK
)
365 << CQSPI_REG_DELAY_TSHSL_LSB
);
366 reg
|= ((tchsh
& CQSPI_REG_DELAY_TCHSH_MASK
)
367 << CQSPI_REG_DELAY_TCHSH_LSB
);
368 reg
|= ((tslch
& CQSPI_REG_DELAY_TSLCH_MASK
)
369 << CQSPI_REG_DELAY_TSLCH_LSB
);
370 reg
|= ((tsd2d
& CQSPI_REG_DELAY_TSD2D_MASK
)
371 << CQSPI_REG_DELAY_TSD2D_LSB
);
372 writel(reg
, reg_base
+ CQSPI_REG_DELAY
);
374 cadence_qspi_apb_controller_enable(reg_base
);
377 void cadence_qspi_apb_controller_init(struct cadence_spi_platdata
*plat
)
381 cadence_qspi_apb_controller_disable(plat
->regbase
);
383 /* Configure the device size and address bytes */
384 reg
= readl(plat
->regbase
+ CQSPI_REG_SIZE
);
385 /* Clear the previous value */
386 reg
&= ~(CQSPI_REG_SIZE_PAGE_MASK
<< CQSPI_REG_SIZE_PAGE_LSB
);
387 reg
&= ~(CQSPI_REG_SIZE_BLOCK_MASK
<< CQSPI_REG_SIZE_BLOCK_LSB
);
388 reg
|= (plat
->page_size
<< CQSPI_REG_SIZE_PAGE_LSB
);
389 reg
|= (plat
->block_size
<< CQSPI_REG_SIZE_BLOCK_LSB
);
390 writel(reg
, plat
->regbase
+ CQSPI_REG_SIZE
);
392 /* Configure the remap address register, no remap */
393 writel(0, plat
->regbase
+ CQSPI_REG_REMAP
);
395 /* Indirect mode configurations */
396 writel(plat
->fifo_depth
/ 2, plat
->regbase
+ CQSPI_REG_SRAMPARTITION
);
398 /* Disable all interrupts */
399 writel(0, plat
->regbase
+ CQSPI_REG_IRQMASK
);
401 cadence_qspi_apb_controller_enable(plat
->regbase
);
404 static int cadence_qspi_apb_exec_flash_cmd(void *reg_base
,
407 unsigned int retry
= CQSPI_REG_RETRY
;
409 /* Write the CMDCTRL without start execution. */
410 writel(reg
, reg_base
+ CQSPI_REG_CMDCTRL
);
412 reg
|= CQSPI_REG_CMDCTRL_EXECUTE
;
413 writel(reg
, reg_base
+ CQSPI_REG_CMDCTRL
);
416 reg
= readl(reg_base
+ CQSPI_REG_CMDCTRL
);
417 if ((reg
& CQSPI_REG_CMDCTRL_INPROGRESS
) == 0)
423 printf("QSPI: flash command execution timeout\n");
427 /* Polling QSPI idle status. */
428 if (!cadence_qspi_wait_idle(reg_base
))
434 /* For command RDID, RDSR. */
435 int cadence_qspi_apb_command_read(void *reg_base
,
436 unsigned int cmdlen
, const u8
*cmdbuf
, unsigned int rxlen
,
440 unsigned int read_len
;
443 if (!cmdlen
|| rxlen
> CQSPI_STIG_DATA_LEN_MAX
|| rxbuf
== NULL
) {
444 printf("QSPI: Invalid input arguments cmdlen %d rxlen %d\n",
449 reg
= cmdbuf
[0] << CQSPI_REG_CMDCTRL_OPCODE_LSB
;
451 reg
|= (0x1 << CQSPI_REG_CMDCTRL_RD_EN_LSB
);
453 /* 0 means 1 byte. */
454 reg
|= (((rxlen
- 1) & CQSPI_REG_CMDCTRL_RD_BYTES_MASK
)
455 << CQSPI_REG_CMDCTRL_RD_BYTES_LSB
);
456 status
= cadence_qspi_apb_exec_flash_cmd(reg_base
, reg
);
460 reg
= readl(reg_base
+ CQSPI_REG_CMDREADDATALOWER
);
462 /* Put the read value into rx_buf */
463 read_len
= (rxlen
> 4) ? 4 : rxlen
;
464 memcpy(rxbuf
, ®
, read_len
);
468 reg
= readl(reg_base
+ CQSPI_REG_CMDREADDATAUPPER
);
470 read_len
= rxlen
- read_len
;
471 memcpy(rxbuf
, ®
, read_len
);
476 /* For commands: WRSR, WREN, WRDI, CHIP_ERASE, BE, etc. */
477 int cadence_qspi_apb_command_write(void *reg_base
, unsigned int cmdlen
,
478 const u8
*cmdbuf
, unsigned int txlen
, const u8
*txbuf
)
480 unsigned int reg
= 0;
481 unsigned int addr_value
;
482 unsigned int wr_data
;
485 if (!cmdlen
|| cmdlen
> 5 || txlen
> 8 || cmdbuf
== NULL
) {
486 printf("QSPI: Invalid input arguments cmdlen %d txlen %d\n",
491 reg
|= cmdbuf
[0] << CQSPI_REG_CMDCTRL_OPCODE_LSB
;
493 if (cmdlen
== 4 || cmdlen
== 5) {
494 /* Command with address */
495 reg
|= (0x1 << CQSPI_REG_CMDCTRL_ADDR_EN_LSB
);
496 /* Number of bytes to write. */
497 reg
|= ((cmdlen
- 2) & CQSPI_REG_CMDCTRL_ADD_BYTES_MASK
)
498 << CQSPI_REG_CMDCTRL_ADD_BYTES_LSB
;
500 addr_value
= cadence_qspi_apb_cmd2addr(&cmdbuf
[1],
501 cmdlen
>= 5 ? 4 : 3);
503 writel(addr_value
, reg_base
+ CQSPI_REG_CMDADDRESS
);
507 /* writing data = yes */
508 reg
|= (0x1 << CQSPI_REG_CMDCTRL_WR_EN_LSB
);
509 reg
|= ((txlen
- 1) & CQSPI_REG_CMDCTRL_WR_BYTES_MASK
)
510 << CQSPI_REG_CMDCTRL_WR_BYTES_LSB
;
512 wr_len
= txlen
> 4 ? 4 : txlen
;
513 memcpy(&wr_data
, txbuf
, wr_len
);
514 writel(wr_data
, reg_base
+
515 CQSPI_REG_CMDWRITEDATALOWER
);
519 wr_len
= txlen
- wr_len
;
520 memcpy(&wr_data
, txbuf
, wr_len
);
521 writel(wr_data
, reg_base
+
522 CQSPI_REG_CMDWRITEDATAUPPER
);
526 /* Execute the command */
527 return cadence_qspi_apb_exec_flash_cmd(reg_base
, reg
);
530 /* Opcode + Address (3/4 bytes) + dummy bytes (0-4 bytes) */
531 int cadence_qspi_apb_indirect_read_setup(struct cadence_spi_platdata
*plat
,
532 unsigned int cmdlen
, unsigned int rx_width
, const u8
*cmdbuf
)
536 unsigned int addr_value
;
537 unsigned int dummy_clk
;
538 unsigned int dummy_bytes
;
539 unsigned int addr_bytes
;
542 * Identify addr_byte. All NOR flash device drivers are using fast read
543 * which always expecting 1 dummy byte, 1 cmd byte and 3/4 addr byte.
544 * With that, the length is in value of 5 or 6. Only FRAM chip from
545 * ramtron using normal read (which won't need dummy byte).
546 * Unlikely NOR flash using normal read due to performance issue.
549 /* to cater fast read where cmd + addr + dummy */
550 addr_bytes
= cmdlen
- 2;
552 /* for normal read (only ramtron as of now) */
553 addr_bytes
= cmdlen
- 1;
555 /* Setup the indirect trigger address */
556 writel(plat
->trigger_address
,
557 plat
->regbase
+ CQSPI_REG_INDIRECTTRIGGER
);
559 /* Configure the opcode */
560 rd_reg
= cmdbuf
[0] << CQSPI_REG_RD_INSTR_OPCODE_LSB
;
562 if (rx_width
& SPI_RX_QUAD
)
563 /* Instruction and address at DQ0, data at DQ0-3. */
564 rd_reg
|= CQSPI_INST_TYPE_QUAD
<< CQSPI_REG_RD_INSTR_TYPE_DATA_LSB
;
567 addr_value
= cadence_qspi_apb_cmd2addr(&cmdbuf
[1], addr_bytes
);
568 writel(addr_value
, plat
->regbase
+ CQSPI_REG_INDIRECTRDSTARTADDR
);
570 /* The remaining lenght is dummy bytes. */
571 dummy_bytes
= cmdlen
- addr_bytes
- 1;
573 if (dummy_bytes
> CQSPI_DUMMY_BYTES_MAX
)
574 dummy_bytes
= CQSPI_DUMMY_BYTES_MAX
;
576 rd_reg
|= (1 << CQSPI_REG_RD_INSTR_MODE_EN_LSB
);
577 #if defined(CONFIG_SPL_SPI_XIP) && defined(CONFIG_SPL_BUILD)
578 writel(0x0, plat
->regbase
+ CQSPI_REG_MODE_BIT
);
580 writel(0xFF, plat
->regbase
+ CQSPI_REG_MODE_BIT
);
583 /* Convert to clock cycles. */
584 dummy_clk
= dummy_bytes
* CQSPI_DUMMY_CLKS_PER_BYTE
;
585 /* Need to minus the mode byte (8 clocks). */
586 dummy_clk
-= CQSPI_DUMMY_CLKS_PER_BYTE
;
589 rd_reg
|= (dummy_clk
& CQSPI_REG_RD_INSTR_DUMMY_MASK
)
590 << CQSPI_REG_RD_INSTR_DUMMY_LSB
;
593 writel(rd_reg
, plat
->regbase
+ CQSPI_REG_RD_INSTR
);
595 /* set device size */
596 reg
= readl(plat
->regbase
+ CQSPI_REG_SIZE
);
597 reg
&= ~CQSPI_REG_SIZE_ADDRESS_MASK
;
598 reg
|= (addr_bytes
- 1);
599 writel(reg
, plat
->regbase
+ CQSPI_REG_SIZE
);
603 static u32
cadence_qspi_get_rd_sram_level(struct cadence_spi_platdata
*plat
)
605 u32 reg
= readl(plat
->regbase
+ CQSPI_REG_SDRAMLEVEL
);
606 reg
>>= CQSPI_REG_SDRAMLEVEL_RD_LSB
;
607 return reg
& CQSPI_REG_SDRAMLEVEL_RD_MASK
;
610 static int cadence_qspi_wait_for_data(struct cadence_spi_platdata
*plat
)
612 unsigned int timeout
= 10000;
616 reg
= cadence_qspi_get_rd_sram_level(plat
);
625 int cadence_qspi_apb_indirect_read_execute(struct cadence_spi_platdata
*plat
,
626 unsigned int n_rx
, u8
*rxbuf
)
628 unsigned int remaining
= n_rx
;
629 unsigned int bytes_to_read
= 0;
632 writel(n_rx
, plat
->regbase
+ CQSPI_REG_INDIRECTRDBYTES
);
634 /* Start the indirect read transfer */
635 writel(CQSPI_REG_INDIRECTRD_START
,
636 plat
->regbase
+ CQSPI_REG_INDIRECTRD
);
638 while (remaining
> 0) {
639 ret
= cadence_qspi_wait_for_data(plat
);
641 printf("Indirect write timed out (%i)\n", ret
);
647 while (bytes_to_read
!= 0) {
648 bytes_to_read
*= plat
->fifo_width
;
649 bytes_to_read
= bytes_to_read
> remaining
?
650 remaining
: bytes_to_read
;
652 * Handle non-4-byte aligned access to avoid
655 if (((uintptr_t)rxbuf
% 4) || (bytes_to_read
% 4))
656 readsb(plat
->ahbbase
, rxbuf
, bytes_to_read
);
658 readsl(plat
->ahbbase
, rxbuf
,
660 rxbuf
+= bytes_to_read
;
661 remaining
-= bytes_to_read
;
662 bytes_to_read
= cadence_qspi_get_rd_sram_level(plat
);
666 /* Check indirect done status */
667 ret
= wait_for_bit_le32(plat
->regbase
+ CQSPI_REG_INDIRECTRD
,
668 CQSPI_REG_INDIRECTRD_DONE
, 1, 10, 0);
670 printf("Indirect read completion error (%i)\n", ret
);
674 /* Clear indirect completion status */
675 writel(CQSPI_REG_INDIRECTRD_DONE
,
676 plat
->regbase
+ CQSPI_REG_INDIRECTRD
);
681 /* Cancel the indirect read */
682 writel(CQSPI_REG_INDIRECTRD_CANCEL
,
683 plat
->regbase
+ CQSPI_REG_INDIRECTRD
);
687 /* Opcode + Address (3/4 bytes) */
688 int cadence_qspi_apb_indirect_write_setup(struct cadence_spi_platdata
*plat
,
689 unsigned int cmdlen
, const u8
*cmdbuf
)
692 unsigned int addr_bytes
= cmdlen
> 4 ? 4 : 3;
694 if (cmdlen
< 4 || cmdbuf
== NULL
) {
695 printf("QSPI: Invalid input argument, len %d cmdbuf %p\n",
699 /* Setup the indirect trigger address */
700 writel(plat
->trigger_address
,
701 plat
->regbase
+ CQSPI_REG_INDIRECTTRIGGER
);
703 /* Configure the opcode */
704 reg
= cmdbuf
[0] << CQSPI_REG_WR_INSTR_OPCODE_LSB
;
705 writel(reg
, plat
->regbase
+ CQSPI_REG_WR_INSTR
);
707 /* Setup write address. */
708 reg
= cadence_qspi_apb_cmd2addr(&cmdbuf
[1], addr_bytes
);
709 writel(reg
, plat
->regbase
+ CQSPI_REG_INDIRECTWRSTARTADDR
);
711 reg
= readl(plat
->regbase
+ CQSPI_REG_SIZE
);
712 reg
&= ~CQSPI_REG_SIZE_ADDRESS_MASK
;
713 reg
|= (addr_bytes
- 1);
714 writel(reg
, plat
->regbase
+ CQSPI_REG_SIZE
);
718 int cadence_qspi_apb_indirect_write_execute(struct cadence_spi_platdata
*plat
,
719 unsigned int n_tx
, const u8
*txbuf
)
721 unsigned int page_size
= plat
->page_size
;
722 unsigned int remaining
= n_tx
;
723 const u8
*bb_txbuf
= txbuf
;
724 void *bounce_buf
= NULL
;
725 unsigned int write_bytes
;
729 * Use bounce buffer for non 32 bit aligned txbuf to avoid data
732 if ((uintptr_t)txbuf
% 4) {
733 bounce_buf
= malloc(n_tx
);
736 memcpy(bounce_buf
, txbuf
, n_tx
);
737 bb_txbuf
= bounce_buf
;
740 /* Configure the indirect read transfer bytes */
741 writel(n_tx
, plat
->regbase
+ CQSPI_REG_INDIRECTWRBYTES
);
743 /* Start the indirect write transfer */
744 writel(CQSPI_REG_INDIRECTWR_START
,
745 plat
->regbase
+ CQSPI_REG_INDIRECTWR
);
747 while (remaining
> 0) {
748 write_bytes
= remaining
> page_size
? page_size
: remaining
;
749 writesl(plat
->ahbbase
, bb_txbuf
, write_bytes
>> 2);
751 writesb(plat
->ahbbase
,
752 bb_txbuf
+ rounddown(write_bytes
, 4),
755 ret
= wait_for_bit_le32(plat
->regbase
+ CQSPI_REG_SDRAMLEVEL
,
756 CQSPI_REG_SDRAMLEVEL_WR_MASK
<<
757 CQSPI_REG_SDRAMLEVEL_WR_LSB
, 0, 10, 0);
759 printf("Indirect write timed out (%i)\n", ret
);
763 bb_txbuf
+= write_bytes
;
764 remaining
-= write_bytes
;
767 /* Check indirect done status */
768 ret
= wait_for_bit_le32(plat
->regbase
+ CQSPI_REG_INDIRECTWR
,
769 CQSPI_REG_INDIRECTWR_DONE
, 1, 10, 0);
771 printf("Indirect write completion error (%i)\n", ret
);
775 /* Clear indirect completion status */
776 writel(CQSPI_REG_INDIRECTWR_DONE
,
777 plat
->regbase
+ CQSPI_REG_INDIRECTWR
);
783 /* Cancel the indirect write */
784 writel(CQSPI_REG_INDIRECTWR_CANCEL
,
785 plat
->regbase
+ CQSPI_REG_INDIRECTWR
);
791 void cadence_qspi_apb_enter_xip(void *reg_base
, char xip_dummy
)
795 /* enter XiP mode immediately and enable direct mode */
796 reg
= readl(reg_base
+ CQSPI_REG_CONFIG
);
797 reg
|= CQSPI_REG_CONFIG_ENABLE
;
798 reg
|= CQSPI_REG_CONFIG_DIRECT
;
799 reg
|= CQSPI_REG_CONFIG_XIP_IMM
;
800 writel(reg
, reg_base
+ CQSPI_REG_CONFIG
);
802 /* keep the XiP mode */
803 writel(xip_dummy
, reg_base
+ CQSPI_REG_MODE_BIT
);
805 /* Enable mode bit at devrd */
806 reg
= readl(reg_base
+ CQSPI_REG_RD_INSTR
);
807 reg
|= (1 << CQSPI_REG_RD_INSTR_MODE_EN_LSB
);
808 writel(reg
, reg_base
+ CQSPI_REG_RD_INSTR
);