From patchwork Thu Jan 29 10:40:01 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 43910 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f198.google.com (mail-wi0-f198.google.com [209.85.212.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 27FBF24119 for ; Thu, 29 Jan 2015 10:41:29 +0000 (UTC) Received: by mail-wi0-f198.google.com with SMTP id h11sf11398274wiw.1 for ; Thu, 29 Jan 2015 02:41:28 -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=N7wzSbXGwlZa44YkeHDV5WT4M6Aed6Z5N4dugAzZ1Vw=; b=MoUnszKQVvT3OPB9VCxoDNjMUeNj6Pj3mI5B0k046g3pMWkOELZXqp7v367OUdVdbJ iu8BoUQJRePRxL9KQoOT/n44tXbIBL1HPZPorEzJelfhGTVKxVPfVAP57Zx9FMjWwz86 97llAaMmbcd1abMbYrIiDFwszi7B8E1sylzfagbJXexajJ27ydNrfnEdBSJW5NarD0Om BzQT971hyel5RZ1HNZGguXc88EGk9NEF8At8Vz+c2UOrE8Ng0IRWMbYLeiYOclMFpn/k rMc3LMmNYCmyVPeZMaaqH+T6xkAY7kMnSXrKaZQBApgBzY2tBmfiH4Kc/MNmg9tJCHKp TijA== X-Gm-Message-State: ALoCoQlEK7hsD2QxXreUzOF+hYG4u9C5unD2IN+UHj6VdiBkCGVVdgH8S9U51ORvKE3IqTv/q8T6 X-Received: by 10.180.105.97 with SMTP id gl1mr226338wib.7.1422528088486; Thu, 29 Jan 2015 02:41:28 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.116.106 with SMTP id jv10ls286222lab.93.gmail; Thu, 29 Jan 2015 02:41:28 -0800 (PST) X-Received: by 10.112.148.34 with SMTP id tp2mr69109lbb.94.1422528088267; Thu, 29 Jan 2015 02:41:28 -0800 (PST) Received: from mail-lb0-f180.google.com (mail-lb0-f180.google.com. [209.85.217.180]) by mx.google.com with ESMTPS id m1si6966225lae.105.2015.01.29.02.41.28 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:41:28 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.180 as permitted sender) client-ip=209.85.217.180; Received: by mail-lb0-f180.google.com with SMTP id b6so26503498lbj.11 for ; Thu, 29 Jan 2015 02:41:28 -0800 (PST) X-Received: by 10.152.197.5 with SMTP id iq5mr13474027lac.6.1422528088169; Thu, 29 Jan 2015 02:41:28 -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 h5csp1719585lbj; Thu, 29 Jan 2015 02:41:27 -0800 (PST) X-Received: by 10.140.109.164 with SMTP id l33mr1333qgf.91.1422528086769; Thu, 29 Jan 2015 02:41:26 -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 g17si9657642qgd.123.2015.01.29.02.41.25 (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:41:26 -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 1YGmXL-0007QK-RA; Thu, 29 Jan 2015 10:41:23 +0000 Received: from mail-lb0-f178.google.com ([209.85.217.178]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YGmWP-0007J0-19 for lng-odp@lists.linaro.org; Thu, 29 Jan 2015 10:40:25 +0000 Received: by mail-lb0-f178.google.com with SMTP id u10so26550384lbd.9 for ; Thu, 29 Jan 2015 02:40:19 -0800 (PST) X-Received: by 10.112.156.132 with SMTP id we4mr13267559lbb.59.1422528019509; Thu, 29 Jan 2015 02:40:19 -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.18 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 29 Jan 2015 02:40:18 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Thu, 29 Jan 2015 11:40:01 +0100 Message-Id: <1422528008-29845-10-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: patch Subject: [lng-odp] [PATCH 09/16] api: odp_packet_flags.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.180 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_packet_flags.h | 57 ++++++++++++++-------- 1 file changed, 38 insertions(+), 19 deletions(-) diff --git a/platform/linux-generic/include/api/odp_packet_flags.h b/platform/linux-generic/include/api/odp_packet_flags.h index 24c4065..399a0bf 100644 --- a/platform/linux-generic/include/api/odp_packet_flags.h +++ b/platform/linux-generic/include/api/odp_packet_flags.h @@ -32,7 +32,8 @@ extern "C" { * Checks all error flags at once. * * @param pkt Packet handle - * @return 1 if packet has errors, 0 otherwise + * @retval 1 if packet has errors + * @retval 0 if packet has no errors */ int odp_packet_error(odp_packet_t pkt); @@ -40,7 +41,8 @@ int odp_packet_error(odp_packet_t pkt); * Check if error was 'frame length' error * * @param pkt Packet handle - * @return 1 if frame length error detected, 0 otherwise + * @retval 1 if frame length error detected + * @retval 0 if frame length error not detected */ int odp_packet_errflag_frame_len(odp_packet_t pkt); @@ -48,7 +50,8 @@ int odp_packet_errflag_frame_len(odp_packet_t pkt); * Check for L2 header, e.g. ethernet * * @param pkt Packet handle - * @return 1 if packet contains a valid & known L2 header, 0 otherwise + * @retval 1 if packet contains a valid & known L2 header + * @retval 0 if packet does not contain a valid & known L2 header */ int odp_packet_has_l2(odp_packet_t pkt); @@ -56,7 +59,8 @@ int odp_packet_has_l2(odp_packet_t pkt); * Check for L3 header, e.g. IPv4, IPv6 * * @param pkt Packet handle - * @return 1 if packet contains a valid & known L3 header, 0 otherwise + * @retval 1 if packet contains a valid & known L3 header + * @retval 0 if packet does not contain a valid & known L3 header */ int odp_packet_has_l3(odp_packet_t pkt); @@ -64,7 +68,8 @@ int odp_packet_has_l3(odp_packet_t pkt); * Check for L4 header, e.g. UDP, TCP, SCTP (also ICMP) * * @param pkt Packet handle - * @return 1 if packet contains a valid & known L4 header, 0 otherwise + * @retval 1 if packet contains a valid & known L4 header + * @retval 0 if packet does not contain a valid & known L4 header */ int odp_packet_has_l4(odp_packet_t pkt); @@ -72,7 +77,8 @@ int odp_packet_has_l4(odp_packet_t pkt); * Check for Ethernet header * * @param pkt Packet handle - * @return 1 if packet contains a valid eth header, 0 otherwise + * @retval 1 if packet contains a valid eth header + * @retval 0 if packet does not contain a valid & known eth header */ int odp_packet_has_eth(odp_packet_t pkt); @@ -80,7 +86,8 @@ int odp_packet_has_eth(odp_packet_t pkt); * Check for jumbo frame * * @param pkt Packet handle - * @return 1 if packet contains jumbo frame, 0 otherwise + * @retval 1 if packet contains a jumbo frame + * @retval 0 if packet does not contain a jumbo frame */ int odp_packet_has_jumbo(odp_packet_t pkt); @@ -88,7 +95,8 @@ int odp_packet_has_jumbo(odp_packet_t pkt); * Check for VLAN * * @param pkt Packet handle - * @return 1 if packet contains a VLAN header, 0 otherwise + * @retval 1 if packet contains a VLAN header + * @retval 0 if packet does not contain a VLAN header */ int odp_packet_has_vlan(odp_packet_t pkt); @@ -96,7 +104,8 @@ int odp_packet_has_vlan(odp_packet_t pkt); * Check for VLAN QinQ (stacked VLAN) * * @param pkt Packet handle - * @return 1 if packet contains a VLAN QinQ header, 0 otherwise + * @retval 1 if packet contains a VLAN QinQ header + * @retval 0 if packet does not contain a VLAN QinQ header */ int odp_packet_has_vlan_qinq(odp_packet_t pkt); @@ -104,7 +113,8 @@ int odp_packet_has_vlan_qinq(odp_packet_t pkt); * Check for ARP * * @param pkt Packet handle - * @return 1 if packet contains an ARP header, 0 otherwise + * @retval 1 if packet contains an ARP message + * @retval 0 if packet does not contain an ARP message */ int odp_packet_has_arp(odp_packet_t pkt); @@ -112,7 +122,8 @@ int odp_packet_has_arp(odp_packet_t pkt); * Check for IPv4 * * @param pkt Packet handle - * @return 1 if packet contains an IPv4 header, 0 otherwise + * @retval 1 if packet contains an IPv4 header + * @retval 0 if packet does not contain an IPv4 header */ int odp_packet_has_ipv4(odp_packet_t pkt); @@ -120,7 +131,8 @@ int odp_packet_has_ipv4(odp_packet_t pkt); * Check for IPv6 * * @param pkt Packet handle - * @return 1 if packet contains an IPv6 header, 0 otherwise + * @retval 1 if packet contains an IPv6 header + * @retval 0 if packet does not contain an IPv6 header */ int odp_packet_has_ipv6(odp_packet_t pkt); @@ -128,7 +140,8 @@ int odp_packet_has_ipv6(odp_packet_t pkt); * Check for IP fragment * * @param pkt Packet handle - * @return 1 if packet is an IP fragment, 0 otherwise + * @retval 1 if packet is an IP fragment + * @retval 0 if packet is not an IP fragment */ int odp_packet_has_ipfrag(odp_packet_t pkt); @@ -136,7 +149,8 @@ int odp_packet_has_ipfrag(odp_packet_t pkt); * Check for IP options * * @param pkt Packet handle - * @return 1 if packet contains IP options, 0 otherwise + * @retval 1 if packet contains IP options + * @retval 0 if packet does not contain IP options */ int odp_packet_has_ipopt(odp_packet_t pkt); @@ -144,7 +158,8 @@ int odp_packet_has_ipopt(odp_packet_t pkt); * Check for IPSec * * @param pkt Packet handle - * @return 1 if packet requires IPSec processing, 0 otherwise + * @retval 1 if packet requires IPSec processing + * @retval 0 if packet does not require IPSec processing */ int odp_packet_has_ipsec(odp_packet_t pkt); @@ -152,7 +167,8 @@ int odp_packet_has_ipsec(odp_packet_t pkt); * Check for UDP * * @param pkt Packet handle - * @return 1 if packet contains a UDP header, 0 otherwise + * @retval 1 if packet contains a UDP header + * @retval 0 if packet does not contain a UDP header */ int odp_packet_has_udp(odp_packet_t pkt); @@ -160,7 +176,8 @@ int odp_packet_has_udp(odp_packet_t pkt); * Check for TCP * * @param pkt Packet handle - * @return 1 if packet contains a TCP header, 0 otherwise + * @retval 1 if packet contains a TCP header + * @retval 0 if packet does not contain a TCP header */ int odp_packet_has_tcp(odp_packet_t pkt); @@ -168,7 +185,8 @@ int odp_packet_has_tcp(odp_packet_t pkt); * Check for SCTP * * @param pkt Packet handle - * @return 1 if packet contains an SCTP header, 0 otherwise + * @retval 1 if packet contains a SCTP header + * @retval 0 if packet does not contain a SCTP header */ int odp_packet_has_sctp(odp_packet_t pkt); @@ -176,7 +194,8 @@ int odp_packet_has_sctp(odp_packet_t pkt); * Check for ICMP * * @param pkt Packet handle - * @return 1 if packet contains an ICMP header, 0 otherwise + * @retval 1 if packet contains an ICMP header + * @retval 0 if packet does not contain an ICMP header */ int odp_packet_has_icmp(odp_packet_t pkt);