efi_hii.h File Reference

EFI human interface infrastructure. More...

#include <string.h>
#include <ipxe/efi/Uefi/UefiInternalFormRepresentation.h>
#include <ipxe/efi/Guid/MdeModuleHii.h>

Go to the source code of this file.

Data Structures
struct	efi_ifr_builder
	An EFI IFR builder. More...

Macros
#define	EFI_HII_IBM_UCM_COMPLIANT_FORMSET_GUID
	GUID indicating formset compliance for IBM Unified Configuration Manager. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	efi_ifr_init (struct efi_ifr_builder *ifr)
	Initialise IFR builder. More...
unsigned int	efi_ifr_string (struct efi_ifr_builder *ifr, const char *fmt,...)
	Add string to IFR builder. More...
void	efi_ifr_end_op (struct efi_ifr_builder *ifr)
	Add end opcode to IFR builder. More...
void	efi_ifr_false_op (struct efi_ifr_builder *ifr)
	Add false opcode to IFR builder. More...
unsigned int	efi_ifr_form_op (struct efi_ifr_builder *ifr, unsigned int title_id)
	Add form opcode to IFR builder. More...
void	efi_ifr_form_set_op (struct efi_ifr_builder *ifr, const EFI_GUID *guid, unsigned int title_id, unsigned int help_id,...)
	Add formset opcode to IFR builder. More...
void	efi_ifr_get_op (struct efi_ifr_builder *ifr, unsigned int varstore_id, unsigned int varstore_info, unsigned int varstore_type)
	Add get opcode to IFR builder. More...
void	efi_ifr_guid_class_op (struct efi_ifr_builder *ifr, unsigned int class)
	Add GUID class opcode to IFR builder. More...
void	efi_ifr_guid_subclass_op (struct efi_ifr_builder *ifr, unsigned int subclass)
	Add GUID subclass opcode to IFR builder. More...
void	efi_ifr_numeric_op (struct efi_ifr_builder *ifr, unsigned int prompt_id, unsigned int help_id, unsigned int question_id, unsigned int varstore_id, unsigned int varstore_info, unsigned int vflags, unsigned long min_value, unsigned long max_value, unsigned int step, unsigned int flags)
	Add numeric opcode to IFR builder. More...
void	efi_ifr_string_op (struct efi_ifr_builder *ifr, unsigned int prompt_id, unsigned int help_id, unsigned int question_id, unsigned int varstore_id, unsigned int varstore_info, unsigned int vflags, unsigned int min_size, unsigned int max_size, unsigned int flags)
	Add string opcode to IFR builder. More...
void	efi_ifr_suppress_if_op (struct efi_ifr_builder *ifr)
	Add suppress-if opcode to IFR builder. More...
void	efi_ifr_text_op (struct efi_ifr_builder *ifr, unsigned int prompt_id, unsigned int help_id, unsigned int text_id)
	Add text opcode to IFR builder. More...
void	efi_ifr_true_op (struct efi_ifr_builder *ifr)
	Add true opcode to IFR builder. More...
unsigned int	efi_ifr_varstore_name_value_op (struct efi_ifr_builder *ifr, const EFI_GUID *guid)
	Add name/value store opcode to IFR builder. More...
void	efi_ifr_free (struct efi_ifr_builder *ifr)
	Free memory used by IFR builder. More...
EFI_HII_PACKAGE_LIST_HEADER *	efi_ifr_package (struct efi_ifr_builder *ifr, const EFI_GUID *guid, const char *language, unsigned int language_id)
	Construct package list from IFR builder. More...

Detailed Description

EFI human interface infrastructure.

Definition in file efi_hii.h.

Macro Definition Documentation

EFI_HII_IBM_UCM_COMPLIANT_FORMSET_GUID

#define EFI_HII_IBM_UCM_COMPLIANT_FORMSET_GUID

Value:

