Data Structures
struct	Ipc_Hdr
	IPC Resource Table Header. More...

struct	Ipc_Trace
	Structure used for remoteproc trace. More...

struct	Ipc_VDevVRing
	Resource Table Device VRing Structure. More...

struct	Ipc_VDev
	VDEV structure. Must match with Linux. More...

struct	Ipc_ResourceTable
	IPC Resource Table used by IPC app. More...

Macros
#define	VIRTIO_ID_CONSOLE 3
	Virtio type console used for Linux remoteproc. More...

#define	VIRTIO_ID_RPMSG 7
	Virtio type as Remote Proc Messaging. More...

#define	VIRTIO_RPMSG_F_NS 0
	RP supports name service notifications. More...

#define	VIRTIO_RING_F_SYMMETRIC 30
	Support symmetric vring. More...

Variables
uint32_t	Ipc_Hdr::ver

uint32_t	Ipc_Hdr::num

uint32_t	Ipc_Hdr::reserved [2]

uint32_t	Ipc_Trace::type

uint32_t	Ipc_Trace::da

uint32_t	Ipc_Trace::len

uint32_t	Ipc_Trace::reserved

uint8_t	Ipc_Trace::name [NAME_LEN]

uint32_t	Ipc_VDevVRing::da

uint32_t	Ipc_VDevVRing::align

uint32_t	Ipc_VDevVRing::num

uint32_t	Ipc_VDevVRing::notifyid

uint32_t	Ipc_VDevVRing::reserved

uint32_t	Ipc_VDev::type

uint32_t	Ipc_VDev::id

uint32_t	Ipc_VDev::notifyid

uint32_t	Ipc_VDev::dfeatures

uint32_t	Ipc_VDev::gfeatures

uint32_t	Ipc_VDev::config_len

uint8_t	Ipc_VDev::status

uint8_t	Ipc_VDev::num_of_vrings

uint8_t	Ipc_VDev::reserved [2]

Ipc_Hdr	Ipc_ResourceTable::base

uint32_t	Ipc_ResourceTable::offset [NUM_ENTRIES]

Ipc_VDev	Ipc_ResourceTable::rpmsg_vdev

Ipc_VDevVRing	Ipc_ResourceTable::rpmsg_vring0

Ipc_VDevVRing	Ipc_ResourceTable::rpmsg_vring1

Ipc_Trace	Ipc_ResourceTable::trace

IPC RP Mailbox Messages
List of various IPC RP messages sent by remote proc kernel driver
#define	IPC_RP_MBOX_READY ((uint32_t)0xFFFFFF00U)

#define	IPC_RP_MBOX_PENDING_MSG ((uint32_t)0xFFFFFF01U)

#define	IPC_RP_MBOX_CRASH ((uint32_t)0xFFFFFF02U)

#define	IPC_RP_MBOX_ECHO_REQUEST ((uint32_t)0xFFFFFF03U)

#define	IPC_RP_MBOX_ECHO_REPLY ((uint32_t)0xFFFFFF04U)

#define	IPC_RP_MBOX_ABORT_REQUEST ((uint32_t)0xFFFFFF05U)

#define	IPC_RP_MBOX_SUSPEND_AUTO ((uint32_t)0xFFFFFF10U)

#define	IPC_RP_MBOX_SUSPEND_SYSTEM ((uint32_t)0xFFFFFF11U)

#define	IPC_RP_MBOX_SUSPEND_ACK ((uint32_t)0xFFFFFF12U)

#define	IPC_RP_MBOX_SUSPEND_CANCEL ((uint32_t)0xFFFFFF13U)

#define	IPC_RP_MBOX_SHUTDOWN ((uint32_t)0xFFFFFF14U)

#define	IPC_RP_MBOX_SHUTDOWN_ACK ((uint32_t)0xFFFFFF15U)

#define	IPC_RP_MBOX_END_MSG ((uint32_t)0xFFFFFF16U)

#define	TYPE_CARVEOUT 0U
	carvout type More...

#define	TYPE_DEVMEM 1U
	Devmem type. More...

#define	TYPE_TRACE 2U
	trace type More...

#define	TYPE_VDEV 3U
	VDEV type. More...

#define	FW_RSC_ADDR_ANY (~0)
	Macro to specify memory needs to be dynamically allocated. More...

#define	NUM_ENTRIES 2
	Number of e ntries. More...

