[virtio-dev] RE: [PATCH v15] admin: Add group member legacy register access commands

2023-07-13 Thread Parav Pandit 
Hi Michael, Cornelia,

> From: Parav Pandit 
> Sent: Tuesday, July 11, 2023 11:02 AM
> To: virtio-comm...@lists.oasis-open.org; m...@redhat.com;
> coh...@redhat.com; david.edmond...@oracle.com

[..]

> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/167
> Signed-off-by: Parav Pandit 
> Signed-off-by: Michael S. Tsirkin 
> ---
> changelog:
> v14->v15:
> - addressed below editorial comments from Michael
> - replaced 'is' with 'are' for command description
> - simplified wording around ignore and skip to just use ignore
> - to -> in preference to
> - small rewording for flags description
> v13->v14:
> - addressed below comments from Michael
> - reworded BAR 1 to 5 text as_is suggested by Michael
> - added text for skipping invalid entries
> - replaced 'contains' with 'contain'
> - removed 'related to the base address associated'
> - addressed comments from Cornelia
> - added article the at many places
> - replaced does not to do not
> - reworded the driver normative for flags parsing
> v12->v13:
> - added article
> - add hyphen between little and endian
> - mentioned vq index depth of 16-bit
> - rewrote alternative approach line
> - mention vq index, length and endianness in mmio description
> - fixed padding bytes size from 7 to 6 bytes
> - rewrote bar field description
> - offset alignment text added
> - added text to ignore reserved notification entries
> - device and driver conformance lines added for notification info command
> fields
> - dropped group member prefix to the driver
> - reworded text for flags requirements
> - reworded to say all driver notifications in conformance
> - itemize conformance section under command to ease reading
> v11->v12:
> - added missing article the at few places
> - rewrote group_member_id statements like other existing
>   commands which is cleaner and shorter
> - added length and alignment lines to multiple commands
> - rewrote fast path to separate dedicated mechanism
> - rewrote example and description para for legacy notification command
> - made separate paragraph for the notify info command
> - dropped citation to virtio pci capabilities for member device
> - notification region changed to notification address throughout
> - added description to all the fields of the info struct
> - avoided union in spirit of keeping all for pci
> - used single listing
> - moved description to end which was in between two structs
> - added 4 entry and preference description
> - added conformance line for notification via mmio works same way as
>   admin command
> v10->v11:
> - replaced tab with white spaces in read structure
> - included pci fields along side other generic fields to avoid
>   indirection
> - merged pci conformance section
> - avoid using definite in starting introduction
> - replace 'all of the' with 'any of the'
> - changed drivers notification normative to indicate use of
>   NOTIFY_INFO command
> - renamed NOTIFY_QUERY to NOTIFY_INFO name
> - merged 4th patch with 3rd
> - added normative line for notify_info command
> - reworded notification region command description to be more verbose
> - merged flags and owner field to indicate end of list

Now that last few iterations handled all the suggested edits,
Can you please start the voting for it?

https://github.com/oasis-tcs/virtio-spec/issues/167

[virtio-dev] Re: [PATCH 0/4] Short document fixes to inner hash feature

2023-07-13 Thread Heng Qi 




在 2023/7/13 下午7:33, Michael S. Tsirkin 写道:

On Thu, Jul 13, 2023 at 11:12:13AM +0200, Cornelia Huck wrote:

On Thu, Jul 13 2023, Parav Pandit  wrote:


This short patches fixes the editing errors that stops the pdf and html
generation.

These 3 fixes are for the patch [1] for the github issue [2].

[1] https://lists.oasis-open.org/archives/virtio-comment/202307/msg00024.html
[2] https://github.com/oasis-tcs/virtio-spec/issues/173

Patch summary:
patch-1 place C code under listing
patch-2 avoid hyphen and extra braces
patch-3 use table as hyperlink do not work well in C code listing
patch-4 refer 'advice' as 'note'

Patch 1 to 3 appears to be must in the testing.
Patch 4 is not a fix and can be done later if it requires discussion.

Parav Pandit (4):
   virtio-net: Place C code under listing
   virtio-net: Avoid hyphen and extra braces
   virtio-net: Use table to describe inner hash to rfc mapping
   virtio-net: Use note instead of advice

  device-types/net/description.tex | 45 ++--
  introduction.tex | 15 +--
  2 files changed, 38 insertions(+), 22 deletions(-)


