release/src-rt-6.x.4708/cfe/cfe/include/cfe_mem.h

   1 /*  *********************************************************************
   2     *  Broadcom Common Firmware Environment (CFE)
   3     *
   4     *  Memory manager definitions               File: cfe_mem.h
   5     *
   6     *  Function prototypes and contants for the memory manager
   7     *  (used to manage the physical memory arena)
   8     *
   9     *  Author:  Mitch Lichtenberg (mpl@broadcom.com)
  10     *
  11     *********************************************************************
  12     *
  13     *  Copyright 2000,2001,2002,2003
  14     *  Broadcom Corporation. All rights reserved.
  15     *
  16     *  This software is furnished under license and may be used and
  17     *  copied only in accordance with the following terms and
  18     *  conditions.  Subject to these conditions, you may download,
  19     *  copy, install, use, modify and distribute modified or unmodified
  20     *  copies of this software in source and/or binary form.  No title
  21     *  or ownership is transferred hereby.
  22     *
  23     *  1) Any source code used, modified or distributed must reproduce
  24     *     and retain this copyright notice and list of conditions
  25     *     as they appear in the source file.
  26     *
  27     *  2) No right is granted to use any trade name, trademark, or
  28     *     logo of Broadcom Corporation.  The "Broadcom Corporation"
  29     *     name may not be used to endorse or promote products derived
  30     *     from this software without the prior written permission of
  31     *     Broadcom Corporation.
  32     *
  33     *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
  34     *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
  35     *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  36     *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
  37     *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
  38     *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
  39     *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  40     *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  41     *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  42     *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  43     *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  44     *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
  45     *     THE POSSIBILITY OF SUCH DAMAGE.
  46     ********************************************************************* */
  47
  48
  49 /*  *********************************************************************
  50     *  Constants
  51     ********************************************************************* */
  52
  53 #define MEMTYPE_EMPTY   0
  54 #define MEMTYPE_DRAM_AVAILABLE  1       /* must match value in cfe_iocb.h */
  55 #define MEMTYPE_DRAM_NOTINSTALLED 2
  56 #define MEMTYPE_DRAM_USEDBYFIRMWARE 3
  57 #define MEMTYPE_BOOTROM 4
  58 #define MEMTYPE_IOREGISTERS 5
  59 #define MEMTYPE_RESERVED 6
  60 #define MEMTYPE_L2CACHE 7
  61 #define MEMTYPE_LDT_PCI 8
  62 #define MEMTYPE_DRAM_BOOTPROGRAM 9
  63
  64 /*  *********************************************************************
  65     *  External data
  66     ********************************************************************* */
  67
  68 extern unsigned int mem_bootarea_start;
  69 extern unsigned int mem_bootarea_size;
  70
  71 /*  *********************************************************************
  72     *  Prototypes
  73     ********************************************************************* */
  74
  75 void cfe_arena_init(void);
  76 int cfe_arena_loadcheck(uintptr_t start,unsigned int size);
  77 int cfe_arena_enum(int idx,int *type,uint64_t *start,uint64_t *size,int allrecs);
  78 void cfe_pagetable_init(void);