1, Fix doxygen comment for structure and macro

2, Add missing macro - EfiBltVideoToVideo

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6094 6f19259b-4bc3-4df7-8a09-765794883524

8 files changed, 85 insertions, 160 deletions

diff --git a/MdePkg/Include/Protocol/Ebc.h b/MdePkg/Include/Protocol/Ebc.h
index 01b4255..9229590 100644
--- a/MdePkg/Include/Protocol/Ebc.h
+++ b/MdePkg/Include/Protocol/Ebc.h
@@ -144,22 +144,6 @@ EFI_STATUS
   loaded into option ROMs. The image loader will load the EBC image, perform standard relocations,

   and invoke the CreateThunk() service to create a thunk for the EBC image's entry point. The

   image can then be run using the standard EFI start image services.

-

-  @param CreateThunk 

-  Creates a thunk for an EBC image entry point or protocol service,

-  and returns a pointer to the thunk. 

-  

-  @param UnloadImage 

-  Called when an EBC image is unloaded to allow the interpreter to

-  perform any cleanup associated with the image execution. 

-  

-  @param RegisterICacheFlush

-  Called to register a callback function that the EBC interpreter can

-  call to flush the processor instruction cache after creating thunks.

-  

-  @param GetVersion 

-  Called to get the version of the associated EBC interpreter.

