ipc_notify.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2023 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef IPC_NOTIFY_H_
#define IPC_NOTIFY_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/hw_include/cslr_soc.h>
 
#define IPC_NOTIFY_CLIENT_ID_MAX    (16U)
 
#define IPC_NOTIFY_CLIENT_ID_RPMSG  (0U)
 
#define IPC_NOTIFY_CLIENT_ID_SYNC  (1U)
 
#define IPC_NOTIFY_DEFAULT_INTR_PRIORITY  (4U)
 
#define IPC_NOTIFY_MSG_VALUE_MAX    (0x10000000U)
 
#define IPC_NOTIFY_CRC_MSG_VALUE_MAX    (0x100000U)
 
#define IPC_NOTIFY_CRC_MAX    (0x100U)
 
#define IPC_NOTIFY_CRC_SIZE    (1U)
 
#define IPC_NOTIFY_CRC_DATASIZE    (4U)
 
#define IPC_INTR_ROUTER_ENABLE    (0x01U)
 
#define IPC_INTR_ROUTER_DISABLE    (0x00U)
 
typedef void (*IpcNotify_FxnCallback)(uint32_t remoteCoreId, uint16_t localClientId, uint32_t msgValue, int32_t crcStatus, void *args);
 
typedef void (*IpcNotify_NonNotifyCallback)(uint32_t remoteCoreId);
 
typedef int32_t (*IpcNotify_CrcHookFxn)(uint8_t *data, uint16_t dataLen, uint8_t crcSize, void *crc);
 
typedef struct IpcNotify_Params_ {
 
    uint32_t numCores;  
    uint32_t coreIdList[CSL_CORE_ID_MAX]; 
    uint32_t selfCoreId; 
    uint32_t linuxCoreId; 
    uint8_t  intrPriority; 
    uint8_t  isCrcEnabled; /* CRC Enable/Disable flag */
    IpcNotify_CrcHookFxn crcHookFxn; /* Hook Function to be provided by application for CRC calculation. */
    uint8_t  isMailboxIpcEnabled; 
    uint8_t  isIPCIntrRouter; 
} IpcNotify_Params;
 
void IpcNotify_Params_init(IpcNotify_Params *params);
 
int32_t IpcNotify_init(const IpcNotify_Params *params);
 
void    IpcNotify_deInit(void);
 
int32_t IpcNotify_sendMsg(uint32_t remoteCoreId, uint16_t remoteClientId, uint32_t msgValue, uint32_t waitForFifoNotFull);
 
int32_t IpcNotify_registerClient(uint16_t localClientId, IpcNotify_FxnCallback msgCallback, void *args);
 
 
int32_t IpcNotify_unregisterClient(uint16_t localClientId);
 
uint32_t IpcNotify_getSelfCoreId(void);
 
uint32_t IpcNotify_isCoreEnabled(uint32_t coreId);
 
int32_t IpcNotify_sendSync(uint32_t remoteCoreId);
 
int32_t IpcNotify_waitSync(uint32_t remoteCoreId, uint32_t timeout);
 
int32_t IpcNotify_syncAll(uint32_t timeout);
 
 
void IpcNotify_registerNonNotifyCallback(IpcNotify_NonNotifyCallback callback);
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPC_NOTIFY_H_ */