NOTICE OF RELOCATION
[keystone-rtos/pa-lld.git] / pa_osal.h
1 /**
2  *   @file  pa_osal.h
3  *
4  *   @brief   
5  *      This is the sample OS Adaptation layer which is used by the PA low level
6  *      driver. 
7  *    
8  *   @details The OSAL layer can be ported in either of the following manners to a native OS:
9  *
10  *      <b> Approach 1: </b>
11  *      @n  Use Prebuilt Libraries
12  *           - Ensure that the LLD users provide an implementation of all 
13  *             Osal_XXX API for their native OS.
14  *           - Link the prebuilt libraries with their application.
15  *           - Refer to the "test" directory for an example of this
16  *       @n <b> Pros: </b>
17  *              - Customers can reuse prebuilt TI provided libraries
18  *       @n <b> Cons: </b>
19  *              - Level of indirection in the API to get to the actual OS call
20  *              
21  *      <b> Approach 2: </b>
22  *      @n  Rebuilt Library 
23  *           - Create a copy of this file and modify it to directly 
24  *             inline the native OS calls
25  *           - Rebuild the PA low level driver library; ensure that the Include 
26  *             path points to the directory where the copy of this file 
27  *             has been provided.
28  *           - Please refer to the "test" directory for an example of this 
29  *       @n <b> Pros: </b>
30  *              - Optimizations can be done to remove the level of indirection
31  *       @n <b> Cons: </b>
32  *              - PA LLD Libraries need to be rebuilt by the customer.
33  *
34  *  \par
35  *  NOTE:
36  *      (C) Copyright 2009-2011 Texas Instruments, Inc.
37  * 
38  *  Redistribution and use in source and binary forms, with or without 
39  *  modification, are permitted provided that the following conditions 
40  *  are met:
41  *
42  *    Redistributions of source code must retain the above copyright 
43  *    notice, this list of conditions and the following disclaimer.
44  *
45  *    Redistributions in binary form must reproduce the above copyright
46  *    notice, this list of conditions and the following disclaimer in the 
47  *    documentation and/or other materials provided with the   
48  *    distribution.
49  *
50  *    Neither the name of Texas Instruments Incorporated nor the names of
51  *    its contributors may be used to endorse or promote products derived
52  *    from this software without specific prior written permission.
53  *
54  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
55  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
56  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
57  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
58  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
59  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
60  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
63  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
64  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65  *
66 */
67 #ifndef _PA_OSAL_H
68 #define _PA_OSAL_H
70 /** @addtogroup PA_LLD_OSAL
71  @{ */
72  
73 /**********************************************************************
74  ************************* Extern Declarations ************************
75  **********************************************************************/
76 extern void Osal_paBeginMemAccess (void* addr, uint32_t size);
77 extern void Osal_paEndMemAccess   (void* addr, uint32_t size);
78 extern void Osal_paMtCsEnter (uint32_t *key);
79 extern void Osal_paMtCsExit (uint32_t key);
81 /**
82  * @brief  This macro is used to alert the application that the PA is
83  *         going to access a block of memory. The application must ensure
84  *         cache coherency for multi-core applications
85  *
86  * <b> Prototype: </b>
87  *  The following is the C prototype for the expected OSAL API.
88  *
89  *  @verbatim
90         void Osal_paBeginMemAccess (void* addr, uint32_t sizeWords)
91     @endverbatim
92  *
93  *  <b> Parameters </b>
94  *  @n  The address of the table to be accessed
95  *  @n  The number of bytes in the table
96  *
97  *  @note PA will make nested calls to this function for memory access
98  *        protection of different memory tables. 
99  */
101 #define Pa_osalBeginMemAccess   Osal_paBeginMemAccess
103 /**
104  * @brief  This macro is used to alert the application that the PA
105  *         has completed access to a block of memory. If the memory block is 
106  *         cached then the application would need to ensure that the contents 
107  *         of the cache are updated immediately to the actual memory.
108  *
109  * <b> Prototype: </b>
110  *  The following is the C prototype for the expected OSAL API.
111  *
112  *  @verbatim
113         void Osal_paEndMemAccess (void* addr, uint32_t sizeWords)
114     @endverbatim
115  *
116  *  <b> Parameters </b>
117  *  @n The address of the table to be accessed
118  *  @n The number of bytes in the table
119  *
120  *  @note PA will make nested calls to this function for memory access
121  *        protection of different memory tables. 
122  */
123  
124 #define Pa_osalEndMemAccess   Osal_paEndMemAccess
126 /**
127  * @brief   The macro is used by the PA LLD to provide critical section to 
128  *          protect its global and shared resources access from multiple cores. 
129  *          If the PALLD operates in single-core environment then these macros can 
130  *          be defined to be NOP. 
131  *
132  * <b> Prototype: </b>
133  *  The following is the C prototype for the expected OSAL API.
134  *
135  *  @verbatim
136        void Osal_paMtCsEnter (uint32_t *key)
137     @endverbatim
138  *      
139  *  <b> Parameter </b>
140  *  @n  Key may be used to lock the multi-core critical section.
141  *
142  *  <b> Return Value </b>
143  *  @n  Not applicable.
144  *
145  *  @note The multiple-core protection area is usually pretty small. To avoid the scenario that the
146  *        interrupt occurs after the multi-core lock is achieved, the interrupt may be disabled in 
147  *        this function and re-enabled at the function Osal_saMtCsExit.
148  */
149 #define Pa_osalMtCsEnter          Osal_paMtCsEnter
151 /**
152  * @brief   The macro is used by the PA LLD to exit a critical section 
153  *      protected using the Osal_paMtCsEnter() API.
154  *
155  * <b> Prototype: </b>
156  *  The following is the C prototype for the expected OSAL API.
157  *
158  *  @verbatim
159        void Osal_paMtCsExit (uint32_t key)
160     @endverbatim
161  *      
162  *  <b> Parameter </b>
163  *  @n  Key may be used to lock the multi-core critical section.
164  *
165  *  <b> Return Value </b>
166  *  @n  Not applicable.
167  */
168 #define Pa_osalMtCsExit           Osal_paMtCsExit
170 /**
171 @}
172 */
173 #endif /* _PA_OSAL_H */