From patchwork Thu Jan 29 10:39:58 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 43908 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id E909024119 for ; Thu, 29 Jan 2015 10:41:00 +0000 (UTC) Received: by mail-lb0-f197.google.com with SMTP id b6sf18147940lbj.0 for ; Thu, 29 Jan 2015 02:40:59 -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=Ig/Fan0lAGcjtDhXLFugF5aJzSdSIpT/vOJWzXrihok=; b=JK/NGJIM0qNwytl8CMVk3uFi1ZAu34eZSg5IX957uvwL8jXjhb/GLQsfRAiBBAr+1E q44zjK6biEiMDVHXXa+6JsfHjlOs1Ipm3XQAj9gVgOXv8si+0861VU6nVgGoVrH08qJm jGcBKLYLfw0nl7F6Vf+a+FHu28gwr9fJZTraCsCCE/Zjyh+LrELda4ZrjOJUFwFF/dmJ 3U3QSYNRXHZOuPH2kJ7j6Gesdv96apEvfqfn7AiP8splymtKIqkYbyzIEbTdCrxgQJES r1lCkme9qryKIQ7nWqj7ujxrzzuERSwAXb9s1KkOjhc/cgQPJpkNhS602ycHlqzMb7Tz +3WQ== X-Gm-Message-State: ALoCoQmro+Vw8fckax3sV7cxHGq1mYZjqbe0W+n53ceQCSOUmgrqleuS7vEEhHjviQzSTTs6+ytD X-Received: by 10.112.30.131 with SMTP id s3mr1696192lbh.13.1422528059922; Thu, 29 Jan 2015 02:40:59 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.43.97 with SMTP id v1ls297452lal.29.gmail; Thu, 29 Jan 2015 02:40:59 -0800 (PST) X-Received: by 10.112.135.196 with SMTP id pu4mr13469639lbb.41.1422528059701; Thu, 29 Jan 2015 02:40:59 -0800 (PST) Received: from mail-lb0-f177.google.com (mail-lb0-f177.google.com. [209.85.217.177]) by mx.google.com with ESMTPS id a4si6941786lbg.132.2015.01.29.02.40.59 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:40:59 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.177 as permitted sender) client-ip=209.85.217.177; Received: by mail-lb0-f177.google.com with SMTP id p9so26557472lbv.8 for ; Thu, 29 Jan 2015 02:40:59 -0800 (PST) X-Received: by 10.112.180.135 with SMTP id do7mr13226192lbc.23.1422528059591; Thu, 29 Jan 2015 02:40:59 -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.35.133 with SMTP id h5csp1719486lbj; Thu, 29 Jan 2015 02:40:58 -0800 (PST) X-Received: by 10.224.29.209 with SMTP id r17mr17323qac.104.1422528056772; Thu, 29 Jan 2015 02:40:56 -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 g9si9709587qgg.79.2015.01.29.02.40.55 (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:40:56 -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 1YGmWr-0007MZ-PN; Thu, 29 Jan 2015 10:40:53 +0000 Received: from mail-lb0-f171.google.com ([209.85.217.171]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YGmWM-0007Ih-1g for lng-odp@lists.linaro.org; Thu, 29 Jan 2015 10:40:22 +0000 Received: by mail-lb0-f171.google.com with SMTP id u14so26466536lbd.2 for ; Thu, 29 Jan 2015 02:40:16 -0800 (PST) X-Received: by 10.152.5.101 with SMTP id r5mr13356691lar.33.1422528016470; Thu, 29 Jan 2015 02:40:16 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id y11sm2037670lba.5.2015.01.29.02.40.15 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 29 Jan 2015 02:40:15 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Thu, 29 Jan 2015 11:39:58 +0100 Message-Id: <1422528008-29845-7-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422528008-29845-1-git-send-email-ola.liljedahl@linaro.org> References: <1422528008-29845-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: Classification patch Subject: [lng-odp] [PATCH 06/16] api: odp_classification.h: updated return descriptions 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.177 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 Updated doxygen descriptions, particularly the @return/@retval descriptions. No change of implementation necessary. Signed-off-by: Ola Liljedahl --- (This document/code contribution attached is provided under the terms of agreement LES-LTM-21309) .../linux-generic/include/api/odp_classification.h | 48 +++++++++++++--------- 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/platform/linux-generic/include/api/odp_classification.h b/platform/linux-generic/include/api/odp_classification.h index 5b2108a..1291b58 100644 --- a/platform/linux-generic/include/api/odp_classification.h +++ b/platform/linux-generic/include/api/odp_classification.h @@ -79,8 +79,8 @@ typedef enum odp_cos_hdr_flow_fields { * * @param[in] name String intended for debugging purposes. * - * @return Class of service instance identifier, - * or ODP_COS_INVALID on error. + * @return Class of service instance identifier + * @retval ODP_COS_INVALID on failure. */ odp_cos_t odp_cos_create(const char *name); @@ -89,7 +89,8 @@ odp_cos_t odp_cos_create(const char *name); * * @param[in] cos_id class-of-service instance. * - * @return 0 on success, non-zero on error. + * @retval 0 on success + * @retval <0 on failure */ int odp_cos_destroy(odp_cos_t cos_id); @@ -102,7 +103,8 @@ int odp_cos_destroy(odp_cos_t cos_id); * of this specific class of service * will be enqueued. * - * @return 0 on success, non-zero on error. + * @retval 0 on success + * @retval <0 on failure */ int odp_cos_set_queue(odp_cos_t cos_id, odp_queue_t queue_id); @@ -112,7 +114,8 @@ int odp_cos_set_queue(odp_cos_t cos_id, odp_queue_t queue_id); * @param[in] cos_id class-of-service instance. * @param[in] drop_policy Desired packet drop policy for this class. * - * @return 0 on success, non-zero on error. + * @retval 0 on success + * @retval <0 on failure * * @note Optional. */ @@ -127,7 +130,8 @@ int odp_cos_set_drop(odp_cos_t cos_id, odp_drop_e drop_policy); * @param[in] qos_table Values of the Layer-2 QoS header field. * @param[in] cos_table Class-of-service assigned to each of the * allowed Layer-2 QOS levels. - * @return 0 on success, non-zero on error. + * @retval 0 on success + * @retval <0 on failure */ int odp_cos_with_l2_priority(odp_pktio_t pktio_in, uint8_t num_qos, @@ -146,7 +150,8 @@ int odp_cos_with_l2_priority(odp_pktio_t pktio_in, * @param[in] l3_preference when true, Layer-3 QoS overrides * L2 QoS when present. * - * @return 0 on success, non-zero on error. + * @retval 0 on success + * @retval <0 on failure * * @note Optional. */ @@ -219,7 +224,8 @@ typedef enum odp_pmr_term { * that must match the value size requirement of the * specific term. * - * @return Handle of the matching rule or ODP_PMR_INVAL on error + * @return Handle of the matching rule + * @retval ODP_PMR_INVAL on failure */ odp_pmr_t odp_pmr_create_match(odp_pmr_term_e term, const void *val, @@ -236,7 +242,8 @@ odp_pmr_t odp_pmr_create_match(odp_pmr_term_e term, * that must match the value size requirement of the * specific term. * - * @return Handle of the matching rule or ODP_PMR_INVAL on error + * @return Handle of the matching rule + * @retval ODP_PMR_INVAL on failure * @note: Range is inclusive [val1..val2]. */ odp_pmr_t odp_pmr_create_range(odp_pmr_term_e term, @@ -248,7 +255,8 @@ odp_pmr_t odp_pmr_create_range(odp_pmr_term_e term, * * @param[in] pmr_id Identifier of the PMR to be destroyed * - * @return 0 on success, non-zero or error. + * @retval 0 on success + * @retval <0 on failure */ int odp_pmr_destroy(odp_pmr_t pmr_id); @@ -259,7 +267,8 @@ int odp_pmr_destroy(odp_pmr_t pmr_id); * @param[in] src_pktio pktio to which this PMR is to be applied * @param[in] dst_cos CoS to be assigned by this PMR * - * @return 0 on success, non-zero or error. + * @retval 0 on success + * @retval <0 on failure */ int odp_pktio_pmr_cos(odp_pmr_t pmr_id, odp_pktio_t src_pktio, odp_cos_t dst_cos); @@ -272,7 +281,8 @@ int odp_pktio_pmr_cos(odp_pmr_t pmr_id, * @param[in] dst_cos CoS to be assigned to packets filtered * from src_cos that match pmr_id. * - * @return 0 on success, non-zero on error. + * @retval 0 on success + * @retval <0 on failure */ int odp_cos_pmr_cos(odp_pmr_t pmr_id, odp_cos_t src_cos, odp_cos_t dst_cos); @@ -346,12 +356,10 @@ typedef uint32_t odp_pmr_set_t; * term desired. * @param[out] pmr_set_id Returned handle to the composite rule set. * - * @return Return value may be a positive number - * indicating the number of terms elements + * @return the number of terms elements * that have been successfully mapped to the - * underlying platform classification engine and - * may be in the range from 1 to num_terms, - * or non-zero for error. + * underlying platform classification engine + * @retval <0 on failure */ int odp_pmr_match_set_create(int num_terms, odp_pmr_match_t *terms, odp_pmr_set_t *pmr_set_id); @@ -369,7 +377,8 @@ int odp_pmr_match_set_create(int num_terms, odp_pmr_match_t *terms, * @param[in] pmr_set_id A composite rule-set handle * returned when created. * - * @return 0 on success, non-zero on error. + * @retval 0 on success + * @retval <0 on failure */ int odp_pmr_match_set_destroy(odp_pmr_set_t pmr_set_id); @@ -381,7 +390,8 @@ int odp_pmr_match_set_destroy(odp_pmr_set_t pmr_set_id); * set is to be applied * @param[in] dst_cos CoS to be assigned by this PMR match set * - * @return 0 on success, non-zero or error. + * @retval 0 on success + * @retval <0 on failure */ int odp_pktio_pmr_match_set_cos(odp_pmr_set_t pmr_set_id, odp_pktio_t src_pktio, odp_cos_t dst_cos);