[people/ms/u-boot.git] / include / i2c.h

/*
 * Copyright (C) 2009 Sergey Kubushyn <ksi@koi8.net>
 * Copyright (C) 2009 - 2013 Heiko Schocher <hs@denx.de>
 * Changes for multibus/multiadapter I2C support.
 *
 * (C) Copyright 2001
 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 *
 * The original I2C interface was
 *   (C) 2000 by Paolo Scaffardi (arsenio@tin.it)
 *   AIRVENT SAM s.p.a - RIMINI(ITALY)
 * but has been changed substantially.
 */

#ifndef _I2C_H_
#define _I2C_H_

/*
 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
 *
 * The implementation MUST NOT use static or global variables if the
 * I2C routines are used to read SDRAM configuration information
 * because this is done before the memories are initialized. Limited
 * use of stack-based variables are OK (the initial stack size is
 * limited).
 *
 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
 */

/*
 * Configuration items.
 */
#define I2C_RXTX_LEN	128	/* maximum tx/rx buffer length */

#if !defined(CONFIG_SYS_I2C_MAX_HOPS)
/* no muxes used bus = i2c adapters */
#define CONFIG_SYS_I2C_DIRECT_BUS	1
#define CONFIG_SYS_I2C_MAX_HOPS		0
#define CONFIG_SYS_NUM_I2C_BUSES	ll_entry_count(struct i2c_adapter, i2c)
#else
/* we use i2c muxes */
#undef CONFIG_SYS_I2C_DIRECT_BUS
#endif

/* define the I2C bus number for RTC and DTT if not already done */
#if !defined(CONFIG_SYS_RTC_BUS_NUM)
#define CONFIG_SYS_RTC_BUS_NUM		0
#endif
#if !defined(CONFIG_SYS_DTT_BUS_NUM)
#define CONFIG_SYS_DTT_BUS_NUM		0
#endif
#if !defined(CONFIG_SYS_SPD_BUS_NUM)
#define CONFIG_SYS_SPD_BUS_NUM		0
#endif

struct i2c_adapter {
	void		(*init)(struct i2c_adapter *adap, int speed,
				int slaveaddr);
	int		(*probe)(struct i2c_adapter *adap, uint8_t chip);
	int		(*read)(struct i2c_adapter *adap, uint8_t chip,
				uint addr, int alen, uint8_t *buffer,
				int len);
	int		(*write)(struct i2c_adapter *adap, uint8_t chip,
				uint addr, int alen, uint8_t *buffer,
				int len);
	uint		(*set_bus_speed)(struct i2c_adapter *adap,
				uint speed);
	int		speed;
	int		slaveaddr;
	int		init_done;
	int		hwadapnr;
	char		*name;
};

#define U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
		_set_speed, _speed, _slaveaddr, _hwadapnr, _name) \
	{ \
		.init		=	_init, \
		.probe		=	_probe, \
		.read		=	_read, \
		.write		=	_write, \
		.set_bus_speed	=	_set_speed, \
		.speed		=	_speed, \
		.slaveaddr	=	_slaveaddr, \
		.init_done	=	0, \
		.hwadapnr	=	_hwadapnr, \
		.name		=	#_name \
};

#define U_BOOT_I2C_ADAP_COMPLETE(_name, _init, _probe, _read, _write, \
			_set_speed, _speed, _slaveaddr, _hwadapnr) \
	ll_entry_declare(struct i2c_adapter, _name, i2c) = \
	U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
		 _set_speed, _speed, _slaveaddr, _hwadapnr, _name);

struct i2c_adapter *i2c_get_adapter(int index);

#ifndef CONFIG_SYS_I2C_DIRECT_BUS
struct i2c_mux {
	int	id;
	char	name[16];
};

struct i2c_next_hop {
	struct i2c_mux		mux;
	uint8_t		chip;
	uint8_t		channel;
};

struct i2c_bus_hose {
	int	adapter;
	struct i2c_next_hop	next_hop[CONFIG_SYS_I2C_MAX_HOPS];
};
#define I2C_NULL_HOP	{{-1, ""}, 0, 0}
extern struct i2c_bus_hose	i2c_bus[];

#define I2C_ADAPTER(bus)	i2c_bus[bus].adapter
#else
#define I2C_ADAPTER(bus)	bus
#endif
#define	I2C_BUS			gd->cur_i2c_bus

