Data Structures | Defines | Typedefs | Functions | Variables

visa.h File Reference


Detailed Description

The Codec Engine System Programming Interface. Provides system developers with services necessary to implement stubs and skeletons.

#include <stddef.h>
#include <ti/sdo/ce/node/node.h>
#include <ti/xdais/ialg.h>
#include <ti/sdo/ce/Engine.h>
Include dependency graph for visa.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  VISA_MsgHeader
 VISA message header. More...

Defines

#define VISA_EOK   0
 Success.
#define VISA_ERUNTIME   -1
 Internal runtime error.
#define VISA_EFAIL   -2
 General system error.
#define VISA_EUNSUPPORTED   -3
 The API is not suported for the given system configuration.
#define VISA_ETIMEOUT   -100
 Timeout occurred.
#define VISA_FOREVER   Engine_FOREVER
 Special value for timeout parameter indicating never timeout.
#define VISA_MODNAME   "ti.sdo.ce.VISA"
 Name to pass to Diags_setMask() to enable logging for VISA functions. For example, Diags_setMask(VISA_MODNAME"+EX1234567"); turns on all Log statements in this module. Diags_setMask() must be called after initialization to take effect.

Typedefs

typedef Int VISA_Status
 VISA result data type.
typedef struct VISA_Obj * VISA_Handle
 Opaque handle to a node.
typedef struct VISA_MsgHeader VISA_MsgHeader
 VISA message header.
typedef VISA_MsgHeaderVISA_Msg

Functions

VISA_Msg VISA_allocMsg (VISA_Handle visa)
 Obtain an algorithm instance's message.
VISA_Status VISA_call (VISA_Handle visa, VISA_Msg *msg)
 Invoke the operation specified in the message and wait for it to complete.
VISA_Status VISA_callAsync (VISA_Handle visa, VISA_Msg *msg)
 Invoke the operation specified in the message and return without waiting for it to complete.
VISA_Status VISA_wait (VISA_Handle visa, VISA_Msg *msg, UInt timeout)
 Wait for the oldest operation from a command specified with VISA_callAsync() to complete.
Void VISA_freeMsg (VISA_Handle visa, VISA_Msg msg)
 Release an algorithm instance's message.
VISA_Status VISA_getAlgMemRecs (VISA_Handle visa, IALG_MemRec *memTab, Int size, Int *numRecs)
 Get the IALG_MemRec memory assigned to an algorithm instance.
VISA_Status VISA_getAlgNumRecs (VISA_Handle visa, Int *numRecs)
 Get the number of IALG_MemRecs assigned to an algorithm.
Void VISA_getContext (VISA_Handle visa, UInt32 *pContext)
 Get optional context parameter.
Ptr VISA_getCodecClassConfig (VISA_Handle visa)
 Get codec-specific values for the VISA class-specific (or codec-specific if the codec doesn't extend VISA) stub-and/ or-skeleton configuration data (that some classes have)
UInt VISA_getMaxMsgSize (VISA_Handle visa)
 Returns max size of messages allocated by VISA_allocMsg()
Void _VISA_init (Void)
 Ininitilize VISA module.
Void _VISA_exit (Void)
 Exit VISA module.
Void VISA_setContext (VISA_Handle visa, UInt32 context)
 Set optional context parameter.
Bool VISA_isLocal (VISA_Handle visa)
 Indicates whether VISA codecs run on a remote or local CPU.
VISA_Handle VISA_create (Engine_Handle engine, String name, IALG_Params *params, size_t msgSize, String type)
 Create a new instance of an algorithm.
Void VISA_delete (VISA_Handle visa)
 Delete an instance of an algorithm.
VISA_Handle VISA_create2 (Engine_Handle engine, String name, IALG_Params *params, Int paramsSize, size_t msgSize, String type)
 Create a new instance of an algorithm.
Void VISA_enter (VISA_Handle visa)
 Enter an algorithm's critical section. This must be called before any of the algorithm's IALG_Fxns are invoked.
Void VISA_exit (VISA_Handle visa)
 Leave an algorithm's critical section. This must be called after the API has completed calling an algorithm's IALG_Fxns.
Ptr VISA_getAlgHandle (VISA_Handle visa)
 Obtains an algorithm's handle. This is the handle required to be passed to the algorithm's IALG_Fxns.
Ptr VISA_getAlgorithmHandle (VISA_Handle visa)
 Obtains an algorithm's handle. If the algorithm is local, this is the handle that can be passed to Algorithm APIs, not to the IALG_Fxns.
IALG_FxnsVISA_getAlgFxns (VISA_Handle visa)
 Get implementation functions for this algorithm.

Variables

Bool VISA_checked

Define Documentation

#define VISA_MODNAME   "ti.sdo.ce.VISA"

Name to pass to Diags_setMask() to enable logging for VISA functions. For example, Diags_setMask(VISA_MODNAME"+EX1234567"); turns on all Log statements in this module. Diags_setMask() must be called after initialization to take effect.


Typedef Documentation

typedef struct VISA_Obj* VISA_Handle

Opaque handle to a node.


Variable Documentation

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Copyright 2012, Texas Instruments Incorporated