From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH] ethernet api: Document rte_eth_vmdq_rx_conf
Date: Thu, 08 Jun 2017 22:48:42 +0200
Message-ID: <4818076.qqcqROevOE@xps>
References: <20170511082800.17608-1-tom.barbette@ulg.ac.be>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: Tom Barbette <tom.barbette@ulg.ac.be>
To: dev@dpdk.org
Return-path: <dev-bounces@dpdk.org>
Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com
 [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id 8E4282BA1
 for <dev@dpdk.org>; Thu,  8 Jun 2017 22:48:43 +0200 (CEST)
In-Reply-To: <20170511082800.17608-1-tom.barbette@ulg.ac.be>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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 {