Engine.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.
 * 
 */
/*
 *  ======== Engine.h ========
 */

#ifndef Engine_
#define Engine_

#ifdef __cplusplus
extern "C" {
#endif


#include <ti/sdo/ce/Server.h>
#include <ti/sdo/ce/ipc/Comm.h>
#include <ti/xdais/ialg.h>
#include <ti/sdo/ce/node/node.h>

#include <stddef.h> /* def of size_t */
#include <stdio.h>  /* def of FILE * */


#define Engine_MODNAME "ti.sdo.ce.Engine"

typedef struct Engine_Obj *Engine_Handle;

typedef Int Engine_Error;

#define Engine_EOK          0   
#define Engine_EEXIST       1   
#define Engine_ENOMEM       2   
#define Engine_EDSPLOAD     3   
#define Engine_ENOCOMM      4   
#define Engine_ENOSERVER    5   
#define Engine_ECOMALLOC    6   
#define Engine_ERUNTIME     7   
#define Engine_ECODECCREATE 8   
#define Engine_ECODECSTART  9   
#define Engine_EINVAL       10  
#define Engine_EBADSERVER   11  
#define Engine_ENOTAVAIL    12  
#define Engine_EWRONGSTATE  13  
#define Engine_EINUSE       14  
#define Engine_ENOTFOUND    15  
#define Engine_ETIMEOUT     16  
typedef struct Engine_NodeObj *Engine_Node;

#define Engine_FOREVER Comm_FOREVER

typedef struct Engine_Attrs {
    String procId;  
} Engine_Attrs;

typedef struct Engine_AlgInfo {
    Int         algInfoSize;    
    String      name;           
    String      *typeTab;       
    Bool        isLocal;        
} Engine_AlgInfo;

typedef struct Engine_AlgInfo2 {
    Int         algInfoSize;    
    String      name;           
    String      types;          
    Bool        isLocal;        
} Engine_AlgInfo2;

extern Engine_Attrs Engine_ATTRS;    
typedef Int Engine_Ctrl;

#define Engine_CEXIT    0
#define Engine_MAXSEGNAMELENGTH 32

typedef enum Engine_CachedMemType {
    Engine_USECACHEDMEM_DEFAULT = -1,  
    Engine_USECACHEDMEM_NONCACHED = 0, 
    Engine_USECACHEDMEM_CACHED = 1     
} Engine_CachedMemType;


/*
 *  ======== Engine_AlgDesc ========
 */
typedef struct Engine_AlgDesc {
    String      name;

    NODE_Uuid   uuid;   
    IALG_Fxns   *fxns;

    Ptr         idmaFxns;

    String      *typeTab;       
    Bool        isLocal;

    Int         groupId;

    Int         rpcProtocolVersion; 
    Ptr         iresFxns;

    Void        *codecClassConfig;

    Engine_CachedMemType memType;  
    String      types;
} Engine_AlgDesc;


#define Engine_GETALGDESCFXN  "GetEngineAlgDesc"

/*
 *  ======== Engine_DllAlgDesc ========
 *  An alg that will be dynamically loaded must have a descriptor of this type.
 */
typedef struct Engine_DllAlgDesc {
    IALG_Fxns   *fxns;

    Ptr         idmaFxns;

    Ptr         iresFxns;

    String      types;

    Void        *codecClassConfig;
} Engine_DllAlgDesc;


/*
 *  ======== Engine_GetAlgDescFxn ========
 *  A dynamically loaded codec library must supply a function of this type to
 *  get properties of the library's algorithm.
 */
typedef Int (*Engine_GetAlgDescFxn)(Engine_DllAlgDesc *dllAlgDesc);


/*
 *  ======== Engine_Desc ========
 */
typedef struct Engine_Desc {
    String name;            
    Engine_AlgDesc *algTab; 
    String remoteName;      
    String memMap;          
    Bool useExtLoader;      
    Int numAlgs;            
    Int heapId;             
} Engine_Desc;


/*
 *  ======== Engine_AlgCreateAttrs ========
 */
typedef struct Engine_AlgCreateAttrs {
    Bool            useExtHeap; 
    Int             priority;   
} Engine_AlgCreateAttrs;


/*
 *  ======== Engine_Config ========
 */
typedef struct Engine_Config {
    Engine_Desc *engineTab;
    String      localEngine;
} Engine_Config;

/*
 *  ======== Engine_MemStat ========
 *  This structure must match Server_MemStat.
 */
typedef struct Engine_MemStat {
    Char   name[Engine_MAXSEGNAMELENGTH + 1]; /* Name of memory segment */
    Uint32 base;           /* Base address of memory segment */
    Uint32 size;           /* Original size of the memory segment. */
    Uint32 used;           /* Number of bytes used. */
    Uint32 maxBlockLen;    /* Size of the largest contiguous free block. */
} Engine_MemStat;

/* Default alg create attributes */
extern Engine_AlgCreateAttrs Engine_ALGCREATEATTRS;

/*
 *  ======== Engine_config ========
 */
extern Engine_Config Engine_config;

/*
 *  ======== Engine_addStubFxns ========
 */
extern Engine_Error Engine_addStubFxns(String fxnsName, IALG_Fxns *fxns);

/*
 *  ======== Engine_add ========
 */
extern Engine_Error Engine_add(Engine_Desc *pDesc);

/*
 *  ======== Engine_addAlg ========
 */
extern Engine_Error Engine_addAlg(String name, Engine_Handle engine,
        String location, Engine_AlgDesc *pAlgDesc);

/*
 *  ======== Engine_removeAlg ========
 */
extern Engine_Error Engine_removeAlg(String name, Engine_Handle engine,
        String algName);

/*
 *  ======== Engine_call ========
 */
extern Int Engine_call(Engine_Node node, Comm_Msg *msg);

/*
 *  ======== Engine_callAsync ========
 */
extern Int Engine_callAsync(Engine_Node node, Comm_Msg *msg);

/*
 *  ======== Engine_callWait ========
 */
extern Int Engine_callWait(Engine_Node node, Comm_Msg *msg, UInt timeout);

/*
 *  ======== Engine_ctrlNode ========
 */
extern Int Engine_ctrlNode(Engine_Node node, Comm_Msg *msg, Engine_Ctrl code);

/*
 *  ======== Engine_close ========
 */
extern Void Engine_close(Engine_Handle engine);

/*
 *  ======== Engine_createNode ========
 */
extern Engine_Node Engine_createNode(Engine_Handle engine, String name,
    size_t msgSize, IALG_Params *nodeAttrs, Engine_AlgCreateAttrs *attrs);


/*
 *  ======== Engine_createNode2 ========
 */
extern Engine_Node Engine_createNode2(Engine_Handle engine, String name,
    size_t msgSize, IALG_Params *nodeAttrs, Int nodeAttrsSize,
    Engine_AlgCreateAttrs *attrs);


/*
 *  ======== Engine_deleteNode ========
 */
extern Void Engine_deleteNode(Engine_Node node);

/*
 *  ======== Engine_getAlgMemRecs ========
 */
extern Engine_Error Engine_getAlgMemRecs(Engine_Node node, IALG_MemRec *memTab, Int size,
        Int *numRecs);

/*
 *  ======== Engine_getAlgNumRecs ========
 */
extern Engine_Error Engine_getAlgNumRecs(Engine_Node node, Int *numRecs);

/*
 *  ======== Engine_getConstName ========
 */
extern String Engine_getConstName(Engine_Handle engine, String name,
    String type);

/*
 *  ======== Engine_getFxns ========
 */
extern IALG_Fxns *Engine_getFxns(Engine_Handle svr, String name, String type,
        Bool *isLocal, Ptr *idmaFxns, Ptr *iresFxns, Int *groupId,
        Engine_CachedMemType *memType);

/*
 *  ======== Engine_getMemId ========
 */
extern Int Engine_getMemId(Engine_Handle engine);

/*
 *  ======== Engine_getLocalEngine ========
 */
extern Engine_Handle Engine_getLocalEngine(Void);

/*
 *  ======== Engine_getEngine ========
 */
extern Engine_Handle Engine_getEngine(Engine_Node node);

/*
 *  ======== Engine_getMemStat ========
 */
extern Engine_Error Engine_getMemStat(Server_Handle server, Int segNum,
    Engine_MemStat *stat);

/*
 *  ======== Engine_getNumMemSegs ========
 */
extern Engine_Error Engine_getNumMemSegs(Server_Handle server, Int *numSegs);

/*
 *  ======== Engine_getNumEngines ========
 */
extern Int Engine_getNumEngines();

/*
 *  ======== Engine_getProcId ========
 */
extern String Engine_getProcId(Engine_Handle engine);

/*
 *  ======== Engine_hasServer ========
 */
extern Bool Engine_hasServer(Engine_Handle engine);

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


/*
 *  ======== Engine_initAlgDesc ========
 */
extern Void Engine_initAlgDesc(Engine_AlgDesc *pAlgDesc);

/*
 *  ======== Engine_initAttrs ========
 */
extern Void Engine_initAttrs(Engine_Attrs *pAttrs);

/*
 *  ======== Engine_initDesc ========
 */
extern Void Engine_initDesc(Engine_Desc *pDesc);

/*
 *  ======== Engine_getRemoteVisa ========
 */
extern UInt32 Engine_getRemoteVisa(Engine_Node node);

/*
 *  ======== Engine_getCodecClassConfig ========
 */
extern Ptr Engine_getCodecClassConfig(Engine_Handle engine, String name,
    String type);

/*
 *  ======== Engine_getNodeQueues ========
 */
extern Void Engine_getNodeQueues(Engine_Node node, Comm_Id *stdIn, Comm_Handle *stdOut);


/*
 *  ======== Engine_initFromServer ========
 */
extern Engine_Error Engine_initFromServer(Engine_Handle engine);


/*
 *  ======== Engine_redefineHeap ========
 */
extern Engine_Error Engine_redefineHeap(Server_Handle server, String name,
        Uint32 base, Uint32 size);

/*
 *  ======== Engine_releaseTraceToken ========
 */
extern Bool Engine_releaseTraceToken(Server_Handle server);

/*
 *  ======== Engine_requestTraceToken ========
 */
extern Engine_Error Engine_requestTraceToken(Server_Handle server);

/*
 *  ======== Engine_restoreHeap ========
 */
extern Engine_Error Engine_restoreHeap(Server_Handle server, String name);

/*
 *  ======== Engine_open ========
 */
extern Engine_Handle Engine_open(String name, Engine_Attrs *attrs,
        Engine_Error *ec);

/*
 *  ======== Engine_fwriteTrace ========
 */
extern Int Engine_fwriteTrace(Engine_Handle engine, String prefix, FILE *out);

/*
 *  ======== Engine_getAlgInfo ========
 */
extern Engine_Error Engine_getAlgInfo(String name, Engine_AlgInfo *algInfo,
        Int index);

/*
 *  ======== Engine_getAlgInfo2 ========
 */
extern Engine_Error Engine_getAlgInfo2(String name, Engine_Handle engine,
        Engine_AlgInfo2 *algInfo2, Int index);


/*
 *  ======== Engine_getCpuLoad ========
 */
extern Int Engine_getCpuLoad(Engine_Handle engine);

/*
 *  ======== Engine_getDesc ========
 */
extern Engine_Error Engine_getDesc(String name, Engine_Desc *desc);

/*
 *  ======== Engine_getLastError ========
 */
extern Engine_Error Engine_getLastError(Engine_Handle engine);

/*
 *  ======== Engine_getName ========
 */
extern String Engine_getName(Engine_Handle engine);


/*
 *  ======== Engine_getNumAlgs ========
 */
extern Engine_Error Engine_getNumAlgs(String name, Int *numAlgs);

/*
 *  ======== Engine_getNumAlgs2 ========
 */
extern Engine_Error Engine_getNumAlgs2(String name, Engine_Handle engine,
        Int *numAlgs);

/*
 *  ======== Engine_getServer ========
 */
extern Server_Handle Engine_getServer(Engine_Handle engine);


/*
 *  ======== Engine_getUsedMem ========
 */
extern UInt32 Engine_getUsedMem(Engine_Handle engine);


/*
 *  ======== Engine_remove ========
 */
extern Engine_Error Engine_remove(String engineName);


/*
 *  ======== Engine_setDesc ========
 */
extern Engine_Error Engine_setDesc(String name, Engine_Desc *desc);


/*
 *  ======== Engine_setTrace ========
 */
extern Int Engine_setTrace(Engine_Handle engine, String mask);


/*
 *  ======== Engine_getDesc ========
 *  Internal for testing.
 */
extern Engine_Desc *_Engine_getDesc(Int i);


#ifdef __cplusplus
}
#endif

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

 */