]> git.sur5r.net Git - u-boot/commitdiff
Rewrite the miiphybb (Bit-banged MII bus driver) in order to support an arbitrary...
authorLuigi 'Comio' Mantellini <luigi.mantellini@idf-hit.com>
Sat, 10 Oct 2009 10:42:20 +0000 (12:42 +0200)
committerBen Warren <biggerbadderben@gmail.com>
Sun, 11 Oct 2009 06:16:53 +0000 (23:16 -0700)
This feature is useful when your board uses different mii buses for different
phys and all (or a part) of these buses are implemented via bit-banging mode.

The driver requires that the following macros should be defined into the board
configuration file:

CONFIG_BITBANGMII       - Enable the miiphybb driver
CONFIG_BITBANGMII_MULTI - Enable the multi bus support

If the CONFIG_BITBANGMII_MULTI is not defined, the board's config file needs
to define at least the following macros:

MII_INIT      - Generic code to enable the MII bus (optional)
MDIO_DECLARE  - Declaration needed to access to the MDIO pin (optional)
MDIO_ACTIVE   - Activate the MDIO pin as out pin
MDIO_TRISTATE - Activate the MDIO pin as input/tristate pin
MDIO_READ     - Read the MDIO pin
MDIO(v)       - Write v on the MDIO pin
MDC_DECLARE   - Declaration needed to access to the MDC pin (optional)
MDC(v)        - Write v on the MDC pin

