Re: [PATCH DOCDAY v2] netif.h: describe request/response structures in terms of binary layout

[Ian Campbell <ian.campbell@citrix.com>]

On Wed, 2015-02-25 at 13:57 +0000, David Vrabel wrote:
> On 25/02/15 13:39, Ian Campbell wrote:
> > 
> > + * Guest transmit
> > + * ==============
> > + *
> > + * Ring slot size is 12 octets, however not all request/response
> > + * structs use the full size.
> > + *
> > + * tx request data (netif_tx_request_t)
> > + * ------------------------------------
> > + *
> > + *    0     1     2     3     4     5     6     7  octet
> > + * +-----+-----+-----+-----+-----+-----+-----+-----+
> > + * | grant ref             | offset    | flags     |
> > + * +-----+-----+-----+-----+-----+-----+-----+-----+
> > + * | id        | size      |
> > + * +-----+-----+-----+-----+
> > + *
> > + * grant ref: Reference to buffer page.
> > + * offset: Offset within buffer page.
> > + * flags: NETTXF_*.
> > + * id: request identifier, echoed in response.
> > + * size: packet size in bytes.
> 
> This size field should be described better since it's a bit weird when a
> packet it split across multiple requests -- I have to look at the
> implementations every time.

Me too :-/

My intention with this patch though was to make the binary layout
clearer, so the field descriptions themselves are the same as before.
Improving those will have to wait for another time.

Ian.