Re: [virtio] Version Control Commit by hornet

[Rusty Russell <rusty@au1.ibm.com>]

Hi Pawel,

        Nice commit!  I only have three minor changes to suggest.

1) I usually like to be completely explicit on who should ignore values
(ie. driver or device).

2) Trying to be explicit on what to do with different Device Version
   Number field.

3) Generally prefer form "Driver must ignore X" to "X must be ignored by
   driver".


Cheers,
Rusty.

diff --git a/content.tex b/content.tex
index 9d46852..4f3c0dc 100644
--- a/content.tex
+++ b/content.tex
@@ -1417,17 +1417,16 @@ All register values are organized as Little Endian.
   \endfoot
   \endlastfoot
   \mmioreg{MagicValue}{Magic value}{0x000}{R}{%
-    MUST be 0x74726976 (a Little Endian equivalent of the "virt" string).
+    Devices MUST return 0x74726976 (a Little Endian equivalent of the "virt" string).  Drivers SHOULD ignore devices which present other values.
   } 
   \hline
   \mmioreg{Version}{Device version number}{0x004}{R}{%
-    Devices compliant with this specification MUST return value 0x2.
+    Devices compliant with this specification MUST return value 0x2.  Drivers MAY operate in legacy mode (see \ref{sec:Virtio Transport Options / Virtio Over MMIO / Legacy interface}~\nameref{sec:Virtio Transport Options / Virtio Over MMIO / Legacy interface}) if this value is 0x1.  Drivers MUST ignore devices with other version numbers, though they MAY report an error.
   }
   \hline 
   \mmioreg{DeviceID}{Virtio Subsystem Device ID}{0x008}{R}{%
     See \ref{sec:Device Types}~\nameref{sec:Device Types} for possible values.
-    Value zero (0x0) is invalid and devices returning this ID MUST be ignored
-    by the driver.
+    Value zero (0x0) is invalid and drivers MUST ignore such devices (this can be used for placeholder devices).
   }
   \hline 
   \mmioreg{VendorID}{Virtio Subsystem Vendor ID}{0x00c}{R}{}


workgroup_mailer@lists.oasis-open.org writes:
> Author: hornet
> Date: 2013-12-09 12:40:04 +0000 (Mon, 09 Dec 2013)
> New Revision: 170
> Web View: https://tools.oasis-open.org/version-control/browse/wsvn/virtio/?rev=170&sc=1
>
> Modified:
>    content.tex
> Log:
> 2.3.2 MMIO: LaTeXisation
>
> Converter the register layout descriptions into
> tables.
>
> Also hardened the specification language, using
> MUSTs and MUST NOTs.
>
> Signed-off-by: Pawel Moll <pawel.moll@arm.com>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe from this mail list, you must leave the OASIS TC that 
> generates this mail.  Follow this link to all your TCs in OASIS at:
> https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php