blob: a2faac5a505569c7e6f0e1f23c87b80021b2a363 [file] [log] [blame]
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001// SPDX-License-Identifier: GPL-2.0
2/*
3 * Driver for Atmel QSPI Controller
4 *
5 * Copyright (C) 2015 Atmel Corporation
6 * Copyright (C) 2018 Cryptera A/S
7 *
8 * Author: Cyrille Pitchen <cyrille.pitchen@atmel.com>
9 * Author: Piotr Bugalski <bugalski.piotr@gmail.com>
10 */
11
Simon Glass9bc15642020-02-03 07:36:16 -070012#include <malloc.h>
Alexander Dahl26ca20a2025-01-23 13:12:14 +010013#include <asm/gpio.h>
Tudor Ambarus88151bb2019-06-18 08:51:50 +000014#include <asm/io.h>
15#include <clk.h>
Tudor Ambarus88151bb2019-06-18 08:51:50 +000016#include <dm.h>
17#include <errno.h>
18#include <fdtdec.h>
Alexander Dahl26ca20a2025-01-23 13:12:14 +010019#include <log.h>
Simon Glass9bc15642020-02-03 07:36:16 -070020#include <dm/device_compat.h>
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +020021#include <linux/bitfield.h>
Simon Glass4dcacfc2020-05-10 11:40:13 -060022#include <linux/bitops.h>
Simon Glassd66c5f72020-02-03 07:36:15 -070023#include <linux/err.h>
Tudor Ambarus88151bb2019-06-18 08:51:50 +000024#include <linux/io.h>
25#include <linux/iopoll.h>
26#include <linux/ioport.h>
27#include <mach/clk.h>
28#include <spi.h>
29#include <spi-mem.h>
30
31/* QSPI register offsets */
32#define QSPI_CR 0x0000 /* Control Register */
33#define QSPI_MR 0x0004 /* Mode Register */
34#define QSPI_RD 0x0008 /* Receive Data Register */
35#define QSPI_TD 0x000c /* Transmit Data Register */
36#define QSPI_SR 0x0010 /* Status Register */
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +020037#define QSPI_SR2 0x0024 /* SAMA7G5 Status Register */
Tudor Ambarus88151bb2019-06-18 08:51:50 +000038#define QSPI_IER 0x0014 /* Interrupt Enable Register */
39#define QSPI_IDR 0x0018 /* Interrupt Disable Register */
40#define QSPI_IMR 0x001c /* Interrupt Mask Register */
41#define QSPI_SCR 0x0020 /* Serial Clock Register */
42
43#define QSPI_IAR 0x0030 /* Instruction Address Register */
44#define QSPI_ICR 0x0034 /* Instruction Code Register */
45#define QSPI_WICR 0x0034 /* Write Instruction Code Register */
46#define QSPI_IFR 0x0038 /* Instruction Frame Register */
47#define QSPI_RICR 0x003C /* Read Instruction Code Register */
48
49#define QSPI_SMR 0x0040 /* Scrambling Mode Register */
50#define QSPI_SKR 0x0044 /* Scrambling Key Register */
51
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +020052#define QSPI_REFRESH 0x0050 /* Refresh Register */
53#define QSPI_WRACNT 0x0054 /* Write Access Counter Register */
54#define QSPI_DLLCFG 0x0058 /* DLL Configuration Register */
55#define QSPI_PCALCFG 0x005C /* Pad Calibration Configuration Register */
56#define QSPI_PCALBP 0x0060 /* Pad Calibration Bypass Register */
57#define QSPI_TOUT 0x0064 /* Timeout Register */
58
Tudor Ambarus88151bb2019-06-18 08:51:50 +000059#define QSPI_WPMR 0x00E4 /* Write Protection Mode Register */
60#define QSPI_WPSR 0x00E8 /* Write Protection Status Register */
61
62#define QSPI_VERSION 0x00FC /* Version Register */
63
64/* Bitfields in QSPI_CR (Control Register) */
65#define QSPI_CR_QSPIEN BIT(0)
66#define QSPI_CR_QSPIDIS BIT(1)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +020067#define QSPI_CR_DLLON BIT(2)
68#define QSPI_CR_DLLOFF BIT(3)
69#define QSPI_CR_STPCAL BIT(4)
70#define QSPI_CR_SRFRSH BIT(5)
Tudor Ambarus88151bb2019-06-18 08:51:50 +000071#define QSPI_CR_SWRST BIT(7)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +020072#define QSPI_CR_UPDCFG BIT(8)
73#define QSPI_CR_STTFR BIT(9)
74#define QSPI_CR_RTOUT BIT(10)
Tudor Ambarus88151bb2019-06-18 08:51:50 +000075#define QSPI_CR_LASTXFER BIT(24)
76
77/* Bitfields in QSPI_MR (Mode Register) */
78#define QSPI_MR_SMM BIT(0)
79#define QSPI_MR_LLB BIT(1)
80#define QSPI_MR_WDRBT BIT(2)
81#define QSPI_MR_SMRM BIT(3)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +020082#define QSPI_MR_DQSDLYEN BIT(3)
83
Tudor Ambarus88151bb2019-06-18 08:51:50 +000084#define QSPI_MR_CSMODE_MASK GENMASK(5, 4)
85#define QSPI_MR_CSMODE_NOT_RELOADED (0 << 4)
86#define QSPI_MR_CSMODE_LASTXFER (1 << 4)
87#define QSPI_MR_CSMODE_SYSTEMATICALLY (2 << 4)
88#define QSPI_MR_NBBITS_MASK GENMASK(11, 8)
89#define QSPI_MR_NBBITS(n) ((((n) - 8) << 8) & QSPI_MR_NBBITS_MASK)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +020090#define QSPI_MR_OENSD BIT(15)
Tudor Ambarus88151bb2019-06-18 08:51:50 +000091#define QSPI_MR_DLYBCT_MASK GENMASK(23, 16)
92#define QSPI_MR_DLYBCT(n) (((n) << 16) & QSPI_MR_DLYBCT_MASK)
93#define QSPI_MR_DLYCS_MASK GENMASK(31, 24)
94#define QSPI_MR_DLYCS(n) (((n) << 24) & QSPI_MR_DLYCS_MASK)
95
96/* Bitfields in QSPI_SR/QSPI_IER/QSPI_IDR/QSPI_IMR */
97#define QSPI_SR_RDRF BIT(0)
98#define QSPI_SR_TDRE BIT(1)
99#define QSPI_SR_TXEMPTY BIT(2)
100#define QSPI_SR_OVRES BIT(3)
101#define QSPI_SR_CSR BIT(8)
102#define QSPI_SR_CSS BIT(9)
103#define QSPI_SR_INSTRE BIT(10)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200104#define QSPI_SR_LWRA BIT(11)
105#define QSPI_SR_QITF BIT(12)
106#define QSPI_SR_QITR BIT(13)
107#define QSPI_SR_CSFA BIT(14)
108#define QSPI_SR_CSRA BIT(15)
109#define QSPI_SR_RFRSHD BIT(16)
110#define QSPI_SR_TOUT BIT(17)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000111#define QSPI_SR_QSPIENS BIT(24)
112
113#define QSPI_SR_CMD_COMPLETED (QSPI_SR_INSTRE | QSPI_SR_CSR)
114
115/* Bitfields in QSPI_SCR (Serial Clock Register) */
116#define QSPI_SCR_CPOL BIT(0)
117#define QSPI_SCR_CPHA BIT(1)
118#define QSPI_SCR_SCBR_MASK GENMASK(15, 8)
119#define QSPI_SCR_SCBR(n) (((n) << 8) & QSPI_SCR_SCBR_MASK)
120#define QSPI_SCR_DLYBS_MASK GENMASK(23, 16)
121#define QSPI_SCR_DLYBS(n) (((n) << 16) & QSPI_SCR_DLYBS_MASK)
122
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200123/* Bitfields in QSPI_SR2 (SAMA7G5 Status Register) */
124#define QSPI_SR2_SYNCBSY BIT(0)
125#define QSPI_SR2_QSPIENS BIT(1)
126#define QSPI_SR2_CSS BIT(2)
127#define QSPI_SR2_RBUSY BIT(3)
128#define QSPI_SR2_HIDLE BIT(4)
129#define QSPI_SR2_DLOCK BIT(5)
130#define QSPI_SR2_CALBSY BIT(6)
131
132/* Bitfields in QSPI_IAR (Instruction Address Register) */
133#define QSPI_IAR_ADDR GENMASK(31, 0)
134
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000135/* Bitfields in QSPI_ICR (Read/Write Instruction Code Register) */
136#define QSPI_ICR_INST_MASK GENMASK(7, 0)
137#define QSPI_ICR_INST(inst) (((inst) << 0) & QSPI_ICR_INST_MASK)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200138#define QSPI_ICR_INST_MASK_SAMA7G5 GENMASK(15, 0)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000139#define QSPI_ICR_OPT_MASK GENMASK(23, 16)
140#define QSPI_ICR_OPT(opt) (((opt) << 16) & QSPI_ICR_OPT_MASK)
141
142/* Bitfields in QSPI_IFR (Instruction Frame Register) */
143#define QSPI_IFR_WIDTH_MASK GENMASK(2, 0)
144#define QSPI_IFR_WIDTH_SINGLE_BIT_SPI (0 << 0)
145#define QSPI_IFR_WIDTH_DUAL_OUTPUT (1 << 0)
146#define QSPI_IFR_WIDTH_QUAD_OUTPUT (2 << 0)
147#define QSPI_IFR_WIDTH_DUAL_IO (3 << 0)
148#define QSPI_IFR_WIDTH_QUAD_IO (4 << 0)
149#define QSPI_IFR_WIDTH_DUAL_CMD (5 << 0)
150#define QSPI_IFR_WIDTH_QUAD_CMD (6 << 0)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200151#define QSPI_IFR_WIDTH_OCT_OUTPUT (7 << 0)
152#define QSPI_IFR_WIDTH_OCT_IO (8 << 0)
153#define QSPI_IFR_WIDTH_OCT_CMD (9 << 0)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000154#define QSPI_IFR_INSTEN BIT(4)
155#define QSPI_IFR_ADDREN BIT(5)
156#define QSPI_IFR_OPTEN BIT(6)
157#define QSPI_IFR_DATAEN BIT(7)
158#define QSPI_IFR_OPTL_MASK GENMASK(9, 8)
159#define QSPI_IFR_OPTL_1BIT (0 << 8)
160#define QSPI_IFR_OPTL_2BIT (1 << 8)
161#define QSPI_IFR_OPTL_4BIT (2 << 8)
162#define QSPI_IFR_OPTL_8BIT (3 << 8)
163#define QSPI_IFR_ADDRL BIT(10)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200164#define QSPI_IFR_ADDRL_SAMA7G5 GENMASK(11, 10)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000165#define QSPI_IFR_TFRTYP_MEM BIT(12)
166#define QSPI_IFR_SAMA5D2_WRITE_TRSFR BIT(13)
167#define QSPI_IFR_CRM BIT(14)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200168#define QSPI_IFR_DDREN BIT(15)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000169#define QSPI_IFR_NBDUM_MASK GENMASK(20, 16)
170#define QSPI_IFR_NBDUM(n) (((n) << 16) & QSPI_IFR_NBDUM_MASK)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200171#define QSPI_IFR_END BIT(22)
172#define QSPI_IFR_SMRM BIT(23)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000173#define QSPI_IFR_APBTFRTYP_READ BIT(24) /* Defined in SAM9X60 */
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200174#define QSPI_IFR_DQSEN BIT(25)
175#define QSPI_IFR_DDRCMDEN BIT(26)
176#define QSPI_IFR_HFWBEN BIT(27)
177#define QSPI_IFR_PROTTYP GENMASK(29, 28)
178#define QSPI_IFR_PROTTYP_STD_SPI 0
179#define QSPI_IFR_PROTTYP_TWIN_QUAD 1
180#define QSPI_IFR_PROTTYP_OCTAFLASH 2
181#define QSPI_IFR_PROTTYP_HYPERFLASH 3
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000182
183/* Bitfields in QSPI_SMR (Scrambling Mode Register) */
184#define QSPI_SMR_SCREN BIT(0)
185#define QSPI_SMR_RVDIS BIT(1)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200186#define QSPI_SMR_SCRKL BIT(2)
187
188/* Bitfields in QSPI_REFRESH (Refresh Register) */
189#define QSPI_REFRESH_DELAY_COUNTER GENMASK(31, 0)
190
191/* Bitfields in QSPI_WRACNT (Write Access Counter Register) */
192#define QSPI_WRACNT_NBWRA GENMASK(31, 0)
193
194/* Bitfields in QSPI_DLLCFG (DLL Configuration Register) */
195#define QSPI_DLLCFG_RANGE BIT(0)
196
197/* Bitfields in QSPI_PCALCFG (DLL Pad Calibration Configuration Register) */
198#define QSPI_PCALCFG_AAON BIT(0)
199#define QSPI_PCALCFG_DAPCAL BIT(1)
200#define QSPI_PCALCFG_DIFFPM BIT(2)
201#define QSPI_PCALCFG_CLKDIV GENMASK(6, 4)
202#define QSPI_PCALCFG_CALCNT GENMASK(16, 8)
203#define QSPI_PCALCFG_CALP GENMASK(27, 24)
204#define QSPI_PCALCFG_CALN GENMASK(31, 28)
205
206/* Bitfields in QSPI_PCALBP (DLL Pad Calibration Bypass Register) */
207#define QSPI_PCALBP_BPEN BIT(0)
208#define QSPI_PCALBP_CALPBP GENMASK(11, 8)
209#define QSPI_PCALBP_CALNBP GENMASK(19, 16)
210
211/* Bitfields in QSPI_TOUT (Timeout Register) */
212#define QSPI_TOUT_TCNTM GENMASK(15, 0)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000213
214/* Bitfields in QSPI_WPMR (Write Protection Mode Register) */
215#define QSPI_WPMR_WPEN BIT(0)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200216#define QSPI_WPMR_WPITEN BIT(1)
217#define QSPI_WPMR_WPCREN BIT(2)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000218#define QSPI_WPMR_WPKEY_MASK GENMASK(31, 8)
219#define QSPI_WPMR_WPKEY(wpkey) (((wpkey) << 8) & QSPI_WPMR_WPKEY_MASK)
220
221/* Bitfields in QSPI_WPSR (Write Protection Status Register) */
222#define QSPI_WPSR_WPVS BIT(0)
223#define QSPI_WPSR_WPVSRC_MASK GENMASK(15, 8)
224#define QSPI_WPSR_WPVSRC(src) (((src) << 8) & QSPI_WPSR_WPVSRC)
225
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200226#define ATMEL_QSPI_TIMEOUT 1000000 /* us */
227#define ATMEL_QSPI_SYNC_TIMEOUT 300000 /* us */
228#define QSPI_DLLCFG_THRESHOLD_FREQ 90000000U
229#define QSPI_TOUT_MAX 0xffff
230
231/**
232 * struct atmel_qspi_pcal - Pad Calibration Clock Division
233 * @pclk_rate: peripheral clock rate.
234 * @pclkdiv: calibration clock division. The clock applied to the calibration
235 * cell is divided by pclkdiv + 1.
236 */
237struct atmel_qspi_pcal {
238 u32 pclk_rate;
239 u8 pclk_div;
240};
241
242#define ATMEL_QSPI_PCAL_ARRAY_SIZE 8
243static const struct atmel_qspi_pcal pcal[ATMEL_QSPI_PCAL_ARRAY_SIZE] = {
244 {25000000, 0},
245 {50000000, 1},
246 {75000000, 2},
247 {100000000, 3},
248 {125000000, 4},
249 {150000000, 5},
250 {175000000, 6},
251 {200000000, 7},
252};
253
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000254struct atmel_qspi_caps {
255 bool has_qspick;
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200256 bool has_gclk;
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000257 bool has_ricr;
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200258 bool octal;
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000259};
260
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200261struct atmel_qspi_priv_ops;
262
Alexander Dahl26ca20a2025-01-23 13:12:14 +0100263#define MAX_CS_COUNT 2
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000264struct atmel_qspi {
265 void __iomem *regs;
266 void __iomem *mem;
Tudor Ambarus678b8932020-03-20 09:37:59 +0000267 resource_size_t mmap_size;
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000268 const struct atmel_qspi_caps *caps;
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200269 const struct atmel_qspi_priv_ops *ops;
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000270 struct udevice *dev;
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000271 ulong bus_clk_rate;
272 u32 mr;
Alexander Dahl26ca20a2025-01-23 13:12:14 +0100273 struct gpio_desc cs_gpios[MAX_CS_COUNT];
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000274};
275
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200276struct atmel_qspi_priv_ops {
277 int (*set_cfg)(struct atmel_qspi *aq, const struct spi_mem_op *op,
278 u32 *offset);
279 int (*transfer)(struct atmel_qspi *aq, const struct spi_mem_op *op,
280 u32 offset);
281};
282
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000283struct atmel_qspi_mode {
284 u8 cmd_buswidth;
285 u8 addr_buswidth;
286 u8 data_buswidth;
287 u32 config;
288};
289
290static const struct atmel_qspi_mode atmel_qspi_modes[] = {
291 { 1, 1, 1, QSPI_IFR_WIDTH_SINGLE_BIT_SPI },
292 { 1, 1, 2, QSPI_IFR_WIDTH_DUAL_OUTPUT },
293 { 1, 1, 4, QSPI_IFR_WIDTH_QUAD_OUTPUT },
294 { 1, 2, 2, QSPI_IFR_WIDTH_DUAL_IO },
295 { 1, 4, 4, QSPI_IFR_WIDTH_QUAD_IO },
296 { 2, 2, 2, QSPI_IFR_WIDTH_DUAL_CMD },
297 { 4, 4, 4, QSPI_IFR_WIDTH_QUAD_CMD },
298};
299
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200300static const struct atmel_qspi_mode atmel_qspi_sama7g5_modes[] = {
301 { 1, 1, 1, QSPI_IFR_WIDTH_SINGLE_BIT_SPI },
302 { 1, 1, 2, QSPI_IFR_WIDTH_DUAL_OUTPUT },
303 { 1, 1, 4, QSPI_IFR_WIDTH_QUAD_OUTPUT },
304 { 1, 2, 2, QSPI_IFR_WIDTH_DUAL_IO },
305 { 1, 4, 4, QSPI_IFR_WIDTH_QUAD_IO },
306 { 2, 2, 2, QSPI_IFR_WIDTH_DUAL_CMD },
307 { 4, 4, 4, QSPI_IFR_WIDTH_QUAD_CMD },
308 { 1, 1, 8, QSPI_IFR_WIDTH_OCT_OUTPUT },
309 { 1, 8, 8, QSPI_IFR_WIDTH_OCT_IO },
310 { 8, 8, 8, QSPI_IFR_WIDTH_OCT_CMD },
311};
312
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000313#ifdef VERBOSE_DEBUG
314static const char *atmel_qspi_reg_name(u32 offset, char *tmp, size_t sz)
315{
316 switch (offset) {
317 case QSPI_CR:
318 return "CR";
319 case QSPI_MR:
320 return "MR";
321 case QSPI_RD:
Tudor Ambarus7e022332021-11-03 18:45:42 +0200322 return "RD";
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000323 case QSPI_TD:
324 return "TD";
325 case QSPI_SR:
326 return "SR";
327 case QSPI_IER:
328 return "IER";
329 case QSPI_IDR:
330 return "IDR";
331 case QSPI_IMR:
332 return "IMR";
333 case QSPI_SCR:
334 return "SCR";
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200335 case QSPI_SR2:
336 return "SR2";
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000337 case QSPI_IAR:
338 return "IAR";
339 case QSPI_ICR:
340 return "ICR/WICR";
341 case QSPI_IFR:
342 return "IFR";
343 case QSPI_RICR:
344 return "RICR";
345 case QSPI_SMR:
346 return "SMR";
347 case QSPI_SKR:
348 return "SKR";
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200349 case QSPI_REFRESH:
350 return "REFRESH";
351 case QSPI_WRACNT:
352 return "WRACNT";
353 case QSPI_DLLCFG:
354 return "DLLCFG";
355 case QSPI_PCALCFG:
356 return "PCALCFG";
357 case QSPI_PCALBP:
358 return "PCALBP";
359 case QSPI_TOUT:
360 return "TOUT";
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000361 case QSPI_WPMR:
362 return "WPMR";
363 case QSPI_WPSR:
364 return "WPSR";
365 case QSPI_VERSION:
366 return "VERSION";
367 default:
368 snprintf(tmp, sz, "0x%02x", offset);
369 break;
370 }
371
372 return tmp;
373}
374#endif /* VERBOSE_DEBUG */
375
376static u32 atmel_qspi_read(struct atmel_qspi *aq, u32 offset)
377{
378 u32 value = readl(aq->regs + offset);
379
380#ifdef VERBOSE_DEBUG
381 char tmp[16];
382
383 dev_vdbg(aq->dev, "read 0x%08x from %s\n", value,
384 atmel_qspi_reg_name(offset, tmp, sizeof(tmp)));
385#endif /* VERBOSE_DEBUG */
386
387 return value;
388}
389
390static void atmel_qspi_write(u32 value, struct atmel_qspi *aq, u32 offset)
391{
392#ifdef VERBOSE_DEBUG
393 char tmp[16];
394
395 dev_vdbg(aq->dev, "write 0x%08x into %s\n", value,
396 atmel_qspi_reg_name(offset, tmp, sizeof(tmp)));
397#endif /* VERBOSE_DEBUG */
398
399 writel(value, aq->regs + offset);
400}
401
Alexander Dahlcced8e02025-01-23 13:12:11 +0100402static int atmel_qspi_reg_sync(struct atmel_qspi *aq)
403{
404 u32 val;
405
406 return readl_poll_timeout(aq->regs + QSPI_SR2, val,
407 !(val & QSPI_SR2_SYNCBSY),
408 ATMEL_QSPI_SYNC_TIMEOUT);
409}
410
411static int atmel_qspi_update_config(struct atmel_qspi *aq)
412{
413 int ret;
414
415 ret = atmel_qspi_reg_sync(aq);
416 if (ret)
417 return ret;
418 atmel_qspi_write(QSPI_CR_UPDCFG, aq, QSPI_CR);
419 return atmel_qspi_reg_sync(aq);
420}
421
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000422static inline bool atmel_qspi_is_compatible(const struct spi_mem_op *op,
423 const struct atmel_qspi_mode *mode)
424{
425 if (op->cmd.buswidth != mode->cmd_buswidth)
426 return false;
427
428 if (op->addr.nbytes && op->addr.buswidth != mode->addr_buswidth)
429 return false;
430
431 if (op->data.nbytes && op->data.buswidth != mode->data_buswidth)
432 return false;
433
434 return true;
435}
436
437static int atmel_qspi_find_mode(const struct spi_mem_op *op)
438{
439 u32 i;
440
441 for (i = 0; i < ARRAY_SIZE(atmel_qspi_modes); i++)
442 if (atmel_qspi_is_compatible(op, &atmel_qspi_modes[i]))
443 return i;
444
445 return -ENOTSUPP;
446}
447
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200448static int atmel_qspi_sama7g5_find_mode(const struct spi_mem_op *op)
449{
450 u32 i;
451
452 for (i = 0; i < ARRAY_SIZE(atmel_qspi_sama7g5_modes); i++)
453 if (atmel_qspi_is_compatible(op, &atmel_qspi_sama7g5_modes[i]))
454 return i;
455
456 return -EOPNOTSUPP;
457}
458
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000459static bool atmel_qspi_supports_op(struct spi_slave *slave,
460 const struct spi_mem_op *op)
461{
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200462 struct atmel_qspi *aq = dev_get_priv(slave->dev->parent);
463
Tudor Ambarus938a6c92022-04-08 11:40:26 +0300464 if (!spi_mem_default_supports_op(slave, op))
465 return false;
466
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200467 if (aq->caps->octal) {
468 if (atmel_qspi_sama7g5_find_mode(op) < 0)
469 return false;
470 else
471 return true;
472 }
473
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000474 if (atmel_qspi_find_mode(op) < 0)
475 return false;
476
477 /* special case not supported by hardware */
478 if (op->addr.nbytes == 2 && op->cmd.buswidth != op->addr.buswidth &&
479 op->dummy.nbytes == 0)
480 return false;
481
482 return true;
483}
484
Alexander Dahlcced8e02025-01-23 13:12:11 +0100485/*
Alexander Dahlffc73302025-01-23 13:12:13 +0100486 * Switch QSPI controller between regular SPI mode or Serial Memory Mode (SMM).
Alexander Dahlcced8e02025-01-23 13:12:11 +0100487 */
Alexander Dahlffc73302025-01-23 13:12:13 +0100488static int atmel_qspi_set_serial_memory_mode(struct atmel_qspi *aq,
489 bool enable)
Alexander Dahlcced8e02025-01-23 13:12:11 +0100490{
491 int ret = 0;
492
Alexander Dahlffc73302025-01-23 13:12:13 +0100493 /* only write if designated state differs from current state */
494 if (!!(aq->mr & QSPI_MR_SMM) != enable) {
495 if (enable)
496 aq->mr |= QSPI_MR_SMM;
497 else
498 aq->mr &= ~QSPI_MR_SMM;
Alexander Dahlcced8e02025-01-23 13:12:11 +0100499 atmel_qspi_write(aq->mr, aq, QSPI_MR);
500
501 if (aq->caps->has_gclk)
502 ret = atmel_qspi_update_config(aq);
503 }
504
505 return ret;
506}
507
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000508static int atmel_qspi_set_cfg(struct atmel_qspi *aq,
509 const struct spi_mem_op *op, u32 *offset)
510{
511 u32 iar, icr, ifr;
512 u32 dummy_cycles = 0;
513 int mode;
514
515 iar = 0;
516 icr = QSPI_ICR_INST(op->cmd.opcode);
517 ifr = QSPI_IFR_INSTEN;
518
519 mode = atmel_qspi_find_mode(op);
520 if (mode < 0)
521 return mode;
522 ifr |= atmel_qspi_modes[mode].config;
523
Alexander Dahl82cca202025-01-23 13:12:10 +0100524 if (op->dummy.nbytes)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000525 dummy_cycles = op->dummy.nbytes * 8 / op->dummy.buswidth;
526
527 /*
528 * The controller allows 24 and 32-bit addressing while NAND-flash
529 * requires 16-bit long. Handling 8-bit long addresses is done using
530 * the option field. For the 16-bit addresses, the workaround depends
531 * of the number of requested dummy bits. If there are 8 or more dummy
532 * cycles, the address is shifted and sent with the first dummy byte.
533 * Otherwise opcode is disabled and the first byte of the address
534 * contains the command opcode (works only if the opcode and address
535 * use the same buswidth). The limitation is when the 16-bit address is
536 * used without enough dummy cycles and the opcode is using a different
537 * buswidth than the address.
538 */
539 if (op->addr.buswidth) {
540 switch (op->addr.nbytes) {
541 case 0:
542 break;
543 case 1:
544 ifr |= QSPI_IFR_OPTEN | QSPI_IFR_OPTL_8BIT;
545 icr |= QSPI_ICR_OPT(op->addr.val & 0xff);
546 break;
547 case 2:
548 if (dummy_cycles < 8 / op->addr.buswidth) {
549 ifr &= ~QSPI_IFR_INSTEN;
550 ifr |= QSPI_IFR_ADDREN;
551 iar = (op->cmd.opcode << 16) |
552 (op->addr.val & 0xffff);
553 } else {
554 ifr |= QSPI_IFR_ADDREN;
555 iar = (op->addr.val << 8) & 0xffffff;
556 dummy_cycles -= 8 / op->addr.buswidth;
557 }
558 break;
559 case 3:
560 ifr |= QSPI_IFR_ADDREN;
561 iar = op->addr.val & 0xffffff;
562 break;
563 case 4:
564 ifr |= QSPI_IFR_ADDREN | QSPI_IFR_ADDRL;
565 iar = op->addr.val & 0x7ffffff;
566 break;
567 default:
568 return -ENOTSUPP;
569 }
570 }
571
572 /* offset of the data access in the QSPI memory space */
573 *offset = iar;
574
575 /* Set number of dummy cycles */
576 if (dummy_cycles)
577 ifr |= QSPI_IFR_NBDUM(dummy_cycles);
578
Alexander Dahl82cca202025-01-23 13:12:10 +0100579 /* Set data enable and data transfer type. */
580 if (op->data.nbytes) {
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000581 ifr |= QSPI_IFR_DATAEN;
582
Alexander Dahl82cca202025-01-23 13:12:10 +0100583 if (op->addr.nbytes)
584 ifr |= QSPI_IFR_TFRTYP_MEM;
585 }
586
Alexander Dahlffc73302025-01-23 13:12:13 +0100587 mode = atmel_qspi_set_serial_memory_mode(aq, true);
Alexander Dahlcced8e02025-01-23 13:12:11 +0100588 if (mode < 0)
589 return mode;
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000590
591 /* Clear pending interrupts */
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000592 (void)atmel_qspi_read(aq, QSPI_SR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000593
Alexander Dahl82cca202025-01-23 13:12:10 +0100594 /* Set QSPI Instruction Frame registers. */
595 if (op->addr.nbytes && !op->data.nbytes)
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000596 atmel_qspi_write(iar, aq, QSPI_IAR);
Alexander Dahl82cca202025-01-23 13:12:10 +0100597
598 if (aq->caps->has_ricr) {
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000599 if (op->data.dir == SPI_MEM_DATA_IN)
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000600 atmel_qspi_write(icr, aq, QSPI_RICR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000601 else
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000602 atmel_qspi_write(icr, aq, QSPI_WICR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000603 } else {
Alexander Dahl82cca202025-01-23 13:12:10 +0100604 if (op->data.nbytes && op->data.dir == SPI_MEM_DATA_OUT)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000605 ifr |= QSPI_IFR_SAMA5D2_WRITE_TRSFR;
606
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000607 atmel_qspi_write(icr, aq, QSPI_ICR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000608 }
609
Alexander Dahl82cca202025-01-23 13:12:10 +0100610 atmel_qspi_write(ifr, aq, QSPI_IFR);
611
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000612 return 0;
613}
614
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200615static int atmel_qspi_transfer(struct atmel_qspi *aq,
616 const struct spi_mem_op *op, u32 offset)
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000617{
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200618 u32 sr, imr;
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000619
620 /* Skip to the final steps if there is no data */
621 if (op->data.nbytes) {
622 /* Dummy read of QSPI_IFR to synchronize APB and AHB accesses */
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000623 (void)atmel_qspi_read(aq, QSPI_IFR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000624
625 /* Send/Receive data */
626 if (op->data.dir == SPI_MEM_DATA_IN)
627 memcpy_fromio(op->data.buf.in, aq->mem + offset,
628 op->data.nbytes);
629 else
630 memcpy_toio(aq->mem + offset, op->data.buf.out,
631 op->data.nbytes);
632
633 /* Release the chip-select */
Tudor Ambarusf44d2e02020-03-20 09:37:59 +0000634 atmel_qspi_write(QSPI_CR_LASTXFER, aq, QSPI_CR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000635 }
636
637 /* Poll INSTruction End and Chip Select Rise flags. */
638 imr = QSPI_SR_INSTRE | QSPI_SR_CSR;
639 return readl_poll_timeout(aq->regs + QSPI_SR, sr, (sr & imr) == imr,
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200640 ATMEL_QSPI_TIMEOUT);
641}
642
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200643static int atmel_qspi_sama7g5_set_cfg(struct atmel_qspi *aq,
644 const struct spi_mem_op *op, u32 *offset)
645{
646 u32 iar, icr, ifr;
647 int mode, ret;
648
649 iar = 0;
650 icr = FIELD_PREP(QSPI_ICR_INST_MASK_SAMA7G5, op->cmd.opcode);
651 ifr = QSPI_IFR_INSTEN;
652
653 mode = atmel_qspi_sama7g5_find_mode(op);
654 if (mode < 0)
655 return mode;
656 ifr |= atmel_qspi_sama7g5_modes[mode].config;
657
658 if (op->dummy.buswidth && op->dummy.nbytes) {
659 if (op->addr.dtr && op->dummy.dtr && op->data.dtr)
660 ifr |= QSPI_IFR_NBDUM(op->dummy.nbytes * 8 /
661 (2 * op->dummy.buswidth));
662 else
663 ifr |= QSPI_IFR_NBDUM(op->dummy.nbytes * 8 /
664 op->dummy.buswidth);
665 }
666
667 if (op->addr.buswidth && op->addr.nbytes) {
668 ifr |= FIELD_PREP(QSPI_IFR_ADDRL_SAMA7G5, op->addr.nbytes - 1) |
669 QSPI_IFR_ADDREN;
670 iar = FIELD_PREP(QSPI_IAR_ADDR, op->addr.val);
671 }
672
673 if (op->addr.dtr && op->dummy.dtr && op->data.dtr) {
674 ifr |= QSPI_IFR_DDREN;
675 if (op->cmd.dtr)
676 ifr |= QSPI_IFR_DDRCMDEN;
677 ifr |= QSPI_IFR_DQSEN;
678 }
679
680 if (op->cmd.buswidth == 8 || op->addr.buswidth == 8 ||
681 op->data.buswidth == 8)
682 ifr |= FIELD_PREP(QSPI_IFR_PROTTYP, QSPI_IFR_PROTTYP_OCTAFLASH);
683
684 /* offset of the data access in the QSPI memory space */
685 *offset = iar;
686
687 /* Set data enable */
688 if (op->data.nbytes) {
689 ifr |= QSPI_IFR_DATAEN;
690 if (op->addr.nbytes)
691 ifr |= QSPI_IFR_TFRTYP_MEM;
692 }
693
Alexander Dahlffc73302025-01-23 13:12:13 +0100694 ret = atmel_qspi_set_serial_memory_mode(aq, true);
Alexander Dahlcced8e02025-01-23 13:12:11 +0100695 if (ret < 0)
696 return ret;
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200697
698 /* Clear pending interrupts */
699 (void)atmel_qspi_read(aq, QSPI_SR);
700
701 /* Set QSPI Instruction Frame registers */
702 if (op->addr.nbytes && !op->data.nbytes)
703 atmel_qspi_write(iar, aq, QSPI_IAR);
704
705 if (op->data.dir == SPI_MEM_DATA_IN) {
706 atmel_qspi_write(icr, aq, QSPI_RICR);
707 } else {
708 atmel_qspi_write(icr, aq, QSPI_WICR);
709 if (op->data.nbytes)
710 atmel_qspi_write(FIELD_PREP(QSPI_WRACNT_NBWRA,
711 op->data.nbytes),
712 aq, QSPI_WRACNT);
713 }
714
715 atmel_qspi_write(ifr, aq, QSPI_IFR);
716
717 return atmel_qspi_update_config(aq);
718}
719
720static int atmel_qspi_sama7g5_transfer(struct atmel_qspi *aq,
721 const struct spi_mem_op *op, u32 offset)
722{
723 int err;
724 u32 val;
725
726 if (!op->data.nbytes) {
727 /* Start the transfer. */
728 err = atmel_qspi_reg_sync(aq);
729 if (err)
730 return err;
731 atmel_qspi_write(QSPI_CR_STTFR, aq, QSPI_CR);
732
733 return readl_poll_timeout(aq->regs + QSPI_SR, val,
734 val & QSPI_SR_CSRA,
735 ATMEL_QSPI_TIMEOUT);
736 }
737
738 /* Send/Receive data. */
739 if (op->data.dir == SPI_MEM_DATA_IN) {
740 memcpy_fromio(op->data.buf.in, aq->mem + offset,
741 op->data.nbytes);
742
743 if (op->addr.nbytes) {
744 err = readl_poll_timeout(aq->regs + QSPI_SR2, val,
745 !(val & QSPI_SR2_RBUSY),
746 ATMEL_QSPI_SYNC_TIMEOUT);
747 if (err)
748 return err;
749 }
750 } else {
751 memcpy_toio(aq->mem + offset, op->data.buf.out,
752 op->data.nbytes);
753
754 err = readl_poll_timeout(aq->regs + QSPI_SR, val,
755 val & QSPI_SR_LWRA,
756 ATMEL_QSPI_TIMEOUT);
757 if (err)
758 return err;
759 }
760
761 /* Release the chip-select. */
762 err = atmel_qspi_reg_sync(aq);
763 if (err)
764 return err;
765 atmel_qspi_write(QSPI_CR_LASTXFER, aq, QSPI_CR);
766
767 return readl_poll_timeout(aq->regs + QSPI_SR, val, val & QSPI_SR_CSRA,
768 ATMEL_QSPI_TIMEOUT);
769}
770
771static int atmel_qspi_exec_op(struct spi_slave *slave,
772 const struct spi_mem_op *op)
773{
774 struct atmel_qspi *aq = dev_get_priv(slave->dev->parent);
775 u32 offset;
776 int err;
777
778 /*
779 * Check if the address exceeds the MMIO window size. An improvement
780 * would be to add support for regular SPI mode and fall back to it
781 * when the flash memories overrun the controller's memory space.
782 */
783 if (op->addr.val + op->data.nbytes > aq->mmap_size)
784 return -ENOTSUPP;
785
786 if (op->addr.nbytes > 4)
787 return -EOPNOTSUPP;
788
789 err = aq->ops->set_cfg(aq, op, &offset);
790 if (err)
791 return err;
792
793 return aq->ops->transfer(aq, op, offset);
794}
795
796static int atmel_qspi_set_pad_calibration(struct udevice *bus, uint hz)
797{
798 struct atmel_qspi *aq = dev_get_priv(bus);
799 u32 status, val;
800 int i, ret;
801 u8 pclk_div = 0;
802
803 for (i = 0; i < ATMEL_QSPI_PCAL_ARRAY_SIZE; i++) {
804 if (aq->bus_clk_rate <= pcal[i].pclk_rate) {
805 pclk_div = pcal[i].pclk_div;
806 break;
807 }
808 }
809
810 /*
811 * Use the biggest divider in case the peripheral clock exceeds
812 * 200MHZ.
813 */
814 if (aq->bus_clk_rate > pcal[ATMEL_QSPI_PCAL_ARRAY_SIZE - 1].pclk_rate)
815 pclk_div = pcal[ATMEL_QSPI_PCAL_ARRAY_SIZE - 1].pclk_div;
816
817 /* Disable QSPI while configuring the pad calibration. */
818 status = atmel_qspi_read(aq, QSPI_SR2);
819 if (status & QSPI_SR2_QSPIENS) {
820 ret = atmel_qspi_reg_sync(aq);
821 if (ret)
822 return ret;
823 atmel_qspi_write(QSPI_CR_QSPIDIS, aq, QSPI_CR);
824 }
825
826 /*
827 * The analog circuitry is not shut down at the end of the calibration
828 * and the start-up time is only required for the first calibration
829 * sequence, thus increasing performance. Set the delay between the Pad
830 * calibration analog circuitry and the calibration request to 2us.
831 */
832 atmel_qspi_write(QSPI_PCALCFG_AAON |
833 FIELD_PREP(QSPI_PCALCFG_CLKDIV, pclk_div) |
834 FIELD_PREP(QSPI_PCALCFG_CALCNT,
835 2 * (aq->bus_clk_rate / 1000000)),
836 aq, QSPI_PCALCFG);
837
838 /* DLL On + start calibration. */
839 atmel_qspi_write(QSPI_CR_DLLON | QSPI_CR_STPCAL, aq, QSPI_CR);
840 ret = readl_poll_timeout(aq->regs + QSPI_SR2, val,
841 (val & QSPI_SR2_DLOCK) &&
842 !(val & QSPI_SR2_CALBSY),
843 ATMEL_QSPI_TIMEOUT);
844
845 /* Refresh analogic blocks every 1 ms.*/
846 atmel_qspi_write(FIELD_PREP(QSPI_REFRESH_DELAY_COUNTER, hz / 1000),
847 aq, QSPI_REFRESH);
848
849 return ret;
850}
851
852static int atmel_qspi_set_gclk(struct udevice *bus, uint hz)
853{
854 struct atmel_qspi *aq = dev_get_priv(bus);
855 struct clk gclk;
856 u32 status, val;
857 int ret;
858
859 /* Disable DLL before setting GCLK */
860 status = atmel_qspi_read(aq, QSPI_SR2);
861 if (status & QSPI_SR2_DLOCK) {
862 atmel_qspi_write(QSPI_CR_DLLOFF, aq, QSPI_CR);
863 ret = readl_poll_timeout(aq->regs + QSPI_SR2, val,
864 !(val & QSPI_SR2_DLOCK),
865 ATMEL_QSPI_TIMEOUT);
866 if (ret)
867 return ret;
868 }
869
870 if (hz > QSPI_DLLCFG_THRESHOLD_FREQ)
871 atmel_qspi_write(QSPI_DLLCFG_RANGE, aq, QSPI_DLLCFG);
872 else
873 atmel_qspi_write(0, aq, QSPI_DLLCFG);
874
875 ret = clk_get_by_name(bus, "gclk", &gclk);
876 if (ret) {
877 dev_err(bus, "Missing QSPI generic clock\n");
878 return ret;
879 }
880
881 ret = clk_disable(&gclk);
882 if (ret)
883 dev_err(bus, "Failed to disable QSPI generic clock\n");
884
885 ret = clk_set_rate(&gclk, hz);
886 if (ret < 0) {
887 dev_err(bus, "Failed to set generic clock rate.\n");
888 return ret;
889 }
890
891 ret = clk_enable(&gclk);
892 if (ret)
893 dev_err(bus, "Failed to enable QSPI generic clock\n");
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200894
895 return ret;
896}
897
898static int atmel_qspi_sama7g5_set_speed(struct udevice *bus, uint hz)
899{
900 struct atmel_qspi *aq = dev_get_priv(bus);
901 u32 val;
902 int ret;
903
904 ret = atmel_qspi_set_gclk(bus, hz);
905 if (ret)
906 return ret;
907
908 if (aq->caps->octal) {
909 ret = atmel_qspi_set_pad_calibration(bus, hz);
910 if (ret)
911 return ret;
912 } else {
913 atmel_qspi_write(QSPI_CR_DLLON, aq, QSPI_CR);
914 ret = readl_poll_timeout(aq->regs + QSPI_SR2, val,
915 val & QSPI_SR2_DLOCK,
916 ATMEL_QSPI_TIMEOUT);
917 }
918
919 /* Set the QSPI controller by default in Serial Memory Mode */
Alexander Dahlcced8e02025-01-23 13:12:11 +0100920 aq->mr |= QSPI_MR_DQSDLYEN;
Alexander Dahlffc73302025-01-23 13:12:13 +0100921 ret = atmel_qspi_set_serial_memory_mode(aq, true);
Alexander Dahlcced8e02025-01-23 13:12:11 +0100922 if (ret < 0)
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200923 return ret;
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +0200924
925 /* Enable the QSPI controller. */
926 ret = atmel_qspi_reg_sync(aq);
927 if (ret)
928 return ret;
929 atmel_qspi_write(QSPI_CR_QSPIEN, aq, QSPI_CR);
930 ret = readl_poll_timeout(aq->regs + QSPI_SR2, val,
931 val & QSPI_SR2_QSPIENS,
932 ATMEL_QSPI_SYNC_TIMEOUT);
933 if (ret)
934 return ret;
935
936 if (aq->caps->octal)
937 ret = readl_poll_timeout(aq->regs + QSPI_SR, val,
938 val & QSPI_SR_RFRSHD,
939 ATMEL_QSPI_TIMEOUT);
940
941 atmel_qspi_write(FIELD_PREP(QSPI_TOUT_TCNTM, QSPI_TOUT_MAX),
942 aq, QSPI_TOUT);
943
944 return ret;
Tudor Ambarus88151bb2019-06-18 08:51:50 +0000945}
946
Alexander Dahl26ca20a2025-01-23 13:12:14 +0100947static int atmel_qspi_claim_bus(struct udevice *dev)
948{
949 struct udevice *bus = dev_get_parent(dev);
950 struct atmel_qspi *aq = dev_get_priv(bus);
951 int ret;
952
953 aq->mr &= ~QSPI_MR_CSMODE_MASK;
954 aq->mr |= QSPI_MR_CSMODE_LASTXFER | QSPI_MR_WDRBT;
955 atmel_qspi_write(aq->mr, aq, QSPI_MR);
956
957 ret = atmel_qspi_set_serial_memory_mode(aq, false);
958 if (ret)
959 return log_ret(ret);
960
961 /* de-assert all chip selects */
962 if (IS_ENABLED(CONFIG_DM_GPIO)) {
963 for (int i = 0; i < ARRAY_SIZE(aq->cs_gpios); i++) {
964 if (dm_gpio_is_valid(&aq->cs_gpios[i]))
965 dm_gpio_set_value(&aq->cs_gpios[i], 0);
966 }
967 }
968
969 atmel_qspi_write(QSPI_CR_QSPIEN, aq, QSPI_CR);
970
971 return 0;
972}
973
974static int atmel_qspi_release_bus(struct udevice *dev)
975{
976 struct udevice *bus = dev_get_parent(dev);
977 struct atmel_qspi *aq = dev_get_priv(bus);
978
979 /* de-assert all chip selects */
980 if (IS_ENABLED(CONFIG_DM_GPIO)) {
981 for (int i = 0; i < ARRAY_SIZE(aq->cs_gpios); i++) {
982 if (dm_gpio_is_valid(&aq->cs_gpios[i]))
983 dm_gpio_set_value(&aq->cs_gpios[i], 0);
984 }
985 }
986
987 atmel_qspi_write(QSPI_CR_QSPIDIS, aq, QSPI_CR);
988
989 return 0;
990}
991
992static int atmel_qspi_set_cs(struct udevice *dev, int value)
993{
994 struct udevice *bus = dev_get_parent(dev);
995 struct atmel_qspi *aq = dev_get_priv(bus);
996 int cs = spi_chip_select(dev);
997
998 if (IS_ENABLED(CONFIG_DM_GPIO)) {
999 if (!dm_gpio_is_valid(&aq->cs_gpios[cs]))
1000 return log_ret(-ENOENT);
1001
1002 return dm_gpio_set_value(&aq->cs_gpios[cs], value);
1003 } else {
1004 return -ENOENT;
1005 }
1006}
1007
1008static int atmel_qspi_xfer(struct udevice *dev, unsigned int bitlen,
1009 const void *dout, void *din, unsigned long flags)
1010{
1011 struct udevice *bus = dev_get_parent(dev);
1012 struct atmel_qspi *aq = dev_get_priv(bus);
1013 unsigned int len, len_rx, len_tx;
1014 const u8 *txp = dout;
1015 u8 *rxp = din;
1016 u32 reg;
1017 int ret;
1018
1019 if (bitlen == 0)
1020 goto out;
1021
1022 if (bitlen % 8) {
1023 flags |= SPI_XFER_END;
1024 goto out;
1025 }
1026
1027 len = bitlen / 8;
1028
1029 if (flags & SPI_XFER_BEGIN) {
1030 ret = atmel_qspi_set_cs(dev, 1);
1031 if (ret)
1032 return log_ret(ret);
1033 reg = atmel_qspi_read(aq, QSPI_RD);
1034 }
1035
1036 for (len_tx = 0, len_rx = 0; len_rx < len; ) {
1037 u32 status = atmel_qspi_read(aq, QSPI_SR);
1038 u8 value;
1039
1040 if (status & QSPI_SR_OVRES)
1041 return log_ret(-1);
1042
1043 if (len_tx < len && (status & QSPI_SR_TDRE)) {
1044 if (txp)
1045 value = *txp++;
1046 else
1047 value = 0;
1048 atmel_qspi_write(value, aq, QSPI_TD);
1049 len_tx++;
1050 }
1051
1052 if (status & QSPI_SR_RDRF) {
1053 value = atmel_qspi_read(aq, QSPI_RD);
1054 if (rxp)
1055 *rxp++ = value;
1056 len_rx++;
1057 }
1058 }
1059
1060out:
1061 if (flags & SPI_XFER_END) {
1062 readl_poll_timeout(aq->regs + QSPI_SR, reg,
1063 reg & QSPI_SR_TXEMPTY,
1064 ATMEL_QSPI_TIMEOUT);
1065
1066 atmel_qspi_write(QSPI_CR_LASTXFER, aq, QSPI_CR);
1067
1068 ret = atmel_qspi_set_cs(dev, 0);
1069 if (ret)
1070 return log_ret(ret);
1071 }
1072
1073 return 0;
1074}
1075
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001076static int atmel_qspi_set_speed(struct udevice *bus, uint hz)
1077{
1078 struct atmel_qspi *aq = dev_get_priv(bus);
1079 u32 scr, scbr, mask, new_value;
1080
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001081 if (aq->caps->has_gclk)
1082 return atmel_qspi_sama7g5_set_speed(bus, hz);
1083
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001084 /* Compute the QSPI baudrate */
1085 scbr = DIV_ROUND_UP(aq->bus_clk_rate, hz);
1086 if (scbr > 0)
1087 scbr--;
1088
1089 new_value = QSPI_SCR_SCBR(scbr);
1090 mask = QSPI_SCR_SCBR_MASK;
1091
Tudor Ambarusf44d2e02020-03-20 09:37:59 +00001092 scr = atmel_qspi_read(aq, QSPI_SCR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001093 if ((scr & mask) == new_value)
1094 return 0;
1095
1096 scr = (scr & ~mask) | new_value;
Tudor Ambarusf44d2e02020-03-20 09:37:59 +00001097 atmel_qspi_write(scr, aq, QSPI_SCR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001098
1099 return 0;
1100}
1101
1102static int atmel_qspi_set_mode(struct udevice *bus, uint mode)
1103{
1104 struct atmel_qspi *aq = dev_get_priv(bus);
1105 u32 scr, mask, new_value = 0;
1106
1107 if (mode & SPI_CPOL)
1108 new_value = QSPI_SCR_CPOL;
1109 if (mode & SPI_CPHA)
1110 new_value = QSPI_SCR_CPHA;
1111
1112 mask = QSPI_SCR_CPOL | QSPI_SCR_CPHA;
1113
Tudor Ambarusf44d2e02020-03-20 09:37:59 +00001114 scr = atmel_qspi_read(aq, QSPI_SCR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001115 if ((scr & mask) == new_value)
1116 return 0;
1117
1118 scr = (scr & ~mask) | new_value;
Tudor Ambarusf44d2e02020-03-20 09:37:59 +00001119 atmel_qspi_write(scr, aq, QSPI_SCR);
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001120 if (aq->caps->has_gclk)
1121 return atmel_qspi_update_config(aq);
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001122
1123 return 0;
1124}
1125
1126static int atmel_qspi_enable_clk(struct udevice *dev)
1127{
1128 struct atmel_qspi *aq = dev_get_priv(dev);
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001129 struct clk pclk, qspick, gclk;
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001130 int ret;
1131
1132 ret = clk_get_by_name(dev, "pclk", &pclk);
1133 if (ret)
1134 ret = clk_get_by_index(dev, 0, &pclk);
1135
1136 if (ret) {
1137 dev_err(dev, "Missing QSPI peripheral clock\n");
1138 return ret;
1139 }
1140
1141 ret = clk_enable(&pclk);
1142 if (ret) {
1143 dev_err(dev, "Failed to enable QSPI peripheral clock\n");
Sean Andersond318eb32023-12-16 14:38:42 -05001144 return ret;
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001145 }
1146
1147 if (aq->caps->has_qspick) {
1148 /* Get the QSPI system clock */
1149 ret = clk_get_by_name(dev, "qspick", &qspick);
1150 if (ret) {
1151 dev_err(dev, "Missing QSPI peripheral clock\n");
Sean Andersond318eb32023-12-16 14:38:42 -05001152 return ret;
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001153 }
1154
1155 ret = clk_enable(&qspick);
1156 if (ret)
1157 dev_err(dev, "Failed to enable QSPI system clock\n");
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001158 } else if (aq->caps->has_gclk) {
1159 ret = clk_get_by_name(dev, "gclk", &gclk);
1160 if (ret) {
1161 dev_err(dev, "Missing QSPI generic clock\n");
Sean Andersond318eb32023-12-16 14:38:42 -05001162 return ret;
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001163 }
1164
1165 ret = clk_enable(&gclk);
1166 if (ret)
1167 dev_err(dev, "Failed to enable QSPI system clock\n");
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001168 }
1169
1170 aq->bus_clk_rate = clk_get_rate(&pclk);
1171 if (!aq->bus_clk_rate)
Sean Andersond318eb32023-12-16 14:38:42 -05001172 return -EINVAL;
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001173
1174 return ret;
1175}
1176
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001177static int atmel_qspi_init(struct atmel_qspi *aq)
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001178{
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001179 int ret;
1180
1181 if (aq->caps->has_gclk) {
1182 ret = atmel_qspi_reg_sync(aq);
1183 if (ret)
1184 return ret;
1185 atmel_qspi_write(QSPI_CR_SWRST, aq, QSPI_CR);
1186 return 0;
1187 }
1188
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001189 /* Reset the QSPI controller */
Tudor Ambarusf44d2e02020-03-20 09:37:59 +00001190 atmel_qspi_write(QSPI_CR_SWRST, aq, QSPI_CR);
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001191
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001192 /* Enable the QSPI controller */
Tudor Ambarusf44d2e02020-03-20 09:37:59 +00001193 atmel_qspi_write(QSPI_CR_QSPIEN, aq, QSPI_CR);
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001194
1195 return 0;
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001196}
1197
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001198static const struct atmel_qspi_priv_ops atmel_qspi_priv_ops = {
1199 .set_cfg = atmel_qspi_set_cfg,
1200 .transfer = atmel_qspi_transfer,
1201};
1202
1203static const struct atmel_qspi_priv_ops atmel_qspi_sama7g5_priv_ops = {
1204 .set_cfg = atmel_qspi_sama7g5_set_cfg,
1205 .transfer = atmel_qspi_sama7g5_transfer,
1206};
1207
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001208static int atmel_qspi_probe(struct udevice *dev)
1209{
1210 struct atmel_qspi *aq = dev_get_priv(dev);
1211 struct resource res;
1212 int ret;
1213
1214 aq->caps = (struct atmel_qspi_caps *)dev_get_driver_data(dev);
1215 if (!aq->caps) {
1216 dev_err(dev, "Could not retrieve QSPI caps\n");
1217 return -EINVAL;
1218 };
1219
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001220 if (aq->caps->has_gclk)
1221 aq->ops = &atmel_qspi_sama7g5_priv_ops;
1222 else
1223 aq->ops = &atmel_qspi_priv_ops;
1224
Alexander Dahl26ca20a2025-01-23 13:12:14 +01001225 if (IS_ENABLED(CONFIG_DM_GPIO)) {
1226 ret = gpio_request_list_by_name(dev, "cs-gpios", aq->cs_gpios,
1227 ARRAY_SIZE(aq->cs_gpios), 0);
1228 if (ret < 0) {
1229 pr_err("Can't get %s gpios! Error: %d", dev->name, ret);
1230 return ret;
1231 }
1232
1233 for (int i = 0; i < ARRAY_SIZE(aq->cs_gpios); i++) {
1234 if (!dm_gpio_is_valid(&aq->cs_gpios[i]))
1235 continue;
1236
1237 dm_gpio_set_dir_flags(&aq->cs_gpios[i],
1238 GPIOD_IS_OUT | GPIOD_IS_OUT_ACTIVE);
1239 }
1240 }
1241
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001242 /* Map the registers */
1243 ret = dev_read_resource_byname(dev, "qspi_base", &res);
1244 if (ret) {
1245 dev_err(dev, "missing registers\n");
1246 return ret;
1247 }
1248
1249 aq->regs = devm_ioremap(dev, res.start, resource_size(&res));
1250 if (IS_ERR(aq->regs))
1251 return PTR_ERR(aq->regs);
1252
1253 /* Map the AHB memory */
1254 ret = dev_read_resource_byname(dev, "qspi_mmap", &res);
1255 if (ret) {
1256 dev_err(dev, "missing AHB memory\n");
1257 return ret;
1258 }
1259
1260 aq->mem = devm_ioremap(dev, res.start, resource_size(&res));
1261 if (IS_ERR(aq->mem))
1262 return PTR_ERR(aq->mem);
1263
Tudor Ambarus678b8932020-03-20 09:37:59 +00001264 aq->mmap_size = resource_size(&res);
1265
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001266 ret = atmel_qspi_enable_clk(dev);
1267 if (ret)
1268 return ret;
1269
Tudor Ambarusf44d2e02020-03-20 09:37:59 +00001270 aq->dev = dev;
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001271 return atmel_qspi_init(aq);
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001272}
1273
1274static const struct spi_controller_mem_ops atmel_qspi_mem_ops = {
1275 .supports_op = atmel_qspi_supports_op,
1276 .exec_op = atmel_qspi_exec_op,
1277};
1278
1279static const struct dm_spi_ops atmel_qspi_ops = {
Alexander Dahl26ca20a2025-01-23 13:12:14 +01001280 .claim_bus = atmel_qspi_claim_bus,
1281 .release_bus = atmel_qspi_release_bus,
1282 .xfer = atmel_qspi_xfer,
1283 .mem_ops = &atmel_qspi_mem_ops,
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001284 .set_speed = atmel_qspi_set_speed,
1285 .set_mode = atmel_qspi_set_mode,
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001286};
1287
1288static const struct atmel_qspi_caps atmel_sama5d2_qspi_caps = {};
1289
1290static const struct atmel_qspi_caps atmel_sam9x60_qspi_caps = {
1291 .has_qspick = true,
1292 .has_ricr = true,
1293};
1294
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001295static const struct atmel_qspi_caps atmel_sama7g5_ospi_caps = {
1296 .has_gclk = true,
1297 .octal = true,
1298};
1299
1300static const struct atmel_qspi_caps atmel_sama7g5_qspi_caps = {
1301 .has_gclk = true,
1302};
1303
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001304static const struct udevice_id atmel_qspi_ids[] = {
1305 {
1306 .compatible = "atmel,sama5d2-qspi",
1307 .data = (ulong)&atmel_sama5d2_qspi_caps,
1308 },
1309 {
1310 .compatible = "microchip,sam9x60-qspi",
1311 .data = (ulong)&atmel_sam9x60_qspi_caps,
1312 },
Tudor Ambarus8e4f44b2021-11-03 18:47:10 +02001313 {
1314 .compatible = "microchip,sama7g5-ospi",
1315 .data = (ulong)&atmel_sama7g5_ospi_caps,
1316 },
1317 {
1318 .compatible = "microchip,sama7g5-qspi",
1319 .data = (ulong)&atmel_sama7g5_qspi_caps,
1320 },
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001321 { /* sentinel */ }
1322};
1323
1324U_BOOT_DRIVER(atmel_qspi) = {
1325 .name = "atmel_qspi",
1326 .id = UCLASS_SPI,
1327 .of_match = atmel_qspi_ids,
1328 .ops = &atmel_qspi_ops,
Simon Glass8a2b47f2020-12-03 16:55:17 -07001329 .priv_auto = sizeof(struct atmel_qspi),
Tudor Ambarus88151bb2019-06-18 08:51:50 +00001330 .probe = atmel_qspi_probe,
1331};