multiboot2_header/
console.rs

1use crate::{HeaderTagFlag, HeaderTagHeader, HeaderTagType};
2use multiboot2_common::{MaybeDynSized, Tag};
3
4/// Possible flags for [`ConsoleHeaderTag`].
5#[repr(u32)]
6#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
7pub enum ConsoleHeaderTagFlags {
8    /// Console required.
9    ConsoleRequired = 0,
10    /// EGA text support.
11    EgaTextSupported = 1,
12}
13
14/// Tells that a console must be available in MBI.
15/// Only relevant for legacy BIOS.
16#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
17#[repr(C, align(8))]
18pub struct ConsoleHeaderTag {
19    header: HeaderTagHeader,
20    console_flags: ConsoleHeaderTagFlags,
21}
22
23impl ConsoleHeaderTag {
24    /// Constructs a new tag.
25    #[must_use]
26    pub const fn new(flags: HeaderTagFlag, console_flags: ConsoleHeaderTagFlags) -> Self {
27        let header =
28            HeaderTagHeader::new(HeaderTagType::ConsoleFlags, flags, Self::BASE_SIZE as u32);
29        Self {
30            header,
31            console_flags,
32        }
33    }
34
35    /// Returns the [`HeaderTagType`].
36    #[must_use]
37    pub const fn typ(&self) -> HeaderTagType {
38        self.header.typ()
39    }
40
41    /// Returns the [`HeaderTagFlag`]s.
42    #[must_use]
43    pub const fn flags(&self) -> HeaderTagFlag {
44        self.header.flags()
45    }
46
47    /// Returns the size.
48    #[must_use]
49    pub const fn size(&self) -> u32 {
50        self.header.size()
51    }
52
53    /// Returns the [`ConsoleHeaderTagFlags`].
54    #[must_use]
55    pub const fn console_flags(&self) -> ConsoleHeaderTagFlags {
56        self.console_flags
57    }
58}
59
60impl MaybeDynSized for ConsoleHeaderTag {
61    type Header = HeaderTagHeader;
62
63    const BASE_SIZE: usize = size_of::<HeaderTagHeader>() + size_of::<u32>();
64}
65
66impl Tag for ConsoleHeaderTag {
67    type IDType = HeaderTagType;
68    const ID: HeaderTagType = HeaderTagType::ConsoleFlags;
69}
multiboot2_header/console.rs

multiboot2_header/
console.rs
