From: Bjorn Andersson <bjorn.andersson@linaro.org>
To: Arnaud POULIQUEN <arnaud.pouliquen@st.com>
Cc: Siddharth Gupta <sidgup@codeaurora.org>,
"rishabhb@codeaurora.org" <rishabhb@codeaurora.org>,
"linux-remoteproc@vger.kernel.org"
<linux-remoteproc@vger.kernel.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"mathieu.poirier@linaro.org" <mathieu.poirier@linaro.org>,
"ohad@wizery.com" <ohad@wizery.com>,
"tsoni@codeaurora.org" <tsoni@codeaurora.org>,
"psodagud@codeaurora.org" <psodagud@codeaurora.org>,
"linux-remoteproc-owner@vger.kernel.org"
<linux-remoteproc-owner@vger.kernel.org>
Subject: Re: [PATCH v3 1/2] remoteproc: Add remoteproc character device interface
Date: Wed, 1 Jul 2020 11:53:18 -0700 [thread overview]
Message-ID: <20200701185318.GA950397@builder.lan> (raw)
In-Reply-To: <275e39c4-0e0b-8ca2-ae0b-d0d435cfc720@st.com>
On Wed 01 Jul 05:13 PDT 2020, Arnaud POULIQUEN wrote:
>
>
> 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:
[..]
> >>>>>> 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)
>
I like this. Thanks for digging up an example Arnaud!
Regards,
Bjorn
next prev parent reply other threads:[~2020-07-01 18:55 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-21 18:10 [PATCH v3 0/2] Add character device interface to remoteproc Rishabh Bhatnagar
2020-04-21 18:10 ` [PATCH v3 1/2] remoteproc: Add remoteproc character device interface Rishabh Bhatnagar
2020-04-29 23:09 ` Mathieu Poirier
2020-04-30 8:30 ` Arnaud POULIQUEN
2020-04-30 16:44 ` Mathieu Poirier
2020-06-16 19:56 ` rishabhb
2020-06-17 8:44 ` Arnaud POULIQUEN
2020-06-30 5:38 ` Siddharth Gupta
2020-06-30 7:43 ` Arnaud POULIQUEN
2020-06-30 22:02 ` Siddharth Gupta
2020-07-01 12:13 ` Arnaud POULIQUEN
2020-07-01 18:53 ` Bjorn Andersson [this message]
2020-07-01 4:38 ` Bjorn Andersson
2020-04-21 18:10 ` [PATCH v3 2/2] remoteproc: core: Register the " Rishabh Bhatnagar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200701185318.GA950397@builder.lan \
--to=bjorn.andersson@linaro.org \
--cc=arnaud.pouliquen@st.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-remoteproc-owner@vger.kernel.org \
--cc=linux-remoteproc@vger.kernel.org \
--cc=mathieu.poirier@linaro.org \
--cc=ohad@wizery.com \
--cc=psodagud@codeaurora.org \
--cc=rishabhb@codeaurora.org \
--cc=sidgup@codeaurora.org \
--cc=tsoni@codeaurora.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.