xref: /wlan-driver/qca-wifi-host-cmn/dp/wifi3.0/dp_hist.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2020 The Linux Foundation. All rights reserved.
3  * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 /**
21  * DOC: dp_hist.h
22  *      histogram header file
23  */
24 
25 #ifndef __DP_HIST_H_
26 #define __DP_HIST_H_
27 
28 #define HIST_AVG_WEIGHT_DENOM 4
29 
30 /**
31  * dp_hist_update_stats() - Update histogram stats
32  * @hist_stats: Delay histogram
33  * @value: Delay value
34  *
35  * Return: void
36  */
37 void dp_hist_update_stats(struct cdp_hist_stats *hist_stats, int value);
38 
39 /**
40  * dp_hist_init() - Initialize the histogram object
41  * @hist_stats: Hist stats object
42  * @hist_type: Histogram type
43  */
44 void dp_hist_init(struct cdp_hist_stats *hist_stats,
45 		  enum cdp_hist_types hist_type);
46 
47 /**
48  * dp_accumulate_hist_stats() - Accumulate the hist src to dst
49  * @src_hist_stats: Source histogram stats
50  * @dst_hist_stats: Destination histogram stats
51  *
52  * Return: void
53  */
54 void dp_accumulate_hist_stats(struct cdp_hist_stats *src_hist_stats,
55 			      struct cdp_hist_stats *dst_hist_stats);
56 
57 /**
58  * dp_copy_hist_stats() - Copy the histogram stats
59  * @src_hist_stats: Source histogram stats
60  * @dst_hist_stats: Destination histogram stats
61  *
62  * Return: void
63  */
64 void dp_copy_hist_stats(struct cdp_hist_stats *src_hist_stats,
65 			struct cdp_hist_stats *dst_hist_stats);
66 
67 const char *dp_hist_tx_hw_delay_str(uint8_t index);
68 const char *dp_hist_delay_percentile_str(uint8_t index);
69 #endif /* __DP_HIST_H_ */
70