Re: [PATCH] ethernet api: Document rte_eth_vmdq_rx_conf

[Thomas Monjalon <thomas@monjalon.net>]

11/05/2017 10:28, Tom Barbette:
> From documentation it is very unclear how VMDq configuration can be
> tweaked, and online search offer very poor results.
> 
> This patch will ultimately spawn an online documentation page
> for the rte_eth_vmdq_rx_conf struct which will eventually add a bit of
> documentation about the rx_mode tag and how to allow e.g. VMDq pools
> to receive packets without VLAN tags.
> ---

I'm not an expert of VMDq.
Please help reviewing this doc addition.

[..]
> +/**
> + * A structure used to configure the VMDQ feature of an Ethernet port when
> + * not combined with the DCB feature.
> + *
> + * Using this feature, packets are routed to a pool of queues. By default, the
> + * pool selection is based on the MAC address, the vlan id in the vlan tag as
> + * specified in the pool_map array.
> + * Passing the ETH_VMDQ_ACCEPT_UNTAGGED in the rx_mode field allows pool
> + * selection using only the MAC address. MAC address to pool mapping is done
> + * using the rte_eth_dev_mac_addr_add function, with the pool parameter
> + * corresponding to the pool id.
> + *
> + * Queue selection within the selected pool will be done using RSS when
> + * it is enabled or revert to the first queue of the pool if not.
> + *
> + * A default pool may be used, if desired, to route all traffic which
> + * does not match the vlan filter rules or any pool MAC address.
> + */
>  struct rte_eth_vmdq_rx_conf {