Re: [PATCH] virtio-spi: add the device specification

[Haixu Cui <quic_haixcui@quicinc.com>]

Hi Cornelia Huck,
    Thank you so much for your helpful comments. I have them fixed in 
another submission.

Best Regards
Haixu Cui

On 3/27/2023 7:35 PM, Cornelia Huck wrote:
> On Fri, Mar 24 2023, Haixu Cui <quic_haixcui@quicinc.com> wrote:
>
> > virtio-spi is a virtual SPI master and it allows a guset to operate and
> > use the physical SPI master controlled by the host.
>
> Please spell out what SPI is the first time you use it.
I explain SPI is the abbreviation of Serial Peripheral Interface.
> Also, please remember to post the separate patch that reserves the ID
> for it.
I have another patch for DEVICE ID for virtio-spi.
> > Signed-off-by: Haixu Cui <quic_haixcui@quicinc.com>
> > ---
> >   conformance.tex                         |  12 +-
> >   content.tex                             |   1 +
> >   device-types/spi/description.tex        | 153 ++++++++++++++++++++++++
> >   device-types/spi/device-conformance.tex |   7 ++
> >   device-types/spi/driver-conformance.tex |   7 ++
> >   5 files changed, 176 insertions(+), 4 deletions(-)
> >   create mode 100644 device-types/spi/description.tex
> >   create mode 100644 device-types/spi/device-conformance.tex
> >   create mode 100644 device-types/spi/driver-conformance.tex
>
> (...)
>
> > diff --git a/device-types/spi/description.tex b/device-types/spi/description.tex
> > new file mode 100644
> > index 0000000..0b69700
> > --- /dev/null
> > +++ b/device-types/spi/description.tex
> > @@ -0,0 +1,153 @@
> > +\section{SPI Master Device}\label{sec:Device Types / SPI Master Device}
> > +
> > +virtio-spi is a virtual SPI master and it allows a guest to operate and use
> > +the physical SPI master devices controlled by the host.
>
> Here as well; it's even more important that the acronym is expanded at
> least once in the spec.
>
> Also, does this mean that the device is supposed to be an interface to
> physical SPI master devices? It would be good if this could be framed
> without guest/host terminology (although this can be used as an
> example.) Maybe something like
>
> "The virtio SPI master device is a virtual SPI (Serial Peripheral
> Interface) master device, potentially interfacing to another SPI master
> device. It allows, for example, for a host to expose access to a
> physical SPI master device controlled by the host to a guest."
virtio-spi is similar to virtio-i2c, so I update the description 
referring to the virtio-i2c specification.
> > +
> > +In a typical host and guest architecture with Virtio SPI, Virtio SPI driver
> > +is the front-end and exists in the guest kernel, Virtio SPI device acts as
> > +the back-end and exists in the host. And VirtQueues assist Virtio SPI driver
> > +and Virtio SPI device in perform VRing operations for communication between
> > +the front-end and the back-end.
>
> I'm not sure I can parse this properly -- does this mean that a
> virtqueue is used for communication between a front-end and a back-end?
yes, I also update the expression more clear.

> (Didn't look at the remainder of the patch yet.)