sys/dev/pci/n8/include_private/n8_manage_memory.h

   1 /*-
   2  * Copyright (C) 2001-2003 by NBMK Encryption Technologies.
   3  * All rights reserved.
   4  *
   5  * NBMK Encryption Technologies provides no support of any kind for
   6  * this software.  Questions or concerns about it may be addressed to
   7  * the members of the relevant open-source community at
   8  * <tech-crypto@netbsd.org>.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are
  12  * met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  17  * 2. Redistributions in binary form must reproduce the above
  18  *    copyright notice, this list of conditions and the following
  19  *    disclaimer in the documentation and/or other materials provided
  20  *    with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 /*****************************************************************************
  36  * @(#) n8_manage_memory.h 1.7@(#)
  37  *****************************************************************************/
  38
  39 /*****************************************************************************/
  40 /** @file n8_manage_memory.h
  41  *  @brief Common definitions for NSP2000 Interface
  42  *
  43  * Common header file for memory management definitions for NSP2000 project
  44  *
  45  *****************************************************************************/
  46
  47 /*****************************************************************************
  48  * Revision history:
  49  * 05/07/03 brr   Reduced functions exposed to user space.
  50  * 04/21/03 brr   Added support for multiple memory banks.
  51  * 07/02/02 brr   Added structure for memory statistics.
  52  * 06/25/02 brr   Moved n8_memoryDisplay back to n8_memory.h.
  53  * 06/03/02 hml   initial version adapted from n8_memory.h
  54  ****************************************************************************/
  55
  56 #ifndef N8_MANAGE_MEMORY_H
  57 #define N8_MANAGE_MEMORY_H
  58
  59 #if 0
  60 #include "n8_pub_common.h"
  61 #include "n8_pub_types.h"
  62 #endif
  63 #include "n8_OS_intf.h"
  64
  65 typedef struct
  66 {
  67      int sessionID; /* 0 if free/non-zero process ID of allocater */
  68      int numBlocks; /* Number of contiguous blocks in this allocation */
  69      int reqSize;   /* requested size (as opposed to allocated size ) */
  70
  71 } MemCtlList_t;
  72
  73 /**********************************************************
  74   The MemBankCtl_t structure describes everything about a
  75   contiguous memory area that has been allocated by the
  76   driver.
  77
  78   memBaseAddress-> ////////////////////////////
  79                    /                          /
  80                    /  MemBankCtl_t structure  /
  81                    /                          /
  82        memCtlPtr-> ////////////////////////////
  83                    /                          /
  84                    /  Allocation Map          /
  85                    /                          /
  86       memBankPtr-> ////////////////////////////
  87                    /                          /
  88                    /                          /
  89                    / Allocatable memory       /
  90                    /                          /
  91                    /                          /
  92                    /                          /
  93                    ////////////////////////////
  94
  95  **********************************************************/
  96 typedef struct
  97 {
  98      unsigned long memBaseAddress;     /* base phys address of entire block */
  99      char         *memBankPtr;         /* phys pointer to allocatable memory */
 100      int           allocSize;          /* Size of entire block */
 101      int           nextIndex;          /* next index to check */
 102      n8_atomic_t   curAllocated;       /* current total blocks allocated */
 103      int           maxAllocated;       /* max allocated since creation */
 104      int           failedAllocs;       /* failed alloc since creation */
 105      int           maxEntries;         /* number of blocks created */
 106      unsigned long granularity;        /* size of each block in bytes */
 107      unsigned int  bankIndex;          /* The index of this bank */
 108      n8_Lock_t     allocationMapLock;  /* lock for this structure */
 109      MemCtlList_t  memCtlList[0];       /* allocation map */
 110 } MemBankCtl_t;
 111
 112 typedef struct
 113 {
 114      int     sessionID;          /* Process ID of the allocater */
 115      int     curAllocated;       /* current number of blocks allocated */
 116      int     maxAllocated;       /* max allocated since creation */
 117      int     failedAllocs;       /* failed alloc since creation */
 118      int     maxEntries;         /* number of blocks in this pool */
 119
 120 } MemStats_t;
 121
 122 unsigned long n8_pmalloc(int           bank,
 123                          int           bytesReq,
 124                          unsigned long sessionID);
 125 void  n8_pfree(int  bank, void *ptr);
 126
 127 #endif /* N8_MANAGE_MEMORY_H */
 128