From patchwork Wed Apr 15 17:52:28 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 47232 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f200.google.com (mail-wi0-f200.google.com [209.85.212.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 687D32121F for ; Wed, 15 Apr 2015 17:54:13 +0000 (UTC) Received: by widjs5 with SMTP id js5sf13242501wid.3 for ; Wed, 15 Apr 2015 10:54:12 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to: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=3B9mHHXH33zycTx5saeoh3raSezRXuVaJ7Mtag3bK8g=; b=PHO0T8HZqft0e7sxH0otIF8KPHmPXC9ldTXTPjggydqD21CdzW+msLOLOF33TTGH+d NtN91u7rvsUGe2orPEFvwglsbrzhN9pGuVH1V+PkqD79RwZfmABowi4XdMQsNSo0Zg1J ust6qgosAVWUdBCmqd2hs+HduugaL/IWbBVHMZ81p5G5PEzBLqVwHVsVENWsKd+MQ8J2 OK693VOtFOHqAAn+NUEceFfeBu18tquCkEcok0WYChYaaGnj++qeb3c3XyRrE/Tisns2 pOtavIJg2EmTWySe+B9iDp/GmA5tG673ldwdXVz2yP8hlbFDXKKDVTLoDTeV1AfRqNci FKdA== X-Gm-Message-State: ALoCoQn/yk7utyEDFAjhpsz/DXPB414hdrnu5ekXCxtP5ENxko8gLDTUM4dsUk/zsLaYiklw7s+z X-Received: by 10.194.178.67 with SMTP id cw3mr5873463wjc.2.1429120452476; Wed, 15 Apr 2015 10:54:12 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.197.97 with SMTP id it1ls239094lac.1.gmail; Wed, 15 Apr 2015 10:54:12 -0700 (PDT) X-Received: by 10.112.171.101 with SMTP id at5mr25062024lbc.66.1429120452308; Wed, 15 Apr 2015 10:54:12 -0700 (PDT) Received: from mail-lb0-f171.google.com (mail-lb0-f171.google.com. [209.85.217.171]) by mx.google.com with ESMTPS id b17si4454184lbo.82.2015.04.15.10.54.12 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 15 Apr 2015 10:54:12 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.171 as permitted sender) client-ip=209.85.217.171; Received: by lbcga7 with SMTP id ga7so40175751lbc.1 for ; Wed, 15 Apr 2015 10:54:12 -0700 (PDT) X-Received: by 10.152.116.11 with SMTP id js11mr25032385lab.106.1429120452169; Wed, 15 Apr 2015 10:54:12 -0700 (PDT) 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.67.65 with SMTP id l1csp2663656lbt; Wed, 15 Apr 2015 10:54:11 -0700 (PDT) X-Received: by 10.140.43.100 with SMTP id d91mr18233783qga.77.1429120450505; Wed, 15 Apr 2015 10:54:10 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 38si5394384qkq.9.2015.04.15.10.54.09; Wed, 15 Apr 2015 10:54:10 -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; Received: by lists.linaro.org (Postfix, from userid 109) id A50BA61F57; Wed, 15 Apr 2015 17:54:09 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 41B3B61D5A; Wed, 15 Apr 2015 17:53:52 +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 EC60661E95; Wed, 15 Apr 2015 17:53:45 +0000 (UTC) Received: from mail-qk0-f178.google.com (mail-qk0-f178.google.com [209.85.220.178]) by lists.linaro.org (Postfix) with ESMTPS id D045B61F56 for ; Wed, 15 Apr 2015 17:53:08 +0000 (UTC) Received: by qkgx75 with SMTP id x75so88938691qkg.1 for ; Wed, 15 Apr 2015 10:53:08 -0700 (PDT) X-Received: by 10.55.49.147 with SMTP id x141mr54565540qkx.23.1429120355450; Wed, 15 Apr 2015 10:52:35 -0700 (PDT) Received: from mike-desktop.?.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id d11sm3665744qgd.31.2015.04.15.10.52.34 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 15 Apr 2015 10:52:35 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 15 Apr 2015 13:52:28 -0400 Message-Id: <1429120348-8213-3-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 In-Reply-To: <1429120348-8213-1-git-send-email-mike.holmes@linaro.org> References: <1429120348-8213-1-git-send-email-mike.holmes@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 3/3] helper: doxygen: group packet headers logically X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 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" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@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.171 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 The headers are all closely related but do not appear that way in the documentation, gather them together Signed-off-by: Mike Holmes --- helper/include/odp/helper/eth.h | 8 ++++++++ helper/include/odp/helper/icmp.h | 8 ++++++++ helper/include/odp/helper/ip.h | 7 +++++++ helper/include/odp/helper/ipsec.h | 8 ++++++++ helper/include/odp/helper/tcp.h | 9 +++++++++ helper/include/odp/helper/udp.h | 9 +++++++++ 6 files changed, 49 insertions(+) diff --git a/helper/include/odp/helper/eth.h b/helper/include/odp/helper/eth.h index 4d0f715..f1c164d 100644 --- a/helper/include/odp/helper/eth.h +++ b/helper/include/odp/helper/eth.h @@ -23,6 +23,10 @@ extern "C" { #include #include +/** @addtogroup odph_header ODPH HEADER + * @{ + */ + #define ODPH_ETHADDR_LEN 6 /**< Ethernet address length */ #define ODPH_ETHHDR_LEN 14 /**< Ethernet header length */ #define ODPH_VLANHDR_LEN 4 /**< VLAN header length */ @@ -80,6 +84,10 @@ _ODP_STATIC_ASSERT(sizeof(odph_vlanhdr_t) == ODPH_VLANHDR_LEN, "ODPH_VLANHDR_T__ #define ODPH_ETHTYPE_MACSEC 0x88E5 /**< MAC security IEEE 802.1AE */ #define ODPH_ETHTYPE_1588 0x88F7 /**< Precision Time Protocol IEEE 1588 */ +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/helper/include/odp/helper/icmp.h b/helper/include/odp/helper/icmp.h index 476af02..abcf818 100644 --- a/helper/include/odp/helper/icmp.h +++ b/helper/include/odp/helper/icmp.h @@ -22,6 +22,10 @@ extern "C" { #include #include +/** @addtogroup odph_header ODPH HEADER + * @{ + */ + /** ICMP header length */ #define ODPH_ICMPHDR_LEN 8 @@ -92,6 +96,10 @@ typedef struct ODP_PACKED { /** @internal Compile time assert */ _ODP_STATIC_ASSERT(sizeof(odph_icmphdr_t) == ODPH_ICMPHDR_LEN, "ODPH_ICMPHDR_T__SIZE_ERROR"); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/helper/include/odp/helper/ip.h b/helper/include/odp/helper/ip.h index 95fabe3..627c82d 100644 --- a/helper/include/odp/helper/ip.h +++ b/helper/include/odp/helper/ip.h @@ -25,6 +25,10 @@ extern "C" { #include +/** @addtogroup odph_header ODPH HEADER + * @{ + */ + #define ODPH_IPV4 4 /**< IP version 4 */ #define ODPH_IPV4HDR_LEN 20 /**< Min length of IP header (no options) */ #define ODPH_IPV4HDR_IHL_MIN 5 /**< Minimum IHL value*/ @@ -171,6 +175,9 @@ typedef struct ODP_PACKED { /**@}*/ +/** + * @} + */ #ifdef __cplusplus } #endif diff --git a/helper/include/odp/helper/ipsec.h b/helper/include/odp/helper/ipsec.h index 70c6b9c..2565f74 100644 --- a/helper/include/odp/helper/ipsec.h +++ b/helper/include/odp/helper/ipsec.h @@ -23,6 +23,10 @@ extern "C" { #include #include +/** @addtogroup odph_header ODPH HEADER + * @{ + */ + #define ODPH_ESPHDR_LEN 8 /**< IPSec ESP header length */ #define ODPH_ESPTRL_LEN 2 /**< IPSec ESP trailer length */ #define ODPH_AHHDR_LEN 12 /**< IPSec AH header length */ @@ -66,6 +70,10 @@ typedef struct ODP_PACKED { /** @internal Compile time assert */ _ODP_STATIC_ASSERT(sizeof(odph_ahhdr_t) == ODPH_AHHDR_LEN, "ODPH_AHHDR_T__SIZE_ERROR"); +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/helper/include/odp/helper/tcp.h b/helper/include/odp/helper/tcp.h index 0d9ec18..defe422 100644 --- a/helper/include/odp/helper/tcp.h +++ b/helper/include/odp/helper/tcp.h @@ -22,6 +22,11 @@ extern "C" { #include #include +/** @addtogroup odph_header ODPH HEADER + * @{ + */ + + /** TCP header */ typedef struct ODP_PACKED { uint16be_t src_port; /**< Source port */ @@ -74,6 +79,10 @@ typedef struct ODP_PACKED { uint16be_t urgptr; /**< Urgent pointer */ } odph_tcphdr_t; +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/helper/include/odp/helper/udp.h b/helper/include/odp/helper/udp.h index 99a96f2..866145a 100644 --- a/helper/include/odp/helper/udp.h +++ b/helper/include/odp/helper/udp.h @@ -22,6 +22,11 @@ extern "C" { #include #include + +/** @addtogroup odph_header ODPH HEADER + * @{ + */ + /** UDP header length */ #define ODPH_UDPHDR_LEN 8 @@ -95,6 +100,10 @@ static inline uint16_t odph_ipv4_udp_chksum(odp_packet_t pkt) /** @internal Compile time assert */ _ODP_STATIC_ASSERT(sizeof(odph_udphdr_t) == ODPH_UDPHDR_LEN, "ODPH_UDPHDR_T__SIZE_ERROR"); +/** + * @} + */ + #ifdef __cplusplus } #endif