LoadLinuxLib.h File Reference

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	LoadLinuxCheckKernelSetup (IN VOID *KernelSetup, IN UINTN KernelSetupSize)
UINTN EFIAPI	LoadLinuxGetKernelSize (IN VOID *KernelSetup, IN UINTN KernelSize)
EFI_STATUS EFIAPI	LoadLinux (IN VOID *Kernel, IN OUT VOID *KernelSetup)
VOID *EFIAPI	LoadLinuxAllocateKernelSetupPages (IN UINTN Pages)
EFI_STATUS EFIAPI	LoadLinuxInitializeKernelSetup (IN VOID *KernelSetup)
VOID *EFIAPI	LoadLinuxAllocateKernelPages (IN VOID *KernelSetup, IN UINTN Pages)
VOID *EFIAPI	LoadLinuxAllocateCommandLinePages (IN UINTN Pages)
VOID *EFIAPI	LoadLinuxAllocateInitrdPages (IN VOID *KernelSetup, IN UINTN Pages)
EFI_STATUS EFIAPI	LoadLinuxSetCommandLine (IN OUT VOID *KernelSetup, IN CHAR8 *CommandLine)
EFI_STATUS EFIAPI	LoadLinuxSetInitrd (IN OUT VOID *KernelSetup, IN VOID *Initrd, IN UINTN InitrdSize)

Detailed Description

Load/boot UEFI Linux.

Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file LoadLinuxLib.h.

Function Documentation

LoadLinux()

EFI_STATUS EFIAPI LoadLinux	(	IN VOID *	Kernel,
		IN OUT VOID *	KernelSetup
	)

Loads and boots UEFI Linux.

Note: If successful, then this routine will not return

Parameters

[in]	Kernel	- The main kernel image
[in,out]	KernelSetup	- The kernel setup image

Return values

EFI_NOT_FOUND	- The Linux kernel was not found
EFI_INVALID_PARAMETER	- Kernel or KernelSetup was NULL
EFI_UNSUPPORTED	- The Linux kernel version is not supported

Definition at line 624 of file Linux.c.

LoadLinuxAllocateCommandLinePages()

VOID *EFIAPI LoadLinuxAllocateCommandLinePages

(

IN UINTN

Pages

)

Allocates pages for the kernel command line.

Parameters

[in]

Pages

- The number of pages.

Return values

NULL	- Unable to allocate pages
!NULL	- The address of the pages allocated

Definition at line 185 of file Linux.c.

LoadLinuxAllocateInitrdPages()

VOID *EFIAPI LoadLinuxAllocateInitrdPages	(	IN VOID *	KernelSetup,
		IN UINTN	Pages
	)

Allocates pages for the initrd image.

Parameters

[in,out]	KernelSetup	- The kernel setup image
[in]	Pages	- The number of pages.

Return values

NULL	- Unable to allocate pages
!NULL	- The address of the pages allocated

Definition at line 208 of file Linux.c.

LoadLinuxAllocateKernelPages()

VOID *EFIAPI LoadLinuxAllocateKernelPages	(	IN VOID *	KernelSetup,
		IN UINTN	Pages
	)

Allocates pages for the kernel.

Parameters

[in]	KernelSetup	- The kernel setup image
[in]	Pages	- The number of pages. (It is recommended to use the size returned from LoadLinuxGetKernelSize.)

Return values

NULL	- Unable to allocate pages
!NULL	- The address of the pages allocated

Definition at line 148 of file Linux.c.

LoadLinuxAllocateKernelSetupPages()

VOID *EFIAPI LoadLinuxAllocateKernelSetupPages

(

IN UINTN

Pages

)

Allocates pages for the kernel setup image.

Parameters

[in]

Pages

- The number of pages

Return values

NULL	- Unable to allocate pages
!NULL	- The address of the pages allocated

Definition at line 92 of file Linux.c.

LoadLinuxCheckKernelSetup()

EFI_STATUS EFIAPI LoadLinuxCheckKernelSetup	(	IN VOID *	KernelSetup,
		IN UINTN	KernelSetupSize
	)

Verifies that the kernel setup image is valid and supported. The kernel setup image should be checked before using other library routines which take the kernel setup as an input.

Parameters

[in]	KernelSetup	- The kernel setup image
[in]	KernelSetupSize	- The kernel setup size

Return values

EFI_SUCCESS	- The Linux kernel setup is valid and supported
EFI_INVALID_PARAMETER	- KernelSetup was NULL
EFI_UNSUPPORTED	- The Linux kernel is not supported

Definition at line 36 of file Linux.c.

LoadLinuxGetKernelSize()

UINTN EFIAPI LoadLinuxGetKernelSize	(	IN VOID *	KernelSetup,
		IN UINTN	KernelSize
	)

Gets the initial runtime size of the Linux kernel image by examining the kernel setup image.

Parameters

[in]	KernelSetup	- The kernel setup image
[in]	KernelSize	- The kernel size on disk.

Return values

0	An error occurred
!0	The initial size required by the kernel to begin execution.

Definition at line 67 of file Linux.c.

LoadLinuxInitializeKernelSetup()

EFI_STATUS EFIAPI LoadLinuxInitializeKernelSetup

(

IN VOID *

KernelSetup

)

Clears the uninitialised space before and after the struct setup_header in the kernel setup image. The kernel requires that these be zeroed unless explicitly initialised, so this function should be called after the setup_header has been copied in from a bzImage, before setting up anything else.

Parameters

[in]

KernelSetup

- The kernel setup image

Return values

EFI_SUCCESS	- The Linux kernel setup was successfully initialized
EFI_INVALID_PARAMETER	- KernelSetup was NULL
EFI_UNSUPPORTED	- The Linux kernel is not supported

Definition at line 115 of file Linux.c.

LoadLinuxSetCommandLine()

EFI_STATUS EFIAPI LoadLinuxSetCommandLine	(	IN OUT VOID *	KernelSetup,
		IN CHAR8 *	CommandLine
	)

Sets the kernel command line parameter within the setup image.

Parameters

[in,out]	KernelSetup	- The kernel setup image
[in]	CommandLine	- The kernel command line

Return values

EFI_SUCCESS	- The Linux kernel setup is valid and supported
EFI_INVALID_PARAMETER	- KernelSetup was NULL
EFI_UNSUPPORTED	- The Linux kernel is not supported

Definition at line 392 of file Linux.c.

LoadLinuxSetInitrd()

EFI_STATUS EFIAPI LoadLinuxSetInitrd	(	IN OUT VOID *	KernelSetup,
		IN VOID *	Initrd,
		IN UINTN	InitrdSize
	)

Sets the kernel initial ram disk pointer within the setup image.

Parameters

[in,out]	KernelSetup	- The kernel setup image
[in]	Initrd	- Pointer to the initial ram disk
[in]	InitrdSize	- The initial ram disk image size

Return values

EFI_SUCCESS	- The Linux kernel setup is valid and supported
EFI_INVALID_PARAMETER	- KernelSetup was NULL
EFI_UNSUPPORTED	- The Linux kernel is not supported

Definition at line 414 of file Linux.c.