if_udavreg.h revision 187378
1/*	$NetBSD: if_udavreg.h,v 1.2 2003/09/04 15:17:39 tsutsui Exp $	*/
2/*	$nabe: if_udavreg.h,v 1.2 2003/08/21 16:26:40 nabe Exp $	*/
3/*	$FreeBSD: head/sys/dev/usb2/ethernet/if_udavreg.h 187378 2009-01-18 05:35:58Z thompsa $	*/
4/*-
5 * Copyright (c) 2003
6 *     Shingo WATANABE <nabe@nabechan.org>.  All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the author nor the names of any co-contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 */
33
34#define	UDAV_IFACE_INDEX	0
35#define	UDAV_CONFIG_INDEX	0	/* config number 1 */
36
37/* Packet length */
38#define	UDAV_MIN_FRAME_LEN	60
39
40/* Request */
41#define	UDAV_REQ_REG_READ	0x00	/* Read from register(s) */
42#define	UDAV_REQ_REG_WRITE	0x01	/* Write to register(s) */
43#define	UDAV_REQ_REG_WRITE1	0x03	/* Write to a register */
44
45#define	UDAV_REQ_MEM_READ	0x02	/* Read from memory */
46#define	UDAV_REQ_MEM_WRITE	0x05	/* Write to memory */
47#define	UDAV_REQ_MEM_WRITE1	0x07	/* Write a byte to memory */
48
49/* Registers */
50#define	UDAV_NCR		0x00	/* Network Control Register */
51#define	UDAV_NCR_EXT_PHY	(1<<7)	/* Select External PHY */
52#define	UDAV_NCR_WAKEEN	(1<<6)		/* Wakeup Event Enable */
53#define	UDAV_NCR_FCOL		(1<<4)	/* Force Collision Mode */
54#define	UDAV_NCR_FDX		(1<<3)	/* Full-Duplex Mode (RO on Int. PHY) */
55#define	UDAV_NCR_LBK1		(1<<2)	/* Lookback Mode */
56#define	UDAV_NCR_LBK0		(1<<1)	/* Lookback Mode */
57#define	UDAV_NCR_RST		(1<<0)	/* Software reset */
58
59#define	UDAV_RCR		0x05	/* RX Control Register */
60#define	UDAV_RCR_WTDIS		(1<<6)	/* Watchdog Timer Disable */
61#define	UDAV_RCR_DIS_LONG	(1<<5)	/* Discard Long Packet(over 1522Byte) */
62#define	UDAV_RCR_DIS_CRC	(1<<4)	/* Discard CRC Error Packet */
63#define	UDAV_RCR_ALL		(1<<3)	/* Pass All Multicast */
64#define	UDAV_RCR_RUNT		(1<<2)	/* Pass Runt Packet */
65#define	UDAV_RCR_PRMSC		(1<<1)	/* Promiscuous Mode */
66#define	UDAV_RCR_RXEN		(1<<0)	/* RX Enable */
67
68#define	UDAV_RSR		0x06	/* RX Status Register */
69#define	UDAV_RSR_RF		(1<<7)	/* Runt Frame */
70#define	UDAV_RSR_MF		(1<<6)	/* Multicast Frame */
71#define	UDAV_RSR_LCS		(1<<5)	/* Late Collision Seen */
72#define	UDAV_RSR_RWTO		(1<<4)	/* Receive Watchdog Time-Out */
73#define	UDAV_RSR_PLE		(1<<3)	/* Physical Layer Error */
74#define	UDAV_RSR_AE		(1<<2)	/* Alignment Error */
75#define	UDAV_RSR_CE		(1<<1)	/* CRC Error */
76#define	UDAV_RSR_FOE		(1<<0)	/* FIFO Overflow Error */
77#define	UDAV_RSR_ERR		(UDAV_RSR_RF | UDAV_RSR_LCS |		\
78				    UDAV_RSR_RWTO | UDAV_RSR_PLE |	\
79				    UDAV_RSR_AE | UDAV_RSR_CE | UDAV_RSR_FOE)
80
81#define	UDAV_EPCR		0x0b	/* EEPROM & PHY Control Register */
82#define	UDAV_EPCR_REEP		(1<<5)	/* Reload EEPROM */
83#define	UDAV_EPCR_WEP		(1<<4)	/* Write EEPROM enable */
84#define	UDAV_EPCR_EPOS		(1<<3)	/* EEPROM or PHY Operation Select */
85#define	UDAV_EPCR_ERPRR		(1<<2)	/* EEPROM/PHY Register Read Command */
86#define	UDAV_EPCR_ERPRW		(1<<1)	/* EEPROM/PHY Register Write Command */
87#define	UDAV_EPCR_ERRE		(1<<0)	/* EEPROM/PHY Access Status */
88
89#define	UDAV_EPAR		0x0c	/* EEPROM & PHY Control Register */
90#define	UDAV_EPAR_PHY_ADR1	(1<<7)	/* PHY Address bit 1 */
91#define	UDAV_EPAR_PHY_ADR0	(1<<6)	/* PHY Address bit 0 */
92#define	UDAV_EPAR_EROA		(1<<0)	/* EEPROM Word/PHY Register Address */
93#define	UDAV_EPAR_EROA_MASK	(0x1f)	/* [5:0] */
94
95#define	UDAV_EPDRL		0x0d	/* EEPROM & PHY Data Register */
96#define	UDAV_EPDRH		0x0e	/* EEPROM & PHY Data Register */
97
98#define	UDAV_PAR0		0x10	/* Ethernet Address, load from EEPROM */
99#define	UDAV_PAR1		0x11	/* Ethernet Address, load from EEPROM */
100#define	UDAV_PAR2		0x12	/* Ethernet Address, load from EEPROM */
101#define	UDAV_PAR3		0x13	/* Ethernet Address, load from EEPROM */
102#define	UDAV_PAR4		0x14	/* Ethernet Address, load from EEPROM */
103#define	UDAV_PAR5		0x15	/* Ethernet Address, load from EEPROM */
104#define	UDAV_PAR		UDAV_PAR0
105
106#define	UDAV_MAR0		0x16	/* Multicast Register */
107#define	UDAV_MAR1		0x17	/* Multicast Register */
108#define	UDAV_MAR2		0x18	/* Multicast Register */
109#define	UDAV_MAR3		0x19	/* Multicast Register */
110#define	UDAV_MAR4		0x1a	/* Multicast Register */
111#define	UDAV_MAR5		0x1b	/* Multicast Register */
112#define	UDAV_MAR6		0x1c	/* Multicast Register */
113#define	UDAV_MAR7		0x1d	/* Multicast Register */
114#define	UDAV_MAR		UDAV_MAR0
115
116#define	UDAV_GPCR		0x1e	/* General purpose control register */
117#define	UDAV_GPCR_GEP_CNTL6	(1<<6)	/* General purpose control 6 */
118#define	UDAV_GPCR_GEP_CNTL5	(1<<5)	/* General purpose control 5 */
119#define	UDAV_GPCR_GEP_CNTL4	(1<<4)	/* General purpose control 4 */
120#define	UDAV_GPCR_GEP_CNTL3	(1<<3)	/* General purpose control 3 */
121#define	UDAV_GPCR_GEP_CNTL2	(1<<2)	/* General purpose control 2 */
122#define	UDAV_GPCR_GEP_CNTL1	(1<<1)	/* General purpose control 1 */
123#define	UDAV_GPCR_GEP_CNTL0	(1<<0)	/* General purpose control 0 */
124
125#define	UDAV_GPR		0x1f	/* General purpose register */
126#define	UDAV_GPR_GEPIO6		(1<<6)	/* General purpose 6 */
127#define	UDAV_GPR_GEPIO5		(1<<5)	/* General purpose 5 */
128#define	UDAV_GPR_GEPIO4		(1<<4)	/* General purpose 4 */
129#define	UDAV_GPR_GEPIO3		(1<<3)	/* General purpose 3 */
130#define	UDAV_GPR_GEPIO2		(1<<2)	/* General purpose 2 */
131#define	UDAV_GPR_GEPIO1		(1<<1)	/* General purpose 1 */
132#define	UDAV_GPR_GEPIO0		(1<<0)	/* General purpose 0 */
133
134#define	GET_MII(sc)	((sc)->sc_miibus ?				\
135			    device_get_softc((sc)->sc_miibus) : NULL)
136
137enum {
138	UDAV_BULK_DT_WR,
139	UDAV_BULK_DT_RD,
140	UDAV_BULK_CS_WR,
141	UDAV_BULK_CS_RD,
142	UDAV_INTR_DT_RD,
143	UDAV_INTR_CS_RD,
144	UDAV_N_TRANSFER = 6,
145};
146
147struct udav_softc {
148	struct ifnet *sc_ifp;
149
150	struct usb2_config_td sc_config_td;
151	struct usb2_callout sc_watchdog;
152	struct mtx sc_mtx;
153
154	struct usb2_device *sc_udev;
155	struct usb2_xfer *sc_xfer[UDAV_N_TRANSFER];
156	device_t sc_miibus;
157	device_t sc_dev;
158
159	uint32_t sc_unit;
160	uint32_t sc_media_active;
161	uint32_t sc_media_status;
162
163	uint16_t sc_flags;
164#define	UDAV_FLAG_WAIT_LINK	0x0001
165#define	UDAV_FLAG_INTR_STALL	0x0002
166#define	UDAV_FLAG_READ_STALL	0x0004
167#define	UDAV_FLAG_WRITE_STALL	0x0008
168#define	UDAV_FLAG_LL_READY	0x0010
169#define	UDAV_FLAG_HL_READY	0x0020
170#define	UDAV_FLAG_EXT_PHY	0x0040
171
172	uint8_t	sc_name[16];
173};
174