From 67e532a42cf4c6c214ed39e33e617bca29508f4e Mon Sep 17 00:00:00 2001
From: Johan Hovold <johan@kernel.org>
Date: Wed, 22 Dec 2021 11:42:13 +0100
Subject: [PATCH] driver core: platform: document registration-failure
requirement
Add an explicit comment to document that the reference initialised by
platform_device_register() needs to be released by a call to
platform_device_put() also when registration fails (cf.
device_register()).
Signed-off-by: Johan Hovold <johan@kernel.org>
Link: https://lore.kernel.org/r/20211222104213.5673-1-johan@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
drivers/base/platform.c | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/drivers/base/platform.c b/drivers/base/platform.c
index 7109351366c80..6cb04ac48bf0b 100644
--- a/drivers/base/platform.c
+++ b/drivers/base/platform.c
@@ -763,6 +763,10 @@ EXPORT_SYMBOL_GPL(platform_device_del);
/**
* platform_device_register - add a platform-level device
* @pdev: platform device we're adding
+ *
+ * NOTE: _Never_ directly free @pdev after calling this function, even if it
+ * returned an error! Always use platform_device_put() to give up the
+ * reference initialised in this function instead.
*/
int platform_device_register(struct platform_device *pdev)
{
--
GitLab