sfcn_bridge.h

simulink real-time workshop for dragon12 development board from

/*
 * Copyright 1994-2002 The MathWorks, Inc.
 *
 * File: sfcn_bridge.h     $Revision: 1.2 $
 *
 * Abstract:
 *   This file helps support a bridge between non-inlined S-functions
 *   and the rtModel. When we did not have the notion of an rtModel,
 *   non-inlined S-functions obtained model data by directly accessing
 *   the model's SimStruct. With the introduction of the rtModel, 
 *   this direct access is no longer possible. Therefore, we need to 
 *   redefine some of the macros inside simstruc.h to instead access
 *   fields of the rtModel. 
 */

#ifndef __SFCN_BRIDGE_H__
#define __SFCN_BRIDGE_H__

typedef struct {
    const char_T  **errorStatusPtr;
    
    int           *numRootSampTimesPtr;
    
    time_T        **tPtrPtr;
    time_T        *tStartPtr;
    time_T        *tFinalPtr;
    time_T        *tOfLastOutputPtr;
    time_T        *stepSizePtr;
    boolean_T     *stopRequestedPtr;
    boolean_T     *derivCacheNeedsResetPtr;
    boolean_T     *zcCacheNeedsResetPtr;
    boolean_T     *blkStateChangePtr;

    int_T         **sampleHitsPtr;
    int_T         **perTaskSampleHitsPtr;

    SS_SimMode    *simModePtr;
    
    RTWSolverInfo **siPtr;
} RTWSfcnInfo;

/* Get a type-cast sfcn info from the SimStruct */
#define _RTSS(S) ((RTWSfcnInfo *) ssGetRTWSfcnInfo(S))

/* Set/Get fields of the sfcn info */
#define rtssSetErrorStatusPtr(sfi,p) (sfi)->errorStatusPtr = (p)

#define rtssSetNumRootSampTimesPtr(sfi,p) (sfi)->numRootSampTimesPtr = (p)

#define rtssSetTPtrPtr(sfi,p)        (sfi)->tPtrPtr = (p)
#define rtssSetTStartPtr(sfi,p)      (sfi)->tStartPtr = (p)
#define rtssSetTFinalPtr(sfi,p)      (sfi)->tFinalPtr = (p)
#define rtssSetTimeOfLastOutputPtr(sfi,p) (sfi)->tOfLastOutputPtr = (p)
#define rtssSetStepSizePtr(sfi,p)    (sfi)->stepSizePtr = (p)
#define rtssSetStopRequestedPtr(sfi,p) (sfi)->stopRequestedPtr = (p)
#define rtssSetDerivCacheNeedsResetPtr(sfi,p) \
     (sfi)->derivCacheNeedsResetPtr = (p)
#define rtssSetZCCacheNeedsResetPtr(sfi,p) \
     (sfi)->zcCacheNeedsResetPtr = (p)
#define rtssSetBlkStateChangePtr(sfi,p) \
     (sfi)->blkStateChangePtr = (p)
#define rtssSetSampleHitsPtr(sfi,p) (sfi)->sampleHitsPtr = (p)
#define rtssSetPerTaskSampleHitsPtr(sfi,p) (sfi)->perTaskSampleHitsPtr = (p)

#define rtssSetSimModePtr(sfi,p)      (sfi)->simModePtr = (p)

#define rtssSetSolverInfoPtr(sfi,p)  (sfi)->siPtr = (p)

/* Error status defines */
#undef ssSetErrorStatus
#define ssSetErrorStatus(S,e) *(_RTSS(S)->errorStatusPtr) = (e)

#undef ssGetErrorStatus
#define ssGetErrorStatus(S)   *(_RTSS(S)->errorStatusPtr)

#undef ssGetNumRootSampleTimes
#define ssGetNumRootSampleTimes(S) *(_RTSS(S)->numRootSampTimesPtr)

/* Timing defines */
#undef ssGetTPtr
#define ssGetTPtr(S) *(_RTSS(S)->tPtrPtr)

#undef ssGetT
#define ssGetT(S) *(_RTSS(S)->tPtrPtr)[0]

#undef ssGetTStart
#define ssGetTStart(S) *(_RTSS(S)->tStartPtr)

#undef ssGetTFinal
#define ssGetTFinal(S) *(_RTSS(S)->tFinalPtr)

#undef ssGetTimeOfLastOutput
#define ssGetTimeOfLastOutput(S) *(_RTSS(S)->tFinalPtr)

#undef ssGetStepSize
#define ssGetStepSize(S) *(_RTSS(S)->stepSizePtr)

#undef ssSetStopRequested
#define ssSetStopRequested(S,v) *(_RTSS(S)->stopRequestedPtr) = (v)

#undef ssGetStopRequested
#define ssGetStopRequested(S) *(_RTSS(S)->stopRequestedPtr)

