xref: /wlan-driver/qca-wifi-host-cmn/spectral/dispatcher/inc/cfg_spectral.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /**
20  * DOC: This file contains centralized cfg definitions of Spectral component
21  */
22 #ifndef __CONFIG_SPECTRAL_H
23 #define __CONFIG_SPECTRAL_H
24 
25 /*
26  * <ini>
27  * spectral_disable - disable spectral feature
28  * @Min: 0
29  * @Max: 1
30  * @Default: 0
31  *
32  * This ini is used to disable spectral feature.
33  *
34  * Related: None
35  *
36  * Supported Feature: Spectral
37  *
38  * Usage: External
39  *
40  * </ini>
41  */
42 #define CFG_SPECTRAL_DISABLE \
43 	CFG_INI_BOOL("spectral_disable", false, \
44 			"Spectral disable")
45 
46 /*
47  * <ini>
48  * poison_spectral_bufs - enable poisoning of spectral buffers
49  * @Min: 0
50  * @Max: 1
51  * @Default: 0
52  *
53  * This ini is used to enable the poisoning of spectral buffers.
54  *
55  * Related: None
56  *
57  * Supported Feature: Spectral
58  *
59  * Usage: Internal
60  *
61  * </ini>
62  */
63 #define CFG_SPECTRAL_POISON_BUFS \
64 	CFG_INI_BOOL("poison_spectral_bufs", false, \
65 			"Enable spectral bufs poison at init")
66 
67 #define CFG_SPECTRAL_ALL \
68 	CFG(CFG_SPECTRAL_DISABLE) \
69 	CFG(CFG_SPECTRAL_POISON_BUFS)
70 
71 #endif
72