pasdk/common/paf_heapMgr.h

   1
   2 /*
   3 Copyright (c) 2016, 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 )
  43 #define PAF_NUM_SHMEM_HEAPS             ( 3 )
  44 #define PAF_NUM_HEAPS                   ( PAF_NUM_PRVMEM_HEAPS + PAF_NUM_SHMEM_HEAPS )
  45 #define PAF_HEAP_ID_INT                 ( 0 )   // L2 SRAM
  46 #define PAF_HEAP_ID_INT1                ( 1 )   // MSMC SRAM
  47 #define PAF_HEAP_ID_EXT                 ( 2 )   // DDR3
  48 #define PAF_HEAP_ID_INT1_SHM            ( 3 )   // MSMC SRAM, Shared
  49 #define PAF_HEAP_ID_EXT_SHM             ( 4 )   // DDR3, Shared
  50 #define PAF_HEAP_ID_EXT_NON_CACHED_SHM  ( 5 )   // DDR3 non-cached, Shared
  51
  52 extern Int gPafHeapIdInt;
  53 extern Int gPafHeapIdInt1;
  54 extern Int gPafHeapIdExt;
  55 extern Int gPafHeapIdInt1Shm;
  56 extern Int gPafHeapIdExtShm;
  57 extern Int gPafHeapIdExtNonCachedShm;
  58
  59 /* Initialize PAF heap manager */
  60 Void pafHeapMgr_init(
  61     IHeap_Handle hIntHeap,
  62     IHeap_Handle hIntHeap1,
  63     IHeap_Handle hExtHeap,
  64     IHeap_Handle hIntHeap1Shm,
  65     IHeap_Handle hExtHeapShm,
  66     IHeap_Handle hExtHeapNonCachedShm
  67 );
  68
  69 /* Write heap handle to PAF heap manager for provided index */
  70 Void pafHeapMgr_writeHeapHandle(
  71     Int heapId,
  72     IHeap_Handle hHeap
  73 );
  74
  75 /* Read heap handle from PAF heap manager for provided index */
  76 IHeap_Handle pafHeapMgr_readHeapHandle(
  77     Int heapId
  78 );
  79
  80 #endif /* _PSDKAF_HEAPMGR_H_ */