if_udavreg.h revision 188412
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_udavreg.h 188412 2009-02-09 22:02:38Z thompsa $ */ 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 37188412Sthompsa#define UDAV_TX_TIMEOUT 1000 38188412Sthompsa#define UDAV_TIMEOUT 10000 39188412Sthompsa 40188412Sthompsa#define UDAV_TX_TIMEOUT 1000 41188412Sthompsa#define UDAV_TIMEOUT 10000 42188412Sthompsa 43184610Salfred/* Packet length */ 44184610Salfred#define UDAV_MIN_FRAME_LEN 60 45184610Salfred 46184610Salfred/* Request */ 47184610Salfred#define UDAV_REQ_REG_READ 0x00 /* Read from register(s) */ 48184610Salfred#define UDAV_REQ_REG_WRITE 0x01 /* Write to register(s) */ 49184610Salfred#define UDAV_REQ_REG_WRITE1 0x03 /* Write to a register */ 50184610Salfred 51184610Salfred#define UDAV_REQ_MEM_READ 0x02 /* Read from memory */ 52184610Salfred#define UDAV_REQ_MEM_WRITE 0x05 /* Write to memory */ 53184610Salfred#define UDAV_REQ_MEM_WRITE1 0x07 /* Write a byte to memory */ 54184610Salfred 55184610Salfred/* Registers */ 56184610Salfred#define UDAV_NCR 0x00 /* Network Control Register */ 57184610Salfred#define UDAV_NCR_EXT_PHY (1<<7) /* Select External PHY */ 58184610Salfred#define UDAV_NCR_WAKEEN (1<<6) /* Wakeup Event Enable */ 59184610Salfred#define UDAV_NCR_FCOL (1<<4) /* Force Collision Mode */ 60184610Salfred#define UDAV_NCR_FDX (1<<3) /* Full-Duplex Mode (RO on Int. PHY) */ 61184610Salfred#define UDAV_NCR_LBK1 (1<<2) /* Lookback Mode */ 62184610Salfred#define UDAV_NCR_LBK0 (1<<1) /* Lookback Mode */ 63184610Salfred#define UDAV_NCR_RST (1<<0) /* Software reset */ 64184610Salfred 65184610Salfred#define UDAV_RCR 0x05 /* RX Control Register */ 66184610Salfred#define UDAV_RCR_WTDIS (1<<6) /* Watchdog Timer Disable */ 67184610Salfred#define UDAV_RCR_DIS_LONG (1<<5) /* Discard Long Packet(over 1522Byte) */ 68184610Salfred#define UDAV_RCR_DIS_CRC (1<<4) /* Discard CRC Error Packet */ 69184610Salfred#define UDAV_RCR_ALL (1<<3) /* Pass All Multicast */ 70184610Salfred#define UDAV_RCR_RUNT (1<<2) /* Pass Runt Packet */ 71184610Salfred#define UDAV_RCR_PRMSC (1<<1) /* Promiscuous Mode */ 72184610Salfred#define UDAV_RCR_RXEN (1<<0) /* RX Enable */ 73184610Salfred 74184610Salfred#define UDAV_RSR 0x06 /* RX Status Register */ 75184610Salfred#define UDAV_RSR_RF (1<<7) /* Runt Frame */ 76184610Salfred#define UDAV_RSR_MF (1<<6) /* Multicast Frame */ 77184610Salfred#define UDAV_RSR_LCS (1<<5) /* Late Collision Seen */ 78184610Salfred#define UDAV_RSR_RWTO (1<<4) /* Receive Watchdog Time-Out */ 79184610Salfred#define UDAV_RSR_PLE (1<<3) /* Physical Layer Error */ 80184610Salfred#define UDAV_RSR_AE (1<<2) /* Alignment Error */ 81184610Salfred#define UDAV_RSR_CE (1<<1) /* CRC Error */ 82184610Salfred#define UDAV_RSR_FOE (1<<0) /* FIFO Overflow Error */ 83184610Salfred#define UDAV_RSR_ERR (UDAV_RSR_RF | UDAV_RSR_LCS | \ 84184610Salfred UDAV_RSR_RWTO | UDAV_RSR_PLE | \ 85184610Salfred UDAV_RSR_AE | UDAV_RSR_CE | UDAV_RSR_FOE) 86184610Salfred 87184610Salfred#define UDAV_EPCR 0x0b /* EEPROM & PHY Control Register */ 88184610Salfred#define UDAV_EPCR_REEP (1<<5) /* Reload EEPROM */ 89184610Salfred#define UDAV_EPCR_WEP (1<<4) /* Write EEPROM enable */ 90184610Salfred#define UDAV_EPCR_EPOS (1<<3) /* EEPROM or PHY Operation Select */ 91184610Salfred#define UDAV_EPCR_ERPRR (1<<2) /* EEPROM/PHY Register Read Command */ 92184610Salfred#define UDAV_EPCR_ERPRW (1<<1) /* EEPROM/PHY Register Write Command */ 93184610Salfred#define UDAV_EPCR_ERRE (1<<0) /* EEPROM/PHY Access Status */ 94184610Salfred 95184610Salfred#define UDAV_EPAR 0x0c /* EEPROM & PHY Control Register */ 96184610Salfred#define UDAV_EPAR_PHY_ADR1 (1<<7) /* PHY Address bit 1 */ 97184610Salfred#define UDAV_EPAR_PHY_ADR0 (1<<6) /* PHY Address bit 0 */ 98184610Salfred#define UDAV_EPAR_EROA (1<<0) /* EEPROM Word/PHY Register Address */ 99184610Salfred#define UDAV_EPAR_EROA_MASK (0x1f) /* [5:0] */ 100184610Salfred 101184610Salfred#define UDAV_EPDRL 0x0d /* EEPROM & PHY Data Register */ 102184610Salfred#define UDAV_EPDRH 0x0e /* EEPROM & PHY Data Register */ 103184610Salfred 104184610Salfred#define UDAV_PAR0 0x10 /* Ethernet Address, load from EEPROM */ 105184610Salfred#define UDAV_PAR1 0x11 /* Ethernet Address, load from EEPROM */ 106184610Salfred#define UDAV_PAR2 0x12 /* Ethernet Address, load from EEPROM */ 107184610Salfred#define UDAV_PAR3 0x13 /* Ethernet Address, load from EEPROM */ 108184610Salfred#define UDAV_PAR4 0x14 /* Ethernet Address, load from EEPROM */ 109184610Salfred#define UDAV_PAR5 0x15 /* Ethernet Address, load from EEPROM */ 110184610Salfred#define UDAV_PAR UDAV_PAR0 111184610Salfred 112184610Salfred#define UDAV_MAR0 0x16 /* Multicast Register */ 113184610Salfred#define UDAV_MAR1 0x17 /* Multicast Register */ 114184610Salfred#define UDAV_MAR2 0x18 /* Multicast Register */ 115184610Salfred#define UDAV_MAR3 0x19 /* Multicast Register */ 116184610Salfred#define UDAV_MAR4 0x1a /* Multicast Register */ 117184610Salfred#define UDAV_MAR5 0x1b /* Multicast Register */ 118184610Salfred#define UDAV_MAR6 0x1c /* Multicast Register */ 119184610Salfred#define UDAV_MAR7 0x1d /* Multicast Register */ 120184610Salfred#define UDAV_MAR UDAV_MAR0 121184610Salfred 122184610Salfred#define UDAV_GPCR 0x1e /* General purpose control register */ 123184610Salfred#define UDAV_GPCR_GEP_CNTL6 (1<<6) /* General purpose control 6 */ 124184610Salfred#define UDAV_GPCR_GEP_CNTL5 (1<<5) /* General purpose control 5 */ 125184610Salfred#define UDAV_GPCR_GEP_CNTL4 (1<<4) /* General purpose control 4 */ 126184610Salfred#define UDAV_GPCR_GEP_CNTL3 (1<<3) /* General purpose control 3 */ 127184610Salfred#define UDAV_GPCR_GEP_CNTL2 (1<<2) /* General purpose control 2 */ 128184610Salfred#define UDAV_GPCR_GEP_CNTL1 (1<<1) /* General purpose control 1 */ 129184610Salfred#define UDAV_GPCR_GEP_CNTL0 (1<<0) /* General purpose control 0 */ 130184610Salfred 131184610Salfred#define UDAV_GPR 0x1f /* General purpose register */ 132184610Salfred#define UDAV_GPR_GEPIO6 (1<<6) /* General purpose 6 */ 133184610Salfred#define UDAV_GPR_GEPIO5 (1<<5) /* General purpose 5 */ 134184610Salfred#define UDAV_GPR_GEPIO4 (1<<4) /* General purpose 4 */ 135184610Salfred#define UDAV_GPR_GEPIO3 (1<<3) /* General purpose 3 */ 136184610Salfred#define UDAV_GPR_GEPIO2 (1<<2) /* General purpose 2 */ 137184610Salfred#define UDAV_GPR_GEPIO1 (1<<1) /* General purpose 1 */ 138184610Salfred#define UDAV_GPR_GEPIO0 (1<<0) /* General purpose 0 */ 139184610Salfred 140188412Sthompsa#define GET_MII(sc) usb2_ether_getmii(&(sc)->sc_ue) 141184610Salfred 142188412Sthompsastruct udav_rxpkt { 143188412Sthompsa uint8_t rxstat; 144188412Sthompsa uint16_t pktlen; 145188412Sthompsa} __packed; 146188412Sthompsa 147187259Sthompsaenum { 148187259Sthompsa UDAV_BULK_DT_WR, 149187259Sthompsa UDAV_BULK_DT_RD, 150187259Sthompsa UDAV_INTR_DT_RD, 151188412Sthompsa UDAV_N_TRANSFER, 152187259Sthompsa}; 153187259Sthompsa 154184610Salfredstruct udav_softc { 155188412Sthompsa struct usb2_ether sc_ue; 156188412Sthompsa struct mtx sc_mtx; 157188412Sthompsa struct usb2_xfer *sc_xfer[UDAV_N_TRANSFER]; 158184610Salfred 159188412Sthompsa int sc_flags; 160188412Sthompsa#define UDAV_FLAG_LINK 0x0001 161184610Salfred#define UDAV_FLAG_EXT_PHY 0x0040 162188412Sthompsa}; 163184610Salfred 164188412Sthompsa#define UDAV_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 165188412Sthompsa#define UDAV_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 166188412Sthompsa#define UDAV_LOCK_ASSERT(_sc, t) mtx_assert(&(_sc)->sc_mtx, t) 167