MdeModulePkg: Fix typos in comments and variables

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / XhciPei / UsbHcMem.c

/** @file\r
PEIM to produce gPeiUsb2HostControllerPpiGuid based on gPeiUsbControllerPpiGuid\r
which is used to enable recovery function from USB Drivers.\r
\r
Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
of the BSD License which accompanies this distribution.  The\r
full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "XhcPeim.h"\r
\r
/**\r
  Allocate a block of memory to be used by the buffer pool.\r
\r
  @param  Pages         How many pages to allocate.\r
\r
  @return Pointer to the allocated memory block or NULL if failed.\r
\r
**/\r
USBHC_MEM_BLOCK *\r
UsbHcAllocMemBlock (\r
  IN UINTN              Pages\r
  )\r
{\r
  USBHC_MEM_BLOCK       *Block;\r
  EFI_STATUS            Status;\r
  UINTN                 PageNumber;\r
  EFI_PHYSICAL_ADDRESS  TempPtr;\r
\r
  PageNumber = EFI_SIZE_TO_PAGES (sizeof (USBHC_MEM_BLOCK));\r
  Status = PeiServicesAllocatePages (\r
             EfiBootServicesData,\r
             PageNumber,\r
             &TempPtr\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
  ZeroMem ((VOID *) (UINTN) TempPtr, EFI_PAGES_TO_SIZE (PageNumber));\r
\r
  //\r
  // each bit in the bit array represents USBHC_MEM_UNIT\r
  // bytes of memory in the memory block.\r
  //\r
  ASSERT (USBHC_MEM_UNIT * 8 <= EFI_PAGE_SIZE);\r
\r
  Block = (USBHC_MEM_BLOCK *) (UINTN) TempPtr;\r
  Block->BufLen = EFI_PAGES_TO_SIZE (Pages);\r
  Block->BitsLen = Block->BufLen / (USBHC_MEM_UNIT * 8);\r
\r
  PageNumber = EFI_SIZE_TO_PAGES (Block->BitsLen);\r
  Status = PeiServicesAllocatePages (\r
             EfiBootServicesData,\r
             PageNumber,\r
             &TempPtr\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
  ZeroMem ((VOID *) (UINTN) TempPtr, EFI_PAGES_TO_SIZE (PageNumber));\r
\r
  Block->Bits = (UINT8 *) (UINTN) TempPtr;\r
\r
  Status = PeiServicesAllocatePages (\r
             EfiBootServicesData,\r
             Pages,\r
             &TempPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
  ZeroMem ((VOID *) (UINTN) TempPtr, EFI_PAGES_TO_SIZE (Pages));\r
\r
  Block->BufHost = (UINT8 *) (UINTN) TempPtr;;\r
  Block->Buf = (UINT8 *) (UINTN) TempPtr;\r
  Block->Next = NULL;\r
\r
  return Block;\r
}\r
\r
/**\r
  Free the memory block from the memory pool.\r
\r
  @param  Pool          The memory pool to free the block from.\r
  @param  Block         The memory block to free.\r
\r
**/\r
VOID\r
UsbHcFreeMemBlock (\r
  IN USBHC_MEM_POOL     *Pool,\r
  IN USBHC_MEM_BLOCK    *Block\r
  )\r
{\r
  ASSERT ((Pool != NULL) && (Block != NULL));\r
  //\r
  // No free memory in PEI.\r
  //\r
}\r
\r
/**\r
  Alloc some memory from the block.\r
\r
  @param  Block         The memory block to allocate memory from.\r
  @param  Units         Number of memory units to allocate.\r
\r
  @return The pointer to the allocated memory.\r
          If couldn't allocate the needed memory, the return value is NULL.\r
\r
**/\r
VOID *\r
UsbHcAllocMemFromBlock (\r
  IN USBHC_MEM_BLOCK    *Block,\r
  IN UINTN              Units\r
  )\r
{\r
  UINTN                 Byte;\r
  UINT8                 Bit;\r
  UINTN                 StartByte;\r
  UINT8                 StartBit;\r
  UINTN                 Available;\r
  UINTN                 Count;\r
\r
  ASSERT ((Block != 0) && (Units != 0));\r
\r
  StartByte  = 0;\r
  StartBit   = 0;\r
  Available  = 0;\r
\r
  for (Byte = 0, Bit = 0; Byte < Block->BitsLen;) {\r
    //\r
    // If current bit is zero, the corresponding memory unit is\r
    // available, otherwise we need to restart our searching.\r
    // Available counts the consective number of zero bit.\r
    //\r
    if (!USB_HC_BIT_IS_SET (Block->Bits[Byte], Bit)) {\r
      Available++;\r
\r
      if (Available >= Units) {\r
        break;\r
      }\r
\r
      NEXT_BIT (Byte, Bit);\r
    } else {\r
      NEXT_BIT (Byte, Bit);\r
\r
      Available  = 0;\r
      StartByte  = Byte;\r
      StartBit   = Bit;\r
    }\r
  }\r
\r
  if (Available < Units) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Mark the memory as allocated\r
  //\r
  Byte  = StartByte;\r
  Bit   = StartBit;\r
\r
  for (Count = 0; Count < Units; Count++) {\r
    ASSERT (!USB_HC_BIT_IS_SET (Block->Bits[Byte], Bit));\r
\r
    Block->Bits[Byte] = (UINT8) (Block->Bits[Byte] | (UINT8) USB_HC_BIT (Bit));\r
    NEXT_BIT (Byte, Bit);\r
  }\r
\r
  return Block->BufHost + (StartByte * 8 + StartBit) * USBHC_MEM_UNIT;\r
}\r
\r
/**\r
  Calculate the corresponding pci bus address according to the Mem parameter.\r
\r
  @param  Pool          The memory pool of the host controller.\r
  @param  Mem           The pointer to host memory.\r
  @param  Size          The size of the memory region.\r
\r
  @return               The pci memory address\r
\r
**/\r
EFI_PHYSICAL_ADDRESS\r
UsbHcGetPciAddrForHostAddr (\r
  IN USBHC_MEM_POOL     *Pool,\r
  IN VOID               *Mem,\r
  IN UINTN              Size\r
  )\r
{\r
  USBHC_MEM_BLOCK       *Head;\r
  USBHC_MEM_BLOCK       *Block;\r
  UINTN                 AllocSize;\r
  EFI_PHYSICAL_ADDRESS  PhyAddr;\r
  UINTN                 Offset;\r
\r
  Head      = Pool->Head;\r
  AllocSize = USBHC_MEM_ROUND (Size);\r
\r
  if (Mem == NULL) {\r
    return 0;\r
  }\r
\r
  for (Block = Head; Block != NULL; Block = Block->Next) {\r
    //\r
    // scan the memory block list for the memory block that\r
    // completely contains the allocated memory.\r
    //\r
    if ((Block->BufHost <= (UINT8 *) Mem) && (((UINT8 *) Mem + AllocSize) <= (Block->BufHost + Block->BufLen))) {\r
      break;\r
    }\r
  }\r
\r
  ASSERT ((Block != NULL));\r
  //\r
  // calculate the pci memory address for host memory address.\r
  //\r
  Offset = (UINT8 *) Mem - Block->BufHost;\r
  PhyAddr = (EFI_PHYSICAL_ADDRESS) (UINTN) (Block->Buf + Offset);\r
  return PhyAddr;\r
}\r
\r
/**\r
  Calculate the corresponding host address according to the pci address.\r
\r
  @param  Pool          The memory pool of the host controller.\r
  @param  Mem           The pointer to pci memory.\r
  @param  Size          The size of the memory region.\r
\r
  @return               The host memory address\r
\r
**/\r
EFI_PHYSICAL_ADDRESS\r
UsbHcGetHostAddrForPciAddr (\r
  IN USBHC_MEM_POOL     *Pool,\r
  IN VOID               *Mem,\r
  IN UINTN              Size\r
  )\r
{\r
  USBHC_MEM_BLOCK       *Head;\r
  USBHC_MEM_BLOCK       *Block;\r
  UINTN                 AllocSize;\r
  EFI_PHYSICAL_ADDRESS  HostAddr;\r
  UINTN                 Offset;\r
\r
  Head      = Pool->Head;\r
  AllocSize = USBHC_MEM_ROUND (Size);\r
\r
  if (Mem == NULL) {\r
    return 0;\r
  }\r
\r
  for (Block = Head; Block != NULL; Block = Block->Next) {\r
    //\r
    // scan the memory block list for the memory block that\r
    // completely contains the allocated memory.\r
    //\r
    if ((Block->Buf <= (UINT8 *) Mem) && (((UINT8 *) Mem + AllocSize) <= (Block->Buf + Block->BufLen))) {\r
      break;\r
    }\r
  }\r
\r
  ASSERT ((Block != NULL));\r
  //\r
  // calculate the host memory address for pci memory address.\r
  //\r
  Offset = (UINT8 *) Mem - Block->Buf;\r
  HostAddr = (EFI_PHYSICAL_ADDRESS) (UINTN) (Block->BufHost + Offset);\r
  return HostAddr;\r
}\r
\r
/**\r
  Insert the memory block to the pool's list of the blocks.\r
\r
  @param  Head          The head of the memory pool's block list.\r
  @param  Block         The memory block to insert.\r
\r
**/\r
VOID\r
UsbHcInsertMemBlockToPool (\r
  IN USBHC_MEM_BLOCK    *Head,\r
  IN USBHC_MEM_BLOCK    *Block\r
  )\r
{\r
  ASSERT ((Head != NULL) && (Block != NULL));\r
  Block->Next = Head->Next;\r
  Head->Next  = Block;\r
}\r
\r
/**\r
  Is the memory block empty?\r
\r
  @param  Block         The memory block to check.\r
\r
  @retval TRUE          The memory block is empty.\r
  @retval FALSE         The memory block isn't empty.\r
\r
**/\r
BOOLEAN\r
UsbHcIsMemBlockEmpty (\r
  IN USBHC_MEM_BLOCK    *Block\r
  )\r
{\r
  UINTN Index;\r
\r
  for (Index = 0; Index < Block->BitsLen; Index++) {\r
    if (Block->Bits[Index] != 0) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Unlink the memory block from the pool's list.\r
\r
  @param  Head          The block list head of the memory's pool.\r
  @param  BlockToUnlink The memory block to unlink.\r
\r
**/\r
VOID\r
UsbHcUnlinkMemBlock (\r
  IN USBHC_MEM_BLOCK    *Head,\r
  IN USBHC_MEM_BLOCK    *BlockToUnlink\r
  )\r
{\r
  USBHC_MEM_BLOCK       *Block;\r
\r
  ASSERT ((Head != NULL) && (BlockToUnlink != NULL));\r
\r
  for (Block = Head; Block != NULL; Block = Block->Next) {\r
    if (Block->Next == BlockToUnlink) {\r
      Block->Next         = BlockToUnlink->Next;\r
      BlockToUnlink->Next = NULL;\r
      break;\r
    }\r
  }\r
}\r
\r
/**\r
  Initialize the memory management pool for the host controller.\r
\r
  @return Pointer to the allocated memory pool or NULL if failed.\r
\r
**/\r
USBHC_MEM_POOL *\r
UsbHcInitMemPool (\r
  VOID\r
  )\r
{\r
  USBHC_MEM_POOL        *Pool;\r
  UINTN                 PageNumber;\r
  EFI_STATUS            Status;\r
  EFI_PHYSICAL_ADDRESS  TempPtr;\r
\r
  PageNumber = EFI_SIZE_TO_PAGES (sizeof (USBHC_MEM_POOL));\r
  Status = PeiServicesAllocatePages (\r
             EfiBootServicesData,\r
             PageNumber,\r
             &TempPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
  ZeroMem ((VOID *) (UINTN) TempPtr, EFI_PAGES_TO_SIZE (PageNumber));\r
\r
  Pool = (USBHC_MEM_POOL *) ((UINTN) TempPtr);\r
  Pool->Head = UsbHcAllocMemBlock (USBHC_MEM_DEFAULT_PAGES);\r
\r
  if (Pool->Head == NULL) {\r
    //\r
    // No free memory in PEI.\r
    //\r
    Pool = NULL;\r
  }\r
\r
  return Pool;\r
}\r
\r
/**\r
  Release the memory management pool.\r
\r
  @param  Pool          The USB memory pool to free.\r
\r
**/\r
VOID\r
UsbHcFreeMemPool (\r
  IN USBHC_MEM_POOL     *Pool\r
  )\r
{\r
  USBHC_MEM_BLOCK       *Block;\r
\r
  ASSERT (Pool->Head != NULL);\r
\r
  //\r
  // Unlink all the memory blocks from the pool, then free them.\r
  // UsbHcUnlinkMemBlock can't be used to unlink and free the\r
  // first block.\r
  //\r
  for (Block = Pool->Head->Next; Block != NULL; Block = Pool->Head->Next) {\r
    //UsbHcUnlinkMemBlock (Pool->Head, Block);\r
    UsbHcFreeMemBlock (Pool, Block);\r
  }\r
\r
  UsbHcFreeMemBlock (Pool, Pool->Head);\r
}\r
\r
/**\r
  Allocate some memory from the host controller's memory pool\r
  which can be used to communicate with host controller.\r
\r
  @param  Pool          The host controller's memory pool.\r
  @param  Size          Size of the memory to allocate.\r
\r
  @return The allocated memory or NULL.\r
\r
**/\r
VOID *\r
UsbHcAllocateMem (\r
  IN USBHC_MEM_POOL     *Pool,\r
  IN UINTN              Size\r
  )\r
{\r
  USBHC_MEM_BLOCK       *Head;\r
  USBHC_MEM_BLOCK       *Block;\r
  USBHC_MEM_BLOCK       *NewBlock;\r
  VOID                  *Mem;\r
  UINTN                 AllocSize;\r
  UINTN                 Pages;\r
\r
  Mem       = NULL;\r
  AllocSize = USBHC_MEM_ROUND (Size);\r
  Head      = Pool->Head;\r
  ASSERT (Head != NULL);\r
\r
  //\r
  // First check whether current memory blocks can satisfy the allocation.\r
  //\r
  for (Block = Head; Block != NULL; Block = Block->Next) {\r
    Mem = UsbHcAllocMemFromBlock (Block, AllocSize / USBHC_MEM_UNIT);\r
\r
    if (Mem != NULL) {\r
      ZeroMem (Mem, Size);\r
      break;\r
    }\r
  }\r
\r
  if (Mem != NULL) {\r
    return Mem;\r
  }\r
\r
  //\r
  // Create a new memory block if there is not enough memory\r
  // in the pool. If the allocation size is larger than the\r
  // default page number, just allocate a large enough memory\r
  // block. Otherwise allocate default pages.\r
  //\r
  if (AllocSize > EFI_PAGES_TO_SIZE (USBHC_MEM_DEFAULT_PAGES)) {\r
    Pages = EFI_SIZE_TO_PAGES (AllocSize);\r
  } else {\r
    Pages = USBHC_MEM_DEFAULT_PAGES;\r
  }\r
  NewBlock = UsbHcAllocMemBlock (Pages);\r
\r
  if (NewBlock == NULL) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Add the new memory block to the pool, then allocate memory from it\r
  //\r
  UsbHcInsertMemBlockToPool (Head, NewBlock);\r
  Mem = UsbHcAllocMemFromBlock (NewBlock, AllocSize / USBHC_MEM_UNIT);\r
\r
  if (Mem != NULL) {\r
    ZeroMem (Mem, Size);\r
  }\r
\r
  return Mem;\r
}\r
\r
/**\r
  Free the allocated memory back to the memory pool.\r
\r
  @param  Pool          The memory pool of the host controller.\r
  @param  Mem           The memory to free.\r
  @param  Size          The size of the memory to free.\r
\r
**/\r
VOID\r
UsbHcFreeMem (\r
  IN USBHC_MEM_POOL     *Pool,\r
  IN VOID               *Mem,\r
  IN UINTN              Size\r
  )\r
{\r
  USBHC_MEM_BLOCK       *Head;\r
  USBHC_MEM_BLOCK       *Block;\r
  UINT8                 *ToFree;\r
  UINTN                 AllocSize;\r
  UINTN                 Byte;\r
  UINTN                 Bit;\r
  UINTN                 Count;\r
\r
  Head      = Pool->Head;\r
  AllocSize = USBHC_MEM_ROUND (Size);\r
  ToFree    = (UINT8 *) Mem;\r
\r
  for (Block = Head; Block != NULL; Block = Block->Next) {\r
    //\r
    // scan the memory block list for the memory block that\r
    // completely contains the memory to free.\r
    //\r
    if ((Block->BufHost <= ToFree) && ((ToFree + AllocSize) <= (Block->BufHost + Block->BufLen))) {\r
      //\r
      // compute the start byte and bit in the bit array\r
      //\r
      Byte  = ((ToFree - Block->BufHost) / USBHC_MEM_UNIT) / 8;\r
      Bit   = ((ToFree - Block->BufHost) / USBHC_MEM_UNIT) % 8;\r
\r
      //\r
      // reset associated bits in bit array\r
      //\r
      for (Count = 0; Count < (AllocSize / USBHC_MEM_UNIT); Count++) {\r
        ASSERT (USB_HC_BIT_IS_SET (Block->Bits[Byte], Bit));\r
\r
        Block->Bits[Byte] = (UINT8) (Block->Bits[Byte] ^ USB_HC_BIT (Bit));\r
        NEXT_BIT (Byte, Bit);\r
      }\r
\r
      break;\r
    }\r
  }\r
\r
  //\r
  // If Block == NULL, it means that the current memory isn't\r
  // in the host controller's pool. This is critical because\r
  // the caller has passed in a wrong memory pointer\r
  //\r
  ASSERT (Block != NULL);\r
\r
  //\r
  // Release the current memory block if it is empty and not the head\r
  //\r
  if ((Block != Head) && UsbHcIsMemBlockEmpty (Block)) {\r
    //UsbHcUnlinkMemBlock (Head, Block);\r
    UsbHcFreeMemBlock (Pool, Block);\r
  }\r
}\r
\r
/**\r
  Allocates pages at a specified alignment.\r
\r
  If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
  @param  Pages                 The number of pages to allocate.\r
  @param  Alignment             The requested alignment of the allocation.  Must be a power of two.\r
  @param  HostAddress           The system memory address to map to the PCI controller.\r
  @param  DeviceAddress         The resulting map address for the bus master PCI controller to\r
                                use to access the hosts HostAddress.\r
\r
  @retval EFI_SUCCESS           Success to allocate aligned pages.\r
  @retval EFI_INVALID_PARAMETER Pages or Alignment is not valid.\r
  @retval EFI_OUT_OF_RESOURCES  Do not have enough resources to allocate memory.\r
\r
**/\r
EFI_STATUS\r
UsbHcAllocateAlignedPages (\r
  IN UINTN                      Pages,\r
  IN UINTN                      Alignment,\r
  OUT VOID                      **HostAddress,\r
  OUT EFI_PHYSICAL_ADDRESS      *DeviceAddress\r
  )\r
{\r
  EFI_STATUS            Status;\r
  EFI_PHYSICAL_ADDRESS  Memory;\r
  UINTN                 AlignedMemory;\r
  UINTN                 AlignmentMask;\r
  UINTN                 RealPages;\r
\r
  //\r
  // Alignment must be a power of two or zero.\r
  //\r
  ASSERT ((Alignment & (Alignment - 1)) == 0);\r
\r
  if ((Alignment & (Alignment - 1)) != 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Pages == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Alignment > EFI_PAGE_SIZE) {\r
    //\r
    // Calculate the total number of pages since alignment is larger than page size.\r
    //\r
    AlignmentMask  = Alignment - 1;\r
    RealPages      = Pages + EFI_SIZE_TO_PAGES (Alignment);\r
    //\r
    // Make sure that Pages plus EFI_SIZE_TO_PAGES (Alignment) does not overflow.\r
    //\r
    ASSERT (RealPages > Pages);\r
\r
    Status = PeiServicesAllocatePages (\r
               EfiBootServicesData,\r
               Pages,\r
               &Memory\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    AlignedMemory = ((UINTN) Memory + AlignmentMask) & ~AlignmentMask;\r
  } else {\r
    //\r
    // Do not over-allocate pages in this case.\r
    //\r
    Status = PeiServicesAllocatePages (\r
               EfiBootServicesData,\r
               Pages,\r
               &Memory\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    AlignedMemory = (UINTN) Memory;\r
  }\r
\r
  *HostAddress = (VOID *) AlignedMemory;\r
  *DeviceAddress = (EFI_PHYSICAL_ADDRESS) AlignedMemory;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Frees memory that was allocated with UsbHcAllocateAlignedPages().\r
\r
  @param  HostAddress           The system memory address to map to the PCI controller.\r
  @param  Pages                 The number of pages to free.\r
\r
**/\r
VOID\r
UsbHcFreeAlignedPages (\r
  IN VOID               *HostAddress,\r
  IN UINTN              Pages\r
  )\r
{\r
  ASSERT (Pages != 0);\r
  //\r
  // No free memory in PEI.\r
  //\r
}\r
\r