1 // SPDX-License-Identifier: GPL-2.0
3 * Xilinx Multirate Ethernet MAC(MRMAC) driver
8 * Copyright (C) 2021 Xilinx, Inc. All rights reserved.
19 #include <linux/delay.h>
20 #include <linux/ethtool.h>
21 #include "xilinx_axi_mrmac.h"
23 static void axi_mrmac_dma_write(struct mcdma_bd *bd, u32 *desc)
25 if (IS_ENABLED(CONFIG_PHYS_64BIT))
26 writeq((unsigned long)bd, desc);
28 writel((uintptr_t)bd, desc);
32 * axi_mrmac_ethernet_init - MRMAC init function
33 * @priv: MRMAC private structure
35 * Return: 0 on success, negative value on errors
37 * This function is called to reset and initialize MRMAC core. This is
38 * typically called during initialization. It does a reset of MRMAC Rx/Tx
39 * channels and Rx/Tx SERDES. It configures MRMAC speed based on mrmac_rate
40 * which is read from DT. This function waits for block lock bit to get set,
41 * if it is not set within 100ms time returns a timeout error.
43 static int axi_mrmac_ethernet_init(struct axi_mrmac_priv *priv)
45 struct mrmac_regs *regs = priv->iobase;
49 /* Perform all the RESET's required */
50 setbits_le32(®s->reset, MRMAC_RX_SERDES_RST_MASK | MRMAC_RX_RST_MASK
51 | MRMAC_TX_SERDES_RST_MASK | MRMAC_TX_RST_MASK);
53 mdelay(MRMAC_RESET_DELAY);
55 /* Configure Mode register */
56 reg = readl(®s->mode);
58 log_debug("Configuring MRMAC speed to %d\n", priv->mrmac_rate);
60 if (priv->mrmac_rate == SPEED_25000) {
61 reg &= ~MRMAC_CTL_RATE_CFG_MASK;
62 reg |= MRMAC_CTL_DATA_RATE_25G;
63 reg |= (MRMAC_CTL_AXIS_CFG_25G_IND << MRMAC_CTL_AXIS_CFG_SHIFT);
64 reg |= (MRMAC_CTL_SERDES_WIDTH_25G <<
65 MRMAC_CTL_SERDES_WIDTH_SHIFT);
67 reg &= ~MRMAC_CTL_RATE_CFG_MASK;
68 reg |= MRMAC_CTL_DATA_RATE_10G;
69 reg |= (MRMAC_CTL_AXIS_CFG_10G_IND << MRMAC_CTL_AXIS_CFG_SHIFT);
70 reg |= (MRMAC_CTL_SERDES_WIDTH_10G <<
71 MRMAC_CTL_SERDES_WIDTH_SHIFT);
75 reg |= MRMAC_CTL_PM_TICK_MASK;
76 writel(reg, ®s->mode);
78 clrbits_le32(®s->reset, MRMAC_RX_SERDES_RST_MASK | MRMAC_RX_RST_MASK
79 | MRMAC_TX_SERDES_RST_MASK | MRMAC_TX_RST_MASK);
81 mdelay(MRMAC_RESET_DELAY);
83 /* Setup MRMAC hardware options */
84 setbits_le32(®s->rx_config, MRMAC_RX_DEL_FCS_MASK);
85 setbits_le32(®s->tx_config, MRMAC_TX_INS_FCS_MASK);
86 setbits_le32(®s->tx_config, MRMAC_TX_EN_MASK);
87 setbits_le32(®s->rx_config, MRMAC_RX_EN_MASK);
89 /* Check for block lock bit to be set. This ensures that
90 * MRMAC ethernet IP is functioning normally.
92 writel(MRMAC_STS_ALL_MASK, (phys_addr_t)priv->iobase +
94 writel(MRMAC_STS_ALL_MASK, (phys_addr_t)priv->iobase +
96 writel(MRMAC_STS_ALL_MASK, (phys_addr_t)priv->iobase +
97 MRMAC_STATRX_BLKLCK_OFFSET);
99 ret = wait_for_bit_le32((u32 *)((phys_addr_t)priv->iobase +
100 MRMAC_STATRX_BLKLCK_OFFSET),
101 MRMAC_RX_BLKLCK_MASK, true,
102 MRMAC_BLKLCK_TIMEOUT, true);
104 log_warning("Error: MRMAC block lock not complete!\n");
108 writel(MRMAC_TICK_TRIGGER, ®s->tick_reg);
114 * axi_mcdma_init - Reset MCDMA engine
115 * @priv: MRMAC private structure
117 * Return: 0 on success, negative value on timeouts
119 * This function is called to reset and initialize MCDMA engine
121 static int axi_mcdma_init(struct axi_mrmac_priv *priv)
125 /* Reset the engine so the hardware starts from a known state */
126 writel(XMCDMA_CR_RESET, &priv->mm2s_cmn->control);
127 writel(XMCDMA_CR_RESET, &priv->s2mm_cmn->control);
129 /* Check Tx/Rx MCDMA.RST. Reset is done when the reset bit is low */
130 ret = wait_for_bit_le32(&priv->mm2s_cmn->control, XMCDMA_CR_RESET,
131 false, MRMAC_DMARST_TIMEOUT, true);
133 log_warning("Tx MCDMA reset Timeout\n");
137 ret = wait_for_bit_le32(&priv->s2mm_cmn->control, XMCDMA_CR_RESET,
138 false, MRMAC_DMARST_TIMEOUT, true);
140 log_warning("Rx MCDMA reset Timeout\n");
144 /* Enable channel 1 for Tx and Rx */
145 writel(XMCDMA_CHANNEL_1, &priv->mm2s_cmn->chen);
146 writel(XMCDMA_CHANNEL_1, &priv->s2mm_cmn->chen);
152 * axi_mrmac_start - MRMAC start
153 * @dev: udevice structure
155 * Return: 0 on success, negative value on errors
157 * This is a initialization function of MRMAC. Call MCDMA initialization
158 * function and setup Rx buffer descriptors for starting reception of packets.
159 * Enable Tx and Rx channels and trigger Rx channel fetch.
161 static int axi_mrmac_start(struct udevice *dev)
163 struct axi_mrmac_priv *priv = dev_get_priv(dev);
164 struct mrmac_regs *regs = priv->iobase;
167 * Initialize MCDMA engine. MCDMA engine must be initialized before
168 * MRMAC. During MCDMA engine initialization, MCDMA hardware is reset,
169 * since MCDMA reset line is connected to MRMAC, this would ensure a
172 axi_mcdma_init(priv);
174 /* Initialize MRMAC hardware */
175 if (axi_mrmac_ethernet_init(priv))
178 /* Disable all Rx interrupts before RxBD space setup */
179 clrbits_le32(&priv->mcdma_rx->control, XMCDMA_IRQ_ALL_MASK);
181 /* Update current descriptor */
182 axi_mrmac_dma_write(priv->rx_bd[0], &priv->mcdma_rx->current);
184 /* Setup Rx BD. MRMAC needs atleast two descriptors */
185 memset(priv->rx_bd[0], 0, RX_BD_TOTAL_SIZE);
187 priv->rx_bd[0]->next_desc = lower_32_bits((u64)priv->rx_bd[1]);
188 priv->rx_bd[0]->buf_addr = lower_32_bits((u64)net_rx_packets[0]);
190 priv->rx_bd[1]->next_desc = lower_32_bits((u64)priv->rx_bd[0]);
191 priv->rx_bd[1]->buf_addr = lower_32_bits((u64)net_rx_packets[1]);
193 if (IS_ENABLED(CONFIG_PHYS_64BIT)) {
194 priv->rx_bd[0]->next_desc_msb = upper_32_bits((u64)priv->rx_bd[1]);
195 priv->rx_bd[0]->buf_addr_msb = upper_32_bits((u64)net_rx_packets[0]);
197 priv->rx_bd[1]->next_desc_msb = upper_32_bits((u64)priv->rx_bd[0]);
198 priv->rx_bd[1]->buf_addr_msb = upper_32_bits((u64)net_rx_packets[1]);
201 priv->rx_bd[0]->cntrl = PKTSIZE_ALIGN;
202 priv->rx_bd[1]->cntrl = PKTSIZE_ALIGN;
204 /* Flush the last BD so DMA core could see the updates */
205 flush_cache((phys_addr_t)priv->rx_bd[0], RX_BD_TOTAL_SIZE);
207 /* It is necessary to flush rx buffers because if you don't do it
208 * then cache can contain uninitialized data
210 flush_cache((phys_addr_t)priv->rx_bd[0]->buf_addr, RX_BUFF_TOTAL_SIZE);
212 /* Start the hardware */
213 setbits_le32(&priv->s2mm_cmn->control, XMCDMA_CR_RUNSTOP_MASK);
214 setbits_le32(&priv->mm2s_cmn->control, XMCDMA_CR_RUNSTOP_MASK);
215 setbits_le32(&priv->mcdma_rx->control, XMCDMA_IRQ_ALL_MASK);
218 setbits_le32(&priv->mcdma_rx->control, XMCDMA_CR_RUNSTOP_MASK);
220 /* Update tail descriptor. Now it's ready to receive data */
221 axi_mrmac_dma_write(priv->rx_bd[1], &priv->mcdma_rx->tail);
224 setbits_le32(®s->tx_config, MRMAC_TX_EN_MASK);
227 setbits_le32(®s->rx_config, MRMAC_RX_EN_MASK);
233 * axi_mrmac_send - MRMAC Tx function
234 * @dev: udevice structure
235 * @ptr: pointer to Tx buffer
236 * @len: transfer length
238 * Return: 0 on success, negative value on errors
240 * This is a Tx send function of MRMAC. Setup Tx buffer descriptors and trigger
241 * transfer. Wait till the data is transferred.
243 static int axi_mrmac_send(struct udevice *dev, void *ptr, int len)
245 struct axi_mrmac_priv *priv = dev_get_priv(dev);
249 print_buffer(ptr, ptr, 1, len, 16);
251 if (len > PKTSIZE_ALIGN)
254 /* If size is less than min packet size, pad to min size */
255 if (len < MIN_PKT_SIZE) {
256 memset(priv->txminframe, 0, MIN_PKT_SIZE);
257 memcpy(priv->txminframe, ptr, len);
259 ptr = priv->txminframe;
262 writel(XMCDMA_IRQ_ALL_MASK, &priv->mcdma_tx->status);
264 clrbits_le32(&priv->mcdma_tx->control, XMCDMA_CR_RUNSTOP_MASK);
266 /* Flush packet to main memory to be trasfered by DMA */
267 flush_cache((phys_addr_t)ptr, len);
269 /* Setup Tx BD. MRMAC needs atleast two descriptors */
270 memset(priv->tx_bd[0], 0, TX_BD_TOTAL_SIZE);
272 priv->tx_bd[0]->next_desc = lower_32_bits((u64)priv->tx_bd[1]);
273 priv->tx_bd[0]->buf_addr = lower_32_bits((u64)ptr);
275 /* At the end of the ring, link the last BD back to the top */
276 priv->tx_bd[1]->next_desc = lower_32_bits((u64)priv->tx_bd[0]);
277 priv->tx_bd[1]->buf_addr = lower_32_bits((u64)ptr + len / 2);
279 if (IS_ENABLED(CONFIG_PHYS_64BIT)) {
280 priv->tx_bd[0]->next_desc_msb = upper_32_bits((u64)priv->tx_bd[1]);
281 priv->tx_bd[0]->buf_addr_msb = upper_32_bits((u64)ptr);
283 priv->tx_bd[1]->next_desc_msb = upper_32_bits((u64)priv->tx_bd[0]);
284 priv->tx_bd[1]->buf_addr_msb = upper_32_bits((u64)ptr + len / 2);
287 /* Split Tx data in to half and send in two descriptors */
288 priv->tx_bd[0]->cntrl = (len / 2) | XMCDMA_BD_CTRL_TXSOF_MASK;
289 priv->tx_bd[1]->cntrl = (len - len / 2) | XMCDMA_BD_CTRL_TXEOF_MASK;
291 /* Flush the last BD so DMA core could see the updates */
292 flush_cache((phys_addr_t)priv->tx_bd[0], TX_BD_TOTAL_SIZE);
294 if (readl(&priv->mcdma_tx->status) & XMCDMA_CH_IDLE) {
295 axi_mrmac_dma_write(priv->tx_bd[0], &priv->mcdma_tx->current);
297 setbits_le32(&priv->mcdma_tx->control, XMCDMA_CR_RUNSTOP_MASK);
299 log_warning("Error: current desc is not updated\n");
303 setbits_le32(&priv->mcdma_tx->control, XMCDMA_IRQ_ALL_MASK);
306 axi_mrmac_dma_write(priv->tx_bd[1], &priv->mcdma_tx->tail);
308 /* Wait for transmission to complete */
309 ret = wait_for_bit_le32(&priv->mcdma_tx->status, XMCDMA_IRQ_IOC_MASK,
312 log_warning("%s: Timeout\n", __func__);
317 priv->tx_bd[0]->sband_stats = 0;
318 priv->tx_bd[1]->sband_stats = 0;
320 log_debug("Sending complete\n");
325 static bool isrxready(struct axi_mrmac_priv *priv)
329 /* Read pending interrupts */
330 status = readl(&priv->mcdma_rx->status);
332 /* Acknowledge pending interrupts */
333 writel(status & XMCDMA_IRQ_ALL_MASK, &priv->mcdma_rx->status);
336 * If Reception done interrupt is asserted, call Rx call back function
337 * to handle the processed BDs and then raise the according flag.
339 if (status & (XMCDMA_IRQ_IOC_MASK | XMCDMA_IRQ_DELAY_MASK))
346 * axi_mrmac_recv - MRMAC Rx function
347 * @dev: udevice structure
348 * @flags: flags from network stack
349 * @packetp pointer to received data
351 * Return: received data length on success, negative value on errors
353 * This is a Rx function of MRMAC. Check if any data is received on MCDMA.
354 * Copy buffer pointer to packetp and return received data length.
356 static int axi_mrmac_recv(struct udevice *dev, int flags, uchar **packetp)
358 struct axi_mrmac_priv *priv = dev_get_priv(dev);
362 /* Wait for an incoming packet */
363 if (!isrxready(priv))
366 /* Clear all interrupts */
367 writel(XMCDMA_IRQ_ALL_MASK, &priv->mcdma_rx->status);
369 /* Disable IRQ for a moment till packet is handled */
370 clrbits_le32(&priv->mcdma_rx->control, XMCDMA_IRQ_ALL_MASK);
372 /* Disable channel fetch */
373 clrbits_le32(&priv->mcdma_rx->control, XMCDMA_CR_RUNSTOP_MASK);
375 rx_bd_end = (ulong)priv->rx_bd[0] + roundup(RX_BD_TOTAL_SIZE,
377 /* Invalidate Rx descriptors to see proper Rx length */
378 invalidate_dcache_range((phys_addr_t)priv->rx_bd[0], rx_bd_end);
380 length = priv->rx_bd[0]->status & XMCDMA_BD_STS_ACTUAL_LEN_MASK;
381 *packetp = (uchar *)(ulong)priv->rx_bd[0]->buf_addr;
384 length = priv->rx_bd[1]->status & XMCDMA_BD_STS_ACTUAL_LEN_MASK;
385 *packetp = (uchar *)(ulong)priv->rx_bd[1]->buf_addr;
389 print_buffer(*packetp, *packetp, 1, length, 16);
392 priv->rx_bd[0]->status = 0;
393 priv->rx_bd[1]->status = 0;
399 * axi_mrmac_free_pkt - MRMAC free packet function
400 * @dev: udevice structure
401 * @packet: receive buffer pointer
402 * @length received data length
404 * Return: 0 on success, negative value on errors
406 * This is Rx free packet function of MRMAC. Prepare MRMAC for reception of
407 * data again. Invalidate previous data from Rx buffers and set Rx buffer
408 * descriptors. Trigger reception by updating tail descriptor.
410 static int axi_mrmac_free_pkt(struct udevice *dev, uchar *packet, int length)
412 struct axi_mrmac_priv *priv = dev_get_priv(dev);
415 /* It is useful to clear buffer to be sure that it is consistent */
416 memset(priv->rx_bd[0]->buf_addr, 0, RX_BUFF_TOTAL_SIZE);
418 /* Disable all Rx interrupts before RxBD space setup */
419 clrbits_le32(&priv->mcdma_rx->control, XMCDMA_IRQ_ALL_MASK);
421 /* Disable channel fetch */
422 clrbits_le32(&priv->mcdma_rx->control, XMCDMA_CR_RUNSTOP_MASK);
424 /* Update current descriptor */
425 axi_mrmac_dma_write(priv->rx_bd[0], &priv->mcdma_rx->current);
428 flush_cache((phys_addr_t)priv->rx_bd[0], RX_BD_TOTAL_SIZE);
430 /* It is necessary to flush rx buffers because if you don't do it
431 * then cache will contain previous packet
433 flush_cache((phys_addr_t)priv->rx_bd[0]->buf_addr, RX_BUFF_TOTAL_SIZE);
436 setbits_le32(&priv->mcdma_rx->control, XMCDMA_IRQ_ALL_MASK);
439 setbits_le32(&priv->mcdma_rx->control, XMCDMA_CR_RUNSTOP_MASK);
441 /* Update tail descriptor. Now it's ready to receive data */
442 axi_mrmac_dma_write(priv->rx_bd[1], &priv->mcdma_rx->tail);
444 log_debug("Rx completed, framelength = %x\n", length);
450 * axi_mrmac_stop - Stop MCDMA transfers
451 * @dev: udevice structure
453 * Return: 0 on success, negative value on errors
455 * Stop MCDMA engine for both Tx and Rx transfers.
457 static void axi_mrmac_stop(struct udevice *dev)
459 struct axi_mrmac_priv *priv = dev_get_priv(dev);
461 /* Stop the hardware */
462 clrbits_le32(&priv->mcdma_tx->control, XMCDMA_CR_RUNSTOP_MASK);
463 clrbits_le32(&priv->mcdma_rx->control, XMCDMA_CR_RUNSTOP_MASK);
465 log_debug("Halted\n");
468 static int axi_mrmac_probe(struct udevice *dev)
470 struct axi_mrmac_plat *plat = dev_get_plat(dev);
471 struct eth_pdata *pdata = &plat->eth_pdata;
472 struct axi_mrmac_priv *priv = dev_get_priv(dev);
474 priv->iobase = (struct mrmac_regs *)pdata->iobase;
476 priv->mm2s_cmn = plat->mm2s_cmn;
477 priv->mcdma_tx = (struct mcdma_chan_reg *)((phys_addr_t)priv->mm2s_cmn
478 + XMCDMA_CHAN_OFFSET);
479 priv->s2mm_cmn = (struct mcdma_common_regs *)((phys_addr_t)priv->mm2s_cmn
481 priv->mcdma_rx = (struct mcdma_chan_reg *)((phys_addr_t)priv->s2mm_cmn
482 + XMCDMA_CHAN_OFFSET);
483 priv->mrmac_rate = plat->mrmac_rate;
485 /* Align buffers to ARCH_DMA_MINALIGN */
486 priv->tx_bd[0] = memalign(ARCH_DMA_MINALIGN, TX_BD_TOTAL_SIZE);
487 priv->tx_bd[1] = (struct mcdma_bd *)((ulong)priv->tx_bd[0] +
488 sizeof(struct mcdma_bd));
490 priv->rx_bd[0] = memalign(ARCH_DMA_MINALIGN, RX_BD_TOTAL_SIZE);
491 priv->rx_bd[1] = (struct mcdma_bd *)((ulong)priv->rx_bd[0] +
492 sizeof(struct mcdma_bd));
494 priv->txminframe = memalign(ARCH_DMA_MINALIGN, MIN_PKT_SIZE);
499 static int axi_mrmac_remove(struct udevice *dev)
501 struct axi_mrmac_priv *priv = dev_get_priv(dev);
503 /* Free buffer descriptors */
504 free(priv->tx_bd[0]);
505 free(priv->rx_bd[0]);
506 free(priv->txminframe);
511 static int axi_mrmac_of_to_plat(struct udevice *dev)
513 struct axi_mrmac_plat *plat = dev_get_plat(dev);
514 struct eth_pdata *pdata = &plat->eth_pdata;
515 struct ofnode_phandle_args phandle_args;
518 pdata->iobase = dev_read_addr(dev);
520 ret = dev_read_phandle_with_args(dev, "axistream-connected", NULL, 0, 0,
523 log_debug("axistream not found\n");
527 plat->mm2s_cmn = (struct mcdma_common_regs *)ofnode_read_u64_default
528 (phandle_args.node, "reg", -1);
529 if (!plat->mm2s_cmn) {
530 log_warning("MRMAC dma register space not found\n");
534 /* Set default MRMAC rate to 10000 */
535 plat->mrmac_rate = dev_read_u32_default(dev, "xlnx,mrmac-rate", 10000);
540 static const struct eth_ops axi_mrmac_ops = {
541 .start = axi_mrmac_start,
542 .send = axi_mrmac_send,
543 .recv = axi_mrmac_recv,
544 .free_pkt = axi_mrmac_free_pkt,
545 .stop = axi_mrmac_stop,
548 static const struct udevice_id axi_mrmac_ids[] = {
549 { .compatible = "xlnx,mrmac-ethernet-1.0" },
553 U_BOOT_DRIVER(axi_mrmac) = {
556 .of_match = axi_mrmac_ids,
557 .of_to_plat = axi_mrmac_of_to_plat,
558 .probe = axi_mrmac_probe,
559 .remove = axi_mrmac_remove,
560 .ops = &axi_mrmac_ops,
561 .priv_auto = sizeof(struct axi_mrmac_priv),
562 .plat_auto = sizeof(struct axi_mrmac_plat),