sys/dev/tl/if_tlreg.h

   1 /*-
   2  * Copyright (c) 1997, 1998
   3  *      Bill Paul <wpaul@ctr.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 struct tl_type {
  37         u_int16_t               tl_vid;
  38         u_int16_t               tl_did;
  39         char                    *tl_name;
  40 };
  41
  42 /*
  43  * ThunderLAN TX/RX list format. The TX and RX lists are pretty much
  44  * identical: the list begins with a 32-bit forward pointer which points
  45  * at the next list in the chain, followed by 16 bits for the total
  46  * frame size, and a 16 bit status field. This is followed by a series
  47  * of 10 32-bit data count/data address pairs that point to the fragments
  48  * that make up the complete frame.
  49  */
  50
  51 #define TL_MAXFRAGS             10
  52 #define TL_RX_LIST_CNT          64
  53 #define TL_TX_LIST_CNT          128
  54 #define TL_MIN_FRAMELEN         64
  55
  56 struct tl_frag {
  57         u_int32_t               tlist_dcnt;
  58         u_int32_t               tlist_dadr;
  59 };
  60
  61 struct tl_list {
  62         u_int32_t               tlist_fptr;     /* phys address of next list */
  63         u_int16_t               tlist_cstat;    /* status word */
  64         u_int16_t               tlist_frsize;   /* size of data in frame */
  65         struct tl_frag          tl_frag[TL_MAXFRAGS];
  66 };
  67
  68 /*
  69  * This is a special case of an RX list. By setting the One_Frag
  70  * bit in the NETCONFIG register, the driver can force the ThunderLAN
  71  * chip to use only one fragment when DMAing RX frames.
  72  */
  73
  74 struct tl_list_onefrag {
  75         u_int32_t               tlist_fptr;
  76         u_int16_t               tlist_cstat;
  77         u_int16_t               tlist_frsize;
  78         struct tl_frag          tl_frag;
  79 };
  80
  81 struct tl_list_data {
  82         struct tl_list_onefrag  tl_rx_list[TL_RX_LIST_CNT];
  83         struct tl_list          tl_tx_list[TL_TX_LIST_CNT];
  84         unsigned char           tl_pad[TL_MIN_FRAMELEN];
  85 };
  86
  87 struct tl_chain {
  88         struct tl_list          *tl_ptr;
  89         struct mbuf             *tl_mbuf;
  90         struct tl_chain         *tl_next;
  91 };
  92
  93 struct tl_chain_onefrag {
  94         struct tl_list_onefrag  *tl_ptr;
  95         struct mbuf             *tl_mbuf;
  96         struct tl_chain_onefrag *tl_next;
  97 };
  98
  99 struct tl_chain_data {
 100         struct tl_chain_onefrag tl_rx_chain[TL_RX_LIST_CNT];
 101         struct tl_chain         tl_tx_chain[TL_TX_LIST_CNT];
 102
 103         struct tl_chain_onefrag *tl_rx_head;
 104         struct tl_chain_onefrag *tl_rx_tail;
 105
 106         struct tl_chain         *tl_tx_head;
 107         struct tl_chain         *tl_tx_tail;
 108         struct tl_chain         *tl_tx_free;
 109 };
 110
 111 struct tl_softc {
 112         struct ifnet            *tl_ifp;
 113         device_t                tl_dev;
 114         struct ifmedia          ifmedia;        /* media info */
 115         bus_space_handle_t      tl_bhandle;
 116         bus_space_tag_t         tl_btag;
 117         void                    *tl_intrhand;
 118         struct resource         *tl_irq;
 119         struct resource         *tl_res;
 120         device_t                tl_miibus;
 121         struct tl_type          *tl_dinfo;      /* ThunderLAN adapter info */
 122         u_int8_t                tl_eeaddr;
 123         struct tl_list_data     *tl_ldata;      /* TX/RX lists and mbufs */
 124         struct tl_chain_data    tl_cdata;
 125         u_int8_t                tl_txeoc;
 126         u_int8_t                tl_bitrate;
 127         int                     tl_if_flags;
 128         struct callout          tl_stat_callout;
 129         struct mtx              tl_mtx;
 130 };
 131
 132 #define TL_LOCK(_sc)            mtx_lock(&(_sc)->tl_mtx)
 133 #define TL_UNLOCK(_sc)          mtx_unlock(&(_sc)->tl_mtx)
 134 #define TL_LOCK_ASSERT(_sc)     mtx_assert(&(_sc)->tl_mtx, MA_OWNED)
 135
 136 /*
 137  * Transmit interrupt threshold.
 138  */
 139 #define TX_THR          0x00000004
 140
 141 /*
 142  * General constants that are fun to know.
 143  *
 144  * The ThunderLAN controller is made by Texas Instruments. The
 145  * manual indicates that if the EEPROM checksum fails, the PCI
 146  * vendor and device ID registers will be loaded with TI-specific
 147  * values.
 148  */
 149 #define TI_VENDORID             0x104C
 150 #define TI_DEVICEID_THUNDERLAN  0x0500
 151
 152 /*
 153  * These are the PCI vendor and device IDs for Compaq ethernet
 154  * adapters based on the ThunderLAN controller.
 155  */
 156 #define COMPAQ_VENDORID                         0x0E11
 157 #define COMPAQ_DEVICEID_NETEL_10_100            0xAE32
 158 #define COMPAQ_DEVICEID_NETEL_UNKNOWN           0xAE33
 159 #define COMPAQ_DEVICEID_NETEL_10                0xAE34
 160 #define COMPAQ_DEVICEID_NETFLEX_3P_INTEGRATED   0xAE35
 161 #define COMPAQ_DEVICEID_NETEL_10_100_DUAL       0xAE40
 162 #define COMPAQ_DEVICEID_NETEL_10_100_PROLIANT   0xAE43
 163 #define COMPAQ_DEVICEID_NETEL_10_100_EMBEDDED   0xB011
 164 #define COMPAQ_DEVICEID_NETEL_10_T2_UTP_COAX    0xB012
 165 #define COMPAQ_DEVICEID_NETEL_10_100_TX_UTP     0xB030
 166 #define COMPAQ_DEVICEID_NETFLEX_3P              0xF130
 167 #define COMPAQ_DEVICEID_NETFLEX_3P_BNC          0xF150
 168
 169 /*
 170  * These are the PCI vendor and device IDs for Olicom
 171  * adapters based on the ThunderLAN controller.
 172  */
 173 #define OLICOM_VENDORID                         0x108D
 174 #define OLICOM_DEVICEID_OC2183                  0x0013
 175 #define OLICOM_DEVICEID_OC2325                  0x0012
 176 #define OLICOM_DEVICEID_OC2326                  0x0014
 177
 178 /*
 179  * PCI low memory base and low I/O base
 180  */
 181 #define TL_PCI_LOIO             0x10
 182 #define TL_PCI_LOMEM            0x14
 183
 184 /*
 185  * PCI latency timer (it's actually 0x0D, but we want a value
 186  * that's longword aligned).
 187  */
 188 #define TL_PCI_LATENCY_TIMER    0x0C
 189
 190 #define TL_DIO_ADDR_INC         0x8000  /* Increment addr on each read */
 191 #define TL_DIO_RAM_SEL          0x4000  /* RAM address select */
 192 #define TL_DIO_ADDR_MASK        0x3FFF  /* address bits mask */
 193
 194 /*
 195  * Interrupt types
 196  */
 197 #define TL_INTR_INVALID         0x0
 198 #define TL_INTR_TXEOF           0x1
 199 #define TL_INTR_STATOFLOW       0x2
 200 #define TL_INTR_RXEOF           0x3
 201 #define TL_INTR_DUMMY           0x4
 202 #define TL_INTR_TXEOC           0x5
 203 #define TL_INTR_ADCHK           0x6
 204 #define TL_INTR_RXEOC           0x7
 205
 206 #define TL_INT_MASK             0x001C
 207 #define TL_VEC_MASK             0x1FE0
 208 /*
 209  * Host command register bits
 210  */
 211 #define TL_CMD_GO               0x80000000
 212 #define TL_CMD_STOP             0x40000000
 213 #define TL_CMD_ACK              0x20000000
 214 #define TL_CMD_CHSEL7           0x10000000
 215 #define TL_CMD_CHSEL6           0x08000000
 216 #define TL_CMD_CHSEL5           0x04000000
 217 #define TL_CMD_CHSEL4           0x02000000
 218 #define TL_CMD_CHSEL3           0x01000000
 219 #define TL_CMD_CHSEL2           0x00800000
 220 #define TL_CMD_CHSEL1           0x00400000
 221 #define TL_CMD_CHSEL0           0x00200000
 222 #define TL_CMD_EOC              0x00100000
 223 #define TL_CMD_RT               0x00080000
 224 #define TL_CMD_NES              0x00040000
 225 #define TL_CMD_ZERO0            0x00020000
 226 #define TL_CMD_ZERO1            0x00010000
 227 #define TL_CMD_ADRST            0x00008000
 228 #define TL_CMD_LDTMR            0x00004000
 229 #define TL_CMD_LDTHR            0x00002000
 230 #define TL_CMD_REQINT           0x00001000
 231 #define TL_CMD_INTSOFF          0x00000800
 232 #define TL_CMD_INTSON           0x00000400
 233 #define TL_CMD_RSVD0            0x00000200
 234 #define TL_CMD_RSVD1            0x00000100
 235 #define TL_CMD_ACK7             0x00000080
 236 #define TL_CMD_ACK6             0x00000040
 237 #define TL_CMD_ACK5             0x00000020
 238 #define TL_CMD_ACK4             0x00000010
 239 #define TL_CMD_ACK3             0x00000008
 240 #define TL_CMD_ACK2             0x00000004
 241 #define TL_CMD_ACK1             0x00000002
 242 #define TL_CMD_ACK0             0x00000001
 243
 244 #define TL_CMD_CHSEL_MASK       0x01FE0000
 245 #define TL_CMD_ACK_MASK         0xFF
 246
 247 /*
 248  * EEPROM address where station address resides.
 249  */
 250 #define TL_EEPROM_EADDR         0x83
 251 #define TL_EEPROM_EADDR2        0x99
 252 #define TL_EEPROM_EADDR3        0xAF
 253 #define TL_EEPROM_EADDR_OC      0xF8    /* Olicom cards use a different
 254                                            address than Compaqs. */
 255 /*
 256  * ThunderLAN host command register offsets.
 257  * (Can be accessed either by IO ports or memory map.)
 258  */
 259 #define TL_HOSTCMD              0x00
 260 #define TL_CH_PARM              0x04
 261 #define TL_DIO_ADDR             0x08
 262 #define TL_HOST_INT             0x0A
 263 #define TL_DIO_DATA             0x0C
 264
 265 /*
 266  * ThunderLAN internal registers
 267  */
 268 #define TL_NETCMD               0x00
 269 #define TL_NETSIO               0x01
 270 #define TL_NETSTS               0x02
 271 #define TL_NETMASK              0x03
 272
 273 #define TL_NETCONFIG            0x04
 274 #define TL_MANTEST              0x06
 275
 276 #define TL_VENID_LSB            0x08
 277 #define TL_VENID_MSB            0x09
 278 #define TL_DEVID_LSB            0x0A
 279 #define TL_DEVID_MSB            0x0B
 280
 281 #define TL_REVISION             0x0C
 282 #define TL_SUBCLASS             0x0D
 283 #define TL_MINLAT               0x0E
 284 #define TL_MAXLAT               0x0F
 285
 286 #define TL_AREG0_B5             0x10
 287 #define TL_AREG0_B4             0x11
 288 #define TL_AREG0_B3             0x12
 289 #define TL_AREG0_B2             0x13
 290
 291 #define TL_AREG0_B1             0x14
 292 #define TL_AREG0_B0             0x15
 293 #define TL_AREG1_B5             0x16
 294 #define TL_AREG1_B4             0x17
 295
 296 #define TL_AREG1_B3             0x18
 297 #define TL_AREG1_B2             0x19
 298 #define TL_AREG1_B1             0x1A
 299 #define TL_AREG1_B0             0x1B
 300
 301 #define TL_AREG2_B5             0x1C
 302 #define TL_AREG2_B4             0x1D
 303 #define TL_AREG2_B3             0x1E
 304 #define TL_AREG2_B2             0x1F
 305
 306 #define TL_AREG2_B1             0x20
 307 #define TL_AREG2_B0             0x21
 308 #define TL_AREG3_B5             0x22
 309 #define TL_AREG3_B4             0x23
 310
 311 #define TL_AREG3_B3             0x24
 312 #define TL_AREG3_B2             0x25
 313 #define TL_AREG3_B1             0x26
 314 #define TL_AREG3_B0             0x27
 315
 316 #define TL_HASH1                0x28
 317 #define TL_HASH2                0x2C
 318 #define TL_TXGOODFRAMES         0x30
 319 #define TL_TXUNDERRUN           0x33
 320 #define TL_RXGOODFRAMES         0x34
 321 #define TL_RXOVERRUN            0x37
 322 #define TL_DEFEREDTX            0x38
 323 #define TL_CRCERROR             0x3A
 324 #define TL_CODEERROR            0x3B
 325 #define TL_MULTICOLTX           0x3C
 326 #define TL_SINGLECOLTX          0x3E
 327 #define TL_EXCESSIVECOL         0x40
 328 #define TL_LATECOL              0x41
 329 #define TL_CARRIERLOSS          0x42
 330 #define TL_ACOMMIT              0x43
 331 #define TL_LDREG                0x44
 332 #define TL_BSIZEREG             0x45
 333 #define TL_MAXRX                0x46
 334
 335 /*
 336  * ThunderLAN SIO register bits
 337  */
 338 #define TL_SIO_MINTEN           0x80
 339 #define TL_SIO_ECLOK            0x40
 340 #define TL_SIO_ETXEN            0x20
 341 #define TL_SIO_EDATA            0x10
 342 #define TL_SIO_NMRST            0x08
 343 #define TL_SIO_MCLK             0x04
 344 #define TL_SIO_MTXEN            0x02
 345 #define TL_SIO_MDATA            0x01
 346
 347 /*
 348  * Thunderlan NETCONFIG bits
 349  */
 350 #define TL_CFG_RCLKTEST         0x8000
 351 #define TL_CFG_TCLKTEST         0x4000
 352 #define TL_CFG_BITRATE          0x2000
 353 #define TL_CFG_RXCRC            0x1000
 354 #define TL_CFG_PEF              0x0800
 355 #define TL_CFG_ONEFRAG          0x0400
 356 #define TL_CFG_ONECHAN          0x0200
 357 #define TL_CFG_MTEST            0x0100
 358 #define TL_CFG_PHYEN            0x0080
 359 #define TL_CFG_MACSEL6          0x0040
 360 #define TL_CFG_MACSEL5          0x0020
 361 #define TL_CFG_MACSEL4          0x0010
 362 #define TL_CFG_MACSEL3          0x0008
 363 #define TL_CFG_MACSEL2          0x0004
 364 #define TL_CFG_MACSEL1          0x0002
 365 #define TL_CFG_MACSEL0          0x0001
 366
 367 /*
 368  * ThunderLAN NETSTS bits
 369  */
 370 #define TL_STS_MIRQ             0x80
 371 #define TL_STS_HBEAT            0x40
 372 #define TL_STS_TXSTOP           0x20
 373 #define TL_STS_RXSTOP           0x10
 374
 375 /*
 376  * ThunderLAN NETCMD bits
 377  */
 378 #define TL_CMD_NRESET           0x80
 379 #define TL_CMD_NWRAP            0x40
 380 #define TL_CMD_CSF              0x20
 381 #define TL_CMD_CAF              0x10
 382 #define TL_CMD_NOBRX            0x08
 383 #define TL_CMD_DUPLEX           0x04
 384 #define TL_CMD_TRFRAM           0x02
 385 #define TL_CMD_TXPACE           0x01
 386
 387 /*
 388  * ThunderLAN NETMASK bits
 389  */
 390 #define TL_MASK_MASK7           0x80
 391 #define TL_MASK_MASK6           0x40
 392 #define TL_MASK_MASK5           0x20
 393 #define TL_MASK_MASK4           0x10
 394
 395 /*
 396  * MII frame format
 397  */
 398 #ifdef ANSI_DOESNT_ALLOW_BITFIELDS
 399 struct tl_mii_frame {
 400         u_int16_t               mii_stdelim:2,
 401                                 mii_opcode:2,
 402                                 mii_phyaddr:5,
 403                                 mii_regaddr:5,
 404                                 mii_turnaround:2;
 405         u_int16_t               mii_data;
 406 };
 407 #else
 408 struct tl_mii_frame {
 409         u_int8_t                mii_stdelim;
 410         u_int8_t                mii_opcode;
 411         u_int8_t                mii_phyaddr;
 412         u_int8_t                mii_regaddr;
 413         u_int8_t                mii_turnaround;
 414         u_int16_t               mii_data;
 415 };
 416 #endif
 417 /*
 418  * MII constants
 419  */
 420 #define TL_MII_STARTDELIM       0x01
 421 #define TL_MII_READOP           0x02
 422 #define TL_MII_WRITEOP          0x01
 423 #define TL_MII_TURNAROUND       0x02
 424
 425 #define TL_LAST_FRAG            0x80000000
 426 #define TL_CSTAT_UNUSED         0x8000
 427 #define TL_CSTAT_FRAMECMP       0x4000
 428 #define TL_CSTAT_READY          0x3000
 429 #define TL_CSTAT_UNUSED13       0x2000
 430 #define TL_CSTAT_UNUSED12       0x1000
 431 #define TL_CSTAT_EOC            0x0800
 432 #define TL_CSTAT_RXERROR        0x0400
 433 #define TL_CSTAT_PASSCRC        0x0200
 434 #define TL_CSTAT_DPRIO          0x0100
 435
 436 #define TL_FRAME_MASK           0x00FFFFFF
 437 #define tl_tx_goodframes(x)     (x.tl_txstat & TL_FRAME_MASK)
 438 #define tl_tx_underrun(x)       ((x.tl_txstat & ~TL_FRAME_MASK) >> 24)
 439 #define tl_rx_goodframes(x)     (x.tl_rxstat & TL_FRAME_MASK)
 440 #define tl_rx_overrun(x)        ((x.tl_rxstat & ~TL_FRAME_MASK) >> 24)
 441
 442 struct tl_stats {
 443         u_int32_t               tl_txstat;
 444         u_int32_t               tl_rxstat;
 445         u_int16_t               tl_deferred;
 446         u_int8_t                tl_crc_errors;
 447         u_int8_t                tl_code_errors;
 448         u_int16_t               tl_tx_multi_collision;
 449         u_int16_t               tl_tx_single_collision;
 450         u_int8_t                tl_excessive_collision;
 451         u_int8_t                tl_late_collision;
 452         u_int8_t                tl_carrier_loss;
 453         u_int8_t                acommit;
 454 };
 455
 456 /*
 457  * ACOMMIT register bits. These are used only when a bitrate
 458  * PHY is selected ('bitrate' bit in netconfig register is set).
 459  */
 460 #define TL_AC_MTXER             0x01    /* reserved */
 461 #define TL_AC_MTXD1             0x02    /* 0 == 10baseT 1 == AUI */
 462 #define TL_AC_MTXD2             0x04    /* loopback disable */
 463 #define TL_AC_MTXD3             0x08    /* full duplex disable */
 464
 465 #define TL_AC_TXTHRESH          0xF0
 466 #define TL_AC_TXTHRESH_16LONG   0x00
 467 #define TL_AC_TXTHRESH_32LONG   0x10
 468 #define TL_AC_TXTHRESH_64LONG   0x20
 469 #define TL_AC_TXTHRESH_128LONG  0x30
 470 #define TL_AC_TXTHRESH_256LONG  0x40
 471 #define TL_AC_TXTHRESH_WHOLEPKT 0x50
 472
 473 /*
 474  * PCI burst size register (TL_BSIZEREG).
 475  */
 476 #define TL_RXBURST              0x0F
 477 #define TL_TXBURST              0xF0
 478
 479 #define TL_RXBURST_4LONG        0x00
 480 #define TL_RXBURST_8LONG        0x01
 481 #define TL_RXBURST_16LONG       0x02
 482 #define TL_RXBURST_32LONG       0x03
 483 #define TL_RXBURST_64LONG       0x04
 484 #define TL_RXBURST_128LONG      0x05
 485
 486 #define TL_TXBURST_4LONG        0x00
 487 #define TL_TXBURST_8LONG        0x10
 488 #define TL_TXBURST_16LONG       0x20
 489 #define TL_TXBURST_32LONG       0x30
 490 #define TL_TXBURST_64LONG       0x40
 491 #define TL_TXBURST_128LONG      0x50
 492
 493 /*
 494  * register space access macros
 495  */
 496 #define CSR_WRITE_4(sc, reg, val)       \
 497         bus_space_write_4(sc->tl_btag, sc->tl_bhandle, reg, val)
 498 #define CSR_WRITE_2(sc, reg, val)       \
 499         bus_space_write_2(sc->tl_btag, sc->tl_bhandle, reg, val)
 500 #define CSR_WRITE_1(sc, reg, val)       \
 501         bus_space_write_1(sc->tl_btag, sc->tl_bhandle, reg, val)
 502
 503 #define CSR_READ_4(sc, reg)             \
 504         bus_space_read_4(sc->tl_btag, sc->tl_bhandle, reg)
 505 #define CSR_READ_2(sc, reg)             \
 506         bus_space_read_2(sc->tl_btag, sc->tl_bhandle, reg)
 507 #define CSR_READ_1(sc, reg)             \
 508         bus_space_read_1(sc->tl_btag, sc->tl_bhandle, reg)
 509
 510 #define CMD_PUT(sc, x) CSR_WRITE_4(sc, TL_HOSTCMD, x)
 511 #define CMD_SET(sc, x)  \
 512         CSR_WRITE_4(sc, TL_HOSTCMD, CSR_READ_4(sc, TL_HOSTCMD) | (x))
 513 #define CMD_CLR(sc, x)  \
 514         CSR_WRITE_4(sc, TL_HOSTCMD, CSR_READ_4(sc, TL_HOSTCMD) & ~(x))
 515
 516 /*
 517  * ThunderLAN adapters typically have a serial EEPROM containing
 518  * configuration information. The main reason we're interested in
 519  * it is because it also contains the adapters's station address.
 520  *
 521  * Access to the EEPROM is a bit goofy since it is a serial device:
 522  * you have to do reads and writes one bit at a time. The state of
 523  * the DATA bit can only change while the CLOCK line is held low.
 524  * Transactions work basically like this:
 525  *
 526  * 1) Send the EEPROM_START sequence to prepare the EEPROM for
 527  *    accepting commands. This pulls the clock high, sets
 528  *    the data bit to 0, enables transmission to the EEPROM,
 529  *    pulls the data bit up to 1, then pulls the clock low.
 530  *    The idea is to do a 0 to 1 transition of the data bit
 531  *    while the clock pin is held high.
 532  *
 533  * 2) To write a bit to the EEPROM, set the TXENABLE bit, then
 534  *    set the EDATA bit to send a 1 or clear it to send a 0.
 535  *    Finally, set and then clear ECLOK. Strobing the clock
 536  *    transmits the bit. After 8 bits have been written, the
 537  *    EEPROM should respond with an ACK, which should be read.
 538  *
 539  * 3) To read a bit from the EEPROM, clear the TXENABLE bit,
 540  *    then set ECLOK. The bit can then be read by reading EDATA.
 541  *    ECLOCK should then be cleared again. This can be repeated
 542  *    8 times to read a whole byte, after which the
 543  *
 544  * 4) We need to send the address byte to the EEPROM. For this
 545  *    we have to send the write control byte to the EEPROM to
 546  *    tell it to accept data. The byte is 0xA0. The EEPROM should
 547  *    ack this. The address byte can be send after that.
 548  *
 549  * 5) Now we have to tell the EEPROM to send us data. For that we
 550  *    have to transmit the read control byte, which is 0xA1. This
 551  *    byte should also be acked. We can then read the data bits
 552  *    from the EEPROM.
 553  *
 554  * 6) When we're all finished, send the EEPROM_STOP sequence.
 555  *
 556  * Note that we use the ThunderLAN's NetSio register to access the
 557  * EEPROM, however there is an alternate method. There is a PCI NVRAM
 558  * register at PCI offset 0xB4 which can also be used with minor changes.
 559  * The difference is that access to PCI registers via pci_conf_read()
 560  * and pci_conf_write() is done using programmed I/O, which we want to
 561  * avoid.
 562  */
 563
 564 /*
 565  * Note that EEPROM_START leaves transmission enabled.
 566  */
 567 #define EEPROM_START                                                    \
 568         tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK); /* Pull clock pin high */\
 569         tl_dio_setbit(sc, TL_NETSIO, TL_SIO_EDATA); /* Set DATA bit to 1 */     \
 570         tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ETXEN); /* Enable xmit to write bit */\
 571         tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_EDATA); /* Pull DATA bit to 0 again */\
 572         tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK); /* Pull clock low again */
 573
 574 /*
 575  * EEPROM_STOP ends access to the EEPROM and clears the ETXEN bit so
 576  * that no further data can be written to the EEPROM I/O pin.
 577  */
 578 #define EEPROM_STOP                                                     \
 579         tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN); /* Disable xmit */  \
 580         tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_EDATA); /* Pull DATA to 0 */        \
 581         tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK); /* Pull clock high */       \
 582         tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ETXEN); /* Enable xmit */   \
 583         tl_dio_setbit(sc, TL_NETSIO, TL_SIO_EDATA); /* Toggle DATA to 1 */      \
 584         tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN); /* Disable xmit. */ \
 585         tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK); /* Pull clock low again */
 586
 587
 588 /*
 589  * Microchip Technology 24Cxx EEPROM control bytes
 590  */
 591 #define EEPROM_CTL_READ                 0xA1    /* 0101 0001 */
 592 #define EEPROM_CTL_WRITE                0xA0    /* 0101 0000 */