loaded into option ROMs. The image loader will load the EBC image, perform standard relocations,\r
and invoke the CreateThunk() service to create a thunk for the EBC image's entry point. The\r
image can then be run using the standard EFI start image services.\r
-\r
- @param CreateThunk \r
- Creates a thunk for an EBC image entry point or protocol service,\r
- and returns a pointer to the thunk. \r
- \r
- @param UnloadImage \r
- Called when an EBC image is unloaded to allow the interpreter to\r
- perform any cleanup associated with the image execution. \r
- \r
- @param RegisterICacheFlush\r
- Called to register a callback function that the EBC interpreter can\r
- call to flush the processor instruction cache after creating thunks.\r
- \r
- @param GetVersion \r
- Called to get the version of the associated EBC interpreter.\r
-\r
**/\r
struct _EFI_EBC_PROTOCOL {\r
EFI_EBC_CREATE_THUNK CreateThunk;\r
EDID information retrieved from the EFI_EDID_OVERRIDE_PROTOCOL if an override is\r
available, or an identical copy of the EDID information from the\r
EFI_EDID_DISCOVERED_PROTOCOL if no overrides are available.\r
-\r
- @param SizeOfEdid \r
- The size, in bytes, of the Edid buffer. 0 if no EDID information\r
- is available from the video output device. Otherwise, it must be a\r
- minimum of 128 bytes.\r
- \r
- @param Edid \r
- A pointer to a read-only array of bytes that contains the EDID\r
- information for an active video output device. This pointer is\r
- NULL if no EDID information is available for the video output\r
- device. The minimum size of a valid Edid buffer is 128 bytes.\r
- EDID information is defined in the E-DID EEPROM\r
- specification published by VESA (www.vesa.org).\r
**/\r
typedef struct {\r
+ ///\r
+ /// The size, in bytes, of the Edid buffer. 0 if no EDID information\r
+ /// is available from the video output device. Otherwise, it must be a\r
+ /// minimum of 128 bytes.\r
+ ///\r
UINT32 SizeOfEdid;\r
+\r
+ ///\r
+ /// A pointer to a read-only array of bytes that contains the EDID\r
+ /// information for an active video output device. This pointer is\r
+ /// NULL if no EDID information is available for the video output\r
+ /// device. The minimum size of a valid Edid buffer is 128 bytes.\r
+ /// EDID information is defined in the E-DID EEPROM\r
+ /// specification published by VESA (www.vesa.org).\r
+ ///\r
UINT8 *Edid;\r
} EFI_EDID_ACTIVE_PROTOCOL;\r
\r
/**\r
@par Protocol Description:\r
This protocol contains the EDID information retrieved from a video output device.\r
-\r
- @param SizeOfEdid \r
- The size, in bytes, of the Edid buffer. 0 if no EDID information\r
- is available from the video output device. Otherwise, it must be a\r
- minimum of 128 bytes.\r
- \r
- @param Edid \r
- A pointer to a read-only array of bytes that contains the EDID\r
- information for an active video output device. This pointer is\r
- NULL if no EDID information is available for the video output\r
- device. The minimum size of a valid Edid buffer is 128 bytes.\r
- EDID information is defined in the E-DID EEPROM\r
- specification published by VESA (www.vesa.org).\r
**/\r
typedef struct {\r
+ ///\r
+ /// The size, in bytes, of the Edid buffer. 0 if no EDID information\r
+ /// is available from the video output device. Otherwise, it must be a\r
+ /// minimum of 128 bytes.\r
+ ///\r
UINT32 SizeOfEdid;\r
+ \r
+ ///\r
+ /// A pointer to a read-only array of bytes that contains the EDID\r
+ /// information for an active video output device. This pointer is\r
+ /// NULL if no EDID information is available for the video output\r
+ /// device. The minimum size of a valid Edid buffer is 128 bytes.\r
+ /// EDID information is defined in the E-DID EEPROM\r
+ /// specification published by VESA (www.vesa.org).\r
+ /// \r
UINT8 *Edid;\r
} EFI_EDID_DISCOVERED_PROTOCOL;\r
\r
@par Protocol Description:\r
This protocol is produced by the platform to allow the platform to provide \r
EDID information to the producer of the Graphics Output protocol.\r
-\r
- @param GetEdid \r
- Returns EDID values and attributes that the Video BIOS must use. \r
-\r
**/\r
struct _EFI_EDID_OVERRIDE_PROTOCOL {\r
+ ///\r
+ /// Returns EDID values and attributes that the Video BIOS must use. \r
+ ///\r
EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID GetEdid;\r
};\r
\r
for example. This level of firmware volume implementation\r
detail is not visible to the consumers of the Firmware Volume\r
Protocol.\r
-\r
- @param GetVolumeAttributes Retrieves volume capabilities\r
- and current settings. \r
-\r
- @param SetVolumeAttributes Modifies the current settings of\r
- the firmware volume.\r
-\r
- @param ReadFile Reads an entire file from the firmware\r
- volume. \r
-\r
- @param ReadSection Reads a single section from a file into\r
- a buffer.\r
-\r
- @param WriteFile Writes an entire file into the firmware\r
- volume. \r
-\r
- @param GetNextFile Provides service to allow searching the\r
- firmware volume.\r
-\r
- @param KeySize Data field that indicates the size in bytes\r
- of the Key input buffer for the\r
- GetNextFile() API.\r
-\r
- @param ParentHandle Handle of the parent firmware volume.\r
-\r
- @param GetInfo Gets the requested file or volume\r
- information. \r
-\r
- @param SetInfo Sets the requested file information.\r
**/\r
struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {\r
EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;\r
EFI_FV_READ_SECTION ReadSection;\r
EFI_FV_WRITE_FILE WriteFile;\r
EFI_FV_GET_NEXT_FILE GetNextFile;\r
+ \r
+ ///\r
+ /// Data field that indicates the size in bytes\r
+ /// of the Key input buffer for the\r
+ /// GetNextFile() API. \r
+ ///\r
UINT32 KeySize;\r
+ \r
+ ///\r
+ /// Handle of the parent firmware volume.\r
+ ///\r
EFI_HANDLE ParentHandle;\r
EFI_FV_GET_INFO GetInfo;\r
EFI_FV_SET_INFO SetInfo;\r
\r
\r
\r
-//\r
-// EFI_LBA_LIST_TERMINATOR\r
-//\r
+///\r
+/// EFI_LBA_LIST_TERMINATOR\r
+///\r
#define EFI_LBA_LIST_TERMINATOR 0xFFFFFFFFFFFFFFFFULL\r
\r
\r
...\r
);\r
\r
-\r
-\r
/**\r
@par Protocol Description:\r
The Firmware Volume Block Protocol is the low-level interface\r
Firmware Volume Protocol abstracts the file system that is\r
used to format the firmware volume and the hardware\r
device-hardening features that may be present.\r
-\r
-\r
- @param GetPhysicalAddress Retrieves the memory-mapped\r
- address of the firmware volume.\r
-\r
- @param GetBlockSize Retrieves the size for a specific block.\r
- Also returns the number of consecutive\r
- similarly sized blocks.\r
-\r
- @param Read Reads n bytes into a buffer from the firmware\r
- volume hardware.\r
-\r
- @param Write Writes n bytes from a buffer into the firmware\r
- volume hardware.\r
-\r
- @param EraseBlocks Erases specified block(s) and sets all\r
- values as indicated by the\r
- EFI_FVB_ERASE_POLARITY bit. See the\r
- EraseBlocks() function description. Type\r
- EFI_FVB_ERASE_POLARITY is defined in\r
- EFI_FIRMWARE_VOLUME_HEADER. ParentHandle\r
- Handle of the parent firmware volume.\r
- \r
- @param GetAttributes Retrieves the current volume attributes.\r
- \r
- @param SetAttributes Sets the current volume attributes.\r
-\r
**/\r
struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {\r
EFI_FVB_GET_ATTRIBUTES GetAttributes;\r
EFI_FVB_READ Read;\r
EFI_FVB_WRITE Write;\r
EFI_FVB_ERASE_BLOCKS EraseBlocks;\r
+ ///\r
+ /// Handle of the parent firmware volume.\r
+ /// \r
EFI_HANDLE ParentHandle;\r
};\r
\r
@par Protocol Description: \r
This interface will allow the caller to direct the configuration \r
driver to use either the HII database or use the passed-in packet of data.\r
-\r
- @param SendForm Browse the specified configuration forms.\r
-\r
- @param BrowserCallback Routine used to expose internal\r
- configuration state of the browser.\r
- This is primarily used by callback\r
- handler routines which were called by\r
- the browser and in-turn need to get\r
- additional information from the\r
- browser itself.\r
-\r
**/\r
struct _EFI_FORM_BROWSER2_PROTOCOL {\r
EFI_SEND_FORM2 SendForm;\r
EFI_BROWSER_CALLBACK2 BrowserCallback;\r
} ;\r
\r
-\r
extern EFI_GUID gEfiFormBrowser2ProtocolGuid;\r
\r
#endif\r
UINT32 Raw;\r
} EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION;\r
\r
+///\r
+/// actions for BltOperations\r
+///\r
typedef enum {\r
+ ///\r
+ /// Write data from the BltBuffer pixel (SourceX, SourceY) \r
+ /// directly to every pixel of the video display rectangle \r
+ /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
+ /// Only one pixel will be used from the BltBuffer. Delta is NOT used. \r
+ ///\r
EfiBltVideoFill,\r
+ \r
+ ///\r
+ /// Read data from the video display rectangle \r
+ /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in \r
+ /// the BltBuffer rectangle (DestinationX, DestinationY ) \r
+ /// (DestinationX + Width, DestinationY + Height). If DestinationX or \r
+ /// DestinationY is not zero then Delta must be set to the length in bytes \r
+ /// of a row in the BltBuffer. \r
+ ///\r
EfiBltVideoToBltBuffer,\r
+ \r
+ ///\r
+ /// Write data from the BltBuffer rectangle \r
+ /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the \r
+ /// video display rectangle (DestinationX, DestinationY) \r
+ /// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is \r
+ /// not zero then Delta must be set to the length in bytes of a row in the \r
+ /// BltBuffer.\r
+ ///\r
EfiBltBufferToVideo, \r
+ \r
+ ///\r
+ /// Copy from the video display rectangle (SourceX, SourceY)\r
+ /// (SourceX + Width, SourceY + Height) .to the video display rectangle \r
+ /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
+ /// The BltBuffer and Delta are not used in this mode.\r
+ /// EfiBltVideoToVideo,\r
+ ///\r
EfiBltVideoToVideo,\r
+ \r
EfiGraphicsOutputBltOperationMax\r
} EFI_GRAPHICS_OUTPUT_BLT_OPERATION;\r
\r
/**\r
- The following table defines actions for BltOperations:\r
-\r
- <B>EfiBltVideoFill</B> - Write data from the BltBuffer pixel (SourceX, SourceY) \r
- directly to every pixel of the video display rectangle \r
- (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
- Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
-\r
- <B>EfiBltVideoToBltBuffer</B> - Read data from the video display rectangle \r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in \r
- the BltBuffer rectangle (DestinationX, DestinationY ) \r
- (DestinationX + Width, DestinationY + Height). If DestinationX or \r
- DestinationY is not zero then Delta must be set to the length in bytes \r
- of a row in the BltBuffer.\r
-\r
- <B>EfiBltBufferToVideo</B> - Write data from the BltBuffer rectangle \r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the \r
- video display rectangle (DestinationX, DestinationY) \r
- (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is \r
- not zero then Delta must be set to the length in bytes of a row in the \r
- BltBuffer.\r
-\r
- <B>EfiBltVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)\r
- (SourceX + Width, SourceY + Height) .to the video display rectangle \r
- (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
- The BltBuffer and Delta are not used in this mode.\r
-\r
+ Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.\r
+ \r
@param This Protocol instance pointer.\r
@param BltBuffer Buffer containing data to blit into video buffer. This\r
buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
Provides a basic abstraction to set video modes and copy pixels to and from \r
the graphics controller's frame buffer. The linear address of the hardware \r
frame buffer is also exposed so software can write directly to the video hardware.\r
-\r
- @param QueryMode\r
- Returns information for an available graphics mode that the graphics device \r
- and the set of active video output devices supports.\r
- \r
- @param SetMode \r
- Set the video device into the specified mode and clears the visible portions \r
- of the output display to black.\r
- \r
- @param Blt\r
- Software abstraction to draw on the video device's frame buffer.\r
- \r
- @param Mode\r
- Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.\r
-\r
**/\r
struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {\r
EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE QueryMode;\r
projects / mirror_edk2.git / commitdiff