-

 **/

 struct _EFI_EBC_PROTOCOL {

   EFI_EBC_CREATE_THUNK          CreateThunk;

diff --git a/MdePkg/Include/Protocol/EdidActive.h b/MdePkg/Include/Protocol/EdidActive.h
index 32baf19..d593260 100644
--- a/MdePkg/Include/Protocol/EdidActive.h
+++ b/MdePkg/Include/Protocol/EdidActive.h
@@ -28,22 +28,23 @@
   EDID information retrieved from the EFI_EDID_OVERRIDE_PROTOCOL if an override is

   available, or an identical copy of the EDID information from the

   EFI_EDID_DISCOVERED_PROTOCOL if no overrides are available.

-

-  @param SizeOfEdid 

-  The size, in bytes, of the Edid buffer. 0 if no EDID information

-  is available from the video output device. Otherwise, it must be a

-  minimum of 128 bytes.

-  

-  @param Edid 

-  A pointer to a read-only array of bytes that contains the EDID

-  information for an active video output device. This pointer is

-  NULL if no EDID information is available for the video output

-  device. The minimum size of a valid Edid buffer is 128 bytes.

-  EDID information is defined in the E-DID EEPROM

-  specification published by VESA (www.vesa.org).

 **/

 typedef struct {

+  ///

+  /// The size, in bytes, of the Edid buffer. 0 if no EDID information

+  /// is available from the video output device. Otherwise, it must be a

+  /// minimum of 128 bytes.

+  ///

   UINT32   SizeOfEdid;

+

+  ///

+  /// A pointer to a read-only array of bytes that contains the EDID

+  /// information for an active video output device. This pointer is

+  /// NULL if no EDID information is available for the video output

+  /// device. The minimum size of a valid Edid buffer is 128 bytes.

+  /// EDID information is defined in the E-DID EEPROM

+  /// specification published by VESA (www.vesa.org).

+  ///

   UINT8    *Edid;

 } EFI_EDID_ACTIVE_PROTOCOL;

 

diff --git a/MdePkg/Include/Protocol/EdidDiscovered.h b/MdePkg/Include/Protocol/EdidDiscovered.h
index cf37653..c1eafae 100644
--- a/MdePkg/Include/Protocol/EdidDiscovered.h
+++ b/MdePkg/Include/Protocol/EdidDiscovered.h
@@ -26,22 +26,23 @@
 /**

   @par Protocol Description:

   This protocol contains the EDID information retrieved from a video output device.

-

-  @param SizeOfEdid 

-  The size, in bytes, of the Edid buffer. 0 if no EDID information

-  is available from the video output device. Otherwise, it must be a

-  minimum of 128 bytes.

-  

-  @param Edid 

-  A pointer to a read-only array of bytes that contains the EDID

-  information for an active video output device. This pointer is

-  NULL if no EDID information is available for the video output

-  device. The minimum size of a valid Edid buffer is 128 bytes.

-  EDID information is defined in the E-DID EEPROM

-  specification published by VESA (www.vesa.org).

 **/

 typedef struct {

+  ///

+  /// The size, in bytes, of the Edid buffer. 0 if no EDID information

+  /// is available from the video output device. Otherwise, it must be a

+  /// minimum of 128 bytes.

+  ///

   UINT32   SizeOfEdid;

+  

+  ///

+  /// A pointer to a read-only array of bytes that contains the EDID

+  /// information for an active video output device. This pointer is

+  /// NULL if no EDID information is available for the video output

+  /// device. The minimum size of a valid Edid buffer is 128 bytes.

+  /// EDID information is defined in the E-DID EEPROM

+  /// specification published by VESA (www.vesa.org).

+  ///  

   UINT8    *Edid;

 } EFI_EDID_DISCOVERED_PROTOCOL;

 

diff --git a/MdePkg/Include/Protocol/EdidOverride.h b/MdePkg/Include/Protocol/EdidOverride.h
index 1bb51f0..9107d54 100644
--- a/MdePkg/Include/Protocol/EdidOverride.h
+++ b/MdePkg/Include/Protocol/EdidOverride.h
@@ -58,12 +58,11 @@ EFI_STATUS
   @par Protocol Description:

   This protocol is produced by the platform to allow the platform to provide 

   EDID information to the producer of the Graphics Output protocol.

-

-  @param GetEdid 

-  Returns EDID values and attributes that the Video BIOS must use. 

-

 **/

 struct _EFI_EDID_OVERRIDE_PROTOCOL {

+  ///

+  /// Returns EDID values and attributes that the Video BIOS must use. 

+  ///

   EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID   GetEdid;

 };

                                              

diff --git a/MdePkg/Include/Protocol/FirmwareVolume2.h b/MdePkg/Include/Protocol/FirmwareVolume2.h
index 1d22bbe..5961c8b 100644
--- a/MdePkg/Include/Protocol/FirmwareVolume2.h
+++ b/MdePkg/Include/Protocol/FirmwareVolume2.h
@@ -705,35 +705,6 @@ EFI_STATUS
   for example. This level of firmware volume implementation

   detail is not visible to the consumers of the Firmware Volume

   Protocol.

-

-  @param  GetVolumeAttributes   Retrieves volume capabilities

-                                and current settings. 

-

-  @param  SetVolumeAttributes   Modifies the current settings of

-                                the firmware volume.

-

-  @param  ReadFile              Reads an entire file from the firmware

-                                volume. 

-

-  @param  ReadSection           Reads a single section from a file into

-                                a buffer.

-

-  @param  WriteFile             Writes an entire file into the firmware

-                                volume. 

-

-  @param  GetNextFile           Provides service to allow searching the

-                                firmware volume.

-

-  @param  KeySize               Data field that indicates the size in bytes

-                                of the Key input buffer for the

-                                GetNextFile() API.

-

-  @param  ParentHandle          Handle of the parent firmware volume.

-

-  @param  GetInfo               Gets the requested file or volume

-                                information. 

-

-  @param  SetInfo               Sets the requested file information.

 **/

 struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {

   EFI_FV_GET_ATTRIBUTES   GetVolumeAttributes;

@@ -742,7 +713,17 @@ struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {
   EFI_FV_READ_SECTION     ReadSection;

   EFI_FV_WRITE_FILE       WriteFile;

   EFI_FV_GET_NEXT_FILE    GetNextFile;

+  

+  ///

+  /// Data field that indicates the size in bytes

+  /// of the Key input buffer for the

+  /// GetNextFile() API.  

+  ///

   UINT32                  KeySize;

+  

+  ///

+  /// Handle of the parent firmware volume.

+  ///

   EFI_HANDLE              ParentHandle;

   EFI_FV_GET_INFO         GetInfo;

   EFI_FV_SET_INFO         SetInfo;

diff --git a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
index 0eaf31a..9c20ba2 100644
--- a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
+++ b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h
@@ -263,9 +263,9 @@ EFI_STATUS
 

 

 

-//

-// EFI_LBA_LIST_TERMINATOR

-//

+///

+/// EFI_LBA_LIST_TERMINATOR

+///

 #define EFI_LBA_LIST_TERMINATOR   0xFFFFFFFFFFFFFFFFULL

 

 

@@ -322,8 +322,6 @@ EFI_STATUS
   ...

 );

 

-

-

 /**

   @par Protocol Description:

   The Firmware Volume Block Protocol is the low-level interface

@@ -347,33 +345,6 @@ EFI_STATUS
   Firmware Volume Protocol abstracts the file system that is

   used to format the firmware volume and the hardware

   device-hardening features that may be present.

-

-

-  @param GetPhysicalAddress   Retrieves the memory-mapped

-                              address of the firmware volume.

-

-  @param GetBlockSize   Retrieves the size for a specific block.

-                        Also returns the number of consecutive

-                        similarly sized blocks.

-

-  @param Read           Reads n bytes into a buffer from the firmware

-                        volume hardware.

-

-  @param Write          Writes n bytes from a buffer into the firmware

-                        volume hardware.

-

-  @param EraseBlocks    Erases specified block(s) and sets all

-                        values as indicated by the

-                        EFI_FVB_ERASE_POLARITY bit. See the

-                        EraseBlocks() function description. Type

-                        EFI_FVB_ERASE_POLARITY is defined in

-                        EFI_FIRMWARE_VOLUME_HEADER. ParentHandle

-                        Handle of the parent firmware volume.

-  

-  @param GetAttributes  Retrieves the current volume attributes.

-  

-  @param SetAttributes  Sets the current volume attributes.

-

 **/

 struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {

   EFI_FVB_GET_ATTRIBUTES        GetAttributes;

@@ -383,6 +354,9 @@ struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {
   EFI_FVB_READ                  Read;

   EFI_FVB_WRITE                 Write;

   EFI_FVB_ERASE_BLOCKS          EraseBlocks;

+  ///

+  /// Handle of the parent firmware volume.

+  ///  

   EFI_HANDLE                    ParentHandle;

 };

 

diff --git a/MdePkg/Include/Protocol/FormBrowser2.h b/MdePkg/Include/Protocol/FormBrowser2.h
index 1eaf7a2..021e04d 100644
--- a/MdePkg/Include/Protocol/FormBrowser2.h
+++ b/MdePkg/Include/Protocol/FormBrowser2.h
@@ -158,24 +158,12 @@ EFI_STATUS
   @par Protocol Description: 

   This interface will allow the caller to direct the configuration 

   driver to use either the HII database or use the passed-in packet of data.

-

-  @param SendForm         Browse the specified configuration forms.

-

-  @param BrowserCallback  Routine used to expose internal

-                          configuration state of the browser.

-                          This is primarily used by callback

-                          handler routines which were called by

-                          the browser and in-turn need to get

-                          additional information from the

-                          browser itself.

-

 **/

 struct _EFI_FORM_BROWSER2_PROTOCOL {

   EFI_SEND_FORM2         SendForm;

   EFI_BROWSER_CALLBACK2  BrowserCallback;

 } ;

 

-

 extern EFI_GUID gEfiFormBrowser2ProtocolGuid;

 

 #endif

diff --git a/MdePkg/Include/Protocol/GraphicsOutput.h b/MdePkg/Include/Protocol/GraphicsOutput.h
index ca96b4a..d8ac161 100644
--- a/MdePkg/Include/Protocol/GraphicsOutput.h
+++ b/MdePkg/Include/Protocol/GraphicsOutput.h
@@ -102,41 +102,53 @@ typedef union {
   UINT32                        Raw;

 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION;

 

+///

+/// actions for BltOperations

+///

 typedef enum {

+  ///

+  /// 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.  

+  ///

   EfiBltVideoFill,

+  

+  ///

+  /// 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.  

+  ///

   EfiBltVideoToBltBuffer,

+  

+  ///

+  /// 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.

+  ///

   EfiBltBufferToVideo, 

+  

+  ///

+  /// 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.

+  /// EfiBltVideoToVideo,

+  ///

   EfiBltVideoToVideo,

+  

   EfiGraphicsOutputBltOperationMax

 } EFI_GRAPHICS_OUTPUT_BLT_OPERATION;

 

 /**

-  The following table defines actions for BltOperations:

-

-  <B>EfiBltVideoFill</B> - 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.

-

-  <B>EfiBltVideoToBltBuffer</B> - 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.

-

-  <B>EfiBltBufferToVideo</B> - 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.

-

-  <B>EfiBltVideoToVideo</B> - 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.

-

+  Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.

+  

   @param  This         Protocol instance pointer.

   @param  BltBuffer    Buffer containing data to blit into video buffer. This

                        buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)

@@ -183,21 +195,6 @@ typedef struct {
   Provides a basic abstraction to set video modes and copy pixels to and from 

   the graphics controller's frame buffer. The linear address of the hardware 

   frame buffer is also exposed so software can write directly to the video hardware.

-

-  @param QueryMode

-  Returns information for an available graphics mode that the graphics device 

-  and the set of active video output devices supports.

-  

-  @param SetMode 

-  Set the video device into the specified mode and clears the visible portions 

-  of the output display to black.

-  

-  @param Blt

-  Software abstraction to draw on the video device's frame buffer.

-  

-  @param Mode

-  Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.

-

 **/

 struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {

   EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE  QueryMode;