PDK API Guide for J721E
ipc_mp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2018
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the
15  * distribution.
16  *
17  * Neither the name of Texas Instruments Incorporated nor the names of
18  * its contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
49 #ifndef IPC_MP_H_
50 #define IPC_MP_H_
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
56 /* ========================================================================== */
57 /* Include Files */
58 /* ========================================================================== */
59 #include <ti/drv/ipc/soc/ipc_soc.h>
61 
62 /* ========================================================================== */
63 /* Macros & Typedefs */
64 /* ========================================================================== */
68 #define IPC_MP_INVALID_ID (0xFFFFFFFFU)
69 
70 /* ========================================================================== */
71 /* Structure Declarations */
72 /* ========================================================================== */
73 
74 /* ========================================================================== */
75 /* Function Declarations */
76 /* ========================================================================== */
77 
92 int32_t Ipc_mpSetConfig(uint32_t selfId, uint16_t numProc, uint32_t procArry[IPC_MAX_PROCS]);
93 
105 uint32_t Ipc_mpGetId(const char* name);
106 
116 const char* Ipc_mpGetName(uint32_t id);
117 
123 uint16_t Ipc_mpGetNumProcessors(void);
124 
125 
132 uint32_t Ipc_mpGetSelfId(void);
133 
138 const char* Ipc_mpGetSelfName(void);
139 
144 uint32_t Ipc_mpGetRemoteProcId(uint32_t coreIndex);
145 
146 /* ========================================================================== */
147 /* Static Function Definitions */
148 /* ========================================================================== */
149 
150 /* None */
151 
152 #ifdef __cplusplus
153 }
154 #endif
155 
156 #endif /* #ifndef IPC_MP_H_ */
157 
158 /* @} */
uint16_t Ipc_mpGetNumProcessors(void)
Gets the number of processors.
uint32_t Ipc_mpGetRemoteProcId(uint32_t coreIndex)
Returns procId of the given index.
uint32_t Ipc_mpGetSelfId(void)
Gets executing processor's MultiProc id.
const char * Ipc_mpGetName(uint32_t id)
Gets the name of a processor.
data types definitions for ipc module.
int32_t Ipc_mpSetConfig(uint32_t selfId, uint16_t numProc, uint32_t procArry[IPC_MAX_PROCS])
Sets the multiproc configuration.
const char * Ipc_mpGetSelfName(void)
Get the processor name for current processor.
uint32_t Ipc_mpGetId(const char *name)
Gets the MultiProc id.