1/* SPDX-License-Identifier: BSD-3-Clause */
2/*  Copyright (c) 2020, 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_tx_fc_filter
50 * @brief boolean indicating if the Tx Flow Control filter should be enabled
51 *
52 * Global sysctl variable indicating whether the Tx Flow Control filters
53 * should be enabled. If true, Ethertype 0x8808 packets will be dropped if
54 * they come from non-HW sources. If false, packets coming from software will
55 * not be dropped. Leave this on if unless you must send flow control frames
56 * (or other control frames) from software.
57 *
58 * @remark each PF has a separate sysctl which can override this value.
59 */
60bool ice_enable_tx_fc_filter = true;
61
62/**
63 * @var ice_enable_tx_lldp_filter
64 * @brief boolean indicating if the Tx LLDP filter should be enabled
65 *
66 * Global sysctl variable indicating whether the Tx Flow Control filters
67 * should be enabled. If true, Ethertype 0x88cc packets will be dropped if
68 * they come from non-HW sources. If false, packets coming from software will
69 * not be dropped. Leave this on if unless you must send LLDP frames from
70 * software.
71 *
72 * @remark each PF has a separate sysctl which can override this value.
73 */
74bool ice_enable_tx_lldp_filter = true;
75
76/* sysctls marked as tunable, (i.e. with the CTLFLAG_TUN set) will
77 * automatically load tunable values, without the need to manually create the
78 * TUNABLE definition.
79 *
80 * This works since at least FreeBSD 11, and was backported into FreeBSD 10
81 * before the FreeBSD 10.1-RELEASE.
82 *
83 * If the tunable needs a custom loader, mark the SYSCTL as CTLFLAG_NOFETCH,
84 * and create the tunable manually.
85 */
86
87static SYSCTL_NODE(_hw, OID_AUTO, ice, CTLFLAG_RD, 0, "ICE driver parameters");
88
89static SYSCTL_NODE(_hw_ice, OID_AUTO, debug, ICE_CTLFLAG_DEBUG | CTLFLAG_RD, 0,
90		   "ICE driver debug parameters");
91
92SYSCTL_BOOL(_hw_ice_debug, OID_AUTO, enable_tx_fc_filter, CTLFLAG_RDTUN,
93	    &ice_enable_tx_fc_filter, 0,
94	    "Drop Ethertype 0x8808 control frames originating from non-HW sources");
95
96SYSCTL_BOOL(_hw_ice_debug, OID_AUTO, enable_tx_lldp_filter, CTLFLAG_RDTUN,
97	    &ice_enable_tx_lldp_filter, 0,
98	    "Drop Ethertype 0x88cc LLDP frames originating from non-HW sources");
99
100#endif /* _ICE_COMMON_SYSCTLS_H_ */
101