MdeModulePkg/Bus/Pci/UhciDxe/UsbHcMem.h

   1 /** @file
   2
   3   This file contains the definination for host controller memory management routines
   4
   5 Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _EFI_EHCI_MEM_H_
  11 #define _EFI_EHCI_MEM_H_
  12
  13 #define USB_HC_BIT(a)                  ((UINTN)(1 << (a)))
  14
  15 #define USB_HC_BIT_IS_SET(Data, Bit)   \
  16           ((BOOLEAN)(((Data) & USB_HC_BIT(Bit)) == USB_HC_BIT(Bit)))
  17
  18 #define USB_HC_HIGH_32BIT(Addr64)    \
  19           ((UINT32)(RShiftU64((UINTN)(Addr64), 32) & 0XFFFFFFFF))
  20
  21
  22 typedef struct _USBHC_MEM_BLOCK USBHC_MEM_BLOCK;
  23 struct _USBHC_MEM_BLOCK {
  24   UINT8                   *Bits;    // Bit array to record which unit is allocated
  25   UINTN                   BitsLen;
  26   UINT8                   *Buf;
  27   UINT8                   *BufHost;
  28   UINTN                   BufLen;   // Memory size in bytes
  29   VOID                    *Mapping;
  30   USBHC_MEM_BLOCK         *Next;
  31 };
  32
  33 //
  34 // USBHC_MEM_POOL is used to manage the memory used by USB
  35 // host controller. EHCI requires the control memory and transfer
  36 // data to be on the same 4G memory.
  37 //
  38 typedef struct _USBHC_MEM_POOL {
  39   EFI_PCI_IO_PROTOCOL     *PciIo;
  40   BOOLEAN                 Check4G;
  41   UINT32                  Which4G;
  42   USBHC_MEM_BLOCK         *Head;
  43 } USBHC_MEM_POOL;
  44
  45 //
  46 // Memory allocation unit, must be 2^n, n>4
  47 //
  48 #define USBHC_MEM_UNIT           64
  49
  50 #define USBHC_MEM_UNIT_MASK      (USBHC_MEM_UNIT - 1)
  51 #define USBHC_MEM_DEFAULT_PAGES  16
  52
  53 #define USBHC_MEM_ROUND(Len)  (((Len) + USBHC_MEM_UNIT_MASK) & (~USBHC_MEM_UNIT_MASK))
  54
  55 //
  56 // Advance the byte and bit to the next bit, adjust byte accordingly.
  57 //
  58 #define NEXT_BIT(Byte, Bit)   \
  59           do {                \
  60             (Bit)++;          \
  61             if ((Bit) > 7) {  \
  62               (Byte)++;       \
  63               (Bit) = 0;      \
  64             }                 \
  65           } while (0)
  66
  67
  68 /**
  69   Initialize the memory management pool for the host controller.
  70
  71   @param  PciIo               The PciIo that can be used to access the host controller.
  72   @param  Check4G             Whether the host controller requires allocated memory
  73                               from one 4G address space.
  74   @param  Which4G             The 4G memory area each memory allocated should be from.
  75
  76   @retval EFI_SUCCESS         The memory pool is initialized.
  77   @retval EFI_OUT_OF_RESOURCE Fail to init the memory pool.
  78
  79 **/
  80 USBHC_MEM_POOL *
  81 UsbHcInitMemPool (
  82   IN EFI_PCI_IO_PROTOCOL  *PciIo,
  83   IN BOOLEAN              Check4G,
  84   IN UINT32               Which4G
  85   );
  86
  87
  88 /**
  89   Release the memory management pool.
  90
  91   @param  Pool               The USB memory pool to free.
  92
  93   @return EFI_SUCCESS        The memory pool is freed.
  94   @return EFI_DEVICE_ERROR   Failed to free the memory pool.
  95
  96 **/
  97 EFI_STATUS
  98 UsbHcFreeMemPool (
  99   IN USBHC_MEM_POOL       *Pool
 100   );
 101
 102
 103
 104 /**
 105   Allocate some memory from the host controller's memory pool
 106   which can be used to communicate with host controller.
 107
 108   @param  Pool  The host controller's memory pool.
 109   @param  Size  Size of the memory to allocate.
 110
 111   @return The allocated memory or NULL.
 112
 113 **/
 114 VOID *
 115 UsbHcAllocateMem (
 116   IN  USBHC_MEM_POOL      *Pool,
 117   IN  UINTN               Size
 118   );
 119
 120
 121
 122 /**
 123   Free the allocated memory back to the memory pool.
 124
 125   @param  Pool  The memory pool of the host controller.
 126   @param  Mem   The memory to free.
 127   @param  Size  The size of the memory to free.
 128
 129   @return None.
 130
 131 **/
 132 VOID
 133 UsbHcFreeMem (
 134   IN USBHC_MEM_POOL       *Pool,
 135   IN VOID                 *Mem,
 136   IN UINTN                Size
 137   );
 138
 139 /**
 140   Calculate the corresponding pci bus address according to the Mem parameter.
 141
 142   @param  Pool           The memory pool of the host controller.
 143   @param  Mem            The pointer to host memory.
 144   @param  Size           The size of the memory region.
 145
 146   @return the pci memory address
 147 **/
 148 EFI_PHYSICAL_ADDRESS
 149 UsbHcGetPciAddressForHostMem (
 150   IN USBHC_MEM_POOL       *Pool,
 151   IN VOID                 *Mem,
 152   IN UINTN                Size
 153   );
 154
 155 #endif