Enum multiboot2::TagType

pub enum TagType {
    End,
    Cmdline,
    BootLoaderName,
    Module,
    BasicMeminfo,
    Bootdev,
    Mmap,
    Vbe,
    Framebuffer,
    ElfSections,
    Apm,
    Efi32,
    Efi64,
    Smbios,
    AcpiV1,
    AcpiV2,
    Network,
    EfiMmap,
    EfiBs,
    Efi32Ih,
    Efi64Ih,
    LoadBaseAddr,
    Custom(u32),
}

Higher level abstraction for TagTypeId that assigns each possible value to a specific semantic according to the specification. Additionally, it allows to use the TagType::Custom variant. It is not binary compatible with TagTypeId.

Variants

End

Tag 0: Marks the end of the tags.

Cmdline

Tag 1: Additional command line string. For example '' or '--my-custom-option foo --provided by_grub, if your GRUB config contains multiboot2 /boot/multiboot2-binary.elf --my-custom-option foo --provided by_grub

BootLoaderName

Tag 2: Name of the bootloader, e.g. ‘GRUB 2.04-1ubuntu44.2’

Module

Tag 3: Additional Multiboot modules, which are BLOBs provided in memory. For example an initial ram disk with essential drivers.

BasicMeminfo

Tag 4: ‘mem_lower’ and ‘mem_upper’ indicate the amount of lower and upper memory, respectively, in kilobytes. Lower memory starts at address 0, and upper memory starts at address 1 megabyte. The maximum possible value for lower memory is 640 kilobytes. The value returned for upper memory is maximally the address of the first upper memory hole minus 1 megabyte. It is not guaranteed to be this value.

This tag may not be provided by some boot loaders on EFI platforms if EFI boot services are enabled and available for the loaded image (EFI boot services not terminated tag exists in Multiboot2 information structure).

Bootdev

Tag 5: This tag indicates which BIOS disk device the boot loader loaded the OS image from. If the OS image was not loaded from a BIOS disk, then this tag must not be present. The operating system may use this field as a hint for determining its own root device, but is not required to.

Mmap

Tag 6: Memory map. The map provided is guaranteed to list all standard RAM that should be available for normal use. This type however includes the regions occupied by kernel, mbi, segments and modules. Kernel must take care not to overwrite these regions.

This tag may not be provided by some boot loaders on EFI platforms if EFI boot services are enabled and available for the loaded image (EFI boot services not terminated tag exists in Multiboot2 information structure).

Vbe

Tag 7: Contains the VBE control information returned by the VBE Function 0x00 and VBE mode information returned by the VBE Function 0x01, respectively. Note that VBE 3.0 defines another protected mode interface which is incompatible with the old one. If you want to use the new protected mode interface, you will have to find the table yourself.

Framebuffer

Tag 8: Framebuffer.

ElfSections

Tag 9: This tag contains section header table from an ELF kernel, the size of each entry, number of entries, and the string table used as the index of names. They correspond to the shdr_* entries (shdr_num, etc.) in the Executable and Linkable Format (ELF) specification in the program header.

Apm

Tag 10: APM table. See Advanced Power Management (APM) BIOS Interface Specification, for more information.

Efi32

Tag 11: This tag contains pointer to i386 EFI system table.

Efi64

Tag 21: This tag contains pointer to amd64 EFI system table.

Smbios

Tag 13: This tag contains a copy of SMBIOS tables as well as their version.

AcpiV1

Tag 14: Also called “AcpiOld” in other multiboot2 implementations.

AcpiV2

Tag 15: Refers to version 2 and later of Acpi. Also called “AcpiNew” in other multiboot2 implementations.

Network

Tag 16: This tag contains network information in the format specified as DHCP. It may be either a real DHCP reply or just the configuration info in the same format. This tag appears once per card.

EfiMmap

Tag 17: This tag contains EFI memory map as per EFI specification. This tag may not be provided by some boot loaders on EFI platforms if EFI boot services are enabled and available for the loaded image (EFI boot services not terminated tag exists in Multiboot2 information structure).

EfiBs

Tag 18: This tag indicates ExitBootServices wasn’t called.

Efi32Ih

Tag 19: This tag contains pointer to EFI i386 image handle. Usually it is boot loader image handle.

Efi64Ih

Tag 20: This tag contains pointer to EFI amd64 image handle. Usually it is boot loader image handle.

LoadBaseAddr

Tag 21: This tag contains image load base physical address. The spec tells “It is provided only if image has relocatable header tag.” but experience showed that this is not true for at least GRUB 2.

Custom(u32)

Custom tag types > 21. The Multiboot2 spec doesn’t explicitly allow or disallow them. Bootloader and OS developers are free to use custom tags.

Implementations

impl TagType

pub fn val(&self) -> u32

Convenient wrapper to get the underlying u32 representation of the tag.

Trait Implementations

impl Clone for TagType

fn clone(&self) -> TagType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TagType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<TagType> for TagTypeId

fn from(value: TagType) -> Self

Converts to this type from the input type.

impl From<TagType> for u32

fn from(value: TagType) -> Self

Converts to this type from the input type.

impl From<TagTypeId> for TagType

fn from(value: TagTypeId) -> Self

Converts to this type from the input type.

impl From<u32> for TagType

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for TagType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TagType

fn cmp(&self, other: &TagType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TagType> for TagType

fn eq(&self, other: &TagType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<TagType> for TagTypeId

fn eq(&self, other: &TagType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<TagType> for u32

fn eq(&self, other: &TagType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<TagTypeId> for TagType

fn eq(&self, other: &TagTypeId) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u32> for TagType

fn eq(&self, other: &u32) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<TagType> for TagType

fn partial_cmp(&self, other: &TagType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for TagType

impl Eq for TagType

impl StructuralEq for TagType

impl StructuralPartialEq for TagType