9da7bdde06
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
366 lines
12 KiB
C
366 lines
12 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-4-Clause
|
|
*
|
|
* Copyright (c) 1997, 1998, 1999, 2000-2003
|
|
* Bill Paul <wpaul@windriver.com>. 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 ASIX Electronics AX88172, AX88178
|
|
* and AX88772 to ethernet controllers.
|
|
*/
|
|
|
|
/*
|
|
* Vendor specific commands. ASIX conveniently doesn't document the 'set
|
|
* NODEID' command in their datasheet (thanks a lot guys).
|
|
* To make handling these commands easier, I added some extra data which is
|
|
* decided by the axe_cmd() routine. Commands are encoded in 16 bits, with
|
|
* the format: LDCC. L and D are both nibbles in the high byte. L represents
|
|
* the data length (0 to 15) and D represents the direction (0 for vendor read,
|
|
* 1 for vendor write). CC is the command byte, as specified in the manual.
|
|
*/
|
|
|
|
#define AXE_CMD_IS_WRITE(x) (((x) & 0x0F00) >> 8)
|
|
#define AXE_CMD_LEN(x) (((x) & 0xF000) >> 12)
|
|
#define AXE_CMD_CMD(x) ((x) & 0x00FF)
|
|
|
|
#define AXE_172_CMD_READ_RXTX_SRAM 0x2002
|
|
#define AXE_182_CMD_READ_RXTX_SRAM 0x8002
|
|
#define AXE_172_CMD_WRITE_RX_SRAM 0x0103
|
|
#define AXE_182_CMD_WRITE_RXTX_SRAM 0x8103
|
|
#define AXE_172_CMD_WRITE_TX_SRAM 0x0104
|
|
#define AXE_CMD_MII_OPMODE_SW 0x0106
|
|
#define AXE_CMD_MII_READ_REG 0x2007
|
|
#define AXE_CMD_MII_WRITE_REG 0x2108
|
|
#define AXE_CMD_MII_READ_OPMODE 0x1009
|
|
#define AXE_CMD_MII_OPMODE_HW 0x010A
|
|
#define AXE_CMD_SROM_READ 0x200B
|
|
#define AXE_CMD_SROM_WRITE 0x010C
|
|
#define AXE_CMD_SROM_WR_ENABLE 0x010D
|
|
#define AXE_CMD_SROM_WR_DISABLE 0x010E
|
|
#define AXE_CMD_RXCTL_READ 0x200F
|
|
#define AXE_CMD_RXCTL_WRITE 0x0110
|
|
#define AXE_CMD_READ_IPG012 0x3011
|
|
#define AXE_172_CMD_WRITE_IPG0 0x0112
|
|
#define AXE_178_CMD_WRITE_IPG012 0x0112
|
|
#define AXE_172_CMD_WRITE_IPG1 0x0113
|
|
#define AXE_178_CMD_READ_NODEID 0x6013
|
|
#define AXE_172_CMD_WRITE_IPG2 0x0114
|
|
#define AXE_178_CMD_WRITE_NODEID 0x6114
|
|
#define AXE_CMD_READ_MCAST 0x8015
|
|
#define AXE_CMD_WRITE_MCAST 0x8116
|
|
#define AXE_172_CMD_READ_NODEID 0x6017
|
|
#define AXE_172_CMD_WRITE_NODEID 0x6118
|
|
|
|
#define AXE_CMD_READ_PHYID 0x2019
|
|
#define AXE_172_CMD_READ_MEDIA 0x101A
|
|
#define AXE_178_CMD_READ_MEDIA 0x201A
|
|
#define AXE_CMD_WRITE_MEDIA 0x011B
|
|
#define AXE_CMD_READ_MONITOR_MODE 0x101C
|
|
#define AXE_CMD_WRITE_MONITOR_MODE 0x011D
|
|
#define AXE_CMD_READ_GPIO 0x101E
|
|
#define AXE_CMD_WRITE_GPIO 0x011F
|
|
|
|
#define AXE_CMD_SW_RESET_REG 0x0120
|
|
#define AXE_CMD_SW_PHY_STATUS 0x0021
|
|
#define AXE_CMD_SW_PHY_SELECT 0x0122
|
|
|
|
/* AX88772A and AX88772B only. */
|
|
#define AXE_CMD_READ_VLAN_CTRL 0x4027
|
|
#define AXE_CMD_WRITE_VLAN_CTRL 0x4028
|
|
|
|
#define AXE_772B_CMD_RXCTL_WRITE_CFG 0x012A
|
|
#define AXE_772B_CMD_READ_RXCSUM 0x002B
|
|
#define AXE_772B_CMD_WRITE_RXCSUM 0x012C
|
|
#define AXE_772B_CMD_READ_TXCSUM 0x002D
|
|
#define AXE_772B_CMD_WRITE_TXCSUM 0x012E
|
|
|
|
#define AXE_SW_RESET_CLEAR 0x00
|
|
#define AXE_SW_RESET_RR 0x01
|
|
#define AXE_SW_RESET_RT 0x02
|
|
#define AXE_SW_RESET_PRTE 0x04
|
|
#define AXE_SW_RESET_PRL 0x08
|
|
#define AXE_SW_RESET_BZ 0x10
|
|
#define AXE_SW_RESET_IPRL 0x20
|
|
#define AXE_SW_RESET_IPPD 0x40
|
|
|
|
/* AX88178 documentation says to always write this bit... */
|
|
#define AXE_178_RESET_MAGIC 0x40
|
|
|
|
#define AXE_178_MEDIA_GMII 0x0001
|
|
#define AXE_MEDIA_FULL_DUPLEX 0x0002
|
|
#define AXE_172_MEDIA_TX_ABORT_ALLOW 0x0004
|
|
|
|
/* AX88178/88772 documentation says to always write 1 to bit 2 */
|
|
#define AXE_178_MEDIA_MAGIC 0x0004
|
|
/* AX88772 documentation says to always write 0 to bit 3 */
|
|
#define AXE_178_MEDIA_ENCK 0x0008
|
|
#define AXE_172_MEDIA_FLOW_CONTROL_EN 0x0010
|
|
#define AXE_178_MEDIA_RXFLOW_CONTROL_EN 0x0010
|
|
#define AXE_178_MEDIA_TXFLOW_CONTROL_EN 0x0020
|
|
#define AXE_178_MEDIA_JUMBO_EN 0x0040
|
|
#define AXE_178_MEDIA_LTPF_ONLY 0x0080
|
|
#define AXE_178_MEDIA_RX_EN 0x0100
|
|
#define AXE_178_MEDIA_100TX 0x0200
|
|
#define AXE_178_MEDIA_SBP 0x0800
|
|
#define AXE_178_MEDIA_SUPERMAC 0x1000
|
|
|
|
#define AXE_RXCMD_PROMISC 0x0001
|
|
#define AXE_RXCMD_ALLMULTI 0x0002
|
|
#define AXE_172_RXCMD_UNICAST 0x0004
|
|
#define AXE_178_RXCMD_KEEP_INVALID_CRC 0x0004
|
|
#define AXE_RXCMD_BROADCAST 0x0008
|
|
#define AXE_RXCMD_MULTICAST 0x0010
|
|
#define AXE_RXCMD_ACCEPT_RUNT 0x0040 /* AX88772B */
|
|
#define AXE_RXCMD_ENABLE 0x0080
|
|
#define AXE_178_RXCMD_MFB_MASK 0x0300
|
|
#define AXE_178_RXCMD_MFB_2048 0x0000
|
|
#define AXE_178_RXCMD_MFB_4096 0x0100
|
|
#define AXE_178_RXCMD_MFB_8192 0x0200
|
|
#define AXE_178_RXCMD_MFB_16384 0x0300
|
|
#define AXE_772B_RXCMD_HDR_TYPE_0 0x0000
|
|
#define AXE_772B_RXCMD_HDR_TYPE_1 0x0100
|
|
#define AXE_772B_RXCMD_IPHDR_ALIGN 0x0200
|
|
#define AXE_772B_RXCMD_ADD_CHKSUM 0x0400
|
|
#define AXE_RXCMD_LOOPBACK 0x1000 /* AX88772A/AX88772B */
|
|
|
|
#define AXE_PHY_SEL_PRI 1
|
|
#define AXE_PHY_SEL_SEC 0
|
|
#define AXE_PHY_TYPE_MASK 0xE0
|
|
#define AXE_PHY_TYPE_SHIFT 5
|
|
#define AXE_PHY_TYPE(x) \
|
|
(((x) & AXE_PHY_TYPE_MASK) >> AXE_PHY_TYPE_SHIFT)
|
|
|
|
#define PHY_TYPE_100_HOME 0 /* 10/100 or 1M HOME PHY */
|
|
#define PHY_TYPE_GIG 1 /* Gigabit PHY */
|
|
#define PHY_TYPE_SPECIAL 4 /* Special case */
|
|
#define PHY_TYPE_RSVD 5 /* Reserved */
|
|
#define PHY_TYPE_NON_SUP 7 /* Non-supported PHY */
|
|
|
|
#define AXE_PHY_NO_MASK 0x1F
|
|
#define AXE_PHY_NO(x) ((x) & AXE_PHY_NO_MASK)
|
|
|
|
#define AXE_772_PHY_NO_EPHY 0x10 /* Embedded 10/100 PHY of AX88772 */
|
|
|
|
#define AXE_GPIO0_EN 0x01
|
|
#define AXE_GPIO0 0x02
|
|
#define AXE_GPIO1_EN 0x04
|
|
#define AXE_GPIO1 0x08
|
|
#define AXE_GPIO2_EN 0x10
|
|
#define AXE_GPIO2 0x20
|
|
#define AXE_GPIO_RELOAD_EEPROM 0x80
|
|
|
|
#define AXE_PHY_MODE_MARVELL 0x00
|
|
#define AXE_PHY_MODE_CICADA 0x01
|
|
#define AXE_PHY_MODE_AGERE 0x02
|
|
#define AXE_PHY_MODE_CICADA_V2 0x05
|
|
#define AXE_PHY_MODE_AGERE_GMII 0x06
|
|
#define AXE_PHY_MODE_CICADA_V2_ASIX 0x09
|
|
#define AXE_PHY_MODE_REALTEK_8211CL 0x0C
|
|
#define AXE_PHY_MODE_REALTEK_8211BN 0x0D
|
|
#define AXE_PHY_MODE_REALTEK_8251CL 0x0E
|
|
#define AXE_PHY_MODE_ATTANSIC 0x40
|
|
|
|
/* AX88772A/AX88772B only. */
|
|
#define AXE_SW_PHY_SELECT_EXT 0x0000
|
|
#define AXE_SW_PHY_SELECT_EMBEDDED 0x0001
|
|
#define AXE_SW_PHY_SELECT_AUTO 0x0002
|
|
#define AXE_SW_PHY_SELECT_SS_MII 0x0004
|
|
#define AXE_SW_PHY_SELECT_SS_RVRS_MII 0x0008
|
|
#define AXE_SW_PHY_SELECT_SS_RVRS_RMII 0x000C
|
|
#define AXE_SW_PHY_SELECT_SS_ENB 0x0010
|
|
|
|
/* AX88772A/AX88772B VLAN control. */
|
|
#define AXE_VLAN_CTRL_ENB 0x00001000
|
|
#define AXE_VLAN_CTRL_STRIP 0x00002000
|
|
#define AXE_VLAN_CTRL_VID1_MASK 0x00000FFF
|
|
#define AXE_VLAN_CTRL_VID2_MASK 0x0FFF0000
|
|
|
|
#define AXE_RXCSUM_IP 0x0001
|
|
#define AXE_RXCSUM_IPVE 0x0002
|
|
#define AXE_RXCSUM_IPV6E 0x0004
|
|
#define AXE_RXCSUM_TCP 0x0008
|
|
#define AXE_RXCSUM_UDP 0x0010
|
|
#define AXE_RXCSUM_ICMP 0x0020
|
|
#define AXE_RXCSUM_IGMP 0x0040
|
|
#define AXE_RXCSUM_ICMP6 0x0080
|
|
#define AXE_RXCSUM_TCPV6 0x0100
|
|
#define AXE_RXCSUM_UDPV6 0x0200
|
|
#define AXE_RXCSUM_ICMPV6 0x0400
|
|
#define AXE_RXCSUM_IGMPV6 0x0800
|
|
#define AXE_RXCSUM_ICMP6V6 0x1000
|
|
#define AXE_RXCSUM_FOPC 0x8000
|
|
|
|
#define AXE_RXCSUM_64TE 0x0100
|
|
#define AXE_RXCSUM_PPPOE 0x0200
|
|
#define AXE_RXCSUM_RPCE 0x8000
|
|
|
|
#define AXE_TXCSUM_IP 0x0001
|
|
#define AXE_TXCSUM_TCP 0x0002
|
|
#define AXE_TXCSUM_UDP 0x0004
|
|
#define AXE_TXCSUM_ICMP 0x0008
|
|
#define AXE_TXCSUM_IGMP 0x0010
|
|
#define AXE_TXCSUM_ICMP6 0x0020
|
|
#define AXE_TXCSUM_TCPV6 0x0100
|
|
#define AXE_TXCSUM_UDPV6 0x0200
|
|
#define AXE_TXCSUM_ICMPV6 0x0400
|
|
#define AXE_TXCSUM_IGMPV6 0x0800
|
|
#define AXE_TXCSUM_ICMP6V6 0x1000
|
|
|
|
#define AXE_TXCSUM_64TE 0x0001
|
|
#define AXE_TXCSUM_PPPOE 0x0002
|
|
|
|
#define AXE_BULK_BUF_SIZE 16384 /* bytes */
|
|
|
|
#define AXE_CTL_READ 0x01
|
|
#define AXE_CTL_WRITE 0x02
|
|
|
|
#define AXE_CONFIG_IDX 0 /* config number 1 */
|
|
#define AXE_IFACE_IDX 0
|
|
|
|
/* EEPROM Map. */
|
|
#define AXE_EEPROM_772B_NODE_ID 0x04
|
|
#define AXE_EEPROM_772B_PHY_PWRCFG 0x18
|
|
|
|
struct ax88772b_mfb {
|
|
int byte_cnt;
|
|
int threshold;
|
|
int size;
|
|
};
|
|
#define AX88772B_MFB_2K 0
|
|
#define AX88772B_MFB_4K 1
|
|
#define AX88772B_MFB_6K 2
|
|
#define AX88772B_MFB_8K 3
|
|
#define AX88772B_MFB_16K 4
|
|
#define AX88772B_MFB_20K 5
|
|
#define AX88772B_MFB_24K 6
|
|
#define AX88772B_MFB_32K 7
|
|
|
|
struct axe_sframe_hdr {
|
|
uint16_t len;
|
|
#define AXE_HDR_LEN_MASK 0xFFFF
|
|
uint16_t ilen;
|
|
} __packed;
|
|
|
|
#define AXE_TX_CSUM_PSEUDO_HDR 0x4000
|
|
#define AXE_TX_CSUM_DIS 0x8000
|
|
|
|
/*
|
|
* When RX checksum offloading is enabled, AX88772B uses new RX header
|
|
* format and it's not compatible with previous RX header format. In
|
|
* addition, IP header align option should be enabled to get correct
|
|
* frame size including RX header. Total transferred size including
|
|
* the RX header is multiple of 4 and controller will pad necessary
|
|
* bytes if the length is not multiple of 4.
|
|
* This driver does not enable partial checksum feature which will
|
|
* compute 16bit checksum from 14th byte to the end of the frame. If
|
|
* this feature is enabled, computed checksum value is embedded into
|
|
* RX header which in turn means it uses different RX header format.
|
|
*/
|
|
struct axe_csum_hdr {
|
|
uint16_t len;
|
|
#define AXE_CSUM_HDR_LEN_MASK 0x07FF
|
|
#define AXE_CSUM_HDR_CRC_ERR 0x1000
|
|
#define AXE_CSUM_HDR_MII_ERR 0x2000
|
|
#define AXE_CSUM_HDR_RUNT 0x4000
|
|
#define AXE_CSUM_HDR_BMCAST 0x8000
|
|
uint16_t ilen;
|
|
uint16_t cstatus;
|
|
#define AXE_CSUM_HDR_VLAN_MASK 0x0007
|
|
#define AXE_CSUM_HDR_VLAN_STRIP 0x0008
|
|
#define AXE_CSUM_HDR_VLAN_PRI_MASK 0x0070
|
|
#define AXE_CSUM_HDR_L4_CSUM_ERR 0x0100
|
|
#define AXE_CSUM_HDR_L3_CSUM_ERR 0x0200
|
|
#define AXE_CSUM_HDR_L4_TYPE_UDP 0x0400
|
|
#define AXE_CSUM_HDR_L4_TYPE_ICMP 0x0800
|
|
#define AXE_CSUM_HDR_L4_TYPE_IGMP 0x0C00
|
|
#define AXE_CSUM_HDR_L4_TYPE_TCP 0x1000
|
|
#define AXE_CSUM_HDR_L4_TYPE_TCPV6 0x1400
|
|
#define AXE_CSUM_HDR_L4_TYPE_MASK 0x1C00
|
|
#define AXE_CSUM_HDR_L3_TYPE_IPV4 0x2000
|
|
#define AXE_CSUM_HDR_L3_TYPE_IPV6 0x4000
|
|
|
|
#ifdef AXE_APPEND_PARTIAL_CSUM
|
|
/*
|
|
* These members present only when partial checksum
|
|
* offloading is enabled. The checksum value is simple
|
|
* 16bit sum of received frame starting at offset 14 of
|
|
* the frame to the end of the frame excluding FCS bytes.
|
|
*/
|
|
uint16_t csum_value;
|
|
uint16_t dummy;
|
|
#endif
|
|
} __packed;
|
|
|
|
#define AXE_CSUM_RXBYTES(x) ((x) & AXE_CSUM_HDR_LEN_MASK)
|
|
|
|
#define GET_MII(sc) uether_getmii(&(sc)->sc_ue)
|
|
|
|
/* The interrupt endpoint is currently unused by the ASIX part. */
|
|
enum {
|
|
AXE_BULK_DT_WR,
|
|
AXE_BULK_DT_RD,
|
|
AXE_N_TRANSFER,
|
|
};
|
|
|
|
struct axe_softc {
|
|
struct usb_ether sc_ue;
|
|
struct mtx sc_mtx;
|
|
struct usb_xfer *sc_xfer[AXE_N_TRANSFER];
|
|
int sc_phyno;
|
|
|
|
int sc_flags;
|
|
#define AXE_FLAG_LINK 0x0001
|
|
#define AXE_FLAG_STD_FRAME 0x0010
|
|
#define AXE_FLAG_CSUM_FRAME 0x0020
|
|
#define AXE_FLAG_772 0x1000 /* AX88772 */
|
|
#define AXE_FLAG_772A 0x2000 /* AX88772A */
|
|
#define AXE_FLAG_772B 0x4000 /* AX88772B */
|
|
#define AXE_FLAG_178 0x8000 /* AX88178 */
|
|
|
|
uint8_t sc_ipgs[3];
|
|
uint8_t sc_phyaddrs[2];
|
|
uint16_t sc_pwrcfg;
|
|
uint16_t sc_lenmask;
|
|
};
|
|
|
|
#define AXE_IS_178_FAMILY(sc) \
|
|
((sc)->sc_flags & (AXE_FLAG_772 | AXE_FLAG_772A | AXE_FLAG_772B | \
|
|
AXE_FLAG_178))
|
|
|
|
#define AXE_IS_772(sc) \
|
|
((sc)->sc_flags & (AXE_FLAG_772 | AXE_FLAG_772A | AXE_FLAG_772B))
|
|
|
|
#define AXE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
|
|
#define AXE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
|
|
#define AXE_LOCK_ASSERT(_sc, t) mtx_assert(&(_sc)->sc_mtx, t)
|