From: Karoly Kemeny <karoly.kemeny@gmail.com>
To: netdev@vger.kernel.org, davem@davemloft.net, linux-doc@vger.kernel.org
Cc: Karoly Kemeny <karoly.kemeny@gmail.com>
Subject: [PATCH 2/2] ipv6: header documentation
Date: Fri, 1 Aug 2014 23:31:23 +0200 [thread overview]
Message-ID: <1406928683-4317-2-git-send-email-karoly.kemeny@gmail.com> (raw)
In-Reply-To: <1406928683-4317-1-git-send-email-karoly.kemeny@gmail.com>
Signed-off-by: Karoly Kemeny <karoly.kemeny@gmail.com>
---
include/net/ipv6.h | 40 ++++++++++++++++++++++++++++------------
1 file changed, 28 insertions(+), 12 deletions(-)
diff --git a/include/net/ipv6.h b/include/net/ipv6.h
index a2db816..7798a97 100644
--- a/include/net/ipv6.h
+++ b/include/net/ipv6.h
@@ -100,8 +100,20 @@
#define IPV6_ADDR_MC_FLAG_RENDEZVOUS(a) \
((a)->s6_addr[1] & 0x40)
-/*
- * fragmentation header
+/**
+ * struct frag_hdr - fragmentation header
+ * @nexthdr - type of the next header
+ * @reserved - reserved field, init to zeroes on transmission,
+ * ignore on reception
+ * @frag_off - 13 MSB bit: offset relative to the start of the
+ * fragmented part of the packet.
+ * - 14-15 bit : reserved, as @reserved
+ * - LSB : indicates if it is the last fragment
+ * of the file. 0 = last fragment
+ * @identification - id of the fragmented packet,
+ * must be the same for all fragments of the same packet
+ *
+ * for more info see RFC-2460
*/
struct frag_hdr {
@@ -200,23 +212,27 @@ struct ip6_ra_chain {
extern struct ip6_ra_chain *ip6_ra_chain;
extern rwlock_t ip6_ra_lock;
-/*
- This structure is prepared by protocol, when parsing
- ancillary data and passed to IPv6.
+/**
+ * struct ipv6_txoption - This structure is prepared by protocol, when parsing
+ * ancillary data and passed to IPv6.
+ * @tot_len - length of this structure
+ * @opt_flen - length of extension header after fragment header
+ * @opt_nlen - length of extension header before fragment header
+ * @hopopt - pointer to the hop-by-hop header
+ * @dst0opt - pointer to the first destination header
+ * @srcrt - pointer to the routing header
+ * @dst1opt - pointer to the second destination header
+ *
*/
struct ipv6_txoptions {
- /* Length of this structure */
int tot_len;
-
- /* length of extension headers */
-
- __u16 opt_flen; /* after fragment hdr */
- __u16 opt_nflen; /* before fragment hdr */
+ __u16 opt_flen;
+ __u16 opt_nflen;
struct ipv6_opt_hdr *hopopt;
struct ipv6_opt_hdr *dst0opt;
- struct ipv6_rt_hdr *srcrt; /* Routing Header */
+ struct ipv6_rt_hdr *srcrt;
struct ipv6_opt_hdr *dst1opt;
/* Option buffer, as read by IPV6_PKTOPTIONS, starts here. */
--
1.9.1
next prev parent reply other threads:[~2014-08-01 21:31 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-01 21:31 [PATCH 1/2] net: socket.h structures documentation Karoly Kemeny
2014-08-01 21:31 ` Karoly Kemeny [this message]
2014-08-03 22:48 ` [PATCH 2/2] ipv6: header documentation Randy Dunlap
2014-08-03 22:48 ` [PATCH 1/2] net: socket.h structures documentation Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1406928683-4317-2-git-send-email-karoly.kemeny@gmail.com \
--to=karoly.kemeny@gmail.com \
--cc=davem@davemloft.net \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).