view Common/Inc/decom.h @ 238:a9d798e8c11f div-fixes-5

cleanup, bugfix: do not mask I2C_SystemStatus with local variable This commit is partly cleanup, and partly possible bugfix. Masking the global I2C_SystemStatus with a local variable is (very) bad practice, but more importantly, dangerous, as other code uses this I2C_SystemStatus to base decisions on. So, this is definitely non-trivial, as it can possibly change the flow of control. This said, its tested and seems to have no negative effects (but also no positive, as I sort of hoped for), so that is why I mark it cleanup as well. Constructs like this shall be heavily documented in the code, when there is a reason to do things like this. Further, remove a 2nd rather useless construct. There is no reason to & 0x03 the output of I2C_SystemStatus. This is the only location in the entire code base where this is done, so, its not only useless but also inconsistent and confusing the true intentions here. Finally, littered to code with todo's that I will take care of in next commits. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
author Jan Mulder <jlmulder@xs4all.nl>
date Mon, 08 Apr 2019 10:16:17 +0200
parents 239aa58b533d
children 1b995079c045
line wrap: on
line source

///////////////////////////////////////////////////////////////////////////////
/// -*- coding: UTF-8 -*-
///
/// \file   Common/Inc/decom.h
/// \brief  This code is used to calculate desat, calculated by RTE and send to Firmware
/// \author Heinrichs Weikamp
/// \date   22-Feb-2016
///
/// $Id$
///////////////////////////////////////////////////////////////////////////////
/// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
///
///     This program is free software: you can redistribute it and/or modify
///     it under the terms of the GNU General Public License as published by
///     the Free Software Foundation, either version 3 of the License, or
///     (at your option) any later version.
///
///     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.
///
///     You should have received a copy of the GNU General Public License
///     along with this program.  If not, see <http://www.gnu.org/licenses/>.
//////////////////////////////////////////////////////////////////////////////

#ifndef DECOM_H
#define DECOM_H

#include "data_central.h"

#	define	WATER_VAPOUR_PRESSURE	(0.0493f) // Schreiner 1971

void decom_get_inert_gases(const float ambient_pressure_bar,const SGas* pGas, float* fraction_nitrogen, float* fraction_helium );
void decom_tissues_exposure(int period_in_seconds, SLifeData* pLifeData);
void decom_tissues_exposure2(int period_in_seconds, SGas* pActualGas, float pressure_ambient_bar, float *tissue_N2_selected_stage, float *tissue_He_selected_stage);
float decom_schreiner_equation(float *initial_inspired_gas_pressure, float *rate_change_insp_gas_pressure, float *interval_time_minutes, const float *gas_time_constant, float *initial_gas_pressure);
void decom_reset_with_1000mbar(SLifeData * pLifeData);
void decom_reset_with_ambientmbar(float ambient, SLifeData * pLifeData);

void decom_tissues_exposure_stage_schreiner(int period_in_seconds, SGas* pGas, float  starting_ambient_pressure_bar, float ending_ambient_pressure_bar,
																		 float* pTissue_nitrogen_bar, float* pTissue_helium_bar);
void decom_CreateGasChangeList(SDiveSettings* pInput, const SLifeData* lifeData);
uint8_t decom_tissue_test_tolerance(float* Tissue_nitrogen_bar, float* Tissue_helium_bar, float GF_value, float depth_in_bar_absolute);
void decom_tissues_desaturation_time(const SLifeData* pLifeData, SLifeData2* pOutput);
void test_decom_CreateGasChangeList(void);

float decom_calc_ppO2(const float ambiant_pressure_bar, const SGas* pGas);
void decom_oxygen_calculate_otu(float* oxygen_otu, float pressure_oxygen_real);
void decom_oxygen_calculate_otu_degrade(float* oxygen_otu, long seconds_since_last_dive);
void decom_oxygen_calculate_cns_degrade(float* oxygen_cns, long seconds_since_last_dive);
void decom_oxygen_calculate_cns(float* oxygen_cns, float pressure_oxygen_real);
void decom_oxygen_calculate_cns_stage_SchreinerStyle(int period_in_seconds, SGas* pGas, float  starting_ambient_pressure_bar, float ending_ambient_pressure_bar, float* oxygen_cns);
void decom_oxygen_calculate_cns_exposure(int period_in_seconds, SGas* pActualGas, float pressure_ambient_bar, float* oxygen_cns);
uint8_t decom_get_actual_deco_stop(SDiveState* pDiveState);

// wird nur in smallCPU verwendet:
int decom_calc_desaturation_time(float* Tissue_nitrogen_bar, float* Tissue_helium_bar, float surface_pressure_bar);

#endif /* DECOM_H */