sys/dev/usb/if_auereg.h

   1 /*-
   2  * Copyright (c) 1997, 1998, 1999
   3  *      Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 /*
  36  * Register definitions for ADMtek Pegasus AN986 USB to Ethernet
  37  * chip. The Pegasus uses a total of four USB endpoints: the control
  38  * endpoint (0), a bulk read endpoint for receiving packets (1),
  39  * a bulk write endpoint for sending packets (2) and an interrupt
  40  * endpoint for passing RX and TX status (3). Endpoint 0 is used
  41  * to read and write the ethernet module's registers. All registers
  42  * are 8 bits wide.
  43  *
  44  * Packet transfer is done in 64 byte chunks. The last chunk in a
  45  * transfer is denoted by having a length less that 64 bytes. For
  46  * the RX case, the data includes an optional RX status word.
  47  */
  48
  49 #define AUE_UR_READREG          0xF0
  50 #define AUE_UR_WRITEREG         0xF1
  51
  52 #define AUE_CONFIG_NO           1
  53 #define AUE_IFACE_IDX           0
  54
  55 /*
  56  * Note that while the ADMtek technically has four
  57  * endpoints, the control endpoint (endpoint 0) is
  58  * regarded as special by the USB code and drivers
  59  * don't have direct access to it. (We access it
  60  * using usbd_do_request() when reading/writing
  61  * registers.) Consequently, our endpoint indexes
  62  * don't match those in the ADMtek Pegasus manual:
  63  * we consider the RX data endpoint to be index 0
  64  * and work up from there.
  65  */
  66 #define AUE_ENDPT_RX            0x0
  67 #define AUE_ENDPT_TX            0x1
  68 #define AUE_ENDPT_INTR          0x2
  69 #define AUE_ENDPT_MAX           0x3
  70
  71 #define AUE_INTR_PKTLEN         0x8
  72
  73 #define AUE_CTL0                0x00
  74 #define AUE_CTL1                0x01
  75 #define AUE_CTL2                0x02
  76 #define AUE_MAR0                0x08
  77 #define AUE_MAR1                0x09
  78 #define AUE_MAR2                0x0A
  79 #define AUE_MAR3                0x0B
  80 #define AUE_MAR4                0x0C
  81 #define AUE_MAR5                0x0D
  82 #define AUE_MAR6                0x0E
  83 #define AUE_MAR7                0x0F
  84 #define AUE_MAR                 AUE_MAR0
  85 #define AUE_PAR0                0x10
  86 #define AUE_PAR1                0x11
  87 #define AUE_PAR2                0x12
  88 #define AUE_PAR3                0x13
  89 #define AUE_PAR4                0x14
  90 #define AUE_PAR5                0x15
  91 #define AUE_PAR                 AUE_PAR0
  92 #define AUE_PAUSE0              0x18
  93 #define AUE_PAUSE1              0x19
  94 #define AUE_PAUSE               AUE_PAUSE0
  95 #define AUE_RX_FLOWCTL_CNT      0x1A
  96 #define AUE_RX_FLOWCTL_FIFO     0x1B
  97 #define AUE_REG_1D              0x1D
  98 #define AUE_EE_REG              0x20
  99 #define AUE_EE_DATA0            0x21
 100 #define AUE_EE_DATA1            0x22
 101 #define AUE_EE_DATA             AUE_EE_DATA0
 102 #define AUE_EE_CTL              0x23
 103 #define AUE_PHY_ADDR            0x25
 104 #define AUE_PHY_DATA0           0x26
 105 #define AUE_PHY_DATA1           0x27
 106 #define AUE_PHY_DATA            AUE_PHY_DATA0
 107 #define AUE_PHY_CTL             0x28
 108 #define AUE_USB_STS             0x2A
 109 #define AUE_TXSTAT0             0x2B
 110 #define AUE_TXSTAT1             0x2C
 111 #define AUE_TXSTAT              AUE_TXSTAT0
 112 #define AUE_RXSTAT              0x2D
 113 #define AUE_PKTLOST0            0x2E
 114 #define AUE_PKTLOST1            0x2F
 115 #define AUE_PKTLOST             AUE_PKTLOST0
 116
 117 #define AUE_REG_7B              0x7B
 118 #define AUE_GPIO0               0x7E
 119 #define AUE_GPIO1               0x7F
 120 #define AUE_REG_81              0x81
 121
 122 #define AUE_CTL0_INCLUDE_RXCRC  0x01
 123 #define AUE_CTL0_ALLMULTI       0x02
 124 #define AUE_CTL0_STOP_BACKOFF   0x04
 125 #define AUE_CTL0_RXSTAT_APPEND  0x08
 126 #define AUE_CTL0_WAKEON_ENB     0x10
 127 #define AUE_CTL0_RXPAUSE_ENB    0x20
 128 #define AUE_CTL0_RX_ENB         0x40
 129 #define AUE_CTL0_TX_ENB         0x80
 130
 131 #define AUE_CTL1_HOMELAN        0x04
 132 #define AUE_CTL1_RESETMAC       0x08
 133 #define AUE_CTL1_SPEEDSEL       0x10    /* 0 = 10mbps, 1 = 100mbps */
 134 #define AUE_CTL1_DUPLEX         0x20    /* 0 = half, 1 = full */
 135 #define AUE_CTL1_DELAYHOME      0x40
 136
 137 #define AUE_CTL2_EP3_CLR        0x01    /* reading EP3 clrs status regs */
 138 #define AUE_CTL2_RX_BADFRAMES   0x02
 139 #define AUE_CTL2_RX_PROMISC     0x04
 140 #define AUE_CTL2_LOOPBACK       0x08
 141 #define AUE_CTL2_EEPROMWR_ENB   0x10
 142 #define AUE_CTL2_EEPROM_LOAD    0x20
 143
 144 #define AUE_EECTL_WRITE         0x01
 145 #define AUE_EECTL_READ          0x02
 146 #define AUE_EECTL_DONE          0x04
 147
 148 #define AUE_PHYCTL_PHYREG       0x1F
 149 #define AUE_PHYCTL_WRITE        0x20
 150 #define AUE_PHYCTL_READ         0x40
 151 #define AUE_PHYCTL_DONE         0x80
 152
 153 #define AUE_USBSTS_SUSPEND      0x01
 154 #define AUE_USBSTS_RESUME       0x02
 155
 156 #define AUE_TXSTAT0_JABTIMO     0x04
 157 #define AUE_TXSTAT0_CARLOSS     0x08
 158 #define AUE_TXSTAT0_NOCARRIER   0x10
 159 #define AUE_TXSTAT0_LATECOLL    0x20
 160 #define AUE_TXSTAT0_EXCESSCOLL  0x40
 161 #define AUE_TXSTAT0_UNDERRUN    0x80
 162
 163 #define AUE_TXSTAT1_PKTCNT      0x0F
 164 #define AUE_TXSTAT1_FIFO_EMPTY  0x40
 165 #define AUE_TXSTAT1_FIFO_FULL   0x80
 166
 167 #define AUE_RXSTAT_OVERRUN      0x01
 168 #define AUE_RXSTAT_PAUSE        0x02
 169
 170 #define AUE_GPIO_IN0            0x01
 171 #define AUE_GPIO_OUT0           0x02
 172 #define AUE_GPIO_SEL0           0x04
 173 #define AUE_GPIO_IN1            0x08
 174 #define AUE_GPIO_OUT1           0x10
 175 #define AUE_GPIO_SEL1           0x20
 176
 177 struct aue_intrpkt {
 178         u_int8_t                aue_txstat0;
 179         u_int8_t                aue_txstat1;
 180         u_int8_t                aue_rxstat;
 181         u_int8_t                aue_rxlostpkt0;
 182         u_int8_t                aue_rxlostpkt1;
 183         u_int8_t                aue_wakeupstat;
 184         u_int8_t                aue_rsvd;
 185 };
 186
 187 struct aue_rxpkt {
 188         u_int16_t               aue_pktlen;
 189         u_int8_t                aue_rxstat;
 190 };
 191
 192 #define AUE_RXSTAT_MCAST        0x01
 193 #define AUE_RXSTAT_GIANT        0x02
 194 #define AUE_RXSTAT_RUNT         0x04
 195 #define AUE_RXSTAT_CRCERR       0x08
 196 #define AUE_RXSTAT_DRIBBLE      0x10
 197 #define AUE_RXSTAT_MASK         0x1E
 198
 199 #define AUE_INC(x, y)           (x) = (x + 1) % y
 200
 201 struct aue_softc {
 202 #if defined(__FreeBSD__)
 203 #define GET_MII(sc) (device_get_softc((sc)->aue_miibus))
 204 #elif defined(__NetBSD__)
 205 #define GET_MII(sc) (&(sc)->aue_mii)
 206 #elif defined(__OpenBSD__)
 207 #define GET_MII(sc) (&(sc)->aue_mii)
 208 #endif
 209         struct ifnet            *aue_ifp;
 210         device_t                aue_dev;
 211         device_t                aue_miibus;
 212         usbd_device_handle      aue_udev;
 213         usbd_interface_handle   aue_iface;
 214         u_int16_t               aue_vendor;
 215         u_int16_t               aue_product;
 216         int                     aue_ed[AUE_ENDPT_MAX];
 217         usbd_pipe_handle        aue_ep[AUE_ENDPT_MAX];
 218         int                     aue_unit;
 219         u_int8_t                aue_link;
 220         int                     aue_if_flags;
 221         struct ue_cdata         aue_cdata;
 222         struct callout_handle   aue_stat_ch;
 223 #if __FreeBSD_version >= 500000
 224         struct mtx              aue_mtx;
 225 #endif
 226         u_int16_t               aue_flags;
 227         char                    aue_dying;
 228         struct timeval          aue_rx_notice;
 229         struct usb_qdat         aue_qdat;
 230 };
 231
 232 #if 0
 233 #define AUE_LOCK(_sc)           mtx_lock(&(_sc)->aue_mtx)
 234 #define AUE_UNLOCK(_sc)         mtx_unlock(&(_sc)->aue_mtx)
 235 #else
 236 #define AUE_LOCK(_sc)
 237 #define AUE_UNLOCK(_sc)
 238 #endif
 239
 240 #define AUE_TIMEOUT             1000
 241 #define AUE_MIN_FRAMELEN        60
 242 #define AUE_INTR_INTERVAL       100 /* ms */