2 Provides some data struct used by OHCI controller driver.
4 Copyright (c) 2013-2015 Intel Corporation.
6 SPDX-License-Identifier: BSD-2-Clause-Patent
14 #include "Descriptor.h"
26 @Param Ohc UHC private data
28 @retval TD structure pointer
33 IN USB_OHCI_HC_DEV
*Ohc
40 @Param Ohc UHC private data
41 @Param Td Pointer to a TD to free
43 @retval EFI_SUCCESS TD freed
48 IN USB_OHCI_HC_DEV
*Ohc
,
56 @Param Ohc Device private data
58 @retval ED descriptor pointer
71 @Param Ohc UHC private data
72 @Param Ed Pointer to a ED to free
74 @retval EFI_SUCCESS ED freed
80 IN USB_OHCI_HC_DEV
*Ohc
,
88 @Param Ohc Device private data
89 @Param Ed Pointer to a ED to free
91 @retval EFI_SUCCESS ED freed
96 IN USB_OHCI_HC_DEV
*Ohc
,
104 @Param Ed Ed to be attached
105 @Param NewEd Ed to attach
107 @retval EFI_SUCCESS NewEd attached to Ed
108 @retval EFI_INVALID_PARAMETER Ed is NULL
113 IN ED_DESCRIPTOR
*Ed
,
114 IN ED_DESCRIPTOR
*NewEd
118 Attach an ED to an ED list
120 @Param OHC UHC private data
121 @Param ListType Type of the ED list
122 @Param Ed ED to attach
123 @Param EdList ED list to be attached
125 @retval EFI_SUCCESS ED attached to ED list
130 IN USB_OHCI_HC_DEV
*Ohc
,
131 IN DESCRIPTOR_LIST_TYPE ListType
,
132 IN ED_DESCRIPTOR
*Ed
,
133 IN ED_DESCRIPTOR
*EdList
137 IN TD_DESCRIPTOR
*Td1
,
138 IN TD_DESCRIPTOR
*Td2
146 @Param Ed ED which TD list attach on
147 @Param HeadTd Head of the TD list to attach
149 @retval EFI_SUCCESS TD list attached on the ED
153 OhciAttachTDListToED (
154 IN ED_DESCRIPTOR
*Ed
,
155 IN TD_DESCRIPTOR
*HeadTd
161 Set value to ED specific field
163 @Param Ed ED to be set
164 @Param Field Field to be set
165 @Param Value Value to set
167 @retval EFI_SUCCESS Value set
172 IN ED_DESCRIPTOR
*Ed
,
180 Get value from an ED's specific field
183 @Param Field Field to get value from
185 @retval Value of the field
190 IN ED_DESCRIPTOR
*Ed
,
197 Set value to TD specific field
199 @Param Td TD to be set
200 @Param Field Field to be set
201 @Param Value Value to set
203 @retval EFI_SUCCESS Value set
208 IN TD_DESCRIPTOR
*Td
,
216 Get value from ED specific field
219 @Param Field Field to get value from
221 @retval Value of the field
227 IN TD_DESCRIPTOR
*Td
,