Add sources for the HII Checkbox lesson

Signed-off-by: Konstantin Aladyshev <aladyshev22@gmail.com>

5 files changed, 219 insertions, 0 deletions

diff --git a/UefiLessonsPkg/HIIFormCheckbox/Form.vfr b/UefiLessonsPkg/HIIFormCheckbox/Form.vfr
new file mode 100644
index 0000000..01759f7
--- /dev/null
+++ b/UefiLessonsPkg/HIIFormCheckbox/Form.vfr
@@ -0,0 +1,25 @@
+#include <Uefi/UefiMultiPhase.h>
+
+#define FORMSET_GUID  {0xef2acc91, 0x7b50, 0x4ab9, {0xab, 0x67, 0x2b, 0x4, 0xf8, 0xbc, 0x13, 0x5e}}
+
+formset
+  guid     = FORMSET_GUID,
+  title    = STRING_TOKEN(FORMSET_TITLE),
+  help     = STRING_TOKEN(FORMSET_HELP),
+
+  efivarstore UINT8,
+    attribute = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,
+    name  = CheckboxValue,
+    guid  = FORMSET_GUID;
+
+  form
+    formid = 1,
+    title = STRING_TOKEN(FORMID1_TITLE);
+
+    checkbox
+      varid = CheckboxValue,
+      prompt = STRING_TOKEN(CHECKBOX_PROMPT),
+      help = STRING_TOKEN(CHECKBOX_HELP),
+    endcheckbox;
+  endform;
+endformset;
diff --git a/UefiLessonsPkg/HIIFormCheckbox/HIIFormCheckbox.c b/UefiLessonsPkg/HIIFormCheckbox/HIIFormCheckbox.c
new file mode 100644
index 0000000..c4f6fd3
--- /dev/null
+++ b/UefiLessonsPkg/HIIFormCheckbox/HIIFormCheckbox.c
@@ -0,0 +1,152 @@
+/*
+ * Copyright (c) 2021, Konstantin Aladyshev <aladyshev22@gmail.com>
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <Library/UefiBootServicesTableLib.h>
+#include <Library/UefiRuntimeServicesTableLib.h>
+#include <Library/UefiLib.h>
+
+#include <Library/HiiLib.h>
+
+#include <Library/DevicePathLib.h>
+#include <Library/BaseMemoryLib.h>
+
+#define FORMSET_GUID  {0xef2acc91, 0x7b50, 0x4ab9, {0xab, 0x67, 0x2b, 0x4, 0xf8, 0xbc, 0x13, 0x5e}}
+
+extern UINT8 FormBin[];
+
+#pragma pack(1)
+///
+/// HII specific Vendor Device Path definition.
+///
+typedef struct {
+  VENDOR_DEVICE_PATH             VendorDevicePath;
+  EFI_DEVICE_PATH_PROTOCOL       End;
+} HII_VENDOR_DEVICE_PATH;
+#pragma pack()
+
+HII_VENDOR_DEVICE_PATH  mHiiVendorDevicePath = {
+  {
+    {
+      HARDWARE_DEVICE_PATH,
+      HW_VENDOR_DP,
+      {
+        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
+        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
+      }
+    },
+    FORMSET_GUID
+  },
+  {
+    END_DEVICE_PATH_TYPE,
+    END_ENTIRE_DEVICE_PATH_SUBTYPE,
+    {
+      (UINT8) (END_DEVICE_PATH_LENGTH),
+      (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
+    }
+  }
+};
+
+
+EFI_HII_HANDLE  mHiiHandle = NULL;
+EFI_HANDLE      mDriverHandle = NULL;
+
+
+EFI_STATUS
+EFIAPI
+HIIFormCheckboxUnload (
+  EFI_HANDLE ImageHandle
+  )
+{
+  if (mHiiHandle != NULL)
+    HiiRemovePackages(mHiiHandle);
+
+  EFI_STATUS Status;
+  UINTN BufferSize;
+  UINT8 EfiVarstore;
+
+  BufferSize = sizeof(UINT8);
+  Status = gRT->GetVariable(
+                L"CheckboxValue",
+                &mHiiVendorDevicePath.VendorDevicePath.Guid,
+                NULL,
+                &BufferSize,
+                &EfiVarstore);
+  if (!EFI_ERROR(Status)) {
+    Status = gRT->SetVariable(
+                  L"CheckboxValue",
+                  &mHiiVendorDevicePath.VendorDevicePath.Guid,
+                  0,
+                  0,
+                  NULL);
+    if (EFI_ERROR(Status)) {
+      Print(L"Error! Can't delete variable! %r\n", Status);
+    }
+  }
+
+  Status = gBS->UninstallMultipleProtocolInterfaces(
+                mDriverHandle,
+                &gEfiDevicePathProtocolGuid,
+                &mHiiVendorDevicePath,
+                NULL
+                );
+
+  return Status;
+}
+
+EFI_STATUS
+EFIAPI
+HIIFormCheckboxEntryPoint (
+  IN EFI_HANDLE        ImageHandle,
+  IN EFI_SYSTEM_TABLE  *SystemTable
+  )
+{
+  EFI_STATUS Status;
+  Status = gBS->InstallMultipleProtocolInterfaces(
+                  &mDriverHandle,
+                  &gEfiDevicePathProtocolGuid,
+                  &mHiiVendorDevicePath,
+                  NULL
+                  );
+  if (EFI_ERROR (Status)) {
+    return Status;
+  }
+
+
+  UINTN BufferSize;
+  UINT8 EfiVarstore;
+  BufferSize = sizeof(UINT8);
+  Status = gRT->GetVariable (
+                L"CheckboxValue",
+                &mHiiVendorDevicePath.VendorDevicePath.Guid,
+                NULL,
+                &BufferSize,
+                &EfiVarstore);
+  if (EFI_ERROR(Status)) {
+    ZeroMem(&EfiVarstore, sizeof(EfiVarstore));
+    Status = gRT->SetVariable(
+                  L"CheckboxValue",
+                  &mHiiVendorDevicePath.VendorDevicePath.Guid,
+                  EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
+                  sizeof(EfiVarstore),
+                  &EfiVarstore);
+    if (EFI_ERROR(Status)) {
+      Print(L"Error! Can't create variable! %r\n", Status);
+    }
+  }
+ 
+  mHiiHandle = HiiAddPackages(
+                 &gEfiCallerIdGuid,
+                 mDriverHandle,
+                 HIIFormCheckboxStrings,
+                 FormBin,
+                 NULL
+                 );
+  if (mHiiHandle == NULL) {
+    return EFI_OUT_OF_RESOURCES;
+  }
+ 
+  return EFI_SUCCESS;
+}
diff --git a/UefiLessonsPkg/HIIFormCheckbox/HIIFormCheckbox.inf b/UefiLessonsPkg/HIIFormCheckbox/HIIFormCheckbox.inf
new file mode 100644
index 0000000..4df03e8
--- /dev/null
+++ b/UefiLessonsPkg/HIIFormCheckbox/HIIFormCheckbox.inf
@@ -0,0 +1,28 @@
+##
+# Copyright (c) 2021, Konstantin Aladyshev <aladyshev22@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+##
+
+[Defines]
+  INF_VERSION                    = 1.25
+  BASE_NAME                      = HIIFormCheckbox
+  FILE_GUID                      = 771a4631-43ba-4852-9593-919d9de079f1
+  MODULE_TYPE                    = UEFI_DRIVER
+  VERSION_STRING                 = 1.0
+  ENTRY_POINT                    = HIIFormCheckboxEntryPoint
+  UNLOAD_IMAGE                   = HIIFormCheckboxUnload
+
+[Sources]
+  HIIFormCheckbox.c
+  Strings.uni
+  Form.vfr
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+
+[LibraryClasses]
+  UefiDriverEntryPoint
+  UefiLib
+  HiiLib
diff --git a/UefiLessonsPkg/HIIFormCheckbox/Strings.uni b/UefiLessonsPkg/HIIFormCheckbox/Strings.uni
new file mode 100644
index 0000000..7788773
--- /dev/null
+++ b/UefiLessonsPkg/HIIFormCheckbox/Strings.uni
@@ -0,0 +1,13 @@
+//
+// Copyright (c) 2021, Konstantin Aladyshev <aladyshev22@gmail.com>
+//
+// SPDX-License-Identifier: MIT
+//
+
+#langdef en-US "English"
+
+#string FORMSET_TITLE          #language en-US  "Simple Formset"
+#string FORMSET_HELP           #language en-US  "This is a very simple formset"
+#string FORMID1_TITLE          #language en-US  "Simple Form"
+#string CHECKBOX_PROMPT        #language en-US  "Checkbox prompt"
+#string CHECKBOX_HELP          #language en-US  "Checkbox help"
diff --git a/UefiLessonsPkg/UefiLessonsPkg.dsc b/UefiLessonsPkg/UefiLessonsPkg.dsc
index d94d78c..b55f860 100644
--- a/UefiLessonsPkg/UefiLessonsPkg.dsc
+++ b/UefiLessonsPkg/UefiLessonsPkg.dsc
@@ -79,6 +79,7 @@
   UefiLessonsPkg/SetVariableExample/SetVariableExample.inf
   UefiLessonsPkg/UpdateDmpstoreDump/UpdateDmpstoreDump.inf
   UefiLessonsPkg/DevicePath/DevicePath.inf
+  UefiLessonsPkg/HIIFormCheckbox/HIIFormCheckbox.inf
 
 [PcdsFixedAtBuild]
   gUefiLessonsPkgTokenSpaceGuid.PcdMyVar32_2|44