From patchwork Mon Feb 8 18:31:57 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Christophe Milard X-Patchwork-Id: 61422 Delivered-To: patch@linaro.org Received: by 10.112.43.199 with SMTP id y7csp1569845lbl; Mon, 8 Feb 2016 09:33:19 -0800 (PST) X-Received: by 10.55.75.212 with SMTP id y203mr37043728qka.3.1454952799517; Mon, 08 Feb 2016 09:33:19 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id d4si16258920qga.119.2016.02.08.09.33.18; Mon, 08 Feb 2016 09:33:19 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dkim=neutral (body hash did not verify) header.i=@linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id C7F4A6172E; Mon, 8 Feb 2016 17:33:18 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=kukJxgn+; dkim-adsp=none (unprotected policy); dkim-atps=neutral X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, T_DKIM_INVALID, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 905D261708; Mon, 8 Feb 2016 17:33:10 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 16A8961724; Mon, 8 Feb 2016 17:33:06 +0000 (UTC) Received: from mail-lb0-f182.google.com (mail-lb0-f182.google.com [209.85.217.182]) by lists.linaro.org (Postfix) with ESMTPS id B55AA6172D for ; Mon, 8 Feb 2016 17:33:02 +0000 (UTC) Received: by mail-lb0-f182.google.com with SMTP id x4so88215154lbm.0 for ; Mon, 08 Feb 2016 09:33:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-type:content-transfer-encoding; bh=DnAmwprKN/IL37GBubTNfNFQchevpbFX4SQtSK+hwNw=; b=kukJxgn+3sd4oAwTmF3pEhubTXR9K7CAk+F+l8ak6eYYJbrqZOJouGuiJzVHYMCXIM 3XtA+UprDNfPSNkZidm1B1168PpWzbX4zFdn+98YzO2iXRZkOr4YvyIXAZClgQSYlrf2 BF6myeT2a7BoXOtVV5vBR/NNKE59l4raxSE70= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-type:content-transfer-encoding; bh=DnAmwprKN/IL37GBubTNfNFQchevpbFX4SQtSK+hwNw=; b=Uwwlm9MEUmI6wfY+dUecDhcJW3xbkRKn1C3YwX1xxYpa7JW/yB7CqBppE2ivFnkhQH EtbMFDpkgYfIVMRzxtEzwLT0u5U2GeHXwqC7SRnpuGPYqT46PCWyNyR9e8+TY6eCyJDS moxoCeEHF9JCXyQCydtfx+OPeI0jRTy1jicqM1XrTnPlSwUr8OXVaidA6mKQ+iAUvtzE BM1LiQR4kGscRZVFgyswVkfyJ18u33M0CujKFR/LNctLxP3/DCOH3NCIibJxsa7XjPP7 Xs1GYOtRTfVyBHOxJ9hOWS/ctysFVHICAFgdGUgCJ8+XK7X4Wpjllzm8OhHN99kMJmKe inxA== X-Gm-Message-State: AG10YORWsUhGoqWb/9N4ufvJZ3BsoQKV9DE2+V+iWpNPJUALrzbdJs15gdZ40BXrzl6Qje933rc= X-Received: by 10.112.148.33 with SMTP id tp1mr12304959lbb.52.1454952781647; Mon, 08 Feb 2016 09:33:01 -0800 (PST) Received: from erachmi-ericsson.ki.sw.ericsson.se (c-83-233-90-46.cust.bredband2.com. [83.233.90.46]) by smtp.gmail.com with ESMTPSA id gm2sm261885lbc.15.2016.02.08.09.33.00 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 08 Feb 2016 09:33:01 -0800 (PST) From: Christophe Milard To: anders.roxell@linaro.org, mike.holmes@linaro.org, bill.fischofer@linaro.org, petri.savolainen@linaro.org Date: Mon, 8 Feb 2016 19:31:57 +0100 Message-Id: <1454956317-2519-4-git-send-email-christophe.milard@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1454956317-2519-1-git-send-email-christophe.milard@linaro.org> References: <1454956317-2519-1-git-send-email-christophe.milard@linaro.org> MIME-Version: 1.0 X-Topics: patch Cc: lng-odp@lists.linaro.org Subject: [lng-odp] [API-NEXT PATCHv2 3/3] doc: descr of structure for new interfaces X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" updates of the documentation to reflect the new structure allowing new interface addition. Signed-off-by: Christophe Milard --- doc/implementers-guide/implementers-guide.adoc | 72 +++++++++++++++----------- doc/users-guide/users-guide.adoc | 11 ++-- 2 files changed, 50 insertions(+), 33 deletions(-) diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc index d68354d..1f0dac9 100644 --- a/doc/implementers-guide/implementers-guide.adoc +++ b/doc/implementers-guide/implementers-guide.adoc @@ -18,44 +18,58 @@ The implementers view of the include source tree allows the common API definitions and documentation to be reused by all the platforms defined in the tree, but leave the actual definitions to be defined by the specific platform. -.Implementers include structure +.Implementers include structure (in repository) ---- ./ ├── include/ │   ├── odp/ -│   │   └── api/ <1> -│   │   └── The Public API and the documentation. +│   │ └── api/ +│   │    └── spec/ +│   │    └── The Public API specification and its documentation. <1> │   │ -│   └── odp.h <4> This file should be the only file included by the application. +│   └── odp_api.h This file should be the only file included by the any ODP +│   application. <4> │ -├── platform/ -│   ├── / -│   │   ├── include/ -│   │   │   ├── odp/ <2> -│   │   │   │   ├── In-line function definitions of the public API for this -│   │   │   │ │ platform seen by the application. -│   │   │   │ │ -│   │   │   │   └── plat/ <3> -│   │   │   │     └── Platform specific types, enums etc as seen by the -│   │   │   │ application but require overriding by the -│   │   │   │ implementation. -│   │   │   │   -│   │   │   └── Internal header files seen only by the implementation. +└── platform/ + └── / + └── include/ + ├── Internal header files seen only by the implementation. + └── odp/ + └── api/ <2> + ├── In-line function definitions of the public API for this + │ platform seen by the application. + │ +    └── plat/ <3> +      └── Platform specific types, enums etc as seen by the + application but require overriding by the + implementation. ---- - -<1> The doxygen description of the API definition is held in the public api file -'include/odp/api'. -<2> The public file is included by a counterpart in -'platform//include/odp'. -The include of the public API is AFTER the platform specific definitions to -allow the platform to provide definitions that match the underlying hardware. -<3> The implementation code includes 'platform//include/plat' -and this then provides the source files with a complete definition the ODP API -to be implemented. -<4> Applications in turn include the include/odp.h file which includes the -'platform//include/plat' files to provide a complete +<1> The specification, defining the ODP application programming interface (API) +is held in 'include/odp/api/spec/'. The ODP API is defined by a set of '.h' +files including doxygen documentation. +<2> Each public specification file is included by a counterpart in +'platform//include/odp/api'. +The include of the specification API is AFTER the platform specific definitions +to allow the platform to provide definitions that match the underlying hardware. +<3> The implementation code may include files from +'platform//include/odp/api/plat' +<4> Applications in turn include the include/odp_api.h file which includes the +'platform//include/odp/api' files to provide a complete definition of the API. +After ODP installation (make install), the structure becomes as follows: + +.Installed ODP structure +---- +./ +└── include/ + ├── odp/ + │ └── api/ API In-line for this platform. + │    ├── plat/ API Platform specific types. + │    └── spec/ The public API specification. + └── odp_api.h +---- + == The validation Suite == ODP provides a comprehensive set of API validation tests that are intended to be diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc index 5668a0b..221fb21 100644 --- a/doc/users-guide/users-guide.adoc +++ b/doc/users-guide/users-guide.adoc @@ -462,8 +462,8 @@ _synchronization_ mechanisms. ODP provides APIs to assist in each of these areas. === The include structure -Applications only include the 'include/odp.h' file, which includes the -'platform//include/odp' files to provide a complete +Applications only include the 'include/odp_api.h' file, which includes the +'platform//include/odp/api' files to provide a complete definition of the API on that platform. The doxygen documentation defining the behavior of the ODP API is all contained in the public API files, and the actual definitions for an implementation will be found in the per platform @@ -477,9 +477,12 @@ visible to the application. ├── include/ │   ├── odp/ │   │   └── api/ -│   │   └── The Public API and the documentation. +│   │   └── spec/ +│   │   └── The Public API and the documentation. │   │ -│   └── odp.h This file should be the only file included by the application. +│   │ +│   ├── odp_api.h This file should be the only file included by the +│   │ application. ---- === Initialization