ethdev: introduce Rx queue offloads API

[dpdk.git] / doc / api / doxy-api-index.md

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index ed1a204..19e0d4f 100644 (file)
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -4,7 +4,7 @@ API {#index}
 <!--
   BSD LICENSE
 
 <!--
   BSD LICENSE
 

-  Copyright 2013 6WIND S.A.
+  Copyright 2013-2017 6WIND S.A.

 
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
 
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions


@@ -33,18 +33,29 @@ API {#index}
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 -->
 
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 -->
 

-There are many libraries, so their headers may be grouped by topics:
+The public API headers are grouped by topics:

 
 - **device**:
   [dev]                (@ref rte_dev.h),
   [ethdev]             (@ref rte_ethdev.h),
   [ethctrl]            (@ref rte_eth_ctrl.h),
 
 - **device**:
   [dev]                (@ref rte_dev.h),
   [ethdev]             (@ref rte_ethdev.h),
   [ethctrl]            (@ref rte_eth_ctrl.h),

+  [rte_flow]           (@ref rte_flow.h),
+  [rte_tm]             (@ref rte_tm.h),

   [cryptodev]          (@ref rte_cryptodev.h),
   [cryptodev]          (@ref rte_cryptodev.h),

+  [eventdev]           (@ref rte_eventdev.h),
+  [metrics]            (@ref rte_metrics.h),
+  [bitrate]            (@ref rte_bitrate.h),
+  [latency]            (@ref rte_latencystats.h),

   [devargs]            (@ref rte_devargs.h),
   [devargs]            (@ref rte_devargs.h),

+  [PCI]                (@ref rte_pci.h)
+
+- **device specific**:

   [bond]               (@ref rte_eth_bond.h),
   [bond]               (@ref rte_eth_bond.h),

-  [vhost]              (@ref rte_virtio_net.h),
+  [vhost]              (@ref rte_vhost.h),

   [KNI]                (@ref rte_kni.h),
   [KNI]                (@ref rte_kni.h),

-  [PCI]                (@ref rte_pci.h),
+  [ixgbe]              (@ref rte_pmd_ixgbe.h),
+  [i40e]               (@ref rte_pmd_i40e.h),
+  [crypto_scheduler]   (@ref rte_cryptodev_scheduler.h)

 
 - **memory**:
   [memseg]             (@ref rte_memory.h),
 
 - **memory**:
   [memseg]             (@ref rte_memory.h),


@@ -66,14 +77,19 @@ There are many libraries, so their headers may be grouped by topics:
 - **CPU arch**:
   [branch prediction]  (@ref rte_branch_prediction.h),
   [cache prefetch]     (@ref rte_prefetch.h),
 - **CPU arch**:
   [branch prediction]  (@ref rte_branch_prediction.h),
   [cache prefetch]     (@ref rte_prefetch.h),

+  [SIMD]               (@ref rte_vect.h),

   [byte order]         (@ref rte_byteorder.h),
   [byte order]         (@ref rte_byteorder.h),

-  [CPU flags]          (@ref rte_cpuflags.h)
+  [CPU flags]          (@ref rte_cpuflags.h),
+  [CPU pause]          (@ref rte_pause.h),
+  [I/O access]         (@ref rte_io.h)

 
 - **CPU multicore**:
   [interrupts]         (@ref rte_interrupts.h),
   [launch]             (@ref rte_launch.h),
   [lcore]              (@ref rte_lcore.h),
   [per-lcore]          (@ref rte_per_lcore.h),
 
 - **CPU multicore**:
   [interrupts]         (@ref rte_interrupts.h),
   [launch]             (@ref rte_launch.h),
   [lcore]              (@ref rte_lcore.h),
   [per-lcore]          (@ref rte_per_lcore.h),

+  [service cores]      (@ref rte_service.h),
+  [keepalive]          (@ref rte_keepalive.h),

   [power/freq]         (@ref rte_power.h)
 
 - **layers**:
   [power/freq]         (@ref rte_power.h)
 
 - **layers**:


@@ -84,10 +100,12 @@ There are many libraries, so their headers may be grouped by topics:
   [SCTP]               (@ref rte_sctp.h),
   [TCP]                (@ref rte_tcp.h),
   [UDP]                (@ref rte_udp.h),
   [SCTP]               (@ref rte_sctp.h),
   [TCP]                (@ref rte_tcp.h),
   [UDP]                (@ref rte_udp.h),

+  [GRO]                (@ref rte_gro.h),

   [frag/reass]         (@ref rte_ip_frag.h),
   [LPM IPv4 route]     (@ref rte_lpm.h),
   [LPM IPv6 route]     (@ref rte_lpm6.h),
   [frag/reass]         (@ref rte_ip_frag.h),
   [LPM IPv4 route]     (@ref rte_lpm.h),
   [LPM IPv6 route]     (@ref rte_lpm6.h),

-  [ACL]                (@ref rte_acl.h)
+  [ACL]                (@ref rte_acl.h),
+  [EFD]                (@ref rte_efd.h)

 
 - **QoS**:
   [metering]           (@ref rte_meter.h),
 
 - **QoS**:
   [metering]           (@ref rte_meter.h),


@@ -140,12 +158,10 @@ There are many libraries, so their headers may be grouped by topics:
   [hexdump]            (@ref rte_hexdump.h),
   [debug]              (@ref rte_debug.h),
   [log]                (@ref rte_log.h),
   [hexdump]            (@ref rte_hexdump.h),
   [debug]              (@ref rte_debug.h),
   [log]                (@ref rte_log.h),

-  [warnings]           (@ref rte_warnings.h),

   [errno]              (@ref rte_errno.h)
 
 - **misc**:
   [EAL config]         (@ref rte_eal.h),
   [common]             (@ref rte_common.h),
   [ABI compat]         (@ref rte_compat.h),
   [errno]              (@ref rte_errno.h)
 
 - **misc**:
   [EAL config]         (@ref rte_eal.h),
   [common]             (@ref rte_common.h),
   [ABI compat]         (@ref rte_compat.h),

-  [keepalive]          (@ref rte_keepalive.h),

   [version]            (@ref rte_version.h)
   [version]            (@ref rte_version.h)