ppc4xx: Cleanup PPC4xx I2C infrastructure
authorStefan Roese <sr@denx.de>
Thu, 19 Nov 2009 13:03:17 +0000 (14:03 +0100)
committerStefan Roese <sr@denx.de>
Mon, 23 Nov 2009 15:27:02 +0000 (16:27 +0100)
This patch cleans up the PPC4xx I2C intrastructure:

- Use C struct to describe the I2C registers instead of defines
- Coding style cleanup (braces, whitespace, comments, line length)
- Extract common code from i2c_read() and i2c_write()
- Remove unneeded IIC defines from ppc405.h & ppc440.h

Signed-off-by: Stefan Roese <sr@denx.de>
cpu/ppc4xx/i2c.c
include/4xx_i2c.h
include/ppc405.h
include/ppc440.h

index e3e1bab64f5473ad8fe71d1cd9fb08bd7352581f..7976e75e0ba2d01e533c2947e20af9ee9ef54054 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright 2007
+ * (C) Copyright 2007-2009
  * Stefan Roese, DENX Software Engineering, sr@denx.de.
  *
  * based on work by Anne Sophie Harnois <anne-sophie.harnois@nextream.fr>
@@ -37,7 +37,8 @@
 DECLARE_GLOBAL_DATA_PTR;
 
 #if defined(CONFIG_I2C_MULTI_BUS)
-/* Initialize the bus pointer to whatever one the SPD EEPROM is on.
+/*
+ * Initialize the bus pointer to whatever one the SPD EEPROM is on.
  * Default is bus 0.  This is necessary because the DDR initialization
  * runs from ROM, and we can't switch buses because we can't modify
  * the global variables.
@@ -45,59 +46,63 @@ DECLARE_GLOBAL_DATA_PTR;
 #ifndef CONFIG_SYS_SPD_BUS_NUM
 #define CONFIG_SYS_SPD_BUS_NUM 0
 #endif
-static unsigned int i2c_bus_num __attribute__ ((section (".data"))) = CONFIG_SYS_SPD_BUS_NUM;
+static unsigned int i2c_bus_num __attribute__ ((section (".data"))) =
+       CONFIG_SYS_SPD_BUS_NUM;
 #endif /* CONFIG_I2C_MULTI_BUS */
 
 static void _i2c_bus_reset(void)
 {
+       struct ppc4xx_i2c *i2c = (struct ppc4xx_i2c *)I2C_BASE_ADDR;
        int i;
        u8 dc;
 
        /* Reset status register */
        /* write 1 in SCMP and IRQA to clear these fields */
-       out_8((u8 *)IIC_STS, 0x0A);
+       out_8(&i2c->sts, 0x0A);
 
        /* write 1 in IRQP IRQD LA ICT XFRA to clear these fields */
-       out_8((u8 *)IIC_EXTSTS, 0x8F);
+       out_8(&i2c->extsts, 0x8F);
 
        /* Place chip in the reset state */
-       out_8((u8 *)IIC_XTCNTLSS, IIC_XTCNTLSS_SRST);
+       out_8(&i2c->xtcntlss, IIC_XTCNTLSS_SRST);
 
        /* Check if bus is free */
-       dc = in_8((u8 *)IIC_DIRECTCNTL);
+       dc = in_8(&i2c->directcntl);
        if (!DIRCTNL_FREE(dc)){
                /* Try to set bus free state */
-               out_8((u8 *)IIC_DIRECTCNTL, IIC_DIRCNTL_SDAC | IIC_DIRCNTL_SCC);
+               out_8(&i2c->directcntl, IIC_DIRCNTL_SDAC | IIC_DIRCNTL_SCC);
 
                /* Wait until we regain bus control */
                for (i = 0; i < 100; ++i) {
-                       dc = in_8((u8 *)IIC_DIRECTCNTL);
+                       dc = in_8(&i2c->directcntl);
                        if (DIRCTNL_FREE(dc))
                                break;
 
                        /* Toggle SCL line */
                        dc ^= IIC_DIRCNTL_SCC;
-                       out_8((u8 *)IIC_DIRECTCNTL, dc);
+                       out_8(&i2c->directcntl, dc);
                        udelay(10);
                        dc ^= IIC_DIRCNTL_SCC;
-                       out_8((u8 *)IIC_DIRECTCNTL, dc);
+                       out_8(&i2c->directcntl, dc);
                }
        }
 
        /* Remove reset */
-       out_8((u8 *)IIC_XTCNTLSS, 0);
+       out_8(&i2c->xtcntlss, 0);
 }
 
