BmConsole.c File Reference

#include "InternalBm.h"

Go to the source code of this file.

Functions
EFI_HANDLE	BmGetVideoController (VOID)
EFI_DEVICE_PATH_PROTOCOL *EFIAPI	EfiBootManagerGetGopDevicePath (IN EFI_HANDLE VideoController)
EFI_STATUS EFIAPI	EfiBootManagerConnectVideoController (EFI_HANDLE VideoController OPTIONAL)
BOOLEAN	BmUpdateSystemTableConsole (IN CHAR16 *VarName, IN EFI_GUID *ConsoleGuid, IN OUT EFI_HANDLE *ConsoleHandle, IN OUT VOID **ProtocolInterface)
EFI_STATUS EFIAPI	EfiBootManagerUpdateConsoleVariable (IN CONSOLE_TYPE ConsoleType, IN EFI_DEVICE_PATH_PROTOCOL *CustomizedConDevicePath, IN EFI_DEVICE_PATH_PROTOCOL *ExclusiveDevicePath)
EFI_STATUS EFIAPI	EfiBootManagerConnectConsoleVariable (IN CONSOLE_TYPE ConsoleType)
VOID EFIAPI	EfiBootManagerConnectAllConsoles (VOID)
EFI_STATUS EFIAPI	EfiBootManagerConnectAllDefaultConsoles (VOID)

Variables
CHAR16 *	mConVarName []

Detailed Description

Library functions which contain all the code to connect console device.

Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2015 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BmConsole.c.

Function Documentation

BmGetVideoController()

EFI_HANDLE BmGetVideoController

(

VOID

)

Search out the video controller.

Returns

PCI device path of the video controller.

Definition at line 27 of file BmConsole.c.

BmUpdateSystemTableConsole()

BOOLEAN BmUpdateSystemTableConsole	(	IN CHAR16 *	VarName,
		IN EFI_GUID *	ConsoleGuid,
		IN OUT EFI_HANDLE *	ConsoleHandle,
		IN OUT VOID **	ProtocolInterface
	)

Fill console handle in System Table if there are no valid console handle in.

Firstly, check the validation of console handle in System Table. If it is invalid, update it by the first console device handle from EFI console variable.

Parameters

VarName	The name of the EFI console variable.
ConsoleGuid	Specified Console protocol GUID.
ConsoleHandle	On IN, console handle in System Table to be checked. On OUT, new console handle in system table.
ProtocolInterface	On IN, console protocol on console handle in System Table to be checked. On OUT, new console protocol on new console handle in system table.

Return values

TRUE	System Table has been updated.
FALSE	System Table hasn't been updated.

Definition at line 289 of file BmConsole.c.

EfiBootManagerConnectAllConsoles()

VOID EFIAPI EfiBootManagerConnectAllConsoles

(

VOID

)

This function will search every input/output device in current system, and make every input/output device as potential console device.

Definition at line 636 of file BmConsole.c.

EfiBootManagerConnectAllDefaultConsoles()

EFI_STATUS EFIAPI EfiBootManagerConnectAllDefaultConsoles

(

VOID

)

This function will connect all the console devices base on the console device variable ConIn, ConOut and ErrOut.

Return values

EFI_DEVICE_ERROR	All the consoles were not connected due to an error.
EFI_SUCCESS	Success connect any one instance of the console device path base on the variable ConVarName.

Definition at line 712 of file BmConsole.c.

EfiBootManagerConnectConsoleVariable()

EFI_STATUS EFIAPI EfiBootManagerConnectConsoleVariable

(

IN CONSOLE_TYPE

ConsoleType

)

Connect the console device base on the variable ConsoleType.

Parameters

ConsoleType

ConIn, ConOut or ErrOut.

Return values

EFI_NOT_FOUND	There is not any console devices connected success
EFI_SUCCESS	Success connect any one instance of the console device path base on the variable ConVarName.

Definition at line 521 of file BmConsole.c.

EfiBootManagerConnectVideoController()

EFI_STATUS EFIAPI EfiBootManagerConnectVideoController

(

EFI_HANDLE VideoController

OPTIONAL

)

Connect the platform active active video controller.

Parameters

VideoController

PCI handle of video controller.

Return values

EFI_NOT_FOUND	There is no active video controller.
EFI_SUCCESS	The video controller is connected.

Definition at line 232 of file BmConsole.c.

EfiBootManagerGetGopDevicePath()

EFI_DEVICE_PATH_PROTOCOL *EFIAPI EfiBootManagerGetGopDevicePath

(

IN EFI_HANDLE

VideoController

)

Query all the children of VideoController and return the device paths of all the children that support GraphicsOutput protocol.

Parameters

VideoController

PCI handle of video controller.

Returns

Device paths of all the children that support GraphicsOutput protocol.

Definition at line 117 of file BmConsole.c.

EfiBootManagerUpdateConsoleVariable()

EFI_STATUS EFIAPI EfiBootManagerUpdateConsoleVariable	(	IN CONSOLE_TYPE	ConsoleType,
		IN EFI_DEVICE_PATH_PROTOCOL *	CustomizedConDevicePath,
		IN EFI_DEVICE_PATH_PROTOCOL *	ExclusiveDevicePath
	)

This function updates the console variable based on ConVarName. It can add or remove one specific console device path from the variable

Parameters

ConsoleType	ConIn, ConOut, ErrOut, ConInDev, ConOutDev or ErrOutDev.
CustomizedConDevicePath	The console device path to be added to the console variable. Cannot be multi-instance.
ExclusiveDevicePath	The console device path to be removed from the console variable. Cannot be multi-instance.

Return values

EFI_UNSUPPORTED	The added device path is the same as a removed one.
EFI_SUCCESS	Successfully added or removed the device path from the console variable.
others	Return status of RT->SetVariable().

Definition at line 418 of file BmConsole.c.

Variable Documentation

mConVarName

CHAR16* mConVarName[]

Initial value:

= {
  L"ConIn",
  L"ConOut",
  L"ErrOut",
  L"ConInDev",
  L"ConOutDev",
  L"ErrOutDev"
}

Definition at line 12 of file BmConsole.c.