freebsd-dev/sys/dev/usb/net/if_cuereg.h
Pedro F. Giffuni df57947f08 spdx: initial adoption of licensing ID tags.
The Software Package Data Exchange (SPDX) group provides a specification
to make it easier for automated tools to detect and summarize well known
opensource licenses. We are gradually adopting the specification, noting
that the tags are considered only advisory and do not, in any way,
superceed or replace the license texts.

Special thanks to Wind River for providing access to "The Duke of
Highlander" tool: an older (2014) run over FreeBSD tree was useful as a
starting point.

Initially, only tag files that use BSD 4-Clause "Original" license.

RelNotes:	yes
Differential Revision:	https://reviews.freebsd.org/D13133
2017-11-18 14:26:50 +00:00

135 lines
4.6 KiB
C

/*-
* SPDX-License-Identifier: BSD-4-Clause
*
* Copyright (c) 1997, 1998, 1999, 2000
* Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by Bill Paul.
* 4. Neither the name of the author nor the names of any co-contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD$
*/
/*
* Definitions for the CATC Netmate II USB to ethernet controller.
*/
/* Vendor specific control commands. */
#define CUE_CMD_RESET 0xF4
#define CUE_CMD_GET_MACADDR 0xF2
#define CUE_CMD_WRITEREG 0xFA
#define CUE_CMD_READREG 0xFB
#define CUE_CMD_READSRAM 0xF1
#define CUE_CMD_WRITESRAM 0xFC
/* Internal registers. */
#define CUE_TX_BUFCNT 0x20
#define CUE_RX_BUFCNT 0x21
#define CUE_ADVANCED_OPMODES 0x22
#define CUE_TX_BUFPKTS 0x23
#define CUE_RX_BUFPKTS 0x24
#define CUE_RX_MAXCHAIN 0x25
#define CUE_ETHCTL 0x60
#define CUE_ETHSTS 0x61
#define CUE_PAR5 0x62
#define CUE_PAR4 0x63
#define CUE_PAR3 0x64
#define CUE_PAR2 0x65
#define CUE_PAR1 0x66
#define CUE_PAR0 0x67
/* Error counters, all 16 bits wide. */
#define CUE_TX_SINGLECOLL 0x69
#define CUE_TX_MULTICOLL 0x6B
#define CUE_TX_EXCESSCOLL 0x6D
#define CUE_RX_FRAMEERR 0x6F
#define CUE_LEDCTL 0x81
/* Advenced operating mode register. */
#define CUE_AOP_SRAMWAITS 0x03
#define CUE_AOP_EMBED_RXLEN 0x08
#define CUE_AOP_RXCOMBINE 0x10
#define CUE_AOP_TXCOMBINE 0x20
#define CUE_AOP_EVEN_PKT_READS 0x40
#define CUE_AOP_LOOPBK 0x80
/* Ethernet control register. */
#define CUE_ETHCTL_RX_ON 0x01
#define CUE_ETHCTL_LINK_POLARITY 0x02
#define CUE_ETHCTL_LINK_FORCE_OK 0x04
#define CUE_ETHCTL_MCAST_ON 0x08
#define CUE_ETHCTL_PROMISC 0x10
/* Ethernet status register. */
#define CUE_ETHSTS_NO_CARRIER 0x01
#define CUE_ETHSTS_LATECOLL 0x02
#define CUE_ETHSTS_EXCESSCOLL 0x04
#define CUE_ETHSTS_TXBUF_AVAIL 0x08
#define CUE_ETHSTS_BAD_POLARITY 0x10
#define CUE_ETHSTS_LINK_OK 0x20
/* LED control register. */
#define CUE_LEDCTL_BLINK_1X 0x00
#define CUE_LEDCTL_BLINK_2X 0x01
#define CUE_LEDCTL_BLINK_QUARTER_ON 0x02
#define CUE_LEDCTL_BLINK_QUARTER_OFF 0x03
#define CUE_LEDCTL_OFF 0x04
#define CUE_LEDCTL_FOLLOW_LINK 0x08
/*
* Address in ASIC's internal SRAM where the multicast hash table lives.
* The table is 64 bytes long, giving us a 512-bit table. We have to set
* the bit that corresponds to the broadcast address in order to enable
* reception of broadcast frames.
*/
#define CUE_MCAST_TABLE_ADDR 0xFA80
#define CUE_TIMEOUT 1000
#define CUE_MIN_FRAMELEN 60
#define CUE_RX_FRAMES 1
#define CUE_TX_FRAMES 1
#define CUE_CTL_READ 0x01
#define CUE_CTL_WRITE 0x02
#define CUE_CONFIG_IDX 0 /* config number 1 */
#define CUE_IFACE_IDX 0
/* The interrupt endpoint is currently unused by the CATC part. */
enum {
CUE_BULK_DT_WR,
CUE_BULK_DT_RD,
CUE_N_TRANSFER,
};
struct cue_softc {
struct usb_ether sc_ue;
struct mtx sc_mtx;
struct usb_xfer *sc_xfer[CUE_N_TRANSFER];
int sc_flags;
#define CUE_FLAG_LINK 0x0001 /* got a link */
};
#define CUE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
#define CUE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
#define CUE_LOCK_ASSERT(_sc, t) mtx_assert(&(_sc)->sc_mtx, t)