| Message ID | 1617344238-12137-1-git-send-email-deesin@codeaurora.org |
|---|---|
| Headers | show |
| Series | soc: qcom: aoss: Expose send for generic usecase | expand |
On Fri 02 Apr 01:17 CDT 2021, Deepak Kumar Singh wrote: > Not all upcoming usecases will have an interface to allow the aoss > driver to hook onto. Expose the send api and create a get function to > enable drivers to send their own messages to aoss. > > Signed-off-by: Chris Lew <clew@codeaurora.org> > Signed-off-by: Deepak Kumar Singh <deesin@codeaurora.org> > --- > drivers/soc/qcom/qcom_aoss.c | 36 +++++++++++++++++++++++++++++++++++- > 1 file changed, 35 insertions(+), 1 deletion(-) > > diff --git a/drivers/soc/qcom/qcom_aoss.c b/drivers/soc/qcom/qcom_aoss.c > index 53acb94..5c643f0 100644 > --- a/drivers/soc/qcom/qcom_aoss.c > +++ b/drivers/soc/qcom/qcom_aoss.c > @@ -8,10 +8,12 @@ > #include <linux/io.h> > #include <linux/mailbox_client.h> > #include <linux/module.h> > +#include <linux/of_platform.h> > #include <linux/platform_device.h> > #include <linux/pm_domain.h> > #include <linux/thermal.h> > #include <linux/slab.h> > +#include <linux/soc/qcom/qcom_aoss.h> I believe you forgot to 'git add' this. > > #define QMP_DESC_MAGIC 0x0 > #define QMP_DESC_VERSION 0x4 > @@ -223,11 +225,14 @@ static bool qmp_message_empty(struct qmp *qmp) > * > * Return: 0 on success, negative errno on failure > */ > -static int qmp_send(struct qmp *qmp, const void *data, size_t len) > +int qmp_send(struct qmp *qmp, const void *data, size_t len) > { > long time_left; > int ret; > > + if (!qmp || !data) I don't see a legit use case where these are NULL, so there's probably a developer staring at the kernel log wondering why their code isn't working. So better wrap this in a WARN_ON() to help him/her. Also, a developer failing to check the return value of qmp_get() would get here with qmp being -ENODEV, -EINVAL or -EPROBE_DEFER. Which we would gladly dereference in the next conditional. So rather than !qmp, IS_ERR_OR_NULL(qmp) would be useful. > + return -EINVAL; > + > if (WARN_ON(len + sizeof(u32) > qmp->size)) > return -EINVAL; > > @@ -261,6 +266,7 @@ static int qmp_send(struct qmp *qmp, const void *data, size_t len) > > return ret; > } > +EXPORT_SYMBOL(qmp_send); > > static int qmp_qdss_clk_prepare(struct clk_hw *hw) > { > @@ -515,6 +521,34 @@ static void qmp_cooling_devices_remove(struct qmp *qmp) > thermal_cooling_device_unregister(qmp->cooling_devs[i].cdev); > } > > +/** > + * qmp_get() - get a qmp handle from a device > + * @dev: client device pointer > + * > + * Return: handle to qmp device on success, ERR_PTR() on failure > + */ > +struct qmp *qmp_get(struct device *dev) > +{ > + struct platform_device *pdev; > + struct device_node *np; > + struct qmp *qmp; > + > + if (!dev || !dev->of_node) > + return ERR_PTR(-ENODEV); Value of @dev is an invalid argument, so I think -EINVAL is suitable. > + > + np = of_parse_phandle(dev->of_node, "qcom,qmp", 0); > + if (!np) > + return ERR_PTR(-ENODEV); > + > + pdev = of_find_device_by_node(np); of_find_device_by_node() will increment the refcount of the underlying struct device of pdev, so you need to platform_device_put() once you're done with it. As a side effect of not putting the struct device, the devm_kzalloc'ed qmp pointer will remain valid. So care is needed to make sure that the client doesn't end up with a dangling pointer if the qmp device is removed. My suggestion is that you add a "qmp_put()" function, which invokes platform_device_put() and that you add some sort of tracking ("bool orphan"?) to the struct qmp and make qmp_send() fail if this is set. That way if someone unbinds the aoss device, the client will still have a "valid" pointer, but won't be able to qmp_send() after qmp_close() has been called in the aoss remove function. Regards, Bjorn > + if (!pdev) > + return ERR_PTR(-EINVAL); > + > + qmp = platform_get_drvdata(pdev); > + return qmp ? qmp : ERR_PTR(-EPROBE_DEFER); > +} > +EXPORT_SYMBOL(qmp_get); > + > static int qmp_probe(struct platform_device *pdev) > { > struct resource *res; > -- > The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, > a Linux Foundation Collaborative Project >
On Fri 02 Apr 01:17 CDT 2021, Deepak Kumar Singh wrote: > [Change from V0] It's typical that the first patchset, without a version specified, is considered "version 1", and as such the second submission would be "v2". > Update qmp_get to parse qmp handle with binding qcom,qmp > I won't be able to merge this until we have a user of the API, so would it be possible to get at least one consumer introduced? Regards, Bjorn > Deepak Kumar Singh (2): > soc: qcom: aoss: Expose send for generic usecase > soc: qcom: aoss: Add debugfs entry > > drivers/soc/qcom/qcom_aoss.c | 77 +++++++++++++++++++++++++++++++++++++++++++- > 1 file changed, 76 insertions(+), 1 deletion(-) > > -- > The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, > a Linux Foundation Collaborative Project >
On Sun, Apr 04, 2021 at 12:17:52PM -0500, Bjorn Andersson wrote: > On Fri 02 Apr 01:17 CDT 2021, Deepak Kumar Singh wrote: > > > Not all upcoming usecases will have an interface to allow the aoss > > driver to hook onto. Expose the send api and create a get function to > > enable drivers to send their own messages to aoss. > > > > Signed-off-by: Chris Lew <clew@codeaurora.org> > > Signed-off-by: Deepak Kumar Singh <deesin@codeaurora.org> > > --- > > drivers/soc/qcom/qcom_aoss.c | 36 +++++++++++++++++++++++++++++++++++- > > 1 file changed, 35 insertions(+), 1 deletion(-) > > > > diff --git a/drivers/soc/qcom/qcom_aoss.c b/drivers/soc/qcom/qcom_aoss.c > > index 53acb94..5c643f0 100644 > > --- a/drivers/soc/qcom/qcom_aoss.c > > +++ b/drivers/soc/qcom/qcom_aoss.c > > @@ -8,10 +8,12 @@ [...] > > + pdev = of_find_device_by_node(np); > > of_find_device_by_node() will increment the refcount of the underlying > struct device of pdev, so you need to platform_device_put() once you're > done with it. > > As a side effect of not putting the struct device, the devm_kzalloc'ed > qmp pointer will remain valid. So care is needed to make sure that the > client doesn't end up with a dangling pointer if the qmp device is > removed. > > My suggestion is that you add a "qmp_put()" function, which invokes > platform_device_put() and that you add some sort of tracking ("bool > orphan"?) to the struct qmp and make qmp_send() fail if this is set. > I think this is a duplication of what the struct device offers. Why can't we use the generic infrastructure for this usecase? Like using device_initialize() in qmp_probe() along with a release callback for "struct device", then using get_device() in qmp_get(). Then there should also be a qmp_put() API which calls put_device() to decrease the refcount. Ideally, the final refcount should be dropped in qmp_remove() and then the release callback will be called automatically to free "struct qmp". > That way if someone unbinds the aoss device, the client will still have > a "valid" pointer, but won't be able to qmp_send() after qmp_close() has > been called in the aoss remove function. > How can someone remove the qmp device if a client is holding its reference? Thanks, Mani > Regards, > Bjorn > > > + if (!pdev) > > + return ERR_PTR(-EINVAL); > > + > > + qmp = platform_get_drvdata(pdev); > > + return qmp ? qmp : ERR_PTR(-EPROBE_DEFER); > > +} > > +EXPORT_SYMBOL(qmp_get); > > + > > static int qmp_probe(struct platform_device *pdev) > > { > > struct resource *res; > > -- > > The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, > > a Linux Foundation Collaborative Project > >
On Fri 09 Apr 02:31 CDT 2021, Manivannan Sadhasivam wrote: > On Sun, Apr 04, 2021 at 12:17:52PM -0500, Bjorn Andersson wrote: > > On Fri 02 Apr 01:17 CDT 2021, Deepak Kumar Singh wrote: > > > > > Not all upcoming usecases will have an interface to allow the aoss > > > driver to hook onto. Expose the send api and create a get function to > > > enable drivers to send their own messages to aoss. > > > > > > Signed-off-by: Chris Lew <clew@codeaurora.org> > > > Signed-off-by: Deepak Kumar Singh <deesin@codeaurora.org> > > > --- > > > drivers/soc/qcom/qcom_aoss.c | 36 +++++++++++++++++++++++++++++++++++- > > > 1 file changed, 35 insertions(+), 1 deletion(-) > > > > > > diff --git a/drivers/soc/qcom/qcom_aoss.c b/drivers/soc/qcom/qcom_aoss.c > > > index 53acb94..5c643f0 100644 > > > --- a/drivers/soc/qcom/qcom_aoss.c > > > +++ b/drivers/soc/qcom/qcom_aoss.c > > > @@ -8,10 +8,12 @@ > > [...] > > > > + pdev = of_find_device_by_node(np); > > > > of_find_device_by_node() will increment the refcount of the underlying > > struct device of pdev, so you need to platform_device_put() once you're > > done with it. > > > > As a side effect of not putting the struct device, the devm_kzalloc'ed > > qmp pointer will remain valid. So care is needed to make sure that the > > client doesn't end up with a dangling pointer if the qmp device is > > removed. > > > > My suggestion is that you add a "qmp_put()" function, which invokes > > platform_device_put() and that you add some sort of tracking ("bool > > orphan"?) to the struct qmp and make qmp_send() fail if this is set. > > > > I think this is a duplication of what the struct device offers. Why > can't we use the generic infrastructure for this usecase? > > Like using device_initialize() in qmp_probe() along with a release > callback for "struct device", then using get_device() in qmp_get(). > Then there should also be a qmp_put() API which calls put_device() to > decrease the refcount. > > Ideally, the final refcount should be dropped in qmp_remove() and then > the release callback will be called automatically to free "struct qmp". > > > That way if someone unbinds the aoss device, the client will still have > > a "valid" pointer, but won't be able to qmp_send() after qmp_close() has > > been called in the aoss remove function. > > > > How can someone remove the qmp device if a client is holding its reference? > The device could be unbound using sysfs, in which case remove() is called and I assumed that devres wouldn't be released until the struct device's refcount hit 0. Apparently this does not seems to be how it works, following the unbind path I see that devres is shot down regardless of the struct device's refcount. So we would need to ensure that struct qmp is refcounted on its own. For this we don't need a separate struct device, we can simply add a kref to the struct and avoid using devres to keep track of its lifetime. Regards, Bjorn > Thanks, > Mani > > > Regards, > > Bjorn > > > > > + if (!pdev) > > > + return ERR_PTR(-EINVAL); > > > + > > > + qmp = platform_get_drvdata(pdev); > > > + return qmp ? qmp : ERR_PTR(-EPROBE_DEFER); > > > +} > > > +EXPORT_SYMBOL(qmp_get); > > > + > > > static int qmp_probe(struct platform_device *pdev) > > > { > > > struct resource *res; > > > -- > > > The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, > > > a Linux Foundation Collaborative Project > > >