modify coding style to pass ecc tool

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

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c b/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c
index 933c9dd695bdaf35c2b4115e0fb9eca4c4ca03ce..b0704f7d7e27ca5b919a0b710c524269f4e28ba4 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c
@@ -1,6 +1,8 @@
 /** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+  UEFI Component Name(2) protocol implementation for 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,13 +11,6 @@ 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
-  ComponentName.c\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #include "UsbMouse.h"\r

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c
index e7b67df7cf24b19f9419a0879b1b9f1ee3769473..212fbf89d29239f47fbe0a8e87bb5358bc5ecf04 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c
@@ -1,6 +1,8 @@
 /** @file\r
 \r
-Copyright (c) 2004, Intel Corporation\r
+  Parse mouse hid descriptor.\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,34 +11,21 @@ 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
-  Mousehid.c\r
-\r
-Abstract:\r
-  Parse mouse hid descriptor\r
-\r
-\r
 **/\r
 \r
 #include "MouseHid.h"\r
 \r
 \r
-//\r
-// Get an item from report descriptor\r
-//\r
-\r
 /**\r
-  Get Next Item\r
+  Get next item from report descriptor.\r
 \r
-  @param  StartPos          Start Position\r
-  @param  EndPos            End Position\r
-  @param  HidItem           HidItem to return\r
+  @param  StartPos          Start Position.\r
+  @param  EndPos            End Position.\r
+  @param  HidItem           HidItem to return.\r
 \r
-  @return Position\r
+  @return Position.\r
 \r
 **/\r
-STATIC\r
 UINT8 *\r
 GetNextItem (\r
   IN  UINT8    *StartPos,\r
@@ -129,14 +118,13 @@ GetNextItem (
 \r
 \r
 /**\r
-  Get Item Data\r
+  Get item data from report descriptor.\r
 \r
-  @param  HidItem           HID_ITEM\r
+  @param  HidItem           The pointer to HID_ITEM.\r
 \r
-  @return HidItem Data\r
+  @return The Data of HidItem.\r
 \r
 **/\r
-STATIC\r
 UINT32\r
 GetItemData (\r
   IN  HID_ITEM *HidItem\r
@@ -162,14 +150,12 @@ GetItemData (
 \r
 \r
 /**\r
-  Parse Local Item\r
-\r
-  @param  UsbMouse          USB_MOUSE_DEV\r
-  @param  LocalItem         Local Item\r
+  Parse local item from report descriptor.\r
 \r
+  @param  UsbMouse          The instance of USB_MOUSE_DEV\r
+  @param  LocalItem         The pointer to local hid item\r
 \r
 **/\r
-STATIC\r
 VOID\r
 ParseLocalItem (\r
   IN  USB_MOUSE_DEV   *UsbMouse,\r
@@ -216,7 +202,14 @@ ParseLocalItem (
   }\r
 }\r
 \r
-STATIC\r
+\r
+/**\r
+  Parse global item from report descriptor.\r
+\r
+  @param  UsbMouse          The instance of USB_MOUSE_DEV\r
+  @param  GlobalItem          The pointer to global hid item\r
+\r
+**/\r
 VOID\r
 ParseGlobalItem (\r
   IN  USB_MOUSE_DEV   *UsbMouse,\r
@@ -247,17 +240,13 @@ ParseGlobalItem (
 }\r
 \r
 \r
-\r
 /**\r
-  Parse Main Item\r
-\r
-  @param  UsbMouse          TODO: add argument description\r
-  @param  MainItem          HID_ITEM to parse\r
+  Parse main item from report descriptor.\r
 \r
-  @return VOID\r
+  @param  UsbMouse         The instance of USB_MOUSE_DEV\r
+  @param  MainItem          Main hid item to parse\r
 \r
 **/\r
-STATIC\r
 VOID\r
 ParseMainItem (\r
   IN  USB_MOUSE_DEV   *UsbMouse,\r
@@ -272,15 +261,12 @@ ParseMainItem (
 \r
 \r
 /**\r
-  Parse Hid Item\r
+  Parse hid item from report descriptor.\r
 \r
-  @param  UsbMouse          USB_MOUSE_DEV\r
-  @param  HidItem           HidItem to parse\r
-\r
-  @return VOID\r
+  @param  UsbMouse          The instance of USB_MOUSE_DEV\r
+  @param  HidItem           The hid item to parse\r
 \r
 **/\r
-STATIC\r
 VOID\r
 ParseHidItem (\r
   IN  USB_MOUSE_DEV   *UsbMouse,\r
@@ -311,19 +297,17 @@ ParseHidItem (
     break;\r
   }\r
 }\r
-//\r
-// A simple parse just read some field we are interested in\r
-//\r
+\r
 \r
 /**\r
-  Parse Mouse Report Descriptor\r
+  Parse Mouse Report Descriptor.\r
 \r
-  @param  UsbMouse          USB_MOUSE_DEV\r
+  @param  UsbMouse          The instance of USB_MOUSE_DEV\r
   @param  ReportDescriptor  Report descriptor to parse\r
   @param  ReportSize        Report descriptor size\r
 \r
   @retval EFI_DEVICE_ERROR  Report descriptor error\r
-  @retval EFI_SUCCESS       Success\r
+  @retval EFI_SUCCESS       Parse descriptor success\r
 \r
 **/\r
 EFI_STATUS\r
@@ -334,14 +318,14 @@ ParseMouseReportDescriptor (
   )\r
 {\r
   UINT8     *DescriptorEnd;\r
-  UINT8     *ptr;\r
+  UINT8     *Ptr;\r
   HID_ITEM  HidItem;\r
 \r
   DescriptorEnd = ReportDescriptor + ReportSize;\r
 \r
-  ptr           = GetNextItem (ReportDescriptor, DescriptorEnd, &HidItem);\r
+  Ptr           = GetNextItem (ReportDescriptor, DescriptorEnd, &HidItem);\r
 \r
-  while (ptr != NULL) {\r
+  while (Ptr != NULL) {\r
     if (HidItem.Format != HID_ITEM_FORMAT_SHORT) {\r
       //\r
       // Long Format Item is not supported at current HID revision\r
@@ -351,7 +335,7 @@ ParseMouseReportDescriptor (
 \r
     ParseHidItem (UsbMouse, &HidItem);\r
 \r
-    ptr = GetNextItem (ptr, DescriptorEnd, &HidItem);\r
+    Ptr = GetNextItem (Ptr, DescriptorEnd, &HidItem);\r
   }\r
 \r
   UsbMouse->NumberOfButtons                 = (UINT8) (UsbMouse->PrivateData.ButtonMaxIndex - UsbMouse->PrivateData.ButtonMinIndex + 1);\r

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
index 80211341a2228a2c79aa2d5388748e4c1b4fe2ac..478bccffe9822e968ce6600bfd9d98285ff2e580 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
@@ -1,6 +1,8 @@
 /** @file\r
 \r
-Copyright (c) 2004, Intel Corporation\r
+  The interface of HID data structure.\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
-  MouseHid.h\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
-#ifndef __MOUSE_HID_H\r
-#define __MOUSE_HID_H\r
+#ifndef _EFI_MOUSE_HID_H_\r
+#define _EFI_MOUSE_HID_H_\r
 \r
 #include "UsbMouse.h"\r
 \r
@@ -75,6 +70,17 @@ typedef struct {
   UINT32          CollectionStackPtr;\r
 } HID_PARSER;\r
 \r
+/**\r
+  Parse Mouse Report Descriptor.\r
+\r
+  @param  UsbMouse          The instance of USB_MOUSE_DEV\r
+  @param  ReportDescriptor  Report descriptor to parse\r
+  @param  ReportSize        Report descriptor size\r
+\r
+  @retval EFI_DEVICE_ERROR  Report descriptor error\r
+  @retval EFI_SUCCESS       Parse descriptor success\r
+\r
+**/\r
 EFI_STATUS\r
 ParseMouseReportDescriptor (\r
   IN  USB_MOUSE_DEV   *UsbMouse,\r

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c
index 378bbec7ed4d4940ab0db62da32233e41874c55c..1e359d75437182ad3e2326ef945739e4f6c2a352 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c
@@ -1,6 +1,8 @@
 /** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+  Usb Mouse Driver Binding and Implement SIMPLE_POINTER_PROTOCOL Protocol.\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,13 +11,6 @@ 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.c\r
-\r
-  Abstract:\r
-\r
-\r
 **/\r
 \r
 #include "UsbMouse.h"\r
@@ -27,10 +22,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "UsbMouse.h"\r
 #include "MouseHid.h"\r
 \r
-//\r
-// Prototypes\r
-// Driver model protocol interface\r
-//\r
+/**\r
+  The USB Mouse driver entry pointer.\r
+\r
+  @param  ImageHandle      The driver image handle.\r
+  @param  SystemTable      The system table.\r
+\r
+  @return EFI_SUCCESS      The component name protocol is installed.\r
+  @return Others           Failed to init the usb driver.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 USBMouseDriverBindingEntryPoint (\r
@@ -38,6 +39,18 @@ USBMouseDriverBindingEntryPoint (
   IN EFI_SYSTEM_TABLE     *SystemTable\r
   );\r
 \r
+/**\r
+  Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
+  that has UsbIoProtocol installed will be supported.\r
+\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Controller            Handle of device to test.\r
+  @param  RemainingDevicePath   Not used.\r
+\r
+  @retval EFI_SUCCESS           This driver supports this device.\r
+  @retval EFI_UNSUPPORTED       This driver does not support this device.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 USBMouseDriverBindingSupported (\r
@@ -46,6 +59,20 @@ USBMouseDriverBindingSupported (
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
   );\r
 \r
+/**\r
+  Starting the Usb Mouse Driver.\r
+\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Controller            Handle of device to test\r
+  @param  RemainingDevicePath   Not used\r
+\r
+  @retval EFI_SUCCESS           This driver supports this device.\r
+  @retval EFI_UNSUPPORTED       This driver does not support this device.\r
+  @retval EFI_DEVICE_ERROR      This driver cannot be started due to device Error.\r
+  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory resources.\r
+  @retval EFI_ALREADY_STARTED   Thios driver has been started.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 USBMouseDriverBindingStart (\r
@@ -54,6 +81,19 @@ USBMouseDriverBindingStart (
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
   );\r
 \r
+/**\r
+  Stop this driver on ControllerHandle. Support stoping any child handles\r
+  created by this driver.\r
+\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Controller            Handle of device to stop driver on.\r
+  @param  NumberOfChildren      Number of Children in the ChildHandleBuffer.\r
+  @param  ChildHandleBuffer     List of handles for the children we need to stop.\r
+\r
+  @retval EFI_SUCCESS           The controller or children are stopped.\r
+  @retval Other                 Failed to stop the driver.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 USBMouseDriverBindingStop (\r
@@ -76,22 +116,43 @@ EFI_DRIVER_BINDING_PROTOCOL gUsbMouseDriverBinding = {
   NULL\r
 };\r
 \r
-//\r
-// helper functions\r
-//\r
-STATIC\r
+/**\r
+  Tell if a Usb Controller is a mouse.\r
+\r
+  @param  UsbIo                 Protocol instance pointer.\r
+\r
+  @retval TRUE                  It is a mouse.\r
+  @retval FALSE                 It is not a mouse.\r
+\r
+**/\r
 BOOLEAN\r
 IsUsbMouse (\r
   IN  EFI_USB_IO_PROTOCOL     *UsbIo\r
   );\r
 \r
-STATIC\r
+/**\r
+  Initialize the Usb Mouse Device.\r
+\r
+  @param  UsbMouseDev           Device instance to be initialized.\r
+\r
+  @retval EFI_SUCCESS           Success.\r
+  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory.\r
+  @retval Other                 Init error. \r
+\r
+**/\r
 EFI_STATUS\r
 InitializeUsbMouseDevice (\r
   IN  USB_MOUSE_DEV           *UsbMouseDev\r
   );\r
 \r
-STATIC\r
+/**\r
+  Event notification function for SIMPLE_POINTER.WaitForInput event\r
+  Signal the event if there is input from mouse.\r
+\r
+  @param  Event                 Wait Event.\r
+  @param  Context               Passed parameter to event handler.\r
+ \r
+**/\r
 VOID\r
 EFIAPI\r
 UsbMouseWaitForInput (\r
@@ -99,10 +160,19 @@ UsbMouseWaitForInput (
   IN  VOID                    *Context\r
   );\r
 \r
-//\r
-// Mouse interrupt handler\r
-//\r
-STATIC\r
+/**\r
+  It is called whenever there is data received from async interrupt\r
+  transfer.\r
+\r
+  @param  Data                  Data received.\r
+  @param  DataLength            Length of Data.\r
+  @param  Context               Passed in context.\r
+  @param  Result                Async Interrupt Transfer result.\r
+\r
+  @return EFI_SUCCESS           Receive data successfully.\r
+  @return EFI_DEVICE_ERROR      USB async interrupt transfer fails.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 OnMouseInterruptComplete (\r
@@ -112,10 +182,17 @@ OnMouseInterruptComplete (
   IN  UINT32      Result\r
   );\r
 \r
-//\r
-// Mouse Protocol\r
-//\r
-STATIC\r
+/**\r
+  Get the mouse state, see SIMPLE POINTER PROTOCOL.\r
+\r
+  @param  This                  Protocol instance pointer.\r
+  @param  MouseState            Current mouse state.\r
+\r
+  @return EFI_SUCCESS           Get usb mouse status successfully.\r
+  @return EFI_DEVICE_ERROR      The parameter is error.\r
+  @return EFI_NOT_READY         Mouse status doesn't change.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 GetMouseState (\r
@@ -123,7 +200,15 @@ GetMouseState (
   OUT  EFI_SIMPLE_POINTER_STATE     *MouseState\r
   );\r
 \r
-STATIC\r
+/**\r
+  Reset the mouse device, see SIMPLE POINTER PROTOCOL.\r
+\r
+  @param  This                  Protocol instance pointer.\r
+  @param  ExtendedVerification  Ignored here.\r
+\r
+  @return EFI_SUCCESS           Reset usb mouse successfully.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 UsbMouseReset (\r
@@ -131,28 +216,23 @@ UsbMouseReset (
   IN BOOLEAN                        ExtendedVerification\r
   );\r
 \r
-//\r
-// Driver start here\r
-//\r
+\r
+/**\r
+  The USB Mouse driver entry pointer.\r
+\r
+  @param  ImageHandle      The driver image handle.\r
+  @param  SystemTable      The system table.\r
+\r
+  @return EFI_SUCCESS      The component name protocol is installed.\r
+  @return Others           Failed to init the usb driver.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 USBMouseDriverBindingEntryPoint (\r
   IN EFI_HANDLE           ImageHandle,\r
   IN EFI_SYSTEM_TABLE     *SystemTable\r
   )\r
-/*++\r
-\r
-  Routine Description:\r
-    Entry point for EFI drivers.\r
-\r
-  Arguments:\r
-   ImageHandle - EFI_HANDLE\r
-   SystemTable - EFI_SYSTEM_TABLE\r
-  Returns:\r
-    EFI_SUCCESS\r
-    others\r
-\r
---*/\r
 {\r
   return EfiLibInstallDriverBindingComponentName2 (\r
            ImageHandle,\r
@@ -167,11 +247,11 @@ USBMouseDriverBindingEntryPoint (
 \r
 /**\r
   Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
-  that has UsbHcProtocol installed will be supported.\r
+  that has UsbIoProtocol installed will be supported.\r
 \r
   @param  This                  Protocol instance pointer.\r
   @param  Controller            Handle of device to test\r
-  @param  RemainingDevicePath   Not used\r
+  @param  RemainingDevicePath   Not used.\r
 \r
   @retval EFI_SUCCESS           This driver supports this device.\r
   @retval EFI_UNSUPPORTED       This driver does not support this device.\r
@@ -225,18 +305,17 @@ USBMouseDriverBindingSupported (
 \r
 \r
 /**\r
-  Starting the Usb Bus Driver\r
+  Starting the Usb Mouse Driver.\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  Controller            Handle of device to test\r
-  @param  RemainingDevicePath   Not used\r
+  @param  Controller            Handle of device to test.\r
+  @param  RemainingDevicePath   Not used.\r
 \r
   @retval EFI_SUCCESS           This driver supports this device.\r
   @retval EFI_UNSUPPORTED       This driver does not support this device.\r
-  @retval EFI_DEVICE_ERROR      This driver cannot be started due to device Error\r
-                                EFI_OUT_OF_RESOURCES- Can't allocate memory\r
-                                resources\r
-  @retval EFI_ALREADY_STARTED   Thios driver has been started\r
+  @retval EFI_DEVICE_ERROR      This driver cannot be started due to device Error.\r
+  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory resources.\r
+  @retval EFI_ALREADY_STARTED   Thios driver has been started.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -477,13 +556,12 @@ ErrorExit:
   created by this driver.\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  Controller            Handle of device to stop driver on\r
-  @param  NumberOfChildren      Number of Children in the ChildHandleBuffer\r
+  @param  Controller            Handle of device to stop driver on.\r
+  @param  NumberOfChildren      Number of Children in the ChildHandleBuffer.\r
   @param  ChildHandleBuffer     List of handles for the children we need to stop.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return others\r
+  @retval EFI_SUCCESS           The controller or children are stopped.\r
+  @retval Other                 Failed to stop the driver.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -552,7 +630,7 @@ USBMouseDriverBindingStop (
 \r
   gBS->CloseEvent (UsbMouseDevice->SimplePointerProtocol.WaitForInput);\r
 \r
-  if (UsbMouseDevice->DelayedRecoveryEvent) {\r
+  if (UsbMouseDevice->DelayedRecoveryEvent != NULL) {\r
     gBS->CloseEvent (UsbMouseDevice->DelayedRecoveryEvent);\r
     UsbMouseDevice->DelayedRecoveryEvent = 0;\r
   }\r
@@ -576,7 +654,7 @@ USBMouseDriverBindingStop (
   gBS->FreePool (UsbMouseDevice->InterfaceDescriptor);\r
   gBS->FreePool (UsbMouseDevice->IntEndpointDescriptor);\r
 \r
-  if (UsbMouseDevice->ControllerNameTable) {\r
+  if (UsbMouseDevice->ControllerNameTable != NULL) {\r
     FreeUnicodeStringTable (UsbMouseDevice->ControllerNameTable);\r
   }\r
 \r
@@ -588,12 +666,12 @@ USBMouseDriverBindingStop (
 \r
 \r
 /**\r
-  Tell if a Usb Controller is a mouse\r
+  Tell if a Usb Controller is a mouse.\r
 \r
   @param  UsbIo                 Protocol instance pointer.\r
 \r
-  @retval TRUE                  It is a mouse\r
-  @retval FALSE                 It is not a mouse\r
+  @retval TRUE                  It is a mouse.\r
+  @retval FALSE                 It is not a mouse.\r
 \r
 **/\r
 BOOLEAN\r
@@ -631,14 +709,13 @@ IsUsbMouse (
 /**\r
   Initialize the Usb Mouse Device.\r
 \r
-  @param  UsbMouseDev           Device instance to be initialized\r
+  @param  UsbMouseDev           Device instance to be initialized.\r
 \r
-  @retval EFI_SUCCESS           Success\r
-  @retval EFI_DEVICE_ERROR      Init error. EFI_OUT_OF_RESOURCES- Can't allocate\r
-                                memory\r
+  @retval EFI_SUCCESS           Success.\r
+  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory.\r
+  @retval Other                 Init error. \r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 InitializeUsbMouseDevice (\r
   IN  USB_MOUSE_DEV           *UsbMouseDev\r
@@ -748,7 +825,7 @@ InitializeUsbMouseDevice (
 \r
   gBS->FreePool (ReportDesc);\r
 \r
-  if (UsbMouseDev->DelayedRecoveryEvent) {\r
+  if (UsbMouseDev->DelayedRecoveryEvent != NULL) {\r
     gBS->CloseEvent (UsbMouseDev->DelayedRecoveryEvent);\r
     UsbMouseDev->DelayedRecoveryEvent = 0;\r
   }\r
@@ -770,15 +847,14 @@ InitializeUsbMouseDevice (
   transfer.\r
 \r
   @param  Data                  Data received.\r
-  @param  DataLength            Length of Data\r
-  @param  Context               Passed in context\r
-  @param  Result                Async Interrupt Transfer result\r
+  @param  DataLength            Length of Data.\r
+  @param  Context               Passed in context.\r
+  @param  Result                Async Interrupt Transfer result.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
+  @return EFI_SUCCESS           Receive data successfully.\r
+  @return EFI_DEVICE_ERROR      USB async interrupt transfer fails.\r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 OnMouseInterruptComplete (\r
@@ -855,32 +931,18 @@ OnMouseInterruptComplete (
   return EFI_SUCCESS;\r
 }\r
 \r
-/*\r
-STATIC VOID\r
-PrintMouseState(\r
-    IN  EFI_MOUSE_STATE *MouseState\r
-    )\r
-{\r
-    Aprint("(%x: %x, %x)\n",\r
-        MouseState->ButtonStates,\r
-        MouseState->dx,\r
-        MouseState->dy\r
-        );\r
-}\r
-*/\r
 \r
 /**\r
   Get the mouse state, see SIMPLE POINTER PROTOCOL.\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  MouseState            Current mouse state\r
+  @param  MouseState            Current mouse state.\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-  @return EFI_NOT_READY\r
+  @return EFI_SUCCESS           Get usb mouse status successfully.\r
+  @return EFI_DEVICE_ERROR      The parameter is error.\r
+  @return EFI_NOT_READY         Mouse status doesn't change.\r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 GetMouseState (\r
@@ -923,12 +985,11 @@ GetMouseState (
   Reset the mouse device, see SIMPLE POINTER PROTOCOL.\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  ExtendedVerification  Ignored here/\r
+  @param  ExtendedVerification  Ignored here.\r
 \r
-  @return EFI_SUCCESS\r
+  @return EFI_SUCCESS           Reset usb mouse successfully.\r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 UsbMouseReset (\r
@@ -959,14 +1020,12 @@ UsbMouseReset (
 \r
 /**\r
   Event notification function for SIMPLE_POINTER.WaitForInput event\r
-  Signal the event if there is input from mouse\r
+  Signal the event if there is input from mouse.\r
 \r
   @param  Event                 Wait Event\r
   @param  Context               Passed parameter to event handler\r
- VOID\r
-\r
+ \r
 **/\r
-STATIC\r
 VOID\r
 EFIAPI\r
 UsbMouseWaitForInput (\r
@@ -1023,7 +1082,7 @@ USBMouseRecoveryHandler (
 \r
 \r
 /**\r
-  Report Status Code in Usb Bot Driver\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

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