timer_sfcn_9s12.c

simulink real-time workshop for dragon12 development board from

/*********************************************************************************/
/*                                                                               */
/* Name: timer_sfcn_9S12 -  S-Function which sets up the timer unit according to */
/*                          the settings chosen in the block mask (e.g. IC/OC)   */
/*                                                                               */
/* fw-08-06                                                                      */
/*********************************************************************************/

/*=====================================*
 * Required setup for C MEX S-Function *
 *=====================================*/

#define S_FUNCTION_NAME timer_sfcn_9S12
#define S_FUNCTION_LEVEL 2



 /*========================*
 * General Defines/macros *
 *========================*/

#ifdef MATLAB_MEX_FILE
#define abort_LED(x) return
#else
#include <mc9s12dp256.h>        /* derivative information */
#include "mc_signal.h"			// abort_LED(), blinky(), ...
#endif

 
 /*
 * Need to include simstruc.h for the definition of the SimStruct and
 * its associated macro definitions.
 */
#include "simstruc.h" 

#define TRUE    1
#define FALSE   0


// -------------------------------------------------------------------------------
// Macros to access the S-function parameter values
// -------------------------------------------------------------------------------

#define NUMBER_OF_ARG		2					// Number of s-function input arguments

#define SAMPLE_TIME     (real_T)((mxGetPr(ssGetSFcnParam(S,0)))[0])   // real_T
#define MODE		    (uint_T)((mxGetPr(ssGetSFcnParam(S,1)))[0])   // uint_T

/* timer modes */
#define OC			1
#define IC			2



// ----------------------------------------------------------------------------------------------------
// S-Function methods
// ----------------------------------------------------------------------------------------------------

/* Function: mdlInitializeSizes ===============================================
 * Abstract:
 *   Initialize the sizes array
 */
/* Function: mdlInitializeSizes ===============================================
 *
 */
static void mdlInitializeSizes (SimStruct *S) {

	ssSetNumSFcnParams(S, NUMBER_OF_ARG);										// expected number of parameters
	if (ssGetNumSFcnParams(S) != ssGetSFcnParamsCount(S))  abort_LED(10);		// incorrect number of parameters

	// not tunable during simulation : sampletime (P0), mode (P1)
	ssSetSFcnParamNotTunable(S, 0);
	ssSetSFcnParamNotTunable(S, 1);

	// define nb of i/p or o/p  --  depends on chosen mode
	switch(MODE) {
			
		case IC:
			
			// no input port
		   if(!ssSetNumInputPorts(S, 0))	abort_LED(18);
			
		   // configure output port
		   if(!ssSetNumOutputPorts(S, 1))	abort_LED(18);
		   ssSetOutputPortWidth(S, 0, 1);
		   ssSetOutputPortDataType(S, 0, SS_DOUBLE);	/* output always taken as double  --  fw-08-06 */
		   
		   break;
		   
		case OC:
			
			// no output port
		   if(!ssSetNumOutputPorts(S, 0))	abort_LED(18);
			
		   // configure input port
		   if(!ssSetNumInputPorts(S, 1))	abort_LED(18);
		   ssSetInputPortWidth(S, 0, 1);
		   ssSetInputPortDirectFeedThrough(S, 0, 1);	// direct feedthrough (only executs after update of inputs)
		   ssSetInputPortRequiredContiguous(S, 0, 1);	// ports to be stored contiguously in memory
		   ssSetInputPortDataType(S, 0, SS_DOUBLE);		/* input always taken as double  --  fw-08-06 */
		   
		   break;
	}

	// block sample times etc.
	ssSetNumSampleTimes (S, 1);					// only 'one' sampletime in this S-Function

	ssSetNumContStates (S, 0);					// number of continuous states
	ssSetNumDiscStates (S, 0);					// number of discrete states

	ssSetNumIWork (S, 1);						// number of integer work vector elements (need one for timer count)
	ssSetNumRWork (S, 1);						// number of real work vector elements (need one for IC mode)
	ssSetNumPWork (S, 0);						// number of pointer work vector elements
			
	/* options */
	ssSetOptions(S,
       SS_OPTION_WORKS_WITH_CODE_REUSE |
       SS_OPTION_EXCEPTION_FREE_CODE);
}



