From patchwork Thu Sep 22 19:04:41 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 76809 Delivered-To: patch@linaro.org Received: by 10.140.106.72 with SMTP id d66csp192374qgf; Thu, 22 Sep 2016 12:04:51 -0700 (PDT) X-Received: by 10.55.36.131 with SMTP id k3mr3598256qkk.86.1474571091774; Thu, 22 Sep 2016 12:04:51 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id v4si2217875qkg.52.2016.09.22.12.04.51; Thu, 22 Sep 2016 12:04:51 -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 1EA8E616E1; Thu, 22 Sep 2016 19:04:51 +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=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL 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 59E3260E34; Thu, 22 Sep 2016 19:04:47 +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 44FA260E35; Thu, 22 Sep 2016 19:04:45 +0000 (UTC) Received: from mail-oi0-f50.google.com (mail-oi0-f50.google.com [209.85.218.50]) by lists.linaro.org (Postfix) with ESMTPS id 3CE98608F3 for ; Thu, 22 Sep 2016 19:04:44 +0000 (UTC) Received: by mail-oi0-f50.google.com with SMTP id t83so108980356oie.3 for ; Thu, 22 Sep 2016 12:04:44 -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=i73gCZG5/WXqH/rdcfm8NU7cQVd3X7qfwAVoOkwFrqU=; b=YwdJpQLdZnHJ+VSIqErySdW/QyDYGIrifmagaK6NqzwmjxXbdXzZffde6AEDylEcgj DT8R/9iT67vbLuOOFPs+bXHbs7UPskDxiV3sWSbKi1fsMmRvpzBdkPSPbqIhfi1miRzS k4H8sddPTWPVvR+Q6rKfavRvVWGtr31UR34oeV58m4j2TXX4nd+Wyevz/2uo7jgHhlM6 iJmGTXmK26T1HXgVeeaMnC/2AdKia0gO7PXU4AfbRmzlgcB6JezE2QkossUK4htAhFyo T7uzIdG5+MGFItAE6TcnBz35XUga8bW+V9agT43Gxtm0CtGdKRfn2ICdQNOK+bnkXRYV yoTw== X-Gm-Message-State: AE9vXwNef+SIm/eiwxxoGhD/S/u43TI1/G0m5pZi4oj5J7MyqdpzE3Rv/UaK6VCG8MXxWHK7ess= X-Received: by 10.202.49.212 with SMTP id x203mr4432513oix.81.1474571083613; Thu, 22 Sep 2016 12:04:43 -0700 (PDT) Received: from localhost.localdomain (cpe-70-121-83-241.austin.res.rr.com. [70.121.83.241]) by smtp.gmail.com with ESMTPSA id t71sm932905oit.5.2016.09.22.12.04.42 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 22 Sep 2016 12:04:42 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Thu, 22 Sep 2016 14:04:41 -0500 Message-Id: <1474571081-6925-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCH] linux-generic: ticketlock: add missing doxygen for ticketlock_inlines.h 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" Add the missing internal doxygen documentation for the ticketlock_inlines functions used to accelerate odp-linux even when building with --enable-abi-compat=yes Signed-off-by: Bill Fischofer --- .../include/odp/api/plat/ticketlock_inlines.h | 26 ++++++++++++++++++++++ 1 file changed, 26 insertions(+) -- 2.7.4 diff --git a/platform/linux-generic/include/odp/api/plat/ticketlock_inlines.h b/platform/linux-generic/include/odp/api/plat/ticketlock_inlines.h index 957d22e..87432a7 100644 --- a/platform/linux-generic/include/odp/api/plat/ticketlock_inlines.h +++ b/platform/linux-generic/include/odp/api/plat/ticketlock_inlines.h @@ -18,6 +18,11 @@ #include #include +/** @internal + * Acquire ticket lock. + * + * @param ticketlock Pointer to a ticket lock + */ static inline void _odp_ticketlock_lock(odp_ticketlock_t *ticketlock) { uint32_t ticket; @@ -33,6 +38,14 @@ static inline void _odp_ticketlock_lock(odp_ticketlock_t *ticketlock) odp_cpu_pause(); } +/** @internal + * Try to acquire ticket lock. + * + * @param tklock Pointer to a ticket lock + * + * @retval 1 lock acquired + * @retval 0 lock not acquired + */ static inline int _odp_ticketlock_trylock(odp_ticketlock_t *tklock) { /* We read 'next_ticket' and 'cur_ticket' non-atomically which should @@ -61,6 +74,11 @@ static inline int _odp_ticketlock_trylock(odp_ticketlock_t *tklock) return 0; } +/** @internal + * Release ticket lock + * + * @param ticketlock Pointer to a ticket lock + */ static inline void _odp_ticketlock_unlock(odp_ticketlock_t *ticketlock) { /* Release the lock by incrementing 'cur_ticket'. As we are the @@ -73,6 +91,14 @@ static inline void _odp_ticketlock_unlock(odp_ticketlock_t *ticketlock) odp_atomic_store_rel_u32(&ticketlock->cur_ticket, cur + 1); } +/** @internal + * Check if ticket lock is locked + * + * @param ticketlock Pointer to a ticket lock + * + * @retval 1 the lock is busy (locked) + * @retval 0 the lock is available (unlocked) + */ static inline int _odp_ticketlock_is_locked(odp_ticketlock_t *ticketlock) { /* Compare 'cur_ticket' with 'next_ticket'. Ideally we should read