[mirror_edk2.git] / QuarkSocPkg / QuarkSouthCluster / Usb / Ohci / Dxe / OhciUrb.h

/** @file\r
Provides some data struct used by OHCI controller driver.\r
\r
Copyright (c) 2013-2015 Intel Corporation.\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\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
**/\r
\r
\r
#ifndef _OHCI_URB_H\r
#define _OHCI_URB_H\r
\r
#include "Descriptor.h"\r
\r
\r
//\r
// Func List\r
//\r
\r
\r
/**\r
\r
  Create a TD\r
\r
  @Param  Ohc                   UHC private data\r
\r
  @retval                       TD structure pointer\r
\r
**/\r
TD_DESCRIPTOR *\r
OhciCreateTD (\r
  IN USB_OHCI_HC_DEV      *Ohc\r
  );\r
\r
/**\r
\r
  Free a TD\r
\r
  @Param  Ohc                   UHC private data\r
  @Param  Td                    Pointer to a TD to free\r
\r
  @retval  EFI_SUCCESS          TD freed\r
\r
**/\r
EFI_STATUS\r
OhciFreeTD (\r
  IN USB_OHCI_HC_DEV      *Ohc,\r
  IN TD_DESCRIPTOR        *Td\r
  );\r
\r
/**\r
\r
  Create a ED\r
\r
  @Param   Ohc                  Device private data\r
\r
  @retval  ED                   descriptor pointer\r
\r
**/\r
ED_DESCRIPTOR *\r
OhciCreateED (\r
  USB_OHCI_HC_DEV          *Ohc\r
  );\r
\r
\r
/**\r
\r
  Free a ED\r
\r
  @Param  Ohc                   UHC private data\r
  @Param  Ed                    Pointer to a ED to free\r
\r
  @retval  EFI_SUCCESS          ED freed\r
\r
**/\r
\r
EFI_STATUS\r
OhciFreeED (\r
  IN USB_OHCI_HC_DEV      *Ohc,\r
  IN ED_DESCRIPTOR        *Ed\r
  );\r
\r
/**\r
\r
  Free  ED\r
\r
  @Param  Ohc                    Device private data\r
  @Param  Ed                     Pointer to a ED to free\r
\r
  @retval  EFI_SUCCESS           ED freed\r
\r
**/\r
EFI_STATUS\r
OhciFreeAllTDFromED (\r
  IN USB_OHCI_HC_DEV      *Ohc,\r
  IN ED_DESCRIPTOR        *Ed\r
  );\r
\r
/**\r
\r
  Find a working ED match the requirement\r
\r
  @Param  EdHead                Head of the ED list\r
  @Param  DeviceAddress         Device address to search\r
  @Param  EndPointNum           End point num to search\r
  @Param  EdDir                 ED Direction to search\r
\r
  @retval   ED descriptor searched\r
\r
**/\r
\r
ED_DESCRIPTOR *\r
OhciFindWorkingEd (\r
  IN ED_DESCRIPTOR       *EdHead,\r
  IN UINT8               DeviceAddress,\r
  IN UINT8               EndPointNum,\r
  IN UINT8               EdDir\r
  );\r
\r
\r
/**\r
\r
  Initialize interrupt list.\r
\r
  @Param Ohc                    Device private data\r
\r
  @retval  EFI_SUCCESS          Initialization done\r
\r
**/\r
EFI_STATUS\r
OhciInitializeInterruptList (\r
  USB_OHCI_HC_DEV          *Ohc\r
  );\r
\r
/**\r
\r
  Attach an ED\r
\r
  @Param  Ed                    Ed to be attached\r
  @Param  NewEd                 Ed to attach\r
\r
  @retval EFI_SUCCESS           NewEd attached to Ed\r
  @retval EFI_INVALID_PARAMETER Ed is NULL\r
\r
**/\r
EFI_STATUS\r
OhciAttachED (\r
  IN ED_DESCRIPTOR        *Ed,\r
  IN ED_DESCRIPTOR        *NewEd\r
  );\r
\r
/**\r
\r
  Count ED number on a ED chain\r
\r
  @Param  Ed                    Head of the ED chain\r
\r
  @retval                       ED number on the chain\r
\r
**/\r
\r
UINTN\r
CountEdNum (\r
  IN ED_DESCRIPTOR      *Ed\r
  );\r