{ 0x5c8e9746, 0xa5f7, 0x4593,                                      \
          { 0xaf, 0x1f, 0x66, 0xa8, 0x2a, 0xa1, 0x9c, 0xb1 } }

GUID indicating formset compliance for IBM Unified Configuration Manager.

Definition at line 17 of file efi_hii.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

efi_ifr_init()

static void efi_ifr_init ( struct efi_ifr_builder *  ifr )

inlinestatic

Initialise IFR builder.

Parameters

ifr	IFR builder

The caller must eventually call efi_ifr_free() to free the dynamic storage associated with the IFR builder.

Definition at line 49 of file efi_hii.h.

                                                                {
        memset ( ifr, 0, sizeof ( *ifr ) );
}

References memset().

Referenced by efi_snp_hii_package_list().

efi_ifr_string()

unsigned int efi_ifr_string	(	struct efi_ifr_builder *	ifr,
		const char *	fmt,
			...
	)

Add string to IFR builder.

Parameters

ifr	IFR builder
fmt	Format string
...	Arguments

Return values

string_id

String identifier, or zero on failure

Definition at line 46 of file efi_hii.c.

                                    {
        EFI_HII_STRING_BLOCK *new_strings;
        EFI_HII_SIBT_STRING_UCS2_BLOCK *ucs2;
        size_t new_strings_len;
        va_list args;
        size_t len;
        unsigned int string_id;

        /* Do nothing if a previous allocation has failed */
        if ( ifr->failed )
                return 0;

        /* Calculate string length */
        va_start ( args, fmt );
        len = ( efi_vsnprintf ( NULL, 0, fmt, args ) + 1 /* wNUL */ );
        va_end ( args );

        /* Reallocate strings */
        new_strings_len = ( ifr->strings_len +
                            offsetof ( typeof ( *ucs2 ), StringText ) +
                            ( len * sizeof ( ucs2->StringText[0] ) ) );
        new_strings = realloc ( ifr->strings, new_strings_len );
        if ( ! new_strings ) {
                ifr->failed = 1;
                return 0;
        }
        ucs2 = ( ( ( void * ) new_strings ) + ifr->strings_len );
        ifr->strings = new_strings;
        ifr->strings_len = new_strings_len;

        /* Fill in string */
        ucs2->Header.BlockType = EFI_HII_SIBT_STRING_UCS2;
        va_start ( args, fmt );
        efi_vsnprintf ( ucs2->StringText, len, fmt, args );
        va_end ( args );

        /* Allocate string ID */
        string_id = ++(ifr->string_id);

        DBGC ( ifr, "IFR %p string %#04x is \"%ls\"\n",
               ifr, string_id, ucs2->StringText );
        return string_id;
}

References EFI_HII_STRING_BLOCK::BlockType, DBGC, EFI_HII_SIBT_STRING_UCS2, efi_vsnprintf(), efi_ifr_builder::failed, fmt, _EFI_HII_SIBT_STRING_UCS2_BLOCK::Header, len, NULL, offsetof, realloc(), efi_ifr_builder::string_id, efi_ifr_builder::strings, efi_ifr_builder::strings_len, _EFI_HII_SIBT_STRING_UCS2_BLOCK::StringText, typeof(), va_end, and va_start.

Referenced by efi_snp_hii_package_list(), and efi_snp_hii_questions().

efi_ifr_end_op()

void efi_ifr_end_op

(

struct efi_ifr_builder *

ifr

)

Add end opcode to IFR builder.

Parameters

ifr	IFR builder

Definition at line 133 of file efi_hii.c.

                                                    {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_END *end;

        /* Add opcode */
        end = efi_ifr_op ( ifr, EFI_IFR_END_OP, sizeof ( *end ) );

        DBGC ( ifr, "IFR %p end\n", ifr );
        DBGC2_HDA ( ifr, dispaddr, end, sizeof ( *end ) );
}

References DBGC, DBGC2_HDA, EFI_IFR_END_OP, efi_ifr_op(), end, and efi_ifr_builder::ops_len.

