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.
28 Allocate a block of memory to be used by the buffer pool
30 @param Pool The buffer pool to allocate memory for
31 @param Pages How many pages to allocate
33 @return The allocated memory block or NULL if failed
39 IN USBHC_MEM_POOL
*Pool
,
43 USBHC_MEM_BLOCK
*Block
;
44 EFI_PCI_IO_PROTOCOL
*PciIo
;
47 EFI_PHYSICAL_ADDRESS MappedAddr
;
53 Block
= AllocateZeroPool (sizeof (USBHC_MEM_BLOCK
));
59 // each bit in the bit array represents USBHC_MEM_UNIT
60 // bytes of memory in the memory block.
62 ASSERT (USBHC_MEM_UNIT
* 8 <= EFI_PAGE_SIZE
);
64 Block
->BufLen
= EFI_PAGES_TO_SIZE (Pages
);
65 Block
->BitsLen
= Block
->BufLen
/ (USBHC_MEM_UNIT
* 8);
66 Block
->Bits
= AllocateZeroPool (Block
->BitsLen
);
68 if (Block
->Bits
== NULL
) {
69 gBS
->FreePool (Block
);
74 // Allocate the number of Pages of memory, then map it for
75 // bus master read and write.
77 Status
= PciIo
->AllocateBuffer (
86 if (EFI_ERROR (Status
)) {
90 Bytes
= EFI_PAGES_TO_SIZE (Pages
);
93 EfiPciIoOperationBusMasterCommonBuffer
,
100 if (EFI_ERROR (Status
) || (Bytes
!= EFI_PAGES_TO_SIZE (Pages
))) {
105 // Check whether the data structure used by the host controller
106 // should be restricted into the same 4G
108 if (Pool
->Check4G
&& (Pool
->Which4G
!= USB_HC_HIGH_32BIT (MappedAddr
))) {
109 PciIo
->Unmap (PciIo
, Mapping
);
113 Block
->BufHost
= BufHost
;
114 Block
->Buf
= (UINT8
*) ((UINTN
) MappedAddr
);
115 Block
->Mapping
= Mapping
;
120 PciIo
->FreeBuffer (PciIo
, Pages
, BufHost
);
123 gBS
->FreePool (Block
->Bits
);
124 gBS
->FreePool (Block
);
130 Free the memory block from the memory pool
132 @param Pool The memory pool to free the block from
133 @param Block The memory block to free
141 IN USBHC_MEM_POOL
*Pool
,
142 IN USBHC_MEM_BLOCK
*Block
145 EFI_PCI_IO_PROTOCOL
*PciIo
;
147 ASSERT ((Pool
!= NULL
) && (Block
!= NULL
));
152 // Unmap the common buffer then free the structures
154 PciIo
->Unmap (PciIo
, Block
->Mapping
);
155 PciIo
->FreeBuffer (PciIo
, EFI_SIZE_TO_PAGES (Block
->BufLen
), Block
->BufHost
);
157 gBS
->FreePool (Block
->Bits
);
158 gBS
->FreePool (Block
);
163 Alloc some memory from the block
165 @param Block The memory block to allocate memory from
166 @param Mem The variable to store the memory allocated
167 @param Units Number of memory units to allocate
169 @return EFI_SUCCESS : The needed memory is allocated
170 @return EFI_NOT_FOUND : Can't find the free memory
175 UsbHcAllocMemFromBlock (
176 IN USBHC_MEM_BLOCK
*Block
,
187 ASSERT ((Block
!= 0) && (Units
!= 0));
193 for (Byte
= 0, Bit
= 0; Byte
< Block
->BitsLen
;) {
195 // If current bit is zero, the corresponding memory unit is
196 // available, otherwise we need to restart our searching.
197 // Available counts the consective number of zero bit.
199 if (!USB_HC_BIT_IS_SET (Block
->Bits
[Byte
], Bit
)) {
202 if (Available
>= Units
) {
206 NEXT_BIT (Byte
, Bit
);
209 NEXT_BIT (Byte
, Bit
);
217 if (Available
< Units
) {
222 // Mark the memory as allocated
227 for (Count
= 0; Count
< Units
; Count
++) {
228 ASSERT (!USB_HC_BIT_IS_SET (Block
->Bits
[Byte
], Bit
));
230 Block
->Bits
[Byte
] = (UINT8
) (Block
->Bits
[Byte
] | USB_HC_BIT (Bit
));
231 NEXT_BIT (Byte
, Bit
);
234 return Block
->Buf
+ (StartByte
* 8 + StartBit
) * USBHC_MEM_UNIT
;
239 Insert the memory block to the pool's list of the blocks
241 @param Head The head of the memory pool's block list
242 @param Block The memory block to insert
249 UsbHcInsertMemBlockToPool (
250 IN USBHC_MEM_BLOCK
*Head
,
251 IN USBHC_MEM_BLOCK
*Block
254 ASSERT ((Head
!= NULL
) && (Block
!= NULL
));
255 Block
->Next
= Head
->Next
;
261 Is the memory block empty?
263 @param Block The memory block to check
265 @return TRUE : The memory block is empty
266 @return FALSE : The memory block isn't empty
271 UsbHcIsMemBlockEmpty (
272 IN USBHC_MEM_BLOCK
*Block
277 for (Index
= 0; Index
< Block
->BitsLen
; Index
++) {
278 if (Block
->Bits
[Index
] != 0) {
288 Unlink the memory block from the pool's list
290 @param Head The block list head of the memory's pool
291 @param BlockToUnlink The memory block to unlink.
298 UsbHcUnlinkMemBlock (
299 IN USBHC_MEM_BLOCK
*Head
,
300 IN USBHC_MEM_BLOCK
*BlockToUnlink
303 USBHC_MEM_BLOCK
*Block
;
305 ASSERT ((Head
!= NULL
) && (BlockToUnlink
!= NULL
));
307 for (Block
= Head
; Block
!= NULL
; Block
= Block
->Next
) {
308 if (Block
->Next
== BlockToUnlink
) {
309 Block
->Next
= BlockToUnlink
->Next
;
310 BlockToUnlink
->Next
= NULL
;
318 Initialize the memory management pool for the host controller
320 @param Pool The USB memory pool to initialize
321 @param PciIo The PciIo that can be used to access the host controller
322 @param Check4G Whether the host controller requires allocated memory
323 from one 4G address space.
324 @param Which4G The 4G memory area each memory allocated should be from
326 @return EFI_SUCCESS : The memory pool is initialized
327 @return EFI_OUT_OF_RESOURCE : Fail to init the memory pool
332 IN EFI_PCI_IO_PROTOCOL
*PciIo
,
337 USBHC_MEM_POOL
*Pool
;
339 Pool
= AllocatePool (sizeof (USBHC_MEM_POOL
));
346 Pool
->Check4G
= Check4G
;
347 Pool
->Which4G
= Which4G
;
348 Pool
->Head
= UsbHcAllocMemBlock (Pool
, USBHC_MEM_DEFAULT_PAGES
);
350 if (Pool
->Head
== NULL
) {
351 gBS
->FreePool (Pool
);
360 Release the memory management pool
362 @param Pool The USB memory pool to free
364 @return EFI_SUCCESS : The memory pool is freed
365 @return EFI_DEVICE_ERROR : Failed to free the memory pool
370 IN USBHC_MEM_POOL
*Pool
373 USBHC_MEM_BLOCK
*Block
;
375 ASSERT (Pool
->Head
!= NULL
);
378 // Unlink all the memory blocks from the pool, then free them.
379 // UsbHcUnlinkMemBlock can't be used to unlink and free the
382 for (Block
= Pool
->Head
->Next
; Block
!= NULL
; Block
= Pool
->Head
->Next
) {
383 UsbHcUnlinkMemBlock (Pool
->Head
, Block
);
384 UsbHcFreeMemBlock (Pool
, Block
);
387 UsbHcFreeMemBlock (Pool
, Pool
->Head
);
388 gBS
->FreePool (Pool
);
394 Allocate some memory from the host controller's memory pool
395 which can be used to communicate with host controller.
397 @param Pool The host controller's memory pool
398 @param Size Size of the memory to allocate
400 @return The allocated memory or NULL
405 IN USBHC_MEM_POOL
*Pool
,
409 USBHC_MEM_BLOCK
*Head
;
410 USBHC_MEM_BLOCK
*Block
;
411 USBHC_MEM_BLOCK
*NewBlock
;
417 AllocSize
= USBHC_MEM_ROUND (Size
);
419 ASSERT (Head
!= NULL
);
422 // First check whether current memory blocks can satisfy the allocation.
424 for (Block
= Head
; Block
!= NULL
; Block
= Block
->Next
) {
425 Mem
= UsbHcAllocMemFromBlock (Block
, AllocSize
/ USBHC_MEM_UNIT
);
438 // Create a new memory block if there is not enough memory
439 // in the pool. If the allocation size is larger than the
440 // default page number, just allocate a large enough memory
441 // block. Otherwise allocate default pages.
443 if (AllocSize
> EFI_PAGES_TO_SIZE (USBHC_MEM_DEFAULT_PAGES
)) {
444 Pages
= EFI_SIZE_TO_PAGES (AllocSize
) + 1;
446 Pages
= USBHC_MEM_DEFAULT_PAGES
;
449 NewBlock
= UsbHcAllocMemBlock (Pool
, Pages
);
451 if (NewBlock
== NULL
) {
452 DEBUG ((EFI_D_INFO
, "UsbHcAllocateMem: failed to allocate block\n"));
457 // Add the new memory block to the pool, then allocate memory from it
459 UsbHcInsertMemBlockToPool (Head
, NewBlock
);
460 Mem
= UsbHcAllocMemFromBlock (NewBlock
, AllocSize
/ USBHC_MEM_UNIT
);
471 Free the allocated memory back to the memory pool
473 @param Pool The memory pool of the host controller
474 @param Mem The memory to free
475 @param Size The size of the memory to free
482 IN USBHC_MEM_POOL
*Pool
,
487 USBHC_MEM_BLOCK
*Head
;
488 USBHC_MEM_BLOCK
*Block
;
496 AllocSize
= USBHC_MEM_ROUND (Size
);
497 ToFree
= (UINT8
*) Mem
;
499 for (Block
= Head
; Block
!= NULL
; Block
= Block
->Next
) {
501 // scan the memory block list for the memory block that
502 // completely contains the memory to free.
504 if ((Block
->Buf
<= ToFree
) && ((ToFree
+ AllocSize
) <= (Block
->Buf
+ Block
->BufLen
))) {
506 // compute the start byte and bit in the bit array
508 Byte
= ((ToFree
- Block
->Buf
) / USBHC_MEM_UNIT
) / 8;
509 Bit
= ((ToFree
- Block
->Buf
) / USBHC_MEM_UNIT
) % 8;
512 // reset associated bits in bit arry
514 for (Count
= 0; Count
< (AllocSize
/ USBHC_MEM_UNIT
); Count
++) {
515 ASSERT (USB_HC_BIT_IS_SET (Block
->Bits
[Byte
], Bit
));
517 Block
->Bits
[Byte
] = (UINT8
) (Block
->Bits
[Byte
] ^ USB_HC_BIT (Bit
));
518 NEXT_BIT (Byte
, Bit
);
526 // If Block == NULL, it means that the current memory isn't
527 // in the host controller's pool. This is critical because
528 // the caller has passed in a wrong memory point
530 ASSERT (Block
!= NULL
);
533 // Release the current memory block if it is empty and not the head
535 if ((Block
!= Head
) && UsbHcIsMemBlockEmpty (Block
)) {
536 UsbHcUnlinkMemBlock (Head
, Block
);
537 UsbHcFreeMemBlock (Pool
, Block
);