LL TEMAC v10 refactored -- for evaluation only

Xilinx LocalLink Tri-Mode Ether MAC driver can be used by Xilinx Microblaze or Xilinx ppc405/440 in SDMA and FIFO mode. DCR or XPS bus can be used.

The driver uses and requires MII and PHYLIB.

CP: 4 warnings: 'Use of volatile is usually wrong' I won't fix this, because it depends on the network driver subsystem.

Reported-by Michal Simek <[email protected]>

Signed-off-by Stephan Linz <[email protected]>

---
 drivers/net/Makefile               |    2 +
 drivers/net/xilinx_ll_temac.c      |  433 ++++++++++++++++++++++++++++++++++++
 drivers/net/xilinx_ll_temac_fifo.c |  143 ++++++++++++
 drivers/net/xilinx_ll_temac_mdio.c |  180 +++++++++++++++
 drivers/net/xilinx_ll_temac_sdma.c |  370 ++++++++++++++++++++++++++++++
 include/netdev.h                   |    1 +
 include/xilinx_ll_temac.h          |  358 +++++++++++++++++++++++++++++
 include/xilinx_ll_temac_fifo.h     |  122 ++++++++++
 include/xilinx_ll_temac_mdio.h     |   53 +++++
 include/xilinx_ll_temac_sdma.h     |  281 +++++++++++++++++++++++
 10 files changed, 1943 insertions(+), 0 deletions(-)

 create mode 100644 drivers/net/xilinx_ll_temac.c
 create mode 100644 drivers/net/xilinx_ll_temac_fifo.c
 create mode 100644 drivers/net/xilinx_ll_temac_mdio.c
 create mode 100644 drivers/net/xilinx_ll_temac_sdma.c
 create mode 100644 include/xilinx_ll_temac.h
 create mode 100644 include/xilinx_ll_temac_fifo.h
 create mode 100644 include/xilinx_ll_temac_mdio.h
 create mode 100644 include/xilinx_ll_temac_sdma.h

U-Boot's multipple network supports enables to use several ethernet drivers but microblaze-generic platform config file select only one driver.

Reported-by Michal Simek <[email protected]>

Signed-off-by Stephan Linz <[email protected]>

---
 include/configs/microblaze-generic.h |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

include/configs/microblaze-generic.h +1 -2

index 03a6f5a..09ac870 100644
@@ -65,11 +65,15 @@
 
 /* ethernet */
 #undef CONFIG_SYS_ENET
-#ifdef XILINX_EMACLITE_BASEADDR
-# define CONFIG_XILINX_EMACLITE		1
+#if defined(XILINX_EMACLITE_BASEADDR)

Quoted 26 lines · Stephan Linz

U-Boot's multipple network supports enables to use several ethernet drivers but microblaze-generic platform config file select only one driver.

Reported-by Michal Simek <[email protected]>

Signed-off-by Stephan Linz <[email protected]>

---
 include/configs/microblaze-generic.h |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

include/configs/microblaze-generic.h +3 -4

index 03a6f5a..09ac870 100644
@@ -65,11 +65,15 @@
 
 /* ethernet */
 #undef CONFIG_SYS_ENET
-#ifdef XILINX_EMACLITE_BASEADDR
-# define CONFIG_XILINX_EMACLITE		1
+#if defined(XILINX_EMACLITE_BASEADDR)
+# define CONFIG_XILINX_EMACLITE	1
 # define CONFIG_SYS_ENET
-#elif XILINX_LLTEMAC_BASEADDR
-# define CONFIG_XILINX_LL_TEMAC		1
+#endif

include/configs/microblaze-generic.h line 76

Quoted 5 lines

include/configs/microblaze-generic.h +5 -0

+#if defined(XILINX_LLTEMAC_BASEADDR)  || defined(XILINX_LLTEMAC_BASEADDR1) || \
+    defined(XILINX_LLTEMAC_BASEADDR2) || defined(XILINX_LLTEMAC_BASEADDR3) || \
+    defined(XILINX_LLTEMAC_BASEADDR4) || defined(XILINX_LLTEMAC_BASEADDR5) || \
+    defined(XILINX_LLTEMAC_BASEADDR6) || defined(XILINX_LLTEMAC_BASEADDR7)
+# define CONFIG_XILINX_LL_TEMAC	1

