module ti.ipc.remoteproc.Resource
index URL

Resource Module

C synopsis target-domain sourced in ti/ipc/remoteproc/Resource.xdc
#include <ti/ipc/remoteproc/Resource.h>
Functions
Ptr 
Resource_getTraceBufPtr// ();
Char 
Resource_getVdevStatus// (UInt32 id);
Ptr 
Resource_getVringDA// (UInt32 vqId);
Int 
Resource_physToVirt// (UInt32 pa, UInt32 *da);
Int 
Resource_virtToPhys// (UInt32 da, UInt32 *pa);
Functions common to all target modules
Resource_Module_getMask// Returns the diagnostics mask for this module, Resource_Module_hasMask// Test whether this module has a diagnostics mask, Resource_Module_heap// The heap from which this module allocates memory, Resource_Module_id// Get this module's unique id, Resource_Module_setMask// Set the diagnostics mask for this module, Resource_Module_startupDone// Test if this module has completed startup
Defines
#define
Resource_E_NOTFOUND//  (Int)-1
#define
Resource_S_SUCCESS//  (Int)0
Typedefs
typedef struct
Resource_MemEntry//  ...
typedef struct
Resource_RscTable//  ...
 
 
const Resource_E_NOTFOUND
index URL
C synopsis target-domain
#define Resource_E_NOTFOUND (Int)-1
 
DEF
Resource_E_NOTFOUND
BRIEF
Element was not found in table
 
const Resource_S_SUCCESS
index URL
C synopsis target-domain
#define Resource_S_SUCCESS (Int)0
 
DEF
Resource_S_SUCCESS
BRIEF
Operation is successful.
 
struct Resource_MemEntry
index URL
C synopsis target-domain
typedef struct Resource_MemEntry {
    UInt32 type;
    UInt32 da;
    UInt32 pa;
    UInt32 len;
    UInt32 flags;
    UInt32 reserved;
    Char name[32];
} Resource_MemEntry;
 
DEF
Resource_MemEntry
BRIEF
A Resource Table memory type record
 
struct Resource_RscTable
index URL
C synopsis target-domain
typedef struct Resource_RscTable {
    UInt32 ver;
    UInt32 num;
    UInt32 reserved[2];
    UInt32 offset[1];
} Resource_RscTable;
 
DEF
Resource_RscTable
BRIEF
An open-ended type-length-value based resource table
 
Resource_getTraceBufPtr()  // module-wide
index URL
C synopsis target-domain
Ptr Resource_getTraceBufPtr();
 
BRIEF
Get the Trace Buffer address from resource table.
RETURN
Pointer to trace buffer, or NULL if not found.
 
Resource_getVdevStatus()  // module-wide
index URL
C synopsis target-domain
Char Resource_getVdevStatus(UInt32 id);
 
BRIEF
Get the status field of the VDEV, given the fw_rsc_vdev id.
RETURN
status value which is set by Virtio device on HLOS.
 
Resource_getVringDA()  // module-wide
index URL
C synopsis target-domain
Ptr Resource_getVringDA(UInt32 vqId);
 
BRIEF
Get the nth (vqId) vring address from the VDEV struct.
RETURN
NULL if no VDEV found, or vqId is not found.
 
Resource_physToVirt()  // module-wide
index URL
C synopsis target-domain
Int Resource_physToVirt(UInt32 pa, UInt32 *da);
 
BRIEF
Physical to Virtual address translation function
SA
Resource_virtToPhys
 
Resource_virtToPhys()  // module-wide
index URL
C synopsis target-domain
Int Resource_virtToPhys(UInt32 da, UInt32 *pa);
 
BRIEF
Virtual to Physical address translation function
SA
Resource_physToVirt
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId Resource_Module_id();
// Get this module's unique id
 
Bool Resource_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle Resource_Module_heap();
// The heap from which this module allocates memory
 
Bool Resource_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 Resource_Module_getMask();
// Returns the diagnostics mask for this module
 
Void Resource_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/ipc/remoteproc/Resource.xdc
var Resource = xdc.useModule('ti.ipc.remoteproc.Resource');
module-wide constants & types
    const Resource.E_NOTFOUND//  = -1;
    const Resource.S_SUCCESS//  = 0;
 
    var obj = new Resource.MemEntry// ;
        obj.type = UInt32  ...
        obj.da = UInt32  ...
        obj.pa = UInt32  ...
        obj.len = UInt32  ...
        obj.flags = UInt32  ...
        obj.reserved = UInt32  ...
        obj.name = Char[32]  ...
 
    var obj = new Resource.RscTable// ;
        obj.ver = UInt32  ...
        obj.num = UInt32  ...
        obj.reserved = UInt32[2]  ...
        obj.offset = UInt32[1]  ...
module-wide config parameters
    Resource.common$// Common module configuration parameters = Types.Common$ undefined;
    Resource.customTable// Flag to indicate the user will provide a custom resource table = Bool false;
    Resource.loadAddr//  = UInt 0x3000;
    Resource.loadSegment//  = String undefined;
    Resource.traceOnly//  = Bool false;
 
 
const Resource.E_NOTFOUND
index URL
Configuration settings
const Resource.E_NOTFOUND = -1;
 
DEF
Resource_E_NOTFOUND
BRIEF
Element was not found in table
C SYNOPSIS
Resource_E_NOTFOUND
 
const Resource.S_SUCCESS
index URL
Configuration settings
const Resource.S_SUCCESS = 0;
 
DEF
Resource_S_SUCCESS
BRIEF
Operation is successful.
C SYNOPSIS
Resource_S_SUCCESS
 
struct Resource.MemEntry
index URL
Configuration settings
var obj = new Resource.MemEntry;
 
    obj.type = UInt32  ...
    obj.da = UInt32  ...
    obj.pa = UInt32  ...
    obj.len = UInt32  ...
    obj.flags = UInt32  ...
    obj.reserved = UInt32  ...
    obj.name = Char[32]  ...
 
DEF
Resource_MemEntry
BRIEF
A Resource Table memory type record
C SYNOPSIS
Resource_MemEntry
 
struct Resource.RscTable
index URL
Configuration settings
var obj = new Resource.RscTable;
 
    obj.ver = UInt32  ...
    obj.num = UInt32  ...
    obj.reserved = UInt32[2]  ...
    obj.offset = UInt32[1]  ...
 
DEF
Resource_RscTable
BRIEF
An open-ended type-length-value based resource table
C SYNOPSIS
Resource_RscTable
 
metaonly config Resource.common$  // module-wide
index URL

Common module configuration parameters

Configuration settings
Resource.common$ = Types.Common$ undefined;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
 
metaonly config Resource.customTable  // module-wide
index URL

Flag to indicate the user will provide a custom resource table

Configuration settings
Resource.customTable = Bool false;
 
DETAILS
If false (the default), a default resource table will be created during configuration.
If true, the user must supply their own resource table. Fundamentally, this amounts to providing a well-formed resource_table structure named 'ti_ipc_remoteproc_ResourceTable'.
 
metaonly config Resource.loadAddr  // module-wide
index URL
Configuration settings
Resource.loadAddr = UInt 0x3000;
 
DEF
Resource_loadAddr
BRIEF
Default load address for the Resource table
 
metaonly config Resource.loadSegment  // module-wide
index URL
Configuration settings
Resource.loadSegment = String undefined;
 
DEF
Resource_loadSegment
BRIEF
If loadSegment is defined, loadAddr is overridden with the base address of the loadSegment
 
metaonly config Resource.traceOnly  // module-wide
index URL
Configuration settings
Resource.traceOnly = Bool false;
 
DEF
Resource_traceOnly
BRIEF
Set traceOnly to true in order to get an image with trace resources only, and without VRINGs. Implemented only for the Keystone II (TCI6638) platform.
generated on Fri, 21 Aug 2015 19:35:32 GMT