xref: /freebsd/sys/dev/etherswitch/arswitch/arswitchvar.h (revision 4543ef516683042d46f3bd3bb8a4f3f746e00499)
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_AR8216,
34 	AR8X16_SWITCH_AR8226,
35 	AR8X16_SWITCH_AR8316,
36 	AR8X16_SWITCH_AR8327,
37 	AR8X16_SWITCH_AR8337,
38 } ar8x16_switch_type;
39 
40 /*
41  * XXX TODO: start using this where required
42  */
43 #define	AR8X16_IS_SWITCH(_sc, _type) \
44 	    (!!((_sc)->sc_switchtype == AR8X16_SWITCH_ ## _type))
45 
46 #define ARSWITCH_NUM_PORTS	MAX(AR8327_NUM_PORTS, AR8X16_NUM_PORTS)
47 #define ARSWITCH_NUM_PHYS	MAX(AR8327_NUM_PHYS, AR8X16_NUM_PHYS)
48 
49 #define ARSWITCH_NUM_LEDS	3
50 
51 struct arswitch_dev_led {
52 	struct arswitch_softc	*sc;
53 	struct cdev	*led;
54 	int		phy;
55 	int		lednum;
56 };
57 
58 struct arswitch_softc {
59 	struct mtx	sc_mtx;		/* serialize access to softc */
60 	device_t	sc_dev;
61 	int		phy4cpu;	/* PHY4 is connected to the CPU */
62 	int		numphys;	/* PHYs we manage */
63 	int		is_rgmii;	/* PHY mode is RGMII (XXX which PHY?) */
64 	int		is_gmii;	/* PHY mode is GMII (XXX which PHY?) */
65 	int		is_mii;		/* PHY mode is MII (XXX which PHY?) */
66 	int		page;
67 	int		chip_ver;
68 	int		chip_rev;
69 	int		mii_lo_first;		/* Send low data DWORD before high */
70 	ar8x16_switch_type	sc_switchtype;
71 	/* should be the max of both pre-AR8327 and AR8327 ports */
72 	char		*ifname[ARSWITCH_NUM_PHYS];
73 	device_t	miibus[ARSWITCH_NUM_PHYS];
74 	if_t ifp[ARSWITCH_NUM_PHYS];
75 	struct arswitch_dev_led	dev_led[ARSWITCH_NUM_PHYS][ARSWITCH_NUM_LEDS];
76 	struct callout	callout_tick;
77 	etherswitch_info_t info;
78 
79 	uint32_t	sc_debug;
80 
81 	/* VLANs support */
82 	int		vid[AR8X16_MAX_VLANS];
83 	uint32_t	vlan_mode;
84 
85 	/* ATU (address table unit) support */
86 	struct {
87 		int count;
88 		int size;
89 		etherswitch_atu_entry_t *entries;
90 	} atu;
91 
92 	struct {
93 		/* Global setup */
94 		int (* arswitch_hw_setup) (struct arswitch_softc *);
95 		int (* arswitch_hw_global_setup) (struct arswitch_softc *);
96 
97 		int (* arswitch_hw_get_switch_macaddr) (struct arswitch_softc *,
98 		    struct ether_addr *sa);
99 		int (* arswitch_hw_set_switch_macaddr) (struct arswitch_softc *,
100 		    const struct ether_addr *sa);
101 
102 		/* Port functions */
103 		void (* arswitch_port_init) (struct arswitch_softc *, int);
104 
105 		/* ATU functions */
106 		int (* arswitch_atu_flush) (struct arswitch_softc *);
107 		int (* arswitch_atu_flush_port) (struct arswitch_softc *, int);
108 		int (* arswitch_atu_learn_default) (struct arswitch_softc *);
109 		int (* arswitch_atu_fetch_table) (struct arswitch_softc *,
110 		    etherswitch_atu_entry_t *, int atu_fetch_op);
111 
112 		/* VLAN functions */
113 		int (* arswitch_port_vlan_setup) (struct arswitch_softc *,
114 		    etherswitch_port_t *);
115 		int (* arswitch_port_vlan_get) (struct arswitch_softc *,
116 		    etherswitch_port_t *);
117 		void (* arswitch_vlan_init_hw) (struct arswitch_softc *);
118 		int (* arswitch_vlan_getvgroup) (struct arswitch_softc *,
119 		    etherswitch_vlangroup_t *);
120 		int (* arswitch_vlan_setvgroup) (struct arswitch_softc *,
121 		    etherswitch_vlangroup_t *);
122 		int (* arswitch_vlan_get_pvid) (struct arswitch_softc *, int,
123 		    int *);
124 		int (* arswitch_vlan_set_pvid) (struct arswitch_softc *, int,
125 		    int);
126 
127 		int (* arswitch_flush_dot1q_vlan) (struct arswitch_softc *sc);
128 		int (* arswitch_purge_dot1q_vlan) (struct arswitch_softc *sc,
129 		    int vid);
130 		int (* arswitch_get_dot1q_vlan) (struct arswitch_softc *,
131 		    uint32_t *ports, uint32_t *untagged_ports, int vid);
132 		int (* arswitch_set_dot1q_vlan) (struct arswitch_softc *sc,
133 		    uint32_t ports, uint32_t untagged_ports, int vid);
134 		int (* arswitch_get_port_vlan) (struct arswitch_softc *sc,
135 		    uint32_t *ports, int vid);
136 		int (* arswitch_set_port_vlan) (struct arswitch_softc *sc,
137 		    uint32_t ports, int vid);
138 
139 		/* PHY functions */
140 		int (* arswitch_phy_read) (device_t, int, int);
141 		int (* arswitch_phy_write) (device_t, int, int, int);
142 	} hal;
143 
144 	struct {
145 		uint32_t port0_status;
146 		uint32_t port5_status;
147 		uint32_t port6_status;
148 	} ar8327;
149 };
150 
151 #define	ARSWITCH_LOCK(_sc)			\
152 	    mtx_lock(&(_sc)->sc_mtx)
153 #define	ARSWITCH_UNLOCK(_sc)			\
154 	    mtx_unlock(&(_sc)->sc_mtx)
155 #define	ARSWITCH_LOCK_ASSERT(_sc, _what)	\
156 	    mtx_assert(&(_sc)->sc_mtx, (_what))
157 #define	ARSWITCH_TRYLOCK(_sc)			\
158 	    mtx_trylock(&(_sc)->sc_mtx)
159 
160 #define	ARSWITCH_DBG_RESET		0x00000001
161 #define	ARSWITCH_DBG_REGIO		0x00000002
162 #define	ARSWITCH_DBG_PHYIO		0x00000004
163 #define	ARSWITCH_DBG_POLL		0x00000008
164 #define	ARSWITCH_DBG_VLAN		0x00000010
165 #define	ARSWITCH_DBG_ATU		0x00000020
166 #define	ARSWITCH_DBG_ANY		0xffffffff
167 
168 #if 1
169 #define DPRINTF(sc, dbg, args...) \
170 	do { \
171 		if (((sc)->sc_debug & (dbg)) || \
172 		    ((sc)->sc_debug == ARSWITCH_DBG_ANY)) { \
173 			device_printf((sc)->sc_dev, args); 	\
174 		} \
175 	} while (0)
176 #define DEVERR(dev, err, fmt, args...) do { \
177 		if (err != 0) device_printf(dev, fmt, err, args); \
178 	} while (0)
179 #else
180 #define DPRINTF(dev, dbg, args...)
181 #define DEVERR(dev, err, fmt, args...)
182 #endif
183 
184 #endif	/* __ARSWITCHVAR_H__ */
185 
186