xref: /freebsd/sys/dev/etherswitch/arswitch/arswitchvar.h (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1 /*-
2  * Copyright (c) 2011-2012 Stefan Bethke.
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
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
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 struct arswitch_softc {
52 	struct mtx	sc_mtx;		/* serialize access to softc */
53 	device_t	sc_dev;
54 	int		phy4cpu;	/* PHY4 is connected to the CPU */
55 	int		numphys;	/* PHYs we manage */
56 	int		is_rgmii;	/* PHY mode is RGMII (XXX which PHY?) */
57 	int		is_gmii;	/* PHY mode is GMII (XXX which PHY?) */
58 	int		is_mii;		/* PHY mode is MII (XXX which PHY?) */
59 	int		page;
60 	int		is_internal_switch;
61 	int		chip_ver;
62 	int		chip_rev;
63 	int		mii_lo_first;		/* Send low data DWORD before high */
64 	ar8x16_switch_type	sc_switchtype;
65 	/* should be the max of both pre-AR8327 and AR8327 ports */
66 	char		*ifname[ARSWITCH_NUM_PHYS];
67 	device_t	miibus[ARSWITCH_NUM_PHYS];
68 	struct ifnet	*ifp[ARSWITCH_NUM_PHYS];
69 	struct callout	callout_tick;
70 	etherswitch_info_t info;
71 
72 	/* VLANs support */
73 	int		vid[AR8X16_MAX_VLANS];
74 	uint32_t	vlan_mode;
75 
76 	struct {
77 		/* Global setup */
78 		int (* arswitch_hw_setup) (struct arswitch_softc *);
79 		int (* arswitch_hw_global_setup) (struct arswitch_softc *);
80 
81 		/* Port functions */
82 		void (* arswitch_port_init) (struct arswitch_softc *, int);
83 
84 		/* ATU functions */
85 		int (* arswitch_atu_flush) (struct arswitch_softc *);
86 
87 		/* VLAN functions */
88 		int (* arswitch_port_vlan_setup) (struct arswitch_softc *,
89 		    etherswitch_port_t *);
90 		int (* arswitch_port_vlan_get) (struct arswitch_softc *,
91 		    etherswitch_port_t *);
92 		void (* arswitch_vlan_init_hw) (struct arswitch_softc *);
93 		int (* arswitch_vlan_getvgroup) (struct arswitch_softc *,
94 		    etherswitch_vlangroup_t *);
95 		int (* arswitch_vlan_setvgroup) (struct arswitch_softc *,
96 		    etherswitch_vlangroup_t *);
97 		int (* arswitch_vlan_get_pvid) (struct arswitch_softc *, int,
98 		    int *);
99 		int (* arswitch_vlan_set_pvid) (struct arswitch_softc *, int,
100 		    int);
101 
102 		int (* arswitch_flush_dot1q_vlan) (struct arswitch_softc *sc);
103 		int (* arswitch_purge_dot1q_vlan) (struct arswitch_softc *sc,
104 		    int vid);
105 		int (* arswitch_get_dot1q_vlan) (struct arswitch_softc *,
106 		    uint32_t *ports, uint32_t *untagged_ports, int vid);
107 		int (* arswitch_set_dot1q_vlan) (struct arswitch_softc *sc,
108 		    uint32_t ports, uint32_t untagged_ports, int vid);
109 		int (* arswitch_get_port_vlan) (struct arswitch_softc *sc,
110 		    uint32_t *ports, int vid);
111 		int (* arswitch_set_port_vlan) (struct arswitch_softc *sc,
112 		    uint32_t ports, int vid);
113 
114 		/* PHY functions */
115 		int (* arswitch_phy_read) (device_t, int, int);
116 		int (* arswitch_phy_write) (device_t, int, int, int);
117 	} hal;
118 
119 	struct {
120 		uint32_t port0_status;
121 		uint32_t port5_status;
122 		uint32_t port6_status;
123 	} ar8327;
124 };
125 
126 #define	ARSWITCH_LOCK(_sc)			\
127 	    mtx_lock(&(_sc)->sc_mtx)
128 #define	ARSWITCH_UNLOCK(_sc)			\
129 	    mtx_unlock(&(_sc)->sc_mtx)
130 #define	ARSWITCH_LOCK_ASSERT(_sc, _what)	\
131 	    mtx_assert(&(_sc)->sc_mtx, (_what))
132 #define	ARSWITCH_TRYLOCK(_sc)			\
133 	    mtx_trylock(&(_sc)->sc_mtx)
134 
135 #if defined(DEBUG)
136 #define DPRINTF(dev, args...) device_printf(dev, args)
137 #define DEVERR(dev, err, fmt, args...) do { \
138 		if (err != 0) device_printf(dev, fmt, err, args); \
139 	} while (0)
140 #define DEBUG_INCRVAR(var)	do { \
141 		var++; \
142 	} while (0)
143 #else
144 #define DPRINTF(dev, args...)
145 #define DEVERR(dev, err, fmt, args...)
146 #define DEBUG_INCRVAR(var)
147 #endif
148 
149 #endif	/* __ARSWITCHVAR_H__ */
150 
151