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/io.h>
  41
  42 #include "arcdevice.h"
  43 #include "com20020.h"
  44
  45 static const char * const clockrates[] = {
  46         "XXXXXXX", "XXXXXXXX", "XXXXXX", "2.5 Mb/s",
  47         "1.25Mb/s", "625 Kb/s", "312.5 Kb/s", "156.25 Kb/s",
  48         "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         /* FIXME: do this some other way! */
 196         if (!dev->dev_addr[0])
 197                 dev->dev_addr[0] = inb(ioaddr + BUS_ALIGN * 8);
 198
 199         SET_SUBADR(SUB_SETUP1);
 200         outb(lp->setup, _XREG);
 201
 202         if (lp->card_flags & ARC_CAN_10MBIT) {
 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                 arc_printk(D_NORMAL, dev, "Can't get IRQ %d!\n", dev->irq);
 220                 return -ENODEV;
 221         }
 222
 223         dev->base_addr = ioaddr;
 224
 225         arc_printk(D_NORMAL, dev, "%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                 arc_printk(D_NORMAL, dev, "Using backplane mode.\n");
 230
 231         if (lp->timeout != 3)
 232                 arc_printk(D_NORMAL, dev, "Using extended timeout value of %d\n",
 233                            lp->timeout);
 234
 235         arc_printk(D_NORMAL, dev, "Using CKP %d - data rate %s\n",
 236                    lp->setup >> 1,
 237                    clockrates[3 -
 238                               ((lp->setup2 & 0xF0) >> 4) +
 239                               ((lp->setup & 0x0F) >> 1)]);
 240                         /* The clockrates array index looks very fragile.
 241                          * It seems like it could have negative indexing.
 242                          */
 243
 244         if (register_netdev(dev)) {
 245                 free_irq(dev->irq, dev);
 246                 return -EIO;
 247         }
 248         return 0;
 249 }
 250
 251 /* Do a hardware reset on the card, and set up necessary registers.
 252  *
 253  * This should be called as little as possible, because it disrupts the
 254  * token on the network (causes a RECON) and requires a significant delay.
 255  *
 256  * However, it does make sure the card is in a defined state.
 257  */
 258 static int com20020_reset(struct net_device *dev, int really_reset)
 259 {
 260         struct arcnet_local *lp = netdev_priv(dev);
 261         u_int ioaddr = dev->base_addr;
 262         u_char inbyte;
 263
 264         arc_printk(D_DEBUG, dev, "%s: %d: %s: dev: %p, lp: %p, dev->name: %s\n",
 265                    __FILE__, __LINE__, __func__, dev, lp, dev->name);
 266         arc_printk(D_INIT, dev, "Resetting %s (status=%02Xh)\n",
 267                    dev->name, ASTATUS());
 268
 269         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 270         lp->config = TXENcfg | (lp->timeout << 3) | (lp->backplane << 2);
 271         /* power-up defaults */
 272         SETCONF;
 273         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 274
 275         if (really_reset) {
 276                 /* reset the card */
 277                 ARCRESET;
 278                 mdelay(RESETtime * 2);
 279                                 /* COM20020 seems to be slower sometimes */
 280         }
 281         /* clear flags & end reset */
 282         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 283         ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
 284
 285         /* verify that the ARCnet signature byte is present */
 286         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 287
 288         com20020_copy_from_card(dev, 0, 0, &inbyte, 1);
 289         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 290         if (inbyte != TESTvalue) {
 291                 arc_printk(D_DEBUG, dev, "%s: %d: %s\n",
 292                            __FILE__, __LINE__, __func__);
 293                 arc_printk(D_NORMAL, dev, "reset failed: TESTvalue not present.\n");
 294                 return 1;
 295         }
 296         /* enable extended (512-byte) packets */
 297         ACOMMAND(CONFIGcmd | EXTconf);
 298         arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
 299
 300         /* done!  return success. */
 301         return 0;
 302 }
 303
 304 static void com20020_setmask(struct net_device *dev, int mask)
 305 {
 306         u_int ioaddr = dev->base_addr;
 307
 308         arc_printk(D_DURING, dev, "Setting mask to %x at %x\n", mask, ioaddr);
 309         AINTMASK(mask);
 310 }
 311
 312 static void com20020_command(struct net_device *dev, int cmd)
 313 {
 314         u_int ioaddr = dev->base_addr;
 315
 316         ACOMMAND(cmd);
 317 }
 318
 319 static int com20020_status(struct net_device *dev)
 320 {
 321         u_int ioaddr = dev->base_addr;
 322
 323         return ASTATUS() + (ADIAGSTATUS() << 8);
 324 }
 325
 326 static void com20020_close(struct net_device *dev)
 327 {
 328         struct arcnet_local *lp = netdev_priv(dev);
 329         int ioaddr = dev->base_addr;
 330
 331         /* disable transmitter */
 332         lp->config &= ~TXENcfg;
 333         SETCONF;
 334 }
 335
 336 /* Set or clear the multicast filter for this adaptor.
 337  * num_addrs == -1    Promiscuous mode, receive all packets
 338  * num_addrs == 0       Normal mode, clear multicast list
 339  * num_addrs > 0        Multicast mode, receive normal and MC packets, and do
 340  *                      best-effort filtering.
 341  *      FIXME - do multicast stuff, not just promiscuous.
 342  */
 343 static void com20020_set_mc_list(struct net_device *dev)
 344 {
 345         struct arcnet_local *lp = netdev_priv(dev);
 346         int ioaddr = dev->base_addr;
 347
 348         if ((dev->flags & IFF_PROMISC) && (dev->flags & IFF_UP)) {
 349                 /* Enable promiscuous mode */
 350                 if (!(lp->setup & PROMISCset))
 351                         arc_printk(D_NORMAL, dev, "Setting promiscuous flag...\n");
 352                 SET_SUBADR(SUB_SETUP1);
 353                 lp->setup |= PROMISCset;
 354                 outb(lp->setup, _XREG);
 355         } else {
 356                 /* Disable promiscuous mode, use normal mode */
 357                 if ((lp->setup & PROMISCset))
 358                         arc_printk(D_NORMAL, dev, "Resetting promiscuous flag...\n");
 359                 SET_SUBADR(SUB_SETUP1);
 360                 lp->setup &= ~PROMISCset;
 361                 outb(lp->setup, _XREG);
 362         }
 363 }
 364
 365 #if defined(CONFIG_ARCNET_COM20020_PCI_MODULE) || \
 366     defined(CONFIG_ARCNET_COM20020_ISA_MODULE) || \
 367     defined(CONFIG_ARCNET_COM20020_CS_MODULE)
 368 EXPORT_SYMBOL(com20020_check);
 369 EXPORT_SYMBOL(com20020_found);
 370 EXPORT_SYMBOL(com20020_netdev_ops);
 371 #endif
 372
 373 MODULE_LICENSE("GPL");
 374
 375 #ifdef MODULE
 376
 377 static int __init com20020_module_init(void)
 378 {
 379         if (BUGLVL(D_NORMAL))
 380                 pr_info("%s\n", "COM20020 chipset support (by David Woodhouse et al.)");
 381         return 0;
 382 }
 383
 384 static void __exit com20020_module_exit(void)
 385 {
 386 }
 387 module_init(com20020_module_init);
 388 module_exit(com20020_module_exit);
 389 #endif                          /* MODULE */