The previous macros make the driver compatible with the previous version
(that didn't support the multi-bus).

When the CONFIG_BITBANGMII_MULTI is also defined, the board code needs to fill
the bb_miiphy_buses[] array with a record for each required bus and declare
the bb_miiphy_buses_num variable with the number of mii buses.
The record (struct bb_miiphy_bus) has the following fields/callbacks (see
miiphy.h for details):

char name[]            - The symbolic name that must be equal to the MII bus
                         registered name
int (*init)()          - Initialization function called at startup time (just
                         before the Ethernet initialization)
int (*mdio_active)()   - Activate the MDIO pin as output
int (*mdio_tristate)() - Activate the MDIO pin as input/tristate pin
int (*set_mdio)()      - Write the MDIO pin
int (*get_mdio)()      - Read the MDIO pin
int (*set_mdc)()       - Write the MDC pin
int (*delay)()         - Delay function
void *priv             - Private data used by board specific code

The board code will look like:

struct bb_miiphy_bus bb_miiphy_buses[] = {
 { .name = miibus#1, .init = b1_init, .mdio_active = b1_mdio_active, ... },
 { .name = miibus#2, .init = b2_init, .mdio_active = b2_mdio_active, ... },
 ...
int bb_miiphy_buses_num = sizeof(bb_miiphy_buses) /
                          sizeof(bb_miiphy_buses[0]);

Signed-off-by: Luigi 'Comio' Mantellini <luigi.mantellini@idf-hit.com>
Signed-off-by: Ben Warren <biggerbadderben@gmail.com>
doc/README.bitbangMII [new file with mode: 0644]
drivers/net/phy/miiphybb.c
include/miiphy.h

diff --git a/doc/README.bitbangMII b/doc/README.bitbangMII
new file mode 100644 (file)
index 0000000..edd0856
--- /dev/null
@@ -0,0 +1,56 @@
+This patch rewrites the miiphybb ( Bit-banged MII bus driver ) in order to
+support an arbitrary number of mii buses. This feature is useful when your
+board uses different mii buses for different phys and all (or a part) of these
+buses are implemented via bit-banging mode.
+
+The driver requires that the following macros should be defined into the board
+configuration file:
+
+CONFIG_BITBANGMII       - Enable the miiphybb driver
+CONFIG_BITBANGMII_MULTI - Enable the multi bus support
+
+If the CONFIG_BITBANGMII_MULTI is not defined, the board's config file needs
+to define at least the following macros:
+
+MII_INIT      - Generic code to enable the MII bus (optional)
+MDIO_DECLARE  - Declaration needed to access to the MDIO pin (optional)
+MDIO_ACTIVE   - Activate the MDIO pin as out pin
+MDIO_TRISTATE - Activate the MDIO pin as input/tristate pin
+MDIO_READ     - Read the MDIO pin
+MDIO(v)       - Write v on the MDIO pin
+MDC_DECLARE   - Declaration needed to access to the MDC pin (optional)
+MDC(v)        - Write v on the MDC pin
+
+The previous macros make the driver compatible with the previous version
+(that didn't support the multi-bus).
+
+When the CONFIG_BITBANGMII_MULTI is also defined, the board code needs to fill
+the bb_miiphy_buses[] array with a record for each required bus and declare
+the bb_miiphy_buses_num variable with the number of mii buses.
+The record (struct bb_miiphy_bus) has the following fields/callbacks (see
+miiphy.h for details):
+
+char name[]            - The symbolic name that must be equal to the MII bus
+                         registered name
+int (*init)()          - Initialization function called at startup time (just
+                         before the Ethernet initialization)
+int (*mdio_active)()   - Activate the MDIO pin as output
+int (*mdio_tristate)() - Activate the MDIO pin as input/tristate pin
+int (*set_mdio)()      - Write the MDIO pin
+int (*get_mdio)()      - Read the MDIO pin
+int (*set_mdc)()       - Write the MDC pin
+int (*delay)()         - Delay function
+void *priv             - Private data used by board specific code
+
+The board code will look like:
+
+struct bb_miiphy_bus bb_miiphy_buses[] = {
+ { .name = "miibus#1", .init = b1_init, .mdio_active = b1_mdio_active, ... },
+ { .name = "miibus#2", .init = b2_init, .mdio_active = b2_mdio_active, ... },
+ ...
+};
+int bb_miiphy_buses_num = sizeof(bb_miiphy_buses) /
+                          sizeof(bb_miiphy_buses[0]);
+
+2009 Industrie Dial Face S.p.A.
+     Luigi 'Comio' Mantellini <luigi.mantellini@idf-hit.com>
index b77c917462ad654f53da93d9cf9eac3d0039ecb9..44c45fa66b417da783b9b8701c850fa31d44bde1 100644 (file)
@@ -1,4 +1,7 @@
 /*
+ * (C) Copyright 2009 Industrie Dial Face S.p.A.
+ * Luigi 'Comio' Mantellini <luigi.mantellini@idf-hit.com>
+ *
  * (C) Copyright 2001
  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
  *
 #include <common.h>
 #include <ioports.h>
 #include <ppc_asm.tmpl>
+#include <miiphy.h>
+
+#define BB_MII_RELOCATE(v,off) (v += (v?off:0))
+
+DECLARE_GLOBAL_DATA_PTR;
+
+#ifndef CONFIG_BITBANGMII_MULTI
+
+/*
+ * If CONFIG_BITBANGMII_MULTI is not defined we use a
+ * compatibility layer with the previous miiphybb implementation
+ * based on macros usage.
+ *
+ */
+static int bb_mii_init_wrap(struct bb_miiphy_bus *bus)
+{
+#ifdef MII_INIT
+       MII_INIT;
+#endif
+       return 0;
+}
+
+static int bb_mdio_active_wrap(struct bb_miiphy_bus *bus)
+{
+#ifdef MDIO_DECLARE
+       MDIO_DECLARE;
+#endif
+       MDIO_ACTIVE;
+       return 0;
+}
+
+static int bb_mdio_tristate_wrap(struct bb_miiphy_bus *bus)
+{
+#ifdef MDIO_DECLARE
+       MDIO_DECLARE;
+#endif
+       MDIO_TRISTATE;
+       return 0;
+}
+
+static int bb_set_mdio_wrap(struct bb_miiphy_bus *bus, int v)
+{
+#ifdef MDIO_DECLARE
+       MDIO_DECLARE;
+#endif
+       MDIO(v);
+       return 0;
+}
+
+static int bb_get_mdio_wrap(struct bb_miiphy_bus *bus, int *v)
+{
+#ifdef MDIO_DECLARE
+       MDIO_DECLARE;
+#endif
+       *v = MDIO_READ;
+       return 0;
+}
+
+static int bb_set_mdc_wrap(struct bb_miiphy_bus *bus, int v)
+{
+#ifdef MDC_DECLARE
+       MDC_DECLARE;
+#endif
+       MDC(v);
+       return 0;
+}
+
+static int bb_delay_wrap(struct bb_miiphy_bus *bus)
+{
+       MIIDELAY;
+       return 0;
+}
+
+struct bb_miiphy_bus bb_miiphy_buses[] = {
+       {
+               .name = BB_MII_DEVNAME,
+               .init = bb_mii_init_wrap,
+               .mdio_active = bb_mdio_active_wrap,
+               .mdio_tristate = bb_mdio_tristate_wrap,
+               .set_mdio = bb_set_mdio_wrap,
+               .get_mdio = bb_get_mdio_wrap,
+               .set_mdc = bb_set_mdc_wrap,
+               .delay = bb_delay_wrap,
+       }
+};
+
+int bb_miiphy_buses_num = sizeof(bb_miiphy_buses) /
+                          sizeof(bb_miiphy_buses[0]);
+#endif
+
+void bb_miiphy_init(void)
+{
+       int i;
+
+       for (i = 0; i < bb_miiphy_buses_num; i++) {
+#if !defined(CONFIG_RELOC_FIXUP_WORKS)
+               /* Relocate the hook pointers*/
+               BB_MII_RELOCATE(bb_miiphy_buses[i].init, gd->reloc_off);
+               BB_MII_RELOCATE(bb_miiphy_buses[i].mdio_active, gd->reloc_off);
+               BB_MII_RELOCATE(bb_miiphy_buses[i].mdio_tristate, gd->reloc_off);
+               BB_MII_RELOCATE(bb_miiphy_buses[i].set_mdio, gd->reloc_off);
+               BB_MII_RELOCATE(bb_miiphy_buses[i].get_mdio, gd->reloc_off);
+               BB_MII_RELOCATE(bb_miiphy_buses[i].set_mdc, gd->reloc_off);
+               BB_MII_RELOCATE(bb_miiphy_buses[i].delay, gd->reloc_off);
+#endif
+               if (bb_miiphy_buses[i].init != NULL) {
+                       bb_miiphy_buses[i].init(&bb_miiphy_buses[i]);
+               }
+       }
+}
+
+static inline struct bb_miiphy_bus *bb_miiphy_getbus(char *devname)
+{
+#ifdef CONFIG_BITBANGMII_MULTI
+       int i;
+
+       /* Search the correct bus */
+       for (i = 0; i < bb_miiphy_buses_num; i++) {
+               if (!strcmp(bb_miiphy_buses[i].name, devname)) {
+                       return &bb_miiphy_buses[i];
+               }
+       }
+       return NULL;
+#else
+       /* We have just one bitbanging bus */
+       return &bb_miiphy_buses[0];
+#endif
+}
 
 /*****************************************************************************
  *
  * Utility to send the preamble, address, and register (common to read
  * and write).
  */
-static void miiphy_pre (char read, unsigned char addr, unsigned char reg)
+static void miiphy_pre(struct bb_miiphy_bus *bus, char read,
+                       unsigned char addr, unsigned char reg)
 {
-       int j;                  /* counter */
-#if !(defined(CONFIG_EP8248) || defined(CONFIG_EP82XXM))
-       volatile ioport_t *iop = ioport_addr ((immap_t *) CONFIG_SYS_IMMR, MDIO_PORT);
-#endif
+       int j;
 
        /*
         * Send a 32 bit preamble ('1's) with an extra '1' bit for good measure.
@@ -50,67 +179,66 @@ static void miiphy_pre (char read, unsigned char addr, unsigned char reg)
         * but it is safer and will be much more robust.
         */
 
-       MDIO_ACTIVE;
-       MDIO (1);
+       bus->mdio_active(bus);
+       bus->set_mdio(bus, 1);
        for (j = 0; j < 32; j++) {
-               MDC (0);
-               MIIDELAY;
-               MDC (1);
-               MIIDELAY;
+               bus->set_mdc(bus, 0);
+               bus->delay(bus);
+               bus->set_mdc(bus, 1);
+               bus->delay(bus);
        }
 
        /* send the start bit (01) and the read opcode (10) or write (10) */
-       MDC (0);
-       MDIO (0);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
-       MDC (0);
-       MDIO (1);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
-       MDC (0);
-       MDIO (read);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
-       MDC (0);
-       MDIO (!read);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
+       bus->set_mdc(bus, 0);
+       bus->set_mdio(bus, 0);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
+       bus->set_mdc(bus, 0);
+       bus->set_mdio(bus, 1);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
+       bus->set_mdc(bus, 0);
+       bus->set_mdio(bus, read);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
+       bus->set_mdc(bus, 0);
+       bus->set_mdio(bus, !read);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
 
        /* send the PHY address */
        for (j = 0; j < 5; j++) {
-               MDC (0);
+               bus->set_mdc(bus, 0);
                if ((addr & 0x10) == 0) {
-                       MDIO (0);
+                       bus->set_mdio(bus, 0);
                } else {
-                       MDIO (1);
+                       bus->set_mdio(bus, 1);
                }
-               MIIDELAY;
-               MDC (1);
-               MIIDELAY;
+               bus->delay(bus);
+               bus->set_mdc(bus, 1);
+               bus->delay(bus);
                addr <<= 1;
        }
 
        /* send the register address */
        for (j = 0; j < 5; j++) {
-               MDC (0);
+               bus->set_mdc(bus, 0);
                if ((reg & 0x10) == 0) {
-                       MDIO (0);
+                       bus->set_mdio(bus, 0);
                } else {
-                       MDIO (1);
+                       bus->set_mdio(bus, 1);
                }
-               MIIDELAY;
-               MDC (1);
-               MIIDELAY;
+               bus->delay(bus);
+               bus->set_mdc(bus, 1);
+               bus->delay(bus);
                reg <<= 1;
        }
 }
 
-
 /*****************************************************************************
  *
  * Read a MII PHY register.
@@ -118,63 +246,69 @@ static void miiphy_pre (char read, unsigned char addr, unsigned char reg)
  * Returns:
  *   0 on success
  */
-int bb_miiphy_read (char *devname, unsigned char addr,
-               unsigned char reg, unsigned short *value)
+int bb_miiphy_read(char *devname, unsigned char addr,
+                   unsigned char reg, unsigned short *value)
 {
-       short rdreg;            /* register working value */
-       int j;                  /* counter */
-#if !(defined(CONFIG_EP8248) || defined(CONFIG_EP82XXM))
-       volatile ioport_t *iop = ioport_addr ((immap_t *) CONFIG_SYS_IMMR, MDIO_PORT);
-#endif
+       short rdreg; /* register working value */
+       int v;
+       int j; /* counter */
+       struct bb_miiphy_bus *bus;
+
+       bus = bb_miiphy_getbus(devname);
+       if (bus == NULL) {
+               return -1;
+       }
 
        if (value == NULL) {
                puts("NULL value pointer\n");
-               return (-1);
+               return -1;
        }
 
-       miiphy_pre (1, addr, reg);
+       miiphy_pre (bus, 1, addr, reg);
 
        /* tri-state our MDIO I/O pin so we can read */
-       MDC (0);
-       MDIO_TRISTATE;
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
+       bus->set_mdc(bus, 0);
+       bus->mdio_tristate(bus);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
 
        /* check the turnaround bit: the PHY should be driving it to zero */
-       if (MDIO_READ != 0) {
+       bus->get_mdio(bus, &v);
+       if (v != 0) {
                /* puts ("PHY didn't drive TA low\n"); */
                for (j = 0; j < 32; j++) {
-                       MDC (0);
-                       MIIDELAY;
-                       MDC (1);
-                       MIIDELAY;
+                       bus->set_mdc(bus, 0);
+                       bus->delay(bus);
+                       bus->set_mdc(bus, 1);
+                       bus->delay(bus);
                }
                /* There is no PHY, set value to 0xFFFF and return */
                *value = 0xFFFF;
-               return (-1);
+               return -1;
        }
 
-       MDC (0);
-       MIIDELAY;
+       bus->set_mdc(bus, 0);
+       bus->delay(bus);
 
        /* read 16 bits of register data, MSB first */
        rdreg = 0;
        for (j = 0; j < 16; j++) {
-               MDC (1);
-               MIIDELAY;
+               bus->set_mdc(bus, 1);
+               bus->delay(bus);
                rdreg <<= 1;
-               rdreg |= MDIO_READ;
-               MDC (0);
-               MIIDELAY;
+               bus->get_mdio(bus, &v);
+               rdreg |= (v & 0x1);
+               bus->set_mdc(bus, 0);
+               bus->delay(bus);
        }
 
-       MDC (1);
-       MIIDELAY;
-       MDC (0);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
+       bus->set_mdc(bus, 0);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
 
        *value = rdreg;
 
@@ -194,49 +328,53 @@ int bb_miiphy_read (char *devname, unsigned char addr,
  *   0 on success
  */
 int bb_miiphy_write (char *devname, unsigned char addr,
-               unsigned char reg, unsigned short value)
+                     unsigned char reg, unsigned short value)
 {
+       struct bb_miiphy_bus *bus;
        int j;                  /* counter */
-#if !(defined(CONFIG_EP8248) || defined(CONFIG_EP82XXM))
-       volatile ioport_t *iop = ioport_addr ((immap_t *) CONFIG_SYS_IMMR, MDIO_PORT);
-#endif
 
-       miiphy_pre (0, addr, reg);
+       bus = bb_miiphy_getbus(devname);
+       if (bus == NULL) {
+               /* Bus not found! */
+               return -1;
+       }
+
+       miiphy_pre (bus, 0, addr, reg);
 
        /* send the turnaround (10) */
-       MDC (0);
-       MDIO (1);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
-       MDC (0);
-       MDIO (0);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
+       bus->set_mdc(bus, 0);
+       bus->set_mdio(bus, 1);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
+       bus->set_mdc(bus, 0);
+       bus->set_mdio(bus, 0);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
 
        /* write 16 bits of register data, MSB first */
        for (j = 0; j < 16; j++) {
-               MDC (0);
+               bus->set_mdc(bus, 0);
                if ((value & 0x00008000) == 0) {
-                       MDIO (0);
+                       bus->set_mdio(bus, 0);
                } else {
-                       MDIO (1);
+                       bus->set_mdio(bus, 1);
                }
-               MIIDELAY;
-               MDC (1);
-               MIIDELAY;
+               bus->delay(bus);
+               bus->set_mdc(bus, 1);
+               bus->delay(bus);
                value <<= 1;
        }
 
        /*
         * Tri-state the MDIO line.
         */
-       MDIO_TRISTATE;
-       MDC (0);
-       MIIDELAY;
-       MDC (1);
-       MIIDELAY;
+       bus->mdio_tristate(bus);
+       bus->set_mdc(bus, 0);
+       bus->delay(bus);
+       bus->set_mdc(bus, 1);
+       bus->delay(bus);
 
        return 0;
-}
+}
\ No newline at end of file
index fa33ec7f71d5a70b053f383534805db896e8ea3d..53621252330f4923a43c0876745c3348a3e3637e 100644 (file)
@@ -19,6 +19,8 @@
 |
 |      COPYRIGHT   I B M   CORPORATION 1999
 |      LICENSED MATERIAL  -  PROGRAM PROPERTY OF I B M
+|
+|   Additions (C) Copyright 2009 Industrie Dial Face S.p.A.
 +----------------------------------------------------------------------------*/
 /*----------------------------------------------------------------------------+
 |
@@ -61,12 +63,33 @@ char *miiphy_get_current_dev (void);
 
 void miiphy_listdev (void);
 
-#define BB_MII_DEVNAME "bbmii"
+#ifdef CONFIG_BITBANGMII
+
+#define BB_MII_DEVNAME "bb_miiphy"
+
+struct bb_miiphy_bus {
+       char name[NAMESIZE];
+       int (*init)(struct bb_miiphy_bus *bus);
+       int (*mdio_active)(struct bb_miiphy_bus *bus);
+       int (*mdio_tristate)(struct bb_miiphy_bus *bus);
+       int (*set_mdio)(struct bb_miiphy_bus *bus, int v);
+       int (*get_mdio)(struct bb_miiphy_bus *bus, int *v);
+       int (*set_mdc)(struct bb_miiphy_bus *bus, int v);
+       int (*delay)(struct bb_miiphy_bus *bus);
+#ifdef CONFIG_BITBANGMII_MULTI
+       void *priv;
+#endif
+};
+
+extern struct bb_miiphy_bus bb_miiphy_buses[];
+extern int bb_miiphy_buses_num;
 
+void bb_miiphy_init (void);
 int bb_miiphy_read (char *devname, unsigned char addr,
                    unsigned char reg, unsigned short *value);
 int bb_miiphy_write (char *devname, unsigned char addr,
                     unsigned char reg, unsigned short value);
+#endif
 
 /* phy seed setup */
 #define AUTO                   99