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
  29 #define pr_fmt(fmt) "arcnet:" KBUILD_MODNAME ": " fmt
  30
  31 #include <linux/module.h>
  32 #include <linux/kernel.h>
  33 #include <linux/types.h>
  34 #include <linux/ioport.h>
  35 #include <linux/errno.h>
  36 #include <linux/delay.h>
  37 #include <linux/netdevice.h>
  38 #include <linux/init.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/arcdevice.h>
  41 #include <linux/com20020.h>
  42
  43 #include <linux/io.h>
  44
  45 static char *clockrates[] = {
  46         "XXXXXXX", "XXXXXXXX", "XXXXXX",
  47         "2.5 Mb/s", "1.25Mb/s", "625 Kb/s", "312.5 Kb/s",
  48         "156.25 Kb/s", "Reserved", "Reserved", "Reserved"
  49 };
  50
  51 static void com20020_command(struct net_device *dev, int command);
  52 static int com20020_status(struct net_device *dev);
  53 static void com20020_setmask(struct net_device *dev, int mask);
  54 static int com20020_reset(struct net_device *dev, int really_reset);
  55 static void com20020_copy_to_card(struct net_device *dev, int bufnum,
  56                                   int offset, void *buf, int count);
  57 static void com20020_copy_from_card(struct net_device *dev, int bufnum,
  58                                     int offset, void *buf, int count);
  59 static void com20020_set_mc_list(struct net_device *dev);
  60 static void com20020_close(struct net_device *);
  61
  62 static void com20020_copy_from_card(struct net_device *dev, int bufnum,
  63                                     int offset, void *buf, int count)
  64 {
  65         int ioaddr = dev->base_addr, ofs = 512 * bufnum + offset;
  66
  67         /* set up the address register */
  68         outb((ofs >> 8) | RDDATAflag | AUTOINCflag, _ADDR_HI);
  69         outb(ofs & 0xff, _ADDR_LO);
  70
  71         /* copy the data */
  72         TIME(dev, "insb", count, insb(_MEMDATA, buf, count));
  73 }
  74
  75 static void com20020_copy_to_card(struct net_device *dev, int bufnum,
  76                                   int offset, void *buf, int count)
  77 {
  78         int ioaddr = dev->base_addr, ofs = 512 * bufnum + offset;
  79
  80         /* set up the address register */
  81         outb((ofs >> 8) | AUTOINCflag, _ADDR_HI);
  82         outb(ofs & 0xff, _ADDR_LO);
  83
  84         /* copy the data */
  85         TIME(dev, "outsb", count, outsb(_MEMDATA, buf, count));
  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                 SET_SUBADR(SUB_SETUP2);
 109                 outb(lp->setup2, _XREG);
 110
 111                 /* must now write the magic "restart operation" command */
 112                 mdelay(1);
 113                 outb(0x18, _COMMAND);
 114         }
 115
 116         lp->config = 0x21 | (lp->timeout << 3) | (lp->backplane << 2);
 117         /* set node ID to 0x42 (but transmitter is disabled, so it's okay) */
 118         SETCONF;
 119         outb(0x42, ioaddr + BUS_ALIGN * 7);
 120
 121         status = ASTATUS();
 122
 123         if ((status & 0x99) != (NORXflag | TXFREEflag | RESETflag)) {
 124                 arc_printk(D_NORMAL, dev, "status invalid (%Xh).\n", status);
 125                 return -ENODEV;
 126         }
 127         arc_printk(D_INIT_REASONS, dev, "status after reset: %X\n", status);
 128
 129         /* Enable TX */
 130         outb(0x39, _CONFIG);
 131         outb(inb(ioaddr + BUS_ALIGN * 8), ioaddr + BUS_ALIGN * 7);
 132
 133         ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
 134
 135         status = ASTATUS();
 136         arc_printk(D_INIT_REASONS, dev, "status after reset acknowledged: %X\n",
 137                    status);
 138
 139         /* Read first location of memory */
 140         outb(0 | RDDATAflag | AUTOINCflag, _ADDR_HI);
 141         outb(0, _ADDR_LO);
 142
 143         status = inb(_MEMDATA);
 144         if (status != TESTvalue) {
 145                 arc_printk(D_NORMAL, dev, "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                 SET_SUBADR(SUB_SETUP2);
 203                 outb(lp->setup2, _XREG);
 204
 205                 /* must now write the magic "restart operation" command */
 206                 mdelay(1);
 207                 outb(0x18, _COMMAND);
 208         }
 209
 210         lp->config = 0x20 | (lp->timeout << 3) | (lp->backplane << 2) | 1;
 211         /* Default 0x38 + register: Node ID */
 212         SETCONF;
 213         outb(dev->dev_addr[0], _XREG);
 214
 215         /* reserve the irq */
 216         if (request_irq(dev->irq, arcnet_interrupt, shared,
 217                         "arcnet (COM20020)", dev)) {
 218                 arc_printk(D_NORMAL, dev, "Can't get IRQ %d!\n", dev->irq);
 219                 return -ENODEV;
 220         }
 221
 222         dev->base_addr = ioaddr;
 223
 224         arc_printk(D_NORMAL, dev, "%s: station %02Xh found at %03lXh, IRQ %d.\n",
 225                    lp->card_name, dev->dev_addr[0], dev->base_addr, dev->irq);
 226
 227         if (lp->backplane)
 228                 arc_printk(D_NORMAL, dev, "Using backplane mode.\n");
 229
 230         if (lp->timeout != 3)
 231                 arc_printk(D_NORMAL, dev, "Using extended timeout value of %d\n",
 232                            lp->timeout);
 233
 234         arc_printk(D_NORMAL, dev, "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 /* Do a hardware reset on the card, and set up necessary registers.
 246  *
 247  * This should be called as little as possible, because it disrupts the
 248  * token on the network (causes a RECON) and requires a significant delay.
 249  *
 250  * However, it does make sure the card is in a defined state.
 251  */
 252 static int com20020_reset(struct net_device *dev, int really_reset)
 253 {
 254         struct arcnet_local *lp = netdev_priv(dev);
 255         u_int ioaddr = dev->base_addr;
 256         u_char inbyte;
 257
 258         arc_printk(D_DEBUG, dev, "%s: %d: %s: dev: %p, lp: %p, dev->name: %s\n",
 259                    __FILE__, __LINE__, __func__, dev, lp, dev->name);
 260         arc_printk(D_INIT, dev, "Resetting %s (status=%02Xh)\n",
 261                    dev->name, ASTATUS());
 262
 263         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 264         lp->config = TXENcfg | (lp->timeout << 3) | (lp->backplane << 2);
 265         /* power-up defaults */
 266         SETCONF;
 267         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 268
 269         if (really_reset) {
 270                 /* reset the card */
 271                 ARCRESET;
 272                 mdelay(RESETtime * 2);  /* COM20020 seems to be slower sometimes */
 273         }
 274         /* clear flags & end reset */
 275         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 276         ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
 277
 278         /* verify that the ARCnet signature byte is present */
 279         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 280
 281         com20020_copy_from_card(dev, 0, 0, &inbyte, 1);
 282         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 283         if (inbyte != TESTvalue) {
 284                 arc_printk(D_DEBUG, dev, "%s: %d: %s\n",
 285                            __FILE__, __LINE__, __func__);
 286                 arc_printk(D_NORMAL, dev, "reset failed: TESTvalue not present.\n");
 287                 return 1;
 288         }
 289         /* enable extended (512-byte) packets */
 290         ACOMMAND(CONFIGcmd | EXTconf);
 291         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 292
 293         /* done!  return success. */
 294         return 0;
 295 }
 296
 297 static void com20020_setmask(struct net_device *dev, int mask)
 298 {
 299         u_int ioaddr = dev->base_addr;
 300
 301         arc_printk(D_DURING, dev, "Setting mask to %x at %x\n", mask, ioaddr);
 302         AINTMASK(mask);
 303 }
 304
 305 static void com20020_command(struct net_device *dev, int cmd)
 306 {
 307         u_int ioaddr = dev->base_addr;
 308
 309         ACOMMAND(cmd);
 310 }
 311
 312 static int com20020_status(struct net_device *dev)
 313 {
 314         u_int ioaddr = dev->base_addr;
 315
 316         return ASTATUS() + (ADIAGSTATUS() << 8);
 317 }
 318
 319 static void com20020_close(struct net_device *dev)
 320 {
 321         struct arcnet_local *lp = netdev_priv(dev);
 322         int ioaddr = dev->base_addr;
 323
 324         /* disable transmitter */
 325         lp->config &= ~TXENcfg;
 326         SETCONF;
 327 }
 328
 329 /* Set or clear the multicast filter for this adaptor.
 330  * num_addrs == -1    Promiscuous mode, receive all packets
 331  * num_addrs == 0       Normal mode, clear multicast list
 332  * num_addrs > 0        Multicast mode, receive normal and MC packets, and do
 333  *                      best-effort filtering.
 334  *      FIXME - do multicast stuff, not just promiscuous.
 335  */
 336 static void com20020_set_mc_list(struct net_device *dev)
 337 {
 338         struct arcnet_local *lp = netdev_priv(dev);
 339         int ioaddr = dev->base_addr;
 340
 341         if ((dev->flags & IFF_PROMISC) && (dev->flags & IFF_UP)) {      /* Enable promiscuous mode */
 342                 if (!(lp->setup & PROMISCset))
 343                         arc_printk(D_NORMAL, dev, "Setting promiscuous flag...\n");
 344                 SET_SUBADR(SUB_SETUP1);
 345                 lp->setup |= PROMISCset;
 346                 outb(lp->setup, _XREG);
 347         } else
 348                 /* Disable promiscuous mode, use normal mode */
 349         {
 350                 if ((lp->setup & PROMISCset))
 351                         arc_printk(D_NORMAL, dev, "Resetting promiscuous flag...\n");
 352                 SET_SUBADR(SUB_SETUP1);
 353                 lp->setup &= ~PROMISCset;
 354                 outb(lp->setup, _XREG);
 355         }
 356 }
 357
 358 #if defined(CONFIG_ARCNET_COM20020_PCI_MODULE) || \
 359     defined(CONFIG_ARCNET_COM20020_ISA_MODULE) || \
 360     defined(CONFIG_ARCNET_COM20020_CS_MODULE)
 361 EXPORT_SYMBOL(com20020_check);
 362 EXPORT_SYMBOL(com20020_found);
 363 EXPORT_SYMBOL(com20020_netdev_ops);
 364 #endif
 365
 366 MODULE_LICENSE("GPL");
 367
 368 #ifdef MODULE
 369
 370 static int __init com20020_module_init(void)
 371 {
 372         if (BUGLVL(D_NORMAL))
 373                 pr_info("%s\n", "COM20020 chipset support (by David Woodhouse et al.)\n");
 374         return 0;
 375 }
 376
 377 static void __exit com20020_module_exit(void)
 378 {
 379 }
 380 module_init(com20020_module_init);
 381 module_exit(com20020_module_exit);
 382 #endif                          /* MODULE */