/** @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
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
typedef struct _UHCI_TD_SW UHCI_TD_SW;\r
typedef struct _UHCI_QH_SW UHCI_QH_SW;\r
\r
-typedef struct _UHCI_QH_SW {\r
+struct _UHCI_QH_SW {\r
UHCI_QH_HW QhHw;\r
UHCI_QH_SW *NextQh;\r
UHCI_TD_SW *TDs;\r
UINTN Interval;\r
-} UHCI_QH_SW;\r
+};\r
\r
-typedef struct _UHCI_TD_SW {\r
+struct _UHCI_TD_SW {\r
UHCI_TD_HW TdHw;\r
UHCI_TD_SW *NextTd;\r
UINT8 *Data;\r
UINT16 DataLen;\r
-} UHCI_TD_SW;\r
+};\r
\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
UhciLinkTdToQh (\r
IN UHCI_QH_SW *Qh,\r
IN UHCI_TD_SW *Td\r
- )\r
-;\r
+ );\r
\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
UhciUnlinkTdFromQh (\r
IN UHCI_QH_SW *Qh,\r
IN UHCI_TD_SW *Td\r
- )\r
-;\r
+ );\r
\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
IN OUT VOID *Request,\r
OUT UINT8 **MappedAddr,\r
OUT VOID **Map\r
- )\r
-;\r
+ );\r
\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
OUT UINT8 *PktId,\r
OUT UINT8 **MappedAddr,\r
OUT VOID **Map\r
- )\r
-;\r
+ );\r
\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
UhciDestoryTds (\r
IN USB_HC_DEV *Uhc,\r
IN UHCI_TD_SW *FirstTd\r
- )\r
-;\r
+ );\r
\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
UhciCreateQh (\r
IN USB_HC_DEV *Uhc,\r
IN UINTN Interval\r
- )\r
-;\r
+ );\r
\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
IN UINTN DataLen,\r
IN UINT8 MaxPacket,\r
IN BOOLEAN IsLow\r
- )\r
-;\r
+ );\r
\r
\r
/**\r
- Create Tds list for Bulk/Interrupt 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
+ @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
+ @return The Tds list head for the bulk transfer.\r
\r
**/\r
UHCI_TD_SW *\r
IN OUT UINT8 *DataToggle,\r
IN UINT8 MaxPacket,\r
IN BOOLEAN IsLow\r
- )\r
-;\r
+ );\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff