xref: /freebsd/sys/dev/ice/ice_common_sysctls.h (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*  Copyright (c) 2023, Intel Corporation
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above copyright notice,
9  *      this list of conditions and the following disclaimer.
10  *
11  *   2. Redistributions in binary form must reproduce the above copyright
12  *      notice, this list of conditions and the following disclaimer in the
13  *      documentation and/or other materials provided with the distribution.
14  *
15  *   3. Neither the name of the Intel Corporation nor the names of its
16  *      contributors may be used to endorse or promote products derived from
17  *      this software without specific prior written permission.
18  *
19  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  *  POSSIBILITY OF SUCH DAMAGE.
30  */
31 /*$FreeBSD$*/
32 
33 /**
34  * @file ice_common_sysctls.h
35  * @brief driver wide sysctls not related to the iflib stack
36  *
37  * Contains static sysctl values which are driver wide and configure all
38  * devices of the driver at once.
39  *
40  * Device specific sysctls are setup by functions in ice_lib.c
41  */
42 
43 #ifndef _ICE_COMMON_SYSCTLS_H_
44 #define _ICE_COMMON_SYSCTLS_H_
45 
46 #include <sys/sysctl.h>
47 
48 /**
49  * @var ice_enable_irdma
50  * @brief boolean indicating if the iRDMA client interface is enabled
51  *
52  * Global sysctl variable indicating whether the RDMA client interface feature
53  * is enabled.
54  */
55 bool ice_enable_irdma = true;
56 
57 /**
58  * @var ice_enable_tx_fc_filter
59  * @brief boolean indicating if the Tx Flow Control filter should be enabled
60  *
61  * Global sysctl variable indicating whether the Tx Flow Control filters
62  * should be enabled. If true, Ethertype 0x8808 packets will be dropped if
63  * they come from non-HW sources. If false, packets coming from software will
64  * not be dropped. Leave this on if unless you must send flow control frames
65  * (or other control frames) from software.
66  *
67  * @remark each PF has a separate sysctl which can override this value.
68  */
69 bool ice_enable_tx_fc_filter = true;
70 
71 /**
72  * @var ice_enable_tx_lldp_filter
73  * @brief boolean indicating if the Tx LLDP filter should be enabled
74  *
75  * Global sysctl variable indicating whether the Tx Flow Control filters
76  * should be enabled. If true, Ethertype 0x88cc packets will be dropped if
77  * they come from non-HW sources. If false, packets coming from software will
78  * not be dropped. Leave this on if unless you must send LLDP frames from
79  * software.
80  *
81  * @remark each PF has a separate sysctl which can override this value.
82  */
83 bool ice_enable_tx_lldp_filter = true;
84 
85 /**
86  * @var ice_enable_health_events
87  * @brief boolean indicating if health status events from the FW should be reported
88  *
89  * Global sysctl variable indicating whether the Health Status events from the
90  * FW should be enabled. If true, if an event occurs, the driver will print out
91  * a message with a description of the event and possible actions to take.
92  *
93  * @remark each PF has a separate sysctl which can override this value.
94  */
95 bool ice_enable_health_events = true;
96 
97 /**
98  * @var ice_tx_balance_en
99  * @brief boolean permitting the 5-layer scheduler topology enablement
100  *
101  * Global sysctl variable indicating whether the driver will allow the
102  * 5-layer scheduler topology feature to be enabled. It's _not_
103  * specifically enabling the feature, just allowing it depending on what
104  * the DDP package allows.
105  */
106 bool ice_tx_balance_en = true;
107 
108 /**
109  * @var ice_rdma_max_msix
110  * @brief maximum number of MSI-X vectors to reserve for RDMA interface
111  *
112  * Global sysctl variable indicating the maximum number of MSI-X vectors to
113  * reserve for a single RDMA interface.
114  */
115 static uint16_t ice_rdma_max_msix = ICE_RDMA_MAX_MSIX;
116 
117 /* sysctls marked as tunable, (i.e. with the CTLFLAG_TUN set) will
118  * automatically load tunable values, without the need to manually create the
119  * TUNABLE definition.
120  *
121  * This works since at least FreeBSD 11, and was backported into FreeBSD 10
122  * before the FreeBSD 10.1-RELEASE.
123  *
124  * If the tunable needs a custom loader, mark the SYSCTL as CTLFLAG_NOFETCH,
125  * and create the tunable manually.
126  */
127 
128 static SYSCTL_NODE(_hw, OID_AUTO, ice, CTLFLAG_RD, 0, "ICE driver parameters");
129 
130 static SYSCTL_NODE(_hw_ice, OID_AUTO, debug, ICE_CTLFLAG_DEBUG | CTLFLAG_RD, 0,
131 		   "ICE driver debug parameters");
132 
133 SYSCTL_BOOL(_hw_ice, OID_AUTO, enable_health_events, CTLFLAG_RDTUN,
134 	    &ice_enable_health_events, 0,
135 	    "Enable FW health event reporting globally");
136 
137 SYSCTL_BOOL(_hw_ice, OID_AUTO, irdma, CTLFLAG_RDTUN, &ice_enable_irdma, 0,
138 	    "Enable iRDMA client interface");
139 
140 SYSCTL_U16(_hw_ice, OID_AUTO, rdma_max_msix, CTLFLAG_RDTUN, &ice_rdma_max_msix,
141 	   0, "Maximum number of MSI-X vectors to reserve per RDMA interface");
142 
143 SYSCTL_BOOL(_hw_ice_debug, OID_AUTO, enable_tx_fc_filter, CTLFLAG_RDTUN,
144 	    &ice_enable_tx_fc_filter, 0,
145 	    "Drop Ethertype 0x8808 control frames originating from non-HW sources");
146 
147 SYSCTL_BOOL(_hw_ice_debug, OID_AUTO, enable_tx_lldp_filter, CTLFLAG_RDTUN,
148 	    &ice_enable_tx_lldp_filter, 0,
149 	    "Drop Ethertype 0x88cc LLDP frames originating from non-HW sources");
150 
151 SYSCTL_BOOL(_hw_ice_debug, OID_AUTO, tx_balance_en, CTLFLAG_RWTUN,
152 	    &ice_tx_balance_en, 0,
153 	    "Enable 5-layer scheduler topology");
154 
155 #endif /* _ICE_COMMON_SYSCTLS_H_ */
156