From patchwork Mon Feb 2 15:42:18 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44154 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-we0-f197.google.com (mail-we0-f197.google.com [74.125.82.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id B8EBD2034D for ; Mon, 2 Feb 2015 15:43:19 +0000 (UTC) Received: by mail-we0-f197.google.com with SMTP id l61sf16826325wev.0 for ; Mon, 02 Feb 2015 07:43:18 -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=C3Gxu9WH72GkQnUoiBj4Hm+o1nX4kDGYhEJp7kItHds=; b=dwY+rO68zovL7pSuimQ/27vZ7QRvSOTRmN7ZkBaXKMAW0vuOlMMgGgBsT4pl/Jsyw1 ZaTxFHG3LVU8lWGZ+eMDL5YdDnBn+6AqZAvYmFj5qtBZYCb9i568SfkgzYDgcT/PiTiZ x2BtpQOxxogi0nwviA4puBy6czYSWjOBCubGaORwcj5DnMF/Oc+SafGX3a4ZnK7QpNt2 pb48O29Ayyy5JsMaQ6k1uG0YeNpvUZH+BXqjorjnkYvE8LwHnis4t7WbSTJ2hjQKIQ1D oh2yf4WYJJ1I4Pg0oX2vS0ygHRFm+3HALiAFGsYfYrGDCVxiUAuf5YqgpJpWkQOTfKPb lOgg== X-Gm-Message-State: ALoCoQkeyG2UW70i/0pJ0tHkSb2yVLZf6yrRfPp6hiBKQuSU3KvCjmwpyp16mJquz/02obqoChlf X-Received: by 10.112.181.198 with SMTP id dy6mr2535609lbc.22.1422891798966; Mon, 02 Feb 2015 07:43:18 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.87.99 with SMTP id w3ls274680laz.2.gmail; Mon, 02 Feb 2015 07:43:18 -0800 (PST) X-Received: by 10.112.37.197 with SMTP id a5mr3389599lbk.19.1422891798755; Mon, 02 Feb 2015 07:43:18 -0800 (PST) Received: from mail-la0-f50.google.com (mail-la0-f50.google.com. [209.85.215.50]) by mx.google.com with ESMTPS id dv9si17232398lbc.63.2015.02.02.07.43.18 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 02 Feb 2015 07:43:18 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.50 as permitted sender) client-ip=209.85.215.50; Received: by mail-la0-f50.google.com with SMTP id hs14so42006650lab.9 for ; Mon, 02 Feb 2015 07:43:18 -0800 (PST) X-Received: by 10.152.2.41 with SMTP id 9mr1332671lar.59.1422891798649; Mon, 02 Feb 2015 07:43:18 -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 h5csp1371814lbj; Mon, 2 Feb 2015 07:43:17 -0800 (PST) X-Received: by 10.224.60.66 with SMTP id o2mr43035529qah.25.1422891797141; Mon, 02 Feb 2015 07:43: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 it2si24731116qcb.3.2015.02.02.07.43.14 (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 02 Feb 2015 07:43: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 1YIJ9c-0001om-FY; Mon, 02 Feb 2015 15:43:12 +0000 Received: from mail-la0-f51.google.com ([209.85.215.51]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YIJ95-0001kk-6A for lng-odp@lists.linaro.org; Mon, 02 Feb 2015 15:42:39 +0000 Received: by mail-la0-f51.google.com with SMTP id ge10so42230307lab.10 for ; Mon, 02 Feb 2015 07:42:33 -0800 (PST) X-Received: by 10.152.29.6 with SMTP id f6mr8788149lah.82.1422891753608; Mon, 02 Feb 2015 07:42:33 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id w1sm4461682lal.49.2015.02.02.07.42.32 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 02 Feb 2015 07:42:33 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Mon, 2 Feb 2015 16:42:18 +0100 Message-Id: <1422891740-5347-8-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422891740-5347-1-git-send-email-ola.liljedahl@linaro.org> References: <1422891740-5347-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: Classification patch Subject: [lng-odp] [PATCHv3 07/18] 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.215.50 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) include/odp/api/classification.h | 48 ++++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/include/odp/api/classification.h b/include/odp/api/classification.h index 5c6636f..35e21cb 100644 --- a/include/odp/api/classification.h +++ b/include/odp/api/classification.h @@ -81,8 +81,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); @@ -91,7 +91,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); @@ -104,7 +105,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); @@ -114,7 +116,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. */ @@ -129,7 +132,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, @@ -148,7 +152,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. */ @@ -221,7 +226,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, @@ -238,7 +244,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, @@ -250,7 +257,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); @@ -261,7 +269,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); @@ -274,7 +283,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); @@ -350,12 +360,10 @@ typedef struct odp_pmr_match_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); @@ -373,7 +381,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); @@ -385,7 +394,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);