AM261x MCU+ SDK: ipc_notify.h Source File

| AM261x MCU+ SDK 26.00.00 |

ipc_notify.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2018-2023 Texas Instruments Incorporated
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
33 #ifndef IPC_NOTIFY_H_
34 #define IPC_NOTIFY_H_
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <stdint.h>
41 #include <kernel/dpl/SystemP.h>
42 #include <drivers/hw_include/cslr_soc.h>
43
56 #define IPC_NOTIFY_CLIENT_ID_MAX (16U)
57
61 #define IPC_NOTIFY_CLIENT_ID_RPMSG (0U)
62
66 #define IPC_NOTIFY_CLIENT_ID_SYNC (1U)
67
71 #define IPC_NOTIFY_DEFAULT_INTR_PRIORITY (4U)
72
76 #define IPC_NOTIFY_MSG_VALUE_MAX (0x10000000U)
77
81 #define IPC_NOTIFY_CRC_MSG_VALUE_MAX (0x100000U)
82
86 #define IPC_NOTIFY_CRC_MAX (0x100U)
87
91 #define IPC_NOTIFY_CRC_SIZE (1U)
92
96 #define IPC_NOTIFY_CRC_DATASIZE (4U)
97
101 #define IPC_INTR_ROUTER_ENABLE (0x01U)
102
106 #define IPC_INTR_ROUTER_DISABLE (0x00U)
107
124 typedef void (*IpcNotify_FxnCallback)(uint32_t remoteCoreId, uint16_t localClientId, uint32_t msgValue, int32_t crcStatus, void *args);
125
133 typedef void (*IpcNotify_NonNotifyCallback)(uint32_t remoteCoreId);
134
145 typedef int32_t (*IpcNotify_CrcHookFxn)(uint8_t *data, uint16_t dataLen, uint8_t crcSize, void *crc);
146
154 typedef struct IpcNotify_Params_ {
155
156 uint32_t numCores;
159 uint32_t coreIdList[CSL_CORE_ID_MAX];
164 uint32_t selfCoreId;
168 uint32_t linuxCoreId;
169 uint8_t intrPriority;
170 uint8_t isCrcEnabled; /* CRC Enable/Disable flag */
171 IpcNotify_CrcHookFxn crcHookFxn; /* Hook Function to be provided by application for CRC calculation. */
172 uint8_t isMailboxIpcEnabled;
173 uint8_t isIPCIntrRouter;
174 } IpcNotify_Params;
175
181 void IpcNotify_Params_init(IpcNotify_Params *params);
182
191 int32_t IpcNotify_init(const IpcNotify_Params *params);
192
199 void IpcNotify_deInit(void);
200
223 int32_t IpcNotify_sendMsg(uint32_t remoteCoreId, uint16_t remoteClientId, uint32_t msgValue, uint32_t waitForFifoNotFull);
224
235 int32_t IpcNotify_registerClient(uint16_t localClientId, IpcNotify_FxnCallback msgCallback, void *args);
236
237
246 int32_t IpcNotify_unregisterClient(uint16_t localClientId);
247
253 uint32_t IpcNotify_getSelfCoreId(void);
254
262 uint32_t IpcNotify_isCoreEnabled(uint32_t coreId);
263
274 int32_t IpcNotify_sendSync(uint32_t remoteCoreId);
275
289 int32_t IpcNotify_waitSync(uint32_t remoteCoreId, uint32_t timeout);
290
306 int32_t IpcNotify_syncAll(uint32_t timeout);
307
308
317 void IpcNotify_registerNonNotifyCallback(IpcNotify_NonNotifyCallback callback);
318
321 #ifdef __cplusplus
322 }
323 #endif
324
325 #endif /* IPC_NOTIFY_H_ */
326
CSL_CORE_ID_MAX
#define CSL_CORE_ID_MAX
Definition: cslr_soc_defines.h:146
IpcNotify_CrcHookFxn
int32_t(* IpcNotify_CrcHookFxn)(uint8_t *data, uint16_t dataLen, uint8_t crcSize, void *crc)
This is the API defined in application for CRC Calculation.
Definition: ipc_notify.h:145
args
void * args
Definition: hsmclient_msg.h:4
IpcNotify_Params::selfCoreId
uint32_t selfCoreId
Definition: ipc_notify.h:164
SystemP.h
IpcNotify_deInit
void IpcNotify_deInit(void)
De-initialize IPC Notify module.
IpcNotify_registerClient
int32_t IpcNotify_registerClient(uint16_t localClientId, IpcNotify_FxnCallback msgCallback, void *args)
Register a callback to handle messages received from a specific remote core and for a specific local ...
IpcNotify_sendSync
int32_t IpcNotify_sendSync(uint32_t remoteCoreId)
Send a sync message to specific core.
IpcNotify_registerNonNotifyCallback
void IpcNotify_registerNonNotifyCallback(IpcNotify_NonNotifyCallback callback)
This is a driver library internal API and is used in certain SOCs by the separate mailbox driver.
IpcNotify_sendMsg
int32_t IpcNotify_sendMsg(uint32_t remoteCoreId, uint16_t remoteClientId, uint32_t msgValue, uint32_t waitForFifoNotFull)
Send message to a specific remote core and specific client ID on that remote core.
IpcNotify_Params::linuxCoreId
uint32_t linuxCoreId
Definition: ipc_notify.h:168
IpcNotify_isCoreEnabled
uint32_t IpcNotify_isCoreEnabled(uint32_t coreId)
Check if a core is enabled for IPC.
IpcNotify_Params
Parameters used by IpcNotify_init.
Definition: ipc_notify.h:154
IpcNotify_Params::isIPCIntrRouter
uint8_t isIPCIntrRouter
Definition: ipc_notify.h:173
IpcNotify_NonNotifyCallback
void(* IpcNotify_NonNotifyCallback)(uint32_t remoteCoreId)
This is a driver library internal API and is used in certain SOCs by the separate mailbox driver.
Definition: ipc_notify.h:133
IpcNotify_syncAll
int32_t IpcNotify_syncAll(uint32_t timeout)
Send a message to all enabled cores and wait for sync message from all enabled cores.
IpcNotify_Params_init
void IpcNotify_Params_init(IpcNotify_Params *params)
Set default value to IpcNotify_Params.
dataLen
uint32_t dataLen
Definition: hsmclient.h:1
IpcNotify_waitSync
int32_t IpcNotify_waitSync(uint32_t remoteCoreId, uint32_t timeout)
Wait for a sync message to be received from the specified core.
IpcNotify_Params::isMailboxIpcEnabled
uint8_t isMailboxIpcEnabled
Definition: ipc_notify.h:172
IpcNotify_getSelfCoreId
uint32_t IpcNotify_getSelfCoreId(void)
Return current core ID.
IpcNotify_unregisterClient
int32_t IpcNotify_unregisterClient(uint16_t localClientId)
Un-register a previously registered callback.
IpcNotify_Params::numCores
uint32_t numCores
Definition: ipc_notify.h:156
IpcNotify_Params::intrPriority
uint8_t intrPriority
Definition: ipc_notify.h:169
IpcNotify_Params::isCrcEnabled
uint8_t isCrcEnabled
Definition: ipc_notify.h:170
IpcNotify_init
int32_t IpcNotify_init(const IpcNotify_Params *params)
Initialize IPC Notify module.
IpcNotify_FxnCallback
void(* IpcNotify_FxnCallback)(uint32_t remoteCoreId, uint16_t localClientId, uint32_t msgValue, int32_t crcStatus, void *args)
User callback that is invoked when a message is received from a reote core for a given client ID.
Definition: ipc_notify.h:124
IpcNotify_Params::crcHookFxn
IpcNotify_CrcHookFxn crcHookFxn
Definition: ipc_notify.h:171