【UEFI实战】HII之常用函数

最新推荐文章于 2024-02-26 14:02:27 发布
最新推荐文章于 2024-02-26 14:02:27 发布
阅读量4k 收藏 20
点赞数 5
分类专栏： UEFI开发基础 文章标签： hii setup uefi
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jiangwei0512/article/details/122825067
版权

资源安装

HiiAddPackages

函数原型：

/**
  Registers a list of packages in the HII Database and returns the HII Handle
  associated with that registration.  If an HII Handle has already been registered
  with the same PackageListGuid and DeviceHandle, then NULL is returned.  If there
  are not enough resources to perform the registration, then NULL is returned.
  If an empty list of packages is passed in, then NULL is returned.  If the size of
  the list of package is 0, then NULL is returned.

  The variable arguments are pointers which point to package header that defined
  by UEFI VFR compiler and StringGather tool.

  #pragma pack (push, 1)
  typedef struct {
    UINT32                  BinaryLength;
    EFI_HII_PACKAGE_HEADER  PackageHeader;
  } EDKII_AUTOGEN_PACKAGES_HEADER;
  #pragma pack (pop)

  @param[in]  PackageListGuid  The GUID of the package list.
  @param[in]  DeviceHandle     If not NULL, the Device Handle on which
                               an instance of DEVICE_PATH_PROTOCOL is installed.
                               This Device Handle uniquely defines the device that
                               the added packages are associated with.
  @param[in]  ...              The variable argument list that contains pointers
                               to packages terminated by a NULL.

  @retval NULL   A HII Handle has already been registered in the HII Database with
                 the same PackageListGuid and DeviceHandle.
  @retval NULL   The HII Handle could not be created.
  @retval NULL   An empty list of packages was passed in.
  @retval NULL   All packages are empty.
  @retval Other  The HII Handle associated with the newly registered package list.

**/
EFI_HII_HANDLE
EFIAPI
HiiAddPackages (
  IN CONST EFI_GUID    *PackageListGuid,
  IN       EFI_HANDLE  DeviceHandle  OPTIONAL,
  ...
  )

简单来说就是将资源（代码中用Package标识，这里将其翻译为资源似乎更好理解，它表示的可能是uni文件对应的字符串、vfr文件对应的Setup骨架、字体等等）安装HII数据库中，并返回数据库的Handle，后续要使用资源就要用到这个Handle。

它的第一个参数是GUID，用来唯一地标识安装的资源，目前不确定其作用，似乎是为了防止重复安装的；DeviceHandle用来在其上安装DEVICE_PATH_PROTOCOL实例，通过这种方式就可以将资源与安装在DeviceHandle之上的其它内容（比如设备）等联系在一起；...表示的是需要安装的资源。

下面是一个简单的例子，为了使用字符串资源，这里首先通过HiiAddPackages()进行安装：

VOID
InitializeStringSupport (
  VOID
  )
{
  gStringPackHandle = HiiAddPackages (
                         &mUiStringPackGuid,
                         gImageHandle,
                         UiAppStrings,
                         NULL
                         );
  ASSERT (gStringPackHandle != NULL);
}

UiAppStrings对应uni文件得到的数据，它通过HiiAddPackages()安装，并返回全局的gStringPackHandle，这个后面会用到，而另外一个gImageHandle在本例中并不重要。使用字符串资源的代码示例：

String = HiiGetString (gStringPackHandle, STRING_TOKEN (STR_MISSING_STRING), NULL);

STR_MISSING_STRING是uni文件中定义的宏，gStringPackHandle是前面调用HiiAddPackages时的返回值，第三个参数NULL表示跟随当前语言。另外需要注意的是这里的返回值String后面需要释放。

另一个比较复杂的示例，首先也是安装：

  //
  // Publish our HII data
  //
  gFrontPagePrivate.HiiHandle = HiiAddPackages (
                                  &mFrontPageGuid,
                                  gFrontPagePrivate.DriverHandle,
                                  FrontPageVfrBin,
                                  UiAppStrings,
                                  NULL
                                  );

这里的mFrontPageGuid跟vfr文件（MdeModulePkg\Application\UiApp\FrontPageVfr.Vfr）中的GUID一致，就是下面的FORMSET_GUID：

#define FORMSET_GUID  { 0x9e0c30bc, 0x3f06, 0x4ba6, 0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe }

#define FRONT_PAGE_FORM_ID             0x1000

#define LABEL_FRANTPAGE_INFORMATION    0x1000
#define LABEL_END                      0xffff

formset
  guid     = FORMSET_GUID,
  title    = STRING_TOKEN(STR_FRONT_PAGE_TITLE),
  help     = STRING_TOKEN(STR_EMPTY_STRING ),
  classguid = FORMSET_GUID,

