Tested ability to read in and parse resource and policy DTB files
[keystone-rtos/rm-lld.git] / rm_osal.h
1 /**
2  *   @file  rm_osal.h
3  *
4  *   @brief   
5  *      This is the sample OS Adaptation layer which is used by the RM low level
6  *      driver. The OSAL layer can be ported in either of the following 
7  *      manners to a native OS:
8  *
9  *      <b> Approach 1: </b>
10  *      @n  Use Prebuilt Libraries
11  *           - Ensure that the provide an implementation of all 
12  *             Osal_XXX API for their native OS.
13  *           - Link the prebuilt libraries with their application.
14  *           - Refer to the "example" directory for an example of this
15  *       @n <b> Pros: </b>
16  *           - Customers can reuse prebuilt TI provided libraries
17  *       @n <b> Cons: </b>
18  *           - Level of indirection in the API to get to the actual OS call
19  *              
20  *      <b> Approach 2: </b>
21  *      @n  Rebuilt Library 
22  *           - Create a copy of this file and modify it to directly 
23  *             inline the native OS calls
24  *           - Rebuild the RM low level drivver library; ensure that the Include 
25  *             path points to the directory where the copy of this file 
26  *             has been provided.
27  *           - Please refer to the "test" directory for an example of this 
28  *       @n <b> Pros: </b>
29  *           - Optimizations can be done to remove the level of indirection
30  *       @n <b> Cons: </b>
31  *           - RM LLD Libraries need to be rebuilt by the customer.
32  *
33  *  \par
34  *  NOTE:
35  *      (C) Copyright 2012 Texas Instruments, Inc.
36  * 
37  *  Redistribution and use in source and binary forms, with or without 
38  *  modification, are permitted provided that the following conditions 
39  *  are met:
40  *
41  *    Redistributions of source code must retain the above copyright 
42  *    notice, this list of conditions and the following disclaimer.
43  *
44  *    Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in the 
46  *    documentation and/or other materials provided with the   
47  *    distribution.
48  *
49  *    Neither the name of Texas Instruments Incorporated nor the names of
50  *    its contributors may be used to endorse or promote products derived
51  *    from this software without specific prior written permission.
52  *
53  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
54  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
55  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
56  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
57  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
58  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
59  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
60  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
61  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
62  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
63  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64  *
65  *  \par
66 */
67 #ifndef __RM_OSAL_H__
68 #define __RM_OSAL_H__
70 /** @addtogroup RM_LLD_OSAL
71  @{ */
73 /**********************************************************************
74  ************************* Extern Declarations ************************
75  **********************************************************************/
77 /* #include <string.h> is here because there used to be 
78  * memcpy/memset prototypes here.  This #include prevents warnings in 
79  * other code that unintentionally worked because of these prototypes
80  */
81 #include <string.h>
82 #include <xdc/runtime/System.h>
85 extern void* Osal_rmMalloc (uint32_t num_bytes);
86 extern void Osal_rmFree (void *ptr, uint32_t size, bool shared);
87 extern void* Osal_rmCsEnter (void);
88 extern void Osal_rmCsExit (void *CsHandle);
89 extern void* Osal_rmMtCsEnter (void);
90 extern void Osal_rmMtCsExit (void *CsHandle);
91 //extern void Osal_rmLog (char *fmt, ... );
92 extern void Osal_rmBeginMemAccess (void *ptr, uint32_t size);
93 extern void Osal_rmEndMemAccess (void *ptr, uint32_t size);
95 /**
96  * @brief   The macro is used by the RM LLD to allocate memory of specified
97  * size
98  *
99  * <b> Prototype: </b>
100  *  The following is the C prototype for the expected OSAL API.
101  *
102  *  @verbatim
103        void* Osal_rmMalloc (uint32_t numBytes)
104     @endverbatim
105  *      
106  *  <b> Parameter </b>
107  *  @n  Number of bytes to be allocated
108  *
109  *  <b> Parameter </b>
110  *  @n  If true the memory should could from shared memory
111  *
112  *  <b> Return Value </b>
113  *  @n  Pointer to the allocated block size
114  */
116 #define Rm_osalMalloc             Osal_rmMalloc
118 /**
119  * @brief   The macro is used by the RM LLD to free a allocated block of 
120  * memory 
121  *
122  * <b> Prototype: </b>
123  *  The following is the C prototype for the expected OSAL API.
124  *
125  *  @verbatim
126        void Osal_rmFree (void *ptr, uint32_t size)
127     @endverbatim
128  *      
129  *  <b> Parameter </b>
130  *  @n  Pointer to the block of memory to be cleaned up.
131  *  @n  Size of the allocated memory which is being freed.
132  *
133  *  <b> Return Value </b>
134  *  @n  Not applicable.
135  */
137 #define Rm_osalFree               Osal_rmFree
139 /**
140  * @brief   The macro is used by the RM LLD to provide critical sections to 
141  * protect global and shared variables from
142  *
143  *      access from multiple cores 
144  *      and 
145  *      access from multiple threads on single core
146  *
147  * <b> Prototype: </b>
148  *  The following is the C prototype for the expected OSAL API.
149  *
150  *  @verbatim
151        void* Osal_rmCsEnter (void)
152     @endverbatim
153  *      
154  *  <b> Parameter </b>
155  *  @n  None.
156  *
157  *  <b> Return Value </b>
158  *  @n  Handle used to lock critical section.
159  */
160 #define Rm_osalCsEnter            Osal_rmCsEnter
162 /**
163  * @brief   The macro is used by the RM LLD to exit a critical section 
164  *      protected using Osal_rmCsEnter() API.
165  *
166  * <b> Prototype: </b>
167  *  The following is the C prototype for the expected OSAL API.
168  *
169  *  @verbatim
170        void Osal_rmCsExit (void *CsHandle)
171     @endverbatim
172  *      
173  *  <b> Parameter </b>
174  *  @n  Handle for unlocking critical section.
175  *
176  *  <b> Return Value </b>
177  *  @n  Not applicable.
178  */
179 #define Rm_osalCsExit             Osal_rmCsExit
181 /**
182  * @brief   The macro is used by the RM LLD to provide critical sections to 
183  * protect global and shared variables from
184  *
185  *      access from multiple threads on single core
186  *
187  * <b> Prototype: </b>
188  *  The following is the C prototype for the expected OSAL API.
189  *
190  *  @verbatim
191        void* Osal_rmMtCsEnter (void)
192     @endverbatim
193  *      
194  *  <b> Parameter </b>
195  *  @n  None.
196  *
197  *  <b> Return Value </b>
198  *  @n  Handle used to lock critical section.
199  */
200 #define Rm_osalMtCsEnter          Osal_rmMtCsEnter
202 /**
203  * @brief   The macro is used by the RM LLD to exit a critical section 
204  *      protected using Osal_rmMtCsEnter() API.
205  *
206  * <b> Prototype: </b>
207  *  The following is the C prototype for the expected OSAL API.
208  *
209  *  @verbatim
210        void Osal_rmMtCsExit (void *CsHandle)
211     @endverbatim
212  *      
213  *  <b> Parameter </b>
214  *  @n  Handle for unlocking critical section.
215  *
216  *  <b> Return Value </b>
217  *  @n  Not applicable.
218  */
219 #define Rm_osalMtCsExit           Osal_rmMtCsExit
221 /**
222  * @brief   The macro is used by the RM LLD to log various 
223  * messages. 
224  *
225  * <b> Prototype: </b>
226  *  The following is the C prototype for the expected OSAL API.
227  *
228  *  @verbatim
229        void Osal_rmLog( char *fmt, ... ) 
230     @endverbatim
231  *
232  *  <b> Parameter </b>
233  *  @n  printf-style format string 
234  *
235  *  <b> Return Value </b>
236  *  @n  Not applicable.
237  */
238 #define Rm_osalLog                System_printf
240 /**
241  * @brief   The macro is used by the RM LLD to indicate that a block
242  * of memory is about to be accessed. If the memory block is cached then
243  * this indicates that the application would need to ensure that the cache
244  * is updated with the data from the actual memory.
245  *
246  * <b> Prototype: </b>
247  *  The following is the C prototype for the expected OSAL API.
248  *
249  *  @verbatim
250        void Osal_rmBeginMemAccess (void *ptr, uint32_t size) 
251     @endverbatim
252  *
253  *  <b> Parameter </b>
254  *  @n  Address of memory block.
255  *  @n  Size of memory block.
256  *
257  *  <b> Return Value </b>
258  *  @n  Not applicable.
259  */
260 #define Rm_osalBeginMemAccess     Osal_rmBeginMemAccess
262 /**
263  * @brief   The macro is used by the RM LLD to indicate that the block of 
264  * memory has finished being accessed. If the memory block is cached then the 
265  * application would need to ensure that the contents of the cache are updated
266  * immediately to the actual memory.
267  *
268  * <b> Prototype: </b>
269  *  The following is the C prototype for the expected OSAL API.
270  *
271  *  @verbatim
272        void Osal_rmEndMemAccess (void *ptr, uint32_t size) 
273     @endverbatim
274  *
275  *  <b> Parameter </b>
276  *  @n  Address of memory block.
277  *  @n  Size of memory block.
278  *
279  *  <b> Return Value </b>
280  *  @n  Not applicable.
281  */
282 #define Rm_osalEndMemAccess       Osal_rmEndMemAccess
284 /**
285 @}
286 */
287 #endif /* __RM_OSAL_H__ */