#define	NAME_LEN 32
	Name Length. More...

#define	TRACE_INTS_VER0 (0 << 16)

#define	TRACE_INTS_VER1 (1 << 16)

Detailed Description

This is documentation for Resource Table configuratin for remote core as A72 running Linux.

Macro Definition Documentation

◆ VIRTIO_ID_CONSOLE

#define VIRTIO_ID_CONSOLE 3

Virtio type console used for Linux remoteproc.

◆ VIRTIO_ID_RPMSG

#define VIRTIO_ID_RPMSG 7

Virtio type as Remote Proc Messaging.

◆ VIRTIO_RPMSG_F_NS

#define VIRTIO_RPMSG_F_NS 0

RP supports name service notifications.

◆ VIRTIO_RING_F_SYMMETRIC

#define VIRTIO_RING_F_SYMMETRIC 30

Support symmetric vring.

◆ IPC_RP_MBOX_READY

#define IPC_RP_MBOX_READY ((uint32_t)0xFFFFFF00U)

◆ IPC_RP_MBOX_PENDING_MSG

#define IPC_RP_MBOX_PENDING_MSG ((uint32_t)0xFFFFFF01U)

◆ IPC_RP_MBOX_CRASH

#define IPC_RP_MBOX_CRASH ((uint32_t)0xFFFFFF02U)

◆ IPC_RP_MBOX_ECHO_REQUEST

#define IPC_RP_MBOX_ECHO_REQUEST ((uint32_t)0xFFFFFF03U)

◆ IPC_RP_MBOX_ECHO_REPLY

#define IPC_RP_MBOX_ECHO_REPLY ((uint32_t)0xFFFFFF04U)

◆ IPC_RP_MBOX_ABORT_REQUEST

#define IPC_RP_MBOX_ABORT_REQUEST ((uint32_t)0xFFFFFF05U)

◆ IPC_RP_MBOX_SUSPEND_AUTO

#define IPC_RP_MBOX_SUSPEND_AUTO ((uint32_t)0xFFFFFF10U)

◆ IPC_RP_MBOX_SUSPEND_SYSTEM

#define IPC_RP_MBOX_SUSPEND_SYSTEM ((uint32_t)0xFFFFFF11U)

◆ IPC_RP_MBOX_SUSPEND_ACK

#define IPC_RP_MBOX_SUSPEND_ACK ((uint32_t)0xFFFFFF12U)

◆ IPC_RP_MBOX_SUSPEND_CANCEL

#define IPC_RP_MBOX_SUSPEND_CANCEL ((uint32_t)0xFFFFFF13U)

◆ IPC_RP_MBOX_SHUTDOWN

#define IPC_RP_MBOX_SHUTDOWN ((uint32_t)0xFFFFFF14U)

◆ IPC_RP_MBOX_SHUTDOWN_ACK

#define IPC_RP_MBOX_SHUTDOWN_ACK ((uint32_t)0xFFFFFF15U)

◆ IPC_RP_MBOX_END_MSG

#define IPC_RP_MBOX_END_MSG ((uint32_t)0xFFFFFF16U)

◆ TYPE_CARVEOUT

#define TYPE_CARVEOUT 0U

carvout type

◆ TYPE_DEVMEM

#define TYPE_DEVMEM 1U

Devmem type.

◆ TYPE_TRACE

#define TYPE_TRACE 2U

trace type

◆ TYPE_VDEV

#define TYPE_VDEV 3U

VDEV type.

◆ FW_RSC_ADDR_ANY

#define FW_RSC_ADDR_ANY (~0)

Macro to specify memory needs to be dynamically allocated.

◆ NUM_ENTRIES

#define NUM_ENTRIES 2

Number of e ntries.

◆ NAME_LEN

#define NAME_LEN 32

Name Length.

◆ TRACE_INTS_VER0

#define TRACE_INTS_VER0 (0 << 16)

◆ TRACE_INTS_VER1

#define TRACE_INTS_VER1 (1 << 16)

Variable Documentation

◆ ver

uint32_t Ipc_Hdr::ver

Version Number

◆ num [1/2]

uint32_t Ipc_Hdr::num

Number of Device

◆ reserved [1/4]

uint32_t Ipc_Hdr::reserved[2]

Reserved for future use

◆ type [1/2]

uint32_t Ipc_Trace::type

Type of trace

◆ da [1/2]

uint32_t Ipc_Trace::da

Device Address

◆ len

