drivers/net/3c501.c

/* */
This source file includes following definitions.
el1_probe
el_open
el_start_xmit
el_interrupt
el_receive
el_reset
el1_close
el1_get_stats
set_multicast_list
init_module
cleanup_module
   1 /* 3c501.c: A 3Com 3c501 ethernet driver for linux. */
   2 /*
   3     Copyright (C) 1992,1993  Donald Becker
   4 
   5     Copyright 1993 United States Government as represented by the
   6     Director, National Security Agency.  This software may be used and
   7     distributed according to the terms of the GNU Public License,
   8     incorporated herein by reference.
   9 
  10     This is a device driver for the 3Com Etherlink 3c501.
  11     Do not purchase this card, even as a joke.  It's performance is horrible,
  12     and it breaks in many ways.  
  13 
  14     The Author may be reached as becker@super.org or
  15     C/O Supercomputing Research Ctr., 17100 Science Dr., Bowie MD 20715
  16     I'll only accept bug fixes, not reports, for the 3c501 driver.
  17 */
  18 
  19 static char *version =
  20     "3c501.c: 3/3/94 Donald Becker (becker@super.org).\n";
  21 
  22 /*
  23   Braindamage remaining:
  24   The 3c501 board.
  25   */
  26 
  27 #include <linux/config.h>
  28 #include <linux/kernel.h>
  29 #include <linux/sched.h>
  30 #include <linux/ptrace.h>
  31 #include <linux/fcntl.h>
  32 #include <linux/ioport.h>
  33 #include <linux/interrupt.h>
  34 #include <linux/malloc.h>
  35 #include <linux/ioport.h>
  36 #include <asm/bitops.h>
  37 #include <asm/io.h>
  38 #include <errno.h>
  39 
  40 #include <linux/netdevice.h>
  41 #include <linux/etherdevice.h>
  42 #include <linux/skbuff.h>
  43 
  44 #ifdef MODULE
  45 #include <linux/module.h>
  46 #include "../../tools/version.h"
  47 #endif
  48 
  49 #ifndef HAVE_AUTOIRQ
  50 /* From auto_irq.c, should be in a *.h file. */
  51 extern void autoirq_setup(int waittime);
  52 extern int autoirq_report(int waittime);
  53 extern struct device *irq2dev_map[16];
  54 #endif
  55 
  56 
  57 /* Index to functions. */
  58 int el1_probe(struct device *dev);
  59 static int  el_open(struct device *dev);
  60 static int  el_start_xmit(struct sk_buff *skb, struct device *dev);
  61 static void el_interrupt(int reg_ptr);
  62 static void el_receive(struct device *dev);
  63 static void el_reset(struct device *dev);
  64 static int  el1_close(struct device *dev);
  65 static struct enet_statistics *el1_get_stats(struct device *dev);
  66 static void set_multicast_list(struct device *dev, int num_addrs, void *addrs);
  67 
  68 #define EL_NAME "EtherLink 3c501"
  69 
  70 #ifndef EL_DEBUG
  71 #define EL_DEBUG  2     /* use 0 for production, 1 for devel., >2 for debug */
  72 #endif                  /* Anything above 5 is wordy death! */
  73 static int el_debug = EL_DEBUG;
  74 static int el_base;
  75 static struct device *eldev;    /* Only for consistency checking.  */
  76  
  77 /* We could easily have this struct kmalloc()ed per-board, but
  78    who would want more than one 3c501?. */
  79 static struct {
  80     struct enet_statistics stats;
  81     int tx_pkt_start;           /* The length of the current Tx packet. */
  82     int collisions;             /* Tx collisions this packet */
  83 } el_status;                    /* This should be stored per-board */
  84 
  85 
  86 #define RX_STATUS (el_base + 0x06)
  87 #define RX_CMD    RX_STATUS
  88 #define TX_STATUS (el_base + 0x07)
  89 #define TX_CMD    TX_STATUS
  90 #define GP_LOW    (el_base + 0x08)
  91 #define GP_HIGH   (el_base + 0x09)
  92 #define RX_BUF_CLR (el_base + 0x0A)
  93 #define RX_LOW    (el_base + 0x0A)
  94 #define RX_HIGH   (el_base + 0x0B)
  95 #define SAPROM    (el_base + 0x0C)
  96 #define AX_STATUS (el_base + 0x0E)
  97 #define AX_CMD    AX_STATUS
  98 #define DATAPORT  (el_base + 0x0F)
  99 #define TX_RDY 0x08             /* In TX_STATUS */
 100 
 101 #define EL1_DATAPTR     0x08
 102 #define EL1_RXPTR       0x0A
 103 #define EL1_SAPROM      0x0C
 104 #define EL1_DATAPORT    0x0f
 105 
 106 /* Writes to the ax command register. */
 107 #define AX_OFF  0x00                    /* Irq off, buffer access on */
 108 #define AX_SYS  0x40                    /* Load the buffer */
 109 #define AX_XMIT 0x44                    /* Transmit a packet */
 110 #define AX_RX   0x48                    /* Receive a packet */
 111 #define AX_LOOP 0x0C                    /* Loopback mode */
 112 #define AX_RESET 0x80
 113 
 114 /* Normal receive mode written to RX_STATUS.  We must intr on short packets
 115    to avoid bogus rx lockups. */
 116 #define RX_NORM 0xA8            /* 0x68 == all addrs, 0xA8 only to me. */
 117 #define RX_PROM 0x68            /* Senior Prom, uhmm promiscuous mode. */
 118 #define RX_MULT 0xE8            /* Accept multicast packets. */
 119 #define TX_NORM 0x0A    /* Interrupt on everything that might hang the chip */
 120 
 121 /* TX_STATUS register. */
 122 #define TX_COLLISION 0x02
 123 #define TX_16COLLISIONS 0x04
 124 #define TX_READY 0x08
 125 
 126 #define RX_RUNT 0x08
 127 #define RX_MISSED 0x01          /* Missed a packet due to 3c501 braindamage. */
 128 #define RX_GOOD 0x30            /* Good packet 0x20, or simple overflow 0x10. */
 129 
 130 
 131 int
 132 el1_probe(struct device *dev)
     /*  */
 133 {
 134     int i;
 135     int ioaddr;
 136     unsigned char station_addr[6];
 137     int autoirq = 0;
 138 
 139     eldev = dev;                /* Store for debugging. */
 140     el_base = dev->base_addr;
 141 
 142     if (el_base < 0x40)         /* Invalid?  Probe for it. */
 143         el_base = 0x280;
 144 
 145     ioaddr = el_base;
 146 
 147     /* Read the station address PROM data from the special port.  */
 148     for (i = 0; i < 6; i++) {
 149         outw(i, ioaddr + EL1_DATAPTR);
 150         station_addr[i] = inb(ioaddr + EL1_SAPROM);
 151     }
 152     /* Check the first three octets of the S.A. for 3Com's code. */ 
 153     if (station_addr[0] != 0x02  ||  station_addr[1] != 0x60
 154         || station_addr[2] != 0x8c) {
 155         return ENODEV;
 156     }
 157 
 158 #ifdef HAVE_PORTRESERVE
 159     /* Grab the region so we can find the another board if autoIRQ fails. */
 160     snarf_region(ioaddr, 16);
 161 #endif
 162 
 163     /* We auto-IRQ by shutting off the interrupt line and letting it float
 164        high. */
 165     if (dev->irq < 2) {
 166 
 167         autoirq_setup(2);
 168 
 169         inb(RX_STATUS);         /* Clear pending interrupts. */
 170         inb(TX_STATUS);
 171         outb(AX_LOOP + 1, AX_CMD);
 172 
 173         outb(0x00, AX_CMD);
 174 
 175         autoirq = autoirq_report(1);
 176 
 177         if (autoirq == 0) {
 178             printk("%s: 3c501 probe failed to detect IRQ line.\n", dev->name);
 179             return EAGAIN;
 180         }
 181         dev->irq = autoirq;
 182     }
 183 
 184     outb(AX_RESET+AX_LOOP, AX_CMD);                     /* Loopback mode. */
 185 
 186     dev->base_addr = el_base;
 187     memcpy(dev->dev_addr, station_addr, ETH_ALEN);
 188     if (dev->mem_start & 0xf)
 189         el_debug = dev->mem_start & 0x7;
 190 
 191     printk("%s: 3c501 EtherLink at %#x, using %sIRQ %d, melting ethernet.\n",
 192            dev->name, dev->base_addr, autoirq ? "auto":"assigned ", dev->irq);
 193 
 194     if (el_debug)
 195         printk("%s", version);
 196 
 197     /* The EL1-specific entries in the device structure. */
 198     dev->open = &el_open;
 199     dev->hard_start_xmit = &el_start_xmit;
 200     dev->stop = &el1_close;
 201     dev->get_stats = &el1_get_stats;
 202     dev->set_multicast_list = &set_multicast_list;
 203     /* Setup the generic properties */
 204     ether_setup(dev);
 205 
 206     return 0;
 207 }
 208 
 209 /* Open/initialize the board. */
 210 static int
 211 el_open(struct device *dev)
     /*  */
 212 {
 213 
 214   if (el_debug > 2)
 215       printk("%s: Doing el_open()...", dev->name);
 216 
 217   if (request_irq(dev->irq, &el_interrupt)) {
 218       if (el_debug > 2)
 219           printk("interrupt busy, exiting el_open().\n");
 220       return -EAGAIN;
 221   }
 222   irq2dev_map[dev->irq] = dev;
 223 
 224   el_reset(dev);
 225 
 226   dev->start = 1;
 227 
 228   outb(AX_RX, AX_CMD);  /* Aux control, irq and receive enabled */
 229   if (el_debug > 2)
 230      printk("finished el_open().\n");
 231 #ifdef MODULE
 232   MOD_INC_USE_COUNT;
 233 #endif       
 234   return (0);
 235 }
 236 
 237 static int
 238 el_start_xmit(struct sk_buff *skb, struct device *dev)
     /*  */
 239 {
 240 
 241     if (dev->tbusy) {
 242         if (jiffies - dev->trans_start < 20) {
 243             if (el_debug > 2)
 244                 printk(" transmitter busy, deferred.\n");
 245             return 1;
 246         }
 247         if (el_debug)
 248             printk ("%s: transmit timed out, txsr %#2x axsr=%02x rxsr=%02x.\n",
 249                     dev->name, inb(TX_STATUS), inb(AX_STATUS), inb(RX_STATUS));
 250         el_status.stats.tx_errors++;
 251 #ifdef oldway
 252         el_reset(dev);
 253 #else
 254         outb(TX_NORM, TX_CMD);
 255         outb(RX_NORM, RX_CMD);
 256         outb(AX_OFF, AX_CMD);   /* Just trigger a false interrupt. */
 257 #endif
 258         outb(AX_RX, AX_CMD);    /* Aux control, irq and receive enabled */
 259         dev->tbusy = 0;
 260         dev->trans_start = jiffies;
 261     }
 262 
 263     if (skb == NULL) {
 264         dev_tint(dev);
 265         return 0;
 266     }
 267 
 268     if (skb->len <= 0)
 269         return 0;
 270 
 271     /* Avoid timer-based retransmission conflicts. */
 272     if (set_bit(0, (void*)&dev->tbusy) != 0)
 273         printk("%s: Transmitter access conflict.\n", dev->name);
 274     else {
 275         int gp_start = 0x800 - (ETH_ZLEN < skb->len ? skb->len : ETH_ZLEN);
 276         unsigned char *buf = skb->data;
 277 
 278         el_status.tx_pkt_start = gp_start;
 279         el_status.collisions = 0;
 280 
 281         outb(AX_SYS, AX_CMD);
 282         inb(RX_STATUS);
 283         inb(TX_STATUS);
 284         outb(0x00, RX_BUF_CLR); /* Set rx packet area to 0. */
 285         outw(gp_start, GP_LOW);
 286         outsb(DATAPORT,buf,skb->len);
 287         outw(gp_start, GP_LOW);
 288         outb(AX_XMIT, AX_CMD);          /* Trigger xmit.  */
 289         dev->trans_start = jiffies;
 290     }
 291 
 292     if (el_debug > 2)
 293         printk(" queued xmit.\n");
 294     if (skb->free)
 295         kfree_skb (skb, FREE_WRITE);
 296     return 0;
 297 }
 298 
 299 
 300 /* The typical workload of the driver:
 301    Handle the ether interface interrupts. */
 302 static void
 303 el_interrupt(int reg_ptr)
     /*  */
 304 {
 305     int irq = -(((struct pt_regs *)reg_ptr)->orig_eax+2);
 306     /*struct device *dev = (struct device *)(irq2dev_map[irq]);*/
 307     struct device *dev = eldev;
 308     int axsr;                   /* Aux. status reg. */
 309     short ioaddr;
 310 
 311     if (eldev->irq != irq) {
 312         printk (EL_NAME ": irq %d for unknown device\n", irq);
 313         return;
 314     }
 315 
 316     ioaddr = dev->base_addr;
 317 
 318     axsr = inb(AX_STATUS);
 319 
 320     if (el_debug > 3)
 321       printk("%s: el_interrupt() aux=%#02x", dev->name, axsr);
 322     if (dev->interrupt)
 323         printk("%s: Reentering the interrupt driver!\n", dev->name);
 324     dev->interrupt = 1;
 325 
 326     if (dev->tbusy) {
 327         int txsr = inb(TX_STATUS);
 328 
 329         if (el_debug > 6)
 330             printk(" txsr=%02x gp=%04x rp=%04x", txsr, inw(GP_LOW),
 331                    inw(RX_LOW));
 332 
 333         if ((axsr & 0x80) && (txsr & TX_READY) == 0) {
 334             printk("%s: Unusual interrupt during Tx, txsr=%02x axsr=%02x"
 335                    " gp=%03x rp=%03x.\n", dev->name, txsr, axsr,
 336                    inw(ioaddr + EL1_DATAPTR), inw(ioaddr + EL1_RXPTR));
 337             dev->tbusy = 0;
 338             mark_bh(NET_BH);
 339         } else if (txsr & TX_16COLLISIONS) {
 340             if (el_debug)
 341                 printk("%s: Transmit failed 16 times, ethernet jammed?\n",
 342                        dev->name);
 343             outb(AX_SYS, AX_CMD);
 344             el_status.stats.tx_aborted_errors++;
 345         } else if (txsr & TX_COLLISION) {       /* Retrigger xmit. */
 346             if (el_debug > 6)
 347                 printk(" retransmitting after a collision.\n");
 348             outb(AX_SYS, AX_CMD);
 349             outw(el_status.tx_pkt_start, GP_LOW);
 350             outb(AX_XMIT, AX_CMD);
 351             el_status.stats.collisions++;
 352             dev->interrupt = 0;
 353             return;
 354         } else {
 355             el_status.stats.tx_packets++;
 356             if (el_debug > 6)
 357                 printk(" Tx succeeded %s\n",
 358                        (txsr & TX_RDY) ? "." : "but tx is busy!");
 359             dev->tbusy = 0;
 360             mark_bh(NET_BH);
 361         }
 362     } else {
 363         int rxsr = inb(RX_STATUS);
 364         if (el_debug > 5)
 365             printk(" rxsr=%02x txsr=%02x rp=%04x", rxsr, inb(TX_STATUS),
 366                    inw(RX_LOW));
 367 
 368         /* Just reading rx_status fixes most errors. */
 369         if (rxsr & RX_MISSED)
 370             el_status.stats.rx_missed_errors++;
 371         if (rxsr & RX_RUNT) {   /* Handled to avoid board lock-up. */
 372             el_status.stats.rx_length_errors++;
 373             if (el_debug > 5) printk(" runt.\n");
 374         } else if (rxsr & RX_GOOD) {
 375             el_receive(eldev);
 376         } else {                        /* Nothing?  Something is broken! */
 377             if (el_debug > 2)
 378                 printk("%s: No packet seen, rxsr=%02x **resetting 3c501***\n",
 379                        dev->name, rxsr);
 380             el_reset(eldev);
 381         }
 382         if (el_debug > 3)
 383             printk(".\n");
 384     }
 385 
 386     outb(AX_RX, AX_CMD);
 387     outb(0x00, RX_BUF_CLR);
 388     inb(RX_STATUS);             /* Be certain that interrupts are cleared. */
 389     inb(TX_STATUS);
 390     dev->interrupt = 0;
 391     return;
 392 }
 393 
 394 
 395 /* We have a good packet. Well, not really "good", just mostly not broken.
 396    We must check everything to see if it is good. */
 397 static void
 398 el_receive(struct device *dev)
     /*  */
 399 {
 400     int pkt_len;
 401     struct sk_buff *skb;
 402 
 403     pkt_len = inw(RX_LOW);
 404 
 405     if (el_debug > 4)
 406       printk(" el_receive %d.\n", pkt_len);
 407 
 408     if ((pkt_len < 60)  ||  (pkt_len > 1536)) {
 409         if (el_debug)
 410           printk("%s: bogus packet, length=%d\n", dev->name, pkt_len);
 411         el_status.stats.rx_over_errors++;
 412         return;
 413     }
 414     outb(AX_SYS, AX_CMD);
 415 
 416     skb = alloc_skb(pkt_len, GFP_ATOMIC);
 417     outw(0x00, GP_LOW);
 418     if (skb == NULL) {
 419         printk("%s: Memory squeeze, dropping packet.\n", dev->name);
 420         el_status.stats.rx_dropped++;
 421         return;
 422     } else {
 423         skb->len = pkt_len;
 424         skb->dev = dev;
 425 
 426         insb(DATAPORT, skb->data, pkt_len);
 427 
 428         netif_rx(skb);
 429         el_status.stats.rx_packets++;
 430     }
 431     return;
 432 }
 433 
 434 static void 
 435 el_reset(struct device *dev)
     /*  */
 436 {
 437     if (el_debug> 2)
 438         printk("3c501 reset...");
 439     outb(AX_RESET, AX_CMD);     /* Reset the chip */
 440     outb(AX_LOOP, AX_CMD);      /* Aux control, irq and loopback enabled */
 441     {
 442         int i;
 443         for (i = 0; i < 6; i++) /* Set the station address. */
 444             outb(dev->dev_addr[i], el_base + i);
 445     }
 446     
 447     outb(0, RX_BUF_CLR);                /* Set rx packet area to 0. */
 448     cli();                      /* Avoid glitch on writes to CMD regs */
 449     outb(TX_NORM, TX_CMD);              /* tx irq on done, collision */
 450     outb(RX_NORM, RX_CMD);      /* Set Rx commands. */
 451     inb(RX_STATUS);             /* Clear status. */
 452     inb(TX_STATUS);
 453     dev->interrupt = 0;
 454     dev->tbusy = 0;
 455     sti();
 456 }
 457 
 458 static int
 459 el1_close(struct device *dev)
     /*  */
 460 {
 461     int ioaddr = dev->base_addr;
 462 
 463     if (el_debug > 2)
 464         printk("%s: Shutting down ethercard at %#x.\n", dev->name, ioaddr);
 465 
 466     dev->tbusy = 1;
 467     dev->start = 0;
 468 
 469     /* Free and disable the IRQ. */
 470     free_irq(dev->irq);
 471     outb(AX_RESET, AX_CMD);     /* Reset the chip */
 472     irq2dev_map[dev->irq] = 0;
 473 
 474 #ifdef MODULE
 475     MOD_DEC_USE_COUNT;
 476 #endif    
 477     return 0;
 478 }
 479 
 480 static struct enet_statistics *
 481 el1_get_stats(struct device *dev)
     /*  */
 482 {
 483     return &el_status.stats;
 484 }
 485 
 486 /* Set or clear the multicast filter for this adaptor.
 487    num_addrs == -1      Promiscuous mode, receive all packets
 488    num_addrs == 0       Normal mode, clear multicast list
 489    num_addrs > 0        Multicast mode, receive normal and MC packets, and do
 490                         best-effort filtering.
 491  */
 492 static void
 493 set_multicast_list(struct device *dev, int num_addrs, void *addrs)
     /*  */
 494 {
 495     if (num_addrs > 0) {
 496         outb(RX_MULT, RX_CMD);
 497         inb(RX_STATUS);         /* Clear status. */
 498     } else if (num_addrs < 0) {
 499         outb(RX_PROM, RX_CMD);
 500         inb(RX_STATUS);
 501     } else {
 502         outb(RX_NORM, RX_CMD);
 503         inb(RX_STATUS);
 504     }
 505 }
 506 
 507 /*
 508  * Local variables:
 509  *  compile-command: "gcc -D__KERNEL__ -Wall -Wstrict-prototypes -O6 -fomit-frame-pointer  -m486 -c -o 3c501.o 3c501.c"
 510  *  kept-new-versions: 5
 511  * End:
 512  */
 513 
 514 #ifdef MODULE
 515 char kernel_version[] = UTS_RELEASE;
 516 static struct device dev_3c501 = {
 517         "" /*"3c501"*/, 
 518                 0, 0, 0, 0,
 519                 0x280, 7,
 520                 0, 0, 0, NULL, el1_probe };
 521         
 522 int
 523 init_module(void)
     /*  */
 524 {
 525         if (register_netdev(&dev_3c501) != 0)
 526                 return -EIO;
 527         return 0;
 528 }
 529 
 530 void
 531 cleanup_module(void)
     /*  */
 532 {
 533         if (MOD_IN_USE)
 534                 printk("3c501: device busy, remove delayed\n");
 535         else
 536         {
 537                 unregister_netdev(&dev_3c501);
 538         }
 539 }
 540 #endif /* MODULE */
/* */
root/drivers/net/3c501.c

DEFINITIONS
