v4l2: add support for bus-based I2C drivers

From: Hans Verkuil <hverkuil@xs4all.nl>

Two new headers were added: one for I2C drivers that are only used
by V4L2 drivers converted to the new bus-based I2C API, and one that
can be used by both converted and unconverted drivers (at the expense of
some additional overhead).

To support the legacy I2C API a helper function was added to v4l2-common.c.

These headers take care of all the 'boilerplate' code that all V4L2 I2C drivers
have in common and will automatically support the bus-based I2C API introduced
in kernel 2.6.22.

Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab@infradead.org>

---
 linux/drivers/media/video/v4l2-common.c   |   37 +++++
 linux/include/media/v4l2-common.h         |   11 +
 linux/include/media/v4l2-i2c-drv-legacy.h |  207 ++++++++++++++++++++++++++++++
 linux/include/media/v4l2-i2c-drv.h        |  199 ++++++++++++++++++++++++++++
 4 files changed, 454 insertions(+)

3 files changed, 417 insertions, 0 deletions

diff --git a/linux/include/media/v4l2-common.h b/linux/include/media/v4l2-common.h
index ee1265433..10fc32e16 100644
--- a/linux/include/media/v4l2-common.h
+++ b/linux/include/media/v4l2-common.h
@@ -113,6 +113,17 @@ int v4l2_chip_match_host(u32 id_type, u32 chip_id);
 
 /* ------------------------------------------------------------------------- */
 
+/* Helper function for I2C legacy drivers */
+
+struct i2c_driver;
+struct i2c_adapter;
+struct i2c_client;
+
+int v4l2_i2c_attach(struct i2c_adapter *adapter, int address, struct i2c_driver *driver,
+		const char *name, int (*probe)(struct i2c_client *));
+
+/* ------------------------------------------------------------------------- */
+
 /* Internal ioctls */
 
 /* VIDIOC_INT_DECODE_VBI_LINE */
