From patchwork Wed Dec 3 14:17:32 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 41845 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f69.google.com (mail-la0-f69.google.com [209.85.215.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 3331C25E88 for ; Wed, 3 Dec 2014 14:18:21 +0000 (UTC) Received: by mail-la0-f69.google.com with SMTP id ge10sf6090495lab.8 for ; Wed, 03 Dec 2014 06:18:19 -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=xP6l80JDFSYdGNX2FO77jlBNVMPuA9aoiV04ur2tnHA=; b=StMbJ/Tj1Z8JIwZDmwSPjRbPPp0C2bhUo12xdzrOp6IiuteOh+JNz7V10H+h4j++Xw YTm1qrQFATMDPjJ46r+hTnR0cTqS07kuDbeqQZ6Pezh9kwV2P0gJZuE9vWhW1aa3HrCq BhRioudWsGzNppXfuIw4VsVolBtqrf3KxW4BzWt6kT92YgHf/I6ltdveplvpagNAy0ys Nu4nPDoqMPepfTNcTHOUlNpnQlAPaHGVthEJXzt08oNEkjSr4yezfvTIZzv8Sna7cdFC 2E9XHtPL9W6mwff64MPbxBQO14v+3LVUiULKM8JP1lEbnBDNUTcBUKT0zbpq1dlM7ZYy 4cMQ== X-Gm-Message-State: ALoCoQncFOamjUhIVHaSDX+5q9vWqwUElEDRrvzNNFdlqAEYfVSwF7lEwILGwfOLBfL3fYE4JySG X-Received: by 10.152.8.67 with SMTP id p3mr1133060laa.4.1417616299819; Wed, 03 Dec 2014 06:18:19 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.30.42 with SMTP id p10ls125494lah.98.gmail; Wed, 03 Dec 2014 06:18:19 -0800 (PST) X-Received: by 10.112.134.193 with SMTP id pm1mr4432968lbb.93.1417616299541; Wed, 03 Dec 2014 06:18:19 -0800 (PST) Received: from mail-lb0-f178.google.com (mail-lb0-f178.google.com. [209.85.217.178]) by mx.google.com with ESMTPS id ue9si23190946lbb.41.2014.12.03.06.18.19 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 03 Dec 2014 06:18:19 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.178 as permitted sender) client-ip=209.85.217.178; Received: by mail-lb0-f178.google.com with SMTP id f15so13716692lbj.9 for ; Wed, 03 Dec 2014 06:18:19 -0800 (PST) X-Received: by 10.112.14.69 with SMTP id n5mr4573289lbc.34.1417616299343; Wed, 03 Dec 2014 06:18:19 -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 ew9csp672008lbc; Wed, 3 Dec 2014 06:18:18 -0800 (PST) X-Received: by 10.236.17.129 with SMTP id j1mr5339221yhj.143.1417616297149; Wed, 03 Dec 2014 06:18:17 -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 n9si28042412qac.13.2014.12.03.06.18.16 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 03 Dec 2014 06:18:17 -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 1XwAkw-0003L7-TK; Wed, 03 Dec 2014 14:18:14 +0000 Received: from mail-la0-f46.google.com ([209.85.215.46]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XwAkW-0003Cw-J7 for lng-odp@lists.linaro.org; Wed, 03 Dec 2014 14:17:48 +0000 Received: by mail-la0-f46.google.com with SMTP id q1so7556291lam.5 for ; Wed, 03 Dec 2014 06:17:43 -0800 (PST) X-Received: by 10.152.2.41 with SMTP id 9mr4361995lar.47.1417616263024; Wed, 03 Dec 2014 06:17:43 -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.42 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 03 Dec 2014 06:17:42 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Wed, 3 Dec 2014 15:17:32 +0100 Message-Id: <1417616254-31760-5-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 4/6] api:odp_spinlock.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.178 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_spinlock.h | 42 ++++++++++++----------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/platform/linux-generic/include/api/odp_spinlock.h b/platform/linux-generic/include/api/odp_spinlock.h index 7c299c8..993413d 100644 --- a/platform/linux-generic/include/api/odp_spinlock.h +++ b/platform/linux-generic/include/api/odp_spinlock.h @@ -22,60 +22,62 @@ extern "C" { #include /** @addtogroup odp_synchronizers - * Operations on spinlock. + * Operations on spin locks. * @{ */ /** - * ODP spinlock + * ODP spinlock type */ typedef struct odp_spinlock_t { - char lock; /**< @private Lock */ + char lock; /**< @private lock flag, should match odp_atomic_flag_t */ } odp_spinlock_t; /** - * Init spinlock + * Initialize spin lock. * - * @param spinlock Spinlock + * @param[out] p_splck Pointer to a spin lock */ -void odp_spinlock_init(odp_spinlock_t *spinlock); +void odp_spinlock_init(odp_spinlock_t *p_splck); /** - * Lock spinlock + * Acquire spin lock. * - * @param spinlock Spinlock + * @param[in,out] p_splck Pointer to a spin lock */ -void odp_spinlock_lock(odp_spinlock_t *spinlock); +void odp_spinlock_lock(odp_spinlock_t *p_splck); /** - * Try to lock spinlock + * Try to acquire spin lock. * - * @param spinlock Spinlock + * @param[in,out] p_splck Pointer to a spin lock * - * @return 1 if the lock was taken, otherwise 0. + * @retval 1 lock aquired + * @retval 0 lock not acquired */ -int odp_spinlock_trylock(odp_spinlock_t *spinlock); +int odp_spinlock_trylock(odp_spinlock_t *p_splck); /** - * Unlock spinlock + * Release spin lock. * - * @param spinlock Spinlock + * @param[in,out] p_splck Pointer to a spin lock */ -void odp_spinlock_unlock(odp_spinlock_t *spinlock); +void odp_spinlock_unlock(odp_spinlock_t *p_splck); /** - * Test if spinlock is locked + * Check if spin lock is busy (locked). * - * @param spinlock Spinlock + * @param[in] p_splck Pointer to a spin lock * - * @return 1 if the lock is locked, otherwise 0. + * @retval 1 lock busy (locked) + * @retval 0 lock not busy. */ -int odp_spinlock_is_locked(odp_spinlock_t *spinlock); +int odp_spinlock_is_locked(odp_spinlock_t *p_splck);