MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / HiiResourcesSampleDxe / HiiResourcesSample.c

/** @file\r
This is an example of how a driver retrieve HII data using HII Package List\r
Protocol, and how to publish the HII data.\r
\r
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Uefi.h>\r
#include <Guid/HiiResourceSampleHii.h>\r
#include <Protocol/HiiPackageList.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/HiiLib.h>\r
\r
#pragma pack(1)\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH             VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL       End;\r
} HII_VENDOR_DEVICE_PATH;\r
#pragma pack()\r
\r
\r
EFI_HII_HANDLE  mHiiHandle = NULL;\r
EFI_HANDLE      mDriverHandle = NULL;\r
\r
HII_VENDOR_DEVICE_PATH  mHiiVendorDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    HII_RESOURCE_SAMPLE_FORM_SET_GUID\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    {\r
      (UINT8) (END_DEVICE_PATH_LENGTH),\r
      (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
    }\r
  }\r
};\r
\r
/**\r
  Main entry for this driver.\r
\r
  @param[in] ImageHandle     Image handle this driver.\r
  @param[in] SystemTable     Pointer to SystemTable.\r
\r
  @retval EFI_SUCESS     This function always complete successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiResourcesSampleInit (\r
  IN EFI_HANDLE                   ImageHandle,\r
  IN EFI_SYSTEM_TABLE             *SystemTable\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_HII_PACKAGE_LIST_HEADER     *PackageList;\r
\r
  //\r
  // Retrieve HII package list from ImageHandle\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ImageHandle,\r
                  &gEfiHiiPackageListProtocolGuid,\r
                  (VOID **) &PackageList,\r
                  ImageHandle,\r
                  NULL,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Publish sample Fromset\r
  //\r
  Status = gBS->InstallProtocolInterface (\r
                  &mDriverHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &mHiiVendorDevicePath\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Publish HII package list to HII Database.\r
  //\r
  Status = gHiiDatabase->NewPackageList (\r
                          gHiiDatabase,\r
                          PackageList,\r
                          mDriverHandle,\r
                          &mHiiHandle\r
                          );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Unloads the application and its installed protocol.\r
\r
  @param[in]  ImageHandle       Handle that identifies the image to be unloaded.\r
\r
  @retval EFI_SUCCESS           The image has been unloaded.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HiiResourcesSampleUnload (\r
  IN EFI_HANDLE  ImageHandle\r
  )\r
{\r
  if (mDriverHandle != NULL) {\r
    gBS->UninstallProtocolInterface (\r
            mDriverHandle,\r
            &gEfiDevicePathProtocolGuid,\r
            &mHiiVendorDevicePath\r
           );\r
    mDriverHandle = NULL;\r
  }\r
\r
  if (mHiiHandle != NULL) {\r
    HiiRemovePackages (mHiiHandle);\r
    mHiiHandle = NULL;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r