1 /* sb1000.c: A General Instruments SB1000 driver for linux. */
 
   3         Written 1998 by Franco Venturi.
 
   5         Copyright 1998 by Franco Venturi.
 
   6         Copyright 1994,1995 by Donald Becker.
 
   7         Copyright 1993 United States Government as represented by the
 
   8         Director, National Security Agency.
 
  10         This driver is for the General Instruments SB1000 (internal SURFboard)
 
  12         The author may be reached as fventuri@mediaone.net
 
  14         This program is free software; you can redistribute it
 
  15         and/or  modify it under  the terms of  the GNU General
 
  16         Public  License as  published  by  the  Free  Software
 
  17         Foundation;  either  version 2 of the License, or  (at
 
  18         your option) any later version.
 
  22         981115 Steven Hirsch <shirsch@adelphia.net>
 
  24         Linus changed the timer interface.  Should work on all recent
 
  27         980608 Steven Hirsch <shirsch@adelphia.net>
 
  29         Small changes to make it work with 2.1.x kernels. Hopefully,
 
  30         nothing major will change before official release of Linux 2.2.
 
  32         Merged with 2.2 - Alan Cox
 
  35 static char version[] = "sb1000.c:v1.1.2 6/01/98 (fventuri@mediaone.net)\n";
 
  37 #include <linux/module.h>
 
  38 #include <linux/kernel.h>
 
  39 #include <linux/string.h>
 
  40 #include <linux/interrupt.h>
 
  41 #include <linux/errno.h>
 
  42 #include <linux/if_cablemodem.h> /* for SIOGCM/SIOSCM stuff */
 
  44 #include <linux/slab.h>
 
  45 #include <linux/ioport.h>
 
  46 #include <linux/netdevice.h>
 
  47 #include <linux/if_arp.h>
 
  48 #include <linux/skbuff.h>
 
  49 #include <linux/delay.h>        /* for udelay() */
 
  50 #include <linux/etherdevice.h>
 
  51 #include <linux/pnp.h>
 
  52 #include <linux/init.h>
 
  53 #include <linux/bitops.h>
 
  56 #include <asm/processor.h>
 
  57 #include <asm/uaccess.h>
 
  60 static int sb1000_debug = SB1000_DEBUG;
 
  62 static const int sb1000_debug = 1;
 
  65 static const int SB1000_IO_EXTENT = 8;
 
  66 /* SB1000 Maximum Receive Unit */
 
  67 static const int SB1000_MRU = 1500; /* octects */
 
  70 struct sb1000_private {
 
  71         struct sk_buff *rx_skb[NPIDS];
 
  73         unsigned int rx_frames;
 
  75         short rx_error_dpc_count;
 
  76         unsigned char rx_session_id[NPIDS];
 
  77         unsigned char rx_frame_id[NPIDS];
 
  78         unsigned char rx_pkt_type[NPIDS];
 
  81 /* prototypes for Linux interface */
 
  82 extern int sb1000_probe(struct net_device *dev);
 
  83 static int sb1000_open(struct net_device *dev);
 
  84 static int sb1000_dev_ioctl (struct net_device *dev, struct ifreq *ifr, int cmd);
 
  85 static int sb1000_start_xmit(struct sk_buff *skb, struct net_device *dev);
 
  86 static irqreturn_t sb1000_interrupt(int irq, void *dev_id);
 
  87 static int sb1000_close(struct net_device *dev);
 
  90 /* SB1000 hardware routines to be used during open/configuration phases */
 
  91 static int card_wait_for_busy_clear(const int ioaddr[],
 
  93 static int card_wait_for_ready(const int ioaddr[], const char* name,
 
  95 static int card_send_command(const int ioaddr[], const char* name,
 
  96         const unsigned char out[], unsigned char in[]);
 
  98 /* SB1000 hardware routines to be used during frame rx interrupt */
 
  99 static int sb1000_wait_for_ready(const int ioaddr[], const char* name);
 
 100 static int sb1000_wait_for_ready_clear(const int ioaddr[],
 
 102 static void sb1000_send_command(const int ioaddr[], const char* name,
 
 103         const unsigned char out[]);
 
 104 static void sb1000_read_status(const int ioaddr[], unsigned char in[]);
 
 105 static void sb1000_issue_read_command(const int ioaddr[],
 
 108 /* SB1000 commands for open/configuration */
 
 109 static int sb1000_reset(const int ioaddr[], const char* name);
 
 110 static int sb1000_check_CRC(const int ioaddr[], const char* name);
 
 111 static inline int sb1000_start_get_set_command(const int ioaddr[],
 
 113 static int sb1000_end_get_set_command(const int ioaddr[],
 
 115 static int sb1000_activate(const int ioaddr[], const char* name);
 
 116 static int sb1000_get_firmware_version(const int ioaddr[],
 
 117         const char* name, unsigned char version[], int do_end);
 
 118 static int sb1000_get_frequency(const int ioaddr[], const char* name,
 
 120 static int sb1000_set_frequency(const int ioaddr[], const char* name,
 
 122 static int sb1000_get_PIDs(const int ioaddr[], const char* name,
 
 124 static int sb1000_set_PIDs(const int ioaddr[], const char* name,
 
 127 /* SB1000 commands for frame rx interrupt */
 
 128 static int sb1000_rx(struct net_device *dev);
 
 129 static void sb1000_error_dpc(struct net_device *dev);
 
 131 static const struct pnp_device_id sb1000_pnp_ids[] = {
 
 135 MODULE_DEVICE_TABLE(pnp, sb1000_pnp_ids);
 
 137 static const struct net_device_ops sb1000_netdev_ops = {
 
 138         .ndo_open               = sb1000_open,
 
 139         .ndo_start_xmit         = sb1000_start_xmit,
 
 140         .ndo_do_ioctl           = sb1000_dev_ioctl,
 
 141         .ndo_stop               = sb1000_close,
 
 142         .ndo_change_mtu         = eth_change_mtu,
 
 143         .ndo_set_mac_address    = eth_mac_addr,
 
 144         .ndo_validate_addr      = eth_validate_addr,
 
 148 sb1000_probe_one(struct pnp_dev *pdev, const struct pnp_device_id *id)
 
 150         struct net_device *dev;
 
 151         unsigned short ioaddr[2], irq;
 
 152         unsigned int serial_number;
 
 155         if (pnp_device_attach(pdev) < 0)
 
 157         if (pnp_activate_dev(pdev) < 0)
 
 160         if (!pnp_port_valid(pdev, 0) || !pnp_port_valid(pdev, 1))
 
 162         if (!pnp_irq_valid(pdev, 0))
 
 165         serial_number = pdev->card->serial;
 
 167         ioaddr[0] = pnp_port_start(pdev, 0);
 
 168         ioaddr[1] = pnp_port_start(pdev, 0);
 
 170         irq = pnp_irq(pdev, 0);
 
 172         if (!request_region(ioaddr[0], 16, "sb1000"))
 
 174         if (!request_region(ioaddr[1], 16, "sb1000"))
 
 175                 goto out_release_region0;
 
 177         dev = alloc_etherdev(sizeof(struct sb1000_private));
 
 180                 goto out_release_regions;
 
 184         dev->base_addr = ioaddr[0];
 
 185         /* mem_start holds the second I/O address */
 
 186         dev->mem_start = ioaddr[1];
 
 189         if (sb1000_debug > 0)
 
 190                 printk(KERN_NOTICE "%s: sb1000 at (%#3.3lx,%#3.3lx), "
 
 191                         "S/N %#8.8x, IRQ %d.\n", dev->name, dev->base_addr,
 
 192                         dev->mem_start, serial_number, dev->irq);
 
 195          * The SB1000 is an rx-only cable modem device.  The uplink is a modem
 
 196          * and we do not want to arp on it.
 
 198         dev->flags = IFF_POINTOPOINT|IFF_NOARP;
 
 200         SET_NETDEV_DEV(dev, &pdev->dev);
 
 202         if (sb1000_debug > 0)
 
 203                 printk(KERN_NOTICE "%s", version);
 
 205         dev->netdev_ops = &sb1000_netdev_ops;
 
 207         /* hardware address is 0:0:serial_number */
 
 208         dev->dev_addr[2]        = serial_number >> 24 & 0xff;
 
 209         dev->dev_addr[3]        = serial_number >> 16 & 0xff;
 
 210         dev->dev_addr[4]        = serial_number >>  8 & 0xff;
 
 211         dev->dev_addr[5]        = serial_number >>  0 & 0xff;
 
 213         pnp_set_drvdata(pdev, dev);
 
 215         error = register_netdev(dev);
 
 217                 goto out_free_netdev;
 
 223         release_region(ioaddr[1], 16);
 
 225         release_region(ioaddr[0], 16);
 
 227         pnp_disable_dev(pdev);
 
 229         pnp_device_detach(pdev);
 
 234 sb1000_remove_one(struct pnp_dev *pdev)
 
 236         struct net_device *dev = pnp_get_drvdata(pdev);
 
 238         unregister_netdev(dev);
 
 239         release_region(dev->base_addr, 16);
 
 240         release_region(dev->mem_start, 16);
 
 244 static struct pnp_driver sb1000_driver = {
 
 246         .id_table       = sb1000_pnp_ids,
 
 247         .probe          = sb1000_probe_one,
 
 248         .remove         = sb1000_remove_one,
 
 253  * SB1000 hardware routines to be used during open/configuration phases
 
 256 static const int TimeOutJiffies = (875 * HZ) / 100;
 
 258 /* Card Wait For Busy Clear (cannot be used during an interrupt) */
 
 260 card_wait_for_busy_clear(const int ioaddr[], const char* name)
 
 263         unsigned long timeout;
 
 265         a = inb(ioaddr[0] + 7);
 
 266         timeout = jiffies + TimeOutJiffies;
 
 267         while (a & 0x80 || a & 0x40) {
 
 271                 a = inb(ioaddr[0] + 7);
 
 272                 if (time_after_eq(jiffies, timeout)) {
 
 273                         printk(KERN_WARNING "%s: card_wait_for_busy_clear timeout\n",
 
 282 /* Card Wait For Ready (cannot be used during an interrupt) */
 
 284 card_wait_for_ready(const int ioaddr[], const char* name, unsigned char in[])
 
 287         unsigned long timeout;
 
 289         a = inb(ioaddr[1] + 6);
 
 290         timeout = jiffies + TimeOutJiffies;
 
 291         while (a & 0x80 || !(a & 0x40)) {
 
 295                 a = inb(ioaddr[1] + 6);
 
 296                 if (time_after_eq(jiffies, timeout)) {
 
 297                         printk(KERN_WARNING "%s: card_wait_for_ready timeout\n",
 
 303         in[1] = inb(ioaddr[0] + 1);
 
 304         in[2] = inb(ioaddr[0] + 2);
 
 305         in[3] = inb(ioaddr[0] + 3);
 
 306         in[4] = inb(ioaddr[0] + 4);
 
 307         in[0] = inb(ioaddr[0] + 5);
 
 308         in[6] = inb(ioaddr[0] + 6);
 
 309         in[5] = inb(ioaddr[1] + 6);
 
 313 /* Card Send Command (cannot be used during an interrupt) */
 
 315 card_send_command(const int ioaddr[], const char* name,
 
 316         const unsigned char out[], unsigned char in[])
 
 320         if ((status = card_wait_for_busy_clear(ioaddr, name)))
 
 322         outb(0xa0, ioaddr[0] + 6);
 
 323         outb(out[2], ioaddr[0] + 1);
 
 324         outb(out[3], ioaddr[0] + 2);
 
 325         outb(out[4], ioaddr[0] + 3);
 
 326         outb(out[5], ioaddr[0] + 4);
 
 327         outb(out[1], ioaddr[0] + 5);
 
 328         outb(0xa0, ioaddr[0] + 6);
 
 329         outb(out[0], ioaddr[0] + 7);
 
 330         if (out[0] != 0x20 && out[0] != 0x30) {
 
 331                 if ((status = card_wait_for_ready(ioaddr, name, in)))
 
 334                 if (sb1000_debug > 3)
 
 335                         printk(KERN_DEBUG "%s: card_send_command "
 
 336                                 "out: %02x%02x%02x%02x%02x%02x  "
 
 337                                 "in: %02x%02x%02x%02x%02x%02x%02x\n", name,
 
 338                                 out[0], out[1], out[2], out[3], out[4], out[5],
 
 339                                 in[0], in[1], in[2], in[3], in[4], in[5], in[6]);
 
 341                 if (sb1000_debug > 3)
 
 342                         printk(KERN_DEBUG "%s: card_send_command "
 
 343                                 "out: %02x%02x%02x%02x%02x%02x\n", name,
 
 344                                 out[0], out[1], out[2], out[3], out[4], out[5]);
 
 347         if (out[1] == 0x1b) {
 
 348                 x = (out[2] == 0x02);
 
 350                 if (out[0] >= 0x80 && in[0] != (out[1] | 0x80))
 
 358  * SB1000 hardware routines to be used during frame rx interrupt
 
 360 static const int Sb1000TimeOutJiffies = 7 * HZ;
 
 362 /* Card Wait For Ready (to be used during frame rx) */
 
 364 sb1000_wait_for_ready(const int ioaddr[], const char* name)
 
 366         unsigned long timeout;
 
 368         timeout = jiffies + Sb1000TimeOutJiffies;
 
 369         while (inb(ioaddr[1] + 6) & 0x80) {
 
 370                 if (time_after_eq(jiffies, timeout)) {
 
 371                         printk(KERN_WARNING "%s: sb1000_wait_for_ready timeout\n",
 
 376         timeout = jiffies + Sb1000TimeOutJiffies;
 
 377         while (!(inb(ioaddr[1] + 6) & 0x40)) {
 
 378                 if (time_after_eq(jiffies, timeout)) {
 
 379                         printk(KERN_WARNING "%s: sb1000_wait_for_ready timeout\n",
 
 388 /* Card Wait For Ready Clear (to be used during frame rx) */
 
 390 sb1000_wait_for_ready_clear(const int ioaddr[], const char* name)
 
 392         unsigned long timeout;
 
 394         timeout = jiffies + Sb1000TimeOutJiffies;
 
 395         while (inb(ioaddr[1] + 6) & 0x80) {
 
 396                 if (time_after_eq(jiffies, timeout)) {
 
 397                         printk(KERN_WARNING "%s: sb1000_wait_for_ready_clear timeout\n",
 
 402         timeout = jiffies + Sb1000TimeOutJiffies;
 
 403         while (inb(ioaddr[1] + 6) & 0x40) {
 
 404                 if (time_after_eq(jiffies, timeout)) {
 
 405                         printk(KERN_WARNING "%s: sb1000_wait_for_ready_clear timeout\n",
 
 413 /* Card Send Command (to be used during frame rx) */
 
 415 sb1000_send_command(const int ioaddr[], const char* name,
 
 416         const unsigned char out[])
 
 418         outb(out[2], ioaddr[0] + 1);
 
 419         outb(out[3], ioaddr[0] + 2);
 
 420         outb(out[4], ioaddr[0] + 3);
 
 421         outb(out[5], ioaddr[0] + 4);
 
 422         outb(out[1], ioaddr[0] + 5);
 
 423         outb(out[0], ioaddr[0] + 7);
 
 424         if (sb1000_debug > 3)
 
 425                 printk(KERN_DEBUG "%s: sb1000_send_command out: %02x%02x%02x%02x"
 
 426                         "%02x%02x\n", name, out[0], out[1], out[2], out[3], out[4], out[5]);
 
 430 /* Card Read Status (to be used during frame rx) */
 
 432 sb1000_read_status(const int ioaddr[], unsigned char in[])
 
 434         in[1] = inb(ioaddr[0] + 1);
 
 435         in[2] = inb(ioaddr[0] + 2);
 
 436         in[3] = inb(ioaddr[0] + 3);
 
 437         in[4] = inb(ioaddr[0] + 4);
 
 438         in[0] = inb(ioaddr[0] + 5);
 
 442 /* Issue Read Command (to be used during frame rx) */
 
 444 sb1000_issue_read_command(const int ioaddr[], const char* name)
 
 446         static const unsigned char Command0[6] = {0x20, 0x00, 0x00, 0x01, 0x00, 0x00};
 
 448         sb1000_wait_for_ready_clear(ioaddr, name);
 
 449         outb(0xa0, ioaddr[0] + 6);
 
 450         sb1000_send_command(ioaddr, name, Command0);
 
 456  * SB1000 commands for open/configuration
 
 458 /* reset SB1000 card */
 
 460 sb1000_reset(const int ioaddr[], const char* name)
 
 462         static const unsigned char Command0[6] = {0x80, 0x16, 0x00, 0x00, 0x00, 0x00};
 
 467         port = ioaddr[1] + 6;
 
 481         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 488 /* check SB1000 firmware CRC */
 
 490 sb1000_check_CRC(const int ioaddr[], const char* name)
 
 492         static const unsigned char Command0[6] = {0x80, 0x1f, 0x00, 0x00, 0x00, 0x00};
 
 498         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 500         if (st[1] != st[3] || st[2] != st[4])
 
 502         crc = st[1] << 8 | st[2];
 
 507 sb1000_start_get_set_command(const int ioaddr[], const char* name)
 
 509         static const unsigned char Command0[6] = {0x80, 0x1b, 0x00, 0x00, 0x00, 0x00};
 
 513         return card_send_command(ioaddr, name, Command0, st);
 
 517 sb1000_end_get_set_command(const int ioaddr[], const char* name)
 
 519         static const unsigned char Command0[6] = {0x80, 0x1b, 0x02, 0x00, 0x00, 0x00};
 
 520         static const unsigned char Command1[6] = {0x20, 0x00, 0x00, 0x00, 0x00, 0x00};
 
 525         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 527         return card_send_command(ioaddr, name, Command1, st);
 
 531 sb1000_activate(const int ioaddr[], const char* name)
 
 533         static const unsigned char Command0[6] = {0x80, 0x11, 0x00, 0x00, 0x00, 0x00};
 
 534         static const unsigned char Command1[6] = {0x80, 0x16, 0x00, 0x00, 0x00, 0x00};
 
 540         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 542         if ((status = card_send_command(ioaddr, name, Command1, st)))
 
 545         if ((status = sb1000_start_get_set_command(ioaddr, name)))
 
 550     return sb1000_start_get_set_command(ioaddr, name);
 
 553 /* get SB1000 firmware version */
 
 555 sb1000_get_firmware_version(const int ioaddr[], const char* name,
 
 556         unsigned char version[], int do_end)
 
 558         static const unsigned char Command0[6] = {0x80, 0x23, 0x00, 0x00, 0x00, 0x00};
 
 563         if ((status = sb1000_start_get_set_command(ioaddr, name)))
 
 565         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 572                 return sb1000_end_get_set_command(ioaddr, name);
 
 577 /* get SB1000 frequency */
 
 579 sb1000_get_frequency(const int ioaddr[], const char* name, int* frequency)
 
 581         static const unsigned char Command0[6] = {0x80, 0x44, 0x00, 0x00, 0x00, 0x00};
 
 587         if ((status = sb1000_start_get_set_command(ioaddr, name)))
 
 589         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 591         *frequency = ((st[1] << 8 | st[2]) << 8 | st[3]) << 8 | st[4];
 
 592         return sb1000_end_get_set_command(ioaddr, name);
 
 595 /* set SB1000 frequency */
 
 597 sb1000_set_frequency(const int ioaddr[], const char* name, int frequency)
 
 601         unsigned char Command0[6] = {0x80, 0x29, 0x00, 0x00, 0x00, 0x00};
 
 603         const int FrequencyLowerLimit = 57000;
 
 604         const int FrequencyUpperLimit = 804000;
 
 606         if (frequency < FrequencyLowerLimit || frequency > FrequencyUpperLimit) {
 
 607                 printk(KERN_ERR "%s: frequency chosen (%d kHz) is not in the range "
 
 608                         "[%d,%d] kHz\n", name, frequency, FrequencyLowerLimit,
 
 609                         FrequencyUpperLimit);
 
 613         if ((status = sb1000_start_get_set_command(ioaddr, name)))
 
 615         Command0[5] = frequency & 0xff;
 
 617         Command0[4] = frequency & 0xff;
 
 619         Command0[3] = frequency & 0xff;
 
 621         Command0[2] = frequency & 0xff;
 
 622         return card_send_command(ioaddr, name, Command0, st);
 
 625 /* get SB1000 PIDs */
 
 627 sb1000_get_PIDs(const int ioaddr[], const char* name, short PID[])
 
 629         static const unsigned char Command0[6] = {0x80, 0x40, 0x00, 0x00, 0x00, 0x00};
 
 630         static const unsigned char Command1[6] = {0x80, 0x41, 0x00, 0x00, 0x00, 0x00};
 
 631         static const unsigned char Command2[6] = {0x80, 0x42, 0x00, 0x00, 0x00, 0x00};
 
 632         static const unsigned char Command3[6] = {0x80, 0x43, 0x00, 0x00, 0x00, 0x00};
 
 638         if ((status = sb1000_start_get_set_command(ioaddr, name)))
 
 641         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 643         PID[0] = st[1] << 8 | st[2];
 
 645         if ((status = card_send_command(ioaddr, name, Command1, st)))
 
 647         PID[1] = st[1] << 8 | st[2];
 
 649         if ((status = card_send_command(ioaddr, name, Command2, st)))
 
 651         PID[2] = st[1] << 8 | st[2];
 
 653         if ((status = card_send_command(ioaddr, name, Command3, st)))
 
 655         PID[3] = st[1] << 8 | st[2];
 
 657         return sb1000_end_get_set_command(ioaddr, name);
 
 660 /* set SB1000 PIDs */
 
 662 sb1000_set_PIDs(const int ioaddr[], const char* name, const short PID[])
 
 664         static const unsigned char Command4[6] = {0x80, 0x2e, 0x00, 0x00, 0x00, 0x00};
 
 669         unsigned char Command0[6] = {0x80, 0x31, 0x00, 0x00, 0x00, 0x00};
 
 670         unsigned char Command1[6] = {0x80, 0x32, 0x00, 0x00, 0x00, 0x00};
 
 671         unsigned char Command2[6] = {0x80, 0x33, 0x00, 0x00, 0x00, 0x00};
 
 672         unsigned char Command3[6] = {0x80, 0x34, 0x00, 0x00, 0x00, 0x00};
 
 675         if ((status = sb1000_start_get_set_command(ioaddr, name)))
 
 679         Command0[3] = p & 0xff;
 
 681         Command0[2] = p & 0xff;
 
 682         if ((status = card_send_command(ioaddr, name, Command0, st)))
 
 686         Command1[3] = p & 0xff;
 
 688         Command1[2] = p & 0xff;
 
 689         if ((status = card_send_command(ioaddr, name, Command1, st)))
 
 693         Command2[3] = p & 0xff;
 
 695         Command2[2] = p & 0xff;
 
 696         if ((status = card_send_command(ioaddr, name, Command2, st)))
 
 700         Command3[3] = p & 0xff;
 
 702         Command3[2] = p & 0xff;
 
 703         if ((status = card_send_command(ioaddr, name, Command3, st)))
 
 706         if ((status = card_send_command(ioaddr, name, Command4, st)))
 
 708         return sb1000_end_get_set_command(ioaddr, name);
 
 713 sb1000_print_status_buffer(const char* name, unsigned char st[],
 
 714         unsigned char buffer[], int size)
 
 718         printk(KERN_DEBUG "%s: status: %02x %02x\n", name, st[0], st[1]);
 
 719         if (buffer[24] == 0x08 && buffer[25] == 0x00 && buffer[26] == 0x45) {
 
 720                 printk(KERN_DEBUG "%s: length: %d protocol: %d from: %d.%d.%d.%d:%d "
 
 721                         "to %d.%d.%d.%d:%d\n", name, buffer[28] << 8 | buffer[29],
 
 722                         buffer[35], buffer[38], buffer[39], buffer[40], buffer[41],
 
 723             buffer[46] << 8 | buffer[47],
 
 724                         buffer[42], buffer[43], buffer[44], buffer[45],
 
 725             buffer[48] << 8 | buffer[49]);
 
 727                 for (i = 0, k = 0; i < (size + 7) / 8; i++) {
 
 728                         printk(KERN_DEBUG "%s: %s", name, i ? "       " : "buffer:");
 
 729                         for (j = 0; j < 8 && k < size; j++, k++)
 
 730                                 printk(" %02x", buffer[k]);
 
 738  * SB1000 commands for frame rx interrupt
 
 740 /* receive a single frame and assemble datagram
 
 741  * (this is the heart of the interrupt routine)
 
 744 sb1000_rx(struct net_device *dev)
 
 747 #define FRAMESIZE 184
 
 748         unsigned char st[2], buffer[FRAMESIZE], session_id, frame_id;
 
 751         unsigned int skbsize;
 
 753         struct sb1000_private *lp = netdev_priv(dev);
 
 754         struct net_device_stats *stats = &dev->stats;
 
 756         /* SB1000 frame constants */
 
 757         const int FrameSize = FRAMESIZE;
 
 758         const int NewDatagramHeaderSkip = 8;
 
 759         const int NewDatagramHeaderSize = NewDatagramHeaderSkip + 18;
 
 760         const int NewDatagramDataSize = FrameSize - NewDatagramHeaderSize;
 
 761         const int ContDatagramHeaderSkip = 7;
 
 762         const int ContDatagramHeaderSize = ContDatagramHeaderSkip + 1;
 
 763         const int ContDatagramDataSize = FrameSize - ContDatagramHeaderSize;
 
 764         const int TrailerSize = 4;
 
 766         ioaddr = dev->base_addr;
 
 768         insw(ioaddr, (unsigned short*) st, 1);
 
 770 printk("cm0: received: %02x %02x\n", st[0], st[1]);
 
 771 #endif /* XXXDEBUG */
 
 774         /* decide if it is a good or bad frame */
 
 775         for (ns = 0; ns < NPIDS; ns++) {
 
 776                 session_id = lp->rx_session_id[ns];
 
 777                 frame_id = lp->rx_frame_id[ns];
 
 778                 if (st[0] == session_id) {
 
 779                         if (st[1] == frame_id || (!frame_id && (st[1] & 0xf0) == 0x30)) {
 
 781                         } else if ((st[1] & 0xf0) == 0x30 && (st[0] & 0x40)) {
 
 786                 } else if (st[0] == (session_id | 0x40)) {
 
 787                         if ((st[1] & 0xf0) == 0x30) {
 
 797         stats->rx_frame_errors++;
 
 798         skb = lp->rx_skb[ns];
 
 799         if (sb1000_debug > 1)
 
 800                 printk(KERN_WARNING "%s: missing frame(s): got %02x %02x "
 
 801                         "expecting %02x %02x\n", dev->name, st[0], st[1],
 
 802                         skb ? session_id : session_id | 0x40, frame_id);
 
 809         lp->rx_frame_id[ns] = 0x30 | ((st[1] + 1) & 0x0f);
 
 812                 /* get data length */
 
 813                 insw(ioaddr, buffer, NewDatagramHeaderSize / 2);
 
 815 printk("cm0: IP identification: %02x%02x  fragment offset: %02x%02x\n", buffer[30], buffer[31], buffer[32], buffer[33]);
 
 816 #endif /* XXXDEBUG */
 
 817                 if (buffer[0] != NewDatagramHeaderSkip) {
 
 818                         if (sb1000_debug > 1)
 
 819                                 printk(KERN_WARNING "%s: new datagram header skip error: "
 
 820                                         "got %02x expecting %02x\n", dev->name, buffer[0],
 
 821                                         NewDatagramHeaderSkip);
 
 822                         stats->rx_length_errors++;
 
 823                         insw(ioaddr, buffer, NewDatagramDataSize / 2);
 
 826                 dlen = ((buffer[NewDatagramHeaderSkip + 3] & 0x0f) << 8 |
 
 827                         buffer[NewDatagramHeaderSkip + 4]) - 17;
 
 828                 if (dlen > SB1000_MRU) {
 
 829                         if (sb1000_debug > 1)
 
 830                                 printk(KERN_WARNING "%s: datagram length (%d) greater "
 
 831                                         "than MRU (%d)\n", dev->name, dlen, SB1000_MRU);
 
 832                         stats->rx_length_errors++;
 
 833                         insw(ioaddr, buffer, NewDatagramDataSize / 2);
 
 836                 lp->rx_dlen[ns] = dlen;
 
 837                 /* compute size to allocate for datagram */
 
 838                 skbsize = dlen + FrameSize;
 
 839                 if ((skb = alloc_skb(skbsize, GFP_ATOMIC)) == NULL) {
 
 840                         if (sb1000_debug > 1)
 
 841                                 printk(KERN_WARNING "%s: can't allocate %d bytes long "
 
 842                                         "skbuff\n", dev->name, skbsize);
 
 844                         insw(ioaddr, buffer, NewDatagramDataSize / 2);
 
 848                 skb_reset_mac_header(skb);
 
 849                 skb->protocol = (unsigned short) buffer[NewDatagramHeaderSkip + 16];
 
 850                 insw(ioaddr, skb_put(skb, NewDatagramDataSize),
 
 851                         NewDatagramDataSize / 2);
 
 852                 lp->rx_skb[ns] = skb;
 
 854                 /* continuation of previous datagram */
 
 855                 insw(ioaddr, buffer, ContDatagramHeaderSize / 2);
 
 856                 if (buffer[0] != ContDatagramHeaderSkip) {
 
 857                         if (sb1000_debug > 1)
 
 858                                 printk(KERN_WARNING "%s: cont datagram header skip error: "
 
 859                                         "got %02x expecting %02x\n", dev->name, buffer[0],
 
 860                                         ContDatagramHeaderSkip);
 
 861                         stats->rx_length_errors++;
 
 862                         insw(ioaddr, buffer, ContDatagramDataSize / 2);
 
 865                 skb = lp->rx_skb[ns];
 
 866                 insw(ioaddr, skb_put(skb, ContDatagramDataSize),
 
 867                         ContDatagramDataSize / 2);
 
 868                 dlen = lp->rx_dlen[ns];
 
 870         if (skb->len < dlen + TrailerSize) {
 
 871                 lp->rx_session_id[ns] &= ~0x40;
 
 875         /* datagram completed: send to upper level */
 
 878         stats->rx_bytes+=dlen;
 
 880         lp->rx_skb[ns] = NULL;
 
 881         lp->rx_session_id[ns] |= 0x40;
 
 885         insw(ioaddr, buffer, FrameSize / 2);
 
 886         if (sb1000_debug > 1)
 
 887                 printk(KERN_WARNING "%s: frame error: got %02x %02x\n",
 
 888                         dev->name, st[0], st[1]);
 
 889         stats->rx_frame_errors++;
 
 891         if (sb1000_debug > 2)
 
 892                 sb1000_print_status_buffer(dev->name, st, buffer, FrameSize);
 
 896                 if ((skb = lp->rx_skb[ns])) {
 
 898                         lp->rx_skb[ns] = NULL;
 
 900                 lp->rx_session_id[ns] |= 0x40;
 
 906 sb1000_error_dpc(struct net_device *dev)
 
 908         static const unsigned char Command0[6] = {0x80, 0x26, 0x00, 0x00, 0x00, 0x00};
 
 913         struct sb1000_private *lp = netdev_priv(dev);
 
 914         const int ErrorDpcCounterInitialize = 200;
 
 916         ioaddr[0] = dev->base_addr;
 
 917         /* mem_start holds the second I/O address */
 
 918         ioaddr[1] = dev->mem_start;
 
 921         sb1000_wait_for_ready_clear(ioaddr, name);
 
 922         sb1000_send_command(ioaddr, name, Command0);
 
 923         sb1000_wait_for_ready(ioaddr, name);
 
 924         sb1000_read_status(ioaddr, st);
 
 926                 lp->rx_error_dpc_count = ErrorDpcCounterInitialize;
 
 932  * Linux interface functions
 
 935 sb1000_open(struct net_device *dev)
 
 938         int ioaddr[2], status;
 
 939         struct sb1000_private *lp = netdev_priv(dev);
 
 940         const unsigned short FirmwareVersion[] = {0x01, 0x01};
 
 942         ioaddr[0] = dev->base_addr;
 
 943         /* mem_start holds the second I/O address */
 
 944         ioaddr[1] = dev->mem_start;
 
 947         /* initialize sb1000 */
 
 948         if ((status = sb1000_reset(ioaddr, name)))
 
 951         if ((status = sb1000_check_CRC(ioaddr, name)))
 
 954         /* initialize private data before board can catch interrupts */
 
 955         lp->rx_skb[0] = NULL;
 
 956         lp->rx_skb[1] = NULL;
 
 957         lp->rx_skb[2] = NULL;
 
 958         lp->rx_skb[3] = NULL;
 
 964         lp->rx_error_count = 0;
 
 965         lp->rx_error_dpc_count = 0;
 
 966         lp->rx_session_id[0] = 0x50;
 
 967         lp->rx_session_id[0] = 0x48;
 
 968         lp->rx_session_id[0] = 0x44;
 
 969         lp->rx_session_id[0] = 0x42;
 
 970         lp->rx_frame_id[0] = 0;
 
 971         lp->rx_frame_id[1] = 0;
 
 972         lp->rx_frame_id[2] = 0;
 
 973         lp->rx_frame_id[3] = 0;
 
 974         if (request_irq(dev->irq, &sb1000_interrupt, 0, "sb1000", dev)) {
 
 978         if (sb1000_debug > 2)
 
 979                 printk(KERN_DEBUG "%s: Opening, IRQ %d\n", name, dev->irq);
 
 981         /* Activate board and check firmware version */
 
 983         if ((status = sb1000_activate(ioaddr, name)))
 
 986         if ((status = sb1000_get_firmware_version(ioaddr, name, version, 0)))
 
 988         if (version[0] != FirmwareVersion[0] || version[1] != FirmwareVersion[1])
 
 989                 printk(KERN_WARNING "%s: found firmware version %x.%02x "
 
 990                         "(should be %x.%02x)\n", name, version[0], version[1],
 
 991                         FirmwareVersion[0], FirmwareVersion[1]);
 
 994         netif_start_queue(dev);
 
 995         return 0;                                       /* Always succeed */
 
 998 static int sb1000_dev_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
 
1001         unsigned char version[2];
 
1003         int ioaddr[2], status, frequency;
 
1004         unsigned int stats[5];
 
1005         struct sb1000_private *lp = netdev_priv(dev);
 
1007         if (!(dev && dev->flags & IFF_UP))
 
1010         ioaddr[0] = dev->base_addr;
 
1011         /* mem_start holds the second I/O address */
 
1012         ioaddr[1] = dev->mem_start;
 
1016         case SIOCGCMSTATS:              /* get statistics */
 
1017                 stats[0] = dev->stats.rx_bytes;
 
1018                 stats[1] = lp->rx_frames;
 
1019                 stats[2] = dev->stats.rx_packets;
 
1020                 stats[3] = dev->stats.rx_errors;
 
1021                 stats[4] = dev->stats.rx_dropped;
 
1022                 if(copy_to_user(ifr->ifr_data, stats, sizeof(stats)))
 
1027         case SIOCGCMFIRMWARE:           /* get firmware version */
 
1028                 if ((status = sb1000_get_firmware_version(ioaddr, name, version, 1)))
 
1030                 if(copy_to_user(ifr->ifr_data, version, sizeof(version)))
 
1034         case SIOCGCMFREQUENCY:          /* get frequency */
 
1035                 if ((status = sb1000_get_frequency(ioaddr, name, &frequency)))
 
1037                 if(put_user(frequency, (int __user *) ifr->ifr_data))
 
1041         case SIOCSCMFREQUENCY:          /* set frequency */
 
1042                 if (!capable(CAP_NET_ADMIN))
 
1044                 if(get_user(frequency, (int __user *) ifr->ifr_data))
 
1046                 if ((status = sb1000_set_frequency(ioaddr, name, frequency)))
 
1050         case SIOCGCMPIDS:                       /* get PIDs */
 
1051                 if ((status = sb1000_get_PIDs(ioaddr, name, PID)))
 
1053                 if(copy_to_user(ifr->ifr_data, PID, sizeof(PID)))
 
1057         case SIOCSCMPIDS:                       /* set PIDs */
 
1058                 if (!capable(CAP_NET_ADMIN))
 
1060                 if(copy_from_user(PID, ifr->ifr_data, sizeof(PID)))
 
1062                 if ((status = sb1000_set_PIDs(ioaddr, name, PID)))
 
1064                 /* set session_id, frame_id and pkt_type too */
 
1065                 lp->rx_session_id[0] = 0x50 | (PID[0] & 0x0f);
 
1066                 lp->rx_session_id[1] = 0x48;
 
1067                 lp->rx_session_id[2] = 0x44;
 
1068                 lp->rx_session_id[3] = 0x42;
 
1069                 lp->rx_frame_id[0] = 0;
 
1070                 lp->rx_frame_id[1] = 0;
 
1071                 lp->rx_frame_id[2] = 0;
 
1072                 lp->rx_frame_id[3] = 0;
 
1082 /* transmit function: do nothing since SB1000 can't send anything out */
 
1084 sb1000_start_xmit(struct sk_buff *skb, struct net_device *dev)
 
1086         printk(KERN_WARNING "%s: trying to transmit!!!\n", dev->name);
 
1087         /* sb1000 can't xmit datagrams */
 
1092 /* SB1000 interrupt handler. */
 
1093 static irqreturn_t sb1000_interrupt(int irq, void *dev_id)
 
1095         static const unsigned char Command0[6] = {0x80, 0x2c, 0x00, 0x00, 0x00, 0x00};
 
1096         static const unsigned char Command1[6] = {0x80, 0x2e, 0x00, 0x00, 0x00, 0x00};
 
1101         struct net_device *dev = dev_id;
 
1102         struct sb1000_private *lp = netdev_priv(dev);
 
1104         const int MaxRxErrorCount = 6;
 
1106         ioaddr[0] = dev->base_addr;
 
1107         /* mem_start holds the second I/O address */
 
1108         ioaddr[1] = dev->mem_start;
 
1111         /* is it a good interrupt? */
 
1112         st = inb(ioaddr[1] + 6);
 
1113         if (!(st & 0x08 && st & 0x20)) {
 
1117         if (sb1000_debug > 3)
 
1118                 printk(KERN_DEBUG "%s: entering interrupt\n", dev->name);
 
1120         st = inb(ioaddr[0] + 7);
 
1122                 lp->rx_error_count++;
 
1124         udelay(SB1000_DELAY);
 
1125 #endif /* SB1000_DELAY */
 
1126         sb1000_issue_read_command(ioaddr, name);
 
1128                 sb1000_error_dpc(dev);
 
1129                 sb1000_issue_read_command(ioaddr, name);
 
1131         if (lp->rx_error_dpc_count && !(--lp->rx_error_dpc_count)) {
 
1132                 sb1000_wait_for_ready_clear(ioaddr, name);
 
1133                 sb1000_send_command(ioaddr, name, Command0);
 
1134                 sb1000_wait_for_ready(ioaddr, name);
 
1135                 sb1000_issue_read_command(ioaddr, name);
 
1137         if (lp->rx_error_count >= MaxRxErrorCount) {
 
1138                 sb1000_wait_for_ready_clear(ioaddr, name);
 
1139                 sb1000_send_command(ioaddr, name, Command1);
 
1140                 sb1000_wait_for_ready(ioaddr, name);
 
1141                 sb1000_issue_read_command(ioaddr, name);
 
1142                 lp->rx_error_count = 0;
 
1148 static int sb1000_close(struct net_device *dev)
 
1152         struct sb1000_private *lp = netdev_priv(dev);
 
1154         if (sb1000_debug > 2)
 
1155                 printk(KERN_DEBUG "%s: Shutting down sb1000.\n", dev->name);
 
1157         netif_stop_queue(dev);
 
1159         ioaddr[0] = dev->base_addr;
 
1160         /* mem_start holds the second I/O address */
 
1161         ioaddr[1] = dev->mem_start;
 
1163         free_irq(dev->irq, dev);
 
1164         /* If we don't do this, we can't re-insmod it later. */
 
1165         release_region(ioaddr[1], SB1000_IO_EXTENT);
 
1166         release_region(ioaddr[0], SB1000_IO_EXTENT);
 
1168         /* free rx_skb's if needed */
 
1169         for (i=0; i<4; i++) {
 
1170                 if (lp->rx_skb[i]) {
 
1171                         dev_kfree_skb(lp->rx_skb[i]);
 
1177 MODULE_AUTHOR("Franco Venturi <fventuri@mediaone.net>");
 
1178 MODULE_DESCRIPTION("General Instruments SB1000 driver");
 
1179 MODULE_LICENSE("GPL");
 
1184         return pnp_register_driver(&sb1000_driver);
 
1190         pnp_unregister_driver(&sb1000_driver);
 
1193 module_init(sb1000_init);
 
1194 module_exit(sb1000_exit);