MdeModulePkg/Bus/Pci/UhciDxe/UsbHcMem.h

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