qcacmn: Fix dp wifi3.0 documentation

The kernel-doc script identified a large number of kernel-doc issues
in the dp/wifi3.0 folder. A series of patches have addressed most of
the issues, so now fix the remaining issues. Just like in the previous
patches, there are a number of instances where public functions have
their implementation documented instead of having their interface
documented, so make sure that the interfaces are documented.

Change-Id: I4bc39b0e1a9d8c264b72ec6db76ff7e92d24f277
CRs-Fixed: 3373822
Šī revīzija ir iekļauta:
Jeff Johnson
2023-01-06 15:48:53 -08:00
revīziju iesūtīja Madan Koyyalamudi
vecāks b2294c287e
revīzija 3cbfba9824
9 mainīti faili ar 68 papildinājumiem un 336 dzēšanām

Parādīt failu

@@ -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
@@ -18,8 +18,8 @@
*/
/**
* @file dp_hist.h
* @brief: histogram header file
* DOC: dp_hist.h
* histogram header file
*/
#ifndef __DP_HIST_H_
@@ -27,20 +27,43 @@
#define HIST_AVG_WEIGHT_DENOM 4
/*
* dp_hist_update_stats: Update histogram stats
* @hist_delay: Delay histogram
/**
* dp_hist_update_stats() - Update histogram stats
* @hist_stats: Delay histogram
* @value: Delay value
*
* Return: void
*/
void dp_hist_update_stats(struct cdp_hist_stats *hist_stats, int value);
/**
* dp_hist_init() - Initialize the histogram object
* @hist_stats: Hist stats object
* @hist_type: Histogram type
*/
void dp_hist_init(struct cdp_hist_stats *hist_stats,
enum cdp_hist_types hist_type);
/**
* dp_accumulate_hist_stats() - Accumulate the hist src to dst
* @src_hist_stats: Source histogram stats
* @dst_hist_stats: Destination histogram stats
*
* Return: void
*/
void dp_accumulate_hist_stats(struct cdp_hist_stats *src_hist_stats,
struct cdp_hist_stats *dst_hist_stats);
/**
* dp_copy_hist_stats() - Copy the histogram stats
* @src_hist_stats: Source histogram stats
* @dst_hist_stats: Destination histogram stats
*
* Return: void
*/
void dp_copy_hist_stats(struct cdp_hist_stats *src_hist_stats,
struct cdp_hist_stats *dst_hist_stats);
const char *dp_hist_tx_hw_delay_str(uint8_t index);
const char *dp_hist_delay_percentile_str(uint8_t index);
#endif /* __DP_HIST_H_ */