3 This file contains the definination for host controller memory management routines
5 Copyright (c) 2007, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _EFI_EHCI_MEM_H_
17 #define _EFI_EHCI_MEM_H_
19 #include <IndustryStandard/Pci22.h>
21 #define USB_HC_BIT(a) ((UINTN)(1 << (a)))
23 #define USB_HC_BIT_IS_SET(Data, Bit) \
24 ((BOOLEAN)(((Data) & USB_HC_BIT(Bit)) == USB_HC_BIT(Bit)))
26 #define USB_HC_HIGH_32BIT(Addr64) \
27 ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))
29 typedef struct _USBHC_MEM_BLOCK USBHC_MEM_BLOCK
;
31 struct _USBHC_MEM_BLOCK
{
32 UINT8
*Bits
; // Bit array to record which unit is allocated
36 UINTN BufLen
; // Memory size in bytes
38 USBHC_MEM_BLOCK
*Next
;
42 // USBHC_MEM_POOL is used to manage the memory used by USB
43 // host controller. EHCI requires the control memory and transfer
44 // data to be on the same 4G memory.
46 typedef struct _USBHC_MEM_POOL
{
47 EFI_PCI_IO_PROTOCOL
*PciIo
;
50 USBHC_MEM_BLOCK
*Head
;
54 USBHC_MEM_UNIT
= 64, // Memory allocation unit, must be 2^n, n>4
56 USBHC_MEM_UNIT_MASK
= USBHC_MEM_UNIT
- 1,
57 USBHC_MEM_DEFAULT_PAGES
= 16
60 #define USBHC_MEM_ROUND(Len) (((Len) + USBHC_MEM_UNIT_MASK) & (~USBHC_MEM_UNIT_MASK))
63 // Advance the byte and bit to the next bit, adjust byte accordingly.
65 #define NEXT_BIT(Byte, Bit) \
76 Initialize the memory management pool for the host controller.
78 @param PciIo The PciIo that can be used to access the host controller.
79 @param Check4G Whether the host controller requires allocated memory
80 from one 4G address space.
81 @param Which4G The 4G memory area each memory allocated should be from.
83 @retval EFI_SUCCESS The memory pool is initialized.
84 @retval EFI_OUT_OF_RESOURCE Fail to init the memory pool.
89 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
97 Release the memory management pool.
99 @param Pool The USB memory pool to free.
101 @return EFI_SUCCESS The memory pool is freed.
102 @return EFI_DEVICE_ERROR Failed to free the memory pool.
107 IN USBHC_MEM_POOL
*Pool
114 Allocate some memory from the host controller's memory pool
115 which can be used to communicate with host controller.
117 @param Pool The host controller's memory pool.
118 @param Size Size of the memory to allocate.
120 @return The allocated memory or NULL.
125 IN USBHC_MEM_POOL
*Pool
,
133 Free the allocated memory back to the memory pool.
135 @param Pool The memory pool of the host controller.
136 @param Mem The memory to free.
137 @param Size The size of the memory to free.
144 IN USBHC_MEM_POOL
*Pool
,