Code Scrub for USB mouse driver.

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

6 files changed, 786 insertions, 940 deletions

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c b/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c
index b0704f7d7e..44cf3d99c3 100644
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/ComponentName.c
@@ -1,6 +1,5 @@
 /** @file

-

-  UEFI Component Name(2) protocol implementation for Usb Mouse driver.

+  UEFI Component Name(2) protocol implementation for USB Mouse driver.

 

 Copyright (c) 2004 - 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials

@@ -13,138 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 **/

 

-#include "UsbMouse.h"

-#include <Library/DebugLib.h>

-

-//

-// EFI Component Name Functions

-//

-/**

-  Retrieves a Unicode string that is the user readable name of the driver.

-

-  This function retrieves the user readable name of a driver in the form of a

-  Unicode string. If the driver specified by This has a user readable name in

-  the language specified by Language, then a pointer to the driver name is

-  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified

-  by This does not support the language specified by Language,

-  then EFI_UNSUPPORTED is returned.

-

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

-                                EFI_COMPONENT_NAME_PROTOCOL instance.

-

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

-                                array indicating the language. This is the

-                                language of the driver name that the caller is

-                                requesting, and it must match one of the

-                                languages specified in SupportedLanguages. The

-                                number of languages supported by a driver is up

-                                to the driver writer. Language is specified

-                                in RFC 3066 or ISO 639-2 language code format.

-

-  @param  DriverName[out]       A pointer to the Unicode string to return.

-                                This Unicode string is the name of the

-                                driver specified by This in the language

-                                specified by Language.

-

-  @retval EFI_SUCCESS           The Unicode string for the Driver specified by

-                                This and the language specified by Language was

-                                returned in DriverName.

-

-  @retval EFI_INVALID_PARAMETER Language is NULL.

-

-  @retval EFI_INVALID_PARAMETER DriverName is NULL.

-

-  @retval EFI_UNSUPPORTED       The driver specified by This does not support

-                                the language specified by Language.

-

-**/

-EFI_STATUS

-EFIAPI

-UsbMouseComponentNameGetDriverName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

-  IN  CHAR8                        *Language,

-  OUT CHAR16                       **DriverName

-  );

-

-

-/**

-  Retrieves a Unicode string that is the user readable name of the controller

-  that is being managed by a driver.

-

-  This function retrieves the user readable name of the controller specified by

-  ControllerHandle and ChildHandle in the form of a Unicode string. If the

-  driver specified by This has a user readable name in the language specified by

-  Language, then a pointer to the controller name is returned in ControllerName,

-  and EFI_SUCCESS is returned.  If the driver specified by This is not currently

-  managing the controller specified by ControllerHandle and ChildHandle,

-  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not

-  support the language specified by Language, then EFI_UNSUPPORTED is returned.

-

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

-                                EFI_COMPONENT_NAME_PROTOCOL instance.

-

-  @param  ControllerHandle[in]  The handle of a controller that the driver

-                                specified by This is managing.  This handle

-                                specifies the controller whose name is to be

-                                returned.

-

-  @param  ChildHandle[in]       The handle of the child controller to retrieve

-                                the name of.  This is an optional parameter that

-                                may be NULL.  It will be NULL for device

-                                drivers.  It will also be NULL for a bus drivers

-                                that wish to retrieve the name of the bus

-                                controller.  It will not be NULL for a bus

-                                driver that wishes to retrieve the name of a

-                                child controller.

-

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

-                                array indicating the language.  This is the

-                                language of the driver name that the caller is

-                                requesting, and it must match one of the

-                                languages specified in SupportedLanguages. The

-                                number of languages supported by a driver is up

-                                to the driver writer. Language is specified in

-                                RFC 3066 or ISO 639-2 language code format.

-

-  @param  ControllerName[out]   A pointer to the Unicode string to return.

-                                This Unicode string is the name of the

-                                controller specified by ControllerHandle and

-                                ChildHandle in the language specified by

-                                Language from the point of view of the driver

-                                specified by This.

-

-  @retval EFI_SUCCESS           The Unicode string for the user readable name in

-                                the language specified by Language for the

-                                driver specified by This was returned in

-                                DriverName.

-

-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.

-

-  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid

-                                EFI_HANDLE.

-

-  @retval EFI_INVALID_PARAMETER Language is NULL.

-

-  @retval EFI_INVALID_PARAMETER ControllerName is NULL.

-

-  @retval EFI_UNSUPPORTED       The driver specified by This is not currently

-                                managing the controller specified by

-                                ControllerHandle and ChildHandle.

-

-  @retval EFI_UNSUPPORTED       The driver specified by This does not support

-                                the language specified by Language.

-

-**/

-EFI_STATUS

-EFIAPI

-UsbMouseComponentNameGetControllerName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,

-  IN  EFI_HANDLE                                      ControllerHandle,

-  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,

-  IN  CHAR8                                           *Language,

-  OUT CHAR16                                          **ControllerName

-  );

 

+#include "UsbMouse.h"

 

 //

 // EFI Component Name Protocol

@@ -165,13 +34,11 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUsbMouseComponentNam
 };

 

 

-

 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbMouseDriverNameTable[] = {

   { "eng;en", L"Usb Mouse Driver" },

   { NULL , NULL }

 };

 

-

 /**

   Retrieves a Unicode string that is the user readable name of the driver.

 

@@ -182,10 +49,9 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbMouseDriverNameTable[
   by This does not support the language specified by Language,

   then EFI_UNSUPPORTED is returned.

 

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

                                 EFI_COMPONENT_NAME_PROTOCOL instance.

-

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

+  @param  Language              A pointer to a Null-terminated ASCII string

                                 array indicating the language. This is the

                                 language of the driver name that the caller is

                                 requesting, and it must match one of the

@@ -193,8 +59,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbMouseDriverNameTable[
                                 number of languages supported by a driver is up

                                 to the driver writer. Language is specified

                                 in RFC 3066 or ISO 639-2 language code format.

-

-  @param  DriverName[out]       A pointer to the Unicode string to return.

+  @param  DriverName            A pointer to the Unicode string to return.

                                 This Unicode string is the name of the

                                 driver specified by This in the language

                                 specified by Language.

@@ -202,11 +67,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbMouseDriverNameTable[
   @retval EFI_SUCCESS           The Unicode string for the Driver specified by

                                 This and the language specified by Language was

                                 returned in DriverName.

-

   @retval EFI_INVALID_PARAMETER Language is NULL.

-

   @retval EFI_INVALID_PARAMETER DriverName is NULL.

-

   @retval EFI_UNSUPPORTED       The driver specified by This does not support

                                 the language specified by Language.

 

@@ -241,15 +103,13 @@ UsbMouseComponentNameGetDriverName (
   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not

   support the language specified by Language, then EFI_UNSUPPORTED is returned.

 

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

                                 EFI_COMPONENT_NAME_PROTOCOL instance.

-

-  @param  ControllerHandle[in]  The handle of a controller that the driver

+  @param  ControllerHandle      The handle of a controller that the driver

                                 specified by This is managing.  This handle

                                 specifies the controller whose name is to be

                                 returned.

-

-  @param  ChildHandle[in]       The handle of the child controller to retrieve

+  @param  ChildHandle           The handle of the child controller to retrieve

                                 the name of.  This is an optional parameter that

                                 may be NULL.  It will be NULL for device

                                 drivers.  It will also be NULL for a bus drivers

@@ -257,8 +117,7 @@ UsbMouseComponentNameGetDriverName (
                                 controller.  It will not be NULL for a bus

                                 driver that wishes to retrieve the name of a

                                 child controller.

-

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

+  @param  Language              A pointer to a Null-terminated ASCII string

                                 array indicating the language.  This is the

                                 language of the driver name that the caller is

                                 requesting, and it must match one of the

@@ -266,8 +125,7 @@ UsbMouseComponentNameGetDriverName (
                                 number of languages supported by a driver is up

                                 to the driver writer. Language is specified in

                                 RFC 3066 or ISO 639-2 language code format.

-

-  @param  ControllerName[out]   A pointer to the Unicode string to return.

+  @param  ControllerName        A pointer to the Unicode string to return.

                                 This Unicode string is the name of the

                                 controller specified by ControllerHandle and

                                 ChildHandle in the language specified by

@@ -278,20 +136,14 @@ UsbMouseComponentNameGetDriverName (
                                 the language specified by Language for the

                                 driver specified by This was returned in

                                 DriverName.

-

   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.

-

   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid

                                 EFI_HANDLE.

-

   @retval EFI_INVALID_PARAMETER Language is NULL.

-

   @retval EFI_INVALID_PARAMETER ControllerName is NULL.

-

   @retval EFI_UNSUPPORTED       The driver specified by This is not currently

                                 managing the controller specified by

                                 ControllerHandle and ChildHandle.

-

   @retval EFI_UNSUPPORTED       The driver specified by This does not support

                                 the language specified by Language.

 

@@ -331,11 +183,11 @@ UsbMouseComponentNameGetControllerName (
                   );

   if (!EFI_ERROR (Status)) {

     gBS->CloseProtocol (

-          ControllerHandle,

-          &gEfiUsbIoProtocolGuid,

-          gUsbMouseDriverBinding.DriverBindingHandle,

-          ControllerHandle

-          );

+           ControllerHandle,

+           &gEfiUsbIoProtocolGuid,

+           gUsbMouseDriverBinding.DriverBindingHandle,

+           ControllerHandle

+           );

 

     return EFI_UNSUPPORTED;

   }

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c
index 212fbf89d2..84eb4ac1c5 100644
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.c
@@ -1,6 +1,5 @@
 /** @file

-

-  Parse mouse hid descriptor.

+  Helper functions to parse HID report descriptor and items.

 

 Copyright (c) 2004 - 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials

@@ -13,21 +12,31 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 **/

 

-#include "MouseHid.h"

+#include "UsbMouse.h"

 

 

 /**

-  Get next item from report descriptor.

+  Get next HID item from report descriptor.

+

+  This function retrieves next HID item from report descriptor, according to

+  the start position.

+  According to USB HID Specification, An item is piece of information

+  about the device. All items have a one-byte prefix that contains

+  the item tag, item type, and item size.

+  There are two basic types of items: short items and long items.

+  If the item is a short item, its optional data size may be 0, 1, 2, or 4 bytes.

+  Only short item is supported here.

 

-  @param  StartPos          Start Position.

-  @param  EndPos            End Position.

-  @param  HidItem           HidItem to return.

+  @param  StartPos          Start position of the HID item to get.

+  @param  EndPos            End position of the range to get the the next HID item.

+  @param  HidItem           Buffer for the HID Item to return.

 

-  @return Position.

+  @return Pointer to end of the HID item returned.

+          NULL if no HID item retrieved.

 

 **/

 UINT8 *