#define	I2C_ADAP_NR(bus)	i2c_get_adapter(I2C_ADAPTER(bus))
#define	I2C_ADAP		I2C_ADAP_NR(gd->cur_i2c_bus)
#define I2C_ADAP_HWNR		(I2C_ADAP->hwadapnr)

#ifndef CONFIG_SYS_I2C_DIRECT_BUS
#define I2C_MUX_PCA9540_ID	1
#define I2C_MUX_PCA9540		{I2C_MUX_PCA9540_ID, "PCA9540B"}
#define I2C_MUX_PCA9542_ID	2
#define I2C_MUX_PCA9542		{I2C_MUX_PCA9542_ID, "PCA9542A"}
#define I2C_MUX_PCA9544_ID	3
#define I2C_MUX_PCA9544		{I2C_MUX_PCA9544_ID, "PCA9544A"}
#define I2C_MUX_PCA9547_ID	4
#define I2C_MUX_PCA9547		{I2C_MUX_PCA9547_ID, "PCA9547A"}
#endif

#ifndef I2C_SOFT_DECLARATIONS
# if defined(CONFIG_MPC8260)
#  define I2C_SOFT_DECLARATIONS volatile ioport_t *iop = ioport_addr((immap_t *)CONFIG_SYS_IMMR, I2C_PORT);
# elif defined(CONFIG_8xx)
#  define I2C_SOFT_DECLARATIONS	volatile immap_t *immr = (immap_t *)CONFIG_SYS_IMMR;

# elif (defined(CONFIG_AT91RM9200) || \
	defined(CONFIG_AT91SAM9260) ||  defined(CONFIG_AT91SAM9261) || \
	defined(CONFIG_AT91SAM9263)) && !defined(CONFIG_AT91_LEGACY)
#  define I2C_SOFT_DECLARATIONS	at91_pio_t *pio	= (at91_pio_t *) ATMEL_BASE_PIOA;
# else
#  define I2C_SOFT_DECLARATIONS
# endif
#endif

#ifdef CONFIG_8xx
/* Set default value for the I2C bus speed on 8xx. In the
 * future, we'll define these in all 8xx board config files.
 */
#ifndef	CONFIG_SYS_I2C_SPEED
#define	CONFIG_SYS_I2C_SPEED	50000
#endif
#endif

/*
 * Many boards/controllers/drivers don't support an I2C slave interface so
 * provide a default slave address for them for use in common code.  A real
 * value for CONFIG_SYS_I2C_SLAVE should be defined for any board which does
 * support a slave interface.
 */
#ifndef	CONFIG_SYS_I2C_SLAVE
#define	CONFIG_SYS_I2C_SLAVE	0xfe
#endif

/*
 * Initialization, must be called once on start up, may be called
 * repeatedly to change the speed and slave addresses.
 */
void i2c_init(int speed, int slaveaddr);
void i2c_init_board(void);
#ifdef CONFIG_SYS_I2C_BOARD_LATE_INIT
void i2c_board_late_init(void);
#endif

#ifdef CONFIG_SYS_I2C
/*
 * i2c_get_bus_num:
 *
 *  Returns index of currently active I2C bus.  Zero-based.
 */
unsigned int i2c_get_bus_num(void);

/*
 * i2c_set_bus_num:
 *
 *  Change the active I2C bus.  Subsequent read/write calls will
 *  go to this one.
 *
 *	bus - bus index, zero based
 *
 *	Returns: 0 on success, not 0 on failure
 *
 */
int i2c_set_bus_num(unsigned int bus);

/*
 * i2c_init_all():
 *
 * Initializes all I2C adapters in the system. All i2c_adap structures must
 * be initialized beforehead with function pointers and data, including
 * speed and slaveaddr. Returns 0 on success, non-0 on failure.
 */
void i2c_init_all(void);

/*
 * Probe the given I2C chip address.  Returns 0 if a chip responded,
 * not 0 on failure.
 */
int i2c_probe(uint8_t chip);

/*
 * Read/Write interface:
 *   chip:    I2C chip address, range 0..127
 *   addr:    Memory (register) address within the chip
 *   alen:    Number of bytes to use for addr (typically 1, 2 for larger
 *              memories, 0 for register type devices with only one
 *              register)
 *   buffer:  Where to read/write the data
 *   len:     How many bytes to read/write
 *
 *   Returns: 0 on success, not 0 on failure
 */
