include/rm_internal.h

   1 /*
   2  *  file  rm_internal.h
   3  *
   4  *  Data structures used by more than one internal RM module.
   5  *
   6  *  ============================================================================
   7  *      (C) Copyright 2012-2013, Texas Instruments, Inc.
   8  *
   9  *  Redistribution and use in source and binary forms, with or without
  10  *  modification, are permitted provided that the following conditions
  11  *  are met:
  12  *
  13  *    Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  *    Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  *    Neither the name of Texas Instruments Incorporated nor the names of
  22  *    its contributors may be used to endorse or promote products derived
  23  *    from this software without specific prior written permission.
  24  *
  25  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  *  \par
  38 */
  39
  40 #ifndef RM_INTERNAL_H_
  41 #define RM_INTERNAL_H_
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /* RM external includes */
  48 #include <ti/drv/rm/rm.h>
  49
  50 /* RM OSAL layer */
  51 #include <rm_osal.h>
  52
  53 /* RM true/false definitions */
  54 #define RM_FALSE 0
  55 #define RM_TRUE  1
  56
  57 /* Shared server enter critical section macro */
  58 #define RM_SS_INST_INV_ENTER_CS(csKey)                      \
  59     Rm_osalBeginMemAccess((void *)rmInst, sizeof(Rm_Inst)); \
  60     if (rmInst->instType == Rm_instType_SHARED_SERVER) {    \
  61         csKey = Rm_osalCsEnter();                           \
  62     }
  63
  64 /* Shared server exit critical section macro */
  65 #define RM_SS_INST_WB_EXIT_CS(csKey)                          \
  66     if (rmInst->instType == Rm_instType_SHARED_SERVER) {      \
  67         Rm_osalEndMemAccess((void *)rmInst, sizeof(Rm_Inst)); \
  68         Rm_osalCsExit(csKey);                                 \
  69     }
  70
  71 /* Shared server invalidate macro */
  72 #define RM_SS_OBJ_INV(obj, objType)                          \
  73     if (rmInst->instType == Rm_instType_SHARED_SERVER) {     \
  74         Rm_osalBeginMemAccess((void *)obj, sizeof(objType)); \
  75     }
  76
  77 /* Shared server writeback macro */
  78 #define RM_SS_OBJ_WB(obj, objType)                         \
  79     if (rmInst->instType == Rm_instType_SHARED_SERVER) {   \
  80         Rm_osalEndMemAccess((void *)obj, sizeof(objType)); \
  81     }
  82
  83 /* RM resource information */
  84 typedef struct {
  85     /* Resource name */
  86     char     name[RM_NAME_MAX_CHARS];
  87     /* Resource base value */
  88     int32_t  base;
  89     /* Resource length value */
  90     uint32_t length;
  91     /* Resource alignment */
  92     int32_t  alignment;
  93     /* NameServer name tied to resource */
  94     char     nameServerName[RM_NAME_MAX_CHARS];
  95 } Rm_ResourceInfo;
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #endif /* RM_INTERNAL_H_ */
 102