Referenced by efi_snp_hii_package_list().

efi_ifr_false_op()

void efi_ifr_false_op

(

struct efi_ifr_builder *

ifr

)

Add false opcode to IFR builder.

Parameters

ifr	IFR builder

Definition at line 149 of file efi_hii.c.

                                                      {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_FALSE *op;

        /* Add opcode */
        op = efi_ifr_op ( ifr, EFI_IFR_FALSE_OP, sizeof ( *op ) );

        DBGC ( ifr, "IFR %p false\n", ifr );
        DBGC2_HDA ( ifr, dispaddr, op, sizeof ( *op ) );
}

References DBGC, DBGC2_HDA, EFI_IFR_FALSE_OP, efi_ifr_op(), op, and efi_ifr_builder::ops_len.

efi_ifr_form_op()

unsigned int efi_ifr_form_op	(	struct efi_ifr_builder *	ifr,
		unsigned int	title_id
	)

Add form opcode to IFR builder.

Parameters

ifr	IFR builder
title_id	Title string identifier

Return values

form_id

Form identifier

Definition at line 167 of file efi_hii.c.

                                                       {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_FORM *form;

        /* Add opcode */
        form = efi_ifr_op ( ifr, EFI_IFR_FORM_OP, sizeof ( *form ) );
        if ( ! form )
                return 0;
        form->Header.Scope = 1;
        form->FormId = ++(ifr->form_id);
        form->FormTitle = title_id;

        DBGC ( ifr, "IFR %p name/value store %#04x title %#04x\n",
               ifr, form->FormId, title_id );
        DBGC2_HDA ( ifr, dispaddr, form, sizeof ( *form ) );
        return form->FormId;
}

References DBGC, DBGC2_HDA, EFI_IFR_FORM_OP, efi_ifr_op(), efi_ifr_builder::form_id, and efi_ifr_builder::ops_len.

Referenced by efi_snp_hii_package_list().

efi_ifr_form_set_op()

void efi_ifr_form_set_op	(	struct efi_ifr_builder *	ifr,
		const EFI_GUID *	guid,
		unsigned int	title_id,
		unsigned int	help_id,
			...
	)

Add formset opcode to IFR builder.

Parameters

ifr	IFR builder
guid	GUID
title_id	Title string identifier
help_id	Help string identifier
...	Class GUIDs (terminated by NULL)

Definition at line 195 of file efi_hii.c.

                                                                              {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_FORM_SET *formset;
        EFI_GUID *class_guid;
        unsigned int num_class_guids = 0;
        size_t len;
        va_list args;

        /* Count number of class GUIDs */
        va_start ( args, help_id );
        while ( va_arg ( args, const EFI_GUID * ) != NULL )
                num_class_guids++;
        va_end ( args );

        /* Add opcode */
        len = ( sizeof ( *formset ) +
                ( num_class_guids * sizeof ( *class_guid ) ) );
        formset = efi_ifr_op ( ifr, EFI_IFR_FORM_SET_OP, len );
        if ( ! formset )
                return;
        formset->Header.Scope = 1;
        memcpy ( &formset->Guid, guid, sizeof ( formset->Guid ) );
        formset->FormSetTitle = title_id;
        formset->Help = help_id;
        formset->Flags = num_class_guids;

        /* Add class GUIDs */
        class_guid = ( ( ( void * ) formset ) + sizeof ( *formset ) );
        va_start ( args, help_id );
        while ( num_class_guids-- ) {
                memcpy ( class_guid++, va_arg ( args, const EFI_GUID * ),
                         sizeof ( *class_guid ) );
        }
        va_end ( args );

        DBGC ( ifr, "IFR %p formset title %#04x help %#04x\n",
               ifr, title_id, help_id );
        DBGC2_HDA ( ifr, dispaddr, formset, len );
}

