Re: [PATCH 2/4] Input: RMI4 - move sensor driver and F01 handlerinto the core

From: Christopher Heiny
Date: Wed Nov 28 2012 - 23:54:25 EST


On 11/27/2012 01:21 AM, Dmitry Torokhov wrote:
There is no point in having the sensor driver and F01 handler separate
from the RMI core since it is not useful without them and having them
all together simplifies initialization among other things.

Hi Dmitry,

I've been looking at this patch as well as your patch 3/4 changes, and I'm not sure it's for the better.

One thing that confuses me is that these appear to go against the advice we've been getting over the past months to rely more on standard kernel bus and driver implementations, instead of the "roll-your-own" implementation we had been using before.

More importantly, the patches inextricably link the sensor driver implementation and the F01 driver implementation to the bus implementation, and means that any given system can have only one way of managing F01. As you observed, a sensor is pretty much useless without an F01 handler, but I am reasonably sure that there will be future systems that have more than one RMI4 sensor in them, and there is a strong possibility that these sensors may have different requirements for handling F01. In the near future, then, these changes will have to be refactored back to something more like the structure of our 2012/11/16 patch set.

Additionally, having F01 as a special case means that when we start implementing things such as support for request_firmware(), there will have to be a bunch of special case code to deal with F01, since it's no longer "just another function driver". That seems to go in exactly the opposite direction of the simplification that you're trying to achieve.

I fully agree that there's a lot of boilerplate that could be (and must be) consolidated and/or eliminated, and that some of the F01 handling during initialization can be simplified. I'm just not sure that this is the right way to go about doing that.

If you'd like me to address this inline in the patches, let me know. I just thought it would be better to address design issues up top. Alternatively, I could submit a patch that tries to address your concerns from another approach.

Of course, it's entirely possible that I'm full of fertilizer here - I trust that you will let me know in detail if that is the case. :-)

Thanks very much,
Chris


Signed-off-by: Dmitry Torokhov <dmitry.torokhov@xxxxxxxxx>
---
drivers/input/rmi4/Kconfig | 23 ++++++-----------------
drivers/input/rmi4/Makefile | 10 +++++++---
drivers/input/rmi4/rmi_bus.c | 41 ++++++++++++++++++++++++++++++++---------
drivers/input/rmi4/rmi_driver.c | 36 ++++++++++++++----------------------
drivers/input/rmi4/rmi_driver.h | 6 ++++++
drivers/input/rmi4/rmi_f01.c | 22 +++-------------------
6 files changed, 68 insertions(+), 70 deletions(-)

diff --git a/drivers/input/rmi4/Kconfig b/drivers/input/rmi4/Kconfig
index 41cbbee..d0c7b6e 100644
--- a/drivers/input/rmi4/Kconfig
+++ b/drivers/input/rmi4/Kconfig
@@ -1,8 +1,8 @@
#
# RMI4 configuration
#
-config RMI4_BUS
- bool "Synaptics RMI4 bus support"
+config RMI4_CORE
+ tristate "Synaptics RMI4 bus support"
help
Say Y here if you want to support the Synaptics RMI4 bus. This is
required for all RMI4 device support.
@@ -13,7 +13,7 @@ config RMI4_BUS

config RMI4_DEBUG
bool "RMI4 Debugging"
- depends on RMI4_BUS
+ depends on RMI4_CORE
select DEBUG_FS
help
Say Y here to enable debug feature in the RMI4 driver.
@@ -26,8 +26,8 @@ config RMI4_DEBUG
If unsure, say N.

config RMI4_I2C
- bool "RMI4 I2C Support"
- depends on RMI4_BUS && I2C
+ tristate "RMI4 I2C Support"
+ depends on RMI4_CORE && I2C
help
Say Y here if you want to support RMI4 devices connected to an I2C
bus.
@@ -36,20 +36,9 @@ config RMI4_I2C

This feature is not currently available as a loadable module.

