1/* SPDX-License-Identifier: BSD-3-Clause */
2/*  Copyright (c) 2021, 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#ifndef _ICE_VLAN_MODE_H_
34#define _ICE_VLAN_MODE_H_
35
36struct ice_hw;
37
38enum ice_status ice_set_vlan_mode(struct ice_hw *hw);
39void ice_init_vlan_mode_ops(struct ice_hw *hw);
40
41/* This structure defines the VLAN mode configuration interface. It is used to set the VLAN mode.
42 *
43 * Note: These operations will be called while the global configuration lock is held.
44 *
45 * enum ice_status (*set_svm)(struct ice_hw *hw);
46 *	This function is called when the DDP and/or Firmware don't support double VLAN mode (DVM) or
47 *	if the set_dvm op is not implemented and/or returns failure. It will set the device in
48 *	single VLAN mode (SVM).
49 *
50 * enum ice_status (*set_dvm)(struct ice_hw *hw);
51 *	This function is called when the DDP and Firmware support double VLAN mode (DVM). It should
52 *	be implemented to set double VLAN mode. If it fails or remains unimplemented, set_svm will
53 *	be called as a fallback plan.
54 */
55struct ice_vlan_mode_ops {
56	enum ice_status (*set_svm)(struct ice_hw *hw);
57	enum ice_status (*set_dvm)(struct ice_hw *hw);
58};
59
60#endif /* _ICE_VLAN_MODE_H */
61