Mercurial > public > hwos_code
annotate src/shared_definitions.h @ 608:d866684249bd
work on 2.99 stable
| author | heinrichsweikamp |
|---|---|
| date | Mon, 07 Jan 2019 21:13:43 +0100 |
| parents | ca4556fb60b9 |
| children | c40025d8e750 |
| rev | line source |
|---|---|
| 0 | 1 #ifdef xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| 2 ; | |
| 604 | 3 ; shared_definitions.h REFACTORED VERSION V2.99e |
| 0 | 4 ; |
| 5 ; Declare variables used both in C and ASM code | |
| 6 ; | |
| 7 ; This program is free software: you can redistribute it and/or modify | |
| 8 ; it under the terms of the GNU General Public License as published by | |
| 9 ; the Free Software Foundation, either version 3 of the License, or | |
| 10 ; (at your option) any later version. | |
| 11 ; | |
| 12 ; This program is distributed in the hope that it will be useful, | |
| 13 ; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 ; GNU General Public License for more details. | |
| 16 ; | |
| 17 ; You should have received a copy of the GNU General Public License | |
| 18 ; along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 ; | |
| 604 | 20 ; Copyright (c) 2010, JD Gascuel |
| 0 | 21 ;============================================================================= |
| 22 ; RATIONAL | |
| 23 ; | |
| 24 ; We must enforce good data passing between the C and the ASM parts of code. | |
| 25 ; The previous design used two independant definitions of each variable, | |
| 26 ; one in C, one in ASM. If they did not match, no error was generated, and | |
| 27 ; anything can happend at runtime... | |
| 28 ; | |
| 29 ; The new design use LINKING to ensure the variables defined in C are at the | |
| 30 ; same address when used in ASM code. And it uses a unique declaration file | |
| 31 ; (with suitable macros) to make sure they have the same size in both language. | |
| 32 ; | |
| 33 ; HISTORY | |
| 604 | 34 ; 2011-01-20: [jDG] Creation |
| 0 | 35 ; |
| 36 ; NOTE | |
| 37 ; | |
| 38 ; This file have to obey both ASM and C syntax. The only common directives | |
| 39 ; are #if/#ifdef/#endif and the #define, so they are eavily used to do the | |
| 40 ; trick. | |
| 41 ; | |
| 42 ; BUGS | |
| 43 ;============================================================================= | |
| 44 ; HISTORY | |
| 45 #endif | |
| 46 | |
| 47 #ifdef __18CXX | |
| 582 | 48 //------------------------------------------------------------------------ |
| 604 | 49 // C-Style Declarations: |
| 50 # ifndef TEST_MAIN | |
| 51 # define VAR_UCHAR(n) extern unsigned char n | |
| 52 # define TAB_UCHAR(n,size) extern unsigned char n[size] | |
| 53 # define VAR_UINT(n) extern unsigned short n | |
| 54 # define TAB_UINT(n,size) extern unsigned short n[size] | |
| 55 # else | |
| 56 # define VAR_UCHAR(n) unsigned char n | |
| 57 # define TAB_UCHAR(n,size) unsigned char n[size] | |
| 58 # define VAR_UINT(n) unsigned short n | |
| 59 # define TAB_UINT(n,size) unsigned short n[size] | |
| 60 # endif | |
| 0 | 61 #else |
| 582 | 62 ;------------------------------------------------------------------------- |
| 604 | 63 ; ASM-Style Declarations: |
| 64 #define VAR_UCHAR(n) n res 1 | |
| 65 #define TAB_UCHAR(n,size) n res size | |
| 66 #define VAR_UINT(n) n res 2 | |
| 67 #define TAB_UINT(n,size) n res 2*size | |
| 0 | 68 #endif |
| 69 | |
|
210
7dbc1d780ca5
do not clear char_O_deco_gas in copy_deco_table
heinrichsweikamp
parents:
126
diff
changeset
|
70 |
| 0 | 71 #ifdef xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| 604 | 72 Define Model Dimensions |
| 0 | 73 NUM_COMP is the number of compartiments in the Bühlmann ZH-L16 model, ie 16. |
| 74 NUM_STOPS is the maximum number of stops computed by decoplanning. | |
| 560 | 75 Note that the deepest stop is roughly limited to 3m * NUM_STOPS |
| 0 | 76 (this is assuming all stops up to the surface are used). |
| 77 Note also that if the table overflow, extra stops are ignored, | |
| 78 and not reported in TTS summing. | |
| 79 NUM_GAS is the number of (potentially) active gas considered during | |
| 80 ascent simulation. | |
| 604 | 81 NUM_SP is the number of setpoints |
| 0 | 82 #endif |
| 604 | 83 #define NUM_COMP 0x10 |
| 84 #define NUM_STOPS 0x20 | |
| 85 #define NUM_GAS 5 | |
| 86 #define NUM_SP 5 | |
| 0 | 87 |
| 560 | 88 |
| 89 #ifdef __18CXX | |
| 582 | 90 //---- BANK 3 DATA ------------------------------------------------------- |
| 604 | 91 // Gather all Data C-Code --> ASM-Code |
| 92 // Memory usage: 202 Byte used, 54 Byte free | |
| 560 | 93 # pragma udata overlay bank3=0x300 |
| 94 #else | |
| 604 | 95 ; in ASM, put the same bank, in overlay mode, at the same address |
| 96 bank3 udata_ovr 0x300 | |
| 560 | 97 #endif |
| 98 | |
| 582 | 99 VAR_UINT (int_O_desaturation_time); // time until tissues desaturated to 5% remains, in minutes |
| 100 VAR_UINT (int_O_nofly_time); // altitude / no-fly waiting time time in minutes | |
| 560 | 101 |
| 582 | 102 VAR_UINT (int_O_ascenttime); // time-to-surface (TTS) in minutes |
| 103 VAR_UINT (int_O_alternate_ascenttime); // TTS for the alternative dive plan | |
| 560 | 104 |
| 582 | 105 VAR_UINT (int_O_CNS_fraction); // current CNS% |
| 106 VAR_UINT (int_O_normal_CNS_fraction); // CNS% at end of dive in normal dive plan | |
| 107 VAR_UINT (int_O_alternate_CNS_fraction); // CNS% at end of dive in alternative plan | |
| 560 | 108 |
| 604 | 109 VAR_UINT (int_O_gradient_factor); // current gradient factor in %, 100% = on M-line of straight Buhlmann |
| 110 | |
| 111 VAR_UCHAR (char_O_lead_number); // number of the leading tissue | |
| 560 | 112 |
| 582 | 113 VAR_UCHAR (char_O_nullzeit); // remaining NDL time in minutes |
| 114 VAR_UCHAR (char_O_alternate_nullzeit); // remaining NDL time for the alternative dive plan | |
| 0 | 115 |
| 560 | 116 VAR_UCHAR (char_O_main_status); // setup of the deco engine regarding the real tissue computations |
| 582 | 117 VAR_UCHAR (char_O_deco_status); // setup of the deco engine regarding the decompression computations |
| 604 | 118 VAR_UCHAR (char_O_deco_warnings); // vector of warnings generated by the deco engine |
| 119 VAR_UCHAR (char_O_deco_info); // vector of infos generated by the deco engine | |
| 560 | 120 |
| 582 | 121 VAR_UCHAR (char_O_EAD); // equivalent air depth (EAD) of breathed gas |
| 122 VAR_UCHAR (char_O_END); // equivalent narcosis depth (END) of breathed gas | |
| 560 | 123 |
| 582 | 124 VAR_UCHAR (char_O_first_deco_depth); // depth of first stop (deco or gas change) |
| 125 VAR_UCHAR (char_O_first_deco_time) ; // duration of first stop | |
| 560 | 126 |
| 604 | 127 TAB_UCHAR (char_O_deco_depth, NUM_STOPS); // stops table: depth, ... | ATTENTION: do not re-arrange these |
| 128 TAB_UCHAR (char_O_deco_time, NUM_STOPS); // ... duration, and | three arrays relative | |
| 129 TAB_UCHAR (char_O_deco_gas, NUM_STOPS); // ... gas breathed | to each other! | |
| 560 | 130 |
| 582 | 131 TAB_UCHAR (char_O_deco_time_for_log, NUM_STOPS); // variant of the stops table for logging purpose |
| 0 | 132 |
| 582 | 133 TAB_UCHAR (char_O_tissue_N2_saturation, NUM_COMP); // nitrogen tissue pressures for display purpose |
| 134 TAB_UCHAR (char_O_tissue_He_saturation, NUM_COMP); // helium tissue pressures for display purpose | |
| 560 | 135 |
| 604 | 136 TAB_UINT (int_O_ascent_volumes, NUM_GAS); // gas volumes needed for ascent in liters |
| 137 TAB_UINT (int_O_ascent_pres_need, NUM_GAS); // tank pressures needed for ascent in bar | |
| 0 | 138 |
| 604 | 139 VAR_UINT (int_O_ceiling); // ascent boundary in mbar relative pressure, calculated at GF-high |
| 0 | 140 |
| 582 | 141 VAR_UINT (int_O_O2_ppO2); // ppO2 of pure O2 at current depth |
| 560 | 142 VAR_UINT (int_O_pure_ppO2); // ppO2 of the current gas or dil if breathed pure |
| 582 | 143 VAR_UINT (int_O_pSCR_ppO2); // ppO2 calculated in pSCR loop |
| 560 | 144 VAR_UINT (int_O_breathed_ppO2); // ppO2 actually breathed (= char_O_pure_ppO2 if in OC) |
| 145 | |
| 604 | 146 TAB_UINT (int_O_pressure_need, 2); // pressure reading, need by deco calculations, in 0.1 bar |
| 147 VAR_UINT (int_O_sac_rate); // SAC rate in 0.1 liter/minute | |
| 148 | |
| 0 | 149 |
| 150 #ifdef __18CXX | |
| 582 | 151 //---- BANK 4 DATA ------------------------------------------------------- |
| 604 | 152 // Gather all Data ASM-Code --> C-Code |
| 153 // Memory usage: 86 Byte used, 170 byte free | |
| 0 | 154 # pragma udata overlay bank4=0x400 |
| 155 #else | |
| 604 | 156 ; in ASM, put the same bank, in overlay mode, at the same address |
| 157 bank4 udata_ovr 0x400 | |
| 0 | 158 #endif |
| 159 | |
| 582 | 160 VAR_UINT (int_I_pres_respiration); // absolute pressure breathed |
| 161 VAR_UINT (int_I_pres_surface); // absolute pressure at surface | |
| 560 | 162 |
| 582 | 163 VAR_UCHAR (char_I_current_gas); // number of gas currently breathed (1..5 for configured gases, 6 for the manual gas) |
| 604 | 164 VAR_UCHAR (char_I_current_gas_type); // type of current gas: (0=Disabled), 1=First, 2=Travel/Normal, 3=Deco/- |
| 165 VAR_UCHAR (char_I_He_ratio); // helium ratio of the currently breathed gas | |
| 166 VAR_UCHAR (char_I_O2_ratio); // oxygen ratio of the currently breathed gas | |
| 560 | 167 |
| 582 | 168 VAR_UCHAR (char_I_saturation_multiplier); // safety factor, 100 = no conservatism, 150 = 50% faster saturation |
| 169 VAR_UCHAR (char_I_desaturation_multiplier); // safety factor, 100 = no conservatism, 66 = 50% slower desaturation | |
| 560 | 170 |
| 582 | 171 VAR_UCHAR (char_I_GF_High_percentage); // GF model high value |
| 172 VAR_UCHAR (char_I_GF_Low_percentage); // GF model low value | |
| 560 | 173 |
| 582 | 174 VAR_UCHAR (char_I_deco_distance); // assumed extra depth below required depth for CNS and gas volumes calculations |
| 175 VAR_UCHAR (char_I_depth_last_deco); // depth of the last deco stop in meters | |
| 560 | 176 |
| 582 | 177 VAR_UCHAR (char_I_deco_model); // deco model selection: 0 = ZH-L16, 1 = ZH-L16-GF (with gradient factors) |
| 560 | 178 |
| 582 | 179 VAR_UCHAR (char_I_bottom_depth); // bottom depth, used for gas volume calculations |
| 180 VAR_UCHAR (char_I_bottom_time); // bottom time, used for gas volume calculations | |
| 560 | 181 |
| 582 | 182 VAR_UCHAR (char_I_dive_interval); // duration of surface break before next dive in minutes, used in simulation |
| 183 VAR_UCHAR (char_I_sim_advance_time); // 'fast forward' of dive time, used in simulation (+5 min function) | |
| 604 | 184 VAR_UCHAR (char_I_extra_time); // extra bottom time for fTTs and delayed ascent calculation in minutes |
| 560 | 185 |
| 582 | 186 VAR_UCHAR (char_I_const_ppO2); // ppO2 reported from sensors or by setpoint |
| 0 | 187 |
| 604 | 188 TAB_UCHAR (char_I_setpoint_cbar, NUM_SP); // setpoints in cbar | ATTENTION: do not change the position of these |
| 189 TAB_UCHAR (char_I_setpoint_change,NUM_SP); // change depth for the setpoints in meter | two arrays relative to each other! | |
| 560 | 190 |
| 604 | 191 TAB_UCHAR (char_I_deco_O2_ratio, NUM_GAS); // oxygen ratios of the configured gases, used for deco calc. | ATTENTION: do not change the |
| 192 TAB_UCHAR (char_I_deco_He_ratio, NUM_GAS); // helium ratios of the configured gases, used for deco calc. | position of these | |
| 193 TAB_UCHAR (char_I_deco_gas_type, NUM_GAS); // type of the configured gases, used for deco calc. | arrays relative to | |
| 194 TAB_UCHAR (char_I_deco_gas_change,NUM_GAS); // change depths of the configured gases, used for deco calc. | each other! | |
| 560 | 195 |
| 604 | 196 TAB_UCHAR (char_I_tank_size, NUM_GAS * 2); // tank sizes, used for pressure needs and SAC calculations |
| 197 TAB_UCHAR (char_I_tank_pres_fill, NUM_GAS * 2); // tank fill pressures (in multiples of 10 bar), used to generate warnings | |
| 0 | 198 |
| 582 | 199 VAR_UCHAR (char_I_cc_max_frac_o2); // limiter for maximum O2% in loop |
| 200 VAR_UCHAR (char_I_PSCR_drop); // pSCR parameter drop [%] | |
| 201 VAR_UCHAR (char_I_PSCR_lungratio); // pSCR parameter lung ratio [1/x] | |
| 0 | 202 |
| 582 | 203 VAR_UCHAR (char_I_altitude_wait); // selector for altitude / no-fly waiting time calculation |
| 560 | 204 |
| 582 | 205 VAR_UCHAR (char_I_bottom_usage); // gas consumption during bottom part and initial ascent in liters/minute |
| 206 VAR_UCHAR (char_I_deco_usage); // gas consumption during deco stops and following ascents in liters/minute | |
| 0 | 207 |
| 604 | 208 VAR_UCHAR (char_I_gas6_depth); // change depth (MOD) of the manually configured gas in meters |
| 582 | 209 |
| 210 VAR_UCHAR (char_I_ppO2_max); // warning threshold for maximum ppO2 during working phase of the dive | |
| 211 VAR_UCHAR (char_I_ppO2_max_deco); // warning threshold for maximum ppO2 during deco phase of the dive | |
| 212 VAR_UCHAR (char_I_ppO2_min); // warning threshold for maximum ppO2 when breathing OC | |
| 213 VAR_UCHAR (char_I_ppO2_min_loop); // warning threshold for maximum ppO2 when breathing from CCR or pSCR | |
| 214 | |
| 215 VAR_UCHAR (char_I_ascent_speed); // ascent speed in meters/minute | |
| 216 VAR_UCHAR (char_I_gas_change_time); // extra time spent during a stop for doing a gas change, in minutes | |
| 604 | 217 |
| 218 VAR_UCHAR (char_I_SAC_mode); // SAC calculation mode | |
| 219 VAR_UCHAR (char_I_max_pres_diff); // maximum pressure difference for independent double mode | |
| 220 | |
| 221 TAB_UINT (int_IO_pressure_value,2); // pressure reading, measured pressure, in 0.1 bar | ATTENTION: do not change the position | |
| 222 TAB_UINT (int_I_pressure_drop, 2); // pressure reading, average pressure drop, in 1/160 bar/sec | of these arrays relative to each other! | |
| 223 | |
| 224 TAB_UCHAR (char_I_pressure_gas, 2); // pressure reading, associated gas (1-5) / diluent (6-10), 0 if off | |
| 225 TAB_UCHAR (char_I_pressure_age, 2); // pressure reading, age of data | |
| 226 TAB_UCHAR (char_I_pressure_stat,2); // pressure reading, transmitter status data | |
| 227 | |
| 228 VAR_UCHAR (char_I_backtrack_time); // index (in minutes) of backtrack entries in char_I_backtrack_depth | |
| 229 | |
| 230 | |
| 231 #ifdef __18CXX | |
| 232 //---- BANK 11 DATA ------------------------------------------------------- | |
| 233 // Backtracking Data ASM-Code --> C-Code | |
| 234 // Memory usage: 256 Byte used, 0 byte free | |
| 235 # pragma udata overlay bank11=0xB00 | |
| 236 #else | |
| 237 ; in ASM, put the same bank, in overlay mode, at the same address | |
| 238 bank11 udata_ovr 0xB00 | |
| 239 #endif | |
| 240 | |
| 241 TAB_UCHAR (char_I_backtrack_depth, 0x100); // recorded depths for backtracking in cave mode |