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_
27 #include <IndustryStandard/Pci22.h>
29 #define USB_HC_BIT(a) ((UINTN)(1 << (a)))
31 #define USB_HC_BIT_IS_SET(Data, Bit) \
32 ((BOOLEAN)(((Data) & USB_HC_BIT(Bit)) == USB_HC_BIT(Bit)))
34 #define USB_HC_HIGH_32BIT(Addr64) \
35 ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))
37 typedef struct _USBHC_MEM_BLOCK USBHC_MEM_BLOCK
;
39 typedef struct _USBHC_MEM_BLOCK
{
40 UINT8
*Bits
; // Bit array to record which unit is allocated
44 UINTN BufLen
; // Memory size in bytes
46 USBHC_MEM_BLOCK
*Next
;
50 // USBHC_MEM_POOL is used to manage the memory used by USB
51 // host controller. EHCI requires the control memory and transfer
52 // data to be on the same 4G memory.
54 typedef struct _USBHC_MEM_POOL
{
55 EFI_PCI_IO_PROTOCOL
*PciIo
;
58 USBHC_MEM_BLOCK
*Head
;
62 USBHC_MEM_UNIT
= 64, // Memory allocation unit, must be 2^n, n>4
64 USBHC_MEM_UNIT_MASK
= USBHC_MEM_UNIT
- 1,
65 USBHC_MEM_DEFAULT_PAGES
= 16,
68 #define USBHC_MEM_ROUND(Len) (((Len) + USBHC_MEM_UNIT_MASK) & (~USBHC_MEM_UNIT_MASK))
71 // Advance the byte and bit to the next bit, adjust byte accordingly.
73 #define NEXT_BIT(Byte, Bit) \
86 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
94 Initialize the memory management pool for the host controller
98 Pool - The USB memory pool to initialize
99 PciIo - The PciIo that can be used to access the host controller
100 Check4G - Whether the host controller requires allocated memory
101 from one 4G address space.
102 Which4G - The 4G memory area each memory allocated should be from
106 EFI_SUCCESS : The memory pool is initialized
107 EFI_OUT_OF_RESOURCE : Fail to init the memory pool
115 Release the memory management pool
117 @param Pool The USB memory pool to free
119 @return EFI_SUCCESS : The memory pool is freed
120 @return EFI_DEVICE_ERROR : Failed to free the memory pool
125 IN USBHC_MEM_POOL
*Pool
132 Allocate some memory from the host controller's memory pool
133 which can be used to communicate with host controller.
135 @param Pool The host controller's memory pool
136 @param Size Size of the memory to allocate
138 @return The allocated memory or NULL
143 IN USBHC_MEM_POOL
*Pool
,
151 Free the allocated memory back to the memory pool
153 @param Pool The memory pool of the host controller
154 @param Mem The memory to free
155 @param Size The size of the memory to free
162 IN USBHC_MEM_POOL
*Pool
,