Skip to contentSkip to conversation

Add character device interface to remoteproc

PATCH In review Rishabh Bhatnagar 5 participants 14 messages Apr 21, 2020 – Jul 1, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v3 cover Add character device interface to remoteproc

This patch series adds a character device interface to remoteproc framework. Currently there is only a sysfs interface which the userspace clients can use. If a usersapce application crashes after booting the remote processor through the sysfs interface the remote processor does not get any indication about the crash. It might still assume that the application is running.
For example modem uses remotefs service to data from disk/flash memory. If the remotefs service crashes, modem still keeps on requesting data which might lead to crash on modem. Even if the service is restarted the file handles modem requested previously would become stale. Adding a character device interface makes the remote processor tightly coupled with the user space application. A crash of the application leads to a close on the file descriptors therefore shutting down the remoteproc.

Changelog:

v2 -> v3:
- Move booting of remoteproc from open to a write call.
- Add ioctl interface for future functionality extension.
- Add an ioctl call to default to rproc shutdown on release.

v2 -> v1:
- Fixed comments from Bjorn and Matthew.

Rishabh Bhatnagar (2):
remoteproc: Add remoteproc character device interface
remoteproc: core: Register the character device interface

 Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
 drivers/remoteproc/Kconfig                         |   9 ++
 drivers/remoteproc/Makefile                        |   1 +
 drivers/remoteproc/remoteproc_cdev.c               | 142 +++++++++++++++++++++
 drivers/remoteproc/remoteproc_core.c               |  10 ++
 drivers/remoteproc/remoteproc_internal.h           |  21 +++
 include/linux/remoteproc.h                         |   3 +
 include/uapi/linux/remoteproc_cdev.h               |  21 +++
 8 files changed, 208 insertions(+)
 create mode 100644 drivers/remoteproc/remoteproc_cdev.c
 create mode 100644 include/uapi/linux/remoteproc_cdev.h
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#1 lore raw

PATCH v3 1/2 remoteproc: Add remoteproc character device interface

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

---
 Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
 drivers/remoteproc/Kconfig                         |   9 ++
 drivers/remoteproc/Makefile                        |   1 +
 drivers/remoteproc/remoteproc_cdev.c               | 143 +++++++++++++++++++++
 drivers/remoteproc/remoteproc_internal.h           |  21 +++
 include/linux/remoteproc.h                         |   3 +
 include/uapi/linux/remoteproc_cdev.h               |  20 +++
 7 files changed, 198 insertions(+)
 create mode 100644 drivers/remoteproc/remoteproc_cdev.c
 create mode 100644 include/uapi/linux/remoteproc_cdev.h
Documentation/userspace-api/ioctl/ioctl-number.rst +1 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File                                           Comments
 0xB4  00-0F  linux/gpio.h                                            <mailto:[email protected]>
 0xB5  00-0F  uapi/linux/rpmsg.h                                      <mailto:[email protected]>
 0xB6  all    linux/fpga-dfl.h
+0xB7  all    uapi/linux/remoteproc_cdev.h			     <mailto:[email protected]>
 0xC0  00-0F  linux/usb/iowarrior.h
 0xCA  00-0F  uapi/misc/cxl.h
 0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
 if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
 config IMX_REMOTEPROC
 	tristate "IMX6/7 remoteproc support"
 	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
 remoteproc-y				+= remoteproc_sysfs.o
 remoteproc-y				+= remoteproc_virtio.o
 remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
 obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
 obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
 obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +143 -0

143 lines not on this page · raw message

drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
 int rproc_init_sysfs(void);
 void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
 void rproc_free_vring(struct rproc_vring *rvring);
 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
 
include/linux/remoteproc.h +3 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
 #include <linux/virtio.h>
 #include <linux/completion.h>
 #include <linux/idr.h>
+#include <linux/cdev.h>
 #include <linux/of.h>
 
 /**
@@ -514,6 +515,8 @@ struct rproc {
 	bool auto_boot;
 	struct list_head dump_segments;
 	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
 };
 
 /**
include/uapi/linux/remoteproc_cdev.h new file +20 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#13 lore raw

PATCH v3 2/2 remoteproc: core: Register the character device interface

In reply to Rishabh Bhatnagar

Add the character device during rproc_add. This would create a character device node at /dev/remoteproc<index>. Userspace applications can interact with the remote processor using this interface.

---
 drivers/remoteproc/remoteproc_core.c | 10 ++++++++++
 1 file changed, 10 insertions(+)
drivers/remoteproc/remoteproc_core.c +10 -0
index 097f33e..76ba171 100644
@@ -1916,6 +1916,13 @@ int rproc_add(struct rproc *rproc)
 	/* create debugfs entries */
 	rproc_create_debug_dir(rproc);
 
+	/* add char device for this remoteproc */
+	ret = rproc_char_device_add(rproc);
+	if (ret) {
+		dev_err(dev, "Failed to add char dev for %s\n", rproc->name);
+		return ret;
+	}
+
 	/* if rproc is marked always-on, request it to boot */
 	if (rproc->auto_boot) {
 		ret = rproc_trigger_auto_boot(rproc);
@@ -2137,6 +2144,7 @@ int rproc_del(struct rproc *rproc)
 	mutex_unlock(&rproc->lock);
 
 	rproc_delete_debug_dir(rproc);
+	rproc_char_device_remove(rproc);
 
 	/* the rproc is downref'ed as soon as it's removed from the klist */
 	mutex_lock(&rproc_list_mutex);
@@ -2220,6 +2228,7 @@ static int __init remoteproc_init(void)
 {
 	rproc_init_sysfs();
 	rproc_init_debugfs();
+	rproc_init_cdev();
 
 	return 0;
 }
@@ -2231,6 +2240,7 @@ static void __exit remoteproc_exit(void)
 
 	rproc_exit_debugfs();
 	rproc_exit_sysfs();
+	rproc_exit_cdev();
 }
 module_exit(remoteproc_exit);
 
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
maintainer
#2 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

In reply to Rishabh Bhatnagar
Quoted 37 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

---
 Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
 drivers/remoteproc/Kconfig                         |   9 ++
 drivers/remoteproc/Makefile                        |   1 +
 drivers/remoteproc/remoteproc_cdev.c               | 143 +++++++++++++++++++++
 drivers/remoteproc/remoteproc_internal.h           |  21 +++
 include/linux/remoteproc.h                         |   3 +
 include/uapi/linux/remoteproc_cdev.h               |  20 +++
 7 files changed, 198 insertions(+)
 create mode 100644 drivers/remoteproc/remoteproc_cdev.c
 create mode 100644 include/uapi/linux/remoteproc_cdev.h
Documentation/userspace-api/ioctl/ioctl-number.rst +1 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File                                           Comments
 0xB4  00-0F  linux/gpio.h                                            <mailto:[email protected]>
 0xB5  00-0F  uapi/linux/rpmsg.h                                      <mailto:[email protected]>
 0xB6  all    linux/fpga-dfl.h
+0xB7  all    uapi/linux/remoteproc_cdev.h			     <mailto:[email protected]>
 0xC0  00-0F  linux/usb/iowarrior.h
 0xCA  00-0F  uapi/misc/cxl.h
 0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +0 -0
