Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* sis900.h Definitions for SiS ethernet controllers including 7014/7016 and 900
0003  * Copyright 1999 Silicon Integrated System Corporation
0004  * References:
0005  *   SiS 7016 Fast Ethernet PCI Bus 10/100 Mbps LAN Controller with OnNow Support,
0006  *  preliminary Rev. 1.0 Jan. 14, 1998
0007  *   SiS 900 Fast Ethernet PCI Bus 10/100 Mbps LAN Single Chip with OnNow Support,
0008  *  preliminary Rev. 1.0 Nov. 10, 1998
0009  *   SiS 7014 Single Chip 100BASE-TX/10BASE-T Physical Layer Solution,
0010  *  preliminary Rev. 1.0 Jan. 18, 1998
0011  *   http://www.sis.com.tw/support/databook.htm
0012  */
0013 
0014 /*
0015  * SiS 7016 and SiS 900 ethernet controller registers
0016  */
0017 
0018 /* The I/O extent, SiS 900 needs 256 bytes of io address */
0019 #define SIS900_TOTAL_SIZE 0x100
0020 
0021 /* Symbolic offsets to registers. */
0022 enum sis900_registers {
0023     cr=0x0,                 //Command Register
0024     cfg=0x4,                //Configuration Register
0025     mear=0x8,               //EEPROM Access Register
0026     ptscr=0xc,              //PCI Test Control Register
0027     isr=0x10,               //Interrupt Status Register
0028     imr=0x14,               //Interrupt Mask Register
0029     ier=0x18,               //Interrupt Enable Register
0030     epar=0x18,              //Enhanced PHY Access Register
0031     txdp=0x20,              //Transmit Descriptor Pointer Register
0032         txcfg=0x24,             //Transmit Configuration Register
0033         rxdp=0x30,              //Receive Descriptor Pointer Register
0034         rxcfg=0x34,             //Receive Configuration Register
0035         flctrl=0x38,            //Flow Control Register
0036         rxlen=0x3c,             //Receive Packet Length Register
0037         rfcr=0x48,              //Receive Filter Control Register
0038         rfdr=0x4C,              //Receive Filter Data Register
0039         pmctrl=0xB0,            //Power Management Control Register
0040         pmer=0xB4               //Power Management Wake-up Event Register
0041 };
0042 
0043 /* Symbolic names for bits in various registers */
0044 enum sis900_command_register_bits {
0045     RELOAD  = 0x00000400, ACCESSMODE = 0x00000200,/* ET */
0046     RESET   = 0x00000100, SWI = 0x00000080, RxRESET = 0x00000020,
0047     TxRESET = 0x00000010, RxDIS = 0x00000008, RxENA = 0x00000004,
0048     TxDIS   = 0x00000002, TxENA = 0x00000001
0049 };
0050 
0051 enum sis900_configuration_register_bits {
0052     DESCRFMT = 0x00000100 /* 7016 specific */, REQALG = 0x00000080,
0053     SB    = 0x00000040, POW = 0x00000020, EXD = 0x00000010,
0054     PESEL = 0x00000008, LPM = 0x00000004, BEM = 0x00000001,
0055     /* 635 & 900B Specific */
0056     RND_CNT = 0x00000400, FAIR_BACKOFF = 0x00000200,
0057     EDB_MASTER_EN = 0x00002000
0058 };
0059 
0060 enum sis900_eeprom_access_register_bits {
0061     MDC  = 0x00000040, MDDIR = 0x00000020, MDIO = 0x00000010, /* 7016 specific */
0062     EECS = 0x00000008, EECLK = 0x00000004, EEDO = 0x00000002,
0063     EEDI = 0x00000001
0064 };
0065 
0066 enum sis900_interrupt_register_bits {
0067     WKEVT  = 0x10000000, TxPAUSEEND = 0x08000000, TxPAUSE = 0x04000000,
0068     TxRCMP = 0x02000000, RxRCMP = 0x01000000, DPERR = 0x00800000,
0069     SSERR  = 0x00400000, RMABT  = 0x00200000, RTABT = 0x00100000,
0070     RxSOVR = 0x00010000, HIBERR = 0x00008000, SWINT = 0x00001000,
0071     MIBINT = 0x00000800, TxURN  = 0x00000400, TxIDLE  = 0x00000200,
0072     TxERR  = 0x00000100, TxDESC = 0x00000080, TxOK  = 0x00000040,
0073     RxORN  = 0x00000020, RxIDLE = 0x00000010, RxEARLY = 0x00000008,
0074     RxERR  = 0x00000004, RxDESC = 0x00000002, RxOK  = 0x00000001
0075 };
0076 
0077 enum sis900_interrupt_enable_register_bits {
0078     IE = 0x00000001
0079 };
0080 
0081 /* maximum dma burst for transmission and receive */
0082 #define MAX_DMA_RANGE   7   /* actually 0 means MAXIMUM !! */
0083 #define TxMXDMA_shift       20
0084 #define RxMXDMA_shift    20
0085 
0086 enum sis900_tx_rx_dma{
0087     DMA_BURST_512 = 0,  DMA_BURST_64 = 5
0088 };
0089 
0090 /* transmit FIFO thresholds */
0091 #define TX_FILL_THRESH   16 /* 1/4 FIFO size */
0092 #define TxFILLT_shift       8
0093 #define TxDRNT_shift        0
0094 #define TxDRNT_100          48  /* 3/4 FIFO size */
0095 #define TxDRNT_10       16  /* 1/2 FIFO size */
0096 
0097 enum sis900_transmit_config_register_bits {
0098     TxCSI = 0x80000000, TxHBI = 0x40000000, TxMLB = 0x20000000,
0099     TxATP = 0x10000000, TxIFG = 0x0C000000, TxFILLT = 0x00003F00,
0100     TxDRNT = 0x0000003F
0101 };
0102 
0103 /* recevie FIFO thresholds */
0104 #define RxDRNT_shift     1
0105 #define RxDRNT_100  16  /* 1/2 FIFO size */
0106 #define RxDRNT_10       24  /* 3/4 FIFO size */
0107 
0108 enum sis900_reveive_config_register_bits {
0109     RxAEP  = 0x80000000, RxARP = 0x40000000, RxATX = 0x10000000,
0110     RxAJAB = 0x08000000, RxDRNT = 0x0000007F
0111 };
0112 
0113 #define RFAA_shift      28
0114 #define RFADDR_shift    16
0115 
0116 enum sis900_receive_filter_control_register_bits {
0117     RFEN  = 0x80000000, RFAAB = 0x40000000, RFAAM = 0x20000000,
0118     RFAAP = 0x10000000, RFPromiscuous = (RFAAB|RFAAM|RFAAP)
0119 };
0120 
0121 enum sis900_reveive_filter_data_mask {
0122     RFDAT =  0x0000FFFF
0123 };
0124 
0125 /* EEPROM Addresses */
0126 enum sis900_eeprom_address {
0127     EEPROMSignature = 0x00, EEPROMVendorID = 0x02, EEPROMDeviceID = 0x03,
0128     EEPROMMACAddr   = 0x08, EEPROMChecksum = 0x0b
0129 };
0130 
0131 /* The EEPROM commands include the alway-set leading bit. Refer to NM93Cxx datasheet */
0132 enum sis900_eeprom_command {
0133     EEread     = 0x0180, EEwrite    = 0x0140, EEerase = 0x01C0,
0134     EEwriteEnable = 0x0130, EEwriteDisable = 0x0100,
0135     EEeraseAll = 0x0120, EEwriteAll = 0x0110,
0136     EEaddrMask = 0x013F, EEcmdShift = 16
0137 };
0138 
0139 /* For SiS962 or SiS963, request the eeprom software access */
0140 enum sis96x_eeprom_command {
0141     EEREQ = 0x00000400, EEDONE = 0x00000200, EEGNT = 0x00000100
0142 };
0143 
0144 /* PCI Registers */
0145 enum sis900_pci_registers {
0146     CFGPMC   = 0x40,
0147     CFGPMCSR = 0x44
0148 };
0149 
0150 /* Power management capabilities bits */
0151 enum sis900_cfgpmc_register_bits {
0152     PMVER   = 0x00070000,
0153     DSI = 0x00100000,
0154     PMESP   = 0xf8000000
0155 };
0156 
0157 enum sis900_pmesp_bits {
0158     PME_D0 = 0x1,
0159     PME_D1 = 0x2,
0160     PME_D2 = 0x4,
0161     PME_D3H = 0x8,
0162     PME_D3C = 0x10
0163 };
0164 
0165 /* Power management control/status bits */
0166 enum sis900_cfgpmcsr_register_bits {
0167     PMESTS = 0x00004000,
0168     PME_EN = 0x00000100, // Power management enable
0169     PWR_STA = 0x00000003 // Current power state
0170 };
0171 
0172 /* Wake-on-LAN support. */
0173 enum sis900_power_management_control_register_bits {
0174     LINKLOSS  = 0x00000001,
0175     LINKON    = 0x00000002,
0176     MAGICPKT  = 0x00000400,
0177     ALGORITHM = 0x00000800,
0178     FRM1EN    = 0x00100000,
0179     FRM2EN    = 0x00200000,
0180     FRM3EN    = 0x00400000,
0181     FRM1ACS   = 0x01000000,
0182     FRM2ACS   = 0x02000000,
0183     FRM3ACS   = 0x04000000,
0184     WAKEALL   = 0x40000000,
0185     GATECLK   = 0x80000000
0186 };
0187 
0188 /* Management Data I/O (mdio) frame */
0189 #define MIIread         0x6000
0190 #define MIIwrite        0x5002
0191 #define MIIpmdShift     7
0192 #define MIIregShift     2
0193 #define MIIcmdLen       16
0194 #define MIIcmdShift     16
0195 
0196 /* Buffer Descriptor Status*/
0197 enum sis900_buffer_status {
0198     OWN    = 0x80000000, MORE   = 0x40000000, INTR = 0x20000000,
0199     SUPCRC = 0x10000000, INCCRC = 0x10000000,
0200     OK     = 0x08000000, DSIZE  = 0x00000FFF
0201 };
0202 /* Status for TX Buffers */
0203 enum sis900_tx_buffer_status {
0204     ABORT   = 0x04000000, UNDERRUN = 0x02000000, NOCARRIER = 0x01000000,
0205     DEFERD  = 0x00800000, EXCDEFER = 0x00400000, OWCOLL    = 0x00200000,
0206     EXCCOLL = 0x00100000, COLCNT   = 0x000F0000
0207 };
0208 
0209 enum sis900_rx_buffer_status {
0210     OVERRUN = 0x02000000, DEST = 0x00800000,     BCAST = 0x01800000,
0211     MCAST   = 0x01000000, UNIMATCH = 0x00800000, TOOLONG = 0x00400000,
0212     RUNT    = 0x00200000, RXISERR  = 0x00100000, CRCERR  = 0x00080000,
0213     FAERR   = 0x00040000, LOOPBK   = 0x00020000, RXCOL   = 0x00010000
0214 };
0215 
0216 /* MII register offsets */
0217 enum mii_registers {
0218     MII_CONTROL = 0x0000, MII_STATUS = 0x0001, MII_PHY_ID0 = 0x0002,
0219     MII_PHY_ID1 = 0x0003, MII_ANADV  = 0x0004, MII_ANLPAR  = 0x0005,
0220     MII_ANEXT   = 0x0006
0221 };
0222 
0223 /* mii registers specific to SiS 900 */
0224 enum sis_mii_registers {
0225     MII_CONFIG1 = 0x0010, MII_CONFIG2 = 0x0011, MII_STSOUT = 0x0012,
0226     MII_MASK    = 0x0013, MII_RESV    = 0x0014
0227 };
0228 
0229 /* mii registers specific to ICS 1893 */
0230 enum ics_mii_registers {
0231     MII_EXTCTRL  = 0x0010, MII_QPDSTS = 0x0011, MII_10BTOP = 0x0012,
0232     MII_EXTCTRL2 = 0x0013
0233 };
0234 
0235 /* mii registers specific to AMD 79C901 */
0236 enum amd_mii_registers {
0237     MII_STATUS_SUMMARY = 0x0018
0238 };
0239 
0240 /* MII Control register bit definitions. */
0241 enum mii_control_register_bits {
0242     MII_CNTL_FDX     = 0x0100, MII_CNTL_RST_AUTO = 0x0200,
0243     MII_CNTL_ISOLATE = 0x0400, MII_CNTL_PWRDWN   = 0x0800,
0244     MII_CNTL_AUTO    = 0x1000, MII_CNTL_SPEED    = 0x2000,
0245     MII_CNTL_LPBK    = 0x4000, MII_CNTL_RESET    = 0x8000
0246 };
0247 
0248 /* MII Status register bit  */
0249 enum mii_status_register_bits {
0250     MII_STAT_EXT    = 0x0001, MII_STAT_JAB        = 0x0002,
0251     MII_STAT_LINK   = 0x0004, MII_STAT_CAN_AUTO   = 0x0008,
0252     MII_STAT_FAULT  = 0x0010, MII_STAT_AUTO_DONE  = 0x0020,
0253     MII_STAT_CAN_T  = 0x0800, MII_STAT_CAN_T_FDX  = 0x1000,
0254     MII_STAT_CAN_TX = 0x2000, MII_STAT_CAN_TX_FDX = 0x4000,
0255     MII_STAT_CAN_T4 = 0x8000
0256 };
0257 
0258 #define     MII_ID1_OUI_LO      0xFC00  /* low bits of OUI mask */
0259 #define     MII_ID1_MODEL       0x03F0  /* model number */
0260 #define     MII_ID1_REV     0x000F  /* model number */
0261 
0262 /* MII NWAY Register Bits ...
0263    valid for the ANAR (Auto-Negotiation Advertisement) and
0264    ANLPAR (Auto-Negotiation Link Partner) registers */
0265 enum mii_nway_register_bits {
0266     MII_NWAY_NODE_SEL = 0x001f, MII_NWAY_CSMA_CD = 0x0001,
0267     MII_NWAY_T    = 0x0020, MII_NWAY_T_FDX   = 0x0040,
0268     MII_NWAY_TX       = 0x0080, MII_NWAY_TX_FDX  = 0x0100,
0269     MII_NWAY_T4       = 0x0200, MII_NWAY_PAUSE   = 0x0400,
0270     MII_NWAY_RF       = 0x2000, MII_NWAY_ACK     = 0x4000,
0271     MII_NWAY_NP       = 0x8000
0272 };
0273 
0274 enum mii_stsout_register_bits {
0275     MII_STSOUT_LINK_FAIL = 0x4000,
0276     MII_STSOUT_SPD       = 0x0080, MII_STSOUT_DPLX = 0x0040
0277 };
0278 
0279 enum mii_stsics_register_bits {
0280     MII_STSICS_SPD  = 0x8000, MII_STSICS_DPLX = 0x4000,
0281     MII_STSICS_LINKSTS = 0x0001
0282 };
0283 
0284 enum mii_stssum_register_bits {
0285     MII_STSSUM_LINK = 0x0008, MII_STSSUM_DPLX = 0x0004,
0286     MII_STSSUM_AUTO = 0x0002, MII_STSSUM_SPD  = 0x0001
0287 };
0288 
0289 enum sis900_revision_id {
0290     SIS630A_900_REV = 0x80,     SIS630E_900_REV = 0x81,
0291     SIS630S_900_REV = 0x82,     SIS630EA1_900_REV = 0x83,
0292     SIS630ET_900_REV = 0x84,    SIS635A_900_REV = 0x90,
0293     SIS96x_900_REV = 0X91,      SIS900B_900_REV = 0x03
0294 };
0295 
0296 enum sis630_revision_id {
0297     SIS630A0    = 0x00, SIS630A1      = 0x01,
0298     SIS630B0    = 0x10, SIS630B1      = 0x11
0299 };
0300 
0301 #define FDX_CAPABLE_DUPLEX_UNKNOWN      0
0302 #define FDX_CAPABLE_HALF_SELECTED       1
0303 #define FDX_CAPABLE_FULL_SELECTED       2
0304 
0305 #define HW_SPEED_UNCONFIG       0
0306 #define HW_SPEED_HOME       1
0307 #define HW_SPEED_10_MBPS            10
0308 #define HW_SPEED_100_MBPS           100
0309 #define HW_SPEED_DEFAULT            (HW_SPEED_100_MBPS)
0310 
0311 #define CRC_SIZE                4
0312 #define MAC_HEADER_SIZE         14
0313 
0314 #if IS_ENABLED(CONFIG_VLAN_8021Q)
0315 #define MAX_FRAME_SIZE  (1518 + 4)
0316 #else
0317 #define MAX_FRAME_SIZE  1518
0318 #endif /* CONFIG_VLAN_802_1Q */
0319 
0320 #define TX_BUF_SIZE     (MAX_FRAME_SIZE+18)
0321 #define RX_BUF_SIZE     (MAX_FRAME_SIZE+18)
0322 
0323 #define NUM_TX_DESC     16          /* Number of Tx descriptor registers. */
0324 #define NUM_RX_DESC     16          /* Number of Rx descriptor registers. */
0325 #define TX_TOTAL_SIZE   NUM_TX_DESC*sizeof(BufferDesc)
0326 #define RX_TOTAL_SIZE   NUM_RX_DESC*sizeof(BufferDesc)
0327 
0328 /* PCI stuff, should be move to pci.h */
0329 #define SIS630_VENDOR_ID        0x1039
0330 #define SIS630_DEVICE_ID        0x0630