EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Typedefs | Functions | Variables

EdkCompatibilityPkg/Foundation/Efi/Protocol/AuthenticationInfo/AuthenticationInfo.h File Reference

Go to the source code of this file.

Data Structures

struct  _EFI_AUTHENTICATION_INFO_PROTOCOL

Defines

#define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID

Typedefs

typedef IN EFI_HANDLE ControllerHandle
typedef IN EFI_HANDLE OUT VOID ** Buffer

Functions

 EFI_FORWARD_DECLARATION (EFI_AUTHENTICATION_INFO_PROTOCOL)
typedef EFI_STATUS (EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_GET)(IN EFI_AUTHENTICATION_INFO_PROTOCOL *This

Variables

EFI_GUID gEfiAuthenticationInfoProtocolGuid

Define Documentation

#define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID
Value:
{ \
    0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7} \
  }

Definition at line 30 of file AuthenticationInfo.h.


Typedef Documentation

typedef IN EFI_HANDLE IN VOID* Buffer

Definition at line 41 of file AuthenticationInfo.h.

Definition at line 41 of file AuthenticationInfo.h.


Function Documentation

EFI_FORWARD_DECLARATION ( EFI_AUTHENTICATION_INFO_PROTOCOL  )
typedef EFI_STATUS ( EFIAPI *  EFI_AUTHENTICATION_INFO_PROTOCOL_GET)

This service of the EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into permanent memory.

Parameters:
PeiServicesPointer to the PEI Services Table.
TemporaryMemoryBaseSource Address in temporary memory from which the SEC or PEIM will copy the Temporary RAM contents.
PermanentMemoryBaseDestination Address in permanent memory into which the SEC or PEIM will copy the Temporary RAM contents.
CopySizeAmount of memory to migrate from temporary to permanent memory.
Return values:
EFI_SUCCESSThe data was successfully returned.
EFI_INVALID_PARAMETERPermanentMemoryBase + CopySize > TemporaryMemoryBase when TemporaryMemoryBase > PermanentMemoryBase.

Return the current video mode information.

Parameters:
ThisProtocol instance pointer.
ModeNumberThe mode number to return information on.
SizeOfInfoA pointer to the size, in bytes, of the Info buffer.
InfoA pointer to callee allocated buffer that returns information about ModeNumber.
Return values:
EFI_SUCCESSMode information returned.
EFI_BUFFER_TOO_SMALLThe Info buffer was too small.
EFI_DEVICE_ERRORA hardware error occurred trying to retrieve the video mode.
EFI_NOT_STARTEDVideo display is not initialized. Call SetMode ()
EFI_INVALID_PARAMETEROne of the input args was NULL.

Return the current video mode information.

Parameters:
ThisProtocol instance pointer.
ModeNumberThe mode number to be set.
Return values:
EFI_SUCCESSGraphics mode was changed.
EFI_DEVICE_ERRORThe device had an error and could not complete the request.
EFI_UNSUPPORTEDModeNumber is not supported by this device.

The following table defines actions for BltOperations:

EfiBltVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY) directly to every pixel of the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). Only one pixel will be used from the BltBuffer. Delta is NOT used.

EfiBltVideoToBltBuffer - Read data from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in the BltBuffer rectangle (DestinationX, DestinationY ) (DestinationX + Width, DestinationY + Height). If DestinationX or DestinationY is not zero then Delta must be set to the length in bytes of a row in the BltBuffer.

EfiBltBufferToVideo - Write data from the BltBuffer rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is not zero then Delta must be set to the length in bytes of a row in the BltBuffer.

EfiBltVideoToVideo - Copy from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) .to the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). The BltBuffer and Delta are not used in this mode.

