clTcUtilsApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */

#ifndef TC_UTILS_API_H
#define TC_UTILS_API_H

#ifdef __cplusplus
extern "C" {
#endif

#include <clAmsTypes.h>

#define TC_MAX_STR_LENGTH       256

typedef enum ClTcParamTypeE
{
        TC_PARAM_NONE,
        TC_PARAM_STRING,
        TC_PARAM_INT32,
        TC_PARAM_FLOAT
} ClTcParamTypeE;

typedef union ClTcParamValU
{
        ClInt32T        int_val;
        double          flt_val;
        ClCharT         str_val[TC_MAX_STR_LENGTH];
} ClTcParamValU;

typedef struct ClTcParamT 
{
        ClCharT                 name[TC_MAX_STR_LENGTH];
        ClInt32T                id; /* short cut to avoid strcmps */
        ClTcParamTypeE  type;
        ClTcParamValU   value;
} ClTcParamT;

typedef struct ClTcParamListT
{
        ClAmsHAStateT   ha_state;/* unsure if this is needed yet */
        ClInt32T                num_params;
        ClTcParamT              *params;
} ClTcParamListT;


int 
clTcParseConfigFile (
                        ClCharT                 *file_path,
                        ClCharT                 *file_name,
                        ClCharT                 *subsystem_name,
                        ClCharT                 *test_case_name,
                        ClTcParamListT  *param_list );

int 
clTcParseWorkLoad (
                        ClAmsCSIDescriptorT *csi_desc,
                        ClCharT                         *subsystem_name,
                        ClCharT                         *test_case_name,
                        ClTcParamListT          *param_list );

int clTcInitialize ( 
                const ClCharT   *subsystem,
                const ClCharT   *test_name,
                int     (*func_to_register)(ClTcParamListT *param_list) );

void clTcFinalize ( void );


int clTcActivate ( ClAmsCSIDescriptorT *csi_desc, ClAmsHAStateT ha_state );

//
//Function   : clTcDeactivate
//
//Description: Set the tc_run_test_flag to false and frees up resources 
//allocated during activate
//Input      : none
//
//Returns    : none

void clTcDeactivate ( void );


void clTcRun ( void );


void clTcPrintParams ( void );

#ifdef __cplusplus
}
#endif

#endif /* TC_UTILS_API_H */