[PATCH 2/5] net/nfp: rename field and add comment for Rx descriptor

[Chaoyong He <chaoyong.he@corigine.com>]

From: Qin Ke <qin.ke@corigine.com>

As rxd.vlan in Rx descriptor has been out of use and can be used
for packet type offload and other offloading information based on
comprehensive evaluation, it is renamed to rxd.offload_info.

Also adds the comment for Rx descriptor structure.

Signed-off-by: Qin Ke <qin.ke@corigine.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@corigine.com>
Reviewed-by: Chaoyong He <chaoyong.he@corigine.com>
---
 drivers/net/nfp/flower/nfp_flower.c |  2 +-
 drivers/net/nfp/nfp_rxtx.c          |  2 +-
 drivers/net/nfp/nfp_rxtx.h          | 24 ++++++++++++------------
 3 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/drivers/net/nfp/flower/nfp_flower.c b/drivers/net/nfp/flower/nfp_flower.c
index 72933e55d0..294e7431b1 100644
--- a/drivers/net/nfp/flower/nfp_flower.c
+++ b/drivers/net/nfp/flower/nfp_flower.c
@@ -428,7 +428,7 @@ nfp_flower_pf_recv_pkts(void *rx_queue,
 
 		if ((rxds->rxd.flags & PCIE_DESC_RX_VLAN) &&
 				(hw->ctrl & NFP_NET_CFG_CTRL_RXVLAN)) {
-			mb->vlan_tci = rte_cpu_to_le_32(rxds->rxd.vlan);
+			mb->vlan_tci = rte_cpu_to_le_32(rxds->rxd.offload_info);
 			mb->ol_flags |= RTE_MBUF_F_RX_VLAN | RTE_MBUF_F_RX_VLAN_STRIPPED;
 		}
 
diff --git a/drivers/net/nfp/nfp_rxtx.c b/drivers/net/nfp/nfp_rxtx.c
index 3c78557221..2f7369315d 100644
--- a/drivers/net/nfp/nfp_rxtx.c
+++ b/drivers/net/nfp/nfp_rxtx.c
@@ -245,7 +245,7 @@ nfp_net_parse_meta_vlan(const struct nfp_meta_parsed *meta,
 		}
 	} else if ((hw->ctrl & NFP_NET_CFG_CTRL_RXVLAN) != 0) {
 		if ((rxd->rxd.flags & PCIE_DESC_RX_VLAN) != 0) {
-			mb->vlan_tci = rte_cpu_to_le_32(rxd->rxd.vlan);
+			mb->vlan_tci = rte_cpu_to_le_32(rxd->rxd.offload_info);
 			mb->ol_flags |= RTE_MBUF_F_RX_VLAN | RTE_MBUF_F_RX_VLAN_STRIPPED;
 		}
 	}
diff --git a/drivers/net/nfp/nfp_rxtx.h b/drivers/net/nfp/nfp_rxtx.h
index f72c54fb25..73ef0a7c9f 100644
--- a/drivers/net/nfp/nfp_rxtx.h
+++ b/drivers/net/nfp/nfp_rxtx.h
@@ -172,25 +172,25 @@ struct nfp_net_txq {
 
 struct nfp_net_rx_desc {
 	union {
-		/* Freelist descriptor */
+		/** Freelist descriptor. */
 		struct {
-			uint16_t dma_addr_hi;
-			uint8_t spare;
-			uint8_t dd;
-
-			uint32_t dma_addr_lo;
+			uint16_t dma_addr_hi;  /**< High bits of buffer address. */
+			uint8_t spare;         /**< Reserved, must be zero. */
+			uint8_t dd;            /**< Whether descriptor available. */
+			uint32_t dma_addr_lo;  /**< Low bits of buffer address. */
 		} __rte_packed fld;
 
-		/* RX descriptor */
+		/** RX descriptor. */
 		struct {
-			uint16_t data_len;
-			uint8_t reserved;
-			uint8_t meta_len_dd;
+			uint16_t data_len;     /**< Length of frame + metadata. */
+			uint8_t reserved;      /**< Reserved, must be zero. */
+			uint8_t meta_len_dd;   /**< Length of metadata + done flag. */
 
-			uint16_t flags;
-			uint16_t vlan;
+			uint16_t flags;        /**< RX flags. */
+			uint16_t offload_info; /**< Offloading info. */
 		} __rte_packed rxd;
 
+		/** Reserved. */
 		uint32_t vals[2];
 	};
 };
-- 
2.39.1