X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fapi%2Fdoxy-api-index.md;h=34927023f2ce116dc4f72bed34cfed6741cbb5e7;hb=c261d1431bd8;hp=ed1a204ead0a84e9abcc88e2cbad6efac6858c8f;hpb=6d059e998091550b570f88e9cf6b81d6a76e8005;p=dpdk.git diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index ed1a204ead..34927023f2 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -4,7 +4,7 @@ API {#index} -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), + [rte_flow] (@ref rte_flow.h), + [rte_tm] (@ref rte_tm.h), + [rte_mtr] (@ref rte_mtr.h), [cryptodev] (@ref rte_cryptodev.h), + [security] (@ref rte_security.h), + [eventdev] (@ref rte_eventdev.h), + [event_eth_rx_adapter] (@ref rte_event_eth_rx_adapter.h), + [metrics] (@ref rte_metrics.h), + [bitrate] (@ref rte_bitrate.h), + [latency] (@ref rte_latencystats.h), [devargs] (@ref rte_devargs.h), + [PCI] (@ref rte_pci.h) + +- **device specific**: + [softnic] (@ref rte_eth_softnic.h), [bond] (@ref rte_eth_bond.h), - [vhost] (@ref rte_virtio_net.h), + [vhost] (@ref rte_vhost.h), [KNI] (@ref rte_kni.h), - [PCI] (@ref rte_pci.h), + [ixgbe] (@ref rte_pmd_ixgbe.h), + [i40e] (@ref rte_pmd_i40e.h), + [bnxt] (@ref rte_pmd_bnxt.h), + [crypto_scheduler] (@ref rte_cryptodev_scheduler.h) - **memory**: [memseg] (@ref rte_memory.h), @@ -66,28 +82,35 @@ 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), + [SIMD] (@ref rte_vect.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), + [service cores] (@ref rte_service.h), + [keepalive] (@ref rte_keepalive.h), [power/freq] (@ref rte_power.h) - **layers**: [ethernet] (@ref rte_ether.h), [ARP] (@ref rte_arp.h), [ICMP] (@ref rte_icmp.h), + [ESP] (@ref rte_esp.h), [IP] (@ref rte_ip.h), [SCTP] (@ref rte_sctp.h), [TCP] (@ref rte_tcp.h), [UDP] (@ref rte_udp.h), + [GRO] (@ref rte_gro.h), + [GSO] (@ref rte_gso.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) + [LPM IPv6 route] (@ref rte_lpm6.h) - **QoS**: [metering] (@ref rte_meter.h), @@ -101,13 +124,19 @@ There are many libraries, so their headers may be grouped by topics: [FBK hash] (@ref rte_fbk_hash.h), [CRC hash] (@ref rte_hash_crc.h) +- **classification** + [reorder] (@ref rte_reorder.h), + [distributor] (@ref rte_distributor.h), + [EFD] (@ref rte_efd.h), + [ACL] (@ref rte_acl.h), + [member] (@ref rte_member.h), + [flow classify] (@ref rte_flow_classify.h) + - **containers**: [mbuf] (@ref rte_mbuf.h), [ring] (@ref rte_ring.h), - [distributor] (@ref rte_distributor.h), - [reorder] (@ref rte_reorder.h), [tailq] (@ref rte_tailq.h), - [bitmap] (@ref rte_bitmap.h), + [bitmap] (@ref rte_bitmap.h) - **packet framework**: * [port] (@ref rte_port.h): @@ -140,12 +169,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), - [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), - [keepalive] (@ref rte_keepalive.h), [version] (@ref rte_version.h)