3 Copyright (c) 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 This file contains the definination for host controller memory management routines
24 #ifndef _EFI_EHCI_MEM_H_
25 #define _EFI_EHCI_MEM_H_
28 #include <IndustryStandard/Pci22.h>
30 #define USB_HC_BIT(a) ((UINTN)(1 << (a)))
32 #define USB_HC_BIT_IS_SET(Data, Bit) \
33 ((BOOLEAN)(((Data) & USB_HC_BIT(Bit)) == USB_HC_BIT(Bit)))
35 #define USB_HC_HIGH_32BIT(Addr64) \
36 ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))
38 typedef struct _USBHC_MEM_BLOCK USBHC_MEM_BLOCK
;
40 struct _USBHC_MEM_BLOCK
{
41 UINT8
*Bits
; // Bit array to record which unit is allocated
45 UINTN BufLen
; // Memory size in bytes
47 USBHC_MEM_BLOCK
*Next
;
51 // USBHC_MEM_POOL is used to manage the memory used by USB
52 // host controller. EHCI requires the control memory and transfer
53 // data to be on the same 4G memory.
55 typedef struct _USBHC_MEM_POOL
{
56 EFI_PCI_IO_PROTOCOL
*PciIo
;
59 USBHC_MEM_BLOCK
*Head
;
63 USBHC_MEM_UNIT
= 64, // Memory allocation unit, must be 2^n, n>4
65 USBHC_MEM_UNIT_MASK
= USBHC_MEM_UNIT
- 1,
66 USBHC_MEM_DEFAULT_PAGES
= 16
69 #define USBHC_MEM_ROUND(Len) (((Len) + USBHC_MEM_UNIT_MASK) & (~USBHC_MEM_UNIT_MASK))
72 // Advance the byte and bit to the next bit, adjust byte accordingly.
74 #define NEXT_BIT(Byte, Bit) \
87 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
95 Initialize the memory management pool for the host controller
99 Pool - The USB memory pool to initialize
100 PciIo - The PciIo that can be used to access the host controller
101 Check4G - Whether the host controller requires allocated memory
102 from one 4G address space.
103 Which4G - The 4G memory area each memory allocated should be from
107 EFI_SUCCESS : The memory pool is initialized
108 EFI_OUT_OF_RESOURCE : Fail to init the memory pool
116 Release the memory management pool
118 @param Pool The USB memory pool to free
120 @return EFI_SUCCESS : The memory pool is freed
121 @return EFI_DEVICE_ERROR : Failed to free the memory pool
126 IN USBHC_MEM_POOL
*Pool
133 Allocate some memory from the host controller's memory pool
134 which can be used to communicate with host controller.
136 @param Pool The host controller's memory pool
137 @param Size Size of the memory to allocate
139 @return The allocated memory or NULL
144 IN USBHC_MEM_POOL
*Pool
,
152 Free the allocated memory back to the memory pool
154 @param Pool The memory pool of the host controller
155 @param Mem The memory to free
156 @param Size The size of the memory to free
163 IN USBHC_MEM_POOL
*Pool
,