From patchwork Thu Dec 4 15:38:51 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 41941 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f71.google.com (mail-la0-f71.google.com [209.85.215.71]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id BC84E2486D for ; Thu, 4 Dec 2014 15:39:27 +0000 (UTC) Received: by mail-la0-f71.google.com with SMTP id q1sf838205lam.10 for ; Thu, 04 Dec 2014 07:39:26 -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=zv+u24HHZdULoTKdqZ9PYE381NCl+eMW2XFDFFzsBAk=; b=VZSicesfORiMz9ygm6CMkqxiXmnnFseYGJiMEQgidQeuWXpKN8NzBg4T24fDnY32gY p75DDjpLIV8maMaOV9HDarQ4z2nfrTZuTUlvy2e92r6ch9XhCGXt6I8d91QQ6VHgPaf2 5nOkgLyu8dBVAOzGV00sicVGc2ABV9FiM1Xm/MIf4iq3vlQBUW1EE2TfjJmUdoXrX2XI oC33yzFWmIGc0rIqloaTnBVWAX1cO5ouvZkG1KQFoxWPvyqq4+Up+0GA1tEEr7Qvw1Lr tmi3EgsvV6rI1sn38W9GsJ/OQNAM1am1HbItkt11u+tkj3vKHB8bwW4npJJ7I0VOUeHW EU5A== X-Gm-Message-State: ALoCoQlQTk6ERKeK/Oc4yyxYsrCfGV+RJBMxgeMmv7ZhJbIvQPCCH4+UaP4HRGzZOm6mHPb3ahrG X-Received: by 10.112.166.102 with SMTP id zf6mr560283lbb.12.1417707566703; Thu, 04 Dec 2014 07:39:26 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.234.104 with SMTP id ud8ls271100lac.36.gmail; Thu, 04 Dec 2014 07:39:26 -0800 (PST) X-Received: by 10.112.184.70 with SMTP id es6mr10098374lbc.85.1417707566461; Thu, 04 Dec 2014 07:39:26 -0800 (PST) Received: from mail-la0-f54.google.com (mail-la0-f54.google.com. [209.85.215.54]) by mx.google.com with ESMTPS id b8si26296550lbv.37.2014.12.04.07.39.26 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 04 Dec 2014 07:39:26 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.54 as permitted sender) client-ip=209.85.215.54; Received: by mail-la0-f54.google.com with SMTP id pv20so9886938lab.27 for ; Thu, 04 Dec 2014 07:39:26 -0800 (PST) X-Received: by 10.112.138.137 with SMTP id qq9mr10041594lbb.80.1417707566385; Thu, 04 Dec 2014 07:39:26 -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 ew9csp56602lbc; Thu, 4 Dec 2014 07:39:25 -0800 (PST) X-Received: by 10.140.104.169 with SMTP id a38mr17609114qgf.35.1417707565017; Thu, 04 Dec 2014 07:39:25 -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 a5si31754312qat.0.2014.12.04.07.39.24 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 04 Dec 2014 07:39:24 -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 1XwYV1-0004SN-4l; Thu, 04 Dec 2014 15:39:23 +0000 Received: from mail-la0-f48.google.com ([209.85.215.48]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XwYUj-0004PU-UP for lng-odp@lists.linaro.org; Thu, 04 Dec 2014 15:39:06 +0000 Received: by mail-la0-f48.google.com with SMTP id gf13so985266lab.7 for ; Thu, 04 Dec 2014 07:39:00 -0800 (PST) X-Received: by 10.112.141.66 with SMTP id rm2mr10089741lbb.0.1417707540417; Thu, 04 Dec 2014 07:39:00 -0800 (PST) Received: from macmini.lan (84-217-193-77.tn.glocalnet.net. [84.217.193.77]) by mx.google.com with ESMTPSA id zo3sm7411637lbb.10.2014.12.04.07.38.59 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 04 Dec 2014 07:38:59 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Thu, 4 Dec 2014 16:38:51 +0100 Message-Id: <1417707535-7632-3-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1417707535-7632-1-git-send-email-ola.liljedahl@linaro.org> References: <1417707535-7632-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv2 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.215.54 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 Reviewed-by: Bill Fischofer --- (This code contribution is provided under the terms of agreement LES-LTM-21309) Update and unify doxygen comments and function parameter names. 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..423982f 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 barr Pointer to a barrier variable + * @param count Thread count */ -void odp_barrier_init(odp_barrier_t *barrier, int count); +void odp_barrier_init(odp_barrier_t *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 barr Pointer to a barrier variable */ -void odp_barrier_wait(odp_barrier_t *barrier); +void odp_barrier_wait(odp_barrier_t *barr); /** * @}