int i2c_read(uint8_t chip, unsigned int addr, int alen,
				uint8_t *buffer, int len);

int i2c_write(uint8_t chip, unsigned int addr, int alen,
				uint8_t *buffer, int len);

/*
 * Utility routines to read/write registers.
 */
uint8_t i2c_reg_read(uint8_t addr, uint8_t reg);

void i2c_reg_write(uint8_t addr, uint8_t reg, uint8_t val);

/*
 * i2c_set_bus_speed:
 *
 *  Change the speed of the active I2C bus
 *
 *	speed - bus speed in Hz
 *
 *	Returns: new bus speed
 *
 */
unsigned int i2c_set_bus_speed(unsigned int speed);

/*
 * i2c_get_bus_speed:
 *
 *  Returns speed of currently active I2C bus in Hz
 */

unsigned int i2c_get_bus_speed(void);

/*
 * i2c_reloc_fixup:
 *
 * Adjusts I2C pointers after U-Boot is relocated to DRAM
 */
void i2c_reloc_fixup(void);
#if defined(CONFIG_SYS_I2C_SOFT)
void i2c_soft_init(void);
void i2c_soft_active(void);
void i2c_soft_tristate(void);
int i2c_soft_read(void);
void i2c_soft_sda(int bit);
void i2c_soft_scl(int bit);
void i2c_soft_delay(void);
#endif
#else

/*
 * Probe the given I2C chip address.  Returns 0 if a chip responded,
 * not 0 on failure.
 */
int i2c_probe(uchar chip);

/*
 * Read/Write interface:
 *   chip:    I2C chip address, range 0..127
 *   addr:    Memory (register) address within the chip
 *   alen:    Number of bytes to use for addr (typically 1, 2 for larger
 *              memories, 0 for register type devices with only one
 *              register)
 *   buffer:  Where to read/write the data
 *   len:     How many bytes to read/write
 *
 *   Returns: 0 on success, not 0 on failure
 */
int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len);
int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len);

/*
 * Utility routines to read/write registers.
 */
static inline u8 i2c_reg_read(u8 addr, u8 reg)
{
	u8 buf;

#ifdef CONFIG_8xx
	/* MPC8xx needs this.  Maybe one day we can get rid of it. */
	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
#endif

#ifdef DEBUG
	printf("%s: addr=0x%02x, reg=0x%02x\n", __func__, addr, reg);
#endif

	i2c_read(addr, reg, 1, &buf, 1);

	return buf;
}

static inline void i2c_reg_write(u8 addr, u8 reg, u8 val)
{
#ifdef CONFIG_8xx
	/* MPC8xx needs this.  Maybe one day we can get rid of it. */
	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
#endif

#ifdef DEBUG
	printf("%s: addr=0x%02x, reg=0x%02x, val=0x%02x\n",
	       __func__, addr, reg, val);
#endif

	i2c_write(addr, reg, 1, &val, 1);
}

/*
 * Functions for setting the current I2C bus and its speed
 */

/*
 * i2c_set_bus_num:
 *
 *  Change the active I2C bus.  Subsequent read/write calls will
 *  go to this one.
 *
 *	bus - bus index, zero based
 *
 *	Returns: 0 on success, not 0 on failure
 *
 */
int i2c_set_bus_num(unsigned int bus);

/*
 * i2c_get_bus_num:
 *
 *  Returns index of currently active I2C bus.  Zero-based.
 */

unsigned int i2c_get_bus_num(void);

/*
 * i2c_set_bus_speed:
 *
 *  Change the speed of the active I2C bus
 *
 *	speed - bus speed in Hz
 *
 *	Returns: 0 on success, not 0 on failure
 *
 */
int i2c_set_bus_speed(unsigned int);

/*
 * i2c_get_bus_speed:
 *
 *  Returns speed of currently active I2C bus in Hz
 */

unsigned int i2c_get_bus_speed(void);
#endif /* CONFIG_SYS_I2C */

/*
 * only for backwardcompatibility, should go away if we switched
 * completely to new multibus support.
 */
