MdePkg/Library/UefiLib/UefiNotTiano.c File Reference


Functions

VOID EFIAPI InternalEmptyFunction (IN EFI_EVENT Event, IN VOID *Context)
EFI_STATUS EFIAPI EfiCreateEventLegacyBoot (OUT EFI_EVENT *LegacyBootEvent)
EFI_STATUS EFIAPI EfiCreateEventLegacyBootEx (IN EFI_TPL NotifyTpl, IN EFI_EVENT_NOTIFY NotifyFunction, IN VOID *NotifyContext, OUT EFI_EVENT *LegacyBootEvent)
EFI_STATUS EFIAPI EfiCreateEventReadyToBoot (OUT EFI_EVENT *ReadyToBootEvent)
EFI_STATUS EFIAPI EfiCreateEventReadyToBootEx (IN EFI_TPL NotifyTpl, IN EFI_EVENT_NOTIFY NotifyFunction, IN VOID *NotifyContext, OUT EFI_EVENT *ReadyToBootEvent)
VOID EFIAPI EfiSignalEventReadyToBoot (VOID)
VOID EFIAPI EfiSignalEventLegacyBoot (VOID)
EFI_GUID *EFIAPI EfiGetNameGuidFromFwVolDevicePathNode (IN CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode)
VOID EFIAPI EfiInitializeFwVolDevicepathNode (IN OUT MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode, IN CONST EFI_GUID *NameGuid)

Detailed Description

Library functions that abstract areas of conflict between framework and UEFI 2.0.

Help Port Framework code that has conflicts with UEFI 2.0 by hiding the old conflicts with library functions and supporting implementations of the old (EDK/EFI 1.10) and new (EDK II/UEFI 2.0) way. This module is a DXE driver as it contains DXE enum extensions for EFI event services.

Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

EFI_STATUS EFIAPI EfiCreateEventLegacyBoot ( OUT EFI_EVENT LegacyBootEvent  ) 

Creates an EFI event in the Legacy Boot Event Group.

Prior to UEFI 2.0 this was done via a non blessed UEFI extensions and this library abstracts the implementation mechanism of this event from the caller. This function abstracts the creation of the Legacy Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent to code form having to change with the version of the specification supported. If LegacyBootEvent is NULL, then ASSERT().

Parameters:
LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
Return values:
EFI_SUCCESS Event was created.
Other Event was not created.

References EfiCreateEventLegacyBootEx(), InternalEmptyFunction(), NULL, and TPL_CALLBACK.

Referenced by EfiSignalEventLegacyBoot().

EFI_STATUS EFIAPI EfiCreateEventLegacyBootEx ( IN EFI_TPL  NotifyTpl,
IN EFI_EVENT_NOTIFY  NotifyFunction,
IN VOID *  NotifyContext,
OUT EFI_EVENT LegacyBootEvent 
)

Create an EFI event in the Legacy Boot Event Group and allows the caller to specify a notification function.

This function abstracts the creation of the Legacy Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent to code form having to change with the version of the specification supported. If LegacyBootEvent is NULL, then ASSERT().

Parameters:
NotifyTpl The task priority level of the event.
NotifyFunction The notification function to call when the event is signaled.
NotifyContext The content to pass to NotifyFunction when the event is signaled.
LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
Return values:
EFI_SUCCESS Event was created.
Other Event was not created.

References ASSERT, EFI_BOOT_SERVICES::CreateEventEx, DEBUG, EFI_2_00_SYSTEM_TABLE_REVISION, EFI_D_ERROR, EFI_UNSUPPORTED, EVT_NOTIFY_SIGNAL, FALSE, gBS, gEfiEventLegacyBootGuid, gST, EFI_SYSTEM_TABLE::Hdr, InternalEmptyFunction(), NULL, and EFI_TABLE_HEADER::Revision.

Referenced by EfiCreateEventLegacyBoot().

EFI_STATUS EFIAPI EfiCreateEventReadyToBoot ( OUT EFI_EVENT ReadyToBootEvent  ) 

Create an EFI event in the Ready To Boot Event Group.

Prior to UEFI 2.0 this was done via a non-standard UEFI extension, and this library abstracts the implementation mechanism of this event from the caller. This function abstracts the creation of the Ready to Boot Event. The Framework moved from a proprietary to UEFI 2.0-based mechanism. This library abstracts the caller from how this event is created to prevent the code form having to change with the version of the specification supported. If ReadyToBootEvent is NULL, then ASSERT().

Parameters:
ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
Return values:
EFI_SUCCESS Event was created.
Other Event was not created.

References EfiCreateEventReadyToBootEx(), InternalEmptyFunction(), NULL, and TPL_CALLBACK.

Referenced by EfiSignalEventReadyToBoot().