index de3862c..6374b79 100644

drivers/remoteproc/Kconfig config REMOTEPROC · line 20

Quoted 7 lines
drivers/remoteproc/Kconfig +4 -0
@@ -14,6 +14,15 @@ config REMOTEPROC
 
 if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc

s/Remoteproc/"the remoteproc"

Quoted 119 lines
drivers/remoteproc/Kconfig +5 -0
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
 config IMX_REMOTEPROC
 	tristate "IMX6/7 remoteproc support"
 	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
 remoteproc-y				+= remoteproc_sysfs.o
 remoteproc-y				+= remoteproc_virtio.o
 remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
 obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
 obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
 obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +93 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user *buf,
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+

drivers/remoteproc/remoteproc_cdev.c line 103

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,

Because this is available on any kind of system it is probably best to provide an compat_ioctl.

Quoted 29 lines
drivers/remoteproc/remoteproc_cdev.c new file +29 -0
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1, "rproc");
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 142

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES, "rproc");
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);

Why not simply using rproc_major here?

Quoted 14 lines
drivers/remoteproc/remoteproc_cdev.c new file +1 -0
+}
drivers/remoteproc/remoteproc_internal.h +5 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
 int rproc_init_sysfs(void);
 void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);

drivers/remoteproc/remoteproc_internal.h struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc, · line 64

Quoted 10 lines
drivers/remoteproc/remoteproc_internal.h +10 -0
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;

Add a comment that mentions the support of the character interface is optional and as such and error is not generated if not available on the system.

Quoted 22 lines
drivers/remoteproc/remoteproc_internal.h +6 -0
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
 void rproc_free_vring(struct rproc_vring *rvring);
 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
 
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
 #include <linux/virtio.h>
 #include <linux/completion.h>
 #include <linux/idr.h>
