universal.h File Reference


Detailed Description

The "universal" algorithm interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM IUNIVERSAL interface.

#include <ti/xdais/dm/xdm.h>
#include <ti/xdais/dm/iuniversal.h>
#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/visa.h>
#include <ti/sdo/ce/skel.h>
Include dependency graph for universal.h:

Go to the source code of this file.

Defines

#define UNIVERSAL_EOK   IUNIVERSAL_EOK
#define UNIVERSAL_EFAIL   IUNIVERSAL_EFAIL
#define UNIVERSAL_EUNSUPPORTED   IUNIVERSAL_EUNSUPPORTED
#define UNIVERSAL_ETIMEOUT   VISA_ETIMEOUT
#define UNIVERSAL_FOREVER   VISA_FOREVER

Typedefs

typedef VISA_Handle UNIVERSAL_Handle
 Opaque handle to a UNIVERSAL codec.
typedef struct IUNIVERSAL_Params UNIVERSAL_Params
 This structure defines the parameters necessary to create an instance of a "universal" algorithm.
typedef IUNIVERSAL_InArgs UNIVERSAL_InArgs
typedef IUNIVERSAL_OutArgs UNIVERSAL_OutArgs
typedef IUNIVERSAL_Cmd UNIVERSAL_Cmd
typedef IUNIVERSAL_Status UNIVERSAL_Status
typedef IUNIVERSAL_DynamicParams UNIVERSAL_DynamicParams

Functions

Int32 UNIVERSAL_control (UNIVERSAL_Handle handle, UNIVERSAL_Cmd id, UNIVERSAL_DynamicParams *params, UNIVERSAL_Status *status)
 Execute the control() method in this instance of a "universal" algorithm.
UNIVERSAL_Handle UNIVERSAL_create (Engine_Handle e, String name, UNIVERSAL_Params *params)
 Create an instance of a universal algorithm.
Void UNIVERSAL_delete (UNIVERSAL_Handle handle)
 Delete the instance of a universal algorithm.
Int32 UNIVERSAL_process (UNIVERSAL_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs, UNIVERSAL_InArgs *inArgs, UNIVERSAL_OutArgs *outArgs)
 Execute the process() method in this instance of a universal algorithm.
XDAS_Int32 UNIVERSAL_processAsync (UNIVERSAL_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs, IUNIVERSAL_InArgs *inArgs, IUNIVERSAL_OutArgs *outArgs)
 Perform asynchronous submission to this instance of a universal algorithm.
XDAS_Int32 UNIVERSAL_processWait (UNIVERSAL_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs, IUNIVERSAL_InArgs *inArgs, IUNIVERSAL_OutArgs *outArgs, UInt timeout)
 Wait for a return message from a previous invocation of UNIVERSAL_processAsync() in this instance of a universal algorithm.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Copyright 2010, Texas Instruments Incorporated