3 Routine procedures for memory allocate/free.
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.
21 Allocate a block of memory to be used by the buffer pool.
23 @param Pool The buffer pool to allocate memory for.
24 @param Pages How many pages to allocate.
26 @return The allocated memory block or NULL if failed.
31 IN USBHC_MEM_POOL
*Pool
,
35 USBHC_MEM_BLOCK
*Block
;
36 EFI_PCI_IO_PROTOCOL
*PciIo
;
39 EFI_PHYSICAL_ADDRESS MappedAddr
;
45 Block
= AllocateZeroPool (sizeof (USBHC_MEM_BLOCK
));
51 // each bit in the bit array represents USBHC_MEM_UNIT
52 // bytes of memory in the memory block.
54 ASSERT (USBHC_MEM_UNIT
* 8 <= EFI_PAGE_SIZE
);
56 Block
->BufLen
= EFI_PAGES_TO_SIZE (Pages
);
57 Block
->BitsLen
= Block
->BufLen
/ (USBHC_MEM_UNIT
* 8);
58 Block
->Bits
= AllocateZeroPool (Block
->BitsLen
);
60 if (Block
->Bits
== NULL
) {
61 gBS
->FreePool (Block
);
66 // Allocate the number of Pages of memory, then map it for
67 // bus master read and write.
69 Status
= PciIo
->AllocateBuffer (
78 if (EFI_ERROR (Status
)) {
82 Bytes
= EFI_PAGES_TO_SIZE (Pages
);
85 EfiPciIoOperationBusMasterCommonBuffer
,
92 if (EFI_ERROR (Status
) || (Bytes
!= EFI_PAGES_TO_SIZE (Pages
))) {
97 // Check whether the data structure used by the host controller
98 // should be restricted into the same 4G
100 if (Pool
->Check4G
&& (Pool
->Which4G
!= USB_HC_HIGH_32BIT (MappedAddr
))) {
101 PciIo
->Unmap (PciIo
, Mapping
);
105 Block
->BufHost
= BufHost
;
106 Block
->Buf
= (UINT8
*) ((UINTN
) MappedAddr
);
107 Block
->Mapping
= Mapping
;
112 PciIo
->FreeBuffer (PciIo
, Pages
, BufHost
);
115 gBS
->FreePool (Block
->Bits
);
116 gBS
->FreePool (Block
);
122 Free the memory block from the memory pool.
124 @param Pool The memory pool to free the block from.
125 @param Block The memory block to free.
132 IN USBHC_MEM_POOL
*Pool
,
133 IN USBHC_MEM_BLOCK
*Block
136 EFI_PCI_IO_PROTOCOL
*PciIo
;
138 ASSERT ((Pool
!= NULL
) && (Block
!= NULL
));
143 // Unmap the common buffer then free the structures
145 PciIo
->Unmap (PciIo
, Block
->Mapping
);
146 PciIo
->FreeBuffer (PciIo
, EFI_SIZE_TO_PAGES (Block
->BufLen
), Block
->BufHost
);
148 gBS
->FreePool (Block
->Bits
);
149 gBS
->FreePool (Block
);
154 Alloc some memory from the block.
156 @param Block The memory block to allocate memory from.
157 @param Units Number of memory units to allocate.
159 @return The pointer to the allocated memory. If couldn't allocate the needed memory,
160 the return value is NULL.
164 UsbHcAllocMemFromBlock (
165 IN USBHC_MEM_BLOCK
*Block
,
176 ASSERT ((Block
!= 0) && (Units
!= 0));
182 for (Byte
= 0, Bit
= 0; Byte
< Block
->BitsLen
;) {
184 // If current bit is zero, the corresponding memory unit is
185 // available, otherwise we need to restart our searching.
186 // Available counts the consective number of zero bit.
188 if (!USB_HC_BIT_IS_SET (Block
->Bits
[Byte
], Bit
)) {
191 if (Available
>= Units
) {
195 NEXT_BIT (Byte
, Bit
);
198 NEXT_BIT (Byte
, Bit
);
206 if (Available
< Units
) {
211 // Mark the memory as allocated
216 for (Count
= 0; Count
< Units
; Count
++) {
217 ASSERT (!USB_HC_BIT_IS_SET (Block
->Bits
[Byte
], Bit
));
219 Block
->Bits
[Byte
] = (UINT8
) (Block
->Bits
[Byte
] | USB_HC_BIT (Bit
));
220 NEXT_BIT (Byte
, Bit
);
223 return Block
->Buf
+ (StartByte
* 8 + StartBit
) * USBHC_MEM_UNIT
;
228 Insert the memory block to the pool's list of the blocks.
230 @param Head The head of the memory pool's block list.
231 @param Block The memory block to insert.
237 UsbHcInsertMemBlockToPool (
238 IN USBHC_MEM_BLOCK
*Head
,
239 IN USBHC_MEM_BLOCK
*Block
242 ASSERT ((Head
!= NULL
) && (Block
!= NULL
));
243 Block
->Next
= Head
->Next
;
249 Is the memory block empty?
251 @param Block The memory block to check.
253 @retval TRUE The memory block is empty.
254 @retval FALSE The memory block isn't empty.
258 UsbHcIsMemBlockEmpty (
259 IN USBHC_MEM_BLOCK
*Block
264 for (Index
= 0; Index
< Block
->BitsLen
; Index
++) {
265 if (Block
->Bits
[Index
] != 0) {
275 Unlink the memory block from the pool's list.
277 @param Head The block list head of the memory's pool.
278 @param BlockToUnlink The memory block to unlink.
284 UsbHcUnlinkMemBlock (
285 IN USBHC_MEM_BLOCK
*Head
,
286 IN USBHC_MEM_BLOCK
*BlockToUnlink
289 USBHC_MEM_BLOCK
*Block
;
291 ASSERT ((Head
!= NULL
) && (BlockToUnlink
!= NULL
));
293 for (Block
= Head
; Block
!= NULL
; Block
= Block
->Next
) {
294 if (Block
->Next
== BlockToUnlink
) {
295 Block
->Next
= BlockToUnlink
->Next
;
296 BlockToUnlink
->Next
= NULL
;
304 Initialize the memory management pool for the host controller.
306 @param PciIo The PciIo that can be used to access the host controller.
307 @param Check4G Whether the host controller requires allocated memory
308 from one 4G address space.
309 @param Which4G The 4G memory area each memory allocated should be from.
311 @retval EFI_SUCCESS The memory pool is initialized.
312 @retval EFI_OUT_OF_RESOURCE Fail to init the memory pool.
317 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
322 USBHC_MEM_POOL
*Pool
;
324 Pool
= AllocatePool (sizeof (USBHC_MEM_POOL
));
331 Pool
->Check4G
= Check4G
;
332 Pool
->Which4G
= Which4G
;
333 Pool
->Head
= UsbHcAllocMemBlock (Pool
, USBHC_MEM_DEFAULT_PAGES
);
335 if (Pool
->Head
== NULL
) {
336 gBS
->FreePool (Pool
);
345 Release the memory management pool.
347 @param Pool The USB memory pool to free.
349 @retval EFI_SUCCESS The memory pool is freed.
350 @retval EFI_DEVICE_ERROR Failed to free the memory pool.
355 IN USBHC_MEM_POOL
*Pool
358 USBHC_MEM_BLOCK
*Block
;
360 ASSERT (Pool
->Head
!= NULL
);
363 // Unlink all the memory blocks from the pool, then free them.
364 // UsbHcUnlinkMemBlock can't be used to unlink and free the
367 for (Block
= Pool
->Head
->Next
; Block
!= NULL
; Block
= Pool
->Head
->Next
) {
368 UsbHcUnlinkMemBlock (Pool
->Head
, Block
);
369 UsbHcFreeMemBlock (Pool
, Block
);
372 UsbHcFreeMemBlock (Pool
, Pool
->Head
);
373 gBS
->FreePool (Pool
);
379 Allocate some memory from the host controller's memory pool
380 which can be used to communicate with host controller.
382 @param Pool The host controller's memory pool.
383 @param Size Size of the memory to allocate.
385 @return The allocated memory or NULL.
390 IN USBHC_MEM_POOL
*Pool
,
394 USBHC_MEM_BLOCK
*Head
;
395 USBHC_MEM_BLOCK
*Block
;
396 USBHC_MEM_BLOCK
*NewBlock
;
402 AllocSize
= USBHC_MEM_ROUND (Size
);
404 ASSERT (Head
!= NULL
);
407 // First check whether current memory blocks can satisfy the allocation.
409 for (Block
= Head
; Block
!= NULL
; Block
= Block
->Next
) {
410 Mem
= UsbHcAllocMemFromBlock (Block
, AllocSize
/ USBHC_MEM_UNIT
);
423 // Create a new memory block if there is not enough memory
424 // in the pool. If the allocation size is larger than the
425 // default page number, just allocate a large enough memory
426 // block. Otherwise allocate default pages.
428 if (AllocSize
> EFI_PAGES_TO_SIZE (USBHC_MEM_DEFAULT_PAGES
)) {
429 Pages
= EFI_SIZE_TO_PAGES (AllocSize
) + 1;
431 Pages
= USBHC_MEM_DEFAULT_PAGES
;
434 NewBlock
= UsbHcAllocMemBlock (Pool
, Pages
);
436 if (NewBlock
== NULL
) {
437 DEBUG ((EFI_D_INFO
, "UsbHcAllocateMem: failed to allocate block\n"));
442 // Add the new memory block to the pool, then allocate memory from it
444 UsbHcInsertMemBlockToPool (Head
, NewBlock
);
445 Mem
= UsbHcAllocMemFromBlock (NewBlock
, AllocSize
/ USBHC_MEM_UNIT
);
456 Free the allocated memory back to the memory pool.
458 @param Pool The memory pool of the host controller.
459 @param Mem The memory to free.
460 @param Size The size of the memory to free.
467 IN USBHC_MEM_POOL
*Pool
,
472 USBHC_MEM_BLOCK
*Head
;
473 USBHC_MEM_BLOCK
*Block
;
481 AllocSize
= USBHC_MEM_ROUND (Size
);
482 ToFree
= (UINT8
*) Mem
;
484 for (Block
= Head
; Block
!= NULL
; Block
= Block
->Next
) {
486 // scan the memory block list for the memory block that
487 // completely contains the memory to free.
489 if ((Block
->Buf
<= ToFree
) && ((ToFree
+ AllocSize
) <= (Block
->Buf
+ Block
->BufLen
))) {
491 // compute the start byte and bit in the bit array
493 Byte
= ((ToFree
- Block
->Buf
) / USBHC_MEM_UNIT
) / 8;
494 Bit
= ((ToFree
- Block
->Buf
) / USBHC_MEM_UNIT
) % 8;
497 // reset associated bits in bit arry
499 for (Count
= 0; Count
< (AllocSize
/ USBHC_MEM_UNIT
); Count
++) {
500 ASSERT (USB_HC_BIT_IS_SET (Block
->Bits
[Byte
], Bit
));
502 Block
->Bits
[Byte
] = (UINT8
) (Block
->Bits
[Byte
] ^ USB_HC_BIT (Bit
));
503 NEXT_BIT (Byte
, Bit
);
511 // If Block == NULL, it means that the current memory isn't
512 // in the host controller's pool. This is critical because
513 // the caller has passed in a wrong memory point
515 ASSERT (Block
!= NULL
);
518 // Release the current memory block if it is empty and not the head
520 if ((Block
!= Head
) && UsbHcIsMemBlockEmpty (Block
)) {
521 UsbHcUnlinkMemBlock (Head
, Block
);
522 UsbHcFreeMemBlock (Pool
, Block
);