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 /* RM cache alignment */
58 #define RM_MAX_CACHE_ALIGN 128
60 /* Shared server enter critical section macro */
61 #define RM_SS_INST_INV_ENTER_CS(csKey) \
62 if (rmInst->instType == Rm_instType_SHARED_SERVER) { \
63 csKey = Rm_osalCsEnter(); \
64 Rm_osalBeginMemAccess((void *)rmInst, sizeof(Rm_Inst)); \
65 }
67 /* Shared client enter critical section macro */
68 #define RM_SC_INST_INV_ENTER_CS(csKey) \
69 if (rmInst->instType == Rm_instType_SHARED_CLIENT) { \
70 csKey = Rm_osalCsEnter(); \
71 Rm_osalBeginMemAccess((void *)rmInst->u.sharedClient.sharedServerHandle, \
72 sizeof(Rm_Inst)); \
73 }
75 /* Shared server exit critical section macro */
76 #define RM_SS_INST_WB_EXIT_CS(csKey) \
77 if (rmInst->instType == Rm_instType_SHARED_SERVER) { \
78 Rm_osalEndMemAccess((void *)rmInst, sizeof(Rm_Inst)); \
79 Rm_osalCsExit(csKey); \
80 }
82 /* Shared server invalidate macro */
83 #define RM_SS_OBJ_INV(obj, objType) \
84 if (rmInst->instType == Rm_instType_SHARED_SERVER) { \
85 Rm_osalBeginMemAccess((void *)obj, sizeof(objType)); \
86 }
88 /* Shared server writeback macro */
89 #define RM_SS_OBJ_WB(obj, objType) \
90 if (rmInst->instType == Rm_instType_SHARED_SERVER) { \
91 Rm_osalEndMemAccess((void *)obj, sizeof(objType)); \
92 }
94 /* RM resource information */
95 typedef struct {
96 /* Resource name */
97 char name[RM_NAME_MAX_CHARS];
98 /* Resource base value */
99 int32_t base;
100 /* Resource length value */
101 uint32_t length;
102 /* Resource alignment */
103 int32_t alignment;
104 /* Resource owner count - number of instances that are in the
105 * resource's owner list */
106 int32_t ownerCount;
107 /* NameServer name tied to resource */
108 char nameServerName[RM_NAME_MAX_CHARS];
109 } Rm_ResourceInfo;
111 #ifdef __cplusplus
112 }
113 #endif
115 #endif /* RM_INTERNAL_H_ */