if_udavreg.h revision 184610
1184610Salfred/* $NetBSD: if_udavreg.h,v 1.2 2003/09/04 15:17:39 tsutsui Exp $ */ 2184610Salfred/* $nabe: if_udavreg.h,v 1.2 2003/08/21 16:26:40 nabe Exp $ */ 3184610Salfred/* $FreeBSD: head/sys/dev/usb2/ethernet/if_udav2_reg.h 184610 2008-11-04 02:31:03Z alfred $ */ 4184610Salfred/*- 5184610Salfred * Copyright (c) 2003 6184610Salfred * Shingo WATANABE <nabe@nabechan.org>. All rights reserved. 7184610Salfred * 8184610Salfred * Redistribution and use in source and binary forms, with or without 9184610Salfred * modification, are permitted provided that the following conditions 10184610Salfred * are met: 11184610Salfred * 1. Redistributions of source code must retain the above copyright 12184610Salfred * notice, this list of conditions and the following disclaimer. 13184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 14184610Salfred * notice, this list of conditions and the following disclaimer in the 15184610Salfred * documentation and/or other materials provided with the distribution. 16184610Salfred * 3. Neither the name of the author nor the names of any co-contributors 17184610Salfred * may be used to endorse or promote products derived from this software 18184610Salfred * without specific prior written permission. 19184610Salfred * 20184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30184610Salfred * SUCH DAMAGE. 31184610Salfred * 32184610Salfred */ 33184610Salfred 34184610Salfred#define UDAV_IFACE_INDEX 0 35184610Salfred#define UDAV_CONFIG_INDEX 0 /* config number 1 */ 36184610Salfred 37184610Salfred#define UDAV_ENDPT_MAX 6 /* units */ 38184610Salfred 39184610Salfred/* Packet length */ 40184610Salfred#define UDAV_MIN_FRAME_LEN 60 41184610Salfred 42184610Salfred/* Request */ 43184610Salfred#define UDAV_REQ_REG_READ 0x00 /* Read from register(s) */ 44184610Salfred#define UDAV_REQ_REG_WRITE 0x01 /* Write to register(s) */ 45184610Salfred#define UDAV_REQ_REG_WRITE1 0x03 /* Write to a register */ 46184610Salfred 47184610Salfred#define UDAV_REQ_MEM_READ 0x02 /* Read from memory */ 48184610Salfred#define UDAV_REQ_MEM_WRITE 0x05 /* Write to memory */ 49184610Salfred#define UDAV_REQ_MEM_WRITE1 0x07 /* Write a byte to memory */ 50184610Salfred 51184610Salfred/* Registers */ 52184610Salfred#define UDAV_NCR 0x00 /* Network Control Register */ 53184610Salfred#define UDAV_NCR_EXT_PHY (1<<7) /* Select External PHY */ 54184610Salfred#define UDAV_NCR_WAKEEN (1<<6) /* Wakeup Event Enable */ 55184610Salfred#define UDAV_NCR_FCOL (1<<4) /* Force Collision Mode */ 56184610Salfred#define UDAV_NCR_FDX (1<<3) /* Full-Duplex Mode (RO on Int. PHY) */ 57184610Salfred#define UDAV_NCR_LBK1 (1<<2) /* Lookback Mode */ 58184610Salfred#define UDAV_NCR_LBK0 (1<<1) /* Lookback Mode */ 59184610Salfred#define UDAV_NCR_RST (1<<0) /* Software reset */ 60184610Salfred 61184610Salfred#define UDAV_RCR 0x05 /* RX Control Register */ 62184610Salfred#define UDAV_RCR_WTDIS (1<<6) /* Watchdog Timer Disable */ 63184610Salfred#define UDAV_RCR_DIS_LONG (1<<5) /* Discard Long Packet(over 1522Byte) */ 64184610Salfred#define UDAV_RCR_DIS_CRC (1<<4) /* Discard CRC Error Packet */ 65184610Salfred#define UDAV_RCR_ALL (1<<3) /* Pass All Multicast */ 66184610Salfred#define UDAV_RCR_RUNT (1<<2) /* Pass Runt Packet */ 67184610Salfred#define UDAV_RCR_PRMSC (1<<1) /* Promiscuous Mode */ 68184610Salfred#define UDAV_RCR_RXEN (1<<0) /* RX Enable */ 69184610Salfred 70184610Salfred#define UDAV_RSR 0x06 /* RX Status Register */ 71184610Salfred#define UDAV_RSR_RF (1<<7) /* Runt Frame */ 72184610Salfred#define UDAV_RSR_MF (1<<6) /* Multicast Frame */ 73184610Salfred#define UDAV_RSR_LCS (1<<5) /* Late Collision Seen */ 74184610Salfred#define UDAV_RSR_RWTO (1<<4) /* Receive Watchdog Time-Out */ 75184610Salfred#define UDAV_RSR_PLE (1<<3) /* Physical Layer Error */ 76184610Salfred#define UDAV_RSR_AE (1<<2) /* Alignment Error */ 77184610Salfred#define UDAV_RSR_CE (1<<1) /* CRC Error */ 78184610Salfred#define UDAV_RSR_FOE (1<<0) /* FIFO Overflow Error */ 79184610Salfred#define UDAV_RSR_ERR (UDAV_RSR_RF | UDAV_RSR_LCS | \ 80184610Salfred UDAV_RSR_RWTO | UDAV_RSR_PLE | \ 81184610Salfred UDAV_RSR_AE | UDAV_RSR_CE | UDAV_RSR_FOE) 82184610Salfred 83184610Salfred#define UDAV_EPCR 0x0b /* EEPROM & PHY Control Register */ 84184610Salfred#define UDAV_EPCR_REEP (1<<5) /* Reload EEPROM */ 85184610Salfred#define UDAV_EPCR_WEP (1<<4) /* Write EEPROM enable */ 86184610Salfred#define UDAV_EPCR_EPOS (1<<3) /* EEPROM or PHY Operation Select */ 87184610Salfred#define UDAV_EPCR_ERPRR (1<<2) /* EEPROM/PHY Register Read Command */ 88184610Salfred#define UDAV_EPCR_ERPRW (1<<1) /* EEPROM/PHY Register Write Command */ 89184610Salfred#define UDAV_EPCR_ERRE (1<<0) /* EEPROM/PHY Access Status */ 90184610Salfred 91184610Salfred#define UDAV_EPAR 0x0c /* EEPROM & PHY Control Register */ 92184610Salfred#define UDAV_EPAR_PHY_ADR1 (1<<7) /* PHY Address bit 1 */ 93184610Salfred#define UDAV_EPAR_PHY_ADR0 (1<<6) /* PHY Address bit 0 */ 94184610Salfred#define UDAV_EPAR_EROA (1<<0) /* EEPROM Word/PHY Register Address */ 95184610Salfred#define UDAV_EPAR_EROA_MASK (0x1f) /* [5:0] */ 96184610Salfred 97184610Salfred#define UDAV_EPDRL 0x0d /* EEPROM & PHY Data Register */ 98184610Salfred#define UDAV_EPDRH 0x0e /* EEPROM & PHY Data Register */ 99184610Salfred 100184610Salfred#define UDAV_PAR0 0x10 /* Ethernet Address, load from EEPROM */ 101184610Salfred#define UDAV_PAR1 0x11 /* Ethernet Address, load from EEPROM */ 102184610Salfred#define UDAV_PAR2 0x12 /* Ethernet Address, load from EEPROM */ 103184610Salfred#define UDAV_PAR3 0x13 /* Ethernet Address, load from EEPROM */ 104184610Salfred#define UDAV_PAR4 0x14 /* Ethernet Address, load from EEPROM */ 105184610Salfred#define UDAV_PAR5 0x15 /* Ethernet Address, load from EEPROM */ 106184610Salfred#define UDAV_PAR UDAV_PAR0 107184610Salfred 108184610Salfred#define UDAV_MAR0 0x16 /* Multicast Register */ 109184610Salfred#define UDAV_MAR1 0x17 /* Multicast Register */ 110184610Salfred#define UDAV_MAR2 0x18 /* Multicast Register */ 111184610Salfred#define UDAV_MAR3 0x19 /* Multicast Register */ 112184610Salfred#define UDAV_MAR4 0x1a /* Multicast Register */ 113184610Salfred#define UDAV_MAR5 0x1b /* Multicast Register */ 114184610Salfred#define UDAV_MAR6 0x1c /* Multicast Register */ 115184610Salfred#define UDAV_MAR7 0x1d /* Multicast Register */ 116184610Salfred#define UDAV_MAR UDAV_MAR0 117184610Salfred 118184610Salfred#define UDAV_GPCR 0x1e /* General purpose control register */ 119184610Salfred#define UDAV_GPCR_GEP_CNTL6 (1<<6) /* General purpose control 6 */ 120184610Salfred#define UDAV_GPCR_GEP_CNTL5 (1<<5) /* General purpose control 5 */ 121184610Salfred#define UDAV_GPCR_GEP_CNTL4 (1<<4) /* General purpose control 4 */ 122184610Salfred#define UDAV_GPCR_GEP_CNTL3 (1<<3) /* General purpose control 3 */ 123184610Salfred#define UDAV_GPCR_GEP_CNTL2 (1<<2) /* General purpose control 2 */ 124184610Salfred#define UDAV_GPCR_GEP_CNTL1 (1<<1) /* General purpose control 1 */ 125184610Salfred#define UDAV_GPCR_GEP_CNTL0 (1<<0) /* General purpose control 0 */ 126184610Salfred 127184610Salfred#define UDAV_GPR 0x1f /* General purpose register */ 128184610Salfred#define UDAV_GPR_GEPIO6 (1<<6) /* General purpose 6 */ 129184610Salfred#define UDAV_GPR_GEPIO5 (1<<5) /* General purpose 5 */ 130184610Salfred#define UDAV_GPR_GEPIO4 (1<<4) /* General purpose 4 */ 131184610Salfred#define UDAV_GPR_GEPIO3 (1<<3) /* General purpose 3 */ 132184610Salfred#define UDAV_GPR_GEPIO2 (1<<2) /* General purpose 2 */ 133184610Salfred#define UDAV_GPR_GEPIO1 (1<<1) /* General purpose 1 */ 134184610Salfred#define UDAV_GPR_GEPIO0 (1<<0) /* General purpose 0 */ 135184610Salfred 136184610Salfred#define GET_MII(sc) ((sc)->sc_miibus ? \ 137184610Salfred device_get_softc((sc)->sc_miibus) : NULL) 138184610Salfred 139184610Salfredstruct udav_softc { 140184610Salfred void *sc_evilhack; /* XXX this pointer must be first */ 141184610Salfred 142184610Salfred struct usb2_config_td sc_config_td; 143184610Salfred struct usb2_callout sc_watchdog; 144184610Salfred struct mtx sc_mtx; 145184610Salfred 146184610Salfred struct ifnet *sc_ifp; 147184610Salfred struct usb2_device *sc_udev; 148184610Salfred struct usb2_xfer *sc_xfer[UDAV_ENDPT_MAX]; 149184610Salfred device_t sc_miibus; 150184610Salfred device_t sc_dev; 151184610Salfred 152184610Salfred uint32_t sc_unit; 153184610Salfred uint32_t sc_media_active; 154184610Salfred uint32_t sc_media_status; 155184610Salfred 156184610Salfred uint16_t sc_flags; 157184610Salfred#define UDAV_FLAG_WAIT_LINK 0x0001 158184610Salfred#define UDAV_FLAG_INTR_STALL 0x0002 159184610Salfred#define UDAV_FLAG_READ_STALL 0x0004 160184610Salfred#define UDAV_FLAG_WRITE_STALL 0x0008 161184610Salfred#define UDAV_FLAG_LL_READY 0x0010 162184610Salfred#define UDAV_FLAG_HL_READY 0x0020 163184610Salfred#define UDAV_FLAG_EXT_PHY 0x0040 164184610Salfred 165184610Salfred uint8_t sc_name[16]; 166184610Salfred}; 167