2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997 Michael Smith
5 * Copyright (c) 1998 Jonathan Lemon
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
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 AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 * Code for dealing with the BIOS in x86 PC systems.
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
48 #include <machine/md_var.h>
49 #include <machine/segments.h>
50 #include <machine/stdarg.h>
51 #include <machine/vmparam.h>
52 #include <machine/pc/bios.h>
54 #include <isa/isavar.h>
55 #include <isa/pnpreg.h>
56 #include <isa/pnpvar.h>
59 #define BIOS_START 0xe0000
60 #define BIOS_SIZE 0x20000
62 /* exported lookup results */
63 struct bios32_SDentry PCIbios;
65 static struct PnPBIOS_table *PnPBIOStable;
67 static u_int bios32_SDCI;
69 /* start fairly early */
70 static void bios32_init(void *junk);
71 SYSINIT(bios32, SI_SUB_CPU, SI_ORDER_ANY, bios32_init, NULL);
76 * Locate various bios32 entities.
79 bios32_init(void *junk)
82 struct bios32_SDheader *sdh;
83 struct PnPBIOS_table *pt;
89 * BIOS32 Service Directory, PCI BIOS
92 /* look for the signature */
93 if ((sigaddr = bios_sigsearch(0, "_32_", 4, 16, 0)) != 0) {
95 /* get a virtual pointer to the structure */
96 sdh = (struct bios32_SDheader *)(uintptr_t)BIOS_PADDRTOVADDR(sigaddr);
97 for (cv = (u_int8_t *)sdh, ck = 0, i = 0; i < (sdh->len * 16); i++) {
100 /* If checksum is OK, enable use of the entrypoint */
101 if ((ck == 0) && (BIOS_START <= sdh->entry ) &&
102 (sdh->entry < (BIOS_START + BIOS_SIZE))) {
103 bios32_SDCI = BIOS_PADDRTOVADDR(sdh->entry);
105 printf("bios32: Found BIOS32 Service Directory header at %p\n", sdh);
106 printf("bios32: Entry = 0x%x (%x) Rev = %d Len = %d\n",
107 sdh->entry, bios32_SDCI, sdh->revision, sdh->len);
110 /* Allow user override of PCI BIOS search */
111 if (((p = kern_getenv("machdep.bios.pci")) == NULL) || strcmp(p, "disable")) {
113 /* See if there's a PCI BIOS entrypoint here */
114 PCIbios.ident.id = 0x49435024; /* PCI systems should have this */
115 if (!bios32_SDlookup(&PCIbios) && bootverbose)
116 printf("pcibios: PCI BIOS entry at 0x%x+0x%x\n", PCIbios.base, PCIbios.entry);
121 printf("bios32: Bad BIOS32 Service Directory\n");
128 * Allow user override of PnP BIOS search
130 if ((((p = kern_getenv("machdep.bios.pnp")) == NULL) || strcmp(p, "disable")) &&
131 ((sigaddr = bios_sigsearch(0, "$PnP", 4, 16, 0)) != 0)) {
133 /* get a virtual pointer to the structure */
134 pt = (struct PnPBIOS_table *)(uintptr_t)BIOS_PADDRTOVADDR(sigaddr);
135 for (cv = (u_int8_t *)pt, ck = 0, i = 0; i < pt->len; i++) {
138 /* If checksum is OK, enable use of the entrypoint */
142 printf("pnpbios: Found PnP BIOS data at %p\n", pt);
143 printf("pnpbios: Entry = %x:%x Rev = %d.%d\n",
144 pt->pmentrybase, pt->pmentryoffset, pt->version >> 4, pt->version & 0xf);
145 if ((pt->control & 0x3) == 0x01)
146 printf("pnpbios: Event flag at %x\n", pt->evflagaddr);
147 if (pt->oemdevid != 0)
148 printf("pnpbios: OEM ID %x\n", pt->oemdevid);
152 printf("pnpbios: Bad PnP BIOS data checksum\n");
158 /* look for other know signatures */
159 printf("Other BIOS signatures found:\n");
166 * Query the BIOS32 Service Directory for the service named in (ent),
167 * returns nonzero if the lookup fails. The caller must fill in
168 * (ent->ident), the remainder are populated on a successful lookup.
171 bios32_SDlookup(struct bios32_SDentry *ent)
173 struct bios_regs args;
175 if (bios32_SDCI == 0)
178 args.eax = ent->ident.id; /* set up arguments */
179 args.ebx = args.ecx = args.edx = 0;
180 bios32(&args, bios32_SDCI, GSEL(GCODE_SEL, SEL_KPL));
181 if ((args.eax & 0xff) == 0) { /* success? */
182 ent->base = args.ebx;
184 ent->entry = args.edx;
185 ent->ventry = BIOS_PADDRTOVADDR(ent->base + ent->entry);
186 return (0); /* all OK */
188 return (1); /* failed */
195 * Search some or all of the BIOS region for a signature string.
197 * (start) Optional offset returned from this function
198 * (for searching for multiple matches), or NULL
199 * to start the search from the base of the BIOS.
200 * Note that this will be a _physical_ address in
201 * the range 0xe0000 - 0xfffff.
202 * (sig) is a pointer to the byte(s) of the signature.
203 * (siglen) number of bytes in the signature.
204 * (paralen) signature paragraph (alignment) size.
205 * (sigofs) offset of the signature within the paragraph.
207 * Returns the _physical_ address of the found signature, 0 if the
208 * signature was not found.
212 bios_sigsearch(u_int32_t start, u_char *sig, int siglen, int paralen, int sigofs)
216 /* compute the starting address */
217 if ((start >= BIOS_START) && (start <= (BIOS_START + BIOS_SIZE))) {
218 sp = (char *)BIOS_PADDRTOVADDR(start);
219 } else if (start == 0) {
220 sp = (char *)BIOS_PADDRTOVADDR(BIOS_START);
222 return 0; /* bogus start address */
225 /* compute the end address */
226 end = (u_char *)BIOS_PADDRTOVADDR(BIOS_START + BIOS_SIZE);
229 while ((sp + sigofs + siglen) < end) {
232 if (!bcmp(sp + sigofs, sig, siglen)) {
233 /* convert back to physical address */
234 return((u_int32_t)BIOS_VADDRTOPADDR(sp));
242 * do not staticize, used by bioscall.s
253 } bioscall_vector; /* bios jump vector */
256 set_bios_selectors(struct bios_segments *seg, int flags)
258 struct soft_segment_descriptor ssd = {
259 0, /* segment base address (overwritten) */
260 0, /* length (overwritten) */
261 SDT_MEMERA, /* segment type (overwritten) */
262 0, /* priority level */
263 1, /* descriptor present */
265 1, /* descriptor size (overwritten) */
266 0 /* granularity == byte units */
268 union descriptor *p_gdt;
271 p_gdt = &gdt[PCPU_GET(cpuid) * NGDT];
276 ssd.ssd_base = seg->code32.base;
277 ssd.ssd_limit = seg->code32.limit;
278 ssdtosd(&ssd, &p_gdt[GBIOSCODE32_SEL].sd);
281 if (flags & BIOSCODE_FLAG) {
282 ssd.ssd_base = seg->code16.base;
283 ssd.ssd_limit = seg->code16.limit;
284 ssdtosd(&ssd, &p_gdt[GBIOSCODE16_SEL].sd);
287 ssd.ssd_type = SDT_MEMRWA;
288 if (flags & BIOSDATA_FLAG) {
289 ssd.ssd_base = seg->data.base;
290 ssd.ssd_limit = seg->data.limit;
291 ssdtosd(&ssd, &p_gdt[GBIOSDATA_SEL].sd);
294 if (flags & BIOSUTIL_FLAG) {
295 ssd.ssd_base = seg->util.base;
296 ssd.ssd_limit = seg->util.limit;
297 ssdtosd(&ssd, &p_gdt[GBIOSUTIL_SEL].sd);
300 if (flags & BIOSARGS_FLAG) {
301 ssd.ssd_base = seg->args.base;
302 ssd.ssd_limit = seg->args.limit;
303 ssdtosd(&ssd, &p_gdt[GBIOSARGS_SEL].sd);
308 extern void bios16_jmp(void);
311 * this routine is really greedy with selectors, and uses 5:
313 * 32-bit code selector: to return to kernel
314 * 16-bit code selector: for running code
315 * data selector: for 16-bit data
316 * util selector: extra utility selector
317 * args selector: to handle pointers
319 * the util selector is set from the util16 entry in bios16_args, if a
320 * "U" specifier is seen.
322 * See <machine/pc/bios.h> for description of format specifiers
325 bios16(struct bios_args *args, char *fmt, ...)
327 char *p, *stack, *stack_top;
329 int flags = BIOSCODE_FLAG | BIOSDATA_FLAG;
330 u_int i, arg_start, arg_end;
334 arg_start = 0xffffffff;
338 * Some BIOS entrypoints attempt to copy the largest-case
339 * argument frame (in order to generalise handling for
340 * different entry types). If our argument frame is
341 * smaller than this, the BIOS will reach off the top of
342 * our constructed stack segment. Pad the top of the stack
343 * with some garbage to avoid this.
345 stack = (caddr_t)PAGE_SIZE - 32;
348 for (p = fmt; p && *p; p++) {
350 case 'p': /* 32-bit pointer */
351 i = va_arg(ap, u_int);
352 arg_start = min(arg_start, i);
353 arg_end = max(arg_end, i);
354 flags |= BIOSARGS_FLAG;
358 case 'i': /* 32-bit integer */
359 i = va_arg(ap, u_int);
363 case 'U': /* 16-bit selector */
364 flags |= BIOSUTIL_FLAG;
366 case 'D': /* 16-bit selector */
367 case 'C': /* 16-bit selector */
371 case 's': /* 16-bit integer passed as an int */
383 if (flags & BIOSARGS_FLAG) {
384 if (arg_end - arg_start > ctob(16))
386 args->seg.args.base = arg_start;
387 args->seg.args.limit = 0xffff;
390 args->seg.code32.base = (u_int)&bios16_jmp & PG_FRAME;
391 args->seg.code32.limit = 0xffff;
393 ptd = (pd_entry_t *)rcr3();
394 #if defined(PAE) || defined(PAE_TABLES)
401 * no page table, so create one and install it.
403 pte = (pt_entry_t *)malloc(PAGE_SIZE, M_TEMP, M_WAITOK);
404 ptd = (pd_entry_t *)((u_int)IdlePTD + KERNBASE);
405 *pte = (vm86pa - PAGE_SIZE) | PG_RW | PG_V;
406 *ptd = vtophys(pte) | PG_RW | PG_V;
409 * this is a user-level page table
412 *pte = (vm86pa - PAGE_SIZE) | PG_RW | PG_V;
414 pmap_invalidate_all(kernel_pmap); /* XXX insurance for now */
418 for (p = fmt; p && *p; p++) {
420 case 'p': /* 32-bit pointer */
421 i = va_arg(ap, u_int);
422 *(u_int *)stack = (i - arg_start) |
423 (GSEL(GBIOSARGS_SEL, SEL_KPL) << 16);
427 case 'i': /* 32-bit integer */
428 i = va_arg(ap, u_int);
433 case 'U': /* 16-bit selector */
434 *(u_short *)stack = GSEL(GBIOSUTIL_SEL, SEL_KPL);
438 case 'D': /* 16-bit selector */
439 *(u_short *)stack = GSEL(GBIOSDATA_SEL, SEL_KPL);
443 case 'C': /* 16-bit selector */
444 *(u_short *)stack = GSEL(GBIOSCODE16_SEL, SEL_KPL);
448 case 's': /* 16-bit integer passed as an int */
450 *(u_short *)stack = i;
461 set_bios_selectors(&args->seg, flags);
462 bioscall_vector.vec16.offset = (u_short)args->entry;
463 bioscall_vector.vec16.segment = GSEL(GBIOSCODE16_SEL, SEL_KPL);
465 i = bios16_call(&args->r, stack_top);
468 *pte = 0; /* remove entry */
470 * XXX only needs to be invlpg(0) but that doesn't work on the 386
472 pmap_invalidate_all(kernel_pmap);
474 *ptd = 0; /* remove page table */
476 * XXX only needs to be invlpg(0) but that doesn't work on the 386
478 pmap_invalidate_all(kernel_pmap);
479 free(pte, M_TEMP); /* ... and free it */
485 bios_oem_strings(struct bios_oem *oem, u_char *buffer, size_t maxlen)
488 struct bios_oem_signature *sig;
490 u_char c, *s, *se, *str, *bios_str;
491 size_t i, off, len, tot;
493 if ( !oem || !buffer || maxlen<2 )
496 sig = oem->signature;
500 from = oem->range.from;
502 if ( (to<=from) || (from<BIOS_START) || (to>(BIOS_START+BIOS_SIZE)) )
505 while (sig->anchor != NULL) {
510 /* make sure offset doesn't go beyond bios area */
511 if ( (to+off)>(BIOS_START+BIOS_SIZE) ||
512 ((from+off)<BIOS_START) ) {
513 printf("sys/i386/i386/bios.c: sig '%s' "
514 "from 0x%0x to 0x%0x offset %d "
515 "out of BIOS bounds 0x%0x - 0x%0x\n",
517 BIOS_START, BIOS_START+BIOS_SIZE);
520 /* make sure we don't overrun return buffer */
521 if (idx + tot > maxlen - 1) {
522 printf("sys/i386/i386/bios.c: sig '%s' "
523 "idx %d + tot %d = %d > maxlen-1 %d\n",
524 str, idx, tot, idx+tot, maxlen-1);
528 s = (u_char *)BIOS_PADDRTOVADDR(from);
529 se = (u_char *)BIOS_PADDRTOVADDR(to-len);
531 if (!bcmp(str, s, len)) {
537 * store pretty version of totlen bytes of bios string with
538 * given offset; 0x20 - 0x7E are printable; uniquify spaces
541 for (i=0; i<tot; i++) {
543 if ( (c < 0x20) || (c > 0x7E) )
548 } else if ( (c != ' ') ||
549 ((c == ' ') && (buffer[idx-1] != ' ')) )
555 /* remove a final trailing space */
556 if ( (idx > 1) && (buffer[idx-1] == ' ') )
564 * PnP BIOS interface; enumerate devices only known to the system
565 * BIOS and save information about them for later use.
575 #define PNPATTR_NODISABLE (1<<0) /* can't be disabled */
576 #define PNPATTR_NOCONFIG (1<<1) /* can't be configured */
577 #define PNPATTR_OUTPUT (1<<2) /* can be primary output */
578 #define PNPATTR_INPUT (1<<3) /* can be primary input */
579 #define PNPATTR_BOOTABLE (1<<4) /* can be booted from */
580 #define PNPATTR_DOCK (1<<5) /* is a docking station */
581 #define PNPATTR_REMOVEABLE (1<<6) /* device is removeable */
582 #define PNPATTR_CONFIG_STATIC (0)
583 #define PNPATTR_CONFIG_DYNAMIC (1)
584 #define PNPATTR_CONFIG_DYNONLY (3)
585 #define PNPATTR_CONFIG(a) (((a) >> 7) & 0x3)
586 /* device-specific data comes here */
590 /* We have to cluster arguments within a 64k range for the bios16 call */
591 struct pnp_sysdevargs
594 struct pnp_sysdev node;
598 * This function is called after the bus has assigned resource
599 * locations for a logical device.
602 pnpbios_set_config(void *arg, struct isa_config *config, int enable)
607 * Quiz the PnP BIOS, build a list of PNP IDs and resource data.
610 pnpbios_identify(driver_t *driver, device_t parent)
612 struct PnPBIOS_table *pt = PnPBIOStable;
613 struct bios_args args;
614 struct pnp_sysdev *pd;
615 struct pnp_sysdevargs *pda;
616 u_int16_t ndevs, bigdev;
618 u_int8_t *devnodebuf, tag;
619 u_int32_t *devid, *compid;
623 /* no PnP BIOS information */
627 /* Check to see if ACPI is already active. */
628 dev = devclass_get_device(devclass_find("acpi"), 0);
629 if (dev != NULL && device_is_attached(dev))
632 /* get count of PnP devices */
633 bzero(&args, sizeof(args));
634 args.seg.code16.base = BIOS_PADDRTOVADDR(pt->pmentrybase);
635 args.seg.code16.limit = 0xffff; /* XXX ? */
636 args.seg.data.base = BIOS_PADDRTOVADDR(pt->pmdataseg);
637 args.seg.data.limit = 0xffff;
638 args.entry = pt->pmentryoffset;
640 if ((error = bios16(&args, PNP_COUNT_DEVNODES, &ndevs, &bigdev)) || (args.r.eax & 0xff)) {
641 printf("pnpbios: error %d/%x getting device count/size limit\n", error, args.r.eax);
644 ndevs &= 0xff; /* clear high byte garbage */
646 printf("pnpbios: %d devices, largest %d bytes\n", ndevs, bigdev);
648 devnodebuf = malloc(bigdev + (sizeof(struct pnp_sysdevargs) - sizeof(struct pnp_sysdev)),
650 if (devnodebuf == NULL) {
651 printf("pnpbios: cannot allocate memory, bailing\n");
654 pda = (struct pnp_sysdevargs *)devnodebuf;
657 for (currdev = 0, left = ndevs; (currdev != 0xff) && (left > 0); left--) {
661 /* get current configuration */
662 if ((error = bios16(&args, PNP_GET_DEVNODE, &pda->next, &pda->node, 1))) {
663 printf("pnpbios: error %d making BIOS16 call\n", error);
666 if ((error = (args.r.eax & 0xff))) {
668 printf("pnpbios: %s 0x%x fetching node %d\n", error & 0x80 ? "error" : "warning", error, currdev);
673 if (pd->size < sizeof(struct pnp_sysdev)) {
674 printf("pnpbios: bogus system node data, aborting scan\n");
679 * Ignore PICs so that we don't have to worry about the PICs
680 * claiming IRQs to prevent their use. The PIC drivers
681 * already ensure that invalid IRQs are not used.
683 if (!strcmp(pnp_eisaformat(pd->devid), "PNP0000")) /* ISA PIC */
685 if (!strcmp(pnp_eisaformat(pd->devid), "PNP0003")) /* APIC */
688 /* Add the device and parse its resources */
689 dev = BUS_ADD_CHILD(parent, ISA_ORDER_PNPBIOS, NULL, -1);
690 isa_set_vendorid(dev, pd->devid);
691 isa_set_logicalid(dev, pd->devid);
693 * It appears that some PnP BIOS doesn't allow us to re-enable
694 * the embedded system device once it is disabled. We shall
695 * mark all system device nodes as "cannot be disabled", regardless
696 * of actual settings in the device attribute byte.
698 isa_set_configattr(dev,
699 ((pd->attrib & PNPATTR_NODISABLE) ? 0 : ISACFGATTR_CANDISABLE) |
700 ((!(pd->attrib & PNPATTR_NOCONFIG) &&
701 PNPATTR_CONFIG(pd->attrib) != PNPATTR_CONFIG_STATIC)
702 ? ISACFGATTR_DYNAMIC : 0));
704 isa_set_configattr(dev,
705 (!(pd->attrib & PNPATTR_NOCONFIG) &&
706 PNPATTR_CONFIG(pd->attrib) != PNPATTR_CONFIG_STATIC)
707 ? ISACFGATTR_DYNAMIC : 0);
708 isa_set_pnpbios_handle(dev, pd->handle);
709 ISA_SET_CONFIG_CALLBACK(parent, dev, pnpbios_set_config, 0);
710 pnp_parse_resources(dev, &pd->devdata[0],
711 pd->size - sizeof(struct pnp_sysdev), 0);
712 if (!device_get_desc(dev))
713 device_set_desc_copy(dev, pnp_eisaformat(pd->devid));
715 /* Find device IDs */
719 /* look for a compatible device ID too */
720 left = pd->size - sizeof(struct pnp_sysdev);
723 tag = pd->devdata[idx++];
724 if (PNP_RES_TYPE(tag) == 0) {
726 switch (PNP_SRES_NUM(tag)) {
727 case PNP_TAG_COMPAT_DEVICE:
728 compid = (u_int32_t *)(pd->devdata + idx);
730 printf("pnpbios: node %d compat ID 0x%08x\n", pd->handle, *compid);
736 idx += PNP_SRES_LEN(tag);
740 /* Large resource, skip it */
741 idx += *(u_int16_t *)(pd->devdata + idx) + 2;
744 printf("pnpbios: handle %d device ID %s (%08x)",
745 pd->handle, pnp_eisaformat(*devid), *devid);
747 printf(" compat ID %s (%08x)",
748 pnp_eisaformat(*compid), *compid);
754 static device_method_t pnpbios_methods[] = {
755 /* Device interface */
756 DEVMETHOD(device_identify, pnpbios_identify),
761 static driver_t pnpbios_driver = {
767 static devclass_t pnpbios_devclass;
769 DRIVER_MODULE(pnpbios, isa, pnpbios_driver, pnpbios_devclass, 0, 0);