]> git.karo-electronics.de Git - karo-tx-uboot.git/blob - drivers/spi/ti_qspi.c
1e2c432ede66b04b13a4991acd8de16531cedd50
[karo-tx-uboot.git] / drivers / spi / ti_qspi.c
1 /*
2  * TI QSPI driver
3  *
4  * Copyright (C) 2013, Texas Instruments, Incorporated
5  *
6  * SPDX-License-Identifier: GPL-2.0+
7  */
8
9 #include <common.h>
10 #include <asm/io.h>
11 #include <asm/arch/omap.h>
12 #include <malloc.h>
13 #include <spi.h>
14 #include <dm.h>
15 #include <asm/gpio.h>
16 #include <asm/omap_gpio.h>
17 #include <asm/omap_common.h>
18 #include <asm/ti-common/ti-edma3.h>
19
20 DECLARE_GLOBAL_DATA_PTR;
21
22 /* ti qpsi register bit masks */
23 #define QSPI_TIMEOUT                    2000000
24 #define QSPI_FCLK                       192000000
25 #define QSPI_DRA7XX_FCLK                76800000
26 #define QSPI_WLEN_MAX_BITS              128
27 #define QSPI_WLEN_MAX_BYTES             (QSPI_WLEN_MAX_BITS >> 3)
28 #define QSPI_WLEN_MASK                  QSPI_WLEN(QSPI_WLEN_MAX_BITS)
29 /* clock control */
30 #define QSPI_CLK_EN                     BIT(31)
31 #define QSPI_CLK_DIV_MAX                0xffff
32 /* command */
33 #define QSPI_EN_CS(n)                   (n << 28)
34 #define QSPI_WLEN(n)                    ((n-1) << 19)
35 #define QSPI_3_PIN                      BIT(18)
36 #define QSPI_RD_SNGL                    BIT(16)
37 #define QSPI_WR_SNGL                    (2 << 16)
38 #define QSPI_INVAL                      (4 << 16)
39 #define QSPI_RD_QUAD                    (7 << 16)
40 /* device control */
41 #define QSPI_DD(m, n)                   (m << (3 + n*8))
42 #define QSPI_CKPHA(n)                   (1 << (2 + n*8))
43 #define QSPI_CSPOL(n)                   (1 << (1 + n*8))
44 #define QSPI_CKPOL(n)                   (1 << (n*8))
45 /* status */
46 #define QSPI_WC                         BIT(1)
47 #define QSPI_BUSY                       BIT(0)
48 #define QSPI_WC_BUSY                    (QSPI_WC | QSPI_BUSY)
49 #define QSPI_XFER_DONE                  QSPI_WC
50 #define MM_SWITCH                       0x01
51 #define MEM_CS(cs)                      ((cs + 1) << 8)
52 #define MEM_CS_UNSELECT                 0xfffff8ff
53 #define MMAP_START_ADDR_DRA             0x5c000000
54 #define MMAP_START_ADDR_AM43x           0x30000000
55 #define CORE_CTRL_IO                    0x4a002558
56
57 #define QSPI_CMD_READ                   (0x3 << 0)
58 #define QSPI_CMD_READ_DUAL              (0x6b << 0)
59 #define QSPI_CMD_READ_QUAD              (0x6c << 0)
60 #define QSPI_CMD_READ_FAST              (0x0b << 0)
61 #define QSPI_SETUP0_NUM_A_BYTES         (0x3 << 8)
62 #define QSPI_SETUP0_NUM_D_BYTES_NO_BITS (0x0 << 10)
63 #define QSPI_SETUP0_NUM_D_BYTES_8_BITS  (0x1 << 10)
64 #define QSPI_SETUP0_READ_NORMAL         (0x0 << 12)
65 #define QSPI_SETUP0_READ_DUAL           (0x1 << 12)
66 #define QSPI_SETUP0_READ_QUAD           (0x3 << 12)
67 #define QSPI_CMD_WRITE                  (0x12 << 16)
68 #define QSPI_NUM_DUMMY_BITS             (0x0 << 24)
69
70 /* ti qspi register set */
71 struct ti_qspi_regs {
72         u32 pid;
73         u32 pad0[3];
74         u32 sysconfig;
75         u32 pad1[3];
76         u32 int_stat_raw;
77         u32 int_stat_en;
78         u32 int_en_set;
79         u32 int_en_ctlr;
80         u32 intc_eoi;
81         u32 pad2[3];
82         u32 clk_ctrl;
83         u32 dc;
84         u32 cmd;
85         u32 status;
86         u32 data;
87         u32 setup0;
88         u32 setup1;
89         u32 setup2;
90         u32 setup3;
91         u32 memswitch;
92         u32 data1;
93         u32 data2;
94         u32 data3;
95 };
96
97 /* ti qspi priv */
98 struct ti_qspi_priv {
99 #ifndef CONFIG_DM_SPI
100         struct spi_slave slave;
101 #else
102         void *memory_map;
103         uint max_hz;
104         u32 num_cs;
105 #endif
106         struct ti_qspi_regs *base;
107         void *ctrl_mod_mmap;
108         ulong fclk;
109         unsigned int mode;
110         u32 cmd;
111         u32 dc;
112 };
113
114 static void ti_spi_set_speed(struct ti_qspi_priv *priv, uint hz)
115 {
116         uint clk_div;
117
118         if (!hz)
119                 clk_div = 0;
120         else
121                 clk_div = (priv->fclk / hz) - 1;
122
123         debug("ti_spi_set_speed: hz: %d, clock divider %d\n", hz, clk_div);
124
125         /* disable SCLK */
126         writel(readl(&priv->base->clk_ctrl) & ~QSPI_CLK_EN,
127                &priv->base->clk_ctrl);
128
129         /* assign clk_div values */
130         if (clk_div < 0)
131                 clk_div = 0;
132         else if (clk_div > QSPI_CLK_DIV_MAX)
133                 clk_div = QSPI_CLK_DIV_MAX;
134
135         /* enable SCLK */
136         writel(QSPI_CLK_EN | clk_div, &priv->base->clk_ctrl);
137 }
138
139 static void ti_qspi_cs_deactivate(struct ti_qspi_priv *priv)
140 {
141         writel(priv->cmd | QSPI_INVAL, &priv->base->cmd);
142         /* dummy readl to ensure bus sync */
143         readl(&priv->base->cmd);
144 }
145
146 static int __ti_qspi_set_mode(struct ti_qspi_priv *priv, unsigned int mode)
147 {
148         priv->dc = 0;
149         if (mode & SPI_CPHA)
150                 priv->dc |= QSPI_CKPHA(0);
151         if (mode & SPI_CPOL)
152                 priv->dc |= QSPI_CKPOL(0);
153         if (mode & SPI_CS_HIGH)
154                 priv->dc |= QSPI_CSPOL(0);
155
156         return 0;
157 }
158
159 static int __ti_qspi_claim_bus(struct ti_qspi_priv *priv, int cs)
160 {
161         writel(priv->dc, &priv->base->dc);
162         writel(0, &priv->base->cmd);
163         writel(0, &priv->base->data);
164
165         priv->dc <<= cs * 8;
166         writel(priv->dc, &priv->base->dc);
167
168         return 0;
169 }
170
171 static void __ti_qspi_release_bus(struct ti_qspi_priv *priv)
172 {
173         writel(0, &priv->base->dc);
174         writel(0, &priv->base->cmd);
175         writel(0, &priv->base->data);
176 }
177
178 static void ti_qspi_ctrl_mode_mmap(void *ctrl_mod_mmap, int cs, bool enable)
179 {
180         u32 val;
181
182         val = readl(ctrl_mod_mmap);
183         if (enable)
184                 val |= MEM_CS(cs);
185         else
186                 val &= MEM_CS_UNSELECT;
187         writel(val, ctrl_mod_mmap);
188 }
189
190 static int __ti_qspi_xfer(struct ti_qspi_priv *priv, unsigned int bitlen,
191                         const void *dout, void *din, unsigned long flags,
192                         u32 cs)
193 {
194         uint words = bitlen >> 3; /* fixed 8-bit word length */
195         const uchar *txp = dout;
196         uchar *rxp = din;
197         uint status;
198         int timeout;
199
200         /* Setup mmap flags */
201         if (flags & SPI_XFER_MMAP) {
202                 writel(MM_SWITCH, &priv->base->memswitch);
203                 if (priv->ctrl_mod_mmap)
204                         ti_qspi_ctrl_mode_mmap(priv->ctrl_mod_mmap, cs, true);
205                 return 0;
206         } else if (flags & SPI_XFER_MMAP_END) {
207                 writel(~MM_SWITCH, &priv->base->memswitch);
208                 if (priv->ctrl_mod_mmap)
209                         ti_qspi_ctrl_mode_mmap(priv->ctrl_mod_mmap, cs, false);
210                 return 0;
211         }
212
213         if (bitlen == 0)
214                 return -1;
215
216         if (bitlen % 8) {
217                 debug("spi_xfer: Non byte aligned SPI transfer\n");
218                 return -1;
219         }
220
221         /* Setup command reg */
222         priv->cmd = 0;
223         priv->cmd |= QSPI_WLEN(8);
224         priv->cmd |= QSPI_EN_CS(cs);
225         if (priv->mode & SPI_3WIRE)
226                 priv->cmd |= QSPI_3_PIN;
227         priv->cmd |= 0xfff;
228
229 /* FIXME: This delay is required for successfull
230  * completion of read/write/erase. Once its root
231  * caused, it will be remove from the driver.
232  */
233 #ifdef CONFIG_AM43XX
234         udelay(100);
235 #endif
236         while (words) {
237                 u8 xfer_len = 0;
238
239                 if (txp) {
240                         u32 cmd = priv->cmd;
241
242                         if (words >= QSPI_WLEN_MAX_BYTES) {
243                                 u32 *txbuf = (u32 *)txp;
244                                 u32 data;
245
246                                 data = cpu_to_be32(*txbuf++);
247                                 writel(data, &priv->base->data3);
248                                 data = cpu_to_be32(*txbuf++);
249                                 writel(data, &priv->base->data2);
250                                 data = cpu_to_be32(*txbuf++);
251                                 writel(data, &priv->base->data1);
252                                 data = cpu_to_be32(*txbuf++);
253                                 writel(data, &priv->base->data);
254                                 cmd &= ~QSPI_WLEN_MASK;
255                                 cmd |= QSPI_WLEN(QSPI_WLEN_MAX_BITS);
256                                 xfer_len = QSPI_WLEN_MAX_BYTES;
257                         } else {
258                                 writeb(*txp, &priv->base->data);
259                                 xfer_len = 1;
260                         }
261                         debug("tx cmd %08x dc %08x\n",
262                               cmd | QSPI_WR_SNGL, priv->dc);
263                         writel(cmd | QSPI_WR_SNGL, &priv->base->cmd);
264                         status = readl(&priv->base->status);
265                         timeout = QSPI_TIMEOUT;
266                         while ((status & QSPI_WC_BUSY) != QSPI_XFER_DONE) {
267                                 if (--timeout < 0) {
268                                         printf("spi_xfer: TX timeout!\n");
269                                         return -1;
270                                 }
271                                 status = readl(&priv->base->status);
272                         }
273                         txp += xfer_len;
274                         debug("tx done, status %08x\n", status);
275                 }
276                 if (rxp) {
277                         debug("rx cmd %08x dc %08x\n",
278                               ((u32)(priv->cmd | QSPI_RD_SNGL)), priv->dc);
279                         writel(priv->cmd | QSPI_RD_SNGL, &priv->base->cmd);
280                         status = readl(&priv->base->status);
281                         timeout = QSPI_TIMEOUT;
282                         while ((status & QSPI_WC_BUSY) != QSPI_XFER_DONE) {
283                                 if (--timeout < 0) {
284                                         printf("spi_xfer: RX timeout!\n");
285                                         return -1;
286                                 }
287                                 status = readl(&priv->base->status);
288                         }
289                         *rxp++ = readl(&priv->base->data);
290                         xfer_len = 1;
291                         debug("rx done, status %08x, read %02x\n",
292                               status, *(rxp-1));
293                 }
294                 words -= xfer_len;
295         }
296
297         /* Terminate frame */
298         if (flags & SPI_XFER_END)
299                 ti_qspi_cs_deactivate(priv);
300
301         return 0;
302 }
303
304 /* TODO: control from sf layer to here through dm-spi */
305 #if defined(CONFIG_TI_EDMA3) && !defined(CONFIG_DMA)
306 void spi_flash_copy_mmap(void *data, void *offset, size_t len)
307 {
308         unsigned int                    addr = (unsigned int) (data);
309         unsigned int                    edma_slot_num = 1;
310
311         /* Invalidate the area, so no writeback into the RAM races with DMA */
312         invalidate_dcache_range(addr, addr + roundup(len, ARCH_DMA_MINALIGN));
313
314         /* enable edma3 clocks */
315         enable_edma3_clocks();
316
317         /* Call edma3 api to do actual DMA transfer     */
318         edma3_transfer(EDMA3_BASE, edma_slot_num, data, offset, len);
319
320         /* disable edma3 clocks */
321         disable_edma3_clocks();
322
323         *((unsigned int *)offset) += len;
324 }
325 #endif
326
327 #ifndef CONFIG_DM_SPI
328
329 static inline struct ti_qspi_priv *to_ti_qspi_priv(struct spi_slave *slave)
330 {
331         return container_of(slave, struct ti_qspi_priv, slave);
332 }
333
334 int spi_cs_is_valid(unsigned int bus, unsigned int cs)
335 {
336         return 1;
337 }
338
339 void spi_cs_activate(struct spi_slave *slave)
340 {
341         /* CS handled in xfer */
342         return;
343 }
344
345 void spi_cs_deactivate(struct spi_slave *slave)
346 {
347         struct ti_qspi_priv *priv = to_ti_qspi_priv(slave);
348         ti_qspi_cs_deactivate(priv);
349 }
350
351 void spi_init(void)
352 {
353         /* nothing to do */
354 }
355
356 static void ti_spi_setup_spi_register(struct ti_qspi_priv *priv)
357 {
358         u32 memval = 0;
359
360 #ifdef CONFIG_QSPI_QUAD_SUPPORT
361         struct spi_slave *slave = &priv->slave;
362         memval |= (QSPI_CMD_READ_QUAD | QSPI_SETUP0_NUM_A_BYTES |
363                         QSPI_SETUP0_NUM_D_BYTES_8_BITS |
364                         QSPI_SETUP0_READ_QUAD | QSPI_CMD_WRITE |
365                         QSPI_NUM_DUMMY_BITS);
366         slave->mode_rx = SPI_RX_QUAD;
367 #else
368         memval |= QSPI_CMD_READ | QSPI_SETUP0_NUM_A_BYTES |
369                         QSPI_SETUP0_NUM_D_BYTES_NO_BITS |
370                         QSPI_SETUP0_READ_NORMAL | QSPI_CMD_WRITE |
371                         QSPI_NUM_DUMMY_BITS;
372 #endif
373
374         writel(memval, &priv->base->setup0);
375 }
376
377 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
378                                   unsigned int max_hz, unsigned int mode)
379 {
380         struct ti_qspi_priv *priv;
381
382 #ifdef CONFIG_AM43XX
383         gpio_request(CONFIG_QSPI_SEL_GPIO, "qspi_gpio");
384         gpio_direction_output(CONFIG_QSPI_SEL_GPIO, 1);
385 #endif
386
387         priv = spi_alloc_slave(struct ti_qspi_priv, bus, cs);
388         if (!priv) {
389                 printf("SPI_error: Fail to allocate ti_qspi_priv\n");
390                 return NULL;
391         }
392
393         priv->base = (struct ti_qspi_regs *)QSPI_BASE;
394         priv->mode = mode;
395 #if defined(CONFIG_DRA7XX) || defined(CONFIG_AM57XX)
396         priv->ctrl_mod_mmap = (void *)CORE_CTRL_IO;
397         priv->slave.memory_map = (void *)MMAP_START_ADDR_DRA;
398         priv->fclk = QSPI_DRA7XX_FCLK;
399 #else
400         priv->slave.memory_map = (void *)MMAP_START_ADDR_AM43x;
401         priv->fclk = QSPI_FCLK;
402 #endif
403
404         ti_spi_set_speed(priv, max_hz);
405
406 #ifdef CONFIG_TI_SPI_MMAP
407         ti_spi_setup_spi_register(priv);
408 #endif
409
410         return &priv->slave;
411 }
412
413 void spi_free_slave(struct spi_slave *slave)
414 {
415         struct ti_qspi_priv *priv = to_ti_qspi_priv(slave);
416         free(priv);
417 }
418
419 int spi_claim_bus(struct spi_slave *slave)
420 {
421         struct ti_qspi_priv *priv = to_ti_qspi_priv(slave);
422
423         debug("%s: bus:%i cs:%i\n", __func__, priv->slave.bus, priv->slave.cs);
424         __ti_qspi_set_mode(priv, priv->mode);
425         return __ti_qspi_claim_bus(priv, priv->slave.cs);
426 }
427 void spi_release_bus(struct spi_slave *slave)
428 {
429         struct ti_qspi_priv *priv = to_ti_qspi_priv(slave);
430
431         debug("%s: bus:%i cs:%i\n", __func__, priv->slave.bus, priv->slave.cs);
432         __ti_qspi_release_bus(priv);
433 }
434
435 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
436              void *din, unsigned long flags)
437 {
438         struct ti_qspi_priv *priv = to_ti_qspi_priv(slave);
439
440         debug("spi_xfer: bus:%i cs:%i bitlen:%i flags:%lx\n",
441               priv->slave.bus, priv->slave.cs, bitlen, flags);
442         return __ti_qspi_xfer(priv, bitlen, dout, din, flags, priv->slave.cs);
443 }
444
445 #else /* CONFIG_DM_SPI */
446
447 static void __ti_qspi_setup_memorymap(struct ti_qspi_priv *priv,
448                                       struct spi_slave *slave,
449                                       bool enable)
450 {
451         u32 memval;
452         u32 mode = slave->mode_rx & (SPI_RX_QUAD | SPI_RX_DUAL);
453
454         if (!enable) {
455                 writel(0, &priv->base->setup0);
456                 return;
457         }
458
459         memval = QSPI_SETUP0_NUM_A_BYTES | QSPI_CMD_WRITE | QSPI_NUM_DUMMY_BITS;
460
461         switch (mode) {
462         case SPI_RX_QUAD:
463                 memval |= QSPI_CMD_READ_QUAD;
464                 memval |= QSPI_SETUP0_NUM_D_BYTES_8_BITS;
465                 memval |= QSPI_SETUP0_READ_QUAD;
466                 slave->mode_rx = SPI_RX_QUAD;
467                 break;
468         case SPI_RX_DUAL:
469                 memval |= QSPI_CMD_READ_DUAL;
470                 memval |= QSPI_SETUP0_NUM_D_BYTES_8_BITS;
471                 memval |= QSPI_SETUP0_READ_DUAL;
472                 break;
473         default:
474                 memval |= QSPI_CMD_READ;
475                 memval |= QSPI_SETUP0_NUM_D_BYTES_NO_BITS;
476                 memval |= QSPI_SETUP0_READ_NORMAL;
477                 break;
478         }
479
480         writel(memval, &priv->base->setup0);
481 }
482
483
484 static int ti_qspi_set_speed(struct udevice *bus, uint max_hz)
485 {
486         struct ti_qspi_priv *priv = dev_get_priv(bus);
487
488         ti_spi_set_speed(priv, max_hz);
489
490         return 0;
491 }
492
493 static int ti_qspi_set_mode(struct udevice *bus, uint mode)
494 {
495         struct ti_qspi_priv *priv = dev_get_priv(bus);
496         return __ti_qspi_set_mode(priv, mode);
497 }
498
499 static int ti_qspi_claim_bus(struct udevice *dev)
500 {
501         struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
502         struct spi_slave *slave = dev_get_parent_priv(dev);
503         struct ti_qspi_priv *priv;
504         struct udevice *bus;
505
506         bus = dev->parent;
507         priv = dev_get_priv(bus);
508
509         if (slave_plat->cs > priv->num_cs) {
510                 debug("invalid qspi chip select\n");
511                 return -EINVAL;
512         }
513
514         __ti_qspi_setup_memorymap(priv, slave, true);
515
516         return __ti_qspi_claim_bus(priv, slave_plat->cs);
517 }
518
519 static int ti_qspi_release_bus(struct udevice *dev)
520 {
521         struct spi_slave *slave = dev_get_parent_priv(dev);
522         struct ti_qspi_priv *priv;
523         struct udevice *bus;
524
525         bus = dev->parent;
526         priv = dev_get_priv(bus);
527
528         __ti_qspi_setup_memorymap(priv, slave, false);
529         __ti_qspi_release_bus(priv);
530
531         return 0;
532 }
533
534 static int ti_qspi_xfer(struct udevice *dev, unsigned int bitlen,
535                         const void *dout, void *din, unsigned long flags)
536 {
537         struct dm_spi_slave_platdata *slave = dev_get_parent_platdata(dev);
538         struct ti_qspi_priv *priv;
539         struct udevice *bus;
540
541         bus = dev->parent;
542         priv = dev_get_priv(bus);
543
544         if (slave->cs > priv->num_cs) {
545                 debug("invalid qspi chip select\n");
546                 return -EINVAL;
547         }
548
549         return __ti_qspi_xfer(priv, bitlen, dout, din, flags, slave->cs);
550 }
551
552 static int ti_qspi_probe(struct udevice *bus)
553 {
554         struct ti_qspi_priv *priv = dev_get_priv(bus);
555
556         priv->fclk = dev_get_driver_data(bus);
557
558         return 0;
559 }
560
561 static int ti_qspi_ofdata_to_platdata(struct udevice *bus)
562 {
563         struct ti_qspi_priv *priv = dev_get_priv(bus);
564         const void *blob = gd->fdt_blob;
565         int node = bus->of_offset;
566         fdt_addr_t addr;
567         void *mmap;
568
569         priv->base = map_physmem(dev_get_addr(bus), sizeof(struct ti_qspi_regs),
570                                  MAP_NOCACHE);
571         priv->memory_map = map_physmem(dev_get_addr_index(bus, 1), 0,
572                                        MAP_NOCACHE);
573         addr = dev_get_addr_index(bus, 2);
574         mmap = map_physmem(dev_get_addr_index(bus, 2), 0, MAP_NOCACHE);
575         priv->ctrl_mod_mmap = (addr == FDT_ADDR_T_NONE) ? NULL : mmap;
576
577         priv->max_hz = fdtdec_get_int(blob, node, "spi-max-frequency", -1);
578         if (priv->max_hz < 0) {
579                 debug("Error: Max frequency missing\n");
580                 return -ENODEV;
581         }
582         priv->num_cs = fdtdec_get_int(blob, node, "num-cs", 4);
583
584         debug("%s: regs=<0x%x>, max-frequency=%d\n", __func__,
585               (int)priv->base, priv->max_hz);
586
587         return 0;
588 }
589
590 static int ti_qspi_child_pre_probe(struct udevice *dev)
591 {
592         struct spi_slave *slave = dev_get_parent_priv(dev);
593         struct udevice *bus = dev_get_parent(dev);
594         struct ti_qspi_priv *priv = dev_get_priv(bus);
595
596         slave->memory_map = priv->memory_map;
597         return 0;
598 }
599
600 static const struct dm_spi_ops ti_qspi_ops = {
601         .claim_bus      = ti_qspi_claim_bus,
602         .release_bus    = ti_qspi_release_bus,
603         .xfer           = ti_qspi_xfer,
604         .set_speed      = ti_qspi_set_speed,
605         .set_mode       = ti_qspi_set_mode,
606 };
607
608 static const struct udevice_id ti_qspi_ids[] = {
609         { .compatible = "ti,dra7xxx-qspi",      .data = QSPI_DRA7XX_FCLK},
610         { .compatible = "ti,am4372-qspi",       .data = QSPI_FCLK},
611         { }
612 };
613
614 U_BOOT_DRIVER(ti_qspi) = {
615         .name   = "ti_qspi",
616         .id     = UCLASS_SPI,
617         .of_match = ti_qspi_ids,
618         .ops    = &ti_qspi_ops,
619         .ofdata_to_platdata = ti_qspi_ofdata_to_platdata,
620         .priv_auto_alloc_size = sizeof(struct ti_qspi_priv),
621         .probe  = ti_qspi_probe,
622         .child_pre_probe = ti_qspi_child_pre_probe,
623 };
624 #endif /* CONFIG_DM_SPI */