PDK API Guide for J721E
Top Level IPC SoC Config

Introduction

Files

file  ipc_soc.h
 IPC Low Level Driver SOC specific file.
 

Functions

int32_t Ipc_getMailboxInfoTx (uint32_t selfId, uint32_t remoteId, uint32_t *clusterId, uint32_t *userId, uint32_t *queueId)
 
int32_t Ipc_getMailboxInfoRx (uint32_t selfId, uint32_t remoteId, uint32_t *clusterId, uint32_t *userId, uint32_t *queueId)
 
int32_t Ipc_getMailboxIntrRouterCfg (uint32_t selfId, uint32_t clusterId, uint32_t userId, Ipc_MbConfig *cfg, uint32_t cnt)
 
uintptr_t Ipc_getMailboxBaseAddr (uint32_t clusterId)
 
const char * Ipc_getCoreName (uint32_t procId)
 Returns the core name for get core id. More...
 
uint32_t Ipc_getCoreId (void)
 Returns Core ID based on core build flag. More...
 
uint32_t Ipc_isCacheCoherent (void)
 Returns TRUE if the memory is cache coherent. More...
 

Macros

#define IPC_INVALID_PROCID   (0XFFU)
 

Macro Definition Documentation

◆ IPC_INVALID_PROCID

#define IPC_INVALID_PROCID   (0XFFU)

Invalid Proc ID

Function Documentation

◆ Ipc_getMailboxInfoTx()

int32_t Ipc_getMailboxInfoTx ( uint32_t  selfId,
uint32_t  remoteId,
uint32_t *  clusterId,
uint32_t *  userId,
uint32_t *  queueId 
)

◆ Ipc_getMailboxInfoRx()

int32_t Ipc_getMailboxInfoRx ( uint32_t  selfId,
uint32_t  remoteId,
uint32_t *  clusterId,
uint32_t *  userId,
uint32_t *  queueId 
)

◆ Ipc_getMailboxIntrRouterCfg()

int32_t Ipc_getMailboxIntrRouterCfg ( uint32_t  selfId,
uint32_t  clusterId,
uint32_t  userId,
Ipc_MbConfig cfg,
uint32_t  cnt 
)

◆ Ipc_getMailboxBaseAddr()

uintptr_t Ipc_getMailboxBaseAddr ( uint32_t  clusterId)

◆ Ipc_getCoreName()

const char* Ipc_getCoreName ( uint32_t  procId)

Returns the core name for get core id.

Parameters
procId[IN] Id of desired core.
Returns
name of the given core id

◆ Ipc_getCoreId()

uint32_t Ipc_getCoreId ( void  )

Returns Core ID based on core build flag.

Returns
Code ID of the current core

◆ Ipc_isCacheCoherent()

uint32_t Ipc_isCacheCoherent ( void  )

Returns TRUE if the memory is cache coherent.

Returns
TRUE/FALSE