From: Bartosz Golaszewski <bgolaszewski@baylibre.com>
To: Nicolas Saenz Julienne <nsaenzjulienne@suse.de>
Cc: "Uwe Kleine-König" <u.kleine-koenig@pengutronix.de>,
LKML <linux-kernel@vger.kernel.org>,
"Florian Fainelli" <f.fainelli@gmail.com>,
"Ray Jui" <rjui@broadcom.com>,
"Scott Branden" <sbranden@broadcom.com>,
bcm-kernel-feedback-list@broadcom.com, linux-pwm@vger.kernel.org,
arm-soc <linux-arm-kernel@lists.infradead.org>,
linux-devicetree <devicetree@vger.kernel.org>,
wahrenst@gmx.net, "Linux Input" <linux-input@vger.kernel.org>,
"Dmitry Torokhov" <dmitry.torokhov@gmail.com>,
"Greg KH" <gregkh@linuxfoundation.org>,
devel@driverdev.osuosl.org,
"Philipp Zabel" <p.zabel@pengutronix.de>,
linux-gpio <linux-gpio@vger.kernel.org>,
"Linus Walleij" <linus.walleij@linaro.org>,
linux-clk <linux-clk@vger.kernel.org>,
"Stephen Boyd" <sboyd@kernel.org>,
linux-rpi-kernel@lists.infradead.org,
"Andy Shevchenko" <andy.shevchenko@gmail.com>
Subject: Re: [PATCH v5 01/11] firmware: raspberrypi: Keep count of all consumers
Date: Thu, 3 Dec 2020 09:05:15 +0100 [thread overview]
Message-ID: <CAMpxmJX6zdoYek2THEj2x8ycJYz-bxqE_5RnOz1sYv0vwLSFpA@mail.gmail.com> (raw)
In-Reply-To: <20201123183833.18750-2-nsaenzjulienne@suse.de>
On Mon, Nov 23, 2020 at 7:38 PM Nicolas Saenz Julienne
<nsaenzjulienne@suse.de> wrote:
>
> When unbinding the firmware device we need to make sure it has no
> consumers left. Otherwise we'd leave them with a firmware handle
> pointing at freed memory.
>
> Keep a reference count of all consumers and introduce rpi_firmware_put()
> which will permit automatically decrease the reference count upon
> unbinding consumer drivers.
>
> Suggested-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> Signed-off-by: Nicolas Saenz Julienne <nsaenzjulienne@suse.de>
> ---
>
> Changes since v3:
> - Use kref instead of waiting on refcount
>
> drivers/firmware/raspberrypi.c | 37 +++++++++++++++++++---
> include/soc/bcm2835/raspberrypi-firmware.h | 2 ++
> 2 files changed, 35 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/firmware/raspberrypi.c b/drivers/firmware/raspberrypi.c
> index 30259dc9b805..ed793aef7851 100644
> --- a/drivers/firmware/raspberrypi.c
> +++ b/drivers/firmware/raspberrypi.c
> @@ -7,6 +7,7 @@
> */
>
> #include <linux/dma-mapping.h>
> +#include <linux/kref.h>
> #include <linux/mailbox_client.h>
> #include <linux/module.h>
> #include <linux/of_platform.h>
> @@ -27,6 +28,8 @@ struct rpi_firmware {
> struct mbox_chan *chan; /* The property channel. */
> struct completion c;
> u32 enabled;
> +
> + struct kref consumers;
> };
>
> static DEFINE_MUTEX(transaction_lock);
> @@ -225,12 +228,27 @@ static void rpi_register_clk_driver(struct device *dev)
> -1, NULL, 0);
> }
>
> +static void rpi_firmware_delete(struct kref *kref)
> +{
> + struct rpi_firmware *fw = container_of(kref, struct rpi_firmware,
> + consumers);
> +
> + mbox_free_channel(fw->chan);
> + kfree(fw);
> +}
> +
> +void rpi_firmware_put(struct rpi_firmware *fw)
> +{
> + kref_put(&fw->consumers, rpi_firmware_delete);
> +}
> +EXPORT_SYMBOL_GPL(rpi_firmware_put);
> +
> static int rpi_firmware_probe(struct platform_device *pdev)
> {
> struct device *dev = &pdev->dev;
> struct rpi_firmware *fw;
>
> - fw = devm_kzalloc(dev, sizeof(*fw), GFP_KERNEL);
One nit from my side: maybe add a comment here saying that you really
want to use non-managed kzalloc() because you're going to get people
blindly converting it to devm_kzalloc() very soon.
Bartosz
> + fw = kzalloc(sizeof(*fw), GFP_KERNEL);
> if (!fw)
> return -ENOMEM;
>
> @@ -247,6 +265,7 @@ static int rpi_firmware_probe(struct platform_device *pdev)
> }
>
> init_completion(&fw->c);
> + kref_init(&fw->consumers);
>
> platform_set_drvdata(pdev, fw);
>
> @@ -275,25 +294,35 @@ static int rpi_firmware_remove(struct platform_device *pdev)
> rpi_hwmon = NULL;
> platform_device_unregister(rpi_clk);
> rpi_clk = NULL;
> - mbox_free_channel(fw->chan);
> +
> + rpi_firmware_put(fw);
>
> return 0;
> }
>
> /**
> - * rpi_firmware_get - Get pointer to rpi_firmware structure.
> * @firmware_node: Pointer to the firmware Device Tree node.
> *
> + * The reference to rpi_firmware has to be released with rpi_firmware_put().
> + *
> * Returns NULL is the firmware device is not ready.
> */
> struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node)
> {
> struct platform_device *pdev = of_find_device_by_node(firmware_node);
> + struct rpi_firmware *fw;
>
> if (!pdev)
> return NULL;
>
> - return platform_get_drvdata(pdev);
> + fw = platform_get_drvdata(pdev);
> + if (!fw)
> + return NULL;
> +
> + if (!kref_get_unless_zero(&fw->consumers))
> + return NULL;
> +
> + return fw;
> }
> EXPORT_SYMBOL_GPL(rpi_firmware_get);
>
> diff --git a/include/soc/bcm2835/raspberrypi-firmware.h b/include/soc/bcm2835/raspberrypi-firmware.h
> index cc9cdbc66403..fdfef7fe40df 100644
> --- a/include/soc/bcm2835/raspberrypi-firmware.h
> +++ b/include/soc/bcm2835/raspberrypi-firmware.h
> @@ -140,6 +140,7 @@ int rpi_firmware_property(struct rpi_firmware *fw,
> u32 tag, void *data, size_t len);
> int rpi_firmware_property_list(struct rpi_firmware *fw,
> void *data, size_t tag_size);
> +void rpi_firmware_put(struct rpi_firmware *fw);
> struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node);
> #else
> static inline int rpi_firmware_property(struct rpi_firmware *fw, u32 tag,
> @@ -154,6 +155,7 @@ static inline int rpi_firmware_property_list(struct rpi_firmware *fw,
> return -ENOSYS;
> }
>
> +static inline void rpi_firmware_put(struct rpi_firmware *fw) { }
> static inline struct rpi_firmware *rpi_firmware_get(struct device_node *firmware_node)
> {
> return NULL;
> --
> 2.29.2
>
next prev parent reply other threads:[~2020-12-03 8:06 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-23 18:38 [PATCH v5 00/11] Raspberry Pi PoE HAT fan support Nicolas Saenz Julienne
2020-11-23 18:38 ` [PATCH v5 01/11] firmware: raspberrypi: Keep count of all consumers Nicolas Saenz Julienne
2020-12-02 17:26 ` Florian Fainelli
2020-12-03 8:05 ` Bartosz Golaszewski [this message]
2020-12-03 8:53 ` Nicolas Saenz Julienne
2020-11-23 18:38 ` [PATCH v5 02/11] firmware: raspberrypi: Introduce devm_rpi_firmware_get() Nicolas Saenz Julienne
2020-12-02 17:27 ` Florian Fainelli
2020-11-23 18:38 ` [PATCH v5 03/11] clk: bcm: rpi: Release firmware handle on unbind Nicolas Saenz Julienne
2020-12-02 17:28 ` Florian Fainelli
2020-11-23 18:38 ` [PATCH v5 04/11] gpio: raspberrypi-exp: " Nicolas Saenz Julienne
2020-12-02 17:29 ` Florian Fainelli
2020-11-23 18:38 ` [PATCH v5 05/11] reset: raspberrypi: " Nicolas Saenz Julienne
2020-12-02 17:29 ` Florian Fainelli
2020-11-23 18:38 ` [PATCH v5 06/11] soc: bcm: raspberrypi-power: " Nicolas Saenz Julienne
2020-12-02 17:55 ` Florian Fainelli
2020-11-23 18:38 ` [PATCH v5 07/11] staging: vchiq: " Nicolas Saenz Julienne
2020-12-02 17:56 ` Florian Fainelli
2020-11-23 18:38 ` [PATCH v5 08/11] input: raspberrypi-ts: Release firmware handle when not needed Nicolas Saenz Julienne
2020-12-02 6:03 ` Dmitry Torokhov
2020-12-03 14:52 ` Nicolas Saenz Julienne
2020-11-23 18:38 ` [PATCH v5 09/11] dt-bindings: pwm: Add binding for RPi firmware PWM bus Nicolas Saenz Julienne
2020-11-23 18:38 ` [PATCH v5 10/11] DO NOT MERGE: ARM: dts: Add RPi's official PoE hat support Nicolas Saenz Julienne
2020-11-23 18:38 ` [PATCH v5 11/11] pwm: Add Raspberry Pi Firmware based PWM bus Nicolas Saenz Julienne
2020-12-09 10:42 ` Nicolas Saenz Julienne
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAMpxmJX6zdoYek2THEj2x8ycJYz-bxqE_5RnOz1sYv0vwLSFpA@mail.gmail.com \
--to=bgolaszewski@baylibre.com \
--cc=andy.shevchenko@gmail.com \
--cc=bcm-kernel-feedback-list@broadcom.com \
--cc=devel@driverdev.osuosl.org \
--cc=devicetree@vger.kernel.org \
--cc=dmitry.torokhov@gmail.com \
--cc=f.fainelli@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=linus.walleij@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-clk@vger.kernel.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--cc=linux-rpi-kernel@lists.infradead.org \
--cc=nsaenzjulienne@suse.de \
--cc=p.zabel@pengutronix.de \
--cc=rjui@broadcom.com \
--cc=sboyd@kernel.org \
--cc=sbranden@broadcom.com \
--cc=u.kleine-koenig@pengutronix.de \
--cc=wahrenst@gmx.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).