edk2

Documentation

Index

• func GetenvEdk2Path() (string, error)
• type FirmwarePair
  • func GetArchitectureFirmwarePairs(hostArch int) ([]FirmwarePair, error)
  • func GetArchitectureFirmwarePairsForUsage(hostArch int, usage FirmwareUsage) ([]FirmwarePair, error)
• type FirmwareUsage
• type Installation
  • func GetArchitectureInstallations(hostArch int) []Installation

Functions

func GetenvEdk2Path

func GetenvEdk2Path() (string, error)

GetenvEdk2Path returns the environment variable for overriding the path to use for EDK2 installations.

Types

type FirmwarePair

type FirmwarePair struct {
	Code string
	Vars string
}

FirmwarePair represents a combination of firmware code (Code) and storage (Vars).

func GetArchitectureFirmwarePairs

func GetArchitectureFirmwarePairs(hostArch int) ([]FirmwarePair, error)

GetArchitectureFirmwarePairs creates an array of FirmwarePair for a specific host architecture. If the environment variable INCUS_EDK2_PATH has been set it will override the default installation path when constructing Code & Vars paths.

func GetArchitectureFirmwarePairsForUsage

func GetArchitectureFirmwarePairsForUsage(hostArch int, usage FirmwareUsage) ([]FirmwarePair, error)

GetArchitectureFirmwarePairsForUsage creates an array of FirmwarePair for a specific host architecture and usage combination. If the environment variable INCUS_EDK2_PATH has been set it will override the default installation path when constructing Code & Vars paths.

type FirmwareUsage

type FirmwareUsage int

FirmwareUsage represents the situation in which a given firmware file will be used.

const (
	// GENERIC is a generic EDK2 firmware.
	GENERIC FirmwareUsage = iota

	// SECUREBOOT is a UEFI Secure Boot enabled firmware.
	SECUREBOOT

	// CSM is a firmware with the UEFI Compatibility Support Module enabled to boot BIOS-only operating systems.
	CSM
)

type Installation

type Installation struct {
	Path  string
	Usage map[FirmwareUsage][]FirmwarePair
}

Installation represents a set of available firmware at a given location on the system.

func GetArchitectureInstallations

func GetArchitectureInstallations(hostArch int) []Installation

GetArchitectureInstallations returns an array of installations for a specific host architecture.