# 59. 간단한 폼 애플리케이션을 UEFI 드라이버 Form으로 변환하기

지금까지는 폼을 HII 데이터베이스에 입력한 것과 동일한 애플리케이션에 표시했다. 그러나 지금까지 한 방식은 표준 방법이 아니다. 일반적으로 UEFI 드라이버는 HII 폼을 작성하고 다른 애플리케이션은 이를 로드한다. 실제 비휘발성 설정을 가진 더  복잡한 form을 생성해야 하기 때문에 이 두 가지 기능을 분리해야 한다.

따라서 아래의 2가지를 진행한다.

* HII Form UEFI 애플리케이션을 UEFI 드라이버 폼으로 변환
* HII 데이터베이스에서 작성된 HII 폼을 로드할 수 있는 애플리케이션 생성

### DisplayHIIByGuid

두 번째 작업부터 진행하기 위해 `DisplayHIIByGuid` 애플리케이션을 생성한다.\
`UefiLessonsPkg/DisplayHIIByGuid/DisplayHIIByGuid.inf`

```
[Defines]
  INF_VERSION                    = 1.25
  BASE_NAME                      = DisplayHIIByGuid
  FILE_GUID                      = 1597e1d0-7f62-4631-a166-703f03bd7223
  MODULE_TYPE                    = UEFI_APPLICATION
  VERSION_STRING                 = 1.0
  ENTRY_POINT                    = ShellCEntryLib

[Sources]
  DisplayHIIByGuid.c

[Packages]
  MdePkg/MdePkg.dec

[LibraryClasses]
  UefiLib
  ShellCEntryLib
```

`UefiLessonsPkg/DisplayHIIByGuid/DisplayHIIByGuid.c`

```c
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>

INTN
EFIAPI
ShellAppMain (
  IN UINTN Argc,
  IN CHAR16 **Argv
  )
{
  return EFI_SUCCESS;
}
```

`UefiLessonsPkg/UefiLessonsPkg.dsc`

```
[Components]
  ...
  UefiLessonsPkg/DisplayHIIByGuid/DisplayHIIByGuid.inf
```

애플리케이션은 명령 인자에서 HII 패키지 목록 GUID를 받아 그 패키지에서 HII 폼을 표시할 것이다.

먼저 인자로 들어오는 문자열을 GUID 값으로 변경해야 한다. 이를 위해`StrToGuid` 함수를 사용할 수 있다.\
<https://github.com/tianocore/edk2/blob/master/MdePkg/Include/Library/BaseLib.h>

```
/**
  Convert a Null-terminated Unicode GUID string to a value of type
  EFI_GUID.
  ...
  If String is not aligned in a 16-bit boundary, then ASSERT().
  @param  String                   Pointer to a Null-terminated Unicode string.
  @param  Guid                     Pointer to the converted GUID.
  @retval RETURN_SUCCESS           Guid is translated from String.
  @retval RETURN_INVALID_PARAMETER If String is NULL.
                                   If Data is NULL.
  @retval RETURN_UNSUPPORTED       If String is not as the above format.
**/
RETURN_STATUS
EFIAPI
StrToGuid (
  IN  CONST CHAR16  *String,
  OUT GUID          *Guid
  );
```

아래와 같이 사용하며 `DisplayHIIByGuid.c`에 작성한다.

```
if (Argc != 2) {
  Print(L"Usage:\n");
  Print(L"  DisplayHIIByGuid <Package list GUID>\n");
  return EFI_INVALID_PARAMETER;
}

EFI_GUID PackageListGuid;
EFI_STATUS Status = StrToGuid(Argv[1], &PackageListGuid);
if (Status != RETURN_SUCCESS) {
  Print(L"Error! Can't convert <Package list GUID> argument to GUID\n");
  return EFI_INVALID_PARAMETER;
}
```

이제 패키지 목록 GUID가 있으면 `HiiGetHiiHandles` 함수를 사용해 GUID에 대한 HII 핸들을 가져올 수 있다.\
<https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Include/Library/HiiLib.h>\
<https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Library/UefiHiiLib/HiiLib.c>