-void i2c_init(int speed, int slaveadd)
+void i2c_init(int speed, int slaveaddr)
 {
-       unsigned long freqOPB;
+       struct ppc4xx_i2c *i2c = (struct ppc4xx_i2c *)I2C_BASE_ADDR;
        int val, divisor;
        int bus;
 
 #ifdef CONFIG_SYS_I2C_INIT_BOARD
-       /* call board specific i2c bus reset routine before accessing the   */
-       /* environment, which might be in a chip on that bus. For details   */
-       /* about this problem see doc/I2C_Edge_Conditions.                  */
+       /*
+        * Call board specific i2c bus reset routine before accessing the
+        * environment, which might be in a chip on that bus. For details
+        * about this problem see doc/I2C_Edge_Conditions.
+        */
        i2c_init_board();
 #endif
 
@@ -109,54 +114,52 @@ void i2c_init(int speed, int slaveadd)
                _i2c_bus_reset();
 
                /* clear lo master address */
-               out_8((u8 *)IIC_LMADR, 0);
+               out_8(&i2c->lmadr, 0);
 
                /* clear hi master address */
-               out_8((u8 *)IIC_HMADR, 0);
+               out_8(&i2c->hmadr, 0);
 
                /* clear lo slave address */
-               out_8((u8 *)IIC_LSADR, 0);
+               out_8(&i2c->lsadr, 0);
 
                /* clear hi slave address */
-               out_8((u8 *)IIC_HSADR, 0);
+               out_8(&i2c->hsadr, 0);
 
                /* Clock divide Register */
-               /* get OPB frequency */
-               freqOPB = get_OPB_freq();
-               /* set divisor according to freqOPB */
-               divisor = (freqOPB - 1) / 10000000;
+               /* set divisor according to freq_opb */
+               divisor = (get_OPB_freq() - 1) / 10000000;
                if (divisor == 0)
                        divisor = 1;
-               out_8((u8 *)IIC_CLKDIV, divisor);
+               out_8(&i2c->clkdiv, divisor);
 
                /* no interrupts */
-               out_8((u8 *)IIC_INTRMSK, 0);
+               out_8(&i2c->intrmsk, 0);
 
                /* clear transfer count */
-               out_8((u8 *)IIC_XFRCNT, 0);
+               out_8(&i2c->xfrcnt, 0);
 
                /* clear extended control & stat */
                /* write 1 in SRC SRS SWC SWS to clear these fields */
-               out_8((u8 *)IIC_XTCNTLSS, 0xF0);
+               out_8(&i2c->xtcntlss, 0xF0);
 
                /* Mode Control Register
                   Flush Slave/Master data buffer */
-               out_8((u8 *)IIC_MDCNTL, IIC_MDCNTL_FSDB | IIC_MDCNTL_FMDB);
+               out_8(&i2c->mdcntl, IIC_MDCNTL_FSDB | IIC_MDCNTL_FMDB);
 
-               val = in_8((u8 *)IIC_MDCNTL);
+               val = in_8(&i2c->mdcntl);
 
                /* Ignore General Call, slave transfers are ignored,
                 * disable interrupts, exit unknown bus state, enable hold
                 * SCL 100kHz normaly or FastMode for 400kHz and above
                 */
 
-               val |= IIC_MDCNTL_EUBS|IIC_MDCNTL_HSCL;
+               val |= IIC_MDCNTL_EUBS | IIC_MDCNTL_HSCL;
                if (speed >= 400000)
                        val |= IIC_MDCNTL_FSM;
-               out_8((u8 *)IIC_MDCNTL, val);
+               out_8(&i2c->mdcntl, val);
 
                /* clear control reg */
-               out_8((u8 *)IIC_CNTL, 0x00);
+               out_8(&i2c->cntl, 0x00);
        }
 
        /* set to SPD bus as default bus upon powerup */
