qcacmn: Fix target_if/init_deinit documentation
The kernel-doc script identified documentation issues in the target_if/init_deinit folder, so fix them. Change-Id: Ie2ddb73072629b0b1a110b8073443f312fa27a16 CRs-Fixed: 3417468
This commit is contained in:

committed by
Madan Koyyalamudi

vanhempi
bc5d273b9e
commit
045d6e4e78
@@ -1,5 +1,6 @@
|
||||
/*
|
||||
* Copyright (c) 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
|
||||
@@ -52,7 +53,7 @@ QDF_STATUS init_deinit_handle_host_mem_req(
|
||||
/**
|
||||
* init_deinit_free_num_units() - Free allocated mem chunks
|
||||
* @psoc: PSOC object
|
||||
* @tgt_info: PSOC_INFO object
|
||||
* @tgt_hdl: PSOC_INFO object
|
||||
*
|
||||
* API to free memory
|
||||
*
|
||||
|
@@ -1,6 +1,6 @@
|
||||
/*
|
||||
* Copyright (c) 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 above
|
||||
@@ -32,7 +32,7 @@
|
||||
#define MGMT_RX_REO_INVALID_SNAPSHOT_VERSION (-1)
|
||||
|
||||
/**
|
||||
* wlan_host_mlo_glb_h_shmem_params - MLO global shared memory parameters
|
||||
* struct wlan_host_mlo_glb_h_shmem_params - MLO global shared memory parameters
|
||||
* @major_version: Major version
|
||||
* @minor_version: Minor version
|
||||
*/
|
||||
@@ -42,8 +42,8 @@ struct wlan_host_mlo_glb_h_shmem_params {
|
||||
};
|
||||
|
||||
/**
|
||||
* wlan_host_mlo_glb_rx_reo_per_link_info - MGMT Rx REO information of a link in
|
||||
* MLO global shared memory
|
||||
* struct wlan_host_mlo_glb_rx_reo_per_link_info - MGMT Rx REO
|
||||
* information of a link in MLO global shared memory
|
||||
* @link_id: Hardware link ID
|
||||
* @fw_consumed: Address of FW consumed snapshot
|
||||
* @fw_forwarded: Address of FW forwarded snapshot
|
||||
@@ -57,8 +57,8 @@ struct wlan_host_mlo_glb_rx_reo_per_link_info {
|
||||
};
|
||||
|
||||
/**
|
||||
* wlan_host_mlo_glb_rx_reo_snapshot_info - MGMT Rx REO information in MLO
|
||||
* global shared memory
|
||||
* struct wlan_host_mlo_glb_rx_reo_snapshot_info - MGMT Rx REO
|
||||
* information in MLO global shared memory
|
||||
* @num_links: Number of valid links
|
||||
* @valid_link_bmap: Valid link bitmap
|
||||
* @link_info: pointer to an array of Rx REO per-link information
|
||||
@@ -76,8 +76,8 @@ struct wlan_host_mlo_glb_rx_reo_snapshot_info {
|
||||
};
|
||||
|
||||
/**
|
||||
* wlan_host_mlo_glb_per_chip_crash_info - per chip crash information in MLO
|
||||
* global shared memory
|
||||
* struct wlan_host_mlo_glb_per_chip_crash_info - per chip crash
|
||||
* information in MLO global shared memory
|
||||
* @chip_id: MLO Chip ID
|
||||
* @crash_reason: Address of the crash_reason corresponding to chip_id
|
||||
*/
|
||||
@@ -86,9 +86,11 @@ struct wlan_host_mlo_glb_per_chip_crash_info {
|
||||
void *crash_reason;
|
||||
};
|
||||
|
||||
/**
|
||||
* wlan_host_mlo_glb_chip_crash_info - chip crash information in MLO
|
||||
* global shared memory
|
||||
/*
|
||||
* NB: intentionally not using kernel-doc comment because the kernel-doc
|
||||
* script does not handle the qdf_bitmap() macro
|
||||
* struct wlan_host_mlo_glb_chip_crash_info - chip crash information in MLO
|
||||
* global shared memory
|
||||
* @no_of_chips: No of partner chip to which crash information is shared
|
||||
* @valid_chip_bmap: Bitmap to indicate the chip to which the crash information
|
||||
* is shared
|
||||
@@ -102,9 +104,11 @@ struct wlan_host_mlo_glb_chip_crash_info {
|
||||
};
|
||||
|
||||
/**
|
||||
* wlan_host_mlo_glb_h_shmem_arena_ctx - MLO Global shared memory arena context
|
||||
* struct wlan_host_mlo_glb_h_shmem_arena_ctx - MLO Global shared
|
||||
* memory arena context
|
||||
* @shmem_params: shared memory parameters
|
||||
* @rx_reo_snapshot_info: MGMT Rx REO snapshot information
|
||||
* @chip_crash_info: chip crash information
|
||||
* @init_count: Number of init calls
|
||||
*/
|
||||
struct wlan_host_mlo_glb_h_shmem_arena_ctx {
|
||||
|
@@ -1,6 +1,6 @@
|
||||
/*
|
||||
* Copyright (c) 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 above
|
||||
@@ -31,7 +31,7 @@
|
||||
/**
|
||||
* global_shmem_register_wifi3_0_ops() - Register wifi3.0 operations of
|
||||
* global shared memory access module
|
||||
* @shmem_tx_ops: Pointer to the local ops table of global shared mem module.
|
||||
* @shmem_local_ops: Pointer to the local ops table of global shared mem module.
|
||||
*
|
||||
* Return: QDF_STATUS of operation
|
||||
*/
|
||||
|
@@ -143,7 +143,13 @@ struct wlan_psoc_host_hal_reg_cap_ext {
|
||||
* @phy_id: Starts with 0
|
||||
* @phy_idx: Index to mac phy caps structure for the given hw_mode_id and phy_id
|
||||
* @hw_mode_config_type: holds the enum wmi_hw_mode_config_type
|
||||
* @bitmap of supported modulations
|
||||
* @supports_11b: is 802.11b supported
|
||||
* @supports_11g: is 802.11g supported
|
||||
* @supports_11a: is 802.11a supported
|
||||
* @supports_11n: is 802.11n supported
|
||||
* @supports_11ac: is 802.11ac supported
|
||||
* @supports_11ax: is 802.11ax supported
|
||||
* @supports_11be: is 802.11be supported
|
||||
* @supported_bands: supported bands, enum WLAN_BAND_CAPABILITY
|
||||
* @ampdu_density: ampdu density 0 for no restriction, 1 for 1/4 us,
|
||||
* 2 for 1/2 us, 3 for 1 us,4 for 2 us, 5 for 4 us,
|
||||
@@ -158,7 +164,7 @@ struct wlan_psoc_host_hal_reg_cap_ext {
|
||||
* - 1 indicates support for VHT-MCS 0-8 for n spatial streams
|
||||
* - 2 indicates support for VHT-MCS 0-9 for n spatial streams
|
||||
* - 3 indicates that n spatial streams is not supported
|
||||
* @he_cap_info_2G[]: HE capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @he_cap_info_2G: HE capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @he_supp_mcs_2G: HE Supported MCS Set field Rx/Tx same
|
||||
* @tx_chain_mask_2G: Valid Transmit chain mask
|
||||
* @rx_chain_mask_2G: Valid Receive chain mask
|
||||
@@ -172,7 +178,7 @@ struct wlan_psoc_host_hal_reg_cap_ext {
|
||||
* - 1 indicates support for VHT-MCS 0-8 for n spatial streams
|
||||
* - 2 indicates support for VHT-MCS 0-9 for n spatial streams
|
||||
* - 3 indicates that n spatial streams is not supported
|
||||
* @he_cap_info_5G[]: HE capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @he_cap_info_5G: HE capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @he_supp_mcs_5G: HE Supported MCS Set field Rx/Tx same
|
||||
* @tx_chain_mask_5G: Valid Transmit chain mask
|
||||
* @rx_chain_mask_5G: Valid Receive chain mask
|
||||
@@ -187,7 +193,7 @@ struct wlan_psoc_host_hal_reg_cap_ext {
|
||||
* @tgt_pdev_id: target pdev id assigned and used by firmware
|
||||
* @nss_ratio_enabled: This flag is set if nss ratio is received from FW as part
|
||||
* of service ready ext event.
|
||||
* @nss_ratio: nss ratio is used to calculate the NSS value for 160MHz.
|
||||
* @nss_ratio_info: nss ratio is used to calculate the NSS value for 160MHz.
|
||||
* @hw_link_id: Unique link id across SoCs used to identify link in Multi-SoC ML
|
||||
*/
|
||||
struct wlan_psoc_host_mac_phy_caps {
|
||||
@@ -253,15 +259,15 @@ struct wlan_psoc_host_hw_mode_caps {
|
||||
uint32_t hw_mode_config_type;
|
||||
};
|
||||
|
||||
/*
|
||||
/**
|
||||
* struct wlan_psoc_host_mac_phy_caps_ext2 - Phy caps received in EXT2 service
|
||||
* @hw_mode_id: HW mode id
|
||||
* @pdev_id: Pdev id
|
||||
* @phy_id: Phy id
|
||||
* @wireless_modes_ext: Extended wireless modes
|
||||
* @eht_cap_info_2G[]: EHT capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @eht_cap_info_2G: EHT capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @eht_supp_mcs_2G: EHT Supported MCS Set field Rx/Tx same
|
||||
* @eht_cap_info_5G[]: EHT capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @eht_cap_info_5G: EHT capability info field of 802.11ax, WMI_HE_CAP defines
|
||||
* @eht_supp_mcs_5G: EHT Supported MCS Set field Rx/Tx same
|
||||
* @eht_cap_phy_info_2G: 2G EHT capability phy field
|
||||
* @eht_cap_phy_info_5G: 5G EHT capability phy field
|
||||
@@ -404,7 +410,7 @@ struct wlan_psoc_host_chainmask_table {
|
||||
* struct wlan_psoc_host_service_ext_param - EXT service base params in event
|
||||
* @default_conc_scan_config_bits: Default concurrenct scan config
|
||||
* @default_fw_config_bits: Default HW config bits
|
||||
* @wlan_psoc_host_ppe_threshold ppet: Host PPE threshold struct
|
||||
* @ppet: Host PPE threshold struct
|
||||
* @he_cap_info: HE capabality info
|
||||
* @mpdu_density: units are microseconds
|
||||
* @max_bssid_rx_filters: Maximum no of BSSID based RX filters host can program
|
||||
@@ -442,10 +448,10 @@ struct wlan_psoc_host_service_ext_param {
|
||||
|
||||
/**
|
||||
* struct wlan_psoc_host_service_ext2_param - EXT service base params in event
|
||||
* reg_db_version_major: REG DB version major number
|
||||
* reg_db_version_minor: REG DB version minor number
|
||||
* bdf_reg_db_version_major: BDF REG DB version major number
|
||||
* bdf_reg_db_version_minor: BDF REG DB version minor number
|
||||
* @reg_db_version_major: REG DB version major number
|
||||
* @reg_db_version_minor: REG DB version minor number
|
||||
* @bdf_reg_db_version_major: BDF REG DB version major number
|
||||
* @bdf_reg_db_version_minor: BDF REG DB version minor number
|
||||
* @num_dbr_ring_caps: Number of direct buf rx ring capabilities
|
||||
* @chwidth_num_peer_caps: Peer limit for peer_chan_width_switch WMI cmd
|
||||
* @max_ndp_sessions: Max number of ndp session fw supports
|
||||
@@ -461,7 +467,7 @@ struct wlan_psoc_host_service_ext_param {
|
||||
* @target_cap_flags: Rx peer metadata version number used by target
|
||||
* @ul_mumimo_tx_2g: UL MUMIMO Tx support for 2GHz
|
||||
* @ul_mumimo_tx_5g: UL MUMIMO Tx support for 5GHz
|
||||
* @ul_mumimo_tx_5g: UL MUMIMO Tx support for 6GHz
|
||||
* @ul_mumimo_tx_6g: UL MUMIMO Tx support for 6GHz
|
||||
* @ul_mumimo_rx_2g: UL MUMIMO Rx support for 2GHz
|
||||
* @ul_mumimo_rx_5g: UL MUMIMO Rx support for 5GHz
|
||||
* @ul_mumimo_rx_6g: UL MUMIMO Rx support for 6GHz
|
||||
|
@@ -188,6 +188,7 @@ extract_mgmt_rx_reo_snapshot_tlv(uint8_t *data, size_t remaining_len,
|
||||
* RX_REO_PER_LINK_SNAPSHOT_INFO TLV
|
||||
* @data: Pointer to start of the TLV
|
||||
* @remaining_len: Length (in bytes) remaining in the arena from @data pointer
|
||||
* @link_id: link ID of interest
|
||||
* @link_info: Pointer to MGMT Rx REO per link info. Extracted information
|
||||
* will be populated in this data structure.
|
||||
*
|
||||
@@ -218,7 +219,7 @@ extract_mlo_glb_rx_reo_per_link_info_tlv(
|
||||
|
||||
link_info->link_id = link_id;
|
||||
|
||||
/**
|
||||
/*
|
||||
* Get the pointer to the fw_consumed snapshot with in the TLV.
|
||||
* Note that snapshots are nested TLVs within link_sanpshot_info TLV.
|
||||
*/
|
||||
@@ -249,7 +250,7 @@ extract_mlo_glb_rx_reo_per_link_info_tlv(
|
||||
validate_parsed_bytes_advance_data_pointer(len, data, remaining_len);
|
||||
parsed_bytes += len;
|
||||
|
||||
/**
|
||||
/*
|
||||
* Return the length of link_sanpshot_info TLV itself as the snapshots
|
||||
* are nested inside link_sanpshot_info TLV and hence no need to add
|
||||
* their lengths separately.
|
||||
|
@@ -1,6 +1,6 @@
|
||||
/*
|
||||
* Copyright (c) 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 above
|
||||
@@ -53,8 +53,8 @@ static uint16_t mgmt_rx_reo_snapshot_get_mgmt_pkt_ctr(uint32_t snapshot_low,
|
||||
}
|
||||
|
||||
/**
|
||||
* mgmt_rx_reo_snapshot_get_mgmt_pkt_ctr() - Get the redundant management packet
|
||||
* counter from MGMT Rx REO snapshot
|
||||
* mgmt_rx_reo_snapshot_get_redundant_mgmt_pkt_ctr() - Get the
|
||||
* redundant management packet counter from MGMT Rx REO snapshot
|
||||
* @snapshot_high: higher 32-bits of the snapshot
|
||||
*
|
||||
* Return: Redundant management packet counter of the snapshot
|
||||
@@ -88,6 +88,7 @@ static bool mgmt_rx_reo_snapshot_is_consistent(uint32_t snapshot_low,
|
||||
* MGMT Rx REO snapshot
|
||||
* @snapshot_low: lower 32-bits of the snapshot
|
||||
* @snapshot_high: higher 32-bits of the snapshot
|
||||
* @snapshot_version: snapshot version id
|
||||
*
|
||||
* Return: Global timestamp of the snapshot
|
||||
*/
|
||||
|
@@ -263,7 +263,7 @@ static bool new_hw_mode_preferred(uint32_t current_hw_mode,
|
||||
}
|
||||
|
||||
/**
|
||||
* select_preferred_mode() - Select preferred hw mode based on current mode.
|
||||
* select_preferred_hw_mode() - Select preferred hw mode based on current mode.
|
||||
* @tgt_hdl: target_psoc_info object
|
||||
* @hw_mode_caps: HW mode caps of new mode id that needs to checked for
|
||||
* selection.
|
||||
@@ -645,7 +645,7 @@ qdf_export_symbol(init_deinit_spectral_scaling_params_free);
|
||||
* init_deinit_update_phy_reg_cap() - Update the low/high frequency for phy0.
|
||||
* @psoc: PSOC common object
|
||||
* @info: FW or lower layer related info
|
||||
* @wlan_psoc_host_hal_reg_capabilities_ext: Reg caps per PHY
|
||||
* @reg_cap: Reg caps per PHY
|
||||
*
|
||||
* For the DBS_SBS capable board, update the low or high frequency
|
||||
* for phy0 by leveraging the frequency populated for phy2
|
||||
|
Viittaa uudesa ongelmassa
Block a user