/* Function: mdlInitializeSampleTimes =========================================
 *
 */
static void mdlInitializeSampleTimes (SimStruct *S) {

   ssSetSampleTime(S, 0, SAMPLE_TIME);			// this S-Function only has 'one' sampletime -> index '0'
   ssSetOffsetTime(S, 0, 0.0);

}

/* Function: mdlStart =========================================================
 *
 */
#define MDL_START
static void mdlStart(SimStruct *S) {

   #ifndef MATLAB_MEX_FILE

	/* THIS SECTION IS NEVER USED -- USING TLC TO GENERATE TARGET CODE,  fw-08-06 */
	/* THIS SECTION IS NEVER USED -- USING TLC TO GENERATE TARGET CODE,  fw-08-06 */
	/* THIS SECTION IS NEVER USED -- USING TLC TO GENERATE TARGET CODE,  fw-08-06 */

   #else   /* MATLAB_MEX_FILE */
   
real_T      *RWork = ssGetRWork(S);

   /* clear RWork[0] (previous time measurement) */
   RWork[0] = 0;
	
   #endif  /* MATLAB_MEX_FILE */

}


/*
 * mdlOutputs - compute the outputs
 *
 * In this function, you compute the outputs of your S-function
 * block.  The outputs are placed in the y variable.
 */
static void mdlOutputs(SimStruct *S, int_T tid) {

	#ifndef MATLAB_MEX_FILE
			
	/* THIS SECTION IS NEVER USED -- USING TLC TO GENERATE TARGET CODE,  fw-08-06 */
	/* THIS SECTION IS NEVER USED -- USING TLC TO GENERATE TARGET CODE,  fw-08-06 */
	/* THIS SECTION IS NEVER USED -- USING TLC TO GENERATE TARGET CODE,  fw-08-06 */

	#else   /* MATLAB_MEX_FILE */
			
real_T      *RWork = ssGetRWork(S);

	// define nb of i/p or o/p  --  depends on chosen mode
	switch(MODE) {
			
		case IC:
			
			{
			real_T	*pY0      = (real_T *)ssGetOutputPortSignal(S,0);
				
				/* compute time difference */
				RWork[0] = RWork[0] + 1.0;	/* here: a sum... (debug) */
				
				// debug
				mexPrintf("IC timer: %f\n", RWork[0]);
				
				// output value
				pY0[0] = RWork[0];
				
			}
		   
		   break;
		   
		case OC:
			
			{
			real_T	inPutVal = (*(real_T *)ssGetInputPortSignal(S,0));
				
				// debug only
				//mexPrintf("Input value: %f\n", inPutVal);
				
				// display ON/OFF message
				if(inPutVal == 0.0) {
					
					/* inactive */
					mexPrintf("OC timer: inactive\n");
					
				} else {
					
					/* active */
					mexPrintf("OC timer: active\n");
					
				}
				
			}
		   
		   break;
	}

	#endif  /* MATLAB_MEX_FILE */
	
}


/*
 * mdlTerminate - called when the simulation is terminated.
 *
 * In this function, you should perform any actions that are necessary
 * at the termination of a simulation.  For example, if memory was allocated
 * in mdlInitializeConditions, this is the place to free it.
 */
static void mdlTerminate (SimStruct *S)
{
   /* not used here */
}



// the define 'MATLAB_MEX_FILE' has to be specified when recompiling this module to a DLL.
// this is only required if the format of the call-up parameters is modified... (FW-06-01)
#ifdef MATLAB_MEX_FILE
   #include "simulink.c"
#else
# error "Attempt to use timer_sfcn_9S12.c as non-inlined S-function"
#endif