References DBGC, DBGC2_HDA, EFI_IFR_FORM_SET_OP, efi_ifr_op(), _EFI_IFR_FORM_SET::Flags, _EFI_IFR_FORM_SET::FormSetTitle, guid, _EFI_IFR_FORM_SET::Guid, _EFI_IFR_FORM_SET::Header, _EFI_IFR_FORM_SET::Help, len, memcpy(), NULL, efi_ifr_builder::ops_len, _EFI_IFR_OP_HEADER::Scope, va_arg, va_end, and va_start.

Referenced by efi_snp_hii_package_list().

efi_ifr_get_op()

void efi_ifr_get_op	(	struct efi_ifr_builder *	ifr,
		unsigned int	varstore_id,
		unsigned int	varstore_info,
		unsigned int	varstore_type
	)

Add get opcode to IFR builder.

Parameters

ifr	IFR builder
varstore_id	Variable store identifier
varstore_info	Variable string identifier or offset
varstore_type	Variable type

Definition at line 244 of file efi_hii.c.

                                                                               {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_GET *get;

        /* Add opcode */
        get = efi_ifr_op ( ifr, EFI_IFR_GET_OP, sizeof ( *get ) );
        get->VarStoreId = varstore_id;
        get->VarStoreInfo.VarName = varstore_info;
        get->VarStoreType = varstore_type;

        DBGC ( ifr, "IFR %p get varstore %#04x:%#04x type %#02x\n",
               ifr, varstore_id, varstore_info, varstore_type );
        DBGC2_HDA ( ifr, dispaddr, get, sizeof ( *get ) );
}

References DBGC, DBGC2_HDA, EFI_IFR_GET_OP, efi_ifr_op(), efi_ifr_builder::ops_len, _EFI_IFR_GET::VarName, _EFI_IFR_GET::VarStoreId, _EFI_IFR_GET::VarStoreInfo, and _EFI_IFR_GET::VarStoreType.

efi_ifr_guid_class_op()

void efi_ifr_guid_class_op	(	struct efi_ifr_builder *	ifr,
		unsigned int	class
	)

Add GUID class opcode to IFR builder.

Parameters

ifr	IFR builder
class	Class

Definition at line 266 of file efi_hii.c.

                                                                               {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_GUID_CLASS *guid_class;

        /* Add opcode */
        guid_class = efi_ifr_op ( ifr, EFI_IFR_GUID_OP,
                                  sizeof ( *guid_class ) );
        if ( ! guid_class )
                return;
        memcpy ( &guid_class->Guid, &tiano_guid, sizeof ( guid_class->Guid ) );
        guid_class->ExtendOpCode = EFI_IFR_EXTEND_OP_CLASS;
        guid_class->Class = class;

        DBGC ( ifr, "IFR %p GUID class %#02x\n", ifr, class );
        DBGC2_HDA ( ifr, dispaddr, guid_class, sizeof ( *guid_class ) );
}

References _EFI_IFR_GUID_CLASS::Class, DBGC, DBGC2_HDA, EFI_IFR_EXTEND_OP_CLASS, EFI_IFR_GUID_OP, efi_ifr_op(), _EFI_IFR_GUID_CLASS::ExtendOpCode, _EFI_IFR_GUID_CLASS::Guid, memcpy(), efi_ifr_builder::ops_len, and tiano_guid.

Referenced by efi_snp_hii_package_list().

efi_ifr_guid_subclass_op()

void efi_ifr_guid_subclass_op	(	struct efi_ifr_builder *	ifr,
		unsigned int	subclass
	)

Add GUID subclass opcode to IFR builder.

Parameters

ifr	IFR builder
subclass	Subclass

