3 * Altera Corporation <www.altera.com>
5 * SPDX-License-Identifier: GPL-2.0+
13 #include <linux/errno.h>
14 #include "cadence_qspi.h"
16 #define CQSPI_STIG_READ 0
17 #define CQSPI_STIG_WRITE 1
18 #define CQSPI_INDIRECT_READ 2
19 #define CQSPI_INDIRECT_WRITE 3
21 DECLARE_GLOBAL_DATA_PTR;
23 static int cadence_spi_write_speed(struct udevice *bus, uint hz)
25 struct cadence_spi_platdata *plat = bus->platdata;
26 struct cadence_spi_priv *priv = dev_get_priv(bus);
28 cadence_qspi_apb_config_baudrate_div(priv->regbase,
29 CONFIG_CQSPI_REF_CLK, hz);
31 /* Reconfigure delay timing if speed is changed. */
32 cadence_qspi_apb_delay(priv->regbase, CONFIG_CQSPI_REF_CLK, hz,
33 plat->tshsl_ns, plat->tsd2d_ns,
34 plat->tchsh_ns, plat->tslch_ns);
39 /* Calibration sequence to determine the read data capture delay register */
40 static int spi_calibration(struct udevice *bus, uint hz)
42 struct cadence_spi_priv *priv = dev_get_priv(bus);
43 void *base = priv->regbase;
44 u8 opcode_rdid = 0x9F;
45 unsigned int idcode = 0, temp = 0;
46 int err = 0, i, range_lo = -1, range_hi = -1;
48 /* start with slowest clock (1 MHz) */
49 cadence_spi_write_speed(bus, 1000000);
51 /* configure the read data capture delay register to 0 */
52 cadence_qspi_apb_readdata_capture(base, 1, 0);
55 cadence_qspi_apb_controller_enable(base);
57 /* read the ID which will be our golden value */
58 err = cadence_qspi_apb_command_read(base, 1, &opcode_rdid,
61 puts("SF: Calibration failed (read)\n");
65 /* use back the intended clock and find low range */
66 cadence_spi_write_speed(bus, hz);
67 for (i = 0; i < CQSPI_READ_CAPTURE_MAX_DELAY; i++) {
69 cadence_qspi_apb_controller_disable(base);
71 /* reconfigure the read data capture delay register */
72 cadence_qspi_apb_readdata_capture(base, 1, i);
74 /* Enable back QSPI */
75 cadence_qspi_apb_controller_enable(base);
77 /* issue a RDID to get the ID value */
78 err = cadence_qspi_apb_command_read(base, 1, &opcode_rdid,
81 puts("SF: Calibration failed (read)\n");
85 /* search for range lo */
86 if (range_lo == -1 && temp == idcode) {
91 /* search for range hi */
92 if (range_lo != -1 && temp != idcode) {
100 puts("SF: Calibration failed (low range)\n");
104 /* Disable QSPI for subsequent initialization */
105 cadence_qspi_apb_controller_disable(base);
107 /* configure the final value for read data capture delay register */
108 cadence_qspi_apb_readdata_capture(base, 1, (range_hi + range_lo) / 2);
109 debug("SF: Read data capture delay calibrated to %i (%i - %i)\n",
110 (range_hi + range_lo) / 2, range_lo, range_hi);
112 /* just to ensure we do once only when speed or chip select change */
113 priv->qspi_calibrated_hz = hz;
114 priv->qspi_calibrated_cs = spi_chip_select(bus);
119 static int cadence_spi_set_speed(struct udevice *bus, uint hz)
121 struct cadence_spi_platdata *plat = bus->platdata;
122 struct cadence_spi_priv *priv = dev_get_priv(bus);
125 if (hz > plat->max_hz)
129 cadence_qspi_apb_controller_disable(priv->regbase);
132 * Calibration required for different current SCLK speed, requested
133 * SCLK speed or chip select
135 if (priv->previous_hz != hz ||
136 priv->qspi_calibrated_hz != hz ||
137 priv->qspi_calibrated_cs != spi_chip_select(bus)) {
138 err = spi_calibration(bus, hz);
142 /* prevent calibration run when same as previous request */
143 priv->previous_hz = hz;
147 cadence_qspi_apb_controller_enable(priv->regbase);
149 debug("%s: speed=%d\n", __func__, hz);
154 static int cadence_spi_probe(struct udevice *bus)
156 struct cadence_spi_platdata *plat = bus->platdata;
157 struct cadence_spi_priv *priv = dev_get_priv(bus);
159 priv->regbase = plat->regbase;
160 priv->ahbbase = plat->ahbbase;
162 if (!priv->qspi_is_init) {
163 cadence_qspi_apb_controller_init(plat);
164 priv->qspi_is_init = 1;
170 static int cadence_spi_set_mode(struct udevice *bus, uint mode)
172 struct cadence_spi_priv *priv = dev_get_priv(bus);
173 unsigned int clk_pol = (mode & SPI_CPOL) ? 1 : 0;
174 unsigned int clk_pha = (mode & SPI_CPHA) ? 1 : 0;
177 cadence_qspi_apb_controller_disable(priv->regbase);
180 cadence_qspi_apb_set_clk_mode(priv->regbase, clk_pol, clk_pha);
183 cadence_qspi_apb_controller_enable(priv->regbase);
188 static int cadence_spi_xfer(struct udevice *dev, unsigned int bitlen,
189 const void *dout, void *din, unsigned long flags)
191 struct udevice *bus = dev->parent;
192 struct cadence_spi_platdata *plat = bus->platdata;
193 struct cadence_spi_priv *priv = dev_get_priv(bus);
194 struct dm_spi_slave_platdata *dm_plat = dev_get_parent_platdata(dev);
195 void *base = priv->regbase;
196 u8 *cmd_buf = priv->cmd_buf;
199 u32 mode = CQSPI_STIG_WRITE;
201 if (flags & SPI_XFER_BEGIN) {
202 /* copy command to local buffer */
203 priv->cmd_len = bitlen / 8;
204 memcpy(cmd_buf, dout, priv->cmd_len);
207 if (flags == (SPI_XFER_BEGIN | SPI_XFER_END)) {
208 /* if start and end bit are set, the data bytes is 0. */
211 data_bytes = bitlen / 8;
213 debug("%s: len=%d [bytes]\n", __func__, data_bytes);
215 /* Set Chip select */
216 cadence_qspi_apb_chipselect(base, spi_chip_select(dev),
217 CONFIG_CQSPI_DECODER);
219 if ((flags & SPI_XFER_END) || (flags == 0)) {
220 if (priv->cmd_len == 0) {
221 printf("QSPI: Error, command is empty.\n");
225 if (din && data_bytes) {
227 /* Use STIG if no address. */
228 if (!CQSPI_IS_ADDR(priv->cmd_len))
229 mode = CQSPI_STIG_READ;
231 mode = CQSPI_INDIRECT_READ;
232 } else if (dout && !(flags & SPI_XFER_BEGIN)) {
234 if (!CQSPI_IS_ADDR(priv->cmd_len))
235 mode = CQSPI_STIG_WRITE;
237 mode = CQSPI_INDIRECT_WRITE;
241 case CQSPI_STIG_READ:
242 err = cadence_qspi_apb_command_read(
243 base, priv->cmd_len, cmd_buf,
247 case CQSPI_STIG_WRITE:
248 err = cadence_qspi_apb_command_write(base,
249 priv->cmd_len, cmd_buf,
252 case CQSPI_INDIRECT_READ:
253 err = cadence_qspi_apb_indirect_read_setup(plat,
254 priv->cmd_len, dm_plat->mode, cmd_buf);
256 err = cadence_qspi_apb_indirect_read_execute
257 (plat, data_bytes, din);
260 case CQSPI_INDIRECT_WRITE:
261 err = cadence_qspi_apb_indirect_write_setup
262 (plat, priv->cmd_len, cmd_buf);
264 err = cadence_qspi_apb_indirect_write_execute
265 (plat, data_bytes, dout);
273 if (flags & SPI_XFER_END) {
274 /* clear command buffer */
275 memset(cmd_buf, 0, sizeof(priv->cmd_buf));
283 static int cadence_spi_ofdata_to_platdata(struct udevice *bus)
285 struct cadence_spi_platdata *plat = bus->platdata;
286 const void *blob = gd->fdt_blob;
287 int node = bus->of_offset;
292 /* 2 base addresses are needed, lets get them from the DT */
293 ret = fdtdec_get_int_array(blob, node, "reg", data, ARRAY_SIZE(data));
295 printf("Error: Can't get base addresses (ret=%d)!\n", ret);
299 plat->regbase = (void *)data[0];
300 plat->ahbbase = (void *)data[2];
302 /* All other paramters are embedded in the child node */
303 subnode = fdt_first_subnode(blob, node);
305 printf("Error: subnode with SPI flash config missing!\n");
309 /* Use 500 KHz as a suitable default */
310 plat->max_hz = fdtdec_get_uint(blob, subnode, "spi-max-frequency",
313 /* Read other parameters from DT */
314 plat->page_size = fdtdec_get_int(blob, subnode, "page-size", 256);
315 plat->block_size = fdtdec_get_int(blob, subnode, "block-size", 16);
316 plat->tshsl_ns = fdtdec_get_int(blob, subnode, "tshsl-ns", 200);
317 plat->tsd2d_ns = fdtdec_get_int(blob, subnode, "tsd2d-ns", 255);
318 plat->tchsh_ns = fdtdec_get_int(blob, subnode, "tchsh-ns", 20);
319 plat->tslch_ns = fdtdec_get_int(blob, subnode, "tslch-ns", 20);
320 plat->sram_size = fdtdec_get_int(blob, node, "sram-size", 128);
322 debug("%s: regbase=%p ahbbase=%p max-frequency=%d page-size=%d\n",
323 __func__, plat->regbase, plat->ahbbase, plat->max_hz,
329 static const struct dm_spi_ops cadence_spi_ops = {
330 .xfer = cadence_spi_xfer,
331 .set_speed = cadence_spi_set_speed,
332 .set_mode = cadence_spi_set_mode,
334 * cs_info is not needed, since we require all chip selects to be
335 * in the device tree explicitly
339 static const struct udevice_id cadence_spi_ids[] = {
340 { .compatible = "cadence,qspi" },
344 U_BOOT_DRIVER(cadence_spi) = {
345 .name = "cadence_spi",
347 .of_match = cadence_spi_ids,
348 .ops = &cadence_spi_ops,
349 .ofdata_to_platdata = cadence_spi_ofdata_to_platdata,
350 .platdata_auto_alloc_size = sizeof(struct cadence_spi_platdata),
351 .priv_auto_alloc_size = sizeof(struct cadence_spi_priv),
352 .probe = cadence_spi_probe,