From patchwork Wed Dec 3 14:17:30 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 41844 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ee0-f70.google.com (mail-ee0-f70.google.com [74.125.83.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 3A00D25E88 for ; Wed, 3 Dec 2014 14:18:09 +0000 (UTC) Received: by mail-ee0-f70.google.com with SMTP id b57sf9736608eek.5 for ; Wed, 03 Dec 2014 06:18:08 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:subject:precedence:list-id:list-unsubscribe:list-archive :list-post:list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=vHy9sv7cFGzNJKDgSoKlWZlIPKqvfwZ8svrYVW+IZX8=; b=MkH85DN1YtC+5fUFhKc4Mr+HK1gwN2UEqoRGcuWEdigJLfyNTmJFZxrz1UavjzbWoE LZFjAwSZlT2svZWNB1ZxDYiwTICfYWWJBmoNaxTb0XHkodN5suKPO0XGaZKM3850Yt/b N3sv+H/sapL54NoqVq86rVjpTy2RDeNLUL83RL/cZcbOb6s4Z+Q1D2f/IM/ofEUG/S+S 5rSRJImRaH6PBmsrLqhD2Za1+e5i2oCCsABG9NPuGoyUWPTqzQJ11lGNNuKghukGU8cP 3t9oO63VIjNX6iOUly8CC5N9Xul+PnaX95hp9LVmQDP5JQdvgbyZXisY/U/YViXz4UgT E4sw== X-Gm-Message-State: ALoCoQmu8AcFHSr6IGoP+pJAkC7Uwr7S2xtHVOElkA06g2bkUKmi0iuOnmoReV7BX8k6K1w+sJqz X-Received: by 10.180.85.72 with SMTP id f8mr13519369wiz.0.1417616288172; Wed, 03 Dec 2014 06:18:08 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.120.2 with SMTP id ky2ls170521lab.9.gmail; Wed, 03 Dec 2014 06:18:07 -0800 (PST) X-Received: by 10.152.23.201 with SMTP id o9mr4464075laf.75.1417616287883; Wed, 03 Dec 2014 06:18:07 -0800 (PST) Received: from mail-lb0-f172.google.com (mail-lb0-f172.google.com. [209.85.217.172]) by mx.google.com with ESMTPS id sf5si23182525lbb.46.2014.12.03.06.18.07 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 03 Dec 2014 06:18:07 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.172 as permitted sender) client-ip=209.85.217.172; Received: by mail-lb0-f172.google.com with SMTP id u10so12408309lbd.17 for ; Wed, 03 Dec 2014 06:18:07 -0800 (PST) X-Received: by 10.112.138.137 with SMTP id qq9mr4492529lbb.80.1417616287798; Wed, 03 Dec 2014 06:18:07 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.184.201 with SMTP id ew9csp671981lbc; Wed, 3 Dec 2014 06:18:06 -0800 (PST) X-Received: by 10.170.54.76 with SMTP id 73mr7269693ykw.0.1417616286438; Wed, 03 Dec 2014 06:18:06 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id q6si27973750qaq.79.2014.12.03.06.18.05 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 03 Dec 2014 06:18:06 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XwAkl-0003He-Ty; Wed, 03 Dec 2014 14:18:03 +0000 Received: from mail-la0-f54.google.com ([209.85.215.54]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XwAkU-0003C6-V8 for lng-odp@lists.linaro.org; Wed, 03 Dec 2014 14:17:47 +0000 Received: by mail-la0-f54.google.com with SMTP id pv20so7955659lab.13 for ; Wed, 03 Dec 2014 06:17:41 -0800 (PST) X-Received: by 10.153.8.137 with SMTP id dk9mr4634935lad.82.1417616261290; Wed, 03 Dec 2014 06:17:41 -0800 (PST) Received: from macmini.lan (84-217-193-77.tn.glocalnet.net. [84.217.193.77]) by mx.google.com with ESMTPSA id or5sm6483330lbb.42.2014.12.03.06.17.40 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 03 Dec 2014 06:17:40 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Wed, 3 Dec 2014 15:17:30 +0100 Message-Id: <1417616254-31760-3-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1417616254-31760-1-git-send-email-ola.liljedahl@linaro.org> References: <1417616254-31760-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 2/6] api:odp_barrier.h: Update doxygen comments, renaming of function params X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: ola.liljedahl@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.172 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Ola Liljedahl --- Update doxygen comments, renaming of function params. platform/linux-generic/include/api/odp_barrier.h | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/platform/linux-generic/include/api/odp_barrier.h b/platform/linux-generic/include/api/odp_barrier.h index 1790ea3..27a17d2 100644 --- a/platform/linux-generic/include/api/odp_barrier.h +++ b/platform/linux-generic/include/api/odp_barrier.h @@ -23,12 +23,12 @@ extern "C" { #include /** @addtogroup odp_synchronizers - * Barrier between threads. + * Synchronize threads. * @{ */ /** - * ODP execution barrier + * ODP thread synchronization barrier */ typedef struct odp_barrier_t { uint32_t count; /**< @private Thread count */ @@ -37,20 +37,24 @@ typedef struct odp_barrier_t { /** - * Init barrier with thread count + * Initialize barrier with thread count. * - * @param barrier Barrier - * @param count Thread count + * @param[out] p_barr Pointer to a barrier variable + * @param[in] count Thread count */ -void odp_barrier_init(odp_barrier_t *barrier, int count); +void odp_barrier_init(odp_barrier_t *p_barr, int count); /** - * Synchronise thread execution on barrier + * Synchronize thread execution on barrier. + * Wait for all threads to arrive at the barrier until they are let loose again. + * Threads will block (spin) until the last thread has arrived at the barrier. + * All memory operations before the odp_barrier_wait() call will be visible + * to all threads when they leave the barrier. * - * @param barrier Barrier + * @param[in,out] p_barr Pointer to a barrier variable */ -void odp_barrier_wait(odp_barrier_t *barrier); +void odp_barrier_wait(odp_barrier_t *p_barr); /** * @}