net: convert altera_tse to driver model and phylib

Convert altera_tse to driver model and phylib.

Signed-off-by Thomas Chou <[email protected]>

---
 configs/nios2-generic_defconfig             |   2 +
 doc/device-tree-bindings/net/altera_tse.txt | 112 ++++
 drivers/net/Kconfig                         |   9 +
 drivers/net/altera_tse.c                    | 938
++++++++++------------------ drivers/net/altera_tse.h                    |
283 +++------
 include/configs/nios2-generic.h             |   8 +
 6 files changed, 536 insertions(+), 816 deletions(-)
 create mode 100644 doc/device-tree-bindings/net/altera_tse.txt

(quoted diff) +0 -0

/* sgdma debug - print descriptor */
static void alt_sgdma_print_desc(volatile struct alt_sgdma_descriptor
*desc) {

drivers/net/altera_tse.c +2 -15

 	debug("SGDMA DEBUG :\n");
-	debug("desc->source : 0x%x \n", (unsigned int)desc->source);
-	debug("desc->destination : 0x%x \n", (unsigned int)desc->destination);
-	debug("desc->next : 0x%x \n", (unsigned int)desc->next);
-	debug("desc->source_pad : 0x%x \n", (unsigned int)desc->source_pad);
-	debug("desc->destination_pad : 0x%x \n",
-	      (unsigned int)desc->destination_pad);
-	debug("desc->next_pad : 0x%x \n", (unsigned int)desc->next_pad);
-	debug("desc->bytes_to_transfer : 0x%x \n",
-	      (unsigned int)desc->bytes_to_transfer);
-	debug("desc->actual_bytes_transferred : 0x%x \n",
-	      (unsigned int)desc->actual_bytes_transferred);
-	debug("desc->descriptor_status : 0x%x \n",
-	      (unsigned int)desc->descriptor_status);
-	debug("desc->descriptor_control : 0x%x \n",
-	      (unsigned int)desc->descriptor_control);
+	debug("desc->source : 0x%x\n", (unsigned int)desc->source);
+	debug("desc->destination : 0x%x\n", (unsigned int)desc->destination);

drivers/net/altera_tse.c +2 -2

-/* This is a generic routine that the SGDMA mode-specific routines
+/*
+ * This is a generic routine that the SGDMA mode-specific routines
  * call to populate a descriptor.
  * arg1	    :pointer to first SGDMA descriptor.
  * arg2	    :pointer to next  SGDMA descriptor.

@@ -108,7 +107,6 @@ static void alt_sgdma_construct_descriptor_burst(
 	 * pointing at this descriptor, it will not run (via the "owned by
 	 * hardware" bit) until all other descriptor has been set up.
 	 */
-
 	desc->descriptor_control =
 	    ((ALT_SGDMA_DESCRIPTOR_CONTROL_OWNED_BY_HW_MSK) |
 	     (generate_eop ?

drivers/net/altera_tse.c +2 -2

 {
 	unsigned int status;
 	int counter = 0;
 
 	/* Wait for any pending transfers to complete */
 	alt_sgdma_print_desc(desc);
-	status = dev->status;
+	status = regs->status;
 
 	counter = 0;
-	while (dev->status & ALT_SGDMA_STATUS_BUSY_MSK) {
+	while (regs->status & ALT_SGDMA_STATUS_BUSY_MSK) {
 		if (counter++ > ALT_TSE_SGDMA_BUSY_WATCHDOG_CNTR)
 			break;
 	}

@@ -144,12 +143,12 @@ static int alt_sgdma_do_sync_transfer(volatile struct

alt_sgdma_registers *dev, * Clear any (previous) status register information

drivers/net/altera_tse.c +1 -1

 	debug("next desc in sgdma 0x%x\n",
-	      (unsigned int)dev->next_descriptor_pointer);
+	      (unsigned int)regs->next_descriptor_pointer);
 
 	/*
 	 * Set up SGDMA controller to:

@@ -157,30 +156,31 @@ static int alt_sgdma_do_sync_transfer(volatile struct

alt_sgdma_registers *dev, * - Run once a valid descriptor is written to controller

drivers/net/altera_tse.c +0 -1

 	 * - Stop on an error with any particular descriptor
 	 */
-	dev->control = (ALT_SGDMA_CONTROL_RUN_MSK |

drivers/net/altera_tse.c +3 -3

 	debug("done\n");
 
 	/* Clear Run */
-	dev->control = (dev->control & (~ALT_SGDMA_CONTROL_RUN_MSK));
+	regs->control = (regs->control & (~ALT_SGDMA_CONTROL_RUN_MSK));
 
 	/* Get & clear status register contents */
-	status = dev->status;
-	dev->status = 0xFF;
+	status = regs->status;
+	regs->status = 0xFF;
 
 	/* we really should check if the transfer completes properly */
 	debug("tx sgdma status = 0x%x", status);
 	return 0;
 }

drivers/net/altera_tse.c +9 -1

-static int tse_eth_rx(struct eth_device *dev)
+static void tse_eth_rx_setup(struct altera_tse_priv *priv)
+{
+	uchar *rx_buf = net_rx_packets[priv->rx_cur & 1];
+	volatile struct alt_sgdma_descriptor *rx_desc = priv->rx_desc;
+
+	invalidate_dcache_range((unsigned long)rx_buf,
+				(unsigned long)rx_buf + PKTSIZE_ALIGN);
+	alt_sgdma_construct_descriptor_burst(
+		&rx_desc[0],

drivers/net/altera_tse.c +5 -0

+		);
+
+	/* setup the sgdma */
+	alt_sgdma_do_async_transfer(priv->sgdma_rx, &rx_desc[0]);
+}

drivers/net/altera_tse.c +20 -0

+static int altera_tse_probe(struct udevice *dev)
+{
+	struct eth_pdata *pdata = dev_get_platdata(dev);
+	struct altera_tse_priv *priv = dev_get_priv(dev);
+	const void *blob = gd->fdt_blob;
+	int node = dev->of_offset;
+	const char *list, *end;
+	const fdt32_t *cell;
+	void *base, *desc_mem = NULL;
+	unsigned long addr, size;
+	int len, idx;
+	int ret;
+
+	/* decode regs, assume address-cells and size-cells are both one */
+	list = fdt_getprop(blob, node, "reg-names", &len);
+	if (!list)
+		return -ENOENT;
+	end = list + len;
+	cell = fdt_getprop(blob, node, "reg", &len);
+	if (!cell)

drivers/net/altera_tse.c +8 -0

+		else if (strcmp(list, "rx_csr") == 0)
+			priv->sgdma_rx = base;
+		else if (strcmp(list, "tx_csr") == 0)
+			priv->sgdma_tx = base;
+		else if (strcmp(list, "s1") == 0)
+			desc_mem = base;
+		idx += 2;
+		list += (len + 1);
 	}

Quoted 11 lines

drivers/net/altera_tse.c +11 -0

+	/* decode regs, assume address-cells and size-cells are both one */
+	list = fdt_getprop(blob, node, "reg-names", &len);
+	if (!list)
+		return -ENOENT;
+	end = list + len;
+	cell = fdt_getprop(blob, node, "reg", &len);
+	if (!cell)
+		return -ENOENT;
+	idx = 0;
+	while (list < end) {
+		addr = fdt_translate_address((void *)blob,

drivers/net/altera_tse.c static int tse_eth_init(struct eth_device *dev, bd_t * bd) · line 614

Quoted 6 lines

drivers/net/altera_tse.c +6 -0

+					     node, cell + idx);
+		size = fdt_addr_to_cpu(cell[idx + 1]);
+		base = ioremap(addr, size);
+		len = strlen(list);
+		if (strcmp(list, "control_port") == 0)
+			priv->mac_dev = base;

fdtdec_get_addr() won't do here?

Hi Marek,

Quoted 11 lines

Quoted 11 lines

drivers/net/altera_tse.c +11 -0

+	/* decode regs, assume address-cells and size-cells are both one */
+	list = fdt_getprop(blob, node, "reg-names", &len);
+	if (!list)
+		return -ENOENT;
+	end = list + len;
+	cell = fdt_getprop(blob, node, "reg", &len);
+	if (!cell)
+		return -ENOENT;
+	idx = 0;
+	while (list < end) {
+		addr = fdt_translate_address((void *)blob,

Quoted 8 lines

drivers/net/altera_tse.c static int tse_eth_init(struct eth_device *dev, bd_t * bd) · line 614

Quoted 6 lines

drivers/net/altera_tse.c +6 -0

+					     node, cell + idx);
+		size = fdt_addr_to_cpu(cell[idx + 1]);
+		base = ioremap(addr, size);
+		len = strlen(list);
+		if (strcmp(list, "control_port") == 0)
+			priv->mac_dev = base;

fdtdec_get_addr() won't do here?

There are multiple "reg" tuples, and need to match "reg-names". That's beyond fdtdec_get_addr().

	tse_mac: ethernet at 0x4000 {
		compatible = "altr,tse-1.0";
		reg = <0x00004000 0x00000400>,
			<0x00004400 0x00000040>,
			<0x00004800 0x00000040>,
			<0x00002000 0x00002000>;
		reg-names = "control_port", "rx_csr", "tx_csr", "s1";

Thanks a lot for your reviews.

Convert altera_tse to driver model and phylib.

Signed-off-by Thomas Chou <[email protected]>

---
v2
remove volatile and use I/O accessors as suggested by Marek. use virt_to_phys() to get dma address.
add free_pkt() ops.
add timeout to loop.
allocate cache aligned rx buffer.
refactor sgdma calls.

 configs/nios2-generic_defconfig             |    2 +
 doc/device-tree-bindings/net/altera_tse.txt |  112 +++
 drivers/net/Kconfig                         |    9 +
 drivers/net/altera_tse.c                    | 1150
+++++++++------------------ drivers/net/altera_tse.h                    | 
277 +------
 include/configs/nios2-generic.h             |    8 +
 6 files changed, 526 insertions(+), 1032 deletions(-)
 create mode 100644 doc/device-tree-bindings/net/altera_tse.txt

Convert altera_tse to driver model and phylib.

Signed-off-by Thomas Chou <[email protected]>

---
v2
remove volatile and use I/O accessors as suggested by Marek. use virt_to_phys() to get dma address.
add free_pkt() ops.
add timeout to loop.
allocate cache aligned rx buffer.
refactor sgdma calls.

 configs/nios2-generic_defconfig             |    2 +
 doc/device-tree-bindings/net/altera_tse.txt |  112 +++
 drivers/net/Kconfig                         |    9 +
 drivers/net/altera_tse.c                    | 1150 +++++++++------------------
 drivers/net/altera_tse.h                    |  277 +------
 include/configs/nios2-generic.h             |    8 +
 6 files changed, 526 insertions(+), 1032 deletions(-)
 create mode 100644 doc/device-tree-bindings/net/altera_tse.txt

drivers/net/altera_tse.c +15 -21

-static void tse_eth_reset(struct eth_device *dev)
+static void tse_eth_reset(struct altera_tse_priv *priv)
 {
-       /* stop sgdmas, disable tse receive */
-       struct altera_tse_priv *priv = dev->priv;
-       volatile struct alt_tse_mac *mac_dev = priv->mac_dev;
-       volatile struct alt_sgdma_registers *rx_sgdma = priv->sgdma_rx;
-       volatile struct alt_sgdma_registers *tx_sgdma = priv->sgdma_tx;
-       int counter;
-       volatile struct alt_sgdma_descriptor *rx_desc =
-           (volatile struct alt_sgdma_descriptor *)&priv->rx_desc[0];
+       struct alt_tse_mac *mac_dev = priv->mac_dev;
+       struct alt_sgdma_registers *rx_sgdma = priv->sgdma_rx;
+       struct alt_sgdma_registers *tx_sgdma = priv->sgdma_tx;
+       struct alt_sgdma_descriptor *rx_desc = priv->rx_desc;
+       unsigned int status;
+       int ret;
+       ulong ctime;
 
        /* clear rx desc & wait for sgdma to complete */
        rx_desc->descriptor_control = 0;
-       rx_sgdma->control = 0;
-       counter = 0;
-       while (rx_sgdma->status & ALT_SGDMA_STATUS_BUSY_MSK) {
-               if (counter++ > ALT_TSE_SGDMA_BUSY_WATCHDOG_CNTR)
-                       break;
-       }
-
-       if (counter >= ALT_TSE_SGDMA_BUSY_WATCHDOG_CNTR) {
-               debug("Timeout waiting for rx sgdma!\n");
-               rx_sgdma->control = ALT_SGDMA_CONTROL_SOFTWARERESET_MSK;
-               rx_sgdma->control = ALT_SGDMA_CONTROL_SOFTWARERESET_MSK;
-       }
+       writel(0, &rx_sgdma->control);
+       ret = alt_sgdma_wait_transfer(rx_sgdma);
+       if (ret == -ETIMEDOUT)
+               writel(ALT_SGDMA_CONTROL_SOFTWARERESET_MSK,
+                      &rx_sgdma->control);
+
+       writel(0, &tx_sgdma->control);

drivers/net/altera_tse.c +43 -9

-static int tse_eth_init(struct eth_device *dev, bd_t * bd)
-{
-       int dat;
-       struct altera_tse_priv *priv = dev->priv;
-       volatile struct alt_tse_mac *mac_dev = priv->mac_dev;
-       volatile struct alt_sgdma_descriptor *tx_desc = priv->tx_desc;
-       volatile struct alt_sgdma_descriptor *rx_desc = priv->rx_desc;
-       volatile struct alt_sgdma_descriptor *rx_desc_cur =
-           (volatile struct alt_sgdma_descriptor *)&rx_desc[0];
+       /*
+        * decode regs, assume address-cells and size-cells are both one.
+        * there are multiple reg tuples, and they need to match with
+        * reg-names.
+        */
+       list = fdt_getprop(blob, node, "reg-names", &len);
+       if (!list)
+               return -ENOENT;
+       end = list + len;
+       cell = fdt_getprop(blob, node, "reg", &len);
+       if (!cell)
+               return -ENOENT;
+       idx = 0;
+       while (list < end) {
+               addr = fdt_translate_address((void *)blob,
+                                            node, cell + idx);
+               size = fdt_addr_to_cpu(cell[idx + 1]);
+               base = ioremap(addr, size);
+               len = strlen(list);
+               if (strcmp(list, "control_port") == 0)
+                       priv->mac_dev = base;
+               else if (strcmp(list, "rx_csr") == 0)
+                       priv->sgdma_rx = base;
+               else if (strcmp(list, "tx_csr") == 0)
+                       priv->sgdma_tx = base;
+               else if (strcmp(list, "s1") == 0)
+                       desc_mem = base;
+               idx += 2;
+               list += (len + 1);
+       }
+       /* decode fifo depth */
+       priv->rx_fifo_depth = fdtdec_get_int(blob, node,
+               "rx-fifo-depth", 0);
+       priv->tx_fifo_depth = fdtdec_get_int(blob, node,
+               "tx-fifo-depth", 0);
+       /* decode phy */
+       addr = fdtdec_get_int(blob, node,
+                             "phy-handle", 0);
+       addr = fdt_node_offset_by_phandle(blob, addr);
+       priv->phyaddr = fdtdec_get_int(blob, addr,
+               "reg", 0);
+       /* init desc */
+       len = sizeof(struct alt_sgdma_descriptor) * 4;

Quoted 12 lines

drivers/net/altera_tse.c +11 -0

+       writel(0, &rx_sgdma->control);
+       ret = alt_sgdma_wait_transfer(rx_sgdma);
+       if (ret == -ETIMEDOUT)
+               writel(ALT_SGDMA_CONTROL_SOFTWARERESET_MSK,
+                      &rx_sgdma->control);
+
+       writel(0, &tx_sgdma->control);
+       ret = alt_sgdma_wait_transfer(tx_sgdma);
+       if (ret == -ETIMEDOUT)
+               writel(ALT_SGDMA_CONTROL_SOFTWARERESET_MSK,
+                      &tx_sgdma->control);

drivers/net/altera_tse.c static int tse_adjust_link(struct altera_tse_priv *priv) · line 370

Quoted 5 lines

drivers/net/altera_tse.c +0 -5

-       counter = 0;
-       tx_sgdma->control = 0;
-       while (tx_sgdma->status & ALT_SGDMA_STATUS_BUSY_MSK) {
-               if (counter++ > ALT_TSE_SGDMA_BUSY_WATCHDOG_CNTR)
-                       break;

It looks like this function can fail in various ways - should it not return an error?

[snip]

drivers/net/altera_tse.c static int tse_adjust_link(struct altera_tse_priv *priv) · line 420

Quoted 3 lines

drivers/net/altera_tse.c +2 -0

+static int altera_tse_free_pkt(struct udevice *dev, uchar *packet,
+                              int length)
  {

These functions seem to just call other functions. Perhaps you might consider moving the code here a follow-on patch?

drivers/net/altera_tse.c static int tse_adjust_link(struct altera_tse_priv *priv) · line 510

Quoted 2 lines

drivers/net/altera_tse.c +2 -0

+       /* allocate recv packet buffer */
+       priv->rx_buf = malloc_cache_aligned(PKTSIZE_ALIGN);

Can you just use

uint8_t rx_buf[PKTSIZE_ALIGN]

in this 'priv' structure? Why do a separate malloc()?

Convert altera_tse to driver model and phylib.

Signed-off-by Thomas Chou <[email protected]>

Reviewed-by Marek Vasut <[email protected]>

Reviewed-by Simon Glass <[email protected]>

---
v2
remove volatile and use I/O accessors as suggested by Marek. use virt_to_phys() to get dma address.
add free_pkt() ops.
add timeout to loop.
allocate cache aligned rx buffer.
refactor sgdma calls.
v3
move the code into net ops for those with a single caller.

  configs/nios2-generic_defconfig             |    2 +
  doc/device-tree-bindings/net/altera_tse.txt |  112 +++
  drivers/net/Kconfig                         |    9 +
  drivers/net/altera_tse.c                    | 1143 +++++++++------------------
  drivers/net/altera_tse.h                    |  277 +------
  include/configs/nios2-generic.h             |    8 +
  6 files changed, 504 insertions(+), 1047 deletions(-)

create mode 100644 doc/device-tree-bindings/net/altera_tse.txt