From: Sven Eckelmann <sven@narfation.org>
To: b.a.t.m.a.n@lists.open-mesh.org
Subject: [B.A.T.M.A.N.] [PATCH 1/8] batman-adv: Add missing kernel-doc to packet.h
Date: Sat, 2 Dec 2017 19:51:46 +0100 [thread overview]
Message-ID: <20171202185153.552-2-sven@narfation.org> (raw)
In-Reply-To: <20171202185153.552-1-sven@narfation.org>
Signed-off-by: Sven Eckelmann <sven@narfation.org>
---
net/batman-adv/packet.h | 25 +++++++++++++++++++++++--
1 file changed, 23 insertions(+), 2 deletions(-)
diff --git a/net/batman-adv/packet.h b/net/batman-adv/packet.h
index 8e8a5db1..bf98cb5f 100644
--- a/net/batman-adv/packet.h
+++ b/net/batman-adv/packet.h
@@ -21,6 +21,12 @@
#include <asm/byteorder.h>
#include <linux/types.h>
+/**
+ * batadv_tp_is_error() - Check throughput meter return code for error
+ * @n: throughput meter return code
+ *
+ * Return: 0 when not error was detected, != 0 otherwise
+ */
#define batadv_tp_is_error(n) ((u8)(n) > 127 ? 1 : 0)
/**
@@ -88,7 +94,15 @@ enum batadv_iv_flags {
BATADV_DIRECTLINK = BIT(2),
};
-/* ICMP message types */
+/**
+ * enum batadv_icmp_packettype - ICMP message types
+ * @BATADV_ECHO_REPLY: success reply to BATADV_ECHO_REQUEST
+ * @BATADV_DESTINATION_UNREACHABLE: failure when route to destination not found
+ * @BATADV_ECHO_REQUEST: request BATADV_ECHO_REPLY from destination
+ * @BATADV_TTL_EXCEEDED: error after BATADV_ECHO_REQUEST traversed too many hops
+ * @BATADV_PARAMETER_PROBLEM: return code for malformed messages
+ * @BATADV_TP: throughput meter packet
+ */
enum batadv_icmp_packettype {
BATADV_ECHO_REPLY = 0,
BATADV_DESTINATION_UNREACHABLE = 3,
@@ -136,7 +150,14 @@ enum batadv_vlan_flags {
BATADV_VLAN_HAS_TAG = BIT(15),
};
-/* claim frame types for the bridge loop avoidance */
+/**
+ * enum batadv_bla_claimframe - claim frame types for the bridge loop avoidance
+ * @BATADV_CLAIM_TYPE_CLAIM: claim of a client mac address
+ * @BATADV_CLAIM_TYPE_UNCLAIM: unclaim of a client mac address
+ * @BATADV_CLAIM_TYPE_ANNOUNCE: announcement of backbone with current crc
+ * @BATADV_CLAIM_TYPE_REQUEST: request of full claim table
+ * @BATADV_CLAIM_TYPE_LOOPDETECT: mesh-traversing loop detect packet
+ */
enum batadv_bla_claimframe {
BATADV_CLAIM_TYPE_CLAIM = 0x00,
BATADV_CLAIM_TYPE_UNCLAIM = 0x01,
--
2.11.0
next prev parent reply other threads:[~2017-12-02 18:51 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-02 18:51 [B.A.T.M.A.N.] [PATCH 0/8] batman-adv: kernel-doc enhancements Sven Eckelmann
2017-12-02 18:51 ` Sven Eckelmann [this message]
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 2/8] batman-adv: Use parentheses in function kernel-doc Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 3/8] batman-adv: Use inline kernel-doc for enum/struct Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 4/8] batman-adv: Fix kernel-doc references to struct members Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 5/8] batman-adv: Add kernel-doc to structs in headers Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 6/8] batman-adv: Add kernel-doc to enums " Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 7/8] batman-adv: Add kernel-doc to functions " Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 8/8] batman-adv: Add kernel-doc to externally visible functions Sven Eckelmann
2017-12-06 10:42 ` [B.A.T.M.A.N.] [PATCH 0/8] batman-adv: kernel-doc enhancements Sven Eckelmann
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=20171202185153.552-2-sven@narfation.org \
--to=sven@narfation.org \
--cc=b.a.t.m.a.n@lists.open-mesh.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