d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

eal: remove PCI device ids header from doxygen

Browse Source 
This file is going to disappear, remove the doxygen parts that reference
various drivers and remove it from the doxygen index.

Signed-off-by: David Marchand <david.marchand@6wind.com>
This commit is contained in:
David Marchand 2016-07-11 16:40:36 +02:00 committed by Thomas Monjalon
parent 8673a3e8bd
commit e9186770ad
2 changed files with 0 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/doxy-api-index.md
View File

@ -45,7 +45,6 @@ There are many libraries, so their headers may be grouped by topics:
[vhost] (@ref rte_virtio_net.h),
[KNI] (@ref rte_kni.h),
[PCI] (@ref rte_pci.h),
[PCI IDs] (@ref rte_pci_dev_ids.h)
- **memory**:
[memseg] (@ref rte_memory.h),

40
lib/librte_eal/common/include/rte_pci_dev_ids.h
View File

@ -57,46 +57,6 @@
*
*/
/**
* @file
*
* This file contains a list of the PCI device IDs recognised by DPDK, which
* can be used to fill out an array of structures describing the devices.
*
* Currently five families of devices are recognised: those supported by the
* IGB driver, by EM driver, those supported by the IXGBE driver, those
* supported by the BNXT driver, and by virtio driver which is a para
* virtualization driver running in guest virtual machine. The inclusion of
* these in an array built using this file depends on the definition of
* RTE_PCI_DEV_ID_DECL_BNXT
* RTE_PCI_DEV_ID_DECL_EM
* RTE_PCI_DEV_ID_DECL_IGB
* RTE_PCI_DEV_ID_DECL_IGBVF
* RTE_PCI_DEV_ID_DECL_IXGBE
* RTE_PCI_DEV_ID_DECL_IXGBEVF
* RTE_PCI_DEV_ID_DECL_I40E
* RTE_PCI_DEV_ID_DECL_I40EVF
* RTE_PCI_DEV_ID_DECL_VIRTIO
* at the time when this file is included.
*
* In order to populate an array, the user of this file must define this macro:
* RTE_PCI_DEV_ID_DECL_IXGBE(vendorID, deviceID). For example:
*
* @code
* struct device {
* int vend;
* int dev;
* };
*
* struct device devices[] = {
* #define RTE_PCI_DEV_ID_DECL_IXGBE(vendorID, deviceID) {vend, dev},
* #include <rte_pci_dev_ids.h>
* };
* @endcode
*
* Note that this file can be included multiple times within the same file.
*/
#ifndef RTE_PCI_DEV_ID_DECL_EM
#define RTE_PCI_DEV_ID_DECL_EM(vend, dev)
#endif