Why to do it in this way? I believe that the first lltemac driver will have XILINX_LLTEMAC_BASEADDR and then others.

But for all configurations if there is lltemac driver then will have anyone just BASEADDR.

U-Boot's multipple network supports enables to use several ethernet drivers but microblaze-generic platform config file select only one driver.

Reported-by Michal Simek <[email protected]>

Signed-off-by Stephan Linz <[email protected]>

---
 include/configs/microblaze-generic.h |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

include/configs/microblaze-generic.h +2 -3

index 03a6f5a..09ac870 100644
@@ -65,11 +65,15 @@
 
 /* ethernet */
 #undef CONFIG_SYS_ENET
-#ifdef XILINX_EMACLITE_BASEADDR
-# define CONFIG_XILINX_EMACLITE		1
+#if defined(XILINX_EMACLITE_BASEADDR)
+# define CONFIG_XILINX_EMACLITE	1
 # define CONFIG_SYS_ENET
-#elif XILINX_LLTEMAC_BASEADDR

From: Michal Simek <[email protected]>

Enable phylib and mii support for LLTEMAC or AXI EMAC ethernet drivers on Microblaze systems.

Signed-off-by Michal Simek <[email protected]>

Acked-by Stephan Linz <[email protected]>

---
 include/configs/microblaze-generic.h |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)

include/configs/microblaze-generic.h +12 -0

index 09ac870..69fcdb6 100644
@@ -342,4 +342,25 @@
 #define CONFIG_FIT		1
 #define CONFIG_OF_LIBFDT	1
 
+#if defined(CONFIG_XILINX_LL_TEMAC) || defined(CONFIG_XILINX_AXIEMAC)
+# define CONFIG_MII		1
+# define CONFIG_CMD_MII		1
+# define CONFIG_PHY_GIGE	1
+# define CONFIG_SYS_FAULT_ECHO_LINK_DOWN	1
+# define CONFIG_PHYLIB		1
+# define CONFIG_PHY_ATHEROS	1
+# define CONFIG_PHY_BROADCOM	1
+# define CONFIG_PHY_DAVICOM	1
+# define CONFIG_PHY_LXT		1
+# define CONFIG_PHY_MARVELL	1
+# define CONFIG_PHY_MICREL	1

Signed-off-by Stephan Linz <[email protected]>

---
 include/configs/microblaze-generic.h |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

include/configs/microblaze-generic.h +0 -0

index 69fcdb6..71d4767 100644

Expand the specific configuration for the microblaze-generic board in xparameters.h with a faked setup to enable the LL_TEMAC driver.

Note: From now the microblaze-generic board is no longer a valid board configuration for a real piece of hardware. Rather than, we use the file config.mk and xparameters.h as a faked board configuration to force the compilation of all potential driver code for Microblaze systems.

Signed-off-by Stephan Linz <[email protected]>

---
 board/xilinx/microblaze-generic/config.mk     |    6 ++++--
 board/xilinx/microblaze-generic/xparameters.h |   24 ++++++++++++++++++++++--
 2 files changed, 26 insertions(+), 4 deletions(-)

board/xilinx/microblaze-generic/config.mk +4 -2

index f8d7e26..9fd1015 100644
@@ -21,8 +21,10 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 # MA 02111-1307 USA
 #
-# CAUTION: This file is automatically generated by libgen.
-# Version: Xilinx EDK 6.3 EDK_Gmm.12.3
+# CAUTION: This file is a faked configuration !!!
+#          There is no real target for the microblaze-generic
+#          configuration. You have to replace this file with
+#          the generated file from your Xilinx design flow.
 #
 
 CONFIG_SYS_TEXT_BASE = 0x29000000

board/xilinx/microblaze-generic/xparameters.h +5 -2