#if defined(CONFIG_SYS_I2C) || defined(CONFIG_I2C_MULTI_BUS)
# if !defined(CONFIG_SYS_MAX_I2C_BUS)
#  define CONFIG_SYS_MAX_I2C_BUS		2
# endif
# define I2C_MULTI_BUS				1
#else
# define CONFIG_SYS_MAX_I2C_BUS		1
# define I2C_MULTI_BUS				0
#endif

/* NOTE: These two functions MUST be always_inline to avoid code growth! */
static inline unsigned int I2C_GET_BUS(void) __attribute__((always_inline));
static inline unsigned int I2C_GET_BUS(void)
{
	return I2C_MULTI_BUS ? i2c_get_bus_num() : 0;
}

static inline void I2C_SET_BUS(unsigned int bus) __attribute__((always_inline));
static inline void I2C_SET_BUS(unsigned int bus)
{
	if (I2C_MULTI_BUS)
		i2c_set_bus_num(bus);
}

/* Multi I2C definitions */
enum {
	I2C_0, I2C_1, I2C_2, I2C_3, I2C_4, I2C_5, I2C_6, I2C_7,
	I2C_8, I2C_9, I2C_10,
};

/* Multi I2C busses handling */
#ifdef CONFIG_SOFT_I2C_MULTI_BUS
extern int get_multi_scl_pin(void);
extern int get_multi_sda_pin(void);
extern int multi_i2c_init(void);
#endif

/**
 * Get FDT values for i2c bus.
 *
 * @param blob  Device tree blbo
 * @return the number of I2C bus
 */
void board_i2c_init(const void *blob);

/**
 * Find the I2C bus number by given a FDT I2C node.
 *
 * @param blob  Device tree blbo
 * @param node  FDT I2C node to find
 * @return the number of I2C bus (zero based), or -1 on error
 */
int i2c_get_bus_num_fdt(int node);

/**
 * Reset the I2C bus represented by the given a FDT I2C node.
 *
 * @param blob  Device tree blbo
 * @param node  FDT I2C node to find
 * @return 0 if port was reset, -1 if not found
 */
int i2c_reset_port_fdt(const void *blob, int node);
#endif	/* _I2C_H_ */
Commit	Line	Data
1f045217	1	/*
385c9ef5 HS	2	* Copyright (C) 2009 Sergey Kubushyn <ksi@koi8.net>
	3	* Copyright (C) 2009 - 2013 Heiko Schocher <hs@denx.de>
	4	* Changes for multibus/multiadapter I2C support.
	5	*
1f045217 WD	6	* (C) Copyright 2001
	7	* Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
	8	*
1a459660	9	* SPDX-License-Identifier: GPL-2.0+
1f045217 WD	10	*
	11	* The original I2C interface was
	12	* (C) 2000 by Paolo Scaffardi (arsenio@tin.it)
	13	* AIRVENT SAM s.p.a - RIMINI(ITALY)
	14	* but has been changed substantially.
	15	*/
	16
	17	#ifndef _I2C_H_
	18	#define _I2C_H_
	19
	20	/*
	21	* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
	22	*
	23	* The implementation MUST NOT use static or global variables if the
	24	* I2C routines are used to read SDRAM configuration information
	25	* because this is done before the memories are initialized. Limited
	26	* use of stack-based variables are OK (the initial stack size is
	27	* limited).
	28	*
	29	* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
	30	*/
	31
	32	/*
	33	* Configuration items.
	34	*/
	35	#define I2C_RXTX_LEN 128 /* maximum tx/rx buffer length */
	36
385c9ef5 HS	37	#if !defined(CONFIG_SYS_I2C_MAX_HOPS)
	38	/* no muxes used bus = i2c adapters */
	39	#define CONFIG_SYS_I2C_DIRECT_BUS 1
	40	#define CONFIG_SYS_I2C_MAX_HOPS 0
	41	#define CONFIG_SYS_NUM_I2C_BUSES ll_entry_count(struct i2c_adapter, i2c)