EFI_STATUS EFIAPI EfiCreateEventReadyToBootEx ( IN EFI_TPL  NotifyTpl,
IN EFI_EVENT_NOTIFY  NotifyFunction,
IN VOID *  NotifyContext,
OUT EFI_EVENT ReadyToBootEvent 
)

Create an EFI event in the Ready To Boot Event Group and allows the caller to specify a notification function.

This function abstracts the creation of the Ready to Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent to code form having to change with the version of the specification supported. If ReadyToBootEvent is NULL, then ASSERT().

Parameters:
NotifyTpl The task priority level of the event.
NotifyFunction The notification function to call when the event is signaled.
NotifyContext The content to pass to NotifyFunction when the event is signaled.
ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
Return values:
EFI_SUCCESS Event was created.
Other Event was not created.

References ASSERT, EFI_BOOT_SERVICES::CreateEventEx, DEBUG, EFI_2_00_SYSTEM_TABLE_REVISION, EFI_D_ERROR, EFI_UNSUPPORTED, EVT_NOTIFY_SIGNAL, FALSE, gBS, gEfiEventReadyToBootGuid, gST, EFI_SYSTEM_TABLE::Hdr, InternalEmptyFunction(), NULL, and EFI_TABLE_HEADER::Revision.

Referenced by EfiCreateEventReadyToBoot().

EFI_GUID* EFIAPI EfiGetNameGuidFromFwVolDevicePathNode ( IN CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvDevicePathNode  ) 

Check to see if the Firmware Volume (FV) Media Device Path is valid

The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. This library function abstracts validating a device path node. Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid. If it is valid, then return the GUID file name from the device path node. Otherwise, return NULL. This device path changed in the DXE CIS version 0.92 in a non back ward compatible way to not conflict with the UEFI 2.0 specification. This function abstracts the differences from the caller. If FvDevicePathNode is NULL, then ASSERT().

Parameters:
FvDevicePathNode The pointer to FV device path to check.
Return values:
NULL FvDevicePathNode is not valid.
Other FvDevicePathNode is valid and pointer to NameGuid was returned.

References ASSERT, DevicePathSubType(), DevicePathType(), MEDIA_DEVICE_PATH, MEDIA_PIWG_FW_FILE_DP, and NULL.

Referenced by GetFileBufferByFilePath().

VOID EFIAPI EfiInitializeFwVolDevicepathNode ( IN OUT MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvDevicePathNode,
IN CONST EFI_GUID NameGuid 
)

Initialize a Firmware Volume (FV) Media Device Path node.

The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. This library function abstracts initializing a device path node. Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device path changed in the DXE CIS version 0.92 in a non back ward compatible way to not conflict with the UEFI 2.0 specification. This function abstracts the differences from the caller. If FvDevicePathNode is NULL, then ASSERT(). If NameGuid is NULL, then ASSERT().

Parameters:
FvDevicePathNode The pointer to a FV device path node to initialize
NameGuid FV file name to use in FvDevicePathNode

References ASSERT, CopyGuid(), MEDIA_DEVICE_PATH, MEDIA_PIWG_FW_FILE_DP, NULL, and SetDevicePathNodeLength().

VOID EFIAPI EfiSignalEventLegacyBoot ( VOID   ) 

Create, Signal, and Close the Ready to Boot event using EfiSignalEventLegacyBoot().

This function abstracts the signaling of the Legacy Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent to code form having to change with the version of the specification supported.

References EFI_BOOT_SERVICES::CloseEvent, EFI_ERROR, EfiCreateEventLegacyBoot(), gBS, and EFI_BOOT_SERVICES::SignalEvent.

VOID EFIAPI EfiSignalEventReadyToBoot ( VOID   ) 

Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot().

This function abstracts the signaling of the Ready to Boot Event. The Framework moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from how this event is created to prevent to code form having to change with the version of the specification supported.

References EFI_BOOT_SERVICES::CloseEvent, EFI_ERROR, EfiCreateEventReadyToBoot(), gBS, and EFI_BOOT_SERVICES::SignalEvent.

VOID EFIAPI InternalEmptyFunction ( IN EFI_EVENT  Event,
IN VOID *  Context 
)

An empty function to pass error checking of CreateEventEx ().

This empty function ensures that EVT_NOTIFY_SIGNAL_ALL is error checked correctly since it is now mapped into CreateEventEx() in UEFI 2.0.

Parameters:
Event Event whose notification function is being invoked.
Context The pointer to the notification function's context, which is implementation-dependent.

Referenced by EfiCreateEventLegacyBoot(), EfiCreateEventLegacyBootEx(), EfiCreateEventReadyToBoot(), and EfiCreateEventReadyToBootEx().


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1