1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
//! Module for [`RsdpV1Tag`] and [`RsdpV2Tag`].
//! Module for RSDP/ACPI. RSDP (Root System Description Pointer) is a data structure used in the
//! ACPI programming interface.
//!
//! The tag that the bootloader passes will depend on the ACPI version the hardware supports.
//! For ACPI Version 1.0, a `RsdpV1Tag` will be provided, which can be accessed from
//! `BootInformation` using the `rsdp_v1_tag` function. For subsequent versions of ACPI, a
//! `RsdpV2Tag` will be provided, which can be accessed with `rsdp_v2_tag`.
//!
//! Even though the bootloader should give the address of the real RSDP/XSDT, the checksum and
//! signature should be manually verified.
//!
use crate::{Tag, TagTrait, TagType, TagTypeId};
#[cfg(feature = "builder")]
use core::mem::size_of;
use core::slice;
use core::str;
use core::str::Utf8Error;
const RSDPV1_LENGTH: usize = 20;
/// This tag contains a copy of RSDP as defined per ACPI 1.0 specification.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(C)]
pub struct RsdpV1Tag {
typ: TagTypeId,
size: u32,
signature: [u8; 8],
checksum: u8,
oem_id: [u8; 6],
revision: u8,
rsdt_address: u32, // This is the PHYSICAL address of the RSDT
}
impl RsdpV1Tag {
#[cfg(feature = "builder")]
pub fn new(
signature: [u8; 8],
checksum: u8,
oem_id: [u8; 6],
revision: u8,
rsdt_address: u32,
) -> Self {
Self {
typ: Self::ID.into(),
size: size_of::<Self>().try_into().unwrap(),
signature,
checksum,
oem_id,
revision,
rsdt_address,
}
}
/// The "RSD PTR " marker signature.
///
/// This is originally a 8-byte C string (not null terminated!) that must contain "RSD PTR "
pub fn signature(&self) -> Result<&str, Utf8Error> {
str::from_utf8(&self.signature)
}
/// Validation of the RSDPv1 checksum
pub fn checksum_is_valid(&self) -> bool {
let bytes =
unsafe { slice::from_raw_parts(self as *const _ as *const u8, RSDPV1_LENGTH + 8) };
bytes[8..]
.iter()
.fold(0u8, |acc, val| acc.wrapping_add(*val))
== 0
}
/// An OEM-supplied string that identifies the OEM.
pub fn oem_id(&self) -> Result<&str, Utf8Error> {
str::from_utf8(&self.oem_id)
}
/// The revision of the ACPI.
pub fn revision(&self) -> u8 {
self.revision
}
/// The physical (I repeat: physical) address of the RSDT table.
pub fn rsdt_address(&self) -> usize {
self.rsdt_address as usize
}
}
impl TagTrait for RsdpV1Tag {
const ID: TagType = TagType::AcpiV1;
fn dst_size(_base_tag: &Tag) {}
}
/// This tag contains a copy of RSDP as defined per ACPI 2.0 or later specification.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(C)]
pub struct RsdpV2Tag {
typ: TagTypeId,
size: u32,
signature: [u8; 8],
checksum: u8,
oem_id: [u8; 6],
revision: u8,
rsdt_address: u32,
length: u32,
xsdt_address: u64,
// This is the PHYSICAL address of the XSDT
ext_checksum: u8,
_reserved: [u8; 3],
}
impl RsdpV2Tag {
#[cfg(feature = "builder")]
#[allow(clippy::too_many_arguments)]
pub fn new(
signature: [u8; 8],
checksum: u8,
oem_id: [u8; 6],
revision: u8,
rsdt_address: u32,
length: u32,
xsdt_address: u64,
ext_checksum: u8,
) -> Self {
Self {
typ: Self::ID.into(),
size: size_of::<Self>().try_into().unwrap(),
signature,
checksum,
oem_id,
revision,
rsdt_address,
length,
xsdt_address,
ext_checksum,
_reserved: [0; 3],
}
}
/// The "RSD PTR " marker signature.
///
/// This is originally a 8-byte C string (not null terminated!) that must contain "RSD PTR ".
pub fn signature(&self) -> Result<&str, Utf8Error> {
str::from_utf8(&self.signature)
}
/// Validation of the RSDPv2 extended checksum
pub fn checksum_is_valid(&self) -> bool {
let bytes = unsafe {
slice::from_raw_parts(self as *const _ as *const u8, self.length as usize + 8)
};
bytes[8..]
.iter()
.fold(0u8, |acc, val| acc.wrapping_add(*val))
== 0
}
/// An OEM-supplied string that identifies the OEM.
pub fn oem_id(&self) -> Result<&str, Utf8Error> {
str::from_utf8(&self.oem_id)
}
/// The revision of the ACPI.
pub fn revision(&self) -> u8 {
self.revision
}
/// Physical address of the XSDT table.
///
/// On x86, this is truncated from 64-bit to 32-bit.
pub fn xsdt_address(&self) -> usize {
self.xsdt_address as usize
}
/// This field is used to calculate the checksum of the entire table, including both checksum fields.
pub fn ext_checksum(&self) -> u8 {
self.ext_checksum
}
}
impl TagTrait for RsdpV2Tag {
const ID: TagType = TagType::AcpiV2;
fn dst_size(_base_tag: &Tag) {}
}