2 * Copyright (c) 1996 Andrew Gordon. All rights reserved.
4 * Copyright (c) 1997, 2001 Hellmuth Michaelis. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
33 *---------------------------------------------------------------------------
35 * i4b_avm_a1.c - AVM A1/Fritz passive card driver for isdn4bsd
36 * ------------------------------------------------------------
38 * $FreeBSD: src/sys/i4b/layer1/isic/i4b_avm_a1.c,v 1.5.2.1 2001/08/10 14:08:38 obrien Exp $
40 * last edit-date: [Wed Jan 24 09:25:23 2001]
42 *---------------------------------------------------------------------------*/
47 #if NISIC > 0 && defined(AVM_A1)
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/socket.h>
54 #include <net/i4b/include/machine/i4b_ioctl.h>
55 #include <net/i4b/include/machine/i4b_trace.h>
56 #include <machine/clock.h>
58 #include "../i4b_l1.h"
62 /*---------------------------------------------------------------------------*
63 * AVM A1 and AVM Fritz! Card special registers
64 *---------------------------------------------------------------------------*/
66 #define AVM_CONF_REG 0x1800 /* base offset for config register */
67 #define AVM_CONF_IRQ 0x1801 /* base offset for IRQ register */
68 /* config register write */
69 #define AVM_CONF_WR_RESET 0x01 /* 1 = RESET ISAC and HSCX */
70 #define AVM_CONF_WR_CCL 0x02 /* 1 = clear counter low nibble */
71 #define AVM_CONF_WR_CCH 0x04 /* 1 = clear counter high nibble */
72 #define AVM_CONF_WR_IRQEN 0x08 /* 1 = enable IRQ */
73 #define AVM_CONF_WR_TEST 0x10 /* test bit */
74 /* config register read */
75 #define AVM_CONF_RD_IIRQ 0x01 /* 0 = ISAC IRQ active */
76 #define AVM_CONF_RD_HIRQ 0x02 /* 0 = HSCX IRQ active */
77 #define AVM_CONF_RD_CIRQ 0x04 /* 0 = counter IRQ active */
78 #define AVM_CONF_RD_ZER1 0x08 /* unused, always read 0 */
79 #define AVM_CONF_RD_TEST 0x10 /* test bit read back */
80 #define AVM_CONF_RD_ZER2 0x20 /* unused, always read 0 */
82 #define AVM_ISAC_R_OFFS (0x1400-0x20)
83 #define AVM_HSCXA_R_OFFS (0x400-0x20)
84 #define AVM_HSCXB_R_OFFS (0xc00-0x20)
85 #define AVM_ISAC_F_OFFS (0x1400-0x20-0x3e0)
86 #define AVM_HSCXA_F_OFFS (0x400-0x20-0x3e0)
87 #define AVM_HSCXB_F_OFFS (0xc00-0x20-0x3e0)
89 /*---------------------------------------------------------------------------*
90 * AVM read fifo routine
91 *---------------------------------------------------------------------------*/
93 avma1_read_fifo(struct l1_softc *sc, int what, void *buf, size_t size)
95 bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+4]);
96 bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+4]);
97 bus_space_read_multi_1(t, h, 0, buf, size);
100 /*---------------------------------------------------------------------------*
101 * AVM write fifo routine
102 *---------------------------------------------------------------------------*/
104 avma1_write_fifo(struct l1_softc *sc, int what, void *buf, size_t size)
106 bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+4]);
107 bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+4]);
108 bus_space_write_multi_1(t, h, 0, (u_int8_t*)buf, size);
111 /*---------------------------------------------------------------------------*
112 * AVM write register routine
113 *---------------------------------------------------------------------------*/
115 avma1_write_reg(struct l1_softc *sc, int what, bus_size_t offs, u_int8_t data)
117 bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+1]);
118 bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+1]);
119 bus_space_write_1(t, h, offs, data);
122 /*---------------------------------------------------------------------------*
123 * AVM read register routine
124 *---------------------------------------------------------------------------*/
126 avma1_read_reg(struct l1_softc *sc, int what, bus_size_t offs)
128 bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[what+1]);
129 bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[what+1]);
130 return bus_space_read_1(t, h, offs);
133 /*---------------------------------------------------------------------------*
134 * allocate an io port
135 *---------------------------------------------------------------------------*/
137 isic_alloc_port(device_t dev, int rid, u_int base, u_int len)
139 size_t unit = device_get_unit(dev);
140 struct l1_softc *sc = &l1_sc[unit];
142 sc->sc_resources.io_rid[rid] = rid;
144 bus_set_resource(dev, SYS_RES_IOPORT, rid, base, len, -1);
146 if(!(sc->sc_resources.io_base[rid] =
147 bus_alloc_resource(dev, SYS_RES_IOPORT,
148 &sc->sc_resources.io_rid[rid],
149 0ul, ~0ul, 1, RF_ACTIVE)))
151 kprintf("isic%d: Error, failed to reserve io #%d!\n", unit, rid);
152 isic_detach_common(dev);
158 /*---------------------------------------------------------------------------*
159 * isic_probe_avma1 - probe for AVM A1 and compatibles
160 *---------------------------------------------------------------------------*/
162 isic_probe_avma1(device_t dev)
164 size_t unit = device_get_unit(dev); /* get unit */
165 struct l1_softc *sc = NULL; /* pointer to softc */
166 void *ih = NULL; /* dummy */
167 bus_space_tag_t t; /* bus things */
168 bus_space_handle_t h;
172 /* check max unit range */
174 if(unit >= ISIC_MAXUNIT)
176 kprintf("isic%d: Error, unit %d >= ISIC_MAXUNIT for AVM A1/Fritz!\n",
181 sc = &l1_sc[unit]; /* get pointer to softc */
182 sc->sc_unit = unit; /* set unit */
184 /* see if an io base was supplied */
186 if(!(sc->sc_resources.io_base[0] =
187 bus_alloc_resource(dev, SYS_RES_IOPORT,
188 &sc->sc_resources.io_rid[0],
189 0ul, ~0ul, 1, RF_ACTIVE)))
191 kprintf("isic%d: Could not get iobase for AVM A1/Fritz!\n",
198 sc->sc_port = rman_get_start(sc->sc_resources.io_base[0]);
200 /* release io base */
202 bus_release_resource(dev, SYS_RES_IOPORT, sc->sc_resources.io_rid[0],
203 sc->sc_resources.io_base[0]);
214 kprintf("isic%d: Error, invalid iobase 0x%x specified for AVM A1/Fritz!\n",
220 if(isic_alloc_port(dev, 0, sc->sc_port+AVM_CONF_REG, 0x20))
223 if(isic_alloc_port(dev, 1, sc->sc_port+AVM_ISAC_R_OFFS, 0x20))
226 if(isic_alloc_port(dev, 2, sc->sc_port+AVM_HSCXA_R_OFFS, 0x20))
229 if(isic_alloc_port(dev, 3, sc->sc_port+AVM_HSCXB_R_OFFS, 0x20))
232 if(isic_alloc_port(dev, 4, sc->sc_port+AVM_ISAC_F_OFFS, 0x20))
235 if(isic_alloc_port(dev, 5, sc->sc_port+AVM_HSCXA_F_OFFS, 0x20))
238 if(isic_alloc_port(dev, 6, sc->sc_port+AVM_HSCXB_F_OFFS, 0x20))
243 if(!(sc->sc_resources.irq =
244 bus_alloc_resource(dev, SYS_RES_IRQ,
245 &sc->sc_resources.irq_rid,
246 0ul, ~0ul, 1, RF_ACTIVE)))
248 kprintf("isic%d: Could not get an irq for AVM A1/Fritz!\n",unit);
249 isic_detach_common(dev);
253 /* get the irq number */
254 sc->sc_irq = rman_get_start(sc->sc_resources.irq);
256 /* register interupt routine */
257 bus_setup_intr(dev, sc->sc_resources.irq, 0,
258 (void(*)(void *))(isicintr),
261 /* check IRQ validity */
280 kprintf("isic%d: Error, invalid IRQ [%d] specified for AVM A1/Fritz!\n",
282 isic_detach_common(dev);
288 sc->readreg = avma1_read_reg;
289 sc->writereg = avma1_write_reg;
291 sc->readfifo = avma1_read_fifo;
292 sc->writefifo = avma1_write_fifo;
294 /* setup card type */
296 sc->sc_cardtyp = CARD_TYPEP_AVMA1;
298 /* setup IOM bus type */
300 sc->sc_bustyp = BUS_TYPE_IOM2;
303 sc->sc_bfifolen = HSCX_FIFO_LEN;
306 * Read HSCX A/B VSTR.
307 * Expected value for AVM A1 is 0x04 or 0x05 and for the
308 * AVM Fritz!Card is 0x05 in the least significant bits.
311 if( (((HSCX_READ(0, H_VSTR) & 0xf) != 0x5) &&
312 ((HSCX_READ(0, H_VSTR) & 0xf) != 0x4)) ||
313 (((HSCX_READ(1, H_VSTR) & 0xf) != 0x5) &&
314 ((HSCX_READ(1, H_VSTR) & 0xf) != 0x4)) )
316 kprintf("isic%d: HSCX VSTR test failed for AVM A1/Fritz\n",
318 kprintf("isic%d: HSC0: VSTR: %#x\n",
319 unit, HSCX_READ(0, H_VSTR));
320 kprintf("isic%d: HSC1: VSTR: %#x\n",
321 unit, HSCX_READ(1, H_VSTR));
325 /* AVM A1 or Fritz! control register bits: */
327 /* 0x01 hscx irq* RESET */
328 /* 0x02 isac irq* clear counter1 */
329 /* 0x04 counter irq* clear counter2 */
330 /* 0x08 always 0 irq enable */
331 /* 0x10 read test bit set test bit */
332 /* 0x20 always 0 unused */
335 * XXX the following test may be destructive, to prevent the
336 * worst case, we save the byte first, and in case the test
337 * fails, we write back the saved byte .....
340 t = rman_get_bustag(sc->sc_resources.io_base[0]);
341 h = rman_get_bushandle(sc->sc_resources.io_base[0]);
343 savebyte = bus_space_read_1(t, h, 0);
345 /* write low to test bit */
347 bus_space_write_1(t, h, 0, 0x00);
349 /* test bit and next higher and lower bit must be 0 */
351 if((byte = bus_space_read_1(t, h, 0) & 0x38) != 0x00)
353 kprintf("isic%d: Error, probe-1 failed, 0x%02x should be 0x00 for AVM A1/Fritz!\n",
355 bus_space_write_1(t, h, 0, savebyte);
359 /* write high to test bit */
361 bus_space_write_1(t, h, 0, 0x10);
363 /* test bit must be high, next higher and lower bit must be 0 */
365 if((byte = bus_space_read_1(t, h, 0) & 0x38) != 0x10)
367 kprintf("isic%d: Error, probe-2 failed, 0x%02x should be 0x10 for AVM A1/Fritz!\n",
369 bus_space_write_1(t, h, 0, savebyte);
375 /*---------------------------------------------------------------------------*
376 * isic_attach_avma1 - attach AVM A1 and compatibles
377 *---------------------------------------------------------------------------*/
379 isic_attach_avma1(device_t dev)
381 size_t unit = device_get_unit(dev);
382 struct l1_softc *sc = &l1_sc[unit];
383 bus_space_tag_t t = rman_get_bustag(sc->sc_resources.io_base[0]);
384 bus_space_handle_t h = rman_get_bushandle(sc->sc_resources.io_base[0]);
386 /* reset ISAC/HSCX */
388 bus_space_write_1(t, h, 0, 0x00);
389 DELAY(SEC_DELAY / 10);
391 bus_space_write_1(t, h, 0, AVM_CONF_WR_RESET);
392 DELAY(SEC_DELAY / 10);
394 bus_space_write_1(t, h, 0, 0x00);
395 DELAY(SEC_DELAY / 10);
399 bus_space_write_1(t, h, 1, sc->sc_irq);
400 DELAY(SEC_DELAY / 10);
402 /* enable IRQ, disable counter IRQ */
404 bus_space_write_1(t, h, 0, AVM_CONF_WR_IRQEN |
405 AVM_CONF_WR_CCH | AVM_CONF_WR_CCL);
406 DELAY(SEC_DELAY / 10);
411 #endif /* NISIC > 0 && defined(AVM_A1) */