2 * Copyright (C) 2017 Álvaro Fernández Rojas <noltari@gmail.com>
4 * Derived from linux/drivers/spi/spi-bcm63xx.c:
5 * Copyright (C) 2009-2012 Florian Fainelli <florian@openwrt.org>
6 * Copyright (C) 2010 Tanguy Bouzeloc <tanguy.bouzeloc@efixo.com>
8 * SPDX-License-Identifier: GPL-2.0+
19 DECLARE_GLOBAL_DATA_PTR
;
21 /* BCM6348 SPI core */
22 #define SPI_6348_CLK 0x06
23 #define SPI_6348_CMD 0x00
24 #define SPI_6348_CTL 0x40
25 #define SPI_6348_CTL_SHIFT 6
26 #define SPI_6348_FILL 0x07
27 #define SPI_6348_IR_MASK 0x04
28 #define SPI_6348_IR_STAT 0x02
29 #define SPI_6348_RX 0x80
30 #define SPI_6348_RX_SIZE 0x3f
31 #define SPI_6348_TX 0x41
32 #define SPI_6348_TX_SIZE 0x3f
34 /* BCM6358 SPI core */
35 #define SPI_6358_CLK 0x706
36 #define SPI_6358_CMD 0x700
37 #define SPI_6358_CTL 0x000
38 #define SPI_6358_CTL_SHIFT 14
39 #define SPI_6358_FILL 0x707
40 #define SPI_6358_IR_MASK 0x702
41 #define SPI_6358_IR_STAT 0x704
42 #define SPI_6358_RX 0x400
43 #define SPI_6358_RX_SIZE 0x220
44 #define SPI_6358_TX 0x002
45 #define SPI_6358_TX_SIZE 0x21e
47 /* SPI Clock register */
48 #define SPI_CLK_SHIFT 0
49 #define SPI_CLK_20MHZ (0 << SPI_CLK_SHIFT)
50 #define SPI_CLK_0_391MHZ (1 << SPI_CLK_SHIFT)
51 #define SPI_CLK_0_781MHZ (2 << SPI_CLK_SHIFT)
52 #define SPI_CLK_1_563MHZ (3 << SPI_CLK_SHIFT)
53 #define SPI_CLK_3_125MHZ (4 << SPI_CLK_SHIFT)
54 #define SPI_CLK_6_250MHZ (5 << SPI_CLK_SHIFT)
55 #define SPI_CLK_12_50MHZ (6 << SPI_CLK_SHIFT)
56 #define SPI_CLK_25MHZ (7 << SPI_CLK_SHIFT)
57 #define SPI_CLK_MASK (7 << SPI_CLK_SHIFT)
58 #define SPI_CLK_SSOFF_SHIFT 3
59 #define SPI_CLK_SSOFF_2 (2 << SPI_CLK_SSOFF_SHIFT)
60 #define SPI_CLK_SSOFF_MASK (7 << SPI_CLK_SSOFF_SHIFT)
61 #define SPI_CLK_BSWAP_SHIFT 7
62 #define SPI_CLK_BSWAP_MASK (1 << SPI_CLK_BSWAP_SHIFT)
64 /* SPI Command register */
65 #define SPI_CMD_OP_SHIFT 0
66 #define SPI_CMD_OP_START (0x3 << SPI_CMD_OP_SHIFT)
67 #define SPI_CMD_SLAVE_SHIFT 4
68 #define SPI_CMD_SLAVE_MASK (0xf << SPI_CMD_SLAVE_SHIFT)
69 #define SPI_CMD_PREPEND_SHIFT 8
70 #define SPI_CMD_PREPEND_BYTES 0xf
71 #define SPI_CMD_3WIRE_SHIFT 12
72 #define SPI_CMD_3WIRE_MASK (1 << SPI_CMD_3WIRE_SHIFT)
74 /* SPI Control register */
75 #define SPI_CTL_TYPE_FD_RW 0
76 #define SPI_CTL_TYPE_HD_W 1
77 #define SPI_CTL_TYPE_HD_R 2
79 /* SPI Interrupt registers */
80 #define SPI_IR_DONE_SHIFT 0
81 #define SPI_IR_DONE_MASK (1 << SPI_IR_DONE_SHIFT)
82 #define SPI_IR_RXOVER_SHIFT 1
83 #define SPI_IR_RXOVER_MASK (1 << SPI_IR_RXOVER_SHIFT)
84 #define SPI_IR_TXUNDER_SHIFT 2
85 #define SPI_IR_TXUNDER_MASK (1 << SPI_IR_TXUNDER_SHIFT)
86 #define SPI_IR_TXOVER_SHIFT 3
87 #define SPI_IR_TXOVER_MASK (1 << SPI_IR_TXOVER_SHIFT)
88 #define SPI_IR_RXUNDER_SHIFT 4
89 #define SPI_IR_RXUNDER_MASK (1 << SPI_IR_RXUNDER_SHIFT)
90 #define SPI_IR_CLEAR_MASK (SPI_IR_DONE_MASK |\
92 SPI_IR_TXUNDER_MASK |\
96 enum bcm63xx_regs_spi
{
110 struct bcm63xx_spi_priv
{
111 const unsigned long *regs
;
117 #define SPI_CLK_CNT 8
118 static const unsigned bcm63xx_spi_freq_table
[SPI_CLK_CNT
][2] = {
119 { 25000000, SPI_CLK_25MHZ
},
120 { 20000000, SPI_CLK_20MHZ
},
121 { 12500000, SPI_CLK_12_50MHZ
},
122 { 6250000, SPI_CLK_6_250MHZ
},
123 { 3125000, SPI_CLK_3_125MHZ
},
124 { 1563000, SPI_CLK_1_563MHZ
},
125 { 781000, SPI_CLK_0_781MHZ
},
126 { 391000, SPI_CLK_0_391MHZ
}
129 static int bcm63xx_spi_cs_info(struct udevice
*bus
, uint cs
,
130 struct spi_cs_info
*info
)
132 struct bcm63xx_spi_priv
*priv
= dev_get_priv(bus
);
134 if (cs
>= priv
->num_cs
) {
135 printf("no cs %u\n", cs
);
142 static int bcm63xx_spi_set_mode(struct udevice
*bus
, uint mode
)
144 struct bcm63xx_spi_priv
*priv
= dev_get_priv(bus
);
145 const unsigned long *regs
= priv
->regs
;
147 if (mode
& SPI_LSB_FIRST
)
148 setbits_8(priv
->base
+ regs
[SPI_CLK
], SPI_CLK_BSWAP_MASK
);
150 clrbits_8(priv
->base
+ regs
[SPI_CLK
], SPI_CLK_BSWAP_MASK
);
155 static int bcm63xx_spi_set_speed(struct udevice
*bus
, uint speed
)
157 struct bcm63xx_spi_priv
*priv
= dev_get_priv(bus
);
158 const unsigned long *regs
= priv
->regs
;
162 /* default to lowest clock configuration */
163 clk_cfg
= SPI_CLK_0_391MHZ
;
165 /* find the closest clock configuration */
166 for (i
= 0; i
< SPI_CLK_CNT
; i
++) {
167 if (speed
>= bcm63xx_spi_freq_table
[i
][0]) {
168 clk_cfg
= bcm63xx_spi_freq_table
[i
][1];
173 /* write clock configuration */
174 clrsetbits_8(priv
->base
+ regs
[SPI_CLK
],
175 SPI_CLK_SSOFF_MASK
| SPI_CLK_MASK
,
176 clk_cfg
| SPI_CLK_SSOFF_2
);
182 * BCM63xx SPI driver doesn't allow keeping CS active between transfers since
183 * they are HW controlled.
184 * However, it provides a mechanism to prepend write transfers prior to read
185 * transfers (with a maximum prepend of 15 bytes), which is usually enough for
186 * SPI-connected flashes since reading requires prepending a write transfer of
189 * This implementation takes advantage of the prepend mechanism and combines
190 * multiple transfers into a single one where possible (single/multiple write
191 * transfer(s) followed by a final read/write transfer).
192 * However, it's not possible to buffer reads, which means that read transfers
193 * should always be done as the final ones.
194 * On the other hand, take into account that combining write transfers into
195 * a single one is just buffering and doesn't require prepend mechanism.
197 static int bcm63xx_spi_xfer(struct udevice
*dev
, unsigned int bitlen
,
198 const void *dout
, void *din
, unsigned long flags
)
200 struct bcm63xx_spi_priv
*priv
= dev_get_priv(dev
->parent
);
201 const unsigned long *regs
= priv
->regs
;
202 size_t data_bytes
= bitlen
/ 8;
204 if (flags
& SPI_XFER_BEGIN
) {
208 /* initialize hardware */
209 writeb_be(0, priv
->base
+ regs
[SPI_IR_MASK
]);
213 /* buffering reads not possible since cs is hw controlled */
214 if (!(flags
& SPI_XFER_END
)) {
215 printf("unable to buffer reads\n");
220 if (data_bytes
> regs
[SPI_RX_SIZE
]) {
221 printf("max rx bytes exceeded\n");
228 if (priv
->tx_bytes
+ data_bytes
> regs
[SPI_TX_SIZE
]) {
229 printf("max tx bytes exceeded\n");
234 memcpy_toio(priv
->base
+ regs
[SPI_TX
] + priv
->tx_bytes
,
236 priv
->tx_bytes
+= data_bytes
;
239 if (flags
& SPI_XFER_END
) {
240 struct dm_spi_slave_platdata
*plat
=
241 dev_get_parent_platdata(dev
);
245 /* determine control config */
247 /* buffered write transfers */
248 val
= priv
->tx_bytes
;
249 val
|= (SPI_CTL_TYPE_HD_W
<< regs
[SPI_CTL_SHIFT
]);
252 if (dout
&& din
&& (flags
& SPI_XFER_ONCE
)) {
253 /* full duplex read/write */
255 val
|= (SPI_CTL_TYPE_FD_RW
<<
256 regs
[SPI_CTL_SHIFT
]);
259 /* prepended write transfer */
261 val
|= (SPI_CTL_TYPE_HD_R
<<
262 regs
[SPI_CTL_SHIFT
]);
263 if (priv
->tx_bytes
> SPI_CMD_PREPEND_BYTES
) {
264 printf("max prepend bytes exceeded\n");
270 if (regs
[SPI_CTL_SHIFT
] >= 8)
271 writew_be(val
, priv
->base
+ regs
[SPI_CTL
]);
273 writeb_be(val
, priv
->base
+ regs
[SPI_CTL
]);
275 /* clear interrupts */
276 writeb_be(SPI_IR_CLEAR_MASK
, priv
->base
+ regs
[SPI_IR_STAT
]);
278 /* issue the transfer */
279 cmd
= SPI_CMD_OP_START
;
280 cmd
|= (plat
->cs
<< SPI_CMD_SLAVE_SHIFT
) & SPI_CMD_SLAVE_MASK
;
281 cmd
|= (priv
->tx_bytes
<< SPI_CMD_PREPEND_SHIFT
);
282 if (plat
->mode
& SPI_3WIRE
)
283 cmd
|= SPI_CMD_3WIRE_MASK
;
284 writew_be(cmd
, priv
->base
+ regs
[SPI_CMD
]);
286 /* enable interrupts */
287 writeb_be(SPI_IR_DONE_MASK
, priv
->base
+ regs
[SPI_IR_MASK
]);
289 ret
= wait_for_bit_8(priv
->base
+ regs
[SPI_IR_STAT
],
290 SPI_IR_DONE_MASK
, true, 1000, false);
292 printf("interrupt timeout\n");
298 memcpy_fromio(din
, priv
->base
+ regs
[SPI_RX
],
305 static const struct dm_spi_ops bcm63xx_spi_ops
= {
306 .cs_info
= bcm63xx_spi_cs_info
,
307 .set_mode
= bcm63xx_spi_set_mode
,
308 .set_speed
= bcm63xx_spi_set_speed
,
309 .xfer
= bcm63xx_spi_xfer
,
312 static const unsigned long bcm6348_spi_regs
[] = {
313 [SPI_CLK
] = SPI_6348_CLK
,
314 [SPI_CMD
] = SPI_6348_CMD
,
315 [SPI_CTL
] = SPI_6348_CTL
,
316 [SPI_CTL_SHIFT
] = SPI_6348_CTL_SHIFT
,
317 [SPI_FILL
] = SPI_6348_FILL
,
318 [SPI_IR_MASK
] = SPI_6348_IR_MASK
,
319 [SPI_IR_STAT
] = SPI_6348_IR_STAT
,
320 [SPI_RX
] = SPI_6348_RX
,
321 [SPI_RX_SIZE
] = SPI_6348_RX_SIZE
,
322 [SPI_TX
] = SPI_6348_TX
,
323 [SPI_TX_SIZE
] = SPI_6348_TX_SIZE
,
326 static const unsigned long bcm6358_spi_regs
[] = {
327 [SPI_CLK
] = SPI_6358_CLK
,
328 [SPI_CMD
] = SPI_6358_CMD
,
329 [SPI_CTL
] = SPI_6358_CTL
,
330 [SPI_CTL_SHIFT
] = SPI_6358_CTL_SHIFT
,
331 [SPI_FILL
] = SPI_6358_FILL
,
332 [SPI_IR_MASK
] = SPI_6358_IR_MASK
,
333 [SPI_IR_STAT
] = SPI_6358_IR_STAT
,
334 [SPI_RX
] = SPI_6358_RX
,
335 [SPI_RX_SIZE
] = SPI_6358_RX_SIZE
,
336 [SPI_TX
] = SPI_6358_TX
,
337 [SPI_TX_SIZE
] = SPI_6358_TX_SIZE
,
340 static const struct udevice_id bcm63xx_spi_ids
[] = {
342 .compatible
= "brcm,bcm6348-spi",
343 .data
= (ulong
)&bcm6348_spi_regs
,
345 .compatible
= "brcm,bcm6358-spi",
346 .data
= (ulong
)&bcm6358_spi_regs
,
347 }, { /* sentinel */ }
350 static int bcm63xx_spi_child_pre_probe(struct udevice
*dev
)
352 struct bcm63xx_spi_priv
*priv
= dev_get_priv(dev
->parent
);
353 const unsigned long *regs
= priv
->regs
;
354 struct spi_slave
*slave
= dev_get_parent_priv(dev
);
355 struct dm_spi_slave_platdata
*plat
= dev_get_parent_platdata(dev
);
358 if (plat
->cs
>= priv
->num_cs
) {
359 printf("no cs %u\n", plat
->cs
);
363 /* max read/write sizes */
364 slave
->max_read_size
= regs
[SPI_RX_SIZE
];
365 slave
->max_write_size
= regs
[SPI_TX_SIZE
];
370 static int bcm63xx_spi_probe(struct udevice
*dev
)
372 struct bcm63xx_spi_priv
*priv
= dev_get_priv(dev
);
373 const unsigned long *regs
=
374 (const unsigned long *)dev_get_driver_data(dev
);
375 struct reset_ctl rst_ctl
;
381 addr
= devfdt_get_addr_size_index(dev
, 0, &size
);
382 if (addr
== FDT_ADDR_T_NONE
)
386 priv
->base
= ioremap(addr
, size
);
387 priv
->num_cs
= fdtdec_get_uint(gd
->fdt_blob
, dev_of_offset(dev
),
391 ret
= clk_get_by_index(dev
, 0, &clk
);
395 ret
= clk_enable(&clk
);
399 ret
= clk_free(&clk
);
404 ret
= reset_get_by_index(dev
, 0, &rst_ctl
);
408 ret
= reset_deassert(&rst_ctl
);
412 ret
= reset_free(&rst_ctl
);
416 /* initialize hardware */
417 writeb_be(0, priv
->base
+ regs
[SPI_IR_MASK
]);
419 /* set fill register */
420 writeb_be(0xff, priv
->base
+ regs
[SPI_FILL
]);
425 U_BOOT_DRIVER(bcm63xx_spi
) = {
426 .name
= "bcm63xx_spi",
428 .of_match
= bcm63xx_spi_ids
,
429 .ops
= &bcm63xx_spi_ops
,
430 .priv_auto_alloc_size
= sizeof(struct bcm63xx_spi_priv
),
431 .child_pre_probe
= bcm63xx_spi_child_pre_probe
,
432 .probe
= bcm63xx_spi_probe
,