-config RMI4_GENERIC
- bool "RMI4 Generic driver"
- depends on RMI4_BUS
- help
- Say Y here if you want to support generic RMI4 devices.
-
- This is pretty much required if you want to do anything useful with
- your RMI device.
-
- This feature is not currently available as a loadable module.
-
config RMI4_F11
tristate "RMI4 Function 11 (2D pointing)"
- depends on RMI4_BUS && RMI4_GENERIC
+ depends on RMI4_CORE
help
Say Y here if you want to add support for RMI4 function 11.

diff --git a/drivers/input/rmi4/Makefile b/drivers/input/rmi4/Makefile
index 8882c3d..5c6bad5 100644
--- a/drivers/input/rmi4/Makefile
+++ b/drivers/input/rmi4/Makefile
@@ -1,8 +1,12 @@
-obj-$(CONFIG_RMI4_BUS) += rmi_bus.o
-obj-$(CONFIG_RMI4_I2C) += rmi_i2c.o
-obj-$(CONFIG_RMI4_GENERIC) += rmi_driver.o rmi_f01.o
+obj-$(CONFIG_RMI4_CORE) += rmi_core.o
+rmi_core-y := rmi_bus.o rmi_driver.o rmi_f01.o
+
+# Function drivers
obj-$(CONFIG_RMI4_F11) += rmi_f11.o

+# Transports
+obj-$(CONFIG_RMI4_I2C) += rmi_i2c.o
+
ccflags-$(CONFIG_RMI4_DEBUG) += -DDEBUG

ifeq ($(KERNELRELEASE),)
diff --git a/drivers/input/rmi4/rmi_bus.c b/drivers/input/rmi4/rmi_bus.c
index a912349..47cf0d5 100644
--- a/drivers/input/rmi4/rmi_bus.c
+++ b/drivers/input/rmi4/rmi_bus.c
@@ -206,6 +206,27 @@ static int __init rmi_bus_init(void)

mutex_init(&rmi_bus_mutex);

+ error = bus_register(&rmi_bus_type);
+ if (error) {
+ pr_err("%s: error registering the RMI bus: %d\n",
+ __func__, error);
+ return error;
+ }
+
+ error = rmi_register_f01_handler();
+ if (error) {
+ pr_err("%s: error registering the RMI F01 handler: %d\n",
+ __func__, error);
+ goto err_unregister_bus;
+ }
+
+ error = rmi_register_sensor_driver();
+ if (error) {
+ pr_err("%s: error registering the RMI sensor driver: %d\n",
+ __func__, error);
+ goto err_unregister_f01;
+ }
+
if (IS_ENABLED(CONFIG_RMI4_DEBUG)) {
rmi_debugfs_root = debugfs_create_dir(rmi_bus_type.name, NULL);
if (!rmi_debugfs_root)
@@ -218,24 +239,26 @@ static int __init rmi_bus_init(void)
}
}

- error = bus_register(&rmi_bus_type);
- if (error < 0) {
- pr_err("%s: error registering the RMI bus: %d\n", __func__,
- error);
- return error;
- }
- pr_debug("%s: successfully registered RMI bus.\n", __func__);
-
return 0;
+
+err_unregister_f01:
+ rmi_unregister_f01_handler();
+err_unregister_bus:
+ bus_unregister(&rmi_bus_type);
+ return error;
}

static void __exit rmi_bus_exit(void)
{
- /* We should only ever get here if all drivers are unloaded, so
+ /*
+ * We should only ever get here if all drivers are unloaded, so
* all we have to do at this point is unregister ourselves.
*/
if (IS_ENABLED(CONFIG_RMI4_DEBUG) && rmi_debugfs_root)
debugfs_remove(rmi_debugfs_root);
+
+ rmi_unregister_sensor_driver();
+ rmi_unregister_f01_handler();
bus_unregister(&rmi_bus_type);
}

diff --git a/drivers/input/rmi4/rmi_driver.c b/drivers/input/rmi4/rmi_driver.c
index e8a4b52..6b6ac0c 100644
--- a/drivers/input/rmi4/rmi_driver.c
+++ b/drivers/input/rmi4/rmi_driver.c
@@ -1608,7 +1608,7 @@ static int __devinit rmi_driver_probe(struct device *dev)
static UNIVERSAL_DEV_PM_OPS(rmi_driver_pm, rmi_driver_suspend,
rmi_driver_resume, NULL);