Definition at line 289 of file efi_hii.c.

                                                        {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_GUID_SUBCLASS *guid_subclass;

        /* Add opcode */
        guid_subclass = efi_ifr_op ( ifr, EFI_IFR_GUID_OP,
                                     sizeof ( *guid_subclass ) );
        if ( ! guid_subclass )
                return;
        memcpy ( &guid_subclass->Guid, &tiano_guid,
                 sizeof ( guid_subclass->Guid ) );
        guid_subclass->ExtendOpCode = EFI_IFR_EXTEND_OP_SUBCLASS;
        guid_subclass->SubClass = subclass;

        DBGC ( ifr, "IFR %p GUID subclass %#02x\n", ifr, subclass );
        DBGC2_HDA ( ifr, dispaddr, guid_subclass, sizeof ( *guid_subclass ) );
}

References DBGC, DBGC2_HDA, EFI_IFR_EXTEND_OP_SUBCLASS, EFI_IFR_GUID_OP, efi_ifr_op(), _EFI_IFR_GUID_SUBCLASS::ExtendOpCode, _EFI_IFR_GUID_SUBCLASS::Guid, memcpy(), efi_ifr_builder::ops_len, _EFI_IFR_GUID_SUBCLASS::SubClass, and tiano_guid.

Referenced by efi_snp_hii_package_list().

efi_ifr_numeric_op()

void efi_ifr_numeric_op	(	struct efi_ifr_builder *	ifr,
		unsigned int	prompt_id,
		unsigned int	help_id,
		unsigned int	question_id,
		unsigned int	varstore_id,
		unsigned int	varstore_info,
		unsigned int	vflags,
		unsigned long	min_value,
		unsigned long	max_value,
		unsigned int	step,
		unsigned int	flags
	)

Add numeric opcode to IFR builder.

Parameters

ifr	IFR builder
prompt_id	Prompt string identifier
help_id	Help string identifier
question_id	Question identifier
varstore_id	Variable store identifier
varstore_info	Variable string identifier or offset
vflags	Variable flags
min_value	Minimum value
max_value	Maximum value
step	Step
flags	Flags

Definition at line 323 of file efi_hii.c.

                                               {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_NUMERIC *numeric;
        unsigned int size;

        /* Add opcode */
        numeric = efi_ifr_op ( ifr, EFI_IFR_NUMERIC_OP, sizeof ( *numeric ) );
        if ( ! numeric )
                return;
        numeric->Question.Header.Prompt = prompt_id;
        numeric->Question.Header.Help = help_id;
        numeric->Question.QuestionId = question_id;
        numeric->Question.VarStoreId = varstore_id;
        numeric->Question.VarStoreInfo.VarName = varstore_info;
        numeric->Question.Flags = vflags;
        size = ( flags & EFI_IFR_NUMERIC_SIZE );
        switch ( size ) {
        case EFI_IFR_NUMERIC_SIZE_1 :
                numeric->data.u8.MinValue = min_value;
                numeric->data.u8.MaxValue = max_value;
                numeric->data.u8.Step = step;
                break;
        case EFI_IFR_NUMERIC_SIZE_2 :
                numeric->data.u16.MinValue = min_value;
                numeric->data.u16.MaxValue = max_value;
                numeric->data.u16.Step = step;
                break;
        case EFI_IFR_NUMERIC_SIZE_4 :
                numeric->data.u32.MinValue = min_value;
                numeric->data.u32.MaxValue = max_value;
                numeric->data.u32.Step = step;
                break;
        case EFI_IFR_NUMERIC_SIZE_8 :
                numeric->data.u64.MinValue = min_value;
                numeric->data.u64.MaxValue = max_value;
                numeric->data.u64.Step = step;
                break;
        }

        DBGC ( ifr, "IFR %p numeric prompt %#04x help %#04x question %#04x "
               "varstore %#04x:%#04x\n", ifr, prompt_id, help_id, question_id,
               varstore_id, varstore_info );
        DBGC2_HDA ( ifr, dispaddr, numeric, sizeof ( *numeric ) );
}