+#include <linux/cdev.h>
 #include <linux/of.h>
 
 /**

include/linux/remoteproc.h struct rproc { · line 519

Quoted 5 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
 	bool auto_boot;
 	struct list_head dump_segments;
 	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;

Please add documentation for these. Also note you will have to rebase your work on the latest rproc-next.

Thanks,
Mathieu

Quoted 32 lines
include/linux/remoteproc.h +0 -0
 };
 
 /**
include/uapi/linux/remoteproc_cdev.h new file +20 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#3 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

In reply to Rishabh Bhatnagar

Hi Rishabh,

Quoted 7 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 98 lines
---
 Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
 drivers/remoteproc/Kconfig                         |   9 ++
 drivers/remoteproc/Makefile                        |   1 +
 drivers/remoteproc/remoteproc_cdev.c               | 143 +++++++++++++++++++++
 drivers/remoteproc/remoteproc_internal.h           |  21 +++
 include/linux/remoteproc.h                         |   3 +
 include/uapi/linux/remoteproc_cdev.h               |  20 +++
 7 files changed, 198 insertions(+)
 create mode 100644 drivers/remoteproc/remoteproc_cdev.c
 create mode 100644 include/uapi/linux/remoteproc_cdev.h
Documentation/userspace-api/ioctl/ioctl-number.rst +1 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File                                           Comments
 0xB4  00-0F  linux/gpio.h                                            <mailto:[email protected]>
 0xB5  00-0F  uapi/linux/rpmsg.h                                      <mailto:[email protected]>
 0xB6  all    linux/fpga-dfl.h
+0xB7  all    uapi/linux/remoteproc_cdev.h			     <mailto:[email protected]>
 0xC0  00-0F  linux/usb/iowarrior.h
 0xCA  00-0F  uapi/misc/cxl.h
 0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
 if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
 config IMX_REMOTEPROC
 	tristate "IMX6/7 remoteproc support"
 	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
 remoteproc-y				+= remoteproc_sysfs.o
 remoteproc-y				+= remoteproc_virtio.o
 remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
 obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
 obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
 obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +35 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user *buf,
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or EINVAL (rproc_sysfs) ?

Quoted 17 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems missing

Quoted 52 lines
drivers/remoteproc/remoteproc_cdev.c new file +52 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+

drivers/remoteproc/remoteproc_cdev.c line 134

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1, "rproc");
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES, "rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 54 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
 int rproc_init_sysfs(void);
 void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
 void rproc_free_vring(struct rproc_vring *rvring);
 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
 
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
 #include <linux/virtio.h>
 #include <linux/completion.h>
 #include <linux/idr.h>
+#include <linux/cdev.h>
 #include <linux/of.h>
 
 /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
 	bool auto_boot;
 	struct list_head dump_segments;
 	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
 };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure. with a pointer in rproc to this structure.

Quoted 19 lines
include/linux/remoteproc.h +0 -0
 /**
include/uapi/linux/remoteproc_cdev.h new file +10 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 10 lines
include/uapi/linux/remoteproc_cdev.h new file +10 -0
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Thanks,
Arnaud

maintainer
#4 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

Quoted 275 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 7 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 98 lines
---
 Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
 drivers/remoteproc/Kconfig                         |   9 ++
 drivers/remoteproc/Makefile                        |   1 +
 drivers/remoteproc/remoteproc_cdev.c               | 143 +++++++++++++++++++++
 drivers/remoteproc/remoteproc_internal.h           |  21 +++
 include/linux/remoteproc.h                         |   3 +
 include/uapi/linux/remoteproc_cdev.h               |  20 +++
 7 files changed, 198 insertions(+)
 create mode 100644 drivers/remoteproc/remoteproc_cdev.c
 create mode 100644 include/uapi/linux/remoteproc_cdev.h
Documentation/userspace-api/ioctl/ioctl-number.rst +1 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File                                           Comments
 0xB4  00-0F  linux/gpio.h                                            <mailto:[email protected]>
 0xB5  00-0F  uapi/linux/rpmsg.h                                      <mailto:[email protected]>
 0xB6  all    linux/fpga-dfl.h
+0xB7  all    uapi/linux/remoteproc_cdev.h                         <mailto:[email protected]>
 0xC0  00-0F  linux/usb/iowarrior.h
 0xCA  00-0F  uapi/misc/cxl.h
 0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
 if REMOTEPROC
 
+config REMOTEPROC_CDEV
+     bool "Remoteproc character device interface"
+     help
+       Say y here to have a character device interface for Remoteproc
+       framework. Userspace can boot/shutdown remote processors through
+       this interface.
+
+       It's safe to say N if you don't want to use this interface.
+
 config IMX_REMOTEPROC
      tristate "IMX6/7 remoteproc support"
      depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y                          += remoteproc_debugfs.o
 remoteproc-y                         += remoteproc_sysfs.o
 remoteproc-y                         += remoteproc_virtio.o
 remoteproc-y                         += remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)                += remoteproc_cdev.o
 obj-$(CONFIG_IMX_REMOTEPROC)         += imx_rproc.o
 obj-$(CONFIG_MTK_SCP)                        += mtk_scp.o mtk_scp_ipi.o
 obj-$(CONFIG_OMAP_REMOTEPROC)                += omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +35 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES    64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user *buf,
+                              size_t len, loff_t *pos)
+{
+     struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+                                        struct rproc, char_dev);
+     int ret = 0;
+     char cmd[10];
+
+     if (!len || len > sizeof(cmd))
+             return -EINVAL;
+
+     ret = copy_from_user(cmd, buf, sizeof(cmd));
+     if (ret)
+             return -EFAULT;
+

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+     if (sysfs_streq(cmd, "start")) {
+             if (rproc->state == RPROC_RUNNING)
+                     return -EBUSY;
+
+             ret = rproc_boot(rproc);
+             if (ret)
+                     dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+     } else if (sysfs_streq(cmd, "stop")) {
+             if (rproc->state == RPROC_OFFLINE)
+                     return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or EINVAL (rproc_sysfs) ?

Quoted 17 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+             rproc_shutdown(rproc);
+     } else {
+             dev_err(&rproc->dev, "Unrecognized option\n");
+             ret = -EINVAL;
+     }
+
+     return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+                             unsigned long arg)
+{
+     struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+                                        struct rproc, char_dev);
+     void __user *argp = (void __user *)arg;
+     int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+     bool param;
+
+     switch (ioctl) {
+     case RPROC_SET_SHUTDOWN_ON_RELEASE:
+             ret = copy_from_user(&param, argp, sizeof(bool));
+             if (ret) {
+                     dev_err(&rproc->dev, "Data copy from userspace failed\n");
+                     return -EINVAL;
+             }
+             rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems missing

Quoted 52 lines
drivers/remoteproc/remoteproc_cdev.c new file +52 -0
+             break;
+     case RPROC_GET_SHUTDOWN_ON_RELEASE:
+             ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+                                sizeof(bool));
+             if (ret) {
+                     dev_err(&rproc->dev, "Data copy to userspace failed\n");
+                     return -EINVAL;
+             }
+             break;
+     default:
+             dev_err(&rproc->dev, "Unsupported ioctl\n");
+             return -EINVAL;
+     }
+     return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+     struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+                                        char_dev);
+
+     if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+             rproc_shutdown(rproc);
+
+     return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+     .write = rproc_cdev_write,
+     .unlocked_ioctl = rproc_device_ioctl,
+     .release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+     int ret;
+     dev_t cdevt;
+
+     cdev_init(&rproc->char_dev, &rproc_fops);
+     rproc->char_dev.owner = THIS_MODULE;
+
+     cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+     ret = cdev_add(&rproc->char_dev, cdevt, 1);
+     if (ret < 0)
+             goto out;
+
+     rproc->dev.devt = cdevt;
+out:
+     return ret;
+}
+

drivers/remoteproc/remoteproc_cdev.c line 134

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+void rproc_char_device_remove(struct rproc *rproc)
+{
+     __unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1, "rproc");
+}
+
+void __init rproc_init_cdev(void)
+{
+     int ret;
+
+     ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES, "rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 52 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+     if (ret < 0)
+             pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+     unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+                              NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char *name, struct rproc *rproc,
 int rproc_init_sysfs(void);
 void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+     return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
 void rproc_free_vring(struct rproc_vring *rvring);
 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
 
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
 #include <linux/virtio.h>
 #include <linux/completion.h>
 #include <linux/idr.h>
+#include <linux/cdev.h>
 #include <linux/of.h>
 
Quoted 11 lines

include/linux/remoteproc.h struct rproc { · line 520

Quoted 8 lines
include/linux/remoteproc.h +2 -0
 /**
@@ -514,6 +515,8 @@ struct rproc {
      bool auto_boot;
      struct list_head dump_segments;
      int nb_vdev;
+     struct cdev char_dev;
+     bool cdev_put_on_release;
 };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure. with a pointer in rproc to this structure.

I think structure @char_dev is just one more core member of rproc - to me the real problem is with @cdev_put_on_release. It is yet another option that has an effect on the processing done on the remote processor. Other 'bool' types like has_iommu, auto_boot and recovery_disabled are additional examples. No matter how much we are careful at limiting their proliferation it is clear to me the current way of declaring bool types every time we need a new option does not scale.

I have been thinking about introducing a new u32 field called "options" and assigning each of the current (and future) boolean flags a bitfield. Individual options would be set with an exported function, something like rproc_set_option(RPROC_OPTION_AUTO_BOOT). That way users never directly manipulate the bitfields and it gives us the opportunity to change how options are managed in the future if we need to.

I will be sending a patchset for this feature in the coming days so that we can discuss the best way to deal with flags.

Thanks,
Mathieu

Quoted 34 lines
Quoted 20 lines
include/linux/remoteproc.h +0 -0
 /**
include/uapi/linux/remoteproc_cdev.h new file +10 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 10 lines
include/uapi/linux/remoteproc_cdev.h new file +10 -0
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
+#define RPROC_MAGIC  0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Thanks,
Arnaud

#5 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

In reply to Arnaud POULIQUEN
Quoted 319 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 7 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 104 lines
---
 Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
 drivers/remoteproc/Kconfig                         |   9 ++
 drivers/remoteproc/Makefile                        |   1 +
 drivers/remoteproc/remoteproc_cdev.c               | 143 
+++++++++++++++++++++
 drivers/remoteproc/remoteproc_internal.h           |  21 +++
 include/linux/remoteproc.h                         |   3 +
 include/uapi/linux/remoteproc_cdev.h               |  20 +++
 7 files changed, 198 insertions(+)
 create mode 100644 drivers/remoteproc/remoteproc_cdev.c
 create mode 100644 include/uapi/linux/remoteproc_cdev.h
Documentation/userspace-api/ioctl/ioctl-number.rst +0 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File                         
                  Comments
 0xB4  00-0F  linux/gpio.h                                            

<mailto:[email protected]>
0xB5 00-0F uapi/linux/rpmsg.h
<mailto:[email protected]>

 0xB6  all    linux/fpga-dfl.h
+0xB7  all    uapi/linux/remoteproc_cdev.h			     
<mailto:[email protected]>
 0xC0  00-0F  linux/usb/iowarrior.h
 0xCA  00-0F  uapi/misc/cxl.h
 0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
 if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
 config IMX_REMOTEPROC
 	tristate "IMX6/7 remoteproc support"
 	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
 remoteproc-y				+= remoteproc_sysfs.o
 remoteproc-y				+= remoteproc_virtio.o
 remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
 obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
 obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
 obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +21 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user 

*buf,

drivers/remoteproc/remoteproc_cdev.c new file +14 -0
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or EINVAL (rproc_sysfs) ?

Quoted 17 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems
missing

Quoted 63 lines
drivers/remoteproc/remoteproc_cdev.c new file +55 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1, 

"rproc");

drivers/remoteproc/remoteproc_cdev.c new file +7 -0
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES, 
Quoted 1 line

"rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 55 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char 
 *name, struct rproc *rproc,
 int rproc_init_sysfs(void);
 void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
 void rproc_free_vring(struct rproc_vring *rvring);
 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
 #include <linux/virtio.h>
 #include <linux/completion.h>
 #include <linux/idr.h>
+#include <linux/cdev.h>
 #include <linux/of.h>
 
 /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
 	bool auto_boot;
 	struct list_head dump_segments;
 	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
 };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure.
with a pointer in rproc to this structure.

Quoted 22 lines
include/linux/remoteproc.h +0 -0
 /**
include/uapi/linux/remoteproc_cdev.h new file +14 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
Quoted 8 lines

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 7 lines
include/uapi/linux/remoteproc_cdev.h new file +6 -0
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst Is there another place where I need to add documentation for this?

Quoted 3 lines

Thanks,
Arnaud

#6 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

Quoted 335 lines · On 6/16/20 9:56 PM, [email protected] wrote:
Quoted 326 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 8 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 106 lines
---
 Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
 drivers/remoteproc/Kconfig                         |   9 ++
 drivers/remoteproc/Makefile                        |   1 +
 drivers/remoteproc/remoteproc_cdev.c               | 143 
+++++++++++++++++++++
 drivers/remoteproc/remoteproc_internal.h           |  21 +++
 include/linux/remoteproc.h                         |   3 +
 include/uapi/linux/remoteproc_cdev.h               |  20 +++
 7 files changed, 198 insertions(+)
 create mode 100644 drivers/remoteproc/remoteproc_cdev.c
 create mode 100644 include/uapi/linux/remoteproc_cdev.h
Documentation/userspace-api/ioctl/ioctl-number.rst +0 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File                         
                  Comments
 0xB4  00-0F  linux/gpio.h                                            

<mailto:[email protected]>
0xB5 00-0F uapi/linux/rpmsg.h
<mailto:[email protected]>

 0xB6  all    linux/fpga-dfl.h
+0xB7  all    uapi/linux/remoteproc_cdev.h			     
<mailto:[email protected]>
 0xC0  00-0F  linux/usb/iowarrior.h
 0xCA  00-0F  uapi/misc/cxl.h
 0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
 if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
 config IMX_REMOTEPROC
 	tristate "IMX6/7 remoteproc support"
 	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
 remoteproc-y				+= remoteproc_sysfs.o
 remoteproc-y				+= remoteproc_virtio.o
 remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
 obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
 obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
 obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +21 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user 

*buf,

drivers/remoteproc/remoteproc_cdev.c new file +14 -0
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or
EINVAL (rproc_sysfs) ?

Quoted 17 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems
missing

Quoted 63 lines
drivers/remoteproc/remoteproc_cdev.c new file +55 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1, 

"rproc");

drivers/remoteproc/remoteproc_cdev.c new file +7 -0
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES, 
Quoted 1 line

"rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 56 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char 
 *name, struct rproc *rproc,
 int rproc_init_sysfs(void);
 void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
 void rproc_free_vring(struct rproc_vring *rvring);
 int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
 #include <linux/virtio.h>
 #include <linux/completion.h>
 #include <linux/idr.h>
+#include <linux/cdev.h>
 #include <linux/of.h>
 
 /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
 	bool auto_boot;
 	struct list_head dump_segments;
 	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
 };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure.
with a pointer in rproc to this structure.

Quoted 23 lines
include/linux/remoteproc.h +0 -0
 /**
include/uapi/linux/remoteproc_cdev.h new file +14 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
Quoted 8 lines

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 7 lines
include/uapi/linux/remoteproc_cdev.h new file +6 -0
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Quoted 3 lines

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst
Is there another place where I need to add documentation for this?

Could you add in this file comments that describe
the IOCTL usage and associated parameter?

Regards,
Arnaud

Quoted 3 lines
Quoted 3 lines

Thanks,
Arnaud

#7 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

Quoted 128 lines · Arnaud POULIQUEN
Quoted 126 lines · On 6/16/20 9:56 PM, [email protected] wrote:
Quoted 125 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 8 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 111 lines
---
  Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
  drivers/remoteproc/Kconfig                         |   9 ++
  drivers/remoteproc/Makefile                        |   1 +
  drivers/remoteproc/remoteproc_cdev.c               | 143
+++++++++++++++++++++
  drivers/remoteproc/remoteproc_internal.h           |  21 +++
  include/linux/remoteproc.h                         |   3 +
  include/uapi/linux/remoteproc_cdev.h               |  20 +++
  7 files changed, 198 insertions(+)

create mode 100644 drivers/remoteproc/remoteproc_cdev.c create mode 100644 include/uapi/linux/remoteproc_cdev.h

Documentation/userspace-api/ioctl/ioctl-number.rst +0 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File
                   Comments
  0xB4  00-0F  linux/gpio.h

<mailto:[email protected]>
0xB5 00-0F uapi/linux/rpmsg.h
<mailto:[email protected]>
0xB6 all linux/fpga-dfl.h
+0xB7 all uapi/linux/remoteproc_cdev.h
<mailto:[email protected]>

  0xC0  00-0F  linux/usb/iowarrior.h
  0xCA  00-0F  uapi/misc/cxl.h
  0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
  if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
  config IMX_REMOTEPROC
  	tristate "IMX6/7 remoteproc support"
  	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
  remoteproc-y				+= remoteproc_sysfs.o
  remoteproc-y				+= remoteproc_virtio.o
  remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
  obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
  obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
  obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +21 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user

*buf,

drivers/remoteproc/remoteproc_cdev.c new file +19 -0
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 5 lines
drivers/remoteproc/remoteproc_cdev.c new file +5 -0
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or
EINVAL (rproc_sysfs) ?

I think EPERM would indicate the operation is not permitted on the device, and EINVAL would indicate that the command/string they wrote to the char device is not a valid command/string. I guess even ENXIO may not be appropriate?

In that case we could use EHOSTDOWN or ESHUTDOWN, thoughts?

Thanks,
Sid

Quoted 206 lines
Quoted 195 lines
Quoted 187 lines
Quoted 18 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems
missing

Quoted 63 lines
drivers/remoteproc/remoteproc_cdev.c new file +55 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1,

"rproc");

drivers/remoteproc/remoteproc_cdev.c new file +7 -0
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES,
Quoted 1 line

"rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 56 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char
 *name, struct rproc *rproc,
  int rproc_init_sysfs(void);
  void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
  void rproc_free_vring(struct rproc_vring *rvring);
  int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
  #include <linux/virtio.h>
  #include <linux/completion.h>
  #include <linux/idr.h>
+#include <linux/cdev.h>
  #include <linux/of.h>
 
  /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
  	bool auto_boot;
  	struct list_head dump_segments;
  	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
  };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure.
with a pointer in rproc to this structure.

Quoted 22 lines
include/linux/remoteproc.h +0 -0
  /**
include/uapi/linux/remoteproc_cdev.h new file +14 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
Quoted 8 lines

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 7 lines
include/uapi/linux/remoteproc_cdev.h new file +6 -0
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Quoted 3 lines

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst
Is there another place where I need to add documentation for this?

Could you add in this file comments that describe
the IOCTL usage and associated parameter?

Regards,
Arnaud

Quoted 2 lines
Quoted 2 lines

Thanks,
Arnaud

#8 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

Quoted 139 lines · Siddharth Gupta
Quoted 128 lines · Arnaud POULIQUEN
Quoted 126 lines · On 6/16/20 9:56 PM, [email protected] wrote:
Quoted 125 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 8 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 111 lines
---
  Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
  drivers/remoteproc/Kconfig                         |   9 ++
  drivers/remoteproc/Makefile                        |   1 +
  drivers/remoteproc/remoteproc_cdev.c               | 143
+++++++++++++++++++++
  drivers/remoteproc/remoteproc_internal.h           |  21 +++
  include/linux/remoteproc.h                         |   3 +
  include/uapi/linux/remoteproc_cdev.h               |  20 +++
  7 files changed, 198 insertions(+)

create mode 100644 drivers/remoteproc/remoteproc_cdev.c create mode 100644 include/uapi/linux/remoteproc_cdev.h

Documentation/userspace-api/ioctl/ioctl-number.rst +0 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File
                   Comments
  0xB4  00-0F  linux/gpio.h

<mailto:[email protected]>
0xB5 00-0F uapi/linux/rpmsg.h
<mailto:[email protected]>
0xB6 all linux/fpga-dfl.h
+0xB7 all uapi/linux/remoteproc_cdev.h
<mailto:[email protected]>

  0xC0  00-0F  linux/usb/iowarrior.h
  0xCA  00-0F  uapi/misc/cxl.h
  0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
  if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
  config IMX_REMOTEPROC
  	tristate "IMX6/7 remoteproc support"
  	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
  remoteproc-y				+= remoteproc_sysfs.o
  remoteproc-y				+= remoteproc_virtio.o
  remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
  obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
  obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
  obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +21 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user

*buf,

drivers/remoteproc/remoteproc_cdev.c new file +19 -0
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 5 lines
drivers/remoteproc/remoteproc_cdev.c new file +5 -0
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or
EINVAL (rproc_sysfs) ?

Quoted 6 lines

I think EPERM would indicate the operation is not permitted on the device, and
EINVAL would indicate that the command/string they wrote to the char device is not a valid command/string. I guess even ENXIO may not be appropriate?

In that case we could use EHOSTDOWN or ESHUTDOWN, thoughts?

Regarding remoteproc_sysfs.c[1], seems that the -EINVAL return would be coherent. It would probably also be better to replace your condition with

	if (rproc->state != RPROC_RUNNING)

[1] https://elixir.bootlin.com/linux/latest/source/drivers/remoteproc/remoteproc_sysfs.c#L104

Regards,
Arnaud

Quoted 210 lines

Thanks,
Sid

Quoted 206 lines
Quoted 195 lines
Quoted 187 lines
Quoted 18 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems
missing

Quoted 63 lines
drivers/remoteproc/remoteproc_cdev.c new file +55 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1,

"rproc");

drivers/remoteproc/remoteproc_cdev.c new file +7 -0
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES,
Quoted 1 line

"rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 56 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char
 *name, struct rproc *rproc,
  int rproc_init_sysfs(void);
  void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
  void rproc_free_vring(struct rproc_vring *rvring);
  int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
  #include <linux/virtio.h>
  #include <linux/completion.h>
  #include <linux/idr.h>
+#include <linux/cdev.h>
  #include <linux/of.h>
 
  /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
  	bool auto_boot;
  	struct list_head dump_segments;
  	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
  };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure.
with a pointer in rproc to this structure.

Quoted 22 lines
include/linux/remoteproc.h +0 -0
  /**
include/uapi/linux/remoteproc_cdev.h new file +14 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
Quoted 8 lines

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 7 lines
include/uapi/linux/remoteproc_cdev.h new file +6 -0
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Quoted 3 lines

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst
Is there another place where I need to add documentation for this?

Could you add in this file comments that describe
the IOCTL usage and associated parameter?

Regards,
Arnaud

Quoted 2 lines
Quoted 2 lines

Thanks,
Arnaud

#9 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

Quoted 138 lines · Arnaud POULIQUEN
Quoted 136 lines · Siddharth Gupta
Quoted 135 lines · Arnaud POULIQUEN
Quoted 134 lines · On 6/16/20 9:56 PM, [email protected] wrote:
Quoted 133 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 8 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 106 lines
---
   Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
   drivers/remoteproc/Kconfig                         |   9 ++
   drivers/remoteproc/Makefile                        |   1 +
   drivers/remoteproc/remoteproc_cdev.c               | 143
+++++++++++++++++++++
   drivers/remoteproc/remoteproc_internal.h           |  21 +++
   include/linux/remoteproc.h                         |   3 +
   include/uapi/linux/remoteproc_cdev.h               |  20 +++
   7 files changed, 198 insertions(+)

create mode 100644 drivers/remoteproc/remoteproc_cdev.c create mode 100644 include/uapi/linux/remoteproc_cdev.h

Documentation/userspace-api/ioctl/ioctl-number.rst +0 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File
                    Comments
   0xB4  00-0F  linux/gpio.h

<mailto:[email protected]>
0xB5 00-0F uapi/linux/rpmsg.h
<mailto:[email protected]>
0xB6 all linux/fpga-dfl.h
+0xB7 all uapi/linux/remoteproc_cdev.h
<mailto:[email protected]>

   0xC0  00-0F  linux/usb/iowarrior.h
   0xCA  00-0F  uapi/misc/cxl.h
   0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
   if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
   config IMX_REMOTEPROC
   	tristate "IMX6/7 remoteproc support"
   	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
   remoteproc-y				+= remoteproc_sysfs.o
   remoteproc-y				+= remoteproc_virtio.o
   remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
   obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
   obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
   obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +21 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user

*buf,

drivers/remoteproc/remoteproc_cdev.c new file +14 -0
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or
EINVAL (rproc_sysfs) ?

Quoted 7 lines
Quoted 6 lines

I think EPERM would indicate the operation is not permitted on the device, and
EINVAL would indicate that the command/string they wrote to the char device is not a valid command/string. I guess even ENXIO may not be appropriate?

In that case we could use EHOSTDOWN or ESHUTDOWN, thoughts?

Regarding remoteproc_sysfs.c[1], seems that the -EINVAL return would be coherent.

Okay sure.

Quoted 2 lines

It would probably also be better to replace your condition with

	if (rproc->state != RPROC_RUNNING)

Will do.

Quoted 212 lines

[1] https://elixir.bootlin.com/linux/latest/source/drivers/remoteproc/remoteproc_sysfs.c#L104

Regards,
Arnaud

Quoted 205 lines

Thanks,
Sid

Quoted 202 lines
Quoted 194 lines
Quoted 186 lines
Quoted 17 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems
missing

Quoted 63 lines
drivers/remoteproc/remoteproc_cdev.c new file +55 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1,

"rproc");

drivers/remoteproc/remoteproc_cdev.c new file +7 -0
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES,
Quoted 1 line

"rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 56 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char
 *name, struct rproc *rproc,
   int rproc_init_sysfs(void);
   void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
   void rproc_free_vring(struct rproc_vring *rvring);
   int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
   #include <linux/virtio.h>
   #include <linux/completion.h>
   #include <linux/idr.h>
+#include <linux/cdev.h>
   #include <linux/of.h>
 
   /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
   	bool auto_boot;
   	struct list_head dump_segments;
   	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
   };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure.
with a pointer in rproc to this structure.

Quoted 22 lines
include/linux/remoteproc.h +0 -0
   /**
include/uapi/linux/remoteproc_cdev.h new file +14 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
Quoted 8 lines

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 7 lines
include/uapi/linux/remoteproc_cdev.h new file +6 -0
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Quoted 3 lines

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst
Is there another place where I need to add documentation for this?

Could you add in this file comments that describe
the IOCTL usage and associated parameter?

Regards,
Arnaud

I don't see any for of comments that describe in detail the IOCTL usage, i.e., input parameters, etc. Could you provide an example so I can follow it?

If not, should I instead put them in Documentation/remoteproc.txt?

Thanks,
Sid

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

Thanks,
Arnaud

#12 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

In reply to Arnaud POULIQUEN
Quoted 147 lines · Arnaud POULIQUEN
Quoted 144 lines · Siddharth Gupta
Quoted 128 lines · Arnaud POULIQUEN
Quoted 126 lines · On 6/16/20 9:56 PM, [email protected] wrote:
Quoted 125 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 8 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 111 lines
---
  Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
  drivers/remoteproc/Kconfig                         |   9 ++
  drivers/remoteproc/Makefile                        |   1 +
  drivers/remoteproc/remoteproc_cdev.c               | 143
+++++++++++++++++++++
  drivers/remoteproc/remoteproc_internal.h           |  21 +++
  include/linux/remoteproc.h                         |   3 +
  include/uapi/linux/remoteproc_cdev.h               |  20 +++
  7 files changed, 198 insertions(+)

create mode 100644 drivers/remoteproc/remoteproc_cdev.c create mode 100644 include/uapi/linux/remoteproc_cdev.h

Documentation/userspace-api/ioctl/ioctl-number.rst +0 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File
                   Comments
  0xB4  00-0F  linux/gpio.h

<mailto:[email protected]>
0xB5 00-0F uapi/linux/rpmsg.h
<mailto:[email protected]>
0xB6 all linux/fpga-dfl.h
+0xB7 all uapi/linux/remoteproc_cdev.h
<mailto:[email protected]>

  0xC0  00-0F  linux/usb/iowarrior.h
  0xCA  00-0F  uapi/misc/cxl.h
  0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
  if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
  config IMX_REMOTEPROC
  	tristate "IMX6/7 remoteproc support"
  	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
  remoteproc-y				+= remoteproc_sysfs.o
  remoteproc-y				+= remoteproc_virtio.o
  remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
  obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
  obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
  obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +21 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user

*buf,

drivers/remoteproc/remoteproc_cdev.c new file +19 -0
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

drivers/remoteproc/remoteproc_cdev.c line 45

Quoted 5 lines
drivers/remoteproc/remoteproc_cdev.c new file +5 -0
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or
EINVAL (rproc_sysfs) ?

I think EPERM would indicate the operation is not permitted on the device, and
EINVAL would indicate that the command/string they wrote to the char device is not a valid command/string. I guess even ENXIO may not be appropriate?

Quoted 6 lines
Quoted 1 line

In that case we could use EHOSTDOWN or ESHUTDOWN, thoughts?

Regarding remoteproc_sysfs.c[1], seems that the -EINVAL return would be coherent. It would probably also be better to replace your condition with

	if (rproc->state != RPROC_RUNNING)

I agree to both points.

Separate of this, and presumably as part of the work to support "detaching" (e.g. to restart Linux with the remoteproc running), we should move the conditional into rproc_shutdown(), under the lock.

But for now, let's mimic what we have in the sysfs interface.

Regards,
Bjorn

Quoted 216 lines

[1] https://elixir.bootlin.com/linux/latest/source/drivers/remoteproc/remoteproc_sysfs.c#L104

Regards,
Arnaud

Quoted 210 lines

Thanks,
Sid

Quoted 206 lines
Quoted 195 lines
Quoted 187 lines
Quoted 18 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c line 72

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems
missing

Quoted 63 lines
drivers/remoteproc/remoteproc_cdev.c new file +55 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1,

"rproc");

drivers/remoteproc/remoteproc_cdev.c new file +7 -0
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES,
Quoted 1 line

"rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 56 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char
 *name, struct rproc *rproc,
  int rproc_init_sysfs(void);
  void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
  void rproc_free_vring(struct rproc_vring *rvring);
  int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
  #include <linux/virtio.h>
  #include <linux/completion.h>
  #include <linux/idr.h>
+#include <linux/cdev.h>
  #include <linux/of.h>
 
  /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
  	bool auto_boot;
  	struct list_head dump_segments;
  	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
  };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure.
with a pointer in rproc to this structure.

Quoted 22 lines
include/linux/remoteproc.h +0 -0
  /**
include/uapi/linux/remoteproc_cdev.h new file +14 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
Quoted 8 lines

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 7 lines
include/uapi/linux/remoteproc_cdev.h new file +6 -0
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Quoted 3 lines

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst
Is there another place where I need to add documentation for this?

Could you add in this file comments that describe
the IOCTL usage and associated parameter?

Regards,
Arnaud

Quoted 2 lines
Quoted 2 lines

Thanks,
Arnaud

#10 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

In reply to Siddharth Gupta
Quoted 361 lines · Siddharth Gupta
Quoted 138 lines · Arnaud POULIQUEN
Quoted 136 lines · Siddharth Gupta
Quoted 135 lines · Arnaud POULIQUEN
Quoted 134 lines · On 6/16/20 9:56 PM, [email protected] wrote:
Quoted 133 lines · Arnaud POULIQUEN

Hi Rishabh,

Quoted 8 lines · Rishabh Bhatnagar

Add the character device interface into remoteproc framework. This interface can be used in order to boot/shutdown remote subsystems and provides a basic ioctl based interface to implement supplementary functionality. An ioctl call is implemented to enable the shutdown on release feature which will allow remote processors to be shutdown when the controlling userpsace application crashes or hangs.

Thanks for intruducing Ioctl, this will help for future evolutions.

Quoted 106 lines
---
   Documentation/userspace-api/ioctl/ioctl-number.rst |   1 +
   drivers/remoteproc/Kconfig                         |   9 ++
   drivers/remoteproc/Makefile                        |   1 +
   drivers/remoteproc/remoteproc_cdev.c               | 143
+++++++++++++++++++++
   drivers/remoteproc/remoteproc_internal.h           |  21 +++
   include/linux/remoteproc.h                         |   3 +
   include/uapi/linux/remoteproc_cdev.h               |  20 +++
   7 files changed, 198 insertions(+)

create mode 100644 drivers/remoteproc/remoteproc_cdev.c create mode 100644 include/uapi/linux/remoteproc_cdev.h

Documentation/userspace-api/ioctl/ioctl-number.rst +0 -0
index 2e91370..412b2a0 100644
@@ -337,6 +337,7 @@ Code  Seq#    Include File
                    Comments
   0xB4  00-0F  linux/gpio.h

<mailto:[email protected]>
0xB5 00-0F uapi/linux/rpmsg.h
<mailto:[email protected]>
0xB6 all linux/fpga-dfl.h
+0xB7 all uapi/linux/remoteproc_cdev.h
<mailto:[email protected]>

   0xC0  00-0F  linux/usb/iowarrior.h
   0xCA  00-0F  uapi/misc/cxl.h
   0xCA  10-2F  uapi/misc/ocxl.h
drivers/remoteproc/Kconfig +9 -0
index de3862c..6374b79 100644
@@ -14,6 +14,15 @@ config REMOTEPROC
 
   if REMOTEPROC
 
+config REMOTEPROC_CDEV
+	bool "Remoteproc character device interface"
+	help
+	  Say y here to have a character device interface for Remoteproc
+	  framework. Userspace can boot/shutdown remote processors through
+	  this interface.
+
+	  It's safe to say N if you don't want to use this interface.
+
   config IMX_REMOTEPROC
   	tristate "IMX6/7 remoteproc support"
   	depends on ARCH_MXC
drivers/remoteproc/Makefile +1 -0
index e30a1b1..b7d4f77 100644
@@ -9,6 +9,7 @@ remoteproc-y				+= remoteproc_debugfs.o
   remoteproc-y				+= remoteproc_sysfs.o
   remoteproc-y				+= remoteproc_virtio.o
   remoteproc-y				+= remoteproc_elf_loader.o
+obj-$(CONFIG_REMOTEPROC_CDEV)		+= remoteproc_cdev.o
   obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
   obj-$(CONFIG_MTK_SCP)			+= mtk_scp.o mtk_scp_ipi.o
   obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
drivers/remoteproc/remoteproc_cdev.c new file +21 -0
new file mode 100644
index 0000000..65142ec
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Character device interface driver for Remoteproc framework.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+#include <linux/cdev.h>
+#include <linux/fs.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/remoteproc.h>
+#include <uapi/linux/remoteproc_cdev.h>
+#include <linux/uaccess.h>
+
+#include "remoteproc_internal.h"
+
+#define NUM_RPROC_DEVICES	64
+static dev_t rproc_major;
+
+static ssize_t rproc_cdev_write(struct file *filp, const char __user

*buf,

drivers/remoteproc/remoteproc_cdev.c new file +14 -0
+				 size_t len, loff_t *pos)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	int ret = 0;
+	char cmd[10];
+
+	if (!len || len > sizeof(cmd))
+		return -EINVAL;
+
+	ret = copy_from_user(cmd, buf, sizeof(cmd));
+	if (ret)
+		return -EFAULT;
+

drivers/remoteproc/remoteproc_cdev.c

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	if (sysfs_streq(cmd, "start")) {
+		if (rproc->state == RPROC_RUNNING)
+			return -EBUSY;
+
+		ret = rproc_boot(rproc);
+		if (ret)
+			dev_err(&rproc->dev, "Boot failed:%d\n", ret);
+	} else if (sysfs_streq(cmd, "stop")) {
+		if (rproc->state == RPROC_OFFLINE)
+			return -ENXIO;

returning ENXIO in this case seems to me no appropriate , what about EPERM or
EINVAL (rproc_sysfs) ?

Quoted 7 lines
Quoted 6 lines

I think EPERM would indicate the operation is not permitted on the device, and
EINVAL would indicate that the command/string they wrote to the char device is not a valid command/string. I guess even ENXIO may not be appropriate?

In that case we could use EHOSTDOWN or ESHUTDOWN, thoughts?

Regarding remoteproc_sysfs.c[1], seems that the -EINVAL return would be coherent.

Okay sure.

Quoted 2 lines

It would probably also be better to replace your condition with

	if (rproc->state != RPROC_RUNNING)

Will do.

Quoted 210 lines

[1] https://elixir.bootlin.com/linux/latest/source/drivers/remoteproc/remoteproc_sysfs.c#L104

Regards,
Arnaud

Quoted 203 lines

Thanks,
Sid

Quoted 200 lines
Quoted 194 lines
Quoted 186 lines
Quoted 17 lines
drivers/remoteproc/remoteproc_cdev.c new file +17 -0
+
+		rproc_shutdown(rproc);
+	} else {
+		dev_err(&rproc->dev, "Unrecognized option\n");
+		ret = -EINVAL;
+	}
+
+	return ret ? ret : len;
+}
+
+static long rproc_device_ioctl(struct file *filp, unsigned int ioctl,
+				unsigned long arg)
+{
+	struct rproc *rproc = container_of(filp->f_inode->i_cdev,
+					   struct rproc, char_dev);
+	void __user *argp = (void __user *)arg;
+	int ret;

drivers/remoteproc/remoteproc_cdev.c

Quoted 10 lines
drivers/remoteproc/remoteproc_cdev.c new file +10 -0
+	bool param;
+
+	switch (ioctl) {
+	case RPROC_SET_SHUTDOWN_ON_RELEASE:
+		ret = copy_from_user(&param, argp, sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy from userspace failed\n");
+			return -EINVAL;
+		}
+		rproc->cdev_put_on_release = param;

argp is an void value, where cdev_put_on_release is a bool a check or a conversion seems
missing

Quoted 63 lines
drivers/remoteproc/remoteproc_cdev.c new file +55 -0
+		break;
+	case RPROC_GET_SHUTDOWN_ON_RELEASE:
+		ret = copy_to_user(argp, &rproc->cdev_put_on_release,
+				   sizeof(bool));
+		if (ret) {
+			dev_err(&rproc->dev, "Data copy to userspace failed\n");
+			return -EINVAL;
+		}
+		break;
+	default:
+		dev_err(&rproc->dev, "Unsupported ioctl\n");
+		return -EINVAL;
+	}
+	return 0;
+}
+
+static int rproc_cdev_release(struct inode *inode, struct file *filp)
+{
+	struct rproc *rproc = container_of(inode->i_cdev, struct rproc,
+					   char_dev);
+
+	if (rproc->cdev_put_on_release && rproc->state != RPROC_OFFLINE)
+		rproc_shutdown(rproc);
+
+	return 0;
+}
+
+
+static const struct file_operations rproc_fops = {
+	.write = rproc_cdev_write,
+	.unlocked_ioctl = rproc_device_ioctl,
+	.release = rproc_cdev_release,
+};
+
+int rproc_char_device_add(struct rproc *rproc)
+{
+	int ret;
+	dev_t cdevt;
+
+	cdev_init(&rproc->char_dev, &rproc_fops);
+	rproc->char_dev.owner = THIS_MODULE;
+
+	cdevt = MKDEV(MAJOR(rproc_major), rproc->index);
+	ret = cdev_add(&rproc->char_dev, cdevt, 1);
+	if (ret < 0)
+		goto out;
+
+	rproc->dev.devt = cdevt;
+out:
+	return ret;
+}
+
+void rproc_char_device_remove(struct rproc *rproc)
+{
+	__unregister_chrdev(MAJOR(rproc->dev.devt), rproc->index, 1,

"rproc");

drivers/remoteproc/remoteproc_cdev.c new file +7 -0
+}
+
+void __init rproc_init_cdev(void)
+{
+	int ret;
+
+	ret = alloc_chrdev_region(&rproc_major, 0, NUM_RPROC_DEVICES,
Quoted 1 line

"rproc");

"remoteproc"instead of "rproc" (in line with sysfs and debugfs naming) .

Quoted 56 lines
drivers/remoteproc/remoteproc_cdev.c new file +9 -0
+	if (ret < 0)
+		pr_err("Failed to alloc rproc_cdev region, err %d\n", ret);
+}
+
+void __exit rproc_exit_cdev(void)
+{
+	unregister_chrdev_region(MKDEV(MAJOR(rproc_major), 0),
+				 NUM_RPROC_DEVICES);
+}
drivers/remoteproc/remoteproc_internal.h +21 -0
index 493ef92..fb9d891 100644
@@ -47,6 +47,27 @@ struct dentry *rproc_create_trace_file(const char
 *name, struct rproc *rproc,
   int rproc_init_sysfs(void);
   void rproc_exit_sysfs(void);
 
+#ifdef CONFIG_REMOTEPROC_CDEV
+void rproc_init_cdev(void);
+void rproc_exit_cdev(void);
+int rproc_char_device_add(struct rproc *rproc);
+void rproc_char_device_remove(struct rproc *rproc);
+#else
+static inline void rproc_init_cdev(void)
+{
+}
+static inline void rproc_exit_cdev(void)
+{
+}
+static inline int rproc_char_device_add(struct rproc *rproc)
+{
+	return 0;
+}
+static inline void  rproc_char_device_remove(struct rproc *rproc)
+{
+}
+#endif
+
   void rproc_free_vring(struct rproc_vring *rvring);
   int rproc_alloc_vring(struct rproc_vdev *rvdev, int i);
include/linux/remoteproc.h +1 -0
index 16ad666..9bd2ff5 100644
@@ -40,6 +40,7 @@
   #include <linux/virtio.h>
   #include <linux/completion.h>
   #include <linux/idr.h>
+#include <linux/cdev.h>
   #include <linux/of.h>
 
   /**

include/linux/remoteproc.h struct rproc { · line 520

Quoted 6 lines
include/linux/remoteproc.h +2 -0
@@ -514,6 +515,8 @@ struct rproc {
   	bool auto_boot;
   	struct list_head dump_segments;
   	int nb_vdev;
+	struct cdev char_dev;
+	bool cdev_put_on_release;
   };

These parameters are local variables of rproc_cdev. Could be defined in a separate structure.
with a pointer in rproc to this structure.

Quoted 22 lines
include/linux/remoteproc.h +0 -0
   /**
include/uapi/linux/remoteproc_cdev.h new file +14 -0
new file mode 100644
index 0000000..3975120
@@ -0,0 +1,20 @@
+/* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
+/*
+ * IOCTLs for Remoteproc's character device interface.
+ *
+ * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ */
+
+
+#ifndef _UAPI_REMOTEPROC_CDEV_H_
+#define _UAPI_REMOTEPROC_CDEV_H_
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
Quoted 8 lines

