CERuntime.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.
 *
 */
/*
 *  ======== ti/sdo/ce/CERuntime.h ========
 */

#ifndef CERuntime_
#define CERuntime_

#ifdef __cplusplus
extern "C" {
#endif


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


/* Define this symbol so alg table for an engine can be NULL */
#define CE_NULL_algs NULL

/*
 *  ======== CE_DECLARE_TYPE ========
 */
#define CE_DECLARE_TYPE(name, types)         \
                                             \
static String typeTab_##name [] = {          \
    (types),                                 \
    NULL                                     \
};                                           \
                                             \
/*
 *  ======== CE_LOCAL_ALG ========
 */

#define CE_LOCAL_ALG(name, algName, ialgFxns, idma3Fxns, iresFxns, groupId, \
                     memType) \
                                             \
    { (algName),      /* name */             \
      {0},            /* uuid */             \
      (ialgFxns),     /* ialgFxns */         \
      (idma3Fxns),    /* idma3Fxns */        \
      typeTab_##name, /* typeTab */          \
      TRUE,           /* isLocal */          \
      (groupId),      /* groupId */          \
      0,              /* protocol */         \
      (iresFxns),     /* iresFxns */         \
      NULL,           /* stub/skel params */ \
      (memType),      /* cached mem type */  \
      NULL,           /* type - typeTab[0] will be used instead */ \
    },

/*
 *  ======== CE_LOCAL_ALG2 ========
 */
#define CE_LOCAL_ALG2(algName, ialgFxns, idma3Fxns, iresFxns, groupId, \
                     memType, types) \
                                             \
    { (algName),      /* name */             \
      {0},            /* uuid */             \
      (ialgFxns),     /* ialgFxns */         \
      (idma3Fxns),    /* idma3Fxns DEPRECATED */        \
      NULL,           /* typeTab */          \
      TRUE,           /* isLocal */          \
      (groupId),      /* groupId */          \
      0,              /* protocol */         \
      (iresFxns),     /* iresFxns */         \
      NULL,           /* stub/skel params */ \
      (memType),      /* cached mem type */  \
      (types),        /* types */            \
    },

/*
 *  ======== CE_DECLARE_LOCAL_ALG ========
 */
#define CE_DECLARE_LOCAL_ALG(name, algName, ialgFxns, idma3Fxns, iresFxns, \
                     groupId, memType, types) \
static Engine_AlgDesc (name) = \
                                             \
    { (algName),      /* name */             \
      {0},            /* uuid */             \
      (ialgFxns),     /* ialgFxns */         \
      (idma3Fxns),    /* idma3Fxns (DEPRECATED) */        \
      NULL,           /* typeTab */          \
      TRUE,           /* isLocal */          \
      (groupId),      /* groupId */          \
      0,              /* protocol */         \
      (iresFxns),     /* iresFxns */         \
      NULL,           /* stub/skel params */ \
      (memType),      /* cached mem type */  \
      (types),        /* types */            \
    };


/*
 *  ======== CE_BEGIN_ALG_TABLE ========
 */
/*
#define CE_BEGIN_ALG_TABLE(name)        \
static Engine_AlgDesc CE_##name##_algs[] = {
*/

#define ALG_TABLE_NAME_LHS(name) CE_##name

#define ALG_TABLE_RHS(name) name##_algs[]

#define CE_BEGIN_ALG_TABLE(name) \
static Engine_AlgDesc ALG_TABLE_RHS(ALG_TABLE_LHS(name))

/*
 *  ======== CE_END_ALG_TABLE ========
 */
#define CE_END_ALG_TABLE(name) \
    {NULL},                    \
};

/*
 *  ======== CE_ENGINE ========
 */
#define CE_ENGINE(algTab, engName, serverName, memMap, useExtLoader, heapId) \
    { (engName),          /* engine name */                      \
      CE_##algTab##_algs, /* alg table */                        \
      (serverName),       /* optional server name */             \
      NULL,               /* memMap */                           \
      0,                  /* useExtLoader */                     \
      0,                  /* # of algs (filled in at runtime) */ \
      (heapId)            /* heapId */                           \
    },


/*
 *  ======== CE_BEGIN_ENGINE_TABLE ========
 */
#define CE_BEGIN_ENGINE_TABLE(name) \
static Engine_AlgDesc _localAlgs_000[] = {    \
    {NULL},                                   \
};                                            \
                                              \
static Engine_Desc name##_000[] = {

/*
 *  ======== CE_END_ENGINE_TABLE ========
 */
#define CE_END_ENGINE_TABLE(name)             \
    {"local",                                 \
     _localAlgs_000,                          \
     NULL,                                    \
     NULL,                                    \
     0,                                       \
    },                                        \
    {NULL, NULL, NULL, NULL, 0}               \
};                                            \
                                              \
Engine_Config Engine_config = {               \
    name##_000,                               \
    "local"                                   \
};

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


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

#ifdef __cplusplus
}
#endif

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

 */