d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
a9d84ead56
numam-dpdk/doc/api/doxy-api-index.md

232 lines
6.6 KiB
Markdown
Raw Normal View History

doc: fix build with doxygen 1.8.18 Having an explicit "index" anchor looks forbidden: doc/api/doxy-api-index.md:1: warning: multiple use of section label 'index' for main page Anyway this anchor was not used, it can be removed. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Cc: stable@dpdk.org Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Tested-by: Jerin Jacob <jerinj@marvell.com>
2020-05-20 13:33:43 +00:00
API
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
===
<!--
eventdev: introduce event timer adapter Event devices can be coupled with various components to provide new event sources by using event adapters. The event timer adapter is one such adapter; it bridges event devices and timer mechanisms. This library extends the event-driven programming model by introducing a new type of event that represents a timer expiration, and it provides APIs with which adapters can be created or destroyed and event timers can be armed and canceled. Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2018-04-04 21:51:06 +00:00
SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2013-2017 6WIND S.A.
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
-->
doc: remove driver interface header from API index The file rte_flow_driver.h is a driver interface, thus it should not be listed in the API index. Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
2017-07-14 14:45:25 +00:00
The public API headers are grouped by topics:
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **device**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[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),
[bbdev](@ref rte_bbdev.h),
[cryptodev](@ref rte_cryptodev.h),
[security](@ref rte_security.h),
[compressdev](@ref rte_compressdev.h),
[compress](@ref rte_comp.h),
[regexdev](@ref rte_regexdev.h),
[dmadev](@ref rte_dmadev.h),
[eventdev](@ref rte_eventdev.h),
[event_eth_rx_adapter](@ref rte_event_eth_rx_adapter.h),
[event_eth_tx_adapter](@ref rte_event_eth_tx_adapter.h),
[event_timer_adapter](@ref rte_event_timer_adapter.h),
[event_crypto_adapter](@ref rte_event_crypto_adapter.h),
[rawdev](@ref rte_rawdev.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),
[vdev](@ref rte_bus_vdev.h),
[vfio](@ref rte_vfio.h)
doc: add device specific API Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
2017-01-30 18:27:25 +00:00
- **device specific**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[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),
[ice](@ref rte_pmd_ice.h),
[iavf](@ref rte_pmd_iavf.h),
[ioat](@ref rte_ioat_rawdev.h),
[bnxt](@ref rte_pmd_bnxt.h),
[cnxk](@ref rte_pmd_cnxk.h),
[dpaa](@ref rte_pmd_dpaa.h),
[dpaa2](@ref rte_pmd_dpaa2.h),
[mlx5](@ref rte_pmd_mlx5.h),
[dpaa2_mempool](@ref rte_dpaa2_mempool.h),
[dpaa2_cmdif](@ref rte_pmd_dpaa2_cmdif.h),
[dpaa2_qdma](@ref rte_pmd_dpaa2_qdma.h),
[crypto_scheduler](@ref rte_cryptodev_scheduler.h),
[dlb2](@ref rte_pmd_dlb2.h),
[ifpga](@ref rte_pmd_ifpga.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **memory**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[memseg](@ref rte_memory.h),
[memzone](@ref rte_memzone.h),
[mempool](@ref rte_mempool.h),
[malloc](@ref rte_malloc.h),
[memcpy](@ref rte_memcpy.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **timers**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[cycles](@ref rte_cycles.h),
[timer](@ref rte_timer.h),
[alarm](@ref rte_alarm.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **locks**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[atomic](@ref rte_atomic.h),
[mcslock](@ref rte_mcslock.h),
[pflock](@ref rte_pflock.h),
[rwlock](@ref rte_rwlock.h),
[spinlock](@ref rte_spinlock.h),
[ticketlock](@ref rte_ticketlock.h),
[RCU](@ref rte_rcu_qsbr.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **CPU arch**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[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 pause](@ref rte_pause.h),
[I/O access](@ref rte_io.h),
[power management](@ref rte_power_intrinsics.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **CPU multicore**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[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),
[PMD power](@ref rte_power_pmd_mgmt.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **layers**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[ethernet](@ref rte_ether.h),
[ARP](@ref rte_arp.h),
[HIGIG](@ref rte_higig.h),
[ICMP](@ref rte_icmp.h),
[ESP](@ref rte_esp.h),
[IPsec](@ref rte_ipsec.h),
[IPsec group](@ref rte_ipsec_group.h),
[IPsec SA](@ref rte_ipsec_sa.h),
[IPsec SAD](@ref rte_ipsec_sad.h),
[IP](@ref rte_ip.h),
[frag/reass](@ref rte_ip_frag.h),
[SCTP](@ref rte_sctp.h),
[TCP](@ref rte_tcp.h),
[UDP](@ref rte_udp.h),
[GTP](@ref rte_gtp.h),
[GRO](@ref rte_gro.h),
[GSO](@ref rte_gso.h),
[GRE](@ref rte_gre.h),
[MPLS](@ref rte_mpls.h),
[VXLAN](@ref rte_vxlan.h),
[Geneve](@ref rte_geneve.h),
[eCPRI](@ref rte_ecpri.h),
[L2TPv2](@ref rte_l2tpv2.h),
[PPP](@ref rte_ppp.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **QoS**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[metering](@ref rte_meter.h),
[scheduler](@ref rte_sched.h),
[RED congestion](@ref rte_red.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
doc: add RIB and FIB into the API index Add RIB/FIB library into the API doxygen index. Move LPM/LPM6 under separate section "routing". Fixes: 5a5793a5ffa2 ("rib: add RIB library") Fixes: f7e861e21c46 ("rib: support IPv6") Fixes: 39e927248416 ("fib: add FIB library") Fixes: 40d41a8a7b34 ("fib: support IPv6") Cc: stable@dpdk.org Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
2020-07-08 18:31:27 +00:00
- **routing**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[LPM IPv4 route](@ref rte_lpm.h),
[LPM IPv6 route](@ref rte_lpm6.h),
[RIB IPv4](@ref rte_rib.h),
[RIB IPv6](@ref rte_rib6.h),
[FIB IPv4](@ref rte_fib.h),
[FIB IPv6](@ref rte_fib6.h)
doc: add RIB and FIB into the API index Add RIB/FIB library into the API doxygen index. Move LPM/LPM6 under separate section "routing". Fixes: 5a5793a5ffa2 ("rib: add RIB library") Fixes: f7e861e21c46 ("rib: support IPv6") Fixes: 39e927248416 ("fib: add FIB library") Fixes: 40d41a8a7b34 ("fib: support IPv6") Cc: stable@dpdk.org Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
2020-07-08 18:31:27 +00:00
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **hashes**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[hash](@ref rte_hash.h),
[jhash](@ref rte_jhash.h),
[thash](@ref rte_thash.h),
[thash_gfni](@ref rte_thash_gfni.h),
[FBK hash](@ref rte_fbk_hash.h),
[CRC hash](@ref rte_hash_crc.h)
doc: group classification libraries in doxygen index The libraries reorder, distributor, EFD, ACL and member seem to belong to the same category. The previous categories "layers" and "containers" do not fit well. It is proposed to group them under "classification" category. Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-10-20 10:26:30 +00:00
- **classification**
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[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),
[BPF](@ref rte_bpf.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **containers**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[mbuf](@ref rte_mbuf.h),
[mbuf pool ops](@ref rte_mbuf_pool_ops.h),
[ring](@ref rte_ring.h),
[stack](@ref rte_stack.h),
[tailq](@ref rte_tailq.h),
[bitmap](@ref rte_bitmap.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
port: new packet framework API This file defines the port operations that have to be implemented by Packet Framework ports. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Pablo de Lara Guarch <pablo.de.lara.guarch@intel.com> Acked by: Ivan Boule <ivan.boule@6wind.com>
2014-06-04 18:08:19 +00:00
- **packet framework**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
* [port](@ref rte_port.h):
[ethdev](@ref rte_port_ethdev.h),
[ring](@ref rte_port_ring.h),
[frag](@ref rte_port_frag.h),
[reass](@ref rte_port_ras.h),
[sched](@ref rte_port_sched.h),
[kni](@ref rte_port_kni.h),
[src/sink](@ref rte_port_source_sink.h)
* [table](@ref rte_table.h):
[lpm IPv4](@ref rte_table_lpm.h),
[lpm IPv6](@ref rte_table_lpm_ipv6.h),
[ACL](@ref rte_table_acl.h),
[hash](@ref rte_table_hash.h),
[array](@ref rte_table_array.h),
[stub](@ref rte_table_stub.h)
* [pipeline](@ref rte_pipeline.h)
[port_in_action](@ref rte_port_in_action.h)
[table_action](@ref rte_table_action.h)
pipeline: add new SWX pipeline type Add new improved Software Switch (SWX) pipeline type that supports dynamically-defined packet headers, meta-data, actions and pipelines. Actions and pipelines are defined through instructions. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
2020-10-01 10:19:29 +00:00
* SWX pipeline:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[control](@ref rte_swx_ctl.h),
[extern](@ref rte_swx_extern.h),
[pipeline](@ref rte_swx_pipeline.h)
pipeline: add SWX pipeline input port Add input ports to the newly introduced SWX pipeline type. Each port instantiates a port type that defines the port operations, e.g. ethdev port, PCAP port, etc. The RX interface is single packet, with packet batching internally for performance. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
2020-10-01 10:19:30 +00:00
* SWX port:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[port](@ref rte_swx_port.h),
[ethdev](@ref rte_swx_port_ethdev.h),
[fd](@ref rte_swx_port_fd.h),
[ring](@ref rte_swx_port_ring.h),
[src/sink](@ref rte_swx_port_source_sink.h)
pipeline: add SWX pipeline tables Add tables to the SWX pipeline. The match fields are flexibly selected from the headers and meta-data. The set of table actions is flexibly selected for each table from the set of pipeline actions. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
2020-10-01 10:19:35 +00:00
* SWX table:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[table](@ref rte_swx_table.h),
[table_em](@ref rte_swx_table_em.h)
[table_wm](@ref rte_swx_table_wm.h)
* [graph](@ref rte_graph.h):
[graph_worker](@ref rte_graph_worker.h)
node: add ethdev control Add ctrl api to setup ethdev_rx and ethdev_tx node. This ctrl api clones 'N' number of ethdev_rx and ethdev_tx nodes with specific (port, queue) pairs updated in their context. All the ethdev ports and queues are setup before this api is called. Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com> Signed-off-by: Kiran Kumar K <kirankumark@marvell.com>
2020-04-11 14:14:17 +00:00
* graph_nodes:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[eth_node](@ref rte_node_eth_api.h),
[ip4_node](@ref rte_node_ip4_api.h)
port: new packet framework API This file defines the port operations that have to be implemented by Packet Framework ports. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Pablo de Lara Guarch <pablo.de.lara.guarch@intel.com> Acked by: Ivan Boule <ivan.boule@6wind.com>
2014-06-04 18:08:19 +00:00
kvargs: add in doc Reference the new library in doxygen. Move also some items from misc to a new basic section. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-02-04 15:11:12 +00:00
- **basic**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[bitops](@ref rte_bitops.h),
[approx fraction](@ref rte_approx.h),
[random](@ref rte_random.h),
[config file](@ref rte_cfgfile.h),
[key/value args](@ref rte_kvargs.h),
[string](@ref rte_string_fns.h)
kvargs: add in doc Reference the new library in doxygen. Move also some items from misc to a new basic section. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-02-04 15:11:12 +00:00
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **debug**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[jobstats](@ref rte_jobstats.h),
[telemetry](@ref rte_telemetry.h),
[pcapng](@ref rte_pcapng.h),
[pdump](@ref rte_pdump.h),
[hexdump](@ref rte_hexdump.h),
[debug](@ref rte_debug.h),
[log](@ref rte_log.h),
[errno](@ref rte_errno.h),
[trace](@ref rte_trace.h),
[trace_point](@ref rte_trace_point.h)
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
- **misc**:
doc: fix API index Markdown syntax API documentation index had spaces between link caption and URL, which may be unsupported by some Markdown implementations. That is, "[caption](URL)" is valid but "[caption] (URL)" is not. The problematic behavior is observed with Doxygen on Windows. Remove the spaces. Unfortunately, Markdown syntax is not formally specified. Fixes: 9bf486e606b0 ("doc: generate HTML for API with doxygen") Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:11 +00:00
[EAL config](@ref rte_eal.h),
[common](@ref rte_common.h),
[experimental APIs](@ref rte_compat.h),
[ABI versioning](@ref rte_function_versioning.h),
[version](@ref rte_version.h)
Reference in New Issue Copy Permalink