netdev - [PATCH 2/2] ipv6: header documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Fri,  1 Aug 2014 23:31:23 +0200
From:	Karoly Kemeny <karoly.kemeny@...il.com>
To:	netdev@...r.kernel.org, davem@...emloft.net,
	linux-doc@...r.kernel.org
Cc:	Karoly Kemeny <karoly.kemeny@...il.com>
Subject: [PATCH 2/2] ipv6: header documentation

Signed-off-by: Karoly Kemeny <karoly.kemeny@...il.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

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html