[processor-sdk/performance-audio-sr.git] / psdk_cust / pdk_k2g_1_0_1_0_eng / packages / ti / csl / csl_sem.h
1 /**
2 * @file csl_sem.h
3 *
4 * @brief
5 * This is the main Header File for the SEM Module which defines all
6 * the data structures and exported API.
7 *
8 * \par
9 * ============================================================================
10 * @n (C) Copyright 2008-2011, Texas Instruments, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 *
16 * Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the
22 * distribution.
23 *
24 * Neither the name of Texas Instruments Incorporated nor the names of
25 * its contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 */
41 #ifndef _CSL_SEM_H_
42 #define _CSL_SEM_H_
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
48 #include <ti/csl/soc.h>
49 #include <ti/csl/csl.h>
50 #include <ti/csl/cslr_sem.h>
52 /** @defgroup CSL_SEM_API Semaphore
53 *
54 * @section Introduction
55 *
56 * @subsection
57 * None
58 *
59 * @subsection References
60 * None
61 *
62 */
64 /**
65 @defgroup CSL_SEM_SYMBOL SEM Symbols Defined
66 @ingroup CSL_SEM_API
67 */
68 /**
69 @defgroup CSL_SEM_FUNCTION SEM Functions
70 @ingroup CSL_SEM_API
71 */
72 /**
73 @addtogroup CSL_SEM_SYMBOL
74 @{
75 */
77 /**
78 * Handle to access SEM registers.
79 */
80 #define hSEM ((CSL_SemRegs*)CSL_SEMAPHORE_REGS)
82 /**
83 @}
84 */
86 #ifdef __cplusplus
87 }
88 #endif
90 #endif /* _CSL_SEM_H_ */