[processor-sdk/performance-audio-sr.git] / psdk_cust / pdk_k2g_1_0_1_0_eng / packages / ti / csl / csl_ipc.h
1 /* ============================================================================
2 * Copyright (c) Texas Instruments Incorporated 2008, 2009
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
34 /**
35 * @file csl_ipc.h
36 *
37 * @brief
38 * IPC CSL Implementation on DSP side
39 *
40 * \par
41 * ============================================================================
42 * @n (C) Copyright 2008, 2009, Texas Instruments, Inc.
43 * @n Use of this software is controlled by the terms and conditions found
44 * @n in the license agreement under which this software has been supplied.
45 * ===========================================================================
46 * \par
47 */
49 /** @defgroup CSL_IPC_API IPC
50 *
51 * @section Introduction
52 *
53 * @subsection xxx Overview
54 *
55 * Each of the GEM cores can communicate with one another in a variety of ways.
56 * Inter-Processor interrupts (IPC) is one of the ways used for core synchronization,
57 * allowing for direct notification from one GEM core to another.
58 * Three different IPC mechanisms are defined:
59 * a) Inter-DSP Interrupts.
60 * b) Host CPU Interrupts (interrupts to external host).
61 * c) Non Maskable Interrupts (NMI) to GEMs.
62 *
63 * @subsection References
64 * -# Inter-Processor Communications (IPC) Architecture
65 *
66 * @subsection Assumptions
67 * The abbreviations IPC, ipc and Ipc have been used throughout this
68 * document to refer to Inter-Processor Communications (IPC) Architecture
69 */
70 #ifndef CSL_IPC_H_
71 #define CSL_IPC_H_
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
77 #include <ti/csl/soc.h>
78 #include <ti/csl/csl.h>
79 #include <ti/csl/cslr_ipc.h>
81 /**
82 @defgroup CSL_IPC_SYMBOL IPC Symbols Defined
83 @ingroup CSL_IPC_API
84 */
85 /**
86 @defgroup CSL_IPC_DATASTRUCT IPC Data Structures
87 @ingroup CSL_IPC_API
88 */
89 /**
90 @defgroup CSL_IPC_FUNCTION IPC Functions
91 @ingroup CSL_IPC_API
92 */
94 /**
95 @addtogroup CSL_IPC_SYMBOL
96 @{
97 */
99 /**
100 @}
101 */
104 /** @addtogroup CSL_IPC_DATASTRUCT
105 @{ */
107 /**
108 * Handle to access IPC registers accessible through config bus.
109 */
110 #define hIpc ((CSL_IPCRegs *) (CSL_BOOT_CFG_REGS + 0x200))
112 /* @} */
114 /** @addtogroup CSL_IPC_FUNCTION
115 @{ */
117 /* @} */
120 #ifdef __cplusplus
121 }
122 #endif
124 #endif /*CSL_IPC_H_*/