```
/**
  Retrieves the array of all the HII Handles or the HII handles of a specific
  package list GUID in the HII Database.
  This array is terminated with a NULL HII Handle.
  This function allocates the returned array using AllocatePool().
  The caller is responsible for freeing the array with FreePool().
  @param[in]  PackageListGuid  An optional parameter that is used to request
                               HII Handles associated with a specific
                               Package List GUID.  If this parameter is NULL,
                               then all the HII Handles in the HII Database
                               are returned.  If this parameter is not NULL,
                               then zero or more HII Handles associated with
                               PackageListGuid are returned.
  @retval NULL   No HII handles were found in the HII database
  @retval NULL   The array of HII Handles could not be retrieved
  @retval Other  A pointer to the NULL terminated array of HII Handles
**/
EFI_HII_HANDLE *
EFIAPI
HiiGetHiiHandles (
  IN CONST EFI_GUID  *PackageListGuid  OPTIONAL
  )
;
```

`HiiGetHiiHandles`를 아래와 같이 간단하게 사용할 수 있으며 `DisplayHIIByGuid.c`에 작성한다.

<pre class="language-c"><code class="lang-c"><strong>...
</strong><strong>EFI_HII_HANDLE* HiiHandles = HiiGetHiiHandles(&#x26;PackageListGuid);
</strong>
&#x3C;...>

FreePool(HiiHandles);
</code></pre>

```c
#include <Library/MemoryAllocationLib.h>
#include <Library/HiiLib.h>
```

`HiiLib` 헤더 파일을 사용하기 때문에 INF 파일에 필요한 패키지와 라이브러리 클래스를 추가한다.

```
[Packages]
  ...
  MdeModulePkg/MdeModulePkg.dec

[LibraryClasses]
  ...
  HiiLib
```

이제 GUID와 연결된 HII 핸들 배열에 대한 포인터가 있다. `SendForm`을 호출하기 전에 이 배열의 길이를 알아야 한다. 아래 코드와 같이 `HiiHandles` 포인터를 복사해 NULL을 만날 때까지 반복문을 돌려 배열의 길이를 알아낸다.\
아래 코드를 `<...>`에 작성한다.

```c
EFI_HII_HANDLE* HiiHandle = HiiHandles;
UINTN HandleCount=0;
while (*HiiHandle != NULL) {
  HiiHandle++;
  HandleCount++;
}
```

`SendForm` 함수를 사용하기 위해 `EFI_FORM_BROWSER2_PROTOCOL`에서 `SendForm` 함수를 호출해야 한다. 따라서 필요한 프로토콜과 헤더 파일을 추가한다.

`UefiLessonsPkg/DisplayHIIByGuid/DisplayHIIByGuid.inf`

```
[Protocols]
  gEfiFormBrowser2ProtocolGuid
```

`UefiLessonsPkg/DisplayHIIByGuid/DisplayHIIByGuid.c`

```c
#include <Protocol/FormBrowser2.h>
```

추가로 프로토콜을 호출하기 위해 아래 코드를 작성한다.

```c
EFI_FORM_BROWSER2_PROTOCOL* FormBrowser2;
Status = gBS->LocateProtocol(&gEfiFormBrowser2ProtocolGuid, NULL, (VOID**)&FormBrowser2);
if (EFI_ERROR(Status)) {
  Print(L"Error! Can't locate gEfiFormBrowser2Protocol\n");
  FreePool(HiiHandles);
  return Status;
}

Status = FormBrowser2->SendForm (
                         FormBrowser2,
                         HiiHandles,
                         HandleCount,
                         NULL,
                         0,
                         NULL,
                         NULL
                         );

if (EFI_ERROR(Status)) {
  Print(L"Error! SendForm returned %r\n", Status);
}
```

빌드 후 QEMU를 실행하여 `DispalyHIIByGuid` 애플리케이션을 실행하기 전에 기존에 만들었던 `ShowHII` 애플리케이션을 통해 HII 데이터베이스의 모든 패키지 목록 확인한다.

```
FS0:\> ShowHII.efi
PackageList[0]: GUID=A487A478-51EF-48AA-8794-7BEE2A0562F1; size=0x1ADC
        Package[0]: type=STRINGS; size=0x1AC4
        Package[1]: type=END; size=0x4
PackageList[1]: GUID=19618BCE-55AE-09C6-37E9-4CE04084C7A1; size=0x21E4
        Package[0]: type=STRINGS; size=0x21CC
        Package[1]: type=END; size=0x4
PackageList[2]: GUID=2F30DA26-F51B-4B6F-85C4-31873C281BCA; size=0xA93
        Package[0]: type=STRINGS; size=0xA7B
        Package[1]: type=END; size=0x4
PackageList[3]: GUID=F74D20EE-37E7-48FC-97F7-9B1047749C69; size=0x2EE9
        Package[0]: type=IMAGES; size=0x2ED1
        Package[1]: type=END; size=0x4
PackageList[4]: GUID=EBF8ED7C-0DD1-4787-84F1-F48D537DCACF; size=0x46C
        Package[0]: type=FORMS; size=0x82
        Package[1]: type=FORMS; size=0x82
        Package[2]: type=STRINGS; size=0x199
        Package[3]: type=STRINGS; size=0x19B
        Package[4]: type=DEVICE_PATH; size=0x1C
        Package[5]: type=END; size=0x4
PackageList[5]: GUID=FE561596-E6BF-41A6-8376-C72B719874D0; size=0x93F
        Package[0]: type=FORMS; size=0xF5
        Package[1]: type=STRINGS; size=0x40A
        Package[2]: type=STRINGS; size=0x40C
        Package[3]: type=DEVICE_PATH; size=0x1C
        Package[4]: type=END; size=0x4
PackageList[6]: GUID=2A46715F-3581-4A55-8E73-2B769AAA30C5; size=0x6B0
        Package[0]: type=FORMS; size=0x143
        Package[1]: type=STRINGS; size=0x539
        Package[2]: type=DEVICE_PATH; size=0x1C
        Package[3]: type=END; size=0x4
PackageList[7]: GUID=99FDC8FD-849B-4EBA-AD13-FB9699C90A4D; size=0x6FE
        Package[0]: type=STRINGS; size=0x340
        Package[1]: type=STRINGS; size=0x3A6
        Package[2]: type=END; size=0x4
PackageList[8]: GUID=E38C1029-E38F-45B9-8F0D-E2E60BC9B262; size=0x15DA
        Package[0]: type=STRINGS; size=0xA88
        Package[1]: type=STRINGS; size=0xB3A
        Package[2]: type=END; size=0x4
PackageList[9]: GUID=D9DCC5DF-4007-435E-9098-8970935504B2; size=0x855
        Package[0]: type=FORMS; size=0x1F6
        Package[1]: type=STRINGS; size=0x62B
        Package[2]: type=DEVICE_PATH; size=0x1C
        Package[3]: type=END; size=0x4
PackageList[10]: GUID=F5F219D3-7006-4648-AC8D-D61DFB7BC6AD; size=0x14EC
        Package[0]: type=SIMPLE_FONTS; size=0x14D4
        Package[1]: type=END; size=0x4
PackageList[11]: GUID=4B47D616-A8D6-4552-9D44-CCAD2E0F4CF9; size=0x6AC8
        Package[0]: type=FORMS; size=0x1030
        Package[1]: type=STRINGS; size=0x3C99
        Package[2]: type=STRINGS; size=0x1DCB
        Package[3]: type=DEVICE_PATH; size=0x1C
        Package[4]: type=END; size=0x4
PackageList[12]: GUID=F95A7CCC-4C55-4426-A7B4-DC8961950BAE; size=0x13909
        Package[0]: type=STRINGS; size=0x138F1
        Package[1]: type=END; size=0x4
PackageList[13]: GUID=DEC5DAA4-6781-4820-9C63-A7B0E4F1DB31; size=0x8677
        Package[0]: type=STRINGS; size=0x865F
        Package[1]: type=END; size=0x4
PackageList[14]: GUID=4344558D-4EF9-4725-B1E4-3376E8D6974F; size=0x83BD
        Package[0]: type=STRINGS; size=0x83A5
        Package[1]: type=END; size=0x4
PackageList[15]: GUID=0AF0B742-63EC-45BD-8DB6-71AD7F2FE8E8; size=0xCB04
        Package[0]: type=STRINGS; size=0xCAEC
        Package[1]: type=END; size=0x4
PackageList[16]: GUID=25F200AA-D3CB-470A-BF51-E7D162D22E6F; size=0x1D3D7
        Package[0]: type=STRINGS; size=0x1D3BF
        Package[1]: type=END; size=0x4
PackageList[17]: GUID=5F5F605D-1583-4A2D-A6B2-EB12DAB4A2B6; size=0x3048
        Package[0]: type=STRINGS; size=0x3030
        Package[1]: type=END; size=0x4
PackageList[18]: GUID=F3D301BB-F4A5-45A8-B0B7-FA999C6237AE; size=0x26B5
        Package[0]: type=STRINGS; size=0x269D
        Package[1]: type=END; size=0x4
PackageList[19]: GUID=7C04A583-9E3E-4F1C-AD65-E05268D0B4D1; size=0x5CB
        Package[0]: type=STRINGS; size=0x5B3
        Package[1]: type=END; size=0x4
```

`ShowHII` 애플리케이션을 통해 GUID도 확인할 수 있으므로 이제 `DisplayHIIByGuid`를 실행할 수 있다.

```
FS0:\> DisplayHIIByGuid.efi EBF8ED7C-0DD1-4787-84F1-F48D537DCACF
FS0:\> DisplayHIIByGuid.efi FE561596-E6BF-41A6-8376-C72B719874D0
FS0:\> DisplayHIIByGuid.efi 2A46715F-3581-4A55-8E73-2B769AAA30C5
FS0:\> DisplayHIIByGuid.efi D9DCC5DF-4007-435E-9098-8970935504B2
FS0:\> DisplayHIIByGuid.efi 4B47D616-A8D6-4552-9D44-CCAD2E0F4CF9
```

여기서 확인한 GUID은 아래와 같다.

* `EBF8ED7C-0DD1-4787-84F1-F48D537DCACF`\
  <https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Universal/DriverHealthManagerDxe/DriverHealthManagerDxe.inf>
* `FE561596-E6BF-41A6-8376-C72B719874D0` `EFI_FILE_EXPLORE_FORMSET_GUID`\
  <https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Library/FileExplorerLib/FormGuid.h>
* `2A46715F-3581-4A55-8E73-2B769AAA30C5` `RAM_DISK_FORM_SET_GUID` `gRamDiskFormSetGuid`\
  <https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Include/Guid/RamDiskHii.h>\
  <https://github.com/tianocore/edk2/blob/master/MdeModulePkg/MdeModulePkg.dec>
* `D9DCC5DF-4007-435E-9098-8970935504B2`\
  <https://github.com/tianocore/edk2/blob/master/OvmfPkg/PlatformDxe/Platform.inf>
* `4B47D616-A8D6-4552-9D44-CCAD2E0F4CF9` `gIScsiConfigGuid` `ISCSI_CONFIG_GUID` \
  <https://github.com/tianocore/edk2/blob/master/NetworkPkg/Include/Guid/IScsiConfigHii.h>\
  <https://github.com/tianocore/edk2/blob/master/NetworkPkg/NetworkPkg.dec>

`DisplayHIIByGuid.efi D9DCC5DF-4007-435E-9098-8970935504B2` 명령어를 통해서는 아래와 같은 화면을 확인할 수 있다.

<figure><img src="/files/D7zZR0gFLKxVKG1DbBIf" alt=""><figcaption></figcaption></figure>

### Formset: classguid

`DisplayHIIByGuid.efi`를 사용해 보았을 때 하나의 GUID가 작동하지 않는 다는 것을 알 수 있었다.

```
FS0:\> DisplayHIIByGuid.efi FE561596-E6BF-41A6-8376-C72B719874D0
Error! SendForm returned Not found
```

해당 GUID에 대한 내용은 아래 링크에서 확인할 수 있다.

* `FE561596-E6BF-41A6-8376-C72B719874D0` `EFI_FILE_EXPLORE_FORMSET_GUID` \
  <https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Library/FileExplorerLib/FormGuid.h>

`EFI_FORM_BROWSER2_PROTOCOL.SendForm()`을 다시 살펴본다.

```
EFI_FORM_BROWSER2_PROTOCOL.SendForm()

Summary:
Initialize the browser to display the specified configuration forms.

Prototype:
typedef
EFI_STATUS
(EFIAPI *EFI_SEND_FORM2) (
 IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,
 IN EFI_HII_HANDLE *Handles,
 IN UINTN HandleCount,
 IN CONST EFI_GUID *FormsetGuid, OPTIONAL
 IN EFI_FORM_ID FormId, OPTIONAL
 IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL
 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL
 );

Parameters:
This			A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.
Handles			A pointer to an array of HII handles to display.
HandleCount		The number of handles in the array specified by Handle.
FormsetGuid		This field points to the EFI_GUID which must match the Guid field or one of the
                	elements of the ClassId field in the EFI_IFR_FORM_SET op-code. If FormsetGuid
                	is NULL, then this function will display the form set class
                	EFI_HII_PLATFORM_SETUP_FORMSET_GUID.
FormId			This field specifies the identifier of the form within the form set to render as the first
			displayable page. If this field has a value of 0x0000, then the Forms Browser will
			render the first enabled form in the form set.
ScreenDimensions	Points to recommended form dimensions, including any non-content area, in characters.
ActionRequested		Points to the action recommended by the form.

Description:
This function is the primary interface to the Forms Browser. The Forms Browser displays the forms specified by FormsetGuid and FormId from all of HII handles specified by Handles. If more than one form can be displayed, the Forms Browser will provide some means for the user to navigate between the
forms in addition to that provided by cross-references in the forms themselves.
```

지금까지 함수를 호출할 때 `FormsetGuid = NULL`을 사용했다. 설명에서는 `EFI_HII_PLATFORM_SETUP_FORMSET_GUID`가 사용되었음을 의미한다.

또한 이전에 `FormSet`에 대해 `classguid`를 명시적으로 선언하지 않았을 때, IFR은 기본값으로 `EFI_HII_PLATFORM_SETUP_FORMSET_GUID`를 가진다는 것을 알아봤었다. 그래서 `SendForm`도 정상적으로 호출됐었던 것이다.

그러나 문제가 있는 패키지 목록에서 폼의 VFR 코드를 보면 다른 `classguid`를 사용한다는 것을 알 수 있다.\
<https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Library/FileExplorerLib/FileExplorerVfr.vfr>

```
formset
  guid = EFI_FILE_EXPLORE_FORMSET_GUID,
  title = STRING_TOKEN(STR_FILE_EXPLORER_TITLE),
  help = STRING_TOKEN(STR_NULL_STRING),
  classguid = EFI_FILE_EXPLORE_FORMSET_GUID,
```

패키지 목록에서 확인한 GUID와 `EFI_FILE_EXPLORE_FORMSET_GUID`는 같다.

문제를 해결하기 위해 `*.c` 코드를 수정해야 한다.

```c
-  if (Argc != 2) {
+  if ((Argc < 2) || (Argc > 3)) {
     Print(L"Usage:\n");
-    Print(L"  DisplayHIIByGuid <Package list GUID>\n");
+    Print(L"  DisplayHIIByGuid <Package list GUID> [<Formset classguid>]\n");
     return EFI_INVALID_PARAMETER;
   }
```

새로운 인자를 처리할 수 있는 코드를 추가한다.

```c
EFI_GUID FormsetClassGuid = EFI_HII_PLATFORM_SETUP_FORMSET_GUID;
if (Argc == 3) {
  Status = StrToGuid(Argv[2], &FormsetClassGuid);
  if (Status != RETURN_SUCCESS) {
    Print(L"Error! Can't convert <Formset classguid> argument to GUID\n");
    return EFI_INVALID_PARAMETER;
  }
}
```

`SendForm`을 호출하는 부분에서 `FormsetClassGuid`를 추가한다.

```
   Status = FormBrowser2->SendForm (
                            FormBrowser2,
                            HiiHandles,
                            HandleCount,
-                           NULL,
+                           &FormsetClassGuid,
                            0,
                            NULL,
                            NULL
                            );
```

이제 아래 명령을 통해 정상 동작하는 것을 확인할 수 있다.

```
FS0:\> DisplayHIIByGuid.efi FE561596-E6BF-41A6-8376-C72B719874D0 FE561596-E6BF-41A6-8376-C72B719874D0
```

<figure><img src="/files/peXFKy7kY6z42CcW9cj3" alt=""><figcaption><p>DisplayHIIByGuid.efi : File Explorer</p></figcaption></figure>

### HIIStaticFormDriver

이전에 생성한 `HIIStaticForm` UEFI 애플리케이션의 복사본이 될 `HIIStaticFormDriver` Uefi 드라이버를 생성한다.&#x20;

아래 스크립트를 코드를 이용해 생성한다.

```bash
#!/bin/bash
##
# Copyright (c) 2021, Konstantin Aladyshev <aladyshev22@gmail.com>
#
# SPDX-License-Identifier: MIT
##

# This is a simple script that creates a basic structure for your new UEFI driver
# Put this script in your edk2 folder and run it with 1 argument - your new driver name

DRIVER_NAME=${1}

UUID=$(uuidgen)

mkdir -p UefiLessonsPkg/${DRIVER_NAME}

cat << EOF > UefiLessonsPkg/${DRIVER_NAME}/${DRIVER_NAME}.inf
[Defines]
  INF_VERSION                    = 1.25
  BASE_NAME                      = ${DRIVER_NAME}
  FILE_GUID                      = ${UUID}
  MODULE_TYPE                    = UEFI_DRIVER
  VERSION_STRING                 = 1.0
  ENTRY_POINT                    = ${DRIVER_NAME}EntryPoint
  UNLOAD_IMAGE                   = ${DRIVER_NAME}Unload

[Sources]
  ${DRIVER_NAME}.c

[Packages]
  MdePkg/MdePkg.dec

[LibraryClasses]
  UefiDriverEntryPoint
  UefiLib
EOF

cat << EOF > UefiLessonsPkg/${DRIVER_NAME}/${DRIVER_NAME}.c
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>


EFI_STATUS
EFIAPI
${DRIVER_NAME}Unload (
  EFI_HANDLE ImageHandle
  )
{
  return EFI_SUCCESS;
}

EFI_STATUS
EFIAPI
${DRIVER_NAME}EntryPoint (
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  )
{
  return EFI_SUCCESS;
}
EOF
```

```
$ ./createNewDriver.sh HIIStaticFormDriver
$ cp UefiLessonsPkg/HIIStaticForm/Form.vfr UefiLessonsPkg/HIIStaticFormDriver/
$ cp UefiLessonsPkg/HIIStaticForm/Strings.uni UefiLessonsPkg/HIIStaticFormDriver/
```

아래는 `HIIStaticFormDriver`의 `*.c`와 `*.inf` 파일이다.&#x20;

`UefiLessonsPkg/HIIStaticFormDriver/HIIStaticFormDriver.inf`&#x20;

```
[Defines]
  INF_VERSION                    = 1.25
  BASE_NAME                      = HIIStaticFormDriver
  FILE_GUID                      = 22514099-ad3b-45ec-b14b-112eb6446db2
  MODULE_TYPE                    = UEFI_DRIVER
  VERSION_STRING                 = 1.0
  ENTRY_POINT                    = HIIStaticFormDriverEntryPoint
  UNLOAD_IMAGE                   = HIIStaticFormDriverUnload

[Sources]
  HIIStaticFormDriver.c
  Strings.uni
  Form.vfr

[Packages]
  MdePkg/MdePkg.dec
  MdeModulePkg/MdeModulePkg.dec

[LibraryClasses]
  UefiDriverEntryPoint
  UefiLib
  HiiLib
```

`UefiLessonsPkg/HIIStaticFormDriver/HIIStaticFormDriver.c`&#x20;

```
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/HiiLib.h>


extern UINT8 FormBin[];

EFI_HII_HANDLE Handle;


EFI_STATUS
EFIAPI
HIIStaticFormDriverUnload (
  EFI_HANDLE ImageHandle
  )
{
  if (Handle != NULL)
    HiiRemovePackages(Handle);

  return EFI_SUCCESS;
}

EFI_STATUS
EFIAPI
HIIStaticFormDriverEntryPoint (
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  )
{
  Handle = HiiAddPackages(
             &gEfiCallerIdGuid,
             NULL,
             HIIStaticFormDriverStrings,
             FormBin,
             NULL
           );
  if (Handle == NULL)
    return EFI_OUT_OF_RESOURCES;

  return EFI_SUCCESS;
}
```

`UefiLessonsPkg/UefiLessonsPkg.dsc`에 INF 파일을 추가한다.

```
[Components]
  UefiLessonsPkg/HIIStaticFormDriver/HIIStaticFormDriver.inf
```

`HIIStaticFormDriver`를 빌드하고 로드한다.

```
FS0:\> load HIIStaticFormDriver.efi
Image 'FS0:\HIIStaticFormDriver.efi' loaded at 688A000 - Success
```

드라이버를 로드하면 드라이버가 HII 데이터베이스에 데이터를 저장한 것을 볼 수 있다.

```
FS0:\> ShowHII.efi
...
PackageList[20]: GUID=22514099-AD3B-45EC-B14B-112EB6446DB2; size=0x28B
        Package[0]: type=FORMS; size=0x98
        Package[1]: type=STRINGS; size=0x1DB
        Package[2]: type=END; size=0x4
```

`DisplayHIIByGuid.efi`를 사용해 HII 데이터를 확인할 수 있다.

```
FS0:\> DisplayHIIByGuid.efi 22514099-AD3B-45EC-B14B-112EB6446DB2
```

<figure><img src="/files/ndRColBWllHyyHkxpO3a" alt=""><figcaption></figcaption></figure>

### 기본 UEFI  메뉴에서   애플리케이션 확인하기

`exit` 명령을 통해 UEFI 메뉴로 나간다.

```
FS0:\> exit
```

`Device Manager`로 이동하면 `Device List`에 `Static Formset`이 있는 것을 확인할 수 있다.

<figure><img src="/files/W57ZbnmLWnN60nPVvv9A" alt=""><figcaption></figcaption></figure>

해당 메뉴를 선택하면 만들었던 드라이버 폼인 것을 볼 수 있다.

`classguid = EFI_HII_PLATFORM_SETUP_FORMSET_GUID`가 있는 모든 폼이 `Device Manager`에 추가된다.

따라서 폼에 다른 classguid를 사용하지 않으면 `DisplayHIIByGuid.efi` 애플리케이션을 사용하는 것보다 메뉴에서 폼을 확인하는 방법이 더 쉽다.

새 폼이 `Device Manager`에 동적으로 추가되는 방법이 궁금한 경우 아래 링크를 통해 확인한다.\
<https://github.com/tianocore/edk2/blob/master/MdeModulePkg/Library/DeviceManagerUiLib/DeviceManager.c>

아래 코드는 `CompareGuid`를 사용하여 모든 formset `classguid`를 `EFI_HII_PLATFORM_SETUP_FORMSET_GUID`와 비교하고 `CompareGuid`가 `True`를 반환하는 경우에만 진행되는 snippet 폼이다.

```
  //
  // Get all the Hii handles
  //
  HiiHandles = HiiGetHiiHandles (NULL);

  ...

  //
  // Search for formset of each class type
  //
  for (Index = 0; HiiHandles[Index] != NULL; Index++) {
    Status = HiiGetFormSetFromHiiHandle (HiiHandles[Index], &Buffer, &BufferSize);
    if (EFI_ERROR (Status)) {
      continue;
    }

    Ptr = (UINT8 *)Buffer;
    while (TempSize < BufferSize) {
      TempSize += ((EFI_IFR_OP_HEADER *)Ptr)->Length;
      if (((EFI_IFR_OP_HEADER *)Ptr)->Length <= OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
        Ptr += ((EFI_IFR_OP_HEADER *)Ptr)->Length;
        continue;
      }

      ClassGuidNum = (UINT8)(((EFI_IFR_FORM_SET *)Ptr)->Flags & 0x3);
      ClassGuid    = (EFI_GUID *)(VOID *)(Ptr + sizeof (EFI_IFR_FORM_SET));
      while (ClassGuidNum-- > 0) {
        if (CompareGuid (&gEfiHiiPlatformSetupFormsetGuid, ClassGuid) == 0) {      <------- Add only formsets with
          ClassGuid++;                                                                      EFI_HII_PLATFORM_SETUP_FORMSET_GUID
          continue;
        }
    ...
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bob-mcd-team.gitbook.io/uefi/uefi-development/vfr/59.form-application.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.