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

   1 /*
   2  *   Copyright (c) 1996 Andrew Gordon. All rights reserved.
   3  *
   4  *   Copyright (c) 1997, 2001 Hellmuth Michaelis. All rights reserved.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *   1. Redistributions of source code must retain the above copyright
  11  *      notice, this list of conditions and the following disclaimer.
  12  *   2. Redistributions in binary form must reproduce the above copyright
  13  *      notice, this list of conditions and the following disclaimer in the
  14  *      documentation and/or other materials provided with the distribution.
  15  *   3. Neither the name of the author nor the names of any co-contributors
  16  *      may be used to endorse or promote products derived from this software
  17  *      without specific prior written permission.
  18  *   4. Altered versions must be plainly marked as such, and must not be
  19  *      misrepresented as being the original software and/or documentation.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  22  *   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  *   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  *   ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  25  *   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  *   OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  *   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  *   OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  *   SUCH DAMAGE.
  32  *
  33  *---------------------------------------------------------------------------
  34  *
  35  *      i4b_avm_a1.c - AVM A1/Fritz passive card driver for isdn4bsd
  36  *      ------------------------------------------------------------
  37  *
  38  * $FreeBSD: src/sys/i4b/layer1/isic/i4b_avm_a1.c,v 1.5.2.1 2001/08/10 14:08:38 obrien Exp $
  39  * $DragonFly: src/sys/net/i4b/layer1/isic/i4b_avm_a1.c,v 1.5 2005/05/24 20:59:05 dillon Exp $
  40  *
  41  *      last edit-date: [Wed Jan 24 09:25:23 2001]
  42  *
  43  *---------------------------------------------------------------------------*/
  44
  45 #include "use_isic.h"
  46 #include "opt_i4b.h"
  47
  48 #if NISIC > 0 && defined(AVM_A1)
  49
  50 #include <sys/param.h>
  51 #include <sys/systm.h>
  52 #include <sys/socket.h>
  53 #include <net/if.h>
  54
  55 #include <net/i4b/include/machine/i4b_ioctl.h>
  56 #include <net/i4b/include/machine/i4b_trace.h>
  57 #include <machine/clock.h>
  58
  59 #include "../i4b_l1.h"
  60 #include "i4b_isic.h"
  61 #include "i4b_hscx.h"
  62
  63 /*---------------------------------------------------------------------------*
  64  *      AVM A1 and AVM Fritz! Card special registers
  65  *---------------------------------------------------------------------------*/
  66
  67 #define AVM_CONF_REG    0x1800          /* base offset for config register */
  68 #define AVM_CONF_IRQ    0x1801          /* base offset for IRQ register    */
  69                                         /* config register write           */
  70 #define  AVM_CONF_WR_RESET      0x01    /* 1 = RESET ISAC and HSCX         */
  71 #define  AVM_CONF_WR_CCL        0x02    /* 1 = clear counter low nibble    */
  72 #define  AVM_CONF_WR_CCH        0x04    /* 1 = clear counter high nibble   */
  73 #define  AVM_CONF_WR_IRQEN      0x08    /* 1 = enable IRQ                  */
  74 #define  AVM_CONF_WR_TEST       0x10    /* test bit                        */
  75                                         /* config register read            */
  76 #define  AVM_CONF_RD_IIRQ       0x01    /* 0 = ISAC IRQ active             */
  77 #define  AVM_CONF_RD_HIRQ       0x02    /* 0 = HSCX IRQ active             */
  78 #define  AVM_CONF_RD_CIRQ       0x04    /* 0 = counter IRQ active          */
  79 #define  AVM_CONF_RD_ZER1       0x08    /* unused, always read 0           */
  80 #define  AVM_CONF_RD_TEST       0x10    /* test bit read back              */
  81 #define  AVM_CONF_RD_ZER2       0x20    /* unused, always read 0           */
  82
  83 #define AVM_ISAC_R_OFFS         (0x1400-0x20)
  84 #define AVM_HSCXA_R_OFFS        (0x400-0x20)
  85 #define AVM_HSCXB_R_OFFS        (0xc00-0x20)
  86 #define AVM_ISAC_F_OFFS         (0x1400-0x20-0x3e0)
  87 #define AVM_HSCXA_F_OFFS        (0x400-0x20-0x3e0)
  88 #define AVM_HSCXB_F_OFFS        (0xc00-0x20-0x3e0)
  89
  90 /*---------------------------------------------------------------------------*
  91  *      AVM read fifo routine
  92  *---------------------------------------------------------------------------*/
  93 static void
  94 avma1_read_fifo(struct l1_softc *sc, int what, void *buf, size_t size)
  95 {
  96         bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+4]);
  97         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+4]);
  98         bus_space_read_multi_1(t, h, 0, buf, size);
  99 }
 100
 101 /*---------------------------------------------------------------------------*
 102  *      AVM write fifo routine
 103  *---------------------------------------------------------------------------*/
 104 static void
 105 avma1_write_fifo(struct l1_softc *sc, int what, void *buf, size_t size)
 106 {
 107         bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+4]);
 108         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+4]);
 109         bus_space_write_multi_1(t, h, 0, (u_int8_t*)buf, size);
 110 }
 111
 112 /*---------------------------------------------------------------------------*
 113  *      AVM write register routine
 114  *---------------------------------------------------------------------------*/
 115 static void
 116 avma1_write_reg(struct l1_softc *sc, int what, bus_size_t offs, u_int8_t data)
 117 {
 118         bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+1]);
 119         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+1]);
 120         bus_space_write_1(t, h, offs, data);
 121 }
 122
 123 /*---------------------------------------------------------------------------*
 124  *      AVM read register routine
 125  *---------------------------------------------------------------------------*/
 126 static u_int8_t
 127 avma1_read_reg(struct l1_softc *sc, int what, bus_size_t offs)
 128 {
 129         bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+1]);
 130         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+1]);
 131         return bus_space_read_1(t, h, offs);
 132 }
 133
 134 /*---------------------------------------------------------------------------*
 135  *      allocate an io port
 136  *---------------------------------------------------------------------------*/
 137 static int
 138 isic_alloc_port(device_t dev, int rid, u_int base, u_int len)
 139 {
 140         size_t unit = device_get_unit(dev);
 141         struct l1_softc *sc = &l1_sc[unit];
 142
 143         sc->sc_resources.io_rid[rid] = rid;
 144
 145         bus_set_resource(dev, SYS_RES_IOPORT, rid, base, len);
 146
 147         if(!(sc->sc_resources.io_base[rid] =
 148                 bus_alloc_resource(dev, SYS_RES_IOPORT,
 149                                    &sc->sc_resources.io_rid[rid],
 150                                    0ul, ~0ul, 1, RF_ACTIVE)))
 151         {
 152                 printf("isic%d: Error, failed to reserve io #%d!\n", unit, rid);
 153                 isic_detach_common(dev);
 154                 return(ENXIO);
 155         }
 156         return(0);
 157 }
 158
 159 /*---------------------------------------------------------------------------*
 160  *      isic_probe_avma1 - probe for AVM A1 and compatibles
 161  *---------------------------------------------------------------------------*/
 162 int
 163 isic_probe_avma1(device_t dev)
 164 {
 165         size_t unit = device_get_unit(dev);     /* get unit */
 166         struct l1_softc *sc = 0;        /* pointer to softc */
 167         void *ih = 0;                   /* dummy */
 168         bus_space_tag_t    t;           /* bus things */
 169         bus_space_handle_t h;
 170         u_char savebyte;
 171         u_char byte;
 172
 173         /* check max unit range */
 174
 175         if(unit >= ISIC_MAXUNIT)
 176         {
 177                 printf("isic%d: Error, unit %d >= ISIC_MAXUNIT for AVM A1/Fritz!\n",
 178                                 unit, unit);
 179                 return(ENXIO);
 180         }
 181
 182         sc = &l1_sc[unit];                      /* get pointer to softc */
 183         sc->sc_unit = unit;                     /* set unit */
 184
 185         /* see if an io base was supplied */
 186
 187         if(!(sc->sc_resources.io_base[0] =
 188                         bus_alloc_resource(dev, SYS_RES_IOPORT,
 189                                            &sc->sc_resources.io_rid[0],
 190                                            0ul, ~0ul, 1, RF_ACTIVE)))
 191         {
 192                 printf("isic%d: Could not get iobase for AVM A1/Fritz!\n",
 193                                 unit);
 194                 return(ENXIO);
 195         }
 196
 197         /* set io base */
 198
 199         sc->sc_port = rman_get_start(sc->sc_resources.io_base[0]);
 200
 201         /* release io base */
 202
 203         bus_release_resource(dev, SYS_RES_IOPORT, sc->sc_resources.io_rid[0],
 204                         sc->sc_resources.io_base[0]);
 205
 206         switch(sc->sc_port)
 207         {
 208                 case 0x200:
 209                 case 0x240:
 210                 case 0x300:
 211                 case 0x340:
 212                         break;
 213
 214                 default:
 215                         printf("isic%d: Error, invalid iobase 0x%x specified for AVM A1/Fritz!\n",
 216                                 unit, sc->sc_port);
 217                         return(ENXIO);
 218                         break;
 219         }
 220
 221         if(isic_alloc_port(dev, 0, sc->sc_port+AVM_CONF_REG, 0x20))
 222                 return(ENXIO);
 223
 224         if(isic_alloc_port(dev, 1, sc->sc_port+AVM_ISAC_R_OFFS, 0x20))
 225                 return(ENXIO);
 226
 227         if(isic_alloc_port(dev, 2, sc->sc_port+AVM_HSCXA_R_OFFS, 0x20))
 228                 return(ENXIO);
 229
 230         if(isic_alloc_port(dev, 3, sc->sc_port+AVM_HSCXB_R_OFFS, 0x20))
 231                 return(ENXIO);
 232
 233         if(isic_alloc_port(dev, 4, sc->sc_port+AVM_ISAC_F_OFFS, 0x20))
 234                 return(ENXIO);
 235
 236         if(isic_alloc_port(dev, 5, sc->sc_port+AVM_HSCXA_F_OFFS, 0x20))
 237                 return(ENXIO);
 238
 239         if(isic_alloc_port(dev, 6, sc->sc_port+AVM_HSCXB_F_OFFS, 0x20))
 240                 return(ENXIO);
 241
 242         /* get our irq */
 243
 244         if(!(sc->sc_resources.irq =
 245                 bus_alloc_resource(dev, SYS_RES_IRQ,
 246                                    &sc->sc_resources.irq_rid,
 247                                    0ul, ~0ul, 1, RF_ACTIVE)))
 248         {
 249                 printf("isic%d: Could not get an irq for AVM A1/Fritz!\n",unit);
 250                 isic_detach_common(dev);
 251                 return ENXIO;
 252         }
 253
 254         /* get the irq number */
 255         sc->sc_irq = rman_get_start(sc->sc_resources.irq);
 256
 257         /* register interupt routine */
 258         bus_setup_intr(dev, sc->sc_resources.irq, INTR_TYPE_NET,
 259                         (void(*)(void *))(isicintr),
 260                         sc, &ih, NULL);
 261
 262         /* check IRQ validity */
 263
 264         switch(sc->sc_irq)
 265         {
 266                 case 3:
 267                 case 4:
 268                 case 5:
 269                 case 6:
 270                 case 7:
 271                 case 8:
 272                 case 10:
 273                 case 11:
 274                 case 12:
 275                 case 13:
 276                 case 14:
 277                 case 15:
 278                         break;
 279
 280                 default:
 281                         printf("isic%d: Error, invalid IRQ [%d] specified for AVM A1/Fritz!\n",
 282                                 unit, sc->sc_irq);
 283                         isic_detach_common(dev);
 284                         return(ENXIO);
 285                         break;
 286         }
 287
 288         sc->clearirq = NULL;
 289         sc->readreg = avma1_read_reg;
 290         sc->writereg = avma1_write_reg;
 291
 292         sc->readfifo = avma1_read_fifo;
 293         sc->writefifo = avma1_write_fifo;
 294
 295         /* setup card type */
 296
 297         sc->sc_cardtyp = CARD_TYPEP_AVMA1;
 298
 299         /* setup IOM bus type */
 300
 301         sc->sc_bustyp = BUS_TYPE_IOM2;
 302
 303         sc->sc_ipac = 0;
 304         sc->sc_bfifolen = HSCX_FIFO_LEN;
 305
 306         /*
 307          * Read HSCX A/B VSTR.
 308          * Expected value for AVM A1 is 0x04 or 0x05 and for the
 309          * AVM Fritz!Card is 0x05 in the least significant bits.
 310          */
 311
 312         if( (((HSCX_READ(0, H_VSTR) & 0xf) != 0x5) &&
 313              ((HSCX_READ(0, H_VSTR) & 0xf) != 0x4))     ||
 314             (((HSCX_READ(1, H_VSTR) & 0xf) != 0x5) &&
 315              ((HSCX_READ(1, H_VSTR) & 0xf) != 0x4)) )
 316         {
 317                 printf("isic%d: HSCX VSTR test failed for AVM A1/Fritz\n",
 318                         unit);
 319                 printf("isic%d: HSC0: VSTR: %#x\n",
 320                         unit, HSCX_READ(0, H_VSTR));
 321                 printf("isic%d: HSC1: VSTR: %#x\n",
 322                         unit, HSCX_READ(1, H_VSTR));
 323                 return(ENXIO);
 324         }
 325
 326         /* AVM A1 or Fritz! control register bits:      */
 327         /*        read                write             */
 328         /* 0x01  hscx irq*           RESET              */
 329         /* 0x02  isac irq*           clear counter1     */
 330         /* 0x04  counter irq*        clear counter2     */
 331         /* 0x08  always 0            irq enable         */
 332         /* 0x10  read test bit       set test bit       */
 333         /* 0x20  always 0            unused             */
 334
 335         /*
 336          * XXX the following test may be destructive, to prevent the
 337          * worst case, we save the byte first, and in case the test
 338          * fails, we write back the saved byte .....
 339          */
 340
 341         t = rman_get_bustag(sc->sc_resources.io_base[0]);
 342         h = rman_get_bushandle(sc->sc_resources.io_base[0]);
 343
 344         savebyte = bus_space_read_1(t, h, 0);
 345
 346         /* write low to test bit */
 347
 348         bus_space_write_1(t, h, 0, 0x00);
 349
 350         /* test bit and next higher and lower bit must be 0 */
 351
 352         if((byte = bus_space_read_1(t, h, 0) & 0x38) != 0x00)
 353         {
 354                 printf("isic%d: Error, probe-1 failed, 0x%02x should be 0x00 for AVM A1/Fritz!\n",
 355                                 unit, byte);
 356                 bus_space_write_1(t, h, 0, savebyte);
 357                 return(ENXIO);
 358         }
 359
 360         /* write high to test bit */
 361
 362         bus_space_write_1(t, h, 0, 0x10);
 363
 364         /* test bit must be high, next higher and lower bit must be 0 */
 365
 366         if((byte = bus_space_read_1(t, h, 0) & 0x38) != 0x10)
 367         {
 368                 printf("isic%d: Error, probe-2 failed, 0x%02x should be 0x10 for AVM A1/Fritz!\n",
 369                                 unit, byte);
 370                 bus_space_write_1(t, h, 0, savebyte);
 371                 return(ENXIO);
 372         }
 373         return(0);
 374 }
 375
 376 /*---------------------------------------------------------------------------*
 377  *      isic_attach_avma1 - attach AVM A1 and compatibles
 378  *---------------------------------------------------------------------------*/
 379 int
 380 isic_attach_avma1(device_t dev)
 381 {
 382         size_t unit = device_get_unit(dev);
 383         struct l1_softc *sc = &l1_sc[unit];
 384         bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[0]);
 385         bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
 386
 387         /* reset ISAC/HSCX */
 388
 389         bus_space_write_1(t, h, 0, 0x00);
 390         DELAY(SEC_DELAY / 10);
 391
 392         bus_space_write_1(t, h, 0, AVM_CONF_WR_RESET);
 393         DELAY(SEC_DELAY / 10);
 394
 395         bus_space_write_1(t, h, 0, 0x00);
 396         DELAY(SEC_DELAY / 10);
 397
 398         /* setup IRQ */
 399
 400         bus_space_write_1(t, h, 1, sc->sc_irq);
 401         DELAY(SEC_DELAY / 10);
 402
 403         /* enable IRQ, disable counter IRQ */
 404
 405         bus_space_write_1(t, h, 0, AVM_CONF_WR_IRQEN |
 406                                 AVM_CONF_WR_CCH | AVM_CONF_WR_CCL);
 407         DELAY(SEC_DELAY / 10);
 408
 409         return(0);
 410 }
 411
 412 #endif /* NISIC > 0 && defined(AVM_A1) */