Updates to enable Yocto parallel build
[keystone-rtos/fault_mgmt.git] / fault_mgmt_osal.h
1 /**
2  *   @file  fault_mgmt_osal.h
3  *
4  *   @brief   
5  *      This is the sample OS Adaptation layer which is used by the fault management 
6  *      communicator module. 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 Message communicator; 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  *           - Message communicator Libraries need to be rebuilt by the customer.
32  *
33  *  \par
34  *  NOTE:
35  *      (C) Copyright 2012-2014 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  */
66  
67  
68 #ifndef __FAULT_MGMT_OSAL_H__
69 #define __FAULT_MGMT_OSAL_H__
71 extern void  Osal_fault_mgmtEndMemAccess(void* ptr, uint32_t size);
72 extern void  Osal_fault_mgmtLog (char *fmt, ... );
74 /** @addtogroup FAULT_MGMT_OSAL_API
75  @{ */
77 /**
78  * @brief   The macro is used by the Fault Management module to indicate that 
79  * the shared memory access is complete. If the memory block is cached then the 
80  * implementation should writeback the cache contents to ensure that 
81  * the cache and the memory are in sync with each other.
82  *
83  * <b> Prototype: </b>
84  *  The following is the C prototype for the expected OSAL API.
85  *
86  *  @verbatim
87        void  Osal_fault_mgmtEndMemAccess(void* ptr, uint32_t size)
88     @endverbatim
89  *
90  *  <b> Parameter </b>
91  *  @n  ptr  - Pointer to the memory 
92  *  @n  size - Size of the memory
93  *
94  *  <b> Return Value </b>
95  *  @n  None
96  */
97 #define Fault_Mgmt_osalEndMemAccess       Osal_fault_mgmtEndMemAccess
99 /**
100  * @brief   The macro is used by FM to log various 
101  *          messages. 
102  *
103  * <b> Prototype: </b>
104  *  The following is the C prototype for the expected OSAL API.
105  *
106  *  @verbatim
107        void Osal_fault_mgmtLog( char *fmt, ... ) 
108     @endverbatim
109  *
110  *  <b> Parameter </b>
111  *  @n  printf-style format string 
112  *
113  *  <b> Return Value </b>
114  *  @n  Not applicable.
115  */
116 #define Fault_Mgmt_osalLog                Osal_fault_mgmtLog
118 /**
119 @}
120 */
122 #endif /* __FAULT_MGMT_OSAL_H__ */