include/uapi/linux/remoteproc_cdev.h line 20

Quoted 7 lines
include/uapi/linux/remoteproc_cdev.h new file +6 -0
+#define RPROC_MAGIC	0xB7
+
+#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)
+#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)
+
+#endif

IOCTLs should probaly be documented.

Quoted 3 lines

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst
Is there another place where I need to add documentation for this?

Could you add in this file comments that describe
the IOCTL usage and associated parameter?

Quoted 8 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

Regards,
Arnaud

I don't see any for of comments that describe in detail the IOCTL usage, i.e.,
input parameters, etc. Could you provide an example so I can follow it?

If not, should I instead put them in Documentation/remoteproc.txt?

Bjorn and Mathieu are the right persons to decide on the best place.

Here are 2 exemples of "inline" documented IOCTRLs.

https://elixir.bootlin.com/linux/latest/source/arch/s390/include/uapi/asm/tape390.h#L15
https://elixir.bootlin.com/linux/latest/source/drivers/net/wan/cosa.h#L63

Could be something like that:

/*
* The RPROC_SET_SHUTDOWN_ON_RELEASE ioctl allows to enable/disable the
* automatic remote processors shutdown when the controlling userpsace
* closes the char device interface.
*
* input parameter: integer
* 0 : disable automatic shutdown
* other: enable automatic shutdown
*/
#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)

