1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2018 Álvaro Fernández Rojas <noltari@gmail.com>
5 * Derived from linux/drivers/dma/bcm63xx-iudma.c:
6 * Copyright (C) 2015 Simon Arlott <simon@fire.lp0.eu>
8 * Derived from linux/drivers/net/ethernet/broadcom/bcm63xx_enet.c:
9 * Copyright (C) 2008 Maxime Bizon <mbizon@freebox.fr>
11 * Derived from bcm963xx_4.12L.06B_consumer/shared/opensource/include/bcm963xx/63268_map_part.h:
12 * Copyright (C) 2000-2010 Broadcom Corporation
14 * Derived from bcm963xx_4.12L.06B_consumer/bcmdrivers/opensource/net/enet/impl4/bcmenet.c:
15 * Copyright (C) 2010 Broadcom Corporation
22 #include <dma-uclass.h>
32 #define DMA_CHAN_FLOWC(x) ((x) >> 1)
33 #define DMA_CHAN_MAX 16
34 #define DMA_CHAN_SIZE 0x10
35 #define DMA_CHAN_TOUT 500
37 /* DMA Global Configuration register */
38 #define DMA_CFG_REG 0x00
39 #define DMA_CFG_ENABLE_SHIFT 0
40 #define DMA_CFG_ENABLE_MASK (1 << DMA_CFG_ENABLE_SHIFT)
41 #define DMA_CFG_FLOWC_ENABLE(x) BIT(DMA_CHAN_FLOWC(x) + 1)
42 #define DMA_CFG_NCHANS_SHIFT 24
43 #define DMA_CFG_NCHANS_MASK (0xf << DMA_CFG_NCHANS_SHIFT)
45 /* DMA Global Flow Control registers */
46 #define DMA_FLOWC_THR_LO_REG(x) (0x04 + DMA_CHAN_FLOWC(x) * 0x0c)
47 #define DMA_FLOWC_THR_HI_REG(x) (0x08 + DMA_CHAN_FLOWC(x) * 0x0c)
48 #define DMA_FLOWC_ALLOC_REG(x) (0x0c + DMA_CHAN_FLOWC(x) * 0x0c)
49 #define DMA_FLOWC_ALLOC_FORCE_SHIFT 31
50 #define DMA_FLOWC_ALLOC_FORCE_MASK (1 << DMA_FLOWC_ALLOC_FORCE_SHIFT)
52 /* DMA Global Reset register */
53 #define DMA_RST_REG 0x34
54 #define DMA_RST_CHAN_SHIFT 0
55 #define DMA_RST_CHAN_MASK(x) (1 << x)
57 /* DMA Channel Configuration register */
58 #define DMAC_CFG_REG(x) (DMA_CHAN_SIZE * (x) + 0x00)
59 #define DMAC_CFG_ENABLE_SHIFT 0
60 #define DMAC_CFG_ENABLE_MASK (1 << DMAC_CFG_ENABLE_SHIFT)
61 #define DMAC_CFG_PKT_HALT_SHIFT 1
62 #define DMAC_CFG_PKT_HALT_MASK (1 << DMAC_CFG_PKT_HALT_SHIFT)
63 #define DMAC_CFG_BRST_HALT_SHIFT 2
64 #define DMAC_CFG_BRST_HALT_MASK (1 << DMAC_CFG_BRST_HALT_SHIFT)
66 /* DMA Channel Max Burst Length register */
67 #define DMAC_BURST_REG(x) (DMA_CHAN_SIZE * (x) + 0x0c)
69 /* DMA SRAM Descriptor Ring Start register */
70 #define DMAS_RSTART_REG(x) (DMA_CHAN_SIZE * (x) + 0x00)
72 /* DMA SRAM State/Bytes done/ring offset register */
73 #define DMAS_STATE_DATA_REG(x) (DMA_CHAN_SIZE * (x) + 0x04)
75 /* DMA SRAM Buffer Descriptor status and length register */
76 #define DMAS_DESC_LEN_STATUS_REG(x) (DMA_CHAN_SIZE * (x) + 0x08)
78 /* DMA SRAM Buffer Descriptor status and length register */
79 #define DMAS_DESC_BASE_BUFPTR_REG(x) (DMA_CHAN_SIZE * (x) + 0x0c)
81 /* DMA Descriptor Status */
82 #define DMAD_ST_CRC_SHIFT 8
83 #define DMAD_ST_CRC_MASK (1 << DMAD_ST_CRC_SHIFT)
84 #define DMAD_ST_WRAP_SHIFT 12
85 #define DMAD_ST_WRAP_MASK (1 << DMAD_ST_WRAP_SHIFT)
86 #define DMAD_ST_SOP_SHIFT 13
87 #define DMAD_ST_SOP_MASK (1 << DMAD_ST_SOP_SHIFT)
88 #define DMAD_ST_EOP_SHIFT 14
89 #define DMAD_ST_EOP_MASK (1 << DMAD_ST_EOP_SHIFT)
90 #define DMAD_ST_OWN_SHIFT 15
91 #define DMAD_ST_OWN_MASK (1 << DMAD_ST_OWN_SHIFT)
93 #define DMAD6348_ST_OV_ERR_SHIFT 0
94 #define DMAD6348_ST_OV_ERR_MASK (1 << DMAD6348_ST_OV_ERR_SHIFT)
95 #define DMAD6348_ST_CRC_ERR_SHIFT 1
96 #define DMAD6348_ST_CRC_ERR_MASK (1 << DMAD6348_ST_CRC_ERR_SHIFT)
97 #define DMAD6348_ST_RX_ERR_SHIFT 2
98 #define DMAD6348_ST_RX_ERR_MASK (1 << DMAD6348_ST_RX_ERR_SHIFT)
99 #define DMAD6348_ST_OS_ERR_SHIFT 4
100 #define DMAD6348_ST_OS_ERR_MASK (1 << DMAD6348_ST_OS_ERR_SHIFT)
101 #define DMAD6348_ST_UN_ERR_SHIFT 9
102 #define DMAD6348_ST_UN_ERR_MASK (1 << DMAD6348_ST_UN_ERR_SHIFT)
104 struct bcm6348_dma_desc {
110 struct bcm6348_chan_priv {
111 void __iomem *dma_ring;
112 uint8_t dma_ring_size;
119 struct bcm6348_iudma_hw {
123 struct bcm6348_iudma_priv {
124 const struct bcm6348_iudma_hw *hw;
128 struct bcm6348_chan_priv **ch_priv;
132 static inline bool bcm6348_iudma_chan_is_rx(uint8_t ch)
137 static inline void bcm6348_iudma_fdc(void *ptr, ulong size)
139 ulong start = (ulong) ptr;
141 flush_dcache_range(start, start + size);
144 static inline void bcm6348_iudma_idc(void *ptr, ulong size)
146 ulong start = (ulong) ptr;
148 invalidate_dcache_range(start, start + size);
151 static void bcm6348_iudma_chan_stop(struct bcm6348_iudma_priv *priv,
154 unsigned int timeout = DMA_CHAN_TOUT;
159 if (timeout > DMA_CHAN_TOUT / 2)
160 halt = DMAC_CFG_PKT_HALT_MASK;
162 halt = DMAC_CFG_BRST_HALT_MASK;
164 /* try to stop dma channel */
165 writel_be(halt, priv->chan + DMAC_CFG_REG(ch));
168 /* check if channel was stopped */
169 cfg = readl_be(priv->chan + DMAC_CFG_REG(ch));
170 if (!(cfg & DMAC_CFG_ENABLE_MASK))
177 pr_err("unable to stop channel %u\n", ch);
179 /* reset dma channel */
180 setbits_be32(priv->base + DMA_RST_REG, DMA_RST_CHAN_MASK(ch));
182 clrbits_be32(priv->base + DMA_RST_REG, DMA_RST_CHAN_MASK(ch));
185 static int bcm6348_iudma_disable(struct dma *dma)
187 struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
188 struct bcm6348_chan_priv *ch_priv = priv->ch_priv[dma->id];
190 /* stop dma channel */
191 bcm6348_iudma_chan_stop(priv, dma->id);
193 /* dma flow control */
194 if (bcm6348_iudma_chan_is_rx(dma->id))
195 writel_be(DMA_FLOWC_ALLOC_FORCE_MASK,
196 DMA_FLOWC_ALLOC_REG(dma->id));
198 /* init channel config */
199 ch_priv->running = false;
200 ch_priv->desc_id = 0;
201 if (bcm6348_iudma_chan_is_rx(dma->id))
202 ch_priv->desc_cnt = 0;
204 ch_priv->desc_cnt = ch_priv->dma_ring_size;
209 static int bcm6348_iudma_enable(struct dma *dma)
211 const struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
212 struct bcm6348_chan_priv *ch_priv = priv->ch_priv[dma->id];
213 struct bcm6348_dma_desc *dma_desc = ch_priv->dma_ring;
217 for (i = 0; i < ch_priv->desc_cnt; i++) {
218 if (bcm6348_iudma_chan_is_rx(dma->id)) {
219 ch_priv->busy_desc[i] = false;
220 dma_desc->status |= DMAD_ST_OWN_MASK;
222 dma_desc->status = 0;
223 dma_desc->length = 0;
224 dma_desc->address = 0;
227 if (i == ch_priv->desc_cnt - 1)
228 dma_desc->status |= DMAD_ST_WRAP_MASK;
233 /* init to first descriptor */
234 ch_priv->desc_id = 0;
236 /* force cache writeback */
237 bcm6348_iudma_fdc(ch_priv->dma_ring,
238 sizeof(*dma_desc) * ch_priv->desc_cnt);
241 writel_be(0, priv->sram + DMAS_STATE_DATA_REG(dma->id));
242 writel_be(0, priv->sram + DMAS_DESC_LEN_STATUS_REG(dma->id));
243 writel_be(0, priv->sram + DMAS_DESC_BASE_BUFPTR_REG(dma->id));
245 /* set dma ring start */
246 writel_be(virt_to_phys(ch_priv->dma_ring),
247 priv->sram + DMAS_RSTART_REG(dma->id));
249 /* set flow control */
250 if (bcm6348_iudma_chan_is_rx(dma->id)) {
253 setbits_be32(priv->base + DMA_CFG_REG,
254 DMA_CFG_FLOWC_ENABLE(dma->id));
256 val = ch_priv->desc_cnt / 3;
257 writel_be(val, priv->base + DMA_FLOWC_THR_LO_REG(dma->id));
259 val = (ch_priv->desc_cnt * 2) / 3;
260 writel_be(val, priv->base + DMA_FLOWC_THR_HI_REG(dma->id));
262 writel_be(0, priv->base + DMA_FLOWC_ALLOC_REG(dma->id));
265 /* set dma max burst */
266 writel_be(ch_priv->desc_cnt,
267 priv->chan + DMAC_BURST_REG(dma->id));
269 /* kick rx dma channel */
270 if (bcm6348_iudma_chan_is_rx(dma->id))
271 setbits_be32(priv->chan + DMAC_CFG_REG(dma->id),
272 DMAC_CFG_ENABLE_MASK);
274 /* channel is now enabled */
275 ch_priv->running = true;
280 static int bcm6348_iudma_request(struct dma *dma)
282 const struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
283 struct bcm6348_chan_priv *ch_priv;
285 /* check if channel is valid */
286 if (dma->id >= priv->n_channels)
289 /* alloc channel private data */
290 priv->ch_priv[dma->id] = calloc(1, sizeof(struct bcm6348_chan_priv));
291 if (!priv->ch_priv[dma->id])
293 ch_priv = priv->ch_priv[dma->id];
296 if (bcm6348_iudma_chan_is_rx(dma->id))
297 ch_priv->dma_ring_size = DMA_RX_DESC;
299 ch_priv->dma_ring_size = DMA_TX_DESC;
302 malloc_cache_aligned(sizeof(struct bcm6348_dma_desc) *
303 ch_priv->dma_ring_size);
304 if (!ch_priv->dma_ring)
307 /* init channel config */
308 ch_priv->running = false;
309 ch_priv->desc_id = 0;
310 if (bcm6348_iudma_chan_is_rx(dma->id)) {
311 ch_priv->desc_cnt = 0;
312 ch_priv->busy_desc = calloc(ch_priv->desc_cnt, sizeof(bool));
314 ch_priv->desc_cnt = ch_priv->dma_ring_size;
315 ch_priv->busy_desc = NULL;
321 static int bcm6348_iudma_receive(struct dma *dma, void **dst, void *metadata)
323 const struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
324 const struct bcm6348_iudma_hw *hw = priv->hw;
325 struct bcm6348_chan_priv *ch_priv = priv->ch_priv[dma->id];
326 struct bcm6348_dma_desc *dma_desc = dma_desc = ch_priv->dma_ring;
329 if (!ch_priv->running)
332 /* get dma ring descriptor address */
333 dma_desc += ch_priv->desc_id;
335 /* invalidate cache data */
336 bcm6348_iudma_idc(dma_desc, sizeof(*dma_desc));
339 if (dma_desc->status & DMAD_ST_OWN_MASK)
343 if (!(dma_desc->status & DMAD_ST_EOP_MASK) ||
344 !(dma_desc->status & DMAD_ST_SOP_MASK) ||
345 (dma_desc->status & hw->err_mask)) {
346 pr_err("invalid pkt received (ch=%ld desc=%u) (st=%04x)\n",
347 dma->id, ch_priv->desc_id, dma_desc->status);
350 /* set dma buffer address */
351 *dst = phys_to_virt(dma_desc->address);
353 /* invalidate cache data */
354 bcm6348_iudma_idc(*dst, dma_desc->length);
356 /* return packet length */
357 ret = dma_desc->length;
360 /* busy dma descriptor */
361 ch_priv->busy_desc[ch_priv->desc_id] = true;
363 /* increment dma descriptor */
364 ch_priv->desc_id = (ch_priv->desc_id + 1) % ch_priv->desc_cnt;
369 static int bcm6348_iudma_send(struct dma *dma, void *src, size_t len,
372 const struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
373 struct bcm6348_chan_priv *ch_priv = priv->ch_priv[dma->id];
374 struct bcm6348_dma_desc *dma_desc;
377 if (!ch_priv->running)
381 bcm6348_iudma_fdc(src, len);
383 /* get dma ring descriptor address */
384 dma_desc = ch_priv->dma_ring;
385 dma_desc += ch_priv->desc_id;
387 /* config dma descriptor */
388 status = (DMAD_ST_OWN_MASK |
392 if (ch_priv->desc_id == ch_priv->desc_cnt - 1)
393 status |= DMAD_ST_WRAP_MASK;
395 /* set dma descriptor */
396 dma_desc->address = virt_to_phys(src);
397 dma_desc->length = len;
398 dma_desc->status = status;
401 bcm6348_iudma_fdc(dma_desc, sizeof(*dma_desc));
403 /* kick tx dma channel */
404 setbits_be32(priv->chan + DMAC_CFG_REG(dma->id), DMAC_CFG_ENABLE_MASK);
406 /* poll dma status */
408 /* invalidate cache */
409 bcm6348_iudma_idc(dma_desc, sizeof(*dma_desc));
411 if (!(dma_desc->status & DMAD_ST_OWN_MASK))
415 /* increment dma descriptor */
416 ch_priv->desc_id = (ch_priv->desc_id + 1) % ch_priv->desc_cnt;
421 static int bcm6348_iudma_free_rcv_buf(struct dma *dma, void *dst, size_t size)
423 const struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
424 struct bcm6348_chan_priv *ch_priv = priv->ch_priv[dma->id];
425 struct bcm6348_dma_desc *dma_desc = ch_priv->dma_ring;
430 /* get dirty dma descriptor */
431 for (i = 0; i < ch_priv->desc_cnt; i++) {
432 if (phys_to_virt(dma_desc->address) == dst)
438 /* dma descriptor not found */
439 if (i == ch_priv->desc_cnt) {
440 pr_err("dirty dma descriptor not found\n");
444 /* invalidate cache */
445 bcm6348_iudma_idc(ch_priv->dma_ring,
446 sizeof(*dma_desc) * ch_priv->desc_cnt);
448 /* free dma descriptor */
449 ch_priv->busy_desc[i] = false;
451 status = DMAD_ST_OWN_MASK;
452 if (i == ch_priv->desc_cnt - 1)
453 status |= DMAD_ST_WRAP_MASK;
455 dma_desc->status |= status;
456 dma_desc->length = PKTSIZE_ALIGN;
458 /* tell dma we allocated one buffer */
459 writel_be(1, DMA_FLOWC_ALLOC_REG(dma->id));
462 bcm6348_iudma_fdc(ch_priv->dma_ring,
463 sizeof(*dma_desc) * ch_priv->desc_cnt);
465 /* kick rx dma channel if disabled */
466 cfg = readl_be(priv->chan + DMAC_CFG_REG(dma->id));
467 if (!(cfg & DMAC_CFG_ENABLE_MASK))
468 setbits_be32(priv->chan + DMAC_CFG_REG(dma->id),
469 DMAC_CFG_ENABLE_MASK);
474 static int bcm6348_iudma_add_rcv_buf(struct dma *dma, void *dst, size_t size)
476 const struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
477 struct bcm6348_chan_priv *ch_priv = priv->ch_priv[dma->id];
478 struct bcm6348_dma_desc *dma_desc = ch_priv->dma_ring;
480 /* no more dma descriptors available */
481 if (ch_priv->desc_cnt == ch_priv->dma_ring_size) {
482 pr_err("max number of buffers reached\n");
486 /* get next dma descriptor */
487 dma_desc += ch_priv->desc_cnt;
489 /* init dma descriptor */
490 dma_desc->address = virt_to_phys(dst);
491 dma_desc->length = size;
492 dma_desc->status = 0;
495 bcm6348_iudma_fdc(dma_desc, sizeof(*dma_desc));
497 /* increment dma descriptors */
503 static int bcm6348_iudma_prepare_rcv_buf(struct dma *dma, void *dst,
506 const struct bcm6348_iudma_priv *priv = dev_get_priv(dma->dev);
507 struct bcm6348_chan_priv *ch_priv = priv->ch_priv[dma->id];
509 /* only add new rx buffers if channel isn't running */
510 if (ch_priv->running)
511 return bcm6348_iudma_free_rcv_buf(dma, dst, size);
513 return bcm6348_iudma_add_rcv_buf(dma, dst, size);
516 static const struct dma_ops bcm6348_iudma_ops = {
517 .disable = bcm6348_iudma_disable,
518 .enable = bcm6348_iudma_enable,
519 .prepare_rcv_buf = bcm6348_iudma_prepare_rcv_buf,
520 .request = bcm6348_iudma_request,
521 .receive = bcm6348_iudma_receive,
522 .send = bcm6348_iudma_send,
525 static const struct bcm6348_iudma_hw bcm6348_hw = {
526 .err_mask = (DMAD6348_ST_OV_ERR_MASK |
527 DMAD6348_ST_CRC_ERR_MASK |
528 DMAD6348_ST_RX_ERR_MASK |
529 DMAD6348_ST_OS_ERR_MASK |
530 DMAD6348_ST_UN_ERR_MASK),
533 static const struct bcm6348_iudma_hw bcm6368_hw = {
537 static const struct udevice_id bcm6348_iudma_ids[] = {
539 .compatible = "brcm,bcm6348-iudma",
540 .data = (ulong)&bcm6348_hw,
542 .compatible = "brcm,bcm6368-iudma",
543 .data = (ulong)&bcm6368_hw,
544 }, { /* sentinel */ }
547 static int bcm6348_iudma_probe(struct udevice *dev)
549 struct dma_dev_priv *uc_priv = dev_get_uclass_priv(dev);
550 struct bcm6348_iudma_priv *priv = dev_get_priv(dev);
551 const struct bcm6348_iudma_hw *hw =
552 (const struct bcm6348_iudma_hw *)dev_get_driver_data(dev);
556 uc_priv->supported = (DMA_SUPPORTS_DEV_TO_MEM |
557 DMA_SUPPORTS_MEM_TO_DEV);
560 /* dma global base address */
561 priv->base = dev_remap_addr_name(dev, "dma");
565 /* dma channels base address */
566 priv->chan = dev_remap_addr_name(dev, "dma-channels");
570 /* dma sram base address */
571 priv->sram = dev_remap_addr_name(dev, "dma-sram");
575 /* get number of channels */
576 priv->n_channels = dev_read_u32_default(dev, "dma-channels", 8);
577 if (priv->n_channels > DMA_CHAN_MAX)
580 /* try to enable clocks */
585 ret = clk_get_by_index(dev, i, &clk);
589 ret = clk_enable(&clk);
591 pr_err("error enabling clock %d\n", i);
595 ret = clk_free(&clk);
597 pr_err("error freeing clock %d\n", i);
602 /* try to perform resets */
604 struct reset_ctl reset;
607 ret = reset_get_by_index(dev, i, &reset);
611 ret = reset_deassert(&reset);
613 pr_err("error deasserting reset %d\n", i);
617 ret = reset_free(&reset);
619 pr_err("error freeing reset %d\n", i);
624 /* disable dma controller */
625 clrbits_be32(priv->base + DMA_CFG_REG, DMA_CFG_ENABLE_MASK);
627 /* alloc channel private data pointers */
628 priv->ch_priv = calloc(priv->n_channels,
629 sizeof(struct bcm6348_chan_priv*));
633 /* stop dma channels */
634 for (ch = 0; ch < priv->n_channels; ch++)
635 bcm6348_iudma_chan_stop(priv, ch);
637 /* enable dma controller */
638 setbits_be32(priv->base + DMA_CFG_REG, DMA_CFG_ENABLE_MASK);
643 U_BOOT_DRIVER(bcm6348_iudma) = {
644 .name = "bcm6348_iudma",
646 .of_match = bcm6348_iudma_ids,
647 .ops = &bcm6348_iudma_ops,
648 .priv_auto_alloc_size = sizeof(struct bcm6348_iudma_priv),
649 .probe = bcm6348_iudma_probe,