1 /* $NetBSD: puc.c,v 1.7 2000/07/29 17:43:38 jlam Exp $ */
4 * Copyright (c) 2002 JF Hay. All rights reserved.
5 * Copyright (c) 2000 M. Warner Losh. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * Copyright (c) 1996, 1998, 1999
31 * Christopher G. Demetriou. All rights reserved.
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 * 3. All advertising materials mentioning features or use of this software
42 * must display the following acknowledgement:
43 * This product includes software developed by Christopher G. Demetriou
44 * for the NetBSD Project.
45 * 4. The name of the author may not be used to endorse or promote products
46 * derived from this software without specific prior written permission
48 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
49 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
50 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
51 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
52 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
53 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
54 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
55 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
57 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60 #include <sys/cdefs.h>
61 __FBSDID("$FreeBSD$");
64 * PCI "universal" communication card device driver, glues com, lpt,
65 * and similar ports to PCI via bridge chip often much larger than
66 * the devices being glued.
68 * Author: Christopher G. Demetriou, May 14, 1998 (derived from NetBSD
69 * sys/dev/pci/pciide.c, revision 1.6).
71 * These devices could be (and some times are) described as
72 * communications/{serial,parallel}, etc. devices with known
73 * programming interfaces, but those programming interfaces (in
74 * particular the BAR assignments for devices, etc.) in fact are not
75 * particularly well defined.
77 * After I/we have seen more of these devices, it may be possible
78 * to generalize some of these bits. In particular, devices which
79 * describe themselves as communications/serial/16[45]50, and
80 * communications/parallel/??? might be attached via direct
81 * 'com' and 'lpt' attachments to pci.
86 #include <sys/param.h>
87 #include <sys/systm.h>
88 #include <sys/kernel.h>
91 #include <sys/malloc.h>
93 #include <machine/bus.h>
94 #include <machine/resource.h>
97 #include <dev/pci/pcireg.h>
98 #include <dev/pci/pcivar.h>
100 #define PUC_ENTRAILS 1
101 #include <dev/puc/pucvar.h>
104 struct resource_list resources;
108 static void puc_intr(void *arg);
110 static int puc_find_free_unit(char *);
112 static void puc_print_resource_list(struct resource_list *);
115 devclass_t puc_devclass;
118 puc_port_bar_index(struct puc_softc *sc, int bar)
122 for (i = 0; i < PUC_MAX_BAR; i += 1) {
123 if (!sc->sc_bar_mappings[i].used)
125 if (sc->sc_bar_mappings[i].bar == bar)
128 sc->sc_bar_mappings[i].bar = bar;
129 sc->sc_bar_mappings[i].used = 1;
134 puc_attach(device_t dev, const struct puc_device_description *desc)
137 int bidx, childunit, i, irq_setup, rid;
138 struct puc_softc *sc;
139 struct puc_device *pdev;
140 struct resource *res;
141 struct resource_list_entry *rle;
143 sc = (struct puc_softc *)device_get_softc(dev);
144 bzero(sc, sizeof(*sc));
146 if (sc->sc_desc == NULL)
152 printf("puc: name: %s\n", sc->sc_desc->name);
155 res = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
156 RF_ACTIVE | RF_SHAREABLE);
163 irq_setup = BUS_SETUP_INTR(device_get_parent(dev), dev, res,
164 INTR_TYPE_TTY | INTR_FAST, puc_intr, sc, &sc->intr_cookie);
166 sc->fastintr = INTR_FAST;
168 irq_setup = BUS_SETUP_INTR(device_get_parent(dev), dev, res,
169 INTR_TYPE_TTY, puc_intr, sc, &sc->intr_cookie);
171 irq_setup = BUS_SETUP_INTR(device_get_parent(dev), dev, res,
172 INTR_TYPE_TTY, puc_intr, sc, &sc->intr_cookie);
178 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) {
179 if (i > 0 && rid == sc->sc_desc->ports[i].bar)
181 rid = sc->sc_desc->ports[i].bar;
182 bidx = puc_port_bar_index(sc, rid);
184 if (sc->sc_bar_mappings[bidx].res != NULL)
186 res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
187 0ul, ~0ul, 1, RF_ACTIVE);
189 printf("could not get resource\n");
192 sc->sc_bar_mappings[bidx].res = res;
194 printf("port rid %d bst %x, start %x, end %x\n", rid,
195 (u_int)rman_get_bustag(res), (u_int)rman_get_start(res),
196 (u_int)rman_get_end(res));
200 if (desc->init != NULL) {
206 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) {
207 rid = sc->sc_desc->ports[i].bar;
208 bidx = puc_port_bar_index(sc, rid);
209 if (sc->sc_bar_mappings[bidx].res == NULL)
212 switch (sc->sc_desc->ports[i].type) {
213 case PUC_PORT_TYPE_COM:
219 pdev = malloc(sizeof(struct puc_device), M_DEVBUF,
223 resource_list_init(&pdev->resources);
225 /* First fake up an IRQ resource. */
226 resource_list_add(&pdev->resources, SYS_RES_IRQ, 0,
227 rman_get_start(sc->irqres), rman_get_end(sc->irqres),
228 rman_get_end(sc->irqres) - rman_get_start(sc->irqres) + 1);
229 rle = resource_list_find(&pdev->resources, SYS_RES_IRQ, 0);
230 rle->res = sc->irqres;
232 /* Now fake an IOPORT resource */
233 res = sc->sc_bar_mappings[bidx].res;
234 resource_list_add(&pdev->resources, SYS_RES_IOPORT, 0,
235 rman_get_start(res) + sc->sc_desc->ports[i].offset,
236 rman_get_start(res) + sc->sc_desc->ports[i].offset + 8 - 1,
238 rle = resource_list_find(&pdev->resources, SYS_RES_IOPORT, 0);
240 if (sc->barmuxed == 0) {
241 rle->res = sc->sc_bar_mappings[bidx].res;
243 rle->res = malloc(sizeof(struct resource), M_DEVBUF,
245 if (rle->res == NULL) {
246 free(pdev, M_DEVBUF);
250 rle->res->r_start = rman_get_start(res) +
251 sc->sc_desc->ports[i].offset;
252 rle->res->r_end = rle->res->r_start + 8 - 1;
253 rle->res->r_bustag = rman_get_bustag(res);
254 bus_space_subregion(rle->res->r_bustag,
255 rman_get_bushandle(res),
256 sc->sc_desc->ports[i].offset, 8,
257 &rle->res->r_bushandle);
260 pdev->serialfreq = sc->sc_desc->ports[i].serialfreq;
262 childunit = puc_find_free_unit(typestr);
263 sc->sc_ports[i].dev = device_add_child(dev, typestr, childunit);
264 if (sc->sc_ports[i].dev == NULL) {
266 bus_space_unmap(rman_get_bustag(rle->res),
267 rman_get_bushandle(rle->res),
269 free(rle->res, M_DEVBUF);
270 free(pdev, M_DEVBUF);
274 device_set_ivars(sc->sc_ports[i].dev, pdev);
275 device_set_desc(sc->sc_ports[i].dev, sc->sc_desc->name);
277 device_quiet(sc->sc_ports[i].dev);
279 printf("puc: type %d, bar %x, offset %x\n",
280 sc->sc_desc->ports[i].type,
281 sc->sc_desc->ports[i].bar,
282 sc->sc_desc->ports[i].offset);
283 puc_print_resource_list(&pdev->resources);
285 device_set_flags(sc->sc_ports[i].dev,
286 sc->sc_desc->ports[i].flags);
287 if (device_probe_and_attach(sc->sc_ports[i].dev) != 0) {
289 bus_space_unmap(rman_get_bustag(rle->res),
290 rman_get_bushandle(rle->res),
292 free(rle->res, M_DEVBUF);
293 free(pdev, M_DEVBUF);
305 * This is just an brute force interrupt handler. It just calls all the
306 * registered handlers sequencially.
308 * Later on we should maybe have a different handler for boards that can
309 * tell us which device generated the interrupt.
315 struct puc_softc *sc;
317 sc = (struct puc_softc *)arg;
318 for (i = 0; i < PUC_MAX_PORTS; i++)
319 if (sc->sc_ports[i].ihand != NULL)
320 (sc->sc_ports[i].ihand)(sc->sc_ports[i].ihandarg);
323 const struct puc_device_description *
324 puc_find_description(uint32_t vend, uint32_t prod, uint32_t svend,
329 #define checkreg(val, index) \
330 (((val) & puc_devices[i].rmask[(index)]) == puc_devices[i].rval[(index)])
332 for (i = 0; puc_devices[i].name != NULL; i++) {
333 if (checkreg(vend, PUC_REG_VEND) &&
334 checkreg(prod, PUC_REG_PROD) &&
335 checkreg(svend, PUC_REG_SVEND) &&
336 checkreg(sprod, PUC_REG_SPROD))
337 return (&puc_devices[i]);
346 puc_find_free_unit(char *name)
354 while (resource_int_value(name, unit, "port", &start) == 0 &&
357 dc = devclass_find(name);
360 while (devclass_get_device(dc, unit))
363 printf("puc: Using %s%d\n", name, unit);
370 puc_print_resource_list(struct resource_list *rl)
373 struct resource_list_entry *rle;
375 printf("print_resource_list: rl %p\n", rl);
376 SLIST_FOREACH(rle, rl, link)
377 printf(" type %x, rid %x start %x end %x count %x\n",
378 rle->type, rle->rid, rle->start, rle->end, rle->count);
379 printf("print_resource_list: end.\n");
385 puc_alloc_resource(device_t dev, device_t child, int type, int *rid,
386 u_long start, u_long end, u_long count, u_int flags)
388 struct puc_device *pdev;
389 struct resource *retval;
390 struct resource_list *rl;
391 struct resource_list_entry *rle;
393 pdev = device_get_ivars(child);
394 rl = &pdev->resources;
397 printf("puc_alloc_resource: pdev %p, looking for t %x, r %x\n",
399 puc_print_resource_list(rl);
402 rle = resource_list_find(rl, type, *rid);
408 printf("found rle, %lx, %lx, %lx\n", start, end, count);
412 printf("oops rle is gone\n");
418 puc_release_resource(device_t dev, device_t child, int type, int rid,
419 struct resource *res)
425 puc_get_resource(device_t dev, device_t child, int type, int rid,
426 u_long *startp, u_long *countp)
428 struct puc_device *pdev;
429 struct resource_list *rl;
430 struct resource_list_entry *rle;
432 pdev = device_get_ivars(child);
433 rl = &pdev->resources;
436 printf("puc_get_resource: pdev %p, looking for t %x, r %x\n", pdev,
438 puc_print_resource_list(rl);
440 rle = resource_list_find(rl, type, rid);
443 printf("found rle %p,", rle);
446 *startp = rle->start;
448 *countp = rle->count;
450 printf(" %lx, %lx\n", rle->start, rle->count);
454 printf("oops rle is gone\n");
459 puc_setup_intr(device_t dev, device_t child, struct resource *r, int flags,
460 void (*ihand)(void *), void *arg, void **cookiep)
463 struct puc_softc *sc;
465 sc = (struct puc_softc *)device_get_softc(dev);
466 if ((flags & INTR_FAST) != sc->fastintr)
468 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) {
469 if (sc->sc_ports[i].dev == child) {
470 if (sc->sc_ports[i].ihand != 0)
472 sc->sc_ports[i].ihand = ihand;
473 sc->sc_ports[i].ihandarg = arg;
482 puc_teardown_intr(device_t dev, device_t child, struct resource *r,
486 struct puc_softc *sc;
488 sc = (struct puc_softc *)device_get_softc(dev);
489 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) {
490 if (sc->sc_ports[i].dev == child) {
491 sc->sc_ports[i].ihand = NULL;
492 sc->sc_ports[i].ihandarg = NULL;
500 puc_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
502 struct puc_device *pdev;
504 pdev = device_get_ivars(child);
510 *result = pdev->serialfreq;