Engine_Desc Struct Reference [Codec Engine Runtime]

This structure is passed to Engine_add(), and contains parameters to specify an engine. More...

#include <Engine.h>

Collaboration diagram for Engine_Desc:

Data Fields
String	name
Engine_AlgDesc *	algTab
String	remoteName
String	memMap
Bool	useExtLoader
Int	numAlgs
Int	heapId

---

Detailed Description

This structure is passed to Engine_add(), and contains parameters to specify an engine.

See also:

Engine_add()

Engine_open()

---

Field Documentation

String Engine_Desc::name

Name of the Engine

Remarks:

This must not be NULL

Engine_AlgDesc* Engine_Desc::algTab

No longer used, set to NULL

String Engine_Desc::remoteName

Name of Server image, if applicable

Remarks:

If this Engine has no remote algorithms, this can be NULL.

On SysLink-based systems, this is the name of a file, and is passed unchanged to ProcMgr_load().

String Engine_Desc::memMap

Name of a file containing the slave memory map

Remarks:

If this Engine has no remote algorithms, this can be NULL.

If the remote algorithms are on a Server whos MMU is not enabled, this can be NULL.

The format of this file matches the SysLink format described at https://processors.wiki.ti.com/index.php/SysLink_MMU_Support

If useExtLoader is FALSE, this field can be NULL.

Bool Engine_Desc::useExtLoader

Indicates whether the Server containing any remote algorithms will be loaded using an external loader (e.g. SysLink's slaveloader)

Remarks:

If useExtLoader is TRUE, Engine_open() will not load the slave.

If useExtLoader is FALSE, Engine_open() will load the Server with the file specified by remoteName.

Int Engine_Desc::numAlgs

No longer used, set to zero

Int Engine_Desc::heapId

No longer used, set to zero

---

The documentation for this struct was generated from the following file:

• Engine.h