aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2021-04-23configure: change abi compatibility default value to disabledMatias Elo
Disable ABI compatibility by default. This way the ODP implementation will offer the best available performance without the user having to change the default configuration. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2021-02-23example: add CLI helper exampleJere Leppänen
This example shows how to start and stop ODP CLI using the CLI helper API functions. Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2021-02-05doc: userguide: update ipsec config dependency for pktio inline inboundAnoob Joseph
Update documentation to reflect latest API semantics. Signed-off-by: Anoob Joseph <anoobj@marvell.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
2021-02-05example: remove ipsec_offload applicationAakash Sasidharan
Remove ipsec_offload application as it is mostly duplicate of the ipsec_api application. Signed-off-by: Aakash Sasidharan <asasidharan@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2020-11-02doc: userguide: add pktio capability capturing timestamp on TxNithin Dabilpuram
Add documentation about new Packet IO capability and offload of capturing timestamp on Tx. This patch also updates notion of Packet IO time source that is different from local and global time source. Packet IO time source is the HW time source that is used to capture Rx and Tx timestamps. Signed-off-by: Matias Elo <matias.elo@nokia.com> Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2020-11-02doc: userguide: add pktio capability of no packet refsNithin Dabilpuram
Add documentation about pktio capability of no packet references offload. This offload helps platform optimize fast path for case when the packet is just forwarded with no static or dynamic references taken. Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
2020-11-02doc: userguide: change checksum insertion API documentationNithin Dabilpuram
Change checksum insertion API documentation with updated API semantics. Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
2020-10-13configure: fix doxygen-dot featureJere Leppänen
Make configure --(en|dis)able-doxygen-dot functional. Enable by default. If dot tool is not found, a warning is emitted and the feature is automatically disabled. Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2020-10-13configure: doc: fix tool requirements for user-guidesJere Leppänen
Require asciidoctor, mscgen and dot when generating user guides with configure --enable-user-guides. Do not require doxygen, it's not used for user guides. Fixes: https://github.com/OpenDataPlane/odp/issues/677 Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2020-09-28example: ipsec_crypto: rename ipsec application to ipsec_cryptoMatias Elo
Rename ipsec application to ipsec_crypto to better distinguish it from the ipsec api example. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
2020-09-17doc: fix mistakes in application-api-guideMalvika Gupta
The following mistakes were corrected: - Repeated and redundant words (odp: 28, 30) - Missing fullstops and commas. These are quite prominent when the API guide is viewed via a web browser (api_guide_lines: 42, 62, 101, 104; release: 51) - Incorrect punctuation (api_guide_lines: 206) - Change 'odp' and 'api' keywords to uppercase to ensure consistency with the remaining document (api_guide_lines: 88, 150) Signed-off-by: Malvika Gupta <Malvika.Gupta@arm.com> Reviewed-by: Govindarajan Mohandoss <Govindarajan.Mohandoss@arm.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2020-09-15example: debug: add new debug example applicationPetri Savolainen
This application can be used to test various debug print functions of ODP API. Debug functions to be called are selected with command line options. E.g. -s option reserves a SHM area and calls odp_shm_print() to print debug information about it. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2020-09-08doc: fix doxygen warningsJerin Jacob
Fix doxygen warning due to invalid PAPER_TYPE value. Based on doxygen 1.8.20 documentation https://www.doxygen.nl/manual/config.html#cfg_paper_type 'a4wide' is not valid paper type. $ make doxygen-doc DXGEN doc/application-api-guide/Doxyfile warning: argument 'a4wide' for option PAPER_TYPE is not a valid enum value Using the default: a4! Signed-off-by: Jerin Jacob <jerinj@marvell.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2020-09-07build: re-format autoconf argument defaultsStanislaw Kardach
Make sure that all autoconf arguments defined by ODP use default value description similar to built-in arguments. That is: [default=<value>]. Also make sure that all arguments use AS_HELP_STRING for uniform text formatting. Signed-off-by: Stanislaw Kardach <skardach@marvell.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2020-09-03doc: fixup example pathStanislaw Kardach
No need to include the whole SRCDIR. It is only needed for CONTRIBUTING (which can be included explicitly). Newer versions of doxygen (1.8.17) warn about ambiguous odp_l2fwd.c example (it's symlinked into example/l2fwd). Signed-off-by: Stanislaw Kardach <skardach@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2020-05-04linux-gen: config: rename CONFIG_NUM_CPU to CONFIG_NUM_CPU_IDSMatias Elo
Rename internal define CONFIG_NUM_CPU to CONFIG_NUM_CPU_IDS to avoid confusion. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2019-10-08example: odp_ping: add new example applicationPetri Savolainen
This application replies to IPv4 ping requests. It can be used to test connectivity with standard ping utility. ARP table needs to be setup manually on the sender side as the application does not reply to ARP requests. Test uses pcap packet IO to send 100 ICMP echo requests and receive the same number of echo replies. Pcap file sizes are compared to check that all packets were received. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2019-04-30validation: init: remove separate files per test casePetri Savolainen
Combining all test cases into a single source file (init_main.c). Create (still) separate binaries per test case as some implementations may assume that an application process won't call odp_global_init() more than once. Added missing local init/term calls to all test cases. Removed non-API compatible assumptions from log test: - ODP_DEBUG_PRINT is not defined in the API - API does not require odp_init_global() to output anything to the log Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2019-03-29example: add new pipeline example applicationMatias Elo
Add new simple pipeline example application. The application receives packets from one interface and passes them through 0-N worker stages before outputting them from a second network interface. The RX, worker, and TX stages are connected using plain queues and each stage is run on a separate CPU thread. Optionally, the worker stages calculate CRC-32C over packet data. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2019-02-28doc: fix issue tracking site urlMatias Elo
Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2019-02-26doc: add missing example applications to DoxygenMatias Elo
Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2019-02-26doc: fix ODP Doxygen logoMatias Elo
The whole ODP logo wasn't drawn correctly in Doxygen html documentation. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2019-02-01doc: update GitHub repository linksMatias Elo
Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
2019-01-23doc: userguide: add section for compression supportBill Fischofer
Add section to User's Guide for compression and decompression support Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Petri Savolainen <petri.savolainen@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2019-01-09doc: userguide: add documentation for flow aware scheduler modeBill Fischofer
Update the ODP User Guide to include information on scheduler capabilities and configuration and operating in flow aware mode. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Petri Savolainen <petri.savolainen@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-11-29doc: implementation: add configuration section to implementation guideBill Fischofer
The recent addition of a formal configuration file and override mechanism to ODP highlights the need to discuss implementation configuration considerations. Add this section to the ODP Implementation Guide and discuss the various types of static and dynamic configuration options available, with illustrations from how they are used in odp-linux. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Petri Savolainen <petri.savolainen@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-10-24doc: pass generated include files to DoxygenDmitry Eremin-Solenikov
Pass generated files to doxygen to let it know about ODP_DEPRECATED()/ODP_VERSION_API_xxx Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-05-11odp: pktio: add pcapng capture capabilitiesIlias Apalodimas
Introduce new fast pcap capture interface to odp. How to test: sudo mkdir /var/run/odp/ start the ODP application sudo dd if=/var/run/odp/"pid"-ethX-flow-"queue" of=~/t.pcap Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-28doc: allow user to provide exta asciidoctor flagsDmitry Eremin-Solenikov
Allow user to provide extra asciidoctor flags. E.g. this allows one to override icons and/or fonts placement. Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-10doc: userguide: add pktio capability and config infoBill Fischofer
Update PktIO section of Users Guide to cover pktio capability and input/output/parser configuration features. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Josep Puigdemont <josep.puigdemont@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-10doc: userguide: add packet checksum and parsing infoBill Fischofer
Update packet documentation to include information on packet parsing and checksum override handling. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Josep Puigdemont <josep.puigdemont@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-10doc: userguide: refresh pktio code examplesBill Fischofer
Update pktio code examples to reflect latest API definitions. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Josep Puigdemont <josep.puigdemont@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-10doc: userguide: change sched type none to parallelBill Fischofer
Replace old ODP_SCHED_SYNC_NONE with current ODP_SCHED_SYNC_PARALLEL when describing queue scheduling options. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Josep Puigdemont <josep.puigdemont@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-10doc: userguide: shm correctionsBill Fischofer
Clarify the use of the ODP_SHM_SINGLE_VM flag on shm operations. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Josep Puigdemont <josep.puigdemont@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-10doc: userguide: change pool queue to plain queueBill Fischofer
Queues fall into types PLAIN and SCHED. Correct terminology from the old POLL queue type to the current PLAIN queue type. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Josep Puigdemont <josep.puigdemont@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-04-10doc: userguide: typo correctionsBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Josep Puigdemont <josep.puigdemont@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-02-26update Linaro Copyrights to 2018 yearMaxim Uvarov
Using simple commands: find . -not -path .git -type f -exec \ sed -i -E 's/ (201[0-9]), Linaro/ \1-2018, Linaro/g' {} + find . -not -path .git -type f -exec \ sed -i -E 's/ (201[0-9])(-201[0-9]), Linaro/ \1-2018, Linaro/g' {} + Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
2018-02-02doc: move platform-specific doc distribution to platform/Makefile.incDmitry Eremin-Solenikov
${with_platform} in doc/platform-api-guide/Makefile.am will add to distro platform docs only for currently selected platform. Move this to platform/Makefile.inc, so that every platform doc file gets included into distro. Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-01-24docs: fixing broken linksPhilip Colmer
Signed-off-by: Philip Colmer <philip.colmer@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-01-15doc: add missing implementers-guide images to Makefile.amDmitry Eremin-Solenikov
Omitting those images in Makefile.am made them disappear from distribution tarball resulting in an improperly-built documentation files. Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2018-01-15doc: add missing user-guide images to Makefile.amDmitry Eremin-Solenikov
Omitting those images in Makefile.am made them disappear from distribution tarball resulting in an improperly-built documentation files. Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2017-12-29docs: update git tree and bugs linkMaxim Uvarov
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
2017-12-27doc: userguide: add odp_timer_capability() section to user guideKevin Wang
Signed-off-by: Kevin Wang <kevin.wang@arm.com> Reviewed-by: Brian Brooks <brian.brooks@arm.com> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2017-12-27doc: userguide: ipsec state machine changesBill Fischofer
Replace the FSMs used to describe SA state transitions and IPsec operations with a Message Sequence Diagram (MSC) that shows the same information in an easier to follow form. Update User Guide to reflect these changes as well. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2017-12-27doc: userguide: add ipsec user documentationBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2017-12-27doc: images: add graphviz source for ipsec fsmBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2017-12-27doc: images: add diagrams used for ipsec documentationBill Fischofer
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2017-12-27doc: userguide: document new packet-oriented crypto operationsBill Fischofer
Crypto now offers two complementary sets of cryptographic APIs: the original parameter-driven API and a new packet-oriented API designed to be more flexible and consistent with the protocol-aware APIs introduced as part of IPsec support. Update the ODP User Guide to include these new APIs. Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
2017-12-21test: build: enable cunit output to xmlMaxim Uvarov
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>
2017-11-10doxygen: remove drv typesMaxim Uvarov
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-18 12:20:19 +0000