index fae03bf..69758c3 100644
@@ -21,8 +21,10 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  * MA 02111-1307 USA
  *
- * CAUTION: This file is automatically generated by libgen.
- * Version: Xilinx EDK 8.2.02 EDK_Im_Sp2.4
+ * CAUTION: This file is a faked configuration !!!
+ *          There is no real target for the microblaze-generic
+ *          configuration. You have to replace this file with
+ *          the generated file from your Xilinx design flow.
  */
 
 #define XILINX_BOARD_NAME	microblaze-generic

@@ -69,3 +71,21 @@
 
 /* Ethernet controller is Ethernet_MAC */
 #define XILINX_EMACLITE_BASEADDR       0x40C00000
+

Quoted 60 lines · Stephan Linz

Expand the specific configuration for the microblaze-generic board in xparameters.h with a faked setup to enable the LL_TEMAC driver.

Note: From now the microblaze-generic board is no longer a valid board configuration for a real piece of hardware. Rather than, we use the file config.mk and xparameters.h as a faked board configuration to force the compilation of all potential driver code for Microblaze systems.

Signed-off-by Stephan Linz <[email protected]>

---
 board/xilinx/microblaze-generic/config.mk     |    6 ++++--
 board/xilinx/microblaze-generic/xparameters.h |   24 ++++++++++++++++++++++--
 2 files changed, 26 insertions(+), 4 deletions(-)

board/xilinx/microblaze-generic/config.mk +4 -2

index f8d7e26..9fd1015 100644
@@ -21,8 +21,10 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 # MA 02111-1307 USA
 #
-# CAUTION: This file is automatically generated by libgen.
-# Version: Xilinx EDK 6.3 EDK_Gmm.12.3
+# CAUTION: This file is a faked configuration !!!
+#          There is no real target for the microblaze-generic
+#          configuration. You have to replace this file with
+#          the generated file from your Xilinx design flow.
 #
 
 CONFIG_SYS_TEXT_BASE = 0x29000000

board/xilinx/microblaze-generic/xparameters.h +10 -2

index fae03bf..69758c3 100644
@@ -21,8 +21,10 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  * MA 02111-1307 USA
  *
- * CAUTION: This file is automatically generated by libgen.
- * Version: Xilinx EDK 8.2.02 EDK_Im_Sp2.4
+ * CAUTION: This file is a faked configuration !!!
+ *          There is no real target for the microblaze-generic
+ *          configuration. You have to replace this file with
+ *          the generated file from your Xilinx design flow.
  */
 
 #define XILINX_BOARD_NAME	microblaze-generic

@@ -69,3 +71,21 @@
 
 /* Ethernet controller is Ethernet_MAC */
 #define XILINX_EMACLITE_BASEADDR       0x40C00000
+
+/* Ethernet controller is Ethernet_MAC */
+#define XILINX_LLTEMAC_BASEADDR			0x44000000
+#define XILINX_LLTEMAC_SDMA_CTRL_BASEADDR	0x42000180
+#define XILINX_LLTEMAC_BASEADDR1		0x44000040
+#define XILINX_LLTEMAC_SDMA_CTRL_BASEADDR1	0x42000200

board/xilinx/microblaze-generic/xparameters.h line 83

Quoted 4 lines

board/xilinx/microblaze-generic/xparameters.h +4 -0

+#define XILINX_LLTEMAC_BASEADDR2		0x44100000
+#define XILINX_LLTEMAC_SDMA_CTRL_BASEADDR2	0x42000280
+#define XILINX_LLTEMAC_BASEADDR3		0x44100040
+#define XILINX_LLTEMAC_SDMA_CTRL_BASEADDR3	0x42000300

Do these two options test anything?

Quoted 5 lines

board/xilinx/microblaze-generic/xparameters.h +4 -0

+#define XILINX_LLTEMAC_BASEADDR4		0x44200000
+#define XILINX_LLTEMAC_FIFO_BASEADDR4		0x42100000
+#define XILINX_LLTEMAC_BASEADDR5		0x44200040
+#define XILINX_LLTEMAC_FIFO_BASEADDR5		0x42110000