返回的gFrontPagePrivate.HiiHandle会在EFI_FORM_BROWSER2_PROTOCOL中使用：

  Status = gFormBrowser2->SendForm (
                            gFormBrowser2,
                            &gFrontPagePrivate.HiiHandle,
                            1,
                            &mFrontPageGuid,
                            0,
                            NULL,
                            &ActionRequest
                            );

这里也用到了mFrontPageGuid，且应该是必须的，跟classguid = FORMSET_GUID匹配。

目前可添加的Packages有如下的种类：

  • Font
  • Simplified Font
  • String
  • Image
  • Device Path
  • keyboard Layout
  • GUID
  • Forms

本例中就使用了Font和String这些Package。

创建操作码

操作码可以在vfr文件中指定，也可以通过代码创建，下面介绍一些简单的创建操作码的函数。

HiiAllocateOpCodeHandle/HiiFreeOpCodeHandle

HiiAllocateOpCodeHandle()创建HII_LIB_OPCODE_BUFFER结构体并返回：

VOID *
EFIAPI
HiiAllocateOpCodeHandle (
  VOID
  )

其结构如下：

typedef struct {
  UINT8  *Buffer;
  UINTN  BufferSize;
  UINTN  Position;
} HII_LIB_OPCODE_BUFFER;

创建好之后的结构体中Buffer是一个大小为0x200字节的空间；BufferSize就是0x200；Position初始化为0。

HiiFreeOpCodeHandle()用来释放HiiAllocateOpCodeHandle()分配的数据，两者配合使用。

Buffer里面存放到就是各类操作码，如果操作码多，则Buffer还会根据实际的情况重新分配大小以存放所有的操作码。

HiiCreateActionOpCode

创建一个可以执行的操作码，其函数原型：

/**
  Create EFI_IFR_ACTION_OP opcode.

  If OpCodeHandle is NULL, then ASSERT().
  If any reserved bits are set in QuestionFlags, then ASSERT().

  @param[in]  OpCodeHandle  Handle to the buffer of opcodes.
  @param[in]  QuestionId      Question ID
  @param[in]  Prompt          String ID for Prompt
  @param[in]  Help            String ID for Help
  @param[in]  QuestionFlags   Flags in Question Header
  @param[in]  QuestionConfig  String ID for configuration

  @retval NULL   There is not enough space left in Buffer to add the opcode.
  @retval Other  A pointer to the created opcode.

**/
UINT8 *
EFIAPI
HiiCreateActionOpCode (
  IN VOID             *OpCodeHandle,
  IN EFI_QUESTION_ID  QuestionId,
  IN EFI_STRING_ID    Prompt,
  IN EFI_STRING_ID    Help,
  IN UINT8            QuestionFlags,
  IN EFI_STRING_ID    QuestionConfig
  )

操作码对应的结构体：

typedef struct _EFI_IFR_ACTION {
  EFI_IFR_OP_HEADER        Header;
  EFI_IFR_QUESTION_HEADER  Question;
  EFI_STRING_ID            QuestionConfig;
} EFI_IFR_ACTION;

HiiCreateGotoExOpCode

创建的操作码用于跳转，其函数原型：

/**
  Create EFI_IFR_REF_OP, EFI_IFR_REF2_OP, EFI_IFR_REF3_OP and EFI_IFR_REF4_OP opcode.

  When RefDevicePath is not zero, EFI_IFR_REF4 opcode will be created.
  When RefDevicePath is zero and RefFormSetId is not NULL, EFI_IFR_REF3 opcode will be created.
  When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is not zero, EFI_IFR_REF2 opcode will be created.
  When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is zero, EFI_IFR_REF opcode will be created.

  If OpCodeHandle is NULL, then ASSERT().
  If any reserved bits are set in QuestionFlags, then ASSERT().

  @param[in]  OpCodeHandle   The handle to the buffer of opcodes.
  @param[in]  RefFormId      The Destination Form ID.
  @param[in]  Prompt         The string ID for Prompt.
  @param[in]  Help           The string ID for Help.
  @param[in]  QuestionFlags  The flags in Question Header
  @param[in]  QuestionId     Question ID.
  @param[in]  RefQuestionId  The question on the form to which this link is referring.
                             If its value is zero, then the link refers to the top of the form.
  @param[in]  RefFormSetId   The form set to which this link is referring. If its value is NULL, and RefDevicePath is
                             zero, then the link is to the current form set.
  @param[in]  RefDevicePath  The string identifier that specifies the string containing the text representation of
                             the device path to which the form set containing the form specified by FormId.
                             If its value is zero, then the link refers to the current page.

  @retval NULL   There is not enough space left in Buffer to add the opcode.
  @retval Other  A pointer to the created opcode.

**/
UINT8 *
EFIAPI
HiiCreateGotoExOpCode (
  IN VOID             *OpCodeHandle,
  IN EFI_FORM_ID      RefFormId,
  IN EFI_STRING_ID    Prompt,
  IN EFI_STRING_ID    Help,
  IN UINT8            QuestionFlags,
  IN EFI_QUESTION_ID  QuestionId,
  IN EFI_QUESTION_ID  RefQuestionId,
  IN EFI_GUID         *RefFormSetId,    OPTIONAL
  IN EFI_STRING_ID    RefDevicePath
  )

