[net-next-2.6.git] / Documentation / i2c / busses / i2c-ocores

Kernel driver i2c-ocores

Supported adapters:
  * OpenCores.org I2C controller by Richard Herveille (see datasheet link)
    Datasheet: http://www.opencores.org/projects.cgi/web/i2c/overview

Author: Peter Korsgaard <jacmet@sunsite.dk>

Description
-----------

i2c-ocores is an i2c bus driver for the OpenCores.org I2C controller
IP core by Richard Herveille.

Usage
-----

i2c-ocores uses the platform bus, so you need to provide a struct
platform_device with the base address and interrupt number. The
dev.platform_data of the device should also point to a struct
ocores_i2c_platform_data (see linux/i2c-ocores.h) describing the
distance between registers and the input clock speed.
There is also a possibility to attach a list of i2c_board_info which
the i2c-ocores driver will add to the bus upon creation.

E.G. something like:

static struct resource ocores_resources[] = {
	[0] = {
		.start	= MYI2C_BASEADDR,
		.end	= MYI2C_BASEADDR + 8,
		.flags	= IORESOURCE_MEM,
	},
	[1] = {
		.start	= MYI2C_IRQ,
		.end	= MYI2C_IRQ,
		.flags	= IORESOURCE_IRQ,
	},
};

/* optional board info */
struct i2c_board_info ocores_i2c_board_info[] = {
	{
		I2C_BOARD_INFO("tsc2003", 0x48),
		.platform_data = &tsc2003_platform_data,
		.irq = TSC_IRQ
	},
	{
		I2C_BOARD_INFO("adv7180", 0x42 >> 1),
		.irq = ADV_IRQ
	}
};

static struct ocores_i2c_platform_data myi2c_data = {
	.regstep	= 2,		/* two bytes between registers */
	.clock_khz	= 50000,	/* input clock of 50MHz */
	.devices	= ocores_i2c_board_info, /* optional table of devices */
	.num_devices	= ARRAY_SIZE(ocores_i2c_board_info), /* table size */
};

static struct platform_device myi2c = {
	.name			= "ocores-i2c",
	.dev = {
		.platform_data	= &myi2c_data,
	},
	.num_resources		= ARRAY_SIZE(ocores_resources),
	.resource		= ocores_resources,
};
Commit	Line	Data
18f98b1e PK	1	Kernel driver i2c-ocores
	2
	3	Supported adapters:
	4	* OpenCores.org I2C controller by Richard Herveille (see datasheet link)
	5	Datasheet: http://www.opencores.org/projects.cgi/web/i2c/overview
	6
	7	Author: Peter Korsgaard <jacmet@sunsite.dk>
	8
	9	Description
	10	-----------
	11
	12	i2c-ocores is an i2c bus driver for the OpenCores.org I2C controller
	13	IP core by Richard Herveille.
	14
	15	Usage
	16	-----
	17
	18	i2c-ocores uses the platform bus, so you need to provide a struct
	19	platform_device with the base address and interrupt number. The
	20	dev.platform_data of the device should also point to a struct
	21	ocores_i2c_platform_data (see linux/i2c-ocores.h) describing the
	22	distance between registers and the input clock speed.
dd14be4c RR	23	There is also a possibility to attach a list of i2c_board_info which
dd14be4c RR	24	the i2c-ocores driver will add to the bus upon creation.
18f98b1e PK	25
	26	E.G. something like:
	27
	28	static struct resource ocores_resources[] = {
	29	[0] = {
	30	.start = MYI2C_BASEADDR,
	31	.end = MYI2C_BASEADDR + 8,
	32	.flags = IORESOURCE_MEM,
	33	},
	34	[1] = {
	35	.start = MYI2C_IRQ,
	36	.end = MYI2C_IRQ,
	37	.flags = IORESOURCE_IRQ,
	38	},
	39	};
	40
dd14be4c RR	41	/* optional board info */
	42	struct i2c_board_info ocores_i2c_board_info[] = {
	43	{
	44	I2C_BOARD_INFO("tsc2003", 0x48),
	45	.platform_data = &tsc2003_platform_data,
	46	.irq = TSC_IRQ
	47	},
	48	{
	49	I2C_BOARD_INFO("adv7180", 0x42 >> 1),
	50	.irq = ADV_IRQ
	51	}
	52	};
	53
18f98b1e PK	54	static struct ocores_i2c_platform_data myi2c_data = {
	55	.regstep = 2, /* two bytes between registers */
	56	.clock_khz = 50000, /* input clock of 50MHz */
dd14be4c RR	57	.devices = ocores_i2c_board_info, /* optional table of devices */
dd14be4c RR	58	.num_devices = ARRAY_SIZE(ocores_i2c_board_info), /* table size */
18f98b1e PK	59	};
	60
	61	static struct platform_device myi2c = {
	62	.name = "ocores-i2c",
	63	.dev = {
	64	.platform_data = &myi2c_data,
	65	},
	66	.num_resources = ARRAY_SIZE(ocores_resources),
	67	.resource = ocores_resources,
	68	};