References _EFI_IFR_NUMERIC::data, DBGC, DBGC2_HDA, EFI_IFR_NUMERIC_OP, EFI_IFR_NUMERIC_SIZE, EFI_IFR_NUMERIC_SIZE_1, EFI_IFR_NUMERIC_SIZE_2, EFI_IFR_NUMERIC_SIZE_4, EFI_IFR_NUMERIC_SIZE_8, efi_ifr_op(), flags, _EFI_IFR_QUESTION_HEADER::Flags, _EFI_IFR_QUESTION_HEADER::Header, _EFI_IFR_STATEMENT_HEADER::Help, MINMAXSTEP_DATA::MaxValue, MINMAXSTEP_DATA::MinValue, efi_ifr_builder::ops_len, _EFI_IFR_STATEMENT_HEADER::Prompt, _EFI_IFR_NUMERIC::Question, _EFI_IFR_QUESTION_HEADER::QuestionId, size, step(), MINMAXSTEP_DATA::Step, MINMAXSTEP_DATA::u16, MINMAXSTEP_DATA::u32, MINMAXSTEP_DATA::u64, MINMAXSTEP_DATA::u8, _EFI_IFR_QUESTION_HEADER::VarName, _EFI_IFR_QUESTION_HEADER::VarStoreId, and _EFI_IFR_QUESTION_HEADER::VarStoreInfo.

efi_ifr_string_op()

void efi_ifr_string_op	(	struct efi_ifr_builder *	ifr,
		unsigned int	prompt_id,
		unsigned int	help_id,
		unsigned int	question_id,
		unsigned int	varstore_id,
		unsigned int	varstore_info,
		unsigned int	vflags,
		unsigned int	min_size,
		unsigned int	max_size,
		unsigned int	flags
	)

Add string opcode to IFR builder.

Parameters

ifr	IFR builder
prompt_id	Prompt string identifier
help_id	Help string identifier
question_id	Question identifier
varstore_id	Variable store identifier
varstore_info	Variable string identifier or offset
vflags	Variable flags
min_size	Minimum size
max_size	Maximum size
flags	Flags

Definition at line 387 of file efi_hii.c.

                                                                     {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_STRING *string;

        /* Add opcode */
        string = efi_ifr_op ( ifr, EFI_IFR_STRING_OP, sizeof ( *string ) );
        if ( ! string )
                return;
        string->Question.Header.Prompt = prompt_id;
        string->Question.Header.Help = help_id;
        string->Question.QuestionId = question_id;
        string->Question.VarStoreId = varstore_id;
        string->Question.VarStoreInfo.VarName = varstore_info;
        string->Question.Flags = vflags;
        string->MinSize = min_size;
        string->MaxSize = max_size;
        string->Flags = flags;

        DBGC ( ifr, "IFR %p string prompt %#04x help %#04x question %#04x "
               "varstore %#04x:%#04x\n", ifr, prompt_id, help_id, question_id,
               varstore_id, varstore_info );
        DBGC2_HDA ( ifr, dispaddr, string, sizeof ( *string ) );
}

References DBGC, DBGC2_HDA, efi_ifr_op(), EFI_IFR_STRING_OP, flags, efi_ifr_builder::ops_len, and string.

Referenced by efi_snp_hii_questions().

efi_ifr_suppress_if_op()

void efi_ifr_suppress_if_op

(

struct efi_ifr_builder *

ifr

)

Add suppress-if opcode to IFR builder.

Parameters

ifr	IFR builder

Definition at line 420 of file efi_hii.c.

                                                            {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_SUPPRESS_IF *suppress_if;

        /* Add opcode */
        suppress_if = efi_ifr_op ( ifr, EFI_IFR_SUPPRESS_IF_OP,
                                   sizeof ( *suppress_if ) );
        suppress_if->Header.Scope = 1;

        DBGC ( ifr, "IFR %p suppress-if\n", ifr );
        DBGC2_HDA ( ifr, dispaddr, suppress_if, sizeof ( *suppress_if ) );
}

