Server.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2010, 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 <stdio.h>  /* def of FILE * */


#define Server_GTNAME "CS"

#define Server_MAXSEGNAMELENGTH 32


typedef struct Server_Obj *Server_Handle;

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_Status;

typedef struct Server_AlgInfo {
    Int         algInfoSize;    
    String      name;           
    String      *typeTab;       
} Server_AlgInfo;

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

/*
 *  ======== 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_getAlgInfo ========
 *  TODO: Do we need this?
 */
extern Int Server_getAlgInfo(Server_Handle server, Int algNum,
        Server_AlgInfo *algInfo);

/*
 *  ======== 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_getNumAlgs ========
 */
extern Server_Status Server_getNumAlgs(Server_Handle server, Int *numAlgs);

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

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

/*
 *  ======== 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,432; 12-2-2010 21:19:08; /db/atree/library/trees/ce/ce-r11x/src/ xlibrary

 */