diff options
| author |   Sven Eckelmann <sven@narfation.org> | 2017-12-02 19:51:46 +0100 |
|---|---|---|
| committer |   Simon Wunderlich <sw@simonwunderlich.de> | 2017-12-15 17:29:19 +0100 |
| commit | 6a3038f07c59152fb640a3cd274afdf909640e4b (patch) | |
| tree | ef6bd07814079022c776d2a1ab56c7be4a63a714 /net/batman-adv | |
| parent | batman-adv: Remove unused sched.h include (diff) | |
| download | linux-dev-6a3038f07c59152fb640a3cd274afdf909640e4b.tar.xz linux-dev-6a3038f07c59152fb640a3cd274afdf909640e4b.zip | |
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>
Diffstat (limited to 'net/batman-adv')
| -rw-r--r-- | net/batman-adv/packet.h | 25 |
1 files changed, 23 insertions, 2 deletions
diff --git a/net/batman-adv/packet.h b/net/batman-adv/packet.h index 4eaf4b426726..dccbd4a6f019 100644 --- a/net/batman-adv/packet.h +++ b/net/batman-adv/packet.h @@ -22,6 +22,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) /** @@ -89,7 +95,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, @@ -137,7 +151,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, |