universal.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2012, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */
/*
 *  ======== universal.h ========
 */

#ifndef ti_sdo_ce_universal_UNIVERSAL_
#define ti_sdo_ce_universal_UNIVERSAL_

#ifdef __cplusplus
extern "C" {
#endif

#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>


#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

typedef VISA_Handle UNIVERSAL_Handle;

typedef struct IUNIVERSAL_Params UNIVERSAL_Params;

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;

#define UNIVERSAL_VISATYPE "ti.sdo.ce.universal.IUNIVERSAL"

extern SKEL_Fxns UNIVERSAL_SKEL;

extern IUNIVERSAL_Fxns UNIVERSAL_STUBS;

typedef struct IUNIVERSAL_CodecClassConfig {
    Bool manageInBufsCache     [ XDM_MAX_IO_BUFFERS ];
    Bool manageInOutBufsCache  [ XDM_MAX_IO_BUFFERS ];
    Bool manageOutBufsCache    [ XDM_MAX_IO_BUFFERS ];
} IUNIVERSAL_CodecClassConfig;


/*
 *  ======== UNIVERSAL_control ========
 */
extern Int32 UNIVERSAL_control(UNIVERSAL_Handle handle,
    UNIVERSAL_Cmd id, UNIVERSAL_DynamicParams *params,
    UNIVERSAL_Status *status);


/*
 *  ======== UNIVERSAL_create ========
 */
extern UNIVERSAL_Handle UNIVERSAL_create(Engine_Handle e, String name,
    UNIVERSAL_Params *params);


/*
 *  ======== UNIVERSAL_delete ========
 */
extern Void UNIVERSAL_delete(UNIVERSAL_Handle handle);


/*
 *  ======== UNIVERSAL_process ========
 */
extern Int32 UNIVERSAL_process(UNIVERSAL_Handle handle,
        XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs,
        UNIVERSAL_InArgs *inArgs, UNIVERSAL_OutArgs *outArgs);

/*
 *  ======== UNIVERSAL_processAsync ========
 */
extern XDAS_Int32 UNIVERSAL_processAsync(UNIVERSAL_Handle handle,
        XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs,
        IUNIVERSAL_InArgs *inArgs, IUNIVERSAL_OutArgs *outArgs);

/*
 *  ======== UNIVERSAL_processWait ========
 */
extern XDAS_Int32 UNIVERSAL_processWait(UNIVERSAL_Handle handle,
        XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, XDM1_BufDesc *inOutBufs,
        IUNIVERSAL_InArgs *inArgs, IUNIVERSAL_OutArgs *outArgs, UInt timeout);

#ifdef __cplusplus
}
#endif

#endif
/*
 *  @(#) ti.sdo.ce.universal; 1, 0, 0,1; 1-17-2012 23:17:43; /db/atree/library/trees/ce/ce-t03/src/ xlibrary

 */