From patchwork Fri Apr 25 10:28:35 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Uvarov X-Patchwork-Id: 29051 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-vc0-f197.google.com (mail-vc0-f197.google.com [209.85.220.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id DF8D6202E6 for ; Fri, 25 Apr 2014 10:28:53 +0000 (UTC) Received: by mail-vc0-f197.google.com with SMTP id if11sf13115999vcb.8 for ; Fri, 25 Apr 2014 03:28:53 -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:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=hkr/IMulL/cnNd+ioBR0I0UmHlOvdYy0wwmWGNh1+B0=; b=bXj3imQSYnN9Czn9OitROmgudDMb5ZVDU0zcB+p7tDr7/BLeWwtQWBeDCPeySmsjwY IwbgOnehUky1arPiLcDBTia99jYSbg+7D0R0E8gLRDn5uy1e7k6jv3wR3dyQFBp11Z/D USMb//mzYxZcyQ3PijFOdXVN2cfTteaNYEpmtnEVDlwLivhWRJ5tKlmlr0CJ5mOi81Le EIvWazpEavSwGnlMvB79J7tgjOSt9lfSNG7edG+Ay8QLlc6H5sdGelNXpuzK5KtKoH2h x3mcNkhoPSQOWS3L+XyOvOziXqFrn4FOLa0D7Pmn8zTuK558hmQJzwYM5/AhphTrV1kx eKZw== X-Gm-Message-State: ALoCoQlzcDAk/eO5VhKz6Kz1PaFNb2VKBnJDdPRYIYUWcdGvUG0Ut8kgkQtnVbl4+bopTvy4ubOR X-Received: by 10.224.29.129 with SMTP id q1mr4007402qac.3.1398421733633; Fri, 25 Apr 2014 03:28:53 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.91.201 with SMTP id z67ls771924qgd.59.gmail; Fri, 25 Apr 2014 03:28:53 -0700 (PDT) X-Received: by 10.220.167.2 with SMTP id o2mr6155462vcy.8.1398421733553; Fri, 25 Apr 2014 03:28:53 -0700 (PDT) Received: from mail-vc0-f181.google.com (mail-vc0-f181.google.com [209.85.220.181]) by mx.google.com with ESMTPS id pu9si1592524vec.209.2014.04.25.03.28.53 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 25 Apr 2014 03:28:53 -0700 (PDT) Received-SPF: none (google.com: patch+caf_=patchwork-forward=linaro.org@linaro.org does not designate permitted sender hosts) client-ip=209.85.220.181; Received: by mail-vc0-f181.google.com with SMTP id id10so4409838vcb.26 for ; Fri, 25 Apr 2014 03:28:53 -0700 (PDT) X-Received: by 10.52.166.102 with SMTP id zf6mr5141782vdb.2.1398421733434; Fri, 25 Apr 2014 03:28:53 -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.220.221.72 with SMTP id ib8csp86767vcb; Fri, 25 Apr 2014 03:28:52 -0700 (PDT) X-Received: by 10.140.88.85 with SMTP id s79mr9353903qgd.70.1398421732783; Fri, 25 Apr 2014 03:28:52 -0700 (PDT) Received: from ip-10-141-164-156.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id c8si3590903qab.75.2014.04.25.03.28.51 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 25 Apr 2014 03:28:52 -0700 (PDT) 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-141-164-156.ec2.internal) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1WddMp-0004u8-Un; Fri, 25 Apr 2014 10:28:27 +0000 Received: from mail-lb0-f182.google.com ([209.85.217.182]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1WddMj-0004u2-Vn for lng-odp@lists.linaro.org; Fri, 25 Apr 2014 10:28:22 +0000 Received: by mail-lb0-f182.google.com with SMTP id l4so2956579lbv.13 for ; Fri, 25 Apr 2014 03:28:39 -0700 (PDT) X-Received: by 10.152.4.41 with SMTP id h9mr804621lah.43.1398421718880; Fri, 25 Apr 2014 03:28:38 -0700 (PDT) Received: from maxim-lap.localhost.onion ([92.39.133.154]) by mx.google.com with ESMTPSA id am9sm290564lac.11.2014.04.25.03.28.37 for (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 25 Apr 2014 03:28:37 -0700 (PDT) From: Maxim Uvarov To: lng-odp@lists.linaro.org Date: Fri, 25 Apr 2014 14:28:35 +0400 Message-Id: <1398421715-7875-1-git-send-email-maxim.uvarov@linaro.org> X-Mailer: git-send-email 1.8.5.1.163.gd7aced9 Subject: [lng-odp] [PATCHv2] make odp_icmp comments doxygen friendly 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: maxim.uvarov@linaro.org X-Original-Authentication-Results: mx.google.com; spf=neutral (google.com: patch+caf_=patchwork-forward=linaro.org@linaro.org does not designate permitted sender hosts) 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 Signed-off-by: Maxim Uvarov --- v2: align comments to the same column include/helper/odp_icmp.h | 90 ++++++++++++++++++++++++----------------------- 1 file changed, 46 insertions(+), 44 deletions(-) diff --git a/include/helper/odp_icmp.h b/include/helper/odp_icmp.h index bfa356d..f34b68e 100644 --- a/include/helper/odp_icmp.h +++ b/include/helper/odp_icmp.h @@ -27,65 +27,67 @@ extern "C" { /** ICMP header */ typedef struct ODP_PACKED { - uint8_t type; /** message type */ - uint8_t code; /** type sub-code */ - uint16be_t chksum; + uint8_t type; /**< message type */ + uint8_t code; /**< type sub-code */ + uint16be_t chksum; /**< checksum of icmp header */ union { struct { uint16be_t id; uint16be_t sequence; - } echo; /** echo datagram */ - uint32be_t gateway; /** gateway address */ + } echo; /**< echo datagram */ + uint32be_t gateway; /**< gateway address */ struct { uint16be_t __unused; uint16be_t mtu; - } frag; /** path mtu discovery */ - } un; + } frag; /**< path mtu discovery */ + } un; /**< icmp sub header */ } odp_icmphdr_t; -#define ICMP_ECHOREPLY 0 /** Echo Reply */ -#define ICMP_DEST_UNREACH 3 /** Destination Unreachable */ -#define ICMP_SOURCE_QUENCH 4 /** Source Quench */ -#define ICMP_REDIRECT 5 /** Redirect (change route) */ -#define ICMP_ECHO 8 /** Echo Request */ -#define ICMP_TIME_EXCEEDED 11 /** Time Exceeded */ -#define ICMP_PARAMETERPROB 12 /** Parameter Problem */ -#define ICMP_TIMESTAMP 13 /** Timestamp Request */ -#define ICMP_TIMESTAMPREPLY 14 /** Timestamp Reply */ -#define ICMP_INFO_REQUEST 15 /** Information Request */ -#define ICMP_INFO_REPLY 16 /** Information Reply */ -#define ICMP_ADDRESS 17 /** Address Mask Request */ -#define ICMP_ADDRESSREPLY 18 /** Address Mask Reply */ -#define NR_ICMP_TYPES 18 +#define ICMP_ECHOREPLY 0 /**< Echo Reply */ +#define ICMP_DEST_UNREACH 3 /**< Destination Unreachable */ +#define ICMP_SOURCE_QUENCH 4 /**< Source Quench */ +#define ICMP_REDIRECT 5 /**< Redirect (change route) */ +#define ICMP_ECHO 8 /**< Echo Request */ +#define ICMP_TIME_EXCEEDED 11 /**< Time Exceeded */ +#define ICMP_PARAMETERPROB 12 /**< Parameter Problem */ +#define ICMP_TIMESTAMP 13 /**< Timestamp Request */ +#define ICMP_TIMESTAMPREPLY 14 /**< Timestamp Reply */ +#define ICMP_INFO_REQUEST 15 /**< Information Request */ +#define ICMP_INFO_REPLY 16 /**< Information Reply */ +#define ICMP_ADDRESS 17 /**< Address Mask Request */ +#define ICMP_ADDRESSREPLY 18 /**< Address Mask Reply */ +#define NR_ICMP_TYPES 18 /**< Number of icmp types */ /** Codes for UNREACH. */ -#define ICMP_NET_UNREACH 0 /** Network Unreachable */ -#define ICMP_HOST_UNREACH 1 /** Host Unreachable */ -#define ICMP_PROT_UNREACH 2 /** Protocol Unreachable */ -#define ICMP_PORT_UNREACH 3 /** Port Unreachable */ -#define ICMP_FRAG_NEEDED 4 /** Fragmentation Needed/DF set */ -#define ICMP_SR_FAILED 5 /** Source Route failed */ -#define ICMP_NET_UNKNOWN 6 -#define ICMP_HOST_UNKNOWN 7 -#define ICMP_HOST_ISOLATED 8 -#define ICMP_NET_ANO 9 -#define ICMP_HOST_ANO 10 -#define ICMP_NET_UNR_TOS 11 -#define ICMP_HOST_UNR_TOS 12 -#define ICMP_PKT_FILTERED 13 /** Packet filtered */ -#define ICMP_PREC_VIOLATION 14 /** Precedence violation */ -#define ICMP_PREC_CUTOFF 15 /** Precedence cut off */ -#define NR_ICMP_UNREACH 15 /** instead of hardcoding immediate value */ +#define ICMP_NET_UNREACH 0 /**< Network Unreachable */ +#define ICMP_HOST_UNREACH 1 /**< Host Unreachable */ +#define ICMP_PROT_UNREACH 2 /**< Protocol Unreachable */ +#define ICMP_PORT_UNREACH 3 /**< Port Unreachable */ +#define ICMP_FRAG_NEEDED 4 /**< Fragmentation Needed/DF set*/ +#define ICMP_SR_FAILED 5 /**< Source Route failed */ +#define ICMP_NET_UNKNOWN 6 /**< Network Unknown */ +#define ICMP_HOST_UNKNOWN 7 /**< Host Unknown */ +#define ICMP_HOST_ISOLATED 8 /**< Host Isolated */ +#define ICMP_NET_ANO 9 /**< ICMP_NET_ANO */ +#define ICMP_HOST_ANO 10 /**< ICMP_HOST_ANO */ +#define ICMP_NET_UNR_TOS 11 /**< ICMP_NET_UNR_TOS */ +#define ICMP_HOST_UNR_TOS 12 /**< ICMP_HOST_UNR_TOS */ +#define ICMP_PKT_FILTERED 13 /**< Packet filtered */ +#define ICMP_PREC_VIOLATION 14 /**< Precedence violation */ +#define ICMP_PREC_CUTOFF 15 /**< Precedence cut off */ +#define NR_ICMP_UNREACH 15 /**< instead of hardcoding + immediate value */ /** Codes for REDIRECT. */ -#define ICMP_REDIR_NET 0 /** Redirect Net */ -#define ICMP_REDIR_HOST 1 /** Redirect Host */ -#define ICMP_REDIR_NETTOS 2 /** Redirect Net for TOS */ -#define ICMP_REDIR_HOSTTOS 3 /** Redirect Host for TOS */ +#define ICMP_REDIR_NET 0 /**< Redirect Net */ +#define ICMP_REDIR_HOST 1 /**< Redirect Host */ +#define ICMP_REDIR_NETTOS 2 /**< Redirect Net for TOS */ +#define ICMP_REDIR_HOSTTOS 3 /**< Redirect Host for TOS */ /** Codes for TIME_EXCEEDED. */ -#define ICMP_EXC_TTL 0 /** TTL count exceeded */ -#define ICMP_EXC_FRAGTIME 1 /** Fragment Reass time exceeded */ +#define ICMP_EXC_TTL 0 /**< TTL count exceeded */ +#define ICMP_EXC_FRAGTIME 1 /**< Fragment Reass time + exceeded*/ /** @internal Compile time assert */ ODP_ASSERT(sizeof(odp_icmphdr_t) == ODP_ICMPHDR_LEN, ODP_ICMPHDR_T__SIZE_ERROR);