xref: /freebsd-13-stable/sys/dev/etherswitch/arswitch/arswitchvar.h (revision f8167e0404dab9ffeaca95853dd237ab7c587f82)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2011-2012 Stefan Bethke.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 #ifndef	__ARSWITCHVAR_H__
29 #define	__ARSWITCHVAR_H__
30 
31 typedef enum {
32 	AR8X16_SWITCH_NONE,
33 	AR8X16_SWITCH_AR7240,
34 	AR8X16_SWITCH_AR8216,
35 	AR8X16_SWITCH_AR8226,
36 	AR8X16_SWITCH_AR8316,
37 	AR8X16_SWITCH_AR9340,
38 	AR8X16_SWITCH_AR8327,
39 	AR8X16_SWITCH_AR8337,
40 } ar8x16_switch_type;
41 
42 /*
43  * XXX TODO: start using this where required
44  */
45 #define	AR8X16_IS_SWITCH(_sc, _type) \
46 	    (!!((_sc)->sc_switchtype == AR8X16_SWITCH_ ## _type))
47 
48 #define ARSWITCH_NUM_PORTS	MAX(AR8327_NUM_PORTS, AR8X16_NUM_PORTS)
49 #define ARSWITCH_NUM_PHYS	MAX(AR8327_NUM_PHYS, AR8X16_NUM_PHYS)
50 
51 #define ARSWITCH_NUM_LEDS	3
52 
53 struct arswitch_dev_led {
54 	struct arswitch_softc	*sc;
55 	struct cdev	*led;
56 	int		phy;
57 	int		lednum;
58 };
59 
60 struct arswitch_softc {
61 	struct mtx	sc_mtx;		/* serialize access to softc */
62 	device_t	sc_dev;
63 	int		phy4cpu;	/* PHY4 is connected to the CPU */
64 	int		numphys;	/* PHYs we manage */
65 	int		is_rgmii;	/* PHY mode is RGMII (XXX which PHY?) */
66 	int		is_gmii;	/* PHY mode is GMII (XXX which PHY?) */
67 	int		is_mii;		/* PHY mode is MII (XXX which PHY?) */
68 	int		page;
69 	int		is_internal_switch;
70 	int		chip_ver;
71 	int		chip_rev;
72 	int		mii_lo_first;		/* Send low data DWORD before high */
73 	ar8x16_switch_type	sc_switchtype;
74 	/* should be the max of both pre-AR8327 and AR8327 ports */
75 	char		*ifname[ARSWITCH_NUM_PHYS];
76 	device_t	miibus[ARSWITCH_NUM_PHYS];
77 	struct ifnet	*ifp[ARSWITCH_NUM_PHYS];
78 	struct arswitch_dev_led	dev_led[ARSWITCH_NUM_PHYS][ARSWITCH_NUM_LEDS];
79 	struct callout	callout_tick;
80 	etherswitch_info_t info;
81 
82 	uint32_t	sc_debug;
83 
84 	/* VLANs support */
85 	int		vid[AR8X16_MAX_VLANS];
86 	uint32_t	vlan_mode;
87 
88 	/* ATU (address table unit) support */
89 	struct {
90 		int count;
91 		int size;
92 		etherswitch_atu_entry_t *entries;
93 	} atu;
94 
95 	struct {
96 		/* Global setup */
97 		int (* arswitch_hw_setup) (struct arswitch_softc *);
98 		int (* arswitch_hw_global_setup) (struct arswitch_softc *);
99 
100 		int (* arswitch_hw_get_switch_macaddr) (struct arswitch_softc *,
101 		    struct ether_addr *sa);
102 		int (* arswitch_hw_set_switch_macaddr) (struct arswitch_softc *,
103 		    const struct ether_addr *sa);
104 
105 		/* Port functions */
106 		void (* arswitch_port_init) (struct arswitch_softc *, int);
107 
108 		/* ATU functions */
109 		int (* arswitch_atu_flush) (struct arswitch_softc *);
110 		int (* arswitch_atu_flush_port) (struct arswitch_softc *, int);
111 		int (* arswitch_atu_learn_default) (struct arswitch_softc *);
112 		int (* arswitch_atu_fetch_table) (struct arswitch_softc *,
113 		    etherswitch_atu_entry_t *, int atu_fetch_op);
114 
115 		/* VLAN functions */
116 		int (* arswitch_port_vlan_setup) (struct arswitch_softc *,
117 		    etherswitch_port_t *);
118 		int (* arswitch_port_vlan_get) (struct arswitch_softc *,
119 		    etherswitch_port_t *);
120 		void (* arswitch_vlan_init_hw) (struct arswitch_softc *);
121 		int (* arswitch_vlan_getvgroup) (struct arswitch_softc *,
122 		    etherswitch_vlangroup_t *);
123 		int (* arswitch_vlan_setvgroup) (struct arswitch_softc *,
124 		    etherswitch_vlangroup_t *);
125 		int (* arswitch_vlan_get_pvid) (struct arswitch_softc *, int,
126 		    int *);
127 		int (* arswitch_vlan_set_pvid) (struct arswitch_softc *, int,
128 		    int);
129 
130 		int (* arswitch_flush_dot1q_vlan) (struct arswitch_softc *sc);
131 		int (* arswitch_purge_dot1q_vlan) (struct arswitch_softc *sc,
132 		    int vid);
133 		int (* arswitch_get_dot1q_vlan) (struct arswitch_softc *,
134 		    uint32_t *ports, uint32_t *untagged_ports, int vid);
135 		int (* arswitch_set_dot1q_vlan) (struct arswitch_softc *sc,
136 		    uint32_t ports, uint32_t untagged_ports, int vid);
137 		int (* arswitch_get_port_vlan) (struct arswitch_softc *sc,
138 		    uint32_t *ports, int vid);
139 		int (* arswitch_set_port_vlan) (struct arswitch_softc *sc,
140 		    uint32_t ports, int vid);
141 
142 		/* PHY functions */
143 		int (* arswitch_phy_read) (device_t, int, int);
144 		int (* arswitch_phy_write) (device_t, int, int, int);
145 	} hal;
146 
147 	struct {
148 		uint32_t port0_status;
149 		uint32_t port5_status;
150 		uint32_t port6_status;
151 	} ar8327;
152 };
153 
154 #define	ARSWITCH_LOCK(_sc)			\
155 	    mtx_lock(&(_sc)->sc_mtx)
156 #define	ARSWITCH_UNLOCK(_sc)			\
157 	    mtx_unlock(&(_sc)->sc_mtx)
158 #define	ARSWITCH_LOCK_ASSERT(_sc, _what)	\
159 	    mtx_assert(&(_sc)->sc_mtx, (_what))
160 #define	ARSWITCH_TRYLOCK(_sc)			\
161 	    mtx_trylock(&(_sc)->sc_mtx)
162 
163 #define	ARSWITCH_DBG_RESET		0x00000001
164 #define	ARSWITCH_DBG_REGIO		0x00000002
165 #define	ARSWITCH_DBG_PHYIO		0x00000004
166 #define	ARSWITCH_DBG_POLL		0x00000008
167 #define	ARSWITCH_DBG_VLAN		0x00000010
168 #define	ARSWITCH_DBG_ATU		0x00000020
169 #define	ARSWITCH_DBG_ANY		0xffffffff
170 
171 #if 1
172 #define DPRINTF(sc, dbg, args...) \
173 	do { \
174 		if (((sc)->sc_debug & (dbg)) || \
175 		    ((sc)->sc_debug == ARSWITCH_DBG_ANY)) { \
176 			device_printf((sc)->sc_dev, args); 	\
177 		} \
178 	} while (0)
179 #define DEVERR(dev, err, fmt, args...) do { \
180 		if (err != 0) device_printf(dev, fmt, err, args); \
181 	} while (0)
182 #else
183 #define DPRINTF(dev, dbg, args...)
184 #define DEVERR(dev, err, fmt, args...)
185 #endif
186 
187 #endif	/* __ARSWITCHVAR_H__ */
188 
189