metaonly module ti.sdo.fc.ires.hdvicp.HDVICP2

HDVICP2-specific IRES Resman and Protocol Implementation

Configuration settings sourced in ti/sdo/fc/ires/hdvicp/HDVICP2.xdc
var HDVICP2 = xdc.useModule('ti.sdo.fc.ires.hdvicp.HDVICP2');
module-wide constants & types
module-wide config parameters
    HDVICP2.autoRegister//  = Bool true;
    HDVICP2.doneFxn// Function indicating "done" = String undefined;
    HDVICP2.freeHDVICP2Fxn//  = String undefined;
    HDVICP2.getHDVICP2Fxn//  = String undefined;
    HDVICP2.getYieldArgsFxn//  = String undefined;
    HDVICP2.intArray//  = UInt[8] undefined;
    HDVICP2.yieldAcquireFxn//  = String undefined;
    HDVICP2.yieldReleaseFxn//  = String undefined;
 
 
const HDVICP2.FOREVER

Timeout value representing "Wait forever" to be used to configure the timeout configuration below

Configuration settings
const HDVICP2.FOREVER = -1;
 
 
const HDVICP2.MAXRESOURCES

Maximum number of HDVICP2 resources this module can manage

Configuration settings
const HDVICP2.MAXRESOURCES = 10;
 
 
config HDVICP2.autoRegister  // module-wide
Configuration settings
HDVICP2.autoRegister = Bool true;
 
 
config HDVICP2.clearPRCMRegister  // module-wide

Boolean value that indicates whether the PRCM register needs to be cleared in the default implementation of the "reset" function

Configuration settings
HDVICP2.clearPRCMRegister = Bool undefined;
 
 
config HDVICP2.configureFxn  // module-wide

Function to configure the interrupt associated with the IVAHD and register a callback function

Configuration settings
HDVICP2.configureFxn = String undefined;
 
DETAILS
Function signature of callback is:
  Void _cbFunction(Void * cbArgs);

  Function signature of configure is:
  XDAS_Void _configure(IALG_Handle algHandle,
          IRES_HDVICP2_Obj * hdvicpHandle,
          IRES_HDVICP2_CallbackFxn cbFunctionPtr, XDAS_Void * cbArgs);
     
 
config HDVICP2.delegate  // module-wide

Package name that implements the above configure, wait, done, reset functions for the IVA-HD

Configuration settings
HDVICP2.delegate = String undefined;
 
 
config HDVICP2.doneFxn  // module-wide

Function indicating "done"

Configuration settings
HDVICP2.doneFxn = String undefined;
 
DETAILS
This is the function called from the ISR interrupt associated with the IVAHD to unblock the waitFxn.
Function signature is:
  XDAS_Void _done(IALG_Handle algHandle, IRES_HDVICP2_Obj * hdvicpHandle);
     
 
config HDVICP2.freeHDVICP2Fxn  // module-wide
Configuration settings
HDVICP2.freeHDVICP2Fxn = String undefined;
 
 
config HDVICP2.getHDVICP2Fxn  // module-wide
Configuration settings
HDVICP2.getHDVICP2Fxn = String undefined;
 
 
config HDVICP2.getYieldArgsFxn  // module-wide
Configuration settings
HDVICP2.getYieldArgsFxn = String undefined;
 
 
config HDVICP2.intArray  // module-wide
Configuration settings
HDVICP2.intArray = UInt[8] undefined;
 
 
config HDVICP2.maxHdvicp2ResetDelay  // module-wide

Maximum number of cycles to wait for HDVICP2 to reset, after a call is issued

Configuration settings
HDVICP2.maxHdvicp2ResetDelay = UInt 1000;
 
 
config HDVICP2.memoryBaseAddress  // module-wide
Configuration settings
HDVICP2.memoryBaseAddress = UInt[HDVICP2.MAXRESOURCES] undefined;
 
 
config HDVICP2.registerBaseAddress  // module-wide

Base-address of the IVA-HD register space

Configuration settings
HDVICP2.registerBaseAddress = UInt[HDVICP2.MAXRESOURCES] undefined;
 
 
config HDVICP2.resetControlAddress  // module-wide
Configuration settings
HDVICP2.resetControlAddress = UInt[HDVICP2.MAXRESOURCES] undefined;
 
 
config HDVICP2.resetFxn  // module-wide

Function to reset the IVAHD

Configuration settings
HDVICP2.resetFxn = String undefined;
 
DETAILS
This is a callback function implemented by the framework and called by the codec.
Function signature is:
  XDAS_UInt32 _reset(IALG_Handle algHandle,
          IRES_HDVICP2_Obj * hdvicpHandle);
     
 
config HDVICP2.semCreateFxn  // module-wide

Function to create semaphores used by the resource manager

Configuration settings
HDVICP2.semCreateFxn = String null;
 
DETAILS
Function signature is:
 Void * _semCreate(Int key, Int count);
     
 
config HDVICP2.semDeleteFxn  // module-wide

Function to delete semaphores used by the resource manager

Configuration settings
HDVICP2.semDeleteFxn = String null;
 
DETAILS
Function signature is:
  Void _semDelete(Void * sem);
     
 
config HDVICP2.semPendFxn  // module-wide

Function to pend on semaphores used by the resource manager

Configuration settings
HDVICP2.semPendFxn = String null;
 
DETAILS
Function signature is:
  Int _semPend(Void * sem, unsigned int timeout);
     
 
config HDVICP2.semPostFxn  // module-wide

Function to post on Semaphores used by the resource manager

Configuration settings
HDVICP2.semPostFxn = String null;
 
DETAILS
Function signature is:
 Void _semPost(Void * sem);
     
 
config HDVICP2.timeout  // module-wide

Timeout setting in microseconds, used by the "waitFxn" while waiting for * a configured IVAHD's interrupt to fire

Configuration settings
HDVICP2.timeout = UInt undefined;
 
 
config HDVICP2.waitFxn  // module-wide

Function to wait on the interrupt associated with the IVAHD to fire

Configuration settings
HDVICP2.waitFxn = String undefined;
 
DETAILS
Function signature is:
  XDAS_UInt32 _wait(IALG_Handle algHandle,
          IRES_HDVICP2_Obj * hdvicpHandle,
          IRES_YieldContext * yieldContext);
     
 
config HDVICP2.yieldAcquireFxn  // module-wide
Configuration settings
HDVICP2.yieldAcquireFxn = String undefined;
 
 
config HDVICP2.yieldReleaseFxn  // module-wide
Configuration settings
HDVICP2.yieldReleaseFxn = String undefined;
 
generated on Mon, 27 Oct 2014 17:56:39 GMT