github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-07-28 01:55:51 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

batman-adv: tp_meter: update stale kernel-doc after refactoring

Browse Source 
The tp_meter codebase was recently refactored:

* throughput meter sender and receiver variables were split into
  two different structures
* the congestion control variables were extracted in a separate structure

But the kernel-doc was not updated everywhere to reflect these changes.

Signed-off-by: Sven Eckelmann <sven@narfation.org>
This commit is contained in:
Sven Eckelmann 2026-06-04 11:09:04 +02:00
parent 0e8c38fe9f
commit 0c0f658d9a
No known key found for this signature in database
GPG Key ID: 4D0F772BD314F5CB
2 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
net/batman-adv/tp_meter.c
View File

@ -289,7 +289,7 @@ batadv_tp_list_find_sender(struct batadv_priv *bat_priv, const u8 *dst)
* @bat_priv: the bat priv with all the mesh interface information
* @dst: the other endpoint MAC address to look for
*
* Return: if matching session with @dst was found
* Return: true if a matching session with @dst was found, false otherwise
*/
static bool batadv_tp_list_active(struct batadv_priv *bat_priv, const u8 *dst)
__must_hold(&bat_priv->tp_list_lock)
@ -355,7 +355,7 @@ batadv_tp_list_find_sender_session(struct batadv_priv *bat_priv, const u8 *dst,
/**
* batadv_tp_vars_common_release() - release batadv_tp_vars_common from lists
* and queue for free after rcu grace period
* @ref: kref pointer of the batadv_tp_vars
* @ref: kref pointer of the batadv_tp_vars_common
*/
static void batadv_tp_vars_common_release(struct kref *ref)
{
@ -391,7 +391,7 @@ static void batadv_tp_sender_put(struct batadv_tp_sender *tp_vars)
}
/**
* batadv_tp_list_detach() - remove tp receiver session from mesh session list once
* batadv_tp_list_detach() - remove tp session from mesh session list once
* @tp_vars: the private data of the current TP meter session
*
* Return: whether tp_vars was detached from list and reference must be freed
@ -509,7 +509,7 @@ static void batadv_tp_sender_finish(struct work_struct *work)
* batadv_tp_reset_sender_timer() - reschedule the sender timer
* @tp_vars: the private TP meter data for this session
*
* Reschedule the timer using tp_vars->rto as delay
* Reschedule the timer using tp_vars->cc.rto as delay
*/
static void batadv_tp_reset_sender_timer(struct batadv_tp_sender *tp_vars)
{
@ -621,9 +621,9 @@ static void batadv_tp_fill_prerandom(struct batadv_tp_sender *tp_vars,
*
* Create and send a single TP Meter message.
*
* Return: 0 on success, BATADV_TP_REASON_DST_UNREACHABLE if the destination is
* not reachable, BATADV_TP_REASON_MEMORY_ERROR if the packet couldn't be
* allocated
* Return: 0 on success, BATADV_TP_REASON_MEMORY_ERROR if the packet couldn't
* be allocated, BATADV_TP_REASON_CANT_SEND if the packet could not be
* transmitted
*/
static int batadv_tp_send_msg(struct batadv_tp_sender *tp_vars, const u8 *src,
struct batadv_orig_node *orig_node,
@ -913,7 +913,7 @@ static int batadv_tp_wait_available(struct batadv_tp_sender *tp_vars, size_t ple
* batadv_tp_send() - main sending thread of a tp meter session
* @arg: address of the related tp_vars
*
* Return: nothing, this function never returns
* Return: 0
*/
static int batadv_tp_send(void *arg)
{

14
net/batman-adv/types.h
View File

@ -1331,7 +1331,7 @@ struct batadv_tp_unacked {
/** @len: length of the packet */
u16 len;
/** @list: list node for &batadv_tp_vars.unacked_list */
/** @list: list node for &batadv_tp_vars_common.unacked_list */
struct list_head list;
};
@ -1367,7 +1367,9 @@ struct batadv_tp_vars_common {
struct rcu_head rcu;
};
/** struct batadv_tp_sender_cc - congestion control variables */
/**
* struct batadv_tp_sender_cc - congestion control variables
*/
struct batadv_tp_sender_cc {
/** @fast_recovery: true if in Fast Recovery mode */
bool fast_recovery:1;
@ -1410,7 +1412,7 @@ struct batadv_tp_sender_cc {
* struct batadv_tp_sender - sender tp meter private variables per session
*/
struct batadv_tp_sender {
/** @common: common batadv_tp_vars (best be first member) */
/** @common: common batadv_tp_vars_common (must be first member) */
struct batadv_tp_vars_common common;
/** @start_time: start time in jiffies */
@ -1437,7 +1439,7 @@ struct batadv_tp_sender {
/** @cc: congestion control variables */
struct batadv_tp_sender_cc cc;
/** @cc_lock: lock do protect @cc */
/** @cc_lock: lock to protect @cc */
spinlock_t cc_lock;
/** @tot_sent: amount of data sent/ACKed so far */
@ -1460,7 +1462,7 @@ struct batadv_tp_sender {
* struct batadv_tp_receiver - receiver tp meter private variables per session
*/
struct batadv_tp_receiver {
/** @common: common batadv_tp_vars (best be first member) */
/** @common: common batadv_tp_vars_common (must be first member) */
struct batadv_tp_vars_common common;
/** @receiving: receiving binary semaphore: 1 if receiving, 0 is not */
@ -1662,7 +1664,7 @@ struct batadv_priv {
/** @forw_bcast_list_lock: lock protecting forw_bcast_list */
spinlock_t forw_bcast_list_lock;
/** @tp_list_lock: spinlock protecting @tp_list */
/** @tp_list_lock: spinlock protecting @tp_sender_list + @tp_receiver_list */
spinlock_t tp_list_lock;
/** @tp_num: number of currently active tp sessions */