From patchwork Tue Aug 9 08:01:46 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christophe Milard X-Patchwork-Id: 73517 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp337906qga; Tue, 9 Aug 2016 00:02:55 -0700 (PDT) X-Received: by 10.55.175.134 with SMTP id y128mr1085487qke.134.1470726175296; Tue, 09 Aug 2016 00:02:55 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 1si20161376qkj.47.2016.08.09.00.02.55; Tue, 09 Aug 2016 00:02:55 -0700 (PDT) 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; dmarc=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id E1B8461977; Tue, 9 Aug 2016 07:02:54 +0000 (UTC) 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.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, 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 1DEFC61787; Tue, 9 Aug 2016 07:02:50 +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 EBBCC6178F; Tue, 9 Aug 2016 07:02:48 +0000 (UTC) Received: from mail-wm0-f53.google.com (mail-wm0-f53.google.com [74.125.82.53]) by lists.linaro.org (Postfix) with ESMTPS id D7E7761781 for ; Tue, 9 Aug 2016 07:02:47 +0000 (UTC) Received: by mail-wm0-f53.google.com with SMTP id o80so13756276wme.1 for ; Tue, 09 Aug 2016 00:02:47 -0700 (PDT) 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; bh=ilD8NWvSspgJAtD6eOh0H4ntow71YjLlu029Kb16etQ=; b=WIAO4mSNlLi4NVz73H+FJv3rS/078IRBlUpLnduOkDPlXx2zmHYC4OmB7scYRX+EnY Ps/C1byRLHwjyH/eWF/ZVAsD6mo68NMqIXnhE/ejxulBnMRdu2GeVZ+LMWn2BS2s4TlY sC//e8UqkAbcmXP8cxEXPuyofob7ZVJGTD1WFRFHX8uchboQzpIxXg8EmMXid5VPgr88 ODRfSIDjuk9OPmc6+JRz6ruQNNbE64CFZOASoykt4b2KV2Bh+AHZxT4gqoyequ1ipVec B4lUy7y2vmaJOy2z7NXJUlbvRotqVUDk0DKUyR38bvV0lIaSThKBplsYfgE8+pHe5UWO 3dTw== X-Gm-Message-State: AEkoouudTyUXlqX6glJ/DpRCBw/40d1+FT0uk1xqpR9RuXJc5BfbSukdQ2VnzH0P4NjOTcRLYvg= X-Received: by 10.25.169.213 with SMTP id s204mr30230499lfe.57.1470726165234; Tue, 09 Aug 2016 00:02:45 -0700 (PDT) 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 p82sm6347716lfd.15.2016.08.09.00.02.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 09 Aug 2016 00:02:44 -0700 (PDT) From: Christophe Milard To: mike.holmes@linaro.org, maxim.uvarov@linaro.com, bill.fischofer@linaro.org, lng-odp@lists.linaro.org Date: Tue, 9 Aug 2016 10:01:46 +0200 Message-Id: <1470729706-54530-1-git-send-email-christophe.milard@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCHv3] linux-gen: doc: defining the ODP thread 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" Signed-off-by: Christophe Milard Signed-off-by: Mike Holmes --- doc/platform-api-guide/Doxyfile | 1 + doc/platform-api-guide/Makefile.am | 8 ++++- platform/linux-generic/doc/platform_specific.dox | 46 ++++++++++++++++++++++++ 3 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 platform/linux-generic/doc/platform_specific.dox -- 2.7.4 diff --git a/doc/platform-api-guide/Doxyfile b/doc/platform-api-guide/Doxyfile index b87b7b2..93f6edf 100644 --- a/doc/platform-api-guide/Doxyfile +++ b/doc/platform-api-guide/Doxyfile @@ -6,6 +6,7 @@ PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg INPUT = $(SRCDIR)/doc/application-api-guide \ $(SRCDIR)/doc/platform-api-guide \ $(SRCDIR)/include \ + $(SRCDIR)/platform/$(WITH_PLATFORM)/doc \ $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR) diff --git a/doc/platform-api-guide/Makefile.am b/doc/platform-api-guide/Makefile.am index a04c254..27cd902 100644 --- a/doc/platform-api-guide/Makefile.am +++ b/doc/platform-api-guide/Makefile.am @@ -1,5 +1,11 @@ +#If additional documentation is added in the platform include directory but it +#is not in a .h file, it must be included here as an extra part of the +#distribution. + EXTRA_DIST = \ - Doxyfile + Doxyfile \ + $(top_srcdir)/platform/${with_platform}/doc/*.dox + clean-local: rm -rf output diff --git a/platform/linux-generic/doc/platform_specific.dox b/platform/linux-generic/doc/platform_specific.dox new file mode 100644 index 0000000..e116ec6 --- /dev/null +++ b/platform/linux-generic/doc/platform_specific.dox @@ -0,0 +1,46 @@ +/* Copyright (c) 2016, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +* @file platform_specific.dox +* extra linux-generic documentation +*/ + +/** @addtogroup odp_thread + * @par ODP thread + * In this ODP implementation an odp thread is either: + * - a linux process descendant (or same as) the odp instantiation process. + * - a pthread 'member' of a linux process descendant (or same as) the odp + * instantiation process. + */ + +/** + * @fn odp_init_local(odp_instance_t instance, odp_thread_type_t thr_type) + * @note In this ODP implementation odpthreads have to be + * processes descendant of (or same as) the ODP + * instantiation process, or pthreads 'member' of such + * processes. + * @note As ODP instantiation processes cannot be descendants + * of each others, the instance parameter provided + * to odp_init_local() is actually fully defined by these + * requirements: It has to be the value returned by the + * unique call to odp_init_global() made by one single + * acsendant of the current process. + */ + +/** + * @fn odp_init_global(odp_instance_t *instance, + * const odp_init_t *params, + * const odp_platform_init_t *platform_params) + * @note This ODP implementation supports mupliple instances of ODP + * (i.e. multiple call to odp_init_global()) with the following + * restrictions: + * @note -Different ODP instances cannot share the same instantiation + * process. In other words, a single process may + * only call odp_init_global() once. + * @note -Different ODP instantiation processes cannot be descendant of + * each other. + */