/*
* The RPROC_GET_SHUTDOWN_ON_RELEASE ioctl gets information about the
* automatic remote processors shutdown when the controlling userpsace
* closes the char device interface.
*
* output parameter: integer
* 0: automatic shutdown disable
* 1: automatic shutdown enable
*/
#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)

Regards,
Arnaud

Quoted 7 lines

Thanks,
Sid

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

Thanks,
Arnaud

#11 lore raw

Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface

Quoted 10 lines · Arnaud POULIQUEN
Quoted 7 lines · Siddharth Gupta
Quoted 5 lines · Arnaud POULIQUEN
Quoted 3 lines · Siddharth Gupta
Quoted 2 lines · Arnaud POULIQUEN
Quoted 1 line · On 6/16/20 9:56 PM, [email protected] wrote:

On 2020-04-30 01:30, Arnaud POULIQUEN wrote:

[..]

Quoted 36 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 4 lines
Quoted 1 line

IOCTLs should probaly be documented.

I have added documentation to Documentation/userspace-api/ioctl/ioctl-number.rst
Is there another place where I need to add documentation for this?

Could you add in this file comments that describe
the IOCTL usage and associated parameter?

Quoted 8 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

Regards,
Arnaud

I don't see any for of comments that describe in detail the IOCTL usage, i.e.,
input parameters, etc. Could you provide an example so I can follow it?