创建的结构体根据参数的不同而存在差异：

typedef struct _EFI_IFR_REF {
  EFI_IFR_OP_HEADER        Header;
  EFI_IFR_QUESTION_HEADER  Question;
  EFI_FORM_ID              FormId;
} EFI_IFR_REF;

typedef struct _EFI_IFR_REF2 {
  EFI_IFR_OP_HEADER        Header;
  EFI_IFR_QUESTION_HEADER  Question;
  EFI_FORM_ID              FormId;
  EFI_QUESTION_ID          QuestionId;
} EFI_IFR_REF2;

typedef struct _EFI_IFR_REF3 {
  EFI_IFR_OP_HEADER        Header;
  EFI_IFR_QUESTION_HEADER  Question;
  EFI_FORM_ID              FormId;
  EFI_QUESTION_ID          QuestionId;
  EFI_GUID                 FormSetId;
} EFI_IFR_REF3;

typedef struct _EFI_IFR_REF4 {
  EFI_IFR_OP_HEADER        Header;
  EFI_IFR_QUESTION_HEADER  Question;
  EFI_FORM_ID              FormId;
  EFI_QUESTION_ID          QuestionId;
  EFI_GUID                 FormSetId;
  EFI_STRING_ID            DevicePath;
} EFI_IFR_REF4;

typedef struct _EFI_IFR_REF5 {
  EFI_IFR_OP_HEADER Header;
  EFI_IFR_QUESTION_HEADER Question;
} EFI_IFR_REF5;

其实现中有如下的代码：

  //
  // Cacluate OpCodeSize based on the input Ref value.
  // Try to use the small OpCode to save size.
  //
  OpCodeSize = sizeof (EFI_IFR_REF);
  if (RefDevicePath != 0) {
    OpCodeSize = sizeof (EFI_IFR_REF4);
  } else if (RefFormSetId != NULL) {
    OpCodeSize = sizeof (EFI_IFR_REF3);
  } else if (RefQuestionId != 0) {
    OpCodeSize = sizeof (EFI_IFR_REF2);
  }

从这里可以看到指定了不同的操作码。

HiiCreateGuidOpCode

函数原型：

/**
  Create EFI_IFR_GUID opcode.

  If OpCodeHandle is NULL, then ASSERT().
  If Guid is NULL, then ASSERT().
  If OpCodeSize < sizeof (EFI_IFR_GUID), then ASSERT().

  @param[in]  OpCodeHandle  Handle to the buffer of opcodes.
  @param[in]  Guid          Pointer to EFI_GUID of this guided opcode.
  @param[in]  GuidOpCode    Pointer to an EFI_IFR_GUID opcode.  This is an
                            optional parameter that may be NULL.  If this
                            parameter is NULL, then the GUID extension
                            region of the created opcode is filled with zeros.
                            If this parameter is not NULL, then the GUID
                            extension region of GuidData will be copied to
                            the GUID extension region of the created opcode.
  @param[in]  OpCodeSize    The size, in bytes, of created opcode.  This value
                            must be >= sizeof(EFI_IFR_GUID).

  @retval NULL   There is not enough space left in Buffer to add the opcode.
  @retval Other  A pointer to the created opcode.

**/
UINT8 *
EFIAPI
HiiCreateGuidOpCode (
  IN VOID            *OpCodeHandle,
  IN CONST EFI_GUID  *Guid,
  IN CONST VOID      *GuidOpCode,    OPTIONAL
  IN UINTN           OpCodeSize
  )

创建EFI_IFR_GUID操作码，它是现有的GUID的扩展，本身包含不同的格式，通过一个GUID来标识，现有的有gEfiIfrTianoGuid，它包含的格式有：

///
/// EDKII implementation extension opcodes, new extension can be added here later.
///
#define EFI_IFR_EXTEND_OP_LABEL       0x0
#define EFI_IFR_EXTEND_OP_BANNER      0x1
#define EFI_IFR_EXTEND_OP_TIMEOUT     0x2
#define EFI_IFR_EXTEND_OP_CLASS       0x3
#define EFI_IFR_EXTEND_OP_SUBCLASS    0x4