FTR, this is the diff I have locally (I had missed one underscore in the
references yesterday...); maybe we can make the intra-reference links in
introdcution.tex a bit nicer, but otherwise, this should be the minimal
change to make this build:

Perfect. Seems like clearly an editorial fix.

Heng Qi, in the future I'd like to ask you to please build the
spec and review the resulting PDF and HTML, before posting.


Yes, I will!






diff --git a/device-types/net/description.tex b/device-types/net/description.tex
index 206020de567d..76585b0dd6d3 100644
--- a/device-types/net/description.tex
+++ b/device-types/net/description.tex
@@ -1024,12 +1024,14 @@ \subsubsection{Processing of Incoming 
Packets}\label{sec:Device Types / Network
  If VIRTIO_NET_F_HASH_TUNNEL has been negotiated, the driver can send the 
command
  VIRTIO_NET_CTRL_HASH_TUNNEL_SET to configure the calculation of the inner 
header hash.
  
+\begin{lstlisting}

  struct virtnet_hash_tunnel {
  le32 enabled_tunnel_types;
  };
  
  #define VIRTIO_NET_CTRL_HASH_TUNNEL 7

   #define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0
+\end{lstlisting}
  
  Field \field{enabled_tunnel_types} contains the bitmask of encapsulation types enabled for inner header hash.

  See \ref{sec:Device Types / Network Device / Device Operation / Processing of 
Incoming Packets /
@@ -1063,16 +1065,16 @@ \subsubsection{Processing of Incoming 
Packets}\label{sec:Device Types / Network
  Hash calculation for incoming packets / Encapsulation types supported/enabled 
for inner header hash}
  
  Encapsulation types applicable for inner header hash:

-\begin{lstlisting}
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784(1 << 0) /* 
\hyperref[intro:gre_rfc2784]{[GRE_rfc2784]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890(1 << 1) /* 
\hyperref[intro:gre_rfc2890]{[GRE_rfc2890]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676(1 << 2) /* 
\hyperref[intro:gre_rfc7676]{[GRE_rfc7676]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* 
\hyperref[intro:gre_in_udp_rfc8086]{[GRE-in-UDP]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN   (1 << 4) /* 
\hyperref[intro:vxlan]{[VXLAN]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE   (1 << 5) /* 
\hyperref[intro:vxlan_gpe]{[VXLAN-GPE]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE  (1 << 6) /* 
\hyperref[intro:geneve]{[GENEVE]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP(1 << 7) /* 
\hyperref[intro:ipip]{[IPIP]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE   (1 << 8) /* 
\hyperref[intro:nvgre]{[NVGRE]} */
+\begin{lstlisting}[escapechar=|]
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784(1 << 0) /* 
|\hyperref[intro:rfc2784]{[RFC2784]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890(1 << 1) /* 
|\hyperref[intro:rfc2890]{[RFC2890]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676(1 << 2) /* 
|\hyperref[intro:rfc7676]{[RFC7676]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* 
|\hyperref[intro:rfc8086]{[GRE-in-UDP]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN   (1 << 4) /* 
|\hyperref[intro:vxlan]{[VXLAN]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE   (1 << 5) /* 
|\hyperref[intro:vxlan-gpe]{[VXLAN-GPE]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE  (1 << 6) /* 
|\hyperref[intro:geneve]{[GENEVE]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP(1 << 7) /* 
|\hyperref[intro:ipip]{[IPIP]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE   (1 << 8) /* 
|\hyperref[intro:nvgre]{[NVGRE]}| */
  \end{lstlisting}
  
  \subparagraph{Advice}

diff --git a/introduction.tex b/introduction.tex
index 81f07a4fee19..6f10a94b6fde 100644
--- a/introduction.tex
+++ b/introduction.tex
@@ -102,18 +102,18 @@ \section{Normative References}\label{sec:Normative 
References}
  Standards for Efficient Cryptography Group(SECG), ``SEC1: Elliptic Cureve

[virtio-dev] RE: [virtio-comment] [PATCH 1/4] virtio-net: Place C code under listing

2023-07-13 Thread Parav Pandit 



> From: Cornelia Huck 
> Sent: Thursday, July 13, 2023 5:13 AM
> To: Parav Pandit ; virtio-comm...@lists.oasis-open.org;
> m...@redhat.com
> On Thu, Jul 13 2023, Parav Pandit  wrote:
> 
> > With extra white space for the define, pdf generation fails.
> > Also place the C code under listing.
> >
> > Signed-off-by: Parav Pandit 
> > ---
> >  device-types/net/description.tex | 4 +++-
> >  1 file changed, 3 insertions(+), 1 deletion(-)
> >
> > diff --git a/device-types/net/description.tex
> > b/device-types/net/description.tex
> > index 206020d..6fd4a20 100644
> > --- a/device-types/net/description.tex
> > +++ b/device-types/net/description.tex
> > @@ -1024,12 +1024,14 @@ \subsubsection{Processing of Incoming
> > Packets}\label{sec:Device Types / Network  If VIRTIO_NET_F_HASH_TUNNEL
> > has been negotiated, the driver can send the command
> VIRTIO_NET_CTRL_HASH_TUNNEL_SET to configure the calculation of the inner
> header hash.
> >
> > +\begin{lstlisting}
> >  struct virtnet_hash_tunnel {
> >  le32 enabled_tunnel_types;
> >  };
> >
> >  #define VIRTIO_NET_CTRL_HASH_TUNNEL 7
> > - #define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0
> > +#define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0
> 
> I think the indentation here is intentional (as in other, similare
> sections.)
> 
Oh right. It is the command part.

> > +\end{lstlisting}
> >
> >  Field \field{enabled_tunnel_types} contains the bitmask of encapsulation
> types enabled for inner header hash.
> >  See \ref{sec:Device Types / Network Device / Device Operation /
> > Processing of Incoming Packets /


-
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org

[virtio-dev] Re: [PATCH 0/4] Short document fixes to inner hash feature

2023-07-13 Thread Michael S. Tsirkin 
On Thu, Jul 13, 2023 at 11:12:13AM +0200, Cornelia Huck wrote:
> On Thu, Jul 13 2023, Parav Pandit  wrote:
> 
> > This short patches fixes the editing errors that stops the pdf and html
> > generation.
> >
> > These 3 fixes are for the patch [1] for the github issue [2].
> >
> > [1] 
> > https://lists.oasis-open.org/archives/virtio-comment/202307/msg00024.html
> > [2] https://github.com/oasis-tcs/virtio-spec/issues/173
> >
> > Patch summary:
> > patch-1 place C code under listing
> > patch-2 avoid hyphen and extra braces
> > patch-3 use table as hyperlink do not work well in C code listing
> > patch-4 refer 'advice' as 'note'
> >
> > Patch 1 to 3 appears to be must in the testing.
> > Patch 4 is not a fix and can be done later if it requires discussion.
> >
> > Parav Pandit (4):
> >   virtio-net: Place C code under listing
> >   virtio-net: Avoid hyphen and extra braces
> >   virtio-net: Use table to describe inner hash to rfc mapping
> >   virtio-net: Use note instead of advice
> >
> >  device-types/net/description.tex | 45 ++--
> >  introduction.tex | 15 +--
> >  2 files changed, 38 insertions(+), 22 deletions(-)
> >
> 
> FTR, this is the diff I have locally (I had missed one underscore in the
> references yesterday...); maybe we can make the intra-reference links in
> introdcution.tex a bit nicer, but otherwise, this should be the minimal
> change to make this build:

Perfect. Seems like clearly an editorial fix.

Heng Qi, in the future I'd like to ask you to please build the
spec and review the resulting PDF and HTML, before posting.



> diff --git a/device-types/net/description.tex 
> b/device-types/net/description.tex
> index 206020de567d..76585b0dd6d3 100644
> --- a/device-types/net/description.tex
> +++ b/device-types/net/description.tex
> @@ -1024,12 +1024,14 @@ \subsubsection{Processing of Incoming 
> Packets}\label{sec:Device Types / Network
>  If VIRTIO_NET_F_HASH_TUNNEL has been negotiated, the driver can send the 
> command
>  VIRTIO_NET_CTRL_HASH_TUNNEL_SET to configure the calculation of the inner 
> header hash.
>  
> +\begin{lstlisting}
>  struct virtnet_hash_tunnel {
>  le32 enabled_tunnel_types;
>  };
>  
>  #define VIRTIO_NET_CTRL_HASH_TUNNEL 7
>   #define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0
> +\end{lstlisting}
>  
>  Field \field{enabled_tunnel_types} contains the bitmask of encapsulation 
> types enabled for inner header hash.
>  See \ref{sec:Device Types / Network Device / Device Operation / Processing 
> of Incoming Packets /
> @@ -1063,16 +1065,16 @@ \subsubsection{Processing of Incoming 
> Packets}\label{sec:Device Types / Network
>  Hash calculation for incoming packets / Encapsulation types 
> supported/enabled for inner header hash}
>  
>  Encapsulation types applicable for inner header hash:
> -\begin{lstlisting}
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784(1 << 0) /* 
> \hyperref[intro:gre_rfc2784]{[GRE_rfc2784]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890(1 << 1) /* 
> \hyperref[intro:gre_rfc2890]{[GRE_rfc2890]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676(1 << 2) /* 
> \hyperref[intro:gre_rfc7676]{[GRE_rfc7676]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* 
> \hyperref[intro:gre_in_udp_rfc8086]{[GRE-in-UDP]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN   (1 << 4) /* 
> \hyperref[intro:vxlan]{[VXLAN]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE   (1 << 5) /* 
> \hyperref[intro:vxlan_gpe]{[VXLAN-GPE]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE  (1 << 6) /* 
> \hyperref[intro:geneve]{[GENEVE]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP(1 << 7) /* 
> \hyperref[intro:ipip]{[IPIP]} */
> -#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE   (1 << 8) /* 
> \hyperref[intro:nvgre]{[NVGRE]} */
> +\begin{lstlisting}[escapechar=|]
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784(1 << 0) /* 
> |\hyperref[intro:rfc2784]{[RFC2784]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890(1 << 1) /* 
> |\hyperref[intro:rfc2890]{[RFC2890]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676(1 << 2) /* 
> |\hyperref[intro:rfc7676]{[RFC7676]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* 
> |\hyperref[intro:rfc8086]{[GRE-in-UDP]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN   (1 << 4) /* 
> |\hyperref[intro:vxlan]{[VXLAN]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE   (1 << 5) /* 
> |\hyperref[intro:vxlan-gpe]{[VXLAN-GPE]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE  (1 << 6) /* 
> |\hyperref[intro:geneve]{[GENEVE]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP(1 << 7) /* 
> |\hyperref[intro:ipip]{[IPIP]}| */
> +#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE   (1 << 8) /* 
> |\hyperref[intro:nvgre]{[NVGRE]}| */
>  \end{lstlisting}
>  
>  \subparagraph{Advice}
> diff --git a/introduction.tex b/introduction.tex
> index 81f07a4fee19..6f10a94b6fde 100644
> --- a/introduction.tex
> +++

[virtio-dev] Re: [PATCH 3/4] virtio-net: Use table to describe inner hash to rfc mapping

2023-07-13 Thread Michael S. Tsirkin 
On Thu, Jul 13, 2023 at 10:09:47AM +0200, Cornelia Huck wrote:
> On Wed, Jul 12 2023, Parav Pandit  wrote:
> 
> >> From: Michael S. Tsirkin 
> >> Sent: Wednesday, July 12, 2023 6:41 PM
> >> Hmm. escapechar did not work then?
> >
> >  Forgot to mention, I tried it, it didn't work.
> 
> It seemed to work for me (at least in the pdf) -- I'd prefer that one as
> a minimal change.

Yes it really should.  Could you post yours please?


-
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org

[virtio-dev] Re: [virtio-comment] Re: [PATCH 0/4] Short document fixes to inner hash feature

2023-07-13 Thread Michael S. Tsirkin 
On Thu, Jul 13, 2023 at 11:32:32AM +0200, Cornelia Huck wrote:
> On Thu, Jul 13 2023, Cornelia Huck  wrote:
> 
> > On Thu, Jul 13 2023, Parav Pandit  wrote:
> >
> >> This short patches fixes the editing errors that stops the pdf and html
> >> generation.
> >>
> >> These 3 fixes are for the patch [1] for the github issue [2].
> >>
> >> [1] 
> >> https://lists.oasis-open.org/archives/virtio-comment/202307/msg00024.html
> >> [2] https://github.com/oasis-tcs/virtio-spec/issues/173
> >>
> >> Patch summary:
> >> patch-1 place C code under listing
> >> patch-2 avoid hyphen and extra braces
> >> patch-3 use table as hyperlink do not work well in C code listing
> >> patch-4 refer 'advice' as 'note'
> >>
> >> Patch 1 to 3 appears to be must in the testing.
> >> Patch 4 is not a fix and can be done later if it requires discussion.
> >>
> >> Parav Pandit (4):
> >>   virtio-net: Place C code under listing
> >>   virtio-net: Avoid hyphen and extra braces
> >>   virtio-net: Use table to describe inner hash to rfc mapping
> >>   virtio-net: Use note instead of advice
> >>
> >>  device-types/net/description.tex | 45 ++--
> >>  introduction.tex | 15 +--
> >>  2 files changed, 38 insertions(+), 22 deletions(-)
> >>
> >
> > FTR, this is the diff I have locally (I had missed one underscore in the
> > references yesterday...); maybe we can make the intra-reference links in
> > introdcution.tex a bit nicer, but otherwise, this should be the minimal
> > change to make this build:
> 
> For the "make it look nicer" part, I think this one would get the job
> done; opinions?
> 
> diff --git a/introduction.tex b/introduction.tex
> index 6f10a94b6fde..1e39a4b2c529 100644
> --- a/introduction.tex
> +++ b/introduction.tex
> @@ -106,8 +106,8 @@ \section{Normative References}\label{sec:Normative 
> References}
>  Generic Routing Encapsulation. This protocol is only specified for IPv4 
> and used as either the payload or delivery protocol.
>   \newline\url{https://datatracker.ietf.org/doc/rfc2784/}\\
>   \phantomsection\label{intro:rfc2890}\textbf{[RFC2890]} &
> -Key and Sequence Number Extensions to GRE \ref{intro:rfc2784}. This 
> protocol describes extensions by which two fields, Key and
> -Sequence Number, can be optionally carried in the GRE Header 
> \ref{intro:rfc2784}.
> +Key and Sequence Number Extensions to \hyperref[intro:rfc2784]{GRE}. 
> This protocol describes extensions by which two fields, Key and
> +Sequence Number, can be optionally carried in the 
> \hyperref[intro:rfc2784]{GRE} Header.

This does look nicer.

>   \newline\url{https://www.rfc-editor.org/rfc/rfc2890}\\
>   \phantomsection\label{intro:rfc7676}\textbf{[RFC7676]} &
>  IPv6 Support for Generic Routing Encapsulation (GRE). This protocol is 
> specified for IPv6 and used as either the payload or


-
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org

[virtio-dev] Re: [virtio-comment] Re: [PATCH 0/4] Short document fixes to inner hash feature

2023-07-13 Thread Cornelia Huck 
On Thu, Jul 13 2023, Cornelia Huck  wrote:

> On Thu, Jul 13 2023, Parav Pandit  wrote:
>
>> This short patches fixes the editing errors that stops the pdf and html
>> generation.
>>
>> These 3 fixes are for the patch [1] for the github issue [2].
>>
>> [1] https://lists.oasis-open.org/archives/virtio-comment/202307/msg00024.html
>> [2] https://github.com/oasis-tcs/virtio-spec/issues/173
>>
>> Patch summary:
>> patch-1 place C code under listing
>> patch-2 avoid hyphen and extra braces
>> patch-3 use table as hyperlink do not work well in C code listing
>> patch-4 refer 'advice' as 'note'
>>
>> Patch 1 to 3 appears to be must in the testing.
>> Patch 4 is not a fix and can be done later if it requires discussion.
>>
>> Parav Pandit (4):
>>   virtio-net: Place C code under listing
>>   virtio-net: Avoid hyphen and extra braces
>>   virtio-net: Use table to describe inner hash to rfc mapping
>>   virtio-net: Use note instead of advice
>>
>>  device-types/net/description.tex | 45 ++--
>>  introduction.tex | 15 +--
>>  2 files changed, 38 insertions(+), 22 deletions(-)
>>
>
> FTR, this is the diff I have locally (I had missed one underscore in the
> references yesterday...); maybe we can make the intra-reference links in
> introdcution.tex a bit nicer, but otherwise, this should be the minimal
> change to make this build:

For the "make it look nicer" part, I think this one would get the job
done; opinions?

diff --git a/introduction.tex b/introduction.tex
index 6f10a94b6fde..1e39a4b2c529 100644
--- a/introduction.tex
+++ b/introduction.tex
@@ -106,8 +106,8 @@ \section{Normative References}\label{sec:Normative 
References}
 Generic Routing Encapsulation. This protocol is only specified for IPv4 
and used as either the payload or delivery protocol.
\newline\url{https://datatracker.ietf.org/doc/rfc2784/}\\
\phantomsection\label{intro:rfc2890}\textbf{[RFC2890]} &
-Key and Sequence Number Extensions to GRE \ref{intro:rfc2784}. This 
protocol describes extensions by which two fields, Key and
-Sequence Number, can be optionally carried in the GRE Header 
\ref{intro:rfc2784}.
+Key and Sequence Number Extensions to \hyperref[intro:rfc2784]{GRE}. This 
protocol describes extensions by which two fields, Key and
+Sequence Number, can be optionally carried in the 
\hyperref[intro:rfc2784]{GRE} Header.
\newline\url{https://www.rfc-editor.org/rfc/rfc2890}\\
\phantomsection\label{intro:rfc7676}\textbf{[RFC7676]} &
 IPv6 Support for Generic Routing Encapsulation (GRE). This protocol is 
specified for IPv6 and used as either the payload or


-
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org

[virtio-dev] Re: [PATCH 2/4] virtio-net: Avoid hyphen and extra braces

2023-07-13 Thread Cornelia Huck 
On Thu, Jul 13 2023, Parav Pandit  wrote:

> Avoid hyphen and replace it with white space like rest of the entries.
> Also avoid unnecessary braces.
> Name RFC as just RFC without special prefix about it.
>
> This likely resolves the html generation errors.
>
> Signed-off-by: Parav Pandit 
> ---
>  device-types/net/description.tex |  2 +-
>  introduction.tex | 15 +++
>  2 files changed, 8 insertions(+), 9 deletions(-)
>
> diff --git a/device-types/net/description.tex 
> b/device-types/net/description.tex
> index 6fd4a20..53c811f 100644
> --- a/device-types/net/description.tex
> +++ b/device-types/net/description.tex
> @@ -904,7 +904,7 @@ \subsubsection{Processing of Incoming 
> Packets}\label{sec:Device Types / Network
>  \end{itemize}
>  
>  The per-packet hash calculation can depend on the IP packet type. See
> -\hyperref[intro:IP]{[IP]}, \hyperref[intro:UDP]{[UDP]} and 
> \hyperref[intro:TCP]{[TCP]}.
> +\hyperref[intro:IP]{IP}, \hyperref[intro:UDP]{UDP} and 
> \hyperref[intro:TCP]{TCP}.

I'd keep that as-is (I think it looks nicer with the brackets).

>  
>  \subparagraph{Supported/enabled hash types}
>  \label{sec:Device Types / Network Device / Device Operation / Processing of 
> Incoming Packets / Hash calculation for incoming packets / Supported/enabled 
> hash types}
> diff --git a/introduction.tex b/introduction.tex
> index 81f07a4..028ec17 100644
> --- a/introduction.tex
> +++ b/introduction.tex
> @@ -101,26 +101,25 @@ \section{Normative References}\label{sec:Normative 
> References}
>   \phantomsection\label{intro:SEC1}\textbf{[SEC1]} &
>  Standards for Efficient Cryptography Group(SECG), ``SEC1: Elliptic 
> Cureve Cryptography'', Version 1.0, September 2000.
>   \newline\url{https://www.secg.org/sec1-v2.pdf}\\
> -
> - \phantomsection\label{intro:gre_rfc2784}\textbf{[GRE_rfc2784]} &
> + \phantomsection\label{intro:rfc2784}\textbf{[RFC2784]} &
>  Generic Routing Encapsulation. This protocol is only specified for IPv4 
> and used as either the payload or delivery protocol.
>   \newline\url{https://datatracker.ietf.org/doc/rfc2784/}\\
> - \phantomsection\label{intro:gre_rfc2890}\textbf{[GRE_rfc2890]} &
> -Key and Sequence Number Extensions to GRE \ref{intro:gre_rfc2784}. This 
> protocol describes extensions by which two fields, Key and
> -Sequence Number, can be optionally carried in the GRE Header 
> \ref{intro:gre_rfc2784}.
> + \phantomsection\label{intro:rfc2890}\textbf{[RFC2890]} &
> +Key and Sequence Number Extensions to GRE \ref{intro:rfc2784}. This 
> protocol describes extensions by which two fields, Key and
> +Sequence Number, can be optionally carried in the GRE Header 
> \ref{intro:rfc2784}.
>   \newline\url{https://www.rfc-editor.org/rfc/rfc2890}\\
> - \phantomsection\label{intro:gre_rfc7676}\textbf{[GRE_rfc7676]} &
> + \phantomsection\label{intro:rfc7676}\textbf{[RFC7676]} &
>  IPv6 Support for Generic Routing Encapsulation (GRE). This protocol is 
> specified for IPv6 and used as either the payload or
>  delivery protocol. Note that this does not change the GRE header format 
> or any behaviors specified by RFC 2784 or RFC 2890.
>   \newline\url{https://datatracker.ietf.org/doc/rfc7676/}\\
> - \phantomsection\label{intro:gre_in_udp_rfc8086}\textbf{[GRE-in-UDP]} &
> + \phantomsection\label{intro:rfc8086}\textbf{[GRE in UDP]} &

Hyphens are ok, I'd keep it.

>  GRE-in-UDP Encapsulation. This specifies a method of encapsulating 
> network protocol packets within GRE and UDP headers.
>  This protocol is specified for IPv4 and IPv6, and used as either the 
> payload or delivery protocol.
>   \newline\url{https://www.rfc-editor.org/rfc/rfc8086}\\
>   \phantomsection\label{intro:vxlan}\textbf{[VXLAN]} &
>  Virtual eXtensible Local Area Network.
>   \newline\url{https://datatracker.ietf.org/doc/rfc7348/}\\
> - \phantomsection\label{intro:vxlan-gpe}\textbf{[VXLAN-GPE]} &
> + \phantomsection\label{intro:vxlan gpe}\textbf{[VXLAN GPE]} &
>  Generic Protocol Extension for VXLAN. This protocol describes extending 
> Virtual eXtensible Local Area Network (VXLAN) via changes to the VXLAN header.
>   
> \newline\url{https://www.ietf.org/archive/id/draft-ietf-nvo3-vxlan-gpe-12.txt}\\
>   \phantomsection\label{intro:geneve}\textbf{[GENEVE]} &


-
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org

[virtio-dev] Re: [virtio-comment] [PATCH 1/4] virtio-net: Place C code under listing

2023-07-13 Thread Cornelia Huck 
On Thu, Jul 13 2023, Parav Pandit  wrote:

> With extra white space for the define, pdf generation fails.
> Also place the C code under listing.
>
> Signed-off-by: Parav Pandit 
> ---
>  device-types/net/description.tex | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/device-types/net/description.tex 
> b/device-types/net/description.tex
> index 206020d..6fd4a20 100644
> --- a/device-types/net/description.tex
> +++ b/device-types/net/description.tex
> @@ -1024,12 +1024,14 @@ \subsubsection{Processing of Incoming 
> Packets}\label{sec:Device Types / Network
>  If VIRTIO_NET_F_HASH_TUNNEL has been negotiated, the driver can send the 
> command
>  VIRTIO_NET_CTRL_HASH_TUNNEL_SET to configure the calculation of the inner 
> header hash.
>  
> +\begin{lstlisting}
>  struct virtnet_hash_tunnel {
>  le32 enabled_tunnel_types;
>  };
>  
>  #define VIRTIO_NET_CTRL_HASH_TUNNEL 7
> - #define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0
> +#define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0

I think the indentation here is intentional (as in other, similare
sections.)

> +\end{lstlisting}
>  
>  Field \field{enabled_tunnel_types} contains the bitmask of encapsulation 
> types enabled for inner header hash.
>  See \ref{sec:Device Types / Network Device / Device Operation / Processing 
> of Incoming Packets /


-
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org

[virtio-dev] Re: [PATCH 0/4] Short document fixes to inner hash feature

2023-07-13 Thread Cornelia Huck 
On Thu, Jul 13 2023, Parav Pandit  wrote:

> This short patches fixes the editing errors that stops the pdf and html
> generation.
>
> These 3 fixes are for the patch [1] for the github issue [2].
>
> [1] https://lists.oasis-open.org/archives/virtio-comment/202307/msg00024.html
> [2] https://github.com/oasis-tcs/virtio-spec/issues/173
>
> Patch summary:
> patch-1 place C code under listing
> patch-2 avoid hyphen and extra braces
> patch-3 use table as hyperlink do not work well in C code listing
> patch-4 refer 'advice' as 'note'
>
> Patch 1 to 3 appears to be must in the testing.
> Patch 4 is not a fix and can be done later if it requires discussion.
>
> Parav Pandit (4):
>   virtio-net: Place C code under listing
>   virtio-net: Avoid hyphen and extra braces
>   virtio-net: Use table to describe inner hash to rfc mapping
>   virtio-net: Use note instead of advice
>
>  device-types/net/description.tex | 45 ++--
>  introduction.tex | 15 +--
>  2 files changed, 38 insertions(+), 22 deletions(-)
>

FTR, this is the diff I have locally (I had missed one underscore in the
references yesterday...); maybe we can make the intra-reference links in
introdcution.tex a bit nicer, but otherwise, this should be the minimal
change to make this build:

diff --git a/device-types/net/description.tex b/device-types/net/description.tex
index 206020de567d..76585b0dd6d3 100644
--- a/device-types/net/description.tex
+++ b/device-types/net/description.tex
@@ -1024,12 +1024,14 @@ \subsubsection{Processing of Incoming 
Packets}\label{sec:Device Types / Network
 If VIRTIO_NET_F_HASH_TUNNEL has been negotiated, the driver can send the 
command
 VIRTIO_NET_CTRL_HASH_TUNNEL_SET to configure the calculation of the inner 
header hash.
 
+\begin{lstlisting}
 struct virtnet_hash_tunnel {
 le32 enabled_tunnel_types;
 };
 
 #define VIRTIO_NET_CTRL_HASH_TUNNEL 7
  #define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0
+\end{lstlisting}
 
 Field \field{enabled_tunnel_types} contains the bitmask of encapsulation types 
enabled for inner header hash.
 See \ref{sec:Device Types / Network Device / Device Operation / Processing of 
Incoming Packets /
@@ -1063,16 +1065,16 @@ \subsubsection{Processing of Incoming 
Packets}\label{sec:Device Types / Network
 Hash calculation for incoming packets / Encapsulation types supported/enabled 
for inner header hash}
 
 Encapsulation types applicable for inner header hash:
-\begin{lstlisting}
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784(1 << 0) /* 
\hyperref[intro:gre_rfc2784]{[GRE_rfc2784]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890(1 << 1) /* 
\hyperref[intro:gre_rfc2890]{[GRE_rfc2890]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676(1 << 2) /* 
\hyperref[intro:gre_rfc7676]{[GRE_rfc7676]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* 
\hyperref[intro:gre_in_udp_rfc8086]{[GRE-in-UDP]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN   (1 << 4) /* 
\hyperref[intro:vxlan]{[VXLAN]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE   (1 << 5) /* 
\hyperref[intro:vxlan_gpe]{[VXLAN-GPE]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE  (1 << 6) /* 
\hyperref[intro:geneve]{[GENEVE]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP(1 << 7) /* 
\hyperref[intro:ipip]{[IPIP]} */
-#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE   (1 << 8) /* 
\hyperref[intro:nvgre]{[NVGRE]} */
+\begin{lstlisting}[escapechar=|]
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784(1 << 0) /* 
|\hyperref[intro:rfc2784]{[RFC2784]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890(1 << 1) /* 
|\hyperref[intro:rfc2890]{[RFC2890]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676(1 << 2) /* 
|\hyperref[intro:rfc7676]{[RFC7676]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* 
|\hyperref[intro:rfc8086]{[GRE-in-UDP]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN   (1 << 4) /* 
|\hyperref[intro:vxlan]{[VXLAN]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE   (1 << 5) /* 
|\hyperref[intro:vxlan-gpe]{[VXLAN-GPE]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE  (1 << 6) /* 
|\hyperref[intro:geneve]{[GENEVE]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP(1 << 7) /* 
|\hyperref[intro:ipip]{[IPIP]}| */
+#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE   (1 << 8) /* 
|\hyperref[intro:nvgre]{[NVGRE]}| */
 \end{lstlisting}
 
 \subparagraph{Advice}
diff --git a/introduction.tex b/introduction.tex
index 81f07a4fee19..6f10a94b6fde 100644
--- a/introduction.tex
+++ b/introduction.tex
@@ -102,18 +102,18 @@ \section{Normative References}\label{sec:Normative 
References}
 Standards for Efficient Cryptography Group(SECG), ``SEC1: Elliptic Cureve 
Cryptography'', Version 1.0, September 2000.
\newline\url{https://www.secg.org/sec1-v2.pdf}\\
 
-   \phantomsection\label{intro:gre_rfc2784}\textbf{[GRE_rfc2784]} &
+   \phantomsection\label{intro:rfc2784}\textbf{[RFC2784]} &
 Generic Routing Encapsulation. This protocol

[virtio-dev] RE: [PATCH 3/4] virtio-net: Use table to describe inner hash to rfc mapping

2023-07-13 Thread Cornelia Huck 
On Wed, Jul 12 2023, Parav Pandit  wrote:

>> From: Michael S. Tsirkin 
>> Sent: Wednesday, July 12, 2023 6:41 PM
>> Hmm. escapechar did not work then?
>
>  Forgot to mention, I tried it, it didn't work.

It seemed to work for me (at least in the pdf) -- I'd prefer that one as
a minimal change.


-
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org