| Message ID | 20211108141937.13016-2-arnaud.pouliquen@foss.st.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Restructure the rpmsg_char driver and introduce rpmsg_ctrl driver | expand |
On Mon 08 Nov 08:19 CST 2021, Arnaud Pouliquen wrote: > To prepare the split of the code related to the control (ctrldev) > and the endpoint (eptdev) devices in 2 separate files: > > - Rename and export the functions in rpmsg_char.h. > > - Suppress the dependency with the rpmsg_ctrldev struct in the > rpmsg_eptdev_create function. > > Suggested-by: Mathieu Poirier <mathieu.poirier@linaro.org> > Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com> > --- > Update vs previous revision: > - change IS_REACHABLE by IS_ENABLE ( dependency will be fixed in kconfig instead > - fix licensing > --- > drivers/rpmsg/rpmsg_char.c | 17 +++++++------ > drivers/rpmsg/rpmsg_char.h | 51 ++++++++++++++++++++++++++++++++++++++ > 2 files changed, 61 insertions(+), 7 deletions(-) > create mode 100644 drivers/rpmsg/rpmsg_char.h > > diff --git a/drivers/rpmsg/rpmsg_char.c b/drivers/rpmsg/rpmsg_char.c > index 2bebc9b2d163..44934d7fa3c4 100644 > --- a/drivers/rpmsg/rpmsg_char.c > +++ b/drivers/rpmsg/rpmsg_char.c > @@ -1,5 +1,6 @@ > // SPDX-License-Identifier: GPL-2.0 > /* > + * Copyright (C) 2021, STMicroelectronics > * Copyright (c) 2016, Linaro Ltd. > * Copyright (c) 2012, Michal Simek <monstr@monstr.eu> > * Copyright (c) 2012, PetaLogix > @@ -23,6 +24,7 @@ > #include <uapi/linux/rpmsg.h> > > #include "rpmsg_internal.h" > +#include "rpmsg_char.h" > > #define RPMSG_DEV_MAX (MINORMASK + 1) > > @@ -78,7 +80,7 @@ struct rpmsg_eptdev { > wait_queue_head_t readq; > }; > > -static int rpmsg_eptdev_destroy(struct device *dev, void *data) > +int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data) > { > struct rpmsg_eptdev *eptdev = dev_to_eptdev(dev); > > @@ -97,6 +99,7 @@ static int rpmsg_eptdev_destroy(struct device *dev, void *data) > > return 0; > } > +EXPORT_SYMBOL(rpmsg_chrdev_eptdev_destroy); > > static int rpmsg_ept_cb(struct rpmsg_device *rpdev, void *buf, int len, > void *priv, u32 addr) > @@ -280,7 +283,7 @@ static long rpmsg_eptdev_ioctl(struct file *fp, unsigned int cmd, > if (cmd != RPMSG_DESTROY_EPT_IOCTL) > return -EINVAL; > > - return rpmsg_eptdev_destroy(&eptdev->dev, NULL); > + return rpmsg_chrdev_eptdev_destroy(&eptdev->dev, NULL); > } > > static const struct file_operations rpmsg_eptdev_fops = { > @@ -339,10 +342,9 @@ static void rpmsg_eptdev_release_device(struct device *dev) > kfree(eptdev); > } > > -static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, > +int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, > struct rpmsg_channel_info chinfo) > { > - struct rpmsg_device *rpdev = ctrldev->rpdev; > struct rpmsg_eptdev *eptdev; > struct device *dev; > int ret; > @@ -362,7 +364,7 @@ static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, > > device_initialize(dev); > dev->class = rpmsg_class; > - dev->parent = &ctrldev->dev; > + dev->parent = parent; > dev->groups = rpmsg_eptdev_groups; > dev_set_drvdata(dev, eptdev); > > @@ -405,6 +407,7 @@ static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, > > return ret; > } > +EXPORT_SYMBOL(rpmsg_chrdev_eptdev_create); > > static int rpmsg_ctrldev_open(struct inode *inode, struct file *filp) > { > @@ -444,7 +447,7 @@ static long rpmsg_ctrldev_ioctl(struct file *fp, unsigned int cmd, > chinfo.src = eptinfo.src; > chinfo.dst = eptinfo.dst; > > - return rpmsg_eptdev_create(ctrldev, chinfo); > + return rpmsg_chrdev_eptdev_create(ctrldev->rpdev, &ctrldev->dev, chinfo); > }; > > static const struct file_operations rpmsg_ctrldev_fops = { > @@ -530,7 +533,7 @@ static void rpmsg_chrdev_remove(struct rpmsg_device *rpdev) > int ret; > > /* Destroy all endpoints */ > - ret = device_for_each_child(&ctrldev->dev, NULL, rpmsg_eptdev_destroy); > + ret = device_for_each_child(&ctrldev->dev, NULL, rpmsg_chrdev_eptdev_destroy); > if (ret) > dev_warn(&rpdev->dev, "failed to nuke endpoints: %d\n", ret); > > diff --git a/drivers/rpmsg/rpmsg_char.h b/drivers/rpmsg/rpmsg_char.h > new file mode 100644 > index 000000000000..aa6e08a04577 > --- /dev/null > +++ b/drivers/rpmsg/rpmsg_char.h > @@ -0,0 +1,51 @@ > +/* SPDX-License-Identifier: GPL-2.0 */ > +/* > + * Copyright (C) STMicroelectronics 2021. > + */ > + > +#ifndef __RPMSG_CHRDEV_H__ > +#define __RPMSG_CHRDEV_H__ > + > +#if IS_ENABLED(CONFIG_RPMSG_CHAR) > +/** > + * rpmsg_chrdev_eptdev_create() - register char device based on an endpoint > + * @rpdev: prepared rpdev to be used for creating endpoints > + * @parent: parent device > + * @chinfo: associated endpoint channel information. > + * > + * This function create a new rpmsg char endpoint device to instantiate a new > + * endpoint based on chinfo information. > + */ > +int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, > + struct rpmsg_channel_info chinfo); > + > +/** > + * rpmsg_chrdev_eptdev_destroy() - destroy created char device endpoint. > + * @data: private data associated to the endpoint device > + * > + * This function destroys a rpmsg char endpoint device created by the RPMSG_DESTROY_EPT_IOCTL > + * control. > + */ > +int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data); > + > +#else /*IS_ENABLED(CONFIG_RPMSG_CHAR) */ > + > +static inline int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, > + struct rpmsg_channel_info chinfo) > +{ > + /* This shouldn't be possible */ But isn't it very much possible that userspace invokes this function through the ioctl that you move to the separate rpmsg_ctrl driver? > + WARN_ON(1); Which would mean that this will spam the kernel with stack dumps. Regards, Bjorn > + return -EINVAL; > +} > + > +static inline int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data) > +{ > + /* This shouldn't be possible */ > + WARN_ON(1); > + > + return 0; > +} > + > +#endif /*IS_ENABLED(CONFIG_RPMSG_CHAR) */ > + > +#endif /*__RPMSG_CHRDEV_H__ */ > -- > 2.17.1 >
Hello Bjorn, On 12/3/21 3:17 AM, Bjorn Andersson wrote: > On Mon 08 Nov 08:19 CST 2021, Arnaud Pouliquen wrote: > >> To prepare the split of the code related to the control (ctrldev) >> and the endpoint (eptdev) devices in 2 separate files: >> >> - Rename and export the functions in rpmsg_char.h. >> >> - Suppress the dependency with the rpmsg_ctrldev struct in the >> rpmsg_eptdev_create function. >> >> Suggested-by: Mathieu Poirier <mathieu.poirier@linaro.org> >> Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com> >> --- >> Update vs previous revision: >> - change IS_REACHABLE by IS_ENABLE ( dependency will be fixed in kconfig instead >> - fix licensing >> --- >> drivers/rpmsg/rpmsg_char.c | 17 +++++++------ >> drivers/rpmsg/rpmsg_char.h | 51 ++++++++++++++++++++++++++++++++++++++ >> 2 files changed, 61 insertions(+), 7 deletions(-) >> create mode 100644 drivers/rpmsg/rpmsg_char.h >> >> diff --git a/drivers/rpmsg/rpmsg_char.c b/drivers/rpmsg/rpmsg_char.c >> index 2bebc9b2d163..44934d7fa3c4 100644 >> --- a/drivers/rpmsg/rpmsg_char.c >> +++ b/drivers/rpmsg/rpmsg_char.c >> @@ -1,5 +1,6 @@ >> // SPDX-License-Identifier: GPL-2.0 >> /* >> + * Copyright (C) 2021, STMicroelectronics >> * Copyright (c) 2016, Linaro Ltd. >> * Copyright (c) 2012, Michal Simek <monstr@monstr.eu> >> * Copyright (c) 2012, PetaLogix >> @@ -23,6 +24,7 @@ >> #include <uapi/linux/rpmsg.h> >> >> #include "rpmsg_internal.h" >> +#include "rpmsg_char.h" >> >> #define RPMSG_DEV_MAX (MINORMASK + 1) >> >> @@ -78,7 +80,7 @@ struct rpmsg_eptdev { >> wait_queue_head_t readq; >> }; >> >> -static int rpmsg_eptdev_destroy(struct device *dev, void *data) >> +int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data) >> { >> struct rpmsg_eptdev *eptdev = dev_to_eptdev(dev); >> >> @@ -97,6 +99,7 @@ static int rpmsg_eptdev_destroy(struct device *dev, void *data) >> >> return 0; >> } >> +EXPORT_SYMBOL(rpmsg_chrdev_eptdev_destroy); >> >> static int rpmsg_ept_cb(struct rpmsg_device *rpdev, void *buf, int len, >> void *priv, u32 addr) >> @@ -280,7 +283,7 @@ static long rpmsg_eptdev_ioctl(struct file *fp, unsigned int cmd, >> if (cmd != RPMSG_DESTROY_EPT_IOCTL) >> return -EINVAL; >> >> - return rpmsg_eptdev_destroy(&eptdev->dev, NULL); >> + return rpmsg_chrdev_eptdev_destroy(&eptdev->dev, NULL); >> } >> >> static const struct file_operations rpmsg_eptdev_fops = { >> @@ -339,10 +342,9 @@ static void rpmsg_eptdev_release_device(struct device *dev) >> kfree(eptdev); >> } >> >> -static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, >> +int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, >> struct rpmsg_channel_info chinfo) >> { >> - struct rpmsg_device *rpdev = ctrldev->rpdev; >> struct rpmsg_eptdev *eptdev; >> struct device *dev; >> int ret; >> @@ -362,7 +364,7 @@ static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, >> >> device_initialize(dev); >> dev->class = rpmsg_class; >> - dev->parent = &ctrldev->dev; >> + dev->parent = parent; >> dev->groups = rpmsg_eptdev_groups; >> dev_set_drvdata(dev, eptdev); >> >> @@ -405,6 +407,7 @@ static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, >> >> return ret; >> } >> +EXPORT_SYMBOL(rpmsg_chrdev_eptdev_create); >> >> static int rpmsg_ctrldev_open(struct inode *inode, struct file *filp) >> { >> @@ -444,7 +447,7 @@ static long rpmsg_ctrldev_ioctl(struct file *fp, unsigned int cmd, >> chinfo.src = eptinfo.src; >> chinfo.dst = eptinfo.dst; >> >> - return rpmsg_eptdev_create(ctrldev, chinfo); >> + return rpmsg_chrdev_eptdev_create(ctrldev->rpdev, &ctrldev->dev, chinfo); >> }; >> >> static const struct file_operations rpmsg_ctrldev_fops = { >> @@ -530,7 +533,7 @@ static void rpmsg_chrdev_remove(struct rpmsg_device *rpdev) >> int ret; >> >> /* Destroy all endpoints */ >> - ret = device_for_each_child(&ctrldev->dev, NULL, rpmsg_eptdev_destroy); >> + ret = device_for_each_child(&ctrldev->dev, NULL, rpmsg_chrdev_eptdev_destroy); >> if (ret) >> dev_warn(&rpdev->dev, "failed to nuke endpoints: %d\n", ret); >> >> diff --git a/drivers/rpmsg/rpmsg_char.h b/drivers/rpmsg/rpmsg_char.h >> new file mode 100644 >> index 000000000000..aa6e08a04577 >> --- /dev/null >> +++ b/drivers/rpmsg/rpmsg_char.h >> @@ -0,0 +1,51 @@ >> +/* SPDX-License-Identifier: GPL-2.0 */ >> +/* >> + * Copyright (C) STMicroelectronics 2021. >> + */ >> + >> +#ifndef __RPMSG_CHRDEV_H__ >> +#define __RPMSG_CHRDEV_H__ >> + >> +#if IS_ENABLED(CONFIG_RPMSG_CHAR) >> +/** >> + * rpmsg_chrdev_eptdev_create() - register char device based on an endpoint >> + * @rpdev: prepared rpdev to be used for creating endpoints >> + * @parent: parent device >> + * @chinfo: associated endpoint channel information. >> + * >> + * This function create a new rpmsg char endpoint device to instantiate a new >> + * endpoint based on chinfo information. >> + */ >> +int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, >> + struct rpmsg_channel_info chinfo); >> + >> +/** >> + * rpmsg_chrdev_eptdev_destroy() - destroy created char device endpoint. >> + * @data: private data associated to the endpoint device >> + * >> + * This function destroys a rpmsg char endpoint device created by the RPMSG_DESTROY_EPT_IOCTL >> + * control. >> + */ >> +int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data); >> + >> +#else /*IS_ENABLED(CONFIG_RPMSG_CHAR) */ >> + >> +static inline int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, >> + struct rpmsg_channel_info chinfo) >> +{ >> + /* This shouldn't be possible */ > > But isn't it very much possible that userspace invokes this function > through the ioctl that you move to the separate rpmsg_ctrl driver? > >> + WARN_ON(1); > > Which would mean that this will spam the kernel with stack dumps. Good catch, I will suppress the WARM_ON. I propose also to return -ENXIO instead of -EINVAL to be aligned with other functions in rpmsg.h Thanks, Arnaud > > Regards, > Bjorn > >> + return -EINVAL; >> +} >> + >> +static inline int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data) >> +{ >> + /* This shouldn't be possible */ >> + WARN_ON(1); >> + >> + return 0; >> +} >> + >> +#endif /*IS_ENABLED(CONFIG_RPMSG_CHAR) */ >> + >> +#endif /*__RPMSG_CHRDEV_H__ */ >> -- >> 2.17.1 >>
On Fri 03 Dec 08:37 PST 2021, Arnaud POULIQUEN wrote: > On 12/3/21 3:17 AM, Bjorn Andersson wrote: > > On Mon 08 Nov 08:19 CST 2021, Arnaud Pouliquen wrote: [..] > >> +static inline int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, > >> + struct rpmsg_channel_info chinfo) > >> +{ > >> + /* This shouldn't be possible */ > > > > But isn't it very much possible that userspace invokes this function > > through the ioctl that you move to the separate rpmsg_ctrl driver? > > > >> + WARN_ON(1); > > > > Which would mean that this will spam the kernel with stack dumps. > > Good catch, I will suppress the WARM_ON. I propose also to return -ENXIO > instead of -EINVAL to be aligned with other functions in rpmsg.h > ENXIO sounds better than EINVAL, let's go with that. Thanks, Bjorn
diff --git a/drivers/rpmsg/rpmsg_char.c b/drivers/rpmsg/rpmsg_char.c index 2bebc9b2d163..44934d7fa3c4 100644 --- a/drivers/rpmsg/rpmsg_char.c +++ b/drivers/rpmsg/rpmsg_char.c @@ -1,5 +1,6 @@ // SPDX-License-Identifier: GPL-2.0 /* + * Copyright (C) 2021, STMicroelectronics * Copyright (c) 2016, Linaro Ltd. * Copyright (c) 2012, Michal Simek <monstr@monstr.eu> * Copyright (c) 2012, PetaLogix @@ -23,6 +24,7 @@ #include <uapi/linux/rpmsg.h> #include "rpmsg_internal.h" +#include "rpmsg_char.h" #define RPMSG_DEV_MAX (MINORMASK + 1) @@ -78,7 +80,7 @@ struct rpmsg_eptdev { wait_queue_head_t readq; }; -static int rpmsg_eptdev_destroy(struct device *dev, void *data) +int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data) { struct rpmsg_eptdev *eptdev = dev_to_eptdev(dev); @@ -97,6 +99,7 @@ static int rpmsg_eptdev_destroy(struct device *dev, void *data) return 0; } +EXPORT_SYMBOL(rpmsg_chrdev_eptdev_destroy); static int rpmsg_ept_cb(struct rpmsg_device *rpdev, void *buf, int len, void *priv, u32 addr) @@ -280,7 +283,7 @@ static long rpmsg_eptdev_ioctl(struct file *fp, unsigned int cmd, if (cmd != RPMSG_DESTROY_EPT_IOCTL) return -EINVAL; - return rpmsg_eptdev_destroy(&eptdev->dev, NULL); + return rpmsg_chrdev_eptdev_destroy(&eptdev->dev, NULL); } static const struct file_operations rpmsg_eptdev_fops = { @@ -339,10 +342,9 @@ static void rpmsg_eptdev_release_device(struct device *dev) kfree(eptdev); } -static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, +int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, struct rpmsg_channel_info chinfo) { - struct rpmsg_device *rpdev = ctrldev->rpdev; struct rpmsg_eptdev *eptdev; struct device *dev; int ret; @@ -362,7 +364,7 @@ static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, device_initialize(dev); dev->class = rpmsg_class; - dev->parent = &ctrldev->dev; + dev->parent = parent; dev->groups = rpmsg_eptdev_groups; dev_set_drvdata(dev, eptdev); @@ -405,6 +407,7 @@ static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev, return ret; } +EXPORT_SYMBOL(rpmsg_chrdev_eptdev_create); static int rpmsg_ctrldev_open(struct inode *inode, struct file *filp) { @@ -444,7 +447,7 @@ static long rpmsg_ctrldev_ioctl(struct file *fp, unsigned int cmd, chinfo.src = eptinfo.src; chinfo.dst = eptinfo.dst; - return rpmsg_eptdev_create(ctrldev, chinfo); + return rpmsg_chrdev_eptdev_create(ctrldev->rpdev, &ctrldev->dev, chinfo); }; static const struct file_operations rpmsg_ctrldev_fops = { @@ -530,7 +533,7 @@ static void rpmsg_chrdev_remove(struct rpmsg_device *rpdev) int ret; /* Destroy all endpoints */ - ret = device_for_each_child(&ctrldev->dev, NULL, rpmsg_eptdev_destroy); + ret = device_for_each_child(&ctrldev->dev, NULL, rpmsg_chrdev_eptdev_destroy); if (ret) dev_warn(&rpdev->dev, "failed to nuke endpoints: %d\n", ret); diff --git a/drivers/rpmsg/rpmsg_char.h b/drivers/rpmsg/rpmsg_char.h new file mode 100644 index 000000000000..aa6e08a04577 --- /dev/null +++ b/drivers/rpmsg/rpmsg_char.h @@ -0,0 +1,51 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * Copyright (C) STMicroelectronics 2021. + */ + +#ifndef __RPMSG_CHRDEV_H__ +#define __RPMSG_CHRDEV_H__ + +#if IS_ENABLED(CONFIG_RPMSG_CHAR) +/** + * rpmsg_chrdev_eptdev_create() - register char device based on an endpoint + * @rpdev: prepared rpdev to be used for creating endpoints + * @parent: parent device + * @chinfo: associated endpoint channel information. + * + * This function create a new rpmsg char endpoint device to instantiate a new + * endpoint based on chinfo information. + */ +int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, + struct rpmsg_channel_info chinfo); + +/** + * rpmsg_chrdev_eptdev_destroy() - destroy created char device endpoint. + * @data: private data associated to the endpoint device + * + * This function destroys a rpmsg char endpoint device created by the RPMSG_DESTROY_EPT_IOCTL + * control. + */ +int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data); + +#else /*IS_ENABLED(CONFIG_RPMSG_CHAR) */ + +static inline int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent, + struct rpmsg_channel_info chinfo) +{ + /* This shouldn't be possible */ + WARN_ON(1); + return -EINVAL; +} + +static inline int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data) +{ + /* This shouldn't be possible */ + WARN_ON(1); + + return 0; +} + +#endif /*IS_ENABLED(CONFIG_RPMSG_CHAR) */ + +#endif /*__RPMSG_CHRDEV_H__ */
To prepare the split of the code related to the control (ctrldev) and the endpoint (eptdev) devices in 2 separate files: - Rename and export the functions in rpmsg_char.h. - Suppress the dependency with the rpmsg_ctrldev struct in the rpmsg_eptdev_create function. Suggested-by: Mathieu Poirier <mathieu.poirier@linaro.org> Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com> --- Update vs previous revision: - change IS_REACHABLE by IS_ENABLE ( dependency will be fixed in kconfig instead - fix licensing --- drivers/rpmsg/rpmsg_char.c | 17 +++++++------ drivers/rpmsg/rpmsg_char.h | 51 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 7 deletions(-) create mode 100644 drivers/rpmsg/rpmsg_char.h