xref: /freebsd/sys/x86/isa/orm.c (revision a05a680469a7ac77b195021fed74e3aa58152dd7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2000 Nikolai Saoukh
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 /*
31  * Driver to take care of holes in ISA I/O memory occupied
32  * by option rom(s)
33  */
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/socket.h>
39 
40 #include <sys/module.h>
41 #include <sys/bus.h>
42 
43 #include <machine/bus.h>
44 #include <machine/resource.h>
45 #include <sys/rman.h>
46 
47 #include <isa/isavar.h>
48 #include <isa/pnpvar.h>
49 
50 #define	IOMEM_START	0x0a0000
51 #define	IOMEM_STEP	0x000800
52 #define	IOMEM_END	0x100000
53 
54 #define	ORM_ID	0x00004d3e
55 
56 static struct isa_pnp_id orm_ids[] = {
57 	{ ORM_ID,	NULL },		/* ORM0000 */
58 	{ 0,		NULL },
59 };
60 
61 #define MAX_ROMS	32
62 
63 struct orm_softc {
64 	int		rnum;
65 	int		rid[MAX_ROMS];
66 	struct resource *res[MAX_ROMS];
67 };
68 
69 static int
70 orm_probe(device_t dev)
71 {
72 	return (ISA_PNP_PROBE(device_get_parent(dev), dev, orm_ids));
73 }
74 
75 static int
76 orm_attach(device_t dev)
77 {
78 	return (0);
79 }
80 
81 static void
82 orm_identify(driver_t* driver, device_t parent)
83 {
84 	bus_space_handle_t	bh;
85 	bus_space_tag_t		bt;
86 	device_t		child;
87 	u_int32_t		chunk = IOMEM_START;
88 	struct resource		*res;
89 	int			rid;
90 	u_int32_t		rom_size;
91 	struct orm_softc	*sc;
92 	u_int8_t		buf[3];
93 
94 	if (resource_disabled("orm", 0))
95 		return;
96 
97 	child = BUS_ADD_CHILD(parent, ISA_ORDER_SENSITIVE, "orm", DEVICE_UNIT_ANY);
98 	device_set_driver(child, driver);
99 	isa_set_logicalid(child, ORM_ID);
100 	isa_set_vendorid(child, ORM_ID);
101 	sc = device_get_softc(child);
102 	sc->rnum = 0;
103 	while (sc->rnum < MAX_ROMS && chunk < IOMEM_END) {
104 		bus_set_resource(child, SYS_RES_MEMORY, sc->rnum, chunk,
105 		    IOMEM_STEP);
106 		rid = sc->rnum;
107 		res = bus_alloc_resource_any(child, SYS_RES_MEMORY, &rid,
108 		    RF_ACTIVE);
109 		if (res == NULL) {
110 			bus_delete_resource(child, SYS_RES_MEMORY, sc->rnum);
111 			chunk += IOMEM_STEP;
112 			continue;
113 		}
114 		bt = rman_get_bustag(res);
115 		bh = rman_get_bushandle(res);
116 		bus_space_read_region_1(bt, bh, 0, buf, sizeof(buf));
117 
118 		/*
119 		 * We need to release and delete the resource since we're
120 		 * changing its size, or the rom isn't there.  There
121 		 * is a checksum field in the ROM to prevent false
122 		 * positives.  However, some common hardware (IBM thinkpads)
123 		 * neglects to put a valid checksum in the ROM, so we do
124 		 * not double check the checksum here.  On the ISA bus
125 		 * areas that have no hardware read back as 0xff, so the
126 		 * tests to see if we have 0x55 followed by 0xaa are
127 		 * generally sufficient.
128 		 */
129 		bus_release_resource(child, SYS_RES_MEMORY, rid, res);
130 		bus_delete_resource(child, SYS_RES_MEMORY, sc->rnum);
131 		if (buf[0] != 0x55 || buf[1] != 0xAA || (buf[2] & 0x03) != 0) {
132 			chunk += IOMEM_STEP;
133 			continue;
134 		}
135 		rom_size = buf[2] << 9;
136 		bus_set_resource(child, SYS_RES_MEMORY, sc->rnum, chunk,
137 		    rom_size);
138 		rid = sc->rnum;
139 		res = bus_alloc_resource_any(child, SYS_RES_MEMORY, &rid, 0);
140 		if (res == NULL) {
141 			bus_delete_resource(child, SYS_RES_MEMORY, sc->rnum);
142 			chunk += IOMEM_STEP;
143 			continue;
144 		}
145 		sc->rid[sc->rnum] = rid;
146 		sc->res[sc->rnum] = res;
147 		sc->rnum++;
148 		chunk += rom_size;
149 	}
150 
151 	if (sc->rnum == 0)
152 		device_delete_child(parent, child);
153 	else if (sc->rnum == 1)
154 		device_set_desc(child, "ISA Option ROM");
155 	else
156 		device_set_desc(child, "ISA Option ROMs");
157 }
158 
159 static int
160 orm_detach(device_t dev)
161 {
162 	int			i;
163 	struct orm_softc	*sc = device_get_softc(dev);
164 
165 	for (i = 0; i < sc->rnum; i++)
166 		bus_release_resource(dev, SYS_RES_MEMORY, sc->rid[i],
167 		    sc->res[i]);
168 	return (0);
169 }
170 
171 static device_method_t orm_methods[] = {
172 	/* Device interface */
173 	DEVMETHOD(device_identify,	orm_identify),
174 	DEVMETHOD(device_probe,		orm_probe),
175 	DEVMETHOD(device_attach,	orm_attach),
176 	DEVMETHOD(device_detach,	orm_detach),
177 	{ 0, 0 }
178 };
179 
180 static driver_t orm_driver = {
181 	"orm",
182 	orm_methods,
183 	sizeof (struct orm_softc)
184 };
185 
186 DRIVER_MODULE(orm, isa, orm_driver, 0, 0);
187 ISA_PNP_INFO(orm_ids);
188