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.
32 * $FreeBSD: src/sys/pci/if_tl.c,v 1.51.2.5 2001/12/16 15:46:08 luigi Exp $
33 * $DragonFly: src/sys/dev/netif/tl/if_tl.c,v 1.9 2004/03/23 22:19:04 hsu Exp $
35 * $FreeBSD: src/sys/pci/if_tl.c,v 1.51.2.5 2001/12/16 15:46:08 luigi Exp $
39 * Texas Instruments ThunderLAN driver for FreeBSD 2.2.6 and 3.x.
40 * Supports many Compaq PCI NICs based on the ThunderLAN ethernet controller,
41 * the National Semiconductor DP83840A physical interface and the
42 * Microchip Technology 24Cxx series serial EEPROM.
44 * Written using the following four documents:
46 * Texas Instruments ThunderLAN Programmer's Guide (www.ti.com)
47 * National Semiconductor DP83840A data sheet (www.national.com)
48 * Microchip Technology 24C02C data sheet (www.microchip.com)
49 * Micro Linear ML6692 100BaseTX only PHY data sheet (www.microlinear.com)
51 * Written by Bill Paul <wpaul@ctr.columbia.edu>
52 * Electrical Engineering Department
53 * Columbia University, New York City
57 * Some notes about the ThunderLAN:
59 * The ThunderLAN controller is a single chip containing PCI controller
60 * logic, approximately 3K of on-board SRAM, a LAN controller, and media
61 * independent interface (MII) bus. The MII allows the ThunderLAN chip to
62 * control up to 32 different physical interfaces (PHYs). The ThunderLAN
63 * also has a built-in 10baseT PHY, allowing a single ThunderLAN controller
64 * to act as a complete ethernet interface.
66 * Other PHYs may be attached to the ThunderLAN; the Compaq 10/100 cards
67 * use a National Semiconductor DP83840A PHY that supports 10 or 100Mb/sec
68 * in full or half duplex. Some of the Compaq Deskpro machines use a
69 * Level 1 LXT970 PHY with the same capabilities. Certain Olicom adapters
70 * use a Micro Linear ML6692 100BaseTX only PHY, which can be used in
71 * concert with the ThunderLAN's internal PHY to provide full 10/100
72 * support. This is cheaper than using a standalone external PHY for both
73 * 10/100 modes and letting the ThunderLAN's internal PHY go to waste.
74 * A serial EEPROM is also attached to the ThunderLAN chip to provide
75 * power-up default register settings and for storing the adapter's
76 * station address. Although not supported by this driver, the ThunderLAN
77 * chip can also be connected to token ring PHYs.
79 * The ThunderLAN has a set of registers which can be used to issue
80 * commands, acknowledge interrupts, and to manipulate other internal
81 * registers on its DIO bus. The primary registers can be accessed
82 * using either programmed I/O (inb/outb) or via PCI memory mapping,
83 * depending on how the card is configured during the PCI probing
84 * phase. It is even possible to have both PIO and memory mapped
85 * access turned on at the same time.
87 * Frame reception and transmission with the ThunderLAN chip is done
88 * using frame 'lists.' A list structure looks more or less like this:
91 * u_int32_t fragment_address;
92 * u_int32_t fragment_size;
95 * u_int32_t forward_pointer;
97 * u_int16_t frame_size;
98 * struct tl_frag fragments[10];
101 * The forward pointer in the list header can be either a 0 or the address
102 * of another list, which allows several lists to be linked together. Each
103 * list contains up to 10 fragment descriptors. This means the chip allows
104 * ethernet frames to be broken up into up to 10 chunks for transfer to
105 * and from the SRAM. Note that the forward pointer and fragment buffer
106 * addresses are physical memory addresses, not virtual. Note also that
107 * a single ethernet frame can not span lists: if the host wants to
108 * transmit a frame and the frame data is split up over more than 10
109 * buffers, the frame has to collapsed before it can be transmitted.
111 * To receive frames, the driver sets up a number of lists and populates
112 * the fragment descriptors, then it sends an RX GO command to the chip.
113 * When a frame is received, the chip will DMA it into the memory regions
114 * specified by the fragment descriptors and then trigger an RX 'end of
115 * frame interrupt' when done. The driver may choose to use only one
116 * fragment per list; this may result is slighltly less efficient use
117 * of memory in exchange for improving performance.
119 * To transmit frames, the driver again sets up lists and fragment
120 * descriptors, only this time the buffers contain frame data that
121 * is to be DMA'ed into the chip instead of out of it. Once the chip
122 * has transfered the data into its on-board SRAM, it will trigger a
123 * TX 'end of frame' interrupt. It will also generate an 'end of channel'
124 * interrupt when it reaches the end of the list.
128 * Some notes about this driver:
130 * The ThunderLAN chip provides a couple of different ways to organize
131 * reception, transmission and interrupt handling. The simplest approach
132 * is to use one list each for transmission and reception. In this mode,
133 * the ThunderLAN will generate two interrupts for every received frame
134 * (one RX EOF and one RX EOC) and two for each transmitted frame (one
135 * TX EOF and one TX EOC). This may make the driver simpler but it hurts
136 * performance to have to handle so many interrupts.
138 * Initially I wanted to create a circular list of receive buffers so
139 * that the ThunderLAN chip would think there was an infinitely long
140 * receive channel and never deliver an RXEOC interrupt. However this
141 * doesn't work correctly under heavy load: while the manual says the
142 * chip will trigger an RXEOF interrupt each time a frame is copied into
143 * memory, you can't count on the chip waiting around for you to acknowledge
144 * the interrupt before it starts trying to DMA the next frame. The result
145 * is that the chip might traverse the entire circular list and then wrap
146 * around before you have a chance to do anything about it. Consequently,
147 * the receive list is terminated (with a 0 in the forward pointer in the
148 * last element). Each time an RXEOF interrupt arrives, the used list
149 * is shifted to the end of the list. This gives the appearance of an
150 * infinitely large RX chain so long as the driver doesn't fall behind
151 * the chip and allow all of the lists to be filled up.
153 * If all the lists are filled, the adapter will deliver an RX 'end of
154 * channel' interrupt when it hits the 0 forward pointer at the end of
155 * the chain. The RXEOC handler then cleans out the RX chain and resets
156 * the list head pointer in the ch_parm register and restarts the receiver.
158 * For frame transmission, it is possible to program the ThunderLAN's
159 * transmit interrupt threshold so that the chip can acknowledge multiple
160 * lists with only a single TX EOF interrupt. This allows the driver to
161 * queue several frames in one shot, and only have to handle a total
162 * two interrupts (one TX EOF and one TX EOC) no matter how many frames
163 * are transmitted. Frame transmission is done directly out of the
164 * mbufs passed to the tl_start() routine via the interface send queue.
165 * The driver simply sets up the fragment descriptors in the transmit
166 * lists to point to the mbuf data regions and sends a TX GO command.
168 * Note that since the RX and TX lists themselves are always used
169 * only by the driver, the are malloc()ed once at driver initialization
170 * time and never free()ed.
172 * Also, in order to remain as platform independent as possible, this
173 * driver uses memory mapped register access to manipulate the card
174 * as opposed to programmed I/O. This avoids the use of the inb/outb
175 * (and related) instructions which are specific to the i386 platform.
177 * Using these techniques, this driver achieves very high performance
178 * by minimizing the amount of interrupts generated during large
179 * transfers and by completely avoiding buffer copies. Frame transfer
180 * to and from the ThunderLAN chip is performed entirely by the chip
181 * itself thereby reducing the load on the host CPU.
184 #include <sys/param.h>
185 #include <sys/systm.h>
186 #include <sys/sockio.h>
187 #include <sys/mbuf.h>
188 #include <sys/malloc.h>
189 #include <sys/kernel.h>
190 #include <sys/socket.h>
193 #include <net/if_arp.h>
194 #include <net/ethernet.h>
195 #include <net/if_dl.h>
196 #include <net/if_media.h>
200 #include <vm/vm.h> /* for vtophys */
201 #include <vm/pmap.h> /* for vtophys */
202 #include <machine/clock.h> /* for DELAY */
203 #include <machine/bus_memio.h>
204 #include <machine/bus_pio.h>
205 #include <machine/bus.h>
206 #include <machine/resource.h>
208 #include <sys/rman.h>
210 #include "../mii_layer/mii.h"
211 #include "../mii_layer/miivar.h"
213 #include <bus/pci/pcireg.h>
214 #include <bus/pci/pcivar.h>
217 * Default to using PIO register access mode to pacify certain
218 * laptop docking stations with built-in ThunderLAN chips that
219 * don't seem to handle memory mapped mode properly.
221 #define TL_USEIOSPACE
223 #include "if_tlreg.h"
225 /* "controller miibus0" required. See GENERIC if you get errors here. */
226 #include "miibus_if.h"
229 * Various supported device vendors/types and their names.
232 static struct tl_type 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 *,
275 struct tl_chain_onefrag *);
276 static void tl_stats_update (void *);
277 static int tl_encap (struct tl_softc *, struct tl_chain *,
280 static void tl_intr (void *);
281 static void tl_start (struct ifnet *);
282 static int tl_ioctl (struct ifnet *, u_long, caddr_t,
284 static void tl_init (void *);
285 static void tl_stop (struct tl_softc *);
286 static void tl_watchdog (struct ifnet *);
287 static void tl_shutdown (device_t);
288 static int tl_ifmedia_upd (struct ifnet *);
289 static void tl_ifmedia_sts (struct ifnet *, struct ifmediareq *);
291 static u_int8_t tl_eeprom_putbyte (struct tl_softc *, int);
292 static u_int8_t tl_eeprom_getbyte (struct tl_softc *,
294 static int tl_read_eeprom (struct tl_softc *, caddr_t, int, int);
296 static void tl_mii_sync (struct tl_softc *);
297 static void tl_mii_send (struct tl_softc *, u_int32_t, int);
298 static int tl_mii_readreg (struct tl_softc *, struct tl_mii_frame *);
299 static int tl_mii_writereg (struct tl_softc *, struct tl_mii_frame *);
300 static int tl_miibus_readreg (device_t, int, int);
301 static int tl_miibus_writereg (device_t, int, int, int);
302 static void tl_miibus_statchg (device_t);
304 static void tl_setmode (struct tl_softc *, int);
305 static int tl_calchash (caddr_t);
306 static void tl_setmulti (struct tl_softc *);
307 static void tl_setfilt (struct tl_softc *, caddr_t, int);
308 static void tl_softreset (struct tl_softc *, int);
309 static void tl_hardreset (device_t);
310 static int tl_list_rx_init (struct tl_softc *);
311 static int tl_list_tx_init (struct tl_softc *);
313 static u_int8_t tl_dio_read8 (struct tl_softc *, int);
314 static u_int16_t tl_dio_read16 (struct tl_softc *, int);
315 static u_int32_t tl_dio_read32 (struct tl_softc *, int);
316 static void tl_dio_write8 (struct tl_softc *, int, int);
317 static void tl_dio_write16 (struct tl_softc *, int, int);
318 static void tl_dio_write32 (struct tl_softc *, int, int);
319 static void tl_dio_setbit (struct tl_softc *, int, int);
320 static void tl_dio_clrbit (struct tl_softc *, int, int);
321 static void tl_dio_setbit16 (struct tl_softc *, int, int);
322 static void tl_dio_clrbit16 (struct tl_softc *, int, int);
325 #define TL_RES SYS_RES_IOPORT
326 #define TL_RID TL_PCI_LOIO
328 #define TL_RES SYS_RES_MEMORY
329 #define TL_RID TL_PCI_LOMEM
332 static device_method_t tl_methods[] = {
333 /* Device interface */
334 DEVMETHOD(device_probe, tl_probe),
335 DEVMETHOD(device_attach, tl_attach),
336 DEVMETHOD(device_detach, tl_detach),
337 DEVMETHOD(device_shutdown, tl_shutdown),
340 DEVMETHOD(bus_print_child, bus_generic_print_child),
341 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
344 DEVMETHOD(miibus_readreg, tl_miibus_readreg),
345 DEVMETHOD(miibus_writereg, tl_miibus_writereg),
346 DEVMETHOD(miibus_statchg, tl_miibus_statchg),
351 static driver_t tl_driver = {
354 sizeof(struct tl_softc)
357 static devclass_t tl_devclass;
359 DECLARE_DUMMY_MODULE(if_tl);
360 DRIVER_MODULE(if_tl, pci, tl_driver, tl_devclass, 0, 0);
361 DRIVER_MODULE(miibus, tl, miibus_driver, miibus_devclass, 0, 0);
363 static u_int8_t tl_dio_read8(sc, reg)
367 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
368 return(CSR_READ_1(sc, TL_DIO_DATA + (reg & 3)));
371 static u_int16_t tl_dio_read16(sc, reg)
375 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
376 return(CSR_READ_2(sc, TL_DIO_DATA + (reg & 3)));
379 static u_int32_t tl_dio_read32(sc, reg)
383 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
384 return(CSR_READ_4(sc, TL_DIO_DATA + (reg & 3)));
387 static void tl_dio_write8(sc, reg, val)
392 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
393 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), val);
397 static void tl_dio_write16(sc, reg, val)
402 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
403 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), val);
407 static void tl_dio_write32(sc, reg, val)
412 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
413 CSR_WRITE_4(sc, TL_DIO_DATA + (reg & 3), val);
417 static void tl_dio_setbit(sc, reg, bit)
424 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
425 f = CSR_READ_1(sc, TL_DIO_DATA + (reg & 3));
427 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), f);
432 static void tl_dio_clrbit(sc, reg, bit)
439 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
440 f = CSR_READ_1(sc, TL_DIO_DATA + (reg & 3));
442 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), f);
447 static void tl_dio_setbit16(sc, reg, bit)
454 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
455 f = CSR_READ_2(sc, TL_DIO_DATA + (reg & 3));
457 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), f);
462 static void tl_dio_clrbit16(sc, reg, bit)
469 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
470 f = CSR_READ_2(sc, TL_DIO_DATA + (reg & 3));
472 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), f);
478 * Send an instruction or address to the EEPROM, check for ACK.
480 static u_int8_t tl_eeprom_putbyte(sc, byte)
487 * Make sure we're in TX mode.
489 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ETXEN);
492 * Feed in each bit and stobe the clock.
494 for (i = 0x80; i; i >>= 1) {
496 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_EDATA);
498 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_EDATA);
501 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
503 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
509 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN);
514 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
515 ack = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_EDATA;
516 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
522 * Read a byte of data stored in the EEPROM at address 'addr.'
524 static u_int8_t tl_eeprom_getbyte(sc, addr, dest)
532 tl_dio_write8(sc, TL_NETSIO, 0);
537 * Send write control code to EEPROM.
539 if (tl_eeprom_putbyte(sc, EEPROM_CTL_WRITE)) {
540 printf("tl%d: failed to send write command, status: %x\n",
541 sc->tl_unit, tl_dio_read8(sc, TL_NETSIO));
546 * Send address of byte we want to read.
548 if (tl_eeprom_putbyte(sc, addr)) {
549 printf("tl%d: failed to send address, status: %x\n",
550 sc->tl_unit, tl_dio_read8(sc, TL_NETSIO));
557 * Send read control code to EEPROM.
559 if (tl_eeprom_putbyte(sc, EEPROM_CTL_READ)) {
560 printf("tl%d: failed to send write command, status: %x\n",
561 sc->tl_unit, tl_dio_read8(sc, TL_NETSIO));
566 * Start reading bits from EEPROM.
568 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN);
569 for (i = 0x80; i; i >>= 1) {
570 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
572 if (tl_dio_read8(sc, TL_NETSIO) & TL_SIO_EDATA)
574 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
581 * No ACK generated for read, so just return byte.
590 * Read a sequence of bytes from the EEPROM.
592 static int tl_read_eeprom(sc, dest, off, cnt)
601 for (i = 0; i < cnt; i++) {
602 err = tl_eeprom_getbyte(sc, off + i, &byte);
611 static void tl_mii_sync(sc)
616 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MTXEN);
618 for (i = 0; i < 32; i++) {
619 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
620 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
626 static void tl_mii_send(sc, bits, cnt)
633 for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
634 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
636 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MDATA);
638 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MDATA);
640 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
644 static int tl_mii_readreg(sc, frame)
646 struct tl_mii_frame *frame;
657 * Set up frame for RX.
659 frame->mii_stdelim = TL_MII_STARTDELIM;
660 frame->mii_opcode = TL_MII_READOP;
661 frame->mii_turnaround = 0;
665 * Turn off MII interrupt by forcing MINTEN low.
667 minten = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MINTEN;
669 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MINTEN);
675 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MTXEN);
678 * Send command/address info.
680 tl_mii_send(sc, frame->mii_stdelim, 2);
681 tl_mii_send(sc, frame->mii_opcode, 2);
682 tl_mii_send(sc, frame->mii_phyaddr, 5);
683 tl_mii_send(sc, frame->mii_regaddr, 5);
688 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MTXEN);
691 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
692 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
695 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
696 ack = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MDATA;
698 /* Complete the cycle */
699 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
702 * Now try reading data bits. If the ack failed, we still
703 * need to clock through 16 cycles to keep the PHYs in sync.
706 for(i = 0; i < 16; i++) {
707 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
708 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
713 for (i = 0x8000; i; i >>= 1) {
714 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
716 if (tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MDATA)
717 frame->mii_data |= i;
719 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
724 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
725 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
727 /* Reenable interrupts */
729 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MINTEN);
739 static int tl_mii_writereg(sc, frame)
741 struct tl_mii_frame *frame;
751 * Set up frame for TX.
754 frame->mii_stdelim = TL_MII_STARTDELIM;
755 frame->mii_opcode = TL_MII_WRITEOP;
756 frame->mii_turnaround = TL_MII_TURNAROUND;
759 * Turn off MII interrupt by forcing MINTEN low.
761 minten = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MINTEN;
763 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MINTEN);
767 * Turn on data output.
769 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MTXEN);
771 tl_mii_send(sc, frame->mii_stdelim, 2);
772 tl_mii_send(sc, frame->mii_opcode, 2);
773 tl_mii_send(sc, frame->mii_phyaddr, 5);
774 tl_mii_send(sc, frame->mii_regaddr, 5);
775 tl_mii_send(sc, frame->mii_turnaround, 2);
776 tl_mii_send(sc, frame->mii_data, 16);
778 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
779 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
784 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MTXEN);
786 /* Reenable interrupts */
788 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MINTEN);
795 static int tl_miibus_readreg(dev, phy, reg)
800 struct tl_mii_frame frame;
802 sc = device_get_softc(dev);
803 bzero((char *)&frame, sizeof(frame));
805 frame.mii_phyaddr = phy;
806 frame.mii_regaddr = reg;
807 tl_mii_readreg(sc, &frame);
809 return(frame.mii_data);
812 static int tl_miibus_writereg(dev, phy, reg, data)
817 struct tl_mii_frame frame;
819 sc = device_get_softc(dev);
820 bzero((char *)&frame, sizeof(frame));
822 frame.mii_phyaddr = phy;
823 frame.mii_regaddr = reg;
824 frame.mii_data = data;
826 tl_mii_writereg(sc, &frame);
831 static void tl_miibus_statchg(dev)
835 struct mii_data *mii;
837 sc = device_get_softc(dev);
838 mii = device_get_softc(sc->tl_miibus);
840 if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX) {
841 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
843 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
850 * Set modes for bitrate devices.
852 static void tl_setmode(sc, media)
856 if (IFM_SUBTYPE(media) == IFM_10_5)
857 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_MTXD1);
858 if (IFM_SUBTYPE(media) == IFM_10_T) {
859 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_MTXD1);
860 if ((media & IFM_GMASK) == IFM_FDX) {
861 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_MTXD3);
862 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
864 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_MTXD3);
865 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
873 * Calculate the hash of a MAC address for programming the multicast hash
874 * table. This hash is simply the address split into 6-bit chunks
876 * byte: 000000|00 1111|1111 22|222222|333333|33 4444|4444 55|555555
877 * bit: 765432|10 7654|3210 76|543210|765432|10 7654|3210 76|543210
878 * Bytes 0-2 and 3-5 are symmetrical, so are folded together. Then
879 * the folded 24-bit value is split into 6-bit portions and XOR'd.
881 static int tl_calchash(addr)
886 t = (addr[0] ^ addr[3]) << 16 | (addr[1] ^ addr[4]) << 8 |
888 return ((t >> 18) ^ (t >> 12) ^ (t >> 6) ^ t) & 0x3f;
892 * The ThunderLAN has a perfect MAC address filter in addition to
893 * the multicast hash filter. The perfect filter can be programmed
894 * with up to four MAC addresses. The first one is always used to
895 * hold the station address, which leaves us free to use the other
896 * three for multicast addresses.
898 static void tl_setfilt(sc, addr, slot)
906 regaddr = TL_AREG0_B5 + (slot * ETHER_ADDR_LEN);
908 for (i = 0; i < ETHER_ADDR_LEN; i++)
909 tl_dio_write8(sc, regaddr + i, *(addr + i));
915 * XXX In FreeBSD 3.0, multicast addresses are managed using a doubly
916 * linked list. This is fine, except addresses are added from the head
917 * end of the list. We want to arrange for 224.0.0.1 (the "all hosts")
918 * group to always be in the perfect filter, but as more groups are added,
919 * the 224.0.0.1 entry (which is always added first) gets pushed down
920 * the list and ends up at the tail. So after 3 or 4 multicast groups
921 * are added, the all-hosts entry gets pushed out of the perfect filter
922 * and into the hash table.
924 * Because the multicast list is a doubly-linked list as opposed to a
925 * circular queue, we don't have the ability to just grab the tail of
926 * the list and traverse it backwards. Instead, we have to traverse
927 * the list once to find the tail, then traverse it again backwards to
928 * update the multicast filter.
930 static void tl_setmulti(sc)
934 u_int32_t hashes[2] = { 0, 0 };
936 struct ifmultiaddr *ifma;
937 u_int8_t dummy[] = { 0, 0, 0, 0, 0 ,0 };
938 ifp = &sc->arpcom.ac_if;
940 /* First, zot all the existing filters. */
941 for (i = 1; i < 4; i++)
942 tl_setfilt(sc, (caddr_t)&dummy, i);
943 tl_dio_write32(sc, TL_HASH1, 0);
944 tl_dio_write32(sc, TL_HASH2, 0);
946 /* Now program new ones. */
947 if (ifp->if_flags & IFF_ALLMULTI) {
948 hashes[0] = 0xFFFFFFFF;
949 hashes[1] = 0xFFFFFFFF;
952 /* First find the tail of the list. */
953 for (ifma = ifp->if_multiaddrs.lh_first; ifma != NULL;
954 ifma = ifma->ifma_link.le_next) {
955 if (ifma->ifma_link.le_next == NULL)
958 /* Now traverse the list backwards. */
959 for (; ifma != NULL && ifma != (void *)&ifp->if_multiaddrs;
960 ifma = (struct ifmultiaddr *)ifma->ifma_link.le_prev) {
961 if (ifma->ifma_addr->sa_family != AF_LINK)
964 * Program the first three multicast groups
965 * into the perfect filter. For all others,
966 * use the hash table.
970 LLADDR((struct sockaddr_dl *)ifma->ifma_addr), i);
976 LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
978 hashes[0] |= (1 << h);
980 hashes[1] |= (1 << (h - 32));
984 tl_dio_write32(sc, TL_HASH1, hashes[0]);
985 tl_dio_write32(sc, TL_HASH2, hashes[1]);
991 * This routine is recommended by the ThunderLAN manual to insure that
992 * the internal PHY is powered up correctly. It also recommends a one
993 * second pause at the end to 'wait for the clocks to start' but in my
994 * experience this isn't necessary.
996 static void tl_hardreset(dev)
1003 sc = device_get_softc(dev);
1007 flags = BMCR_LOOP|BMCR_ISO|BMCR_PDOWN;
1009 for (i = 0; i < MII_NPHY; i++)
1010 tl_miibus_writereg(dev, i, MII_BMCR, flags);
1012 tl_miibus_writereg(dev, 31, MII_BMCR, BMCR_ISO);
1014 tl_miibus_writereg(dev, 31, MII_BMCR, BMCR_LOOP|BMCR_ISO);
1016 while(tl_miibus_readreg(dev, 31, MII_BMCR) & BMCR_RESET);
1022 static void tl_softreset(sc, internal)
1023 struct tl_softc *sc;
1026 u_int32_t cmd, dummy, i;
1028 /* Assert the adapter reset bit. */
1029 CMD_SET(sc, TL_CMD_ADRST);
1031 /* Turn off interrupts */
1032 CMD_SET(sc, TL_CMD_INTSOFF);
1034 /* First, clear the stats registers. */
1035 for (i = 0; i < 5; i++)
1036 dummy = tl_dio_read32(sc, TL_TXGOODFRAMES);
1038 /* Clear Areg and Hash registers */
1039 for (i = 0; i < 8; i++)
1040 tl_dio_write32(sc, TL_AREG0_B5, 0x00000000);
1043 * Set up Netconfig register. Enable one channel and
1044 * one fragment mode.
1046 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_ONECHAN|TL_CFG_ONEFRAG);
1047 if (internal && !sc->tl_bitrate) {
1048 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_PHYEN);
1050 tl_dio_clrbit16(sc, TL_NETCONFIG, TL_CFG_PHYEN);
1053 /* Handle cards with bitrate devices. */
1055 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_BITRATE);
1058 * Load adapter irq pacing timer and tx threshold.
1059 * We make the transmit threshold 1 initially but we may
1060 * change that later.
1062 cmd = CSR_READ_4(sc, TL_HOSTCMD);
1064 cmd &= ~(TL_CMD_RT|TL_CMD_EOC|TL_CMD_ACK_MASK|TL_CMD_CHSEL_MASK);
1065 CMD_PUT(sc, cmd | (TL_CMD_LDTHR | TX_THR));
1066 CMD_PUT(sc, cmd | (TL_CMD_LDTMR | 0x00000003));
1068 /* Unreset the MII */
1069 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_NMRST);
1071 /* Take the adapter out of reset */
1072 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_NRESET|TL_CMD_NWRAP);
1074 /* Wait for things to settle down a little. */
1081 * Probe for a ThunderLAN chip. Check the PCI vendor and device IDs
1082 * against our list and return its name if we find a match.
1084 static int tl_probe(dev)
1091 while(t->tl_name != NULL) {
1092 if ((pci_get_vendor(dev) == t->tl_vid) &&
1093 (pci_get_device(dev) == t->tl_did)) {
1094 device_set_desc(dev, t->tl_name);
1103 static int tl_attach(dev)
1111 struct tl_softc *sc;
1112 int unit, error = 0, rid;
1116 vid = pci_get_vendor(dev);
1117 did = pci_get_device(dev);
1118 sc = device_get_softc(dev);
1119 unit = device_get_unit(dev);
1120 bzero(sc, sizeof(struct tl_softc));
1123 while(t->tl_name != NULL) {
1124 if (vid == t->tl_vid && did == t->tl_did)
1129 if (t->tl_name == NULL) {
1130 printf("tl%d: unknown device!?\n", unit);
1135 * Map control/status registers.
1137 command = pci_read_config(dev, PCIR_COMMAND, 4);
1138 command |= (PCIM_CMD_PORTEN|PCIM_CMD_MEMEN|PCIM_CMD_BUSMASTEREN);
1139 pci_write_config(dev, PCIR_COMMAND, command, 4);
1140 command = pci_read_config(dev, PCIR_COMMAND, 4);
1142 #ifdef TL_USEIOSPACE
1143 if (!(command & PCIM_CMD_PORTEN)) {
1144 printf("tl%d: failed to enable I/O ports!\n", unit);
1150 sc->tl_res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
1151 0, ~0, 1, RF_ACTIVE);
1154 * Some cards have the I/O and memory mapped address registers
1155 * reversed. Try both combinations before giving up.
1157 if (sc->tl_res == NULL) {
1159 sc->tl_res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
1160 0, ~0, 1, RF_ACTIVE);
1163 if (!(command & PCIM_CMD_MEMEN)) {
1164 printf("tl%d: failed to enable memory mapping!\n", unit);
1170 sc->tl_res = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid,
1171 0, ~0, 1, RF_ACTIVE);
1172 if (sc->tl_res == NULL) {
1174 sc->tl_res = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid,
1175 0, ~0, 1, RF_ACTIVE);
1179 if (sc->tl_res == NULL) {
1180 printf("tl%d: couldn't map ports/memory\n", unit);
1185 sc->tl_btag = rman_get_bustag(sc->tl_res);
1186 sc->tl_bhandle = rman_get_bushandle(sc->tl_res);
1190 * The ThunderLAN manual suggests jacking the PCI latency
1191 * timer all the way up to its maximum value. I'm not sure
1192 * if this is really necessary, but what the manual wants,
1195 command = pci_read_config(dev, TL_PCI_LATENCY_TIMER, 4);
1196 command |= 0x0000FF00;
1197 pci_write_config(dev, TL_PCI_LATENCY_TIMER, command, 4);
1200 /* Allocate interrupt */
1202 sc->tl_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
1203 RF_SHAREABLE | RF_ACTIVE);
1205 if (sc->tl_irq == NULL) {
1206 bus_release_resource(dev, TL_RES, TL_RID, sc->tl_res);
1207 printf("tl%d: couldn't map interrupt\n", unit);
1212 error = bus_setup_intr(dev, sc->tl_irq, INTR_TYPE_NET,
1213 tl_intr, sc, &sc->tl_intrhand);
1216 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->tl_irq);
1217 bus_release_resource(dev, TL_RES, TL_RID, sc->tl_res);
1218 printf("tl%d: couldn't set up irq\n", unit);
1223 * Now allocate memory for the TX and RX lists.
1225 sc->tl_ldata = contigmalloc(sizeof(struct tl_list_data), M_DEVBUF,
1226 M_NOWAIT, 0, 0xffffffff, PAGE_SIZE, 0);
1228 if (sc->tl_ldata == NULL) {
1229 bus_teardown_intr(dev, sc->tl_irq, sc->tl_intrhand);
1230 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->tl_irq);
1231 bus_release_resource(dev, TL_RES, TL_RID, sc->tl_res);
1232 printf("tl%d: no memory for list buffers!\n", unit);
1237 bzero(sc->tl_ldata, sizeof(struct tl_list_data));
1241 if (t->tl_vid == COMPAQ_VENDORID || t->tl_vid == TI_VENDORID)
1242 sc->tl_eeaddr = TL_EEPROM_EADDR;
1243 if (t->tl_vid == OLICOM_VENDORID)
1244 sc->tl_eeaddr = TL_EEPROM_EADDR_OC;
1246 /* Reset the adapter. */
1247 tl_softreset(sc, 1);
1249 tl_softreset(sc, 1);
1252 * Get station address from the EEPROM.
1254 if (tl_read_eeprom(sc, (caddr_t)&sc->arpcom.ac_enaddr,
1255 sc->tl_eeaddr, ETHER_ADDR_LEN)) {
1256 bus_teardown_intr(dev, sc->tl_irq, sc->tl_intrhand);
1257 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->tl_irq);
1258 bus_release_resource(dev, TL_RES, TL_RID, sc->tl_res);
1259 contigfree(sc->tl_ldata,
1260 sizeof(struct tl_list_data), M_DEVBUF);
1261 printf("tl%d: failed to read station address\n", unit);
1267 * XXX Olicom, in its desire to be different from the
1268 * rest of the world, has done strange things with the
1269 * encoding of the station address in the EEPROM. First
1270 * of all, they store the address at offset 0xF8 rather
1271 * than at 0x83 like the ThunderLAN manual suggests.
1272 * Second, they store the address in three 16-bit words in
1273 * network byte order, as opposed to storing it sequentially
1274 * like all the other ThunderLAN cards. In order to get
1275 * the station address in a form that matches what the Olicom
1276 * diagnostic utility specifies, we have to byte-swap each
1277 * word. To make things even more confusing, neither 00:00:28
1278 * nor 00:00:24 appear in the IEEE OUI database.
1280 if (sc->tl_dinfo->tl_vid == OLICOM_VENDORID) {
1281 for (i = 0; i < ETHER_ADDR_LEN; i += 2) {
1283 p = (u_int16_t *)&sc->arpcom.ac_enaddr[i];
1289 * A ThunderLAN chip was detected. Inform the world.
1291 printf("tl%d: Ethernet address: %6D\n", unit,
1292 sc->arpcom.ac_enaddr, ":");
1294 ifp = &sc->arpcom.ac_if;
1296 if_initname(ifp, "tl", sc->tl_unit);
1297 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
1298 ifp->if_ioctl = tl_ioctl;
1299 ifp->if_output = ether_output;
1300 ifp->if_start = tl_start;
1301 ifp->if_watchdog = tl_watchdog;
1302 ifp->if_init = tl_init;
1303 ifp->if_mtu = ETHERMTU;
1304 ifp->if_snd.ifq_maxlen = TL_TX_LIST_CNT - 1;
1305 callout_handle_init(&sc->tl_stat_ch);
1307 /* Reset the adapter again. */
1308 tl_softreset(sc, 1);
1310 tl_softreset(sc, 1);
1313 * Do MII setup. If no PHYs are found, then this is a
1314 * bitrate ThunderLAN chip that only supports 10baseT
1317 if (mii_phy_probe(dev, &sc->tl_miibus,
1318 tl_ifmedia_upd, tl_ifmedia_sts)) {
1319 struct ifmedia *ifm;
1321 ifmedia_init(&sc->ifmedia, 0, tl_ifmedia_upd, tl_ifmedia_sts);
1322 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T, 0, NULL);
1323 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T|IFM_HDX, 0, NULL);
1324 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T|IFM_FDX, 0, NULL);
1325 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_5, 0, NULL);
1326 ifmedia_set(&sc->ifmedia, IFM_ETHER|IFM_10_T);
1327 /* Reset again, this time setting bitrate mode. */
1328 tl_softreset(sc, 1);
1330 ifm->ifm_media = ifm->ifm_cur->ifm_media;
1331 tl_ifmedia_upd(ifp);
1335 * Call MI attach routine.
1337 ether_ifattach(ifp, sc->arpcom.ac_enaddr);
1344 static int tl_detach(dev)
1347 struct tl_softc *sc;
1353 sc = device_get_softc(dev);
1354 ifp = &sc->arpcom.ac_if;
1357 ether_ifdetach(ifp);
1359 bus_generic_detach(dev);
1360 device_delete_child(dev, sc->tl_miibus);
1362 contigfree(sc->tl_ldata, sizeof(struct tl_list_data), M_DEVBUF);
1364 ifmedia_removeall(&sc->ifmedia);
1366 bus_teardown_intr(dev, sc->tl_irq, sc->tl_intrhand);
1367 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->tl_irq);
1368 bus_release_resource(dev, TL_RES, TL_RID, sc->tl_res);
1376 * Initialize the transmit lists.
1378 static int tl_list_tx_init(sc)
1379 struct tl_softc *sc;
1381 struct tl_chain_data *cd;
1382 struct tl_list_data *ld;
1387 for (i = 0; i < TL_TX_LIST_CNT; i++) {
1388 cd->tl_tx_chain[i].tl_ptr = &ld->tl_tx_list[i];
1389 if (i == (TL_TX_LIST_CNT - 1))
1390 cd->tl_tx_chain[i].tl_next = NULL;
1392 cd->tl_tx_chain[i].tl_next = &cd->tl_tx_chain[i + 1];
1395 cd->tl_tx_free = &cd->tl_tx_chain[0];
1396 cd->tl_tx_tail = cd->tl_tx_head = NULL;
1403 * Initialize the RX lists and allocate mbufs for them.
1405 static int tl_list_rx_init(sc)
1406 struct tl_softc *sc;
1408 struct tl_chain_data *cd;
1409 struct tl_list_data *ld;
1415 for (i = 0; i < TL_RX_LIST_CNT; i++) {
1416 cd->tl_rx_chain[i].tl_ptr =
1417 (struct tl_list_onefrag *)&ld->tl_rx_list[i];
1418 if (tl_newbuf(sc, &cd->tl_rx_chain[i]) == ENOBUFS)
1420 if (i == (TL_RX_LIST_CNT - 1)) {
1421 cd->tl_rx_chain[i].tl_next = NULL;
1422 ld->tl_rx_list[i].tlist_fptr = 0;
1424 cd->tl_rx_chain[i].tl_next = &cd->tl_rx_chain[i + 1];
1425 ld->tl_rx_list[i].tlist_fptr =
1426 vtophys(&ld->tl_rx_list[i + 1]);
1430 cd->tl_rx_head = &cd->tl_rx_chain[0];
1431 cd->tl_rx_tail = &cd->tl_rx_chain[TL_RX_LIST_CNT - 1];
1436 static int tl_newbuf(sc, c)
1437 struct tl_softc *sc;
1438 struct tl_chain_onefrag *c;
1440 struct mbuf *m_new = NULL;
1442 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
1446 MCLGET(m_new, M_DONTWAIT);
1447 if (!(m_new->m_flags & M_EXT)) {
1458 c->tl_ptr->tlist_frsize = MCLBYTES;
1459 c->tl_ptr->tlist_fptr = 0;
1460 c->tl_ptr->tl_frag.tlist_dadr = vtophys(mtod(m_new, caddr_t));
1461 c->tl_ptr->tl_frag.tlist_dcnt = MCLBYTES;
1462 c->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1467 * Interrupt handler for RX 'end of frame' condition (EOF). This
1468 * tells us that a full ethernet frame has been captured and we need
1471 * Reception is done using 'lists' which consist of a header and a
1472 * series of 10 data count/data address pairs that point to buffers.
1473 * Initially you're supposed to create a list, populate it with pointers
1474 * to buffers, then load the physical address of the list into the
1475 * ch_parm register. The adapter is then supposed to DMA the received
1476 * frame into the buffers for you.
1478 * To make things as fast as possible, we have the chip DMA directly
1479 * into mbufs. This saves us from having to do a buffer copy: we can
1480 * just hand the mbufs directly to ether_input(). Once the frame has
1481 * been sent on its way, the 'list' structure is assigned a new buffer
1482 * and moved to the end of the RX chain. As long we we stay ahead of
1483 * the chip, it will always think it has an endless receive channel.
1485 * If we happen to fall behind and the chip manages to fill up all of
1486 * the buffers, it will generate an end of channel interrupt and wait
1487 * for us to empty the chain and restart the receiver.
1489 static int tl_intvec_rxeof(xsc, type)
1493 struct tl_softc *sc;
1494 int r = 0, total_len = 0;
1495 struct ether_header *eh;
1498 struct tl_chain_onefrag *cur_rx;
1501 ifp = &sc->arpcom.ac_if;
1503 while(sc->tl_cdata.tl_rx_head != NULL) {
1504 cur_rx = sc->tl_cdata.tl_rx_head;
1505 if (!(cur_rx->tl_ptr->tlist_cstat & TL_CSTAT_FRAMECMP))
1508 sc->tl_cdata.tl_rx_head = cur_rx->tl_next;
1509 m = cur_rx->tl_mbuf;
1510 total_len = cur_rx->tl_ptr->tlist_frsize;
1512 if (tl_newbuf(sc, cur_rx) == ENOBUFS) {
1514 cur_rx->tl_ptr->tlist_frsize = MCLBYTES;
1515 cur_rx->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1516 cur_rx->tl_ptr->tl_frag.tlist_dcnt = MCLBYTES;
1520 sc->tl_cdata.tl_rx_tail->tl_ptr->tlist_fptr =
1521 vtophys(cur_rx->tl_ptr);
1522 sc->tl_cdata.tl_rx_tail->tl_next = cur_rx;
1523 sc->tl_cdata.tl_rx_tail = cur_rx;
1525 eh = mtod(m, struct ether_header *);
1526 m->m_pkthdr.rcvif = ifp;
1529 * Note: when the ThunderLAN chip is in 'capture all
1530 * frames' mode, it will receive its own transmissions.
1531 * We drop don't need to process our own transmissions,
1532 * so we drop them here and continue.
1534 /*if (ifp->if_flags & IFF_PROMISC && */
1535 if (!bcmp(eh->ether_shost, sc->arpcom.ac_enaddr,
1541 /* Remove header from mbuf and pass it on. */
1542 m->m_pkthdr.len = m->m_len =
1543 total_len - sizeof(struct ether_header);
1544 m->m_data += sizeof(struct ether_header);
1545 ether_input(ifp, eh, m);
1552 * The RX-EOC condition hits when the ch_parm address hasn't been
1553 * initialized or the adapter reached a list with a forward pointer
1554 * of 0 (which indicates the end of the chain). In our case, this means
1555 * the card has hit the end of the receive buffer chain and we need to
1556 * empty out the buffers and shift the pointer back to the beginning again.
1558 static int tl_intvec_rxeoc(xsc, type)
1562 struct tl_softc *sc;
1564 struct tl_chain_data *cd;
1570 /* Flush out the receive queue and ack RXEOF interrupts. */
1571 r = tl_intvec_rxeof(xsc, type);
1572 CMD_PUT(sc, TL_CMD_ACK | r | (type & ~(0x00100000)));
1574 cd->tl_rx_head = &cd->tl_rx_chain[0];
1575 cd->tl_rx_tail = &cd->tl_rx_chain[TL_RX_LIST_CNT - 1];
1576 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(sc->tl_cdata.tl_rx_head->tl_ptr));
1577 r |= (TL_CMD_GO|TL_CMD_RT);
1581 static int tl_intvec_txeof(xsc, type)
1585 struct tl_softc *sc;
1587 struct tl_chain *cur_tx;
1592 * Go through our tx list and free mbufs for those
1593 * frames that have been sent.
1595 while (sc->tl_cdata.tl_tx_head != NULL) {
1596 cur_tx = sc->tl_cdata.tl_tx_head;
1597 if (!(cur_tx->tl_ptr->tlist_cstat & TL_CSTAT_FRAMECMP))
1599 sc->tl_cdata.tl_tx_head = cur_tx->tl_next;
1602 m_freem(cur_tx->tl_mbuf);
1603 cur_tx->tl_mbuf = NULL;
1605 cur_tx->tl_next = sc->tl_cdata.tl_tx_free;
1606 sc->tl_cdata.tl_tx_free = cur_tx;
1607 if (!cur_tx->tl_ptr->tlist_fptr)
1615 * The transmit end of channel interrupt. The adapter triggers this
1616 * interrupt to tell us it hit the end of the current transmit list.
1618 * A note about this: it's possible for a condition to arise where
1619 * tl_start() may try to send frames between TXEOF and TXEOC interrupts.
1620 * You have to avoid this since the chip expects things to go in a
1621 * particular order: transmit, acknowledge TXEOF, acknowledge TXEOC.
1622 * When the TXEOF handler is called, it will free all of the transmitted
1623 * frames and reset the tx_head pointer to NULL. However, a TXEOC
1624 * interrupt should be received and acknowledged before any more frames
1625 * are queued for transmission. If tl_statrt() is called after TXEOF
1626 * resets the tx_head pointer but _before_ the TXEOC interrupt arrives,
1627 * it could attempt to issue a transmit command prematurely.
1629 * To guard against this, tl_start() will only issue transmit commands
1630 * if the tl_txeoc flag is set, and only the TXEOC interrupt handler
1631 * can set this flag once tl_start() has cleared it.
1633 static int tl_intvec_txeoc(xsc, type)
1637 struct tl_softc *sc;
1642 ifp = &sc->arpcom.ac_if;
1644 /* Clear the timeout timer. */
1647 if (sc->tl_cdata.tl_tx_head == NULL) {
1648 ifp->if_flags &= ~IFF_OACTIVE;
1649 sc->tl_cdata.tl_tx_tail = NULL;
1653 /* First we have to ack the EOC interrupt. */
1654 CMD_PUT(sc, TL_CMD_ACK | 0x00000001 | type);
1655 /* Then load the address of the next TX list. */
1656 CSR_WRITE_4(sc, TL_CH_PARM,
1657 vtophys(sc->tl_cdata.tl_tx_head->tl_ptr));
1658 /* Restart TX channel. */
1659 cmd = CSR_READ_4(sc, TL_HOSTCMD);
1661 cmd |= TL_CMD_GO|TL_CMD_INTSON;
1669 static int tl_intvec_adchk(xsc, type)
1673 struct tl_softc *sc;
1678 printf("tl%d: adapter check: %x\n", sc->tl_unit,
1679 (unsigned int)CSR_READ_4(sc, TL_CH_PARM));
1681 tl_softreset(sc, 1);
1684 CMD_SET(sc, TL_CMD_INTSON);
1689 static int tl_intvec_netsts(xsc, type)
1693 struct tl_softc *sc;
1698 netsts = tl_dio_read16(sc, TL_NETSTS);
1699 tl_dio_write16(sc, TL_NETSTS, netsts);
1701 printf("tl%d: network status: %x\n", sc->tl_unit, netsts);
1706 static void tl_intr(xsc)
1709 struct tl_softc *sc;
1718 /* Disable interrupts */
1719 ints = CSR_READ_2(sc, TL_HOST_INT);
1720 CSR_WRITE_2(sc, TL_HOST_INT, ints);
1721 type = (ints << 16) & 0xFFFF0000;
1722 ivec = (ints & TL_VEC_MASK) >> 5;
1723 ints = (ints & TL_INT_MASK) >> 2;
1725 ifp = &sc->arpcom.ac_if;
1728 case (TL_INTR_INVALID):
1730 printf("tl%d: got an invalid interrupt!\n", sc->tl_unit);
1732 /* Re-enable interrupts but don't ack this one. */
1736 case (TL_INTR_TXEOF):
1737 r = tl_intvec_txeof((void *)sc, type);
1739 case (TL_INTR_TXEOC):
1740 r = tl_intvec_txeoc((void *)sc, type);
1742 case (TL_INTR_STATOFLOW):
1743 tl_stats_update(sc);
1746 case (TL_INTR_RXEOF):
1747 r = tl_intvec_rxeof((void *)sc, type);
1749 case (TL_INTR_DUMMY):
1750 printf("tl%d: got a dummy interrupt\n", sc->tl_unit);
1753 case (TL_INTR_ADCHK):
1755 r = tl_intvec_adchk((void *)sc, type);
1757 r = tl_intvec_netsts((void *)sc, type);
1759 case (TL_INTR_RXEOC):
1760 r = tl_intvec_rxeoc((void *)sc, type);
1763 printf("%s: bogus interrupt type\n", ifp->if_xname);
1767 /* Re-enable interrupts */
1769 CMD_PUT(sc, TL_CMD_ACK | r | type);
1772 if (ifp->if_snd.ifq_head != NULL)
1778 static void tl_stats_update(xsc)
1781 struct tl_softc *sc;
1783 struct tl_stats tl_stats;
1784 struct mii_data *mii;
1790 bzero((char *)&tl_stats, sizeof(struct tl_stats));
1793 ifp = &sc->arpcom.ac_if;
1795 p = (u_int32_t *)&tl_stats;
1797 CSR_WRITE_2(sc, TL_DIO_ADDR, TL_TXGOODFRAMES|TL_DIO_ADDR_INC);
1798 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1799 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1800 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1801 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1802 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1804 ifp->if_opackets += tl_tx_goodframes(tl_stats);
1805 ifp->if_collisions += tl_stats.tl_tx_single_collision +
1806 tl_stats.tl_tx_multi_collision;
1807 ifp->if_ipackets += tl_rx_goodframes(tl_stats);
1808 ifp->if_ierrors += tl_stats.tl_crc_errors + tl_stats.tl_code_errors +
1809 tl_rx_overrun(tl_stats);
1810 ifp->if_oerrors += tl_tx_underrun(tl_stats);
1812 if (tl_tx_underrun(tl_stats)) {
1814 tx_thresh = tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_TXTHRESH;
1815 if (tx_thresh != TL_AC_TXTHRESH_WHOLEPKT) {
1818 printf("tl%d: tx underrun -- increasing "
1819 "tx threshold to %d bytes\n", sc->tl_unit,
1820 (64 * (tx_thresh * 4)));
1821 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH);
1822 tl_dio_setbit(sc, TL_ACOMMIT, tx_thresh << 4);
1826 sc->tl_stat_ch = timeout(tl_stats_update, sc, hz);
1828 if (!sc->tl_bitrate) {
1829 mii = device_get_softc(sc->tl_miibus);
1839 * Encapsulate an mbuf chain in a list by coupling the mbuf data
1840 * pointers to the fragment pointers.
1842 static int tl_encap(sc, c, m_head)
1843 struct tl_softc *sc;
1845 struct mbuf *m_head;
1848 struct tl_frag *f = NULL;
1853 * Start packing the mbufs in this chain into
1854 * the fragment pointers. Stop when we run out
1855 * of fragments or hit the end of the mbuf chain.
1860 for (m = m_head, frag = 0; m != NULL; m = m->m_next) {
1861 if (m->m_len != 0) {
1862 if (frag == TL_MAXFRAGS)
1864 total_len+= m->m_len;
1865 c->tl_ptr->tl_frag[frag].tlist_dadr =
1866 vtophys(mtod(m, vm_offset_t));
1867 c->tl_ptr->tl_frag[frag].tlist_dcnt = m->m_len;
1873 * Handle special cases.
1874 * Special case #1: we used up all 10 fragments, but
1875 * we have more mbufs left in the chain. Copy the
1876 * data into an mbuf cluster. Note that we don't
1877 * bother clearing the values in the other fragment
1878 * pointers/counters; it wouldn't gain us anything,
1879 * and would waste cycles.
1882 struct mbuf *m_new = NULL;
1884 MGETHDR(m_new, M_DONTWAIT, MT_DATA);
1885 if (m_new == NULL) {
1886 printf("tl%d: no memory for tx list\n", sc->tl_unit);
1889 if (m_head->m_pkthdr.len > MHLEN) {
1890 MCLGET(m_new, M_DONTWAIT);
1891 if (!(m_new->m_flags & M_EXT)) {
1893 printf("tl%d: no memory for tx list\n",
1898 m_copydata(m_head, 0, m_head->m_pkthdr.len,
1899 mtod(m_new, caddr_t));
1900 m_new->m_pkthdr.len = m_new->m_len = m_head->m_pkthdr.len;
1903 f = &c->tl_ptr->tl_frag[0];
1904 f->tlist_dadr = vtophys(mtod(m_new, caddr_t));
1905 f->tlist_dcnt = total_len = m_new->m_len;
1910 * Special case #2: the frame is smaller than the minimum
1911 * frame size. We have to pad it to make the chip happy.
1913 if (total_len < TL_MIN_FRAMELEN) {
1914 if (frag == TL_MAXFRAGS)
1915 printf("tl%d: all frags filled but "
1916 "frame still to small!\n", sc->tl_unit);
1917 f = &c->tl_ptr->tl_frag[frag];
1918 f->tlist_dcnt = TL_MIN_FRAMELEN - total_len;
1919 f->tlist_dadr = vtophys(&sc->tl_ldata->tl_pad);
1920 total_len += f->tlist_dcnt;
1924 c->tl_mbuf = m_head;
1925 c->tl_ptr->tl_frag[frag - 1].tlist_dcnt |= TL_LAST_FRAG;
1926 c->tl_ptr->tlist_frsize = total_len;
1927 c->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1928 c->tl_ptr->tlist_fptr = 0;
1934 * Main transmit routine. To avoid having to do mbuf copies, we put pointers
1935 * to the mbuf data regions directly in the transmit lists. We also save a
1936 * copy of the pointers since the transmit list fragment pointers are
1937 * physical addresses.
1939 static void tl_start(ifp)
1942 struct tl_softc *sc;
1943 struct mbuf *m_head = NULL;
1945 struct tl_chain *prev = NULL, *cur_tx = NULL, *start_tx;
1950 * Check for an available queue slot. If there are none,
1953 if (sc->tl_cdata.tl_tx_free == NULL) {
1954 ifp->if_flags |= IFF_OACTIVE;
1958 start_tx = sc->tl_cdata.tl_tx_free;
1960 while(sc->tl_cdata.tl_tx_free != NULL) {
1961 IF_DEQUEUE(&ifp->if_snd, m_head);
1965 /* Pick a chain member off the free list. */
1966 cur_tx = sc->tl_cdata.tl_tx_free;
1967 sc->tl_cdata.tl_tx_free = cur_tx->tl_next;
1969 cur_tx->tl_next = NULL;
1971 /* Pack the data into the list. */
1972 tl_encap(sc, cur_tx, m_head);
1974 /* Chain it together */
1976 prev->tl_next = cur_tx;
1977 prev->tl_ptr->tlist_fptr = vtophys(cur_tx->tl_ptr);
1982 * If there's a BPF listener, bounce a copy of this frame
1986 bpf_mtap(ifp, cur_tx->tl_mbuf);
1990 * If there are no packets queued, bail.
1996 * That's all we can stands, we can't stands no more.
1997 * If there are no other transfers pending, then issue the
1998 * TX GO command to the adapter to start things moving.
1999 * Otherwise, just leave the data in the queue and let
2000 * the EOF/EOC interrupt handler send.
2002 if (sc->tl_cdata.tl_tx_head == NULL) {
2003 sc->tl_cdata.tl_tx_head = start_tx;
2004 sc->tl_cdata.tl_tx_tail = cur_tx;
2008 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(start_tx->tl_ptr));
2009 cmd = CSR_READ_4(sc, TL_HOSTCMD);
2011 cmd |= TL_CMD_GO|TL_CMD_INTSON;
2015 sc->tl_cdata.tl_tx_tail->tl_next = start_tx;
2016 sc->tl_cdata.tl_tx_tail = cur_tx;
2020 * Set a timeout in case the chip goes out to lunch.
2027 static void tl_init(xsc)
2030 struct tl_softc *sc = xsc;
2031 struct ifnet *ifp = &sc->arpcom.ac_if;
2033 struct mii_data *mii;
2037 ifp = &sc->arpcom.ac_if;
2040 * Cancel pending I/O.
2044 /* Initialize TX FIFO threshold */
2045 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH);
2046 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH_16LONG);
2048 /* Set PCI burst size */
2049 tl_dio_write8(sc, TL_BSIZEREG, TL_RXBURST_16LONG|TL_TXBURST_16LONG);
2052 * Set 'capture all frames' bit for promiscuous mode.
2054 if (ifp->if_flags & IFF_PROMISC)
2055 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_CAF);
2057 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_CAF);
2060 * Set capture broadcast bit to capture broadcast frames.
2062 if (ifp->if_flags & IFF_BROADCAST)
2063 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_NOBRX);
2065 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_NOBRX);
2067 tl_dio_write16(sc, TL_MAXRX, MCLBYTES);
2069 /* Init our MAC address */
2070 tl_setfilt(sc, (caddr_t)&sc->arpcom.ac_enaddr, 0);
2072 /* Init multicast filter, if needed. */
2075 /* Init circular RX list. */
2076 if (tl_list_rx_init(sc) == ENOBUFS) {
2077 printf("tl%d: initialization failed: no "
2078 "memory for rx buffers\n", sc->tl_unit);
2083 /* Init TX pointers. */
2084 tl_list_tx_init(sc);
2086 /* Enable PCI interrupts. */
2087 CMD_SET(sc, TL_CMD_INTSON);
2089 /* Load the address of the rx list */
2090 CMD_SET(sc, TL_CMD_RT);
2091 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(&sc->tl_ldata->tl_rx_list[0]));
2093 if (!sc->tl_bitrate) {
2094 if (sc->tl_miibus != NULL) {
2095 mii = device_get_softc(sc->tl_miibus);
2100 /* Send the RX go command */
2101 CMD_SET(sc, TL_CMD_GO|TL_CMD_NES|TL_CMD_RT);
2103 ifp->if_flags |= IFF_RUNNING;
2104 ifp->if_flags &= ~IFF_OACTIVE;
2108 /* Start the stats update counter */
2109 sc->tl_stat_ch = timeout(tl_stats_update, sc, hz);
2115 * Set media options.
2117 static int tl_ifmedia_upd(ifp)
2120 struct tl_softc *sc;
2121 struct mii_data *mii = NULL;
2126 tl_setmode(sc, sc->ifmedia.ifm_media);
2128 mii = device_get_softc(sc->tl_miibus);
2136 * Report current media status.
2138 static void tl_ifmedia_sts(ifp, ifmr)
2140 struct ifmediareq *ifmr;
2142 struct tl_softc *sc;
2143 struct mii_data *mii;
2147 ifmr->ifm_active = IFM_ETHER;
2149 if (sc->tl_bitrate) {
2150 if (tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_MTXD1)
2151 ifmr->ifm_active = IFM_ETHER|IFM_10_5;
2153 ifmr->ifm_active = IFM_ETHER|IFM_10_T;
2154 if (tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_MTXD3)
2155 ifmr->ifm_active |= IFM_HDX;
2157 ifmr->ifm_active |= IFM_FDX;
2160 mii = device_get_softc(sc->tl_miibus);
2162 ifmr->ifm_active = mii->mii_media_active;
2163 ifmr->ifm_status = mii->mii_media_status;
2169 static int tl_ioctl(ifp, command, data, cr)
2175 struct tl_softc *sc = ifp->if_softc;
2176 struct ifreq *ifr = (struct ifreq *) data;
2185 error = ether_ioctl(ifp, command, data);
2188 if (ifp->if_flags & IFF_UP) {
2189 if (ifp->if_flags & IFF_RUNNING &&
2190 ifp->if_flags & IFF_PROMISC &&
2191 !(sc->tl_if_flags & IFF_PROMISC)) {
2192 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_CAF);
2194 } else if (ifp->if_flags & IFF_RUNNING &&
2195 !(ifp->if_flags & IFF_PROMISC) &&
2196 sc->tl_if_flags & IFF_PROMISC) {
2197 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_CAF);
2202 if (ifp->if_flags & IFF_RUNNING) {
2206 sc->tl_if_flags = ifp->if_flags;
2217 error = ifmedia_ioctl(ifp, ifr, &sc->ifmedia, command);
2219 struct mii_data *mii;
2220 mii = device_get_softc(sc->tl_miibus);
2221 error = ifmedia_ioctl(ifp, ifr,
2222 &mii->mii_media, command);
2235 static void tl_watchdog(ifp)
2238 struct tl_softc *sc;
2242 printf("tl%d: device timeout\n", sc->tl_unit);
2246 tl_softreset(sc, 1);
2253 * Stop the adapter and free any mbufs allocated to the
2256 static void tl_stop(sc)
2257 struct tl_softc *sc;
2262 ifp = &sc->arpcom.ac_if;
2264 /* Stop the stats updater. */
2265 untimeout(tl_stats_update, sc, sc->tl_stat_ch);
2267 /* Stop the transmitter */
2268 CMD_CLR(sc, TL_CMD_RT);
2269 CMD_SET(sc, TL_CMD_STOP);
2270 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2272 /* Stop the receiver */
2273 CMD_SET(sc, TL_CMD_RT);
2274 CMD_SET(sc, TL_CMD_STOP);
2275 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2278 * Disable host interrupts.
2280 CMD_SET(sc, TL_CMD_INTSOFF);
2283 * Clear list pointer.
2285 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2288 * Free the RX lists.
2290 for (i = 0; i < TL_RX_LIST_CNT; i++) {
2291 if (sc->tl_cdata.tl_rx_chain[i].tl_mbuf != NULL) {
2292 m_freem(sc->tl_cdata.tl_rx_chain[i].tl_mbuf);
2293 sc->tl_cdata.tl_rx_chain[i].tl_mbuf = NULL;
2296 bzero((char *)&sc->tl_ldata->tl_rx_list,
2297 sizeof(sc->tl_ldata->tl_rx_list));
2300 * Free the TX list buffers.
2302 for (i = 0; i < TL_TX_LIST_CNT; i++) {
2303 if (sc->tl_cdata.tl_tx_chain[i].tl_mbuf != NULL) {
2304 m_freem(sc->tl_cdata.tl_tx_chain[i].tl_mbuf);
2305 sc->tl_cdata.tl_tx_chain[i].tl_mbuf = NULL;
2308 bzero((char *)&sc->tl_ldata->tl_tx_list,
2309 sizeof(sc->tl_ldata->tl_tx_list));
2311 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
2317 * Stop all chip I/O so that the kernel's probe routines don't
2318 * get confused by errant DMAs when rebooting.
2320 static void tl_shutdown(dev)
2323 struct tl_softc *sc;
2325 sc = device_get_softc(dev);