pasdk/common/paf_heapMgr.h

   1
   2 /*
   3 Copyright (c) 2017, Texas Instruments Incorporated - http://www.ti.com/
   4 All rights reserved.
   5
   6 * Redistribution and use in source and binary forms, with or without
   7 * modification, are permitted provided that the following conditions
   8 * are met:
   9 *
  10 * Redistributions of source code must retain the above copyright
  11 * notice, this list of conditions and the following disclaimer.
  12 *
  13 * Redistributions in binary form must reproduce the above copyright
  14 * notice, this list of conditions and the following disclaimer in the
  15 * documentation and/or other materials provided with the
  16 * distribution.
  17 *
  18 * Neither the name of Texas Instruments Incorporated nor the names of
  19 * its contributors may be used to endorse or promote products derived
  20 * from this software without specific prior written permission.
  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 #ifndef _PSDKAF_HEAPMGR_H_
  37 #define _PSDKAF_HEAPMGR_H_
  38
  39 #include <xdc/std.h>
  40 #include <xdc/runtime/IHeap.h>
  41
  42 #define PAF_NUM_PRVMEM_HEAPS                ( 3 )   // number of private (local) heaps
  43 #define PAF_NUM_SHMEM_HEAPS                 ( 3 )   // number of shared heaps
  44 #define PAF_NUM_HEAPS                       ( PAF_NUM_PRVMEM_HEAPS + PAF_NUM_SHMEM_HEAPS ) // total number of heaps
  45
  46 // heap IDs
  47 #define PAF_HEAP_ID_INT                     ( 0 )   // L2 SRAM
  48 #define PAF_HEAP_ID_INT1                    ( 1 )   // MSMC SRAM
  49 #define PAF_HEAP_ID_EXT                     ( 2 )   // DDR3
  50 #define PAF_HEAP_ID_INT1_SHM                ( 3 )   // MSMC SRAM, Shared
  51 #define PAF_HEAP_ID_EXT_SHM                 ( 4 )   // DDR3, Shared
  52 #define PAF_HEAP_ID_EXT_NON_CACHED_SHM      ( 5 )   // DDR3 non-cached, Shared
  53
  54 // macros for translating heap IDs to handles
  55 #define PAF_HEAP_INT                        (HeapMem_Handle)pafHeapMgr_readHeapHandle(gPafHeapIdInt)
  56 #define PAF_HEAP_INT1                       (HeapMem_Handle)pafHeapMgr_readHeapHandle(gPafHeapIdInt1)
  57 #define PAF_HEAP_EXT                        (HeapMem_Handle)pafHeapMgr_readHeapHandle(gPafHeapIdExt)
  58 #define PAF_HEAP_INT1_SHM                   (HeapMem_Handle)pafHeapMgr_readHeapHandle(gPafHeapIdInt1Shm)
  59 #define PAF_HEAP_EXT_SHM                    (HeapMem_Handle)pafHeapMgr_readHeapHandle(gPafHeapIdExtShm)
  60 #define PAF_HEAP_EXT_NONCACHED_SHM          (HeapMem_Handle)pafHeapMgr_readHeapHandle(gPafHeapIdExtNonCachedShm)
  61
  62 // exported heap IDs
  63 extern Int gPafHeapIdInt;               // L2 SRAM
  64 extern Int gPafHeapIdInt1;              // MSMC SRAM
  65 extern Int gPafHeapIdExt;               // DDR3
  66 extern Int gPafHeapIdInt1Shm;           // MSMC SRAM, Shared
  67 extern Int gPafHeapIdExtShm;            // DDR3, Shared
  68 extern Int gPafHeapIdExtNonCachedShm;   // DDR3 non-cached, Shared
  69
  70 /* Initialize PAF heap manager */
  71 Void pafHeapMgr_init(
  72     IHeap_Handle hIntHeap,
  73     IHeap_Handle hIntHeap1,
  74     IHeap_Handle hExtHeap,
  75     IHeap_Handle hIntHeap1Shm,
  76     IHeap_Handle hExtHeapShm,
  77     IHeap_Handle hExtHeapNonCachedShm
  78 );
  79
  80 /* Write heap handle to PAF heap manager for provided index */
  81 Void pafHeapMgr_writeHeapHandle(
  82     Int heapId,
  83     IHeap_Handle hHeap
  84 );
  85
  86 /* Read heap handle from PAF heap manager for provided index */
  87 IHeap_Handle pafHeapMgr_readHeapHandle(
  88     Int heapId
  89 );
  90
  91 #endif /* _PSDKAF_HEAPMGR_H_ */