下面是创建一个LABLE的示例：

  //
  // Create Hii Extend Label OpCode.
  //
  StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
                                        StartOpCodeHandle,
                                        &gEfiIfrTianoGuid,
                                        NULL,
                                        sizeof (EFI_IFR_GUID_LABEL)
                                        );

参数说明：

  • OpCodeHandle：对应容纳操作码的HII_LIB_OPCODE_BUFFER结构体；

HiiCreateOneOfOpCode

函数原型：

/**
  Create EFI_IFR_ONE_OF_OP opcode.

  If OpCodeHandle is NULL, then ASSERT().
  If any reserved bits are set in QuestionFlags, then ASSERT().
  If any reserved bits are set in OneOfFlags, then ASSERT().

  @param[in]  OpCodeHandle          Handle to the buffer of opcodes.
  @param[in]  QuestionId            Question ID
  @param[in]  VarStoreId            Storage ID
  @param[in]  VarOffset             Offset in Storage or String ID of the name (VarName)
                                    for this name/value pair.
  @param[in]  Prompt                String ID for Prompt
  @param[in]  Help                  String ID for Help
  @param[in]  QuestionFlags         Flags in Question Header
  @param[in]  OneOfFlags            Flags for oneof opcode
  @param[in]  OptionsOpCodeHandle   Handle for a buffer of ONE_OF_OPTION opcodes.
  @param[in]  DefaultsOpCodeHandle  Handle for a buffer of DEFAULT opcodes.  This
                                    is an optional parameter that may be NULL.

  @retval NULL   There is not enough space left in Buffer to add the opcode.
  @retval Other  A pointer to the created opcode.

**/
UINT8 *
EFIAPI
HiiCreateOneOfOpCode (
  IN VOID             *OpCodeHandle,
  IN EFI_QUESTION_ID  QuestionId,
  IN EFI_VARSTORE_ID  VarStoreId,
  IN UINT16           VarOffset,
  IN EFI_STRING_ID    Prompt,
  IN EFI_STRING_ID    Help,
  IN UINT8            QuestionFlags,
  IN UINT8            OneOfFlags,
  IN VOID             *OptionsOpCodeHandle,
  IN VOID             *DefaultsOpCodeHandle  OPTIONAL
  )

创建EFI_IFR_ONE_OF操作码，它表示的是select-one-of question，其实就是单选框，比如Front Page中的语言选择框：

在这里插入图片描述

其对应的结构体：

typedef struct _EFI_IFR_ONE_OF {
  EFI_IFR_OP_HEADER        Header;
  EFI_IFR_QUESTION_HEADER  Question; // 单选框结构体中的EFI_IFR_QUESTION_HEADER
  UINT8                    Flags;
  MINMAXSTEP_DATA          data;
} EFI_IFR_ONE_OF;

下面是一个示例：

  HiiCreateOneOfOpCode (
    StartOpCodeHandle,
    FRONT_PAGE_KEY_LANGUAGE,
    0,
    0,
    STRING_TOKEN (STR_LANGUAGE_SELECT),
    STRING_TOKEN (STR_LANGUAGE_SELECT_HELP),
    EFI_IFR_FLAG_CALLBACK,
    EFI_IFR_NUMERIC_SIZE_1,
    OptionsOpCodeHandle,
    NULL
    );

参数说明：

  • OpCodeHandle：应该是上一层操作码对应的HII_LIB_OPCODE_BUFFER结构体；
  • QuestionId：其实是一个UINT16类型的数值，它是一个在当前驱动唯一的值，通过它回调函数（由EFI_HII_ACCESS_FORM_CALLBACK声明）就能够知道需要处理的数据具体是哪个；（UEFI规范中的说明：A unique value which is sent to the original exporting driver so that it can identify the type of data to expect. The format of the data tends to vary based on the opcode that generated the callback. ）

EFI_HII_ACCESS_FORM_CALLBACK回调函数的声明如下：

