drivers/net/arcnet/com90io.c

   1 /*
   2  * Linux ARCnet driver - COM90xx chipset (IO-mapped buffers)
   3  *
   4  * Written 1997 by David Woodhouse.
   5  * Written 1994-1999 by Avery Pennarun.
   6  * Written 1999-2000 by Martin Mares <mj@ucw.cz>.
   7  * Derived from skeleton.c by Donald Becker.
   8  *
   9  * Special thanks to Contemporary Controls, Inc. (www.ccontrols.com)
  10  *  for sponsoring the further development of this driver.
  11  *
  12  * **********************
  13  *
  14  * The original copyright of skeleton.c was as follows:
  15  *
  16  * skeleton.c Written 1993 by Donald Becker.
  17  * Copyright 1993 United States Government as represented by the
  18  * Director, National Security Agency.  This software may only be used
  19  * and distributed according to the terms of the GNU General Public License as
  20  * modified by SRC, incorporated herein by reference.
  21  *
  22  * **********************
  23  *
  24  * For more details, see drivers/net/arcnet.c
  25  *
  26  * **********************
  27  */
  28 #include <linux/kernel.h>
  29 #include <linux/module.h>
  30 #include <linux/moduleparam.h>
  31 #include <linux/ioport.h>
  32 #include <linux/delay.h>
  33 #include <linux/netdevice.h>
  34 #include <linux/bootmem.h>
  35 #include <linux/init.h>
  36 #include <linux/interrupt.h>
  37 #include <linux/io.h>
  38 #include <linux/arcdevice.h>
  39
  40 #define VERSION "arcnet: COM90xx IO-mapped mode support (by David Woodhouse et el.)\n"
  41
  42 /* Internal function declarations */
  43
  44 static int com90io_found(struct net_device *dev);
  45 static void com90io_command(struct net_device *dev, int command);
  46 static int com90io_status(struct net_device *dev);
  47 static void com90io_setmask(struct net_device *dev, int mask);
  48 static int com90io_reset(struct net_device *dev, int really_reset);
  49 static void com90io_copy_to_card(struct net_device *dev, int bufnum, int offset,
  50                                  void *buf, int count);
  51 static void com90io_copy_from_card(struct net_device *dev, int bufnum, int offset,
  52                                    void *buf, int count);
  53
  54 /* Handy defines for ARCnet specific stuff */
  55
  56 /* The number of low I/O ports used by the card. */
  57 #define ARCNET_TOTAL_SIZE 16
  58
  59 /* COM 9026 controller chip --> ARCnet register addresses */
  60 #define _INTMASK        (ioaddr + 0)    /* writable */
  61 #define _STATUS         (ioaddr + 0)    /* readable */
  62 #define _COMMAND        (ioaddr + 1)    /* writable, returns random vals on read (?) */
  63 #define _RESET          (ioaddr + 8)    /* software reset (on read) */
  64 #define _MEMDATA        (ioaddr + 12)   /* Data port for IO-mapped memory */
  65 #define _ADDR_HI        (ioaddr + 15)   /* Control registers for said */
  66 #define _ADDR_LO        (ioaddr + 14)
  67 #define _CONFIG         (ioaddr + 2)    /* Configuration register */
  68
  69 #undef ASTATUS
  70 #undef ACOMMAND
  71 #undef AINTMASK
  72
  73 #define ASTATUS()       inb(_STATUS)
  74 #define ACOMMAND(cmd)   outb((cmd), _COMMAND)
  75 #define AINTMASK(msk)   outb((msk), _INTMASK)
  76 #define SETCONF()       outb((lp->config), _CONFIG)
  77
  78 /****************************************************************************
  79  *                                                                          *
  80  * IO-mapped operation routines                                             *
  81  *                                                                          *
  82  ****************************************************************************/
  83
  84 #undef ONE_AT_A_TIME_TX
  85 #undef ONE_AT_A_TIME_RX
  86
  87 static u_char get_buffer_byte(struct net_device *dev, unsigned offset)
  88 {
  89         int ioaddr = dev->base_addr;
  90
  91         outb(offset >> 8, _ADDR_HI);
  92         outb(offset & 0xff, _ADDR_LO);
  93
  94         return inb(_MEMDATA);
  95 }
  96
  97 #ifdef ONE_AT_A_TIME_TX
  98 static void put_buffer_byte(struct net_device *dev, unsigned offset, u_char datum)
  99 {
 100         int ioaddr = dev->base_addr;
 101
 102         outb(offset >> 8, _ADDR_HI);
 103         outb(offset & 0xff, _ADDR_LO);
 104
 105         outb(datum, _MEMDATA);
 106 }
 107
 108 #endif
 109
 110 static void get_whole_buffer(struct net_device *dev, unsigned offset, unsigned length, char *dest)
 111 {
 112         int ioaddr = dev->base_addr;
 113
 114         outb((offset >> 8) | AUTOINCflag, _ADDR_HI);
 115         outb(offset & 0xff, _ADDR_LO);
 116
 117         while (length--)
 118 #ifdef ONE_AT_A_TIME_RX
 119                 *(dest++) = get_buffer_byte(dev, offset++);
 120 #else
 121                 *(dest++) = inb(_MEMDATA);
 122 #endif
 123 }
 124
 125 static void put_whole_buffer(struct net_device *dev, unsigned offset, unsigned length, char *dest)
 126 {
 127         int ioaddr = dev->base_addr;
 128
 129         outb((offset >> 8) | AUTOINCflag, _ADDR_HI);
 130         outb(offset & 0xff, _ADDR_LO);
 131
 132         while (length--)
 133 #ifdef ONE_AT_A_TIME_TX
 134                 put_buffer_byte(dev, offset++, *(dest++));
 135 #else
 136                 outb(*(dest++), _MEMDATA);
 137 #endif
 138 }
 139
 140 /* We cannot probe for an IO mapped card either, although we can check that
 141  * it's where we were told it was, and even autoirq
 142  */
 143 static int __init com90io_probe(struct net_device *dev)
 144 {
 145         int ioaddr = dev->base_addr, status;
 146         unsigned long airqmask;
 147
 148         BUGLVL(D_NORMAL) printk(VERSION);
 149         BUGLVL(D_NORMAL) printk("E-mail me if you actually test this driver, please!\n");
 150
 151         if (!ioaddr) {
 152                 BUGMSG(D_NORMAL, "No autoprobe for IO mapped cards; you must specify the base address!\n");
 153                 return -ENODEV;
 154         }
 155         if (!request_region(ioaddr, ARCNET_TOTAL_SIZE, "com90io probe")) {
 156                 BUGMSG(D_INIT_REASONS, "IO request_region %x-%x failed.\n",
 157                        ioaddr, ioaddr + ARCNET_TOTAL_SIZE - 1);
 158                 return -ENXIO;
 159         }
 160         if (ASTATUS() == 0xFF) {
 161                 BUGMSG(D_INIT_REASONS, "IO address %x empty\n", ioaddr);
 162                 goto err_out;
 163         }
 164         inb(_RESET);
 165         mdelay(RESETtime);
 166
 167         status = ASTATUS();
 168
 169         if ((status & 0x9D) != (NORXflag | RECONflag | TXFREEflag | RESETflag)) {
 170                 BUGMSG(D_INIT_REASONS, "Status invalid (%Xh).\n", status);
 171                 goto err_out;
 172         }
 173         BUGMSG(D_INIT_REASONS, "Status after reset: %X\n", status);
 174
 175         ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
 176
 177         BUGMSG(D_INIT_REASONS, "Status after reset acknowledged: %X\n", status);
 178
 179         status = ASTATUS();
 180
 181         if (status & RESETflag) {
 182                 BUGMSG(D_INIT_REASONS, "Eternal reset (status=%Xh)\n", status);
 183                 goto err_out;
 184         }
 185         outb((0x16 | IOMAPflag) & ~ENABLE16flag, _CONFIG);
 186
 187         /* Read first loc'n of memory */
 188
 189         outb(AUTOINCflag, _ADDR_HI);
 190         outb(0, _ADDR_LO);
 191
 192         if ((status = inb(_MEMDATA)) != 0xd1) {
 193                 BUGMSG(D_INIT_REASONS, "Signature byte not found (%Xh instead).\n",
 194                        status);
 195                 goto err_out;
 196         }
 197         if (!dev->irq) {
 198                 /* if we do this, we're sure to get an IRQ since the
 199                  * card has just reset and the NORXflag is on until
 200                  * we tell it to start receiving.
 201                  */
 202
 203                 airqmask = probe_irq_on();
 204                 outb(NORXflag, _INTMASK);
 205                 udelay(1);
 206                 outb(0, _INTMASK);
 207                 dev->irq = probe_irq_off(airqmask);
 208
 209                 if ((int)dev->irq <= 0) {
 210                         BUGMSG(D_INIT_REASONS, "Autoprobe IRQ failed\n");
 211                         goto err_out;
 212                 }
 213         }
 214         release_region(ioaddr, ARCNET_TOTAL_SIZE); /* end of probing */
 215         return com90io_found(dev);
 216
 217 err_out:
 218         release_region(ioaddr, ARCNET_TOTAL_SIZE);
 219         return -ENODEV;
 220 }
 221
 222 /* Set up the struct net_device associated with this card.  Called after
 223  * probing succeeds.
 224  */
 225 static int __init com90io_found(struct net_device *dev)
 226 {
 227         struct arcnet_local *lp;
 228         int ioaddr = dev->base_addr;
 229         int err;
 230
 231         /* Reserve the irq */
 232         if (request_irq(dev->irq, arcnet_interrupt, 0, "arcnet (COM90xx-IO)", dev)) {
 233                 BUGMSG(D_NORMAL, "Can't get IRQ %d!\n", dev->irq);
 234                 return -ENODEV;
 235         }
 236         /* Reserve the I/O region */
 237         if (!request_region(dev->base_addr, ARCNET_TOTAL_SIZE, "arcnet (COM90xx-IO)")) {
 238                 free_irq(dev->irq, dev);
 239                 return -EBUSY;
 240         }
 241
 242         lp = netdev_priv(dev);
 243         lp->card_name = "COM90xx I/O";
 244         lp->hw.command = com90io_command;
 245         lp->hw.status = com90io_status;
 246         lp->hw.intmask = com90io_setmask;
 247         lp->hw.reset = com90io_reset;
 248         lp->hw.owner = THIS_MODULE;
 249         lp->hw.copy_to_card = com90io_copy_to_card;
 250         lp->hw.copy_from_card = com90io_copy_from_card;
 251
 252         lp->config = (0x16 | IOMAPflag) & ~ENABLE16flag;
 253         SETCONF();
 254
 255         /* get and check the station ID from offset 1 in shmem */
 256
 257         dev->dev_addr[0] = get_buffer_byte(dev, 1);
 258
 259         err = register_netdev(dev);
 260         if (err) {
 261                 outb((inb(_CONFIG) & ~IOMAPflag), _CONFIG);
 262                 free_irq(dev->irq, dev);
 263                 release_region(dev->base_addr, ARCNET_TOTAL_SIZE);
 264                 return err;
 265         }
 266
 267         BUGMSG(D_NORMAL, "COM90IO: station %02Xh found at %03lXh, IRQ %d.\n",
 268                dev->dev_addr[0], dev->base_addr, dev->irq);
 269
 270         return 0;
 271 }
 272
 273 /* Do a hardware reset on the card, and set up necessary registers.
 274  *
 275  * This should be called as little as possible, because it disrupts the
 276  * token on the network (causes a RECON) and requires a significant delay.
 277  *
 278  * However, it does make sure the card is in a defined state.
 279  */
 280 static int com90io_reset(struct net_device *dev, int really_reset)
 281 {
 282         struct arcnet_local *lp = netdev_priv(dev);
 283         short ioaddr = dev->base_addr;
 284
 285         BUGMSG(D_INIT, "Resetting %s (status=%02Xh)\n", dev->name, ASTATUS());
 286
 287         if (really_reset) {
 288                 /* reset the card */
 289                 inb(_RESET);
 290                 mdelay(RESETtime);
 291         }
 292         /* Set the thing to IO-mapped, 8-bit  mode */
 293         lp->config = (0x1C | IOMAPflag) & ~ENABLE16flag;
 294         SETCONF();
 295
 296         ACOMMAND(CFLAGScmd | RESETclear);       /* clear flags & end reset */
 297         ACOMMAND(CFLAGScmd | CONFIGclear);
 298
 299         /* verify that the ARCnet signature byte is present */
 300         if (get_buffer_byte(dev, 0) != TESTvalue) {
 301                 BUGMSG(D_NORMAL, "reset failed: TESTvalue not present.\n");
 302                 return 1;
 303         }
 304         /* enable extended (512-byte) packets */
 305         ACOMMAND(CONFIGcmd | EXTconf);
 306
 307         /* done!  return success. */
 308         return 0;
 309 }
 310
 311 static void com90io_command(struct net_device *dev, int cmd)
 312 {
 313         short ioaddr = dev->base_addr;
 314
 315         ACOMMAND(cmd);
 316 }
 317
 318 static int com90io_status(struct net_device *dev)
 319 {
 320         short ioaddr = dev->base_addr;
 321
 322         return ASTATUS();
 323 }
 324
 325 static void com90io_setmask(struct net_device *dev, int mask)
 326 {
 327         short ioaddr = dev->base_addr;
 328
 329         AINTMASK(mask);
 330 }
 331
 332 static void com90io_copy_to_card(struct net_device *dev, int bufnum, int offset,
 333                                  void *buf, int count)
 334 {
 335         TIME("put_whole_buffer", count, put_whole_buffer(dev, bufnum * 512 + offset, count, buf));
 336 }
 337
 338 static void com90io_copy_from_card(struct net_device *dev, int bufnum, int offset,
 339                                    void *buf, int count)
 340 {
 341         TIME("get_whole_buffer", count, get_whole_buffer(dev, bufnum * 512 + offset, count, buf));
 342 }
 343
 344 static int io;                  /* use the insmod io= irq= shmem= options */
 345 static int irq;
 346 static char device[9];          /* use eg. device=arc1 to change name */
 347
 348 module_param(io, int, 0);
 349 module_param(irq, int, 0);
 350 module_param_string(device, device, sizeof(device), 0);
 351 MODULE_LICENSE("GPL");
 352
 353 #ifndef MODULE
 354 static int __init com90io_setup(char *s)
 355 {
 356         int ints[4];
 357
 358         s = get_options(s, 4, ints);
 359         if (!ints[0])
 360                 return 0;
 361         switch (ints[0]) {
 362         default:                /* ERROR */
 363                 printk("com90io: Too many arguments.\n");
 364         case 2:         /* IRQ */
 365                 irq = ints[2];
 366         case 1:         /* IO address */
 367                 io = ints[1];
 368         }
 369         if (*s)
 370                 snprintf(device, sizeof(device), "%s", s);
 371         return 1;
 372 }
 373 __setup("com90io=", com90io_setup);
 374 #endif
 375
 376 static struct net_device *my_dev;
 377
 378 static int __init com90io_init(void)
 379 {
 380         struct net_device *dev;
 381         int err;
 382
 383         dev = alloc_arcdev(device);
 384         if (!dev)
 385                 return -ENOMEM;
 386
 387         dev->base_addr = io;
 388         dev->irq = irq;
 389         if (dev->irq == 2)
 390                 dev->irq = 9;
 391
 392         err = com90io_probe(dev);
 393
 394         if (err) {
 395                 free_netdev(dev);
 396                 return err;
 397         }
 398
 399         my_dev = dev;
 400         return 0;
 401 }
 402
 403 static void __exit com90io_exit(void)
 404 {
 405         struct net_device *dev = my_dev;
 406         int ioaddr = dev->base_addr;
 407
 408         unregister_netdev(dev);
 409
 410         /* Set the thing back to MMAP mode, in case the old driver is loaded later */
 411         outb((inb(_CONFIG) & ~IOMAPflag), _CONFIG);
 412
 413         free_irq(dev->irq, dev);
 414         release_region(dev->base_addr, ARCNET_TOTAL_SIZE);
 415         free_netdev(dev);
 416 }
 417
 418 module_init(com90io_init)
 419 module_exit(com90io_exit)