2 * Copyright (c) 1999 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * Modifications for Intel architecture by Garrett A. Wollman.
30 * Copyright 1998 Massachusetts Institute of Technology
32 * Permission to use, copy, modify, and distribute this software and
33 * its documentation for any purpose and without fee is hereby
34 * granted, provided that both the above copyright notice and this
35 * permission notice appear in all copies, that both the above
36 * copyright notice and this permission notice appear in all
37 * supporting documentation, and that the name of M.I.T. not be used
38 * in advertising or publicity pertaining to distribution of the
39 * software without specific, written prior permission. M.I.T. makes
40 * no representations about the suitability of this software for any
41 * purpose. It is provided "as is" without express or implied
44 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS
45 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
46 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
47 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
48 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
51 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
52 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
53 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
54 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * Parts of the ISA bus implementation common to all architectures.
62 #include <sys/param.h>
63 #include <sys/systm.h>
64 #include <sys/kernel.h>
66 #include <sys/malloc.h>
67 #include <sys/module.h>
68 #include <machine/bus.h>
71 #include <machine/resource.h>
73 #include <isa/isavar.h>
74 #include <isa/isa_common.h>
75 #ifdef __alpha__ /* XXX workaround a stupid warning */
76 #include <alpha/isa/isavar.h>
79 MALLOC_DEFINE(M_ISADEV, "isadev", "ISA device");
81 static devclass_t isa_devclass;
82 static int isa_running;
85 * At 'probe' time, we add all the devices which we know about to the
86 * bus. The generic attach routine will probe and attach them if they
90 isa_probe(device_t dev)
92 device_set_desc(dev, "ISA bus");
93 isa_init(); /* Allow machdep code to initialise */
97 extern device_t isa_bus_device;
100 isa_attach(device_t dev)
103 * Arrange for isa_probe_children(dev) to be called later. XXX
105 isa_bus_device = dev;
110 * Find a working set of memory regions for a child using the ranges
111 * in *config and return the regions in *result. Returns non-zero if
112 * a set of ranges was found.
115 isa_find_memory(device_t child,
116 struct isa_config *config,
117 struct isa_config *result)
120 struct resource *res[ISA_NMEM];
123 * First clear out any existing resource definitions.
125 for (i = 0; i < ISA_NMEM; i++) {
126 bus_delete_resource(child, SYS_RES_MEMORY, i);
131 result->ic_nmem = config->ic_nmem;
132 for (i = 0; i < config->ic_nmem; i++) {
133 u_int32_t start, end, size, align;
134 for (start = config->ic_mem[i].ir_start,
135 end = config->ic_mem[i].ir_end,
136 size = config->ic_mem[i].ir_size,
137 align = config->ic_mem[i].ir_align;
138 start + size - 1 <= end;
140 bus_set_resource(child, SYS_RES_MEMORY, i,
142 res[i] = bus_alloc_resource(child,
144 0, ~0, 1, RF_ACTIVE);
146 result->ic_mem[i].ir_start = start;
147 result->ic_mem[i].ir_end = start + size - 1;
148 result->ic_mem[i].ir_size = size;
149 result->ic_mem[i].ir_align = align;
155 * If we didn't find a place for memory range i, then
164 for (i = 0; i < ISA_NMEM; i++) {
166 bus_release_resource(child, SYS_RES_MEMORY,
174 * Find a working set of port regions for a child using the ranges
175 * in *config and return the regions in *result. Returns non-zero if
176 * a set of ranges was found.
179 isa_find_port(device_t child,
180 struct isa_config *config,
181 struct isa_config *result)
184 struct resource *res[ISA_NPORT];
187 * First clear out any existing resource definitions.
189 for (i = 0; i < ISA_NPORT; i++) {
190 bus_delete_resource(child, SYS_RES_IOPORT, i);
195 result->ic_nport = config->ic_nport;
196 for (i = 0; i < config->ic_nport; i++) {
197 u_int32_t start, end, size, align;
198 for (start = config->ic_port[i].ir_start,
199 end = config->ic_port[i].ir_end,
200 size = config->ic_port[i].ir_size,
201 align = config->ic_port[i].ir_align;
202 start + size - 1 <= end;
204 bus_set_resource(child, SYS_RES_IOPORT, i,
206 res[i] = bus_alloc_resource(child,
208 0, ~0, 1, RF_ACTIVE);
210 result->ic_port[i].ir_start = start;
211 result->ic_port[i].ir_end = start + size - 1;
212 result->ic_port[i].ir_size = size;
213 result->ic_port[i].ir_align = align;
219 * If we didn't find a place for port range i, then
228 for (i = 0; i < ISA_NPORT; i++) {
230 bus_release_resource(child, SYS_RES_IOPORT,
238 * Return the index of the first bit in the mask (or -1 if mask is empty.
241 find_first_bit(u_int32_t mask)
243 return ffs(mask) - 1;
247 * Return the index of the next bit in the mask, or -1 if there are no more.
250 find_next_bit(u_int32_t mask, int bit)
253 while (bit < 32 && !(mask & (1 << bit)))
261 * Find a working set of irqs for a child using the masks in *config
262 * and return the regions in *result. Returns non-zero if a set of
266 isa_find_irq(device_t child,
267 struct isa_config *config,
268 struct isa_config *result)
271 struct resource *res[ISA_NIRQ];
274 * First clear out any existing resource definitions.
276 for (i = 0; i < ISA_NIRQ; i++) {
277 bus_delete_resource(child, SYS_RES_IRQ, i);
282 result->ic_nirq = config->ic_nirq;
283 for (i = 0; i < config->ic_nirq; i++) {
284 u_int32_t mask = config->ic_irqmask[i];
286 for (irq = find_first_bit(mask);
288 irq = find_next_bit(mask, irq)) {
289 bus_set_resource(child, SYS_RES_IRQ, i,
291 res[i] = bus_alloc_resource(child,
293 0, ~0, 1, RF_ACTIVE);
295 result->ic_irqmask[i] = (1 << irq);
301 * If we didn't find a place for irq range i, then
310 for (i = 0; i < ISA_NIRQ; i++) {
312 bus_release_resource(child, SYS_RES_IRQ,
320 * Find a working set of drqs for a child using the masks in *config
321 * and return the regions in *result. Returns non-zero if a set of
325 isa_find_drq(device_t child,
326 struct isa_config *config,
327 struct isa_config *result)
330 struct resource *res[ISA_NDRQ];
333 * First clear out any existing resource definitions.
335 for (i = 0; i < ISA_NDRQ; i++) {
336 bus_delete_resource(child, SYS_RES_DRQ, i);
341 result->ic_ndrq = config->ic_ndrq;
342 for (i = 0; i < config->ic_ndrq; i++) {
343 u_int32_t mask = config->ic_drqmask[i];
345 for (drq = find_first_bit(mask);
347 drq = find_next_bit(mask, drq)) {
348 bus_set_resource(child, SYS_RES_DRQ, i,
350 res[i] = bus_alloc_resource(child,
352 0, ~0, 1, RF_ACTIVE);
354 result->ic_drqmask[i] = (1 << drq);
360 * If we didn't find a place for drq range i, then
369 for (i = 0; i < ISA_NDRQ; i++) {
371 bus_release_resource(child, SYS_RES_DRQ,
379 * Attempt to find a working set of resources for a device. Return
380 * non-zero if a working configuration is found.
383 isa_assign_resources(device_t child)
385 struct isa_device *idev = DEVTOISA(child);
386 struct isa_config_entry *ice;
387 struct isa_config config;
389 bzero(&config, sizeof config);
390 TAILQ_FOREACH(ice, &idev->id_configs, ice_link) {
391 if (!isa_find_memory(child, &ice->ice_config, &config))
393 if (!isa_find_port(child, &ice->ice_config, &config))
395 if (!isa_find_irq(child, &ice->ice_config, &config))
397 if (!isa_find_drq(child, &ice->ice_config, &config))
401 * A working configuration was found enable the device
402 * with this configuration.
404 if (idev->id_config_cb) {
405 idev->id_config_cb(idev->id_config_arg,
412 * Disable the device.
414 if (device_get_desc(child))
415 device_printf(child, "<%s> can't assign resources\n",
416 device_get_desc(child));
418 device_printf(child, "can't assign resources\n");
419 bzero(&config, sizeof config);
420 if (idev->id_config_cb)
421 idev->id_config_cb(idev->id_config_arg, &config, 0);
422 device_disable(child);
428 * Called after other devices have initialised to probe for isa devices.
431 isa_probe_children(device_t dev)
437 * Create all the children by calling driver's identify methods.
439 bus_generic_probe(dev);
441 if (device_get_children(dev, &children, &nchildren))
445 * First disable all pnp devices so that they don't get
446 * matched by legacy probes.
449 printf("isa_probe_children: disabling PnP devices\n");
450 for (i = 0; i < nchildren; i++) {
451 device_t child = children[i];
452 struct isa_device *idev = DEVTOISA(child);
453 struct isa_config config;
455 bzero(&config, sizeof config);
456 if (idev->id_config_cb)
457 idev->id_config_cb(idev->id_config_arg, &config, 0);
461 * Next probe all non-pnp devices so that they claim their
465 printf("isa_probe_children: probing non-PnP devices\n");
466 for (i = 0; i < nchildren; i++) {
467 device_t child = children[i];
468 struct isa_device *idev = DEVTOISA(child);
470 if (TAILQ_FIRST(&idev->id_configs))
473 device_probe_and_attach(child);
477 * Finally assign resource to pnp devices and probe them.
480 printf("isa_probe_children: probing PnP devices\n");
481 for (i = 0; i < nchildren; i++) {
482 device_t child = children[i];
483 struct isa_device* idev = DEVTOISA(child);
485 if (!TAILQ_FIRST(&idev->id_configs))
488 if (isa_assign_resources(child)) {
489 struct resource_list *rl = &idev->id_resources;
490 struct resource_list_entry *rle;
492 device_probe_and_attach(child);
495 * Claim any unallocated resources to keep other
496 * devices from using them.
498 SLIST_FOREACH(rle, rl, link) {
501 resource_list_alloc(rl, dev, child,
511 free(children, M_TEMP);
517 * Add a new child with default ivars.
520 isa_add_child(device_t dev, int order, const char *name, int unit)
523 struct isa_device *idev;
525 idev = malloc(sizeof(struct isa_device), M_ISADEV, M_NOWAIT);
528 bzero(idev, sizeof *idev);
530 resource_list_init(&idev->id_resources);
531 TAILQ_INIT(&idev->id_configs);
533 child = device_add_child_ordered(dev, order, name, unit);
534 device_set_ivars(child, idev);
540 isa_print_resources(struct resource_list *rl, const char *name, int type,
541 int count, const char *format)
543 struct resource_list_entry *rle;
548 for (i = 0; i < count; i++) {
549 rle = resource_list_find(rl, type, i);
552 printf(" %s ", name);
553 else if (printed > 0)
556 printf(format, rle->start);
557 if (rle->count > 1) {
559 printf(format, rle->start + rle->count - 1);
562 /* check the first few regardless */
569 isa_print_child(device_t bus, device_t dev)
571 struct isa_device *idev = DEVTOISA(dev);
572 struct resource_list *rl = &idev->id_resources;
575 retval += bus_print_child_header(bus, dev);
577 if (SLIST_FIRST(rl) || device_get_flags(dev))
578 retval += printf(" at");
580 isa_print_resources(rl, "port", SYS_RES_IOPORT, ISA_NPORT, "%#lx");
581 isa_print_resources(rl, "iomem", SYS_RES_MEMORY, ISA_NMEM, "%#lx");
582 isa_print_resources(rl, "irq", SYS_RES_IRQ, ISA_NIRQ, "%ld");
583 isa_print_resources(rl, "drq", SYS_RES_DRQ, ISA_NDRQ, "%ld");
584 if (device_get_flags(dev))
585 retval += printf(" flags %#x", device_get_flags(dev));
587 retval += bus_print_child_footer(bus, dev);
593 isa_read_ivar(device_t bus, device_t dev, int index, uintptr_t * result)
595 struct isa_device* idev = DEVTOISA(dev);
596 struct resource_list *rl = &idev->id_resources;
597 struct resource_list_entry *rle;
600 case ISA_IVAR_PORT_0:
601 rle = resource_list_find(rl, SYS_RES_IOPORT, 0);
603 *result = rle->start;
608 case ISA_IVAR_PORT_1:
609 rle = resource_list_find(rl, SYS_RES_IOPORT, 1);
611 *result = rle->start;
616 case ISA_IVAR_PORTSIZE_0:
617 rle = resource_list_find(rl, SYS_RES_IOPORT, 0);
619 *result = rle->count;
624 case ISA_IVAR_PORTSIZE_1:
625 rle = resource_list_find(rl, SYS_RES_IOPORT, 1);
627 *result = rle->count;
632 case ISA_IVAR_MADDR_0:
633 rle = resource_list_find(rl, SYS_RES_MEMORY, 0);
635 *result = rle->start;
640 case ISA_IVAR_MADDR_1:
641 rle = resource_list_find(rl, SYS_RES_MEMORY, 1);
643 *result = rle->start;
648 case ISA_IVAR_MSIZE_0:
649 rle = resource_list_find(rl, SYS_RES_MEMORY, 0);
651 *result = rle->count;
656 case ISA_IVAR_MSIZE_1:
657 rle = resource_list_find(rl, SYS_RES_MEMORY, 1);
659 *result = rle->count;
665 rle = resource_list_find(rl, SYS_RES_IRQ, 0);
667 *result = rle->start;
673 rle = resource_list_find(rl, SYS_RES_IRQ, 1);
675 *result = rle->start;
681 rle = resource_list_find(rl, SYS_RES_DRQ, 0);
683 *result = rle->start;
689 rle = resource_list_find(rl, SYS_RES_DRQ, 1);
691 *result = rle->start;
696 case ISA_IVAR_VENDORID:
697 *result = idev->id_vendorid;
700 case ISA_IVAR_SERIAL:
701 *result = idev->id_serial;
704 case ISA_IVAR_LOGICALID:
705 *result = idev->id_logicalid;
708 case ISA_IVAR_COMPATID:
709 *result = idev->id_compatid;
720 isa_write_ivar(device_t bus, device_t dev,
721 int index, uintptr_t value)
723 struct isa_device* idev = DEVTOISA(dev);
726 case ISA_IVAR_PORT_0:
727 case ISA_IVAR_PORT_1:
728 case ISA_IVAR_PORTSIZE_0:
729 case ISA_IVAR_PORTSIZE_1:
730 case ISA_IVAR_MADDR_0:
731 case ISA_IVAR_MADDR_1:
732 case ISA_IVAR_MSIZE_0:
733 case ISA_IVAR_MSIZE_1:
740 case ISA_IVAR_VENDORID:
741 idev->id_vendorid = value;
744 case ISA_IVAR_SERIAL:
745 idev->id_serial = value;
748 case ISA_IVAR_LOGICALID:
749 idev->id_logicalid = value;
752 case ISA_IVAR_COMPATID:
753 idev->id_compatid = value;
764 * Free any resources which the driver missed or which we were holding for
765 * it (see isa_probe_children).
768 isa_child_detached(device_t dev, device_t child)
770 struct isa_device* idev = DEVTOISA(child);
771 struct resource_list *rl = &idev->id_resources;
772 struct resource_list_entry *rle;
774 SLIST_FOREACH(rle, &idev->id_resources, link) {
776 resource_list_release(rl, dev, child,
784 isa_driver_added(device_t dev, driver_t *driver)
790 * Don't do anything if drivers are dynamically
791 * added during autoconfiguration (cf. ymf724).
792 * since that would end up calling identify
798 DEVICE_IDENTIFY(driver, dev);
799 if (device_get_children(dev, &children, &nchildren))
802 for (i = 0; i < nchildren; i++) {
803 device_t child = children[i];
804 struct isa_device *idev = DEVTOISA(child);
805 struct resource_list *rl = &idev->id_resources;
806 struct resource_list_entry *rle;
808 if (device_get_state(child) != DS_NOTPRESENT)
811 if (TAILQ_FIRST(&idev->id_configs))
812 if (!isa_assign_resources(child))
815 device_probe_and_attach(child);
817 if (TAILQ_FIRST(&idev->id_configs)) {
819 * Claim any unallocated resources to keep other
820 * devices from using them.
822 SLIST_FOREACH(rle, rl, link) {
825 resource_list_alloc(rl, dev, child,
835 free(children, M_TEMP);
839 isa_set_resource(device_t dev, device_t child, int type, int rid,
840 u_long start, u_long count)
842 struct isa_device* idev = DEVTOISA(child);
843 struct resource_list *rl = &idev->id_resources;
845 if (type != SYS_RES_IOPORT && type != SYS_RES_MEMORY
846 && type != SYS_RES_IRQ && type != SYS_RES_DRQ)
850 if (type == SYS_RES_IOPORT && rid >= ISA_NPORT)
852 if (type == SYS_RES_MEMORY && rid >= ISA_NMEM)
854 if (type == SYS_RES_IRQ && rid >= ISA_NIRQ)
856 if (type == SYS_RES_DRQ && rid >= ISA_NDRQ)
859 resource_list_add(rl, type, rid, start, start + count - 1, count);
865 isa_get_resource(device_t dev, device_t child, int type, int rid,
866 u_long *startp, u_long *countp)
868 struct isa_device* idev = DEVTOISA(child);
869 struct resource_list *rl = &idev->id_resources;
870 struct resource_list_entry *rle;
872 rle = resource_list_find(rl, type, rid);
877 *startp = rle->start;
879 *countp = rle->count;
885 isa_delete_resource(device_t dev, device_t child, int type, int rid)
887 struct isa_device* idev = DEVTOISA(child);
888 struct resource_list *rl = &idev->id_resources;
889 resource_list_delete(rl, type, rid);
893 isa_add_config(device_t dev, device_t child,
894 int priority, struct isa_config *config)
896 struct isa_device* idev = DEVTOISA(child);
897 struct isa_config_entry *newice, *ice;
899 newice = malloc(sizeof *ice, M_DEVBUF, M_NOWAIT);
903 newice->ice_priority = priority;
904 newice->ice_config = *config;
906 TAILQ_FOREACH(ice, &idev->id_configs, ice_link) {
907 if (ice->ice_priority > priority)
911 TAILQ_INSERT_BEFORE(ice, newice, ice_link);
913 TAILQ_INSERT_TAIL(&idev->id_configs, newice, ice_link);
919 isa_set_config_callback(device_t dev, device_t child,
920 isa_config_cb *fn, void *arg)
922 struct isa_device* idev = DEVTOISA(child);
924 idev->id_config_cb = fn;
925 idev->id_config_arg = arg;
929 isa_pnp_probe(device_t dev, device_t child, struct isa_pnp_id *ids)
931 struct isa_device* idev = DEVTOISA(child);
933 if (!idev->id_vendorid)
938 * Really ought to support >1 compat id per device.
940 if (idev->id_logicalid == ids->ip_id
941 || idev->id_compatid == ids->ip_id) {
943 device_set_desc(child, ids->ip_desc);
952 static device_method_t isa_methods[] = {
953 /* Device interface */
954 DEVMETHOD(device_probe, isa_probe),
955 DEVMETHOD(device_attach, isa_attach),
956 DEVMETHOD(device_detach, bus_generic_detach),
957 DEVMETHOD(device_shutdown, bus_generic_shutdown),
958 DEVMETHOD(device_suspend, bus_generic_suspend),
959 DEVMETHOD(device_resume, bus_generic_resume),
962 DEVMETHOD(bus_add_child, isa_add_child),
963 DEVMETHOD(bus_print_child, isa_print_child),
964 DEVMETHOD(bus_read_ivar, isa_read_ivar),
965 DEVMETHOD(bus_write_ivar, isa_write_ivar),
966 DEVMETHOD(bus_child_detached, isa_child_detached),
967 DEVMETHOD(bus_driver_added, isa_driver_added),
968 DEVMETHOD(bus_alloc_resource, isa_alloc_resource),
969 DEVMETHOD(bus_release_resource, isa_release_resource),
970 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
971 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
972 DEVMETHOD(bus_setup_intr, isa_setup_intr),
973 DEVMETHOD(bus_teardown_intr, isa_teardown_intr),
974 DEVMETHOD(bus_set_resource, isa_set_resource),
975 DEVMETHOD(bus_get_resource, isa_get_resource),
976 DEVMETHOD(bus_delete_resource, isa_delete_resource),
979 DEVMETHOD(isa_add_config, isa_add_config),
980 DEVMETHOD(isa_set_config_callback, isa_set_config_callback),
981 DEVMETHOD(isa_pnp_probe, isa_pnp_probe),
986 static driver_t isa_driver = {
993 * ISA can be attached to a PCI-ISA bridge or directly to the nexus.
995 DRIVER_MODULE(isa, isab, isa_driver, isa_devclass, 0, 0);
997 DRIVER_MODULE(isa, nexus, isa_driver, isa_devclass, 0, 0);
1001 * A fallback driver for reporting un-matched pnp devices.
1005 unknown_probe(device_t dev)
1008 * Only match pnp devices.
1010 if (isa_get_vendorid(dev) != 0)
1016 unknown_attach(device_t dev)
1022 unknown_detach(device_t dev)
1027 static device_method_t unknown_methods[] = {
1028 /* Device interface */
1029 DEVMETHOD(device_probe, unknown_probe),
1030 DEVMETHOD(device_attach, unknown_attach),
1031 DEVMETHOD(device_detach, unknown_detach),
1036 static driver_t unknown_driver = {
1042 static devclass_t unknown_devclass;
1044 DRIVER_MODULE(unknown, isa, unknown_driver, unknown_devclass, 0, 0);