Commit c00de1c4 authored by Benjamin Berg's avatar Benjamin Berg Committed by Johannes Berg
Browse files

wifi: mac80211: mesh: fix some kdoc warnings 



These were mostly missing or incorrectly tagged return values.

Signed-off-by: default avatarBenjamin Berg <benjamin.berg@intel.com>
Signed-off-by: default avatarGregory Greenman <gregory.greenman@intel.com>
Link: https://lore.kernel.org/r/20230928172905.33fea2968c62.I41d197b570370ab7cad1405518512fdd36e08717@changeid


Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent 256caff2

net/mac80211/mesh.c

+6 −2
Original line number Diff line number Diff line
@@ -56,6 +56,8 @@ static void ieee80211_mesh_housekeeping_timer(struct timer_list *t) 
 *

 * This function checks if the mesh configuration of a mesh point matches the

 * local mesh configuration, i.e. if both nodes belong to the same mesh network.

 *

 * Returns: %true if both nodes belong to the same mesh

 */

bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,

			struct ieee802_11_elems *ie)
@@ -119,6 +121,8 @@ bool mesh_matches_local(struct ieee80211_sub_if_data *sdata, 
 * mesh_peer_accepts_plinks - check if an mp is willing to establish peer links

 *

 * @ie: information elements of a management frame from the mesh peer

 *

 * Returns: %true if the mesh peer is willing to establish peer links

 */

bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie)

