Received: by 2002:a05:6902:102b:0:0:0:0 with SMTP id x11csp569528ybt; Wed, 1 Jul 2020 05:17:48 -0700 (PDT) X-Google-Smtp-Source: ABdhPJx1cI7YdFDL8enEW87+JPdLfSpbVyXApffTAu2UVpA1rfrxknICENSb69zZ3Ek4hqSCW6pQ X-Received: by 2002:a17:907:1051:: with SMTP id oy17mr23528186ejb.394.1593605867943; Wed, 01 Jul 2020 05:17:47 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1593605867; cv=none; d=google.com; s=arc-20160816; b=hgvc7ZGP0FbVcJSZGQOQjGpKu3qwGIm99f7E/37PaHKEQae2WSxV50uLauKMjl+ASu fs8faymzN0Mx5+LXmmpxodhCcvSiXbWNKcqIyG81dGTs0CxwrU8QyXVQWO0lD+u1vRFR rYMIcpNt2QequaA++SMfYZ6SNfgodgVH+FqblPdifb/7/Ul3nvRFrp4nm1K5PVL7ss+4 kwn/WZXQ6EbViGZaf2b5siqxHnMkRrQVbNoecJ4Q0amMXO5sX7li7ScCPM97pr/R+yW0 Q+h4tL0phNa9CXjuoI9wGjFSCewJYYnuEvJM3KJ6eFxjFLjjWsodTdwqwqPljdSd6Gga 2Nyw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding :content-language:in-reply-to:mime-version:user-agent:date :message-id:from:references:cc:to:subject:dkim-signature; bh=8Ja8kNpnzG3A+zd4mgRIxA7QpQjh3tYAsUQWyfSQJIw=; b=jezfqKy3NtdLTwaww/wOwj0XODRsyK1jtGIiapJBhAb7fXa98seZ/rXe0IL3zQyKQ2 vIUUvV6jM2HqOch8Xz/OCtstiAp3w6WE9RJ5ZkKtgvR4XwrL/EWh57IpX9XpIBDGfRAZ KXRw3Nx1ZFgPD9Qi6JX+PvXsBO3mpi9aGcbnZJzY6R6LFujD1GJu3p9AblQPuIhGmMWW TcMoNE6gZruEA8q/IiDo4y67eEfW8PFaXBfhNoe0IspUN/BmntMS2bDEOFlxxiGi6tUl z25uXrG4ThuGDlJfxNINOWvrklqQXQ4YoASZlZ+8NXGwYvb5JK9T1M5Fzi6XoAwz1YUr 6xEQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@st.com header.s=STMicroelectronics header.b=kCYKr+TX; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=st.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id n27si3670765eje.543.2020.07.01.05.17.24; Wed, 01 Jul 2020 05:17:47 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@st.com header.s=STMicroelectronics header.b=kCYKr+TX; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=st.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730554AbgGAMOF (ORCPT + 99 others); Wed, 1 Jul 2020 08:14:05 -0400 Received: from mx08-00178001.pphosted.com ([91.207.212.93]:50972 "EHLO mx07-00178001.pphosted.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1730271AbgGAMOE (ORCPT ); Wed, 1 Jul 2020 08:14:04 -0400 Received: from pps.filterd (m0046661.ppops.net [127.0.0.1]) by mx07-00178001.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id 061BsUuW021383; Wed, 1 Jul 2020 14:13:56 +0200 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=st.com; h=subject : to : cc : references : from : message-id : date : mime-version : in-reply-to : content-type : content-transfer-encoding; s=STMicroelectronics; bh=8Ja8kNpnzG3A+zd4mgRIxA7QpQjh3tYAsUQWyfSQJIw=; b=kCYKr+TX+p9Zp0TfcJBZs9H9u41EFPf/NmbfmL9bUCWj0VabpyoP1UHn9n30U0z+77De uvSJUdty4e6PjHE4+s9/kM9Q/Ukepfpct3eQibl4sWo9YpF2DGw6fDxzQ+PQK0VweV9S rQwAdxkaHsjof0RTH82iB8CCfLtU30XVbChnBgbENH/oTmYv7Ta4vPidS4dmtvrUp8sX UeUQYhhK9JMxXdXaUIslAtyOffRCk1iPN6mWw034ILdgcUoDyyPzDIa19k/QY1mbA8wT JViTm4erkv+5YREPmOF/vu1ylSOF/5VXGtyzIjfynBZV8qDMLcKvW1Lz/X0RYMXId7Jl sA== Received: from beta.dmz-eu.st.com (beta.dmz-eu.st.com [164.129.1.35]) by mx07-00178001.pphosted.com with ESMTP id 31ww0g9us7-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 01 Jul 2020 14:13:56 +0200 Received: from euls16034.sgp.st.com (euls16034.sgp.st.com [10.75.44.20]) by beta.dmz-eu.st.com (STMicroelectronics) with ESMTP id BD3CD100039; Wed, 1 Jul 2020 14:13:55 +0200 (CEST) Received: from Webmail-eu.st.com (sfhdag3node1.st.com [10.75.127.7]) by euls16034.sgp.st.com (STMicroelectronics) with ESMTP id A00B62B38ED; Wed, 1 Jul 2020 14:13:55 +0200 (CEST) Received: from lmecxl0889.tpe.st.com (10.75.127.51) by SFHDAG3NODE1.st.com (10.75.127.7) with Microsoft SMTP Server (TLS) id 15.0.1473.3; Wed, 1 Jul 2020 14:13:54 +0200 Subject: Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface To: Siddharth Gupta , "rishabhb@codeaurora.org" CC: "linux-remoteproc@vger.kernel.org" , "linux-kernel@vger.kernel.org" , "bjorn.andersson@linaro.org" , "mathieu.poirier@linaro.org" , "ohad@wizery.com" , "tsoni@codeaurora.org" , "psodagud@codeaurora.org" , "linux-remoteproc-owner@vger.kernel.org" References: <1587492618-15896-1-git-send-email-rishabhb@codeaurora.org> <1587492618-15896-2-git-send-email-rishabhb@codeaurora.org> <3738198d-53d4-2fe6-a92b-2db0cd0afa68@st.com> <83c70517-32e4-9ce0-e1b4-2ed7a8b5c506@codeaurora.org> <94541ff3-ba34-3a08-f989-6e1a0a88fbf2@st.com> From: Arnaud POULIQUEN Message-ID: <275e39c4-0e0b-8ca2-ae0b-d0d435cfc720@st.com> Date: Wed, 1 Jul 2020 14:13:53 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.8.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset="utf-8" Content-Language: en-US Content-Transfer-Encoding: 7bit X-Originating-IP: [10.75.127.51] X-ClientProxiedBy: SFHDAG5NODE2.st.com (10.75.127.14) To SFHDAG3NODE1.st.com (10.75.127.7) X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.235,18.0.687 definitions=2020-07-01_07:2020-07-01,2020-07-01 signatures=0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 7/1/20 12:02 AM, Siddharth Gupta wrote: > > On 6/30/2020 12:43 AM, Arnaud POULIQUEN wrote: >> >> On 6/30/20 7:38 AM, Siddharth Gupta wrote: >>> On 6/17/2020 1:44 AM, Arnaud POULIQUEN wrote: >>>> On 6/16/20 9:56 PM, rishabhb@codeaurora.org wrote: >>>>> On 2020-04-30 01:30, Arnaud POULIQUEN wrote: >>>>>> Hi Rishabh, >>>>>> >>>>>> >>>>>> On 4/21/20 8:10 PM, Rishabh Bhatnagar wrote: >>>>>>> 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. >>>>>> >>>>>>> Signed-off-by: Rishabh Bhatnagar >>>>>>> --- >>>>>>> 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 >>>>>>> >>>>>>> diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst >>>>>>> b/Documentation/userspace-api/ioctl/ioctl-number.rst >>>>>>> index 2e91370..412b2a0 100644 >>>>>>> --- a/Documentation/userspace-api/ioctl/ioctl-number.rst >>>>>>> +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst >>>>>>> @@ -337,6 +337,7 @@ Code Seq# Include File >>>>>>> Comments >>>>>>> 0xB4 00-0F linux/gpio.h >>>>>>> >>>>>>> 0xB5 00-0F uapi/linux/rpmsg.h >>>>>>> >>>>>>> 0xB6 all linux/fpga-dfl.h >>>>>>> +0xB7 all uapi/linux/remoteproc_cdev.h >>>>>>> >>>>>>> 0xC0 00-0F linux/usb/iowarrior.h >>>>>>> 0xCA 00-0F uapi/misc/cxl.h >>>>>>> 0xCA 10-2F uapi/misc/ocxl.h >>>>>>> diff --git a/drivers/remoteproc/Kconfig b/drivers/remoteproc/Kconfig >>>>>>> index de3862c..6374b79 100644 >>>>>>> --- a/drivers/remoteproc/Kconfig >>>>>>> +++ b/drivers/remoteproc/Kconfig >>>>>>> @@ -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 >>>>>>> diff --git a/drivers/remoteproc/Makefile b/drivers/remoteproc/Makefile >>>>>>> index e30a1b1..b7d4f77 100644 >>>>>>> --- a/drivers/remoteproc/Makefile >>>>>>> +++ b/drivers/remoteproc/Makefile >>>>>>> @@ -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 >>>>>>> diff --git a/drivers/remoteproc/remoteproc_cdev.c >>>>>>> b/drivers/remoteproc/remoteproc_cdev.c >>>>>>> new file mode 100644 >>>>>>> index 0000000..65142ec >>>>>>> --- /dev/null >>>>>>> +++ b/drivers/remoteproc/remoteproc_cdev.c >>>>>>> @@ -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 >>>>>>> +#include >>>>>>> +#include >>>>>>> +#include >>>>>>> +#include >>>>>>> +#include >>>>>>> +#include >>>>>>> + >>>>>>> +#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; >>>>>> 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? >> Regarding remoteproc_sysfs.c[1], seems that the -EINVAL return would be coherent. > Okay sure. >> It would probably also be better to replace your condition with >> if (rproc->state != RPROC_RUNNING) > Will do. >> >> >> [1] https://elixir.bootlin.com/linux/latest/source/drivers/remoteproc/remoteproc_sysfs.c#L104 >> >> Regards, >> Arnaud >> >>> Thanks, >>> Sid >>> >>>>>>> + >>>>>>> + 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(¶m, 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 >>>>>> >>>>>>> + 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"); >>>>>>> +} >>>>>>> + >>>>>>> +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) >>>>>> . >>>>>> >>>>>>> + 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); >>>>>>> +} >>>>>>> diff --git a/drivers/remoteproc/remoteproc_internal.h >>>>>>> b/drivers/remoteproc/remoteproc_internal.h >>>>>>> index 493ef92..fb9d891 100644 >>>>>>> --- a/drivers/remoteproc/remoteproc_internal.h >>>>>>> +++ b/drivers/remoteproc/remoteproc_internal.h >>>>>>> @@ -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); >>>>>>> >>>>>>> diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h >>>>>>> index 16ad666..9bd2ff5 100644 >>>>>>> --- a/include/linux/remoteproc.h >>>>>>> +++ b/include/linux/remoteproc.h >>>>>>> @@ -40,6 +40,7 @@ >>>>>>> #include >>>>>>> #include >>>>>>> #include >>>>>>> +#include >>>>>>> #include >>>>>>> >>>>>>> /** >>>>>>> @@ -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. >>>>>> >>>>>>> /** >>>>>>> diff --git a/include/uapi/linux/remoteproc_cdev.h >>>>>>> b/include/uapi/linux/remoteproc_cdev.h >>>>>>> new file mode 100644 >>>>>>> index 0000000..3975120 >>>>>>> --- /dev/null >>>>>>> +++ b/include/uapi/linux/remoteproc_cdev.h >>>>>>> @@ -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 >>>>>>> +#include >>>>>>> + >>>>>>> +#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? >>>> 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? 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 > > Thanks, > Sid > >>>> >>>>>> Thanks, >>>>>> Arnaud