79b2d0bb	42	#else
385c9ef5 HS	43	/* we use i2c muxes */
385c9ef5 HS	44	#undef CONFIG_SYS_I2C_DIRECT_BUS
79b2d0bb SR	45	#endif
79b2d0bb SR	46
8c12045a	47	/* define the I2C bus number for RTC and DTT if not already done */
6d0f6bcf JCPV	48	#if !defined(CONFIG_SYS_RTC_BUS_NUM)
6d0f6bcf JCPV	49	#define CONFIG_SYS_RTC_BUS_NUM 0
8c12045a	50	#endif
6d0f6bcf JCPV	51	#if !defined(CONFIG_SYS_DTT_BUS_NUM)
6d0f6bcf JCPV	52	#define CONFIG_SYS_DTT_BUS_NUM 0
8c12045a	53	#endif
6d0f6bcf JCPV	54	#if !defined(CONFIG_SYS_SPD_BUS_NUM)
6d0f6bcf JCPV	55	#define CONFIG_SYS_SPD_BUS_NUM 0
d8a8ea5c	56	#endif
8c12045a	57
385c9ef5 HS	58	struct i2c_adapter {
	59	void (init)(struct i2c_adapter adap, int speed,
	60	int slaveaddr);
	61	int (probe)(struct i2c_adapter adap, uint8_t chip);
	62	int (read)(struct i2c_adapter adap, uint8_t chip,
	63	uint addr, int alen, uint8_t *buffer,
	64	int len);
	65	int (write)(struct i2c_adapter adap, uint8_t chip,
	66	uint addr, int alen, uint8_t *buffer,
	67	int len);
	68	uint (set_bus_speed)(struct i2c_adapter adap,
	69	uint speed);
	70	int speed;
	71	int slaveaddr;
	72	int init_done;
	73	int hwadapnr;
	74	char *name;
	75	};
	76
	77	#define U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
	78	_set_speed, _speed, _slaveaddr, _hwadapnr, _name) \
	79	{ \
	80	.init = _init, \
	81	.probe = _probe, \
	82	.read = _read, \
	83	.write = _write, \
	84	.set_bus_speed = _set_speed, \
	85	.speed = _speed, \
	86	.slaveaddr = _slaveaddr, \
	87	.init_done = 0, \
	88	.hwadapnr = _hwadapnr, \
	89	.name = #_name \
	90	};
	91
	92	#define U_BOOT_I2C_ADAP_COMPLETE(_name, _init, _probe, _read, _write, \
	93	_set_speed, _speed, _slaveaddr, _hwadapnr) \
	94	ll_entry_declare(struct i2c_adapter, _name, i2c) = \
	95	U_BOOT_I2C_MKENT_COMPLETE(_init, _probe, _read, _write, \
	96	_set_speed, _speed, _slaveaddr, _hwadapnr, _name);
	97
	98	struct i2c_adapter *i2c_get_adapter(int index);
	99
	100	#ifndef CONFIG_SYS_I2C_DIRECT_BUS
	101	struct i2c_mux {
	102	int id;
	103	char name[16];
	104	};
	105
	106	struct i2c_next_hop {
	107	struct i2c_mux mux;
	108	uint8_t chip;
	109	uint8_t channel;
	110	};
	111
	112	struct i2c_bus_hose {
	113	int adapter;
	114	struct i2c_next_hop next_hop[CONFIG_SYS_I2C_MAX_HOPS];
	115	};
	116	#define I2C_NULL_HOP {{-1, ""}, 0, 0}
	117	extern struct i2c_bus_hose i2c_bus[];
	118
	119	#define I2C_ADAPTER(bus) i2c_bus[bus].adapter
	120	#else
	121	#define I2C_ADAPTER(bus) bus
122	#endif
123	#define I2C_BUS gd->cur_i2c_bus
124
125	#define I2C_ADAP_NR(bus) i2c_get_adapter(I2C_ADAPTER(bus))
126	#define I2C_ADAP I2C_ADAP_NR(gd->cur_i2c_bus)
127	#define I2C_ADAP_HWNR (I2C_ADAP->hwadapnr)
128
129	#ifndef CONFIG_SYS_I2C_DIRECT_BUS
130	#define I2C_MUX_PCA9540_ID 1
131	#define I2C_MUX_PCA9540 {I2C_MUX_PCA9540_ID, "PCA9540B"}
132	#define I2C_MUX_PCA9542_ID 2
133	#define I2C_MUX_PCA9542 {I2C_MUX_PCA9542_ID, "PCA9542A"}
134	#define I2C_MUX_PCA9544_ID 3
135	#define I2C_MUX_PCA9544 {I2C_MUX_PCA9544_ID, "PCA9544A"}
136	#define I2C_MUX_PCA9547_ID 4
137	#define I2C_MUX_PCA9547 {I2C_MUX_PCA9547_ID, "PCA9547A"}
138	#endif
139
98aed379 HS	140	#ifndef I2C_SOFT_DECLARATIONS
98aed379 HS	141	# if defined(CONFIG_MPC8260)
6d0f6bcf	142	# define I2C_SOFT_DECLARATIONS volatile ioport_t iop = ioport_addr((immap_t )CONFIG_SYS_IMMR, I2C_PORT);
98aed379	143	# elif defined(CONFIG_8xx)
6d0f6bcf	144	# define I2C_SOFT_DECLARATIONS volatile immap_t immr = (immap_t )CONFIG_SYS_IMMR;
0cf0b931 JS	145
	146	# elif (defined(CONFIG_AT91RM9200) \|\| \
	147	defined(CONFIG_AT91SAM9260) \|\| defined(CONFIG_AT91SAM9261) \|\| \
	148	defined(CONFIG_AT91SAM9263)) && !defined(CONFIG_AT91_LEGACY)
