92ddc1b7e78318a6d0cfa58cb22daae8846bd646
[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>
83 extern void* Osal_rmMalloc (uint32_t num_bytes, bool shared);
84 extern void Osal_rmFree (void *ptr, uint32_t size, bool shared);
85 extern void* Osal_rmCsEnter (void);
86 extern void Osal_rmCsExit (void *CsHandle);
87 extern void* Osal_rmMtCsEnter (void);
88 extern void Osal_rmMtCsExit (void *CsHandle);
89 extern void Osal_rmLog (char *fmt, ... );
90 extern void Osal_rmBeginMemAccess (void *ptr, uint32_t size);
91 extern void Osal_rmEndMemAccess (void *ptr, uint32_t size);
93 /**
94  * @brief   The macro is used by the RM LLD to allocate memory of specified
95  * size
96  *
97  * <b> Prototype: </b>
98  *  The following is the C prototype for the expected OSAL API.
99  *
100  *  @verbatim
101        void* Osal_rmMalloc (uint32_t numBytes)
102     @endverbatim
103  *      
104  *  <b> Parameter </b>
105  *  @n  Number of bytes to be allocated
106  *
107  *  <b> Parameter </b>
108  *  @n  If true the memory should could from shared memory
109  *
110  *  <b> Return Value </b>
111  *  @n  Pointer to the allocated block size
112  */
114 #define Rm_osalMalloc             Osal_rmMalloc
116 /**
117  * @brief   The macro is used by the RM LLD to free a allocated block of 
118  * memory 
119  *
120  * <b> Prototype: </b>
121  *  The following is the C prototype for the expected OSAL API.
122  *
123  *  @verbatim
124        void Osal_rmFree (void *ptr, uint32_t size)
125     @endverbatim
126  *      
127  *  <b> Parameter </b>
128  *  @n  Pointer to the block of memory to be cleaned up.
129  *  @n  Size of the allocated memory which is being freed.
130  *
131  *  <b> Return Value </b>
132  *  @n  Not applicable.
133  */
135 #define Rm_osalFree               Osal_rmFree
137 /**
138  * @brief   The macro is used by the RM LLD to provide critical sections to 
139  * protect global and shared variables from
140  *
141  *      access from multiple cores 
142  *      and 
143  *      access from multiple threads on single core
144  *
145  * <b> Prototype: </b>
146  *  The following is the C prototype for the expected OSAL API.
147  *
148  *  @verbatim
149        void* Osal_rmCsEnter (void)
150     @endverbatim
151  *      
152  *  <b> Parameter </b>
153  *  @n  None.
154  *
155  *  <b> Return Value </b>
156  *  @n  Handle used to lock critical section.
157  */
158 #define Rm_osalCsEnter            Osal_rmCsEnter
160 /**
161  * @brief   The macro is used by the RM LLD to exit a critical section 
162  *      protected using Osal_rmCsEnter() API.
163  *
164  * <b> Prototype: </b>
165  *  The following is the C prototype for the expected OSAL API.
166  *
167  *  @verbatim
168        void Osal_rmCsExit (void *CsHandle)
169     @endverbatim
170  *      
171  *  <b> Parameter </b>
172  *  @n  Handle for unlocking critical section.
173  *
174  *  <b> Return Value </b>
175  *  @n  Not applicable.
176  */
177 #define Rm_osalCsExit             Osal_rmCsExit
179 /**
180  * @brief   The macro is used by the RM LLD to provide critical sections to 
181  * protect global and shared variables from
182  *
183  *      access from multiple threads on single core
184  *
185  * <b> Prototype: </b>
186  *  The following is the C prototype for the expected OSAL API.
187  *
188  *  @verbatim
189        void* Osal_rmMtCsEnter (void)
190     @endverbatim
191  *      
192  *  <b> Parameter </b>
193  *  @n  None.
194  *
195  *  <b> Return Value </b>
196  *  @n  Handle used to lock critical section.
197  */
198 #define Rm_osalMtCsEnter          Osal_rmMtCsEnter
200 /**
201  * @brief   The macro is used by the RM LLD to exit a critical section 
202  *      protected using Osal_rmMtCsEnter() API.
203  *
204  * <b> Prototype: </b>
205  *  The following is the C prototype for the expected OSAL API.
206  *
207  *  @verbatim
208        void Osal_rmMtCsExit (void *CsHandle)
209     @endverbatim
210  *      
211  *  <b> Parameter </b>
212  *  @n  Handle for unlocking critical section.
213  *
214  *  <b> Return Value </b>
215  *  @n  Not applicable.
216  */
217 #define Rm_osalMtCsExit           Osal_rmMtCsExit
219 /**
220  * @brief   The macro is used by the RM LLD to log various 
221  * messages. 
222  *
223  * <b> Prototype: </b>
224  *  The following is the C prototype for the expected OSAL API.
225  *
226  *  @verbatim
227        void Osal_rmLog( char *fmt, ... ) 
228     @endverbatim
229  *
230  *  <b> Parameter </b>
231  *  @n  printf-style format string 
232  *
233  *  <b> Return Value </b>
234  *  @n  Not applicable.
235  */
236 #define Rm_osalLog                Osal_rmLog
238 /**
239  * @brief   The macro is used by the RM LLD to indicate that a block
240  * of memory is about to be accessed. If the memory block is cached then
241  * this indicates that the application would need to ensure that the cache
242  * is updated with the data from the actual memory.
243  *
244  * <b> Prototype: </b>
245  *  The following is the C prototype for the expected OSAL API.
246  *
247  *  @verbatim
248        void Osal_rmBeginMemAccess (void *ptr, uint32_t size) 
249     @endverbatim
250  *
251  *  <b> Parameter </b>
252  *  @n  Address of memory block.
253  *  @n  Size of memory block.
254  *
255  *  <b> Return Value </b>
256  *  @n  Not applicable.
257  */
258 #define Rm_osalBeginMemAccess     Osal_rmBeginMemAccess
260 /**
261  * @brief   The macro is used by the RM LLD to indicate that the block of 
262  * memory has finished being accessed. If the memory block is cached then the 
263  * application would need to ensure that the contents of the cache are updated
264  * immediately to the actual memory.
265  *
266  * <b> Prototype: </b>
267  *  The following is the C prototype for the expected OSAL API.
268  *
269  *  @verbatim
270        void Osal_rmEndMemAccess (void *ptr, uint32_t size) 
271     @endverbatim
272  *
273  *  <b> Parameter </b>
274  *  @n  Address of memory block.
275  *  @n  Size of memory block.
276  *
277  *  <b> Return Value </b>
278  *  @n  Not applicable.
279  */
280 #define Rm_osalEndMemAccess       Osal_rmEndMemAccess
282 /**
283 @}
284 */
285 #endif /* __RM_OSAL_H__ */