From patchwork Thu Oct 14 08:37:00 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Rybchenko X-Patchwork-Id: 101566 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 61756A0C4C; Thu, 14 Oct 2021 10:37:25 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BB770411EE; Thu, 14 Oct 2021 10:37:19 +0200 (CEST) Received: from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113]) by mails.dpdk.org (Postfix) with ESMTP id 2F70C40041 for ; Thu, 14 Oct 2021 10:37:19 +0200 (CEST) Received: by shelob.oktetlabs.ru (Postfix, from userid 122) id F296F7F6FD; Thu, 14 Oct 2021 11:37:18 +0300 (MSK) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on shelob.oktetlabs.ru X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=ALL_TRUSTED, DKIM_ADSP_DISCARD, URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.2 Received: from aros.oktetlabs.ru (aros.oktetlabs.ru [192.168.38.17]) by shelob.oktetlabs.ru (Postfix) with ESMTP id BA42A7F6F3; Thu, 14 Oct 2021 11:37:11 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru BA42A7F6F3 Authentication-Results: shelob.oktetlabs.ru/BA42A7F6F3; dkim=none; dkim-atps=neutral From: Andrew Rybchenko To: Thomas Monjalon , Ferruh Yigit , Konstantin Ananyev Cc: dev@dpdk.org Date: Thu, 14 Oct 2021 11:37:00 +0300 Message-Id: <20211014083704.2542493-2-andrew.rybchenko@oktetlabs.ru> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20211014083704.2542493-1-andrew.rybchenko@oktetlabs.ru> References: <20211014083704.2542493-1-andrew.rybchenko@oktetlabs.ru> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 1/5] ethdev: avoid documentation in next lines X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Documentation in the next separate line is confusing. If documentation requires own line it should be before, not after. Fixes: 9f3eb8826450 ("ethdev: hide eth dev related structures") Signed-off-by: Andrew Rybchenko --- lib/ethdev/ethdev_driver.h | 72 ++++++++++++++++++-------------------- 1 file changed, 35 insertions(+), 37 deletions(-) diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h index 0174ba03d7..e5c7d08160 100644 --- a/lib/ethdev/ethdev_driver.h +++ b/lib/ethdev/ethdev_driver.h @@ -44,18 +44,17 @@ struct rte_eth_rxtx_callback { struct rte_eth_dev { eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */ eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */ + /** Pointer to PMD transmit prepare function. */ eth_tx_prep_t tx_pkt_prepare; - /**< Pointer to PMD transmit prepare function. */ + /** Get the number of used RX descriptors. */ eth_rx_queue_count_t rx_queue_count; - /**< Get the number of used RX descriptors. */ + /** Check the status of a Rx descriptor. */ eth_rx_descriptor_status_t rx_descriptor_status; - /**< Check the status of a Rx descriptor. */ + /** Check the status of a Tx descriptor. */ eth_tx_descriptor_status_t tx_descriptor_status; - /**< Check the status of a Tx descriptor. */ /** - * points to device data that is shared between - * primary and secondary processes. + * Device data that is shared between primary and secondary processes. */ struct rte_eth_dev_data *data; void *process_private; /**< Pointer to per-process device data. */ @@ -100,64 +99,63 @@ struct rte_eth_dev_data { struct rte_eth_dev_sriov sriov; /**< SRIOV data */ + /** PMD-specific private data. @see rte_eth_dev_release_port(). */ void *dev_private; - /**< PMD-specific private data. - * @see rte_eth_dev_release_port() - */ struct rte_eth_link dev_link; /**< Link-level information & status. */ struct rte_eth_conf dev_conf; /**< Configuration applied to device. */ uint16_t mtu; /**< Maximum Transmission Unit. */ + /** Common RX buffer size handled by all queues. */ uint32_t min_rx_buf_size; - /**< Common RX buffer size handled by all queues. */ uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */ + /** Device Ethernet link address. @see rte_eth_dev_release_port(). */ struct rte_ether_addr *mac_addrs; - /**< Device Ethernet link address. - * @see rte_eth_dev_release_port() - */ + /** Bitmap associating MAC addresses to pools. */ uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR]; - /**< Bitmap associating MAC addresses to pools. */ + /** + * Device Ethernet MAC addresses of hash filtering. + * @see rte_eth_dev_release_port() + */ struct rte_ether_addr *hash_mac_addrs; - /**< Device Ethernet MAC addresses of hash filtering. - * @see rte_eth_dev_release_port() - */ uint16_t port_id; /**< Device [external] port identifier. */ __extension__ - uint8_t promiscuous : 1, - /**< RX promiscuous mode ON(1) / OFF(0). */ + uint8_t /** RX promiscuous mode ON(1) / OFF(0). */ + promiscuous : 1, + /** RX of scattered packets is ON(1) / OFF(0) */ scattered_rx : 1, - /**< RX of scattered packets is ON(1) / OFF(0) */ + /** RX all multicast mode ON(1) / OFF(0). */ all_multicast : 1, - /**< RX all multicast mode ON(1) / OFF(0). */ + /** Device state: STARTED(1) / STOPPED(0). */ dev_started : 1, - /**< Device state: STARTED(1) / STOPPED(0). */ + /** RX LRO is ON(1) / OFF(0) */ lro : 1, - /**< RX LRO is ON(1) / OFF(0) */ - dev_configured : 1; - /**< Indicates whether the device is configured. - * CONFIGURED(1) / NOT CONFIGURED(0). + /** + * Indicates whether the device is configured. + * CONFIGURED(1) / NOT CONFIGURED(0). */ + dev_configured : 1; + /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */ uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT]; - /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */ + /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */ uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT]; - /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */ uint32_t dev_flags; /**< Capabilities. */ int numa_node; /**< NUMA node connection. */ + /** VLAN filter configuration. */ struct rte_vlan_filter_conf vlan_filter_conf; - /**< VLAN filter configuration. */ struct rte_eth_dev_owner owner; /**< The port owner. */ + /** + * Switch-specific identifier. + * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags. + */ uint16_t representor_id; - /**< Switch-specific identifier. - * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags. - */ + /** + * Port ID of the backing device. + * This device will be used to query representor info and calculate + * representor IDs. Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags. + */ uint16_t backer_port_id; - /**< Port ID of the backing device. - * This device will be used to query representor - * info and calculate representor IDs. - * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags. - */ pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */ uint64_t reserved_64s[4]; /**< Reserved for future fields */