drivers/net/arcnet/arc-rimi.c

   1 /*
   2  * Linux ARCnet driver - "RIM I" (entirely mem-mapped) cards
   3  *
   4  * Written 1994-1999 by Avery Pennarun.
   5  * Written 1999-2000 by Martin Mares <mj@ucw.cz>.
   6  * Derived from skeleton.c by Donald Becker.
   7  *
   8  * Special thanks to Contemporary Controls, Inc. (www.ccontrols.com)
   9  *  for sponsoring the further development of this driver.
  10  *
  11  * **********************
  12  *
  13  * The original copyright of skeleton.c was as follows:
  14  *
  15  * skeleton.c Written 1993 by Donald Becker.
  16  * Copyright 1993 United States Government as represented by the
  17  * Director, National Security Agency.  This software may only be used
  18  * and distributed according to the terms of the GNU General Public License as
  19  * modified by SRC, incorporated herein by reference.
  20  *
  21  * **********************
  22  *
  23  * For more details, see drivers/net/arcnet.c
  24  *
  25  * **********************
  26  */
  27 #include <linux/kernel.h>
  28 #include <linux/module.h>
  29 #include <linux/moduleparam.h>
  30 #include <linux/ioport.h>
  31 #include <linux/delay.h>
  32 #include <linux/netdevice.h>
  33 #include <linux/bootmem.h>
  34 #include <linux/init.h>
  35 #include <linux/interrupt.h>
  36 #include <asm/io.h>
  37 #include <linux/arcdevice.h>
  38
  39 #define VERSION "arcnet: RIM I (entirely mem-mapped) support\n"
  40
  41 /* Internal function declarations */
  42
  43 static int arcrimi_probe(struct net_device *dev);
  44 static int arcrimi_found(struct net_device *dev);
  45 static void arcrimi_command(struct net_device *dev, int command);
  46 static int arcrimi_status(struct net_device *dev);
  47 static void arcrimi_setmask(struct net_device *dev, int mask);
  48 static int arcrimi_reset(struct net_device *dev, int really_reset);
  49 static void arcrimi_copy_to_card(struct net_device *dev, int bufnum, int offset,
  50                                  void *buf, int count);
  51 static void arcrimi_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 /* Amount of I/O memory used by the card */
  57 #define BUFFER_SIZE     (512)
  58 #define MIRROR_SIZE     (BUFFER_SIZE * 4)
  59
  60 /* COM 9026 controller chip --> ARCnet register addresses */
  61 #define _INTMASK        (ioaddr + 0)    /* writable */
  62 #define _STATUS         (ioaddr + 0)    /* readable */
  63 #define _COMMAND        (ioaddr + 1)    /* writable, returns random vals on read (?) */
  64 #define _RESET          (ioaddr + 8)    /* software reset (on read) */
  65 #define _MEMDATA        (ioaddr + 12)   /* Data port for IO-mapped memory */
  66 #define _ADDR_HI        (ioaddr + 15)   /* Control registers for said */
  67 #define _ADDR_LO        (ioaddr + 14)
  68 #define _CONFIG         (ioaddr + 2)    /* Configuration register */
  69
  70 #undef ASTATUS
  71 #undef ACOMMAND
  72 #undef AINTMASK
  73
  74 #define ASTATUS()       readb(_STATUS)
  75 #define ACOMMAND(cmd)   writeb((cmd), _COMMAND)
  76 #define AINTMASK(msk)   writeb((msk), _INTMASK)
  77 #define SETCONF()       writeb(lp->config, _CONFIG)
  78
  79 /*
  80  * We cannot probe for a RIM I card; one reason is I don't know how to reset
  81  * them.  In fact, we can't even get their node ID automatically.  So, we
  82  * need to be passed a specific shmem address, IRQ, and node ID.
  83  */
  84 static int __init arcrimi_probe(struct net_device *dev)
  85 {
  86         BUGLVL(D_NORMAL) printk(VERSION);
  87         BUGLVL(D_NORMAL) printk("E-mail me if you actually test the RIM I driver, please!\n");
  88
  89         BUGLVL(D_NORMAL) printk("Given: node %02Xh, shmem %lXh, irq %d\n",
  90                                 dev->dev_addr[0], dev->mem_start, dev->irq);
  91
  92         if (dev->mem_start <= 0 || dev->irq <= 0) {
  93                 BUGLVL(D_NORMAL) printk("No autoprobe for RIM I; you must specify the shmem and irq!\n");
  94                 return -ENODEV;
  95         }
  96         if (dev->dev_addr[0] == 0) {
  97                 BUGLVL(D_NORMAL) printk("You need to specify your card's station ID!\n");
  98                 return -ENODEV;
  99         }
 100         /*
 101          * Grab the memory region at mem_start for MIRROR_SIZE bytes.
 102          * Later in arcrimi_found() the real size will be determined
 103          * and this reserve will be released and the correct size
 104          * will be taken.
 105          */
 106         if (!request_mem_region(dev->mem_start, MIRROR_SIZE, "arcnet (90xx)")) {
 107                 BUGLVL(D_NORMAL) printk("Card memory already allocated\n");
 108                 return -ENODEV;
 109         }
 110         return arcrimi_found(dev);
 111 }
 112
 113 static int check_mirror(unsigned long addr, size_t size)
 114 {
 115         void __iomem *p;
 116         int res = -1;
 117
 118         if (!request_mem_region(addr, size, "arcnet (90xx)"))
 119                 return -1;
 120
 121         p = ioremap(addr, size);
 122         if (p) {
 123                 if (readb(p) == TESTvalue)
 124                         res = 1;
 125                 else
 126                         res = 0;
 127                 iounmap(p);
 128         }
 129
 130         release_mem_region(addr, size);
 131         return res;
 132 }
 133
 134 /*
 135  * Set up the struct net_device associated with this card.  Called after
 136  * probing succeeds.
 137  */
 138 static int __init arcrimi_found(struct net_device *dev)
 139 {
 140         struct arcnet_local *lp;
 141         unsigned long first_mirror, last_mirror, shmem;
 142         void __iomem *p;
 143         int mirror_size;
 144         int err;
 145
 146         p = ioremap(dev->mem_start, MIRROR_SIZE);
 147         if (!p) {
 148                 release_mem_region(dev->mem_start, MIRROR_SIZE);
 149                 BUGMSG(D_NORMAL, "Can't ioremap\n");
 150                 return -ENODEV;
 151         }
 152
 153         /* reserve the irq */
 154         if (request_irq(dev->irq, arcnet_interrupt, 0, "arcnet (RIM I)", dev)) {
 155                 iounmap(p);
 156                 release_mem_region(dev->mem_start, MIRROR_SIZE);
 157                 BUGMSG(D_NORMAL, "Can't get IRQ %d!\n", dev->irq);
 158                 return -ENODEV;
 159         }
 160
 161         shmem = dev->mem_start;
 162         writeb(TESTvalue, p);
 163         writeb(dev->dev_addr[0], p + 1);        /* actually the node ID */
 164
 165         /* find the real shared memory start/end points, including mirrors */
 166
 167         /* guess the actual size of one "memory mirror" - the number of
 168          * bytes between copies of the shared memory.  On most cards, it's
 169          * 2k (or there are no mirrors at all) but on some, it's 4k.
 170          */
 171         mirror_size = MIRROR_SIZE;
 172         if (readb(p) == TESTvalue &&
 173             check_mirror(shmem - MIRROR_SIZE, MIRROR_SIZE) == 0 &&
 174             check_mirror(shmem - 2 * MIRROR_SIZE, MIRROR_SIZE) == 1)
 175                 mirror_size = 2 * MIRROR_SIZE;
 176
 177         first_mirror = shmem - mirror_size;
 178         while (check_mirror(first_mirror, mirror_size) == 1)
 179                 first_mirror -= mirror_size;
 180         first_mirror += mirror_size;
 181
 182         last_mirror = shmem + mirror_size;
 183         while (check_mirror(last_mirror, mirror_size) == 1)
 184                 last_mirror += mirror_size;
 185         last_mirror -= mirror_size;
 186
 187         dev->mem_start = first_mirror;
 188         dev->mem_end = last_mirror + MIRROR_SIZE - 1;
 189
 190         /* initialize the rest of the device structure. */
 191
 192         lp = netdev_priv(dev);
 193         lp->card_name = "RIM I";
 194         lp->hw.command = arcrimi_command;
 195         lp->hw.status = arcrimi_status;
 196         lp->hw.intmask = arcrimi_setmask;
 197         lp->hw.reset = arcrimi_reset;
 198         lp->hw.owner = THIS_MODULE;
 199         lp->hw.copy_to_card = arcrimi_copy_to_card;
 200         lp->hw.copy_from_card = arcrimi_copy_from_card;
 201
 202         /*
 203          * re-reserve the memory region - arcrimi_probe() alloced this reqion
 204          * but didn't know the real size.  Free that region and then re-get
 205          * with the correct size.  There is a VERY slim chance this could
 206          * fail.
 207          */
 208         iounmap(p);
 209         release_mem_region(shmem, MIRROR_SIZE);
 210         if (!request_mem_region(dev->mem_start,
 211                                 dev->mem_end - dev->mem_start + 1,
 212                                 "arcnet (90xx)")) {
 213                 BUGMSG(D_NORMAL, "Card memory already allocated\n");
 214                 goto err_free_irq;
 215         }
 216
 217         lp->mem_start = ioremap(dev->mem_start, dev->mem_end - dev->mem_start + 1);
 218         if (!lp->mem_start) {
 219                 BUGMSG(D_NORMAL, "Can't remap device memory!\n");
 220                 goto err_release_mem;
 221         }
 222
 223         /* get and check the station ID from offset 1 in shmem */
 224         dev->dev_addr[0] = readb(lp->mem_start + 1);
 225
 226         BUGMSG(D_NORMAL, "ARCnet RIM I: station %02Xh found at IRQ %d, ShMem %lXh (%ld*%d bytes)\n",
 227                dev->dev_addr[0],
 228                dev->irq, dev->mem_start,
 229          (dev->mem_end - dev->mem_start + 1) / mirror_size, mirror_size);
 230
 231         err = register_netdev(dev);
 232         if (err)
 233                 goto err_unmap;
 234
 235         return 0;
 236
 237 err_unmap:
 238         iounmap(lp->mem_start);
 239 err_release_mem:
 240         release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
 241 err_free_irq:
 242         free_irq(dev->irq, dev);
 243         return -EIO;
 244 }
 245
 246 /*
 247  * Do a hardware reset on the card, and set up necessary registers.
 248  *
 249  * This should be called as little as possible, because it disrupts the
 250  * token on the network (causes a RECON) and requires a significant delay.
 251  *
 252  * However, it does make sure the card is in a defined state.
 253  */
 254 static int arcrimi_reset(struct net_device *dev, int really_reset)
 255 {
 256         struct arcnet_local *lp = netdev_priv(dev);
 257         void __iomem *ioaddr = lp->mem_start + 0x800;
 258
 259         BUGMSG(D_INIT, "Resetting %s (status=%02Xh)\n", dev->name, ASTATUS());
 260
 261         if (really_reset) {
 262                 writeb(TESTvalue, ioaddr - 0x800);      /* fake reset */
 263                 return 0;
 264         }
 265         ACOMMAND(CFLAGScmd | RESETclear);       /* clear flags & end reset */
 266         ACOMMAND(CFLAGScmd | CONFIGclear);
 267
 268         /* enable extended (512-byte) packets */
 269         ACOMMAND(CONFIGcmd | EXTconf);
 270
 271         /* done!  return success. */
 272         return 0;
 273 }
 274
 275 static void arcrimi_setmask(struct net_device *dev, int mask)
 276 {
 277         struct arcnet_local *lp = netdev_priv(dev);
 278         void __iomem *ioaddr = lp->mem_start + 0x800;
 279
 280         AINTMASK(mask);
 281 }
 282
 283 static int arcrimi_status(struct net_device *dev)
 284 {
 285         struct arcnet_local *lp = netdev_priv(dev);
 286         void __iomem *ioaddr = lp->mem_start + 0x800;
 287
 288         return ASTATUS();
 289 }
 290
 291 static void arcrimi_command(struct net_device *dev, int cmd)
 292 {
 293         struct arcnet_local *lp = netdev_priv(dev);
 294         void __iomem *ioaddr = lp->mem_start + 0x800;
 295
 296         ACOMMAND(cmd);
 297 }
 298
 299 static void arcrimi_copy_to_card(struct net_device *dev, int bufnum, int offset,
 300                                  void *buf, int count)
 301 {
 302         struct arcnet_local *lp = netdev_priv(dev);
 303         void __iomem *memaddr = lp->mem_start + 0x800 + bufnum * 512 + offset;
 304
 305         TIME("memcpy_toio", count, memcpy_toio(memaddr, buf, count));
 306 }
 307
 308 static void arcrimi_copy_from_card(struct net_device *dev, int bufnum, int offset,
 309                                    void *buf, int count)
 310 {
 311         struct arcnet_local *lp = netdev_priv(dev);
 312         void __iomem *memaddr = lp->mem_start + 0x800 + bufnum * 512 + offset;
 313
 314         TIME("memcpy_fromio", count, memcpy_fromio(buf, memaddr, count));
 315 }
 316
 317 static int node;
 318 static int io;                  /* use the insmod io= irq= node= options */
 319 static int irq;
 320 static char device[9];          /* use eg. device=arc1 to change name */
 321
 322 module_param(node, int, 0);
 323 module_param(io, int, 0);
 324 module_param(irq, int, 0);
 325 module_param_string(device, device, sizeof(device), 0);
 326 MODULE_LICENSE("GPL");
 327
 328 static struct net_device *my_dev;
 329
 330 static int __init arc_rimi_init(void)
 331 {
 332         struct net_device *dev;
 333
 334         dev = alloc_arcdev(device);
 335         if (!dev)
 336                 return -ENOMEM;
 337
 338         if (node && node != 0xff)
 339                 dev->dev_addr[0] = node;
 340
 341         dev->mem_start = io;
 342         dev->irq = irq;
 343         if (dev->irq == 2)
 344                 dev->irq = 9;
 345
 346         if (arcrimi_probe(dev)) {
 347                 free_netdev(dev);
 348                 return -EIO;
 349         }
 350
 351         my_dev = dev;
 352         return 0;
 353 }
 354
 355 static void __exit arc_rimi_exit(void)
 356 {
 357         struct net_device *dev = my_dev;
 358         struct arcnet_local *lp = netdev_priv(dev);
 359
 360         unregister_netdev(dev);
 361         iounmap(lp->mem_start);
 362         release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
 363         free_irq(dev->irq, dev);
 364         free_netdev(dev);
 365 }
 366
 367 #ifndef MODULE
 368 static int __init arcrimi_setup(char *s)
 369 {
 370         int ints[8];
 371
 372         s = get_options(s, 8, ints);
 373         if (!ints[0])
 374                 return 1;
 375         switch (ints[0]) {
 376         default:                /* ERROR */
 377                 printk("arcrimi: Too many arguments.\n");
 378         case 3:         /* Node ID */
 379                 node = ints[3];
 380         case 2:         /* IRQ */
 381                 irq = ints[2];
 382         case 1:         /* IO address */
 383                 io = ints[1];
 384         }
 385         if (*s)
 386                 snprintf(device, sizeof(device), "%s", s);
 387         return 1;
 388 }
 389 __setup("arcrimi=", arcrimi_setup);
 390 #endif                          /* MODULE */
 391
 392 module_init(arc_rimi_init)
 393 module_exit(arc_rimi_exit)