doc: announce ABI change for PCI class
authorZiye Yang <ziye.yang@intel.com>
Wed, 17 Feb 2016 01:54:33 +0000 (09:54 +0800)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Tue, 5 Apr 2016 15:33:14 +0000 (17:33 +0200)
The purpose of this patch is used to add a new field
"class" in rte_pci_id structure. The new class field includes
class_id, subcalss_id, programming interface of a pci device.
With this field, we can identify pci device by its class info,
which can be more flexible instead of probing the device by
vendor_id OR device_id OR subvendor_id OR subdevice_id.
For example, we can probe all nvme devices by class field, which
can be quite convenient.

Signed-off-by: Ziye Yang <ziye.yang@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Helin Zhang <helin.zhang@intel.com>
Acked-by: Cunming Liang <cunming.liang@intel.com>
doc/guides/rel_notes/deprecation.rst

index 8b3794b..98d5529 100644 (file)
@@ -15,6 +15,12 @@ Deprecation Notices
   The /sys entries extended_tag and max_read_request_size created by igb_uio
   will be removed.
 
+* ABI changes are planned for struct rte_pci_id, i.e., add new field ``class``.
+  This new added ``class`` field can be used to probe pci device by class
+  related info. This change should impact size of struct rte_pci_id and struct
+  rte_pci_device. The release 16.04 does not contain these ABI changes, but
+  release 16.07 will.
+
 * The following fields have been deprecated in rte_eth_stats:
   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff