From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 407181B45A for ; Wed, 10 Oct 2018 04:27:37 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 09 Oct 2018 19:27:35 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.54,362,1534834800"; d="scan'208";a="97636240" Received: from yexl-server.sh.intel.com ([10.67.110.207]) by fmsmga001.fm.intel.com with ESMTP; 09 Oct 2018 19:27:34 -0700 From: Xiaolong Ye To: dev@dpdk.org, Maxime Coquelin , Tiwei Bie , Zhihong Wang , Ferruh Yigit Cc: xiao.w.wang@intel.com, Xiaolong Ye Date: Wed, 10 Oct 2018 17:14:47 +0800 Message-Id: <20181010091447.64542-1-xiaolong.ye@intel.com> X-Mailer: git-send-email 2.17.1 Subject: [dpdk-dev] [PATCH] vhost: add doxygen comment to vDPA header X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 10 Oct 2018 02:27:38 -0000 As APIs in rte_vdpa.h are public, we need to add doxygen comments to all APIs and structures. Signed-off-by: Xiaolong Ye --- doc/api/doxy-api-index.md | 1 + lib/librte_vhost/rte_vdpa.h | 54 +++++++++++++++++++++++++++++++++---- 2 files changed, 50 insertions(+), 5 deletions(-) diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index 9584ccb4c..a3039d168 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -37,6 +37,7 @@ The public API headers are grouped by topics: [softnic] (@ref rte_eth_softnic.h), [bond] (@ref rte_eth_bond.h), [vhost] (@ref rte_vhost.h), + [vdpa] (@ref rte_vdpa.h), [KNI] (@ref rte_kni.h), [ixgbe] (@ref rte_pmd_ixgbe.h), [i40e] (@ref rte_pmd_i40e.h), diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h index b8223e337..bdbb2ae18 100644 --- a/lib/librte_vhost/rte_vdpa.h +++ b/lib/librte_vhost/rte_vdpa.h @@ -21,6 +21,9 @@ enum vdpa_addr_type { VDPA_ADDR_MAX }; +/** + * vdpa device address + */ struct rte_vdpa_dev_addr { enum vdpa_addr_type type; union { @@ -29,6 +32,9 @@ struct rte_vdpa_dev_addr { }; }; +/** + * vdpa device operations + */ struct rte_vdpa_dev_ops { /* Get capabilities of this device */ int (*get_queue_num)(int did, uint32_t *queue_num); @@ -62,29 +68,67 @@ struct rte_vdpa_dev_ops { void *reserved[5]; }; +/** + * vdpa device structure includes device address and device operations. + */ struct rte_vdpa_device { struct rte_vdpa_dev_addr addr; struct rte_vdpa_dev_ops *ops; } __rte_cache_aligned; -/* Register a vdpa device, return did if successful, -1 on failure */ +/** + * Register a vdpa device + * + * @param addr + * the vdpa device address + * @parm ops + * the vdpa device operations + * @return + * device id on success, -1 on failure + */ int __rte_experimental rte_vdpa_register_device(struct rte_vdpa_dev_addr *addr, struct rte_vdpa_dev_ops *ops); -/* Unregister a vdpa device, return -1 on failure */ +/** + * Unregister a vdpa device + * + * @param did + * vdpa device id + * @return + * device id on success, -1 on failure + */ int __rte_experimental rte_vdpa_unregister_device(int did); -/* Find did of a vdpa device, return -1 on failure */ +/** + * Find the device id of a vdpa device + * + * @param addr + * the vdpa device address + * @return + * device id on success, -1 on failure + */ int __rte_experimental rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr); -/* Find a vdpa device based on did */ +/** + * Find a vdpa device based on device id + * + * @param did + * device id + * @return + * rte_vdpa_device on success, NULL on failure + */ struct rte_vdpa_device * __rte_experimental rte_vdpa_get_device(int did); -/* Get current available vdpa device number */ +/** + * Get current available vdpa device number + * + * @return + * available vdpa device number + */ int __rte_experimental rte_vdpa_get_device_num(void); #endif /* _RTE_VDPA_H_ */ -- 2.17.1