@@ -195,13 +198,14 @@ static int i2c_transfer(unsigned char cmd_type,
                        unsigned char data[],
                        unsigned short data_len)
 {
-       unsigned char* ptr;
+       struct ppc4xx_i2c *i2c = (struct ppc4xx_i2c *)I2C_BASE_ADDR;
+       u8 *ptr;
        int reading;
-       int tran,cnt;
+       int tran, cnt;
        int result;
        int status;
        int i;
-       uchar creg;
+       u8 creg;
 
        if (data == 0 || data_len == 0) {
                /* Don't support data transfer of no length or to address 0 */
@@ -219,12 +223,13 @@ static int i2c_transfer(unsigned char cmd_type,
        }
 
        /* Clear Stop Complete Bit */
-       out_8((u8 *)IIC_STS, IIC_STS_SCMP);
+       out_8(&i2c->sts, IIC_STS_SCMP);
+
        /* Check init */
        i = 10;
        do {
                /* Get status */
-               status = in_8((u8 *)IIC_STS);
+               status = in_8(&i2c->sts);
                i--;
        } while ((status & IIC_STS_PT) && (i > 0));
 
@@ -232,13 +237,16 @@ static int i2c_transfer(unsigned char cmd_type,
                result = IIC_NOK_TOUT;
                return(result);
        }
+
        /* flush the Master/Slave Databuffers */
-       out_8((u8 *)IIC_MDCNTL, ((in_8((u8 *)IIC_MDCNTL))|IIC_MDCNTL_FMDB|IIC_MDCNTL_FSDB));
+       out_8(&i2c->mdcntl, in_8(&i2c->mdcntl) |
+             IIC_MDCNTL_FMDB | IIC_MDCNTL_FSDB);
+
        /* need to wait 4 OPB clocks? code below should take that long */
 
        /* 7-bit adressing */
-       out_8((u8 *)IIC_HMADR, 0);
-       out_8((u8 *)IIC_LMADR, chip);
+       out_8(&i2c->hmadr, 0);
+       out_8(&i2c->lmadr, chip);
 
        tran = 0;
        result = IIC_OK;
@@ -247,9 +255,10 @@ static int i2c_transfer(unsigned char cmd_type,
        while (tran != cnt && (result == IIC_OK)) {
                int  bc,j;
 
-               /* Control register =
-                * Normal transfer, 7-bits adressing, Transfer up to bc bytes, Normal start,
-                * Transfer is a sequence of transfers
+               /*
+                * Control register =
+                * Normal transfer, 7-bits adressing, Transfer up to
+                * bc bytes, Normal start, Transfer is a sequence of transfers
                 */
                creg |= IIC_CNTL_PT;
 
@@ -259,32 +268,36 @@ static int i2c_transfer(unsigned char cmd_type,
                if ((!cmd_type && (ptr == addr)) || ((tran + bc) != cnt))
                        creg |= IIC_CNTL_CHT;
 
-               if (reading)
+               if (reading) {
                        creg |= IIC_CNTL_READ;
-               else
-                       for(j=0; j < bc; j++)
+               } else {
+                       for(j = 0; j < bc; j++) {
                                /* Set buffer */
-                               out_8((u8 *)IIC_MDBUF, ptr[tran+j]);
-               out_8((u8 *)IIC_CNTL, creg);
+                               out_8(&i2c->mdbuf, ptr[tran + j]);
+                       }
+               }
+               out_8(&i2c->cntl, creg);
 
-               /* Transfer is in progress
+               /*
+                * Transfer is in progress
                 * we have to wait for upto 5 bytes of data
                 * 1 byte chip address+r/w bit then bc bytes
                 * of data.
                 * udelay(10) is 1 bit time at 100khz
                 * Doubled for slop. 20 is too small.
                 */
-               i = 2*5*8;
+               i = 2 * 5 * 8;
                do {
                        /* Get status */
-                       status = in_8((u8 *)IIC_STS);
+                       status = in_8(&i2c->sts);
                        udelay(10);
                        i--;
-               } while ((status & IIC_STS_PT) && !(status & IIC_STS_ERR) && (i > 0));
+               } while ((status & IIC_STS_PT) && !(status & IIC_STS_ERR) &&
+                        (i > 0));
 
                if (status & IIC_STS_ERR) {
                        result = IIC_NOK;
-                       status = in_8((u8 *)IIC_EXTSTS);
+                       status = in_8(&i2c->extsts);
                        /* Lost arbitration? */
                        if (status & IIC_EXTSTS_LA)
                                result = IIC_NOK_LA;
@@ -297,19 +310,21 @@ static int i2c_transfer(unsigned char cmd_type,
                } else if ( status & IIC_STS_PT) {
                        result = IIC_NOK_TOUT;
                }
+
                /* Command is reading => get buffer */
                if ((reading) && (result == IIC_OK)) {
                        /* Are there data in buffer */
                        if (status & IIC_STS_MDBS) {
                                /*
-                                * even if we have data we have to wait 4OPB clocks
-                                * for it to hit the front of the FIFO, after that
-                                * we can just read. We should check XFCNT here and
-                                * if the FIFO is full there is no need to wait.
+                                * even if we have data we have to wait 4OPB
+                                * clocks for it to hit the front of the FIFO,
+                                * after that we can just read. We should check
+                                * XFCNT here and if the FIFO is full there is
+                                * no need to wait.
                                 */
                                udelay(1);
-                               for (j=0; j<bc; j++)
-                                       ptr[tran+j] = in_8((u8 *)IIC_MDBUF);
+                               for (j = 0; j < bc; j++)
+                                       ptr[tran + j] = in_8(&i2c->mdbuf);
                        } else
                                result = IIC_NOK_DATA;
                }
@@ -324,7 +339,7 @@ static int i2c_transfer(unsigned char cmd_type,
                                creg = IIC_CNTL_RPST;
                }
        }
-       return (result);
+       return result;
 }
 
 int i2c_probe(uchar chip)
@@ -338,17 +353,17 @@ int i2c_probe(uchar chip)
         * address was <ACK>ed (i.e. there was a chip at that address which
         * drove the data line low).
         */
-       return (i2c_transfer(1, chip << 1, 0,0, buf, 1) != 0);
+       return (i2c_transfer(1, chip << 1, 0, 0, buf, 1) != 0);
 }
 
-
-int i2c_read(uchar chip, uint addr, int alen, uchar * buffer, int len)
+static int ppc4xx_i2c_transfer(uchar chip, uint addr, int alen, uchar *buffer,
+                              int len, int read)
 {
        uchar xaddr[4];
        int ret;
 
        if (alen > 4) {
-               printf ("I2C read: addr len %d not supported\n", alen);
+               printf("I2C: addr len %d not supported\n", alen);
                return 1;
        }
 
@@ -373,50 +388,30 @@ int i2c_read(uchar chip, uint addr, int alen, uchar * buffer, int len)
         * hidden in the chip address.
         */
        if (alen > 0)
-               chip |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
+               chip |= ((addr >> (alen * 8)) &
+                        CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
 #endif
-       if ((ret = i2c_transfer(1, chip<<1, &xaddr[4-alen], alen, buffer, len)) != 0) {
-               if (gd->have_console)
-                       printf( "I2c read: failed %d\n", ret);
+       if ((ret = i2c_transfer(read, chip << 1, &xaddr[4 - alen], alen,
+                               buffer, len)) != 0) {
+               if (gd->have_console) {
+                       printf("I2C %s: failed %d\n",
+                              read ? "read" : "write", ret);
+               }
+
                return 1;
        }
+
        return 0;
 }
 
-int i2c_write(uchar chip, uint addr, int alen, uchar * buffer, int len)
+int i2c_read(uchar chip, uint addr, int alen, uchar * buffer, int len)
 {
-       uchar xaddr[4];
-
-       if (alen > 4) {
-               printf ("I2C write: addr len %d not supported\n", alen);
-               return 1;
-
-       }
-
-       if (alen > 0) {
-               xaddr[0] = (addr >> 24) & 0xFF;
-               xaddr[1] = (addr >> 16) & 0xFF;
-               xaddr[2] = (addr >> 8) & 0xFF;
-               xaddr[3] = addr & 0xFF;
-       }
-
-#ifdef CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW
-       /*
-        * EEPROM chips that implement "address overflow" are ones
-        * like Catalyst 24WC04/08/16 which has 9/10/11 bits of
-        * address and the extra bits end up in the "chip address"
-        * bit slots. This makes a 24WC08 (1Kbyte) chip look like
-        * four 256 byte chips.
-        *
-        * Note that we consider the length of the address field to
-        * still be one byte because the extra address bits are
-        * hidden in the chip address.
-        */
-       if (alen > 0)
-               chip |= ((addr >> (alen * 8)) & CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW);
-#endif
+       return ppc4xx_i2c_transfer(chip, addr, alen, buffer, len, 1);
+}
 
-       return (i2c_transfer(0, chip<<1, &xaddr[4-alen], alen, buffer, len ) != 0);
+int i2c_write(uchar chip, uint addr, int alen, uchar * buffer, int len)
+{
+       return ppc4xx_i2c_transfer(chip, addr, alen, buffer, len, 0);
 }
 
 #if defined(CONFIG_I2C_MULTI_BUS)
index 070657fbb6663a2ffb9f4c4a5562463c35e333e2..0c6c926f73174bf0573889ab30e7037f3abf2518 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * (C) Copyright 2007
+ * (C) Copyright 2007-2009
  * Stefan Roese, DENX Software Engineering, sr@denx.de.
  *
  * See file CREDITS for list of people who contributed to this
 #define I2C_BASE_ADDR  (0xEF600500 + I2C_BUS_OFFS)
 #endif
 
-#define I2C_REGISTERS_BASE_ADDRESS I2C_BASE_ADDR
-#define IIC_MDBUF      (I2C_REGISTERS_BASE_ADDRESS+IICMDBUF)
-#define IIC_SDBUF      (I2C_REGISTERS_BASE_ADDRESS+IICSDBUF)
-#define IIC_LMADR      (I2C_REGISTERS_BASE_ADDRESS+IICLMADR)
-#define IIC_HMADR      (I2C_REGISTERS_BASE_ADDRESS+IICHMADR)
-#define IIC_CNTL       (I2C_REGISTERS_BASE_ADDRESS+IICCNTL)
-#define IIC_MDCNTL     (I2C_REGISTERS_BASE_ADDRESS+IICMDCNTL)
-#define IIC_STS                (I2C_REGISTERS_BASE_ADDRESS+IICSTS)
-#define IIC_EXTSTS     (I2C_REGISTERS_BASE_ADDRESS+IICEXTSTS)
-#define IIC_LSADR      (I2C_REGISTERS_BASE_ADDRESS+IICLSADR)
-#define IIC_HSADR      (I2C_REGISTERS_BASE_ADDRESS+IICHSADR)
-#define IIC_CLKDIV     (I2C_REGISTERS_BASE_ADDRESS+IIC0_CLKDIV)
-#define IIC_INTRMSK    (I2C_REGISTERS_BASE_ADDRESS+IICINTRMSK)
-#define IIC_XFRCNT     (I2C_REGISTERS_BASE_ADDRESS+IICXFRCNT)
-#define IIC_XTCNTLSS   (I2C_REGISTERS_BASE_ADDRESS+IICXTCNTLSS)
-#define IIC_DIRECTCNTL (I2C_REGISTERS_BASE_ADDRESS+IICDIRECTCNTL)
+struct ppc4xx_i2c {
+       u8 mdbuf;
+       u8 res1;
+       u8 sdbuf;
+       u8 res2;
+       u8 lmadr;
+       u8 hmadr;
+       u8 cntl;
+       u8 mdcntl;
+       u8 sts;
+       u8 extsts;
+       u8 lsadr;
+       u8 hsadr;
+       u8 clkdiv;
+       u8 intrmsk;
+       u8 xfrcnt;
+       u8 xtcntlss;
+       u8 directcntl;
+       u8 intr;
+};
 
 /* MDCNTL Register Bit definition */
 #define IIC_MDCNTL_HSCL                0x01
index 508c77b14e54f2f1db0e146f140a81fddded1422..bc2d051fc789de3b088413ac6ef98668ea4651e5 100644 (file)
 #define        MAL0_RCBS16     (MAL_DCR_BASE + 0x70) /* RX 16 Channel buffer size */
 #define        MAL0_RCBS24     (MAL_DCR_BASE + 0x78) /* RX 24 Channel buffer size */
 
-/*-----------------------------------------------------------------------------
-| IIC Register Offsets
-'----------------------------------------------------------------------------*/
-#define    IICMDBUF        0x00
-#define    IICSDBUF        0x02
-#define    IICLMADR        0x04
-#define    IICHMADR        0x05
-#define    IICCNTL         0x06
-#define    IICMDCNTL       0x07
-#define    IICSTS          0x08
-#define    IICEXTSTS       0x09
-#define    IICLSADR        0x0A
-#define    IICHSADR        0x0B
-#define    IIC0_CLKDIV     0x0C
-#define    IICINTRMSK      0x0D
-#define    IICXFRCNT       0x0E
-#define    IICXTCNTLSS     0x0F
-#define    IICDIRECTCNTL    0x10
-
 /*-----------------------------------------------------------------------------
 | UART Register Offsets
 '----------------------------------------------------------------------------*/
index a050ffd1c0c99468f8d5f3b81e50e9afe9ef00e4..e60fa13905e7d0eae5ef2bb3554fd9da4a516387 100644 (file)
 #define CPR0_PERD_PERDV0_MASK  0x07000000
 #endif
 
-/*-----------------------------------------------------------------------------
-| IIC Register Offsets
-'----------------------------------------------------------------------------*/
-#define IICMDBUF               0x00
-#define IICSDBUF               0x02
-#define IICLMADR               0x04
-#define IICHMADR               0x05
-#define IICCNTL                        0x06
-#define IICMDCNTL              0x07
-#define IICSTS                 0x08
-#define IICEXTSTS              0x09
-#define IICLSADR               0x0A
-#define IICHSADR               0x0B
-#define IIC0_CLKDIV            0x0C
-#define IICINTRMSK             0x0D
-#define IICXFRCNT              0x0E
-#define IICXTCNTLSS            0x0F
-#define IICDIRECTCNTL          0x10
-
 /*-----------------------------------------------------------------------------
 | PCI Internal Registers et. al. (accessed via plb)
 +----------------------------------------------------------------------------*/