board/xilinx/microblaze-generic/xparameters.h line 91

Quoted 4 lines

board/xilinx/microblaze-generic/xparameters.h +4 -0

+#define XILINX_LLTEMAC_BASEADDR6		0x44300000
+#define XILINX_LLTEMAC_FIFO_BASEADDR6		0x42120000
+#define XILINX_LLTEMAC_BASEADDR7		0x44300040
+#define XILINX_LLTEMAC_FIFO_BASEADDR7		0x42130000

The same here.

Expand the specific configuration for the microblaze-generic board in xparameters.h with a faked setup to enable the LL_TEMAC driver.

Note: From now the microblaze-generic board is no longer a valid board configuration for a real piece of hardware. Rather than, we use the file config.mk and xparameters.h as a faked board configuration to force the compilation of all potential driver code for Microblaze systems.

Signed-off-by Stephan Linz <[email protected]>

---
 board/xilinx/microblaze-generic/config.mk     |    6 ++++--
 board/xilinx/microblaze-generic/xparameters.h |   24 ++++++++++++++++++++++--
 2 files changed, 26 insertions(+), 4 deletions(-)

board/xilinx/microblaze-generic/config.mk +4 -2

index f8d7e26..9fd1015 100644
@@ -21,8 +21,10 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 # MA 02111-1307 USA
 #
-# CAUTION: This file is automatically generated by libgen.
-# Version: Xilinx EDK 6.3 EDK_Gmm.12.3
+# CAUTION: This file is a faked configuration !!!
+#          There is no real target for the microblaze-generic
+#          configuration. You have to replace this file with
+#          the generated file from your Xilinx design flow.
 #
 
 CONFIG_SYS_TEXT_BASE = 0x29000000

board/xilinx/microblaze-generic/xparameters.h +12 -2

index fae03bf..69758c3 100644
@@ -21,8 +21,10 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  * MA 02111-1307 USA
  *
- * CAUTION: This file is automatically generated by libgen.
- * Version: Xilinx EDK 8.2.02 EDK_Im_Sp2.4
+ * CAUTION: This file is a faked configuration !!!
+ *          There is no real target for the microblaze-generic
+ *          configuration. You have to replace this file with
+ *          the generated file from your Xilinx design flow.
  */
 
 #define XILINX_BOARD_NAME	microblaze-generic

@@ -69,3 +71,21 @@
 
 /* Ethernet controller is Ethernet_MAC */
 #define XILINX_EMACLITE_BASEADDR       0x40C00000
+
+/* Ethernet controller is Ethernet_MAC */
+#define XILINX_LLTEMAC_BASEADDR			0x44000000
+#define XILINX_LLTEMAC_SDMA_CTRL_BASEADDR	0x42000180
+#define XILINX_LLTEMAC_BASEADDR1		0x44000040
+#define XILINX_LLTEMAC_SDMA_CTRL_BASEADDR1	0x42000200
+#define XILINX_LLTEMAC_BASEADDR2		0x44100000
+#define XILINX_LLTEMAC_SDMA_CTRL_BASEADDR2	0x42000280

Signed-off-by Stephan Linz <[email protected]>

---
 .../xilinx/microblaze-generic/microblaze-generic.c |   57 ++++++++++++++++++++
 drivers/net/xilinx_ll_temac.c                      |    2 +-
 include/xilinx_ll_temac.h                          |    3 +
 3 files changed, 61 insertions(+), 1 deletions(-)

board/xilinx/microblaze-generic/microblaze-generic.c +4 -0

index 517b2f1..d2f56b9 100644
@@ -31,6 +31,10 @@
 #include <asm/microblaze_intc.h>
 #include <asm/asm.h>
 
