runtime/plc_common_main.c
author etisserant
Wed, 20 Aug 2008 00:11:40 +0200
changeset 203 cb9901076a21
parent 178 2390b409eb93
permissions -rw-r--r--
Added concepts :
- connector class (for PLC control, debug and flashing abstraction).
- builder class (C toolchain abstraction)

Added features :
- Pyro based connector.
- ctypes loader, load PLC shared object and run it
- ctypes based debugger embryo (not tested)
- gcc builder

Broken:
- Win32 runtime
- Most tests
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
     1
/*
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
     2
 * Prototypes for function provided by arch-specific code (main)
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
     3
 * concatained after this template
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
     4
 ** /
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
     5
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
     6
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
     7
/*
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
     8
 * Functions and variables provied by generated C softPLC
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
     9
 **/ 
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    10
extern int common_ticktime__;
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    11
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    12
/*
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    13
 * Functions and variables provied by plc.c
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    14
 **/ 
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    15
void run(long int tv_sec, long int tv_nsec);
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    16
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    17
#define maxval(a,b) ((a>b)?a:b)
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    18
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    19
#include "iec_types.h"
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    20
/*#include "stdio.h" /* For debug */
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    21
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    22
/*
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    23
 * Functions and variables provied by generated C softPLC
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    24
 **/ 
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    25
void config_run__(int tick);
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    26
void config_init__(void);
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    27
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    28
/*
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    29
 *  Functions and variables to export to generated C softPLC and plugins
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    30
 **/
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    31
 
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    32
IEC_TIME __CURRENT_TIME;
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    33
int __tick = 0;
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    34
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    35
static int init_level = 0;
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    36
static int Debugging = 1;
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    37
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    38
/*
137
187a4e2412e5 Modifying svgui plugin for following new SVGUIEditor version
lbessard
parents: 57
diff changeset
    39
 * Prototypes of functions exported by plugins 
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    40
 **/
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    41
%(calls_prototypes)s
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    42
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    43
/*
137
187a4e2412e5 Modifying svgui plugin for following new SVGUIEditor version
lbessard
parents: 57
diff changeset
    44
 * Retrieve input variables, run PLC and publish output variables 
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    45
 **/
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    46
void __run()
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    47
{
137
187a4e2412e5 Modifying svgui plugin for following new SVGUIEditor version
lbessard
parents: 57
diff changeset
    48
    %(retrieve_calls)s
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    49
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    50
    if(Debugging) __retrieve_debug();
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    51
    
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    52
    config_run__(__tick);
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    53
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    54
    if(Debugging) __publish_debug();
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    55
    
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    56
    %(publish_calls)s
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    57
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    58
    __tick++;
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    59
}
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    60
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    61
/*
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    62
 * Initialize variables according to PLC's defalut values,
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    63
 * and then init plugins with that values  
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    64
 **/
57
3b53f9a509d9 Basic CANOpen master node test compiles and run.
etisserant
parents: 54
diff changeset
    65
int __init(int argc,char **argv)
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    66
{
57
3b53f9a509d9 Basic CANOpen master node test compiles and run.
etisserant
parents: 54
diff changeset
    67
    int res;
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    68
    config_init__();
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    69
    %(init_calls)s
57
3b53f9a509d9 Basic CANOpen master node test compiles and run.
etisserant
parents: 54
diff changeset
    70
    return 0;
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    71
}
54
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    72
/*
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    73
 * Calls plugin cleanup proc.
ff82e7088ec5 Comments...
etisserant
parents: 49
diff changeset
    74
 **/
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    75
void __cleanup()
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    76
{
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    77
    %(cleanup_calls)s
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    78
}
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents:
diff changeset
    79
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    80
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    81
void PLC_GetTime(IEC_TIME *CURRENT_TIME);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    82
void PLC_SetTimer(long long next, long long period);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    83
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    84
#define CALIBRATED -2
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    85
#define NOT_CALIBRATED -1
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    86
static int calibration_count = NOT_CALIBRATED;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    87
static IEC_TIME cal_begin;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    88
static long long Tsync = 0;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    89
static long long FreqCorr = 0;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    90
static int Nticks = 0;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    91
static int  last_tick = 0;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    92
static long long Ttick = 0;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    93
#define mod %%
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    94
/*
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    95
 * Call this on each external sync, 
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    96
 * @param sync_align_ratio 0->100 : align ratio, < 0 : no align, calibrate period 
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    97
 **/
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
    98
