Cleanup "Tiano" word.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5942 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-09-22 05:22:41 +00:00
parent e20a8c69b1
commit 7f1eba7b99
3 changed files with 69 additions and 63 deletions

View File

@ -618,14 +618,15 @@ EfiSignalEventLegacyBoot (
); );
/** /**
Create a Legacy Boot Event. 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.
Tiano extended the CreateEvent Type enum to add a legacy boot event type. This function abstracts the creation of the Legacy Boot Event. The Framework
This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts
added and now it's possible to not voilate the UEFI specification by the caller from how this event is created to prevent to code form having to
declaring a GUID for the legacy boot event class. This library supports change with the version of the specification supported.
the EDK/EFI 1.10 form and EDK II/UEFI 2.0 form and allows common code to If LegacyBootEvent is NULL, then ASSERT().
work both ways.
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@ -668,14 +669,15 @@ EfiCreateEventLegacyBootEx (
); );
/** /**
Create a Read to Boot Event. 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.
Tiano extended the CreateEvent Type enum to add a ready to boot event type. This function abstracts the creation of the Ready to Boot Event. The Framework
This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was moved from a proprietary to UEFI 2.0-based mechanism. This library abstracts
added and now it's possible to not voilate the UEFI specification and use the caller from how this event is created to prevent the code form having to
the ready to boot event class defined in UEFI 2.0. This library supports change with the version of the specification supported.
the EDK/EFI 1.10 form and EDKII/UEFI 2.0 form and allows common code to If ReadyToBootEvent is NULL, then ASSERT().
work both ways.
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@ -720,13 +722,17 @@ EfiCreateEventReadyToBootEx (
/** /**
Initialize a Firmware Volume (FV) Media Device Path node. Initialize a Firmware Volume (FV) Media Device Path node.
Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.
so as we move to UEFI 2.0 support we must use a mechanism that conforms with This library function abstracts initializing a device path node.
the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed
device path is defined for Tiano extensions of device path. If the code Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device
is compiled to conform with the UEFI 2.0 specification use the new device path path changed in the DXE CIS version 0.92 in a non back ward compatible way to
else use the old form for backwards compatability. 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().
@param FvDevicePathNode Pointer to a FV device path node to initialize @param FvDevicePathNode Pointer to a FV device path node to initialize
@param NameGuid FV file name to use in FvDevicePathNode @param NameGuid FV file name to use in FvDevicePathNode
@ -741,14 +747,15 @@ EfiInitializeFwVolDevicepathNode (
/** /**
Check to see if the Firmware Volume (FV) Media Device Path is valid Check to see if the Firmware Volume (FV) Media Device Path is valid
Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.
so as we move to UEFI 2.0 support we must use a mechanism that conforms with This library function abstracts validating a device path node.
the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed
device path is defined for Tiano extensions of device path. If the code Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid.
is compiled to conform with the UEFI 2.0 specification use the new device path If it is valid, then return the GUID file name from the device path node. Otherwise,
else use the old form for backwards compatability. The return value to this return NULL. This device path changed in the DXE CIS version 0.92 in a non back ward
function points to a location in FvDevicePathNode and it does not allocate compatible way to not conflict with the UEFI 2.0 specification. This function abstracts
new memory for the GUID pointer that is returned. the differences from the caller.
If FvDevicePathNode is NULL, then ASSERT().
@param FvDevicePathNode Pointer to FV device path to check. @param FvDevicePathNode Pointer to FV device path to check.

View File

@ -1,7 +1,7 @@
/** @file /** @file
Status code Runtime Protocol as defined in PI Specification VOLUME 2 DXE Status code Runtime Protocol as defined in PI Specification VOLUME 2 DXE
The StatusCode () Tiano service is added to the EFI system table and the The StatusCode () service is added to the EFI system table and the
EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL
pointer. pointer.

View File

@ -43,15 +43,16 @@ InternalEmptyFuntion (
} }
/** /**
Create a Legacy Boot Event. 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
Tiano extended the CreateEvent Type enum to add a legacy boot event type. implementation mechanism of this event from the caller.
This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was
added and now it's possible to not voilate the UEFI specification by This function abstracts the creation of the Legacy Boot Event. The Framework
declaring a GUID for the legacy boot event class. This library supports moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts
the EDK/EFI 1.10 form and EDK II/UEFI 2.0 form and allows common code to the caller from how this event is created to prevent to code form having to
work both ways. change with the version of the specification supported.
If LegacyBootEvent is NULL, then ASSERT().
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@retval EFI_SUCCESS Event was created. @retval EFI_SUCCESS Event was created.
@ -127,14 +128,15 @@ EfiCreateEventLegacyBootEx (
} }
/** /**
Create a "Ready to Boot" Event. 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
Tiano extended the CreateEvent Type enum to add a ready to boot event type. implementation mechanism of this event from the caller.
This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was
added and now it's possible to not voilate the UEFI specification and use This function abstracts the creation of the Ready to Boot Event. The Framework
the ready to boot event class defined in UEFI 2.0. This library supports moved from a proprietary to UEFI 2.0-based mechanism. This library abstracts
the EDK/EFI 1.10 form and EDK II/UEFI 2.0 form and allows common code to the caller from how this event is created to prevent the code form having to
work both ways. change with the version of the specification supported.
If ReadyToBootEvent is NULL, then ASSERT().
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@ -259,16 +261,14 @@ EfiSignalEventLegacyBoot (
/** /**
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.
Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid.
so as we move to UEFI 2.0 support we must use a mechanism that conforms with If it is valid, then return the GUID file name from the device path node.
the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed Otherwise, return NULL. This device path changed in the DXE CIS version 0.92
device path is defined for Tiano extensions of device path. If the code in a non back ward compatible way to not conflict with the UEFI 2.0 specification.
is compiled to conform with the UEFI 2.0 specification use the new device path This function abstracts the differences from the caller.
else use the old form for backwards compatability. The return value to this
function points to a location in FvDevicePathNode and it does not allocate
new memory for the GUID pointer that is returned.
If FvDevicePathNode is NULL, then ASSERT(). If FvDevicePathNode is NULL, then ASSERT().
@param FvFileDevicePathNode Pointer to FV device path to check. @param FvFileDevicePathNode Pointer to FV device path to check.
@ -295,14 +295,13 @@ EfiGetNameGuidFromFwVolDevicePathNode (
/** /**
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.
Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device
so as we move to UEFI 2.0 support we must use a mechanism that conforms with path changed in the DXE CIS version 0.92 in a non back ward compatible way to
the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed not conflict with the UEFI 2.0 specification. This function abstracts the
device path is defined for Tiano extensions of device path. If the code differences from the caller.
is compiled to conform with the UEFI 2.0 specification use the new device path
else use the old form for backwards compatability.
If FvDevicePathNode is NULL, then ASSERT(). If FvDevicePathNode is NULL, then ASSERT().
If NameGuid is NULL, then ASSERT(). If NameGuid is NULL, then ASSERT().