net/tipc: fix various kernel-doc warnings (5fcb7d47) · Commits · EulixOS / Software / Kernel

net/tipc/crypto.c

+12 −5

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0
		/**
		/*
		* net/tipc/crypto.c: TIPC crypto for key handling & packet en/decryption
		*
		* Copyright (c) 2019, Ericsson AB
		@@ -51,7 +51,7 @@

		#define TIPC_REKEYING_INTV_DEF (60 * 24) /* default: 1 day */

		/**
		/*
		* TIPC Key ids
		*/
		enum {
		@@ -63,7 +63,7 @@ enum {
		KEY_MAX = KEY_3,
		};

		/**
		/*
		* TIPC Crypto statistics
		*/
		enum {
		@@ -90,7 +90,7 @@ int sysctl_tipc_max_tfms __read_mostly = TIPC_MAX_TFMS_DEF;
		/* Key exchange switch, default: on */
		int sysctl_tipc_key_exchange_enabled __read_mostly = 1;

		/**
		/*
		* struct tipc_key - TIPC keys' status indicator
		*
		* 7 6 5 4 3 2 1 0
		@@ -123,6 +123,8 @@ struct tipc_key {

		/**
		* struct tipc_tfm - TIPC TFM structure to form a list of TFMs
		* @tfm: cipher handle/key
		* @list: linked list of TFMs
		*/
		struct tipc_tfm {
		struct crypto_aead *tfm;
		@@ -138,7 +140,7 @@ struct tipc_tfm {
		* @salt: the key's SALT value
		* @authsize: authentication tag size (max = 16)
		* @mode: crypto mode is applied to the key
		* @hint[]: a hint for user key
		* @hint: a hint for user key
		* @rcu: struct rcu_head
		* @key: the aead key
		* @gen: the key's generation
		@@ -166,6 +168,7 @@ struct tipc_aead {

		/**
		* struct tipc_crypto_stats - TIPC Crypto statistics
		* @stat: array of crypto statistics
		*/
		struct tipc_crypto_stats {
		unsigned int stat[MAX_STATS];
		@@ -194,6 +197,7 @@ struct tipc_crypto_stats {
		* @key_master: flag indicates if master key exists
		* @legacy_user: flag indicates if a peer joins w/o master key (for bwd comp.)
		* @nokey: no key indication
		* @flags: combined flags field
		* @lock: tipc_key lock
		*/
		struct tipc_crypto {
		@@ -324,6 +328,8 @@ do { \

		/**
		* tipc_aead_key_validate - Validate a AEAD user key
		* @ukey: pointer to user key data
		* @info: netlink info pointer
		*/
		int tipc_aead_key_validate(struct tipc_aead_key ukey, struct genl_info info)
		{
		@@ -477,6 +483,7 @@ static void tipc_aead_users_set(struct tipc_aead __rcu *aead, int val)

		/**
		* tipc_aead_tfm_next - Move TFM entry to the next one in list and return it
		* @aead: the AEAD key pointer
		*/
		static struct crypto_aead tipc_aead_tfm_next(struct tipc_aead aead)
		{

net/tipc/discover.c

+2 −1

Original line number	Diff line number	Diff line
		@@ -74,6 +74,7 @@ struct tipc_discoverer {
		/**
		* tipc_disc_init_msg - initialize a link setup message
		* @net: the applicable net namespace
		* @skb: buffer containing message
		* @mtyp: message type (request or response)
		* @b: ptr to bearer issuing message
		*/
		@@ -380,7 +381,7 @@ int tipc_disc_create(struct net net, struct tipc_bearer b,

		/**
		* tipc_disc_delete - destroy object sending periodic link setup requests
		* @d: ptr to link duest structure
		* @d: ptr to link dest structure
		*/
		void tipc_disc_delete(struct tipc_discoverer *d)
		{

net/tipc/msg.c

+7 −3

Original line number	Diff line number	Diff line
		@@ -58,10 +58,12 @@ static unsigned int align(unsigned int i)
		/**
		* tipc_buf_acquire - creates a TIPC message buffer
		* @size: message size (including TIPC header)
		* @gfp: memory allocation flags
		*
		* Returns a new buffer with data pointers set to the specified size.
		*
		* NOTE: Headroom is reserved to allow prepending of a data link header.
		* NOTE:
		* Headroom is reserved to allow prepending of a data link header.
		* There may also be unrequested tailroom present at the buffer's end.
		*/
		struct sk_buff *tipc_buf_acquire(u32 size, gfp_t gfp)
		@@ -367,6 +369,7 @@ int tipc_msg_fragment(struct sk_buff skb, const struct tipc_msg hdr,
		* tipc_msg_build - create buffer chain containing specified header and data
		* @mhdr: Message header, to be prepended to data
		* @m: User message
		* @offset: buffer offset for fragmented messages (FIXME)
		* @dsz: Total length of user data
		* @pktmax: Max packet size that can be used
		* @list: Buffer or chain of buffers to be returned to caller
		@@ -580,7 +583,7 @@ bool tipc_msg_try_bundle(struct sk_buff tskb, struct sk_buff *skb, u32 mss,
		* @skb: buffer to be extracted from.
		* @iskb: extracted inner buffer, to be returned
		* @pos: position in outer message of msg to be extracted.
		* Returns position of next msg
		* Returns position of next msg.
		* Consumes outer buffer when last packet extracted
		* Returns true when there is an extracted buffer, otherwise false
		*/
		@@ -698,6 +701,7 @@ bool tipc_msg_skb_clone(struct sk_buff_head msg, struct sk_buff_head cpy)

		/**
		* tipc_msg_lookup_dest(): try to find new destination for named message
		* @net: pointer to associated network namespace
		* @skb: the buffer containing the message.
		* @err: error code to be used by caller if lookup fails
		* Does not consume buffer

net/tipc/node.c

+3 −2

Original line number	Diff line number	Diff line
		@@ -900,7 +900,8 @@ static void tipc_node_link_up(struct tipc_node *n, int bearer_id,
		*
		* This function is only called in a very special situation where link
		* failover can be already started on peer node but not on this node.
		* This can happen when e.g.
		* This can happen when e.g.::
		*
		* 1. Both links <1A-2A>, <1B-2B> down
		* 2. Link endpoint 2A up, but 1A still down (e.g. due to network
		* disturbance, wrong session, etc.)

net/tipc/socket.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -3799,7 +3799,7 @@ int tipc_nl_publ_dump(struct sk_buff skb, struct netlink_callback cb)
		/**
		* tipc_sk_filtering - check if a socket should be traced
		* @sk: the socket to be examined
		* @sysctl_tipc_sk_filter[]: the socket tuple for filtering,
		* @sysctl_tipc_sk_filter: the socket tuple for filtering:
		* (portid, sock type, name type, name lower, name upper)
		*
		* Returns true if the socket meets the socket tuple data