Re: [virtio] [PATCH 5/6] mmio: map common notifications terminology to MMIO

[Stefan Hajnoczi <stefanha@redhat.com>]

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

On Thu, Apr 26, 2018 at 01:00:01PM +0200, Halil Pasic wrote:
> @@ -1716,26 +1716,28 @@ The driver will typically initialize the virtual queue in the following way:
>  \item Write 0x1 to \field{QueueReady}.
>  \end{enumerate}
>  
> -\subsubsection{Notifying The Device}\label{sec:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Notifying The Device}
> +\subsubsection{Available Buffer Notifications}\label{sec:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Available Buffer Notifications}
>  
> -The driver notifies the device about new buffers being available in
> -a queue by writing the index of the updated queue to \field{QueueNotify}.
> +The driver sends an available buffer notification to the device a by

s/device a by/device by/

> +writing the index of the queue to \field{QueueNotify} to be notified.
>  
>  \subsubsection{Notifications From The Device}\label{sec:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Notifications From The Device}
>  
>  The memory mapped virtio device is using a single, dedicated
>  interrupt signal, which is asserted when at least one of the
>  bits described in the description of \field{InterruptStatus}
> -is set. This is how the device notifies the
> -driver about a new used buffer being available in the queue
> -or about a change in the device configuration.
> +is set. This is how the device sends an used buffer notification
> +or a configuration change notifaciton to the device.

s/notifaciton/notification/

Please run a spell checker over the patches in case I missed other
typos.

>  
>  \drivernormative{\paragraph}{Notifications From The Device}{Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Notifications From The Device}
>  After receiving an interrupt, the driver MUST read
> -\field{InterruptStatus} to check what caused the interrupt
> -(see the register description). After the interrupt is handled,
> -the driver MUST acknowledge it by writing a bit mask
> -corresponding to the handled events to the InterruptACK register.
> +
> +\field{InterruptStatus} to check what caused the interrupt (see the
> +register description).  The used buffer notification bit being set,

The comma is unnecessary here.  The "SHOULD ..." clause is not
independent and needs something directly before it.

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