samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qcacld-3.0: Fix Target Interface Documentation

Browse Source 
The kernel-doc script identified some documentation issues in
components/target_if, so fix them.

Change-Id: Id925b899074b1e9491cc3b9a3066420512459770
CRs-Fixed: 3359868
This commit is contained in:
Jeff Johnson
2023-01-04 12:54:38 -08:00
committed by Madan Koyyalamudi
parent 884f011576
commit a38d67be64
15 changed files with 46 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/target_if/coap/inc/target_if_coap.h
View File

@@ -1,5 +1,5 @@
/*
* 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
@@ -33,7 +33,7 @@ target_if_coap_register_tx_ops(struct wlan_lmac_if_tx_ops *tx_ops);
/**
* target_if_coap_get_tx_ops() - get tx ops
* @tx_ops: pointer to target_if tx ops
* @psoc: pointer to psoc object
*
* API to retrieve the CoAP tx ops from the psoc context
*

4
components/target_if/coex/src/target_if_coex.c
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 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 above
@@ -84,7 +84,7 @@ target_if_dbam_process_event(struct wlan_objmgr_psoc *psoc,
* event from firmware.
* @scn: scn handle
* @data: data buffer foe the event
* @data_len: data length
* @len: data length
*
* Return: 0 on success, and error code on failure
*/

8
components/target_if/connection_mgr/src/target_if_cm_roam_offload.c
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2020-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 above
@@ -1015,7 +1015,7 @@ target_if_cm_roam_scan_offload_rssi_thresh(
}
/**
* target_if_roam_scan_offload_scan_period() - set roam offload scan period
* target_if_cm_roam_scan_offload_scan_period() - set roam offload scan period
* @wmi_handle: wmi handle
* @req: roam scan period parameters
*
@@ -1318,7 +1318,7 @@ target_if_cm_roam_send_roam_init(struct wlan_objmgr_vdev *vdev,
/**
* target_if_cm_roam_scan_rssi_change_cmd() - Send WMI_ROAM_SCAN_RSSI_CHANGE
* command to firmware
* @vdev: Vdev object
* @wmi_handle: WMI handle
* @params: RSSI change parameters
*
* Return: QDF_STATUS
@@ -1368,7 +1368,7 @@ target_if_cm_roam_send_time_sync_cmd(wmi_unified_t wmi_handle)
#ifdef WLAN_FEATURE_11BE_MLO
/**
* target_if_cm_roam_send_start() - Send roam mlo related commands
* target_if_cm_roam_send_mlo_config() - Send roam mlo related commands
* to wmi
* @vdev: vdev object
* @req: roam mlo config parameters

3
components/target_if/cp_stats/src/target_if_mc_cp_stats.c
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
@@ -1564,6 +1564,7 @@ static uint32_t get_stats_id(enum stats_req_type type)
/**
* target_if_cp_stats_send_stats_req() - API to send stats request to wmi
* @psoc: pointer to psoc object
* @type: Type of stats requested
* @req: pointer to object containing stats request parameters
*
* Return: status of operation.

5
components/target_if/disa/inc/target_if_disa.h
View File

@@ -1,5 +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
@@ -60,7 +61,7 @@ int target_if_encrypt_decrypt_event_handler(ol_scn_t scn_handle, uint8_t *data,
void target_if_disa_register_tx_ops(struct wlan_disa_tx_ops *tx_ops);
/**
* target_if_disa_register_ev_handler() - Register disa event handlers.
* target_if_disa_register_ev_handlers() - Register disa event handlers.
* @psoc:objmgr psoc handle
*
* Return: QDF status
@@ -69,7 +70,7 @@ QDF_STATUS
target_if_disa_register_ev_handlers(struct wlan_objmgr_psoc *psoc);
/**
* target_if_disa_register_ev_handler() - Unregister disa event handlers.
* target_if_disa_unregister_ev_handlers() - Unregister disa event handlers.
* @psoc:objmgr psoc handle
*
* Return: QDF status

4
components/target_if/dp/src/target_if_dp_comp.c
View File

@@ -1,5 +1,5 @@
/*
* 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
@@ -33,7 +33,7 @@
#include <wlan_cm_api.h>
/**
* target_if_dp_arp_stats_event_handler() - arp stats event handler
* target_if_dp_get_arp_stats_event_handler() - arp stats event handler
* @scn: scn
* @data: buffer with event
* @datalen: buffer length

5
components/target_if/fw_offload/src/target_if_fwol.c
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2019-2021 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
@@ -437,7 +438,7 @@ target_if_fwol_register_thermal_throttle_handler(struct wlan_objmgr_psoc *psoc)
}
/**
* target_if_fwol_unregister_thermal_stats_handler() - Register handler for
* target_if_fwol_unregister_thermal_throttle_handler() - Unregister handler for
* thermal throttle stats firmware event
* @psoc: psoc object
*
@@ -473,7 +474,7 @@ target_if_fwol_unregister_thermal_throttle_handler(
/**
* target_if_fwol_set_mdns_config() - Set mdns Config to FW
* @psoc: pointer to PSOC object
* @offload_info: pointer to mdns config info
* @mdns_info: pointer to mdns config info
*
* Return: QDF_STATUS_SUCCESS on success
*/

