3 This file contains the definination for host controller memory management routines
5 Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef _EFI_EHCI_MEM_H_
11 #define _EFI_EHCI_MEM_H_
13 #define USB_HC_BIT(a) ((UINTN)(1 << (a)))
15 #define USB_HC_BIT_IS_SET(Data, Bit) \
16 ((BOOLEAN)(((Data) & USB_HC_BIT(Bit)) == USB_HC_BIT(Bit)))
18 #define USB_HC_HIGH_32BIT(Addr64) \
19 ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))
21 typedef struct _USBHC_MEM_BLOCK USBHC_MEM_BLOCK
;
22 struct _USBHC_MEM_BLOCK
{
23 UINT8
*Bits
; // Bit array to record which unit is allocated
27 UINTN BufLen
; // Memory size in bytes
29 USBHC_MEM_BLOCK
*Next
;
33 // USBHC_MEM_POOL is used to manage the memory used by USB
34 // host controller. EHCI requires the control memory and transfer
35 // data to be on the same 4G memory.
37 typedef struct _USBHC_MEM_POOL
{
38 EFI_PCI_IO_PROTOCOL
*PciIo
;
41 USBHC_MEM_BLOCK
*Head
;
45 // Memory allocation unit, must be 2^n, n>4
47 #define USBHC_MEM_UNIT 64
49 #define USBHC_MEM_UNIT_MASK (USBHC_MEM_UNIT - 1)
50 #define USBHC_MEM_DEFAULT_PAGES 16
52 #define USBHC_MEM_ROUND(Len) (((Len) + USBHC_MEM_UNIT_MASK) & (~USBHC_MEM_UNIT_MASK))
55 // Advance the byte and bit to the next bit, adjust byte accordingly.
57 #define NEXT_BIT(Byte, Bit) \
67 Initialize the memory management pool for the host controller.
69 @param PciIo The PciIo that can be used to access the host controller.
70 @param Check4G Whether the host controller requires allocated memory
71 from one 4G address space.
72 @param Which4G The 4G memory area each memory allocated should be from.
74 @retval EFI_SUCCESS The memory pool is initialized.
75 @retval EFI_OUT_OF_RESOURCE Fail to init the memory pool.
80 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
86 Release the memory management pool.
88 @param Pool The USB memory pool to free.
90 @return EFI_SUCCESS The memory pool is freed.
91 @return EFI_DEVICE_ERROR Failed to free the memory pool.
96 IN USBHC_MEM_POOL
*Pool
100 Allocate some memory from the host controller's memory pool
101 which can be used to communicate with host controller.
103 @param Pool The host controller's memory pool.
104 @param Size Size of the memory to allocate.
106 @return The allocated memory or NULL.
111 IN USBHC_MEM_POOL
*Pool
,
116 Free the allocated memory back to the memory pool.
118 @param Pool The memory pool of the host controller.
119 @param Mem The memory to free.
120 @param Size The size of the memory to free.
127 IN USBHC_MEM_POOL
*Pool
,
133 Calculate the corresponding pci bus address according to the Mem parameter.
135 @param Pool The memory pool of the host controller.
136 @param Mem The pointer to host memory.
137 @param Size The size of the memory region.
139 @return the pci memory address
142 UsbHcGetPciAddressForHostMem (
143 IN USBHC_MEM_POOL
*Pool
,