blob: 08b95de2b218c32dde0a91e81699bebc77350fc1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
/* Copyright (c) 2013-2018, Linaro Limited
* All rights reserved
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @mainpage
*
* @section sec_1 Introduction
*
* OpenDataPlane (ODP) provides a data plane application programming
* environment that is easy to use, high performance, and portable
* between networking SoCs. This documentation is both a user guide
* for developers who wish to use ODP and a detailed reference for ODP
* programmers covering APIs, data structures, files, etc. It should
* also be useful for those wishing to implement ODP on other
* platforms.
*
* @image html overview.svg
*
* ODP consists of a common layer and an implementation layer.
* Applications written to the common layer are portable across all
* ODP implementations. To compile and run an ODP application, it is
* compiled against a specific ODP implementation layer. The purpose
* of the implementation layer is to provide an optimal mapping of ODP
* APIs to the underlying capabilities (including hardware
* co-processing and acceleration support) of of SoCs hosting ODP
* implementations. As a bootstrapping mechanism for applications, as
* well as to provide a model for ODP implementers, ODP provides a
* 'linux-generic' reference implementation designed to run on any SoC
* which has a Linux kernel. While linux-generic is not a performance
* target, it does provide a starting point for ODP implementers and
* application programmers alike. As a pure software implementation
* of ODP, linux-generic is designed to provide best-in-class performance
* for general Linux data plane support.
*
* @section contact Contact Details
* - The main web site is http://www.opendataplane.org/
* - The git repo is https://github.com/OpenDataPlane/odp.git
* - Bug tracking is https://github.com/OpenDataPlane/odp/issues
*
*/
/**@page contributing Contributing Guide Lines
* @verbinclude CONTRIBUTING
*/
|
