Server.h

Go to the documentation of this file.

/*
 *  Copyright 2013 by Texas Instruments Incorporated.
 *
 */

/*
 * Copyright (c) 2013, 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.
 *
 */
/*
 *  ======== Server.h ========
 *  DSP Server module
 *
 *  APIs for accessing information from remote server.
 */

#ifndef ti_sdo_ce_Server_
#define ti_sdo_ce_Server_

#ifdef __cplusplus
extern "C" {
#endif


#include <ti/sdo/ce/ServerDefs.h>
#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/skel.h>

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


#define Server_MODNAME "ti.sdo.ce.Server"

#define Server_MAXSEGNAMELENGTH 32

typedef enum Server_Status {
    Server_EOK       = 0,      
    Server_ENOSERVER = 1,      
    Server_ENOMEM    = 2,      
    Server_ERUNTIME  = 3,      
    Server_EINVAL    = 4,      
    Server_EWRONGSTATE =5,     
    Server_EINUSE    = 6,      
    Server_ENOTFOUND = 7,      
    Server_EFAIL     = 8,      
    Server_ENOTSUPPORTED = 9   
} Server_Status;

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

    IALG_Fxns   *fxns;

    Ptr         idmaFxns;

    Bool        isLocal;

    Int         groupId;

    Ptr         iresFxns;

    /*
     *  Currently not used.
     *           Codec class configuration data for stub side, if any.  We
     *           generate this structure for both sides, although it is
     *           currently only used in the skeletons.
     */
    Void        *stubsCodecClassConfig;

    Void        *codecClassConfig;

    /*
     *  Currently not used.
     *          Indicates the type of memory the alg's memory requests will
     *          be allocated from.
     *          The alg's memory will be allocated from cached memory, if
     *              memType = Engine_USECACHEDMEM_CACHED,
     *          from non-cached memory, if
     *              memType = Engine_USECACHEDMEM_NONCACHED,
     *          Otherwise, if
     *              memType = Engine_USECACHEDMEM_DEFAULT,
     *          memory allocations will be determined by the value of
     *          ti_sdo_ce_alg_Algorithm_useCache (cached, if TRUE, non-cached,
     *          if FALSE).
     *
     *  @sa  Engine_CachedMemType
     */
    Engine_CachedMemType memType;  
    String      types;

    String      stubFxnsName;

    SKEL_Fxns   *skelFxns;

    Int         priority;

    Int         stackSize;

    /*
     *  Currently not used.
     *          Memory heap for algorithm stack.
     */
    Int         stackSeg;
} Server_AlgDesc;

typedef struct Server_MemStat {
    Char   name[Server_MAXSEGNAMELENGTH + 1]; 
    Uint32 base;           
    Uint32 size;           
    Uint32 used;           
    Uint32 maxBlockLen;    
} Server_MemStat;


/*
 *  ======== Server_addAlg ========
 */
extern Server_Status Server_addAlg(Server_Handle server, String location,
        Server_AlgDesc *pAlgDesc);


/*
 *  ======== Server_connectTrace ========
 */
extern Server_Status Server_connectTrace(Server_Handle server, Int * token);

/*
 *  ======== Server_disconnectTrace ========
 */
extern Server_Status Server_disconnectTrace(Server_Handle server, Int token);

/*
 *  ======== Server_fwriteTrace ========
 */
extern Int Server_fwriteTrace(Server_Handle server, String prefix, FILE *out);

/*
 *  ======== Server_getCpuLoad ========
 */
extern Int Server_getCpuLoad(Server_Handle server);

/*
 *  ======== Server_getMemStat ========
 */
extern Server_Status Server_getMemStat(Server_Handle server, Int segNum,
        Server_MemStat *memStat);

/*
 *  ======== Server_getNumMemSegs ========
 */
extern Server_Status Server_getNumMemSegs(Server_Handle server, Int *numSegs);

/*
 *  ======== Server_init ========
 */
extern Void Server_init(Void);
/*
 *  ======== Server_initAlgDesc ========
 */
extern Void Server_initAlgDesc(Server_AlgDesc *pAlgDesc);

/*
 *  ======== Server_redefineHeap ========
 */
extern Server_Status Server_redefineHeap(Server_Handle server, String name,
        Uint32 base, Uint32 size);

#if 0
/*
 *  ======== Server_removeAlg ========
 */
/*
 *  Currently not implemented.
 *
 *  @brief      Dynamically remove an algorithm that was added to a Server
 *              with Server_addAlg().
 *
 *  @remarks    The same values of the parameters @c name and @c server that
 *              were passed to Server_addAlg() should be used here.  In
 *              particular, if @c name was used to add the alg, all handles to
 *              the engine named @c name must be closed before calling
 *              Server_removeAlg().
 *
 *
 *  @param[in]  name            The name of the engine or NULL, that was
 *                              passed to Server_addAlg(). Set to NULL for now.
 *                              Currently, only the default "local" engine is
 *                              supported.
 *  @param[in]  server          The handle to a server, previously acquired
 *                              by a call to Engine_getServer(), or NULL.
 *                              Set to NULL for now.  In the future, this will
 *                              be used to dynamically remove remote
 *                              algorithms from a server.
 *  @param[in]  algName         Name of the algorithm to remove.
 *
 *  @retval     Server_EOK          Success.
 *  @retval     Server_ENOTFOUND    The server's underlying engine, @c name,
 *                                  does not exist.
 *  @retval     Server_ENOTFOUND    @c algName could not be found in the
 *                                  server's underlying engine table.
 *  @retval     Server_EINUSE       The server's underlying engine, @c name,
 *                                  is still open.
 *
 *  @sa         Server_addAlg()
 */
extern Server_Status Server_removeAlg(String name, Server_Handle server,
        String algName);
#endif

/*
 *  ======== Server_restoreHeap ========
 */
extern Server_Status Server_restoreHeap(Server_Handle server, String name);

/*
 *  ======== Server_setTrace ========
 */
extern Int Server_setTrace(Server_Handle server, String mask);
  /* ingroup */

#ifdef __cplusplus
}
#endif

#endif
/*
 *  @(#) ti.sdo.ce; 1, 0, 6,3; 6-13-2013 00:10:03; /db/atree/library/trees/ce/ce-w08/src/ xlibrary

 */