4
components/target_if/interop_issues_ap/src/target_if_interop_issues_ap.c
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2019-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
@@ -35,6 +36,7 @@
/**
* target_if_interop_issues_ap_event_handler() - callback for event
* @sc: scn handle
* @event: firmware event
* @len: the event length
*
@@ -139,7 +141,7 @@ target_if_interop_issues_ap_unregister_event_handler(
/**
* target_if_set_interop_issues_ap_req() - API to send stats request to wmi
* @psoc: pointer to psoc object
* @raq: pointer to interop issues ap info
* @rap: pointer to interop issues ap info
*
* Return: status of operation.
*/

3
components/target_if/nan/inc/target_if_nan.h
View File

@@ -1,5 +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
@@ -67,7 +68,7 @@ void target_if_nan_register_tx_ops(struct wlan_nan_tx_ops *tx_ops);
/**
* target_if_nan_register_rx_ops() - registers nan rx ops
* @tx_ops: rx ops
* @rx_ops: rx ops
*
* Return: none
*/

3
components/target_if/p2p/inc/target_if_p2p.h
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
@@ -115,7 +116,7 @@ QDF_STATUS target_if_p2p_unregister_noa_event_handler(
/**
* target_if_p2p_set_ps() - Set power save
* @psoc: soc object
* @arg: additional argument
* @ps_config: powersave configuration
*
* Target interface API to set power save.
*

10
components/target_if/p2p/src/target_if_p2p.c
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2017-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
@@ -49,8 +49,8 @@ target_if_p2p_lo_register_tx_ops(struct wlan_lmac_if_p2p_tx_ops *p2p_tx_ops)
/**
* target_p2p_lo_event_handler() - WMI callback for lo stop event
* @scn: pointer to scn
* @event_buf: event buffer
* @len: buffer length
* @data: event buffer
* @datalen: buffer length
*
* This function gets called from WMI when triggered wmi event
* wmi_p2p_lo_stop_event_id.
@@ -203,8 +203,8 @@ target_if_p2p_lo_register_tx_ops(struct wlan_lmac_if_p2p_tx_ops *p2p_tx_ops)
/**
* target_p2p_noa_event_handler() - WMI callback for noa event
* @scn: pointer to scn
* @event_buf: event buffer
* @len: buffer length
* @data: event buffer
* @datalen: buffer length
*
* This function gets called from WMI when triggered WMI event
* wmi_p2p_noa_event_id.

6
components/target_if/p2p/src/target_if_p2p_mcc_quota.c
View File

@@ -1,5 +1,5 @@
/*
* 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
@@ -29,8 +29,8 @@
/**
* target_if_mcc_quota_event_handler() - WMI callback for mcc_quota
* @scn: pointer to scn
* @event_buf: event buffer
* @len: buffer length
* @data: event buffer
* @datalen: buffer length
*
* This function gets called from WMI when triggered WMI event
* WMI_RESMGR_CHAN_TIME_QUOTA_CHANGED_EVENTID

17
components/target_if/pmo/inc/target_if_pmo.h
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2017-2021 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
@@ -32,7 +33,6 @@
* target_if_pmo_enable_wow_wakeup_event() - Enable wow wakeup events.
* @vdev:objmgr vdev handle
* @bitmap: Event bitmap
* @enable: enable/disable
*
* Return: QDF status
*/
@@ -43,7 +43,6 @@ QDF_STATUS target_if_pmo_enable_wow_wakeup_event(struct wlan_objmgr_vdev *vdev,
* target_if_pmo_disable_wow_wakeup_event() - Disable wow wakeup events.
* @vdev:objmgr vdev handle
* @bitmap: Event bitmap
* @enable: enable/disable
*
* Return: QDF status
*/
@@ -75,7 +74,7 @@ QDF_STATUS target_if_pmo_del_wow_patterns_to_fw(struct wlan_objmgr_vdev *vdev,
/**
* target_if_pmo_send_enhance_mc_offload_req() - send enhance mc offload req
* @vdev: objmgr vdev
* @action: enable or disable enhance multicast offload
* @enable: enable or disable enhance multicast offload
*
* Return: QDF_STATUS_SUCCESS on success else error code
*/
@@ -86,7 +85,7 @@ QDF_STATUS target_if_pmo_send_enhance_mc_offload_req(
/**
* target_if_pmo_set_mc_filter_req() - set mcast filter command to fw
* @vdev: objmgr vdev handle
* @multicastAddr: mcast address
* @multicast_addr: mcast address
*
* Return: 0 for success or error code
*/
@@ -96,7 +95,7 @@ QDF_STATUS target_if_pmo_set_mc_filter_req(struct wlan_objmgr_vdev *vdev,
/**
* target_if_pmo_clear_mc_filter_req() - clear mcast filter command to fw
* @vdev: objmgr vdev handle
* @multicastAddr: mcast address
* @multicast_addr: mcast address
*
* Return: 0 for success or error code
*/
@@ -117,7 +116,7 @@ bool target_if_pmo_get_multiple_mc_filter_support(
* target_if_pmo_set_multiple_mc_filter_req() - set multiple mcast filter
* command to fw
* @vdev: objmgr vdev handle
* @multicastAddr: mcast address
* @mc_list: mcast address list
*
* Return: 0 for success or error code
*/
@@ -129,7 +128,7 @@ QDF_STATUS target_if_pmo_set_multiple_mc_filter_req(
* target_if_pmo_clear_multiple_mc_filter_req() - clear multiple mcast
* filter command to fw
* @vdev: objmgr vdev handle
* @multicastAddr: mcast address
* @mc_list: mcast address list
*
* Return: 0 for success or error code
*/
@@ -150,8 +149,8 @@ QDF_STATUS target_if_pmo_send_ra_filter_req(struct wlan_objmgr_vdev *vdev,
/**
* target_if_pmo_send_action_frame_patterns() - register action frame map to fw
* @handle: Pointer to wma handle
* @vdev_id: VDEV ID
* @vdev: objmgr vdev handle
* @ip_cmd: Action frame wakeup params
*
* This is called to push action frames wow patterns from local
* cache to firmware.

3
components/target_if/pmo/src/target_if_pmo_lphb.c
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2017-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
@@ -188,7 +189,7 @@ QDF_STATUS target_if_pmo_send_lphb_udp_params(struct wlan_objmgr_psoc *psoc,
}
/**
* target_if_pmo_lphb_send_udp_pkt_filter() - Send LPHB udp pkt filter req
* target_if_pmo_send_lphb_udp_pkt_filter() - Send LPHB udp pkt filter req
* @psoc: objmgr psoc handle
* @ts_lphb_udp_filter: lphb udp filter request which needs to configure in fwr
*

8
components/target_if/twt/src/target_if_ext_twt_evt.c
View File

@@ -1,5 +1,5 @@
/*
* 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
@@ -191,8 +191,7 @@ done:
}
/**
* target_if_twt_resume_dialog_complete_event_handler - TWT resume dlg
* complete evt handler
* target_if_twt_resume_complete_event_handler - TWT resume complete evt handler
* @scn: scn
* @event: buffer with event
* @len: buffer length
@@ -249,8 +248,7 @@ done:
}
/**
* target_if_twt_nudge_dialog_complete_event_handler - TWT nudge dlg
* complete evt handler
* target_if_twt_nudge_complete_event_handler - TWT nudge complete evt handler
* @scn: scn
* @event: buffer with event
* @len: buffer length