if_cuereg.h revision 192984
1184610Salfred/*- 2184610Salfred * Copyright (c) 1997, 1998, 1999, 2000 3184610Salfred * Bill Paul <wpaul@ee.columbia.edu>. All rights reserved. 4184610Salfred * 5184610Salfred * Redistribution and use in source and binary forms, with or without 6184610Salfred * modification, are permitted provided that the following conditions 7184610Salfred * are met: 8184610Salfred * 1. Redistributions of source code must retain the above copyright 9184610Salfred * notice, this list of conditions and the following disclaimer. 10184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 11184610Salfred * notice, this list of conditions and the following disclaimer in the 12184610Salfred * documentation and/or other materials provided with the distribution. 13184610Salfred * 3. All advertising materials mentioning features or use of this software 14184610Salfred * must display the following acknowledgement: 15184610Salfred * This product includes software developed by Bill Paul. 16184610Salfred * 4. 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 Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD 24184610Salfred * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25184610Salfred * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26184610Salfred * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27184610Salfred * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28184610Salfred * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29184610Salfred * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 30184610Salfred * THE POSSIBILITY OF SUCH DAMAGE. 31184610Salfred * 32184610Salfred * $FreeBSD: head/sys/dev/usb/net/if_cuereg.h 192984 2009-05-28 17:36:36Z thompsa $ 33184610Salfred */ 34184610Salfred 35184610Salfred/* 36184610Salfred * Definitions for the CATC Netmate II USB to ethernet controller. 37184610Salfred */ 38184610Salfred 39184610Salfred/* Vendor specific control commands. */ 40184610Salfred#define CUE_CMD_RESET 0xF4 41184610Salfred#define CUE_CMD_GET_MACADDR 0xF2 42184610Salfred#define CUE_CMD_WRITEREG 0xFA 43184610Salfred#define CUE_CMD_READREG 0xFB 44184610Salfred#define CUE_CMD_READSRAM 0xF1 45184610Salfred#define CUE_CMD_WRITESRAM 0xFC 46184610Salfred/* Internal registers. */ 47184610Salfred#define CUE_TX_BUFCNT 0x20 48184610Salfred#define CUE_RX_BUFCNT 0x21 49184610Salfred#define CUE_ADVANCED_OPMODES 0x22 50184610Salfred#define CUE_TX_BUFPKTS 0x23 51184610Salfred#define CUE_RX_BUFPKTS 0x24 52184610Salfred#define CUE_RX_MAXCHAIN 0x25 53184610Salfred#define CUE_ETHCTL 0x60 54184610Salfred#define CUE_ETHSTS 0x61 55184610Salfred#define CUE_PAR5 0x62 56184610Salfred#define CUE_PAR4 0x63 57184610Salfred#define CUE_PAR3 0x64 58184610Salfred#define CUE_PAR2 0x65 59184610Salfred#define CUE_PAR1 0x66 60184610Salfred#define CUE_PAR0 0x67 61184610Salfred/* Error counters, all 16 bits wide. */ 62184610Salfred#define CUE_TX_SINGLECOLL 0x69 63184610Salfred#define CUE_TX_MULTICOLL 0x6B 64184610Salfred#define CUE_TX_EXCESSCOLL 0x6D 65184610Salfred#define CUE_RX_FRAMEERR 0x6F 66184610Salfred#define CUE_LEDCTL 0x81 67184610Salfred/* Advenced operating mode register. */ 68184610Salfred#define CUE_AOP_SRAMWAITS 0x03 69184610Salfred#define CUE_AOP_EMBED_RXLEN 0x08 70184610Salfred#define CUE_AOP_RXCOMBINE 0x10 71184610Salfred#define CUE_AOP_TXCOMBINE 0x20 72184610Salfred#define CUE_AOP_EVEN_PKT_READS 0x40 73184610Salfred#define CUE_AOP_LOOPBK 0x80 74184610Salfred/* Ethernet control register. */ 75184610Salfred#define CUE_ETHCTL_RX_ON 0x01 76184610Salfred#define CUE_ETHCTL_LINK_POLARITY 0x02 77184610Salfred#define CUE_ETHCTL_LINK_FORCE_OK 0x04 78184610Salfred#define CUE_ETHCTL_MCAST_ON 0x08 79184610Salfred#define CUE_ETHCTL_PROMISC 0x10 80184610Salfred/* Ethernet status register. */ 81184610Salfred#define CUE_ETHSTS_NO_CARRIER 0x01 82184610Salfred#define CUE_ETHSTS_LATECOLL 0x02 83184610Salfred#define CUE_ETHSTS_EXCESSCOLL 0x04 84184610Salfred#define CUE_ETHSTS_TXBUF_AVAIL 0x08 85184610Salfred#define CUE_ETHSTS_BAD_POLARITY 0x10 86184610Salfred#define CUE_ETHSTS_LINK_OK 0x20 87184610Salfred/* LED control register. */ 88184610Salfred#define CUE_LEDCTL_BLINK_1X 0x00 89184610Salfred#define CUE_LEDCTL_BLINK_2X 0x01 90184610Salfred#define CUE_LEDCTL_BLINK_QUARTER_ON 0x02 91184610Salfred#define CUE_LEDCTL_BLINK_QUARTER_OFF 0x03 92184610Salfred#define CUE_LEDCTL_OFF 0x04 93184610Salfred#define CUE_LEDCTL_FOLLOW_LINK 0x08 94184610Salfred 95184610Salfred/* 96184610Salfred * Address in ASIC's internal SRAM where the multicast hash table lives. 97184610Salfred * The table is 64 bytes long, giving us a 512-bit table. We have to set 98184610Salfred * the bit that corresponds to the broadcast address in order to enable 99184610Salfred * reception of broadcast frames. 100184610Salfred */ 101184610Salfred#define CUE_MCAST_TABLE_ADDR 0xFA80 102184610Salfred 103184610Salfred#define CUE_TIMEOUT 1000 104184610Salfred#define CUE_MIN_FRAMELEN 60 105184610Salfred#define CUE_RX_FRAMES 1 106184610Salfred#define CUE_TX_FRAMES 1 107184610Salfred 108184610Salfred#define CUE_CTL_READ 0x01 109184610Salfred#define CUE_CTL_WRITE 0x02 110184610Salfred 111184610Salfred#define CUE_CONFIG_IDX 0 /* config number 1 */ 112184610Salfred#define CUE_IFACE_IDX 0 113184610Salfred 114184610Salfred/* The interrupt endpoint is currently unused by the KLSI part. */ 115187259Sthompsaenum { 116187259Sthompsa CUE_BULK_DT_WR, 117187259Sthompsa CUE_BULK_DT_RD, 118188412Sthompsa CUE_N_TRANSFER, 119187259Sthompsa}; 120184610Salfred 121184610Salfredstruct cue_softc { 122192984Sthompsa struct usb_ether sc_ue; 123188412Sthompsa struct mtx sc_mtx; 124192984Sthompsa struct usb_xfer *sc_xfer[CUE_N_TRANSFER]; 125184610Salfred 126188412Sthompsa int sc_flags; 127188412Sthompsa#define CUE_FLAG_LINK 0x0001 /* got a link */ 128188412Sthompsa}; 129184610Salfred 130188412Sthompsa#define CUE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 131188412Sthompsa#define CUE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 132188412Sthompsa#define CUE_LOCK_ASSERT(_sc, t) mtx_assert(&(_sc)->sc_mtx, t) 133