qcacmn: Fix target_if documentation

The kernel-doc script identified multiple documentation issues in the
target_if folder. Some sub-folders which had a multitude of issues
were patched individually. Now fix the remaining issues.

Change-Id: Ia46f54eaec90762e61e590344760f3c3364088de
CRs-Fixed: 3417471
This commit is contained in:
Jeff Johnson
2023-02-25 13:06:31 -08:00
committed by Madan Koyyalamudi
parent 29eb537def
commit ad2ba39a28
15 changed files with 94 additions and 74 deletions

View File

@@ -35,7 +35,7 @@
/**
* target_if_cp_stats_get_rx_ops() - get rx ops
* @tx_ops: pointer to lmac tx ops
* @psoc: pointer to psoc object
*
* Return: pointer to rx ops
*/
@@ -55,7 +55,7 @@ target_if_cp_stats_get_rx_ops(struct wlan_objmgr_psoc *psoc)
/**
* target_if_cp_stats_get_tx_ops() - get tx ops
* @tx_ops: pointer to lmac tx ops
* @psoc: pointer to psoc object
*
* Return: pointer to tx ops
*/
@@ -84,7 +84,7 @@ target_if_cp_stats_register_tx_ops(struct wlan_lmac_if_tx_ops *tx_ops);
#ifdef WLAN_SUPPORT_LEGACY_CP_STATS_HANDLERS
/**
* @target_if_cp_stats_register_legacy_event_handler() - Register handler
* target_if_cp_stats_register_legacy_event_handler() - Register handler
* specific to legacy components
* @psoc: pointer to psoc object
*
@@ -95,7 +95,7 @@ QDF_STATUS
target_if_cp_stats_register_legacy_event_handler(struct wlan_objmgr_psoc *psoc);
/**
* @target_if_cp_stats_unregister_legacy_event_handler() - Unregister handler
* target_if_cp_stats_unregister_legacy_event_handler() - Unregister handler
* specific to legacy components
* @psoc: pointer to psoc object
*

View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2020, The Linux Foundation. All rights reserved.
* Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
@@ -29,7 +30,7 @@
/**
* target_if_dcs_get_rx_ops() - get rx ops
* @tx_ops: pointer to target_if tx ops
* @psoc: pointer to psoc context
*
* API to retrieve the dcs rx ops from the psoc context
*
@@ -50,7 +51,7 @@ target_if_dcs_get_rx_ops(struct wlan_objmgr_psoc *psoc)
/**
* target_if_dcs_get_tx_ops() - get tx ops
* @tx_ops: pointer to target_if tx ops
* @psoc: pointer to psoc context
*
* API to retrieve the dcs tx ops from the psoc context
*

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2017-2018, 2020 The Linux Foundation. All rights reserved.
*
* Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -24,7 +24,7 @@
/**
* target_if_register_dfs_tx_ops() - register dfs tx ops
* @dfs_tx_ops: tx ops pointer
* @tx_ops: tx ops pointer
*
* Register dfs tx ops
*

View File

@@ -1,7 +1,6 @@
/*
* Copyright (c) 2017-2021 The Linux Foundation. All rights reserved.
* Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -164,9 +163,8 @@ static int target_if_radar_event_handler(
}
/**
* target_if_reg_phyerr_events() - register dfs phyerr radar event.
* target_if_reg_phyerr_events_dfs2() - register dfs phyerr radar event.
* @psoc: pointer to psoc.
* @pdev: pointer to pdev.
*
* Return: QDF_STATUS.
*/
@@ -215,9 +213,13 @@ static bool target_if_dfs_offload(struct wlan_objmgr_psoc *psoc)
}
/**
* target_if_dfs_bangradar_320_supp: Check the service of
* 'wmi_service_bang_radar_320_support' whether the bang radar 320 is
* supported or not. If the service is enabled, then it returns true.
* target_if_dfs_bangradar_320_supp: Check if bang radar 320 is supported
* @psoc: psoc handle
*
* Check the service of 'wmi_service_bang_radar_320_support' whether
* the bang radar 320 is supported or not.
*
* Return: true if the service is enabled, false otherwise
*/
static bool target_if_dfs_bangradar_320_supp(struct wlan_objmgr_psoc *psoc)
@@ -236,10 +238,17 @@ static bool target_if_dfs_bangradar_320_supp(struct wlan_objmgr_psoc *psoc)
#ifdef WLAN_FEATURE_11BE
/**
* target_if_dfs_is_radar_found_chan_freq_eq_center_freq: Check whether the
* service of 'radar_found_chan_freq' representing the center frequency of the
* radar segment is supported or not. If the service is not enabled, then
* chan_freq will indicate the channel's primary 20MHz center.
* target_if_dfs_is_radar_found_chan_freq_eq_center_freq() -
* Check if service 'radar_found_chan_freq' is supported
* @psoc: psoc handle
*
* Check whether the service of 'radar_found_chan_freq' representing
* the center frequency of the radar segment is supported or not. If
* the service is not enabled, then chan_freq will indicate the
* channel's primary 20MHz center.
*
* Return: true if wmi_service_radar_found_chan_freq_eq_center_freq is
* supported, false otherwise
*/
static bool
target_if_dfs_is_radar_found_chan_freq_eq_center_freq(

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2017-2021 The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -182,6 +182,7 @@ g_dbr_ring_debug_event[DBR_RING_DEBUG_EVENT_MAX][RING_DEBUG_EVENT_NAME_SIZE] = {
* @print_priv: The private data to be consumed by @print
* @dbr_pdev_obj: Pdev object of the DBR module
* @mod_id: Module ID
* @srng_id: ring id
*
* Print ring debug entries of the ring identified by @dbr_pdev_obj and @mod_id
* using the given print adapter function
@@ -227,7 +228,7 @@ static QDF_STATUS target_if_dbr_print_ring_debug_entries(
/**
* target_if_dbr_qdf_err_printer() - QDF error level printer for DBR module
* @print_priv: The private data
* @priv: The private data
* @fmt: Format string
*
* This function should be passed in place of the 'print' argument to
@@ -2013,6 +2014,7 @@ dbr_get_pdev_and_srng_id(struct wlan_objmgr_psoc *psoc, uint8_t pdev_id,
* @pdev: pointer to pdev object
* @mod_id: Module ID
* @event: ring debug event
* @srng_id: ring id
*
* Log the given event, head and tail pointers of DBR ring of the given module
* into its ring debug data structure.

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2017-2019 The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -39,7 +39,7 @@ struct direct_buf_rx_data;
#endif
/**
* struct direct_buf_rx_info - direct buffer rx operation info struct
* struct direct_buf_rx_buf_info - direct buffer rx operation info struct
* @cookie: SW cookie used to get the virtual address
* @paddr: Physical address pointer for DMA operation
* @vaddr: Virtual address pointer
@@ -63,6 +63,7 @@ struct direct_buf_rx_buf_info {
* @head_idx_addr: head index addr
* @tail_idx_addr: tail index addr
* @srng: HAL srng context
* @buf_size: size of each buffer
*/
struct direct_buf_rx_ring_cfg {
uint32_t num_ptr;
@@ -139,7 +140,7 @@ struct dbr_debugfs_priv {
* @ring_debug_idx: Current index in the array of ring debug entries
* @num_ring_debug_entries: Total ring debug entries
* @debugfs_entry: Debugfs entry for this ring
* @debugfs_priv: Debugfs ops for this ring
* @debugfs_fops: Debugfs ops for this ring
*/
struct direct_buf_rx_ring_debug {
struct direct_buf_rx_ring_debug_entry *entries;
@@ -171,13 +172,13 @@ struct direct_buf_rx_module_debug {
* struct direct_buf_rx_module_param - DMA module param
* @mod_id: Module ID
* @pdev_id: pdev ID
* @srng_id: SRNG ID
* @dbr_config: Pointer to dirct buf rx module configuration struct
* @dbr_ring_cap: Pointer to direct buf rx ring capabilities struct
* @dbr_ring_cfg: Pointer to direct buf rx ring config struct
* @dbr_buf_pool: Pointer to direct buf rx buffer pool struct
* @dbr_rsp_handler: Pointer to direct buf rx response handler for the module
* @srng_initialized: Whether the DBR ring is successfully initialized for this
* @pdev_id @srng_id
*/
struct direct_buf_rx_module_param {
enum DBR_MODULE mod_id;
@@ -214,11 +215,11 @@ struct direct_buf_rx_pdev_obj {
* struct direct_buf_rx_psoc_obj - Direct Buf RX psoc object struct
* @hal_soc: Opaque HAL SOC handle
* @osdev: QDF os device handle
* @dbr_pdev_objs: array of DBR pdev objects
* @dbr_pdev_obj: array of DBR pdev objects
* @mem_list: list for holding the large memories during the entire
* PSOC lifetime
* @mem_list_lock: spin lock for the memory list
* handler_ctx: Direct DMA event handler context
* @handler_ctx: Direct DMA event handler context
*/
struct direct_buf_rx_psoc_obj {
void *hal_soc;
@@ -299,7 +300,8 @@ QDF_STATUS target_if_direct_buf_rx_pdev_destroy_handler(
* target_if_direct_buf_rx_psoc_create_handler() - Handler invoked for
* direct buffer rx module
* during attach
* @pdev: pointer to psoc object
* @psoc: pointer to psoc object
* @data: callback context provided during registration
*
* Return : QDF status of operation
*/
@@ -310,7 +312,8 @@ QDF_STATUS target_if_direct_buf_rx_psoc_create_handler(
* target_if_direct_buf_rx_psoc_destroy_handler() - Handler invoked for
* direct buffer rx module
* during detach
* @pdev: pointer to psoc object
* @psoc: pointer to psoc object
* @data: callback context provided during registration
*
* Return : QDF status of operation
*/
@@ -364,7 +367,7 @@ QDF_STATUS target_if_direct_buf_rx_module_unregister(
* target_if_direct_buf_rx_get_ring_params() - Function to get ring parameters
* for module_id
* @pdev: pointer to pdev object
* @module_ring_params: pointer to store ring params
* @param: pointer to store ring params
* @mod_id: module idindicating module using direct buffer rx framework
* @srng_id: srng ID
*/

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2016-2019 The Linux Foundation. All rights reserved.
* Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -25,17 +25,17 @@
#ifndef _TARGET_IF_PUB_H_
#define _TARGET_IF_PUB_H_
struct target_pdev_info;
/**
* typedef target_pdev_info_t - Opaque definition of target pdev
* information structure
*/
struct target_pdev_info;
typedef struct target_pdev_info target_pdev_info_t;
struct target_psoc_info;
/**
* typedef target_psoc_info_t - Opaque definition of target psoc
* information structure
*/
struct target_psoc_info;
typedef struct target_psoc_info target_psoc_info_t;
#endif /* _TARGET_IF_PUB_H_ */

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -39,8 +39,8 @@
* @psoc: psoc
* @vdev_id: vdev id
* @pdev_id: pdev id
* @peer_macaddr: peer mac address
* @hw_qdesc: hw queue descriptor
* @peer_mac: peer mac address
* @hw_qdesc_paddr: hw queue descriptor
* @tid: tid number
* @queue_no: queue number
* @ba_window_size_valid: BA window size validity flag
@@ -89,7 +89,7 @@ target_if_peer_set_default_routing(struct cdp_ctrl_objmgr_psoc *psoc,
uint8_t lmac_peer_id_msb);
/**
* target_if_peer_rx_reorder_queue_setup() - setup rx reorder queue
* @pdev: pdev pointer
* @psoc: psoc pointer
* @pdev_id: pdev id
* @vdev_id: vdev id
* @peer_macaddr: peer mac address
@@ -128,7 +128,8 @@ target_if_peer_rx_reorder_queue_remove(struct cdp_ctrl_objmgr_psoc *psoc,
/**
* target_if_lro_hash_config() - send LRO hash config to FW
* @psoc_handle: psoc handle pointer
* @psoc: psoc pointer
* @pdev_id: pdev id
* @lro_hash_cfg: LRO hash config parameters
*
* return: QDF_STATUS_SUCCESS for success or error code

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2018 The Linux Foundation. All rights reserved.
*
* Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -58,9 +58,9 @@ target_if_ftm_detach(struct wlan_objmgr_psoc *psoc);
/**
* target_if_ftm_cmd_send() - Send WMI command for FTM requests
* @pdev: pdev pointer
* buf: data to be sent to FW
* len: length of the data
* pdev_id: pdev id
* @buf: data to be sent to FW
* @len: length of the data
* @pdev_id: pdev id
*
* Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
*/

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2018, 2020 The Linux Foundation. All rights reserved.
* Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021, 2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -46,6 +46,8 @@ target_if_ipa_uc_offload_control_req(struct wlan_objmgr_psoc *psoc,
}
/**
* target_if_ipa_intrabss_control_req() - Send IPA intra-BSS control request
* @psoc: psoc object
* @req: IPA intra bss enable/disable control param
*
* Return: QDF_STATUS_SUCCESS on success

View File

@@ -29,12 +29,13 @@
#include <wlan_lmac_if_api.h>
#include <init_deinit_lmac.h>
#include <wlan_mlo_mgr_setup.h>
/**
* target_if_mgmt_rx_reo_fw_consumed_event_handler() - WMI event handler to
* process MGMT Rx FW consumed event handler
* @scn: Pointer to scn object
* @data_buf: Pointer to event buffer
* @data_len: Length of event buffer
* @data: Pointer to event buffer
* @datalen: Length of event buffer
*
* Return: 0 for success, else failure
*/
@@ -251,6 +252,7 @@ target_if_mgmt_rx_reo_get_valid_hw_link_bitmap(struct wlan_objmgr_psoc *psoc,
* @mgmt_rx_reo_snapshot_low: Pointer to lower 32 bits of snapshot value
* @mgmt_rx_reo_snapshot_high: Pointer to higher 32 bits of snapshot value
* @snapshot_version: snapshot version
* @raw_snapshot: Raw snapshot data
*
* Read raw value of management rx-reorder snapshots.
*
@@ -324,6 +326,7 @@ target_if_mgmt_rx_reo_read_snapshot_raw
* @snapshot_info: Snapshot info
* @id: Snapshot ID
* @snapshot_value: Pointer to snapshot value
* @raw_snapshot: Raw snapshot data
*
* Read management rx-reorder snapshots from target.
*
@@ -609,7 +612,7 @@ target_if_mgmt_rx_reo_extract_reo_params(
/**
* target_if_mgmt_rx_reo_schedule_delivery() - Schedule the delivery of
* management frames of the given psoc
* @soc: Pointer to psoc object
* @psoc: Pointer to psoc object
*
* Return: QDF_STATUS
*/
@@ -637,7 +640,7 @@ target_if_mgmt_rx_reo_schedule_delivery(struct wlan_objmgr_psoc *psoc)
/**
* target_if_mgmt_rx_reo_cancel_scheduled_delivery() - Cancel the scheduled
* delivery of management frames of the given psoc
* @soc: Pointer to psoc object
* @psoc: Pointer to psoc object
*
* Return: QDF_STATUS
*/

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2013-2021 The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -31,7 +31,7 @@
#ifdef FEATURE_VDEV_OPS_WAKELOCK
/**
* struct wlan_vdev_wakelock - vdev wake lock sub structure
* struct psoc_mlme_wakelock - psoc wake lock sub structure
* @start_wakelock: wakelock for vdev start
* @stop_wakelock: wakelock for vdev stop
* @delete_wakelock: wakelock for vdev delete
@@ -60,9 +60,8 @@ enum wakelock_mode {
#ifdef FEATURE_VDEV_OPS_WAKELOCK
/**
* target_if_wake_lock_init() - API to initialize
wakelocks:start,
stop and delete.
* target_if_wake_lock_init() - API to initialize wakelocks:
* start, stop and delete.
* @psoc: pointer to psoc
*
* This also initialize the runtime lock
@@ -72,8 +71,8 @@ enum wakelock_mode {
void target_if_wake_lock_init(struct wlan_objmgr_psoc *psoc);
/**
* target_if_wake_lock_deinit() - API to destroy
wakelocks:start, stop and delete.
* target_if_wake_lock_deinit() - API to destroy wakelocks:
* start, stop and delete.
* @psoc: pointer to psoc
*
* This also destroy the runtime lock
@@ -83,9 +82,9 @@ void target_if_wake_lock_init(struct wlan_objmgr_psoc *psoc);
void target_if_wake_lock_deinit(struct wlan_objmgr_psoc *psoc);
/**
* target_if_start_wake_lock_timeout_acquire() - acquire the
vdev start wakelock
* target_if_wake_lock_timeout_acquire() - acquire the start wakelock
* @psoc: pointer to psoc
* @mode: wakelock mode
*
* This also acquires the target_if runtime pm lock.
*
@@ -94,9 +93,9 @@ void target_if_wake_lock_deinit(struct wlan_objmgr_psoc *psoc);
QDF_STATUS target_if_wake_lock_timeout_acquire(struct wlan_objmgr_psoc *psoc,
enum wakelock_mode mode);
/**
* target_if_start_wake_lock_timeout_release() - release the
start wakelock
* target_if_wake_lock_timeout_release() - release the start wakelock
* @psoc: pointer to psoc
* @mode: wakelock mode
*
* This also release the target_if runtime pm lock.
*
@@ -107,7 +106,7 @@ QDF_STATUS target_if_wake_lock_timeout_release(struct wlan_objmgr_psoc *psoc,
/**
* target_if_vdev_start_link_handler() - check for SAP mode and DFS freq
to handle link up/down
* to handle link up/down
* @vdev: pointer to vdev
* @is_restart: flag to check if it is vdev restart
*

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2019-2020 The Linux Foundation. All rights reserved.
* Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -61,8 +61,7 @@ target_if_vdev_mgr_get_tx_ops(struct wlan_objmgr_psoc *psoc)
}
/**
* target_if_vdev_mgr_vdev_mlme_register_tx_ops() - define mlme lmac
* tx ops functions
* target_if_vdev_mgr_register_tx_ops() - register vdev mgr tx ops functions
* @tx_ops: pointer to lmac tx ops
*
* Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
@@ -83,7 +82,7 @@ QDF_STATUS target_if_vdev_mgr_send_fd_tmpl(struct wlan_objmgr_vdev *vdev,
/**
* target_if_vdev_mgr_assert_mgmt() - vdev assert mgmt api
* @PSOC: pointer to objmgr psoc
* @psoc: pointer to objmgr psoc
* @vdev_id: vdev id
*
* Return: NA

View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2017-2018 The Linux Foundation. All rights reserved.
* Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -34,7 +35,7 @@ struct wlan_objmgr_psoc;
/**
* target_if_nlo_match_event_handler() - nlo match event handler
* @scn: scn handle
* @event: event data
* @data: event data
* @len: data length
*
* Record NLO match event comes from FW. It's a indication that
@@ -48,7 +49,7 @@ int target_if_nlo_match_event_handler(ol_scn_t scn, uint8_t *data,
/**
* target_if_nlo_complete_handler() - nlo complete event handler
* @scn: scn handle
* @event: event data
* @data: event data
* @len: data length
*
* Record NLO match event comes from FW. It's a indication that

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2013-2021 The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -35,7 +35,7 @@
/**
* target_if_wifi_pos_oem_data_req() - start OEM data request to target
* @psoc: pointer to psoc object mgr
* @pdev: pointer to pdev object mgr
* @req: start request params
*
* Return: QDF_STATUS