diff --git a/linux/include/media/v4l2-i2c-drv-legacy.h b/linux/include/media/v4l2-i2c-drv-legacy.h
new file mode 100644
index 000000000..b76f6580c
--- /dev/null
+++ b/linux/include/media/v4l2-i2c-drv-legacy.h
@@ -0,0 +1,207 @@
+/*
+ * v4l2-i2c-drv-legacy.h - contains I2C handling code that's identical
+ *		    for all V4L2 I2C drivers. Use this header if the
+ *		    I2C driver is used by both legacy drivers and
+ *		    drivers converted to the bus-based I2C API.
+ *
+ * Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+struct v4l2_i2c_driver_data {
+	const char * const name;
+	int driverid;
+	int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
+	int (*probe)(struct i2c_client *client);
+	int (*remove)(struct i2c_client *client);
+	int (*suspend)(struct i2c_client *client, pm_message_t state);
+	int (*resume)(struct i2c_client *client);
+#ifdef I2C_CLASS_TV_ANALOG
+	int legacy_class;
+#else
+	int legacy_id;
+#endif
+};
+
+static struct v4l2_i2c_driver_data v4l2_i2c_data;
+static struct i2c_client_address_data addr_data;
+static struct i2c_driver v4l2_i2c_driver_legacy;
+static char v4l2_i2c_drv_name_legacy[32];
+
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
+static int v4l2_i2c_drv_attach_legacy(struct i2c_adapter *adapter, int address, int kind)
+#else
+static int v4l2_i2c_drv_attach_legacy(struct i2c_adapter *adapter, int address,
+			 unsigned short flags, int kind)
+#endif
+{
+	return v4l2_i2c_attach(adapter, address, &v4l2_i2c_driver_legacy,
+			v4l2_i2c_drv_name_legacy, v4l2_i2c_data.probe);
+}
+
+static int v4l2_i2c_drv_probe_legacy(struct i2c_adapter *adapter)
+{
+#ifdef I2C_CLASS_TV_ANALOG
+	if (adapter->class & v4l2_i2c_data.legacy_class)
+#else
+	if (adapter->id == v4l2_i2c_data.legacy_id)
+#endif
+		return i2c_probe(adapter, &addr_data, v4l2_i2c_drv_attach_legacy);
+	return 0;
+}
+
+static int v4l2_i2c_drv_detach_legacy(struct i2c_client *client)
+{
+	int err = i2c_detach_client(client);
+
+	if (err)
+		return err;
+	if (v4l2_i2c_data.remove)
+		v4l2_i2c_data.remove(client);
+	kfree(client);
+
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)
+	MOD_DEC_USE_COUNT;
+#endif
+	return 0;
+}
+
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,14)
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,20)
+static int v4l2_i2c_drv_suspend_helper(struct i2c_client *client, pm_message_t state)
+#else
+static int v4l2_i2c_drv_suspend_helper(struct device * dev, pm_message_t state)
+#endif
+#else
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,13)
+static int v4l2_i2c_drv_suspend_helper(struct device * dev, pm_message_t state, u32 level)
+#else
+static int v4l2_i2c_drv_suspend_helper(struct device * dev, u32 state, u32 level)
+#endif
+#endif
+{
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,20)
+	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
+#endif
+	return v4l2_i2c_data.suspend ? v4l2_i2c_data.suspend(client, state) : 0;
+}
+
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,14)
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,20)
+static int v4l2_i2c_drv_resume_helper(struct i2c_client *client)
+#else
+static int v4l2_i2c_drv_resume_helper(struct device * dev)
+#endif
+#else
+static int v4l2_i2c_drv_resume_helper(struct device * dev, u32 level)
+#endif
+{
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,20)
+	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
+#endif
+	return v4l2_i2c_data.resume ? v4l2_i2c_data.resume(client) : 0;
+}
+#endif
+
+/* ----------------------------------------------------------------------- */
+
+/* i2c implementation */
+static struct i2c_driver v4l2_i2c_driver_legacy = {
+#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)) && (LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,15))
+	.owner = THIS_MODULE,
+#endif
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,15)
+	.flags = I2C_DF_NOTIFY,
+#endif
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
+	.driver = {
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,15)
+		.owner = THIS_MODULE,
+#endif
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,20)
+		.suspend = v4l2_i2c_drv_suspend_helper,
+		.resume  = v4l2_i2c_drv_resume_helper,
+#endif
+	},
+#endif
+	.attach_adapter = v4l2_i2c_drv_probe_legacy,
+	.detach_client = v4l2_i2c_drv_detach_legacy,
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,20)
+	.suspend = v4l2_i2c_drv_suspend_helper,
+	.resume  = v4l2_i2c_drv_resume_helper,
+#endif
+};
+
+/* ----------------------------------------------------------------------- */
+
+/* i2c implementation */
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)
+static struct i2c_driver v4l2_i2c_driver = {
+	.suspend 	= v4l2_i2c_drv_suspend_helper,
+	.resume  	= v4l2_i2c_drv_resume_helper,
+};
+#endif
+
+static int __init v4l2_i2c_drv_init(void)
+{
+	int err;
+
+	strlcpy(v4l2_i2c_drv_name_legacy, v4l2_i2c_data.name, sizeof(v4l2_i2c_drv_name_legacy));
+	strlcat(v4l2_i2c_drv_name_legacy, "'", sizeof(v4l2_i2c_drv_name_legacy));
+
+#ifdef I2C_CLASS_TV_ANALOG
+	if (v4l2_i2c_data.legacy_class == 0)
+		v4l2_i2c_data.legacy_class = I2C_CLASS_TV_ANALOG;
+#else
+	if (v4l2_i2c_data.legacy_id == 0)
+		v4l2_i2c_data.legacy_id = I2C_HW_B_BT848;
+#endif
+
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,15)
+	strlcpy(v4l2_i2c_driver_legacy.name, v4l2_i2c_drv_name_legacy, sizeof(v4l2_i2c_driver_legacy.name));
+#else
+	v4l2_i2c_driver_legacy.driver.name = v4l2_i2c_drv_name_legacy;
+#endif
+	v4l2_i2c_driver_legacy.id = v4l2_i2c_data.driverid;
+	v4l2_i2c_driver_legacy.command = v4l2_i2c_data.command;
+	err = i2c_add_driver(&v4l2_i2c_driver_legacy);
+
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)
+	if (err)
+		return err;
+	v4l2_i2c_driver.driver.name = v4l2_i2c_data.name;
+	v4l2_i2c_driver.id = v4l2_i2c_data.driverid;
+	v4l2_i2c_driver.command = v4l2_i2c_data.command;
+	v4l2_i2c_driver.probe = v4l2_i2c_data.probe;
+	v4l2_i2c_driver.remove = v4l2_i2c_data.remove;
+	err = i2c_add_driver(&v4l2_i2c_driver);
+	if (err)
+		i2c_del_driver(&v4l2_i2c_driver_legacy);
+#endif
+	return err;
+}
+
+static void __exit v4l2_i2c_drv_cleanup(void)
+{
+	i2c_del_driver(&v4l2_i2c_driver_legacy);
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)
+	i2c_del_driver(&v4l2_i2c_driver);
+#endif
+}
+
+module_init(v4l2_i2c_drv_init);
+module_exit(v4l2_i2c_drv_cleanup);
diff --git a/linux/include/media/v4l2-i2c-drv.h b/linux/include/media/v4l2-i2c-drv.h
new file mode 100644
index 000000000..f027f27fb
--- /dev/null
+++ b/linux/include/media/v4l2-i2c-drv.h
@@ -0,0 +1,199 @@
+/*
+ * v4l2-i2c-drv.h - contains I2C handling code that's identical for
+ *		    all V4L2 I2C drivers. Use this header if the
+ *		    I2C driver is only used by drivers converted
+ *		    to the bus-based I2C API.
+ *
+ * Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+struct v4l2_i2c_driver_data {
+	const char * const name;
+	int driverid;
+	int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
+	int (*probe)(struct i2c_client *client);
+	int (*remove)(struct i2c_client *client);
+	int (*suspend)(struct i2c_client *client, pm_message_t state);
+	int (*resume)(struct i2c_client *client);
+#ifdef I2C_CLASS_TV_ANALOG
+	int legacy_class;
+#else
+	int legacy_id;
+#endif
+};
+
+static struct v4l2_i2c_driver_data v4l2_i2c_data;
+static struct i2c_client_address_data addr_data;
+static struct i2c_driver v4l2_i2c_driver;
+
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,22)
+
+/* Bus-based I2C implementation for kernels >= 2.6.22 */
+
+static int __init v4l2_i2c_drv_init(void)
+{
+	v4l2_i2c_driver.driver.name = v4l2_i2c_data.name;
+	v4l2_i2c_driver.id = v4l2_i2c_data.driverid;
+	v4l2_i2c_driver.command = v4l2_i2c_data.command;
+	v4l2_i2c_driver.probe = v4l2_i2c_data.probe;
+	v4l2_i2c_driver.remove = v4l2_i2c_data.remove;
+	v4l2_i2c_driver.suspend = v4l2_i2c_data.suspend;
+	v4l2_i2c_driver.resume = v4l2_i2c_data.resume;
+	return i2c_add_driver(&v4l2_i2c_driver);
+}
+
+#else
+
+/* Bus-based I2C API is not present, add legacy code */
+
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
+static int v4l2_i2c_drv_attach_legacy(struct i2c_adapter *adapter, int address, int kind)
+#else
+static int v4l2_i2c_drv_attach_legacy(struct i2c_adapter *adapter, int address,
+			 unsigned short flags, int kind)
+#endif
+{
+	return v4l2_i2c_attach(adapter, address, &v4l2_i2c_driver,
+			v4l2_i2c_data.name, v4l2_i2c_data.probe);
+}
+
+static int v4l2_i2c_drv_probe_legacy(struct i2c_adapter *adapter)
+{
+#ifdef I2C_CLASS_TV_ANALOG
+	if (adapter->class & v4l2_i2c_data.legacy_class)
+#else
+	if (adapter->id == v4l2_i2c_data.legacy_id)
+#endif
+		return i2c_probe(adapter, &addr_data, v4l2_i2c_drv_attach_legacy);
+	return 0;
+}
+
+static int v4l2_i2c_drv_detach_legacy(struct i2c_client *client)
+{
+	int err = i2c_detach_client(client);
+
+	if (err)
+		return err;
+	if (v4l2_i2c_data.remove)
+		v4l2_i2c_data.remove(client);
+	kfree(client);
+
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)
+	MOD_DEC_USE_COUNT;
+#endif
+	return 0;
+}
+
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,14)
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,20)
+static int v4l2_i2c_drv_suspend_helper(struct i2c_client *client, pm_message_t state)
+#else
+static int v4l2_i2c_drv_suspend_helper(struct device * dev, pm_message_t state)
+#endif
+#else
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,13)
+static int v4l2_i2c_drv_suspend_helper(struct device * dev, pm_message_t state, u32 level)
+#else
+static int v4l2_i2c_drv_suspend_helper(struct device * dev, u32 state, u32 level)
+#endif
+#endif
+{
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,20)
+	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
+#endif
+	return v4l2_i2c_data.suspend ? v4l2_i2c_data.suspend(client, state) : 0;
+}
+
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,14)
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,20)
+static int v4l2_i2c_drv_resume_helper(struct i2c_client *client)
+#else
+static int v4l2_i2c_drv_resume_helper(struct device * dev)
+#endif
+#else
+static int v4l2_i2c_drv_resume_helper(struct device * dev, u32 level)
+#endif
+{
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,20)
+	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
+#endif
+	return v4l2_i2c_data.resume ? v4l2_i2c_data.resume(client) : 0;
+}
+#endif
+
+/* ----------------------------------------------------------------------- */
+
+static struct i2c_driver v4l2_i2c_driver = {
+#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)) && (LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,15))
+	.owner = THIS_MODULE,
+#endif
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,15)
+	.flags = I2C_DF_NOTIFY,
+#endif
+#if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
+	.driver = {
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,15)
+		.owner = THIS_MODULE,
+#endif
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,20)
+		.suspend = v4l2_i2c_drv_suspend_helper,
+		.resume  = v4l2_i2c_drv_resume_helper,
+#endif
+	},
+#endif
+	.attach_adapter = v4l2_i2c_drv_probe_legacy,
+	.detach_client = v4l2_i2c_drv_detach_legacy,
+#if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,20)
+	.suspend = v4l2_i2c_drv_suspend_helper,
+	.resume  = v4l2_i2c_drv_resume_helper,
+#endif
+};
+
+/* ----------------------------------------------------------------------- */
+
+static int __init v4l2_i2c_drv_init(void)
+{
+#ifdef I2C_CLASS_TV_ANALOG
+	if (v4l2_i2c_data.legacy_class == 0)
+		v4l2_i2c_data.legacy_class = I2C_CLASS_TV_ANALOG;
+#else
+	if (v4l2_i2c_data.legacy_id == 0)
+		v4l2_i2c_data.legacy_id = I2C_HW_B_BT848;
+#endif
+
+#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,15)
+	strlcpy(v4l2_i2c_driver.name, v4l2_i2c_data.name, sizeof(v4l2_i2c_driver.name));
+#else
+	v4l2_i2c_driver.driver.name = v4l2_i2c_data.name;
+#endif
+	v4l2_i2c_driver.id = v4l2_i2c_data.driverid;
+	v4l2_i2c_driver.command = v4l2_i2c_data.command;
+	return i2c_add_driver(&v4l2_i2c_driver);
+}
+
+/* End legacy code */
+
+#endif
+
+static void __exit v4l2_i2c_drv_cleanup(void)
+{
+	i2c_del_driver(&v4l2_i2c_driver);
+}
+
+module_init(v4l2_i2c_drv_init);
+module_exit(v4l2_i2c_drv_cleanup);