References DBGC, DBGC2_HDA, efi_ifr_op(), EFI_IFR_SUPPRESS_IF_OP, _EFI_IFR_SUPPRESS_IF::Header, efi_ifr_builder::ops_len, and _EFI_IFR_OP_HEADER::Scope.

efi_ifr_text_op()

void efi_ifr_text_op	(	struct efi_ifr_builder *	ifr,
		unsigned int	prompt_id,
		unsigned int	help_id,
		unsigned int	text_id
	)

Add text opcode to IFR builder.

Parameters

ifr	IFR builder
prompt_id	Prompt string identifier
help_id	Help string identifier
text_id	Text string identifier

Definition at line 441 of file efi_hii.c.

                                                                    {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_TEXT *text;

        /* Add opcode */
        text = efi_ifr_op ( ifr, EFI_IFR_TEXT_OP, sizeof ( *text ) );
        if ( ! text )
                return;
        text->Statement.Prompt = prompt_id;
        text->Statement.Help = help_id;
        text->TextTwo = text_id;

        DBGC ( ifr, "IFR %p text prompt %#04x help %#04x text %#04x\n",
               ifr, prompt_id, help_id, text_id );
        DBGC2_HDA ( ifr, dispaddr, text, sizeof ( *text ) );
}

References DBGC, DBGC2_HDA, efi_ifr_op(), EFI_IFR_TEXT_OP, _EFI_IFR_STATEMENT_HEADER::Help, efi_ifr_builder::ops_len, _EFI_IFR_STATEMENT_HEADER::Prompt, _EFI_IFR_TEXT::Statement, and _EFI_IFR_TEXT::TextTwo.

Referenced by efi_snp_hii_package_list().

efi_ifr_true_op()

void efi_ifr_true_op

(

struct efi_ifr_builder *

ifr

)

Add true opcode to IFR builder.

Parameters

ifr	IFR builder

Definition at line 464 of file efi_hii.c.

                                                     {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_TRUE *op;

        /* Add opcode */
        op = efi_ifr_op ( ifr, EFI_IFR_TRUE_OP, sizeof ( *op ) );

        DBGC ( ifr, "IFR %p true\n", ifr );
        DBGC2_HDA ( ifr, dispaddr, op, sizeof ( *op ) );
}

References DBGC, DBGC2_HDA, efi_ifr_op(), EFI_IFR_TRUE_OP, op, and efi_ifr_builder::ops_len.

efi_ifr_varstore_name_value_op()

unsigned int efi_ifr_varstore_name_value_op	(	struct efi_ifr_builder *	ifr,
		const EFI_GUID *	guid
	)

Add name/value store opcode to IFR builder.

Parameters

ifr	IFR builder
guid	GUID

Return values

varstore_id

Variable store identifier, or 0 on failure

Definition at line 482 of file efi_hii.c.

                                                                     {
        size_t dispaddr = ifr->ops_len;
        EFI_IFR_VARSTORE_NAME_VALUE *varstore;

        /* Add opcode */
        varstore = efi_ifr_op ( ifr, EFI_IFR_VARSTORE_NAME_VALUE_OP,
                                sizeof ( *varstore ) );
        if ( ! varstore )
                return 0;
        varstore->VarStoreId = ++(ifr->varstore_id);
        memcpy ( &varstore->Guid, guid, sizeof ( varstore->Guid ) );

        DBGC ( ifr, "IFR %p name/value store %#04x\n",
               ifr, varstore->VarStoreId );
        DBGC2_HDA ( ifr, dispaddr, varstore, sizeof ( *varstore ) );
        return varstore->VarStoreId;
}

References DBGC, DBGC2_HDA, efi_ifr_op(), EFI_IFR_VARSTORE_NAME_VALUE_OP, guid, _EFI_IFR_VARSTORE_NAME_VALUE::Guid, memcpy(), efi_ifr_builder::ops_len, efi_ifr_builder::varstore_id, and _EFI_IFR_VARSTORE_NAME_VALUE::VarStoreId.

