1 // SPDX-License-Identifier: GPL-2.0
3 * Driver for Atmel QSPI Controller
5 * Copyright (C) 2015 Atmel Corporation
6 * Copyright (C) 2018 Cryptera A/S
8 * Author: Cyrille Pitchen <cyrille.pitchen@atmel.com>
9 * Author: Piotr Bugalski <bugalski.piotr@gmail.com>
19 #include <dm/device_compat.h>
20 #include <linux/bitops.h>
21 #include <linux/err.h>
23 #include <linux/iopoll.h>
24 #include <linux/ioport.h>
29 /* QSPI register offsets */
30 #define QSPI_CR 0x0000 /* Control Register */
31 #define QSPI_MR 0x0004 /* Mode Register */
32 #define QSPI_RD 0x0008 /* Receive Data Register */
33 #define QSPI_TD 0x000c /* Transmit Data Register */
34 #define QSPI_SR 0x0010 /* Status Register */
35 #define QSPI_IER 0x0014 /* Interrupt Enable Register */
36 #define QSPI_IDR 0x0018 /* Interrupt Disable Register */
37 #define QSPI_IMR 0x001c /* Interrupt Mask Register */
38 #define QSPI_SCR 0x0020 /* Serial Clock Register */
40 #define QSPI_IAR 0x0030 /* Instruction Address Register */
41 #define QSPI_ICR 0x0034 /* Instruction Code Register */
42 #define QSPI_WICR 0x0034 /* Write Instruction Code Register */
43 #define QSPI_IFR 0x0038 /* Instruction Frame Register */
44 #define QSPI_RICR 0x003C /* Read Instruction Code Register */
46 #define QSPI_SMR 0x0040 /* Scrambling Mode Register */
47 #define QSPI_SKR 0x0044 /* Scrambling Key Register */
49 #define QSPI_WPMR 0x00E4 /* Write Protection Mode Register */
50 #define QSPI_WPSR 0x00E8 /* Write Protection Status Register */
52 #define QSPI_VERSION 0x00FC /* Version Register */
54 /* Bitfields in QSPI_CR (Control Register) */
55 #define QSPI_CR_QSPIEN BIT(0)
56 #define QSPI_CR_QSPIDIS BIT(1)
57 #define QSPI_CR_SWRST BIT(7)
58 #define QSPI_CR_LASTXFER BIT(24)
60 /* Bitfields in QSPI_MR (Mode Register) */
61 #define QSPI_MR_SMM BIT(0)
62 #define QSPI_MR_LLB BIT(1)
63 #define QSPI_MR_WDRBT BIT(2)
64 #define QSPI_MR_SMRM BIT(3)
65 #define QSPI_MR_CSMODE_MASK GENMASK(5, 4)
66 #define QSPI_MR_CSMODE_NOT_RELOADED (0 << 4)
67 #define QSPI_MR_CSMODE_LASTXFER (1 << 4)
68 #define QSPI_MR_CSMODE_SYSTEMATICALLY (2 << 4)
69 #define QSPI_MR_NBBITS_MASK GENMASK(11, 8)
70 #define QSPI_MR_NBBITS(n) ((((n) - 8) << 8) & QSPI_MR_NBBITS_MASK)
71 #define QSPI_MR_DLYBCT_MASK GENMASK(23, 16)
72 #define QSPI_MR_DLYBCT(n) (((n) << 16) & QSPI_MR_DLYBCT_MASK)
73 #define QSPI_MR_DLYCS_MASK GENMASK(31, 24)
74 #define QSPI_MR_DLYCS(n) (((n) << 24) & QSPI_MR_DLYCS_MASK)
76 /* Bitfields in QSPI_SR/QSPI_IER/QSPI_IDR/QSPI_IMR */
77 #define QSPI_SR_RDRF BIT(0)
78 #define QSPI_SR_TDRE BIT(1)
79 #define QSPI_SR_TXEMPTY BIT(2)
80 #define QSPI_SR_OVRES BIT(3)
81 #define QSPI_SR_CSR BIT(8)
82 #define QSPI_SR_CSS BIT(9)
83 #define QSPI_SR_INSTRE BIT(10)
84 #define QSPI_SR_QSPIENS BIT(24)
86 #define QSPI_SR_CMD_COMPLETED (QSPI_SR_INSTRE | QSPI_SR_CSR)
88 /* Bitfields in QSPI_SCR (Serial Clock Register) */
89 #define QSPI_SCR_CPOL BIT(0)
90 #define QSPI_SCR_CPHA BIT(1)
91 #define QSPI_SCR_SCBR_MASK GENMASK(15, 8)
92 #define QSPI_SCR_SCBR(n) (((n) << 8) & QSPI_SCR_SCBR_MASK)
93 #define QSPI_SCR_DLYBS_MASK GENMASK(23, 16)
94 #define QSPI_SCR_DLYBS(n) (((n) << 16) & QSPI_SCR_DLYBS_MASK)
96 /* Bitfields in QSPI_ICR (Read/Write Instruction Code Register) */
97 #define QSPI_ICR_INST_MASK GENMASK(7, 0)
98 #define QSPI_ICR_INST(inst) (((inst) << 0) & QSPI_ICR_INST_MASK)
99 #define QSPI_ICR_OPT_MASK GENMASK(23, 16)
100 #define QSPI_ICR_OPT(opt) (((opt) << 16) & QSPI_ICR_OPT_MASK)
102 /* Bitfields in QSPI_IFR (Instruction Frame Register) */
103 #define QSPI_IFR_WIDTH_MASK GENMASK(2, 0)
104 #define QSPI_IFR_WIDTH_SINGLE_BIT_SPI (0 << 0)
105 #define QSPI_IFR_WIDTH_DUAL_OUTPUT (1 << 0)
106 #define QSPI_IFR_WIDTH_QUAD_OUTPUT (2 << 0)
107 #define QSPI_IFR_WIDTH_DUAL_IO (3 << 0)
108 #define QSPI_IFR_WIDTH_QUAD_IO (4 << 0)
109 #define QSPI_IFR_WIDTH_DUAL_CMD (5 << 0)
110 #define QSPI_IFR_WIDTH_QUAD_CMD (6 << 0)
111 #define QSPI_IFR_INSTEN BIT(4)
112 #define QSPI_IFR_ADDREN BIT(5)
113 #define QSPI_IFR_OPTEN BIT(6)
114 #define QSPI_IFR_DATAEN BIT(7)
115 #define QSPI_IFR_OPTL_MASK GENMASK(9, 8)
116 #define QSPI_IFR_OPTL_1BIT (0 << 8)
117 #define QSPI_IFR_OPTL_2BIT (1 << 8)
118 #define QSPI_IFR_OPTL_4BIT (2 << 8)
119 #define QSPI_IFR_OPTL_8BIT (3 << 8)
120 #define QSPI_IFR_ADDRL BIT(10)
121 #define QSPI_IFR_TFRTYP_MEM BIT(12)
122 #define QSPI_IFR_SAMA5D2_WRITE_TRSFR BIT(13)
123 #define QSPI_IFR_CRM BIT(14)
124 #define QSPI_IFR_NBDUM_MASK GENMASK(20, 16)
125 #define QSPI_IFR_NBDUM(n) (((n) << 16) & QSPI_IFR_NBDUM_MASK)
126 #define QSPI_IFR_APBTFRTYP_READ BIT(24) /* Defined in SAM9X60 */
128 /* Bitfields in QSPI_SMR (Scrambling Mode Register) */
129 #define QSPI_SMR_SCREN BIT(0)
130 #define QSPI_SMR_RVDIS BIT(1)
132 /* Bitfields in QSPI_WPMR (Write Protection Mode Register) */
133 #define QSPI_WPMR_WPEN BIT(0)
134 #define QSPI_WPMR_WPKEY_MASK GENMASK(31, 8)
135 #define QSPI_WPMR_WPKEY(wpkey) (((wpkey) << 8) & QSPI_WPMR_WPKEY_MASK)
137 /* Bitfields in QSPI_WPSR (Write Protection Status Register) */
138 #define QSPI_WPSR_WPVS BIT(0)
139 #define QSPI_WPSR_WPVSRC_MASK GENMASK(15, 8)
140 #define QSPI_WPSR_WPVSRC(src) (((src) << 8) & QSPI_WPSR_WPVSRC)
142 struct atmel_qspi_caps {
150 resource_size_t mmap_size;
151 const struct atmel_qspi_caps *caps;
157 struct atmel_qspi_mode {
164 static const struct atmel_qspi_mode atmel_qspi_modes[] = {
165 { 1, 1, 1, QSPI_IFR_WIDTH_SINGLE_BIT_SPI },
166 { 1, 1, 2, QSPI_IFR_WIDTH_DUAL_OUTPUT },
167 { 1, 1, 4, QSPI_IFR_WIDTH_QUAD_OUTPUT },
168 { 1, 2, 2, QSPI_IFR_WIDTH_DUAL_IO },
169 { 1, 4, 4, QSPI_IFR_WIDTH_QUAD_IO },
170 { 2, 2, 2, QSPI_IFR_WIDTH_DUAL_CMD },
171 { 4, 4, 4, QSPI_IFR_WIDTH_QUAD_CMD },
175 static const char *atmel_qspi_reg_name(u32 offset, char *tmp, size_t sz)
215 snprintf(tmp, sz, "0x%02x", offset);
221 #endif /* VERBOSE_DEBUG */
223 static u32 atmel_qspi_read(struct atmel_qspi *aq, u32 offset)
225 u32 value = readl(aq->regs + offset);
230 dev_vdbg(aq->dev, "read 0x%08x from %s\n", value,
231 atmel_qspi_reg_name(offset, tmp, sizeof(tmp)));
232 #endif /* VERBOSE_DEBUG */
237 static void atmel_qspi_write(u32 value, struct atmel_qspi *aq, u32 offset)
242 dev_vdbg(aq->dev, "write 0x%08x into %s\n", value,
243 atmel_qspi_reg_name(offset, tmp, sizeof(tmp)));
244 #endif /* VERBOSE_DEBUG */
246 writel(value, aq->regs + offset);
249 static inline bool atmel_qspi_is_compatible(const struct spi_mem_op *op,
250 const struct atmel_qspi_mode *mode)
252 if (op->cmd.buswidth != mode->cmd_buswidth)
255 if (op->addr.nbytes && op->addr.buswidth != mode->addr_buswidth)
258 if (op->data.nbytes && op->data.buswidth != mode->data_buswidth)
264 static int atmel_qspi_find_mode(const struct spi_mem_op *op)
268 for (i = 0; i < ARRAY_SIZE(atmel_qspi_modes); i++)
269 if (atmel_qspi_is_compatible(op, &atmel_qspi_modes[i]))
275 static bool atmel_qspi_supports_op(struct spi_slave *slave,
276 const struct spi_mem_op *op)
278 if (atmel_qspi_find_mode(op) < 0)
281 /* special case not supported by hardware */
282 if (op->addr.nbytes == 2 && op->cmd.buswidth != op->addr.buswidth &&
283 op->dummy.nbytes == 0)
289 static int atmel_qspi_set_cfg(struct atmel_qspi *aq,
290 const struct spi_mem_op *op, u32 *offset)
293 u32 dummy_cycles = 0;
297 icr = QSPI_ICR_INST(op->cmd.opcode);
298 ifr = QSPI_IFR_INSTEN;
300 mode = atmel_qspi_find_mode(op);
303 ifr |= atmel_qspi_modes[mode].config;
305 if (op->dummy.buswidth && op->dummy.nbytes)
306 dummy_cycles = op->dummy.nbytes * 8 / op->dummy.buswidth;
309 * The controller allows 24 and 32-bit addressing while NAND-flash
310 * requires 16-bit long. Handling 8-bit long addresses is done using
311 * the option field. For the 16-bit addresses, the workaround depends
312 * of the number of requested dummy bits. If there are 8 or more dummy
313 * cycles, the address is shifted and sent with the first dummy byte.
314 * Otherwise opcode is disabled and the first byte of the address
315 * contains the command opcode (works only if the opcode and address
316 * use the same buswidth). The limitation is when the 16-bit address is
317 * used without enough dummy cycles and the opcode is using a different
318 * buswidth than the address.
320 if (op->addr.buswidth) {
321 switch (op->addr.nbytes) {
325 ifr |= QSPI_IFR_OPTEN | QSPI_IFR_OPTL_8BIT;
326 icr |= QSPI_ICR_OPT(op->addr.val & 0xff);
329 if (dummy_cycles < 8 / op->addr.buswidth) {
330 ifr &= ~QSPI_IFR_INSTEN;
331 ifr |= QSPI_IFR_ADDREN;
332 iar = (op->cmd.opcode << 16) |
333 (op->addr.val & 0xffff);
335 ifr |= QSPI_IFR_ADDREN;
336 iar = (op->addr.val << 8) & 0xffffff;
337 dummy_cycles -= 8 / op->addr.buswidth;
341 ifr |= QSPI_IFR_ADDREN;
342 iar = op->addr.val & 0xffffff;
345 ifr |= QSPI_IFR_ADDREN | QSPI_IFR_ADDRL;
346 iar = op->addr.val & 0x7ffffff;
353 /* offset of the data access in the QSPI memory space */
356 /* Set number of dummy cycles */
358 ifr |= QSPI_IFR_NBDUM(dummy_cycles);
360 /* Set data enable */
362 ifr |= QSPI_IFR_DATAEN;
365 * If the QSPI controller is set in regular SPI mode, set it in
366 * Serial Memory Mode (SMM).
368 if (aq->mr != QSPI_MR_SMM) {
369 atmel_qspi_write(QSPI_MR_SMM, aq, QSPI_MR);
370 aq->mr = QSPI_MR_SMM;
373 /* Clear pending interrupts */
374 (void)atmel_qspi_read(aq, QSPI_SR);
376 if (aq->caps->has_ricr) {
377 if (!op->addr.nbytes && op->data.dir == SPI_MEM_DATA_IN)
378 ifr |= QSPI_IFR_APBTFRTYP_READ;
380 /* Set QSPI Instruction Frame registers */
381 atmel_qspi_write(iar, aq, QSPI_IAR);
382 if (op->data.dir == SPI_MEM_DATA_IN)
383 atmel_qspi_write(icr, aq, QSPI_RICR);
385 atmel_qspi_write(icr, aq, QSPI_WICR);
386 atmel_qspi_write(ifr, aq, QSPI_IFR);
388 if (op->data.dir == SPI_MEM_DATA_OUT)
389 ifr |= QSPI_IFR_SAMA5D2_WRITE_TRSFR;
391 /* Set QSPI Instruction Frame registers */
392 atmel_qspi_write(iar, aq, QSPI_IAR);
393 atmel_qspi_write(icr, aq, QSPI_ICR);
394 atmel_qspi_write(ifr, aq, QSPI_IFR);
400 static int atmel_qspi_exec_op(struct spi_slave *slave,
401 const struct spi_mem_op *op)
403 struct atmel_qspi *aq = dev_get_priv(slave->dev->parent);
408 * Check if the address exceeds the MMIO window size. An improvement
409 * would be to add support for regular SPI mode and fall back to it
410 * when the flash memories overrun the controller's memory space.
412 if (op->addr.val + op->data.nbytes > aq->mmap_size)
415 err = atmel_qspi_set_cfg(aq, op, &offset);
419 /* Skip to the final steps if there is no data */
420 if (op->data.nbytes) {
421 /* Dummy read of QSPI_IFR to synchronize APB and AHB accesses */
422 (void)atmel_qspi_read(aq, QSPI_IFR);
424 /* Send/Receive data */
425 if (op->data.dir == SPI_MEM_DATA_IN)
426 memcpy_fromio(op->data.buf.in, aq->mem + offset,
429 memcpy_toio(aq->mem + offset, op->data.buf.out,
432 /* Release the chip-select */
433 atmel_qspi_write(QSPI_CR_LASTXFER, aq, QSPI_CR);
436 /* Poll INSTruction End and Chip Select Rise flags. */
437 imr = QSPI_SR_INSTRE | QSPI_SR_CSR;
438 return readl_poll_timeout(aq->regs + QSPI_SR, sr, (sr & imr) == imr,
442 static int atmel_qspi_set_speed(struct udevice *bus, uint hz)
444 struct atmel_qspi *aq = dev_get_priv(bus);
445 u32 scr, scbr, mask, new_value;
447 /* Compute the QSPI baudrate */
448 scbr = DIV_ROUND_UP(aq->bus_clk_rate, hz);
452 new_value = QSPI_SCR_SCBR(scbr);
453 mask = QSPI_SCR_SCBR_MASK;
455 scr = atmel_qspi_read(aq, QSPI_SCR);
456 if ((scr & mask) == new_value)
459 scr = (scr & ~mask) | new_value;
460 atmel_qspi_write(scr, aq, QSPI_SCR);
465 static int atmel_qspi_set_mode(struct udevice *bus, uint mode)
467 struct atmel_qspi *aq = dev_get_priv(bus);
468 u32 scr, mask, new_value = 0;
471 new_value = QSPI_SCR_CPOL;
473 new_value = QSPI_SCR_CPHA;
475 mask = QSPI_SCR_CPOL | QSPI_SCR_CPHA;
477 scr = atmel_qspi_read(aq, QSPI_SCR);
478 if ((scr & mask) == new_value)
481 scr = (scr & ~mask) | new_value;
482 atmel_qspi_write(scr, aq, QSPI_SCR);
487 static int atmel_qspi_enable_clk(struct udevice *dev)
489 struct atmel_qspi *aq = dev_get_priv(dev);
490 struct clk pclk, qspick;
493 ret = clk_get_by_name(dev, "pclk", &pclk);
495 ret = clk_get_by_index(dev, 0, &pclk);
498 dev_err(dev, "Missing QSPI peripheral clock\n");
502 ret = clk_enable(&pclk);
504 dev_err(dev, "Failed to enable QSPI peripheral clock\n");
508 if (aq->caps->has_qspick) {
509 /* Get the QSPI system clock */
510 ret = clk_get_by_name(dev, "qspick", &qspick);
512 dev_err(dev, "Missing QSPI peripheral clock\n");
516 ret = clk_enable(&qspick);
518 dev_err(dev, "Failed to enable QSPI system clock\n");
522 aq->bus_clk_rate = clk_get_rate(&pclk);
523 if (!aq->bus_clk_rate)
532 static void atmel_qspi_init(struct atmel_qspi *aq)
534 /* Reset the QSPI controller */
535 atmel_qspi_write(QSPI_CR_SWRST, aq, QSPI_CR);
537 /* Set the QSPI controller by default in Serial Memory Mode */
538 atmel_qspi_write(QSPI_MR_SMM, aq, QSPI_MR);
539 aq->mr = QSPI_MR_SMM;
541 /* Enable the QSPI controller */
542 atmel_qspi_write(QSPI_CR_QSPIEN, aq, QSPI_CR);
545 static int atmel_qspi_probe(struct udevice *dev)
547 struct atmel_qspi *aq = dev_get_priv(dev);
551 aq->caps = (struct atmel_qspi_caps *)dev_get_driver_data(dev);
553 dev_err(dev, "Could not retrieve QSPI caps\n");
557 /* Map the registers */
558 ret = dev_read_resource_byname(dev, "qspi_base", &res);
560 dev_err(dev, "missing registers\n");
564 aq->regs = devm_ioremap(dev, res.start, resource_size(&res));
565 if (IS_ERR(aq->regs))
566 return PTR_ERR(aq->regs);
568 /* Map the AHB memory */
569 ret = dev_read_resource_byname(dev, "qspi_mmap", &res);
571 dev_err(dev, "missing AHB memory\n");
575 aq->mem = devm_ioremap(dev, res.start, resource_size(&res));
577 return PTR_ERR(aq->mem);
579 aq->mmap_size = resource_size(&res);
581 ret = atmel_qspi_enable_clk(dev);
592 static const struct spi_controller_mem_ops atmel_qspi_mem_ops = {
593 .supports_op = atmel_qspi_supports_op,
594 .exec_op = atmel_qspi_exec_op,
597 static const struct dm_spi_ops atmel_qspi_ops = {
598 .set_speed = atmel_qspi_set_speed,
599 .set_mode = atmel_qspi_set_mode,
600 .mem_ops = &atmel_qspi_mem_ops,
603 static const struct atmel_qspi_caps atmel_sama5d2_qspi_caps = {};
605 static const struct atmel_qspi_caps atmel_sam9x60_qspi_caps = {
610 static const struct udevice_id atmel_qspi_ids[] = {
612 .compatible = "atmel,sama5d2-qspi",
613 .data = (ulong)&atmel_sama5d2_qspi_caps,
616 .compatible = "microchip,sam9x60-qspi",
617 .data = (ulong)&atmel_sam9x60_qspi_caps,
622 U_BOOT_DRIVER(atmel_qspi) = {
623 .name = "atmel_qspi",
625 .of_match = atmel_qspi_ids,
626 .ops = &atmel_qspi_ops,
627 .priv_auto_alloc_size = sizeof(struct atmel_qspi),
628 .probe = atmel_qspi_probe,