-static struct rmi_driver sensor_driver = {
+static struct rmi_driver rmi_sensor_driver = {
.driver = {
.owner = THIS_MODULE,
.name = "rmi_generic",
@@ -1624,38 +1624,30 @@ static struct rmi_driver sensor_driver = {
.set_input_params = rmi_driver_set_input_params,
};

-static int __init rmi_driver_init(void)
+int __init rmi_register_sensor_driver(void)
{
- int retval;
+ int error;

- retval = driver_register(&sensor_driver.driver);
- if (retval) {
+ error = driver_register(&rmi_sensor_driver.driver);
+ if (error) {
pr_err("%s: driver register failed, code=%d.\n", __func__,
- retval);
- return retval;
+ error);
+ return error;
}

/* Ask the bus to let us know when drivers are bound to devices. */
- retval = bus_register_notifier(&rmi_bus_type, &rmi_bus_notifier);
- if (retval) {
+ error = bus_register_notifier(&rmi_bus_type, &rmi_bus_notifier);
+ if (error) {
pr_err("%s: failed to register bus notifier, code=%d.\n",
- __func__, retval);
- return retval;
+ __func__, error);
+ return error;
}

- return retval;
+ return 0;
}

-static void __exit rmi_driver_exit(void)
+void __exit rmi_unregister_sensor_driver(void)
{
bus_unregister_notifier(&rmi_bus_type, &rmi_bus_notifier);
- driver_unregister(&sensor_driver.driver);
+ driver_unregister(&rmi_sensor_driver.driver);
}
-
-module_init(rmi_driver_init);
-module_exit(rmi_driver_exit);
-
-MODULE_AUTHOR("Christopher Heiny <cheiny@xxxxxxxxxxxxx");
-MODULE_DESCRIPTION("RMI generic driver");
-MODULE_LICENSE("GPL");
-MODULE_VERSION(RMI_DRIVER_VERSION);
diff --git a/drivers/input/rmi4/rmi_driver.h b/drivers/input/rmi4/rmi_driver.h
index 1fc4676..e71ffdc 100644
--- a/drivers/input/rmi4/rmi_driver.h
+++ b/drivers/input/rmi4/rmi_driver.h
@@ -136,4 +136,10 @@ extern void rmi4_fw_update(struct rmi_device *rmi_dev,
#define rmi4_fw_update(rmi_dev, f01_pdt, f34_pdt)
#endif

+int rmi_register_sensor_driver(void);
+void rmi_unregister_sensor_driver(void);
+
+int rmi_register_f01_handler(void);
+void rmi_unregister_f01_handler(void);
+
#endif
diff --git a/drivers/input/rmi4/rmi_f01.c b/drivers/input/rmi4/rmi_f01.c
index 5e6bef6..41ac5f0 100644
--- a/drivers/input/rmi4/rmi_f01.c
+++ b/drivers/input/rmi4/rmi_f01.c
@@ -1265,28 +1265,12 @@ static struct rmi_function_handler function_handler = {
#endif /* CONFIG_PM */
};

-static int __init rmi_f01_module_init(void)
+int __init rmi_register_f01_handler(void)
{
- int error;
-
- error = driver_register(&function_handler.driver);
- if (error < 0) {
- pr_err("%s: register failed!\n", __func__);
- return error;
- }
-
- return 0;
+ return driver_register(&function_handler.driver);
}

-static void __exit rmi_f01_module_exit(void)
+void __exit rmi_unregister_f01_handler(void)
{
driver_unregister(&function_handler.driver);
}
-
-module_init(rmi_f01_module_init);
-module_exit(rmi_f01_module_exit);
-
-MODULE_AUTHOR("Christopher Heiny <cheiny@xxxxxxxxxxxxx>");
-MODULE_DESCRIPTION("RMI F01 module");
-MODULE_LICENSE("GPL");
-MODULE_VERSION(RMI_DRIVER_VERSION);



--

Christopher Heiny
Senior Staff Firmware Engineer
Synaptics Incorporated
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/