{
@@ -858,7 +862,7 @@ bool ieee80211_mesh_xmit_fast(struct ieee80211_sub_if_data *sdata, 
 * @meshsa:	source address in the mesh.  Same as TA, as frame is

 *              locally originated.

 *

 * Return the length of the 802.11 (does not include a mesh control header)

 * Returns: the length of the 802.11 frame header (excludes mesh control header)

 */

int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,

				  const u8 *meshda, const u8 *meshsa)
@@ -891,7 +895,7 @@ int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc, 
 * @addr6:	2nd address in the ae header, which corresponds to addr6 of the

 *              mesh frame

 *

 * Return the header length.

 * Returns: the header length

 */

unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,

				       struct ieee80211s_hdr *meshhdr,

net/mac80211/mesh_hwmp.c

+2 −0
Original line number Diff line number Diff line
@@ -230,6 +230,8 @@ static void prepare_frame_for_deferred_tx(struct ieee80211_sub_if_data *sdata, 
 * Note: This function may be called with driver locks taken that the driver

 * also acquires in the TX path.  To avoid a deadlock we don't transmit the

 * frame directly but add it to the pending queue instead.

 *

 * Returns: 0 on success

 */

int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,

		       u8 ttl, const u8 *target, u32 target_sn,

net/mac80211/mesh_pathtbl.c

+13 −7
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/*

 * Copyright (c) 2008, 2009 open80211s Ltd.

 * Copyright (C) 2023 Intel Corporation

 * Author:     Luis Carlos Cobo <luisca@cozybit.com>

 */
@@ -173,6 +174,11 @@ static void prepare_for_gate(struct sk_buff *skb, char *dst_addr, 
/**

 * mesh_path_move_to_queue - Move or copy frames from one mpath queue to another

 *

 * @gate_mpath: An active mpath the frames will be sent to (i.e. the gate)

 * @from_mpath: The failed mpath

 * @copy: When true, copy all the frames to the new mpath queue.  When false,

 * move them.

 *

 * This function is used to transfer or copy frames from an unresolved mpath to

 * a gate mpath.  The function also adds the Address Extension field and

 * updates the next hop.
@@ -181,11 +187,6 @@ static void prepare_for_gate(struct sk_buff *skb, char *dst_addr, 
 * destination addresses are updated.

 *

 * The gate mpath must be an active mpath with a valid mpath->next_hop.

 *

 * @gate_mpath: An active mpath the frames will be sent to (i.e. the gate)

 * @from_mpath: The failed mpath

 * @copy: When true, copy all the frames to the new mpath queue.  When false,

 * move them.

 */

static void mesh_path_move_to_queue(struct mesh_path *gate_mpath,

				    struct mesh_path *from_mpath,
@@ -330,6 +331,8 @@ mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx) 
/**

 * mesh_path_add_gate - add the given mpath to a mesh gate to our path table

 * @mpath: gate path to add to table

 *

 * Returns: 0 on success, -EEXIST

 */

int mesh_path_add_gate(struct mesh_path *mpath)

{
@@ -388,6 +391,8 @@ static void mesh_gate_del(struct mesh_table *tbl, struct mesh_path *mpath) 
/**

 * mesh_gate_num - number of gates known to this interface

 * @sdata: subif data

 *

 * Returns: The number of gates

 */

int mesh_gate_num(struct ieee80211_sub_if_data *sdata)

{
@@ -861,10 +866,9 @@ static void table_flush_by_iface(struct mesh_table *tbl) 
/**

 * mesh_path_flush_by_iface - Deletes all mesh paths associated with a given iface

 *

 * This function deletes both mesh paths as well as mesh portal paths.

 *

 * @sdata: interface data to match

 *

 * This function deletes both mesh paths as well as mesh portal paths.

 */

void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)

{
@@ -944,6 +948,8 @@ void mesh_path_tx_pending(struct mesh_path *mpath) 
 * queue to that gate's queue.  If there are more than one gates, the frames

 * are copied from each gate to the next.  After frames are copied, the

 * mpath queues are emptied onto the transmission queue.

 *

 * Returns: 0 on success, -EHOSTUNREACH

 */

int mesh_path_send_to_gates(struct mesh_path *mpath)

{

net/mac80211/mesh_plink.c

+5 −1
Original line number Diff line number Diff line
@@ -153,6 +153,8 @@ static u64 mesh_set_short_slot_time(struct ieee80211_sub_if_data *sdata) 
 * selected if any non-HT peers are present in our MBSS.  20MHz-protection mode

 * is selected if all peers in our 20/40MHz MBSS support HT and at least one

 * HT20 peer is present. Otherwise no-protection mode is selected.

 *

 * Returns: BSS_CHANGED_HT or 0 for no change

 */

static u64 mesh_set_ht_prot_mode(struct ieee80211_sub_if_data *sdata)

{
@@ -362,7 +364,7 @@ static int mesh_plink_frame_tx(struct ieee80211_sub_if_data *sdata, 
 * Mesh paths with this peer as next hop should be flushed

 * by the caller outside of plink_lock.

 *

 * Returns beacon changed flag if the beacon content changed.

 * Returns: beacon changed flag if the beacon content changed.

 *

 * Locking: the caller must hold sta->mesh->plink_lock

 */
@@ -390,6 +392,8 @@ static u64 __mesh_plink_deactivate(struct sta_info *sta) 
 * @sta: mesh peer link to deactivate

 *

 * All mesh paths with this peer as next hop will be flushed

 *

 * Returns: beacon changed flag if the beacon content changed.

 */

u64 mesh_plink_deactivate(struct sta_info *sta)

{

net/mac80211/mesh_ps.c

+5 −1
Original line number Diff line number Diff line
@@ -15,6 +15,8 @@ 
/**

 * mps_qos_null_get - create pre-addressed QoS Null frame for mesh powersave

 * @sta: the station to get the frame for

 *

 * Returns: A newly allocated SKB

 */

static struct sk_buff *mps_qos_null_get(struct sta_info *sta)

{
@@ -77,6 +79,8 @@ static void mps_qos_null_tx(struct sta_info *sta) 
 *

 * sets the non-peer power mode and triggers the driver PS (re-)configuration

 * Return BSS_CHANGED_BEACON if a beacon update is necessary.

 *

 * Returns: BSS_CHANGED_BEACON if a beacon update is in order.

 */

u64 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata)

{
@@ -147,7 +151,7 @@ u64 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata) 
 *

 * @sta: mesh STA

 * @pm: the power mode to set

 * Return BSS_CHANGED_BEACON if a beacon update is in order.

 * Returns: BSS_CHANGED_BEACON if a beacon update is in order.

 */

u64 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,

				   enum nl80211_mesh_power_mode pm)