All of lore.kernel.org
 help / color / mirror / Atom feed
From: Stefan Hajnoczi <stefanha@redhat.com>
To: Viresh Kumar <viresh.kumar@linaro.org>
Cc: "Jason Wang" <jasowang@redhat.com>,
	"Michael S. Tsirkin" <mst@redhat.com>,
	"Arnd Bergmann" <arnd@kernel.org>,
	"Cornelia Huck" <cohuck@redhat.com>,
	"Linus Walleij" <linus.walleij@linaro.org>,
	"Bartosz Golaszewski" <bgolaszewski@baylibre.com>,
	"Vincent Guittot" <vincent.guittot@linaro.org>,
	"Jean-Philippe Brucker" <jean-philippe@linaro.org>,
	"Bill Mills" <bill.mills@linaro.org>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	"Enrico Weigelt, metux IT consult" <info@metux.net>,
	virtio-dev@lists.oasis-open.org,
	"Geert Uytterhoeven" <geert@linux-m68k.org>,
	stratos-dev@op-lists.linaro.org, "Arnd Bergmann" <arnd@arndb.de>
Subject: Re: [virtio-dev] [PATCH V9] virtio-gpio: Add the device specification
Date: Tue, 17 Aug 2021 10:37:36 +0100	[thread overview]
Message-ID: <YRuDYG6LKSyssCDa@stefanha-x1.localdomain> (raw)
In-Reply-To: <cb15de92f8cb840204a945ae643c14700b567600.1628492314.git.viresh.kumar@linaro.org>

[-- Attachment #1: Type: text/plain, Size: 2214 bytes --]

On Mon, Aug 09, 2021 at 12:32:14PM +0530, Viresh Kumar wrote:
> +\subsubsection{requestq Operation: Get Line Names}\label{sec:Device Types / GPIO Device / requestq Operation / Get Line Names}
> +
> +The driver sends this message to receive a stream of zero-terminated strings,
> +where each string represents the name of a GPIO line, present in increasing
> +order of the GPIO line numbers. The names of the GPIO lines are optional and may
> +be present only for a subset of GPIO lines. If missing, then a zero-byte must be
> +present for the GPIO line. If present, the name string must be zero-terminated
> +and the name must be unique within a GPIO Device.

Sorry I didn't get to this patch before the vote. It's necessary to
specify the character encoding. In the text above it's unclear whether
the characters are limited to US-ASCII, UTF-8, or something else.

I suggest UTF-8 for maximum flexibility.

> +These names of the GPIO lines should be most meaningful producer names for the
> +system, such as name indicating the usage. For example "MMC-CD", "Red LED Vdd"
> +and "ethernet reset" are reasonable line names as they describe what the line is
> +used for, while "GPIO0" is not a good name to give to a GPIO line.

Does this belong in the device normative section? Normally "should",
"must", "may", etc are only used there. If you prefer to keep it here,
please adjust the language ("The device describes GPIO lines with the
most meaningful producer names for the system, ...").

> +
> +The driver sends this message to request the device to configure a line's
> +direction. The driver can either set the direction to
> +\field{VIRTIO_GPIO_DIRECTION_IN} or \field{VIRTIO_GPIO_DIRECTION_OUT}, which
> +also activates the line, or to \field{VIRTIO_GPIO_DIRECTION_NONE}, which
> +deactivates the line.
> +
> +The driver should set the value of the GPIO line, using the
> +\field{VIRTIO_GPIO_MSG_SET_VALUE} message, before setting the direction of the
> +line to output to avoid any undesired behavior.

Does this belong in the driver normative section? Normally "should",
"must", "may", etc are only used there. If you prefer to keep it here,
please adjust the language ("The driver sets the value ...").

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

  parent reply	other threads:[~2021-08-17  9:37 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-09  7:02 [PATCH V9] virtio-gpio: Add the device specification Viresh Kumar
2021-08-10  9:58 ` [virtio-dev] " Cornelia Huck
2021-08-17  9:37 ` Stefan Hajnoczi [this message]
2021-08-17 10:01   ` [virtio-dev] " Cornelia Huck
2021-08-18 11:05 ` [virtio-dev] " Cornelia Huck
2021-08-18 11:11   ` Viresh Kumar
2021-08-18 11:21     ` [virtio-dev] " Cornelia Huck

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=YRuDYG6LKSyssCDa@stefanha-x1.localdomain \
    --to=stefanha@redhat.com \
    --cc=alex.bennee@linaro.org \
    --cc=arnd@arndb.de \
    --cc=arnd@kernel.org \
    --cc=bgolaszewski@baylibre.com \
    --cc=bill.mills@linaro.org \
    --cc=cohuck@redhat.com \
    --cc=geert@linux-m68k.org \
    --cc=info@metux.net \
    --cc=jasowang@redhat.com \
    --cc=jean-philippe@linaro.org \
    --cc=linus.walleij@linaro.org \
    --cc=mst@redhat.com \
    --cc=stratos-dev@op-lists.linaro.org \
    --cc=vincent.guittot@linaro.org \
    --cc=viresh.kumar@linaro.org \
    --cc=virtio-dev@lists.oasis-open.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.