Added support for Shared Clients which piggyback onto a Shared Server instance in...
[keystone-rtos/rm-lld.git] / 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 */
40 #ifndef RM_INTERNAL_H_
41 #define RM_INTERNAL_H_
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
47 /* RM external includes */
48 #include <ti/drv/rm/rm.h>
50 /* RM OSAL layer */
51 #include <rm_osal.h>
53 /* RM true/false definitions */
54 #define RM_FALSE 0
55 #define RM_TRUE  1
57 /* Shared server enter critical section macro */
58 #define RM_SS_INST_INV_ENTER_CS(csKey)                          \
59     if (rmInst->instType == Rm_instType_SHARED_SERVER) {        \
60         csKey = Rm_osalCsEnter();                               \
61         Rm_osalBeginMemAccess((void *)rmInst, sizeof(Rm_Inst)); \
62     }
64 /* Shared client enter critical section macro */
65 #define RM_SC_INST_INV_ENTER_CS(csKey)                                           \
66     if (rmInst->instType == Rm_instType_SHARED_CLIENT) {                         \
67         csKey = Rm_osalCsEnter();                                                \
68         Rm_osalBeginMemAccess((void *)rmInst->u.sharedClient.sharedServerHandle, \
69                               sizeof(Rm_Inst));                                  \
70     }
72 /* Shared server exit critical section macro */
73 #define RM_SS_INST_WB_EXIT_CS(csKey)                          \
74     if (rmInst->instType == Rm_instType_SHARED_SERVER) {      \
75         Rm_osalEndMemAccess((void *)rmInst, sizeof(Rm_Inst)); \
76         Rm_osalCsExit(csKey);                                 \
77     }  
79 /* Shared server invalidate macro */
80 #define RM_SS_OBJ_INV(obj, objType)                          \
81     if (rmInst->instType == Rm_instType_SHARED_SERVER) {     \
82         Rm_osalBeginMemAccess((void *)obj, sizeof(objType)); \
83     }
85 /* Shared server writeback macro */
86 #define RM_SS_OBJ_WB(obj, objType)                         \
87     if (rmInst->instType == Rm_instType_SHARED_SERVER) {   \
88         Rm_osalEndMemAccess((void *)obj, sizeof(objType)); \
89     }    
91 /* RM resource information */
92 typedef struct {
93     /* Resource name */
94     char     name[RM_NAME_MAX_CHARS];
95     /* Resource base value */
96     int32_t  base;
97     /* Resource length value */
98     uint32_t length;
99     /* Resource alignment */
100     int32_t  alignment;
101     /* NameServer name tied to resource */
102     char     nameServerName[RM_NAME_MAX_CHARS];
103 } Rm_ResourceInfo;
105 #ifdef __cplusplus
107 #endif
109 #endif /* RM_INTERNAL_H_ */