\r
/**\r
\r
  Find the minimal burn ED list on a specific depth level\r
\r
  @Param  Ohc                   Device private data\r
  @Param  Depth                 Depth level\r
\r
  @retval                       ED list found\r
\r
**/\r
\r
ED_DESCRIPTOR *\r
OhciFindMinInterruptEDList (\r
  IN USB_OHCI_HC_DEV      *Ohc,\r
  IN UINT32               Depth\r
  );\r
\r
/**\r
\r
  Attach an ED to an ED list\r
\r
  @Param  OHC                   UHC private data\r
  @Param  ListType              Type of the ED list\r
  @Param  Ed                    ED to attach\r
  @Param  EdList                ED list to be attached\r
\r
  @retval  EFI_SUCCESS          ED attached to ED list\r
\r
**/\r
ED_DESCRIPTOR *\r
OhciAttachEDToList (\r
  IN USB_OHCI_HC_DEV       *Ohc,\r
  IN DESCRIPTOR_LIST_TYPE  ListType,\r
  IN ED_DESCRIPTOR         *Ed,\r
  IN ED_DESCRIPTOR         *EdList\r
  );\r
\r
/**\r
\r
  Remove interrupt EDs that match requirement\r
\r
  @Param  Ohc                   UHC private data\r
  @Param  IntEd                 The address of Interrupt endpoint\r
\r
  @retval  EFI_SUCCESS          EDs match requirement removed\r
\r
**/\r
\r
EFI_STATUS\r
OhciFreeInterruptEdByEd (\r
  IN USB_OHCI_HC_DEV      *Ohc,\r
  IN ED_DESCRIPTOR        *IntEd\r
  );\r
\r
/**\r
\r
  Remove interrupt EDs that match requirement\r
\r
  @Param  Ohc                   UHC private data\r
  @Param  FunctionAddress       Requirement on function address\r
  @Param  EndPointNum           Requirement on end point number\r
\r
  @retval  EFI_SUCCESS          EDs match requirement removed\r
\r
**/\r
EFI_STATUS\r
OhciFreeInterruptEdByAddr (\r
  IN USB_OHCI_HC_DEV      *Ohc,\r
  IN UINT8                FunctionAddress,\r
  IN UINT8                EndPointNum\r
  );\r
\r
\r
/**\r
\r
  Link Td2 to the end of Td1\r
\r
  @Param Td1                    TD to be linked\r
  @Param Td2                    TD to link\r
\r
  @retval EFI_SUCCESS           TD successfully linked\r
  @retval EFI_INVALID_PARAMETER Td1 is NULL\r
\r
**/\r
EFI_STATUS\r
OhciLinkTD (\r
  IN TD_DESCRIPTOR        *Td1,\r
  IN TD_DESCRIPTOR        *Td2\r
  );\r
\r
\r
/**\r
\r
  Attach TD list to ED\r
\r
  @Param  Ed                    ED which TD list attach on\r
  @Param  HeadTd                Head of the TD list to attach\r
\r
  @retval  EFI_SUCCESS          TD list attached on the ED\r
\r
**/\r
EFI_STATUS\r
OhciAttachTDListToED (\r
  IN ED_DESCRIPTOR        *Ed,\r
  IN TD_DESCRIPTOR        *HeadTd\r
  );\r
\r
\r
/**\r
\r
  Set value to ED specific field\r
\r
  @Param  Ed                    ED to be set\r
  @Param  Field                 Field to be set\r
  @Param  Value                 Value to set\r
\r
  @retval  EFI_SUCCESS          Value set\r
\r
**/\r
EFI_STATUS\r
OhciSetEDField (\r
  IN ED_DESCRIPTOR        *Ed,\r
  IN UINT32               Field,\r
  IN UINT32               Value\r
  );\r
\r
\r
/**\r
\r
  Get value from an ED's specific field\r
\r
  @Param  Ed                    ED pointer\r
  @Param  Field                 Field to get value from\r
\r
  @retval                       Value of the field\r
\r
**/\r
UINT32\r
OhciGetEDField (\r
  IN ED_DESCRIPTOR        *Ed,\r
  IN UINT32               Field\r
  );\r
\r
\r
/**\r
\r
  Set value to TD specific field\r
\r
  @Param  Td                    TD to be set\r
  @Param  Field                 Field to be set\r
  @Param  Value                 Value to set\r
\r
  @retval  EFI_SUCCESS          Value set\r
\r
**/\r
EFI_STATUS\r
OhciSetTDField (\r
  IN TD_DESCRIPTOR        *Td,\r
  IN UINT32               Field,\r
  IN UINT32               Value\r
  );\r