+#ifdef CONFIG_XILINX_LL_TEMAC
+#include <xilinx_ll_temac.h>
+#endif
+
 int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 {
 #ifdef CONFIG_SYS_GPIO_0

Quoted 25 lines · Stephan Linz

Signed-off-by Stephan Linz <[email protected]>

---
 .../xilinx/microblaze-generic/microblaze-generic.c |   57 ++++++++++++++++++++
 drivers/net/xilinx_ll_temac.c                      |    2 +-
 include/xilinx_ll_temac.h                          |    3 +
 3 files changed, 61 insertions(+), 1 deletions(-)

board/xilinx/microblaze-generic/microblaze-generic.c +4 -0

index 517b2f1..d2f56b9 100644
@@ -31,6 +31,10 @@
 #include <asm/microblaze_intc.h>
 #include <asm/asm.h>
 
+#ifdef CONFIG_XILINX_LL_TEMAC
+#include <xilinx_ll_temac.h>
+#endif
+
 int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 {
 #ifdef CONFIG_SYS_GPIO_0

@@ -92,7 +96,60 @@ int board_eth_init(bd_t *bis)
 #endif
 

board/xilinx/microblaze-generic/microblaze-generic.c int board_eth_init(bd_t *bis) · line 102

Quoted 5 lines

board/xilinx/microblaze-generic/microblaze-generic.c +3 -0

 #ifdef CONFIG_XILINX_LL_TEMAC
+#if 1
+	/* This should be the preferred way to initialize
+	 * all the interfaces. */
 	ret |= xilinx_ll_temac_standard_init(bis);

if 1 is not the best for mainline because it means that below is dead code.

Hi Michal,

back to your requests and objections I've built up a new patch set for evaluation. Some of the changes relate to the Microblaze platform rather than the network driver.

1) U-Boot configuration variables vs. xparameters.h
----------------------------------------------------------------------
I've tried to find a compromise between the U-Boot coding and configuration style and your preference. But at least in the point of the many many CPP conditional directives I can not reduce the code. I can move the code only to another place. I need a converstion from the automaticaly generated content of xparameters.h to the U-Boot configuration space. Now you can find this conversion matrix in a new platform header, xconversions.h -- I've placed the header in board/xilinx/microblaze-generic/ I think, we can find a better place.

The conversion matrix avoids all the wrong configuration variables inside U-Boot code beginning with XILINX_ (and not CONFIG_) and we can expand the configuration to new software related options we never get from hardware (example special interface naming). This mechanism can also be used by other driver and platform code, for example arch/microblaze/cpu/cache.c and arch/microblaze/lib/bootm.c (use XILINX_USE_DCACHE instead of ex. CONFIG_XILINX_DCACHE), common/cmd_mfsl.c (use XILINX_FSL_NUMBER instead of ex. CONFIG_XILINX_FSL), serial_xuartlite.c (use XILINX_UARTLITE_BASEADDR, XILINX_UARTLITE_BASEADDR1, ...), and probably also in xilinx_emaclite.c and xilinx_axi_emac.c when we extand a multi-IP support as we have done for the LL TEMAC now. Sure we have to work on, but it's another case (I can make some patches if you want)

Another but not currently existing feasibility would be to generate a U-Boot conform xparameters.h, for example CONFIG_XILINX_LL_TEMAC0_BASE_ADDR instead of XILINX_LLTEMAC_BASEADDR. You and I, we have it in hand. We can change the Xilinx BSP in the near future. You in PataLinux and I in my own home-brewed BSP generator TPOS.

2) Standard initialization vs. multiple direct calls from platform
----------------------------------------------------------------------
Returning to the topic "standard" initialization. The last patch will show the differences bwetween your prefered way to do all in board init and my applicable standard initializition (a single call to the driver). Please look at it in the code and decide for yourself.

We need a forward-looking decision, what kind of initialization, we want to use. Do we want to copy and paste the standard initialization steps from ip core to ip core (board init) and from platform to platform (Microplace, PPC405, PPC440) or make a simple call to the driver?

My preferences is to call the driver from platform and let him run all the necessary steps, that I do not want knowing on platform side.

Hi Stephan,

Quoted 6 lines · Stephan Linz

Hi Michal,

back to your requests and objections I've built up a new patch set for evaluation. Some of the changes relate to the Microblaze platform rather than the network driver.

