Update For R9 Review.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / VgaMiniPortDxe / VgaMiniPort.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.h b/IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.h
index 10508aafae7eaad47ab2ad97cba9d0677b8b0135..a1100a27cf96d58952ef2c304418001adf421427 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.h
@@ -11,8 +11,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _VGA_MINIPORT_H\r
-#define _VGA_MINIPORT_H\r
+#ifndef _VGA_MINIPORT_H_\r
+#define _VGA_MINIPORT_H_\r
 \r
 //\r
 // The package level header files this module uses\r
@@ -61,21 +61,66 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gPciVgaMiniPortComponentName2;
 //\r
 // Driver Binding Protocol functions\r
 //\r
+/**\r
+  Supported.\r
+\r
+  (Standard DriverBinding Protocol Supported() function)\r
+\r
+  @param  This                   The driver binding protocol.\r
+  @param  Controller             The controller handle to check.\r
+  @param  RemainingDevicePath    The remaining device path.\r
+\r
+  @retval EFI_SUCCESS            The driver supports this controller.\r
+  @retval EFI_UNSUPPORTED        This device isn't supported.\r
+\r
+**/\r
 EFI_STATUS\r
+EFIAPI\r
 PciVgaMiniPortDriverBindingSupported (\r
   IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN EFI_HANDLE                   Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
   );\r
 \r
+/**\r
+  Install VGA Mini Port Protocol onto VGA device handles\r
+\r
+  (Standard DriverBinding Protocol Start() function)\r
+\r
+  @param  This                   The driver binding instance.\r
+  @param  Controller             The controller to check.\r
+  @param  RemainingDevicePath    The remaining device patch.\r
+\r
+  @retval EFI_SUCCESS            The controller is controlled by the driver.\r
+  @retval EFI_ALREADY_STARTED    The controller is already controlled by the driver.\r
+  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.\r
+\r
+**/\r
 EFI_STATUS\r
+EFIAPI\r
 PciVgaMiniPortDriverBindingStart (\r
   IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN EFI_HANDLE                   Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
   );\r
 \r
+/**\r
+  Stop.\r
+\r
+  (Standard DriverBinding Protocol Stop() function)\r
+\r
+  @param  This                   The driver binding protocol.\r
+  @param  Controller             The controller to release.\r
+  @param  NumberOfChildren       The child number that opened controller\r
+                                 BY_CHILD.\r
+  @param  ChildHandleBuffer      The array of child handle.\r
+\r
+  @retval EFI_SUCCESS            The controller or children are stopped.\r
+  @retval EFI_DEVICE_ERROR       Failed to stop the driver.\r
+\r
+**/\r
 EFI_STATUS\r
+EFIAPI\r
 PciVgaMiniPortDriverBindingStop (\r
   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN  EFI_HANDLE                   Controller,\r
@@ -86,6 +131,16 @@ PciVgaMiniPortDriverBindingStop (
 //\r
 // VGA Mini Port Protocol functions\r
 //\r
+/**\r
+  Thunk function of EFI_VGA_MINI_PORT_SET_MODE.\r
+\r
+  @param  This             Point to instance of EFI_VGA_MINI_PORT_PROTOCOL.\r
+  @param  ModeNumber       Mode number.\r
+\r
+  @retval EFI_UNSUPPORTED  Invalid mode number.\r
+  @retval EFI_SUCCESS      Success.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PciVgaMiniPortSetMode (\r