Skip to contentSkip to conversation

i2c, mpc83xx: add CONFIG_SYS_I2C_INIT_BOARD for fsl_i2c

PATCH New Heiko Schocher 2 participants 6 messages Jan 28, 2009 I2C

lore
Share & tools
lore
#0 lore raw

PATCH 19/31 i2c, mpc83xx: add CONFIG_SYS_I2C_INIT_BOARD for fsl_i2c

This patch adds the possibility to call a board specific i2c bus reset routine for the fsl_i2c bus driver, and adds this option for the keymile kmeter1 board.

---
 board/keymile/common/common.c |   14 ++++++++++++++
 drivers/i2c/fsl_i2c.c         |    6 ++++++
 include/configs/kmeter1.h     |    1 +
 3 files changed, 21 insertions(+), 0 deletions(-)
board/keymile/common/common.c +14 -0
index 17312b5..a282421 100644
@@ -421,6 +421,7 @@ static int get_scl (void)
 
 #endif
 
+#if !defined(CONFIG_KMETER1)
 static void writeStartSeq (void)
 {
 	set_sda (1);
@@ -471,6 +472,7 @@ static int i2c_make_abort (void)
 	get_sda ();
 	return ret;
 }
+#endif
 
 /**
  * i2c_init_board - reset i2c bus. When the board is powercycled during a
@@ -478,6 +480,17 @@ static int i2c_make_abort (void)
  */
 void i2c_init_board(void)
 {
+#if defined(CONFIG_KMETER1)
+	struct fsl_i2c *dev;
+	dev = (struct fsl_i2c *) (CONFIG_SYS_IMMR + CONFIG_SYS_I2C_OFFSET);
+	uchar	dummy;
+
+	out_8 (&dev->cr, (I2C_CR_MSTA));
+	out_8 (&dev->cr, (I2C_CR_MEN | I2C_CR_MSTA));
+	dummy = in_8(&dev->dr);
+	out_8 (&dev->cr, (I2C_CR_MEN));
+
+#else
 #if defined(CONFIG_HARD_I2C)
 	volatile immap_t *immap = (immap_t *)CONFIG_SYS_IMMR ;
 	volatile i2c8260_t *i2c	= (i2c8260_t *)&immap->im_i2c;
@@ -497,6 +510,7 @@ void i2c_init_board(void)
 	/* Set the PortPins back to use for I2C */
 	setports (0);
 #endif
+#endif
 }
 #endif
 #endif
drivers/i2c/fsl_i2c.c +6 -0
index 5242884..7ba5ab1 100644
@@ -176,6 +176,12 @@ i2c_init(int speed, int slaveadd)
 	struct fsl_i2c *dev;
 	unsigned int temp;
 
+#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.                  */
+	i2c_init_board();
+#endif
 	dev = (struct fsl_i2c *) (CONFIG_SYS_IMMR + CONFIG_SYS_I2C_OFFSET);
 
 	writeb(0, &dev->cr);			/* stop I2C controller */
include/configs/kmeter1.h +1 -0
index 17ddcec..31e5cd6 100644
@@ -316,6 +316,7 @@
 #define CONFIG_SYS_I2C_OFFSET	0x3000
 
 #define CONFIG_SYS_MAX_I2C_BUS		2
+#define CONFIG_SYS_I2C_INIT_BOARD	1
 #define CONFIG_I2C_MUX		1
 
 /* EEprom support */
Signature · 5 lines
1.6.0.6

-- 
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
#1 lore raw

PATCH 19/31 i2c, mpc83xx: add CONFIG_SYS_I2C_INIT_BOARD for fsl_i2c

Quoted 5 lines

This patch adds the possibility to call a board specific i2c bus reset routine for the fsl_i2c bus driver, and adds this option for the keymile kmeter1 board.

Review

Quoted 8 lines
---
 board/keymile/common/common.c |   14 ++++++++++++++
 drivers/i2c/fsl_i2c.c         |    6 ++++++
 include/configs/kmeter1.h     |    1 +
 3 files changed, 21 insertions(+), 0 deletions(-)
