2 * Copyright (c) 1997, 1998
3 * Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 * Texas Instruments ThunderLAN driver for FreeBSD 2.2.6 and 3.x.
38 * Supports many Compaq PCI NICs based on the ThunderLAN ethernet controller,
39 * the National Semiconductor DP83840A physical interface and the
40 * Microchip Technology 24Cxx series serial EEPROM.
42 * Written using the following four documents:
44 * Texas Instruments ThunderLAN Programmer's Guide (www.ti.com)
45 * National Semiconductor DP83840A data sheet (www.national.com)
46 * Microchip Technology 24C02C data sheet (www.microchip.com)
47 * Micro Linear ML6692 100BaseTX only PHY data sheet (www.microlinear.com)
49 * Written by Bill Paul <wpaul@ctr.columbia.edu>
50 * Electrical Engineering Department
51 * Columbia University, New York City
54 * Some notes about the ThunderLAN:
56 * The ThunderLAN controller is a single chip containing PCI controller
57 * logic, approximately 3K of on-board SRAM, a LAN controller, and media
58 * independent interface (MII) bus. The MII allows the ThunderLAN chip to
59 * control up to 32 different physical interfaces (PHYs). The ThunderLAN
60 * also has a built-in 10baseT PHY, allowing a single ThunderLAN controller
61 * to act as a complete ethernet interface.
63 * Other PHYs may be attached to the ThunderLAN; the Compaq 10/100 cards
64 * use a National Semiconductor DP83840A PHY that supports 10 or 100Mb/sec
65 * in full or half duplex. Some of the Compaq Deskpro machines use a
66 * Level 1 LXT970 PHY with the same capabilities. Certain Olicom adapters
67 * use a Micro Linear ML6692 100BaseTX only PHY, which can be used in
68 * concert with the ThunderLAN's internal PHY to provide full 10/100
69 * support. This is cheaper than using a standalone external PHY for both
70 * 10/100 modes and letting the ThunderLAN's internal PHY go to waste.
71 * A serial EEPROM is also attached to the ThunderLAN chip to provide
72 * power-up default register settings and for storing the adapter's
73 * station address. Although not supported by this driver, the ThunderLAN
74 * chip can also be connected to token ring PHYs.
76 * The ThunderLAN has a set of registers which can be used to issue
77 * commands, acknowledge interrupts, and to manipulate other internal
78 * registers on its DIO bus. The primary registers can be accessed
79 * using either programmed I/O (inb/outb) or via PCI memory mapping,
80 * depending on how the card is configured during the PCI probing
81 * phase. It is even possible to have both PIO and memory mapped
82 * access turned on at the same time.
84 * Frame reception and transmission with the ThunderLAN chip is done
85 * using frame 'lists.' A list structure looks more or less like this:
88 * u_int32_t fragment_address;
89 * u_int32_t fragment_size;
92 * u_int32_t forward_pointer;
94 * u_int16_t frame_size;
95 * struct tl_frag fragments[10];
98 * The forward pointer in the list header can be either a 0 or the address
99 * of another list, which allows several lists to be linked together. Each
100 * list contains up to 10 fragment descriptors. This means the chip allows
101 * ethernet frames to be broken up into up to 10 chunks for transfer to
102 * and from the SRAM. Note that the forward pointer and fragment buffer
103 * addresses are physical memory addresses, not virtual. Note also that
104 * a single ethernet frame can not span lists: if the host wants to
105 * transmit a frame and the frame data is split up over more than 10
106 * buffers, the frame has to collapsed before it can be transmitted.
108 * To receive frames, the driver sets up a number of lists and populates
109 * the fragment descriptors, then it sends an RX GO command to the chip.
110 * When a frame is received, the chip will DMA it into the memory regions
111 * specified by the fragment descriptors and then trigger an RX 'end of
112 * frame interrupt' when done. The driver may choose to use only one
113 * fragment per list; this may result is slighltly less efficient use
114 * of memory in exchange for improving performance.
116 * To transmit frames, the driver again sets up lists and fragment
117 * descriptors, only this time the buffers contain frame data that
118 * is to be DMA'ed into the chip instead of out of it. Once the chip
119 * has transfered the data into its on-board SRAM, it will trigger a
120 * TX 'end of frame' interrupt. It will also generate an 'end of channel'
121 * interrupt when it reaches the end of the list.
124 * Some notes about this driver:
126 * The ThunderLAN chip provides a couple of different ways to organize
127 * reception, transmission and interrupt handling. The simplest approach
128 * is to use one list each for transmission and reception. In this mode,
129 * the ThunderLAN will generate two interrupts for every received frame
130 * (one RX EOF and one RX EOC) and two for each transmitted frame (one
131 * TX EOF and one TX EOC). This may make the driver simpler but it hurts
132 * performance to have to handle so many interrupts.
134 * Initially I wanted to create a circular list of receive buffers so
135 * that the ThunderLAN chip would think there was an infinitely long
136 * receive channel and never deliver an RXEOC interrupt. However this
137 * doesn't work correctly under heavy load: while the manual says the
138 * chip will trigger an RXEOF interrupt each time a frame is copied into
139 * memory, you can't count on the chip waiting around for you to acknowledge
140 * the interrupt before it starts trying to DMA the next frame. The result
141 * is that the chip might traverse the entire circular list and then wrap
142 * around before you have a chance to do anything about it. Consequently,
143 * the receive list is terminated (with a 0 in the forward pointer in the
144 * last element). Each time an RXEOF interrupt arrives, the used list
145 * is shifted to the end of the list. This gives the appearance of an
146 * infinitely large RX chain so long as the driver doesn't fall behind
147 * the chip and allow all of the lists to be filled up.
149 * If all the lists are filled, the adapter will deliver an RX 'end of
150 * channel' interrupt when it hits the 0 forward pointer at the end of
151 * the chain. The RXEOC handler then cleans out the RX chain and resets
152 * the list head pointer in the ch_parm register and restarts the receiver.
154 * For frame transmission, it is possible to program the ThunderLAN's
155 * transmit interrupt threshold so that the chip can acknowledge multiple
156 * lists with only a single TX EOF interrupt. This allows the driver to
157 * queue several frames in one shot, and only have to handle a total
158 * two interrupts (one TX EOF and one TX EOC) no matter how many frames
159 * are transmitted. Frame transmission is done directly out of the
160 * mbufs passed to the tl_start() routine via the interface send queue.
161 * The driver simply sets up the fragment descriptors in the transmit
162 * lists to point to the mbuf data regions and sends a TX GO command.
164 * Note that since the RX and TX lists themselves are always used
165 * only by the driver, the are malloc()ed once at driver initialization
166 * time and never free()ed.
168 * Also, in order to remain as platform independent as possible, this
169 * driver uses memory mapped register access to manipulate the card
170 * as opposed to programmed I/O. This avoids the use of the inb/outb
171 * (and related) instructions which are specific to the i386 platform.
173 * Using these techniques, this driver achieves very high performance
174 * by minimizing the amount of interrupts generated during large
175 * transfers and by completely avoiding buffer copies. Frame transfer
176 * to and from the ThunderLAN chip is performed entirely by the chip
177 * itself thereby reducing the load on the host CPU.
180 #include <sys/param.h>
181 #include <sys/systm.h>
182 #include <sys/sockio.h>
183 #include <sys/mbuf.h>
184 #include <sys/malloc.h>
185 #include <sys/kernel.h>
186 #include <sys/module.h>
187 #include <sys/socket.h>
190 #include <net/if_arp.h>
191 #include <net/ethernet.h>
192 #include <net/if_dl.h>
193 #include <net/if_media.h>
194 #include <net/if_types.h>
198 #include <vm/vm.h> /* for vtophys */
199 #include <vm/pmap.h> /* for vtophys */
200 #include <machine/bus.h>
201 #include <machine/resource.h>
203 #include <sys/rman.h>
205 #include <dev/mii/mii.h>
206 #include <dev/mii/mii_bitbang.h>
207 #include <dev/mii/miivar.h>
209 #include <dev/pci/pcireg.h>
210 #include <dev/pci/pcivar.h>
213 * Default to using PIO register access mode to pacify certain
214 * laptop docking stations with built-in ThunderLAN chips that
215 * don't seem to handle memory mapped mode properly.
217 #define TL_USEIOSPACE
219 #include <dev/tl/if_tlreg.h>
221 MODULE_DEPEND(tl, pci, 1, 1, 1);
222 MODULE_DEPEND(tl, ether, 1, 1, 1);
223 MODULE_DEPEND(tl, miibus, 1, 1, 1);
225 /* "device miibus" required. See GENERIC if you get errors here. */
226 #include "miibus_if.h"
229 * Various supported device vendors/types and their names.
232 static const struct tl_type const tl_devs[] = {
233 { TI_VENDORID, TI_DEVICEID_THUNDERLAN,
234 "Texas Instruments ThunderLAN" },
235 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10,
236 "Compaq Netelligent 10" },
237 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100,
238 "Compaq Netelligent 10/100" },
239 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_PROLIANT,
240 "Compaq Netelligent 10/100 Proliant" },
241 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_DUAL,
242 "Compaq Netelligent 10/100 Dual Port" },
243 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETFLEX_3P_INTEGRATED,
244 "Compaq NetFlex-3/P Integrated" },
245 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETFLEX_3P,
246 "Compaq NetFlex-3/P" },
247 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETFLEX_3P_BNC,
248 "Compaq NetFlex 3/P w/ BNC" },
249 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_EMBEDDED,
250 "Compaq Netelligent 10/100 TX Embedded UTP" },
251 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_T2_UTP_COAX,
252 "Compaq Netelligent 10 T/2 PCI UTP/Coax" },
253 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_TX_UTP,
254 "Compaq Netelligent 10/100 TX UTP" },
255 { OLICOM_VENDORID, OLICOM_DEVICEID_OC2183,
256 "Olicom OC-2183/2185" },
257 { OLICOM_VENDORID, OLICOM_DEVICEID_OC2325,
259 { OLICOM_VENDORID, OLICOM_DEVICEID_OC2326,
260 "Olicom OC-2326 10/100 TX UTP" },
264 static int tl_probe(device_t);
265 static int tl_attach(device_t);
266 static int tl_detach(device_t);
267 static int tl_intvec_rxeoc(void *, u_int32_t);
268 static int tl_intvec_txeoc(void *, u_int32_t);
269 static int tl_intvec_txeof(void *, u_int32_t);
270 static int tl_intvec_rxeof(void *, u_int32_t);
271 static int tl_intvec_adchk(void *, u_int32_t);
272 static int tl_intvec_netsts(void *, u_int32_t);
274 static int tl_newbuf(struct tl_softc *, struct tl_chain_onefrag *);
275 static void tl_stats_update(void *);
276 static int tl_encap(struct tl_softc *, struct tl_chain *, struct mbuf *);
278 static void tl_intr(void *);
279 static void tl_start(struct ifnet *);
280 static void tl_start_locked(struct ifnet *);
281 static int tl_ioctl(struct ifnet *, u_long, caddr_t);
282 static void tl_init(void *);
283 static void tl_init_locked(struct tl_softc *);
284 static void tl_stop(struct tl_softc *);
285 static void tl_watchdog(struct tl_softc *);
286 static int tl_shutdown(device_t);
287 static int tl_ifmedia_upd(struct ifnet *);
288 static void tl_ifmedia_sts(struct ifnet *, struct ifmediareq *);
290 static u_int8_t tl_eeprom_putbyte(struct tl_softc *, int);
291 static u_int8_t tl_eeprom_getbyte(struct tl_softc *, int, u_int8_t *);
292 static int tl_read_eeprom(struct tl_softc *, caddr_t, int, int);
294 static int tl_miibus_readreg(device_t, int, int);
295 static int tl_miibus_writereg(device_t, int, int, int);
296 static void tl_miibus_statchg(device_t);
298 static void tl_setmode(struct tl_softc *, int);
299 static uint32_t tl_mchash(const uint8_t *);
300 static void tl_setmulti(struct tl_softc *);
301 static void tl_setfilt(struct tl_softc *, caddr_t, int);
302 static void tl_softreset(struct tl_softc *, int);
303 static void tl_hardreset(device_t);
304 static int tl_list_rx_init(struct tl_softc *);
305 static int tl_list_tx_init(struct tl_softc *);
307 static u_int8_t tl_dio_read8(struct tl_softc *, int);
308 static u_int16_t tl_dio_read16(struct tl_softc *, int);
309 static u_int32_t tl_dio_read32(struct tl_softc *, int);
310 static void tl_dio_write8(struct tl_softc *, int, int);
311 static void tl_dio_write16(struct tl_softc *, int, int);
312 static void tl_dio_write32(struct tl_softc *, int, int);
313 static void tl_dio_setbit(struct tl_softc *, int, int);
314 static void tl_dio_clrbit(struct tl_softc *, int, int);
315 static void tl_dio_setbit16(struct tl_softc *, int, int);
316 static void tl_dio_clrbit16(struct tl_softc *, int, int);
321 static uint32_t tl_mii_bitbang_read(device_t);
322 static void tl_mii_bitbang_write(device_t, uint32_t);
324 static const struct mii_bitbang_ops tl_mii_bitbang_ops = {
326 tl_mii_bitbang_write,
328 TL_SIO_MDATA, /* MII_BIT_MDO */
329 TL_SIO_MDATA, /* MII_BIT_MDI */
330 TL_SIO_MCLK, /* MII_BIT_MDC */
331 TL_SIO_MTXEN, /* MII_BIT_DIR_HOST_PHY */
332 0, /* MII_BIT_DIR_PHY_HOST */
337 #define TL_RES SYS_RES_IOPORT
338 #define TL_RID TL_PCI_LOIO
340 #define TL_RES SYS_RES_MEMORY
341 #define TL_RID TL_PCI_LOMEM
344 static device_method_t tl_methods[] = {
345 /* Device interface */
346 DEVMETHOD(device_probe, tl_probe),
347 DEVMETHOD(device_attach, tl_attach),
348 DEVMETHOD(device_detach, tl_detach),
349 DEVMETHOD(device_shutdown, tl_shutdown),
352 DEVMETHOD(bus_print_child, bus_generic_print_child),
353 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
356 DEVMETHOD(miibus_readreg, tl_miibus_readreg),
357 DEVMETHOD(miibus_writereg, tl_miibus_writereg),
358 DEVMETHOD(miibus_statchg, tl_miibus_statchg),
363 static driver_t tl_driver = {
366 sizeof(struct tl_softc)
369 static devclass_t tl_devclass;
371 DRIVER_MODULE(tl, pci, tl_driver, tl_devclass, 0, 0);
372 DRIVER_MODULE(miibus, tl, miibus_driver, miibus_devclass, 0, 0);
374 static u_int8_t tl_dio_read8(sc, reg)
379 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
380 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
381 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
382 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
383 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
384 return(CSR_READ_1(sc, TL_DIO_DATA + (reg & 3)));
387 static u_int16_t tl_dio_read16(sc, reg)
392 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
393 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
394 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
395 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
396 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
397 return(CSR_READ_2(sc, TL_DIO_DATA + (reg & 3)));
400 static u_int32_t tl_dio_read32(sc, reg)
405 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
406 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
407 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
408 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
409 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
410 return(CSR_READ_4(sc, TL_DIO_DATA + (reg & 3)));
413 static void tl_dio_write8(sc, reg, val)
419 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
420 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
421 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
422 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
423 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
424 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), val);
427 static void tl_dio_write16(sc, reg, val)
433 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
434 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
435 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
436 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
437 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
438 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), val);
441 static void tl_dio_write32(sc, reg, val)
447 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
448 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
449 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
450 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
451 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
452 CSR_WRITE_4(sc, TL_DIO_DATA + (reg & 3), val);
456 tl_dio_setbit(sc, reg, bit)
463 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
464 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
465 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
466 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
467 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
468 f = CSR_READ_1(sc, TL_DIO_DATA + (reg & 3));
470 CSR_BARRIER(sc, TL_DIO_DATA + (reg & 3), 1,
471 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
472 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), f);
476 tl_dio_clrbit(sc, reg, bit)
483 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
484 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
485 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
486 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
487 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
488 f = CSR_READ_1(sc, TL_DIO_DATA + (reg & 3));
490 CSR_BARRIER(sc, TL_DIO_DATA + (reg & 3), 1,
491 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
492 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), f);
495 static void tl_dio_setbit16(sc, reg, bit)
502 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
503 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
504 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
505 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
506 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
507 f = CSR_READ_2(sc, TL_DIO_DATA + (reg & 3));
509 CSR_BARRIER(sc, TL_DIO_DATA + (reg & 3), 2,
510 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
511 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), f);
514 static void tl_dio_clrbit16(sc, reg, bit)
521 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
522 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
523 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
524 CSR_BARRIER(sc, TL_DIO_ADDR, 2,
525 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
526 f = CSR_READ_2(sc, TL_DIO_DATA + (reg & 3));
528 CSR_BARRIER(sc, TL_DIO_DATA + (reg & 3), 2,
529 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
530 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), f);
534 * Send an instruction or address to the EEPROM, check for ACK.
536 static u_int8_t tl_eeprom_putbyte(sc, byte)
540 register int i, ack = 0;
543 * Make sure we're in TX mode.
545 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ETXEN);
548 * Feed in each bit and stobe the clock.
550 for (i = 0x80; i; i >>= 1) {
552 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_EDATA);
554 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_EDATA);
557 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
559 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
565 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN);
570 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
571 ack = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_EDATA;
572 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
578 * Read a byte of data stored in the EEPROM at address 'addr.'
580 static u_int8_t tl_eeprom_getbyte(sc, addr, dest)
587 device_t tl_dev = sc->tl_dev;
589 tl_dio_write8(sc, TL_NETSIO, 0);
594 * Send write control code to EEPROM.
596 if (tl_eeprom_putbyte(sc, EEPROM_CTL_WRITE)) {
597 device_printf(tl_dev, "failed to send write command, status: %x\n",
598 tl_dio_read8(sc, TL_NETSIO));
603 * Send address of byte we want to read.
605 if (tl_eeprom_putbyte(sc, addr)) {
606 device_printf(tl_dev, "failed to send address, status: %x\n",
607 tl_dio_read8(sc, TL_NETSIO));
614 * Send read control code to EEPROM.
616 if (tl_eeprom_putbyte(sc, EEPROM_CTL_READ)) {
617 device_printf(tl_dev, "failed to send write command, status: %x\n",
618 tl_dio_read8(sc, TL_NETSIO));
623 * Start reading bits from EEPROM.
625 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN);
626 for (i = 0x80; i; i >>= 1) {
627 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
629 if (tl_dio_read8(sc, TL_NETSIO) & TL_SIO_EDATA)
631 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
638 * No ACK generated for read, so just return byte.
647 * Read a sequence of bytes from the EEPROM.
650 tl_read_eeprom(sc, dest, off, cnt)
659 for (i = 0; i < cnt; i++) {
660 err = tl_eeprom_getbyte(sc, off + i, &byte);
669 #define TL_SIO_MII (TL_SIO_MCLK | TL_SIO_MDATA | TL_SIO_MTXEN)
672 * Read the MII serial port for the MII bit-bang module.
675 tl_mii_bitbang_read(device_t dev)
680 sc = device_get_softc(dev);
682 val = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MII;
683 CSR_BARRIER(sc, TL_NETSIO, 1,
684 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
690 * Write the MII serial port for the MII bit-bang module.
693 tl_mii_bitbang_write(device_t dev, uint32_t val)
697 sc = device_get_softc(dev);
699 val = (tl_dio_read8(sc, TL_NETSIO) & ~TL_SIO_MII) | val;
700 CSR_BARRIER(sc, TL_NETSIO, 1,
701 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
702 tl_dio_write8(sc, TL_NETSIO, val);
703 CSR_BARRIER(sc, TL_NETSIO, 1,
704 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
708 tl_miibus_readreg(dev, phy, reg)
715 sc = device_get_softc(dev);
718 * Turn off MII interrupt by forcing MINTEN low.
720 minten = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MINTEN;
722 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MINTEN);
725 val = mii_bitbang_readreg(dev, &tl_mii_bitbang_ops, phy, reg);
727 /* Reenable interrupts. */
729 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MINTEN);
736 tl_miibus_writereg(dev, phy, reg, data)
743 sc = device_get_softc(dev);
746 * Turn off MII interrupt by forcing MINTEN low.
748 minten = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MINTEN;
750 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MINTEN);
753 mii_bitbang_writereg(dev, &tl_mii_bitbang_ops, phy, reg, data);
755 /* Reenable interrupts. */
757 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MINTEN);
764 tl_miibus_statchg(dev)
768 struct mii_data *mii;
770 sc = device_get_softc(dev);
771 mii = device_get_softc(sc->tl_miibus);
773 if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX) {
774 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
776 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
781 * Set modes for bitrate devices.
784 tl_setmode(sc, media)
788 if (IFM_SUBTYPE(media) == IFM_10_5)
789 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_MTXD1);
790 if (IFM_SUBTYPE(media) == IFM_10_T) {
791 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_MTXD1);
792 if ((media & IFM_GMASK) == IFM_FDX) {
793 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_MTXD3);
794 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
796 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_MTXD3);
797 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
803 * Calculate the hash of a MAC address for programming the multicast hash
804 * table. This hash is simply the address split into 6-bit chunks
806 * byte: 000000|00 1111|1111 22|222222|333333|33 4444|4444 55|555555
807 * bit: 765432|10 7654|3210 76|543210|765432|10 7654|3210 76|543210
808 * Bytes 0-2 and 3-5 are symmetrical, so are folded together. Then
809 * the folded 24-bit value is split into 6-bit portions and XOR'd.
817 t = (addr[0] ^ addr[3]) << 16 | (addr[1] ^ addr[4]) << 8 |
819 return ((t >> 18) ^ (t >> 12) ^ (t >> 6) ^ t) & 0x3f;
823 * The ThunderLAN has a perfect MAC address filter in addition to
824 * the multicast hash filter. The perfect filter can be programmed
825 * with up to four MAC addresses. The first one is always used to
826 * hold the station address, which leaves us free to use the other
827 * three for multicast addresses.
830 tl_setfilt(sc, addr, slot)
838 regaddr = TL_AREG0_B5 + (slot * ETHER_ADDR_LEN);
840 for (i = 0; i < ETHER_ADDR_LEN; i++)
841 tl_dio_write8(sc, regaddr + i, *(addr + i));
845 * XXX In FreeBSD 3.0, multicast addresses are managed using a doubly
846 * linked list. This is fine, except addresses are added from the head
847 * end of the list. We want to arrange for 224.0.0.1 (the "all hosts")
848 * group to always be in the perfect filter, but as more groups are added,
849 * the 224.0.0.1 entry (which is always added first) gets pushed down
850 * the list and ends up at the tail. So after 3 or 4 multicast groups
851 * are added, the all-hosts entry gets pushed out of the perfect filter
852 * and into the hash table.
854 * Because the multicast list is a doubly-linked list as opposed to a
855 * circular queue, we don't have the ability to just grab the tail of
856 * the list and traverse it backwards. Instead, we have to traverse
857 * the list once to find the tail, then traverse it again backwards to
858 * update the multicast filter.
865 u_int32_t hashes[2] = { 0, 0 };
867 struct ifmultiaddr *ifma;
868 u_int8_t dummy[] = { 0, 0, 0, 0, 0 ,0 };
871 /* First, zot all the existing filters. */
872 for (i = 1; i < 4; i++)
873 tl_setfilt(sc, (caddr_t)&dummy, i);
874 tl_dio_write32(sc, TL_HASH1, 0);
875 tl_dio_write32(sc, TL_HASH2, 0);
877 /* Now program new ones. */
878 if (ifp->if_flags & IFF_ALLMULTI) {
879 hashes[0] = 0xFFFFFFFF;
880 hashes[1] = 0xFFFFFFFF;
884 TAILQ_FOREACH_REVERSE(ifma, &ifp->if_multiaddrs, ifmultihead, ifma_link) {
885 if (ifma->ifma_addr->sa_family != AF_LINK)
888 * Program the first three multicast groups
889 * into the perfect filter. For all others,
890 * use the hash table.
894 LLADDR((struct sockaddr_dl *)ifma->ifma_addr), i);
900 LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
902 hashes[0] |= (1 << h);
904 hashes[1] |= (1 << (h - 32));
906 if_maddr_runlock(ifp);
909 tl_dio_write32(sc, TL_HASH1, hashes[0]);
910 tl_dio_write32(sc, TL_HASH2, hashes[1]);
914 * This routine is recommended by the ThunderLAN manual to insure that
915 * the internal PHY is powered up correctly. It also recommends a one
916 * second pause at the end to 'wait for the clocks to start' but in my
917 * experience this isn't necessary.
926 mii_bitbang_sync(dev, &tl_mii_bitbang_ops);
928 flags = BMCR_LOOP|BMCR_ISO|BMCR_PDOWN;
930 for (i = 0; i < MII_NPHY; i++)
931 tl_miibus_writereg(dev, i, MII_BMCR, flags);
933 tl_miibus_writereg(dev, 31, MII_BMCR, BMCR_ISO);
935 tl_miibus_writereg(dev, 31, MII_BMCR, BMCR_LOOP|BMCR_ISO);
936 mii_bitbang_sync(dev, &tl_mii_bitbang_ops);
937 while(tl_miibus_readreg(dev, 31, MII_BMCR) & BMCR_RESET);
943 tl_softreset(sc, internal)
947 u_int32_t cmd, dummy, i;
949 /* Assert the adapter reset bit. */
950 CMD_SET(sc, TL_CMD_ADRST);
952 /* Turn off interrupts */
953 CMD_SET(sc, TL_CMD_INTSOFF);
955 /* First, clear the stats registers. */
956 for (i = 0; i < 5; i++)
957 dummy = tl_dio_read32(sc, TL_TXGOODFRAMES);
959 /* Clear Areg and Hash registers */
960 for (i = 0; i < 8; i++)
961 tl_dio_write32(sc, TL_AREG0_B5, 0x00000000);
964 * Set up Netconfig register. Enable one channel and
967 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_ONECHAN|TL_CFG_ONEFRAG);
968 if (internal && !sc->tl_bitrate) {
969 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_PHYEN);
971 tl_dio_clrbit16(sc, TL_NETCONFIG, TL_CFG_PHYEN);
974 /* Handle cards with bitrate devices. */
976 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_BITRATE);
979 * Load adapter irq pacing timer and tx threshold.
980 * We make the transmit threshold 1 initially but we may
983 cmd = CSR_READ_4(sc, TL_HOSTCMD);
985 cmd &= ~(TL_CMD_RT|TL_CMD_EOC|TL_CMD_ACK_MASK|TL_CMD_CHSEL_MASK);
986 CMD_PUT(sc, cmd | (TL_CMD_LDTHR | TX_THR));
987 CMD_PUT(sc, cmd | (TL_CMD_LDTMR | 0x00000003));
989 /* Unreset the MII */
990 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_NMRST);
992 /* Take the adapter out of reset */
993 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_NRESET|TL_CMD_NWRAP);
995 /* Wait for things to settle down a little. */
1000 * Probe for a ThunderLAN chip. Check the PCI vendor and device IDs
1001 * against our list and return its name if we find a match.
1007 const struct tl_type *t;
1011 while(t->tl_name != NULL) {
1012 if ((pci_get_vendor(dev) == t->tl_vid) &&
1013 (pci_get_device(dev) == t->tl_did)) {
1014 device_set_desc(dev, t->tl_name);
1015 return (BUS_PROBE_DEFAULT);
1028 const struct tl_type *t;
1030 struct tl_softc *sc;
1031 int error, flags, i, rid, unit;
1034 vid = pci_get_vendor(dev);
1035 did = pci_get_device(dev);
1036 sc = device_get_softc(dev);
1038 unit = device_get_unit(dev);
1041 while(t->tl_name != NULL) {
1042 if (vid == t->tl_vid && did == t->tl_did)
1047 if (t->tl_name == NULL) {
1048 device_printf(dev, "unknown device!?\n");
1052 mtx_init(&sc->tl_mtx, device_get_nameunit(dev), MTX_NETWORK_LOCK,
1056 * Map control/status registers.
1058 pci_enable_busmaster(dev);
1060 #ifdef TL_USEIOSPACE
1063 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
1067 * Some cards have the I/O and memory mapped address registers
1068 * reversed. Try both combinations before giving up.
1070 if (sc->tl_res == NULL) {
1072 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
1077 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
1079 if (sc->tl_res == NULL) {
1081 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
1086 if (sc->tl_res == NULL) {
1087 device_printf(dev, "couldn't map ports/memory\n");
1094 * The ThunderLAN manual suggests jacking the PCI latency
1095 * timer all the way up to its maximum value. I'm not sure
1096 * if this is really necessary, but what the manual wants,
1099 command = pci_read_config(dev, TL_PCI_LATENCY_TIMER, 4);
1100 command |= 0x0000FF00;
1101 pci_write_config(dev, TL_PCI_LATENCY_TIMER, command, 4);
1104 /* Allocate interrupt */
1106 sc->tl_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
1107 RF_SHAREABLE | RF_ACTIVE);
1109 if (sc->tl_irq == NULL) {
1110 device_printf(dev, "couldn't map interrupt\n");
1116 * Now allocate memory for the TX and RX lists.
1118 sc->tl_ldata = contigmalloc(sizeof(struct tl_list_data), M_DEVBUF,
1119 M_NOWAIT, 0, 0xffffffff, PAGE_SIZE, 0);
1121 if (sc->tl_ldata == NULL) {
1122 device_printf(dev, "no memory for list buffers!\n");
1127 bzero(sc->tl_ldata, sizeof(struct tl_list_data));
1129 if (vid == COMPAQ_VENDORID || vid == TI_VENDORID)
1130 sc->tl_eeaddr = TL_EEPROM_EADDR;
1131 if (vid == OLICOM_VENDORID)
1132 sc->tl_eeaddr = TL_EEPROM_EADDR_OC;
1134 /* Reset the adapter. */
1135 tl_softreset(sc, 1);
1137 tl_softreset(sc, 1);
1140 * Get station address from the EEPROM.
1142 if (tl_read_eeprom(sc, eaddr, sc->tl_eeaddr, ETHER_ADDR_LEN)) {
1143 device_printf(dev, "failed to read station address\n");
1149 * XXX Olicom, in its desire to be different from the
1150 * rest of the world, has done strange things with the
1151 * encoding of the station address in the EEPROM. First
1152 * of all, they store the address at offset 0xF8 rather
1153 * than at 0x83 like the ThunderLAN manual suggests.
1154 * Second, they store the address in three 16-bit words in
1155 * network byte order, as opposed to storing it sequentially
1156 * like all the other ThunderLAN cards. In order to get
1157 * the station address in a form that matches what the Olicom
1158 * diagnostic utility specifies, we have to byte-swap each
1159 * word. To make things even more confusing, neither 00:00:28
1160 * nor 00:00:24 appear in the IEEE OUI database.
1162 if (vid == OLICOM_VENDORID) {
1163 for (i = 0; i < ETHER_ADDR_LEN; i += 2) {
1165 p = (u_int16_t *)&eaddr[i];
1170 ifp = sc->tl_ifp = if_alloc(IFT_ETHER);
1172 device_printf(dev, "can not if_alloc()\n");
1177 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
1178 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
1179 ifp->if_ioctl = tl_ioctl;
1180 ifp->if_start = tl_start;
1181 ifp->if_init = tl_init;
1182 ifp->if_mtu = ETHERMTU;
1183 ifp->if_snd.ifq_maxlen = TL_TX_LIST_CNT - 1;
1184 ifp->if_capabilities |= IFCAP_VLAN_MTU;
1185 ifp->if_capenable |= IFCAP_VLAN_MTU;
1186 callout_init_mtx(&sc->tl_stat_callout, &sc->tl_mtx, 0);
1188 /* Reset the adapter again. */
1189 tl_softreset(sc, 1);
1191 tl_softreset(sc, 1);
1194 * Do MII setup. If no PHYs are found, then this is a
1195 * bitrate ThunderLAN chip that only supports 10baseT
1197 * XXX mii_attach() can fail for reason different than
1201 if (vid == COMPAQ_VENDORID) {
1202 if (did == COMPAQ_DEVICEID_NETEL_10_100_PROLIANT ||
1203 did == COMPAQ_DEVICEID_NETFLEX_3P_INTEGRATED ||
1204 did == COMPAQ_DEVICEID_NETFLEX_3P_BNC ||
1205 did == COMPAQ_DEVICEID_NETEL_10_T2_UTP_COAX)
1206 flags |= MIIF_MACPRIV0;
1207 if (did == COMPAQ_DEVICEID_NETEL_10 ||
1208 did == COMPAQ_DEVICEID_NETEL_10_100_DUAL ||
1209 did == COMPAQ_DEVICEID_NETFLEX_3P ||
1210 did == COMPAQ_DEVICEID_NETEL_10_100_EMBEDDED)
1211 flags |= MIIF_MACPRIV1;
1212 } else if (vid == OLICOM_VENDORID && did == OLICOM_DEVICEID_OC2183)
1213 flags |= MIIF_MACPRIV0 | MIIF_MACPRIV1;
1214 if (mii_attach(dev, &sc->tl_miibus, ifp, tl_ifmedia_upd,
1215 tl_ifmedia_sts, BMSR_DEFCAPMASK, MII_PHY_ANY, MII_OFFSET_ANY, 0)) {
1216 struct ifmedia *ifm;
1218 ifmedia_init(&sc->ifmedia, 0, tl_ifmedia_upd, tl_ifmedia_sts);
1219 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T, 0, NULL);
1220 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T|IFM_HDX, 0, NULL);
1221 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T|IFM_FDX, 0, NULL);
1222 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_5, 0, NULL);
1223 ifmedia_set(&sc->ifmedia, IFM_ETHER|IFM_10_T);
1224 /* Reset again, this time setting bitrate mode. */
1225 tl_softreset(sc, 1);
1227 ifm->ifm_media = ifm->ifm_cur->ifm_media;
1228 tl_ifmedia_upd(ifp);
1232 * Call MI attach routine.
1234 ether_ifattach(ifp, eaddr);
1236 /* Hook interrupt last to avoid having to lock softc */
1237 error = bus_setup_intr(dev, sc->tl_irq, INTR_TYPE_NET | INTR_MPSAFE,
1238 NULL, tl_intr, sc, &sc->tl_intrhand);
1241 device_printf(dev, "couldn't set up irq\n");
1242 ether_ifdetach(ifp);
1254 * Shutdown hardware and free up resources. This can be called any
1255 * time after the mutex has been initialized. It is called in both
1256 * the error case in attach and the normal detach case so it needs
1257 * to be careful about only freeing resources that have actually been
1264 struct tl_softc *sc;
1267 sc = device_get_softc(dev);
1268 KASSERT(mtx_initialized(&sc->tl_mtx), ("tl mutex not initialized"));
1271 /* These should only be active if attach succeeded */
1272 if (device_is_attached(dev)) {
1273 ether_ifdetach(ifp);
1277 callout_drain(&sc->tl_stat_callout);
1280 device_delete_child(dev, sc->tl_miibus);
1281 bus_generic_detach(dev);
1284 contigfree(sc->tl_ldata, sizeof(struct tl_list_data), M_DEVBUF);
1286 ifmedia_removeall(&sc->ifmedia);
1288 if (sc->tl_intrhand)
1289 bus_teardown_intr(dev, sc->tl_irq, sc->tl_intrhand);
1291 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->tl_irq);
1293 bus_release_resource(dev, TL_RES, TL_RID, sc->tl_res);
1298 mtx_destroy(&sc->tl_mtx);
1304 * Initialize the transmit lists.
1308 struct tl_softc *sc;
1310 struct tl_chain_data *cd;
1311 struct tl_list_data *ld;
1316 for (i = 0; i < TL_TX_LIST_CNT; i++) {
1317 cd->tl_tx_chain[i].tl_ptr = &ld->tl_tx_list[i];
1318 if (i == (TL_TX_LIST_CNT - 1))
1319 cd->tl_tx_chain[i].tl_next = NULL;
1321 cd->tl_tx_chain[i].tl_next = &cd->tl_tx_chain[i + 1];
1324 cd->tl_tx_free = &cd->tl_tx_chain[0];
1325 cd->tl_tx_tail = cd->tl_tx_head = NULL;
1332 * Initialize the RX lists and allocate mbufs for them.
1336 struct tl_softc *sc;
1338 struct tl_chain_data *cd;
1339 struct tl_list_data *ld;
1345 for (i = 0; i < TL_RX_LIST_CNT; i++) {
1346 cd->tl_rx_chain[i].tl_ptr =
1347 (struct tl_list_onefrag *)&ld->tl_rx_list[i];
1348 if (tl_newbuf(sc, &cd->tl_rx_chain[i]) == ENOBUFS)
1350 if (i == (TL_RX_LIST_CNT - 1)) {
1351 cd->tl_rx_chain[i].tl_next = NULL;
1352 ld->tl_rx_list[i].tlist_fptr = 0;
1354 cd->tl_rx_chain[i].tl_next = &cd->tl_rx_chain[i + 1];
1355 ld->tl_rx_list[i].tlist_fptr =
1356 vtophys(&ld->tl_rx_list[i + 1]);
1360 cd->tl_rx_head = &cd->tl_rx_chain[0];
1361 cd->tl_rx_tail = &cd->tl_rx_chain[TL_RX_LIST_CNT - 1];
1368 struct tl_softc *sc;
1369 struct tl_chain_onefrag *c;
1371 struct mbuf *m_new = NULL;
1373 m_new = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
1379 c->tl_ptr->tlist_frsize = MCLBYTES;
1380 c->tl_ptr->tlist_fptr = 0;
1381 c->tl_ptr->tl_frag.tlist_dadr = vtophys(mtod(m_new, caddr_t));
1382 c->tl_ptr->tl_frag.tlist_dcnt = MCLBYTES;
1383 c->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1388 * Interrupt handler for RX 'end of frame' condition (EOF). This
1389 * tells us that a full ethernet frame has been captured and we need
1392 * Reception is done using 'lists' which consist of a header and a
1393 * series of 10 data count/data address pairs that point to buffers.
1394 * Initially you're supposed to create a list, populate it with pointers
1395 * to buffers, then load the physical address of the list into the
1396 * ch_parm register. The adapter is then supposed to DMA the received
1397 * frame into the buffers for you.
1399 * To make things as fast as possible, we have the chip DMA directly
1400 * into mbufs. This saves us from having to do a buffer copy: we can
1401 * just hand the mbufs directly to ether_input(). Once the frame has
1402 * been sent on its way, the 'list' structure is assigned a new buffer
1403 * and moved to the end of the RX chain. As long we we stay ahead of
1404 * the chip, it will always think it has an endless receive channel.
1406 * If we happen to fall behind and the chip manages to fill up all of
1407 * the buffers, it will generate an end of channel interrupt and wait
1408 * for us to empty the chain and restart the receiver.
1411 tl_intvec_rxeof(xsc, type)
1415 struct tl_softc *sc;
1416 int r = 0, total_len = 0;
1417 struct ether_header *eh;
1420 struct tl_chain_onefrag *cur_rx;
1427 while(sc->tl_cdata.tl_rx_head != NULL) {
1428 cur_rx = sc->tl_cdata.tl_rx_head;
1429 if (!(cur_rx->tl_ptr->tlist_cstat & TL_CSTAT_FRAMECMP))
1432 sc->tl_cdata.tl_rx_head = cur_rx->tl_next;
1433 m = cur_rx->tl_mbuf;
1434 total_len = cur_rx->tl_ptr->tlist_frsize;
1436 if (tl_newbuf(sc, cur_rx) == ENOBUFS) {
1438 cur_rx->tl_ptr->tlist_frsize = MCLBYTES;
1439 cur_rx->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1440 cur_rx->tl_ptr->tl_frag.tlist_dcnt = MCLBYTES;
1444 sc->tl_cdata.tl_rx_tail->tl_ptr->tlist_fptr =
1445 vtophys(cur_rx->tl_ptr);
1446 sc->tl_cdata.tl_rx_tail->tl_next = cur_rx;
1447 sc->tl_cdata.tl_rx_tail = cur_rx;
1450 * Note: when the ThunderLAN chip is in 'capture all
1451 * frames' mode, it will receive its own transmissions.
1452 * We drop don't need to process our own transmissions,
1453 * so we drop them here and continue.
1455 eh = mtod(m, struct ether_header *);
1456 /*if (ifp->if_flags & IFF_PROMISC && */
1457 if (!bcmp(eh->ether_shost, IF_LLADDR(sc->tl_ifp),
1463 m->m_pkthdr.rcvif = ifp;
1464 m->m_pkthdr.len = m->m_len = total_len;
1467 (*ifp->if_input)(ifp, m);
1475 * The RX-EOC condition hits when the ch_parm address hasn't been
1476 * initialized or the adapter reached a list with a forward pointer
1477 * of 0 (which indicates the end of the chain). In our case, this means
1478 * the card has hit the end of the receive buffer chain and we need to
1479 * empty out the buffers and shift the pointer back to the beginning again.
1482 tl_intvec_rxeoc(xsc, type)
1486 struct tl_softc *sc;
1488 struct tl_chain_data *cd;
1494 /* Flush out the receive queue and ack RXEOF interrupts. */
1495 r = tl_intvec_rxeof(xsc, type);
1496 CMD_PUT(sc, TL_CMD_ACK | r | (type & ~(0x00100000)));
1498 cd->tl_rx_head = &cd->tl_rx_chain[0];
1499 cd->tl_rx_tail = &cd->tl_rx_chain[TL_RX_LIST_CNT - 1];
1500 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(sc->tl_cdata.tl_rx_head->tl_ptr));
1501 r |= (TL_CMD_GO|TL_CMD_RT);
1506 tl_intvec_txeof(xsc, type)
1510 struct tl_softc *sc;
1512 struct tl_chain *cur_tx;
1517 * Go through our tx list and free mbufs for those
1518 * frames that have been sent.
1520 while (sc->tl_cdata.tl_tx_head != NULL) {
1521 cur_tx = sc->tl_cdata.tl_tx_head;
1522 if (!(cur_tx->tl_ptr->tlist_cstat & TL_CSTAT_FRAMECMP))
1524 sc->tl_cdata.tl_tx_head = cur_tx->tl_next;
1527 m_freem(cur_tx->tl_mbuf);
1528 cur_tx->tl_mbuf = NULL;
1530 cur_tx->tl_next = sc->tl_cdata.tl_tx_free;
1531 sc->tl_cdata.tl_tx_free = cur_tx;
1532 if (!cur_tx->tl_ptr->tlist_fptr)
1540 * The transmit end of channel interrupt. The adapter triggers this
1541 * interrupt to tell us it hit the end of the current transmit list.
1543 * A note about this: it's possible for a condition to arise where
1544 * tl_start() may try to send frames between TXEOF and TXEOC interrupts.
1545 * You have to avoid this since the chip expects things to go in a
1546 * particular order: transmit, acknowledge TXEOF, acknowledge TXEOC.
1547 * When the TXEOF handler is called, it will free all of the transmitted
1548 * frames and reset the tx_head pointer to NULL. However, a TXEOC
1549 * interrupt should be received and acknowledged before any more frames
1550 * are queued for transmission. If tl_statrt() is called after TXEOF
1551 * resets the tx_head pointer but _before_ the TXEOC interrupt arrives,
1552 * it could attempt to issue a transmit command prematurely.
1554 * To guard against this, tl_start() will only issue transmit commands
1555 * if the tl_txeoc flag is set, and only the TXEOC interrupt handler
1556 * can set this flag once tl_start() has cleared it.
1559 tl_intvec_txeoc(xsc, type)
1563 struct tl_softc *sc;
1570 /* Clear the timeout timer. */
1573 if (sc->tl_cdata.tl_tx_head == NULL) {
1574 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
1575 sc->tl_cdata.tl_tx_tail = NULL;
1579 /* First we have to ack the EOC interrupt. */
1580 CMD_PUT(sc, TL_CMD_ACK | 0x00000001 | type);
1581 /* Then load the address of the next TX list. */
1582 CSR_WRITE_4(sc, TL_CH_PARM,
1583 vtophys(sc->tl_cdata.tl_tx_head->tl_ptr));
1584 /* Restart TX channel. */
1585 cmd = CSR_READ_4(sc, TL_HOSTCMD);
1587 cmd |= TL_CMD_GO|TL_CMD_INTSON;
1596 tl_intvec_adchk(xsc, type)
1600 struct tl_softc *sc;
1605 device_printf(sc->tl_dev, "adapter check: %x\n",
1606 (unsigned int)CSR_READ_4(sc, TL_CH_PARM));
1608 tl_softreset(sc, 1);
1611 CMD_SET(sc, TL_CMD_INTSON);
1617 tl_intvec_netsts(xsc, type)
1621 struct tl_softc *sc;
1626 netsts = tl_dio_read16(sc, TL_NETSTS);
1627 tl_dio_write16(sc, TL_NETSTS, netsts);
1629 device_printf(sc->tl_dev, "network status: %x\n", netsts);
1638 struct tl_softc *sc;
1648 /* Disable interrupts */
1649 ints = CSR_READ_2(sc, TL_HOST_INT);
1650 CSR_WRITE_2(sc, TL_HOST_INT, ints);
1651 type = (ints << 16) & 0xFFFF0000;
1652 ivec = (ints & TL_VEC_MASK) >> 5;
1653 ints = (ints & TL_INT_MASK) >> 2;
1658 case (TL_INTR_INVALID):
1660 device_printf(sc->tl_dev, "got an invalid interrupt!\n");
1662 /* Re-enable interrupts but don't ack this one. */
1666 case (TL_INTR_TXEOF):
1667 r = tl_intvec_txeof((void *)sc, type);
1669 case (TL_INTR_TXEOC):
1670 r = tl_intvec_txeoc((void *)sc, type);
1672 case (TL_INTR_STATOFLOW):
1673 tl_stats_update(sc);
1676 case (TL_INTR_RXEOF):
1677 r = tl_intvec_rxeof((void *)sc, type);
1679 case (TL_INTR_DUMMY):
1680 device_printf(sc->tl_dev, "got a dummy interrupt\n");
1683 case (TL_INTR_ADCHK):
1685 r = tl_intvec_adchk((void *)sc, type);
1687 r = tl_intvec_netsts((void *)sc, type);
1689 case (TL_INTR_RXEOC):
1690 r = tl_intvec_rxeoc((void *)sc, type);
1693 device_printf(sc->tl_dev, "bogus interrupt type\n");
1697 /* Re-enable interrupts */
1699 CMD_PUT(sc, TL_CMD_ACK | r | type);
1702 if (ifp->if_snd.ifq_head != NULL)
1703 tl_start_locked(ifp);
1709 tl_stats_update(xsc)
1712 struct tl_softc *sc;
1714 struct tl_stats tl_stats;
1715 struct mii_data *mii;
1718 bzero((char *)&tl_stats, sizeof(struct tl_stats));
1724 p = (u_int32_t *)&tl_stats;
1726 CSR_WRITE_2(sc, TL_DIO_ADDR, TL_TXGOODFRAMES|TL_DIO_ADDR_INC);
1727 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1728 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1729 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1730 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1731 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1733 ifp->if_opackets += tl_tx_goodframes(tl_stats);
1734 ifp->if_collisions += tl_stats.tl_tx_single_collision +
1735 tl_stats.tl_tx_multi_collision;
1736 ifp->if_ipackets += tl_rx_goodframes(tl_stats);
1737 ifp->if_ierrors += tl_stats.tl_crc_errors + tl_stats.tl_code_errors +
1738 tl_rx_overrun(tl_stats);
1739 ifp->if_oerrors += tl_tx_underrun(tl_stats);
1741 if (tl_tx_underrun(tl_stats)) {
1743 tx_thresh = tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_TXTHRESH;
1744 if (tx_thresh != TL_AC_TXTHRESH_WHOLEPKT) {
1747 device_printf(sc->tl_dev, "tx underrun -- increasing "
1748 "tx threshold to %d bytes\n",
1749 (64 * (tx_thresh * 4)));
1750 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH);
1751 tl_dio_setbit(sc, TL_ACOMMIT, tx_thresh << 4);
1755 if (sc->tl_timer > 0 && --sc->tl_timer == 0)
1758 callout_reset(&sc->tl_stat_callout, hz, tl_stats_update, sc);
1760 if (!sc->tl_bitrate) {
1761 mii = device_get_softc(sc->tl_miibus);
1767 * Encapsulate an mbuf chain in a list by coupling the mbuf data
1768 * pointers to the fragment pointers.
1771 tl_encap(sc, c, m_head)
1772 struct tl_softc *sc;
1774 struct mbuf *m_head;
1777 struct tl_frag *f = NULL;
1780 struct ifnet *ifp = sc->tl_ifp;
1783 * Start packing the mbufs in this chain into
1784 * the fragment pointers. Stop when we run out
1785 * of fragments or hit the end of the mbuf chain.
1790 for (m = m_head, frag = 0; m != NULL; m = m->m_next) {
1791 if (m->m_len != 0) {
1792 if (frag == TL_MAXFRAGS)
1794 total_len+= m->m_len;
1795 c->tl_ptr->tl_frag[frag].tlist_dadr =
1796 vtophys(mtod(m, vm_offset_t));
1797 c->tl_ptr->tl_frag[frag].tlist_dcnt = m->m_len;
1803 * Handle special cases.
1804 * Special case #1: we used up all 10 fragments, but
1805 * we have more mbufs left in the chain. Copy the
1806 * data into an mbuf cluster. Note that we don't
1807 * bother clearing the values in the other fragment
1808 * pointers/counters; it wouldn't gain us anything,
1809 * and would waste cycles.
1812 struct mbuf *m_new = NULL;
1814 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
1815 if (m_new == NULL) {
1816 if_printf(ifp, "no memory for tx list\n");
1819 if (m_head->m_pkthdr.len > MHLEN) {
1820 MCLGET(m_new, M_DONTWAIT);
1821 if (!(m_new->m_flags & M_EXT)) {
1823 if_printf(ifp, "no memory for tx list\n");
1827 m_copydata(m_head, 0, m_head->m_pkthdr.len,
1828 mtod(m_new, caddr_t));
1829 m_new->m_pkthdr.len = m_new->m_len = m_head->m_pkthdr.len;
1832 f = &c->tl_ptr->tl_frag[0];
1833 f->tlist_dadr = vtophys(mtod(m_new, caddr_t));
1834 f->tlist_dcnt = total_len = m_new->m_len;
1839 * Special case #2: the frame is smaller than the minimum
1840 * frame size. We have to pad it to make the chip happy.
1842 if (total_len < TL_MIN_FRAMELEN) {
1843 if (frag == TL_MAXFRAGS)
1845 "all frags filled but frame still to small!\n");
1846 f = &c->tl_ptr->tl_frag[frag];
1847 f->tlist_dcnt = TL_MIN_FRAMELEN - total_len;
1848 f->tlist_dadr = vtophys(&sc->tl_ldata->tl_pad);
1849 total_len += f->tlist_dcnt;
1853 c->tl_mbuf = m_head;
1854 c->tl_ptr->tl_frag[frag - 1].tlist_dcnt |= TL_LAST_FRAG;
1855 c->tl_ptr->tlist_frsize = total_len;
1856 c->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1857 c->tl_ptr->tlist_fptr = 0;
1863 * Main transmit routine. To avoid having to do mbuf copies, we put pointers
1864 * to the mbuf data regions directly in the transmit lists. We also save a
1865 * copy of the pointers since the transmit list fragment pointers are
1866 * physical addresses.
1872 struct tl_softc *sc;
1876 tl_start_locked(ifp);
1881 tl_start_locked(ifp)
1884 struct tl_softc *sc;
1885 struct mbuf *m_head = NULL;
1887 struct tl_chain *prev = NULL, *cur_tx = NULL, *start_tx;
1893 * Check for an available queue slot. If there are none,
1896 if (sc->tl_cdata.tl_tx_free == NULL) {
1897 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
1901 start_tx = sc->tl_cdata.tl_tx_free;
1903 while(sc->tl_cdata.tl_tx_free != NULL) {
1904 IF_DEQUEUE(&ifp->if_snd, m_head);
1908 /* Pick a chain member off the free list. */
1909 cur_tx = sc->tl_cdata.tl_tx_free;
1910 sc->tl_cdata.tl_tx_free = cur_tx->tl_next;
1912 cur_tx->tl_next = NULL;
1914 /* Pack the data into the list. */
1915 tl_encap(sc, cur_tx, m_head);
1917 /* Chain it together */
1919 prev->tl_next = cur_tx;
1920 prev->tl_ptr->tlist_fptr = vtophys(cur_tx->tl_ptr);
1925 * If there's a BPF listener, bounce a copy of this frame
1928 BPF_MTAP(ifp, cur_tx->tl_mbuf);
1932 * If there are no packets queued, bail.
1938 * That's all we can stands, we can't stands no more.
1939 * If there are no other transfers pending, then issue the
1940 * TX GO command to the adapter to start things moving.
1941 * Otherwise, just leave the data in the queue and let
1942 * the EOF/EOC interrupt handler send.
1944 if (sc->tl_cdata.tl_tx_head == NULL) {
1945 sc->tl_cdata.tl_tx_head = start_tx;
1946 sc->tl_cdata.tl_tx_tail = cur_tx;
1950 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(start_tx->tl_ptr));
1951 cmd = CSR_READ_4(sc, TL_HOSTCMD);
1953 cmd |= TL_CMD_GO|TL_CMD_INTSON;
1957 sc->tl_cdata.tl_tx_tail->tl_next = start_tx;
1958 sc->tl_cdata.tl_tx_tail = cur_tx;
1962 * Set a timeout in case the chip goes out to lunch.
1971 struct tl_softc *sc = xsc;
1980 struct tl_softc *sc;
1982 struct ifnet *ifp = sc->tl_ifp;
1983 struct mii_data *mii;
1990 * Cancel pending I/O.
1994 /* Initialize TX FIFO threshold */
1995 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH);
1996 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH_16LONG);
1998 /* Set PCI burst size */
1999 tl_dio_write8(sc, TL_BSIZEREG, TL_RXBURST_16LONG|TL_TXBURST_16LONG);
2002 * Set 'capture all frames' bit for promiscuous mode.
2004 if (ifp->if_flags & IFF_PROMISC)
2005 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_CAF);
2007 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_CAF);
2010 * Set capture broadcast bit to capture broadcast frames.
2012 if (ifp->if_flags & IFF_BROADCAST)
2013 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_NOBRX);
2015 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_NOBRX);
2017 tl_dio_write16(sc, TL_MAXRX, MCLBYTES);
2019 /* Init our MAC address */
2020 tl_setfilt(sc, IF_LLADDR(sc->tl_ifp), 0);
2022 /* Init multicast filter, if needed. */
2025 /* Init circular RX list. */
2026 if (tl_list_rx_init(sc) == ENOBUFS) {
2027 device_printf(sc->tl_dev,
2028 "initialization failed: no memory for rx buffers\n");
2033 /* Init TX pointers. */
2034 tl_list_tx_init(sc);
2036 /* Enable PCI interrupts. */
2037 CMD_SET(sc, TL_CMD_INTSON);
2039 /* Load the address of the rx list */
2040 CMD_SET(sc, TL_CMD_RT);
2041 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(&sc->tl_ldata->tl_rx_list[0]));
2043 if (!sc->tl_bitrate) {
2044 if (sc->tl_miibus != NULL) {
2045 mii = device_get_softc(sc->tl_miibus);
2049 tl_ifmedia_upd(ifp);
2052 /* Send the RX go command */
2053 CMD_SET(sc, TL_CMD_GO|TL_CMD_NES|TL_CMD_RT);
2055 ifp->if_drv_flags |= IFF_DRV_RUNNING;
2056 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
2058 /* Start the stats update counter */
2059 callout_reset(&sc->tl_stat_callout, hz, tl_stats_update, sc);
2063 * Set media options.
2069 struct tl_softc *sc;
2070 struct mii_data *mii = NULL;
2076 tl_setmode(sc, sc->ifmedia.ifm_media);
2078 mii = device_get_softc(sc->tl_miibus);
2087 * Report current media status.
2090 tl_ifmedia_sts(ifp, ifmr)
2092 struct ifmediareq *ifmr;
2094 struct tl_softc *sc;
2095 struct mii_data *mii;
2100 ifmr->ifm_active = IFM_ETHER;
2102 if (sc->tl_bitrate) {
2103 if (tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_MTXD1)
2104 ifmr->ifm_active = IFM_ETHER|IFM_10_5;
2106 ifmr->ifm_active = IFM_ETHER|IFM_10_T;
2107 if (tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_MTXD3)
2108 ifmr->ifm_active |= IFM_HDX;
2110 ifmr->ifm_active |= IFM_FDX;
2113 mii = device_get_softc(sc->tl_miibus);
2115 ifmr->ifm_active = mii->mii_media_active;
2116 ifmr->ifm_status = mii->mii_media_status;
2122 tl_ioctl(ifp, command, data)
2127 struct tl_softc *sc = ifp->if_softc;
2128 struct ifreq *ifr = (struct ifreq *) data;
2134 if (ifp->if_flags & IFF_UP) {
2135 if (ifp->if_drv_flags & IFF_DRV_RUNNING &&
2136 ifp->if_flags & IFF_PROMISC &&
2137 !(sc->tl_if_flags & IFF_PROMISC)) {
2138 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_CAF);
2140 } else if (ifp->if_drv_flags & IFF_DRV_RUNNING &&
2141 !(ifp->if_flags & IFF_PROMISC) &&
2142 sc->tl_if_flags & IFF_PROMISC) {
2143 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_CAF);
2148 if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
2152 sc->tl_if_flags = ifp->if_flags;
2166 error = ifmedia_ioctl(ifp, ifr, &sc->ifmedia, command);
2168 struct mii_data *mii;
2169 mii = device_get_softc(sc->tl_miibus);
2170 error = ifmedia_ioctl(ifp, ifr,
2171 &mii->mii_media, command);
2175 error = ether_ioctl(ifp, command, data);
2184 struct tl_softc *sc;
2191 if_printf(ifp, "device timeout\n");
2195 tl_softreset(sc, 1);
2200 * Stop the adapter and free any mbufs allocated to the
2205 struct tl_softc *sc;
2214 /* Stop the stats updater. */
2215 callout_stop(&sc->tl_stat_callout);
2217 /* Stop the transmitter */
2218 CMD_CLR(sc, TL_CMD_RT);
2219 CMD_SET(sc, TL_CMD_STOP);
2220 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2222 /* Stop the receiver */
2223 CMD_SET(sc, TL_CMD_RT);
2224 CMD_SET(sc, TL_CMD_STOP);
2225 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2228 * Disable host interrupts.
2230 CMD_SET(sc, TL_CMD_INTSOFF);
2233 * Clear list pointer.
2235 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2238 * Free the RX lists.
2240 for (i = 0; i < TL_RX_LIST_CNT; i++) {
2241 if (sc->tl_cdata.tl_rx_chain[i].tl_mbuf != NULL) {
2242 m_freem(sc->tl_cdata.tl_rx_chain[i].tl_mbuf);
2243 sc->tl_cdata.tl_rx_chain[i].tl_mbuf = NULL;
2246 bzero((char *)&sc->tl_ldata->tl_rx_list,
2247 sizeof(sc->tl_ldata->tl_rx_list));
2250 * Free the TX list buffers.
2252 for (i = 0; i < TL_TX_LIST_CNT; i++) {
2253 if (sc->tl_cdata.tl_tx_chain[i].tl_mbuf != NULL) {
2254 m_freem(sc->tl_cdata.tl_tx_chain[i].tl_mbuf);
2255 sc->tl_cdata.tl_tx_chain[i].tl_mbuf = NULL;
2258 bzero((char *)&sc->tl_ldata->tl_tx_list,
2259 sizeof(sc->tl_ldata->tl_tx_list));
2261 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
2265 * Stop all chip I/O so that the kernel's probe routines don't
2266 * get confused by errant DMAs when rebooting.
2272 struct tl_softc *sc;
2274 sc = device_get_softc(dev);