If not, should I instead put them in Documentation/remoteproc.txt?

Bjorn and Mathieu are the right persons to decide on the best place.

Here are 2 exemples of "inline" documented IOCTRLs.

https://elixir.bootlin.com/linux/latest/source/arch/s390/include/uapi/asm/tape390.h#L15
https://elixir.bootlin.com/linux/latest/source/drivers/net/wan/cosa.h#L63

Could be something like that:

/*
* The RPROC_SET_SHUTDOWN_ON_RELEASE ioctl allows to enable/disable the
* automatic remote processors shutdown when the controlling userpsace
* closes the char device interface.
*
* input parameter: integer
* 0 : disable automatic shutdown
* other: enable automatic shutdown
*/
#define RPROC_SET_SHUTDOWN_ON_RELEASE _IOW(RPROC_MAGIC, 1, int)

Quoted 11 lines

/*
* The RPROC_GET_SHUTDOWN_ON_RELEASE ioctl gets information about the
* automatic remote processors shutdown when the controlling userpsace
* closes the char device interface.
*
* output parameter: integer
* 0: automatic shutdown disable
* 1: automatic shutdown enable
*/
#define RPROC_GET_SHUTDOWN_ON_RELEASE _IOR(RPROC_MAGIC, 2, int)

I like this. Thanks for digging up an example Arnaud!

Regards,
Bjorn