sys/amd64/include/pc/bios.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1997 Michael Smith
   5  * Copyright (c) 1998 Jonathan Lemon
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  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.
  16  *
  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
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _MACHINE_PC_BIOS_H_
  33 #define _MACHINE_PC_BIOS_H_
  34
  35 /*
  36  * Int 15:E820 'SMAP' structure
  37  */
  38 #define SMAP_SIG        0x534D4150                      /* 'SMAP' */
  39
  40 #define SMAP_TYPE_MEMORY        1
  41 #define SMAP_TYPE_RESERVED      2
  42 #define SMAP_TYPE_ACPI_RECLAIM  3
  43 #define SMAP_TYPE_ACPI_NVS      4
  44 #define SMAP_TYPE_ACPI_ERROR    5
  45 #define SMAP_TYPE_DISABLED      6
  46 #define SMAP_TYPE_PMEM          7
  47 #define SMAP_TYPE_PRAM          12
  48
  49 #define SMAP_XATTR_ENABLED      0x00000001
  50 #define SMAP_XATTR_NON_VOLATILE 0x00000002
  51 #define SMAP_XATTR_MASK         (SMAP_XATTR_ENABLED | SMAP_XATTR_NON_VOLATILE)
  52
  53 struct bios_smap {
  54     u_int64_t   base;
  55     u_int64_t   length;
  56     u_int32_t   type;
  57 } __packed;
  58
  59 /* Structure extended to include extended attribute field in ACPI 3.0. */
  60 struct bios_smap_xattr {
  61     u_int64_t   base;
  62     u_int64_t   length;
  63     u_int32_t   type;
  64     u_int32_t   xattr;
  65 } __packed;
  66
  67 /*
  68  * System Management BIOS
  69  */
  70 #define SMBIOS_START    0xf0000
  71 #define SMBIOS_STEP     0x10
  72 #define SMBIOS_OFF      0
  73 #define SMBIOS_LEN      4
  74 #define SMBIOS_SIG      "_SM_"
  75
  76 struct smbios_eps {
  77         uint8_t         anchor_string[4];               /* '_SM_' */
  78         uint8_t         checksum;
  79         uint8_t         length;
  80         uint8_t         major_version;
  81         uint8_t         minor_version;
  82         uint16_t        maximum_structure_size;
  83         uint8_t         entry_point_revision;
  84         uint8_t         formatted_area[5];
  85         uint8_t         intermediate_anchor_string[5];  /* '_DMI_' */
  86         uint8_t         intermediate_checksum;
  87         uint16_t        structure_table_length;
  88         uint32_t        structure_table_address;
  89         uint16_t        number_structures;
  90         uint8_t         BCD_revision;
  91 };
  92
  93 struct smbios_structure_header {
  94         uint8_t         type;
  95         uint8_t         length;
  96         uint16_t        handle;
  97 };
  98
  99 #ifdef _KERNEL
 100 #define BIOS_PADDRTOVADDR(x)    ((x) + KERNBASE)
 101 #define BIOS_VADDRTOPADDR(x)    ((x) - KERNBASE)
 102
 103 struct bios_oem_signature {
 104         char * anchor;          /* search anchor string in BIOS memory */
 105         size_t offset;          /* offset from anchor (may be negative) */
 106         size_t totlen;          /* total length of BIOS string to copy */
 107 } __packed;
 108
 109 struct bios_oem_range {
 110         u_int from;             /* shouldn't be below 0xe0000 */
 111         u_int to;               /* shouldn't be above 0xfffff */
 112 } __packed;
 113
 114 struct bios_oem {
 115         struct bios_oem_range range;
 116         struct bios_oem_signature signature[];
 117 } __packed;
 118
 119 int     bios_oem_strings(struct bios_oem *oem, u_char *buffer, size_t maxlen);
 120 uint32_t bios_sigsearch(uint32_t start, u_char *sig, int siglen, int paralen,
 121             int sigofs);
 122 void bios_add_smap_entries(struct bios_smap *smapbase, u_int32_t smapsize,
 123             vm_paddr_t *physmap, int *physmap_idx);
 124 #endif
 125
 126 #endif /* _MACHINE_PC_BIOS_H_ */