/**

  This function is called to provide results data to the driver.
  This data consists of a unique key that is used to identify
  which data is either being passed back or being asked for.

  @param  This                   Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
  @param  Action                 Specifies the type of action taken by the browser.
  @param  QuestionId             A unique value which is sent to the original
                                 exporting driver so that it can identify the type
                                 of data to expect. The format of the data tends to
                                 vary based on the opcode that generated the callback.
  @param  Type                   The type of value for the question.
  @param  Value                  A pointer to the data being sent to the original
                                 exporting driver.
  @param  ActionRequest          On return, points to the action requested by the
                                 callback function.

  @retval EFI_SUCCESS            The callback successfully handled the action.
  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the
                                 variable and its data.
  @retval EFI_DEVICE_ERROR       The variable could not be saved.
  @retval EFI_UNSUPPORTED        The specified Action is not supported by the
                                 callback.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_HII_ACCESS_FORM_CALLBACK)(
  IN     CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
  IN     EFI_BROWSER_ACTION                     Action,
  IN     EFI_QUESTION_ID                        QuestionId,
  IN     UINT8                                  Type,
  IN OUT EFI_IFR_TYPE_VALUE                     *Value,
  OUT    EFI_BROWSER_ACTION_REQUEST             *ActionRequest
  );

它是EFI_HII_CONFIG_ACCESS_PROTOCOL的接口。

  • VarStoreId/VarOffset：这里通过一个ID指定对应的变量，通过Offset指定对应的成员，对该操作码的修改就对应的变量；如果没有变量与之对应，就直接写0就可以了；
  • Prompt：对应显示；
  • Help：对应操作的帮助；
  • QuestionFlags：表示选项的属性，比如只读、回调，等等，对应的值如下所示：
//
// Flag values of EFI_IFR_QUESTION_HEADER
//
#define EFI_IFR_FLAG_READ_ONLY          0x01
#define EFI_IFR_FLAG_CALLBACK           0x04
#define EFI_IFR_FLAG_RESET_REQUIRED     0x10
#define EFI_IFR_FLAG_REST_STYLE         0x20
#define EFI_IFR_FLAG_RECONNECT_REQUIRED 0x40
#define EFI_IFR_FLAG_OPTIONS_ONLY       0x80

EFI_IFR_QUESTION_HEADER在不少操作码都存在，比如这里创建的单选框（见结构体中的Question成员）就有，其结构体：

typedef struct _EFI_IFR_QUESTION_HEADER {
  EFI_IFR_STATEMENT_HEADER Header;
  EFI_QUESTION_ID          QuestionId;
  EFI_VARSTORE_ID          VarStoreId;
  union {
    EFI_STRING_ID          VarName;
    UINT16                 VarOffset;
  }                        VarStoreInfo;
  UINT8                    Flags;	// 对应QuestionFlags
} EFI_IFR_QUESTION_HEADER;
  • OneOfFlags：单选框的Flags，有如下的值：
//
// Flags related to the numeric question
//
#define EFI_IFR_NUMERIC_SIZE           0x03
#define   EFI_IFR_NUMERIC_SIZE_1       0x00
#define   EFI_IFR_NUMERIC_SIZE_2       0x01
#define   EFI_IFR_NUMERIC_SIZE_4       0x02
#define   EFI_IFR_NUMERIC_SIZE_8       0x03

#define EFI_IFR_DISPLAY                0x30
#define   EFI_IFR_DISPLAY_INT_DEC      0x00
#define   EFI_IFR_DISPLAY_UINT_DEC     0x10
#define   EFI_IFR_DISPLAY_UINT_HEX     0x20

它表示的意义目前有两种，第一种表示值的类型，第二种表示显示的格式；

  • OptionsOpCodeHandle：表示单选框操作码本身，它里面通常还需要包含EFI_IFR_ONE_OF_OPTION_OP操作码，表示单选框中的子选项；
  • DefaultsOpCodeHandle：表示默认显示的单选框子选项；

关于子选项，见HiiCreateOneOfOptionOpCode。

HiiCreateOneOfOptionOpCode

函数原型：

/**
  Create EFI_IFR_ONE_OF_OPTION_OP opcode.

  If OpCodeHandle is NULL, then ASSERT().
  If Type is invalid, then ASSERT().
  If Flags is invalid, then ASSERT().

  @param[in]  OpCodeHandle  Handle to the buffer of opcodes.
  @param[in]  StringId      StringId for the option
  @param[in]  Flags         Flags for the option
  @param[in]  Type          Type for the option
  @param[in]  Value         Value for the option

  @retval NULL   There is not enough space left in Buffer to add the opcode.
  @retval Other  A pointer to the created opcode.

**/
UINT8 *
EFIAPI
HiiCreateOneOfOptionOpCode (
  IN VOID    *OpCodeHandle,
  IN UINT16  StringId,
  IN UINT8   Flags,
  IN UINT8   Type,
  IN UINT64  Value
  )

创建的操作码对应的结构体：

typedef struct _EFI_IFR_ONE_OF_OPTION {
  EFI_IFR_OP_HEADER        Header;
  EFI_STRING_ID            Option;
  UINT8                    Flags;
  UINT8                    Type;
  EFI_IFR_TYPE_VALUE       Value;
} EFI_IFR_ONE_OF_OPTION;

HiiCreateSubTitleOpCode

函数原型：