Quoted 10 lines

1) U-Boot configuration variables vs. xparameters.h
----------------------------------------------------------------------
I've tried to find a compromise between the U-Boot coding and configuration style and your preference. But at least in the point of the many many CPP conditional directives I can not reduce the code. I can move the code only to another place. I need a converstion from the automaticaly generated content of xparameters.h to the U-Boot configuration space. Now you can find this conversion matrix in a new platform header, xconversions.h -- I've placed the header in board/xilinx/microblaze-generic/ I think, we can find a better place.

Sorry I don't like that idea in general. I think that make no sense to create infrastructure for several ll_temac driver in bootloader.

The same code in different location is the same solution which I won't like.

Quoted 14 lines

The conversion matrix avoids all the wrong configuration variables inside U-Boot code beginning with XILINX_ (and not CONFIG_) and we can expand the configuration to new software related options we never get from hardware (example special interface naming). This mechanism can also be used by other driver and platform code, for example arch/microblaze/cpu/cache.c and arch/microblaze/lib/bootm.c (use XILINX_USE_DCACHE instead of ex. CONFIG_XILINX_DCACHE), common/cmd_mfsl.c (use XILINX_FSL_NUMBER instead of ex. CONFIG_XILINX_FSL), serial_xuartlite.c (use XILINX_UARTLITE_BASEADDR, XILINX_UARTLITE_BASEADDR1, ...), and probably also in xilinx_emaclite.c and xilinx_axi_emac.c when we extand a multi-IP support as we have done for the LL TEMAC now. Sure we have to work on, but it's another case (I can make some patches if you want)

I agree that we should use the same variable name if has to start with CONFIG_ prefix.
Based on my experience make more sense to move all functionality and configuration thing to BSP and keep them out of mainline code because none cares in community that we can change almost everything.
That's why u-boot uses xparamters.h, linux dts and 5 kernel parameters.

Creating any conversions out of BSPs is just wrong way and I won't agree with that. If you want to talk about renaming some variables I am ok to do so and I can also change my bsp to cover backward compatibility.

Pretty soon the same situation will be with u-boot for Xilinx Zynq arm platform where we will have to use the same style to be acceptable.

Quoted 5 lines

Another but not currently existing feasibility would be to generate a U-Boot conform xparameters.h, for example CONFIG_XILINX_LL_TEMAC0_BASE_ADDR instead of XILINX_LLTEMAC_BASEADDR. You and I, we have it in hand. We can change the Xilinx BSP in the near future. You in PataLinux and I in my own home-brewed BSP generator TPOS.

As I wrote above. Suggest what we should change and we can do that.

Quoted 7 lines

2) Standard initialization vs. multiple direct calls from platform
----------------------------------------------------------------------
Returning to the topic "standard" initialization. The last patch will show the differences bwetween your prefered way to do all in board init and my applicable standard initializition (a single call to the driver). Please look at it in the code and decide for yourself.

IRC. I describe you how I would like to see that configuration. It should be the same as I use for axiemac and emaclite.

Quoted 8 lines

We need a forward-looking decision, what kind of initialization, we want to use. Do we want to copy and paste the standard initialization steps from ip core to ip core (board init) and from platform to platform (Microplace, PPC405, PPC440) or make a simple call to the driver?

My preferences is to call the driver from platform and let him run all the necessary steps, that I do not want knowing on platform side.

You have to know platform all the time.
I want to keep microblaze-generic platform as simple as possible.

If you are not OK with my preferred way you can of course create your new platform with conversion tables as you like.
In PetaLinux we uses separate platform because of configuration things which lie above of it.

Honestly if I look at patch v10 1/8 my eyes hurting me because the origin patch (v3 or so) had ~670 line of code and yours 1943 and do the same things.
From my point of view I am OK to keep this driver completely out of mainline because
it is based on plb which will be deprecated in near future.
I know that people will still use it for a long time but the question is if make sense to push to mainline.
I will definitely use v3 in PetaLinux and keep things simpler.
Future is axi driver is in the mainline.

Regards,
Michal