(quoted diff) +0 -0

b/board/keymile/common/common.c

Quoted 12 lines

index 17312b5..a282421 100644

board/keymile/common/common.c +1 -0
@@ -421,6 +421,7 @@ static int get_scl (void)
 
 #endif
 
+#if !defined(CONFIG_KMETER1)
 static void writeStartSeq (void)
 {
    set_sda (1);

board/keymile/common/common.c static int i2c_make_abort (void) · line 478

Quoted 7 lines
board/keymile/common/common.c +1 -0
@@ -471,6 +472,7 @@ static int i2c_make_abort (void)
    get_sda ();
    return ret;
 }
+#endif
 
 /**
  * i2c_init_board - reset i2c bus. When the board is powercycled during 

a

board/keymile/common/common.c static int i2c_make_abort (void) · line 491

Quoted 13 lines
board/keymile/common/common.c +9 -0
@@ -478,6 +480,17 @@ static int i2c_make_abort (void)
  */
 void i2c_init_board(void)
 {
+#if defined(CONFIG_KMETER1)
+   struct fsl_i2c *dev;
+   dev = (struct fsl_i2c *) (CONFIG_SYS_IMMR + CONFIG_SYS_I2C_OFFSET);
+   uchar   dummy;
+
+   out_8 (&dev->cr, (I2C_CR_MSTA));
+   out_8 (&dev->cr, (I2C_CR_MEN | I2C_CR_MSTA));
+   dummy = in_8(&dev->dr);
+   out_8 (&dev->cr, (I2C_CR_MEN));

Are you sure this will generate a proper I2C reset sequence? We also use this controller and I tried to do it too but didn't find a way. I then asked
Freescale and they could not come up with a solution either.

Jocke

#2 lore raw

PATCH 19/31 i2c, mpc83xx: add CONFIG_SYS_I2C_INIT_BOARD for fsl_i2c

Hello Joakim,

Quoted 4 lines · Joakim Tjernlund
Quoted 4 lines

This patch adds the possibility to call a board specific i2c bus reset routine for the fsl_i2c bus driver, and adds this option for the keymile kmeter1 board.

[...]

Quoted 10 lines
Quoted 10 lines
board/keymile/common/common.c +6 -0
@@ -478,6 +480,17 @@ static int i2c_make_abort (void)
  */
 void i2c_init_board(void)
 {
+#if defined(CONFIG_KMETER1)
+   struct fsl_i2c *dev;
+   dev = (struct fsl_i2c *) (CONFIG_SYS_IMMR + CONFIG_SYS_I2C_OFFSET);
+   uchar   dummy;
+
+   out_8 (&dev->cr, (I2C_CR_MSTA));
Quoted 8 lines

board/keymile/common/common.c static int i2c_make_abort (void) · line 491

Quoted 3 lines
board/keymile/common/common.c +3 -0
+   out_8 (&dev->cr, (I2C_CR_MEN | I2C_CR_MSTA));
+   dummy = in_8(&dev->dr);
+   out_8 (&dev->cr, (I2C_CR_MEN));

Are you sure this will generate a proper I2C reset sequence? We also use this controller and I tried to do it too but didn't find a way. I then asked
Freescale and they could not come up with a solution either.

?
This routine is decribed in the MPC8260ERM.pdf ?15.5.7 on page 15-23 from Freescale!

15.5.7 Generation of SCLn when SDAn is Negated
It is sometimes necessary to force the I2C module to become the I2C bus master out of reset and drive SCLn (even though SDAn may already be driven, which indicates that the bus is busy). This can occur when a system reset does not cause all I2C devices to be reset. Thus, SDAn can be negated low by another I2C device while this I2C module is coming out of reset and will stay low indefinitely. The following procedure can be used to force this I2C module to generate SCLn so that the device driving SDAn can finish its transaction:
1. Disable the I2C module and set the master bit by setting I2CnCR to 0x20.
2. Enable the I2C module by setting I2CnCR to 0xA0.
3. Read I2CnDR.
4. Return the I2C module to slave mode by setting I2CnCR to 0x80.

And this worked fine on our Hardware ...

bye
Heiko

Signature · 2 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
#3 lore raw

PATCH 19/31 i2c, mpc83xx: add CONFIG_SYS_I2C_INIT_BOARD for fsl_i2c

Heiko Schocher <[email protected]> wrote on 28/01/2009 11:54:22:

Quoted 7 lines

Hello Joakim,

Quoted 4 lines · Joakim Tjernlund
Quoted 4 lines

This patch adds the possibility to call a board specific i2c bus reset routine for the fsl_i2c bus driver, and adds this option for the keymile kmeter1 board.

Quoted 8 lines

[...]

Quoted 7 lines

board/keymile/common/common.c static int i2c_make_abort (void) · line 485

Quoted 7 lines
board/keymile/common/common.c +3 -0
@@ -478,6 +480,17 @@ static int i2c_make_abort (void)
  */
 void i2c_init_board(void)
 {
+#if defined(CONFIG_KMETER1)
+   struct fsl_i2c *dev;
+   dev = (struct fsl_i2c *) (CONFIG_SYS_IMMR + 

CONFIG_SYS_I2C_OFFSET);

Quoted 9 lines
Quoted 9 lines

board/keymile/common/common.c static int i2c_make_abort (void) · line 491

Quoted 6 lines
board/keymile/common/common.c +6 -0
+   uchar   dummy;
+
+   out_8 (&dev->cr, (I2C_CR_MSTA));
+   out_8 (&dev->cr, (I2C_CR_MEN | I2C_CR_MSTA));
+   dummy = in_8(&dev->dr);
+   out_8 (&dev->cr, (I2C_CR_MEN));

Are you sure this will generate a proper I2C reset sequence? We also use this controller and I tried to do it too but didn't find a way. I

then

Quoted 9 lines
Quoted 2 lines

asked
Freescale and they could not come up with a solution either.

?
This routine is decribed in the MPC8260ERM.pdf ?15.5.7 on page 15-23 from Freescale!

15.5.7 Generation of SCLn when SDAn is Negated
It is sometimes necessary to force the I2C module to become the I2C bus

master out of reset and drive

Quoted 1 line

SCLn (even though SDAn may already be driven, which indicates that the

bus is busy). This can occur

Quoted 1 line

when a system reset does not cause all I2C devices to be reset. Thus,

SDAn can be negated low by another

Quoted 1 line

I2C device while this I2C module is coming out of reset and will stay

low indefinitely. The following

Quoted 1 line

procedure can be used to force this I2C module to generate SCLn so that

the device driving SDAn can

Quoted 2 lines

finish its transaction:
1. Disable the I2C module and set the master bit by setting I2CnCR to

0x20.

Quoted 5 lines

2. Enable the I2C module by setting I2CnCR to 0xA0.
3. Read I2CnDR.
4. Return the I2C module to slave mode by setting I2CnCR to 0x80.

And this worked fine on our Hardware ...

Ahh, memory slowly returns. The problem is that this does not generate a reset
sequence that will work in all cases. Consider the case when the CPU is reset half-way through writing or reading a byte from the device.

I once researched this(can't remember the exact details now) but the only reset sequence that works in all cases is:

static void send_start(void)

{
        I2C_DELAY;
        I2C_TRISTATE;
        I2C_SDA(1);
        I2C_DELAY;
        I2C_SCL(1);
        I2C_DELAY;
        I2C_SDA(0);
        I2C_ACTIVE;
        I2C_DELAY;
}

static void send_stop(void)

{
        I2C_SCL(0);
        I2C_DELAY;
        I2C_SDA(0);
        I2C_ACTIVE;
        I2C_DELAY;
        I2C_SCL(1);
        I2C_DELAY;
        I2C_TRISTATE;
        I2C_SDA(1);
        I2C_DELAY;
}

/*-----------------------------------------------------------------------
* Send a reset sequence consisting of 9 clocks with the data signal high
* to clock any confused device back into an idle state. Also send a
* <stop> at the end of the sequence for belts & suspenders. */
void tm_i2c_reset(int bus)

{
        int j;

        I2C_INIT;
        I2C_TRISTATE;
        for(j = 0; j < 9; j++) {
                if(I2C_READ)
                        send_start();
                I2C_SCL(0);
                I2C_DELAY;
                I2C_TRISTATE;
                I2C_SDA(1);
                I2C_DELAY;
                I2C_SCL(1);
                I2C_DELAY;
                I2C_DELAY;
        }
        send_stop();
        if(!I2C_READ)
                printf("I2C SDA is low! I2C bus:%d is stuck!!!\n", bus);
}
#4 lore raw

PATCH 19/31 i2c, mpc83xx: add CONFIG_SYS_I2C_INIT_BOARD for fsl_i2c

Hello Joakim,

Quoted 104 lines · Joakim Tjernlund

Heiko Schocher <[email protected]> wrote on 28/01/2009 11:54:22:

Quoted 5 lines
Quoted 4 lines · Joakim Tjernlund
Quoted 4 lines

This patch adds the possibility to call a board specific i2c bus reset routine for the fsl_i2c bus driver, and adds this option for the keymile kmeter1 board.

Quoted 8 lines

[...]

Quoted 7 lines

board/keymile/common/common.c static int i2c_make_abort (void) · line 485

Quoted 7 lines
board/keymile/common/common.c +3 -0
@@ -478,6 +480,17 @@ static int i2c_make_abort (void)
  */
 void i2c_init_board(void)
 {
+#if defined(CONFIG_KMETER1)
+   struct fsl_i2c *dev;
+   dev = (struct fsl_i2c *) (CONFIG_SYS_IMMR + 

CONFIG_SYS_I2C_OFFSET);

Quoted 8 lines
Quoted 8 lines

board/keymile/common/common.c static int i2c_make_abort (void) · line 491

Quoted 6 lines
board/keymile/common/common.c +6 -0
+   uchar   dummy;
+
+   out_8 (&dev->cr, (I2C_CR_MSTA));
+   out_8 (&dev->cr, (I2C_CR_MEN | I2C_CR_MSTA));
+   dummy = in_8(&dev->dr);
+   out_8 (&dev->cr, (I2C_CR_MEN));

Are you sure this will generate a proper I2C reset sequence? We also use this controller and I tried to do it too but didn't find a way. I

then

Quoted 8 lines
Quoted 2 lines

asked
Freescale and they could not come up with a solution either.

?
This routine is decribed in the MPC8260ERM.pdf ?15.5.7 on page 15-23 from Freescale!

15.5.7 Generation of SCLn when SDAn is Negated
It is sometimes necessary to force the I2C module to become the I2C bus

master out of reset and drive

Quoted 1 line

SCLn (even though SDAn may already be driven, which indicates that the

bus is busy). This can occur

Quoted 1 line

when a system reset does not cause all I2C devices to be reset. Thus,

SDAn can be negated low by another

Quoted 1 line

I2C device while this I2C module is coming out of reset and will stay

low indefinitely. The following

Quoted 1 line

procedure can be used to force this I2C module to generate SCLn so that

the device driving SDAn can

Quoted 2 lines

finish its transaction:
1. Disable the I2C module and set the master bit by setting I2CnCR to

0x20.

Quoted 5 lines

2. Enable the I2C module by setting I2CnCR to 0xA0.
3. Read I2CnDR.
4. Return the I2C module to slave mode by setting I2CnCR to 0x80.

And this worked fine on our Hardware ...

Ahh, memory slowly returns. The problem is that this does not generate a reset
sequence that will work in all cases. Consider the case when the CPU is reset half-way through writing or reading a byte from the device.

I once researched this(can't remember the exact details now) but the only reset sequence that works in all cases is:

static void send_start(void)

{
        I2C_DELAY;
        I2C_TRISTATE;
        I2C_SDA(1);
        I2C_DELAY;
        I2C_SCL(1);
        I2C_DELAY;
        I2C_SDA(0);
        I2C_ACTIVE;
        I2C_DELAY;
}

static void send_stop(void)

{
        I2C_SCL(0);
        I2C_DELAY;
        I2C_SDA(0);
        I2C_ACTIVE;
        I2C_DELAY;
        I2C_SCL(1);
        I2C_DELAY;
        I2C_TRISTATE;
        I2C_SDA(1);
        I2C_DELAY;
}

/*-----------------------------------------------------------------------
* Send a reset sequence consisting of 9 clocks with the data signal high
* to clock any confused device back into an idle state. Also send a
* <stop> at the end of the sequence for belts & suspenders. */
void tm_i2c_reset(int bus)

{
        int j;

        I2C_INIT;
        I2C_TRISTATE;
        for(j = 0; j < 9; j++) {
                if(I2C_READ)
                        send_start();
                I2C_SCL(0);
                I2C_DELAY;
                I2C_TRISTATE;
                I2C_SDA(1);
                I2C_DELAY;
Quoted 8 lines
                I2C_SCL(1);
                I2C_DELAY;
                I2C_DELAY;
        }
        send_stop();
        if(!I2C_READ)
                printf("I2C SDA is low! I2C bus:%d is stuck!!!\n", bus);
}

I dont know if it is possible to make this with the 8360 ...

Maybe we can do the following:
- make the reset Sequence suggested from Freescale
- checking the Status Register, if the Bus is now free (MBB Bit = 0) If not, do again the reset Sequence. And this for max. 9 times.

What do you think?

bye
Heiko

Signature · 2 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
#5 lore raw

PATCH 19/31 i2c, mpc83xx: add CONFIG_SYS_I2C_INIT_BOARD for fsl_i2c

Quoted 26 lines

Hello Joakim,

Quoted 23 lines · Joakim Tjernlund

Heiko Schocher <[email protected]> wrote on 28/01/2009 11:54:22:

Quoted 5 lines
Quoted 4 lines · Joakim Tjernlund
Quoted 4 lines

This patch adds the possibility to call a board specific i2c bus reset routine for the fsl_i2c bus driver, and adds this option for the keymile kmeter1 board.

Quoted 8 lines

[...]

Quoted 7 lines

board/keymile/common/common.c static int i2c_make_abort (void) · line 485

Quoted 7 lines
board/keymile/common/common.c +3 -0
@@ -478,6 +480,17 @@ static int i2c_make_abort (void)
  */
 void i2c_init_board(void)
 {
+#if defined(CONFIG_KMETER1)
+   struct fsl_i2c *dev;
+   dev = (struct fsl_i2c *) (CONFIG_SYS_IMMR + 

CONFIG_SYS_I2C_OFFSET);

Quoted 8 lines
Quoted 8 lines

board/keymile/common/common.c static int i2c_make_abort (void) · line 491

Quoted 6 lines
board/keymile/common/common.c +6 -0
+   uchar   dummy;
+
+   out_8 (&dev->cr, (I2C_CR_MSTA));
+   out_8 (&dev->cr, (I2C_CR_MEN | I2C_CR_MSTA));
+   dummy = in_8(&dev->dr);
+   out_8 (&dev->cr, (I2C_CR_MEN));

Are you sure this will generate a proper I2C reset sequence? We also use this controller and I tried to do it too but didn't find a way.

I

Quoted 9 lines
Quoted 9 lines

then

Quoted 8 lines
Quoted 2 lines

asked
Freescale and they could not come up with a solution either.

?
This routine is decribed in the MPC8260ERM.pdf ?15.5.7 on page 15-23 from Freescale!

15.5.7 Generation of SCLn when SDAn is Negated
It is sometimes necessary to force the I2C module to become the I2C

bus

Quoted 2 lines
Quoted 2 lines

master out of reset and drive

Quoted 1 line

SCLn (even though SDAn may already be driven, which indicates that

the

Quoted 8 lines
Quoted 8 lines

bus is busy). This can occur

Quoted 1 line

when a system reset does not cause all I2C devices to be reset. Thus,

SDAn can be negated low by another

Quoted 1 line

I2C device while this I2C module is coming out of reset and will stay

low indefinitely. The following

Quoted 1 line

procedure can be used to force this I2C module to generate SCLn so

that

Quoted 4 lines
Quoted 3 lines

the device driving SDAn can

Quoted 2 lines

finish its transaction:
1. Disable the I2C module and set the master bit by setting I2CnCR to

Quoted 8 lines
Quoted 8 lines

0x20.

Quoted 5 lines

2. Enable the I2C module by setting I2CnCR to 0xA0.
3. Read I2CnDR.
4. Return the I2C module to slave mode by setting I2CnCR to 0x80.

And this worked fine on our Hardware ...

Ahh, memory slowly returns. The problem is that this does not generate

a

Quoted 3 lines
Quoted 3 lines

reset
sequence that will work in all cases. Consider the case when the CPU is reset half-way through writing or reading a byte from the

device.

Quoted 17 lines
Quoted 17 lines

I once researched this(can't remember the exact details now) but the only reset sequence that works in all cases is:

static void send_start(void)

{
        I2C_DELAY;
        I2C_TRISTATE;
        I2C_SDA(1);
        I2C_DELAY;
        I2C_SCL(1);
        I2C_DELAY;
        I2C_SDA(0);
        I2C_ACTIVE;
        I2C_DELAY;
}
Quoted 15 lines
Quoted 15 lines

static void send_stop(void)

{
        I2C_SCL(0);
        I2C_DELAY;
        I2C_SDA(0);
        I2C_ACTIVE;
        I2C_DELAY;
        I2C_SCL(1);
        I2C_DELAY;
        I2C_TRISTATE;
        I2C_SDA(1);
        I2C_DELAY;
}

/*-----------------------------------------------------------------------

Quoted 1 line
Quoted 1 line

* Send a reset sequence consisting of 9 clocks with the data signal

high

Quoted 16 lines
Quoted 16 lines

* to clock any confused device back into an idle state. Also send a
* <stop> at the end of the sequence for belts & suspenders. */
void tm_i2c_reset(int bus)

{
        int j;

        I2C_INIT;
        I2C_TRISTATE;
        for(j = 0; j < 9; j++) {
                if(I2C_READ)
                        send_start();
                I2C_SCL(0);
                I2C_DELAY;
                I2C_TRISTATE;
                I2C_SDA(1);
Quoted 8 lines
Quoted 8 lines
                I2C_DELAY;
                I2C_SCL(1);
                I2C_DELAY;
                I2C_DELAY;
        }
        send_stop();
        if(!I2C_READ)
                printf("I2C SDA is low! I2C bus:%d is stuck!!!\n", 

bus);

Quoted 10 lines
Quoted 1 line

}

I dont know if it is possible to make this with the 8360 ...

Maybe we can do the following:
- make the reset Sequence suggested from Freescale
- checking the Status Register, if the Bus is now free (MBB Bit = 0) If not, do again the reset Sequence. And this for max. 9 times.

What do you think?

It is better, but not complete I think.
Looks similar to our old reset procedure that didn't handle the case when a slave was stuck writing a byte but without the STOP condition:

        I2C_INIT;
        I2C_SCL(1);
        I2C_SDA(1);
        I2C_INIT;
        I2C_TRISTATE;
        for(j = 0; j < 9; j++) {
                I2C_SCL(0);
                I2C_DELAY;
                I2C_DELAY;
                I2C_SCL(1);
                I2C_DELAY;
                I2C_DELAY;
        }
        send_stop();
        if(!I2C_READ)
                printf("I2C SDA is low! I2C bus is stuck!!!\n");

You need to experiment and you probably need some help from Freescale.

Jocke