multiboot2_header/
console.rs

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

multiboot2_header/
console.rs
