visa.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.
 * 
 */
/*
 *  ======== visa.h ========
 */
#ifndef ti_sdo_ce_VISA_
#define ti_sdo_ce_VISA_

#include <stddef.h>     /* for size_t */

#include <ti/sdo/ce/node/node.h>
#include <ti/xdais/ialg.h>
#include <ti/sdo/ce/Engine.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef Int VISA_Status;

#define VISA_EOK        0

#define VISA_ERUNTIME   -1

#define VISA_EFAIL     -2

#define VISA_EUNSUPPORTED  -3

#define VISA_ETIMEOUT  -100

#define VISA_FOREVER Engine_FOREVER

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

typedef struct VISA_Obj *VISA_Handle;

typedef struct VISA_MsgHeader {
    NODE_MsgHeader  header;
    Int             cmd;        
    VISA_Status     status;     
} VISA_MsgHeader;

/*
 *  ======== VISA_Msg ========
 */
typedef VISA_MsgHeader *VISA_Msg;

/*
 *  ======== VISA_allocMsg ========
 */
extern VISA_Msg VISA_allocMsg(VISA_Handle visa);

/*
 *  ======== VISA_call ========
 */
extern VISA_Status VISA_call(VISA_Handle visa, VISA_Msg *msg);

/*
 *  ======== VISA_callAsync ========
 */
extern VISA_Status VISA_callAsync(VISA_Handle visa, VISA_Msg *msg);

/*
 *  ======== VISA_wait ========
 */
extern VISA_Status VISA_wait(VISA_Handle visa, VISA_Msg *msg, UInt timeout);

/*
 *  ======== VISA_freeMsg ========
 */
extern Void VISA_freeMsg(VISA_Handle visa, VISA_Msg msg);



/*
 *  ======== VISA_create ========
 */
extern VISA_Handle VISA_create(Engine_Handle engine, String name,
    IALG_Params *params, size_t msgSize, String type);

/*
 *  ======== VISA_delete ========
 */
extern Void VISA_delete(VISA_Handle visa);


/*
 *  ======== VISA_create2 ========
 */
extern VISA_Handle VISA_create2(Engine_Handle engine, String name,
    IALG_Params *params, Int paramsSize, size_t msgSize, String type);


/*
 *  ======== VISA_enter ========
 */
extern Void VISA_enter(VISA_Handle visa);

/*
 *  ======== VISA_exit ========
 */
extern Void VISA_exit(VISA_Handle visa);

/*
 *  ======== VISA_getAlgHandle ========
 */
extern Ptr VISA_getAlgHandle(VISA_Handle visa);

/*
 *  ======== VISA_getAlgorithmHandle ========
 */
extern Ptr VISA_getAlgorithmHandle(VISA_Handle visa);

/*
 *  ======== VISA_getAlgFxns ========
 */
extern IALG_Fxns *VISA_getAlgFxns(VISA_Handle visa);
  /* ingroup */

/*
 *  ======== VISA_getAlgMemRecs ========
 */
extern VISA_Status VISA_getAlgMemRecs(VISA_Handle visa, IALG_MemRec *memTab,
        Int size, Int *numRecs);

/*
 *  ======== VISA_getAlgNumRecs ========
 */
extern VISA_Status VISA_getAlgNumRecs(VISA_Handle visa, Int *numRecs);


/*
 *  ======== VISA_getContext ========
 */
extern Void VISA_getContext(VISA_Handle visa, UInt32 * pContext);

/*
 *  ======== VISA_getCodecClassConfig ========
 */
extern Ptr VISA_getCodecClassConfig(VISA_Handle visa);


/*
 *  ======== VISA_getMaxMsgSize ========
 */
extern UInt VISA_getMaxMsgSize(VISA_Handle visa);

/*
 *  ======== _VISA_init ========
 */
extern Void _VISA_init(Void);

/*
 *  ======== _VISA_exit ========
 */
extern Void _VISA_exit(Void);


/*
 * Semi-internal variable generatd by Settings.xdt - used in the following
 * inline
 */
extern Bool VISA_checked;

/*
 *  ======== VISA_isChecked ========
 */
static inline Bool VISA_isChecked(Void)
{
    return (VISA_checked);
}

/*
 *  ======== VISA_setContext ========
 */
extern Void VISA_setContext(VISA_Handle visa, UInt32 context);

/*
 *  ======== VISA_isLocal ========
 */
extern Bool VISA_isLocal(VISA_Handle visa);

#ifdef __cplusplus
}
#endif

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

 */