From: Thierry Reding <thierry.reding@gmail.com>
To: Jassi Brar <jassisinghbrar@gmail.com>
Cc: linux-kernel@vger.kernel.org,
Andy Gospodarek <gospo@broadcom.com>,
Bjorn Andersson <bjorn.andersson@linaro.org>,
Caesar Wang <wxt@rock-chips.com>, CK Hu <ck.hu@mediatek.com>,
Dong Aisheng <aisheng.dong@nxp.com>,
Eric Anholt <eric@anholt.net>,
Fabien Dessenne <fabien.dessenne@st.com>,
Florian Fainelli <f.fainelli@gmail.com>,
Georgi Djakov <georgi.djakov@linaro.org>,
Houlong Wei <houlong.wei@mediatek.com>,
HS Liao <hs.liao@mediatek.com>,
Kaihua Zhong <zhongkaihua@huawei.com>,
Kevin Wangtao <kevin.wangtao@hisilicon.com>,
Lee Jones <lee.jones@linaro.org>, Leo Yan <leo.yan@linaro.org>,
Ley Foon Tan <lftan@altera.com>,
Ludovic Barre <ludovic.barre@st.com>,
Neil Armstrong <narmstrong@baylibre.com>,
Nishanth Menon <nm@ti.com>,
Oleksij Rempel <o.rempel@pengutronix.de>,
Ray Jui <ray.jui@broadcom.com>, Rob Rice <rob.rice@broadcom.com>,
Scott Branden <scott.branden@broadcom.com>,
Sibi Sankar <sibis@codeaurora.org>,
Stefan Wahren <stefan.wahren@i2se.com>,
Sudeep Holla <sudeep.holla@arm.com>, Suman Anna <s-anna@ti.com>,
Tony Lindgren <tony@atomide.com>,
Vikram Prakash <vikram.prakash@broadcom.com>,
Vladimir Zapolskiy <vz@mleia.com>
Subject: [PATCH v3 01/19] mailbox: Add device-managed registration functions
Date: Thu, 20 Dec 2018 18:19:44 +0100 [thread overview]
Message-ID: <20181220172002.9016-2-thierry.reding@gmail.com> (raw)
In-Reply-To: <20181220172002.9016-1-thierry.reding@gmail.com>
From: Thierry Reding <treding@nvidia.com>
Add device-managed equivalents of the mbox_controller_register() and
mbox_controller_unregister() functions that can be used to have the
devres infrastructure automatically unregister mailbox controllers on
driver probe failure or driver removal. This can help remove a lot of
boiler plate code from drivers.
Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Reviewed-by: Sudeep Holla <sudeep.holla@arm.com>
Signed-off-by: Thierry Reding <treding@nvidia.com>
---
Changes in v2:
- fix indirection in device-managed pointer (now runtime-tested)
drivers/mailbox/mailbox.c | 70 ++++++++++++++++++++++++++++++
include/linux/mailbox_controller.h | 5 +++
2 files changed, 75 insertions(+)
diff --git a/drivers/mailbox/mailbox.c b/drivers/mailbox/mailbox.c
index 674b35f402f5..08ce9a1ab53a 100644
--- a/drivers/mailbox/mailbox.c
+++ b/drivers/mailbox/mailbox.c
@@ -515,3 +515,73 @@ void mbox_controller_unregister(struct mbox_controller *mbox)
mutex_unlock(&con_mutex);
}
EXPORT_SYMBOL_GPL(mbox_controller_unregister);
+
+static void __devm_mbox_controller_unregister(struct device *dev, void *res)
+{
+ struct mbox_controller **mbox = res;
+
+ mbox_controller_unregister(*mbox);
+}
+
+static int devm_mbox_controller_match(struct device *dev, void *res, void *data)
+{
+ struct mbox_controller **mbox = res;
+
+ if (WARN_ON(!mbox || !*mbox))
+ return 0;
+
+ return *mbox == data;
+}
+
+/**
+ * devm_mbox_controller_register() - managed mbox_controller_register()
+ * @dev: device owning the mailbox controller being registered
+ * @mbox: mailbox controller being registered
+ *
+ * This function adds a device-managed resource that will make sure that the
+ * mailbox controller, which is registered using mbox_controller_register()
+ * as part of this function, will be unregistered along with the rest of
+ * device-managed resources upon driver probe failure or driver removal.
+ *
+ * Returns 0 on success or a negative error code on failure.
+ */
+int devm_mbox_controller_register(struct device *dev,
+ struct mbox_controller *mbox)
+{
+ struct mbox_controller **ptr;
+ int err;
+
+ ptr = devres_alloc(__devm_mbox_controller_unregister, sizeof(*ptr),
+ GFP_KERNEL);
+ if (!ptr)
+ return -ENOMEM;
+
+ err = mbox_controller_register(mbox);
+ if (err < 0) {
+ devres_free(ptr);
+ return err;
+ }
+
+ devres_add(dev, ptr);
+ *ptr = mbox;
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(devm_mbox_controller_register);
+
+/**
+ * devm_mbox_controller_unregister() - managed mbox_controller_unregister()
+ * @dev: device owning the mailbox controller being unregistered
+ * @mbox: mailbox controller being unregistered
+ *
+ * This function unregisters the mailbox controller and removes the device-
+ * managed resource that was set up to automatically unregister the mailbox
+ * controller on driver probe failure or driver removal. It's typically not
+ * necessary to call this function.
+ */
+void devm_mbox_controller_unregister(struct device *dev, struct mbox_controller *mbox)
+{
+ WARN_ON(devres_release(dev, __devm_mbox_controller_unregister,
+ devm_mbox_controller_match, mbox));
+}
+EXPORT_SYMBOL_GPL(devm_mbox_controller_unregister);
diff --git a/include/linux/mailbox_controller.h b/include/linux/mailbox_controller.h
index 74deadb42d76..9b0b21207345 100644
--- a/include/linux/mailbox_controller.h
+++ b/include/linux/mailbox_controller.h
@@ -131,4 +131,9 @@ void mbox_controller_unregister(struct mbox_controller *mbox); /* can sleep */
void mbox_chan_received_data(struct mbox_chan *chan, void *data); /* atomic */
void mbox_chan_txdone(struct mbox_chan *chan, int r); /* atomic */
+int devm_mbox_controller_register(struct device *dev,
+ struct mbox_controller *mbox);
+void devm_mbox_controller_unregister(struct device *dev,
+ struct mbox_controller *mbox);
+
#endif /* __MAILBOX_CONTROLLER_H */
--
2.19.1
next prev parent reply other threads:[~2018-12-20 17:20 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-20 17:19 [PATCH v3 00/19] mailbox: Device-managed registration Thierry Reding
2018-12-20 17:19 ` Thierry Reding [this message]
2018-12-20 17:19 ` [PATCH v3 02/19] mailbox: arm-mhu: Use device-managed registration API Thierry Reding
2018-12-20 17:19 ` [PATCH v3 03/19] mailbox: bcm2835: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 04/19] mailbox: bcm-flexrm: " Thierry Reding
2018-12-20 17:46 ` Scott Branden
2018-12-20 17:19 ` [PATCH v3 05/19] mailbox: bcm-pdc: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 06/19] mailbox: hi3660: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 07/19] mailbox: hi6220: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 08/19] mailbox: imx: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 09/19] mailbox: altera: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 10/19] mailbox: sti: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 11/19] mailbox: xgene-slimpro: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 12/19] mailbox: mtk-cmdq: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 13/19] mailbox: mtk-cmdq: Remove needless devm_kfree() calls Thierry Reding
2018-12-20 17:19 ` [PATCH v3 14/19] mailbox: omap: Use device-managed registration API Thierry Reding
2018-12-20 17:19 ` [PATCH v3 15/19] mailbox: platform-mhu: " Thierry Reding
2018-12-20 17:19 ` [PATCH v3 16/19] mailbox: qcom-apcs: " Thierry Reding
2018-12-20 17:20 ` [PATCH v3 17/19] mailbox: rockchip: " Thierry Reding
2018-12-20 17:20 ` [PATCH v3 18/19] mailbox: stm32-ipcc: " Thierry Reding
2018-12-20 17:20 ` [PATCH v3 19/19] mailbox: ti-msgmgr: " Thierry Reding
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=20181220172002.9016-2-thierry.reding@gmail.com \
--to=thierry.reding@gmail.com \
--cc=aisheng.dong@nxp.com \
--cc=bjorn.andersson@linaro.org \
--cc=ck.hu@mediatek.com \
--cc=eric@anholt.net \
--cc=f.fainelli@gmail.com \
--cc=fabien.dessenne@st.com \
--cc=georgi.djakov@linaro.org \
--cc=gospo@broadcom.com \
--cc=houlong.wei@mediatek.com \
--cc=hs.liao@mediatek.com \
--cc=jassisinghbrar@gmail.com \
--cc=kevin.wangtao@hisilicon.com \
--cc=lee.jones@linaro.org \
--cc=leo.yan@linaro.org \
--cc=lftan@altera.com \
--cc=linux-kernel@vger.kernel.org \
--cc=ludovic.barre@st.com \
--cc=narmstrong@baylibre.com \
--cc=nm@ti.com \
--cc=o.rempel@pengutronix.de \
--cc=ray.jui@broadcom.com \
--cc=rob.rice@broadcom.com \
--cc=s-anna@ti.com \
--cc=scott.branden@broadcom.com \
--cc=sibis@codeaurora.org \
--cc=stefan.wahren@i2se.com \
--cc=sudeep.holla@arm.com \
--cc=tony@atomide.com \
--cc=vikram.prakash@broadcom.com \
--cc=vz@mleia.com \
--cc=wxt@rock-chips.com \
--cc=zhongkaihua@huawei.com \
/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).