/**
  Create EFI_IFR_SUBTITLE_OP opcode.

  If OpCodeHandle is NULL, then ASSERT().
  If any reserved bits are set in Flags, then ASSERT().
  If Scope > 1, then ASSERT().

  @param[in]  OpCodeHandle  Handle to the buffer of opcodes.
  @param[in]  Prompt      String ID for Prompt
  @param[in]  Help        String ID for Help
  @param[in]  Flags       Subtitle opcode flags
  @param[in]  Scope       1 if this opcode is the beginning of a new scope.
                          0 if this opcode is within the current scope.

  @retval NULL   There is not enough space left in Buffer to add the opcode.
  @retval Other  A pointer to the created opcode.

**/
UINT8 *
EFIAPI
HiiCreateSubTitleOpCode (
  IN VOID           *OpCodeHandle,
  IN EFI_STRING_ID  Prompt,
  IN EFI_STRING_ID  Help,
  IN UINT8          Flags,
  IN UINT8          Scope
  )

创建的操作码对应的结构体：

typedef struct _EFI_IFR_SUBTITLE {
  EFI_IFR_OP_HEADER        Header;
  EFI_IFR_STATEMENT_HEADER Statement;
  UINT8                    Flags;
} EFI_IFR_SUBTITLE;

字符串操作

HiiGetString

函数原型：

/**
  Retrieves a string from a string package in a specific language specified in Language
  or in the best lanaguage. See HiiGetStringEx () for the details.

  @param[in]  HiiHandle  A handle that was previously registered in the HII Database.
  @param[in]  StringId   The identifier of the string to retrieved from the string
                         package associated with HiiHandle.
  @param[in]  Language   The language of the string to retrieve.  If this parameter
                         is NULL, then the current platform language is used.  The
                         format of Language must follow the language format assumed
                         the HII Database.

  @retval NULL   The string specified by StringId is not present in the string package.
  @retval Other  The string was returned.

**/
EFI_STRING
EFIAPI
HiiGetString (
  IN EFI_HII_HANDLE  HiiHandle,
  IN EFI_STRING_ID   StringId,
  IN CONST CHAR8     *Language  OPTIONAL
  );

这个函数用来获取字符串，字符串通过Language来确定语种，StringId确定使用哪个字段，这个字段定义在uni文件中，而uni文件通过函数HiiAddPackages()安装，下面是一个例子（来自MdeModulePkg\Application\UiApp\UiApp.inf）：

  //
  // Publish our HII data
  //
  gFrontPagePrivate.HiiHandle = HiiAddPackages (
                                  &mFrontPageGuid,
                                  gFrontPagePrivate.DriverHandle,
                                  FrontPageVfrBin,
                                  UiAppStrings,
                                  NULL
                                  );

UiAppStrings是一个中间文件（AutoGen.c）中定义的变量，在Build目录中生成，它的名字来自inf中设置的MODULE_UNI_FILE:

MODULE_UNI_FILE                = UiApp.uni

两者的关系是uni文件去掉后缀并加上Strings就得到的用在HiiAddPackages()中的变量。不过模块中的uni文件并不需要都是这个名字，可以有多个不同名的uni文件。

下面是使用HiiGetString()的一个例子：

  //
  // Update default banner string.
  //
  NewString = HiiGetString (gFrontPagePrivate.HiiHandle, STRING_TOKEN (STR_CUSTOMIZE_BANNER_LINE4_LEFT), NULL);

STR_CUSTOMIZE_BANNER_LINE4_LEFT就是在某个uni文件（FrontPageStrings.uni）中定义的（目前是空的）：

#string STR_CUSTOMIZE_BANNER_LINE4_LEFT  #language en-US  ""
                                         #language fr-FR  ""

而gFrontPagePrivate.HiiHandle是使用HiiAddPackages()安装时的返回值。

HiiSetString

函数原型：

/**
  This function creates a new string in String Package or updates an existing
  string in a String Package.  If StringId is 0, then a new string is added to
  a String Package.  If StringId is not zero, then a string in String Package is
  updated.  If SupportedLanguages is NULL, then the string is added or updated
  for all the languages that the String Package supports.  If SupportedLanguages
  is not NULL, then the string is added or updated for the set of languages
  specified by SupportedLanguages.

  If HiiHandle is NULL, then ASSERT().
  If String is NULL, then ASSERT().

  @param[in]  HiiHandle           A handle that was previously registered in the
                                  HII Database.
  @param[in]  StringId            If zero, then a new string is created in the
                                  String Package associated with HiiHandle.  If
                                  non-zero, then the string specified by StringId
                                  is updated in the String Package associated
                                  with HiiHandle.
  @param[in]  String              A pointer to the Null-terminated Unicode string
                                  to add or update in the String Package associated
                                  with HiiHandle.
  @param[in]  SupportedLanguages  A pointer to a Null-terminated ASCII string of
                                  language codes.  If this parameter is NULL, then
                                  String is added or updated in the String Package
                                  associated with HiiHandle for all the languages
                                  that the String Package supports.  If this
                                  parameter is not NULL, then String is added
                                  or updated in the String Package associated with
                                  HiiHandle for the set of languages specified by
                                  SupportedLanguages.  The format of
                                  SupportedLanguages must follow the language
                                  format assumed in the HII Database.

  @retval 0      The string could not be added or updated in the String Package.
  @retval Other  The EFI_STRING_ID of the newly added or updated string.

**/
EFI_STRING_ID
EFIAPI
HiiSetString (
  IN EFI_HII_HANDLE    HiiHandle,
  IN EFI_STRING_ID     StringId,            OPTIONAL
  IN CONST EFI_STRING  String,
  IN CONST CHAR8       *SupportedLanguages  OPTIONAL
  );