Parameters:
ThisProtocol instance pointer.
BltBufferBuffer containing data to blit into video buffer. This buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
BltOperationOperation to perform on BlitBuffer and video memory
SourceXX coordinate of source for the BltBuffer.
SourceYY coordinate of source for the BltBuffer.
DestinationXX coordinate of destination for the BltBuffer.
DestinationYY coordinate of destination for the BltBuffer.
WidthWidth of rectangle in BltBuffer in pixels.
HeightHight of rectangle in BltBuffer in pixels.
DeltaOPTIONAL
Return values:
EFI_SUCCESSThe Blt operation completed.
EFI_INVALID_PARAMETERBltOperation is not valid.
EFI_DEVICE_ERRORA hardware error occured writting to the video buffer.

Registers the various packs that are passed in via the Packages parameter.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
PackagesA pointer to an EFI_HII_PACKAGES package instance.
HandleA pointer to the EFI_HII_HANDLE instance.
Return values:
EFI_SUCCESSData was extracted from Packages, the database was updated with the data, and Handle returned successfully.
EFI_INVALID_PARAMETERThe content of Packages was invalid.

Removes a package from the HII database.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleThe handle that was registered to the data that is requested for removal.
Return values:
EFI_SUCCESSThe data associated with the Handle was removed from the HII database.
EFI_INVALID_PARAMETERThe Handle was not valid.

Determines the handles that are currently active in the database.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleBufferLengthOn input, a pointer to the length of the handle buffer. On output, the length of the handle buffer that is required for the handles found.
HandleAn array of EFI_HII_HANDLE instances returned.
Return values:
EFI_SUCCESSHandle was updated successfully.
EFI_BUFFER_TOO_SMALLThe HandleBufferLength parameter indicates that Handle is too small to support the number of handles.

Exports the contents of the database into a buffer.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleAn EFI_HII_HANDLE that corresponds to the desired handle to export. If the value is 0, the entire database will be exported. In either case, the data will be exported in a format described by the structure definition of EFI_HII_EXPORT_TABLE.
BufferSizeOn input, a pointer to the length of the buffer. On output, the length of the buffer that is required for the export data.
BufferA pointer to a buffer that will contain the results of the export function.
Return values:
EFI_SUCCESSThe buffer was successfully filled with BufferSize amount of data.
EFI_BUFFER_TOO_SMALLThe value in BufferSize was too small to contain the export data.

Remove any new strings that were added after the initial string export for this handle.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleThe handle on which the string resides.
Return values:
EFI_SUCCESSRemove strings from the handle successfully.
EFI_INVALID_PARAMETERThe Handle was unknown.

Tests if all of the characters in a string have corresponding font characters.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
StringToTestA pointer to a Unicode string.
FirstMissingA pointer to an index into the string. On input, the index of the first character in the StringToTest to examine. On exit, the index of the first character encountered for which a glyph is unavailable. If all glyphs in the string are available, the index is the index of the terminator of the string.
GlyphBufferSizeA pointer to a value. On output, if the function returns EFI_SUCCESS, it contains the amount of memory that is required to store the string's glyph equivalent.
Return values:
EFI_SUCCESSAll glyphs are available. Note that an empty string always returns this value.
EFI_NOT_FOUNDA glyph was not found for a character.

Translates a Unicode character into the corresponding font glyph.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
SourceA pointer to a Unicode string.
IndexOn input, the offset into the string from which to fetch the character.On successful completion, the index is updated to the first character past the character(s) making up the just extracted glyph.
GlyphBufferPointer to an array where the glyphs corresponding to the characters in the source may be stored. GlyphBuffer is assumed to be wide enough to accept a wide glyph character.
BitWidthIf EFI_SUCCESS was returned, the UINT16 pointed to by this value is filled with the length of the glyph in pixels. It is unchanged if the call was unsuccessful.
InternalStatusThe cell pointed to by this parameter must be initialized to zero prior to invoking the call the first time for any string.
Return values:
EFI_SUCCESSIt worked.
EFI_NOT_FOUNDA glyph for a character was not found.