78132275	149	# define I2C_SOFT_DECLARATIONS at91_pio_t pio = (at91_pio_t ) ATMEL_BASE_PIOA;
98aed379 HS	150	# else
	151	# define I2C_SOFT_DECLARATIONS
	152	# endif
	153	#endif
ecf5f077 TT	154
ecf5f077 TT	155	#ifdef CONFIG_8xx
9c90a2c8	156	/* Set default value for the I2C bus speed on 8xx. In the
ecf5f077 TT	157	* future, we'll define these in all 8xx board config files.
	158	*/
	159	#ifndef CONFIG_SYS_I2C_SPEED
	160	#define CONFIG_SYS_I2C_SPEED 50000
	161	#endif
9c90a2c8	162	#endif
ecf5f077	163
9c90a2c8 PT	164	/*
	165	* Many boards/controllers/drivers don't support an I2C slave interface so
	166	* provide a default slave address for them for use in common code. A real
	167	* value for CONFIG_SYS_I2C_SLAVE should be defined for any board which does
	168	* support a slave interface.
	169	*/
ecf5f077	170	#ifndef CONFIG_SYS_I2C_SLAVE
9c90a2c8	171	#define CONFIG_SYS_I2C_SLAVE 0xfe
ecf5f077 TT	172	#endif
ecf5f077 TT	173
1f045217 WD	174	/*
	175	* Initialization, must be called once on start up, may be called
	176	* repeatedly to change the speed and slave addresses.
	177	*/
	178	void i2c_init(int speed, int slaveaddr);
06d01dbe	179	void i2c_init_board(void);
26a33504 RR	180	#ifdef CONFIG_SYS_I2C_BOARD_LATE_INIT
	181	void i2c_board_late_init(void);
	182	#endif
1f045217	183
385c9ef5	184	#ifdef CONFIG_SYS_I2C
385c9ef5 HS	185	/*
	186	* i2c_get_bus_num:
	187	*
	188	* Returns index of currently active I2C bus. Zero-based.
	189	*/
	190	unsigned int i2c_get_bus_num(void);
	191
	192	/*
	193	* i2c_set_bus_num:
	194	*
	195	* Change the active I2C bus. Subsequent read/write calls will
	196	* go to this one.
	197	*
	198	* bus - bus index, zero based
	199	*
	200	* Returns: 0 on success, not 0 on failure
	201	*
	202	*/
	203	int i2c_set_bus_num(unsigned int bus);
	204
	205	/*
	206	* i2c_init_all():
	207	*
	208	* Initializes all I2C adapters in the system. All i2c_adap structures must
	209	* be initialized beforehead with function pointers and data, including
	210	* speed and slaveaddr. Returns 0 on success, non-0 on failure.
	211	*/
	212	void i2c_init_all(void);
	213
	214	/*
	215	* Probe the given I2C chip address. Returns 0 if a chip responded,
	216	* not 0 on failure.
	217	*/
	218	int i2c_probe(uint8_t chip);
	219
	220	/*
	221	* Read/Write interface:
	222	* chip: I2C chip address, range 0..127
	223	* addr: Memory (register) address within the chip
	224	* alen: Number of bytes to use for addr (typically 1, 2 for larger
	225	* memories, 0 for register type devices with only one
	226	* register)
	227	* buffer: Where to read/write the data
	228	* len: How many bytes to read/write
	229	*
	230	* Returns: 0 on success, not 0 on failure
	231	*/
	232	int i2c_read(uint8_t chip, unsigned int addr, int alen,
	233	uint8_t *buffer, int len);
	234
	235	int i2c_write(uint8_t chip, unsigned int addr, int alen,
	236	uint8_t *buffer, int len);
	237
	238	/*
	239	* Utility routines to read/write registers.
	240	*/
	241	uint8_t i2c_reg_read(uint8_t addr, uint8_t reg);
	242
	243	void i2c_reg_write(uint8_t addr, uint8_t reg, uint8_t val);
	244
	245	/*
	246	* i2c_set_bus_speed:
	247	*
	248	* Change the speed of the active I2C bus
249	*
250	* speed - bus speed in Hz
251	*
252	* Returns: new bus speed
253	*
254	*/
255	unsigned int i2c_set_bus_speed(unsigned int speed);
67b23a32	256
385c9ef5 HS	257	/*
	258	* i2c_get_bus_speed:
	259	*
	260	* Returns speed of currently active I2C bus in Hz
	261	*/
