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 $
36 * Texas Instruments ThunderLAN driver for FreeBSD 2.2.6 and 3.x.
37 * Supports many Compaq PCI NICs based on the ThunderLAN ethernet controller,
38 * the National Semiconductor DP83840A physical interface and the
39 * Microchip Technology 24Cxx series serial EEPROM.
41 * Written using the following four documents:
43 * Texas Instruments ThunderLAN Programmer's Guide (www.ti.com)
44 * National Semiconductor DP83840A data sheet (www.national.com)
45 * Microchip Technology 24C02C data sheet (www.microchip.com)
46 * Micro Linear ML6692 100BaseTX only PHY data sheet (www.microlinear.com)
48 * Written by Bill Paul <wpaul@ctr.columbia.edu>
49 * Electrical Engineering Department
50 * 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.
125 * Some notes about this driver:
127 * The ThunderLAN chip provides a couple of different ways to organize
128 * reception, transmission and interrupt handling. The simplest approach
129 * is to use one list each for transmission and reception. In this mode,
130 * the ThunderLAN will generate two interrupts for every received frame
131 * (one RX EOF and one RX EOC) and two for each transmitted frame (one
132 * TX EOF and one TX EOC). This may make the driver simpler but it hurts
133 * performance to have to handle so many interrupts.
135 * Initially I wanted to create a circular list of receive buffers so
136 * that the ThunderLAN chip would think there was an infinitely long
137 * receive channel and never deliver an RXEOC interrupt. However this
138 * doesn't work correctly under heavy load: while the manual says the
139 * chip will trigger an RXEOF interrupt each time a frame is copied into
140 * memory, you can't count on the chip waiting around for you to acknowledge
141 * the interrupt before it starts trying to DMA the next frame. The result
142 * is that the chip might traverse the entire circular list and then wrap
143 * around before you have a chance to do anything about it. Consequently,
144 * the receive list is terminated (with a 0 in the forward pointer in the
145 * last element). Each time an RXEOF interrupt arrives, the used list
146 * is shifted to the end of the list. This gives the appearance of an
147 * infinitely large RX chain so long as the driver doesn't fall behind
148 * the chip and allow all of the lists to be filled up.
150 * If all the lists are filled, the adapter will deliver an RX 'end of
151 * channel' interrupt when it hits the 0 forward pointer at the end of
152 * the chain. The RXEOC handler then cleans out the RX chain and resets
153 * the list head pointer in the ch_parm register and restarts the receiver.
155 * For frame transmission, it is possible to program the ThunderLAN's
156 * transmit interrupt threshold so that the chip can acknowledge multiple
157 * lists with only a single TX EOF interrupt. This allows the driver to
158 * queue several frames in one shot, and only have to handle a total
159 * two interrupts (one TX EOF and one TX EOC) no matter how many frames
160 * are transmitted. Frame transmission is done directly out of the
161 * mbufs passed to the tl_start() routine via the interface send queue.
162 * The driver simply sets up the fragment descriptors in the transmit
163 * lists to point to the mbuf data regions and sends a TX GO command.
165 * Note that since the RX and TX lists themselves are always used
166 * only by the driver, the are malloc()ed once at driver initialization
167 * time and never free()ed.
169 * Also, in order to remain as platform independent as possible, this
170 * driver uses memory mapped register access to manipulate the card
171 * as opposed to programmed I/O. This avoids the use of the inb/outb
172 * (and related) instructions which are specific to the i386 platform.
174 * Using these techniques, this driver achieves very high performance
175 * by minimizing the amount of interrupts generated during large
176 * transfers and by completely avoiding buffer copies. Frame transfer
177 * to and from the ThunderLAN chip is performed entirely by the chip
178 * itself thereby reducing the load on the host CPU.
181 #include <sys/param.h>
182 #include <sys/systm.h>
183 #include <sys/sockio.h>
184 #include <sys/mbuf.h>
185 #include <sys/malloc.h>
186 #include <sys/kernel.h>
187 #include <sys/socket.h>
188 #include <sys/serialize.h>
190 #include <sys/rman.h>
191 #include <sys/thread2.h>
192 #include <sys/interrupt.h>
195 #include <net/ifq_var.h>
196 #include <net/if_arp.h>
197 #include <net/ethernet.h>
198 #include <net/if_dl.h>
199 #include <net/if_media.h>
203 #include <vm/vm.h> /* for vtophys */
204 #include <vm/pmap.h> /* for vtophys */
206 #include "../mii_layer/mii.h"
207 #include "../mii_layer/miivar.h"
209 #include <bus/pci/pcireg.h>
210 #include <bus/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 "if_tlreg.h"
221 /* "controller miibus0" required. See GENERIC if you get errors here. */
222 #include "miibus_if.h"
225 * Various supported device vendors/types and their names.
228 static struct tl_type tl_devs[] = {
229 { TI_VENDORID, TI_DEVICEID_THUNDERLAN,
230 "Texas Instruments ThunderLAN" },
231 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10,
232 "Compaq Netelligent 10" },
233 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100,
234 "Compaq Netelligent 10/100" },
235 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_PROLIANT,
236 "Compaq Netelligent 10/100 Proliant" },
237 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_DUAL,
238 "Compaq Netelligent 10/100 Dual Port" },
239 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETFLEX_3P_INTEGRATED,
240 "Compaq NetFlex-3/P Integrated" },
241 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETFLEX_3P,
242 "Compaq NetFlex-3/P" },
243 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETFLEX_3P_BNC,
244 "Compaq NetFlex 3/P w/ BNC" },
245 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_EMBEDDED,
246 "Compaq Netelligent 10/100 TX Embedded UTP" },
247 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_T2_UTP_COAX,
248 "Compaq Netelligent 10 T/2 PCI UTP/Coax" },
249 { COMPAQ_VENDORID, COMPAQ_DEVICEID_NETEL_10_100_TX_UTP,
250 "Compaq Netelligent 10/100 TX UTP" },
251 { OLICOM_VENDORID, OLICOM_DEVICEID_OC2183,
252 "Olicom OC-2183/2185" },
253 { OLICOM_VENDORID, OLICOM_DEVICEID_OC2325,
255 { OLICOM_VENDORID, OLICOM_DEVICEID_OC2326,
256 "Olicom OC-2326 10/100 TX UTP" },
260 static int tl_probe (device_t);
261 static int tl_attach (device_t);
262 static int tl_detach (device_t);
263 static int tl_intvec_rxeoc (void *, u_int32_t);
264 static int tl_intvec_txeoc (void *, u_int32_t);
265 static int tl_intvec_txeof (void *, u_int32_t);
266 static int tl_intvec_rxeof (void *, u_int32_t);
267 static int tl_intvec_adchk (void *, u_int32_t);
268 static int tl_intvec_netsts (void *, u_int32_t);
270 static int tl_newbuf (struct tl_softc *,
271 struct tl_chain_onefrag *);
272 static void tl_stats_update (void *);
273 static void tl_stats_update_serialized(void *);
274 static int tl_encap (struct tl_softc *, struct tl_chain *,
277 static void tl_intr (void *);
278 static void tl_start (struct ifnet *);
279 static int tl_ioctl (struct ifnet *, u_long, caddr_t,
281 static void tl_init (void *);
282 static void tl_stop (struct tl_softc *);
283 static void tl_watchdog (struct ifnet *);
284 static void tl_shutdown (device_t);
285 static int tl_ifmedia_upd (struct ifnet *);
286 static void tl_ifmedia_sts (struct ifnet *, struct ifmediareq *);
288 static u_int8_t tl_eeprom_putbyte (struct tl_softc *, int);
289 static u_int8_t tl_eeprom_getbyte (struct tl_softc *,
291 static int tl_read_eeprom (struct tl_softc *, caddr_t, int, int);
293 static void tl_mii_sync (struct tl_softc *);
294 static void tl_mii_send (struct tl_softc *, u_int32_t, int);
295 static int tl_mii_readreg (struct tl_softc *, struct tl_mii_frame *);
296 static int tl_mii_writereg (struct tl_softc *, struct tl_mii_frame *);
297 static int tl_miibus_readreg (device_t, int, int);
298 static int tl_miibus_writereg (device_t, int, int, int);
299 static void tl_miibus_statchg (device_t);
301 static void tl_setmode (struct tl_softc *, int);
302 static int tl_calchash (caddr_t);
303 static void tl_setmulti (struct tl_softc *);
304 static void tl_setfilt (struct tl_softc *, caddr_t, int);
305 static void tl_softreset (struct tl_softc *, int);
306 static void tl_hardreset (device_t);
307 static int tl_list_rx_init (struct tl_softc *);
308 static int tl_list_tx_init (struct tl_softc *);
310 static u_int8_t tl_dio_read8 (struct tl_softc *, int);
311 static u_int16_t tl_dio_read16 (struct tl_softc *, int);
312 static u_int32_t tl_dio_read32 (struct tl_softc *, int);
313 static void tl_dio_write8 (struct tl_softc *, int, int);
314 static void tl_dio_write16 (struct tl_softc *, int, int);
315 static void tl_dio_write32 (struct tl_softc *, int, int);
316 static void tl_dio_setbit (struct tl_softc *, int, int);
317 static void tl_dio_clrbit (struct tl_softc *, int, int);
318 static void tl_dio_setbit16 (struct tl_softc *, int, int);
319 static void tl_dio_clrbit16 (struct tl_softc *, int, int);
322 #define TL_RES SYS_RES_IOPORT
323 #define TL_RID TL_PCI_LOIO
325 #define TL_RES SYS_RES_MEMORY
326 #define TL_RID TL_PCI_LOMEM
329 static device_method_t tl_methods[] = {
330 /* Device interface */
331 DEVMETHOD(device_probe, tl_probe),
332 DEVMETHOD(device_attach, tl_attach),
333 DEVMETHOD(device_detach, tl_detach),
334 DEVMETHOD(device_shutdown, tl_shutdown),
337 DEVMETHOD(bus_print_child, bus_generic_print_child),
338 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
341 DEVMETHOD(miibus_readreg, tl_miibus_readreg),
342 DEVMETHOD(miibus_writereg, tl_miibus_writereg),
343 DEVMETHOD(miibus_statchg, tl_miibus_statchg),
348 static driver_t tl_driver = {
351 sizeof(struct tl_softc)
354 static devclass_t tl_devclass;
356 DECLARE_DUMMY_MODULE(if_tl);
357 DRIVER_MODULE(if_tl, pci, tl_driver, tl_devclass, NULL, NULL);
358 DRIVER_MODULE(miibus, tl, miibus_driver, miibus_devclass, NULL, NULL);
361 tl_dio_read8(struct tl_softc *sc, int reg)
363 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
364 return(CSR_READ_1(sc, TL_DIO_DATA + (reg & 3)));
368 tl_dio_read16(struct tl_softc *sc, int reg)
370 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
371 return(CSR_READ_2(sc, TL_DIO_DATA + (reg & 3)));
375 tl_dio_read32(struct tl_softc *sc, int reg)
377 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
378 return(CSR_READ_4(sc, TL_DIO_DATA + (reg & 3)));
382 tl_dio_write8(struct tl_softc *sc, int reg, int val)
384 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
385 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), val);
390 tl_dio_write16(struct tl_softc *sc, int reg, int val)
392 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
393 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), val);
398 tl_dio_write32(struct tl_softc *sc, int reg, int val)
400 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
401 CSR_WRITE_4(sc, TL_DIO_DATA + (reg & 3), val);
406 tl_dio_setbit(struct tl_softc *sc, int reg, int bit)
410 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
411 f = CSR_READ_1(sc, TL_DIO_DATA + (reg & 3));
413 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), f);
419 tl_dio_clrbit(struct tl_softc *sc, int reg, int bit)
423 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
424 f = CSR_READ_1(sc, TL_DIO_DATA + (reg & 3));
426 CSR_WRITE_1(sc, TL_DIO_DATA + (reg & 3), f);
432 tl_dio_setbit16(struct tl_softc *sc, int reg, int bit)
436 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
437 f = CSR_READ_2(sc, TL_DIO_DATA + (reg & 3));
439 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), f);
445 tl_dio_clrbit16(struct tl_softc *sc, int reg, int bit)
449 CSR_WRITE_2(sc, TL_DIO_ADDR, reg);
450 f = CSR_READ_2(sc, TL_DIO_DATA + (reg & 3));
452 CSR_WRITE_2(sc, TL_DIO_DATA + (reg & 3), f);
458 * Send an instruction or address to the EEPROM, check for ACK.
461 tl_eeprom_putbyte(struct tl_softc *sc, int byte)
466 * Make sure we're in TX mode.
468 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ETXEN);
471 * Feed in each bit and stobe the clock.
473 for (i = 0x80; i; i >>= 1) {
475 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_EDATA);
477 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_EDATA);
480 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
482 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
488 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN);
493 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
494 ack = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_EDATA;
495 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
501 * Read a byte of data stored in the EEPROM at address 'addr.'
504 tl_eeprom_getbyte(struct tl_softc *sc, int addr, u_int8_t *dest)
509 tl_dio_write8(sc, TL_NETSIO, 0);
514 * Send write control code to EEPROM.
516 if (tl_eeprom_putbyte(sc, EEPROM_CTL_WRITE)) {
517 if_printf(&sc->arpcom.ac_if, "failed to send write command, "
518 "status: %x\n", tl_dio_read8(sc, TL_NETSIO));
523 * Send address of byte we want to read.
525 if (tl_eeprom_putbyte(sc, addr)) {
526 if_printf(&sc->arpcom.ac_if, "failed to send address, "
527 "status: %x\n", tl_dio_read8(sc, TL_NETSIO));
534 * Send read control code to EEPROM.
536 if (tl_eeprom_putbyte(sc, EEPROM_CTL_READ)) {
537 if_printf(&sc->arpcom.ac_if, "failed to send write command, "
538 "status: %x\n", tl_dio_read8(sc, TL_NETSIO));
543 * Start reading bits from EEPROM.
545 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ETXEN);
546 for (i = 0x80; i; i >>= 1) {
547 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_ECLOK);
549 if (tl_dio_read8(sc, TL_NETSIO) & TL_SIO_EDATA)
551 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_ECLOK);
558 * No ACK generated for read, so just return byte.
567 * Read a sequence of bytes from the EEPROM.
570 tl_read_eeprom(struct tl_softc *sc, caddr_t dest, int off, int cnt)
575 for (i = 0; i < cnt; i++) {
576 err = tl_eeprom_getbyte(sc, off + i, &byte);
586 tl_mii_sync(struct tl_softc *sc)
590 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MTXEN);
592 for (i = 0; i < 32; i++) {
593 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
594 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
601 tl_mii_send(struct tl_softc *sc, u_int32_t bits, int cnt)
605 for (i = (0x1 << (cnt - 1)); i; i >>= 1) {
606 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
608 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MDATA);
610 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MDATA);
612 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
617 tl_mii_readreg(struct tl_softc *sc, struct tl_mii_frame *frame)
625 * Set up frame for RX.
627 frame->mii_stdelim = TL_MII_STARTDELIM;
628 frame->mii_opcode = TL_MII_READOP;
629 frame->mii_turnaround = 0;
633 * Turn off MII interrupt by forcing MINTEN low.
635 minten = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MINTEN;
637 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MINTEN);
643 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MTXEN);
646 * Send command/address info.
648 tl_mii_send(sc, frame->mii_stdelim, 2);
649 tl_mii_send(sc, frame->mii_opcode, 2);
650 tl_mii_send(sc, frame->mii_phyaddr, 5);
651 tl_mii_send(sc, frame->mii_regaddr, 5);
656 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MTXEN);
659 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
660 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
663 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
664 ack = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MDATA;
666 /* Complete the cycle */
667 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
670 * Now try reading data bits. If the ack failed, we still
671 * need to clock through 16 cycles to keep the PHYs in sync.
674 for(i = 0; i < 16; i++) {
675 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
676 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
681 for (i = 0x8000; i; i >>= 1) {
682 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
684 if (tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MDATA)
685 frame->mii_data |= i;
687 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
692 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
693 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
695 /* Reenable interrupts */
697 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MINTEN);
706 tl_mii_writereg(struct tl_softc *sc, struct tl_mii_frame *frame)
713 * Set up frame for TX.
716 frame->mii_stdelim = TL_MII_STARTDELIM;
717 frame->mii_opcode = TL_MII_WRITEOP;
718 frame->mii_turnaround = TL_MII_TURNAROUND;
721 * Turn off MII interrupt by forcing MINTEN low.
723 minten = tl_dio_read8(sc, TL_NETSIO) & TL_SIO_MINTEN;
725 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MINTEN);
729 * Turn on data output.
731 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MTXEN);
733 tl_mii_send(sc, frame->mii_stdelim, 2);
734 tl_mii_send(sc, frame->mii_opcode, 2);
735 tl_mii_send(sc, frame->mii_phyaddr, 5);
736 tl_mii_send(sc, frame->mii_regaddr, 5);
737 tl_mii_send(sc, frame->mii_turnaround, 2);
738 tl_mii_send(sc, frame->mii_data, 16);
740 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MCLK);
741 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MCLK);
746 tl_dio_clrbit(sc, TL_NETSIO, TL_SIO_MTXEN);
748 /* Reenable interrupts */
750 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_MINTEN);
756 tl_miibus_readreg(device_t dev, int phy, int reg)
759 struct tl_mii_frame frame;
761 sc = device_get_softc(dev);
762 bzero((char *)&frame, sizeof(frame));
764 frame.mii_phyaddr = phy;
765 frame.mii_regaddr = reg;
766 tl_mii_readreg(sc, &frame);
768 return(frame.mii_data);
772 tl_miibus_writereg(device_t dev, int phy, int reg, int data)
775 struct tl_mii_frame frame;
777 sc = device_get_softc(dev);
778 bzero((char *)&frame, sizeof(frame));
780 frame.mii_phyaddr = phy;
781 frame.mii_regaddr = reg;
782 frame.mii_data = data;
784 tl_mii_writereg(sc, &frame);
790 tl_miibus_statchg(device_t dev)
793 struct mii_data *mii;
795 sc = device_get_softc(dev);
796 mii = device_get_softc(sc->tl_miibus);
798 if ((mii->mii_media_active & IFM_GMASK) == IFM_FDX) {
799 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
801 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
808 * Set modes for bitrate devices.
811 tl_setmode(struct tl_softc *sc, int media)
813 if (IFM_SUBTYPE(media) == IFM_10_5)
814 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_MTXD1);
815 if (IFM_SUBTYPE(media) == IFM_10_T) {
816 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_MTXD1);
817 if ((media & IFM_GMASK) == IFM_FDX) {
818 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_MTXD3);
819 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
821 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_MTXD3);
822 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_DUPLEX);
830 * Calculate the hash of a MAC address for programming the multicast hash
831 * table. This hash is simply the address split into 6-bit chunks
833 * byte: 000000|00 1111|1111 22|222222|333333|33 4444|4444 55|555555
834 * bit: 765432|10 7654|3210 76|543210|765432|10 7654|3210 76|543210
835 * Bytes 0-2 and 3-5 are symmetrical, so are folded together. Then
836 * the folded 24-bit value is split into 6-bit portions and XOR'd.
839 tl_calchash(caddr_t addr)
843 t = (addr[0] ^ addr[3]) << 16 | (addr[1] ^ addr[4]) << 8 |
845 return ((t >> 18) ^ (t >> 12) ^ (t >> 6) ^ t) & 0x3f;
849 * The ThunderLAN has a perfect MAC address filter in addition to
850 * the multicast hash filter. The perfect filter can be programmed
851 * with up to four MAC addresses. The first one is always used to
852 * hold the station address, which leaves us free to use the other
853 * three for multicast addresses.
856 tl_setfilt(struct tl_softc *sc, caddr_t addr, int slot)
861 regaddr = TL_AREG0_B5 + (slot * ETHER_ADDR_LEN);
863 for (i = 0; i < ETHER_ADDR_LEN; i++)
864 tl_dio_write8(sc, regaddr + i, *(addr + i));
870 * XXX In FreeBSD 3.0, multicast addresses are managed using a doubly
871 * linked list. This is fine, except addresses are added from the head
872 * end of the list. We want to arrange for 224.0.0.1 (the "all hosts")
873 * group to always be in the perfect filter, but as more groups are added,
874 * the 224.0.0.1 entry (which is always added first) gets pushed down
875 * the list and ends up at the tail. So after 3 or 4 multicast groups
876 * are added, the all-hosts entry gets pushed out of the perfect filter
877 * and into the hash table.
879 * Because the multicast list is a doubly-linked list as opposed to a
880 * circular queue, we don't have the ability to just grab the tail of
881 * the list and traverse it backwards. Instead, we have to traverse
882 * the list once to find the tail, then traverse it again backwards to
883 * update the multicast filter.
886 tl_setmulti(struct tl_softc *sc)
889 u_int32_t hashes[2] = { 0, 0 };
891 struct ifmultiaddr *ifma;
892 u_int8_t dummy[] = { 0, 0, 0, 0, 0 ,0 };
893 ifp = &sc->arpcom.ac_if;
895 /* First, zot all the existing filters. */
896 for (i = 1; i < 4; i++)
897 tl_setfilt(sc, (caddr_t)&dummy, i);
898 tl_dio_write32(sc, TL_HASH1, 0);
899 tl_dio_write32(sc, TL_HASH2, 0);
901 /* Now program new ones. */
902 if (ifp->if_flags & IFF_ALLMULTI) {
903 hashes[0] = 0xFFFFFFFF;
904 hashes[1] = 0xFFFFFFFF;
907 TAILQ_FOREACH_REVERSE(ifma, &ifp->if_multiaddrs, ifmultihead, ifma_link) {
908 if (ifma->ifma_addr->sa_family != AF_LINK)
911 * Program the first three multicast groups
912 * into the perfect filter. For all others,
913 * use the hash table.
917 LLADDR((struct sockaddr_dl *)ifma->ifma_addr), i);
923 LLADDR((struct sockaddr_dl *)ifma->ifma_addr));
925 hashes[0] |= (1 << h);
927 hashes[1] |= (1 << (h - 32));
931 tl_dio_write32(sc, TL_HASH1, hashes[0]);
932 tl_dio_write32(sc, TL_HASH2, hashes[1]);
938 * This routine is recommended by the ThunderLAN manual to insure that
939 * the internal PHY is powered up correctly. It also recommends a one
940 * second pause at the end to 'wait for the clocks to start' but in my
941 * experience this isn't necessary.
944 tl_hardreset(device_t dev)
950 sc = device_get_softc(dev);
954 flags = BMCR_LOOP|BMCR_ISO|BMCR_PDOWN;
956 for (i = 0; i < MII_NPHY; i++)
957 tl_miibus_writereg(dev, i, MII_BMCR, flags);
959 tl_miibus_writereg(dev, 31, MII_BMCR, BMCR_ISO);
961 tl_miibus_writereg(dev, 31, MII_BMCR, BMCR_LOOP|BMCR_ISO);
963 while(tl_miibus_readreg(dev, 31, MII_BMCR) & BMCR_RESET);
970 tl_softreset(struct tl_softc *sc, int internal)
972 u_int32_t cmd, dummy, i;
974 /* Assert the adapter reset bit. */
975 CMD_SET(sc, TL_CMD_ADRST);
977 /* Turn off interrupts */
978 CMD_SET(sc, TL_CMD_INTSOFF);
980 /* First, clear the stats registers. */
981 for (i = 0; i < 5; i++)
982 dummy = tl_dio_read32(sc, TL_TXGOODFRAMES);
984 /* Clear Areg and Hash registers */
985 for (i = 0; i < 8; i++)
986 tl_dio_write32(sc, TL_AREG0_B5, 0x00000000);
989 * Set up Netconfig register. Enable one channel and
992 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_ONECHAN|TL_CFG_ONEFRAG);
993 if (internal && !sc->tl_bitrate) {
994 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_PHYEN);
996 tl_dio_clrbit16(sc, TL_NETCONFIG, TL_CFG_PHYEN);
999 /* Handle cards with bitrate devices. */
1001 tl_dio_setbit16(sc, TL_NETCONFIG, TL_CFG_BITRATE);
1004 * Load adapter irq pacing timer and tx threshold.
1005 * We make the transmit threshold 1 initially but we may
1006 * change that later.
1008 cmd = CSR_READ_4(sc, TL_HOSTCMD);
1010 cmd &= ~(TL_CMD_RT|TL_CMD_EOC|TL_CMD_ACK_MASK|TL_CMD_CHSEL_MASK);
1011 CMD_PUT(sc, cmd | (TL_CMD_LDTHR | TX_THR));
1012 CMD_PUT(sc, cmd | (TL_CMD_LDTMR | 0x00000003));
1014 /* Unreset the MII */
1015 tl_dio_setbit(sc, TL_NETSIO, TL_SIO_NMRST);
1017 /* Take the adapter out of reset */
1018 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_NRESET|TL_CMD_NWRAP);
1020 /* Wait for things to settle down a little. */
1027 * Probe for a ThunderLAN chip. Check the PCI vendor and device IDs
1028 * against our list and return its name if we find a match.
1031 tl_probe(device_t dev)
1037 while(t->tl_name != NULL) {
1038 if ((pci_get_vendor(dev) == t->tl_vid) &&
1039 (pci_get_device(dev) == t->tl_did)) {
1040 device_set_desc(dev, t->tl_name);
1050 tl_attach(device_t dev)
1056 struct tl_softc *sc;
1058 uint8_t eaddr[ETHER_ADDR_LEN];
1060 vid = pci_get_vendor(dev);
1061 did = pci_get_device(dev);
1062 sc = device_get_softc(dev);
1065 while(t->tl_name != NULL) {
1066 if (vid == t->tl_vid && did == t->tl_did)
1071 KKASSERT(t->tl_name != NULL);
1073 pci_enable_busmaster(dev);
1075 #ifdef TL_USEIOSPACE
1077 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
1081 * Some cards have the I/O and memory mapped address registers
1082 * reversed. Try both combinations before giving up.
1084 if (sc->tl_res == NULL) {
1086 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
1091 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
1093 if (sc->tl_res == NULL) {
1095 sc->tl_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
1100 if (sc->tl_res == NULL) {
1101 device_printf(dev, "couldn't map ports/memory\n");
1106 sc->tl_btag = rman_get_bustag(sc->tl_res);
1107 sc->tl_bhandle = rman_get_bushandle(sc->tl_res);
1111 * The ThunderLAN manual suggests jacking the PCI latency
1112 * timer all the way up to its maximum value. I'm not sure
1113 * if this is really necessary, but what the manual wants,
1116 command = pci_read_config(dev, TL_PCI_LATENCY_TIMER, 4);
1117 command |= 0x0000FF00;
1118 pci_write_config(dev, TL_PCI_LATENCY_TIMER, command, 4);
1121 /* Allocate interrupt */
1123 sc->tl_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
1124 RF_SHAREABLE | RF_ACTIVE);
1126 if (sc->tl_irq == NULL) {
1127 device_printf(dev, "couldn't map interrupt\n");
1133 * Now allocate memory for the TX and RX lists.
1135 sc->tl_ldata = contigmalloc(sizeof(struct tl_list_data), M_DEVBUF,
1136 M_WAITOK | M_ZERO, 0, 0xffffffff, PAGE_SIZE, 0);
1138 if (sc->tl_ldata == NULL) {
1139 device_printf(dev, "no memory for list buffers!\n");
1145 if (t->tl_vid == COMPAQ_VENDORID || t->tl_vid == TI_VENDORID)
1146 sc->tl_eeaddr = TL_EEPROM_EADDR;
1147 if (t->tl_vid == OLICOM_VENDORID)
1148 sc->tl_eeaddr = TL_EEPROM_EADDR_OC;
1150 /* Reset the adapter. */
1151 tl_softreset(sc, 1);
1153 tl_softreset(sc, 1);
1155 ifp = &sc->arpcom.ac_if;
1156 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
1159 * Get station address from the EEPROM.
1161 if (tl_read_eeprom(sc, eaddr, sc->tl_eeaddr, ETHER_ADDR_LEN)) {
1162 device_printf(dev, "failed to read station address\n");
1168 * XXX Olicom, in its desire to be different from the
1169 * rest of the world, has done strange things with the
1170 * encoding of the station address in the EEPROM. First
1171 * of all, they store the address at offset 0xF8 rather
1172 * than at 0x83 like the ThunderLAN manual suggests.
1173 * Second, they store the address in three 16-bit words in
1174 * network byte order, as opposed to storing it sequentially
1175 * like all the other ThunderLAN cards. In order to get
1176 * the station address in a form that matches what the Olicom
1177 * diagnostic utility specifies, we have to byte-swap each
1178 * word. To make things even more confusing, neither 00:00:28
1179 * nor 00:00:24 appear in the IEEE OUI database.
1181 if (sc->tl_dinfo->tl_vid == OLICOM_VENDORID) {
1182 for (i = 0; i < ETHER_ADDR_LEN; i += 2) {
1184 p = (u_int16_t *)&eaddr[i];
1190 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
1191 ifp->if_ioctl = tl_ioctl;
1192 ifp->if_start = tl_start;
1193 ifp->if_watchdog = tl_watchdog;
1194 ifp->if_init = tl_init;
1195 ifp->if_mtu = ETHERMTU;
1196 ifq_set_maxlen(&ifp->if_snd, TL_TX_LIST_CNT - 1);
1197 ifq_set_ready(&ifp->if_snd);
1198 callout_init(&sc->tl_stat_timer);
1200 /* Reset the adapter again. */
1201 tl_softreset(sc, 1);
1203 tl_softreset(sc, 1);
1206 * Do MII setup. If no PHYs are found, then this is a
1207 * bitrate ThunderLAN chip that only supports 10baseT
1210 if (mii_phy_probe(dev, &sc->tl_miibus,
1211 tl_ifmedia_upd, tl_ifmedia_sts)) {
1212 struct ifmedia *ifm;
1214 ifmedia_init(&sc->ifmedia, 0, tl_ifmedia_upd, tl_ifmedia_sts);
1215 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T, 0, NULL);
1216 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T|IFM_HDX, 0, NULL);
1217 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_T|IFM_FDX, 0, NULL);
1218 ifmedia_add(&sc->ifmedia, IFM_ETHER|IFM_10_5, 0, NULL);
1219 ifmedia_set(&sc->ifmedia, IFM_ETHER|IFM_10_T);
1220 /* Reset again, this time setting bitrate mode. */
1221 tl_softreset(sc, 1);
1223 ifm->ifm_media = ifm->ifm_cur->ifm_media;
1224 tl_ifmedia_upd(ifp);
1228 * Call MI attach routine.
1230 ether_ifattach(ifp, eaddr, NULL);
1232 error = bus_setup_intr(dev, sc->tl_irq, INTR_MPSAFE,
1233 tl_intr, sc, &sc->tl_intrhand,
1234 ifp->if_serializer);
1237 ether_ifdetach(ifp);
1238 device_printf(dev, "couldn't set up irq\n");
1242 ifp->if_cpuid = ithread_cpuid(rman_get_start(sc->tl_irq));
1243 KKASSERT(ifp->if_cpuid >= 0 && ifp->if_cpuid < ncpus);
1253 tl_detach(device_t dev)
1255 struct tl_softc *sc = device_get_softc(dev);
1256 struct ifnet *ifp = &sc->arpcom.ac_if;
1258 if (device_is_attached(dev)) {
1259 lwkt_serialize_enter(ifp->if_serializer);
1261 bus_teardown_intr(dev, sc->tl_irq, sc->tl_intrhand);
1262 lwkt_serialize_exit(ifp->if_serializer);
1264 ether_ifdetach(ifp);
1268 device_delete_child(dev, sc->tl_miibus);
1269 bus_generic_detach(dev);
1272 contigfree(sc->tl_ldata, sizeof(struct tl_list_data), M_DEVBUF);
1274 ifmedia_removeall(&sc->ifmedia);
1276 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->tl_irq);
1278 bus_release_resource(dev, TL_RES, TL_RID, sc->tl_res);
1284 * Initialize the transmit lists.
1287 tl_list_tx_init(struct tl_softc *sc)
1289 struct tl_chain_data *cd;
1290 struct tl_list_data *ld;
1295 for (i = 0; i < TL_TX_LIST_CNT; i++) {
1296 cd->tl_tx_chain[i].tl_ptr = &ld->tl_tx_list[i];
1297 if (i == (TL_TX_LIST_CNT - 1))
1298 cd->tl_tx_chain[i].tl_next = NULL;
1300 cd->tl_tx_chain[i].tl_next = &cd->tl_tx_chain[i + 1];
1303 cd->tl_tx_free = &cd->tl_tx_chain[0];
1304 cd->tl_tx_tail = cd->tl_tx_head = NULL;
1311 * Initialize the RX lists and allocate mbufs for them.
1314 tl_list_rx_init(struct tl_softc *sc)
1316 struct tl_chain_data *cd;
1317 struct tl_list_data *ld;
1323 for (i = 0; i < TL_RX_LIST_CNT; i++) {
1324 cd->tl_rx_chain[i].tl_ptr =
1325 (struct tl_list_onefrag *)&ld->tl_rx_list[i];
1326 if (tl_newbuf(sc, &cd->tl_rx_chain[i]) == ENOBUFS)
1328 if (i == (TL_RX_LIST_CNT - 1)) {
1329 cd->tl_rx_chain[i].tl_next = NULL;
1330 ld->tl_rx_list[i].tlist_fptr = 0;
1332 cd->tl_rx_chain[i].tl_next = &cd->tl_rx_chain[i + 1];
1333 ld->tl_rx_list[i].tlist_fptr =
1334 vtophys(&ld->tl_rx_list[i + 1]);
1338 cd->tl_rx_head = &cd->tl_rx_chain[0];
1339 cd->tl_rx_tail = &cd->tl_rx_chain[TL_RX_LIST_CNT - 1];
1345 tl_newbuf(struct tl_softc *sc, struct tl_chain_onefrag *c)
1349 m_new = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
1355 c->tl_ptr->tlist_frsize = MCLBYTES;
1356 c->tl_ptr->tlist_fptr = 0;
1357 c->tl_ptr->tl_frag.tlist_dadr = vtophys(mtod(m_new, caddr_t));
1358 c->tl_ptr->tl_frag.tlist_dcnt = MCLBYTES;
1359 c->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1365 * Interrupt handler for RX 'end of frame' condition (EOF). This
1366 * tells us that a full ethernet frame has been captured and we need
1369 * Reception is done using 'lists' which consist of a header and a
1370 * series of 10 data count/data address pairs that point to buffers.
1371 * Initially you're supposed to create a list, populate it with pointers
1372 * to buffers, then load the physical address of the list into the
1373 * ch_parm register. The adapter is then supposed to DMA the received
1374 * frame into the buffers for you.
1376 * To make things as fast as possible, we have the chip DMA directly
1377 * into mbufs. This saves us from having to do a buffer copy: we can
1378 * just hand the mbufs directly to ether_input(). Once the frame has
1379 * been sent on its way, the 'list' structure is assigned a new buffer
1380 * and moved to the end of the RX chain. As long we we stay ahead of
1381 * the chip, it will always think it has an endless receive channel.
1383 * If we happen to fall behind and the chip manages to fill up all of
1384 * the buffers, it will generate an end of channel interrupt and wait
1385 * for us to empty the chain and restart the receiver.
1388 tl_intvec_rxeof(void *xsc, u_int32_t type)
1390 struct tl_softc *sc;
1391 int r = 0, total_len = 0;
1392 struct ether_header *eh;
1395 struct tl_chain_onefrag *cur_rx;
1398 ifp = &sc->arpcom.ac_if;
1400 while(sc->tl_cdata.tl_rx_head != NULL) {
1401 cur_rx = sc->tl_cdata.tl_rx_head;
1402 if (!(cur_rx->tl_ptr->tlist_cstat & TL_CSTAT_FRAMECMP))
1405 sc->tl_cdata.tl_rx_head = cur_rx->tl_next;
1406 m = cur_rx->tl_mbuf;
1407 total_len = cur_rx->tl_ptr->tlist_frsize;
1409 if (tl_newbuf(sc, cur_rx) == ENOBUFS) {
1411 cur_rx->tl_ptr->tlist_frsize = MCLBYTES;
1412 cur_rx->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1413 cur_rx->tl_ptr->tl_frag.tlist_dcnt = MCLBYTES;
1417 sc->tl_cdata.tl_rx_tail->tl_ptr->tlist_fptr =
1418 vtophys(cur_rx->tl_ptr);
1419 sc->tl_cdata.tl_rx_tail->tl_next = cur_rx;
1420 sc->tl_cdata.tl_rx_tail = cur_rx;
1422 eh = mtod(m, struct ether_header *);
1423 m->m_pkthdr.rcvif = ifp;
1424 m->m_pkthdr.len = m->m_len = total_len;
1427 * Note: when the ThunderLAN chip is in 'capture all
1428 * frames' mode, it will receive its own transmissions.
1429 * We drop don't need to process our own transmissions,
1430 * so we drop them here and continue.
1432 /*if (ifp->if_flags & IFF_PROMISC && */
1433 if (!bcmp(eh->ether_shost, sc->arpcom.ac_enaddr,
1439 ifp->if_input(ifp, m);
1446 * The RX-EOC condition hits when the ch_parm address hasn't been
1447 * initialized or the adapter reached a list with a forward pointer
1448 * of 0 (which indicates the end of the chain). In our case, this means
1449 * the card has hit the end of the receive buffer chain and we need to
1450 * empty out the buffers and shift the pointer back to the beginning again.
1453 tl_intvec_rxeoc(void *xsc, u_int32_t type)
1455 struct tl_softc *sc;
1457 struct tl_chain_data *cd;
1463 /* Flush out the receive queue and ack RXEOF interrupts. */
1464 r = tl_intvec_rxeof(xsc, type);
1465 CMD_PUT(sc, TL_CMD_ACK | r | (type & ~(0x00100000)));
1467 cd->tl_rx_head = &cd->tl_rx_chain[0];
1468 cd->tl_rx_tail = &cd->tl_rx_chain[TL_RX_LIST_CNT - 1];
1469 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(sc->tl_cdata.tl_rx_head->tl_ptr));
1470 r |= (TL_CMD_GO|TL_CMD_RT);
1475 tl_intvec_txeof(void *xsc, u_int32_t type)
1477 struct tl_softc *sc;
1479 struct tl_chain *cur_tx;
1484 * Go through our tx list and free mbufs for those
1485 * frames that have been sent.
1487 while (sc->tl_cdata.tl_tx_head != NULL) {
1488 cur_tx = sc->tl_cdata.tl_tx_head;
1489 if (!(cur_tx->tl_ptr->tlist_cstat & TL_CSTAT_FRAMECMP))
1491 sc->tl_cdata.tl_tx_head = cur_tx->tl_next;
1494 m_freem(cur_tx->tl_mbuf);
1495 cur_tx->tl_mbuf = NULL;
1497 cur_tx->tl_next = sc->tl_cdata.tl_tx_free;
1498 sc->tl_cdata.tl_tx_free = cur_tx;
1499 if (!cur_tx->tl_ptr->tlist_fptr)
1507 * The transmit end of channel interrupt. The adapter triggers this
1508 * interrupt to tell us it hit the end of the current transmit list.
1510 * A note about this: it's possible for a condition to arise where
1511 * tl_start() may try to send frames between TXEOF and TXEOC interrupts.
1512 * You have to avoid this since the chip expects things to go in a
1513 * particular order: transmit, acknowledge TXEOF, acknowledge TXEOC.
1514 * When the TXEOF handler is called, it will free all of the transmitted
1515 * frames and reset the tx_head pointer to NULL. However, a TXEOC
1516 * interrupt should be received and acknowledged before any more frames
1517 * are queued for transmission. If tl_statrt() is called after TXEOF
1518 * resets the tx_head pointer but _before_ the TXEOC interrupt arrives,
1519 * it could attempt to issue a transmit command prematurely.
1521 * To guard against this, tl_start() will only issue transmit commands
1522 * if the tl_txeoc flag is set, and only the TXEOC interrupt handler
1523 * can set this flag once tl_start() has cleared it.
1526 tl_intvec_txeoc(void *xsc, u_int32_t type)
1528 struct tl_softc *sc;
1533 ifp = &sc->arpcom.ac_if;
1535 /* Clear the timeout timer. */
1538 if (sc->tl_cdata.tl_tx_head == NULL) {
1539 ifp->if_flags &= ~IFF_OACTIVE;
1540 sc->tl_cdata.tl_tx_tail = NULL;
1544 /* First we have to ack the EOC interrupt. */
1545 CMD_PUT(sc, TL_CMD_ACK | 0x00000001 | type);
1546 /* Then load the address of the next TX list. */
1547 CSR_WRITE_4(sc, TL_CH_PARM,
1548 vtophys(sc->tl_cdata.tl_tx_head->tl_ptr));
1549 /* Restart TX channel. */
1550 cmd = CSR_READ_4(sc, TL_HOSTCMD);
1552 cmd |= TL_CMD_GO|TL_CMD_INTSON;
1561 tl_intvec_adchk(void *xsc, u_int32_t type)
1563 struct tl_softc *sc;
1568 if_printf(&sc->arpcom.ac_if, "adapter check: %x\n",
1569 (unsigned int)CSR_READ_4(sc, TL_CH_PARM));
1572 tl_softreset(sc, 1);
1575 CMD_SET(sc, TL_CMD_INTSON);
1581 tl_intvec_netsts(void *xsc, u_int32_t type)
1583 struct tl_softc *sc;
1588 netsts = tl_dio_read16(sc, TL_NETSTS);
1589 tl_dio_write16(sc, TL_NETSTS, netsts);
1591 if_printf(&sc->arpcom.ac_if, "network status: %x\n", netsts);
1599 struct tl_softc *sc;
1608 /* Disable interrupts */
1609 ints = CSR_READ_2(sc, TL_HOST_INT);
1610 CSR_WRITE_2(sc, TL_HOST_INT, ints);
1611 type = (ints << 16) & 0xFFFF0000;
1612 ivec = (ints & TL_VEC_MASK) >> 5;
1613 ints = (ints & TL_INT_MASK) >> 2;
1615 ifp = &sc->arpcom.ac_if;
1618 case (TL_INTR_INVALID):
1620 if_printf(ifp, "got an invalid interrupt!\n");
1622 /* Re-enable interrupts but don't ack this one. */
1626 case (TL_INTR_TXEOF):
1627 r = tl_intvec_txeof((void *)sc, type);
1629 case (TL_INTR_TXEOC):
1630 r = tl_intvec_txeoc((void *)sc, type);
1632 case (TL_INTR_STATOFLOW):
1633 tl_stats_update_serialized(sc);
1636 case (TL_INTR_RXEOF):
1637 r = tl_intvec_rxeof((void *)sc, type);
1639 case (TL_INTR_DUMMY):
1640 if_printf(ifp, "got a dummy interrupt\n");
1643 case (TL_INTR_ADCHK):
1645 r = tl_intvec_adchk((void *)sc, type);
1647 r = tl_intvec_netsts((void *)sc, type);
1649 case (TL_INTR_RXEOC):
1650 r = tl_intvec_rxeoc((void *)sc, type);
1653 if_printf(ifp, "bogus interrupt type\n");
1657 /* Re-enable interrupts */
1659 CMD_PUT(sc, TL_CMD_ACK | r | type);
1662 if (!ifq_is_empty(&ifp->if_snd))
1668 tl_stats_update(void *xsc)
1670 struct tl_softc *sc = xsc;
1671 struct ifnet *ifp = &sc->arpcom.ac_if;
1673 lwkt_serialize_enter(ifp->if_serializer);
1674 tl_stats_update_serialized(xsc);
1675 lwkt_serialize_exit(ifp->if_serializer);
1680 tl_stats_update_serialized(void *xsc)
1682 struct tl_softc *sc;
1684 struct tl_stats tl_stats;
1685 struct mii_data *mii;
1688 bzero((char *)&tl_stats, sizeof(struct tl_stats));
1691 ifp = &sc->arpcom.ac_if;
1693 p = (u_int32_t *)&tl_stats;
1695 CSR_WRITE_2(sc, TL_DIO_ADDR, TL_TXGOODFRAMES|TL_DIO_ADDR_INC);
1696 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1697 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1698 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1699 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1700 *p++ = CSR_READ_4(sc, TL_DIO_DATA);
1702 ifp->if_opackets += tl_tx_goodframes(tl_stats);
1703 ifp->if_collisions += tl_stats.tl_tx_single_collision +
1704 tl_stats.tl_tx_multi_collision;
1705 ifp->if_ipackets += tl_rx_goodframes(tl_stats);
1706 ifp->if_ierrors += tl_stats.tl_crc_errors + tl_stats.tl_code_errors +
1707 tl_rx_overrun(tl_stats);
1708 ifp->if_oerrors += tl_tx_underrun(tl_stats);
1710 if (tl_tx_underrun(tl_stats)) {
1712 tx_thresh = tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_TXTHRESH;
1713 if (tx_thresh != TL_AC_TXTHRESH_WHOLEPKT) {
1716 if_printf(ifp, "tx underrun -- increasing "
1717 "tx threshold to %d bytes\n",
1718 (64 * (tx_thresh * 4)));
1719 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH);
1720 tl_dio_setbit(sc, TL_ACOMMIT, tx_thresh << 4);
1724 callout_reset(&sc->tl_stat_timer, hz, tl_stats_update, sc);
1726 if (!sc->tl_bitrate) {
1727 mii = device_get_softc(sc->tl_miibus);
1733 * Encapsulate an mbuf chain in a list by coupling the mbuf data
1734 * pointers to the fragment pointers.
1737 tl_encap(struct tl_softc *sc, struct tl_chain *c, struct mbuf *m_head)
1740 struct tl_frag *f = NULL;
1745 * Start packing the mbufs in this chain into
1746 * the fragment pointers. Stop when we run out
1747 * of fragments or hit the end of the mbuf chain.
1751 for (m = m_head, frag = 0; m != NULL; m = m->m_next) {
1752 if (m->m_len != 0) {
1753 if (frag == TL_MAXFRAGS)
1755 total_len+= m->m_len;
1756 c->tl_ptr->tl_frag[frag].tlist_dadr =
1757 vtophys(mtod(m, vm_offset_t));
1758 c->tl_ptr->tl_frag[frag].tlist_dcnt = m->m_len;
1764 * Handle special cases.
1765 * Special case #1: we used up all 10 fragments, but
1766 * we have more mbufs left in the chain. Copy the
1767 * data into an mbuf cluster. Note that we don't
1768 * bother clearing the values in the other fragment
1769 * pointers/counters; it wouldn't gain us anything,
1770 * and would waste cycles.
1775 m_new = m_getl(m_head->m_pkthdr.len, MB_DONTWAIT, MT_DATA,
1777 if (m_new == NULL) {
1778 if_printf(&sc->arpcom.ac_if, "no memory for tx list\n");
1781 m_copydata(m_head, 0, m_head->m_pkthdr.len,
1782 mtod(m_new, caddr_t));
1783 m_new->m_pkthdr.len = m_new->m_len = m_head->m_pkthdr.len;
1786 f = &c->tl_ptr->tl_frag[0];
1787 f->tlist_dadr = vtophys(mtod(m_new, caddr_t));
1788 f->tlist_dcnt = total_len = m_new->m_len;
1793 * Special case #2: the frame is smaller than the minimum
1794 * frame size. We have to pad it to make the chip happy.
1796 if (total_len < TL_MIN_FRAMELEN) {
1797 if (frag == TL_MAXFRAGS) {
1798 if_printf(&sc->arpcom.ac_if, "all frags filled but "
1799 "frame still to small!\n");
1801 f = &c->tl_ptr->tl_frag[frag];
1802 f->tlist_dcnt = TL_MIN_FRAMELEN - total_len;
1803 f->tlist_dadr = vtophys(&sc->tl_ldata->tl_pad);
1804 total_len += f->tlist_dcnt;
1808 c->tl_mbuf = m_head;
1809 c->tl_ptr->tl_frag[frag - 1].tlist_dcnt |= TL_LAST_FRAG;
1810 c->tl_ptr->tlist_frsize = total_len;
1811 c->tl_ptr->tlist_cstat = TL_CSTAT_READY;
1812 c->tl_ptr->tlist_fptr = 0;
1818 * Main transmit routine. To avoid having to do mbuf copies, we put pointers
1819 * to the mbuf data regions directly in the transmit lists. We also save a
1820 * copy of the pointers since the transmit list fragment pointers are
1821 * physical addresses.
1824 tl_start(struct ifnet *ifp)
1826 struct tl_softc *sc;
1827 struct mbuf *m_head = NULL;
1829 struct tl_chain *prev = NULL, *cur_tx = NULL, *start_tx;
1834 * Check for an available queue slot. If there are none,
1837 if (sc->tl_cdata.tl_tx_free == NULL) {
1838 ifp->if_flags |= IFF_OACTIVE;
1842 start_tx = sc->tl_cdata.tl_tx_free;
1844 while(sc->tl_cdata.tl_tx_free != NULL) {
1845 m_head = ifq_dequeue(&ifp->if_snd, NULL);
1849 /* Pick a chain member off the free list. */
1850 cur_tx = sc->tl_cdata.tl_tx_free;
1851 sc->tl_cdata.tl_tx_free = cur_tx->tl_next;
1853 cur_tx->tl_next = NULL;
1855 /* Pack the data into the list. */
1856 tl_encap(sc, cur_tx, m_head);
1858 /* Chain it together */
1860 prev->tl_next = cur_tx;
1861 prev->tl_ptr->tlist_fptr = vtophys(cur_tx->tl_ptr);
1865 BPF_MTAP(ifp, cur_tx->tl_mbuf);
1869 * If there are no packets queued, bail.
1875 * That's all we can stands, we can't stands no more.
1876 * If there are no other transfers pending, then issue the
1877 * TX GO command to the adapter to start things moving.
1878 * Otherwise, just leave the data in the queue and let
1879 * the EOF/EOC interrupt handler send.
1881 if (sc->tl_cdata.tl_tx_head == NULL) {
1882 sc->tl_cdata.tl_tx_head = start_tx;
1883 sc->tl_cdata.tl_tx_tail = cur_tx;
1887 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(start_tx->tl_ptr));
1888 cmd = CSR_READ_4(sc, TL_HOSTCMD);
1890 cmd |= TL_CMD_GO|TL_CMD_INTSON;
1894 sc->tl_cdata.tl_tx_tail->tl_next = start_tx;
1895 sc->tl_cdata.tl_tx_tail = cur_tx;
1899 * Set a timeout in case the chip goes out to lunch.
1909 struct tl_softc *sc = xsc;
1910 struct ifnet *ifp = &sc->arpcom.ac_if;
1911 struct mii_data *mii;
1914 * Cancel pending I/O.
1918 /* Initialize TX FIFO threshold */
1919 tl_dio_clrbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH);
1920 tl_dio_setbit(sc, TL_ACOMMIT, TL_AC_TXTHRESH_16LONG);
1922 /* Set PCI burst size */
1923 tl_dio_write8(sc, TL_BSIZEREG, TL_RXBURST_16LONG|TL_TXBURST_16LONG);
1926 * Set 'capture all frames' bit for promiscuous mode.
1928 if (ifp->if_flags & IFF_PROMISC)
1929 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_CAF);
1931 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_CAF);
1934 * Set capture broadcast bit to capture broadcast frames.
1936 if (ifp->if_flags & IFF_BROADCAST)
1937 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_NOBRX);
1939 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_NOBRX);
1941 tl_dio_write16(sc, TL_MAXRX, MCLBYTES);
1943 /* Init our MAC address */
1944 tl_setfilt(sc, (caddr_t)&sc->arpcom.ac_enaddr, 0);
1946 /* Init multicast filter, if needed. */
1949 /* Init circular RX list. */
1950 if (tl_list_rx_init(sc) == ENOBUFS) {
1951 if_printf(ifp, "initialization failed: no "
1952 "memory for rx buffers\n");
1957 /* Init TX pointers. */
1958 tl_list_tx_init(sc);
1960 /* Enable PCI interrupts. */
1961 CMD_SET(sc, TL_CMD_INTSON);
1963 /* Load the address of the rx list */
1964 CMD_SET(sc, TL_CMD_RT);
1965 CSR_WRITE_4(sc, TL_CH_PARM, vtophys(&sc->tl_ldata->tl_rx_list[0]));
1967 if (!sc->tl_bitrate) {
1968 if (sc->tl_miibus != NULL) {
1969 mii = device_get_softc(sc->tl_miibus);
1974 /* Send the RX go command */
1975 CMD_SET(sc, TL_CMD_GO|TL_CMD_NES|TL_CMD_RT);
1977 ifp->if_flags |= IFF_RUNNING;
1978 ifp->if_flags &= ~IFF_OACTIVE;
1980 /* Start the stats update counter */
1981 callout_reset(&sc->tl_stat_timer, hz, tl_stats_update, sc);
1985 * Set media options.
1988 tl_ifmedia_upd(struct ifnet *ifp)
1990 struct tl_softc *sc;
1991 struct mii_data *mii = NULL;
1996 tl_setmode(sc, sc->ifmedia.ifm_media);
1998 mii = device_get_softc(sc->tl_miibus);
2006 * Report current media status.
2009 tl_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
2011 struct tl_softc *sc;
2012 struct mii_data *mii;
2016 ifmr->ifm_active = IFM_ETHER;
2018 if (sc->tl_bitrate) {
2019 if (tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_MTXD1)
2020 ifmr->ifm_active = IFM_ETHER|IFM_10_5;
2022 ifmr->ifm_active = IFM_ETHER|IFM_10_T;
2023 if (tl_dio_read8(sc, TL_ACOMMIT) & TL_AC_MTXD3)
2024 ifmr->ifm_active |= IFM_HDX;
2026 ifmr->ifm_active |= IFM_FDX;
2029 mii = device_get_softc(sc->tl_miibus);
2031 ifmr->ifm_active = mii->mii_media_active;
2032 ifmr->ifm_status = mii->mii_media_status;
2039 tl_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
2041 struct tl_softc *sc = ifp->if_softc;
2042 struct ifreq *ifr = (struct ifreq *) data;
2047 if (ifp->if_flags & IFF_UP) {
2048 if (ifp->if_flags & IFF_RUNNING &&
2049 ifp->if_flags & IFF_PROMISC &&
2050 !(sc->tl_if_flags & IFF_PROMISC)) {
2051 tl_dio_setbit(sc, TL_NETCMD, TL_CMD_CAF);
2053 } else if (ifp->if_flags & IFF_RUNNING &&
2054 !(ifp->if_flags & IFF_PROMISC) &&
2055 sc->tl_if_flags & IFF_PROMISC) {
2056 tl_dio_clrbit(sc, TL_NETCMD, TL_CMD_CAF);
2061 if (ifp->if_flags & IFF_RUNNING) {
2065 sc->tl_if_flags = ifp->if_flags;
2076 error = ifmedia_ioctl(ifp, ifr, &sc->ifmedia, command);
2078 struct mii_data *mii;
2079 mii = device_get_softc(sc->tl_miibus);
2080 error = ifmedia_ioctl(ifp, ifr,
2081 &mii->mii_media, command);
2085 error = ether_ioctl(ifp, command, data);
2092 tl_watchdog(struct ifnet *ifp)
2094 struct tl_softc *sc;
2098 if_printf(ifp, "device timeout\n");
2102 tl_softreset(sc, 1);
2109 * Stop the adapter and free any mbufs allocated to the
2113 tl_stop(struct tl_softc *sc)
2118 ifp = &sc->arpcom.ac_if;
2120 /* Stop the stats updater. */
2121 callout_stop(&sc->tl_stat_timer);
2123 /* Stop the transmitter */
2124 CMD_CLR(sc, TL_CMD_RT);
2125 CMD_SET(sc, TL_CMD_STOP);
2126 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2128 /* Stop the receiver */
2129 CMD_SET(sc, TL_CMD_RT);
2130 CMD_SET(sc, TL_CMD_STOP);
2131 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2134 * Disable host interrupts.
2136 CMD_SET(sc, TL_CMD_INTSOFF);
2139 * Clear list pointer.
2141 CSR_WRITE_4(sc, TL_CH_PARM, 0);
2144 * Free the RX lists.
2146 for (i = 0; i < TL_RX_LIST_CNT; i++) {
2147 if (sc->tl_cdata.tl_rx_chain[i].tl_mbuf != NULL) {
2148 m_freem(sc->tl_cdata.tl_rx_chain[i].tl_mbuf);
2149 sc->tl_cdata.tl_rx_chain[i].tl_mbuf = NULL;
2152 bzero((char *)&sc->tl_ldata->tl_rx_list,
2153 sizeof(sc->tl_ldata->tl_rx_list));
2156 * Free the TX list buffers.
2158 for (i = 0; i < TL_TX_LIST_CNT; i++) {
2159 if (sc->tl_cdata.tl_tx_chain[i].tl_mbuf != NULL) {
2160 m_freem(sc->tl_cdata.tl_tx_chain[i].tl_mbuf);
2161 sc->tl_cdata.tl_tx_chain[i].tl_mbuf = NULL;
2164 bzero((char *)&sc->tl_ldata->tl_tx_list,
2165 sizeof(sc->tl_ldata->tl_tx_list));
2167 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
2173 * Stop all chip I/O so that the kernel's probe routines don't
2174 * get confused by errant DMAs when rebooting.
2177 tl_shutdown(device_t dev)
2179 struct tl_softc *sc;
2181 sc = device_get_softc(dev);