xref: /freebsd/sys/i386/bios/smapi.c (revision 2357939bc239bd5334a169b62313806178dd8f30)
1 /*-
2  * Copyright (c) 2003 Matthew N. Dodd <winter@jurai.net>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 
34 #include <sys/module.h>
35 #include <sys/bus.h>
36 #include <sys/conf.h>
37 
38 #include <machine/bus.h>
39 #include <machine/resource.h>
40 #include <sys/rman.h>
41 
42 /* And all this for BIOS_PADDRTOVADDR() */
43 #include <vm/vm.h>
44 #include <vm/pmap.h>
45 #include <machine/md_var.h>
46 #include <machine/pc/bios.h>
47 
48 #include <machine/smapi.h>
49 
50 #define	SMAPI_START	0xf0000
51 #define	SMAPI_STEP	0x10
52 #define	SMAPI_OFF	0
53 #define	SMAPI_LEN	4
54 #define	SMAPI_SIG	"$SMB"
55 
56 #define	RES2HDR(res)	((struct smapi_bios_header *)rman_get_virtual(res))
57 #define	ADDR2HDR(addr)	((struct smapi_bios_header *)BIOS_PADDRTOVADDR(addr))
58 
59 struct smapi_softc {
60 	dev_t			cdev;
61 	device_t		dev;
62 	struct resource *	res;
63 	int			rid;
64 
65 	u_int32_t		smapi32_entry;
66 
67 	struct smapi_bios_header *header;
68 };
69 
70 extern u_long smapi32_offset;
71 extern u_short smapi32_segment;
72 
73 devclass_t smapi_devclass;
74 
75 static d_ioctl_t smapi_ioctl;
76 
77 static struct cdevsw smapi_cdevsw = {
78 	.d_version =	D_VERSION,
79 	.d_ioctl =	smapi_ioctl,
80 	.d_name =	"smapi",
81 	.d_flags =	D_MEM | D_NEEDGIANT,
82 };
83 
84 static void	smapi_identify		(driver_t *, device_t);
85 static int	smapi_probe		(device_t);
86 static int	smapi_attach		(device_t);
87 static int	smapi_detach            (device_t);
88 static int	smapi_modevent		(module_t, int, void *);
89 
90 static int	smapi_header_cksum	(struct smapi_bios_header *);
91 
92 extern int	smapi32			(struct smapi_bios_parameter *,
93 					 struct smapi_bios_parameter *);
94 extern int	smapi32_new		(u_long, u_short,
95 					 struct smapi_bios_parameter *,
96 					 struct smapi_bios_parameter *);
97 
98 static int
99 smapi_ioctl (dev, cmd, data, fflag, td)
100 	dev_t		dev;
101 	u_long		cmd;
102 	caddr_t		data;
103 	int		fflag;
104 	d_thread_t *	td;
105 {
106 	struct smapi_softc *sc;
107 	int error;
108 
109 	error = 0;
110 	sc = devclass_get_softc(smapi_devclass, minor(dev));
111         if (sc == NULL) {
112                 error = ENXIO;
113                 goto fail;
114         }
115 
116 	switch (cmd) {
117 	case SMAPIOGHEADER:
118 		bcopy((caddr_t)sc->header, data,
119 				sizeof(struct smapi_bios_header));
120 		error = 0;
121 		break;
122 	case SMAPIOCGFUNCTION:
123 		smapi32_offset = sc->smapi32_entry;
124 		error = smapi32((struct smapi_bios_parameter *)data,
125 				(struct smapi_bios_parameter *)data);
126 		break;
127 	default:
128 		error = ENOTTY;
129 	}
130 
131 fail:
132 	return (error);
133 }
134 
135 static int
136 smapi_header_cksum (struct smapi_bios_header *header)
137 {
138 	u_int8_t *ptr;
139 	u_int8_t cksum;
140 	int i;
141 
142 	ptr = (u_int8_t *)header;
143 	cksum = 0;
144 	for (i = 0; i < header->length; i++) {
145 		cksum += ptr[i];
146 	}
147 
148 	return (cksum);
149 }
150 
151 static void
152 smapi_identify (driver_t *driver, device_t parent)
153 {
154 	device_t child;
155 	u_int32_t addr;
156 	int length;
157 	int rid;
158 
159 	if (!device_is_alive(parent))
160 		return;
161 
162 	addr = bios_sigsearch(SMAPI_START, SMAPI_SIG, SMAPI_LEN,
163                               SMAPI_STEP, SMAPI_OFF);
164 	if (addr != 0) {
165 		rid = 0;
166 		length = ADDR2HDR(addr)->length;
167 
168 		child = BUS_ADD_CHILD(parent, 0, "smapi", -1);
169 		device_set_driver(child, driver);
170 		bus_set_resource(child, SYS_RES_MEMORY, rid, addr, length);
171 		device_set_desc(child, "SMAPI BIOS");
172 	}
173 
174 	return;
175 }
176 
177 static int
178 smapi_probe (device_t dev)
179 {
180 	struct resource *res;
181 	int rid;
182 	int error;
183 
184 	error = 0;
185 	rid = 0;
186 	res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
187 	if (res == NULL) {
188 		device_printf(dev, "Unable to allocate memory resource.\n");
189 		error = ENOMEM;
190 		goto bad;
191 	}
192 
193 	if (smapi_header_cksum(RES2HDR(res))) {
194 		device_printf(dev, "SMAPI header checksum failed.\n");
195 		error = ENXIO;
196 		goto bad;
197 	}
198 
199 bad:
200 	if (res)
201 		bus_release_resource(dev, SYS_RES_MEMORY, rid, res);
202 	return (error);
203 }
204 
205 static int
206 smapi_attach (device_t dev)
207 {
208 	struct smapi_softc *sc;
209 	int error;
210 
211 	sc = device_get_softc(dev);
212 	error = 0;
213 
214 	sc->dev = dev;
215 	sc->rid = 0;
216 	sc->res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->rid,
217 		 RF_ACTIVE);
218 	if (sc->res == NULL) {
219 		device_printf(dev, "Unable to allocate memory resource.\n");
220 		error = ENOMEM;
221 		goto bad;
222 	}
223 	sc->header = (struct smapi_bios_header *)rman_get_virtual(sc->res);
224 	sc->smapi32_entry = (u_int32_t)BIOS_PADDRTOVADDR(
225 					sc->header->prot32_segment +
226 					sc->header->prot32_offset);
227 
228         sc->cdev = make_dev(&smapi_cdevsw,
229 			device_get_unit(sc->dev),
230 			UID_ROOT, GID_WHEEL, 0600,
231 			"%s%d",
232 			smapi_cdevsw.d_name,
233 			device_get_unit(sc->dev));
234 
235 	device_printf(dev, "Version: %d.%02d, Length: %d, Checksum: 0x%02x\n",
236 		bcd2bin(sc->header->version_major),
237 		bcd2bin(sc->header->version_minor),
238 		sc->header->length,
239 		sc->header->checksum);
240 	device_printf(dev, "Information=0x%b\n",
241 		sc->header->information,
242 		"\020"
243 		"\001REAL_VM86"
244 		"\002PROTECTED_16"
245 		"\003PROTECTED_32");
246 
247 	if (bootverbose) {
248 		if (sc->header->information & SMAPI_REAL_VM86)
249 			device_printf(dev, "Real/VM86 mode: Segment 0x%04x, Offset 0x%04x\n",
250 				sc->header->real16_segment,
251 				sc->header->real16_offset);
252 		if (sc->header->information & SMAPI_PROT_16BIT)
253 			device_printf(dev, "16-bit Protected mode: Segment 0x%08x, Offset 0x%04x\n",
254 				sc->header->prot16_segment,
255 				sc->header->prot16_offset);
256 		if (sc->header->information & SMAPI_PROT_32BIT)
257 			device_printf(dev, "32-bit Protected mode: Segment 0x%08x, Offset 0x%08x\n",
258 				sc->header->prot32_segment,
259 				sc->header->prot32_offset);
260 	}
261 
262 	return (0);
263 bad:
264 	if (sc->res)
265 		bus_release_resource(dev, SYS_RES_MEMORY, sc->rid, sc->res);
266 	return (error);
267 }
268 
269 static int
270 smapi_detach (device_t dev)
271 {
272 	struct smapi_softc *sc;
273 
274 	sc = device_get_softc(dev);
275 
276 	destroy_dev(sc->cdev);
277 
278 	if (sc->res)
279 		bus_release_resource(dev, SYS_RES_MEMORY, sc->rid, sc->res);
280 
281 	return (0);
282 }
283 
284 static int
285 smapi_modevent (mod, what, arg)
286         module_t        mod;
287         int             what;
288         void *          arg;
289 {
290 	device_t *	devs;
291 	int		count;
292 	int		i;
293 
294 	switch (what) {
295 	case MOD_LOAD:
296 		break;
297 	case MOD_UNLOAD:
298 		devclass_get_devices(smapi_devclass, &devs, &count);
299 		for (i = 0; i < count; i++) {
300 			device_delete_child(device_get_parent(devs[i]), devs[i]);
301 		}
302 		break;
303 	default:
304 		break;
305 	}
306 
307 	return (0);
308 }
309 
310 static device_method_t smapi_methods[] = {
311 	/* Device interface */
312 	DEVMETHOD(device_identify,      smapi_identify),
313 	DEVMETHOD(device_probe,         smapi_probe),
314 	DEVMETHOD(device_attach,        smapi_attach),
315 	DEVMETHOD(device_detach,        smapi_detach),
316 	{ 0, 0 }
317 };
318 
319 static driver_t smapi_driver = {
320 	"smapi",
321 	smapi_methods,
322 	sizeof(struct smapi_softc),
323 };
324 
325 DRIVER_MODULE(smapi, nexus, smapi_driver, smapi_devclass, smapi_modevent, 0);
326 MODULE_VERSION(smapi, 1);
327