67b23a32	262
385c9ef5	263	unsigned int i2c_get_bus_speed(void);
67b23a32	264
385c9ef5 HS	265	/*
	266	* i2c_reloc_fixup:
	267	*
	268	* Adjusts I2C pointers after U-Boot is relocated to DRAM
	269	*/
	270	void i2c_reloc_fixup(void);
ea818dbb HS	271	#if defined(CONFIG_SYS_I2C_SOFT)
	272	void i2c_soft_init(void);
	273	void i2c_soft_active(void);
	274	void i2c_soft_tristate(void);
	275	int i2c_soft_read(void);
	276	void i2c_soft_sda(int bit);
	277	void i2c_soft_scl(int bit);
	278	void i2c_soft_delay(void);
67b23a32	279	#endif
385c9ef5	280	#else
67b23a32	281
1f045217 WD	282	/*
	283	* Probe the given I2C chip address. Returns 0 if a chip responded,
	284	* not 0 on failure.
	285	*/
	286	int i2c_probe(uchar chip);
	287
	288	/*
	289	* Read/Write interface:
	290	* chip: I2C chip address, range 0..127
	291	* addr: Memory (register) address within the chip
	292	* alen: Number of bytes to use for addr (typically 1, 2 for larger
	293	* memories, 0 for register type devices with only one
	294	* register)
	295	* buffer: Where to read/write the data
	296	* len: How many bytes to read/write
	297	*
	298	* Returns: 0 on success, not 0 on failure
	299	*/
	300	int i2c_read(uchar chip, uint addr, int alen, uchar *buffer, int len);
	301	int i2c_write(uchar chip, uint addr, int alen, uchar *buffer, int len);
	302
	303	/*
	304	* Utility routines to read/write registers.
	305	*/
ecf5f077 TT	306	static inline u8 i2c_reg_read(u8 addr, u8 reg)
	307	{
	308	u8 buf;
	309
	310	#ifdef CONFIG_8xx
	311	/* MPC8xx needs this. Maybe one day we can get rid of it. */
	312	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
	313	#endif
	314
	315	#ifdef DEBUG
	316	printf("%s: addr=0x%02x, reg=0x%02x\n", __func__, addr, reg);
	317	#endif
	318
ecf5f077	319	i2c_read(addr, reg, 1, &buf, 1);
ecf5f077 TT	320
	321	return buf;
	322	}
	323
	324	static inline void i2c_reg_write(u8 addr, u8 reg, u8 val)
	325	{
	326	#ifdef CONFIG_8xx
	327	/* MPC8xx needs this. Maybe one day we can get rid of it. */
	328	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
	329	#endif
	330
	331	#ifdef DEBUG
	332	printf("%s: addr=0x%02x, reg=0x%02x, val=0x%02x\n",
	333	__func__, addr, reg, val);
	334	#endif
	335
ecf5f077	336	i2c_write(addr, reg, 1, &val, 1);
ecf5f077	337	}
1f045217	338
bb99ad6d BW	339	/*
	340	* Functions for setting the current I2C bus and its speed
	341	*/
	342
	343	/*
	344	* i2c_set_bus_num:
	345	*
	346	* Change the active I2C bus. Subsequent read/write calls will
	347	* go to this one.
	348	*
53677ef1	349	* bus - bus index, zero based
bb99ad6d	350	*
53677ef1	351	* Returns: 0 on success, not 0 on failure
bb99ad6d BW	352	*
bb99ad6d BW	353	*/
9ca880a2	354	int i2c_set_bus_num(unsigned int bus);
bb99ad6d BW	355
	356	/*
	357	* i2c_get_bus_num:
	358	*
	359	* Returns index of currently active I2C bus. Zero-based.
	360	*/
	361
