drivers/net/wan/n2.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * SDL Inc. RISCom/N2 synchronous serial card driver for Linux
   4  *
   5  * Copyright (C) 1998-2003 Krzysztof Halasa <khc@pm.waw.pl>
   6  *
   7  * For information see <https://www.kernel.org/pub/linux/utils/net/hdlc/>
   8  *
   9  * Note: integrated CSU/DSU/DDS are not supported by this driver
  10  *
  11  * Sources of information:
  12  *    Hitachi HD64570 SCA User's Manual
  13  *    SDL Inc. PPP/HDLC/CISCO driver
  14  */
  15
  16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  17
  18 #include <linux/module.h>
  19 #include <linux/kernel.h>
  20 #include <linux/capability.h>
  21 #include <linux/slab.h>
  22 #include <linux/types.h>
  23 #include <linux/fcntl.h>
  24 #include <linux/in.h>
  25 #include <linux/string.h>
  26 #include <linux/errno.h>
  27 #include <linux/init.h>
  28 #include <linux/ioport.h>
  29 #include <linux/moduleparam.h>
  30 #include <linux/netdevice.h>
  31 #include <linux/hdlc.h>
  32 #include <asm/io.h>
  33 #include "hd64570.h"
  34
  35 static const char *version = "SDL RISCom/N2 driver version: 1.15";
  36 static const char *devname = "RISCom/N2";
  37
  38 #undef DEBUG_PKT
  39 #define DEBUG_RINGS
  40
  41 #define USE_WINDOWSIZE 16384
  42 #define USE_BUS16BITS 1
  43 #define CLOCK_BASE 9830400      /* 9.8304 MHz */
  44 #define MAX_PAGES      16       /* 16 RAM pages at max */
  45 #define MAX_RAM_SIZE 0x80000    /* 512 KB */
  46 #if MAX_RAM_SIZE > MAX_PAGES * USE_WINDOWSIZE
  47 #undef MAX_RAM_SIZE
  48 #define MAX_RAM_SIZE (MAX_PAGES * USE_WINDOWSIZE)
  49 #endif
  50 #define N2_IOPORTS 0x10
  51 #define NEED_DETECT_RAM
  52 #define NEED_SCA_MSCI_INTR
  53 #define MAX_TX_BUFFERS 10
  54
  55 static char *hw;        /* pointer to hw=xxx command line string */
  56
  57 /* RISCom/N2 Board Registers */
  58
  59 /* PC Control Register */
  60 #define N2_PCR 0
  61 #define PCR_RUNSCA 1     /* Run 64570 */
  62 #define PCR_VPM    2     /* Enable VPM - needed if using RAM above 1 MB */
  63 #define PCR_ENWIN  4     /* Open window */
  64 #define PCR_BUS16  8     /* 16-bit bus */
  65
  66 /* Memory Base Address Register */
  67 #define N2_BAR 2
  68
  69 /* Page Scan Register  */
  70 #define N2_PSR 4
  71 #define WIN16K       0x00
  72 #define WIN32K       0x20
  73 #define WIN64K       0x40
  74 #define PSR_WINBITS  0x60
  75 #define PSR_DMAEN    0x80
  76 #define PSR_PAGEBITS 0x0F
  77
  78 /* Modem Control Reg */
  79 #define N2_MCR 6
  80 #define CLOCK_OUT_PORT1 0x80
  81 #define CLOCK_OUT_PORT0 0x40
  82 #define TX422_PORT1     0x20
  83 #define TX422_PORT0     0x10
  84 #define DSR_PORT1       0x08
  85 #define DSR_PORT0       0x04
  86 #define DTR_PORT1       0x02
  87 #define DTR_PORT0       0x01
  88
  89 typedef struct port_s {
  90         struct net_device *dev;
  91         struct card_s *card;
  92         spinlock_t lock;        /* TX lock */
  93         sync_serial_settings settings;
  94         int valid;              /* port enabled */
  95         int rxpart;             /* partial frame received, next frame invalid*/
  96         unsigned short encoding;
  97         unsigned short parity;
  98         u16 rxin;               /* rx ring buffer 'in' pointer */
  99         u16 txin;               /* tx ring buffer 'in' and 'last' pointers */
 100         u16 txlast;
 101         u8 rxs, txs, tmc;       /* SCA registers */
 102         u8 phy_node;            /* physical port # - 0 or 1 */
 103         u8 log_node;            /* logical port # */
 104 } port_t;
 105
 106 typedef struct card_s {
 107         u8 __iomem *winbase;            /* ISA window base address */
 108         u32 phy_winbase;        /* ISA physical base address */
 109         u32 ram_size;           /* number of bytes */
 110         u16 io;                 /* IO Base address */
 111         u16 buff_offset;        /* offset of first buffer of first channel */
 112         u16 rx_ring_buffers;    /* number of buffers in a ring */
 113         u16 tx_ring_buffers;
 114         u8 irq;                 /* IRQ (3-15) */
 115
 116         port_t ports[2];
 117         struct card_s *next_card;
 118 } card_t;
 119
 120 static card_t *first_card;
 121 static card_t **new_card = &first_card;
 122
 123 #define sca_reg(reg, card) (0x8000 | (card)->io | \
 124                             ((reg) & 0x0F) | (((reg) & 0xF0) << 6))
 125 #define sca_in(reg, card)               inb(sca_reg(reg, card))
 126 #define sca_out(value, reg, card)       outb(value, sca_reg(reg, card))
 127 #define sca_inw(reg, card)              inw(sca_reg(reg, card))
 128 #define sca_outw(value, reg, card)      outw(value, sca_reg(reg, card))
 129
 130 #define port_to_card(port)              ((port)->card)
 131 #define log_node(port)                  ((port)->log_node)
 132 #define phy_node(port)                  ((port)->phy_node)
 133 #define winsize(card)                   (USE_WINDOWSIZE)
 134 #define winbase(card)                   ((card)->winbase)
 135 #define get_port(card, port)            ((card)->ports[port].valid ? \
 136                                          &(card)->ports[port] : NULL)
 137
 138 static __inline__ u8 sca_get_page(card_t *card)
 139 {
 140         return inb(card->io + N2_PSR) & PSR_PAGEBITS;
 141 }
 142
 143 static __inline__ void openwin(card_t *card, u8 page)
 144 {
 145         u8 psr = inb(card->io + N2_PSR);
 146
 147         outb((psr & ~PSR_PAGEBITS) | page, card->io + N2_PSR);
 148 }
 149
 150 #include "hd64570.c"
 151
 152 static void n2_set_iface(port_t *port)
 153 {
 154         card_t *card = port->card;
 155         int io = card->io;
 156         u8 mcr = inb(io + N2_MCR);
 157         u8 msci = get_msci(port);
 158         u8 rxs = port->rxs & CLK_BRG_MASK;
 159         u8 txs = port->txs & CLK_BRG_MASK;
 160
 161         switch (port->settings.clock_type) {
 162         case CLOCK_INT:
 163                 mcr |= port->phy_node ? CLOCK_OUT_PORT1 : CLOCK_OUT_PORT0;
 164                 rxs |= CLK_BRG_RX; /* BRG output */
 165                 txs |= CLK_RXCLK_TX; /* RX clock */
 166                 break;
 167
 168         case CLOCK_TXINT:
 169                 mcr |= port->phy_node ? CLOCK_OUT_PORT1 : CLOCK_OUT_PORT0;
 170                 rxs |= CLK_LINE_RX; /* RXC input */
 171                 txs |= CLK_BRG_TX; /* BRG output */
 172                 break;
 173
 174         case CLOCK_TXFROMRX:
 175                 mcr |= port->phy_node ? CLOCK_OUT_PORT1 : CLOCK_OUT_PORT0;
 176                 rxs |= CLK_LINE_RX; /* RXC input */
 177                 txs |= CLK_RXCLK_TX; /* RX clock */
 178                 break;
 179
 180         default:                /* Clock EXTernal */
 181                 mcr &= port->phy_node ? ~CLOCK_OUT_PORT1 : ~CLOCK_OUT_PORT0;
 182                 rxs |= CLK_LINE_RX; /* RXC input */
 183                 txs |= CLK_LINE_TX; /* TXC input */
 184         }
 185
 186         outb(mcr, io + N2_MCR);
 187         port->rxs = rxs;
 188         port->txs = txs;
 189         sca_out(rxs, msci + RXS, card);
 190         sca_out(txs, msci + TXS, card);
 191         sca_set_port(port);
 192 }
 193
 194 static int n2_open(struct net_device *dev)
 195 {
 196         port_t *port = dev_to_port(dev);
 197         int io = port->card->io;
 198         u8 mcr = inb(io + N2_MCR) | (port->phy_node ? TX422_PORT1:TX422_PORT0);
 199         int result;
 200
 201         result = hdlc_open(dev);
 202         if (result)
 203                 return result;
 204
 205         mcr &= port->phy_node ? ~DTR_PORT1 : ~DTR_PORT0; /* set DTR ON */
 206         outb(mcr, io + N2_MCR);
 207
 208         outb(inb(io + N2_PCR) | PCR_ENWIN, io + N2_PCR); /* open window */
 209         outb(inb(io + N2_PSR) | PSR_DMAEN, io + N2_PSR); /* enable dma */
 210         sca_open(dev);
 211         n2_set_iface(port);
 212         return 0;
 213 }
 214
 215 static int n2_close(struct net_device *dev)
 216 {
 217         port_t *port = dev_to_port(dev);
 218         int io = port->card->io;
 219         u8 mcr = inb(io+N2_MCR) | (port->phy_node ? TX422_PORT1 : TX422_PORT0);
 220
 221         sca_close(dev);
 222         mcr |= port->phy_node ? DTR_PORT1 : DTR_PORT0; /* set DTR OFF */
 223         outb(mcr, io + N2_MCR);
 224         hdlc_close(dev);
 225         return 0;
 226 }
 227
 228 static int n2_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
 229 {
 230         const size_t size = sizeof(sync_serial_settings);
 231         sync_serial_settings new_line;
 232         sync_serial_settings __user *line = ifr->ifr_settings.ifs_ifsu.sync;
 233         port_t *port = dev_to_port(dev);
 234
 235 #ifdef DEBUG_RINGS
 236         if (cmd == SIOCDEVPRIVATE) {
 237                 sca_dump_rings(dev);
 238                 return 0;
 239         }
 240 #endif
 241         if (cmd != SIOCWANDEV)
 242                 return hdlc_ioctl(dev, ifr, cmd);
 243
 244         switch (ifr->ifr_settings.type) {
 245         case IF_GET_IFACE:
 246                 ifr->ifr_settings.type = IF_IFACE_SYNC_SERIAL;
 247                 if (ifr->ifr_settings.size < size) {
 248                         ifr->ifr_settings.size = size; /* data size wanted */
 249                         return -ENOBUFS;
 250                 }
 251                 if (copy_to_user(line, &port->settings, size))
 252                         return -EFAULT;
 253                 return 0;
 254
 255         case IF_IFACE_SYNC_SERIAL:
 256                 if (!capable(CAP_NET_ADMIN))
 257                         return -EPERM;
 258
 259                 if (copy_from_user(&new_line, line, size))
 260                         return -EFAULT;
 261
 262                 if (new_line.clock_type != CLOCK_EXT &&
 263                     new_line.clock_type != CLOCK_TXFROMRX &&
 264                     new_line.clock_type != CLOCK_INT &&
 265                     new_line.clock_type != CLOCK_TXINT)
 266                         return -EINVAL; /* No such clock setting */
 267
 268                 if (new_line.loopback != 0 && new_line.loopback != 1)
 269                         return -EINVAL;
 270
 271                 memcpy(&port->settings, &new_line, size); /* Update settings */
 272                 n2_set_iface(port);
 273                 return 0;
 274
 275         default:
 276                 return hdlc_ioctl(dev, ifr, cmd);
 277         }
 278 }
 279
 280 static void n2_destroy_card(card_t *card)
 281 {
 282         int cnt;
 283
 284         for (cnt = 0; cnt < 2; cnt++)
 285                 if (card->ports[cnt].card) {
 286                         struct net_device *dev = port_to_dev(&card->ports[cnt]);
 287
 288                         unregister_hdlc_device(dev);
 289                 }
 290
 291         if (card->irq)
 292                 free_irq(card->irq, card);
 293
 294         if (card->winbase) {
 295                 iounmap(card->winbase);
 296                 release_mem_region(card->phy_winbase, USE_WINDOWSIZE);
 297         }
 298
 299         if (card->io)
 300                 release_region(card->io, N2_IOPORTS);
 301         if (card->ports[0].dev)
 302                 free_netdev(card->ports[0].dev);
 303         if (card->ports[1].dev)
 304                 free_netdev(card->ports[1].dev);
 305         kfree(card);
 306 }
 307
 308 static const struct net_device_ops n2_ops = {
 309         .ndo_open       = n2_open,
 310         .ndo_stop       = n2_close,
 311         .ndo_start_xmit = hdlc_start_xmit,
 312         .ndo_do_ioctl   = n2_ioctl,
 313 };
 314
 315 static int __init n2_run(unsigned long io, unsigned long irq,
 316                          unsigned long winbase, long valid0, long valid1)
 317 {
 318         card_t *card;
 319         u8 cnt, pcr;
 320         int i;
 321
 322         if (io < 0x200 || io > 0x3FF || (io % N2_IOPORTS) != 0) {
 323                 pr_err("invalid I/O port value\n");
 324                 return -ENODEV;
 325         }
 326
 327         if (irq < 3 || irq > 15 || irq == 6) /* FIXME */ {
 328                 pr_err("invalid IRQ value\n");
 329                 return -ENODEV;
 330         }
 331
 332         if (winbase < 0xA0000 || winbase > 0xFFFFF || (winbase & 0xFFF) != 0) {
 333                 pr_err("invalid RAM value\n");
 334                 return -ENODEV;
 335         }
 336
 337         card = kzalloc(sizeof(card_t), GFP_KERNEL);
 338         if (!card)
 339                 return -ENOBUFS;
 340
 341         card->ports[0].dev = alloc_hdlcdev(&card->ports[0]);
 342         card->ports[1].dev = alloc_hdlcdev(&card->ports[1]);
 343         if (!card->ports[0].dev || !card->ports[1].dev) {
 344                 pr_err("unable to allocate memory\n");
 345                 n2_destroy_card(card);
 346                 return -ENOMEM;
 347         }
 348
 349         if (!request_region(io, N2_IOPORTS, devname)) {
 350                 pr_err("I/O port region in use\n");
 351                 n2_destroy_card(card);
 352                 return -EBUSY;
 353         }
 354         card->io = io;
 355
 356         if (request_irq(irq, sca_intr, 0, devname, card)) {
 357                 pr_err("could not allocate IRQ\n");
 358                 n2_destroy_card(card);
 359                 return -EBUSY;
 360         }
 361         card->irq = irq;
 362
 363         if (!request_mem_region(winbase, USE_WINDOWSIZE, devname)) {
 364                 pr_err("could not request RAM window\n");
 365                 n2_destroy_card(card);
 366                 return -EBUSY;
 367         }
 368         card->phy_winbase = winbase;
 369         card->winbase = ioremap(winbase, USE_WINDOWSIZE);
 370         if (!card->winbase) {
 371                 pr_err("ioremap() failed\n");
 372                 n2_destroy_card(card);
 373                 return -EFAULT;
 374         }
 375
 376         outb(0, io + N2_PCR);
 377         outb(winbase >> 12, io + N2_BAR);
 378
 379         switch (USE_WINDOWSIZE) {
 380         case 16384:
 381                 outb(WIN16K, io + N2_PSR);
 382                 break;
 383
 384         case 32768:
 385                 outb(WIN32K, io + N2_PSR);
 386                 break;
 387
 388         case 65536:
 389                 outb(WIN64K, io + N2_PSR);
 390                 break;
 391
 392         default:
 393                 pr_err("invalid window size\n");
 394                 n2_destroy_card(card);
 395                 return -ENODEV;
 396         }
 397
 398         pcr = PCR_ENWIN | PCR_VPM | (USE_BUS16BITS ? PCR_BUS16 : 0);
 399         outb(pcr, io + N2_PCR);
 400
 401         card->ram_size = sca_detect_ram(card, card->winbase, MAX_RAM_SIZE);
 402
 403         /* number of TX + RX buffers for one port */
 404         i = card->ram_size / ((valid0 + valid1) * (sizeof(pkt_desc) +
 405                                                    HDLC_MAX_MRU));
 406
 407         card->tx_ring_buffers = min(i / 2, MAX_TX_BUFFERS);
 408         card->rx_ring_buffers = i - card->tx_ring_buffers;
 409
 410         card->buff_offset = (valid0 + valid1) * sizeof(pkt_desc) *
 411                 (card->tx_ring_buffers + card->rx_ring_buffers);
 412
 413         pr_info("RISCom/N2 %u KB RAM, IRQ%u, using %u TX + %u RX packets rings\n",
 414                 card->ram_size / 1024, card->irq,
 415                 card->tx_ring_buffers, card->rx_ring_buffers);
 416
 417         if (card->tx_ring_buffers < 1) {
 418                 pr_err("RAM test failed\n");
 419                 n2_destroy_card(card);
 420                 return -EIO;
 421         }
 422
 423         pcr |= PCR_RUNSCA;              /* run SCA */
 424         outb(pcr, io + N2_PCR);
 425         outb(0, io + N2_MCR);
 426
 427         sca_init(card, 0);
 428         for (cnt = 0; cnt < 2; cnt++) {
 429                 port_t *port = &card->ports[cnt];
 430                 struct net_device *dev = port_to_dev(port);
 431                 hdlc_device *hdlc = dev_to_hdlc(dev);
 432
 433                 if ((cnt == 0 && !valid0) || (cnt == 1 && !valid1))
 434                         continue;
 435
 436                 port->phy_node = cnt;
 437                 port->valid = 1;
 438
 439                 if ((cnt == 1) && valid0)
 440                         port->log_node = 1;
 441
 442                 spin_lock_init(&port->lock);
 443                 dev->irq = irq;
 444                 dev->mem_start = winbase;
 445                 dev->mem_end = winbase + USE_WINDOWSIZE - 1;
 446                 dev->tx_queue_len = 50;
 447                 dev->netdev_ops = &n2_ops;
 448                 hdlc->attach = sca_attach;
 449                 hdlc->xmit = sca_xmit;
 450                 port->settings.clock_type = CLOCK_EXT;
 451                 port->card = card;
 452
 453                 if (register_hdlc_device(dev)) {
 454                         pr_warn("unable to register hdlc device\n");
 455                         port->card = NULL;
 456                         n2_destroy_card(card);
 457                         return -ENOBUFS;
 458                 }
 459                 sca_init_port(port); /* Set up SCA memory */
 460
 461                 netdev_info(dev, "RISCom/N2 node %d\n", port->phy_node);
 462         }
 463
 464         *new_card = card;
 465         new_card = &card->next_card;
 466
 467         return 0;
 468 }
 469
 470 static int __init n2_init(void)
 471 {
 472         if (!hw) {
 473 #ifdef MODULE
 474                 pr_info("no card initialized\n");
 475 #endif
 476                 return -EINVAL; /* no parameters specified, abort */
 477         }
 478
 479         pr_info("%s\n", version);
 480
 481         do {
 482                 unsigned long io, irq, ram;
 483                 long valid[2] = { 0, 0 }; /* Default = both ports disabled */
 484
 485                 io = simple_strtoul(hw, &hw, 0);
 486
 487                 if (*hw++ != ',')
 488                         break;
 489                 irq = simple_strtoul(hw, &hw, 0);
 490
 491                 if (*hw++ != ',')
 492                         break;
 493                 ram = simple_strtoul(hw, &hw, 0);
 494
 495                 if (*hw++ != ',')
 496                         break;
 497                 while (1) {
 498                         if (*hw == '0' && !valid[0])
 499                                 valid[0] = 1; /* Port 0 enabled */
 500                         else if (*hw == '1' && !valid[1])
 501                                 valid[1] = 1; /* Port 1 enabled */
 502                         else
 503                                 break;
 504                         hw++;
 505                 }
 506
 507                 if (!valid[0] && !valid[1])
 508                         break;  /* at least one port must be used */
 509
 510                 if (*hw == ':' || *hw == '\x0')
 511                         n2_run(io, irq, ram, valid[0], valid[1]);
 512
 513                 if (*hw == '\x0')
 514                         return first_card ? 0 : -EINVAL;
 515         } while (*hw++ == ':');
 516
 517         pr_err("invalid hardware parameters\n");
 518         return first_card ? 0 : -EINVAL;
 519 }
 520
 521 static void __exit n2_cleanup(void)
 522 {
 523         card_t *card = first_card;
 524
 525         while (card) {
 526                 card_t *ptr = card;
 527
 528                 card = card->next_card;
 529                 n2_destroy_card(ptr);
 530         }
 531 }
 532
 533 module_init(n2_init);
 534 module_exit(n2_cleanup);
 535
 536 MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
 537 MODULE_DESCRIPTION("RISCom/N2 serial port driver");
 538 MODULE_LICENSE("GPL v2");
 539 module_param(hw, charp, 0444);
 540 MODULE_PARM_DESC(hw, "io,irq,ram,ports:io,irq,...");