lwis_device_i2c.c - kernel/google-modules/lwis - Git at Google

 /*
  * Google LWIS I2C Device Driver
  *
  * Copyright (c) 2018 Google, LLC
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 as
  * published by the Free Software Foundation.
  */

 #define pr_fmt(fmt) KBUILD_MODNAME "-i2c-dev: " fmt

 #include "lwis_device_i2c.h"

 #include <linux/device.h>
 #include <linux/init.h>
 #include <linux/kernel.h>
 #include <linux/kthread.h>
 #include <linux/module.h>
 #include <linux/platform_device.h>
 #include <linux/pm.h>
 #include <linux/preempt.h>
 #include <linux/sched.h>
 #include <linux/sched/types.h>
 #include <linux/slab.h>
 #include <uapi/linux/sched/types.h>

 #include "lwis_i2c.h"
 #include "lwis_init.h"
 #include "lwis_periodic_io.h"
 #include "lwis_util.h"

 #ifdef CONFIG_OF
 #include "lwis_dt.h"
 #endif

 #define LWIS_DRIVER_NAME "lwis-i2c"

 #define I2C_DEFAULT_STATE_STRING "default"
 #define I2C_ON_STRING "on_i2c"
 #define I2C_OFF_STRING "off_i2c"

 static int lwis_i2c_device_enable(struct lwis_device *lwis_dev);
 static int lwis_i2c_device_disable(struct lwis_device *lwis_dev);
 static int lwis_i2c_register_io(struct lwis_device *lwis_dev, struct lwis_io_entry *entry,
 				int access_size);

 static struct lwis_device_subclass_operations i2c_vops = {
 	.register_io = lwis_i2c_register_io,
 	.register_io_barrier = NULL,
 	.device_enable = lwis_i2c_device_enable,
 	.device_disable = lwis_i2c_device_disable,
 	.event_enable = NULL,
 	.event_flags_updated = NULL,
 	.close = NULL,
 };

 static struct lwis_event_subscribe_operations i2c_subscribe_ops = {
 	.subscribe_event = NULL,
 	.unsubscribe_event = NULL,
 	.notify_event_subscriber = NULL,
 	.release = NULL,
 };

 static int lwis_i2c_device_enable(struct lwis_device *lwis_dev)
 {
 	int ret;
 	struct lwis_i2c_device *i2c_dev;
 	i2c_dev = container_of(lwis_dev, struct lwis_i2c_device, base_dev);

 	/* Enable the I2C bus */
 	mutex_lock(i2c_dev->group_i2c_lock);

 #if IS_ENABLED(CONFIG_INPUT_STMVL53L1)
 	if (is_shared_i2c_with_stmvl53l1(i2c_dev->state_pinctrl))
 		ret = shared_i2c_set_state(&i2c_dev->client->dev,
 					   i2c_dev->state_pinctrl,
 					   I2C_ON_STRING);
 	else
 		ret = lwis_i2c_set_state(i2c_dev, I2C_ON_STRING);
 #else
 	ret = lwis_i2c_set_state(i2c_dev, I2C_ON_STRING);
 #endif

 	mutex_unlock(i2c_dev->group_i2c_lock);
 	if (ret) {
 		dev_err(lwis_dev->dev, "Error enabling i2c bus (%d)\n", ret);
 		return ret;
 	}

 	return 0;
 }

 static int lwis_i2c_device_disable(struct lwis_device *lwis_dev)
 {
 	int ret;
 	struct lwis_i2c_device *i2c_dev;
 	i2c_dev = container_of(lwis_dev, struct lwis_i2c_device, base_dev);

 #if IS_ENABLED(CONFIG_INPUT_STMVL53L1)
 	if (is_shared_i2c_with_stmvl53l1(i2c_dev->state_pinctrl)) {
 		/* Disable the shared i2c bus */
 		mutex_lock(i2c_dev->group_i2c_lock);
 		ret = shared_i2c_set_state(&i2c_dev->client->dev,
 					   i2c_dev->state_pinctrl,
 					   I2C_OFF_STRING);
 		mutex_unlock(i2c_dev->group_i2c_lock);
 		if (ret) {
 			dev_err(lwis_dev->dev, "Error disabling i2c bus (%d)\n",
 				ret);
 		}
 		return ret;
 	}
 #endif

 	if (!lwis_i2c_dev_is_in_use(lwis_dev)) {
 		/* Disable the I2C bus */
 		mutex_lock(i2c_dev->group_i2c_lock);
 		ret = lwis_i2c_set_state(i2c_dev, I2C_OFF_STRING);
 		mutex_unlock(i2c_dev->group_i2c_lock);
 		if (ret) {
 			dev_err(lwis_dev->dev, "Error disabling i2c bus (%d)\n", ret);
 			return ret;
 		}
 	}

 	return 0;
 }

 static int lwis_i2c_register_io(struct lwis_device *lwis_dev, struct lwis_io_entry *entry,
 				int access_size)
 {
 	struct lwis_i2c_device *i2c_dev;
 	i2c_dev = container_of(lwis_dev, struct lwis_i2c_device, base_dev);

 	/* Running in interrupt context is not supported as i2c driver might sleep */
 	if (in_interrupt()) {
 		return -EAGAIN;
 	}
 	return lwis_i2c_io_entry_rw(i2c_dev, entry);
 }

 static int lwis_i2c_addr_matcher(struct device *dev, void *data)
 {
 	struct i2c_client *client = i2c_verify_client(dev);
 	int address = *(int *)data;

 	/* Return 0 if error, or address doesn't match */
 	if (IS_ERR_OR_NULL(client) || (client->addr != address)) {
 		return 0;
 	}

 	/* Return 1 when address is found */
 	return 1;
 }

 static int lwis_i2c_device_setup(struct lwis_i2c_device *i2c_dev)
 {
 	int ret;
 	struct i2c_board_info info = {};
 	struct device *dev;
 	struct pinctrl *pinctrl;
 	struct pinctrl_state *state;

 #ifdef CONFIG_OF
 	/* Parse device tree for device configurations */
 	ret = lwis_i2c_device_parse_dt(i2c_dev);
 	if (ret) {
 		dev_err(i2c_dev->base_dev.dev, "Failed to parse device tree\n");
 		return ret;
 	}
 #else
 	/* Non-device-tree init: Save for future implementation */
 	return -ENOSYS;
 #endif

 	info.addr = i2c_dev->address;

 	i2c_dev->client = i2c_new_client_device(i2c_dev->adapter, &info);

 	/* New device creation failed, possibly because client with the same
 	   address is defined, try to find the client instance in the adapter
 	   and use it here */
 	if (IS_ERR_OR_NULL(i2c_dev->client)) {
 		struct device *idev;
 		idev = device_find_child(&i2c_dev->adapter->dev, &i2c_dev->address,
 					 lwis_i2c_addr_matcher);
 		i2c_dev->client = i2c_verify_client(idev);
 	}

 	/* Still getting error in obtaining client, return error */
 	if (IS_ERR_OR_NULL(i2c_dev->client)) {
 		dev_err(i2c_dev->base_dev.dev, "Failed to create or find i2c device\n");
 		return -EINVAL;
 	}

 	dev = &i2c_dev->client->dev;

 	/* Parent of the client is the i2c block, which is where the i2c state
 	   pinctrl's are defined */
 	/* TODO: Need to figure out why this is parent's parent */
 	pinctrl = devm_pinctrl_get(dev->parent->parent);
 	if (IS_ERR(pinctrl)) {
 		dev_err(i2c_dev->base_dev.dev, "Cannot instantiate pinctrl instance (%lu)\n",
 			PTR_ERR(pinctrl));
 		return PTR_ERR(pinctrl);
 	}

 	/* Verify that on_i2c or off_i2c strings are present */
 	i2c_dev->pinctrl_default_state_only = false;
 	if (IS_ERR(pinctrl_lookup_state(pinctrl, I2C_OFF_STRING)) ||
 	    IS_ERR(pinctrl_lookup_state(pinctrl, I2C_ON_STRING))) {
 		state = pinctrl_lookup_state(pinctrl, I2C_DEFAULT_STATE_STRING);
 		/* Default option also missing, return error */
 		if (IS_ERR(state)) {
 			dev_err(i2c_dev->base_dev.dev,
 				"Pinctrl states {%s, %s, %s} not found (%lu)\n", I2C_OFF_STRING,
 				I2C_ON_STRING, I2C_DEFAULT_STATE_STRING, PTR_ERR(state));
 			return PTR_ERR(state);
 		}
 		/* on_i2c or off_i2c not found, fall back to default */
 		dev_warn(i2c_dev->base_dev.dev,
 			 "pinctrl state %s or %s not found, fall back to %s\n", I2C_OFF_STRING,
 			 I2C_ON_STRING, I2C_DEFAULT_STATE_STRING);
 		i2c_dev->pinctrl_default_state_only = true;
 	}
 	i2c_dev->state_pinctrl = pinctrl;

 	return 0;
 }

 static int lwis_i2c_device_probe(struct platform_device *plat_dev)
 {
 	int ret = 0;
 	struct lwis_i2c_device *i2c_dev;

 	/* Allocate I2C device specific data construct */
 	i2c_dev = kzalloc(sizeof(struct lwis_i2c_device), GFP_KERNEL);
 	if (!i2c_dev) {
 		pr_err("Failed to allocate i2c device structure\n");
 		return -ENOMEM;
 	}

 	i2c_dev->base_dev.type = DEVICE_TYPE_I2C;
 	i2c_dev->base_dev.vops = i2c_vops;
 	i2c_dev->base_dev.subscribe_ops = i2c_subscribe_ops;

 	/* Call the base device probe function */
 	ret = lwis_base_probe(&i2c_dev->base_dev, plat_dev);
 	if (ret) {
 		pr_err("Error in lwis base probe\n");
 		goto error_probe;
 	}

 	/* Call I2C device specific setup function */
 	ret = lwis_i2c_device_setup(i2c_dev);
 	if (ret) {
 		dev_err(i2c_dev->base_dev.dev, "Error in i2c device initialization\n");
 		lwis_base_unprobe(&i2c_dev->base_dev);
 		goto error_probe;
 	}

 	/* Create associated kworker threads */
 	ret = lwis_create_kthread_workers(&i2c_dev->base_dev, "lwis_i2c_trans_kthread",
 					 "lwis_i2c_prd_io_kthread");
 	if (ret) {
 		dev_err(i2c_dev->base_dev.dev,"Failed to create lwis_i2c_kthread");
 		lwis_base_unprobe(&i2c_dev->base_dev);
 		goto error_probe;
 	}

 	if (i2c_dev->base_dev.transaction_thread_priority != 0) {
 		ret = lwis_set_kthread_priority(&i2c_dev->base_dev,
 			i2c_dev->base_dev.transaction_worker_thread,
 			i2c_dev->base_dev.transaction_thread_priority);
 		if (ret) {
 			dev_err(i2c_dev->base_dev.dev,
 				"Failed to set LWIS I2C transaction kthread priority (%d)",
 				ret);
 			lwis_base_unprobe(&i2c_dev->base_dev);
 			goto error_probe;
 		}
 	}
 	if (i2c_dev->base_dev.periodic_io_thread_priority != 0) {
 		ret = lwis_set_kthread_priority(&i2c_dev->base_dev,
 			i2c_dev->base_dev.periodic_io_worker_thread,
 			i2c_dev->base_dev.periodic_io_thread_priority);
 		if (ret) {
 			dev_err(i2c_dev->base_dev.dev,
 				"Failed to set LWIS I2C periodic io kthread priority (%d)",
 				ret);
 			lwis_base_unprobe(&i2c_dev->base_dev);
 			goto error_probe;
 		}
 	}

 	dev_info(i2c_dev->base_dev.dev, "I2C Device Probe: Success\n");

 	return 0;

 error_probe:
 	kfree(i2c_dev);
 	return ret;
 }

 #ifdef CONFIG_PM
 static int lwis_i2c_device_suspend(struct device *dev)
 {
 	struct lwis_device *lwis_dev = dev_get_drvdata(dev);
 	struct lwis_client *lwis_client, *n;
 	int ret = 0;

 	if (lwis_dev->enabled == 0) {
 		return ret;
 	}

 	if (lwis_dev->pm_hibernation == 0) {
 		dev_warn(lwis_dev->dev, "Can't suspend because %s is in use!\n", lwis_dev->name);
 		return -EBUSY;
 	}

 	/* Send an error event to userspace to handle the system suspend */
 	lwis_device_error_event_emit(lwis_dev, LWIS_ERROR_EVENT_ID_SYSTEM_SUSPEND,
 				     /*payload=*/NULL, /*payload_size=*/0);

 	list_for_each_entry_safe (lwis_client, n, &lwis_dev->clients, node) {
 		if (!lwis_client->is_enabled) {
 			continue;
 		}

 		/* Clear event states for this client */
 		lwis_client_event_states_clear(lwis_client);

 		/* Flush all periodic io to complete */
 		ret = lwis_periodic_io_client_flush(lwis_client);
 		if (ret) {
 			dev_err(lwis_dev->dev,
 				"Failed to wait for in-process periodic io to complete\n");
 		}

 		/* Flush all pending transactions */
 		ret = lwis_transaction_client_flush(lwis_client);
 		if (ret) {
 			dev_err(lwis_dev->dev, "Failed to flush pending transactions\n");
 		}

 		/* Run cleanup transactions. */
 		lwis_transaction_client_cleanup(lwis_client);

 		lwis_client->is_enabled = false;
 	}

 	mutex_lock(&lwis_dev->client_lock);
 	ret = lwis_dev_power_down_locked(lwis_dev);
 	if (ret < 0) {
 		dev_err(lwis_dev->dev, "Failed to power down device\n");
 	}

 	lwis_device_event_states_clear_locked(lwis_dev);
 	lwis_dev->enabled = 0;
 	dev_warn(lwis_dev->dev, "Device disabled when system suspend\n");
 	mutex_unlock(&lwis_dev->client_lock);
 	return 0;
 }

 static int lwis_i2c_device_resume(struct device *dev)
 {
 	return 0;
 }

 static SIMPLE_DEV_PM_OPS(lwis_i2c_device_ops, lwis_i2c_device_suspend, lwis_i2c_device_resume);
 #endif

 #ifdef CONFIG_OF
 static const struct of_device_id lwis_id_match[] = {
 	{ .compatible = LWIS_I2C_DEVICE_COMPAT },
 	{},
 };
 MODULE_DEVICE_TABLE(of, lwis_id_match);

 static struct platform_driver lwis_driver = {
 	.probe = lwis_i2c_device_probe,
 	.driver =
 		{
 			.name = LWIS_DRIVER_NAME,
 			.owner = THIS_MODULE,
 			.of_match_table = lwis_id_match,
 			.pm	= &lwis_i2c_device_ops,
 		},
 };
 #else /* CONFIG_OF not defined */
 static struct platform_device_id lwis_driver_id[] = {
 	{
 		.name = LWIS_DRIVER_NAME,
 		.driver_data = 0,
 	},
 	{},
 };
 MODULE_DEVICE_TABLE(platform, lwis_driver_id);

 static struct platform_driver lwis_driver = { .probe = lwis_i2c_device_probe,
 					      .id_table = lwis_driver_id,
 					      .driver = {
 						      .name = LWIS_DRIVER_NAME,
 						      .owner = THIS_MODULE,
 					      } };
 #endif /* CONFIG_OF */

 /*
  *  lwis_i2c_device_init: Init function that will be called by the kernel
  *  initialization routines.
  */
 int __init lwis_i2c_device_init(void)
 {
 	int ret = 0;

 	pr_info("I2C device initialization\n");

 	ret = platform_driver_register(&lwis_driver);
 	if (ret) {
 		pr_err("platform_driver_register failed: %d\n", ret);
 	}

 	return ret;
 }

 int lwis_i2c_device_deinit(void)
 {
 	platform_driver_unregister(&lwis_driver);
 	return 0;
 }
	/*
	* Google LWIS I2C Device Driver
	*
	* Copyright (c) 2018 Google, LLC
	*
	* This program is free software; you can redistribute it and/or modify
	* it under the terms of the GNU General Public License version 2 as
	* published by the Free Software Foundation.
	*/

	#define pr_fmt(fmt) KBUILD_MODNAME "-i2c-dev: " fmt

	#include "lwis_device_i2c.h"

	#include <linux/device.h>
	#include <linux/init.h>
	#include <linux/kernel.h>
	#include <linux/kthread.h>
	#include <linux/module.h>
	#include <linux/platform_device.h>
	#include <linux/pm.h>
	#include <linux/preempt.h>
	#include <linux/sched.h>
	#include <linux/sched/types.h>
	#include <linux/slab.h>
	#include <uapi/linux/sched/types.h>

	#include "lwis_i2c.h"
	#include "lwis_init.h"
	#include "lwis_periodic_io.h"
	#include "lwis_util.h"

	#ifdef CONFIG_OF
	#include "lwis_dt.h"
	#endif

	#define LWIS_DRIVER_NAME "lwis-i2c"

	#define I2C_DEFAULT_STATE_STRING "default"
	#define I2C_ON_STRING "on_i2c"
	#define I2C_OFF_STRING "off_i2c"

	static int lwis_i2c_device_enable(struct lwis_device *lwis_dev);
	static int lwis_i2c_device_disable(struct lwis_device *lwis_dev);
	static int lwis_i2c_register_io(struct lwis_device lwis_dev, struct lwis_io_entry entry,
	int access_size);

	static struct lwis_device_subclass_operations i2c_vops = {
	.register_io = lwis_i2c_register_io,
	.register_io_barrier = NULL,
	.device_enable = lwis_i2c_device_enable,
	.device_disable = lwis_i2c_device_disable,
	.event_enable = NULL,
	.event_flags_updated = NULL,
	.close = NULL,
	};

	static struct lwis_event_subscribe_operations i2c_subscribe_ops = {
	.subscribe_event = NULL,
	.unsubscribe_event = NULL,
	.notify_event_subscriber = NULL,
	.release = NULL,
	};

	static int lwis_i2c_device_enable(struct lwis_device *lwis_dev)
	{
	int ret;
	struct lwis_i2c_device *i2c_dev;
	i2c_dev = container_of(lwis_dev, struct lwis_i2c_device, base_dev);

	/* Enable the I2C bus */
	mutex_lock(i2c_dev->group_i2c_lock);

	#if IS_ENABLED(CONFIG_INPUT_STMVL53L1)
	if (is_shared_i2c_with_stmvl53l1(i2c_dev->state_pinctrl))
	ret = shared_i2c_set_state(&i2c_dev->client->dev,
	i2c_dev->state_pinctrl,
	I2C_ON_STRING);
	else
	ret = lwis_i2c_set_state(i2c_dev, I2C_ON_STRING);
	#else
	ret = lwis_i2c_set_state(i2c_dev, I2C_ON_STRING);
	#endif

	mutex_unlock(i2c_dev->group_i2c_lock);
	if (ret) {
	dev_err(lwis_dev->dev, "Error enabling i2c bus (%d)\n", ret);
	return ret;
	}

	return 0;
	}

	static int lwis_i2c_device_disable(struct lwis_device *lwis_dev)
	{
	int ret;
	struct lwis_i2c_device *i2c_dev;
	i2c_dev = container_of(lwis_dev, struct lwis_i2c_device, base_dev);

	#if IS_ENABLED(CONFIG_INPUT_STMVL53L1)
	if (is_shared_i2c_with_stmvl53l1(i2c_dev->state_pinctrl)) {
	/* Disable the shared i2c bus */
	mutex_lock(i2c_dev->group_i2c_lock);
	ret = shared_i2c_set_state(&i2c_dev->client->dev,
	i2c_dev->state_pinctrl,
	I2C_OFF_STRING);
	mutex_unlock(i2c_dev->group_i2c_lock);
	if (ret) {
	dev_err(lwis_dev->dev, "Error disabling i2c bus (%d)\n",
	ret);
	}
	return ret;
	}
	#endif

	if (!lwis_i2c_dev_is_in_use(lwis_dev)) {
	/* Disable the I2C bus */
	mutex_lock(i2c_dev->group_i2c_lock);
	ret = lwis_i2c_set_state(i2c_dev, I2C_OFF_STRING);
	mutex_unlock(i2c_dev->group_i2c_lock);
	if (ret) {
	dev_err(lwis_dev->dev, "Error disabling i2c bus (%d)\n", ret);
	return ret;
	}
	}

	return 0;
	}

	static int lwis_i2c_register_io(struct lwis_device lwis_dev, struct lwis_io_entry entry,
	int access_size)
	{
	struct lwis_i2c_device *i2c_dev;
	i2c_dev = container_of(lwis_dev, struct lwis_i2c_device, base_dev);

	/* Running in interrupt context is not supported as i2c driver might sleep */
	if (in_interrupt()) {
	return -EAGAIN;
	}
	return lwis_i2c_io_entry_rw(i2c_dev, entry);
	}

	static int lwis_i2c_addr_matcher(struct device dev, void data)
	{
	struct i2c_client *client = i2c_verify_client(dev);
	int address = (int )data;

	/* Return 0 if error, or address doesn't match */
	if (IS_ERR_OR_NULL(client) \|\| (client->addr != address)) {
	return 0;
	}

	/* Return 1 when address is found */
	return 1;
	}

	static int lwis_i2c_device_setup(struct lwis_i2c_device *i2c_dev)
	{
	int ret;
	struct i2c_board_info info = {};
	struct device *dev;
	struct pinctrl *pinctrl;
	struct pinctrl_state *state;

	#ifdef CONFIG_OF
	/* Parse device tree for device configurations */
	ret = lwis_i2c_device_parse_dt(i2c_dev);
	if (ret) {
	dev_err(i2c_dev->base_dev.dev, "Failed to parse device tree\n");
	return ret;
	}
	#else
	/* Non-device-tree init: Save for future implementation */
	return -ENOSYS;
	#endif

	info.addr = i2c_dev->address;

	i2c_dev->client = i2c_new_client_device(i2c_dev->adapter, &info);

	/* New device creation failed, possibly because client with the same
	address is defined, try to find the client instance in the adapter
	and use it here */
	if (IS_ERR_OR_NULL(i2c_dev->client)) {
	struct device *idev;
	idev = device_find_child(&i2c_dev->adapter->dev, &i2c_dev->address,
	lwis_i2c_addr_matcher);
	i2c_dev->client = i2c_verify_client(idev);
	}

	/* Still getting error in obtaining client, return error */
	if (IS_ERR_OR_NULL(i2c_dev->client)) {
	dev_err(i2c_dev->base_dev.dev, "Failed to create or find i2c device\n");
	return -EINVAL;
	}

	dev = &i2c_dev->client->dev;

	/* Parent of the client is the i2c block, which is where the i2c state
	pinctrl's are defined */
	/* TODO: Need to figure out why this is parent's parent */
	pinctrl = devm_pinctrl_get(dev->parent->parent);
	if (IS_ERR(pinctrl)) {
	dev_err(i2c_dev->base_dev.dev, "Cannot instantiate pinctrl instance (%lu)\n",
	PTR_ERR(pinctrl));
	return PTR_ERR(pinctrl);
	}

	/* Verify that on_i2c or off_i2c strings are present */
	i2c_dev->pinctrl_default_state_only = false;
	if (IS_ERR(pinctrl_lookup_state(pinctrl, I2C_OFF_STRING)) \|\|
	IS_ERR(pinctrl_lookup_state(pinctrl, I2C_ON_STRING))) {
	state = pinctrl_lookup_state(pinctrl, I2C_DEFAULT_STATE_STRING);
	/* Default option also missing, return error */
	if (IS_ERR(state)) {
	dev_err(i2c_dev->base_dev.dev,
	"Pinctrl states {%s, %s, %s} not found (%lu)\n", I2C_OFF_STRING,
	I2C_ON_STRING, I2C_DEFAULT_STATE_STRING, PTR_ERR(state));
	return PTR_ERR(state);
	}
	/* on_i2c or off_i2c not found, fall back to default */
	dev_warn(i2c_dev->base_dev.dev,
	"pinctrl state %s or %s not found, fall back to %s\n", I2C_OFF_STRING,
	I2C_ON_STRING, I2C_DEFAULT_STATE_STRING);
	i2c_dev->pinctrl_default_state_only = true;
	}
	i2c_dev->state_pinctrl = pinctrl;

	return 0;
	}

	static int lwis_i2c_device_probe(struct platform_device *plat_dev)
	{
	int ret = 0;
	struct lwis_i2c_device *i2c_dev;

	/* Allocate I2C device specific data construct */
	i2c_dev = kzalloc(sizeof(struct lwis_i2c_device), GFP_KERNEL);
	if (!i2c_dev) {
	pr_err("Failed to allocate i2c device structure\n");
	return -ENOMEM;
	}

	i2c_dev->base_dev.type = DEVICE_TYPE_I2C;
	i2c_dev->base_dev.vops = i2c_vops;
	i2c_dev->base_dev.subscribe_ops = i2c_subscribe_ops;

	/* Call the base device probe function */
	ret = lwis_base_probe(&i2c_dev->base_dev, plat_dev);
	if (ret) {
	pr_err("Error in lwis base probe\n");
	goto error_probe;
	}

	/* Call I2C device specific setup function */
	ret = lwis_i2c_device_setup(i2c_dev);
	if (ret) {
	dev_err(i2c_dev->base_dev.dev, "Error in i2c device initialization\n");
	lwis_base_unprobe(&i2c_dev->base_dev);
	goto error_probe;
	}

	/* Create associated kworker threads */
	ret = lwis_create_kthread_workers(&i2c_dev->base_dev, "lwis_i2c_trans_kthread",
	"lwis_i2c_prd_io_kthread");
	if (ret) {
	dev_err(i2c_dev->base_dev.dev,"Failed to create lwis_i2c_kthread");
	lwis_base_unprobe(&i2c_dev->base_dev);
	goto error_probe;
	}

	if (i2c_dev->base_dev.transaction_thread_priority != 0) {
	ret = lwis_set_kthread_priority(&i2c_dev->base_dev,
	i2c_dev->base_dev.transaction_worker_thread,
	i2c_dev->base_dev.transaction_thread_priority);
	if (ret) {
	dev_err(i2c_dev->base_dev.dev,
	"Failed to set LWIS I2C transaction kthread priority (%d)",
	ret);
	lwis_base_unprobe(&i2c_dev->base_dev);
	goto error_probe;
	}
	}
	if (i2c_dev->base_dev.periodic_io_thread_priority != 0) {
	ret = lwis_set_kthread_priority(&i2c_dev->base_dev,
	i2c_dev->base_dev.periodic_io_worker_thread,
	i2c_dev->base_dev.periodic_io_thread_priority);
	if (ret) {
	dev_err(i2c_dev->base_dev.dev,
	"Failed to set LWIS I2C periodic io kthread priority (%d)",
	ret);
	lwis_base_unprobe(&i2c_dev->base_dev);
	goto error_probe;
	}
	}

	dev_info(i2c_dev->base_dev.dev, "I2C Device Probe: Success\n");

	return 0;

	error_probe:
	kfree(i2c_dev);
	return ret;
	}

	#ifdef CONFIG_PM
	static int lwis_i2c_device_suspend(struct device *dev)
	{
	struct lwis_device *lwis_dev = dev_get_drvdata(dev);
	struct lwis_client lwis_client, n;
	int ret = 0;

	if (lwis_dev->enabled == 0) {
	return ret;
	}

	if (lwis_dev->pm_hibernation == 0) {
	dev_warn(lwis_dev->dev, "Can't suspend because %s is in use!\n", lwis_dev->name);
	return -EBUSY;
	}

	/* Send an error event to userspace to handle the system suspend */
	lwis_device_error_event_emit(lwis_dev, LWIS_ERROR_EVENT_ID_SYSTEM_SUSPEND,
	/payload=/NULL, /payload_size=/0);

	list_for_each_entry_safe (lwis_client, n, &lwis_dev->clients, node) {
	if (!lwis_client->is_enabled) {
	continue;
	}

	/* Clear event states for this client */
	lwis_client_event_states_clear(lwis_client);

	/* Flush all periodic io to complete */
	ret = lwis_periodic_io_client_flush(lwis_client);
	if (ret) {
	dev_err(lwis_dev->dev,
	"Failed to wait for in-process periodic io to complete\n");
	}

	/* Flush all pending transactions */
	ret = lwis_transaction_client_flush(lwis_client);
	if (ret) {
	dev_err(lwis_dev->dev, "Failed to flush pending transactions\n");
	}

	/* Run cleanup transactions. */
	lwis_transaction_client_cleanup(lwis_client);

	lwis_client->is_enabled = false;
	}

	mutex_lock(&lwis_dev->client_lock);
	ret = lwis_dev_power_down_locked(lwis_dev);
	if (ret < 0) {
	dev_err(lwis_dev->dev, "Failed to power down device\n");
	}

	lwis_device_event_states_clear_locked(lwis_dev);
	lwis_dev->enabled = 0;
	dev_warn(lwis_dev->dev, "Device disabled when system suspend\n");
	mutex_unlock(&lwis_dev->client_lock);
	return 0;
	}

	static int lwis_i2c_device_resume(struct device *dev)
	{
	return 0;
	}

	static SIMPLE_DEV_PM_OPS(lwis_i2c_device_ops, lwis_i2c_device_suspend, lwis_i2c_device_resume);
	#endif

	#ifdef CONFIG_OF
	static const struct of_device_id lwis_id_match[] = {
	{ .compatible = LWIS_I2C_DEVICE_COMPAT },
	{},
	};
	MODULE_DEVICE_TABLE(of, lwis_id_match);

	static struct platform_driver lwis_driver = {
	.probe = lwis_i2c_device_probe,
	.driver =
	{
	.name = LWIS_DRIVER_NAME,
	.owner = THIS_MODULE,
	.of_match_table = lwis_id_match,
	.pm = &lwis_i2c_device_ops,
	},
	};
	#else /* CONFIG_OF not defined */
	static struct platform_device_id lwis_driver_id[] = {
	{
	.name = LWIS_DRIVER_NAME,
	.driver_data = 0,
	},
	{},
	};
	MODULE_DEVICE_TABLE(platform, lwis_driver_id);

	static struct platform_driver lwis_driver = { .probe = lwis_i2c_device_probe,
	.id_table = lwis_driver_id,
	.driver = {
	.name = LWIS_DRIVER_NAME,
	.owner = THIS_MODULE,
	} };
	#endif /* CONFIG_OF */

	/*
	* lwis_i2c_device_init: Init function that will be called by the kernel
	* initialization routines.
	*/
	int __init lwis_i2c_device_init(void)
	{
	int ret = 0;

	pr_info("I2C device initialization\n");

	ret = platform_driver_register(&lwis_driver);
	if (ret) {
	pr_err("platform_driver_register failed: %d\n", ret);
	}

	return ret;
	}

	int lwis_i2c_device_deinit(void)
	{
	platform_driver_unregister(&lwis_driver);
	return 0;
	}