platform/chrome: cros_ec: miscellaneous cleanups
Subsystems (2)
v3 cover platform/chrome: cros_ec: miscellaneous cleanups
The 1st patch fixes unhandled undos in error handling path.
The rest of patches cleans drivers/platform/chrome/cros_ec.c.
Changes from v2:
(https://patchwork.kernel.org/project/chrome-platform/cover/[email protected]/)
- Fix review comments in 1st and 2nd patch.
Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit messages.
- Use IS_ERR_OR_NULL() in 1st patch.
Tzung-Bi Shih (6):
platform/chrome: cros_ec: fix error handling in cros_ec_register() platform/chrome: cros_ec: remove unused variable was_wake_device platform/chrome: cros_ec: determine wake_enabled in
cros_ec_suspend()
platform/chrome: cros_ec: don't initialize err in cros_ec_register() platform/chrome: cros_ec: sort header inclusion alphabetically platform/chrome: cros_ec: append newline to all logs
drivers/platform/chrome/cros_ec.c | 37 +++++++++++---------- include/linux/platform_data/cros_ec_proto.h | 3 -- 2 files changed, 20 insertions(+), 20 deletions(-)
Signature · 1 line
2.35.0.263.gb82422642f-goog
PATCH v3 1/6 platform/chrome: cros_ec: fix error handling in cros_ec_register()
Fix cros_ec_register() to unregister platform devices if blocking_notifier_chain_register() fails.
Also use the single exit path to handle the platform device unregistration.
---
Changes from v2:
(https://patchwork.kernel.org/project/chrome-platform/patch/[email protected]/)
- Fix grammar error in commit message.
- Change the code that don't rely on zeroed memory.
- Remove unnecessary if checks before calling platform_device_unregister().
Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.
- Use IS_ERR_OR_NULL() in 1st patch.
drivers/platform/chrome/cros_ec.c | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-)
drivers/platform/chrome/cros_ec.c +9 -6
@@ -245,18 +245,16 @@ int cros_ec_register(struct cros_ec_device *ec_dev)if (IS_ERR (ec_dev->pd)) {dev_err (ec_dev->dev,"Failed to create CrOS PD platform device\n" ); -platform_device_unregister (ec_dev->ec); -return PTR_ERR (ec_dev->pd); + err =PTR_ERR (ec_dev->pd); + goto exit; } }if (IS_ENABLED (CONFIG_OF ) && dev->of_node) { err =devm_of_platform_populate (dev);if (err) { -platform_device_unregister (ec_dev->pd); -platform_device_unregister (ec_dev->ec);dev_err (dev,"Failed to register sub-devices\n" ); -return err; + goto exit; } }
@@ -278,7 +276,7 @@ int cros_ec_register(struct cros_ec_device *ec_dev) err =blocking_notifier_chain_register (&ec_dev->event_notifier, &ec_dev->notifier_ready);if (err) -return err; + goto exit; }dev_info (dev,"Chrome EC device registered\n" );
@@ -291,6 +289,11 @@ int cros_ec_register(struct cros_ec_device *ec_dev)cros_ec_irq_thread (0 , ec_dev);return 0 ; +exit: +if (ec_dev->max_passthru) +platform_device_unregister (ec_dev->pd); +platform_device_unregister (ec_dev->ec); +return err; }EXPORT_SYMBOL (cros_ec_register);
Signature · 1 line
2.35.0.263.gb82422642f-goog
Re: [PATCH v3 1/6] platform/chrome: cros_ec: fix error handling in cros_ec_register()
Quoted 59 lines · Tzung-Bi Shih
Fix
cros_ec_register()to unregister platform devices ifblocking_notifier_chain_register()fails.Also use the single exit path to handle the platform device unregistration.
Fixes 42cd0ab476e2 ("platform/chrome: cros_ec: Query EC protocol version if EC transitions between RO/RW")Signed-off-by Tzung-Bi Shih <[email protected]>---
Changes from v2:
(https://patchwork.kernel.org/project/chrome-platform/patch/[email protected]/)
- Fix grammar error in commit message.
- Change the code that don't rely on zeroed memory.
- Remove unnecessaryifchecks before callingplatform_device_unregister().Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.
- UseIS_ERR_OR_NULL()in 1st patch.drivers/platform/chrome/cros_ec.c | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-)drivers/platform/chrome/cros_ec.c +4
-6@@ -245,18 +245,16 @@ int cros_ec_register(struct cros_ec_device *ec_dev)if (IS_ERR (ec_dev->pd)) {dev_err (ec_dev->dev,"Failed to create CrOS PD platform device\n" ); -platform_device_unregister (ec_dev->ec); -return PTR_ERR (ec_dev->pd); + err =PTR_ERR (ec_dev->pd); + goto exit; } }if (IS_ENABLED (CONFIG_OF ) && dev->of_node) { err =devm_of_platform_populate (dev);if (err) { -platform_device_unregister (ec_dev->pd); -platform_device_unregister (ec_dev->ec);dev_err (dev,"Failed to register sub-devices\n" ); -return err; + goto exit; } }@@ -278,7 +276,7 @@ int cros_ec_register(struct cros_ec_device *ec_dev) err =blocking_notifier_chain_register (&ec_dev->event_notifier, &ec_dev->notifier_ready);if (err) -return err; + goto exit; }dev_info (dev,"Chrome EC device registered\n" );
drivers/platform/chrome/cros_ec.c int cros_ec_register(struct cros_ec_device *ec_dev) · line 293
Quoted 5 lines
drivers/platform/chrome/cros_ec.c +2
-0@@ -291,6 +289,11 @@ int cros_ec_register(struct cros_ec_device *ec_dev)cros_ec_irq_thread (0 , ec_dev);return 0 ; +exit: +if (ec_dev->max_passthru)
This just complicates things, by depending on another variable. Just initialize ec_dev->pd and ec_dev->ec to NULL at the beginning instead.
Quoted 9 lines
drivers/platform/chrome/cros_ec.c +3
-1+platform_device_unregister (ec_dev->pd); +platform_device_unregister (ec_dev->ec); +return err; }EXPORT_SYMBOL (cros_ec_register); --2.35.0.263.gb82422642f-goog
-Prashant
Re: [PATCH v3 1/6] platform/chrome: cros_ec: fix error handling in cros_ec_register()
Quoted 6 lines · Prashant Malani
drivers/platform/chrome/cros_ec.c int cros_ec_register(struct cros_ec_device *ec_dev) · line 293
Quoted 2 lines · Tzung-Bi Shih
drivers/platform/chrome/cros_ec.c +2
-0+exit: +if (ec_dev->max_passthru)This just complicates things, by depending on another variable. Just initialize
ec_dev->pdandec_dev->ecto NULL at the beginning instead.
Ack, will fix in the next version.
PATCH v3 2/6 platform/chrome: cros_ec: remove unused variable `was_wake_device`
In reply to Tzung-Bi Shih---
Changes from v2:
(https://patchwork.kernel.org/project/chrome-platform/patch/[email protected]/)
- Add pmalani's R-b tag.
- Remove redundant commit message.
Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.
drivers/platform/chrome/cros_ec.c | 1 - include/linux/platform_data/cros_ec_proto.h | 3 --- 2 files changed, 4 deletions(-)
drivers/platform/chrome/cros_ec.c +0 -1
@@ -343,7 +343,6 @@ int cros_ec_suspend(struct cros_ec_device *ec_dev) ec_dev->wake_enabled = !enable_irq_wake (ec_dev->irq);disable_irq (ec_dev->irq); - ec_dev->was_wake_device = ec_dev->wake_enabled; ec_dev->suspended = true;return 0 ;
include/linux/platform_data/cros_ec_proto.h +0 -3
@@ -76,8 +76,6 @@ struct cros_ec_command {* struct cros_ec_device - Information about a ChromeOS EC device. * @phys_name: Name of physical comms layer (e.g. 'i2c-4'). * @dev: Device pointer for physical comms device -* @was_wake_device: True if this device was set to wake the system from -* sleep at the last suspend. * @cros_class: The class structure for this device. * @cmd_readmem: Direct read of the EC memory-mapped region, if supported. * @offset: Is within EC_LPC_ADDR_MEMMAP region.
@@ -137,7 +135,6 @@ struct cros_ec_device {/* These are used by other drivers that want to talk to the EC */ const char *phys_name;struct device *dev; -bool was_wake_device;struct class *cros_class;int (*cmd_readmem)(struct cros_ec_device *ec,unsigned int offset,unsigned int bytes,void *dest);
Signature · 1 line
2.35.0.263.gb82422642f-goog
PATCH v3 3/6 platform/chrome: cros_ec: determine `wake_enabled` in cros_ec_suspend()
In reply to Tzung-Bi Shihwake_enabled indicates cros_ec_resume() needs to call disable_irq_wake() to undo enable_irq_wake() in cros_ec_suspend().
Determine wake_enabled in cros_ec_suspend() instead of reset-after-used in cros_ec_resume().
---
No changes from v2.
Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.
drivers/platform/chrome/cros_ec.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
drivers/platform/chrome/cros_ec.c +4 -3
@@ -341,6 +341,8 @@ int cros_ec_suspend(struct cros_ec_device *ec_dev)if (device_may_wakeup (dev)) ec_dev->wake_enabled = !enable_irq_wake (ec_dev->irq); +else + ec_dev->wake_enabled = false;disable_irq (ec_dev->irq); ec_dev->suspended = true;
@@ -382,10 +384,9 @@ int cros_ec_resume(struct cros_ec_device *ec_dev)dev_dbg (ec_dev->dev,"Error %d sending resume event to ec" , ret); -if (ec_dev->wake_enabled) { +if (ec_dev->wake_enabled)disable_irq_wake (ec_dev->irq); - ec_dev->wake_enabled =0 ; - } +/* * Let the mfd devices know about events that occur during * suspend. This way the clients know what to do with them.
Signature · 1 line
2.35.0.263.gb82422642f-goog
PATCH v3 4/6 platform/chrome: cros_ec: don't initialize `err` in cros_ec_register()
In reply to Tzung-Bi Shiherr in cros_ec_register() doesn't need to be initialized because it is going to be overridden in the following code soon.
---
No changes from v2.
Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.
drivers/platform/chrome/cros_ec.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/platform/chrome/cros_ec.c +1 -1
@@ -182,7 +182,7 @@ static int cros_ec_ready_event(struct notifier_block *nb,int cros_ec_register (struct cros_ec_device *ec_dev) {struct device *dev = ec_dev->dev; -int err =0 ; +int err;BLOCKING_INIT_NOTIFIER_HEAD (&ec_dev->event_notifier);
Signature · 1 line
2.35.0.263.gb82422642f-goog
Re: [PATCH v3 4/6] platform/chrome: cros_ec: don't initialize `err` in cros_ec_register()
Quoted 2 lines · Tzung-Bi Shih
errincros_ec_register()doesn't need to be initialized because it is going to be overridden in the following code soon.
As mentioned in the previous version [1], please drop this patch, since it is not necessary (doesn't meaningfully improve readability, doesn't fix any bugs).
Quoted 28 lines
Signed-off-by Tzung-Bi Shih <[email protected]>---
No changes from v2.Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.drivers/platform/chrome/cros_ec.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/platform/chrome/cros_ec.c +1
-2@@ -182,7 +182,7 @@ static int cros_ec_ready_event(struct notifier_block *nb,int cros_ec_register (struct cros_ec_device *ec_dev) {struct device *dev = ec_dev->dev; -int err =0 ; +int err;BLOCKING_INIT_NOTIFIER_HEAD (&ec_dev->event_notifier); --2.35.0.263.gb82422642f-goog
Re: [PATCH v3 4/6] platform/chrome: cros_ec: don't initialize `err` in cros_ec_register()
Quoted 9 lines · Prashant Malani
Quoted 2 lines · Tzung-Bi Shih
errincros_ec_register()doesn't need to be initialized because it is going to be overridden in the following code soon.As mentioned in the previous version [1], please drop this patch, since it is not necessary (doesn't meaningfully improve readability, doesn't fix any bugs).
Ack, will drop it in the next version.
PATCH v3 5/6 platform/chrome: cros_ec: sort header inclusion alphabetically
In reply to Tzung-Bi ShihSort header inclusion alphabetically.
---
No changes from v2.
Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.
drivers/platform/chrome/cros_ec.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/platform/chrome/cros_ec.c +2 -2
@@ -9,12 +9,12 @@* battery charging and regulator control, firmware update. */ -#include <linux/of_platform.h> #include <linux/interrupt.h> -#include <linux/slab.h> #include <linux/module.h> +#include <linux/of_platform.h> #include <linux/platform_data/cros_ec_commands.h> #include <linux/platform_data/cros_ec_proto.h> +#include <linux/slab.h> #include <linux/suspend.h> #include "cros_ec.h"
Signature · 1 line
2.35.0.263.gb82422642f-goog
Re: [PATCH v3 5/6] platform/chrome: cros_ec: sort header inclusion alphabetically
Quoted 3 lines · Tzung-Bi Shih
Sort header inclusion alphabetically.
Signed-off-by Tzung-Bi Shih <[email protected]>
Quoted 32 lines
---
No changes from v2.Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.drivers/platform/chrome/cros_ec.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/platform/chrome/cros_ec.c +2
-3@@ -9,12 +9,12 @@* battery charging and regulator control, firmware update. */ -#include <linux/of_platform.h> #include <linux/interrupt.h> -#include <linux/slab.h> #include <linux/module.h> +#include <linux/of_platform.h> #include <linux/platform_data/cros_ec_commands.h> #include <linux/platform_data/cros_ec_proto.h> +#include <linux/slab.h> #include <linux/suspend.h> #include "cros_ec.h" --2.35.0.263.gb82422642f-goog
PATCH v3 6/6 platform/chrome: cros_ec: append newline to all logs
In reply to Tzung-Bi ShihTo be consistent, append newline ("\n") to all logs.
---
No changes from v2.
Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.
drivers/platform/chrome/cros_ec.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/platform/chrome/cros_ec.c +4 -4
@@ -213,7 +213,7 @@ int cros_ec_register(struct cros_ec_device *ec_dev)IRQF_TRIGGER_LOW |IRQF_ONESHOT , "chromeos-ec", ec_dev);if (err) { -dev_err (dev,"Failed to request IRQ %d: %d" , +dev_err (dev,"Failed to request IRQ %d: %d\n" , ec_dev->irq, err);return err; }
@@ -264,7 +264,7 @@ int cros_ec_register(struct cros_ec_device *ec_dev)*/ err =cros_ec_sleep_event (ec_dev,0 );if (err <0 ) -dev_dbg (ec_dev->dev,"Error %d clearing sleep event to ec" , +dev_dbg (ec_dev->dev,"Error %d clearing sleep event to ec\n" , err);if (ec_dev->mkbp_event_supported) {
@@ -336,7 +336,7 @@ int cros_ec_suspend(struct cros_ec_device *ec_dev) ret =cros_ec_sleep_event (ec_dev, sleep_event);if (ret <0 ) -dev_dbg (ec_dev->dev,"Error %d sending suspend event to ec" , +dev_dbg (ec_dev->dev,"Error %d sending suspend event to ec\n" , ret);if (device_may_wakeup (dev))
@@ -381,7 +381,7 @@ int cros_ec_resume(struct cros_ec_device *ec_dev) ret =cros_ec_sleep_event (ec_dev, sleep_event);if (ret <0 ) -dev_dbg (ec_dev->dev,"Error %d sending resume event to ec" , +dev_dbg (ec_dev->dev,"Error %d sending resume event to ec\n" , ret);if (ec_dev->wake_enabled)
Signature · 1 line
2.35.0.263.gb82422642f-goog
Re: [PATCH v3 6/6] platform/chrome: cros_ec: append newline to all logs
Quoted 3 lines · Tzung-Bi Shih
To be consistent, append newline ("\n") to all logs.
Signed-off-by Tzung-Bi Shih <[email protected]>
Quoted 53 lines
---
No changes from v2.Changes from v1:
(https://lore.kernel.org/lkml/[email protected]/T/#u)
- Use imperative mood in commit message.drivers/platform/chrome/cros_ec.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)drivers/platform/chrome/cros_ec.c +4
-5@@ -213,7 +213,7 @@ int cros_ec_register(struct cros_ec_device *ec_dev)IRQF_TRIGGER_LOW |IRQF_ONESHOT , "chromeos-ec", ec_dev);if (err) { -dev_err (dev,"Failed to request IRQ %d: %d" , +dev_err (dev,"Failed to request IRQ %d: %d\n" , ec_dev->irq, err);return err; }@@ -264,7 +264,7 @@ int cros_ec_register(struct cros_ec_device *ec_dev)*/ err =cros_ec_sleep_event (ec_dev,0 );if (err <0 ) -dev_dbg (ec_dev->dev,"Error %d clearing sleep event to ec" , +dev_dbg (ec_dev->dev,"Error %d clearing sleep event to ec\n" , err);if (ec_dev->mkbp_event_supported) {@@ -336,7 +336,7 @@ int cros_ec_suspend(struct cros_ec_device *ec_dev) ret =cros_ec_sleep_event (ec_dev, sleep_event);if (ret <0 ) -dev_dbg (ec_dev->dev,"Error %d sending suspend event to ec" , +dev_dbg (ec_dev->dev,"Error %d sending suspend event to ec\n" , ret);if (device_may_wakeup (dev))@@ -381,7 +381,7 @@ int cros_ec_resume(struct cros_ec_device *ec_dev) ret =cros_ec_sleep_event (ec_dev, sleep_event);if (ret <0 ) -dev_dbg (ec_dev->dev,"Error %d sending resume event to ec" , +dev_dbg (ec_dev->dev,"Error %d sending resume event to ec\n" , ret);if (ec_dev->wake_enabled) --2.35.0.263.gb82422642f-goog