modify coding style to pass ecc tool and provide comments that complied with Doxgen.

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / UhciDxe / UhciQueue.h

diff --git a/MdeModulePkg/Bus/Pci/UhciDxe/UhciQueue.h b/MdeModulePkg/Bus/Pci/UhciDxe/UhciQueue.h
index 1b60ad7ff9a84b833cc958aea55014db537ffa1c..0463f4bff6c3aab3fb303b061a6f9ef335ad857e 100644 (file)
--- a/MdeModulePkg/Bus/Pci/UhciDxe/UhciQueue.h
+++ b/MdeModulePkg/Bus/Pci/UhciDxe/UhciQueue.h
@@ -1,5 +1,7 @@
 /** @file\r
 \r
+  The definition for UHCI register operation routines.\r
+\r
 Copyright (c) 2007, 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
@@ -9,17 +11,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  UhciQueue.h\r
-\r
-Abstract:\r
-\r
-  The definition for UHCI register operation routines.\r
-\r
-Revision History\r
-\r
-\r
 **/\r
 \r
 #ifndef _EFI_UHCI_QUEUE_H_\r
@@ -104,12 +95,12 @@ struct _UHCI_TD_SW {
 \r
 \r
 /**\r
-  Link the TD To QH\r
+  Link the TD To QH.\r
 \r
-  @param  Qh          The queue head for the TD to link to\r
-  @param  Td          The TD to link\r
+  @param  Qh          The queue head for the TD to link to.\r
+  @param  Td          The TD to link.\r
 \r
-  @return VOID\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -121,12 +112,12 @@ UhciLinkTdToQh (
 \r
 \r
 /**\r
-  Unlink TD from the QH\r
+  Unlink TD from the QH.\r
 \r
-  @param  Qh          The queue head to unlink from\r
-  @param  Td          The TD to unlink\r
+  @param  Qh          The queue head to unlink from.\r
+  @param  Td          The TD to unlink.\r
 \r
-  @return VOID\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -138,15 +129,15 @@ UhciUnlinkTdFromQh (
 \r
 \r
 /**\r
-  Map address of request structure buffer\r
+  Map address of request structure buffer.\r
 \r
-  @param  Uhc         The UHCI device\r
-  @param  Request     The user request buffer\r
-  @param  MappedAddr  Mapped address of request\r
-  @param  Map         Identificaion of this mapping to return\r
+  @param  Uhc                The UHCI device.\r
+  @param  Request            The user request buffer.\r
+  @param  MappedAddr         Mapped address of request.\r
+  @param  Map                Identificaion of this mapping to return.\r
 \r
-  @return EFI_SUCCESS      : Success\r
-  @return EFI_DEVICE_ERROR : Fail to map the user request\r
+  @return EFI_SUCCESS        Success.\r
+  @return EFI_DEVICE_ERROR   Fail to map the user request.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -160,18 +151,18 @@ UhciMapUserRequest (
 \r
 \r
 /**\r
-  Map address of user data buffer\r
+  Map address of user data buffer.\r
 \r
-  @param  Uhc         The UHCI device\r
-  @param  Direction   direction of the data transfer\r
-  @param  Data        The user data buffer\r
-  @param  Len         Length of the user data\r
-  @param  PktId       Packet identificaion\r
-  @param  MappedAddr  mapped address to return\r
-  @param  Map         identificaion of this mapping to return\r
+  @param  Uhc                The UHCI device.\r
+  @param  Direction          Direction of the data transfer.\r
+  @param  Data               The user data buffer.\r
+  @param  Len                Length of the user data.\r
+  @param  PktId              Packet identificaion.\r
+  @param  MappedAddr         Mapped address to return.\r
+  @param  Map                Identificaion of this mapping to return.\r
 \r
-  @return EFI_SUCCESS      : Success\r
-  @return EFI_DEVICE_ERROR : Fail to map the user data\r
+  @return EFI_SUCCESS        Success.\r
+  @return EFI_DEVICE_ERROR   Fail to map the user data.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -188,12 +179,12 @@ UhciMapUserData (
 \r
 \r
 /**\r
-  Delete a list of TDs\r
+  Delete a list of TDs.\r
 \r
-  @param  Uhc         The UHCI device\r
-  @param  FirstTd     TD link list head\r
+  @param  Uhc         The UHCI device.\r
+  @param  FirstTd     TD link list head.\r
 \r
-  @return VOID\r
+  @return None.\r
 \r
 **/\r
 VOID\r
@@ -205,12 +196,12 @@ UhciDestoryTds (
 \r
 \r
 /**\r
-  Create an initialize a new queue head\r
+  Create an initialize a new queue head.\r
 \r
-  @param  Uhc         The UHCI device\r
-  @param  Interval    The polling interval for the queue\r
+  @param  Uhc         The UHCI device.\r
+  @param  Interval    The polling interval for the queue.\r
 \r
-  @return The newly created queue header\r
+  @return The newly created queue header.\r
 \r
 **/\r
 UHCI_QH_SW *\r
@@ -222,18 +213,18 @@ UhciCreateQh (
 \r
 \r
 /**\r
-  Create Tds list for Control Transfer\r
+  Create Tds list for Control Transfer.\r
 \r
-  @param  Uhc         The UHCI device\r
-  @param  DeviceAddr  The device address\r
-  @param  DataPktId   Packet Identification of Data Tds\r
-  @param  Request     A pointer to request structure buffer to transfer\r
-  @param  Data        A pointer to user data buffer to transfer\r
-  @param  DataLen     Length of user data to transfer\r
-  @param  MaxPacket   Maximum packet size for control transfer\r
-  @param  IsLow       Full speed or low speed\r
+  @param  Uhc         The UHCI device.\r
+  @param  DeviceAddr  The device address.\r
+  @param  DataPktId   Packet Identification of Data Tds.\r
+  @param  Request     A pointer to request structure buffer to transfer.\r
+  @param  Data        A pointer to user data buffer to transfer.\r
+  @param  DataLen     Length of user data to transfer.\r
+  @param  MaxPacket   Maximum packet size for control transfer.\r
+  @param  IsLow       Full speed or low speed.\r
 \r
-  @return The Td list head for the control transfer\r
+  @return The Td list head for the control transfer.\r
 \r
 **/\r
 UHCI_TD_SW *\r
@@ -251,19 +242,19 @@ UhciCreateCtrlTds (
 \r
 \r
 /**\r
-  Create Tds list for Bulk/Interrupt Transfer\r
-\r
-  @param  Uhc         USB_HC_DEV\r
-  @param  DevAddr     Address of Device\r
-  @param  EndPoint    Endpoint Number\r
-  @param  PktId       Packet Identification of Data Tds\r
-  @param  Data        A pointer to user data buffer to transfer\r
-  @param  DataLen     Length of user data to transfer\r
-  @param  DataToggle  Data Toggle Pointer\r
-  @param  MaxPacket   Maximum packet size for Bulk/Interrupt transfer\r
-  @param  IsLow       Is Low Speed Device\r
-\r
-  @return The Tds list head for the bulk transfer\r
+  Create Tds list for Bulk/Interrupt Transfer.\r
+\r
+  @param  Uhc         USB_HC_DEV.\r
+  @param  DevAddr     Address of Device.\r
+  @param  EndPoint    Endpoint Number.\r
+  @param  PktId       Packet Identification of Data Tds.\r
+  @param  Data        A pointer to user data buffer to transfer.\r
+  @param  DataLen     Length of user data to transfer.\r
+  @param  DataToggle  Data Toggle Pointer.\r
+  @param  MaxPacket   Maximum packet size for Bulk/Interrupt transfer.\r
+  @param  IsLow       Is Low Speed Device.\r
+\r
+  @return The Tds list head for the bulk transfer.\r
 \r
 **/\r
 UHCI_TD_SW *\r