From patchwork Thu Jan 28 10:32:34 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Christophe Milard X-Patchwork-Id: 60692 Delivered-To: patch@linaro.org Received: by 10.112.130.2 with SMTP id oa2csp363071lbb; Thu, 28 Jan 2016 01:37:37 -0800 (PST) X-Received: by 10.141.4.139 with SMTP id g133mr2348370qhd.34.1453973856936; Thu, 28 Jan 2016 01:37:36 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id v64si10730291qhv.61.2016.01.28.01.37.36; Thu, 28 Jan 2016 01:37:36 -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 73A766194F; Thu, 28 Jan 2016 09:37:36 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=hidm5Iaz; 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 6C8AF6195A; Thu, 28 Jan 2016 09:34:45 +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 0996F6196B; Thu, 28 Jan 2016 09:34:35 +0000 (UTC) Received: from mail-lf0-f46.google.com (mail-lf0-f46.google.com [209.85.215.46]) by lists.linaro.org (Postfix) with ESMTPS id 25BB1617C0 for ; Thu, 28 Jan 2016 09:34:27 +0000 (UTC) Received: by mail-lf0-f46.google.com with SMTP id s81so23087792lfd.0 for ; Thu, 28 Jan 2016 01:34:27 -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=ZVaJPxIQnuFAWR3eYqR1ZXUK3CiniBdbkufIVhUj5P4=; b=hidm5IazVAGBOXQQR2udPY3tPHZwpqKtUGhplGa6BeTHfr4k9/IVdfuwnuv+k1TYiK NG8dZj/z4ziFFskYGR5QfO1VLvxDQSpyEp1FRMCHlr3g982AIJqMwRe6TwiGYMGYU+1J VvRCn3os8nZ61URawVZpEJ897/QeW+npSKPN0= 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=ZVaJPxIQnuFAWR3eYqR1ZXUK3CiniBdbkufIVhUj5P4=; b=R48Le39rfgHBkypgrnMCFeRPWkME2TtEm1nRzZfyCFLW7HMVuyMlmgQn2mgFzdfn85 oBG3PytP5rKKRSipVY6PbiPExVyd2EzkIo5UUw27UY+l6cYFNk2Nh9/mIqBrWAjafnT6 gmOEPz/tpgtX9Ux+wxDt3C9rHRVwc3eFfcBFkx1EYXHnTqg0PPNG9T4ZNmsS+3U5WEcR Odm7W+5vtYgF3noUA8MWEresddT5RZkMR+sFLCPrPz3PqDkrTTY8R8SnZOg6EK1TgL6G UuNxEWZXviPT0Dq7le0RHvO63twF2DcJaEmdGnzgc+oTIXA/LgPqKfb8nlryddWiM0M2 GOgA== X-Gm-Message-State: AG10YOTowzFLBjp4kEhevi/J5ZFz8HVCYA7Q1HWhQCa59L62zHRAyT1PLmnFfUnkwtPPqSBU578= X-Received: by 10.25.131.150 with SMTP id f144mr750431lfd.155.1453973666035; Thu, 28 Jan 2016 01:34:26 -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 ax1sm1332993lbc.20.2016.01.28.01.34.25 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 28 Jan 2016 01:34:25 -0800 (PST) From: Christophe Milard To: anders.roxell@linaro.org, mike.holmes@linaro.org, bill.fischofer@linaro.org, petri.savolainen@linaro.org Date: Thu, 28 Jan 2016 11:32:34 +0100 Message-Id: <1453977154-55935-4-git-send-email-christophe.milard@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1453977154-55935-1-git-send-email-christophe.milard@linaro.org> References: <1453977154-55935-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 PATCH 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 | 76 +++++++++++++++----------- doc/users-guide/users-guide.adoc | 15 +++-- 2 files changed, 54 insertions(+), 37 deletions(-) diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc index d68354d..328728d 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. -│   │ -│   └── odp.h <4> This file should be the only file included by the application. +│   └── odp/ +│   ├── api/ +│   │   └── spec/ +│   │   └── The Public API specification and its documentation. <1> +│   │ +│   └── 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. + └── 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..b6cec87 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 @@ -476,10 +476,13 @@ visible to the application. ./ ├── include/ │   ├── odp/ -│   │   └── api/ -│   │   └── The Public API and the documentation. -│   │ -│   └── odp.h This file should be the only file included by the application. +│   │   ├── api/ +│   │   │ └── spec/ +│   │   │ └── The Public API and the documentation. +│   │ │ +│   │ │ +│   │ └── api.h This file should be the only file included by the +│   │ application. ---- === Initialization