UhciSched.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
The definition for EHCI register operation routines.
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
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
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_UHCI_SCHED_H_
#define _EFI_UHCI_SCHED_H_
//
// The failure mask for USB transfer return status. If any of
// these bit is set, the transfer failed. EFI_USB_ERR_NOEXECUTE
// and EFI_USB_ERR_NAK are not considered as error condition:
// the transfer is still going on.
//
//
// Structure to return the result of UHCI QH execution.
// Result is the final result of the QH's QTD. NextToggle
// is the next data toggle to use. Complete is the actual
// length of data transferred.
//
typedef struct {
typedef struct _UHCI_ASYNC_REQUEST UHCI_ASYNC_REQUEST;
//
// Structure used to manager the asynchronous interrupt transfers.
//
struct _UHCI_ASYNC_REQUEST{
//
// Endpoint attributes
//
//
// Data and UHC structures
//
//
// User callback and its context
//
};
#define UHCI_ASYNC_INT_FROM_LINK(a) \
/**
Create Frame List Structure.
@param Uhc The UHCI device.
@return EFI_OUT_OF_RESOURCES Can't allocate memory resources.
@return EFI_UNSUPPORTED Map memory fail.
@return EFI_SUCCESS Success.
**/
);
/**
Destory FrameList buffer.
@param Uhc The UHCI device.
@return None.
**/
);
/**
Convert the poll rate to the maxium 2^n that is smaller
than Interval.
@param Interval The poll rate to convert.
@return The converted poll rate.
**/
);
/**
Link a queue head (for asynchronous interrupt transfer) to
the frame list.
@param Uhc The UHCI device.
@param Qh The queue head to link into.
**/
);
/**
Unlink QH from the frame list is easier: find all
the precedence node, and pointer there next to QhSw's
next.
@param Uhc The UHCI device.
@param Qh The queue head to unlink.
**/
);
/**
Check the result of the transfer.
@param Uhc The UHCI device.
@param Qh The queue head of the transfer.
@param Td The first TDs of the transfer.
@param TimeOut TimeOut value in milliseconds.
@param IsLow Is Low Speed Device.
@param QhResult The variable to return result.
@retval EFI_SUCCESS The transfer finished with success.
@retval EFI_DEVICE_ERROR Transfer failed.
**/
);
/**
Create Async Request node, and Link to List.
@param Uhc The UHCI device.
@param Qh The queue head of the transfer.
@param FirstTd First TD of the transfer.
@param DevAddr Device Address.
@param EndPoint EndPoint Address.
@param DataLen Data length.
@param Interval Polling Interval when inserted to frame list.
@param Data Data buffer, unmapped.
@param Callback Callback after interrupt transfeer.
@param Context Callback Context passed as function parameter.
@param IsLow Is Low Speed.
@retval EFI_SUCCESS An asynchronous transfer is created.
@retval EFI_INVALID_PARAMETER Paremeter is error.
@retval EFI_OUT_OF_RESOURCES Failed because of resource shortage.
**/
);
/**
Delete Async Interrupt QH and TDs.
@param Uhc The UHCI device.
@param DevAddr Device Address.
@param EndPoint EndPoint Address.
@param Toggle The next data toggle to use.
@retval EFI_SUCCESS The request is deleted.
@retval EFI_INVALID_PARAMETER Paremeter is error.
@retval EFI_NOT_FOUND The asynchronous isn't found.
**/
);
/**
Release all the asynchronous transfers on the lsit.
@param Uhc The UHCI device.
@return None.
**/
);
/**
Interrupt transfer periodic check handler.
@param Event The event of the time.
@param Context Context of the event, pointer to USB_HC_DEV.
@return None.
**/
);
#endif