xref: /freebsd/sys/dev/ice/ice_vlan_mode.h (revision d08b8680e12ad692736c84238dcf45c70c228914)
1*d08b8680SEric Joyner /* SPDX-License-Identifier: BSD-3-Clause */
2*d08b8680SEric Joyner /*  Copyright (c) 2021, Intel Corporation
3*d08b8680SEric Joyner  *  All rights reserved.
4*d08b8680SEric Joyner  *
5*d08b8680SEric Joyner  *  Redistribution and use in source and binary forms, with or without
6*d08b8680SEric Joyner  *  modification, are permitted provided that the following conditions are met:
7*d08b8680SEric Joyner  *
8*d08b8680SEric Joyner  *   1. Redistributions of source code must retain the above copyright notice,
9*d08b8680SEric Joyner  *      this list of conditions and the following disclaimer.
10*d08b8680SEric Joyner  *
11*d08b8680SEric Joyner  *   2. Redistributions in binary form must reproduce the above copyright
12*d08b8680SEric Joyner  *      notice, this list of conditions and the following disclaimer in the
13*d08b8680SEric Joyner  *      documentation and/or other materials provided with the distribution.
14*d08b8680SEric Joyner  *
15*d08b8680SEric Joyner  *   3. Neither the name of the Intel Corporation nor the names of its
16*d08b8680SEric Joyner  *      contributors may be used to endorse or promote products derived from
17*d08b8680SEric Joyner  *      this software without specific prior written permission.
18*d08b8680SEric Joyner  *
19*d08b8680SEric Joyner  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20*d08b8680SEric Joyner  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21*d08b8680SEric Joyner  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22*d08b8680SEric Joyner  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23*d08b8680SEric Joyner  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24*d08b8680SEric Joyner  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25*d08b8680SEric Joyner  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26*d08b8680SEric Joyner  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27*d08b8680SEric Joyner  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28*d08b8680SEric Joyner  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29*d08b8680SEric Joyner  *  POSSIBILITY OF SUCH DAMAGE.
30*d08b8680SEric Joyner  */
31*d08b8680SEric Joyner /*$FreeBSD$*/
32*d08b8680SEric Joyner 
33*d08b8680SEric Joyner #ifndef _ICE_VLAN_MODE_H_
34*d08b8680SEric Joyner #define _ICE_VLAN_MODE_H_
35*d08b8680SEric Joyner 
36*d08b8680SEric Joyner struct ice_hw;
37*d08b8680SEric Joyner 
38*d08b8680SEric Joyner enum ice_status ice_set_vlan_mode(struct ice_hw *hw);
39*d08b8680SEric Joyner void ice_init_vlan_mode_ops(struct ice_hw *hw);
40*d08b8680SEric Joyner 
41*d08b8680SEric Joyner /* This structure defines the VLAN mode configuration interface. It is used to set the VLAN mode.
42*d08b8680SEric Joyner  *
43*d08b8680SEric Joyner  * Note: These operations will be called while the global configuration lock is held.
44*d08b8680SEric Joyner  *
45*d08b8680SEric Joyner  * enum ice_status (*set_svm)(struct ice_hw *hw);
46*d08b8680SEric Joyner  *	This function is called when the DDP and/or Firmware don't support double VLAN mode (DVM) or
47*d08b8680SEric Joyner  *	if the set_dvm op is not implemented and/or returns failure. It will set the device in
48*d08b8680SEric Joyner  *	single VLAN mode (SVM).
49*d08b8680SEric Joyner  *
50*d08b8680SEric Joyner  * enum ice_status (*set_dvm)(struct ice_hw *hw);
51*d08b8680SEric Joyner  *	This function is called when the DDP and Firmware support double VLAN mode (DVM). It should
52*d08b8680SEric Joyner  *	be implemented to set double VLAN mode. If it fails or remains unimplemented, set_svm will
53*d08b8680SEric Joyner  *	be called as a fallback plan.
54*d08b8680SEric Joyner  */
55*d08b8680SEric Joyner struct ice_vlan_mode_ops {
56*d08b8680SEric Joyner 	enum ice_status (*set_svm)(struct ice_hw *hw);
57*d08b8680SEric Joyner 	enum ice_status (*set_dvm)(struct ice_hw *hw);
58*d08b8680SEric Joyner };
59*d08b8680SEric Joyner 
60*d08b8680SEric Joyner #endif /* _ICE_VLAN_MODE_H */
61