sys/net/i4b/layer1/isic/i4b_elsa_pcc16.c

   1 /*
   2  * Copyright (c) 1999, 2001 Hellmuth Michaelis. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  *
  25  *---------------------------------------------------------------------------
  26  *
  27  *      isic - I4B driver for ELSA MicroLink ISDN/PCC-16 and ELSA PCFpro
  28  *      ================================================================
  29  *
  30  * $FreeBSD: src/sys/i4b/layer1/isic/i4b_elsa_pcc16.c,v 1.5.2.2 2001/10/24 14:17:20 hm Exp $
  31  * $DragonFly: src/sys/net/i4b/layer1/isic/i4b_elsa_pcc16.c,v 1.3 2003/08/07 21:17:26 dillon Exp $
  32  *
  33  *      last edit-date: [Wed Oct 24 16:15:26 2001]
  34  *
  35  *---------------------------------------------------------------------------*/
  36
  37 #include "use_isic.h"
  38 #include "opt_i4b.h"
  39
  40 #if (NISIC > 0) && defined(ELSA_PCC16)
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/socket.h>
  45 #include <net/if.h>
  46
  47 #include <machine/i4b_ioctl.h>
  48
  49 #include "i4b_isic.h"
  50 #include "i4b_hscx.h"
  51
  52 static void i4b_epcc16_clrirq(struct l1_softc *sc);
  53
  54 /* masks for register encoded in base addr */
  55
  56 #define ELSA_BASE_MASK          0x0ffff
  57 #define ELSA_OFF_MASK           0xf0000
  58
  59 /* register id's to be encoded in base addr */
  60
  61 #define ELSA_IDISAC             0x00000
  62 #define ELSA_IDHSCXA            0x10000
  63 #define ELSA_IDHSCXB            0x20000
  64
  65 /* offsets from base address */
  66
  67 #define ELSA_OFF_ISAC           0x00
  68 #define ELSA_OFF_HSCX           0x02
  69 #define ELSA_OFF_OFF            0x03
  70 #define ELSA_OFF_CTRL           0x04
  71 #define ELSA_OFF_CFG            0x05
  72 #define ELSA_OFF_TIMR           0x06
  73 #define ELSA_OFF_IRQ            0x07
  74
  75 /* control register (write access) */
  76
  77 #define ELSA_CTRL_LED_YELLOW    0x02
  78 #define ELSA_CTRL_LED_GREEN     0x08
  79 #define ELSA_CTRL_RESET         0x20
  80 #define ELSA_CTRL_TIMEREN       0x80
  81 #define ELSA_CTRL_SECRET        0x50
  82
  83 /*---------------------------------------------------------------------------*
  84  *      ELSA MicroLink ISDN/PCC-16 clear IRQ routine
  85  *---------------------------------------------------------------------------*/
  86 static void
  87 i4b_epcc16_clrirq(struct l1_softc *sc)
  88 {
  89         bus_space_tag_t    t = rman_get_bustag(sc->sc_resources.io_base[0]);
  90         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
  91         bus_space_write_1(t, h, ELSA_OFF_IRQ, 0);
  92 }
  93
  94 /*---------------------------------------------------------------------------*
  95  *      ELSA MicroLink ISDN/PCC-16 ISAC get fifo routine
  96  *---------------------------------------------------------------------------*/
  97 static void
  98 epcc16_read_fifo(struct l1_softc *sc, int what, void *buf, size_t size)
  99 {
 100         bus_space_tag_t    t = rman_get_bustag(sc->sc_resources.io_base[0]);
 101         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
 102
 103         switch (what) {
 104                 case ISIC_WHAT_ISAC:
 105                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0);
 106                         bus_space_read_multi_1(t, h, ELSA_OFF_ISAC, buf, size);
 107                         break;
 108                 case ISIC_WHAT_HSCXA:
 109                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0);
 110                         bus_space_read_multi_1(t, h, ELSA_OFF_HSCX, buf, size);
 111                         break;
 112                 case ISIC_WHAT_HSCXB:
 113                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0x40);
 114                         bus_space_read_multi_1(t, h, ELSA_OFF_HSCX, buf, size);
 115                         break;
 116         }
 117 }
 118
 119 /*---------------------------------------------------------------------------*
 120  *      ELSA MicroLink ISDN/PCC-16 ISAC put fifo routine
 121  *---------------------------------------------------------------------------*/
 122 static void
 123 epcc16_write_fifo(struct l1_softc *sc, int what, void *buf, size_t size)
 124 {
 125         bus_space_tag_t    t = rman_get_bustag(sc->sc_resources.io_base[0]);
 126         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
 127
 128         switch (what) {
 129                 case ISIC_WHAT_ISAC:
 130                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0);
 131                         bus_space_write_multi_1(t, h, ELSA_OFF_ISAC, buf, size);
 132                         break;
 133                 case ISIC_WHAT_HSCXA:
 134                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0);
 135                         bus_space_write_multi_1(t, h, ELSA_OFF_HSCX, buf, size);
 136                         break;
 137                 case ISIC_WHAT_HSCXB:
 138                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0x40);
 139                         bus_space_write_multi_1(t, h, ELSA_OFF_HSCX, buf, size);
 140                         break;
 141         }
 142 }
 143
 144 /*---------------------------------------------------------------------------*
 145  *      ELSA MicroLink ISDN/PCC-16 ISAC put register routine
 146  *---------------------------------------------------------------------------*/
 147 static void
 148 epcc16_write_reg(struct l1_softc *sc, int what, bus_size_t offs, u_int8_t data)
 149 {
 150         bus_space_tag_t    t = rman_get_bustag(sc->sc_resources.io_base[0]);
 151         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
 152
 153         switch (what) {
 154                 case ISIC_WHAT_ISAC:
 155                         bus_space_write_1(t, h, ELSA_OFF_OFF, offs);
 156                         bus_space_write_1(t, h, ELSA_OFF_ISAC, data);
 157                         break;
 158                 case ISIC_WHAT_HSCXA:
 159                         bus_space_write_1(t, h, ELSA_OFF_OFF, offs);
 160                         bus_space_write_1(t, h, ELSA_OFF_HSCX, data);
 161                         break;
 162                 case ISIC_WHAT_HSCXB:
 163                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0x40+offs);
 164                         bus_space_write_1(t, h, ELSA_OFF_HSCX, data);
 165                         break;
 166         }
 167 }
 168
 169 /*---------------------------------------------------------------------------*
 170  *      ELSA MicroLink ISDN/PCC-16 ISAC get register routine
 171  *---------------------------------------------------------------------------*/
 172 static u_int8_t
 173 epcc16_read_reg(struct l1_softc *sc, int what, bus_size_t offs)
 174 {
 175         bus_space_tag_t    t = rman_get_bustag(sc->sc_resources.io_base[0]);
 176         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
 177
 178         switch (what) {
 179                 case ISIC_WHAT_ISAC:
 180                         bus_space_write_1(t, h, ELSA_OFF_OFF, offs);
 181                         return bus_space_read_1(t, h, ELSA_OFF_ISAC);
 182                 case ISIC_WHAT_HSCXA:
 183                         bus_space_write_1(t, h, ELSA_OFF_OFF, offs);
 184                         return bus_space_read_1(t, h, ELSA_OFF_HSCX);
 185                 case ISIC_WHAT_HSCXB:
 186                         bus_space_write_1(t, h, ELSA_OFF_OFF, 0x40+offs);
 187                         return bus_space_read_1(t, h, ELSA_OFF_HSCX);
 188         }
 189         return 0;
 190 }
 191
 192 /*---------------------------------------------------------------------------*
 193  *      isic_detach_Epcc16 - detach for ELSA MicroLink ISDN/PCC-16
 194  *---------------------------------------------------------------------------*/
 195 static void
 196 isic_detach_Epcc16(device_t dev)
 197 {
 198         struct l1_softc *sc = &l1_sc[device_get_unit(dev)];
 199
 200         if ( sc->sc_resources.irq )
 201         {
 202                 bus_teardown_intr(dev,sc->sc_resources.irq,
 203                         (void(*)(void *))isicintr);
 204                 bus_release_resource(dev,SYS_RES_IRQ,
 205                                         sc->sc_resources.irq_rid,
 206                                         sc->sc_resources.irq);
 207                 sc->sc_resources.irq = 0;
 208         }
 209
 210         if ( sc->sc_resources.io_base[0] ) {
 211                 bus_release_resource(dev,SYS_RES_IOPORT,
 212                                         sc->sc_resources.io_rid[0],
 213                                         sc->sc_resources.io_base[0]);
 214                 sc->sc_resources.io_base[0] = 0;
 215         }
 216 }
 217
 218 /*---------------------------------------------------------------------------*
 219  *      isic_probe_Epcc16 - probe for ELSA MicroLink ISDN/PCC-16
 220  *---------------------------------------------------------------------------*/
 221 int
 222 isic_probe_Epcc16(device_t dev)
 223 {
 224         size_t unit = device_get_unit(dev);     /* get unit */
 225         struct l1_softc *sc = 0;                /* pointer to softc */
 226         void *ih = 0;                           /* dummy */
 227
 228         /* check max unit range */
 229         if(unit >= ISIC_MAXUNIT)
 230         {
 231                 printf("isic%d: Error, unit %d >= ISIC_MAXUNIT for ELSA PCC-16!\n",
 232                                 unit, unit);
 233                 return(ENXIO);
 234         }
 235
 236         sc = &l1_sc[unit];              /* get pointer to softc */
 237         sc->sc_unit = unit;             /* set unit */
 238
 239         /* see if an io base was supplied */
 240
 241         if(!(sc->sc_resources.io_base[0] =
 242                         bus_alloc_resource(dev, SYS_RES_IOPORT,
 243                                            &sc->sc_resources.io_rid[0],
 244                                            0ul, ~0ul, 1, RF_ACTIVE)))
 245         {
 246                 printf("isic%d: Could not get iobase for ELSA PCC-16.\n",
 247                                 unit);
 248                 return(ENXIO);
 249         }
 250
 251         /* check if we got an iobase */
 252
 253         sc->sc_port = rman_get_start(sc->sc_resources.io_base[0]);
 254
 255         switch(sc->sc_port)
 256         {
 257                 case 0x160:
 258                 case 0x170:
 259                 case 0x260:
 260                 case 0x360:
 261                         break;
 262                 default:
 263                         printf("isic%d: Error, invalid iobase 0x%x specified for ELSA MicroLink ISDN/PCC-16!\n",
 264                                 unit, sc->sc_port);
 265                         isic_detach_Epcc16(dev);
 266                         return(ENXIO);
 267                         break;
 268         }
 269
 270         /* setup access routines */
 271
 272         sc->clearirq = i4b_epcc16_clrirq;
 273         sc->readreg = epcc16_read_reg;
 274         sc->writereg = epcc16_write_reg;
 275
 276         sc->readfifo = epcc16_read_fifo;
 277         sc->writefifo = epcc16_write_fifo;
 278
 279         /* setup card type */
 280
 281         sc->sc_cardtyp = CARD_TYPEP_PCC16;
 282
 283         /* setup IOM bus type */
 284
 285         sc->sc_bustyp = BUS_TYPE_IOM2;
 286
 287         sc->sc_ipac = 0;
 288         sc->sc_bfifolen = HSCX_FIFO_LEN;
 289
 290         /*
 291          * Read HSCX A/B VSTR.  Expected value for the ELSA PCC-16
 292          * is 0x05 ( = version 2.1 ) in the least significant bits.
 293          */
 294
 295         if( ((HSCX_READ(0, H_VSTR) & 0xf) != 0x5) ||
 296             ((HSCX_READ(1, H_VSTR) & 0xf) != 0x5) )
 297         {
 298                 /* patch from "Doobee R . Tzeck" <drt@ailis.de>:
 299                  * I own an ELSA PCFpro. To my knowledge, the ELSA PCC16 is
 300                  * a stripped down Version on the PCFpro. By patching the
 301                  * card detection routine for the PPC16 I was able to use
 302                  * the PPC16 driver for the PCFpro.
 303                  */
 304                 if( ((HSCX_READ(0, H_VSTR) & 0xf) != 0x85) ||
 305                     ((HSCX_READ(1, H_VSTR) & 0xf) != 0x85) )
 306                 {
 307                         printf("isic%d: HSCX VSTR test failed for ELSA MicroLink ISDN/PCC-16\n",
 308                                 unit);
 309                         isic_detach_Epcc16(dev);
 310                         printf("isic%d: HSC0: VSTR: %#x\n",
 311                                 unit, HSCX_READ(0, H_VSTR));
 312                         printf("isic%d: HSC1: VSTR: %#x\n",
 313                                 unit, HSCX_READ(1, H_VSTR));
 314                         return (ENXIO);
 315                 }
 316                 else
 317                 {
 318                         printf("isic%d: ELSA MicroLink ISDN/PCFpro found, going to tread it as PCC-16\n",
 319                                 unit);
 320                 }
 321         }
 322
 323         /* get our irq */
 324
 325         if(!(sc->sc_resources.irq =
 326                         bus_alloc_resource(dev, SYS_RES_IRQ,
 327                                         &sc->sc_resources.irq_rid,
 328                                         0ul, ~0ul, 1, RF_ACTIVE)))
 329         {
 330                 printf("isic%d: Could not get an irq.\n",unit);
 331                 isic_detach_Epcc16(dev);
 332                 return ENXIO;
 333         }
 334
 335         /* get the irq number */
 336         sc->sc_irq = rman_get_start(sc->sc_resources.irq);
 337
 338         /* check IRQ validity */
 339         switch(sc->sc_irq)
 340         {
 341                 case 2:
 342                 case 9:
 343                 case 3:
 344                 case 5:
 345                 case 10:
 346                 case 11:
 347                 case 15:
 348                         break;
 349
 350                 default:
 351                         printf("isic%d: Error, invalid IRQ [%d] specified for ELSA MicroLink ISDN/PCC-16!\n",
 352                                 unit, sc->sc_irq);
 353                         isic_detach_Epcc16(dev);
 354                         return(ENXIO);
 355                         break;
 356         }
 357
 358         /* register interupt routine */
 359         bus_setup_intr(dev,sc->sc_resources.irq,INTR_TYPE_NET,
 360                         (void(*)(void *))(isicintr),
 361                         sc,&ih);
 362
 363
 364         return (0);
 365 }
 366
 367 /*---------------------------------------------------------------------------*
 368  * isic_attach_Epcc16 - attach for ELSA MicroLink ISDN/PCC-16
 369  *---------------------------------------------------------------------------*/
 370 int
 371 isic_attach_Epcc16(device_t dev)
 372 {
 373         int unit = device_get_unit(dev);
 374         struct l1_softc *sc = &l1_sc[unit];
 375         bus_space_tag_t    t = rman_get_bustag(sc->sc_resources.io_base[0]);
 376         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
 377
 378         u_char byte = ELSA_CTRL_SECRET;
 379
 380         byte &= ~ELSA_CTRL_RESET;
 381         bus_space_write_1(t, h, ELSA_OFF_CTRL, byte);
 382         DELAY(20);
 383         byte |= ELSA_CTRL_RESET;
 384         bus_space_write_1(t, h, ELSA_OFF_CTRL, byte);
 385
 386         DELAY(20);
 387         bus_space_write_1(t, h, ELSA_OFF_IRQ, 0xff);
 388
 389         return 0;
 390 }
 391
 392 #endif /* (NISIC > 0) && defined(ELSA_PCC16) */