/** @file\r
\r
+ The definition for EHCI 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
- UhciSched.h\r
-\r
-Abstract:\r
-\r
- The definition for EHCI register operation routines.\r
-\r
-Revision History\r
-\r
-\r
**/\r
\r
#ifndef _EFI_UHCI_SCHED_H_\r
#define _EFI_UHCI_SCHED_H_\r
\r
\r
-enum {\r
+typedef enum {\r
UHCI_ASYNC_INT_SIGNATURE = EFI_SIGNATURE_32 ('u', 'h', 'c', 'a'),\r
\r
//\r
EFI_USB_ERR_TIMEOUT | EFI_USB_ERR_BITSTUFF |\r
EFI_USB_ERR_SYSTEM\r
\r
-};\r
+}UHCI_ERR_FAIL_MASK;\r
\r
//\r
// Structure to return the result of UHCI QH execution.\r
#define UHCI_ASYNC_INT_FROM_LINK(a) \\r
CR (a, UHCI_ASYNC_REQUEST, Link, UHCI_ASYNC_INT_SIGNATURE)\r
\r
-EFI_STATUS\r
-UhciInitFrameList (\r
- IN USB_HC_DEV *Uhc\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
- Create Frame List Structure\r
-\r
-Arguments:\r
-\r
- Uhc - UHCI device\r
+/**\r
+ Create Frame List Structure.\r
\r
-Returns:\r
+ @param Uhc The UHCI device.\r
\r
- EFI_OUT_OF_RESOURCES - Can't allocate memory resources\r
- EFI_UNSUPPORTED - Map memory fail\r
- EFI_SUCCESS - Success\r
+ @return EFI_OUT_OF_RESOURCES Can't allocate memory resources.\r
+ @return EFI_UNSUPPORTED Map memory fail.\r
+ @return EFI_SUCCESS Success.\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+UhciInitFrameList (\r
+ IN USB_HC_DEV *Uhc\r
+ )\r
;\r
\r
-\r
/**\r
- Destory FrameList buffer\r
+ Destory FrameList buffer.\r
\r
- @param Uhc The UHCI device\r
+ @param Uhc The UHCI device.\r
\r
- @return VOID\r
+ @return None.\r
\r
**/\r
VOID\r
\r
/**\r
Convert the poll rate to the maxium 2^n that is smaller\r
- than Interval\r
+ than Interval.\r
\r
- @param Interval The poll rate to convert\r
+ @param Interval The poll rate to convert.\r
\r
- @return The converted poll rate\r
+ @return The converted poll rate.\r
\r
**/\r
UINTN\r
Link a queue head (for asynchronous interrupt transfer) to\r
the frame list.\r
\r
- @param FrameBase The base of the frame list\r
- @param Qh The queue head to link into\r
+ @param FrameBase The base of the frame list.\r
+ @param Qh The queue head to link into.\r
\r
- @return None\r
+ @return None.\r
\r
**/\r
VOID\r
the precedence node, and pointer there next to QhSw's\r
next.\r
\r
- @param FrameBase The base address of the frame list\r
- @param Qh The queue head to unlink\r
+ @param FrameBase The base address of the frame list.\r
+ @param Qh The queue head to unlink.\r
\r
- @return None\r
+ @return None.\r
\r
**/\r
VOID\r
\r
\r
/**\r
- Check the result of the transfer\r
+ Check the result of the transfer.\r
\r
- @param Uhc The UHCI device\r
- @param Td The first TDs of the transfer\r
- @param TimeOut TimeOut value in milliseconds\r
- @param IsLow Is Low Speed Device\r
- @param QhResult The variable to return result\r
+ @param Uhc The UHCI device.\r
+ @param Qh The queue head of the transfer.\r
+ @param Td The first TDs of the transfer.\r
+ @param TimeOut TimeOut value in milliseconds.\r
+ @param IsLow Is Low Speed Device.\r
+ @param QhResult The variable to return result.\r
\r
- @retval EFI_SUCCESS The transfer finished with success\r
- @retval EFI_DEVICE_ERROR Transfer failed\r
+ @retval EFI_SUCCESS The transfer finished with success.\r
+ @retval EFI_DEVICE_ERROR Transfer failed.\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Create Async Request node, and Link to List\r
-\r
- @param Uhc The UHCI device\r
- @param Qh The queue head of the transfer\r
- @param FirstTd First TD of the transfer\r
- @param DevAddr Device Address\r
- @param EndPoint EndPoint Address\r
- @param Toggle Data Toggle\r
- @param DataLen Data length\r
- @param Interval Polling Interval when inserted to frame list\r
- @param Mapping Mapping value\r
- @param Data Data buffer, unmapped\r
- @param Callback Callback after interrupt transfeer\r
- @param Context Callback Context passed as function parameter\r
- @param IsLow Is Low Speed\r
-\r
- @retval EFI_SUCCESS An asynchronous transfer is created\r
- @retval EFI_INVALID_PARAMETER Paremeter is error\r
+ Create Async Request node, and Link to List.\r
+\r
+ @param Uhc The UHCI device.\r
+ @param Qh The queue head of the transfer.\r
+ @param FirstTd First TD of the transfer.\r
+ @param DevAddr Device Address.\r
+ @param EndPoint EndPoint Address.\r
+ @param DataLen Data length.\r
+ @param Interval Polling Interval when inserted to frame list.\r
+ @param Mapping Mapping value.\r
+ @param Data Data buffer, unmapped.\r
+ @param Callback Callback after interrupt transfeer.\r
+ @param Context Callback Context passed as function parameter.\r
+ @param IsLow Is Low Speed.\r
+\r
+ @retval EFI_SUCCESS An asynchronous transfer is created.\r
+ @retval EFI_INVALID_PARAMETER Paremeter is error.\r
@retval EFI_OUT_OF_RESOURCES Failed because of resource shortage.\r
\r
**/\r
\r
\r
/**\r
- Delete Async Interrupt QH and TDs\r
+ Delete Async Interrupt QH and TDs.\r
\r
- @param Uhc The UHCI device\r
- @param DevAddr Device Address\r
- @param EndPoint EndPoint Address\r
- @param Toggle The next data toggle to use\r
+ @param Uhc The UHCI device.\r
+ @param DevAddr Device Address.\r
+ @param EndPoint EndPoint Address.\r
+ @param Toggle The next data toggle to use.\r
\r
- @retval EFI_SUCCESS The request is deleted\r
- @retval EFI_INVALID_PARAMETER Paremeter is error\r
- @retval EFI_NOT_FOUND The asynchronous isn't found\r
+ @retval EFI_SUCCESS The request is deleted.\r
+ @retval EFI_INVALID_PARAMETER Paremeter is error.\r
+ @retval EFI_NOT_FOUND The asynchronous isn't found.\r
\r
**/\r
EFI_STATUS\r
/**\r
Release all the asynchronous transfers on the lsit.\r
\r
- @param Uhc The UHCI device\r
+ @param Uhc The UHCI device.\r
\r
- @return VOID\r
+ @return None.\r
\r
**/\r
VOID\r
\r
\r
/**\r
- Interrupt transfer periodic check handler\r
+ Interrupt transfer periodic check handler.\r
\r
- @param Event The event of the time\r
- @param Context Context of the event, pointer to USB_HC_DEV\r
+ @param Event The event of the time.\r
+ @param Context Context of the event, pointer to USB_HC_DEV.\r
\r
- @return VOID\r
+ @return None.\r
\r
**/\r
VOID\r
projects / mirror_edk2.git / blobdiff