modify coding style to pass ecc tool

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseDxe / MouseHid.c

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