-GetNextItem (

+GetNextHidItem (

   IN  UINT8    *StartPos,

   IN  UINT8    *EndPos,

   OUT HID_ITEM *HidItem

@@ -35,25 +44,25 @@ GetNextItem (
 {

   UINT8 Temp;

 

-  if ((EndPos - StartPos) <= 0) {

+  if (EndPos <= StartPos) {

     return NULL;

   }

 

   Temp = *StartPos;

   StartPos++;

+

   //

-  // bit 2,3

-  //

-  HidItem->Type = (UINT8) ((Temp >> 2) & 0x03);

-  //

-  // bit 4-7

+  // Bit format of prefix byte:

+  // Bits 0-1: Size

+  // Bits 2-3: Type

+  // Bits 4-7: Tag

   //

-  HidItem->Tag = (UINT8) ((Temp >> 4) & 0x0F);

+  HidItem->Type = BitFieldRead8 (Temp, 2, 3);

+  HidItem->Tag  = BitFieldRead8 (Temp, 4, 7);

 

   if (HidItem->Tag == HID_ITEM_TAG_LONG) {

     //

-    // Long Items are not supported by HID rev1.0,

-    // although we try to parse it.

+    // Long Items are not supported, although we try to parse it.

     //

     HidItem->Format = HID_ITEM_FORMAT_LONG;

 

@@ -69,12 +78,9 @@ GetNextItem (
     }

   } else {

     HidItem->Format = HID_ITEM_FORMAT_SHORT;

-    //

-    // bit 0, 1

-    //

-    HidItem->Size   = (UINT8) (Temp & 0x03);

-    switch (HidItem->Size) {

+    HidItem->Size   = BitFieldRead8 (Temp, 0, 1);

 

+    switch (HidItem->Size) {

     case 0:

       //

       // No data

@@ -83,7 +89,7 @@ GetNextItem (
 

     case 1:

       //

-      // One byte data

+      // 1-byte data

       //

       if ((EndPos - StartPos) >= 1) {

         HidItem->Data.U8 = *StartPos++;

@@ -92,7 +98,7 @@ GetNextItem (
 

     case 2:

       //

-      // Two byte data

+      // 2-byte data

       //

       if ((EndPos - StartPos) >= 2) {

         CopyMem (&HidItem->Data.U16, StartPos, sizeof (UINT16));

@@ -102,9 +108,9 @@ GetNextItem (
 

     case 3:

       //

-      // 4 byte data, adjust size

+      // 4-byte data, adjust size

       //

-      HidItem->Size++;

+      HidItem->Size = 4;

       if ((EndPos - StartPos) >= 4) {

         CopyMem (&HidItem->Data.U32, StartPos, sizeof (UINT32));

         StartPos += 4;

@@ -118,11 +124,15 @@ GetNextItem (
 

 

 /**

-  Get item data from report descriptor.

+  Get data from HID item.

 

-  @param  HidItem           The pointer to HID_ITEM.

+  This function retrieves data from HID item.

+  It only supports short items, which has 4 types of data:

+  0, 1, 2, or 4 bytes.

 

-  @return The Data of HidItem.

+  @param  HidItem       Pointer to the HID item.

+

+  @return The data of HID item.

 

 **/

 UINT32

@@ -131,170 +141,89 @@ GetItemData (
   )

 {

   //

-  // Get Data from HID_ITEM structure

+  // Get data from HID item.

   //

   switch (HidItem->Size) {

-

   case 1:

     return HidItem->Data.U8;

-

   case 2:

     return HidItem->Data.U16;

-

   case 4:

     return HidItem->Data.U32;

   }

-

   return 0;

 }

 

-

 /**

-  Parse local item from report descriptor.

+  Parse HID item from report descriptor.

 

+  There are three item types: Main, Global, and Local.

+  This function parses these types of HID items according

+  to tag info.

+  

   @param  UsbMouse          The instance of USB_MOUSE_DEV

-  @param  LocalItem         The pointer to local hid item

+  @param  HidItem           The HID item to parse

 

 **/

 VOID

-ParseLocalItem (

+ParseHidItem (

   IN  USB_MOUSE_DEV   *UsbMouse,

-  IN  HID_ITEM        *LocalItem

+  IN  HID_ITEM        *HidItem

   )

 {

-  UINT32  Data;

+  UINT8  Data;

 

-  if (LocalItem->Size == 0) {

+  switch (HidItem->Type) {

+

+  case HID_ITEM_TYPE_MAIN:

     //

-    // No expected data for local item

+    // we don't care any main items, just skip

     //

-    return ;

-  }

+    return;

 

-  Data = GetItemData (LocalItem);

-

-  switch (LocalItem->Tag) {

-

-  case HID_LOCAL_ITEM_TAG_DELIMITER:

+  case HID_ITEM_TYPE_GLOBAL:

     //

-    // we don't support delimiter here

+    // For global items, we only care Usage Page tag for Button Page here

     //

-    return ;

-

-  case HID_LOCAL_ITEM_TAG_USAGE:

-    return ;

+    if (HidItem->Tag == HID_GLOBAL_ITEM_TAG_USAGE_PAGE) {

+      Data = (UINT8) GetItemData (HidItem);

+      if (Data == 0x09) {

+        //

+        // Button Page

+        //

+        UsbMouse->PrivateData.ButtonDetected = TRUE;

+      }

+    }

+    return;

 

-  case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:

-    if (UsbMouse->PrivateData.ButtonDetected) {

-      UsbMouse->PrivateData.ButtonMinIndex = (UINT8) Data;

+  case HID_ITEM_TYPE_LOCAL:

+    if (HidItem->Size == 0) {

+      //

+      // No expected data for local item

+      //

+      return ;

     }

 

-    return ;

+    Data = (UINT8) GetItemData (HidItem);

 

-  case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:

-    {

+    switch (HidItem->Tag) {

+    case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:

       if (UsbMouse->PrivateData.ButtonDetected) {

-        UsbMouse->PrivateData.ButtonMaxIndex = (UINT8) Data;

+        UsbMouse->PrivateData.ButtonMinIndex = Data;

       }

-

       return ;

-    }

-  }

-}

 

-

-/**

-  Parse global item from report descriptor.

-

-  @param  UsbMouse          The instance of USB_MOUSE_DEV

-  @param  GlobalItem          The pointer to global hid item

-

-**/

-VOID

-ParseGlobalItem (

-  IN  USB_MOUSE_DEV   *UsbMouse,

-  IN  HID_ITEM        *GlobalItem

-  )

-{

-  UINT8 UsagePage;

-

-  switch (GlobalItem->Tag) {

-  case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:

+    case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:

     {

-      UsagePage = (UINT8) GetItemData (GlobalItem);

-

-      //

-      // We only care Button Page here

-      //

-      if (UsagePage == 0x09) {

-        //

-        // Button Page

-        //

-        UsbMouse->PrivateData.ButtonDetected = TRUE;

-        return ;

+      if (UsbMouse->PrivateData.ButtonDetected) {

+        UsbMouse->PrivateData.ButtonMaxIndex = Data;

       }

-      break;

+      return ;

     }

 

-  }

-}

-

-

-/**

-  Parse main item from report descriptor.

-

-  @param  UsbMouse         The instance of USB_MOUSE_DEV

-  @param  MainItem          Main hid item to parse

-

-**/

-VOID

-ParseMainItem (

-  IN  USB_MOUSE_DEV   *UsbMouse,

-  IN  HID_ITEM        *MainItem

-  )

-{

-  //

-  // we don't care any main items, just skip

-  //

-  return ;

-}

-

-

-/**

-  Parse hid item from report descriptor.

-

-  @param  UsbMouse          The instance of USB_MOUSE_DEV

-  @param  HidItem           The hid item to parse

-

-**/

-VOID

-ParseHidItem (

-  IN  USB_MOUSE_DEV   *UsbMouse,

-  IN  HID_ITEM        *HidItem

-  )

-{

-  switch (HidItem->Type) {

-

-  case HID_ITEM_TYPE_MAIN:

-    //

-    // For Main Item, parse main item

-    //

-    ParseMainItem (UsbMouse, HidItem);

-    break;

-

-  case HID_ITEM_TYPE_GLOBAL:

-    //

-    // For global Item, parse global item

-    //

-    ParseGlobalItem (UsbMouse, HidItem);

-    break;

-

-  case HID_ITEM_TYPE_LOCAL:

-    //

-    // For Local Item, parse local item

-    //

-    ParseLocalItem (UsbMouse, HidItem);

-    break;

+    default:

+      return;

+    }

   }

 }

 

@@ -302,17 +231,22 @@ ParseHidItem (
 /**

   Parse Mouse Report Descriptor.

 

+  According to USB HID Specification, report descriptors are

+  composed of pieces of information. Each piece of information

+  is called an Item. This function retrieves each item from

+  the report descriptor and updates USB_MOUSE_DEV.

+

   @param  UsbMouse          The instance of USB_MOUSE_DEV

   @param  ReportDescriptor  Report descriptor to parse

   @param  ReportSize        Report descriptor size

 

-  @retval EFI_DEVICE_ERROR  Report descriptor error

-  @retval EFI_SUCCESS       Parse descriptor success

+  @retval EFI_SUCCESS       Report descriptor successfully parsed.

+  @retval EFI_UNSUPPORTED   Report descriptor contains long item.

 

 **/

 EFI_STATUS

 ParseMouseReportDescriptor (

-  IN  USB_MOUSE_DEV   *UsbMouse,

+  OUT USB_MOUSE_DEV   *UsbMouse,

   IN  UINT8           *ReportDescriptor,

   IN  UINTN           ReportSize

   )

@@ -323,24 +257,25 @@ ParseMouseReportDescriptor (
 

   DescriptorEnd = ReportDescriptor + ReportSize;

 

-  Ptr           = GetNextItem (ReportDescriptor, DescriptorEnd, &HidItem);

-

+  Ptr = GetNextHidItem (ReportDescriptor, DescriptorEnd, &HidItem);

   while (Ptr != NULL) {

     if (HidItem.Format != HID_ITEM_FORMAT_SHORT) {

       //

-      // Long Format Item is not supported at current HID revision

+      // Long Item is not supported at current HID revision

       //

-      return EFI_DEVICE_ERROR;

+      return EFI_UNSUPPORTED;

     }

 

     ParseHidItem (UsbMouse, &HidItem);

 

-    Ptr = GetNextItem (Ptr, DescriptorEnd, &HidItem);

+    Ptr = GetNextHidItem (Ptr, DescriptorEnd, &HidItem);

   }

 

-  UsbMouse->NumberOfButtons                 = (UINT8) (UsbMouse->PrivateData.ButtonMaxIndex - UsbMouse->PrivateData.ButtonMinIndex + 1);

-  UsbMouse->XLogicMax                       = UsbMouse->YLogicMax = 127;

-  UsbMouse->XLogicMin                       = UsbMouse->YLogicMin = -127;

+  UsbMouse->NumberOfButtons = (UINT8) (UsbMouse->PrivateData.ButtonMaxIndex - UsbMouse->PrivateData.ButtonMinIndex + 1);

+  UsbMouse->XLogicMax = 127;

+  UsbMouse->YLogicMax = 127;

+  UsbMouse->XLogicMin = -127;

+  UsbMouse->YLogicMin = -127;

 

   return EFI_SUCCESS;

 }

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
deleted file mode 100644
index 478bccffe9..0000000000
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
+++ /dev/null
@@ -1,91 +0,0 @@
-/** @file

-

-  The interface of HID data structure.

-

-Copyright (c) 2004 - 2008, Intel Corporation

-All rights reserved. This program and the accompanying materials

-are licensed and made available under the terms and conditions of the BSD License

-which accompanies this distribution.  The full text of the license may be found at

-http://opensource.org/licenses/bsd-license.php

-

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

-

-**/

-

-#ifndef _EFI_MOUSE_HID_H_

-#define _EFI_MOUSE_HID_H_

-

-#include "UsbMouse.h"

-

-//

-// HID Item general structure

-//

-typedef struct _hid_item {

-  UINT16  Format;

-  UINT8   Size;

-  UINT8   Type;

-  UINT8   Tag;

-  union {

-    UINT8   U8;

-    UINT16  U16;

-    UINT32  U32;

-    INT8    I8;

-    INT16   I16;

-    INT32   I32;

-    UINT8   *LongData;

-  } Data;

-} HID_ITEM;

-

-typedef struct {

-  UINT16  UsagePage;

-  INT32   LogicMin;

-  INT32   LogicMax;

-  INT32   PhysicalMin;

-  INT32   PhysicalMax;

-  UINT16  UnitExp;

-  UINT16 UINT;

-  UINT16 ReportId;

-  UINT16 ReportSize;

-  UINT16 ReportCount;

-} HID_GLOBAL;

-

-typedef struct {

-  UINT16  Usage[16];  /* usage array */

-  UINT16  UsageIndex;

-  UINT16  UsageMin;

-} HID_LOCAL;

-

-typedef struct {

-  UINT16  Type;

-  UINT16  Usage;

-} HID_COLLECTION;

-

-typedef struct {

-  HID_GLOBAL      Global;

-  HID_GLOBAL      GlobalStack[8];

-  UINT32          GlobalStackPtr;

-  HID_LOCAL       Local;

-  HID_COLLECTION  CollectionStack[8];

-  UINT32          CollectionStackPtr;

-} HID_PARSER;

-

-/**

-  Parse Mouse Report Descriptor.

-

-  @param  UsbMouse          The instance of USB_MOUSE_DEV

-  @param  ReportDescriptor  Report descriptor to parse

-  @param  ReportSize        Report descriptor size

-

-  @retval EFI_DEVICE_ERROR  Report descriptor error

-  @retval EFI_SUCCESS       Parse descriptor success

-

-**/

-EFI_STATUS

-ParseMouseReportDescriptor (

-  IN  USB_MOUSE_DEV   *UsbMouse,

-  IN  UINT8           *ReportDescriptor,

-  IN  UINTN           ReportSize

-  );

-

-#endif

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c
index ffe5c01c2f..f13d26527e 100644
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.c
@@ -1,6 +1,5 @@
 /** @file

-

-  Usb Mouse Driver Binding and Implement SIMPLE_POINTER_PROTOCOL Protocol.

+  USB Mouse Driver that manages USB mouse and produces Simple Pointer Protocol.

 

 Copyright (c) 2004 - 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials

@@ -15,18 +14,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #include "UsbMouse.h"

 

-#include <Library/DebugLib.h>

-#include <IndustryStandard/Usb.h>

-

-

-#include "UsbMouse.h"

-#include "MouseHid.h"

-

-

-EFI_GUID  gEfiUsbMouseDriverGuid = {

-  0x290156b5, 0x6a05, 0x4ac0, {0xb8, 0x0, 0x51, 0x27, 0x55, 0xad, 0x14, 0x29}

-};

-

 EFI_DRIVER_BINDING_PROTOCOL gUsbMouseDriverBinding = {

   USBMouseDriverBindingSupported,

   USBMouseDriverBindingStart,

@@ -37,114 +24,15 @@ EFI_DRIVER_BINDING_PROTOCOL gUsbMouseDriverBinding = {
 };

 

 /**

-  Tell if a Usb Controller is a mouse.

-

-  @param  UsbIo                 Protocol instance pointer.

-

-  @retval TRUE                  It is a mouse.

-  @retval FALSE                 It is not a mouse.

-

-**/

-BOOLEAN

-IsUsbMouse (

-  IN  EFI_USB_IO_PROTOCOL     *UsbIo

-  );

-

-/**

-  Initialize the Usb Mouse Device.

-

-  @param  UsbMouseDev           Device instance to be initialized.

-

-  @retval EFI_SUCCESS           Success.

-  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory.

-  @retval Other                 Init error. 

-

-**/

-EFI_STATUS

-InitializeUsbMouseDevice (

-  IN  USB_MOUSE_DEV           *UsbMouseDev

-  );

-

-/**

-  Event notification function for SIMPLE_POINTER.WaitForInput event

-  Signal the event if there is input from mouse.

-

-  @param  Event                 Wait Event.

-  @param  Context               Passed parameter to event handler.

- 

-**/

-VOID

-EFIAPI

-UsbMouseWaitForInput (

-  IN  EFI_EVENT               Event,

-  IN  VOID                    *Context

-  );

-

-/**

-  It is called whenever there is data received from async interrupt

-  transfer.

-

-  @param  Data                  Data received.

-  @param  DataLength            Length of Data.

-  @param  Context               Passed in context.

-  @param  Result                Async Interrupt Transfer result.

-

-  @return EFI_SUCCESS           Receive data successfully.

-  @return EFI_DEVICE_ERROR      USB async interrupt transfer fails.

-

-**/

-EFI_STATUS

-EFIAPI

-OnMouseInterruptComplete (

-  IN  VOID        *Data,

-  IN  UINTN       DataLength,

-  IN  VOID        *Context,

-  IN  UINT32      Result

-  );

-

-/**

-  Get the mouse state, see SIMPLE POINTER PROTOCOL.

-

-  @param  This                  Protocol instance pointer.

-  @param  MouseState            Current mouse state.

-

-  @return EFI_SUCCESS           Get usb mouse status successfully.

-  @return EFI_DEVICE_ERROR      The parameter is error.

-  @return EFI_NOT_READY         Mouse status doesn't change.

-

-**/

-EFI_STATUS

-EFIAPI

-GetMouseState (

-  IN   EFI_SIMPLE_POINTER_PROTOCOL  *This,

-  OUT  EFI_SIMPLE_POINTER_STATE     *MouseState

-  );

-

-/**

-  Reset the mouse device, see SIMPLE POINTER PROTOCOL.

+  Entrypoint of USB Mouse Driver.

 

-  @param  This                  Protocol instance pointer.

-  @param  ExtendedVerification  Ignored here.

+  This function is the entrypoint of USB Mouse Driver. It installs Driver Binding

+  Protocols together with Component Name Protocols.

 

-  @return EFI_SUCCESS           Reset usb mouse successfully.

+  @param  ImageHandle       The firmware allocated handle for the EFI image.

+  @param  SystemTable       A pointer to the EFI System Table.

 

-**/

-EFI_STATUS

-EFIAPI

-UsbMouseReset (

-  IN EFI_SIMPLE_POINTER_PROTOCOL    *This,

-  IN BOOLEAN                        ExtendedVerification

-  );

-

-

-/**

-  The USB Mouse driver entry pointer.

-

-  @param  ImageHandle      The driver image handle.

-  @param  SystemTable      The system table.

-

-  @return EFI_SUCCESS      The component name protocol is installed.

-  @return Others           Failed to init the usb driver.

+  @retval EFI_SUCCESS       The entry point is executed successfully.

 

 **/

 EFI_STATUS

@@ -154,27 +42,31 @@ USBMouseDriverBindingEntryPoint (
   IN EFI_SYSTEM_TABLE     *SystemTable

   )

 {

-  return EfiLibInstallDriverBindingComponentName2 (

-           ImageHandle,

-           SystemTable,

-           &gUsbMouseDriverBinding,

-           ImageHandle,

-           &gUsbMouseComponentName,

-           &gUsbMouseComponentName2

-           );

+  EFI_STATUS              Status;

+

+  Status = EfiLibInstallDriverBindingComponentName2 (

+             ImageHandle,

+             SystemTable,

+             &gUsbMouseDriverBinding,

+             ImageHandle,

+             &gUsbMouseComponentName,

+             &gUsbMouseComponentName2

+             );

+  ASSERT_EFI_ERROR (Status);

+

+  return EFI_SUCCESS;

 }

 

 

 /**

-  Test to see if this driver supports ControllerHandle. Any ControllerHandle

-  that has UsbIoProtocol installed will be supported.

+  Check whether USB mouse driver supports this device.

 

-  @param  This                  Protocol instance pointer.

-  @param  Controller            Handle of device to test

-  @param  RemainingDevicePath   Not used.

+  @param  This                   The USB mouse driver binding protocol.

+  @param  Controller             The controller handle to check.

+  @param  RemainingDevicePath    The remaining device path.

 

-  @retval EFI_SUCCESS           This driver supports this device.

-  @retval EFI_UNSUPPORTED       This driver does not support this device.

+  @retval EFI_SUCCESS            The driver supports this controller.

+  @retval other                  This device isn't supported.

 

 **/

 EFI_STATUS

@@ -185,29 +77,24 @@ USBMouseDriverBindingSupported (
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath

   )

 {

-  EFI_STATUS          OpenStatus;

-  EFI_USB_IO_PROTOCOL *UsbIo;

   EFI_STATUS          Status;

+  EFI_USB_IO_PROTOCOL *UsbIo;

 

-  OpenStatus = gBS->OpenProtocol (

-                      Controller,

-                      &gEfiUsbIoProtocolGuid,

-                      (VOID **) &UsbIo,

-                      This->DriverBindingHandle,

-                      Controller,

-                      EFI_OPEN_PROTOCOL_BY_DRIVER

-                      );

-  if (EFI_ERROR (OpenStatus) && (OpenStatus != EFI_ALREADY_STARTED)) {

-    return EFI_UNSUPPORTED;

-  }

-

-  if (OpenStatus == EFI_ALREADY_STARTED) {

-    return EFI_ALREADY_STARTED;

+  Status = gBS->OpenProtocol (

+                  Controller,

+                  &gEfiUsbIoProtocolGuid,

+                  (VOID **) &UsbIo,

+                  This->DriverBindingHandle,

+                  Controller,

+                  EFI_OPEN_PROTOCOL_BY_DRIVER

+                  );

+  if (EFI_ERROR (Status)) {

+    return Status;

   }

 

   //

-  // Use the USB I/O protocol interface to see the Controller is

-  // the Mouse controller that can be managed by this driver.

+  // Use the USB I/O Protocol interface to check whether Controller is

+  // a mouse device that can be managed by this driver.

   //

   Status = EFI_SUCCESS;

   if (!IsUsbMouse (UsbIo)) {

@@ -220,16 +107,22 @@ USBMouseDriverBindingSupported (
         This->DriverBindingHandle,

         Controller

         );

+

   return Status;

 }

 

 

 /**

-  Starting the Usb Mouse Driver.

+  Starts the mouse device with this driver.

+

+  This function consumes USB I/O Portocol, intializes USB mouse device,

+  installs Simple Pointer Protocol, and submits Asynchronous Interrupt

+  Transfer to manage the USB mouse device.

 

-  @param  This                  Protocol instance pointer.

-  @param  Controller            Handle of device to test.

-  @param  RemainingDevicePath   Not used.

+  @param  This                  The USB mouse driver binding instance.

+  @param  Controller            Handle of device to bind driver to.

+  @param  RemainingDevicePath   Optional parameter use to pick a specific child

+                                device to start.

 

   @retval EFI_SUCCESS           This driver supports this device.

   @retval EFI_UNSUPPORTED       This driver does not support this device.

@@ -248,17 +141,18 @@ USBMouseDriverBindingStart (
 {

   EFI_STATUS                  Status;

   EFI_USB_IO_PROTOCOL         *UsbIo;

-  EFI_USB_ENDPOINT_DESCRIPTOR *EndpointDesc;

   USB_MOUSE_DEV               *UsbMouseDevice;

   UINT8                       EndpointNumber;

+  EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;

   UINT8                       Index;

   UINT8                       EndpointAddr;

   UINT8                       PollingInterval;

   UINT8                       PacketSize;

+  BOOLEAN                     Found;

 

-  UsbMouseDevice  = NULL;

-  Status          = EFI_SUCCESS;

-

+  //

+  // Open USB I/O Protocol

+  //

   Status = gBS->OpenProtocol (

                   Controller,

                   &gEfiUsbIoProtocolGuid,

@@ -268,30 +162,15 @@ USBMouseDriverBindingStart (
                   EFI_OPEN_PROTOCOL_BY_DRIVER

                   );

   if (EFI_ERROR (Status)) {

-    goto ErrorExit;

+    return Status;

   }

 

   UsbMouseDevice = AllocateZeroPool (sizeof (USB_MOUSE_DEV));

-  if (UsbMouseDevice == NULL) {

-    Status = EFI_OUT_OF_RESOURCES;

-    goto ErrorExit;

-  }

+  ASSERT (UsbMouseDevice != NULL);

 

-  UsbMouseDevice->UsbIo               = UsbIo;

+  UsbMouseDevice->UsbIo     = UsbIo;

+  UsbMouseDevice->Signature = USB_MOUSE_DEV_SIGNATURE;

 

-  UsbMouseDevice->Signature           = USB_MOUSE_DEV_SIGNATURE;

-

-  UsbMouseDevice->InterfaceDescriptor = AllocatePool (sizeof (EFI_USB_INTERFACE_DESCRIPTOR));

-  if (UsbMouseDevice->InterfaceDescriptor == NULL) {

-    Status = EFI_OUT_OF_RESOURCES;

-    goto ErrorExit;

-  }

-

-  EndpointDesc = AllocatePool (sizeof (EFI_USB_ENDPOINT_DESCRIPTOR));

-  if (EndpointDesc == NULL) {

-    Status = EFI_OUT_OF_RESOURCES;

-    goto ErrorExit;

-  }

   //

   // Get the Device Path Protocol on Controller's handle

   //

@@ -311,31 +190,36 @@ USBMouseDriverBindingStart (
   // Get interface & endpoint descriptor

   //

   UsbIo->UsbGetInterfaceDescriptor (

-          UsbIo,

-          UsbMouseDevice->InterfaceDescriptor

-          );

+           UsbIo,

+           &UsbMouseDevice->InterfaceDescriptor

+           );

 

-  EndpointNumber = UsbMouseDevice->InterfaceDescriptor->NumEndpoints;

+  EndpointNumber = UsbMouseDevice->InterfaceDescriptor.NumEndpoints;

 

+  //

+  // Traverse endpoints to find interrupt endpoint

+  //

+  Found = FALSE;

   for (Index = 0; Index < EndpointNumber; Index++) {

     UsbIo->UsbGetEndpointDescriptor (

-            UsbIo,

-            Index,

-            EndpointDesc

-            );

-

-    if ((EndpointDesc->Attributes & 0x03) == 0x03) {

+             UsbIo,

+             Index,

+             &EndpointDescriptor

+             );

 

+    if ((EndpointDescriptor.Attributes & (BIT0 | BIT1)) == USB_ENDPOINT_INTERRUPT) {

       //

       // We only care interrupt endpoint here

       //

-      UsbMouseDevice->IntEndpointDescriptor = EndpointDesc;

+      CopyMem(&UsbMouseDevice->IntEndpointDescriptor, &EndpointDescriptor, sizeof(EndpointDescriptor));

+      Found = TRUE;

+      break;

     }

   }

 

-  if (UsbMouseDevice->IntEndpointDescriptor == NULL) {

+  if (!Found) {

     //

-    // No interrupt endpoint, then error

+    // No interrupt endpoint found, then return unsupported.

     //

     Status = EFI_UNSUPPORTED;

     goto ErrorExit;

@@ -343,15 +227,21 @@ USBMouseDriverBindingStart (
 

   Status = InitializeUsbMouseDevice (UsbMouseDevice);

   if (EFI_ERROR (Status)) {

-    MouseReportStatusCode (

-      UsbMouseDevice->DevicePath,

+    //

+    // Fail to initialize USB mouse device.

+    //

+    REPORT_STATUS_CODE_WITH_DEVICE_PATH (

       EFI_ERROR_CODE | EFI_ERROR_MINOR,

-      PcdGet32 (PcdStatusCodeValueMouseInterfaceError)

+      PcdGet32 (PcdStatusCodeValueMouseInterfaceError),

+      UsbMouseDevice->DevicePath

       );

 

     goto ErrorExit;

   }

 

+  //

+  // Initialize and install EFI Simple Pointer Protocol.

+  //

   UsbMouseDevice->SimplePointerProtocol.GetState  = GetMouseState;

   UsbMouseDevice->SimplePointerProtocol.Reset     = UsbMouseReset;

   UsbMouseDevice->SimplePointerProtocol.Mode      = &UsbMouseDevice->Mode;

@@ -375,28 +265,26 @@ USBMouseDriverBindingStart (
                   );

 

   if (EFI_ERROR (Status)) {

-    Status = EFI_DEVICE_ERROR;

     goto ErrorExit;

   }

 

   //

-  // After Enabling Async Interrupt Transfer on this mouse Device

-  // we will be able to get key data from it. Thus this is deemed as

-  // the enable action of the mouse

+  // The next step would be submitting Asynchronous Interrupt Transfer on this mouse device.

+  // After that we will be able to get key data from it. Thus this is deemed as

+  // the enable action of the mouse, so report status code accordingly.

   //

-

-  MouseReportStatusCode (

-    UsbMouseDevice->DevicePath,

+  REPORT_STATUS_CODE_WITH_DEVICE_PATH (

     EFI_PROGRESS_CODE,

-    PcdGet32 (PcdStatusCodeValueMouseEnable)

+    PcdGet32 (PcdStatusCodeValueMouseEnable),

+    UsbMouseDevice->DevicePath

     );

 

   //

-  // submit async interrupt transfer

+  // Submit Asynchronous Interrupt Transfer to manage this device.

   //

-  EndpointAddr    = UsbMouseDevice->IntEndpointDescriptor->EndpointAddress;

-  PollingInterval = UsbMouseDevice->IntEndpointDescriptor->Interval;

-  PacketSize      = (UINT8) (UsbMouseDevice->IntEndpointDescriptor->MaxPacketSize);

+  EndpointAddr    = UsbMouseDevice->IntEndpointDescriptor.EndpointAddress;

+  PollingInterval = UsbMouseDevice->IntEndpointDescriptor.Interval;

+  PacketSize      = (UINT8) (UsbMouseDevice->IntEndpointDescriptor.MaxPacketSize);

 

   Status = UsbIo->UsbAsyncInterruptTransfer (

                     UsbIo,

@@ -408,38 +296,39 @@ USBMouseDriverBindingStart (
                     UsbMouseDevice

                     );

 

-  if (!EFI_ERROR (Status)) {

-

-    UsbMouseDevice->ControllerNameTable = NULL;

-    AddUnicodeString2 (

-      "eng",

-      gUsbMouseComponentName.SupportedLanguages,

-      &UsbMouseDevice->ControllerNameTable,

-      L"Generic Usb Mouse",

-      TRUE

-      );

-    AddUnicodeString2 (

-      "en",

-      gUsbMouseComponentName2.SupportedLanguages,

-      &UsbMouseDevice->ControllerNameTable,

-      L"Generic Usb Mouse",

-      FALSE

-      );

-

-

-    return EFI_SUCCESS;

+  if (EFI_ERROR (Status)) {

+    //

+    // If submit error, uninstall that interface

+    //

+    gBS->UninstallProtocolInterface (

+           Controller,

+           &gEfiSimplePointerProtocolGuid,

+           &UsbMouseDevice->SimplePointerProtocol

+           );

+    goto ErrorExit;

   }

+  

+  UsbMouseDevice->ControllerNameTable = NULL;

+  AddUnicodeString2 (

+    "eng",

+    gUsbMouseComponentName.SupportedLanguages,

+    &UsbMouseDevice->ControllerNameTable,

+    L"Generic Usb Mouse",

+    TRUE

+    );

+  AddUnicodeString2 (

+    "en",

+    gUsbMouseComponentName2.SupportedLanguages,

+    &UsbMouseDevice->ControllerNameTable,

+    L"Generic Usb Mouse",

+    FALSE

+    );

 

-  //

-  // If submit error, uninstall that interface

-  //

-  Status = EFI_DEVICE_ERROR;

-  gBS->UninstallProtocolInterface (

-        Controller,

-        &gEfiSimplePointerProtocolGuid,

-        &UsbMouseDevice->SimplePointerProtocol

-        );

+  return EFI_SUCCESS;

 

+//

+// Error handler

+//

 ErrorExit:

   if (EFI_ERROR (Status)) {

     gBS->CloseProtocol (

@@ -450,19 +339,11 @@ ErrorExit:
           );

 

     if (UsbMouseDevice != NULL) {

-      if (UsbMouseDevice->InterfaceDescriptor != NULL) {

-        gBS->FreePool (UsbMouseDevice->InterfaceDescriptor);

-      }

-

-      if (UsbMouseDevice->IntEndpointDescriptor != NULL) {

-        gBS->FreePool (UsbMouseDevice->IntEndpointDescriptor);

-      }

-

       if ((UsbMouseDevice->SimplePointerProtocol).WaitForInput != NULL) {

         gBS->CloseEvent ((UsbMouseDevice->SimplePointerProtocol).WaitForInput);

       }

 

-      gBS->FreePool (UsbMouseDevice);

+      FreePool (UsbMouseDevice);

       UsbMouseDevice = NULL;

     }

   }

@@ -472,16 +353,16 @@ ErrorExit:
 

 

 /**

-  Stop this driver on ControllerHandle. Support stopping any child handles

-  created by this driver.

+  Stop the USB mouse device handled by this driver.

 

-  @param  This                  Protocol instance pointer.

-  @param  Controller            Handle of device to stop driver on.

-  @param  NumberOfChildren      Number of Children in the ChildHandleBuffer.

-  @param  ChildHandleBuffer     List of handles for the children we need to stop.

+  @param  This                   The USB mouse driver binding protocol.

+  @param  Controller             The controller to release.

+  @param  NumberOfChildren       The number of handles in ChildHandleBuffer.

+  @param  ChildHandleBuffer      The array of child handle.

 

-  @retval EFI_SUCCESS           The controller or children are stopped.

-  @retval Other                 Failed to stop the driver.

+  @retval EFI_SUCCESS            The device was stopped.

+  @retval EFI_UNSUPPORTED        Simple Pointer Protocol is not installed on Controller.

+  @retval Others                 Fail to uninstall protocols attached on the device.

 

 **/

 EFI_STATUS

@@ -498,9 +379,6 @@ USBMouseDriverBindingStop (
   EFI_SIMPLE_POINTER_PROTOCOL *SimplePointerProtocol;

   EFI_USB_IO_PROTOCOL         *UsbIo;

 

-  //

-  // Get our context back.

-  //

   Status = gBS->OpenProtocol (

                   Controller,

                   &gEfiSimplePointerProtocolGuid,

@@ -516,44 +394,29 @@ USBMouseDriverBindingStop (
 

   UsbMouseDevice = USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (SimplePointerProtocol);

 

-  gBS->CloseProtocol (

-        Controller,

-        &gEfiSimplePointerProtocolGuid,

-        This->DriverBindingHandle,

-        Controller

-        );

-

   UsbIo = UsbMouseDevice->UsbIo;

 

   //

-  // Uninstall the Asyn Interrupt Transfer from this device

-  // will disable the mouse data input from this device

+  // The key data input from this device will be disabled.

   //

-  MouseReportStatusCode (

-    UsbMouseDevice->DevicePath,

+  REPORT_STATUS_CODE_WITH_DEVICE_PATH (

     EFI_PROGRESS_CODE,

-    PcdGet32 (PcdStatusCodeValueMouseDisable)

+    PcdGet32 (PcdStatusCodeValueMouseDisable),

+    UsbMouseDevice->DevicePath

     );

 

   //

-  // Delete Mouse Async Interrupt Transfer

+  // Delete the Asynchronous Interrupt Transfer from this device

   //

   UsbIo->UsbAsyncInterruptTransfer (

-          UsbIo,

-          UsbMouseDevice->IntEndpointDescriptor->EndpointAddress,

-          FALSE,

-          UsbMouseDevice->IntEndpointDescriptor->Interval,

-          0,

-          NULL,

-          NULL

-          );

-

-  gBS->CloseEvent (UsbMouseDevice->SimplePointerProtocol.WaitForInput);

-

-  if (UsbMouseDevice->DelayedRecoveryEvent != NULL) {

-    gBS->CloseEvent (UsbMouseDevice->DelayedRecoveryEvent);

-    UsbMouseDevice->DelayedRecoveryEvent = 0;

-  }

+           UsbIo,

+           UsbMouseDevice->IntEndpointDescriptor.EndpointAddress,

+           FALSE,

+           UsbMouseDevice->IntEndpointDescriptor.Interval,

+           0,

+           NULL,

+           NULL

+           );

 

   Status = gBS->UninstallProtocolInterface (

                   Controller,

@@ -565,20 +428,27 @@ USBMouseDriverBindingStop (
   }

 

   gBS->CloseProtocol (

-        Controller,

-        &gEfiUsbIoProtocolGuid,

-        This->DriverBindingHandle,

-        Controller

-        );

+         Controller,

+         &gEfiUsbIoProtocolGuid,

+         This->DriverBindingHandle,

+         Controller

+         );

+

+  //

+  // Free all resources.

+  //

+  gBS->CloseEvent (UsbMouseDevice->SimplePointerProtocol.WaitForInput);

 

-  gBS->FreePool (UsbMouseDevice->InterfaceDescriptor);

-  gBS->FreePool (UsbMouseDevice->IntEndpointDescriptor);

+  if (UsbMouseDevice->DelayedRecoveryEvent != NULL) {

+    gBS->CloseEvent (UsbMouseDevice->DelayedRecoveryEvent);

+    UsbMouseDevice->DelayedRecoveryEvent = NULL;

+  }

 

   if (UsbMouseDevice->ControllerNameTable != NULL) {

     FreeUnicodeStringTable (UsbMouseDevice->ControllerNameTable);

   }

 

-  gBS->FreePool (UsbMouseDevice);

+  FreePool (UsbMouseDevice);

 

   return EFI_SUCCESS;

 

@@ -586,12 +456,12 @@ USBMouseDriverBindingStop (
 

 

 /**

-  Tell if a Usb Controller is a mouse.

+  Uses USB I/O to check whether the device is a USB mouse device.

 

-  @param  UsbIo                 Protocol instance pointer.

+  @param  UsbIo    Pointer to a USB I/O protocol instance.

 

-  @retval TRUE                  It is a mouse.

-  @retval FALSE                 It is not a mouse.

+  @retval TRUE     Device is a USB mouse device.

+  @retval FALSE    Device is a not USB mouse device.

 

 **/

 BOOLEAN

@@ -603,8 +473,7 @@ IsUsbMouse (
   EFI_USB_INTERFACE_DESCRIPTOR  InterfaceDescriptor;

 

   //

-  // Get the Default interface descriptor, now we only

-  // suppose it is interface 1

+  // Get the default interface descriptor

   //

   Status = UsbIo->UsbGetInterfaceDescriptor (

                     UsbIo,

@@ -627,18 +496,23 @@ IsUsbMouse (
 

 

 /**

-  Initialize the Usb Mouse Device.

+  Initialize the USB mouse device.

+

+  This function retrieves and parses HID report descriptor, and

+  initializes state of USB_MOUSE_DEV. Then it sets indefinite idle

+  rate for the device. Finally it creates event for delayed recovery,

+  which deals with device error.

 

   @param  UsbMouseDev           Device instance to be initialized.

 

-  @retval EFI_SUCCESS           Success.

-  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory.

-  @retval Other                 Init error. 

+  @retval EFI_SUCCESS           USB mouse device successfully initialized..

+  @retval EFI_UNSUPPORTED       HID descriptor type is not report descriptor.

+  @retval Other                 USB mouse device was not initialized successfully.

 

 **/

 EFI_STATUS

 InitializeUsbMouseDevice (

-  IN  USB_MOUSE_DEV           *UsbMouseDev

+  IN OUT USB_MOUSE_DEV           *UsbMouseDev

   )

 {

   EFI_USB_IO_PROTOCOL     *UsbIo;

@@ -646,6 +520,8 @@ InitializeUsbMouseDevice (
   EFI_STATUS              Status;

   EFI_USB_HID_DESCRIPTOR  MouseHidDesc;

   UINT8                   *ReportDesc;

+  UINT8                   ReportId;

+  UINT8                   Duration;

 

   UsbIo = UsbMouseDev->UsbIo;

 

@@ -653,36 +529,33 @@ InitializeUsbMouseDevice (
   // Get HID descriptor

   //

   Status = UsbGetHidDescriptor (

-            UsbIo,

-            UsbMouseDev->InterfaceDescriptor->InterfaceNumber,

-            &MouseHidDesc

-            );

-

+             UsbIo,

+             UsbMouseDev->InterfaceDescriptor.InterfaceNumber,

+             &MouseHidDesc

+             );

   if (EFI_ERROR (Status)) {

     return Status;

   }

 

   //

-  // Get Report descriptor

+  // Get report descriptor

   //

-  if (MouseHidDesc.HidClassDesc[0].DescriptorType != 0x22) {

+  if (MouseHidDesc.HidClassDesc[0].DescriptorType != USB_DESC_TYPE_REPORT) {

     return EFI_UNSUPPORTED;

   }

 

   ReportDesc = AllocateZeroPool (MouseHidDesc.HidClassDesc[0].DescriptorLength);

-  if (ReportDesc == NULL) {

-    return EFI_OUT_OF_RESOURCES;

-  }

+  ASSERT (ReportDesc != NULL);

 

   Status = UsbGetReportDescriptor (

-            UsbIo,

-            UsbMouseDev->InterfaceDescriptor->InterfaceNumber,

-            MouseHidDesc.HidClassDesc[0].DescriptorLength,

-            ReportDesc

-            );

+             UsbIo,

+             UsbMouseDev->InterfaceDescriptor.InterfaceNumber,

+             MouseHidDesc.HidClassDesc[0].DescriptorLength,

+             ReportDesc

+             );

 

   if (EFI_ERROR (Status)) {

-    gBS->FreePool (ReportDesc);

+    FreePool (ReportDesc);

     return Status;

   }

 

@@ -690,89 +563,106 @@ InitializeUsbMouseDevice (
   // Parse report descriptor

   //

   Status = ParseMouseReportDescriptor (

-            UsbMouseDev,

-            ReportDesc,

-            MouseHidDesc.HidClassDesc[0].DescriptorLength

-            );

+             UsbMouseDev,

+             ReportDesc,

+             MouseHidDesc.HidClassDesc[0].DescriptorLength

+             );

 

   if (EFI_ERROR (Status)) {

-    gBS->FreePool (ReportDesc);

+    FreePool (ReportDesc);

     return Status;

   }

 

+  //

+  // Check the presence of left and right buttons,

+  // and initialize fields of EFI_SIMPLE_POINTER_MODE.

+  //

   if (UsbMouseDev->NumberOfButtons >= 1) {

     UsbMouseDev->Mode.LeftButton = TRUE;

   }

-

   if (UsbMouseDev->NumberOfButtons > 1) {

     UsbMouseDev->Mode.RightButton = TRUE;

   }

-

   UsbMouseDev->Mode.ResolutionX = 8;

   UsbMouseDev->Mode.ResolutionY = 8;

   UsbMouseDev->Mode.ResolutionZ = 0;

+

   //

-  // Here we just assume interface 0 is the mouse interface

+  // Set boot protocol for the USB mouse.

+  // This driver only supports boot protocol.

   //

   UsbGetProtocolRequest (

     UsbIo,

-    0,

+    UsbMouseDev->InterfaceDescriptor.InterfaceNumber,

     &Protocol

     );

-

   if (Protocol != BOOT_PROTOCOL) {

     Status = UsbSetProtocolRequest (

-              UsbIo,

-              0,

-              BOOT_PROTOCOL

-              );

+               UsbIo,

+               0,

+               BOOT_PROTOCOL

+               );

 

     if (EFI_ERROR (Status)) {

-      gBS->FreePool (ReportDesc);

-      return EFI_DEVICE_ERROR;

+      FreePool (ReportDesc);

+      return Status;

     }

   }

 

   //

-  // Set indefinite Idle rate for USB Mouse

+  // ReportId is zero, which means the idle rate applies to all input reports.

+  //

+  ReportId = 0;

   //

+  // Duration is zero, which means the duration is infinite.

+  // so the endpoint will inhibit reporting forever,

+  // and only reporting when a change is detected in the report data.

+  //

+  Duration = 0;

   UsbSetIdleRequest (

     UsbIo,

-    0,

-    0,

-    0

+    UsbMouseDev->InterfaceDescriptor.InterfaceNumber,

+    ReportId,

+    Duration

     );

 

-  gBS->FreePool (ReportDesc);

+  FreePool (ReportDesc);

 

+  //

+  // Create event for delayed recovery, which deals with device error.

+  //

   if (UsbMouseDev->DelayedRecoveryEvent != NULL) {

     gBS->CloseEvent (UsbMouseDev->DelayedRecoveryEvent);

     UsbMouseDev->DelayedRecoveryEvent = 0;

   }

 

-  Status = gBS->CreateEvent (

-                  EVT_TIMER | EVT_NOTIFY_SIGNAL,

-                  TPL_NOTIFY,

-                  USBMouseRecoveryHandler,

-                  UsbMouseDev,

-                  &UsbMouseDev->DelayedRecoveryEvent

-                  );

+  gBS->CreateEvent (

+         EVT_TIMER | EVT_NOTIFY_SIGNAL,

+         TPL_NOTIFY,

+         USBMouseRecoveryHandler,

+         UsbMouseDev,

+         &UsbMouseDev->DelayedRecoveryEvent

+         );

 

   return EFI_SUCCESS;

 }

 

 

 /**

-  It is called whenever there is data received from async interrupt

-  transfer.

+  Handler function for USB mouse's asynchronous interrupt transfer.

+

+  This function is the handler function for USB mouse's asynchronous interrupt transfer

+  to manage the mouse. It parses data returned from asynchronous interrupt transfer, and

+  get button and movement state.

 

-  @param  Data                  Data received.

-  @param  DataLength            Length of Data.

-  @param  Context               Passed in context.

-  @param  Result                Async Interrupt Transfer result.

+  @param  Data             A pointer to a buffer that is filled with key data which is

+                           retrieved via asynchronous interrupt transfer.

+  @param  DataLength       Indicates the size of the data buffer.

+  @param  Context          Pointing to USB_KB_DEV instance.

+  @param  Result           Indicates the result of the asynchronous interrupt transfer.

 

-  @return EFI_SUCCESS           Receive data successfully.

-  @return EFI_DEVICE_ERROR      USB async interrupt transfer fails.

+  @retval EFI_SUCCESS      Asynchronous interrupt transfer is handled successfully.

+  @retval EFI_DEVICE_ERROR Hardware error occurs.

 

 **/

 EFI_STATUS

@@ -796,14 +686,14 @@ OnMouseInterruptComplete (
     //

     // Some errors happen during the process

     //

-    MouseReportStatusCode (

-      UsbMouseDevice->DevicePath,

+    REPORT_STATUS_CODE_WITH_DEVICE_PATH (

       EFI_ERROR_CODE | EFI_ERROR_MINOR,

-      PcdGet32 (PcdStatusCodeValueMouseInputError)

+      PcdGet32 (PcdStatusCodeValueMouseInputError),

+      UsbMouseDevice->DevicePath

       );

 

     if ((Result & EFI_USB_ERR_STALL) == EFI_USB_ERR_STALL) {

-      EndpointAddr = UsbMouseDevice->IntEndpointDescriptor->EndpointAddress;

+      EndpointAddr = UsbMouseDevice->IntEndpointDescriptor.EndpointAddress;

 

       UsbClearEndpointHalt (

         UsbIo,

@@ -812,24 +702,33 @@ OnMouseInterruptComplete (
         );

     }

 

+    //

+    // Delete & Submit this interrupt again

+    // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt. 

+    //

     UsbIo->UsbAsyncInterruptTransfer (

-            UsbIo,

-            UsbMouseDevice->IntEndpointDescriptor->EndpointAddress,

-            FALSE,

-            0,

-            0,

-            NULL,

-            NULL

-            );

-

+             UsbIo,

+             UsbMouseDevice->IntEndpointDescriptor.EndpointAddress,

+             FALSE,

+             0,

+             0,

+             NULL,

+             NULL

+             );

+    //

+    // EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.

+    //

     gBS->SetTimer (

-          UsbMouseDevice->DelayedRecoveryEvent,

-          TimerRelative,

-          EFI_USB_INTERRUPT_DELAY

-          );

+           UsbMouseDevice->DelayedRecoveryEvent,

+           TimerRelative,

+           EFI_USB_INTERRUPT_DELAY

+           );

     return EFI_DEVICE_ERROR;

   }

 

+  //

+  // If no error and no data, just return EFI_SUCCESS.

+  //

   if (DataLength == 0 || Data == NULL) {

     return EFI_SUCCESS;

   }

@@ -838,9 +737,18 @@ OnMouseInterruptComplete (
 

   //

   // Check mouse Data

-  //

-  UsbMouseDevice->State.LeftButton  = (BOOLEAN) (*(UINT8 *) Data & 0x01);

-  UsbMouseDevice->State.RightButton = (BOOLEAN) (*(UINT8 *) Data & 0x02);

+  // USB HID Specification specifies following data format:

+  // Byte    Bits    Description

+  // 0       0       Button 1

+  //         1       Button 2

+  //         2       Button 3

+  //         4 to 7  Device-specific

+  // 1       0 to 7  X displacement

+  // 2       0 to 7  Y displacement

+  // 3 to n  0 to 7  Device specific (optional)

+  //

+  UsbMouseDevice->State.LeftButton  = (BOOLEAN) ((*(UINT8 *) Data & BIT0) != 0);

+  UsbMouseDevice->State.RightButton = (BOOLEAN) ((*(UINT8 *) Data & BIT1) != 0);

   UsbMouseDevice->State.RelativeMovementX += *((INT8 *) Data + 1);

   UsbMouseDevice->State.RelativeMovementY += *((INT8 *) Data + 2);

 

@@ -851,16 +759,18 @@ OnMouseInterruptComplete (
   return EFI_SUCCESS;

 }

 

-

 /**

-  Get the mouse state, see SIMPLE POINTER PROTOCOL.

-

-  @param  This                  Protocol instance pointer.

-  @param  MouseState            Current mouse state.

-

-  @return EFI_SUCCESS           Get usb mouse status successfully.

-  @return EFI_DEVICE_ERROR      The parameter is error.

-  @return EFI_NOT_READY         Mouse status doesn't change.

+  Retrieves the current state of a pointer device.

+    

+  @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.                                   

+  @param  MouseState            A pointer to the state information on the pointer device.

+                                

+  @retval EFI_SUCCESS           The state of the pointer device was returned in State.

+  @retval EFI_NOT_READY         The state of the pointer device has not changed since the last call to

+                                GetState().                                                           

+  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to retrieve the pointer device's

+                                current state.                                                           

+  @retval EFI_INVALID_PARAMETER MouseState is NULL.                                                           

 

 **/

 EFI_STATUS

@@ -873,7 +783,7 @@ GetMouseState (
   USB_MOUSE_DEV *MouseDev;

 

   if (MouseState == NULL) {

-    return EFI_DEVICE_ERROR;

+    return EFI_INVALID_PARAMETER;

   }

 

   MouseDev = USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (This);

@@ -882,6 +792,9 @@ GetMouseState (
     return EFI_NOT_READY;

   }

 

+  //

+  // Retrieve mouse state from USB_MOUSE_DEV, which was filled by OnMouseInterruptComplete()

+  //

   CopyMem (

     MouseState,

     &MouseDev->State,

@@ -901,13 +814,15 @@ GetMouseState (
 }

 

 

-/**

-  Reset the mouse device, see SIMPLE POINTER PROTOCOL.

-

-  @param  This                  Protocol instance pointer.

-  @param  ExtendedVerification  Ignored here.

-

-  @return EFI_SUCCESS           Reset usb mouse successfully.

+/**                                                                 

+  Resets the pointer device hardware.

+  

+  @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.

+  @param  ExtendedVerification  Indicates that the driver may perform a more exhaustive

+                                verification operation of the device during reset.

+                                

+  @retval EFI_SUCCESS           The device was reset.

+  @retval EFI_DEVICE_ERROR      The device is not functioning correctly and could not be reset.

 

 **/

 EFI_STATUS

@@ -921,13 +836,15 @@ UsbMouseReset (
 

   UsbMouseDevice  = USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (This);

 

-  MouseReportStatusCode (

-    UsbMouseDevice->DevicePath,

+  REPORT_STATUS_CODE_WITH_DEVICE_PATH (

     EFI_PROGRESS_CODE,

-    PcdGet32 (PcdStatusCodeValueMouseReset)

-

+    PcdGet32 (PcdStatusCodeValueMouseReset),

+    UsbMouseDevice->DevicePath

     );

 

+  //

+  // Clear mouse state.

+  //

   ZeroMem (

     &UsbMouseDevice->State,

     sizeof (EFI_SIMPLE_POINTER_STATE)

@@ -939,11 +856,10 @@ UsbMouseReset (
 

 

 /**

-  Event notification function for SIMPLE_POINTER.WaitForInput event

-  Signal the event if there is input from mouse.

+  Event notification function for SIMPLE_POINTER.WaitForInput event.

 

-  @param  Event                 Wait Event

-  @param  Context               Passed parameter to event handler

+  @param  Event        Event to be signaled when there's input from mouse.

+  @param  Context      Points to USB_MOUSE_DEV instance.

  

 **/

 VOID

@@ -958,8 +874,7 @@ UsbMouseWaitForInput (
   UsbMouseDev = (USB_MOUSE_DEV *) Context;

 

   //

-  // Someone is waiting on the mouse event, if there's

-  // input from mouse, signal the event

+  // If there's input from mouse, signal the event.

   //

   if (UsbMouseDev->StateChanged) {

     gBS->SignalEvent (Event);

@@ -968,11 +883,16 @@ UsbMouseWaitForInput (
 

 

 /**

-  Timer handler for Delayed Recovery timer.

+  Handler for Delayed Recovery event.

 

-  @param  Event                 The Delayed Recovery event.

-  @param  Context               Points to the USB_KB_DEV instance.

+  This function is the handler for Delayed Recovery event triggered

+  by timer.

+  After a device error occurs, the event would be triggered

+  with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY

+  is defined in USB standard for error handling.

 

+  @param  Event              The Delayed Recovery event.

+  @param  Context            Points to the USB_MOUSE_DEV instance.

 

 **/

 VOID

@@ -989,38 +909,16 @@ USBMouseRecoveryHandler (
 

   UsbIo       = UsbMouseDev->UsbIo;

 

+  //

+  // Re-submit Asynchronous Interrupt Transfer for recovery.

+  //

   UsbIo->UsbAsyncInterruptTransfer (

-          UsbIo,

-          UsbMouseDev->IntEndpointDescriptor->EndpointAddress,

-          TRUE,

-          UsbMouseDev->IntEndpointDescriptor->Interval,

-          UsbMouseDev->IntEndpointDescriptor->MaxPacketSize,

-          OnMouseInterruptComplete,

-          UsbMouseDev

-          );

-}

-

-

-/**

-  Report Status Code in Usb Bot Driver.

-

-  @param  DevicePath            Use this to get Device Path

-  @param  CodeType              Status Code Type

-  @param  CodeValue             Status Code Value

-

-  @return None

-

-**/

-VOID

-MouseReportStatusCode (

-  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,

-  IN EFI_STATUS_CODE_TYPE      CodeType,

-  IN EFI_STATUS_CODE_VALUE     Value

-  )

-{

-  REPORT_STATUS_CODE_WITH_DEVICE_PATH (

-    CodeType,

-    Value,

-    DevicePath

-    );

+           UsbIo,

+           UsbMouseDev->IntEndpointDescriptor.EndpointAddress,

+           TRUE,

+           UsbMouseDev->IntEndpointDescriptor.Interval,

+           UsbMouseDev->IntEndpointDescriptor.MaxPacketSize,

+           OnMouseInterruptComplete,

+           UsbMouseDev

+           );

 }

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h
index 037ec2b86c..7c0ff785a2 100644
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouse.h
@@ -1,5 +1,4 @@
 /** @file

-

   Helper routine and corresponding data struct used by USB Mouse Driver.

 

 Copyright (c) 2004 - 2008, Intel Corporation

@@ -31,6 +30,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/MemoryAllocationLib.h>

 #include <Library/PcdLib.h>

 #include <Library/UefiUsbLib.h>

+#include <Library/DebugLib.h>

 

 #include <IndustryStandard/Usb.h>

 

@@ -43,20 +43,26 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #define USB_MOUSE_DEV_SIGNATURE SIGNATURE_32 ('u', 'm', 'o', 'u')

 

+///

+/// Button range and status

+///

 typedef struct {

   BOOLEAN ButtonDetected;

   UINT8   ButtonMinIndex;

   UINT8   ButtonMaxIndex;

   UINT8   Reserved;

-} PRIVATE_DATA;

+} USB_MOUSE_BUTTON_DATA;

 

+///

+/// Device instance of USB mouse.

+///

 typedef struct {

   UINTN                         Signature;

   EFI_DEVICE_PATH_PROTOCOL      *DevicePath;

   EFI_EVENT                     DelayedRecoveryEvent;

   EFI_USB_IO_PROTOCOL           *UsbIo;

-  EFI_USB_INTERFACE_DESCRIPTOR  *InterfaceDescriptor;

-  EFI_USB_ENDPOINT_DESCRIPTOR   *IntEndpointDescriptor;

+  EFI_USB_INTERFACE_DESCRIPTOR  InterfaceDescriptor;

+  EFI_USB_ENDPOINT_DESCRIPTOR   IntEndpointDescriptor;

   UINT8                         NumberOfButtons;

   INT32                         XLogicMax;

   INT32                         XLogicMin;

@@ -66,134 +72,383 @@ typedef struct {
   EFI_SIMPLE_POINTER_STATE      State;

   EFI_SIMPLE_POINTER_MODE       Mode;

   BOOLEAN                       StateChanged;

-  PRIVATE_DATA                  PrivateData;

+  USB_MOUSE_BUTTON_DATA         PrivateData;

   EFI_UNICODE_STRING_TABLE      *ControllerNameTable;

 } USB_MOUSE_DEV;

 

+///

+/// General HID Item structure

+///

+typedef struct {

+  UINT16  Format;

+  UINT8   Size;

+  UINT8   Type;

+  UINT8   Tag;

+  union {

+    UINT8   U8;

+    UINT16  U16;

+    UINT32  U32;

+    INT8    I8;

+    INT16   I16;

+    INT32   I32;

+    UINT8   *LongData;

+  } Data;

+} HID_ITEM;

+

 #define USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL(a) \

     CR(a, USB_MOUSE_DEV, SimplePointerProtocol, USB_MOUSE_DEV_SIGNATURE)

 

+//

+// Global Variables

+//

+extern EFI_DRIVER_BINDING_PROTOCOL   gUsbMouseDriverBinding;

+extern EFI_COMPONENT_NAME_PROTOCOL   gUsbMouseComponentName;

+extern EFI_COMPONENT_NAME2_PROTOCOL  gUsbMouseComponentName2;

+

+//

+// Functions of Driver Binding Protocol

+//

 

 /**

-  Timer handler for Delayed Recovery timer.

+  Check whether USB mouse driver supports this device.

 

-  @param  Event                 The Delayed Recovery event.

-  @param  Context               Points to the USB_KB_DEV instance.

+  @param  This                   The USB mouse driver binding protocol.

+  @param  Controller             The controller handle to check.

+  @param  RemainingDevicePath    The remaining device path.

 

+  @retval EFI_SUCCESS            The driver supports this controller.

+  @retval other                  This device isn't supported.

 

 **/

-VOID

+EFI_STATUS

 EFIAPI

-USBMouseRecoveryHandler (

-  IN    EFI_EVENT    Event,

-  IN    VOID         *Context

+USBMouseDriverBindingSupported (

+  IN EFI_DRIVER_BINDING_PROTOCOL    *This,

+  IN EFI_HANDLE                     Controller,

+  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath

+  );

+

+/**

+  Starts the mouse device with this driver.

+

+  This function consumes USB I/O Portocol, intializes USB mouse device,

+  installs Simple Pointer Protocol, and submits Asynchronous Interrupt

+  Transfer to manage the USB mouse device.

+

+  @param  This                  The USB mouse driver binding instance.

+  @param  Controller            Handle of device to bind driver to.

+  @param  RemainingDevicePath   Optional parameter use to pick a specific child

+                                device to start.

+

+  @retval EFI_SUCCESS           This driver supports this device.

+  @retval EFI_UNSUPPORTED       This driver does not support this device.

+  @retval EFI_DEVICE_ERROR      This driver cannot be started due to device Error.

+  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory resources.

+  @retval EFI_ALREADY_STARTED   This driver has been started.

+

+**/

+EFI_STATUS

+EFIAPI

+USBMouseDriverBindingStart (

+  IN EFI_DRIVER_BINDING_PROTOCOL    *This,

+  IN EFI_HANDLE                     Controller,

+  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath

+  );

+

+/**

+  Stop the USB mouse device handled by this driver.

+

+  @param  This                   The USB mouse driver binding protocol.

+  @param  Controller             The controller to release.

+  @param  NumberOfChildren       The number of handles in ChildHandleBuffer.

+  @param  ChildHandleBuffer      The array of child handle.

+

+  @retval EFI_SUCCESS            The device was stopped.

+  @retval EFI_UNSUPPORTED        Simple Pointer Protocol is not installed on Controller.

+  @retval Others                 Fail to uninstall protocols attached on the device.

+

+**/

+EFI_STATUS

+EFIAPI

+USBMouseDriverBindingStop (

+  IN  EFI_DRIVER_BINDING_PROTOCOL   *This,

+  IN  EFI_HANDLE                    Controller,

+  IN  UINTN                         NumberOfChildren,

+  IN  EFI_HANDLE                    *ChildHandleBuffer

   );

 

 //

-// Global Variables

+// EFI Component Name Functions

 //

-extern EFI_DRIVER_BINDING_PROTOCOL   gUsbMouseDriverBinding;

-extern EFI_COMPONENT_NAME_PROTOCOL   gUsbMouseComponentName;

-extern EFI_COMPONENT_NAME2_PROTOCOL  gUsbMouseComponentName2;

-extern EFI_GUID                      gEfiUsbMouseDriverGuid;

 

+/**

+  Retrieves a Unicode string that is the user readable name of the driver.

+

+  This function retrieves the user readable name of a driver in the form of a

+  Unicode string. If the driver specified by This has a user readable name in

+  the language specified by Language, then a pointer to the driver name is

+  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified

+  by This does not support the language specified by Language,

+  then EFI_UNSUPPORTED is returned.

+

+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

+                                EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param  Language              A pointer to a Null-terminated ASCII string

+                                array indicating the language. This is the

+                                language of the driver name that the caller is

+                                requesting, and it must match one of the

+                                languages specified in SupportedLanguages. The

+                                number of languages supported by a driver is up

+                                to the driver writer. Language is specified

+                                in RFC 3066 or ISO 639-2 language code format.

+  @param  DriverName            A pointer to the Unicode string to return.

+                                This Unicode string is the name of the

+                                driver specified by This in the language

+                                specified by Language.

+

+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by

+                                This and the language specified by Language was

+                                returned in DriverName.

+  @retval EFI_INVALID_PARAMETER Language is NULL.

+  @retval EFI_INVALID_PARAMETER DriverName is NULL.

+  @retval EFI_UNSUPPORTED       The driver specified by This does not support

+                                the language specified by Language.

+

+**/

+EFI_STATUS

+EFIAPI

+UsbMouseComponentNameGetDriverName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

+  IN  CHAR8                        *Language,

+  OUT CHAR16                       **DriverName

+  );

 

 /**

-  Report Status Code in Usb Bot Driver.

+  Retrieves a Unicode string that is the user readable name of the controller

+  that is being managed by a driver.

+

+  This function retrieves the user readable name of the controller specified by

+  ControllerHandle and ChildHandle in the form of a Unicode string. If the

+  driver specified by This has a user readable name in the language specified by

+  Language, then a pointer to the controller name is returned in ControllerName,

+  and EFI_SUCCESS is returned.  If the driver specified by This is not currently

+  managing the controller specified by ControllerHandle and ChildHandle,

+  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not

+  support the language specified by Language, then EFI_UNSUPPORTED is returned.

+

+  @param  This                  A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

+                                EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param  ControllerHandle      The handle of a controller that the driver

+                                specified by This is managing.  This handle

+                                specifies the controller whose name is to be

+                                returned.

+  @param  ChildHandle           The handle of the child controller to retrieve

+                                the name of.  This is an optional parameter that

+                                may be NULL.  It will be NULL for device

+                                drivers.  It will also be NULL for a bus drivers

+                                that wish to retrieve the name of the bus

+                                controller.  It will not be NULL for a bus

+                                driver that wishes to retrieve the name of a

+                                child controller.

+  @param  Language              A pointer to a Null-terminated ASCII string

+                                array indicating the language.  This is the

+                                language of the driver name that the caller is

+                                requesting, and it must match one of the

+                                languages specified in SupportedLanguages. The

+                                number of languages supported by a driver is up

+                                to the driver writer. Language is specified in

+                                RFC 3066 or ISO 639-2 language code format.

+  @param  ControllerName        A pointer to the Unicode string to return.

+                                This Unicode string is the name of the

+                                controller specified by ControllerHandle and

+                                ChildHandle in the language specified by

+                                Language from the point of view of the driver

+                                specified by This.

+

+  @retval EFI_SUCCESS           The Unicode string for the user readable name in

+                                the language specified by Language for the

+                                driver specified by This was returned in

+                                DriverName.

+  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid

+                                EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER Language is NULL.

+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.

+  @retval EFI_UNSUPPORTED       The driver specified by This is not currently

+                                managing the controller specified by

+                                ControllerHandle and ChildHandle.

+  @retval EFI_UNSUPPORTED       The driver specified by This does not support

+                                the language specified by Language.

 

-  @param  DevicePath            Use this to get Device Path

-  @param  CodeType              Status Code Type

-  @param  CodeValue             Status Code Value

+**/

+EFI_STATUS

+EFIAPI

+UsbMouseComponentNameGetControllerName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,

+  IN  EFI_HANDLE                                      ControllerHandle,

+  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,

+  IN  CHAR8                                           *Language,

+  OUT CHAR16                                          **ControllerName

+  );

 

-  @return None

+//

+// Internal worker functions

+//

+

+/**

+  Uses USB I/O to check whether the device is a USB mouse device.

+

+  @param  UsbIo    Pointer to a USB I/O protocol instance.

+

+  @retval TRUE     Device is a USB mouse device.

+  @retval FALSE    Device is a not USB mouse device.

 

 **/

-VOID

-MouseReportStatusCode (

-  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,

-  IN EFI_STATUS_CODE_TYPE      CodeType,

-  IN EFI_STATUS_CODE_VALUE     Value

+BOOLEAN

+IsUsbMouse (

+  IN  EFI_USB_IO_PROTOCOL     *UsbIo

   );

 

 /**

-  The USB Mouse driver entry pointer.

+  Initialize the USB mouse device.

+

+  This function retrieves and parses HID report descriptor, and

+  initializes state of USB_MOUSE_DEV. Then it sets indefinite idle

+  rate for the device. Finally it creates event for delayed recovery,

+  which deals with device error.

 

-  @param  ImageHandle      The driver image handle.

-  @param  SystemTable      The system table.

+  @param  UsbMouseDev           Device instance to be initialized.

 

-  @return EFI_SUCCESS      The component name protocol is installed.

-  @return Others           Failed to init the usb driver.

+  @retval EFI_SUCCESS           USB mouse device successfully initialized..

+  @retval EFI_UNSUPPORTED       HID descriptor type is not report descriptor.

+  @retval Other                 USB mouse device was not initialized successfully.

 

 **/

 EFI_STATUS

-EFIAPI

-USBMouseDriverBindingEntryPoint (

-  IN EFI_HANDLE           ImageHandle,

-  IN EFI_SYSTEM_TABLE     *SystemTable

+InitializeUsbMouseDevice (

+  IN OUT USB_MOUSE_DEV           *UsbMouseDev

   );

 

 /**

-  Test to see if this driver supports ControllerHandle. Any ControllerHandle

-  that has UsbIoProtocol installed will be supported.

+  Handler function for USB mouse's asynchronous interrupt transfer.

 

-  @param  This                  Protocol instance pointer.

-  @param  Controller            Handle of device to test.

-  @param  RemainingDevicePath   Not used.

+  This function is the handler function for USB mouse's asynchronous interrupt transfer

+  to manage the mouse. It parses data returned from asynchronous interrupt transfer, and

+  get button and movement state.

 

-  @retval EFI_SUCCESS           This driver supports this device.

-  @retval EFI_UNSUPPORTED       This driver does not support this device.

+  @param  Data             A pointer to a buffer that is filled with key data which is

+                           retrieved via asynchronous interrupt transfer.

+  @param  DataLength       Indicates the size of the data buffer.

+  @param  Context          Pointing to USB_KB_DEV instance.

+  @param  Result           Indicates the result of the asynchronous interrupt transfer.

+

+  @retval EFI_SUCCESS      Asynchronous interrupt transfer is handled successfully.

+  @retval EFI_DEVICE_ERROR Hardware error occurs.

 

 **/

 EFI_STATUS

 EFIAPI

-USBMouseDriverBindingSupported (

-  IN EFI_DRIVER_BINDING_PROTOCOL    *This,

-  IN EFI_HANDLE                     Controller,

-  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath

+OnMouseInterruptComplete (

+  IN  VOID        *Data,

+  IN  UINTN       DataLength,

+  IN  VOID        *Context,

+  IN  UINT32      Result

   );

 

 /**

-  Starting the Usb Mouse Driver.

+  Retrieves the current state of a pointer device.

+    

+  @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.                                   

+  @param  MouseState            A pointer to the state information on the pointer device.

+                                

+  @retval EFI_SUCCESS           The state of the pointer device was returned in State.

+  @retval EFI_NOT_READY         The state of the pointer device has not changed since the last call to

+                                GetState().                                                           

+  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to retrieve the pointer device's

+                                current state.                                                           

+  @retval EFI_INVALID_PARAMETER MouseState is NULL.                                                           

 

-  @param  This                  Protocol instance pointer.

-  @param  Controller            Handle of device to test

-  @param  RemainingDevicePath   Not used

+**/

+EFI_STATUS

+EFIAPI

+GetMouseState (

+  IN   EFI_SIMPLE_POINTER_PROTOCOL  *This,

+  OUT  EFI_SIMPLE_POINTER_STATE     *MouseState

+  );

 

-  @retval EFI_SUCCESS           This driver supports this device.

-  @retval EFI_UNSUPPORTED       This driver does not support this device.

-  @retval EFI_DEVICE_ERROR      This driver cannot be started due to device Error.

-  @retval EFI_OUT_OF_RESOURCES  Can't allocate memory resources.

-  @retval EFI_ALREADY_STARTED   Thios driver has been started.

+/**                                                                 

+  Resets the pointer device hardware.

+  

+  @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.

+  @param  ExtendedVerification  Indicates that the driver may perform a more exhaustive

+                                verification operation of the device during reset.

+                                

+  @retval EFI_SUCCESS           The device was reset.

+  @retval EFI_DEVICE_ERROR      The device is not functioning correctly and could not be reset.

 

 **/

 EFI_STATUS

 EFIAPI

-USBMouseDriverBindingStart (

-  IN EFI_DRIVER_BINDING_PROTOCOL    *This,

-  IN EFI_HANDLE                     Controller,

-  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath

+UsbMouseReset (

+  IN EFI_SIMPLE_POINTER_PROTOCOL    *This,

+  IN BOOLEAN                        ExtendedVerification

   );

 

 /**

-  Stop this driver on ControllerHandle. Support stoping any child handles

-  created by this driver.

+  Event notification function for SIMPLE_POINTER.WaitForInput event.

 

-  @param  This                  Protocol instance pointer.

-  @param  Controller            Handle of device to stop driver on.

-  @param  NumberOfChildren      Number of Children in the ChildHandleBuffer.

-  @param  ChildHandleBuffer     List of handles for the children we need to stop.

+  @param  Event        Event to be signaled when there's input from mouse.

+  @param  Context      Points to USB_MOUSE_DEV instance.

+ 

+**/

+VOID

+EFIAPI

+UsbMouseWaitForInput (

+  IN  EFI_EVENT               Event,

+  IN  VOID                    *Context

+  );

 

-  @retval EFI_SUCCESS           The controller or children are stopped.

-  @retval Other                 Failed to stop the driver.

+/**

+  Handler for Delayed Recovery event.

+

+  This function is the handler for Delayed Recovery event triggered

+  by timer.

+  After a device error occurs, the event would be triggered

+  with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY

+  is defined in USB standard for error handling.

+

+  @param  Event              The Delayed Recovery event.

+  @param  Context            Points to the USB_MOUSE_DEV instance.

 

 **/

-EFI_STATUS

+VOID

 EFIAPI

-USBMouseDriverBindingStop (

-  IN  EFI_DRIVER_BINDING_PROTOCOL   *This,

-  IN  EFI_HANDLE                    Controller,

-  IN  UINTN                         NumberOfChildren,

-  IN  EFI_HANDLE                    *ChildHandleBuffer

+USBMouseRecoveryHandler (

+  IN    EFI_EVENT    Event,

+  IN    VOID         *Context

+  );

+

+/**

+  Parse Mouse Report Descriptor.

+

+  According to USB HID Specification, report descriptors are

+  composed of pieces of information. Each piece of information

+  is called an Item. This function retrieves each item from

+  the report descriptor and updates USB_MOUSE_DEV.

+

+  @param  UsbMouse          The instance of USB_MOUSE_DEV

+  @param  ReportDescriptor  Report descriptor to parse

+  @param  ReportSize        Report descriptor size

+

+  @retval EFI_SUCCESS       Report descriptor successfully parsed.

+  @retval EFI_UNSUPPORTED   Report descriptor contains long item.

+

+**/

+EFI_STATUS

+ParseMouseReportDescriptor (

+  OUT USB_MOUSE_DEV   *UsbMouse,

+  IN  UINT8           *ReportDescriptor,

+  IN  UINTN           ReportSize

   );

 

 #endif

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouseDxe.inf b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouseDxe.inf
index 5945498914..5ef67af690 100644
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouseDxe.inf
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/UsbMouseDxe.inf
@@ -1,8 +1,7 @@
 #/** @file

-# Component name for module UsbMouse

+# USB Mouse Driver that manages USB mouse and produces Simple Pointer Protocol.

 #

-# FIX ME!

-# Copyright (c) 2006, Intel Corporation. 

+# Copyright (c) 2006 - 2008, Intel Corporation. 

 #

 #  All rights reserved. This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

@@ -37,7 +36,6 @@
 [Sources.common]

   ComponentName.c

   MouseHid.c

-  MouseHid.h

   UsbMouse.c

   UsbMouse.h

 

@@ -54,11 +52,10 @@
   PcdLib

   UefiUsbLib

 

-

 [Protocols]

-  gEfiUsbIoProtocolGuid                         # PROTOCOL ALWAYS_CONSUMED

-  gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED

-  gEfiSimplePointerProtocolGuid                 # PROTOCOL ALWAYS_CONSUMED

+  gEfiUsbIoProtocolGuid                         # PROTOCOL TO_START

+  gEfiDevicePathProtocolGuid                    # PROTOCOL TO_START

+  gEfiSimplePointerProtocolGuid                 # PROTOCOL BY_START

 

 [FixedPcd]

   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueMouseInterfaceError