From patchwork Thu Jul 28 11:59:35 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christophe Milard X-Patchwork-Id: 72944 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp784158qga; Thu, 28 Jul 2016 04:00:53 -0700 (PDT) X-Received: by 10.200.56.35 with SMTP id q32mr55831931qtb.32.1469703653633; Thu, 28 Jul 2016 04:00:53 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id r35si7600186qtc.48.2016.07.28.04.00.52; Thu, 28 Jul 2016 04:00:53 -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 C0B05685CB; Thu, 28 Jul 2016 11:00:52 +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 1747B68043; Thu, 28 Jul 2016 11:00:49 +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 4B094680AE; Thu, 28 Jul 2016 11:00:47 +0000 (UTC) Received: from mail-lf0-f41.google.com (mail-lf0-f41.google.com [209.85.215.41]) by lists.linaro.org (Postfix) with ESMTPS id 53FDA68041 for ; Thu, 28 Jul 2016 11:00:45 +0000 (UTC) Received: by mail-lf0-f41.google.com with SMTP id l69so46787130lfg.1 for ; Thu, 28 Jul 2016 04:00:45 -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=tFLNQaIAyf+00/jAmrvrNSui1md1lf0Jw/VeIsulwHM=; b=N6nI7vCBZ7SlDcdeEyeErI65CN++PP3C4K3Gr97j9NTkBR047JeuNoLLdWpf/A5snJ 5Z3edTangRGDkjmSWKHiR4niymYggbfDApp2RHoypcEWXtX/Gzrh2RdOCwb0Isw3lTiT NPk4pP1s3s69MM3YvqY26dfZGfJlbrrPlS7QkDOqCjtzhypaaMtLGipk6hTKSw137IK4 Dmkm377rnNV0ykCZWP/U1C0rGppdw8WNeh1O9mraMEcbMLaPw664kf/0sx3kL0JukZVC FX112jLCcdBftP57jGvWIdB8mabo4f0ApWKB1KuluQAYEr2vB1lHe2guHC5HrNxMr8MX 0RRg== X-Gm-Message-State: AEkoouuPaI9gw7lsqmeV1nShkW9QrEhDsPGY6cvghrSnNy9wCyw99p5sKVs8AQThmZsuggXZTZg= X-Received: by 10.25.168.212 with SMTP id r203mr14933350lfe.85.1469703644052; Thu, 28 Jul 2016 04:00:44 -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 19sm1862622ljj.2.2016.07.28.04.00.42 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 28 Jul 2016 04:00:43 -0700 (PDT) From: Christophe Milard To: mike.holmes@linaro.org, balakrishna.garapati@linaro.org, lng-odp@lists.linaro.org Date: Thu, 28 Jul 2016 13:59:35 +0200 Message-Id: <1469707175-55370-1-git-send-email-christophe.milard@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCH] 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" Defining an odp thread for the linux generic implementation of ODP. Signed-off-by: Christophe Milard --- .../include/odp/api/platform_specific.dox | 46 ++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 platform/linux-generic/include/odp/api/platform_specific.dox -- 2.7.4 diff --git a/platform/linux-generic/include/odp/api/platform_specific.dox b/platform/linux-generic/include/odp/api/platform_specific.dox new file mode 100644 index 0000000..e116ec6 --- /dev/null +++ b/platform/linux-generic/include/odp/api/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. + */