hmereg.h revision 1.10
1/* $NetBSD: hmereg.h,v 1.10 2001/11/26 06:51:13 tron Exp $ */ 2 3/*- 4 * Copyright (c) 1999 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Paul Kranenburg. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39/* 40 * HME Shared Ethernet Block register offsets 41 */ 42#define HME_SEBI_RESET (0*4) 43#define HME_SEBI_CFG (1*4) 44#define HME_SEBI_STAT (64*4) 45#define HME_SEBI_IMASK (65*4) 46 47/* HME SEB bits. */ 48#define HME_SEB_RESET_ETX 0x00000001 /* reset external transmitter */ 49#define HME_SEB_RESET_ERX 0x00000002 /* reset external receiver */ 50 51#define HME_SEB_CFG_BURSTMASK 0x00000003 /* covers all burst bits */ 52#define HME_SEB_CFG_BURST16 0x00000000 /* 16 byte bursts */ 53#define HME_SEB_CFG_BURST32 0x00000001 /* 32 byte bursts */ 54#define HME_SEB_CFG_BURST64 0x00000002 /* 64 byte bursts */ 55#define HME_SEB_CFG_64BIT 0x00000004 /* ? */ 56#define HME_SEB_CFG_PARITY 0x00000008 /* ? */ 57 58#define HME_SEB_STAT_GOTFRAME 0x00000001 /* frame received */ 59#define HME_SEB_STAT_RCNTEXP 0x00000002 /* rx frame count expired */ 60#define HME_SEB_STAT_ACNTEXP 0x00000004 /* align error count expired */ 61#define HME_SEB_STAT_CCNTEXP 0x00000008 /* crc error count expired */ 62#define HME_SEB_STAT_LCNTEXP 0x00000010 /* length error count expired */ 63#define HME_SEB_STAT_RFIFOVF 0x00000020 /* rx fifo overflow */ 64#define HME_SEB_STAT_CVCNTEXP 0x00000040 /* code violation counter exp */ 65#define HME_SEB_STAT_STSTERR 0x00000080 /* xif sqe test failed */ 66#define HME_SEB_STAT_SENTFRAME 0x00000100 /* frame sent */ 67#define HME_SEB_STAT_TFIFO_UND 0x00000200 /* tx fifo underrun */ 68#define HME_SEB_STAT_MAXPKTERR 0x00000400 /* max-packet size error */ 69#define HME_SEB_STAT_NCNTEXP 0x00000800 /* normal collision count exp */ 70#define HME_SEB_STAT_ECNTEXP 0x00001000 /* excess collision count exp */ 71#define HME_SEB_STAT_LCCNTEXP 0x00002000 /* late collision count exp */ 72#define HME_SEB_STAT_FCNTEXP 0x00004000 /* first collision count exp */ 73#define HME_SEB_STAT_DTIMEXP 0x00008000 /* defer timer expired */ 74#define HME_SEB_STAT_RXTOHOST 0x00010000 /* pkt moved from rx fifo->memory */ 75#define HME_SEB_STAT_NORXD 0x00020000 /* out of receive descriptors */ 76#define HME_SEB_STAT_RXERR 0x00040000 /* rx dma error */ 77#define HME_SEB_STAT_RXLATERR 0x00080000 /* late error during rx dma */ 78#define HME_SEB_STAT_RXPERR 0x00100000 /* parity error during rx dma */ 79#define HME_SEB_STAT_RXTERR 0x00200000 /* tag error during rx dma */ 80#define HME_SEB_STAT_EOPERR 0x00400000 /* tx descriptor did not set EOP */ 81#define HME_SEB_STAT_MIFIRQ 0x00800000 /* mif needs attention */ 82#define HME_SEB_STAT_HOSTTOTX 0x01000000 /* pkt moved from memory->tx fifo */ 83#define HME_SEB_STAT_TXALL 0x02000000 /* all pkts in fifo transmitted */ 84#define HME_SEB_STAT_TXEACK 0x04000000 /* error during tx dma */ 85#define HME_SEB_STAT_TXLERR 0x08000000 /* late error during tx dma */ 86#define HME_SEB_STAT_TXPERR 0x10000000 /* parity error during tx dma */ 87#define HME_SEB_STAT_TXTERR 0x20000000 /* tag error durig tx dma */ 88#define HME_SEB_STAT_SLVERR 0x40000000 /* pio access error */ 89#define HME_SEB_STAT_SLVPERR 0x80000000 /* pio access parity error */ 90#define HME_SEB_STAT_BITS \ 91 "\020\1RX\2RCNT\3ACNT\4CCNT\5LCNT\6RFIFO\7CVCNT\10STST" \ 92 "\11TX\12TFIFO\13MAXPKT\14NCNT\15ECNT\16LCCNT\17FCNT" \ 93 "\20DTIME\21RXHOST\22NORXD\23RXE\24EXLATE\25RXP\26RXT\27EOP" \ 94 "\30MIF\31TXHOST\32TXALL\33TXE\34TXL\35TXP\36TXT\37SLV" \ 95 "\40SLVP" 96 97 98#define HME_SEB_STAT_ALL_ERRORS \ 99 (HME_SEB_STAT_SLVPERR | HME_SEB_STAT_SLVERR | HME_SEB_STAT_TXTERR |\ 100 HME_SEB_STAT_TXPERR | HME_SEB_STAT_TXLERR | HME_SEB_STAT_TXEACK |\ 101 HME_SEB_STAT_EOPERR | HME_SEB_STAT_RXTERR | HME_SEB_STAT_RXPERR |\ 102 HME_SEB_STAT_RXLATERR | HME_SEB_STAT_RXERR | HME_SEB_STAT_NORXD |\ 103 HME_SEB_STAT_DTIMEXP | HME_SEB_STAT_FCNTEXP | HME_SEB_STAT_LCCNTEXP |\ 104 HME_SEB_STAT_ECNTEXP | HME_SEB_STAT_NCNTEXP | HME_SEB_STAT_MAXPKTERR|\ 105 HME_SEB_STAT_TFIFO_UND| HME_SEB_STAT_STSTERR | HME_SEB_STAT_CVCNTEXP |\ 106 HME_SEB_STAT_LCNTEXP | HME_SEB_STAT_CCNTEXP| HME_SEB_STAT_ACNTEXP) 107 108#define HME_SEB_STAT_VLAN_ERRORS \ 109 (HME_SEB_STAT_SLVPERR | HME_SEB_STAT_SLVERR | HME_SEB_STAT_TXTERR |\ 110 HME_SEB_STAT_TXPERR | HME_SEB_STAT_TXLERR | HME_SEB_STAT_TXEACK |\ 111 HME_SEB_STAT_EOPERR | HME_SEB_STAT_RXTERR | HME_SEB_STAT_RXPERR |\ 112 HME_SEB_STAT_RXLATERR | HME_SEB_STAT_RXERR | HME_SEB_STAT_NORXD |\ 113 HME_SEB_STAT_DTIMEXP | HME_SEB_STAT_FCNTEXP | HME_SEB_STAT_LCCNTEXP |\ 114 HME_SEB_STAT_ECNTEXP | HME_SEB_STAT_NCNTEXP | \ 115 HME_SEB_STAT_TFIFO_UND| HME_SEB_STAT_STSTERR | HME_SEB_STAT_CVCNTEXP |\ 116 HME_SEB_STAT_LCNTEXP | HME_SEB_STAT_CCNTEXP | HME_SEB_STAT_ACNTEXP) 117 118/* 119 * HME Transmitter register offsets 120 */ 121#define HME_ETXI_PENDING (0*4) /* Pending/wakeup */ 122#define HME_ETXI_CFG (1*4) 123#define HME_ETXI_RING (2*4) /* Descriptor Ring pointer */ 124#define HME_ETXI_BBASE (3*4) /* Buffer base address (ro) */ 125#define HME_ETXI_BDISP (4*4) /* Buffer displacement (ro) */ 126#define HME_ETXI_FIFO_WPTR (5*4) /* FIFO write pointer */ 127#define HME_ETXI_FIFO_SWPTR (6*4) /* FIFO shadow write pointer */ 128#define HME_ETXI_FIFO_RPTR (7*4) /* FIFO read pointer */ 129#define HME_ETXI_FIFO_SRPTR (8*4) /* FIFO shadow read pointer */ 130#define HME_ETXI_FIFO_PKTCNT (9*4) /* FIFO packet counter */ 131#define HME_ETXI_STATEMACHINE (10*4) /* State machine */ 132#define HME_ETXI_RSIZE (11*4) /* Ring size */ 133#define HME_ETXI_BPTR (12*4) /* Buffer pointer */ 134 135 136/* TXI_PENDING bits */ 137#define HME_ETX_TP_DMAWAKEUP 0x00000001 /* Start tx (rw, auto-clear) */ 138 139/* TXI_CFG bits */ 140#define HME_ETX_CFG_DMAENABLE 0x00000001 /* Enable TX dma */ 141#define HME_ETX_CFG_FIFOTHRESH 0x000003fe /* TX fifo threshold */ 142#define HME_ETX_CFG_IRQDAFTER 0x00000400 /* Intr after tx-fifo empty */ 143#define HME_ETX_CFG_IRQDBEFORE 0x00000000 /* Intr before tx-fifo empty */ 144 145 146/* 147 * HME Receiver register offsets 148 */ 149#define HME_ERXI_CFG (0*4) 150#define HME_ERXI_RING (1*4) /* Descriptor Ring pointer */ 151#define HME_ERXI_BPTR (2*4) /* Data Buffer pointer (ro) */ 152#define HME_ERXI_FIFO_WPTR (3*4) /* FIFO write pointer */ 153#define HME_ERXI_FIFO_SWPTR (4*4) /* FIFO shadow write pointer */ 154#define HME_ERXI_FIFO_RPTR (5*4) /* FIFO read pointer */ 155#define HME_ERXI_FIFO_SRPTR (6*4) /* FIFO shadow read pointer */ 156#define HME_ERXI_STATEMACHINE (7*4) /* State machine */ 157 158/* RXI_CFG bits */ 159#define HME_ERX_CFG_DMAENABLE 0x00000001 /* Enable RX dma */ 160#define HME_ERX_CFG_BYTEOFFSET 0x00000038 /* RX first byte offset */ 161#define HME_ERX_CFG_RINGSIZE32 0x00000000 /* Descriptor ring size: 32 */ 162#define HME_ERX_CFG_RINGSIZE64 0x00000200 /* Descriptor ring size: 64 */ 163#define HME_ERX_CFG_RINGSIZE128 0x00000400 /* Descriptor ring size: 128 */ 164#define HME_ERX_CFG_RINGSIZE256 0x00000600 /* Descriptor ring size: 256 */ 165#define HME_ERX_CFG_CSUMSTART 0x007f0000 /* cksum offset */ 166 167/* 168 * HME MAC-core register offsets 169 */ 170#define HME_MACI_XIF (0*4) 171#define HME_MACI_TXSWRST (130*4) /* TX reset */ 172#define HME_MACI_TXCFG (131*4) /* TX config */ 173#define HME_MACI_JSIZE (139*4) /* TX jam size */ 174#define HME_MACI_TXSIZE (140*4) /* TX max size */ 175#define HME_MACI_NCCNT (144*4) /* TX normal collision cnt */ 176#define HME_MACI_FCCNT (145*4) /* TX first collision cnt */ 177#define HME_MACI_EXCNT (146*4) /* TX excess collision cnt */ 178#define HME_MACI_LTCNT (147*4) /* TX late collision cnt */ 179#define HME_MACI_RANDSEED (148*4) /* */ 180#define HME_MACI_RXSWRST (194*4) /* RX reset */ 181#define HME_MACI_RXCFG (195*4) /* RX config */ 182#define HME_MACI_RXSIZE (196*4) /* RX max size */ 183#define HME_MACI_MACADDR2 (198*4) /* MAC address */ 184#define HME_MACI_MACADDR1 (199*4) 185#define HME_MACI_MACADDR0 (200*4) 186#define HME_MACI_HASHTAB3 (208*4) /* Address hash table */ 187#define HME_MACI_HASHTAB2 (209*4) 188#define HME_MACI_HASHTAB1 (210*4) 189#define HME_MACI_HASHTAB0 (211*4) 190#define HME_MACI_AFILTER2 (212*4) /* Address filter */ 191#define HME_MACI_AFILTER1 (213*4) 192#define HME_MACI_AFILTER0 (214*4) 193#define HME_MACI_AFILTER_MASK (215*4) 194 195/* XIF config register. */ 196#define HME_MAC_XIF_OE 0x00000001 /* Output driver enable */ 197#define HME_MAC_XIF_XLBACK 0x00000002 /* Loopback-mode XIF enable */ 198#define HME_MAC_XIF_MLBACK 0x00000004 /* Loopback-mode MII enable */ 199#define HME_MAC_XIF_MIIENABLE 0x00000008 /* MII receive buffer enable */ 200#define HME_MAC_XIF_SQENABLE 0x00000010 /* SQE test enable */ 201#define HME_MAC_XIF_SQETWIN 0x000003e0 /* SQE time window */ 202#define HME_MAC_XIF_LANCE 0x00000010 /* Lance mode enable */ 203#define HME_MAC_XIF_LIPG0 0x000003e0 /* Lance mode IPG0 */ 204 205/* Transmit config register. */ 206#define HME_MAC_TXCFG_ENABLE 0x00000001 /* Enable the transmitter */ 207#define HME_MAC_TXCFG_SMODE 0x00000020 /* Enable slow transmit mode */ 208#define HME_MAC_TXCFG_CIGN 0x00000040 /* Ignore transmit collisions */ 209#define HME_MAC_TXCFG_FCSOFF 0x00000080 /* Do not emit FCS */ 210#define HME_MAC_TXCFG_DBACKOFF 0x00000100 /* Disable backoff */ 211#define HME_MAC_TXCFG_FULLDPLX 0x00000200 /* Enable full-duplex */ 212#define HME_MAC_TXCFG_DGIVEUP 0x00000400 /* Don't give up on transmits */ 213 214/* Receive config register. */ 215#define HME_MAC_RXCFG_ENABLE 0x00000001 /* Enable the receiver */ 216#define HME_MAC_RXCFG_PSTRIP 0x00000020 /* Pad byte strip enable */ 217#define HME_MAC_RXCFG_PMISC 0x00000040 /* Enable promiscous mode */ 218#define HME_MAC_RXCFG_DERR 0x00000080 /* Disable error checking */ 219#define HME_MAC_RXCFG_DCRCS 0x00000100 /* Disable CRC stripping */ 220#define HME_MAC_RXCFG_ME 0x00000200 /* Receive packets addressed to me */ 221#define HME_MAC_RXCFG_PGRP 0x00000400 /* Enable promisc group mode */ 222#define HME_MAC_RXCFG_HENABLE 0x00000800 /* Enable the hash filter */ 223#define HME_MAC_RXCFG_AENABLE 0x00001000 /* Enable the address filter */ 224 225/* 226 * HME MIF register offsets 227 */ 228#define HME_MIFI_BB_CLK (0*4) /* bit-bang clock */ 229#define HME_MIFI_BB_DATA (1*4) /* bit-bang data */ 230#define HME_MIFI_BB_OE (2*4) /* bit-bang output enable */ 231#define HME_MIFI_FO (3*4) /* frame output */ 232#define HME_MIFI_CFG (4*4) /* */ 233#define HME_MIFI_IMASK (5*4) /* Interrupt mask for status change */ 234#define HME_MIFI_STAT (6*4) /* Status (ro, auto-clear) */ 235#define HME_MIFI_SM (7*4) /* State machine (ro) */ 236 237/* MIF Configuration register */ 238#define HME_MIF_CFG_PHY 0x00000001 /* PHY select */ 239#define HME_MIF_CFG_PE 0x00000002 /* Poll enable */ 240#define HME_MIF_CFG_BBMODE 0x00000004 /* Bit-bang mode */ 241#define HME_MIF_CFG_PRADDR 0x000000f8 /* Poll register adddress */ 242#define HME_MIF_CFG_MDI0 0x00000100 /* MDI_0 (ro) */ 243#define HME_MIF_CFG_MDI1 0x00000200 /* MDI_1 (ro) */ 244#define HME_MIF_CFG_PPADDR 0x00007c00 /* Poll phy adddress */ 245 246/* MIF Frame/Output register */ 247#define HME_MIF_FO_ST 0xc0000000 /* Start of frame */ 248#define HME_MIF_FO_ST_SHIFT 30 /* */ 249#define HME_MIF_FO_OPC 0x30000000 /* Opcode */ 250#define HME_MIF_FO_OPC_SHIFT 28 /* */ 251#define HME_MIF_FO_PHYAD 0x0f800000 /* PHY Address */ 252#define HME_MIF_FO_PHYAD_SHIFT 23 /* */ 253#define HME_MIF_FO_REGAD 0x007c0000 /* Register Address */ 254#define HME_MIF_FO_REGAD_SHIFT 18 /* */ 255#define HME_MIF_FO_TAMSB 0x00020000 /* Turn-around MSB */ 256#define HME_MIF_FO_TALSB 0x00010000 /* Turn-around LSB */ 257#define HME_MIF_FO_DATA 0x0000ffff /* data to read or write */ 258 259/* Wired HME PHY addresses */ 260#define HME_PHYAD_INTERNAL 1 261#define HME_PHYAD_EXTERNAL 0 262 263/* 264 * Buffer Descriptors. 265 */ 266#ifdef notdef 267struct hme_xd { 268 volatile u_int32_t xd_flags; 269 volatile u_int32_t xd_addr; /* Buffer address (DMA) */ 270}; 271#endif 272#define HME_XD_SIZE 8 273#define HME_XD_FLAGS(base, index) ((base) + ((index) * HME_XD_SIZE) + 0) 274#define HME_XD_ADDR(base, index) ((base) + ((index) * HME_XD_SIZE) + 4) 275#define HME_XD_GETFLAGS(p, b, i) \ 276 (p) ? le32toh(*((u_int32_t *)HME_XD_FLAGS(b,i))) : \ 277 (*((u_int32_t *)HME_XD_FLAGS(b,i))) 278#define HME_XD_SETFLAGS(p, b, i, f) do { \ 279 *((u_int32_t *)HME_XD_FLAGS(b,i)) = ((p) ? htole32(f) : (f)); \ 280} while(0) 281#define HME_XD_SETADDR(p, b, i, a) do { \ 282 *((u_int32_t *)HME_XD_ADDR(b,i)) = ((p) ? htole32(a) : (a)); \ 283} while(0) 284 285/* Descriptor flag values */ 286#define HME_XD_OWN 0x80000000 /* ownership: 1=hw, 0=sw */ 287#define HME_XD_SOP 0x40000000 /* start of packet marker (tx) */ 288#define HME_XD_OFL 0x40000000 /* buffer overflow (rx) */ 289#define HME_XD_EOP 0x20000000 /* end of packet marker (tx) */ 290#define HME_XD_TXCKSUM 0x10000000 /* checksum enable (tx) */ 291#define HME_XD_RXLENMSK 0x3fff0000 /* packet length mask (rx) */ 292#define HME_XD_RXLENSHIFT 16 293#define HME_XD_TXLENMSK 0x00003fff /* packet length mask (tx) */ 294#define HME_XD_RXCKSUM 0x0000ffff /* packet checksum (rx) */ 295 296/* Macros to encode/decode the receive buffer size from the flags field */ 297#define HME_XD_ENCODE_RSIZE(sz) \ 298 (((sz) << HME_XD_RXLENSHIFT) & HME_XD_RXLENMSK) 299#define HME_XD_DECODE_RSIZE(flags) \ 300 (((flags) & HME_XD_RXLENMSK) >> HME_XD_RXLENSHIFT) 301 302/* Provide encode/decode macros for the transmit buffers for symmetry */ 303#define HME_XD_ENCODE_TSIZE(sz) \ 304 (((sz) << 0) & HME_XD_TXLENMSK) 305#define HME_XD_DECODE_TSIZE(flags) \ 306 (((flags) & HME_XD_TXLENMSK) >> 0) 307 308#define HME_MTU \ 309 (ETHERMTU + ETHER_VLAN_ENCAP_LEN + sizeof(u_int32_t) + \ 310 sizeof(struct ether_header)) 311