annotate Common/Inc/global_constants.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 9fc06e1e0f66
children a6c0375bc950
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
101
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
1 ///////////////////////////////////////////////////////////////////////////////
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
2 /// -*- coding: UTF-8 -*-
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
3 ///
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
4 /// \file Common/Inc/global_constants.h
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
5 /// \brief
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
6 /// \author Dmitry Romanov<kitt@bk.ru>
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
7 /// \date 11.2018
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
8 ///
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
9 /// $Id$
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
10 ///////////////////////////////////////////////////////////////////////////////
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
11 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
12 ///
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
13 /// This program is free software: you can redistribute it and/or modify
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
14 /// it under the terms of the GNU General Public License as published by
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
15 /// the Free Software Foundation, either version 3 of the License, or
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
16 /// (at your option) any later version.
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
17 ///
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
18 /// This program is distributed in the hope that it will be useful,
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
19 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
20 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
21 /// GNU General Public License for more details.
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
22 ///
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
23 /// You should have received a copy of the GNU General Public License
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
24 /// along with this program. If not, see <http://www.gnu.org/licenses/>.
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
25 //////////////////////////////////////////////////////////////////////////////
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
26
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
27 #ifndef GLOBAL_CONSTANTS_H
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
28 #define GLOBAL_CONSTANTS_H
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
29 //Rename it ahead.
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
30 //Buttons section
172
c659fda83e44 Minor: Button defaults, release date adjusted, use SPI_SHOW_SYNC_STATS
heinrichsweikamp
parents: 153
diff changeset
31 #define DEFAULT_BUTTONRESPONSIVENESS_GUI 85
101
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
32 #define MIN_BUTTONRESPONSIVENESS_GUI 30 //50 (-10correction)
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
33 #define MAX_BUTTONRESPONSIVENESS_GUI 110//100 (+10correction)
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
34 #define MIN_BUTTONRESPONSIVENESS MIN_BUTTONRESPONSIVENESS_GUI-20 //MIN_BUTTONRESPONSIVENESS_GUI-20 correction
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
35 #define MAX_BUTTONRESPONSIVENESS MAX_BUTTONRESPONSIVENESS_GUI+20//MIN_BUTTONRESPONSIVENESS_GUI+20correction
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
36 #define BUTTON_DEBOUNCE_DELAY 50 //Delay for debounce filter for piezo buttons
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
37
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
38
153
791cdfad0c8e Added definitions for SPI sequence counter
Ideenmodellierer
parents: 104
diff changeset
39 // Spi sync data debug
172
c659fda83e44 Minor: Button defaults, release date adjusted, use SPI_SHOW_SYNC_STATS
heinrichsweikamp
parents: 153
diff changeset
40 #define SPI_SHOW_SYNC_STATS 0
104
22a1094545f3 Tested and alive.
Dmitry Romanov <kitt@bk.ru>
parents: 103
diff changeset
41 #define SPI_MIN_ERROR_SHOW 10
103
f5d2f02dc73f Generalize TEXT of pressure unit
Dmitry Romanov <kitt@bk.ru>
parents: 101
diff changeset
42
208
9fc06e1e0f66 Update SPI error display and handling
ideenmodellierer
parents: 172
diff changeset
43 /* Define INDEX for information exchanged within the header */
9fc06e1e0f66 Update SPI error display and handling
ideenmodellierer
parents: 172
diff changeset
44 #define SPI_HEADER_INDEX_RX_STATE (1)
9fc06e1e0f66 Update SPI error display and handling
ideenmodellierer
parents: 172
diff changeset
45 #define SPI_HEADER_INDEX_FRAME_CNT (2)
153
791cdfad0c8e Added definitions for SPI sequence counter
Ideenmodellierer
parents: 104
diff changeset
46
208
9fc06e1e0f66 Update SPI error display and handling
ideenmodellierer
parents: 172
diff changeset
47 #define SPI_RX_STATE_OK (0)
9fc06e1e0f66 Update SPI error display and handling
ideenmodellierer
parents: 172
diff changeset
48 #define SPI_RX_STATE_SHIFTED (1)
9fc06e1e0f66 Update SPI error display and handling
ideenmodellierer
parents: 172
diff changeset
49 #define SPI_RX_STATE_OFFLINE (2)
9fc06e1e0f66 Update SPI error display and handling
ideenmodellierer
parents: 172
diff changeset
50 #define SPI_RX_STATE_INVALID (3)
103
f5d2f02dc73f Generalize TEXT of pressure unit
Dmitry Romanov <kitt@bk.ru>
parents: 101
diff changeset
51
f5d2f02dc73f Generalize TEXT of pressure unit
Dmitry Romanov <kitt@bk.ru>
parents: 101
diff changeset
52 //Text data
f5d2f02dc73f Generalize TEXT of pressure unit
Dmitry Romanov <kitt@bk.ru>
parents: 101
diff changeset
53 #define TEXT_PRESSURE_UNIT "hPa"
101
83feba2ad1c3 globals
Dmitry Romanov <kitt@bk.ru>
parents:
diff changeset
54 #endif