\r
\r
/**\r
\r
  Get value from ED specific field\r
\r
  @Param  Td                    TD pointer\r
  @Param  Field                 Field to get value from\r
\r
  @retval                       Value of the field\r
\r
**/\r
\r
UINT32\r
OhciGetTDField (\r
  IN TD_DESCRIPTOR      *Td,\r
  IN UINT32             Field\r
  );\r
/**\r
\r
  Free the Ed,Td,buffer that were created during transferring\r
\r
  @Param  Ohc                   Device private data\r
**/\r
\r
VOID\r
OhciFreeDynamicIntMemory(\r
  IN USB_OHCI_HC_DEV      *Ohc\r
  );\r
\r
/**\r
\r
  Free the Ed that were initilized during driver was starting,\r
  those memory were used as interrupt ED head\r
\r
  @Param  Ohc                   Device private data\r
\r
\r
**/\r
VOID\r
OhciFreeFixedIntMemory (\r
  IN USB_OHCI_HC_DEV      *Ohc\r
  );\r
/**\r
\r
  Release all OHCI used memory when OHCI going to quit\r
\r
  @Param  Ohc                   Device private data\r
\r
  @retval EFI_SUCCESS          Memory released\r
\r
**/\r
\r
EFI_STATUS\r
OhciFreeIntTransferMemory (\r
  IN USB_OHCI_HC_DEV           *Ohc\r
  );\r