uint32_t Ipc_Trace::len

Length of buffer

◆ reserved [2/4]

uint32_t Ipc_Trace::reserved

Reserved for future use

◆ name

uint8_t Ipc_Trace::name[NAME_LEN]

Name of the trace

◆ da [2/2]

uint32_t Ipc_VDevVRing::da

device address

◆ align

uint32_t Ipc_VDevVRing::align

Alignment of the buffer.

◆ num [2/2]

uint32_t Ipc_VDevVRing::num

Number of buffers

◆ notifyid [1/2]

uint32_t Ipc_VDevVRing::notifyid

NotifyId for receive channel

◆ reserved [3/4]

uint32_t Ipc_VDevVRing::reserved

Reserved for future use

◆ type [2/2]

uint32_t Ipc_VDev::type

type of VDEV

◆ id

uint32_t Ipc_VDev::id

ID of VDEV

◆ notifyid [2/2]

uint32_t Ipc_VDev::notifyid

NotifiedId

◆ dfeatures

uint32_t Ipc_VDev::dfeatures

Not used

◆ gfeatures

uint32_t Ipc_VDev::gfeatures

not used

◆ config_len

uint32_t Ipc_VDev::config_len

Length of configuration

◆ status

uint8_t Ipc_VDev::status

Status of VDev. It is updated by remote proc during loading

◆ num_of_vrings

uint8_t Ipc_VDev::num_of_vrings

number of vrings

◆ reserved [4/4]

uint8_t Ipc_VDev::reserved[2]

Reserved for future use

◆ base

Ipc_Hdr Ipc_ResourceTable::base

Header Information

◆ offset

uint32_t Ipc_ResourceTable::offset[NUM_ENTRIES]

offset, Should match 'num' in actual definition

◆ rpmsg_vdev

Ipc_VDev Ipc_ResourceTable::rpmsg_vdev

RPMessage vDev Entry

◆ rpmsg_vring0

Ipc_VDevVRing Ipc_ResourceTable::rpmsg_vring0

1st - VRing

◆ rpmsg_vring1

Ipc_VDevVRing Ipc_ResourceTable::rpmsg_vring1

2nd VRing

◆ trace

Ipc_Trace Ipc_ResourceTable::trace

Trace used by remote proc

Data Structures

Macros

Variables

IPC RP Mailbox Messages

Detailed Description

Macro Definition Documentation

◆ VIRTIO_ID_CONSOLE

◆ VIRTIO_ID_RPMSG

◆ VIRTIO_RPMSG_F_NS

◆ VIRTIO_RING_F_SYMMETRIC

◆ IPC_RP_MBOX_READY

◆ IPC_RP_MBOX_PENDING_MSG

◆ IPC_RP_MBOX_CRASH

◆ IPC_RP_MBOX_ECHO_REQUEST

◆ IPC_RP_MBOX_ECHO_REPLY

◆ IPC_RP_MBOX_ABORT_REQUEST

◆ IPC_RP_MBOX_SUSPEND_AUTO

◆ IPC_RP_MBOX_SUSPEND_SYSTEM

◆ IPC_RP_MBOX_SUSPEND_ACK

◆ IPC_RP_MBOX_SUSPEND_CANCEL

◆ IPC_RP_MBOX_SHUTDOWN

◆ IPC_RP_MBOX_SHUTDOWN_ACK

◆ IPC_RP_MBOX_END_MSG

◆ TYPE_CARVEOUT

◆ TYPE_DEVMEM

◆ TYPE_TRACE

◆ TYPE_VDEV

◆ FW_RSC_ADDR_ANY

◆ NUM_ENTRIES

◆ NAME_LEN

◆ TRACE_INTS_VER0

◆ TRACE_INTS_VER1

Variable Documentation

◆ ver

◆ num [1/2]

◆ reserved [1/4]

◆ type [1/2]

◆ da [1/2]

◆ len

◆ reserved [2/4]

◆ name

◆ da [2/2]

◆ align

◆ num [2/2]

◆ notifyid [1/2]

◆ reserved [3/4]

◆ type [2/2]

◆ id

◆ notifyid [2/2]

◆ dfeatures

◆ gfeatures

◆ config_len

◆ status

◆ num_of_vrings

◆ reserved [4/4]

◆ base

◆ offset

◆ rpmsg_vdev

◆ rpmsg_vring0

◆ rpmsg_vring1

◆ trace