Initial import.

[mirror_edk2.git] / MdePkg / Library / UefiLib / UefiNotTiano.c

/** @file\r
  Library functions that abstract areas of conflict between Tiano an UEFI 2.0.\r
\r
  Help Port Framework/Tinao code that has conflicts with UEFI 2.0 by hiding the\r
  oldconflicts with library functions and supporting implementations of the old \r
  (R8.5/EFI 1.10) and new (R9/UEFI 2.0) way.\r
\r
Copyright (c) 2006, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
\r
/**\r
  Create a Legacy Boot Event.  \r
  \r
  Tiano extended the CreateEvent Type enum to add a legacy boot event type. \r
  This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was\r
  added and now it's possible to not voilate the UEFI specification by \r
  declaring a GUID for the legacy boot event class. This library supports\r
  the R8.5/EFI 1.10 form and R9/UEFI 2.0 form and allows common code to \r
  work both ways.\r
\r
  @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
  @retval EFI_SUCCESS       Event was created.\r
  @retval Other             Event was not created.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiCreateEventLegacyBoot (\r
  OUT  EFI_EVENT   *LegacyBootEvent\r
  )\r
{\r
  EFI_STATUS    Status;\r
\r
  ASSERT (LegacyBootEvent != NULL);\r
\r
#if (EFI_SPECIFICATION_VERSION < 0x00020000) \r
  //\r
  // prior to UEFI 2.0 use Tiano extension to EFI\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_SIGNAL_LEGACY_BOOT | EFI_EVENT_NOTIFY_SIGNAL_ALL,\r
                  EFI_TPL_CALLBACK,\r
                  NULL,\r
                  NULL,\r
                  LegacyBootEvent\r
                  );\r
#else\r
  //\r
  // For UEFI 2.0 and the future use an Event Group\r
  //\r
  Status = gBS->CreateEventEx (\r
                  EVENT_NOTIFY_SIGNAL,\r
                  EFI_TPL_CALLBACK,\r
                  NULL,\r
                  NULL,\r
                  &gEfiEventLegacyBootGuid,\r
                  LegacyBootEvent\r
                  );\r
#endif\r
  return Status;\r
}\r
\r
\r
\r
/**\r
  Create a Read to Boot Event.  \r
  \r
  Tiano extended the CreateEvent Type enum to add a ready to boot event type. \r
  This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was\r
  added and now it's possible to not voilate the UEFI specification and use \r
  the ready to boot event class defined in UEFI 2.0. This library supports\r
  the R8.5/EFI 1.10 form and R9/UEFI 2.0 form and allows common code to \r
  work both ways.\r
\r
  @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
  @retval EFI_SUCCESS       Event was created.\r
  @retval Other             Event was not created.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiCreateEventReadyToBoot (\r
  IN  EFI_EVENT   *ReadyToBootEvent\r
  )\r
{\r
  EFI_STATUS    Status;\r
\r
  ASSERT (ReadyToBootEvent != NULL);\r
\r
#if (EFI_SPECIFICATION_VERSION < 0x00020000) \r
  //\r
  // prior to UEFI 2.0 use Tiano extension to EFI\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_SIGNAL_READY_TO_BOOT | EFI_EVENT_NOTIFY_SIGNAL_ALL,\r
                  EFI_TPL_CALLBACK,\r
                  NULL,\r
                  NULL,\r
                  ReadyToBootEvent\r
                  );\r
#else\r
  //\r
  // For UEFI 2.0 and the future use an Event Group\r
  //\r
  Status = gBS->CreateEventEx (\r
                  EVENT_NOTIFY_SIGNAL,\r
                  EFI_TPL_CALLBACK,\r
                  NULL,\r
                  NULL,\r
                  &gEfiEventReadyToBootGuid,\r
                  ReadyToBootEvent\r
                  );\r
#endif\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Signal a Ready to Boot Event.  \r
  \r
  Create a Ready to Boot Event. Signal it and close it. This causes other \r
  events of the same event group to be signaled in other modules. \r
\r
**/\r
VOID\r
EFIAPI\r
EfiSignalEventReadyToBoot (\r
  VOID\r
  )\r
{\r
  EFI_STATUS    Status;\r
  EFI_EVENT     ReadyToBootEvent;\r
\r
  Status = EfiCreateEventReadyToBoot (&ReadyToBootEvent);\r
  if (!EFI_ERROR (Status)) {\r
    gBS->SignalEvent (ReadyToBootEvent);\r
    gBS->CloseEvent (ReadyToBootEvent);\r
  }\r
}\r
\r
/**\r
  Signal a Legacy Boot Event.  \r
  \r
  Create a legacy Boot Event. Signal it and close it. This causes other \r
  events of the same event group to be signaled in other modules. \r
\r
**/\r
VOID\r
EFIAPI\r
EfiSignalEventLegacyBoot (\r
  VOID\r
  )\r
{\r
  EFI_STATUS    Status;\r
  EFI_EVENT     LegacyBootEvent;\r
\r
  Status = EfiCreateEventLegacyBoot (&LegacyBootEvent);\r
  if (!EFI_ERROR (Status)) {\r
    gBS->SignalEvent (LegacyBootEvent);\r
    gBS->CloseEvent (LegacyBootEvent);\r
  }\r
}\r
\r
\r
/**\r
  Check to see if the Firmware Volume (FV) Media Device Path is valid \r
  \r
  Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum\r
  so as we move to UEFI 2.0 support we must use a mechanism that conforms with\r
  the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed \r
  device path is defined for PIWG extensions of device path. If the code \r
  is compiled to conform with the UEFI 2.0 specification use the new device path\r
  else use the old form for backwards compatability. The return value to this\r
  function points to a location in FvDevicePathNode and it does not allocate\r
  new memory for the GUID pointer that is returned.\r
\r
  @param  FvDevicePathNode  Pointer to FV device path to check.\r
\r
  @retval NULL              FvDevicePathNode is not valid.\r
  @retval Other             FvDevicePathNode is valid and pointer to NameGuid was returned.\r
\r
**/\r
EFI_GUID *\r
EFIAPI\r
EfiGetNameGuidFromFwVolDevicePathNode (\r
  IN  MEDIA_FW_VOL_FILEPATH_DEVICE_PATH   *FvDevicePathNode\r
  )\r
{\r
  ASSERT (FvDevicePathNode != NULL);\r
\r
#if (EFI_SPECIFICATION_VERSION < 0x00020000) \r
  //\r
  // Use old Device Path that conflicts with UEFI\r
  //\r
  if (DevicePathType (&FvDevicePathNode->Header) == MEDIA_DEVICE_PATH ||\r
      DevicePathSubType (&FvDevicePathNode->Header) == MEDIA_FV_FILEPATH_DP) {\r
    return &FvDevicePathNode->NameGuid;\r
  }\r
\r
#else\r
  //\r
  // Use the new Device path that does not conflict with the UEFI\r
  //\r
  if (FvDevicePathNode->Piwg.Header.Type == MEDIA_DEVICE_PATH ||\r
      FvDevicePathNode->Piwg.Header.SubType == MEDIA_VENDOR_DP) {\r
    if (CompareGuid (&gEfiFrameworkDevicePathGuid, &FvDevicePathNode->Piwg.PiwgSpecificDevicePath)) {\r
      if (FvDevicePathNode->Piwg.Type == PIWG_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE) {\r
        return &FvDevicePathNode->NameGuid;\r
      }\r
    }\r
  }\r
#endif  \r
  return NULL;\r
}\r
\r
\r
/**\r
  Initialize a Firmware Volume (FV) Media Device Path node.\r
  \r
  Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum\r
  so as we move to UEFI 2.0 support we must use a mechanism that conforms with\r
  the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed \r
  device path is defined for PIWG extensions of device path. If the code \r
  is compiled to conform with the UEFI 2.0 specification use the new device path\r
  else use the old form for backwards compatability.\r
\r
  @param FvDevicePathNode   Pointer to a FV device path node to initialize\r
  @param NameGuid           FV file name to use in FvDevicePathNode\r
\r
**/\r
VOID\r
EFIAPI\r
EfiInitializeFwVolDevicepathNode (\r
  IN  MEDIA_FW_VOL_FILEPATH_DEVICE_PATH     *FvDevicePathNode,\r
  IN EFI_GUID                               *NameGuid\r
  )\r
{\r
  ASSERT (FvDevicePathNode  != NULL);\r
  ASSERT (NameGuid          != NULL);\r
\r
#if (EFI_SPECIFICATION_VERSION < 0x00020000) \r
  //\r
  // Use old Device Path that conflicts with UEFI\r
  //\r
  FvDevicePathNode->Header.Type     = MEDIA_DEVICE_PATH;\r
  FvDevicePathNode->Header.SubType  = MEDIA_FV_FILEPATH_DP;\r
  SetDevicePathNodeLength (&FvDevicePathNode->Header, sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH));\r
  \r
#else\r
  //\r
  // Use the new Device path that does not conflict with the UEFI\r
  //\r
  FvDevicePathNode->Piwg.Header.Type     = MEDIA_DEVICE_PATH;\r
  FvDevicePathNode->Piwg.Header.SubType  = MEDIA_VENDOR_DP;\r
  SetDevicePathNodeLength (&FvDevicePathNode->Piwg.Header, sizeof (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH));\r
\r
  //\r
  // Add the GUID for generic PIWG device paths\r
  //\r
  CopyGuid (&FvDevicePathNode->Piwg.PiwgSpecificDevicePath, &gEfiFrameworkDevicePathGuid);\r
\r
  //\r
  // Add in the FW Vol File Path PIWG defined inforation\r
  //\r
  FvDevicePathNode->Piwg.Type = PIWG_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE;\r
\r
#endif\r
\r
  CopyGuid (&FvDevicePathNode->NameGuid, NameGuid);\r
\r
}\r
\r