void align_tick(int sync_align_ratio)
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
    99
{
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   100
	/*
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   101
	printf("align_tick(%%d)\n", calibrate);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   102
	*/
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   103
	if(sync_align_ratio < 0){ /* Calibration */
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   104
		if(calibration_count == CALIBRATED)
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   105
			/* Re-calibration*/
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   106
			calibration_count = NOT_CALIBRATED;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   107
		if(calibration_count == NOT_CALIBRATED)
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   108
			/* Calibration start, get time*/
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   109
			PLC_GetTime(&cal_begin);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   110
		calibration_count++;
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   111
	}else{ /* do alignment (if possible) */
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   112
		if(calibration_count >= 0){
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   113
			/* End of calibration */
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   114
			/* Get final time */
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   115
			IEC_TIME cal_end;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   116
			PLC_GetTime(&cal_end);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   117
			/*adjust calibration_count*/
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   118
			calibration_count++;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   119
			/* compute mean of Tsync, over calibration period */	
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   120
			Tsync = ((long long)(cal_end.tv_sec - cal_begin.tv_sec) * (long long)1000000000 +
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   121
					(cal_end.tv_nsec - cal_begin.tv_nsec)) / calibration_count;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   122
			if( (Nticks = (Tsync / Ttick)) > 0){
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   123
				FreqCorr = (Tsync mod Ttick); /* to be divided by Nticks */
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   124
			}else{
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   125
				FreqCorr = Tsync - (Ttick mod Tsync);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   126
			}
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   127
			/*
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   128
			printf("Tsync = %%ld\n", Tsync);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   129
			printf("calibration_count = %%d\n", calibration_count);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   130
			printf("Nticks = %%d\n", Nticks);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   131
			*/
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   132
			calibration_count = CALIBRATED;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   133
		}
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   134
		if(calibration_count == CALIBRATED){
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   135
			/* Get Elapsed time since last PLC tick (__CURRENT_TIME) */
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   136
			IEC_TIME now;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   137
			long long elapsed;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   138
			long long Tcorr;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   139
			long long PhaseCorr;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   140
			long long PeriodicTcorr;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   141
			PLC_GetTime(&now);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   142
			elapsed = (now.tv_sec - __CURRENT_TIME.tv_sec) * 1000000000 + now.tv_nsec - __CURRENT_TIME.tv_nsec;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   143
			if(Nticks > 0){
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   144
				PhaseCorr = elapsed - (Ttick + FreqCorr/Nticks)*sync_align_ratio/100; /* to be divided by Nticks */
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   145
				Tcorr = Ttick + (PhaseCorr + FreqCorr) / Nticks;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   146
				if(Nticks < 2){
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   147
					/* When Sync source period is near Tick time */
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   148
					/* PhaseCorr may not be applied to Periodic time given to timer */
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   149
					PeriodicTcorr = Ttick + FreqCorr / Nticks;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   150
				}else{
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   151
					PeriodicTcorr = Tcorr; 
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   152
				}
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   153
			}else if(__tick > last_tick){
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   154
				last_tick = __tick;
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   155
				PhaseCorr = elapsed - (Tsync*sync_align_ratio/100);
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   156
				PeriodicTcorr = Tcorr = Ttick + PhaseCorr + FreqCorr;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   157
			}else{
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   158
				/*PLC did not run meanwhile. Nothing to do*/
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   159
				return;
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   160
			}
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   161
			/* DO ALIGNEMENT */
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   162
			PLC_SetTimer(Tcorr - elapsed, PeriodicTcorr);
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   163
		}
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   164
	}
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 137
diff changeset
   165
}
203
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   166
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   167
int suspendDebug()
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   168
{
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   169
    /* Prevent PLC to enter debug code */
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   170
    Debugging = 0;
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   171
}
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   172
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   173
int resumeDebug()
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   174
{
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   175
    /* Let PLC enter debug code */
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   176
    Debugging = 1;
cb9901076a21 Added concepts :
etisserant
parents: 178
diff changeset
   177
}