这个函数在字符串资源中新增或者字符串。StringId如果是0表示新增，否则就表示修改原有的字符串。

Form操作

HiiUpdateForm

用于更新界面结构，函数原型：

EFI_STATUS
EFIAPI
HiiUpdateForm (
  IN EFI_HII_HANDLE  HiiHandle,
  IN EFI_GUID        *FormSetGuid,        OPTIONAL
  IN EFI_FORM_ID     FormId,
  IN VOID            *StartOpCodeHandle,
  IN VOID            *EndOpCodeHandle     OPTIONAL
  )

这里的HiiHandle就是HiiAddPackages()添加元素数据之后的返回值：

  gFrontPagePrivate.HiiHandle = HiiAddPackages (
                                  &mFrontPageGuid,
                                  gFrontPagePrivate.DriverHandle,
                                  FrontPageVfrBin,
                                  UiAppStrings,
                                  NULL
                                  );

FormSetGuid是HiiAddPackages()中的第一个参数，即mFrontPageGuid。

FormId是定义在vfr文件中：

form formid = FRONT_PAGE_FORM_ID,

StartOpCodeHandle和EndOpCodeHandle由HiiAllocateOpCodeHandle()创建。

jiangwei0512
关注
专栏目录
UEFI实战 gST、gBS和gImageHandle
qq_30135687的博客
09-05 743
文章目录一、gST、gBS和gImageHandle是什么？二、使用步骤1.变量定义2.变量的初始化3.gST、gBS和gImageHandle的使用 一、gST、gBS和gImageHandle是什么？ gST：globalSystemTable，指向SystemTable，EFI系统表的缓存指针； gBS：globalBootServices，指向SystemTable->BootServices，EFI引导服务表的缓存指针； gImageHandle：ImageHandle，Image句柄的
【BIOS/UEFI】Memory Service（篇目一）PEI内存服务
weixin_45258382的博客
03-29 1624
HOB是一个临时内存，放在CPU 的catch上，可读可写（使用时是只读的）。PEI阶段，同一模块或者不同模块的function之间用HOB传递信息，可以实现全局信息共享（是共享）。根据不同的使用需求，HOB被定义为不同的Type：【CAR（Cache As RAM）是以CPU的Cache作为RAM为PEI阶段的C提供memory资源，以便EFI尽早进入C语言环境。【PPI共享的是Services。
【UEFI】HiiDataBase 学习
等
11-27 1323
HiiDataBase由多个PackageList组成，每个PackageList对应一个HiiHandle数据存放在一块连续内存，通过HiiHandle可以找到对应的PackageList；遍历整个HiiDataBase首先从HiiHandles入手，因为每个HiiHandle就是一个PackageList，所以便利每个HiiHandle时导出一个PackageList。注意：有些设备的PackageListGuid是固定的有些则是运行时生成的。其在UEFI中的体现是 BIOS Setup的内容显示。
UEFI HII (Human Interface Infrastructure)一些知识点
weixin_50158428的博客
05-17 637
HII database 涉及到packagelist-》Forms package-》IFR-》Opcode数据结构
【UEFI实战】HII之HII数据库和Form浏览器
jiangwei0512的博客
02-08 1773
【UEFI实战】HII之HII数据库和Form浏览器。
UEFI实战--------HII之uni文件
技术联盟
03-11 1675
uni文件HII的实现涉及到多种不同类型的文件，uni文件是其中最简单的一种，它用来存放各种语言的字符串以实现本地化。本节主要参考自《edk-ii-uni-specification.pdf》，后面简称为参考文档。
UEFI开发探索17 – 使用HII显示汉字2
09-15 1233
(请保留-> 作者: 罗冰) 本篇博客的关键字：SimpleFont。 上次编程后，我始终在思考如何在UEFI Shell下显示汉字。上一篇中，参考书中的例子，基本了解了字符串资源是怎么组织的。当在TestString函数中，把参数Language改为”zh-Hans”，什么也没有显示。 看来还是缺少相应的字库。 UEFI下提供了SimpleFont和Font字体，前一个相对简单些，...
uefi实战：hii之vfr文件
07-15
在实战中，您可以使用VFR文件来定义UEFI固件中的用户界面。首先，您需要创建一个VFR文件，其中包含界面的布局和控件的定义。然后，使用编译器将VFR文件编译为对应的二进制格式，生成一个可执行的HII包。最后，将HII...
HII_9_2.zip_UEFI Bios_UEFI Spec_human_uefi
09-21
本文将深入探讨UEFI BIOS的人机接口协议（Human Interface Interface，简称HII），以及UEFI规范的相关知识。 UEFI BIOS的人机接口协议是UEFI环境下的用户界面标准，用于在系统启动和管理过程中提供图形化或文本化的...
bios/uefi HII基本框架及概述
07-15
HII（Human Interface Infrastructure）是UEFI中的一个基本框架，它提供了一种标准化的方式来创建和管理图形用户界面（GUI）。下面是对BIOS/UEFI和HII的基本概述： 1. BIOS：BIOS是一种早期的固件接口，在过去的...
UEFI实战——在Windows下运行UEFI BIOS（Nt32篇）
技术联盟
05-14 2145
综述 EDK2源代码中有一个PKG名称Nt32Pkg： 通过这个PKG可以编译出可以在Windows下直接运行的UEFI BIOS程序，因此可以通过它来学习UEFI的一些基础和细节。 本文主要介绍如何编译这个PKG以及如何运行生成的BIOS。 源代码来自：https://gitee.com/jiangwei0512/vUDK2017，也可以在https://github.com/tianoc...
【UEFI实战】HII之uni文件
jiangwei0512的博客
02-08 4034
【UEFI实战】HII之uni文件。
UEFI Setup界面Hii动态创建选项
最新发布
qq_43561214的博客
02-26 1208
每个界面的选项一些操作 恢复默认值 动态创建的选项需要配置对应的当前值或者BufferStorage的值进行显示和存取操作，CallBack针对选项的操作进行执行CallBacFunc函数,其中实例需要自己实现每个vfr都可以按照需求实现自己的ConfigAccess Protocol。使用form formid 点击goto选项会跳到相同的formid页面。1.Vfr文件中建立Label ，在C文件中动态插入选项到Label位置。实例：这样就实现在vfr中跳转到不同的Form页面。
UEFI开发探索18 – 使用HII显示汉字3
09-16 1690
(请保留-> 作者: 罗冰) 本篇博客的关键字：Font。 今天准备把UEFI另外一种字体Font的方方面面研究一下，仍旧是以代码移植为主，间以解决自己提的几个问题。 1 Text模式和Graphics模式 实验之前，我想谈一下Text模式和Graphics模式。UEFI spec中，对于Text模式和Graphics模式谈得比较少。我一直很疑惑，spec中的Text模式和Graph...
UEFI学习1
qq_28629687的博客
09-12 1259
本文主要翻译wikipedia：https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface 统一可扩展固件接口(UEFI)是定义操作系统和平台固件之间的软件接口的规范。UEFI替换了最初出现在所有IBM pc兼容的个人计算机上的基本输入/输出系统(BIOS)固件接口，大多数UEFI固件实现都为BIOS服务提供了遗留支持。...
【BIOS/UEFI】HII 基本框架及概述
weixin_45258382的博客
12-23 5104
HII（Human Interface Infrastructure ）定义了一套管理用户输入的基础框架。HII数据库主要提供用户安装、卸载以及使用各种字符串、字体和图片等资源的接口。驱动程序和应用程序将元素（如字体、字符串、图像和表单）安装到 HII 数据库中，该数据库充当整个平台的中央存储库。Forms Browser 使用这些元素在显示设备上呈现用户界面，并通过 HID 设备从用户接收信息。
UEFI HII驱动开发——HII资源绑定的方法
yao00037的博客
06-19 789
方法一 调用EFI_HII_DATABASE_PROTOCOL提供的NewPackageList()进行绑定 在模块的inf文件中需要定义UEFI_HII_RESOURCE_SECTION = TRUE 该方法不能满足模块中提供多个form的功能 方法二 调用HiiLib中的HiiAddPackages接口进行绑定 inf文件中不需要定义UEFI_HII_RESOURCE_SECTION = TRUE 在源文件中需要声明extern UINT8 ModuleStrings[] 和 extern UIN
【UEFI实战】HII之配置
jiangwei0512的博客
02-08 2984
【UEFI实战】HII之配置。
【UEFI实战】HII之FrontPage
jiangwei0512的博客
02-08 3285
【UEFI实战】HII之FrontPage。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值