MdeModulePkg/Bus/Pci/EhciDxe/UsbHcMem.h

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