use the GUIDed versions of events: EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE and EVT_SIGNAL_E...

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / IdeBusDxe / IdeBus.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
index 8e998cb4cda79f43995e9eee897e4ae09fc21414..0fdacfed829220de447f2bf1378c6ea508a07f1d 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _IDE_BUS_H\r
-#define _IDE_BUS_H\r
+#ifndef _IDE_BUS_H_\r
+#define _IDE_BUS_H_\r
 \r
 \r
 \r
@@ -37,6 +37,8 @@
 #include <Library/UefiRuntimeServicesTableLib.h>\r
 #include <Library/DevicePathLib.h>\r
 \r
+#include <Guid/EventGroup.h>\r
+\r
 #include <IndustryStandard/Pci22.h>\r
 #include "IdeData.h"\r
 \r
@@ -62,7 +64,7 @@ typedef struct {
   BOOLEAN DeviceProcessed[MAX_IDE_DEVICE];\r
 } IDE_BUS_DRIVER_PRIVATE_DATA;\r
 \r
-#define IDE_BLK_IO_DEV_SIGNATURE  EFI_SIGNATURE_32 ('i', 'b', 'i', 'd')\r
+#define IDE_BLK_IO_DEV_SIGNATURE  SIGNATURE_32 ('i', 'b', 'i', 'd')\r
 \r
 typedef struct {\r
   UINT32                      Signature;\r
@@ -127,7 +129,7 @@ extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gIDEBusDriverDiagnostics2;
   @param  ImageHandle TODO: add argument description\r
   @param  SystemTable TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -144,7 +146,7 @@ IDEBusControllerDriverEntryPoint (
   @param  Controller TODO: add argument description\r
   @param  RemainingDevicePath TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -162,7 +164,7 @@ IDEBusDriverBindingSupported (
   @param  Controller TODO: add argument description\r
   @param  RemainingDevicePath TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -181,7 +183,7 @@ IDEBusDriverBindingStart (
   @param  NumberOfChildren TODO: add argument description\r
   @param  ChildHandleBuffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -196,6 +198,18 @@ IDEBusDriverBindingStop (
 //\r
 // EFI Driver Configuration Functions\r
 //\r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  This                 TODO: add argument description\r
+  @param  ControllerHandle     TODO: add argument description\r
+  @param  ChildHandle          TODO: add argument description\r
+  @param  Language             TODO: add argument description\r
+  @param  ActionRequired       TODO: add argument description\r
+\r
+  TODO: add return values.\r
+\r
+**/\r
 EFI_STATUS\r
 IDEBusDriverConfigurationSetOptions (\r
   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL                      *This,\r
@@ -205,6 +219,16 @@ IDEBusDriverConfigurationSetOptions (
   OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED               *ActionRequired\r
   );\r
 \r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  This                 TODO: add argument description\r
+  @param  ControllerHandle     TODO: add argument description\r
+  @param  ChildHandle          TODO: add argument description\r
+\r
+  TODO: add return values.\r
+\r
+**/\r
 EFI_STATUS\r
 IDEBusDriverConfigurationOptionsValid (\r
   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL               *This,\r
@@ -212,6 +236,18 @@ IDEBusDriverConfigurationOptionsValid (
   IN  EFI_HANDLE                                      ChildHandle  OPTIONAL\r
   );\r
 \r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  This                 TODO: add argument description\r
+  @param  ControllerHandle     TODO: add argument description\r
+  @param  ChildHandle          TODO: add argument description\r
+  @param  DefaultType          TODO: add argument description\r
+  @param  ActionRequired       TODO: add argument description\r
+\r
+  TODO: add return values.\r
+\r
+**/\r
 EFI_STATUS\r
 IDEBusDriverConfigurationForceDefaults (\r
   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL                      *This,\r
@@ -224,6 +260,21 @@ IDEBusDriverConfigurationForceDefaults (
 //\r
 // EFI Driver Diagnostics Functions\r
 //\r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  This                 TODO: add argument description\r
+  @param  ControllerHandle     TODO: add argument description\r
+  @param  ChildHandle          TODO: add argument description\r
+  @param  DiagnosticType       TODO: add argument description\r
+  @param  Language             TODO: add argument description\r
+  @param  ErrorType            TODO: add argument description\r
+  @param  BufferSize           TODO: add argument description\r
+  @param  Buffer               TODO: add argument description\r
+\r
+  TODO: add return values.\r
+\r
+**/\r
 EFI_STATUS\r
 IDEBusDriverDiagnosticsRunDiagnostics (\r
   IN  EFI_DRIVER_DIAGNOSTICS_PROTOCOL               *This,\r
@@ -245,7 +296,7 @@ IDEBusDriverDiagnosticsRunDiagnostics (
   @param  This TODO: add argument description\r
   @param  ExtendedVerification TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -264,7 +315,7 @@ IDEBlkIoReset (
   @param  BufferSize TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -286,7 +337,7 @@ IDEBlkIoReadBlocks (
   @param  BufferSize TODO: add argument description\r
   @param  Buffer TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -304,7 +355,7 @@ IDEBlkIoWriteBlocks (
 \r
   @param  This TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -319,7 +370,7 @@ IDEBlkIoFlushBlocks (
   @param  PciIo TODO: add argument description\r
   @param  Enable TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -335,7 +386,7 @@ IDERegisterDecodeEnableorDisable (
   @param  InquiryData TODO: add argument description\r
   @param  IntquiryDataSize TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -353,7 +404,7 @@ IDEDiskInfoInquiry (
   @param  IdentifyData TODO: add argument description\r
   @param  IdentifyDataSize TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -372,7 +423,7 @@ IDEDiskInfoIdentify (
   @param  SenseDataSize TODO: add argument description\r
   @param  SenseDataNumber TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -391,7 +442,7 @@ IDEDiskInfoSenseData (
   @param  IdeChannel TODO: add argument description\r
   @param  IdeDevice TODO: add argument description\r
 \r
-  TODO: add return values\r
+  TODO: add return values.\r
 \r
 **/\r
 EFI_STATUS\r