Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* $Id: sunhme.h,v 1.33 2001/08/03 06:23:04 davem Exp $
0003  * sunhme.h: Definitions for Sparc HME/BigMac 10/100baseT ethernet driver.
0004  *           Also known as the "Happy Meal".
0005  *
0006  * Copyright (C) 1996, 1999 David S. Miller (davem@redhat.com)
0007  */
0008 
0009 #ifndef _SUNHME_H
0010 #define _SUNHME_H
0011 
0012 #include <linux/pci.h>
0013 
0014 /* Happy Meal global registers. */
0015 #define GREG_SWRESET    0x000UL /* Software Reset  */
0016 #define GREG_CFG    0x004UL /* Config Register */
0017 #define GREG_STAT   0x100UL /* Status          */
0018 #define GREG_IMASK  0x104UL /* Interrupt Mask  */
0019 #define GREG_REG_SIZE   0x108UL
0020 
0021 /* Global reset register. */
0022 #define GREG_RESET_ETX         0x01
0023 #define GREG_RESET_ERX         0x02
0024 #define GREG_RESET_ALL         0x03
0025 
0026 /* Global config register. */
0027 #define GREG_CFG_BURSTMSK      0x03
0028 #define GREG_CFG_BURST16       0x00
0029 #define GREG_CFG_BURST32       0x01
0030 #define GREG_CFG_BURST64       0x02
0031 #define GREG_CFG_64BIT         0x04
0032 #define GREG_CFG_PARITY        0x08
0033 #define GREG_CFG_RESV          0x10
0034 
0035 /* Global status register. */
0036 #define GREG_STAT_GOTFRAME     0x00000001 /* Received a frame                         */
0037 #define GREG_STAT_RCNTEXP      0x00000002 /* Receive frame counter expired            */
0038 #define GREG_STAT_ACNTEXP      0x00000004 /* Align-error counter expired              */
0039 #define GREG_STAT_CCNTEXP      0x00000008 /* CRC-error counter expired                */
0040 #define GREG_STAT_LCNTEXP      0x00000010 /* Length-error counter expired             */
0041 #define GREG_STAT_RFIFOVF      0x00000020 /* Receive FIFO overflow                    */
0042 #define GREG_STAT_CVCNTEXP     0x00000040 /* Code-violation counter expired           */
0043 #define GREG_STAT_STSTERR      0x00000080 /* Test error in XIF for SQE                */
0044 #define GREG_STAT_SENTFRAME    0x00000100 /* Transmitted a frame                      */
0045 #define GREG_STAT_TFIFO_UND    0x00000200 /* Transmit FIFO underrun                   */
0046 #define GREG_STAT_MAXPKTERR    0x00000400 /* Max-packet size error                    */
0047 #define GREG_STAT_NCNTEXP      0x00000800 /* Normal-collision counter expired         */
0048 #define GREG_STAT_ECNTEXP      0x00001000 /* Excess-collision counter expired         */
0049 #define GREG_STAT_LCCNTEXP     0x00002000 /* Late-collision counter expired           */
0050 #define GREG_STAT_FCNTEXP      0x00004000 /* First-collision counter expired          */
0051 #define GREG_STAT_DTIMEXP      0x00008000 /* Defer-timer expired                      */
0052 #define GREG_STAT_RXTOHOST     0x00010000 /* Moved from receive-FIFO to host memory   */
0053 #define GREG_STAT_NORXD        0x00020000 /* No more receive descriptors              */
0054 #define GREG_STAT_RXERR        0x00040000 /* Error during receive dma                 */
0055 #define GREG_STAT_RXLATERR     0x00080000 /* Late error during receive dma            */
0056 #define GREG_STAT_RXPERR       0x00100000 /* Parity error during receive dma          */
0057 #define GREG_STAT_RXTERR       0x00200000 /* Tag error during receive dma             */
0058 #define GREG_STAT_EOPERR       0x00400000 /* Transmit descriptor did not have EOP set */
0059 #define GREG_STAT_MIFIRQ       0x00800000 /* MIF is signaling an interrupt condition  */
0060 #define GREG_STAT_HOSTTOTX     0x01000000 /* Moved from host memory to transmit-FIFO  */
0061 #define GREG_STAT_TXALL        0x02000000 /* Transmitted all packets in the tx-fifo   */
0062 #define GREG_STAT_TXEACK       0x04000000 /* Error during transmit dma                */
0063 #define GREG_STAT_TXLERR       0x08000000 /* Late error during transmit dma           */
0064 #define GREG_STAT_TXPERR       0x10000000 /* Parity error during transmit dma         */
0065 #define GREG_STAT_TXTERR       0x20000000 /* Tag error during transmit dma            */
0066 #define GREG_STAT_SLVERR       0x40000000 /* PIO access got an error                  */
0067 #define GREG_STAT_SLVPERR      0x80000000 /* PIO access got a parity error            */
0068 
0069 /* All interesting error conditions. */
0070 #define GREG_STAT_ERRORS       0xfc7efefc
0071 
0072 /* Global interrupt mask register. */
0073 #define GREG_IMASK_GOTFRAME    0x00000001 /* Received a frame                         */
0074 #define GREG_IMASK_RCNTEXP     0x00000002 /* Receive frame counter expired            */
0075 #define GREG_IMASK_ACNTEXP     0x00000004 /* Align-error counter expired              */
0076 #define GREG_IMASK_CCNTEXP     0x00000008 /* CRC-error counter expired                */
0077 #define GREG_IMASK_LCNTEXP     0x00000010 /* Length-error counter expired             */
0078 #define GREG_IMASK_RFIFOVF     0x00000020 /* Receive FIFO overflow                    */
0079 #define GREG_IMASK_CVCNTEXP    0x00000040 /* Code-violation counter expired           */
0080 #define GREG_IMASK_STSTERR     0x00000080 /* Test error in XIF for SQE                */
0081 #define GREG_IMASK_SENTFRAME   0x00000100 /* Transmitted a frame                      */
0082 #define GREG_IMASK_TFIFO_UND   0x00000200 /* Transmit FIFO underrun                   */
0083 #define GREG_IMASK_MAXPKTERR   0x00000400 /* Max-packet size error                    */
0084 #define GREG_IMASK_NCNTEXP     0x00000800 /* Normal-collision counter expired         */
0085 #define GREG_IMASK_ECNTEXP     0x00001000 /* Excess-collision counter expired         */
0086 #define GREG_IMASK_LCCNTEXP    0x00002000 /* Late-collision counter expired           */
0087 #define GREG_IMASK_FCNTEXP     0x00004000 /* First-collision counter expired          */
0088 #define GREG_IMASK_DTIMEXP     0x00008000 /* Defer-timer expired                      */
0089 #define GREG_IMASK_RXTOHOST    0x00010000 /* Moved from receive-FIFO to host memory   */
0090 #define GREG_IMASK_NORXD       0x00020000 /* No more receive descriptors              */
0091 #define GREG_IMASK_RXERR       0x00040000 /* Error during receive dma                 */
0092 #define GREG_IMASK_RXLATERR    0x00080000 /* Late error during receive dma            */
0093 #define GREG_IMASK_RXPERR      0x00100000 /* Parity error during receive dma          */
0094 #define GREG_IMASK_RXTERR      0x00200000 /* Tag error during receive dma             */
0095 #define GREG_IMASK_EOPERR      0x00400000 /* Transmit descriptor did not have EOP set */
0096 #define GREG_IMASK_MIFIRQ      0x00800000 /* MIF is signaling an interrupt condition  */
0097 #define GREG_IMASK_HOSTTOTX    0x01000000 /* Moved from host memory to transmit-FIFO  */
0098 #define GREG_IMASK_TXALL       0x02000000 /* Transmitted all packets in the tx-fifo   */
0099 #define GREG_IMASK_TXEACK      0x04000000 /* Error during transmit dma                */
0100 #define GREG_IMASK_TXLERR      0x08000000 /* Late error during transmit dma           */
0101 #define GREG_IMASK_TXPERR      0x10000000 /* Parity error during transmit dma         */
0102 #define GREG_IMASK_TXTERR      0x20000000 /* Tag error during transmit dma            */
0103 #define GREG_IMASK_SLVERR      0x40000000 /* PIO access got an error                  */
0104 #define GREG_IMASK_SLVPERR     0x80000000 /* PIO access got a parity error            */
0105 
0106 /* Happy Meal external transmitter registers. */
0107 #define ETX_PENDING 0x00UL  /* Transmit pending/wakeup register */
0108 #define ETX_CFG     0x04UL  /* Transmit config register         */
0109 #define ETX_RING    0x08UL  /* Transmit ring pointer            */
0110 #define ETX_BBASE   0x0cUL  /* Transmit buffer base             */
0111 #define ETX_BDISP   0x10UL  /* Transmit buffer displacement     */
0112 #define ETX_FIFOWPTR    0x14UL  /* FIFO write ptr                   */
0113 #define ETX_FIFOSWPTR   0x18UL  /* FIFO write ptr (shadow register) */
0114 #define ETX_FIFORPTR    0x1cUL  /* FIFO read ptr                    */
0115 #define ETX_FIFOSRPTR   0x20UL  /* FIFO read ptr (shadow register)  */
0116 #define ETX_FIFOPCNT    0x24UL  /* FIFO packet counter              */
0117 #define ETX_SMACHINE    0x28UL  /* Transmitter state machine        */
0118 #define ETX_RSIZE   0x2cUL  /* Ring descriptor size             */
0119 #define ETX_BPTR    0x30UL  /* Transmit data buffer ptr         */
0120 #define ETX_REG_SIZE    0x34UL
0121 
0122 /* ETX transmit pending register. */
0123 #define ETX_TP_DMAWAKEUP         0x00000001 /* Restart transmit dma             */
0124 
0125 /* ETX config register. */
0126 #define ETX_CFG_DMAENABLE        0x00000001 /* Enable transmit dma              */
0127 #define ETX_CFG_FIFOTHRESH       0x000003fe /* Transmit FIFO threshold          */
0128 #define ETX_CFG_IRQDAFTER        0x00000400 /* Interrupt after TX-FIFO drained  */
0129 #define ETX_CFG_IRQDBEFORE       0x00000000 /* Interrupt before TX-FIFO drained */
0130 
0131 #define ETX_RSIZE_SHIFT          4
0132 
0133 /* Happy Meal external receiver registers. */
0134 #define ERX_CFG     0x00UL  /* Receiver config register         */
0135 #define ERX_RING    0x04UL  /* Receiver ring ptr                */
0136 #define ERX_BPTR    0x08UL  /* Receiver buffer ptr              */
0137 #define ERX_FIFOWPTR    0x0cUL  /* FIFO write ptr                   */
0138 #define ERX_FIFOSWPTR   0x10UL  /* FIFO write ptr (shadow register) */
0139 #define ERX_FIFORPTR    0x14UL  /* FIFO read ptr                    */
0140 #define ERX_FIFOSRPTR   0x18UL  /* FIFO read ptr (shadow register)  */
0141 #define ERX_SMACHINE    0x1cUL  /* Receiver state machine           */
0142 #define ERX_REG_SIZE    0x20UL
0143 
0144 /* ERX config register. */
0145 #define ERX_CFG_DMAENABLE    0x00000001 /* Enable receive DMA        */
0146 #define ERX_CFG_RESV1        0x00000006 /* Unused...                 */
0147 #define ERX_CFG_BYTEOFFSET   0x00000038 /* Receive first byte offset */
0148 #define ERX_CFG_RESV2        0x000001c0 /* Unused...                 */
0149 #define ERX_CFG_SIZE32       0x00000000 /* Receive ring size == 32   */
0150 #define ERX_CFG_SIZE64       0x00000200 /* Receive ring size == 64   */
0151 #define ERX_CFG_SIZE128      0x00000400 /* Receive ring size == 128  */
0152 #define ERX_CFG_SIZE256      0x00000600 /* Receive ring size == 256  */
0153 #define ERX_CFG_RESV3        0x0000f800 /* Unused...                 */
0154 #define ERX_CFG_CSUMSTART    0x007f0000 /* Offset of checksum start,
0155                      * in halfwords. */
0156 
0157 /* I'd like a Big Mac, small fries, small coke, and SparcLinux please. */
0158 #define BMAC_XIFCFG 0x0000UL    /* XIF config register                */
0159     /* 0x4-->0x204, reserved */
0160 #define BMAC_TXSWRESET  0x208UL /* Transmitter software reset         */
0161 #define BMAC_TXCFG  0x20cUL /* Transmitter config register        */
0162 #define BMAC_IGAP1  0x210UL /* Inter-packet gap 1                 */
0163 #define BMAC_IGAP2  0x214UL /* Inter-packet gap 2                 */
0164 #define BMAC_ALIMIT 0x218UL /* Transmit attempt limit             */
0165 #define BMAC_STIME  0x21cUL /* Transmit slot time                 */
0166 #define BMAC_PLEN   0x220UL /* Size of transmit preamble          */
0167 #define BMAC_PPAT   0x224UL /* Pattern for transmit preamble      */
0168 #define BMAC_TXSDELIM   0x228UL /* Transmit delimiter                 */
0169 #define BMAC_JSIZE  0x22cUL /* Jam size                           */
0170 #define BMAC_TXMAX  0x230UL /* Transmit max pkt size              */
0171 #define BMAC_TXMIN  0x234UL /* Transmit min pkt size              */
0172 #define BMAC_PATTEMPT   0x238UL /* Count of transmit peak attempts    */
0173 #define BMAC_DTCTR  0x23cUL /* Transmit defer timer               */
0174 #define BMAC_NCCTR  0x240UL /* Transmit normal-collision counter  */
0175 #define BMAC_FCCTR  0x244UL /* Transmit first-collision counter   */
0176 #define BMAC_EXCTR  0x248UL /* Transmit excess-collision counter  */
0177 #define BMAC_LTCTR  0x24cUL /* Transmit late-collision counter    */
0178 #define BMAC_RSEED  0x250UL /* Transmit random number seed        */
0179 #define BMAC_TXSMACHINE 0x254UL /* Transmit state machine             */
0180     /* 0x258-->0x304, reserved */
0181 #define BMAC_RXSWRESET  0x308UL /* Receiver software reset            */
0182 #define BMAC_RXCFG  0x30cUL /* Receiver config register           */
0183 #define BMAC_RXMAX  0x310UL /* Receive max pkt size               */
0184 #define BMAC_RXMIN  0x314UL /* Receive min pkt size               */
0185 #define BMAC_MACADDR2   0x318UL /* Ether address register 2           */
0186 #define BMAC_MACADDR1   0x31cUL /* Ether address register 1           */
0187 #define BMAC_MACADDR0   0x320UL /* Ether address register 0           */
0188 #define BMAC_FRCTR  0x324UL /* Receive frame receive counter      */
0189 #define BMAC_GLECTR 0x328UL /* Receive giant-length error counter */
0190 #define BMAC_UNALECTR   0x32cUL /* Receive unaligned error counter    */
0191 #define BMAC_RCRCECTR   0x330UL /* Receive CRC error counter          */
0192 #define BMAC_RXSMACHINE 0x334UL /* Receiver state machine             */
0193 #define BMAC_RXCVALID   0x338UL /* Receiver code violation            */
0194     /* 0x33c, reserved */
0195 #define BMAC_HTABLE3    0x340UL /* Hash table 3                       */
0196 #define BMAC_HTABLE2    0x344UL /* Hash table 2                       */
0197 #define BMAC_HTABLE1    0x348UL /* Hash table 1                       */
0198 #define BMAC_HTABLE0    0x34cUL /* Hash table 0                       */
0199 #define BMAC_AFILTER2   0x350UL /* Address filter 2                   */
0200 #define BMAC_AFILTER1   0x354UL /* Address filter 1                   */
0201 #define BMAC_AFILTER0   0x358UL /* Address filter 0                   */
0202 #define BMAC_AFMASK 0x35cUL /* Address filter mask                */
0203 #define BMAC_REG_SIZE   0x360UL
0204 
0205 /* BigMac XIF config register. */
0206 #define BIGMAC_XCFG_ODENABLE  0x00000001 /* Output driver enable         */
0207 #define BIGMAC_XCFG_XLBACK    0x00000002 /* Loopback-mode XIF enable     */
0208 #define BIGMAC_XCFG_MLBACK    0x00000004 /* Loopback-mode MII enable     */
0209 #define BIGMAC_XCFG_MIIDISAB  0x00000008 /* MII receive buffer disable   */
0210 #define BIGMAC_XCFG_SQENABLE  0x00000010 /* SQE test enable              */
0211 #define BIGMAC_XCFG_SQETWIN   0x000003e0 /* SQE time window              */
0212 #define BIGMAC_XCFG_LANCE     0x00000010 /* Lance mode enable            */
0213 #define BIGMAC_XCFG_LIPG0     0x000003e0 /* Lance mode IPG0              */
0214 
0215 /* BigMac transmit config register. */
0216 #define BIGMAC_TXCFG_ENABLE   0x00000001 /* Enable the transmitter       */
0217 #define BIGMAC_TXCFG_SMODE    0x00000020 /* Enable slow transmit mode    */
0218 #define BIGMAC_TXCFG_CIGN     0x00000040 /* Ignore transmit collisions   */
0219 #define BIGMAC_TXCFG_FCSOFF   0x00000080 /* Do not emit FCS              */
0220 #define BIGMAC_TXCFG_DBACKOFF 0x00000100 /* Disable backoff              */
0221 #define BIGMAC_TXCFG_FULLDPLX 0x00000200 /* Enable full-duplex           */
0222 #define BIGMAC_TXCFG_DGIVEUP  0x00000400 /* Don't give up on transmits   */
0223 
0224 /* BigMac receive config register. */
0225 #define BIGMAC_RXCFG_ENABLE   0x00000001 /* Enable the receiver             */
0226 #define BIGMAC_RXCFG_PSTRIP   0x00000020 /* Pad byte strip enable           */
0227 #define BIGMAC_RXCFG_PMISC    0x00000040 /* Enable promiscuous mode          */
0228 #define BIGMAC_RXCFG_DERR     0x00000080 /* Disable error checking          */
0229 #define BIGMAC_RXCFG_DCRCS    0x00000100 /* Disable CRC stripping           */
0230 #define BIGMAC_RXCFG_REJME    0x00000200 /* Reject packets addressed to me  */
0231 #define BIGMAC_RXCFG_PGRP     0x00000400 /* Enable promisc group mode       */
0232 #define BIGMAC_RXCFG_HENABLE  0x00000800 /* Enable the hash filter          */
0233 #define BIGMAC_RXCFG_AENABLE  0x00001000 /* Enable the address filter       */
0234 
0235 /* These are the "Management Interface" (ie. MIF) registers of the transceiver. */
0236 #define TCVR_BBCLOCK    0x00UL  /* Bit bang clock register          */
0237 #define TCVR_BBDATA 0x04UL  /* Bit bang data register           */
0238 #define TCVR_BBOENAB    0x08UL  /* Bit bang output enable           */
0239 #define TCVR_FRAME  0x0cUL  /* Frame control/data register      */
0240 #define TCVR_CFG    0x10UL  /* MIF config register              */
0241 #define TCVR_IMASK  0x14UL  /* MIF interrupt mask               */
0242 #define TCVR_STATUS 0x18UL  /* MIF status                       */
0243 #define TCVR_SMACHINE   0x1cUL  /* MIF state machine                */
0244 #define TCVR_REG_SIZE   0x20UL
0245 
0246 /* Frame commands. */
0247 #define FRAME_WRITE           0x50020000
0248 #define FRAME_READ            0x60020000
0249 
0250 /* Transceiver config register */
0251 #define TCV_CFG_PSELECT       0x00000001 /* Select PHY                      */
0252 #define TCV_CFG_PENABLE       0x00000002 /* Enable MIF polling              */
0253 #define TCV_CFG_BENABLE       0x00000004 /* Enable the "bit banger" oh baby */
0254 #define TCV_CFG_PREGADDR      0x000000f8 /* Address of poll register        */
0255 #define TCV_CFG_MDIO0         0x00000100 /* MDIO zero, data/attached        */
0256 #define TCV_CFG_MDIO1         0x00000200 /* MDIO one,  data/attached        */
0257 #define TCV_CFG_PDADDR        0x00007c00 /* Device PHY address polling      */
0258 
0259 /* Here are some PHY addresses. */
0260 #define TCV_PADDR_ETX         0          /* Internal transceiver            */
0261 #define TCV_PADDR_ITX         1          /* External transceiver            */
0262 
0263 /* Transceiver status register */
0264 #define TCV_STAT_BASIC        0xffff0000 /* The "basic" part                */
0265 #define TCV_STAT_NORMAL       0x0000ffff /* The "non-basic" part            */
0266 
0267 /* Inside the Happy Meal transceiver is the physical layer, they use an
0268  * implementations for National Semiconductor, part number DP83840VCE.
0269  * You can retrieve the data sheets and programming docs for this beast
0270  * from http://www.national.com/
0271  *
0272  * The DP83840 is capable of both 10 and 100Mbps ethernet, in both
0273  * half and full duplex mode.  It also supports auto negotiation.
0274  *
0275  * But.... THIS THING IS A PAIN IN THE ASS TO PROGRAM!
0276  * Debugging eeprom burnt code is more fun than programming this chip!
0277  */
0278 
0279 /* Generic MII registers defined in linux/mii.h, these below
0280  * are DP83840 specific.
0281  */
0282 #define DP83840_CSCONFIG        0x17        /* CS configuration            */
0283 
0284 /* The Carrier Sense config register. */
0285 #define CSCONFIG_RESV1          0x0001  /* Unused...                   */
0286 #define CSCONFIG_LED4           0x0002  /* Pin for full-dplx LED4      */
0287 #define CSCONFIG_LED1           0x0004  /* Pin for conn-status LED1    */
0288 #define CSCONFIG_RESV2          0x0008  /* Unused...                   */
0289 #define CSCONFIG_TCVDISAB       0x0010  /* Turns off the transceiver   */
0290 #define CSCONFIG_DFBYPASS       0x0020  /* Bypass disconnect function  */
0291 #define CSCONFIG_GLFORCE        0x0040  /* Good link force for 100mbps */
0292 #define CSCONFIG_CLKTRISTATE    0x0080  /* Tristate 25m clock          */
0293 #define CSCONFIG_RESV3          0x0700  /* Unused...                   */
0294 #define CSCONFIG_ENCODE         0x0800  /* 1=MLT-3, 0=binary           */
0295 #define CSCONFIG_RENABLE        0x1000  /* Repeater mode enable        */
0296 #define CSCONFIG_TCDISABLE      0x2000  /* Disable timeout counter     */
0297 #define CSCONFIG_RESV4          0x4000  /* Unused...                   */
0298 #define CSCONFIG_NDISABLE       0x8000  /* Disable NRZI                */
0299 
0300 /* Happy Meal descriptor rings and such.
0301  * All descriptor rings must be aligned on a 2K boundary.
0302  * All receive buffers must be 64 byte aligned.
0303  * Always write the address first before setting the ownership
0304  * bits to avoid races with the hardware scanning the ring.
0305  */
0306 typedef u32 __bitwise hme32;
0307 
0308 struct happy_meal_rxd {
0309     hme32 rx_flags;
0310     hme32 rx_addr;
0311 };
0312 
0313 #define RXFLAG_OWN         0x80000000 /* 1 = hardware, 0 = software */
0314 #define RXFLAG_OVERFLOW    0x40000000 /* 1 = buffer overflow        */
0315 #define RXFLAG_SIZE        0x3fff0000 /* Size of the buffer         */
0316 #define RXFLAG_CSUM        0x0000ffff /* HW computed checksum       */
0317 
0318 struct happy_meal_txd {
0319     hme32 tx_flags;
0320     hme32 tx_addr;
0321 };
0322 
0323 #define TXFLAG_OWN         0x80000000 /* 1 = hardware, 0 = software */
0324 #define TXFLAG_SOP         0x40000000 /* 1 = start of packet        */
0325 #define TXFLAG_EOP         0x20000000 /* 1 = end of packet          */
0326 #define TXFLAG_CSENABLE    0x10000000 /* 1 = enable hw-checksums    */
0327 #define TXFLAG_CSLOCATION  0x0ff00000 /* Where to stick the csum    */
0328 #define TXFLAG_CSBUFBEGIN  0x000fc000 /* Where to begin checksum    */
0329 #define TXFLAG_SIZE        0x00003fff /* Size of the packet         */
0330 
0331 #define TX_RING_SIZE       32         /* Must be >16 and <255, multiple of 16  */
0332 #define RX_RING_SIZE       32         /* see ERX_CFG_SIZE* for possible values */
0333 
0334 #if (TX_RING_SIZE < 16 || TX_RING_SIZE > 256 || (TX_RING_SIZE % 16) != 0)
0335 #error TX_RING_SIZE holds illegal value
0336 #endif
0337 
0338 #define TX_RING_MAXSIZE    256
0339 #define RX_RING_MAXSIZE    256
0340 
0341 /* We use a 14 byte offset for checksum computation. */
0342 #if (RX_RING_SIZE == 32)
0343 #define ERX_CFG_DEFAULT(off) (ERX_CFG_DMAENABLE|((off)<<3)|ERX_CFG_SIZE32|((14/2)<<16))
0344 #else
0345 #if (RX_RING_SIZE == 64)
0346 #define ERX_CFG_DEFAULT(off) (ERX_CFG_DMAENABLE|((off)<<3)|ERX_CFG_SIZE64|((14/2)<<16))
0347 #else
0348 #if (RX_RING_SIZE == 128)
0349 #define ERX_CFG_DEFAULT(off) (ERX_CFG_DMAENABLE|((off)<<3)|ERX_CFG_SIZE128|((14/2)<<16))
0350 #else
0351 #if (RX_RING_SIZE == 256)
0352 #define ERX_CFG_DEFAULT(off) (ERX_CFG_DMAENABLE|((off)<<3)|ERX_CFG_SIZE256|((14/2)<<16))
0353 #else
0354 #error RX_RING_SIZE holds illegal value
0355 #endif
0356 #endif
0357 #endif
0358 #endif
0359 
0360 #define NEXT_RX(num)       (((num) + 1) & (RX_RING_SIZE - 1))
0361 #define NEXT_TX(num)       (((num) + 1) & (TX_RING_SIZE - 1))
0362 #define PREV_RX(num)       (((num) - 1) & (RX_RING_SIZE - 1))
0363 #define PREV_TX(num)       (((num) - 1) & (TX_RING_SIZE - 1))
0364 
0365 #define TX_BUFFS_AVAIL(hp)                                    \
0366         (((hp)->tx_old <= (hp)->tx_new) ?                     \
0367       (hp)->tx_old + (TX_RING_SIZE - 1) - (hp)->tx_new :  \
0368                 (hp)->tx_old - (hp)->tx_new - 1)
0369 
0370 #define RX_OFFSET          2
0371 #define RX_BUF_ALLOC_SIZE  (1546 + RX_OFFSET + 64)
0372 
0373 #define RX_COPY_THRESHOLD  256
0374 
0375 struct hmeal_init_block {
0376     struct happy_meal_rxd happy_meal_rxd[RX_RING_MAXSIZE];
0377     struct happy_meal_txd happy_meal_txd[TX_RING_MAXSIZE];
0378 };
0379 
0380 #define hblock_offset(mem, elem) \
0381 ((__u32)((unsigned long)(&(((struct hmeal_init_block *)0)->mem[elem]))))
0382 
0383 /* Now software state stuff. */
0384 enum happy_transceiver {
0385     external = 0,
0386     internal = 1,
0387     none     = 2,
0388 };
0389 
0390 /* Timer state engine. */
0391 enum happy_timer_state {
0392     arbwait  = 0,  /* Waiting for auto negotiation to complete.          */
0393     lupwait  = 1,  /* Auto-neg complete, awaiting link-up status.        */
0394     ltrywait = 2,  /* Forcing try of all modes, from fastest to slowest. */
0395     asleep   = 3,  /* Time inactive.                                     */
0396 };
0397 
0398 struct quattro;
0399 
0400 /* Happy happy, joy joy! */
0401 struct happy_meal {
0402     void __iomem    *gregs;         /* Happy meal global registers       */
0403     struct hmeal_init_block  *happy_block;  /* RX and TX descriptors (CPU addr)  */
0404 
0405 #if defined(CONFIG_SBUS) && defined(CONFIG_PCI)
0406     u32 (*read_desc32)(hme32 *);
0407     void (*write_txd)(struct happy_meal_txd *, u32, u32);
0408     void (*write_rxd)(struct happy_meal_rxd *, u32, u32);
0409 #endif
0410 
0411     /* This is either an platform_device or a pci_dev. */
0412     void              *happy_dev;
0413     struct device         *dma_dev;
0414 
0415     spinlock_t        happy_lock;
0416 
0417     struct sk_buff           *rx_skbs[RX_RING_SIZE];
0418     struct sk_buff           *tx_skbs[TX_RING_SIZE];
0419 
0420     int rx_new, tx_new, rx_old, tx_old;
0421 
0422 #if defined(CONFIG_SBUS) && defined(CONFIG_PCI)
0423     u32 (*read32)(void __iomem *);
0424     void (*write32)(void __iomem *, u32);
0425 #endif
0426 
0427     void __iomem    *etxregs;        /* External transmitter regs        */
0428     void __iomem    *erxregs;        /* External receiver regs           */
0429     void __iomem    *bigmacregs;     /* BIGMAC core regs             */
0430     void __iomem    *tcvregs;        /* MIF transceiver regs             */
0431 
0432     dma_addr_t                hblock_dvma;    /* DVMA visible address happy block  */
0433     unsigned int              happy_flags;    /* Driver state flags                */
0434     int                       irq;
0435     enum happy_transceiver    tcvr_type;      /* Kind of transceiver in use        */
0436     unsigned int              happy_bursts;   /* Get your mind out of the gutter   */
0437     unsigned int              paddr;          /* PHY address for transceiver       */
0438     unsigned short            hm_revision;    /* Happy meal revision               */
0439     unsigned short            sw_bmcr;        /* SW copy of BMCR                   */
0440     unsigned short            sw_bmsr;        /* SW copy of BMSR                   */
0441     unsigned short            sw_physid1;     /* SW copy of PHYSID1                */
0442     unsigned short            sw_physid2;     /* SW copy of PHYSID2                */
0443     unsigned short            sw_advertise;   /* SW copy of ADVERTISE              */
0444     unsigned short            sw_lpa;         /* SW copy of LPA                    */
0445     unsigned short            sw_expansion;   /* SW copy of EXPANSION              */
0446     unsigned short            sw_csconfig;    /* SW copy of CSCONFIG               */
0447     unsigned int              auto_speed;     /* Auto-nego link speed              */
0448         unsigned int              forced_speed;   /* Force mode link speed             */
0449     unsigned int              poll_data;      /* MIF poll data                     */
0450     unsigned int              poll_flag;      /* MIF poll flag                     */
0451     unsigned int              linkcheck;      /* Have we checked the link yet?     */
0452     unsigned int              lnkup;          /* Is the link up as far as we know? */
0453     unsigned int              lnkdown;        /* Trying to force the link down?    */
0454     unsigned int              lnkcnt;         /* Counter for link-up attempts.     */
0455     struct timer_list         happy_timer;    /* To watch the link when coming up. */
0456     enum happy_timer_state    timer_state;    /* State of the auto-neg timer.      */
0457     unsigned int              timer_ticks;    /* Number of clicks at each state.   */
0458 
0459     struct net_device    *dev;      /* Backpointer                       */
0460     struct quattro       *qfe_parent;   /* For Quattro cards                 */
0461     int           qfe_ent;  /* Which instance on quattro         */
0462 };
0463 
0464 /* Here are the happy flags. */
0465 #define HFLAG_POLL                0x00000001      /* We are doing MIF polling          */
0466 #define HFLAG_FENABLE             0x00000002      /* The MII frame is enabled          */
0467 #define HFLAG_LANCE               0x00000004      /* We are using lance-mode           */
0468 #define HFLAG_RXENABLE            0x00000008      /* Receiver is enabled               */
0469 #define HFLAG_AUTO                0x00000010      /* Using auto-negotiation, 0 = force */
0470 #define HFLAG_FULL                0x00000020      /* Full duplex enable                */
0471 #define HFLAG_MACFULL             0x00000040      /* Using full duplex in the MAC      */
0472 #define HFLAG_POLLENABLE          0x00000080      /* Actually try MIF polling          */
0473 #define HFLAG_RXCV                0x00000100      /* XXX RXCV ENABLE                   */
0474 #define HFLAG_INIT                0x00000200      /* Init called at least once         */
0475 #define HFLAG_LINKUP              0x00000400      /* 1 = Link is up                    */
0476 #define HFLAG_PCI                 0x00000800      /* PCI based Happy Meal              */
0477 #define HFLAG_QUATTRO         0x00001000      /* On QFE/Quattro card           */
0478 
0479 #define HFLAG_20_21  (HFLAG_POLLENABLE | HFLAG_FENABLE)
0480 #define HFLAG_NOT_A0 (HFLAG_POLLENABLE | HFLAG_FENABLE | HFLAG_LANCE | HFLAG_RXCV)
0481 
0482 /* Support for QFE/Quattro cards. */
0483 struct quattro {
0484     struct net_device   *happy_meals[4];
0485 
0486     /* This is either a sbus_dev or a pci_dev. */
0487     void            *quattro_dev;
0488 
0489     struct quattro      *next;
0490 
0491     /* PROM ranges, if any. */
0492 #ifdef CONFIG_SBUS
0493     struct linux_prom_ranges  ranges[8];
0494 #endif
0495     int           nranges;
0496 };
0497 
0498 /* We use this to acquire receive skb's that we can DMA directly into. */
0499 #define ALIGNED_RX_SKB_ADDR(addr) \
0500         ((((unsigned long)(addr) + (64UL - 1UL)) & ~(64UL - 1UL)) - (unsigned long)(addr))
0501 #define happy_meal_alloc_skb(__length, __gfp_flags) \
0502 ({  struct sk_buff *__skb; \
0503     __skb = alloc_skb((__length) + 64, (__gfp_flags)); \
0504     if(__skb) { \
0505         int __offset = (int) ALIGNED_RX_SKB_ADDR(__skb->data); \
0506         if(__offset) \
0507             skb_reserve(__skb, __offset); \
0508     } \
0509     __skb; \
0510 })
0511 
0512 #endif /* !(_SUNHME_H) */