Skip to content

Commit 6a3038f

Browse files
ecsvsimonwunderlich
authored andcommitted
batman-adv: Add missing kernel-doc to packet.h
Signed-off-by: Sven Eckelmann <sven@narfation.org> Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
1 parent eface06 commit 6a3038f

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

net/batman-adv/packet.h

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@
2222
#include <asm/byteorder.h>
2323
#include <linux/types.h>
2424

25+
/**
26+
* batadv_tp_is_error() - Check throughput meter return code for error
27+
* @n: throughput meter return code
28+
*
29+
* Return: 0 when not error was detected, != 0 otherwise
30+
*/
2531
#define batadv_tp_is_error(n) ((u8)(n) > 127 ? 1 : 0)
2632

2733
/**
@@ -89,7 +95,15 @@ enum batadv_iv_flags {
8995
BATADV_DIRECTLINK = BIT(2),
9096
};
9197

92-
/* ICMP message types */
98+
/**
99+
* enum batadv_icmp_packettype - ICMP message types
100+
* @BATADV_ECHO_REPLY: success reply to BATADV_ECHO_REQUEST
101+
* @BATADV_DESTINATION_UNREACHABLE: failure when route to destination not found
102+
* @BATADV_ECHO_REQUEST: request BATADV_ECHO_REPLY from destination
103+
* @BATADV_TTL_EXCEEDED: error after BATADV_ECHO_REQUEST traversed too many hops
104+
* @BATADV_PARAMETER_PROBLEM: return code for malformed messages
105+
* @BATADV_TP: throughput meter packet
106+
*/
93107
enum batadv_icmp_packettype {
94108
BATADV_ECHO_REPLY = 0,
95109
BATADV_DESTINATION_UNREACHABLE = 3,
@@ -137,7 +151,14 @@ enum batadv_vlan_flags {
137151
BATADV_VLAN_HAS_TAG = BIT(15),
138152
};
139153

140-
/* claim frame types for the bridge loop avoidance */
154+
/**
155+
* enum batadv_bla_claimframe - claim frame types for the bridge loop avoidance
156+
* @BATADV_CLAIM_TYPE_CLAIM: claim of a client mac address
157+
* @BATADV_CLAIM_TYPE_UNCLAIM: unclaim of a client mac address
158+
* @BATADV_CLAIM_TYPE_ANNOUNCE: announcement of backbone with current crc
159+
* @BATADV_CLAIM_TYPE_REQUEST: request of full claim table
160+
* @BATADV_CLAIM_TYPE_LOOPDETECT: mesh-traversing loop detect packet
161+
*/
141162
enum batadv_bla_claimframe {
142163
BATADV_CLAIM_TYPE_CLAIM = 0x00,
143164
BATADV_CLAIM_TYPE_UNCLAIM = 0x01,

0 commit comments

Comments
 (0)