sys/dev/usb/net/if_smscreg.h

   1 /*-
   2  * Copyright (c) 2012
   3  *      Ben Gray <bgray@freebsd.org>.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29 #ifndef _IF_SMSCREG_H_
  30 #define _IF_SMSCREG_H_
  31
  32 /*
  33  * Definitions for the SMSC LAN9514 and LAN9514 USB to ethernet controllers.
  34  *
  35  * This information was gleaned from the SMSC driver in the linux kernel, where
  36  * it is Copyrighted (C) 2007-2008 SMSC.
  37  *
  38  */
  39
  40 /**
  41  * TRANSMIT FRAMES
  42  * ---------------
  43  *   Tx frames are prefixed with an 8-byte header which describes the frame
  44  *
  45  *         4 bytes      4 bytes           variable
  46  *      +------------+------------+--- . . . . . . . . . . . . ---+
  47  *      | TX_CTRL_0  | TX_CTRL_1  |  Ethernet frame data          |
  48  *      +------------+------------+--- . . . . . . . . . . . . ---+
  49  *
  50  *   Where the headers have the following fields:
  51  *
  52  *      TX_CTRL_0 <20:16>  Data offset
  53  *      TX_CTRL_0 <13>     First segment of frame indicator
  54  *      TX_CTRL_0 <12>     Last segment of frame indicator
  55  *      TX_CTRL_0 <10:0>   Buffer size (?)
  56  *
  57  *      TX_CTRL_1 <14>     Perform H/W checksuming on IP packets
  58  *      TX_CTRL_1 <13>     Disable automatic ethernet CRC generation
  59  *      TX_CTRL_1 <12>     Disable padding (?)
  60  *      TX_CTRL_1 <10:0>   Packet byte length
  61  *
  62  */
  63 #define SMSC_TX_CTRL_0_OFFSET(x)         (((x) & 0x1FUL) << 16)
  64 #define SMSC_TX_CTRL_0_FIRST_SEG         (0x1UL << 13)
  65 #define SMSC_TX_CTRL_0_LAST_SEG          (0x1UL << 12)
  66 #define SMSC_TX_CTRL_0_BUF_SIZE(x)       ((x) & 0x000007FFUL)
  67
  68 #define SMSC_TX_CTRL_1_CSUM_ENABLE       (0x1UL << 14)
  69 #define SMSC_TX_CTRL_1_CRC_DISABLE       (0x1UL << 13)
  70 #define SMSC_TX_CTRL_1_PADDING_DISABLE   (0x1UL << 12)
  71 #define SMSC_TX_CTRL_1_PKT_LENGTH(x)     ((x) & 0x000007FFUL)
  72
  73 /**
  74  * RECEIVE FRAMES
  75  * --------------
  76  *   Rx frames are prefixed with an 4-byte status header which describes any
  77  *   errors with the frame as well as things like the length
  78  *
  79  *         4 bytes             variable
  80  *      +------------+--- . . . . . . . . . . . . ---+
  81  *      |   RX_STAT  |  Ethernet frame data          |
  82  *      +------------+--- . . . . . . . . . . . . ---+
  83  *
  84  *   Where the status header has the following fields:
  85  *
  86  *      RX_STAT   <30>     Filter Fail
  87  *      RX_STAT   <29:16>  Frame Length
  88  *      RX_STAT   <15>     Error Summary
  89  *      RX_STAT   <13>     Broadcast Frame
  90  *      RX_STAT   <12>     Length Error
  91  *      RX_STAT   <11>     Runt Frame
  92  *      RX_STAT   <10>     Multicast Frame
  93  *      RX_STAT   <7>      Frame too long
  94  *      RX_STAT   <6>      Collision Seen
  95  *      RX_STAT   <5>      Frame Type
  96  *      RX_STAT   <4>      Receive Watchdog
  97  *      RX_STAT   <3>      Mii Error
  98  *      RX_STAT   <2>      Dribbling
  99  *      RX_STAT   <1>      CRC Error
 100  *
 101  */
 102 #define SMSC_RX_STAT_FILTER_FAIL         (0x1UL << 30)
 103 #define SMSC_RX_STAT_FRM_LENGTH(x)       (((x) >> 16) & 0x3FFFUL)
 104 #define SMSC_RX_STAT_ERROR               (0x1UL << 15)
 105 #define SMSC_RX_STAT_BROADCAST           (0x1UL << 13)
 106 #define SMSC_RX_STAT_LENGTH_ERROR        (0x1UL << 12)
 107 #define SMSC_RX_STAT_RUNT                (0x1UL << 11)
 108 #define SMSC_RX_STAT_MULTICAST           (0x1UL << 10)
 109 #define SMSC_RX_STAT_FRM_TO_LONG         (0x1UL << 7)
 110 #define SMSC_RX_STAT_COLLISION           (0x1UL << 6)
 111 #define SMSC_RX_STAT_FRM_TYPE            (0x1UL << 5)
 112 #define SMSC_RX_STAT_WATCHDOG            (0x1UL << 4)
 113 #define SMSC_RX_STAT_MII_ERROR           (0x1UL << 3)
 114 #define SMSC_RX_STAT_DRIBBLING           (0x1UL << 2)
 115 #define SMSC_RX_STAT_CRC_ERROR           (0x1UL << 1)
 116
 117 /**
 118  * REGISTERS
 119  *
 120  */
 121 #define SMSC_ID_REV                 0x000
 122 #define SMSC_INTR_STATUS            0x008
 123 #define SMSC_RX_CFG                 0x00C
 124 #define SMSC_TX_CFG                 0x010
 125 #define SMSC_HW_CFG                 0x014
 126 #define SMSC_PM_CTRL                0x020
 127 #define SMSC_LED_GPIO_CFG           0x024
 128 #define SMSC_GPIO_CFG               0x028
 129 #define SMSC_AFC_CFG                0x02C
 130 #define SMSC_EEPROM_CMD             0x030
 131 #define SMSC_EEPROM_DATA            0x034
 132 #define SMSC_BURST_CAP              0x038
 133 #define SMSC_GPIO_WAKE              0x064
 134 #define SMSC_INTR_CFG               0x068
 135 #define SMSC_BULK_IN_DLY            0x06C
 136 #define SMSC_MAC_CSR                0x100
 137 #define SMSC_MAC_ADDRH              0x104
 138 #define SMSC_MAC_ADDRL              0x108
 139 #define SMSC_HASHH                  0x10C
 140 #define SMSC_HASHL                  0x110
 141 #define SMSC_MII_ADDR               0x114
 142 #define SMSC_MII_DATA               0x118
 143 #define SMSC_FLOW                   0x11C
 144 #define SMSC_VLAN1                  0x120
 145 #define SMSC_VLAN2                  0x124
 146 #define SMSC_WUFF                   0x128
 147 #define SMSC_WUCSR                  0x12C
 148 #define SMSC_COE_CTRL               0x130
 149
 150 /* ID / Revision register */
 151 #define SMSC_ID_REV_CHIP_ID_MASK    0xFFFF0000UL
 152 #define SMSC_ID_REV_CHIP_REV_MASK   0x0000FFFFUL
 153
 154 #define SMSC_RX_FIFO_FLUSH          (0x1UL << 0)
 155
 156 #define SMSC_TX_CFG_ON              (0x1UL << 2)
 157 #define SMSC_TX_CFG_STOP            (0x1UL << 1)
 158 #define SMSC_TX_CFG_FIFO_FLUSH      (0x1UL << 0)
 159
 160 #define SMSC_HW_CFG_BIR             (0x1UL << 12)
 161 #define SMSC_HW_CFG_LEDB            (0x1UL << 11)
 162 #define SMSC_HW_CFG_RXDOFF          (0x3UL << 9)    /* RX pkt alignment */
 163 #define SMSC_HW_CFG_DRP             (0x1UL << 6)
 164 #define SMSC_HW_CFG_MEF             (0x1UL << 5)
 165 #define SMSC_HW_CFG_LRST            (0x1UL << 3)    /* Lite reset */
 166 #define SMSC_HW_CFG_PSEL            (0x1UL << 2)
 167 #define SMSC_HW_CFG_BCE             (0x1UL << 1)
 168 #define SMSC_HW_CFG_SRST            (0x1UL << 0)
 169
 170 #define SMSC_PM_CTRL_PHY_RST        (0x1UL << 4)    /* PHY reset */
 171
 172 #define SMSC_LED_GPIO_CFG_SPD_LED   (0x1UL << 24)
 173 #define SMSC_LED_GPIO_CFG_LNK_LED   (0x1UL << 20)
 174 #define SMSC_LED_GPIO_CFG_FDX_LED   (0x1UL << 16)
 175
 176 /* Hi watermark = 15.5Kb (~10 mtu pkts) */
 177 /* low watermark = 3k (~2 mtu pkts) */
 178 /* backpressure duration = ~ 350us */
 179 /* Apply FC on any frame. */
 180 #define AFC_CFG_DEFAULT             (0x00F830A1)
 181
 182 #define SMSC_EEPROM_CMD_BUSY        (0x1UL << 31)
 183 #define SMSC_EEPROM_CMD_MASK        (0x7UL << 28)
 184 #define SMSC_EEPROM_CMD_READ        (0x0UL << 28)
 185 #define SMSC_EEPROM_CMD_WRITE       (0x3UL << 28)
 186 #define SMSC_EEPROM_CMD_ERASE       (0x5UL << 28)
 187 #define SMSC_EEPROM_CMD_RELOAD      (0x7UL << 28)
 188 #define SMSC_EEPROM_CMD_TIMEOUT     (0x1UL << 10)
 189 #define SMSC_EEPROM_CMD_ADDR_MASK   0x000001FFUL
 190
 191 /* MAC Control and Status Register */
 192 #define SMSC_MAC_CSR_RCVOWN         (0x1UL << 23)  /* Half duplex */
 193 #define SMSC_MAC_CSR_LOOPBK         (0x1UL << 21)  /* Loopback */
 194 #define SMSC_MAC_CSR_FDPX           (0x1UL << 20)  /* Full duplex */
 195 #define SMSC_MAC_CSR_MCPAS          (0x1UL << 19)  /* Multicast mode */
 196 #define SMSC_MAC_CSR_PRMS           (0x1UL << 18)  /* Promiscuous mode */
 197 #define SMSC_MAC_CSR_INVFILT        (0x1UL << 17)  /* Inverse filtering */
 198 #define SMSC_MAC_CSR_PASSBAD        (0x1UL << 16)  /* Pass on bad frames */
 199 #define SMSC_MAC_CSR_HPFILT         (0x1UL << 13)  /* Hash filtering */
 200 #define SMSC_MAC_CSR_BCAST          (0x1UL << 11)  /* Broadcast */
 201 #define SMSC_MAC_CSR_TXEN           (0x1UL << 3)   /* TX enable */
 202 #define SMSC_MAC_CSR_RXEN           (0x1UL << 2)   /* RX enable */
 203
 204 /* Interrupt control register */
 205 #define SMSC_INTR_NTEP              (0x1UL << 31)
 206 #define SMSC_INTR_MACRTO            (0x1UL << 19)
 207 #define SMSC_INTR_TX_STOP           (0x1UL << 17)
 208 #define SMSC_INTR_RX_STOP           (0x1UL << 16)
 209 #define SMSC_INTR_PHY_INT           (0x1UL << 15)
 210 #define SMSC_INTR_TXE               (0x1UL << 14)
 211 #define SMSC_INTR_TDFU              (0x1UL << 13)
 212 #define SMSC_INTR_TDFO              (0x1UL << 12)
 213 #define SMSC_INTR_RXDF              (0x1UL << 11)
 214 #define SMSC_INTR_GPIOS             0x000007FFUL
 215
 216 /* Phy MII interface register */
 217 #define SMSC_MII_WRITE              (0x1UL << 1)
 218 #define SMSC_MII_READ               (0x0UL << 1)
 219 #define SMSC_MII_BUSY               (0x1UL << 0)
 220
 221 /* H/W checksum register */
 222 #define SMSC_COE_CTRL_TX_EN         (0x1UL << 16)  /* Tx H/W csum enable */
 223 #define SMSC_COE_CTRL_RX_MODE       (0x1UL << 1)
 224 #define SMSC_COE_CTRL_RX_EN         (0x1UL << 0)   /* Rx H/W csum enable */
 225
 226 /* Registers on the phy, accessed via MII/MDIO */
 227 #define SMSC_PHY_INTR_STAT          (29)
 228 #define SMSC_PHY_INTR_MASK          (30)
 229
 230 #define SMSC_PHY_INTR_ENERGY_ON     (0x1U << 7)
 231 #define SMSC_PHY_INTR_ANEG_COMP     (0x1U << 6)
 232 #define SMSC_PHY_INTR_REMOTE_FAULT  (0x1U << 5)
 233 #define SMSC_PHY_INTR_LINK_DOWN     (0x1U << 4)
 234
 235 /* USB Vendor Requests */
 236 #define SMSC_UR_WRITE_REG   0xA0
 237 #define SMSC_UR_READ_REG    0xA1
 238 #define SMSC_UR_GET_STATS   0xA2
 239
 240 #define SMSC_CONFIG_INDEX       0       /* config number 1 */
 241 #define SMSC_IFACE_IDX          0
 242
 243 /*
 244  * USB endpoints.
 245  */
 246 enum {
 247         SMSC_BULK_DT_RD,
 248         SMSC_BULK_DT_WR,
 249         /* the LAN9514 device does support interrupt endpoints, however I couldn't
 250          * get then to work reliably and since they are unneeded (poll the mii
 251          * status) they are unused.
 252          * SMSC_INTR_DT_WR,
 253          * SMSC_INTR_DT_RD,
 254          */
 255         SMSC_N_TRANSFER,
 256 };
 257
 258 struct smsc_softc {
 259         struct usb_ether  sc_ue;
 260         struct mtx        sc_mtx;
 261         struct usb_xfer  *sc_xfer[SMSC_N_TRANSFER];
 262         int               sc_phyno;
 263
 264         /* The following stores the settings in the mac control (MAC_CSR) register */
 265         uint32_t          sc_mac_csr;
 266         uint32_t          sc_rev_id;
 267
 268         uint32_t          sc_flags;
 269 #define SMSC_FLAG_LINK      0x0001
 270 #define SMSC_FLAG_LAN9514   0x1000      /* LAN9514 */
 271 };
 272
 273 #define SMSC_LOCK(_sc)             mtx_lock(&(_sc)->sc_mtx)
 274 #define SMSC_UNLOCK(_sc)           mtx_unlock(&(_sc)->sc_mtx)
 275 #define SMSC_LOCK_ASSERT(_sc, t)   mtx_assert(&(_sc)->sc_mtx, t)
 276
 277 #endif  /* _IF_SMSCREG_H_ */