IPC Driver MultiProc configuration

Introduction

This is documentation for MultiProc configuration used by IPC

Files
file	ipc_mp.h
	IPC - Multiproc interface.

Functions
int32_t	Ipc_mpSetConfig (uint32_t selfId, uint16_t numProc, uint32_t procArry[IPC_MAX_PROCS])
	Sets the multiproc configuration. More...
uint32_t	Ipc_mpGetId (const char *name)
	Gets the MultiProc id. More...
const char *	Ipc_mpGetName (uint32_t id)
	Gets the name of a processor. More...
uint16_t	Ipc_mpGetNumProcessors (void)
	Gets the number of processors. More...
uint32_t	Ipc_mpGetSelfId (void)
	Gets executing processor's MultiProc id. More...
const char *	Ipc_mpGetSelfName (void)
	Get the processor name for current processor. More...
uint32_t	Ipc_mpGetRemoteProcId (uint32_t coreIndex)
	Returns procId of the given index. More...

Macros
#define	IPC_MP_INVALID_ID   (0xFFFFFFFFU)
	Invalid processor id. More...

Macro Definition Documentation

IPC_MP_INVALID_ID

#define IPC_MP_INVALID_ID   (0xFFFFFFFFU)

Invalid processor id.

Function Documentation

Ipc_mpSetConfig()

int32_t Ipc_mpSetConfig	(	uint32_t	selfId,
		uint16_t	numProc,
		uint32_t	procArry[IPC_MAX_PROCS]
	)

Sets the multiproc configuration.

sets the current current processor, number of processor, and array of processors participating

Parameters

selfId	[IN] Self ProcId
numProc	[IN] Number of core in application
procArry	[IN] Array of processorId in application

Returns

IPC_SOK for success IPC_MP_INVALID_ID for invalid parameter

Ipc_mpGetId()

uint32_t Ipc_mpGetId

(

const char *

name

)

Gets the MultiProc id.

Retrieves the MultiProc id for the processor with corresponding MultiProc name. IPC_MP_INVALID_ID is returned if the name was not found.

Parameters

name	[IN] Name of the processor.

Returns

ProcId if valid core name, else returns -1

Ipc_mpGetName()

const char* Ipc_mpGetName

(

uint32_t

id

)

Gets the name of a processor.

Parameters

id	[IN] MultiProc id.

Returns

Name of the processor The returned string should never be modified.

Ipc_mpGetNumProcessors()

uint16_t Ipc_mpGetNumProcessors

(

void

)

Gets the number of processors.

Returns

Number of processors configured with MultiProc

Ipc_mpGetSelfId()

uint32_t Ipc_mpGetSelfId

(

void

)

Gets executing processor's MultiProc id.

Returns

Executing processor's id

Ipc_mpGetSelfName()

const char* Ipc_mpGetSelfName

(

void

)

Get the processor name for current processor.

Ipc_mpGetRemoteProcId()

uint32_t Ipc_mpGetRemoteProcId

(

uint32_t

coreIndex

)

Returns procId of the given index.