\r
#endif\r
Commit	Line	Data
9b6bbcdb MK	1	/** @file\r
	2	Provides some data struct used by OHCI controller driver.\r
	3	\r
	4	Copyright (c) 2013-2015 Intel Corporation.\r
	5	\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	\r
	17	#ifndef _OHCI_URB_H\r
	18	#define _OHCI_URB_H\r
	19	\r
	20	#include "Descriptor.h"\r
	21	\r
	22	\r
	23	//\r
	24	// Func List\r
	25	//\r
	26	\r
	27	\r
	28	/**\r
	29	\r
	30	Create a TD\r
	31	\r
	32	@Param Ohc UHC private data\r
	33	\r
	34	@retval TD structure pointer\r
	35	\r
	36	**/\r
	37	TD_DESCRIPTOR *\r
	38	OhciCreateTD (\r
	39	IN USB_OHCI_HC_DEV *Ohc\r
	40	);\r
	41	\r
	42	/**\r
	43	\r
	44	Free a TD\r
	45	\r
	46	@Param Ohc UHC private data\r
	47	@Param Td Pointer to a TD to free\r
	48	\r
	49	@retval EFI_SUCCESS TD freed\r
	50	\r
	51	**/\r
	52	EFI_STATUS\r
	53	OhciFreeTD (\r
	54	IN USB_OHCI_HC_DEV *Ohc,\r
	55	IN TD_DESCRIPTOR *Td\r
	56	);\r
	57	\r
	58	/**\r
	59	\r
	60	Create a ED\r
	61	\r
	62	@Param Ohc Device private data\r
	63	\r
	64	@retval ED descriptor pointer\r
65	\r
66	**/\r
67	ED_DESCRIPTOR *\r
68	OhciCreateED (\r
69	USB_OHCI_HC_DEV *Ohc\r
70	);\r
71	\r
72	\r
73	/**\r
74	\r
75	Free a ED\r
76	\r
77	@Param Ohc UHC private data\r
78	@Param Ed Pointer to a ED to free\r
79	\r
80	@retval EFI_SUCCESS ED freed\r
81	\r
82	**/\r
83	\r
84	EFI_STATUS\r
85	OhciFreeED (\r
86	IN USB_OHCI_HC_DEV *Ohc,\r
87	IN ED_DESCRIPTOR *Ed\r
88	);\r
89	\r
90	/**\r
91	\r
92	Free ED\r
93	\r
94	@Param Ohc Device private data\r
95	@Param Ed Pointer to a ED to free\r
96	\r
97	@retval EFI_SUCCESS ED freed\r
98	\r
99	**/\r
100	EFI_STATUS\r
101	OhciFreeAllTDFromED (\r
102	IN USB_OHCI_HC_DEV *Ohc,\r
103	IN ED_DESCRIPTOR *Ed\r
104	);\r
105	\r
106	/**\r
107	\r
108	Find a working ED match the requirement\r
109	\r
110	@Param EdHead Head of the ED list\r
111	@Param DeviceAddress Device address to search\r
112	@Param EndPointNum End point num to search\r
113	@Param EdDir ED Direction to search\r
114	\r
115	@retval ED descriptor searched\r
116	\r
117	**/\r
118	\r
119	ED_DESCRIPTOR *\r
120	OhciFindWorkingEd (\r
121	IN ED_DESCRIPTOR *EdHead,\r
122	IN UINT8 DeviceAddress,\r
123	IN UINT8 EndPointNum,\r
124	IN UINT8 EdDir\r
125	);\r
126	\r
127	\r
128	/**\r
129	\r
130	Initialize interrupt list.\r
131	\r
132	@Param Ohc Device private data\r
133	\r
134	@retval EFI_SUCCESS Initialization done\r
135	\r
136	**/\r
137	EFI_STATUS\r
138	OhciInitializeInterruptList (\r
139	USB_OHCI_HC_DEV *Ohc\r
140	);\r
141	\r
142	/**\r
143	\r
144	Attach an ED\r
145	\r
146	@Param Ed Ed to be attached\r
147	@Param NewEd Ed to attach\r
148	\r
149	@retval EFI_SUCCESS NewEd attached to Ed\r
150	@retval EFI_INVALID_PARAMETER Ed is NULL\r
151	\r
152	**/\r
153	EFI_STATUS\r
154	OhciAttachED (\r
155	IN ED_DESCRIPTOR *Ed,\r
156	IN ED_DESCRIPTOR *NewEd\r
157	);\r
158	\r
159	/**\r
160	\r
161	Count ED number on a ED chain\r
162	\r
163	@Param Ed Head of the ED chain\r
164	\r
165	@retval ED number on the chain\r
166	\r
167	**/\r
168	\r
169	UINTN\r
170	CountEdNum (\r
171	IN ED_DESCRIPTOR *Ed\r
172	);\r
173	\r
174	/**\r
175	\r
176	Find the minimal burn ED list on a specific depth level\r
177	\r
178	@Param Ohc Device private data\r
179	@Param Depth Depth level\r
180	\r
181	@retval ED list found\r
182	\r
183	**/\r
184	\r
185	ED_DESCRIPTOR *\r
186	OhciFindMinInterruptEDList (\r
187	IN USB_OHCI_HC_DEV *Ohc,\r
188	IN UINT32 Depth\r
189	);\r
190	\r
191	/**\r
192	\r
193	Attach an ED to an ED list\r
194	\r
195	@Param OHC UHC private data\r
196	@Param ListType Type of the ED list\r
197	@Param Ed ED to attach\r
198	@Param EdList ED list to be attached\r
199	\r
200	@retval EFI_SUCCESS ED attached to ED list\r
201	\r
202	**/\r
203	ED_DESCRIPTOR *\r
204	OhciAttachEDToList (\r
205	IN USB_OHCI_HC_DEV *Ohc,\r
206	IN DESCRIPTOR_LIST_TYPE ListType,\r
207	IN ED_DESCRIPTOR *Ed,\r
208	IN ED_DESCRIPTOR *EdList\r
209	);\r
210	\r
211	/**\r
212	\r
213	Remove interrupt EDs that match requirement\r
214	\r
215	@Param Ohc UHC private data\r
216	@Param IntEd The address of Interrupt endpoint\r
217	\r
218	@retval EFI_SUCCESS EDs match requirement removed\r
219	\r
220	**/\r
221	\r
222	EFI_STATUS\r
223	OhciFreeInterruptEdByEd (\r
224	IN USB_OHCI_HC_DEV *Ohc,\r
225	IN ED_DESCRIPTOR *IntEd\r
226	);\r
227	\r
228	/**\r
229	\r
230	Remove interrupt EDs that match requirement\r
231	\r
232	@Param Ohc UHC private data\r
233	@Param FunctionAddress Requirement on function address\r
234	@Param EndPointNum Requirement on end point number\r
235	\r
236	@retval EFI_SUCCESS EDs match requirement removed\r
237	\r
238	**/\r
239	EFI_STATUS\r
240	OhciFreeInterruptEdByAddr (\r
241	IN USB_OHCI_HC_DEV *Ohc,\r
242	IN UINT8 FunctionAddress,\r
243	IN UINT8 EndPointNum\r
244	);\r
245	\r
246	\r
247	/**\r
248	\r
249	Link Td2 to the end of Td1\r
250	\r
251	@Param Td1 TD to be linked\r
252	@Param Td2 TD to link\r
253	\r
254	@retval EFI_SUCCESS TD successfully linked\r
255	@retval EFI_INVALID_PARAMETER Td1 is NULL\r
256	\r
257	**/\r
258	EFI_STATUS\r
259	OhciLinkTD (\r
260	IN TD_DESCRIPTOR *Td1,\r
261	IN TD_DESCRIPTOR *Td2\r
262	);\r
263	\r
264	\r
265	/**\r
266	\r
267	Attach TD list to ED\r
268	\r
269	@Param Ed ED which TD list attach on\r
270	@Param HeadTd Head of the TD list to attach\r
271	\r
272	@retval EFI_SUCCESS TD list attached on the ED\r
273	\r
274	**/\r
275	EFI_STATUS\r
276	OhciAttachTDListToED (\r
277	IN ED_DESCRIPTOR *Ed,\r
278	IN TD_DESCRIPTOR *HeadTd\r
279	);\r
280	\r
281	\r
282	/**\r
283	\r
284	Set value to ED specific field\r
285	\r
286	@Param Ed ED to be set\r
287	@Param Field Field to be set\r
288	@Param Value Value to set\r
289	\r
290	@retval EFI_SUCCESS Value set\r
291	\r
292	**/\r
293	EFI_STATUS\r
294	OhciSetEDField (\r
295	IN ED_DESCRIPTOR *Ed,\r
296	IN UINT32 Field,\r
297	IN UINT32 Value\r
298	);\r
299	\r
300	\r
301	/**\r
302	\r
303	Get value from an ED's specific field\r
304	\r
305	@Param Ed ED pointer\r
306	@Param Field Field to get value from\r
307	\r
308	@retval Value of the field\r
309	\r
310	**/\r
311	UINT32\r
312	OhciGetEDField (\r
313	IN ED_DESCRIPTOR *Ed,\r
314	IN UINT32 Field\r
315	);\r
316	\r
317	\r
318	/**\r
319	\r
320	Set value to TD specific field\r
321	\r
322	@Param Td TD to be set\r
323	@Param Field Field to be set\r
324	@Param Value Value to set\r
325	\r
326	@retval EFI_SUCCESS Value set\r
327	\r
328	**/\r
329	EFI_STATUS\r
330	OhciSetTDField (\r
331	IN TD_DESCRIPTOR *Td,\r
332	IN UINT32 Field,\r
333	IN UINT32 Value\r
334	);\r
335	\r
336	\r
337	/**\r
338	\r
339	Get value from ED specific field\r
340	\r
341	@Param Td TD pointer\r
342	@Param Field Field to get value from\r
343	\r
344	@retval Value of the field\r
345	\r
346	**/\r
347	\r
348	UINT32\r
349	OhciGetTDField (\r
350	IN TD_DESCRIPTOR *Td,\r
351	IN UINT32 Field\r
352	);\r
353	/**\r
354	\r
355	Free the Ed,Td,buffer that were created during transferring\r
356	\r
357	@Param Ohc Device private data\r
358	**/\r
359	\r
360	VOID\r
361	OhciFreeDynamicIntMemory(\r
362	IN USB_OHCI_HC_DEV *Ohc\r
363	);\r
364	\r
365	/**\r
366	\r
367	Free the Ed that were initilized during driver was starting,\r
368	those memory were used as interrupt ED head\r
369	\r
370	@Param Ohc Device private data\r
371	\r
372	\r
373	**/\r
374	VOID\r
375	OhciFreeFixedIntMemory (\r
376	IN USB_OHCI_HC_DEV *Ohc\r
377	);\r
378	/**\r
379	\r
380	Release all OHCI used memory when OHCI going to quit\r
381	\r
382	@Param Ohc Device private data\r
383	\r
384	@retval EFI_SUCCESS Memory released\r
385	\r
386	**/\r
387	\r
388	EFI_STATUS\r
389	OhciFreeIntTransferMemory (\r
390	IN USB_OHCI_HC_DEV *Ohc\r
391	);\r
392	\r
393	#endif\r