LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: Arnaud POULIQUEN <arnaud.pouliquen@foss.st.com>
Cc: Ohad Ben-Cohen <ohad@wizery.com>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Mathieu Poirier <mathieu.poirier@linaro.org>,
	Jiri Slaby <jirislaby@kernel.org>, Suman Anna <s-anna@ti.com>,
	linux-stm32@st-md-mailman.stormreply.com,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-remoteproc@vger.kernel.org
Subject: Re: [PATCH v8 2/2] tty: add rpmsg driver
Date: Tue, 5 Oct 2021 18:17:23 +0200	[thread overview]
Message-ID: <YVx6k1MMx0BTmgO6@kroah.com> (raw)
In-Reply-To: <4cfc7497-ac85-828b-0b2f-a212c5a0503c@foss.st.com>

On Tue, Oct 05, 2021 at 06:03:25PM +0200, Arnaud POULIQUEN wrote:
> Hello Greg,
> 
> On 10/5/21 2:59 PM, Greg Kroah-Hartman wrote:
> > On Thu, Sep 30, 2021 at 06:05:20PM +0200, Arnaud Pouliquen wrote:
> >> This driver exposes a standard TTY interface on top of the rpmsg
> >> framework through a rpmsg service.
> >>
> >> This driver supports multi-instances, offering a /dev/ttyRPMSGx entry
> >> per rpmsg endpoint.
> >>
> >> Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
> >> ---
> >>  Documentation/serial/tty_rpmsg.rst |  15 ++
> >>  drivers/tty/Kconfig                |   9 +
> >>  drivers/tty/Makefile               |   1 +
> >>  drivers/tty/rpmsg_tty.c            | 275 +++++++++++++++++++++++++++++
> >>  4 files changed, 300 insertions(+)
> >>  create mode 100644 Documentation/serial/tty_rpmsg.rst
> >>  create mode 100644 drivers/tty/rpmsg_tty.c
> >>
> >> diff --git a/Documentation/serial/tty_rpmsg.rst b/Documentation/serial/tty_rpmsg.rst
> >> new file mode 100644
> >> index 000000000000..b055107866c9
> >> --- /dev/null
> >> +++ b/Documentation/serial/tty_rpmsg.rst
> >> @@ -0,0 +1,15 @@
> >> +.. SPDX-License-Identifier: GPL-2.0
> >> +
> >> +=========
> >> +RPMsg TTY
> >> +=========
> >> +
> >> +The rpmsg tty driver implements serial communication on the RPMsg bus to makes possible for
> >> +user-space programs to send and receive rpmsg messages as a standard tty protocol.
> >> +
> >> +The remote processor can instantiate a new tty by requesting a "rpmsg-tty" RPMsg service.
> >> +
> >> +The "rpmsg-tty" service is directly used for data exchange. No flow control is implemented.
> >> +
> >> +Information related to the RPMsg and associated tty device is available in
> >> +/sys/bus/rpmsg/devices/.
> > 
> > 
> > Why is this file needed?  Nothing references it, and this would be the
> > only file in this directory.
> 
> This file is created by the RPMsg framework, it allows to have information about
> RPMsg endpoint addresses associated to the rpmsg tty service instance.
> I can add this additional information to clarify the sentence.

As you are not tying in this into the kernel documentation build at all,
it makes no sense to add it.

Just use normal kernel-doc comments in your .c file and tie _THAT_ into
the kernel documentation build.  No need for a .rst file at all.

thanks,

greg k-h

      reply	other threads:[~2021-10-05 16:17 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-30 16:05 [PATCH v8 0/2] Add rpmsg tty driver Arnaud Pouliquen
2021-09-30 16:05 ` [PATCH v8 1/2] rpmsg: core: add API to get MTU Arnaud Pouliquen
2021-10-05 16:27   ` Bjorn Andersson
2021-09-30 16:05 ` [PATCH v8 2/2] tty: add rpmsg driver Arnaud Pouliquen
2021-10-04 20:12   ` Bjorn Andersson
2021-10-05 16:00     ` Arnaud POULIQUEN
2021-10-05 16:24       ` Bjorn Andersson
2021-10-07 10:20         ` Arnaud POULIQUEN
2021-10-05 12:59   ` Greg Kroah-Hartman
2021-10-05 16:03     ` Arnaud POULIQUEN
2021-10-05 16:17       ` Greg Kroah-Hartman [this message]

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=YVx6k1MMx0BTmgO6@kroah.com \
    --to=gregkh@linuxfoundation.org \
    --cc=arnaud.pouliquen@foss.st.com \
    --cc=bjorn.andersson@linaro.org \
    --cc=corbet@lwn.net \
    --cc=jirislaby@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-remoteproc@vger.kernel.org \
    --cc=linux-stm32@st-md-mailman.stormreply.com \
    --cc=mathieu.poirier@linaro.org \
    --cc=ohad@wizery.com \
    --cc=s-anna@ti.com \
    --subject='Re: [PATCH v8 2/2] tty: add rpmsg driver' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).