3 This file contains the definination for host controller memory management routines.
5 Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef _EFI_XHCI_MEM_H_
11 #define _EFI_XHCI_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 typedef struct _USBHC_MEM_BLOCK USBHC_MEM_BLOCK
;
19 struct _USBHC_MEM_BLOCK
{
20 UINT8
*Bits
; // Bit array to record which unit is allocated
24 UINTN BufLen
; // Memory size in bytes
26 USBHC_MEM_BLOCK
*Next
;
30 // USBHC_MEM_POOL is used to manage the memory used by USB
31 // host controller. XHCI requires the control memory and transfer
32 // data to be on the same 4G memory.
34 typedef struct _USBHC_MEM_POOL
{
35 EFI_PCI_IO_PROTOCOL
*PciIo
;
38 USBHC_MEM_BLOCK
*Head
;
42 // Memory allocation unit, must be 2^n, n>4
44 #define USBHC_MEM_UNIT 64
46 #define USBHC_MEM_UNIT_MASK (USBHC_MEM_UNIT - 1)
47 #define USBHC_MEM_DEFAULT_PAGES 16
49 #define USBHC_MEM_ROUND(Len) (((Len) + USBHC_MEM_UNIT_MASK) & (~USBHC_MEM_UNIT_MASK))
52 // Advance the byte and bit to the next bit, adjust byte accordingly.
54 #define NEXT_BIT(Byte, Bit) \
64 Initialize the memory management pool for the host controller.
66 @param PciIo The PciIo that can be used to access the host controller.
68 @retval EFI_SUCCESS The memory pool is initialized.
69 @retval EFI_OUT_OF_RESOURCE Fail to init the memory pool.
74 IN EFI_PCI_IO_PROTOCOL
*PciIo
78 Release the memory management pool.
80 @param Pool The USB memory pool to free.
82 @retval EFI_SUCCESS The memory pool is freed.
83 @retval EFI_DEVICE_ERROR Failed to free the memory pool.
88 IN USBHC_MEM_POOL
*Pool
92 Allocate some memory from the host controller's memory pool
93 which can be used to communicate with host controller.
95 @param Pool The host controller's memory pool.
96 @param Size Size of the memory to allocate.
98 @return The allocated memory or NULL.
103 IN USBHC_MEM_POOL
*Pool
,
108 Free the allocated memory back to the memory pool.
110 @param Pool The memory pool of the host controller.
111 @param Mem The memory to free.
112 @param Size The size of the memory to free.
117 IN USBHC_MEM_POOL
*Pool
,
123 Calculate the corresponding pci bus address according to the Mem parameter.
125 @param Pool The memory pool of the host controller.
126 @param Mem The pointer to host memory.
127 @param Size The size of the memory region.
129 @return The pci memory address
133 UsbHcGetPciAddrForHostAddr (
134 IN USBHC_MEM_POOL
*Pool
,
140 Calculate the corresponding host address according to the pci address.
142 @param Pool The memory pool of the host controller.
143 @param Mem The pointer to pci memory.
144 @param Size The size of the memory region.
146 @return The host memory address
150 UsbHcGetHostAddrForPciAddr (
151 IN USBHC_MEM_POOL
*Pool
,
157 Allocates pages at a specified alignment that are suitable for an EfiPciIoOperationBusMasterCommonBuffer mapping.
159 If Alignment is not a power of two and Alignment is not zero, then ASSERT().
161 @param PciIo The PciIo that can be used to access the host controller.
162 @param Pages The number of pages to allocate.
163 @param Alignment The requested alignment of the allocation. Must be a power of two.
164 @param HostAddress The system memory address to map to the PCI controller.
165 @param DeviceAddress The resulting map address for the bus master PCI controller to
166 use to access the hosts HostAddress.
167 @param Mapping A resulting value to pass to Unmap().
169 @retval EFI_SUCCESS Success to allocate aligned pages.
170 @retval EFI_INVALID_PARAMETER Pages or Alignment is not valid.
171 @retval EFI_OUT_OF_RESOURCES Do not have enough resources to allocate memory.
176 UsbHcAllocateAlignedPages (
177 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
180 OUT VOID
**HostAddress
,
181 OUT EFI_PHYSICAL_ADDRESS
*DeviceAddress
,
186 Frees memory that was allocated with UsbHcAllocateAlignedPages().
188 @param PciIo The PciIo that can be used to access the host controller.
189 @param HostAddress The system memory address to map to the PCI controller.
190 @param Pages The number of pages to free.
191 @param Mapping The mapping value returned from Map().
195 UsbHcFreeAlignedPages (
196 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
197 IN VOID
*HostAddress
,