Translates a glyph into the format required for input to the Universal Graphics Adapter (UGA) Block Transfer (BLT) routines.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
GlyphBufferA pointer to the buffer that contains glyph data.
ForegroundThe foreground setting requested to be used for the generated BltBuffer data.
BackgroundThe background setting requested to be used for the generated BltBuffer data.
CountThe entry in the BltBuffer upon which to act.
WidthThe width in bits of the glyph being converted.
HeightThe height in bits of the glyph being converted
BltBufferA pointer to the buffer that contains the data that is ready to be used by the UGA BLT routines.
Return values:
EFI_SUCCESSIt worked.
EFI_NOT_FOUNDA glyph for a character was not found.

Allows a new string to be added to an already existing string package.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
Pointerto a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the language in which the string is translated.
HandleThe handle of the language pack to which the string is to be added.
ReferenceThe identifier of the string to be added. If the reference value is zero, then the string will be assigned a new identifier on that handle for the language specified. Otherwise, the string will be updated with the NewString Value.
NewStringThe string to be added.
Return values:
EFI_SUCCESSThe string was effectively registered.
EFI_INVALID_PARAMETERThe Handle was unknown.

Allows a program to determine the primary languages that are supported on a given handle.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleThe handle on which the strings reside.
LanguageStringA string allocated by GetPrimaryLanguages() that contains a list of all primary languages registered on the handle.
Return values:
EFI_SUCCESSLanguageString was correctly returned.
EFI_INVALID_PARAMETERThe Handle was unknown.

Allows a program to determine which secondary languages are supported on a given handle for a given primary language.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleThe handle on which the strings reside.
PrimaryLanguagePointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the primary language.
LanguageStringA string allocated by GetSecondaryLanguages() containing a list of all secondary languages registered on the handle.
Return values:
EFI_SUCCESSLanguageString was correctly returned.
EFI_INVALID_PARAMETERThe Handle was unknown.

Extracts a string from a package already registered with the EFI HII database.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleThe handle on which the string resides.
TokenThe string token assigned to the string.
RawIf TRUE, the string is returned unedited in the internal storage format described above. If false, the string returned is edited by replacing <cr> with <space> and by removing special characters such as the <wide> prefix.
LanguageStringPointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the language to print. If the LanguageString is empty (starts with a NULL), the default system language will be used to determine the language.
BufferLengthLength of the StringBuffer.
StringBufferThe buffer designed to receive the characters in the string.
Return values:
EFI_SUCCESSStringBuffer is filled with a NULL-terminated string.
EFI_INVALID_PARAMETERThe handle or string token is unknown.
EFI_BUFFER_TOO_SMALLThe buffer provided was not large enough to allow the entire string to be stored.

Allows a program to extract a part of a string of not more than a given width.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleThe handle on which the string resides.
TokenThe string token assigned to the string.
IndexOn input, the offset into the string where the line is to start. On output, the index is updated to point to beyond the last character returned in the call.
LineWidthThe maximum width of the line in units of narrow glyphs.
LanguageStringPointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating the language to print.
BufferLengthPointer to the length of the StringBuffer.
StringBufferThe buffer designed to receive the characters in the string.
Return values:
EFI_SUCCESSStringBuffer filled with characters that will fit on the line.
EFI_NOT_FOUNDThe font glyph for at least one of the characters in the string is not in the font database.
EFI_BUFFER_TOO_SMALLThe buffer provided was not large enough to allow the entire string to be stored.

Allows a program to extract a form or form package that has previously been registered with the HII database.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleHandle on which the form resides.
FormIdThe ID of the form to return. If the ID is zero, the entire form package is returned.
BufferLengthOn input, the length of the Buffer. On output, the length of the returned buffer,
BufferThe buffer designed to receive the form(s).
Return values:
EFI_SUCCESSBuffer filled with the requested forms. BufferLength was updated.
EFI_INVALID_PARAMETERThe handle is unknown.
EFI_NOT_FOUNDA form on the requested handle cannot be found with the requested FormId.
EFI_BUFFER_TOO_SMALLThe buffer provided was not large enough to allow the form to be stored.