9ca880a2	362	unsigned int i2c_get_bus_num(void);
bb99ad6d BW	363
	364	/*
	365	* i2c_set_bus_speed:
	366	*
	367	* Change the speed of the active I2C bus
	368	*
53677ef1	369	* speed - bus speed in Hz
bb99ad6d	370	*
53677ef1	371	* Returns: 0 on success, not 0 on failure
bb99ad6d BW	372	*
bb99ad6d BW	373	*/
9ca880a2	374	int i2c_set_bus_speed(unsigned int);
bb99ad6d BW	375
	376	/*
	377	* i2c_get_bus_speed:
	378	*
	379	* Returns speed of currently active I2C bus in Hz
	380	*/
	381
9ca880a2	382	unsigned int i2c_get_bus_speed(void);
385c9ef5 HS	383	#endif /* CONFIG_SYS_I2C */
	384
	385	/*
	386	* only for backwardcompatibility, should go away if we switched
	387	* completely to new multibus support.
	388	*/
	389	#if defined(CONFIG_SYS_I2C) \|\| defined(CONFIG_I2C_MULTI_BUS)
	390	# if !defined(CONFIG_SYS_MAX_I2C_BUS)
	391	# define CONFIG_SYS_MAX_I2C_BUS 2
	392	# endif
ea0f73ab	393	# define I2C_MULTI_BUS 1
385c9ef5 HS	394	#else
	395	# define CONFIG_SYS_MAX_I2C_BUS 1
	396	# define I2C_MULTI_BUS 0
	397	#endif
bb99ad6d	398
cd7b4e82 MV	399	/* NOTE: These two functions MUST be always_inline to avoid code growth! */
	400	static inline unsigned int I2C_GET_BUS(void) __attribute__((always_inline));
	401	static inline unsigned int I2C_GET_BUS(void)
	402	{
	403	return I2C_MULTI_BUS ? i2c_get_bus_num() : 0;
	404	}
	405
	406	static inline void I2C_SET_BUS(unsigned int bus) __attribute__((always_inline));
	407	static inline void I2C_SET_BUS(unsigned int bus)
	408	{
	409	if (I2C_MULTI_BUS)
	410	i2c_set_bus_num(bus);
	411	}
	412
7ca8f73a ŁM	413	/* Multi I2C definitions */
	414	enum {
	415	I2C_0, I2C_1, I2C_2, I2C_3, I2C_4, I2C_5, I2C_6, I2C_7,
	416	I2C_8, I2C_9, I2C_10,
	417	};
	418
	419	/* Multi I2C busses handling */
	420	#ifdef CONFIG_SOFT_I2C_MULTI_BUS
	421	extern int get_multi_scl_pin(void);
	422	extern int get_multi_sda_pin(void);
	423	extern int multi_i2c_init(void);
	424	#endif
a9d2ae70 RS	425
	426	/**
	427	* Get FDT values for i2c bus.
	428	*
	429	* @param blob Device tree blbo
	430	* @return the number of I2C bus
	431	*/
	432	void board_i2c_init(const void *blob);
	433
	434	/**
	435	* Find the I2C bus number by given a FDT I2C node.
	436	*
	437	* @param blob Device tree blbo
	438	* @param node FDT I2C node to find
	439	* @return the number of I2C bus (zero based), or -1 on error
	440	*/
	441	int i2c_get_bus_num_fdt(int node);
	442
	443	/**
	444	* Reset the I2C bus represented by the given a FDT I2C node.
	445	*
	446	* @param blob Device tree blbo
	447	* @param node FDT I2C node to find
	448	* @return 0 if port was reset, -1 if not found
	449	*/
	450	int i2c_reset_port_fdt(const void *blob, int node);
1f045217	451	#endif /* _I2C_H_ */