6bf8bde7b863857313fecb1e24df7b776daf92df
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-2013 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_OSAL_API
71 @{
72 */
74 /**********************************************************************
75 ************************* Extern Declarations ************************
76 **********************************************************************/
78 extern void* Osal_rmMalloc (uint32_t num_bytes);
79 extern void Osal_rmFree (void *ptr, uint32_t size);
80 extern void Osal_rmLog (char *fmt, ... );
82 /**
83 * @brief The macro is used by the RM LLD to allocate memory of specified
84 * size
85 *
86 * <b> Prototype: </b>
87 * The following is the C prototype for the expected OSAL API.
88 *
89 * @verbatim
90 void* Osal_rmMalloc (uint32_t numBytes)
91 @endverbatim
92 *
93 * <b> Parameter </b>
94 * @n Number of bytes to be allocated
95 *
96 * <b> Parameter </b>
97 * @n If true the memory should could from shared memory
98 *
99 * <b> Return Value </b>
100 * @n Pointer to the allocated block size
101 */
103 #define Rm_osalMalloc Osal_rmMalloc
105 /**
106 * @brief The macro is used by the RM LLD to free a allocated block of
107 * memory
108 *
109 * <b> Prototype: </b>
110 * The following is the C prototype for the expected OSAL API.
111 *
112 * @verbatim
113 void Osal_rmFree (void *ptr, uint32_t size)
114 @endverbatim
115 *
116 * <b> Parameter </b>
117 * @n Pointer to the block of memory to be cleaned up.
118 * @n Size of the allocated memory which is being freed.
119 *
120 * <b> Return Value </b>
121 * @n Not applicable.
122 */
124 #define Rm_osalFree Osal_rmFree
126 /**
127 * @brief The macro is used by the RM LLD to log various
128 * messages.
129 *
130 * <b> Prototype: </b>
131 * The following is the C prototype for the expected OSAL API.
132 *
133 * @verbatim
134 void Osal_rmLog( char *fmt, ... )
135 @endverbatim
136 *
137 * <b> Parameter </b>
138 * @n printf-style format string
139 *
140 * <b> Return Value </b>
141 * @n Not applicable.
142 */
143 #define Rm_osalLog Osal_rmLog
145 /**
146 @}
147 */
148 #endif /* __RM_OSAL_H__ */