Referenced by efi_snp_hii_package_list().

efi_ifr_free()

void efi_ifr_free

(

struct efi_ifr_builder *

ifr

)

Free memory used by IFR builder.

Parameters

ifr	IFR builder

Definition at line 506 of file efi_hii.c.

                                                  {

        free ( ifr->ops );
        free ( ifr->strings );
        memset ( ifr, 0, sizeof ( *ifr ) );
}

References free, memset(), efi_ifr_builder::ops, and efi_ifr_builder::strings.

Referenced by efi_snp_hii_package_list().

efi_ifr_package()

EFI_HII_PACKAGE_LIST_HEADER* efi_ifr_package	(	struct efi_ifr_builder *	ifr,
		const EFI_GUID *	guid,
		const char *	language,
		unsigned int	language_id
	)

Construct package list from IFR builder.

Parameters

ifr	IFR builder
guid	Package GUID
language	Language
language_id	Language string ID

Return values

package

Package list, or NULL

The package list is allocated using malloc(), and must eventually be freed by the caller. (The caller must also call efi_ifr_free() to free the temporary storage used during construction.)

Definition at line 526 of file efi_hii.c.

                                                                           {
        struct {
                EFI_HII_PACKAGE_LIST_HEADER header;
                struct {
                        EFI_HII_PACKAGE_HEADER header;
                        uint8_t data[ifr->ops_len];
                } __attribute__ (( packed )) ops;
                struct {
                        union {
                                EFI_HII_STRING_PACKAGE_HDR header;
                                uint8_t pad[offsetof(EFI_HII_STRING_PACKAGE_HDR,
                                                     Language) +
                                            strlen ( language ) + 1 /* NUL */ ];
                        } __attribute__ (( packed )) header;
                        uint8_t data[ifr->strings_len];
                        EFI_HII_STRING_BLOCK end;
                } __attribute__ (( packed )) strings;
                EFI_HII_PACKAGE_HEADER end;
        } __attribute__ (( packed )) *package;

        /* Fail if any previous allocation failed */
        if ( ifr->failed )
                return NULL;

        /* Allocate package list */
        package = zalloc ( sizeof ( *package ) );
        if ( ! package )
                return NULL;

        /* Populate package list */
        package->header.PackageLength = sizeof ( *package );
        memcpy ( &package->header.PackageListGuid, guid,
                 sizeof ( package->header.PackageListGuid ) );
        package->ops.header.Length = sizeof ( package->ops );
        package->ops.header.Type = EFI_HII_PACKAGE_FORMS;
        memcpy ( package->ops.data, ifr->ops, sizeof ( package->ops.data ) );
        package->strings.header.header.Header.Length =
                sizeof ( package->strings );
        package->strings.header.header.Header.Type =
                EFI_HII_PACKAGE_STRINGS;
        package->strings.header.header.HdrSize =
                sizeof ( package->strings.header );
        package->strings.header.header.StringInfoOffset =
                sizeof ( package->strings.header );
        package->strings.header.header.LanguageName = language_id;
        strcpy ( package->strings.header.header.Language, language );
        memcpy ( package->strings.data, ifr->strings,
                 sizeof ( package->strings.data ) );
        package->strings.end.BlockType = EFI_HII_SIBT_END;
        package->end.Type = EFI_HII_PACKAGE_END;
        package->end.Length = sizeof ( package->end );

        return &package->header;
}

References __attribute__, data, EFI_HII_PACKAGE_END, EFI_HII_PACKAGE_FORMS, EFI_HII_PACKAGE_STRINGS, EFI_HII_SIBT_END, end, efi_ifr_builder::failed, guid, header, memcpy(), NULL, offsetof, efi_ifr_builder::ops, efi_ifr_builder::ops_len, pad, strcpy(), efi_ifr_builder::strings, efi_ifr_builder::strings_len, and strlen().