#undef ssSetDerivCacheNeedsReset
#define ssSetDerivCacheNeedsReset(S,v) \
     *(_RTSS(S)->derivCacheNeedsResetPtr) = (v)

#undef ssGetDerivCacheNeedsReset
#define ssGetDerivCacheNeedsReset(S) \
     *(_RTSS(S)->derivCacheNeedsResetPtr)

#undef ssSetZCCacheNeedsReset
#define ssSetZCCacheNeedsReset(S,v) \
     *(_RTSS(S)->zcCacheNeedsResetPtr) = (v)

#undef ssGetZCCacheNeedsReset
#define ssGetZCCacheNeedsReset(S) \
     *(_RTSS(S)->zcCacheNeedsResetPtr)

#undef ssSetBlkStateChange
#define ssSetBlkStateChange(S) *(_RTSS(S)->blkStateChangePtr) = true

#undef ssGetBlkStateChange
#define ssGetBlkStateChange(S) *(_RTSS(S)->blkStateChangePtr)

#undef ssGetSampleHitPtr
#define ssGetSampleHitPtr(S) *(_RTSS(S)->sampleHitsPtr)

#undef ssGetPerTaskSampleHitsPtr
#define ssGetPerTaskSampleHitsPtr(S) *(_RTSS(S)->perTaskSampleHitsPtr)
           
#undef ssGetSimMode
#define ssGetSimMode(S) *(_RTSS(S)->simModePtr)

/* Solver-related defines */
#undef ssGetSolverName
#define ssGetSolverName(S) \
   rtsiGetSolverName(*(_RTSS(S)->siPtr))

#undef ssIsVariableStepSolver
#define ssIsVariableStepSolver(S) \
   rtsiIsVariableStepSolver(*(_RTSS(S)->siPtr))

#undef ssSetSolverNeedsReset
#define ssSetSolverNeedsReset(S) \
   rtsiSetSolverNeedsReset(*(_RTSS(S)->siPtr), true)

#undef ssGetSolverNeedsReset
#define ssGetSolverNeedsReset(S) \
   rtsiGetSolverNeedsReset(*(_RTSS(S)->siPtr))

#undef ssGetSolverMode
#define ssGetSolverMode(S) \
   rtsiGetSolverMode(*(_RTSS(S)->siPtr))

#undef ssGetSolverMode
#define ssGetSolverMode(S) \
   rtsiGetSolverMode(*(_RTSS(S)->siPtr))

#undef ssGetSolverStopTime
#define ssGetSolverStopTime(S) \
   rtsiGetSolverStopTime(*(_RTSS(S)->siPtr))

#undef ssGetMinStepSize
#define ssGetMinStepSize(S) \
   rtsiGetMinStepSize(*(_RTSS(S)->siPtr))

#undef ssGetMaxStepSize
#define ssGetMaxStepSize(S) \
   rtsiGetMaxStepSize(*(_RTSS(S)->siPtr))

#undef ssGetFixedStepSize
#define ssGetFixedStepSize(S) \
   rtsiGetFixedStepSize(*(_RTSS(S)->siPtr))

#undef ssGetMaxNumMinSteps
#define ssGetMaxNumMinSteps(S) \
   rtsiGetMaxNumMinSteps(*(_RTSS(S)->siPtr))

#undef ssGetSolverRefineFactor
#define ssGetSolverRefineFactor(S) \
   rtsiGetSolverRefineFactor(*(_RTSS(S)->siPtr))

#undef ssGetSolverRelTol
#define ssGetSolverRelTol(S) \
   rtsiGetSolverRelTol(*(_RTSS(S)->siPtr))

#undef ssGetSolverAbsTol
#define ssGetSolverAbsTol(S) \
   rtsiGetSolverAbsTol(*(_RTSS(S)->siPtr))

#undef ssGetSolverMaxOrder
#define ssGetSolverMaxOrder(S) \
   rtsiGetSolverMaxOrder(*(_RTSS(S)->siPtr))

#undef ssGetSimTimeStep
#define ssGetSimTimeStep(S) \
   rtsiGetSimTimeStep(*(_RTSS(S)->siPtr))

#undef ssIsMinorTimeStep
#define ssIsMinorTimeStep(S) \
   (ssGetSimTimeStep(S) == MINOR_TIME_STEP)

#undef ssIsMajorTimeStep
#define ssIsMajorTimeStep(S) \
   (ssGetSimTimeStep(S) == MAJOR_TIME_STEP)

#undef ssGetTaskTime
#define ssGetTaskTime(S,sti) \
          (ssGetTPtr(S))[ssGetSampleTimeTaskID(S,sti)]

#endif /* __SFCN_BRIDGE_H__ */

/* [EOF] sfcn_bridge.h */