drivers/net/arcnet/com20020.c

   1 /*
   2  * Linux ARCnet driver - COM20020 chipset support
   3  *
   4  * Written 1997 by David Woodhouse.
   5  * Written 1994-1999 by Avery Pennarun.
   6  * Written 1999 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/module.h>
  29 #include <linux/kernel.h>
  30 #include <linux/types.h>
  31 #include <linux/ioport.h>
  32 #include <linux/errno.h>
  33 #include <linux/delay.h>
  34 #include <linux/netdevice.h>
  35 #include <linux/init.h>
  36 #include <linux/interrupt.h>
  37 #include <linux/arcdevice.h>
  38 #include <linux/com20020.h>
  39
  40 #include <asm/io.h>
  41
  42 #define VERSION "arcnet: COM20020 chipset support (by David Woodhouse et al.)\n"
  43
  44 static char *clockrates[] =
  45 {"10 Mb/s", "Reserved", "5 Mb/s",
  46  "2.5 Mb/s", "1.25Mb/s", "625 Kb/s", "312.5 Kb/s",
  47  "156.25 Kb/s", "Reserved", "Reserved", "Reserved"};
  48
  49 static void com20020_command(struct net_device *dev, int command);
  50 static int com20020_status(struct net_device *dev);
  51 static void com20020_setmask(struct net_device *dev, int mask);
  52 static int com20020_reset(struct net_device *dev, int really_reset);
  53 static void com20020_copy_to_card(struct net_device *dev, int bufnum,
  54                                   int offset, void *buf, int count);
  55 static void com20020_copy_from_card(struct net_device *dev, int bufnum,
  56                                     int offset, void *buf, int count);
  57 static void com20020_set_mc_list(struct net_device *dev);
  58 static void com20020_close(struct net_device *);
  59
  60 static void com20020_copy_from_card(struct net_device *dev, int bufnum,
  61                                     int offset, void *buf, int count)
  62 {
  63         int ioaddr = dev->base_addr, ofs = 512 * bufnum + offset;
  64
  65         /* set up the address register */
  66         outb((ofs >> 8) | RDDATAflag | AUTOINCflag, _ADDR_HI);
  67         outb(ofs & 0xff, _ADDR_LO);
  68
  69         /* copy the data */
  70         TIME("insb", count, insb(_MEMDATA, buf, count));
  71 }
  72
  73
  74 static void com20020_copy_to_card(struct net_device *dev, int bufnum,
  75                                   int offset, void *buf, int count)
  76 {
  77         int ioaddr = dev->base_addr, ofs = 512 * bufnum + offset;
  78
  79         /* set up the address register */
  80         outb((ofs >> 8) | AUTOINCflag, _ADDR_HI);
  81         outb(ofs & 0xff, _ADDR_LO);
  82
  83         /* copy the data */
  84         TIME("outsb", count, outsb(_MEMDATA, buf, count));
  85 }
  86
  87
  88 /* Reset the card and check some basic stuff during the detection stage. */
  89 int com20020_check(struct net_device *dev)
  90 {
  91         int ioaddr = dev->base_addr, status;
  92         struct arcnet_local *lp = netdev_priv(dev);
  93
  94         ARCRESET0;
  95         mdelay(RESETtime);
  96
  97         lp->setup = lp->clockm ? 0 : (lp->clockp << 1);
  98         lp->setup2 = (lp->clockm << 4) | 8;
  99
 100         /* CHECK: should we do this for SOHARD cards ? */
 101         /* Enable P1Mode for backplane mode */
 102         lp->setup = lp->setup | P1MODE;
 103
 104         SET_SUBADR(SUB_SETUP1);
 105         outb(lp->setup, _XREG);
 106
 107         if (lp->clockm != 0)
 108         {
 109                 SET_SUBADR(SUB_SETUP2);
 110                 outb(lp->setup2, _XREG);
 111
 112                 /* must now write the magic "restart operation" command */
 113                 mdelay(1);
 114                 outb(0x18, _COMMAND);
 115         }
 116
 117         lp->config = 0x21 | (lp->timeout << 3) | (lp->backplane << 2);
 118         /* set node ID to 0x42 (but transmitter is disabled, so it's okay) */
 119         SETCONF;
 120         outb(0x42, ioaddr + BUS_ALIGN*7);
 121
 122         status = ASTATUS();
 123
 124         if ((status & 0x99) != (NORXflag | TXFREEflag | RESETflag)) {
 125                 BUGMSG(D_NORMAL, "status invalid (%Xh).\n", status);
 126                 return -ENODEV;
 127         }
 128         BUGMSG(D_INIT_REASONS, "status after reset: %X\n", status);
 129
 130         /* Enable TX */
 131         outb(0x39, _CONFIG);
 132         outb(inb(ioaddr + BUS_ALIGN*8), ioaddr + BUS_ALIGN*7);
 133
 134         ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
 135
 136         status = ASTATUS();
 137         BUGMSG(D_INIT_REASONS, "status after reset acknowledged: %X\n",
 138                status);
 139
 140         /* Read first location of memory */
 141         outb(0 | RDDATAflag | AUTOINCflag, _ADDR_HI);
 142         outb(0, _ADDR_LO);
 143
 144         if ((status = inb(_MEMDATA)) != TESTvalue) {
 145                 BUGMSG(D_NORMAL, "Signature byte not found (%02Xh != D1h).\n",
 146                        status);
 147                 return -ENODEV;
 148         }
 149         return 0;
 150 }
 151
 152 static int com20020_set_hwaddr(struct net_device *dev, void *addr)
 153 {
 154         int ioaddr = dev->base_addr;
 155         struct arcnet_local *lp = netdev_priv(dev);
 156         struct sockaddr *hwaddr = addr;
 157
 158         memcpy(dev->dev_addr, hwaddr->sa_data, 1);
 159         SET_SUBADR(SUB_NODE);
 160         outb(dev->dev_addr[0], _XREG);
 161
 162         return 0;
 163 }
 164
 165 const struct net_device_ops com20020_netdev_ops = {
 166         .ndo_open       = arcnet_open,
 167         .ndo_stop       = arcnet_close,
 168         .ndo_start_xmit = arcnet_send_packet,
 169         .ndo_tx_timeout = arcnet_timeout,
 170         .ndo_set_mac_address = com20020_set_hwaddr,
 171         .ndo_set_rx_mode = com20020_set_mc_list,
 172 };
 173
 174 /* Set up the struct net_device associated with this card.  Called after
 175  * probing succeeds.
 176  */
 177 int com20020_found(struct net_device *dev, int shared)
 178 {
 179         struct arcnet_local *lp;
 180         int ioaddr = dev->base_addr;
 181
 182         /* Initialize the rest of the device structure. */
 183
 184         lp = netdev_priv(dev);
 185
 186         lp->hw.owner = THIS_MODULE;
 187         lp->hw.command = com20020_command;
 188         lp->hw.status = com20020_status;
 189         lp->hw.intmask = com20020_setmask;
 190         lp->hw.reset = com20020_reset;
 191         lp->hw.copy_to_card = com20020_copy_to_card;
 192         lp->hw.copy_from_card = com20020_copy_from_card;
 193         lp->hw.close = com20020_close;
 194
 195         if (!dev->dev_addr[0])
 196                 dev->dev_addr[0] = inb(ioaddr + BUS_ALIGN*8);   /* FIXME: do this some other way! */
 197
 198         SET_SUBADR(SUB_SETUP1);
 199         outb(lp->setup, _XREG);
 200
 201         if (lp->card_flags & ARC_CAN_10MBIT)
 202         {
 203                 SET_SUBADR(SUB_SETUP2);
 204                 outb(lp->setup2, _XREG);
 205
 206                 /* must now write the magic "restart operation" command */
 207                 mdelay(1);
 208                 outb(0x18, _COMMAND);
 209         }
 210
 211         lp->config = 0x20 | (lp->timeout << 3) | (lp->backplane << 2) | 1;
 212         /* Default 0x38 + register: Node ID */
 213         SETCONF;
 214         outb(dev->dev_addr[0], _XREG);
 215
 216         /* reserve the irq */
 217         if (request_irq(dev->irq, arcnet_interrupt, shared,
 218                         "arcnet (COM20020)", dev)) {
 219                 BUGMSG(D_NORMAL, "Can't get IRQ %d!\n", dev->irq);
 220                 return -ENODEV;
 221         }
 222
 223         dev->base_addr = ioaddr;
 224
 225         BUGMSG(D_NORMAL, "%s: station %02Xh found at %03lXh, IRQ %d.\n",
 226                lp->card_name, dev->dev_addr[0], dev->base_addr, dev->irq);
 227
 228         if (lp->backplane)
 229                 BUGMSG(D_NORMAL, "Using backplane mode.\n");
 230
 231         if (lp->timeout != 3)
 232                 BUGMSG(D_NORMAL, "Using extended timeout value of %d.\n", lp->timeout);
 233
 234         BUGMSG(D_NORMAL, "Using CKP %d - data rate %s.\n",
 235                lp->setup >> 1,
 236                clockrates[3 - ((lp->setup2 & 0xF0) >> 4) + ((lp->setup & 0x0F) >> 1)]);
 237
 238         if (register_netdev(dev)) {
 239                 free_irq(dev->irq, dev);
 240                 return -EIO;
 241         }
 242         return 0;
 243 }
 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 com20020_reset(struct net_device *dev, int really_reset)
 255 {
 256         struct arcnet_local *lp = netdev_priv(dev);
 257         u_int ioaddr = dev->base_addr;
 258         u_char inbyte;
 259
 260         BUGMSG(D_DEBUG, "%s: %d: %s: dev: %p, lp: %p, dev->name: %s\n",
 261                 __FILE__,__LINE__,__func__,dev,lp,dev->name);
 262         BUGMSG(D_INIT, "Resetting %s (status=%02Xh)\n",
 263                dev->name, ASTATUS());
 264
 265         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
 266         lp->config = TXENcfg | (lp->timeout << 3) | (lp->backplane << 2);
 267         /* power-up defaults */
 268         SETCONF;
 269         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
 270
 271         if (really_reset) {
 272                 /* reset the card */
 273                 ARCRESET;
 274                 mdelay(RESETtime * 2);  /* COM20020 seems to be slower sometimes */
 275         }
 276         /* clear flags & end reset */
 277         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
 278         ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
 279
 280         /* verify that the ARCnet signature byte is present */
 281         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
 282
 283         com20020_copy_from_card(dev, 0, 0, &inbyte, 1);
 284         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
 285         if (inbyte != TESTvalue) {
 286                 BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
 287                 BUGMSG(D_NORMAL, "reset failed: TESTvalue not present.\n");
 288                 return 1;
 289         }
 290         /* enable extended (512-byte) packets */
 291         ACOMMAND(CONFIGcmd | EXTconf);
 292         BUGMSG(D_DEBUG, "%s: %d: %s\n",__FILE__,__LINE__,__func__);
 293
 294         /* done!  return success. */
 295         return 0;
 296 }
 297
 298
 299 static void com20020_setmask(struct net_device *dev, int mask)
 300 {
 301         u_int ioaddr = dev->base_addr;
 302         BUGMSG(D_DURING, "Setting mask to %x at %x\n",mask,ioaddr);
 303         AINTMASK(mask);
 304 }
 305
 306
 307 static void com20020_command(struct net_device *dev, int cmd)
 308 {
 309         u_int ioaddr = dev->base_addr;
 310         ACOMMAND(cmd);
 311 }
 312
 313
 314 static int com20020_status(struct net_device *dev)
 315 {
 316         u_int ioaddr = dev->base_addr;
 317
 318         return ASTATUS() + (ADIAGSTATUS()<<8);
 319 }
 320
 321 static void com20020_close(struct net_device *dev)
 322 {
 323         struct arcnet_local *lp = netdev_priv(dev);
 324         int ioaddr = dev->base_addr;
 325
 326         /* disable transmitter */
 327         lp->config &= ~TXENcfg;
 328         SETCONF;
 329 }
 330
 331 /* Set or clear the multicast filter for this adaptor.
 332  * num_addrs == -1    Promiscuous mode, receive all packets
 333  * num_addrs == 0       Normal mode, clear multicast list
 334  * num_addrs > 0        Multicast mode, receive normal and MC packets, and do
 335  *                      best-effort filtering.
 336  *      FIXME - do multicast stuff, not just promiscuous.
 337  */
 338 static void com20020_set_mc_list(struct net_device *dev)
 339 {
 340         struct arcnet_local *lp = netdev_priv(dev);
 341         int ioaddr = dev->base_addr;
 342
 343         if ((dev->flags & IFF_PROMISC) && (dev->flags & IFF_UP)) {      /* Enable promiscuous mode */
 344                 if (!(lp->setup & PROMISCset))
 345                         BUGMSG(D_NORMAL, "Setting promiscuous flag...\n");
 346                 SET_SUBADR(SUB_SETUP1);
 347                 lp->setup |= PROMISCset;
 348                 outb(lp->setup, _XREG);
 349         } else
 350                 /* Disable promiscuous mode, use normal mode */
 351         {
 352                 if ((lp->setup & PROMISCset))
 353                         BUGMSG(D_NORMAL, "Resetting promiscuous flag...\n");
 354                 SET_SUBADR(SUB_SETUP1);
 355                 lp->setup &= ~PROMISCset;
 356                 outb(lp->setup, _XREG);
 357         }
 358 }
 359
 360 #if defined(CONFIG_ARCNET_COM20020_PCI_MODULE) || \
 361     defined(CONFIG_ARCNET_COM20020_ISA_MODULE) || \
 362     defined(CONFIG_ARCNET_COM20020_CS_MODULE)
 363 EXPORT_SYMBOL(com20020_check);
 364 EXPORT_SYMBOL(com20020_found);
 365 EXPORT_SYMBOL(com20020_netdev_ops);
 366 #endif
 367
 368 MODULE_LICENSE("GPL");
 369
 370 #ifdef MODULE
 371
 372 static int __init com20020_module_init(void)
 373 {
 374         BUGLVL(D_NORMAL) printk(VERSION);
 375         return 0;
 376 }
 377
 378 static void __exit com20020_module_exit(void)
 379 {
 380 }
 381 module_init(com20020_module_init);
 382 module_exit(com20020_module_exit);
 383 #endif                          /* MODULE */