Extracts the defaults that are associated with a given handle in the HII database.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleThe HII handle from which will have default data retrieved.
DefaultMaskThe mask used to specify some type of default override when extracting the default image data.
VariablePackListA indirect pointer to the first entry of a link list with type EFI_HII_VARIABLE_PACK_LIST.
Return values:
EFI_SUCCESSThe VariablePackList was populated with the appropriate default setting data.
EFI_NOT_FOUNDThe IFR does not have any explicit or default map(s).
EFI_INVALID_PARAMETERThe HII database entry associated with Handle contain invalid data.

Allows the caller to update a form or form package that has previously been registered with the EFI HII database.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
HandleHandle of the package where the form to be updated resides.
LabelThe label inside the form package where the update is to take place.
AddDataIf TRUE, adding data at a given Label; otherwise, if FALSE, removing data at a given Label.
DataThe buffer containing the new tags to insert after the Label
Return values:
EFI_SUCCESSThe form was updated with the new tags.
EFI_INVALID_PARAMETERThe buffer for the buffer length does not contain an integral number of tags.
EFI_NOT_FOUNDThe Handle, Label, or FormId was not found.

Retrieves the current keyboard layout.

Parameters:
ThisA pointer to the EFI_HII_PROTOCOL instance.
DescriptorCountA pointer to the number of Descriptor entries being described in the keyboard layout being retrieved.
DescriptorA pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR entries. Each entry will reflect the definition of a specific physical key.
Return values:
EFI_SUCCESSThe keyboard layout was retrieved successfully.

Return the current video mode information.

Parameters:
ThisProtocol instance pointer.
HorizontalResolutionCurrent video horizontal resolution in pixels
VerticalResolutionCurrent video vertical resolution in pixels
ColorDepthCurrent video color depth in bits per pixel
RefreshRateCurrent video refresh rate in Hz.
Return values:
EFI_SUCCESSMode information returned.
EFI_NOT_STARTEDVideo display is not initialized. Call SetMode ()
EFI_INVALID_PARAMETEROne of the input args was NULL.

Return the current video mode information.

Parameters:
ThisProtocol instance pointer.
HorizontalResolutionCurrent video horizontal resolution in pixels
VerticalResolutionCurrent video vertical resolution in pixels
ColorDepthCurrent video color depth in bits per pixel
RefreshRateCurrent video refresh rate in Hz.
Return values:
EFI_SUCCESSMode information returned.
EFI_NOT_STARTEDVideo display is not initialized. Call SetMode ()

Type specifying a pointer to a function to perform an UGA Blt operation.

The following table defines actions for BltOperations:

EfiUgaVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY) directly to every pixel of the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). Only one pixel will be used from the BltBuffer. Delta is NOT used.

EfiUgaVideoToBltBuffer - Read data from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in the BltBuffer rectangle (DestinationX, DestinationY ) (DestinationX + Width, DestinationY + Height). If DestinationX or DestinationY is not zero then Delta must be set to the length in bytes of a row in the BltBuffer.

EfiUgaBltBufferToVideo - Write data from the BltBuffer rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is not zero then Delta must be set to the length in bytes of a row in the BltBuffer.

EfiUgaVideoToVideo - Copy from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) .to the video display rectangle (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). The BltBuffer and Delta are not used in this mode.

Parameters:
[in]This- Protocol instance pointer.
[in]BltBuffer- Buffer containing data to blit into video buffer. This buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)
[in]BltOperation- Operation to perform on BlitBuffer and video memory
[in]SourceX- X coordinate of source for the BltBuffer.
[in]SourceY- Y coordinate of source for the BltBuffer.
[in]DestinationX- X coordinate of destination for the BltBuffer.
[in]DestinationY- Y coordinate of destination for the BltBuffer.
[in]Width- Width of rectangle in BltBuffer in pixels.
[in]Height- Hight of rectangle in BltBuffer in pixels.
[in]Delta- OPTIONAL
Return values:
EFI_SUCCESS- The Blt operation completed.
EFI_INVALID_PARAMETER- BltOperation is not valid.
EFI_DEVICE_ERROR- A hardware error occured writting to the video buffer.

--


Variable Documentation

Definition at line 27 of file AuthenticationInfo.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines