modify coding style to pass ecc tool

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseDxe / UsbMouse.h

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h
index cb8cc03ea1d65f5a6286964787df0afc5a458129..0e4c56621a9bd216f266908375ec1bea6ea244d9 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h
@@ -1,6 +1,8 @@
 /** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+  Helper routine and corrsponding data struct used by USB Mouse Driver.\r
+\r
+Copyright (c) 2004 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -9,17 +11,10 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:\r
-\r
-    UsbMouse.h\r
-\r
-  Abstract:\r
-\r
-\r
 **/\r
 \r
-#ifndef _USB_MOUSE_H\r
-#define _USB_MOUSE_H\r
+#ifndef _EFI_USB_MOUSE_H_\r
+#define _EFI_USB_MOUSE_H_\r
 \r
 \r
 #include <PiDxe.h>\r
@@ -78,6 +73,15 @@ typedef struct {
 #define USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL(a) \\r
     CR(a, USB_MOUSE_DEV, SimplePointerProtocol, USB_MOUSE_DEV_SIGNATURE)\r
 \r
+\r
+/**\r
+  Timer handler for Delayed Recovery timer.\r
+\r
+  @param  Event                 The Delayed Recovery event.\r
+  @param  Context               Points to the USB_KB_DEV instance.\r
+\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 USBMouseRecoveryHandler (\r
@@ -93,6 +97,17 @@ extern EFI_COMPONENT_NAME_PROTOCOL   gUsbMouseComponentName;
 extern EFI_COMPONENT_NAME2_PROTOCOL  gUsbMouseComponentName2;\r
 extern EFI_GUID                      gEfiUsbMouseDriverGuid;\r
 \r
+\r
+/**\r
+  Report Status Code in Usb Bot Driver.\r
+\r
+  @param  DevicePath            Use this to get Device Path\r
+  @param  CodeType              Status Code Type\r
+  @param  CodeValue             Status Code Value\r
+\r
+  @return None\r
+\r
+**/\r
 VOID\r
 MouseReportStatusCode (\r
   IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r