annotate BootLoader/Inc/tInfoBootloader.h @ 319:d8e86af78474 fix-version

bugfix: correct packed main version number in dive header This fixes a rather mysterious bug. Users report that up to 1.3.5 beta, a correct version number is shown in libdivecomputer based applications (like in Subsurface, in the extra data tab). Careful examining the code in both libdivecomputer and the firmware shows a subtle error in the bit mask and shift operation to pack a full X.Y.Z.beta version number in 2 bytes (as is available in the dive header) in the firmware end (as the libdivecomputer code looks sane, assuming this is the right way to pack things). Likely, this bug crept in in the conversion from the closed source Keil period into the open source GCC setup of the code base. So its impossible to document the exact history of this problem here. Further notice that the main version number is only 1 of 3 version numbers, denoting the full version of the firmware (besides Font and RTE). Finally notice that this way of packing is limited to 2^5 bits (decimal 32), so we could easily build a 1.4.21, but not a 1.4.55. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
author Jan Mulder <jlmulder@xs4all.nl>
date Wed, 19 Jun 2019 14:31:50 +0200
parents 7801c5d8a562
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
1 ///////////////////////////////////////////////////////////////////////////////
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
2 /// -*- coding: UTF-8 -*-
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
3 ///
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
4 /// \file BootLoader/Inc/tInfoBootloader.h
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
5 /// \brief Header file communication with PC
36
7801c5d8a562 Update author name for release
heinrichsweikamp
parents: 30
diff changeset
6 /// \author heinrichs weikamp gmbh
30
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
7 /// \date 08-Aug-2014
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
8 ///
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
9 /// $Id$
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
10 ///////////////////////////////////////////////////////////////////////////////
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
11 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
12 ///
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
13 /// This program is free software: you can redistribute it and/or modify
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
14 /// it under the terms of the GNU General Public License as published by
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
15 /// the Free Software Foundation, either version 3 of the License, or
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
16 /// (at your option) any later version.
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
17 ///
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
18 /// This program is distributed in the hope that it will be useful,
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
19 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
20 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
21 /// GNU General Public License for more details.
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
22 ///
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
23 /// You should have received a copy of the GNU General Public License
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
24 /// along with this program. If not, see <http://www.gnu.org/licenses/>.
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
25 //////////////////////////////////////////////////////////////////////////////
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
26
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
27 /* Define to prevent recursive inclusion -------------------------------------*/
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
28 #ifndef TINFO_BOOTLOADER_H
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
29 #define TINFO_BOOTLOADER_H
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
30
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
31 /* Includes ------------------------------------------------------------------*/
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
32 #include <stdint.h>
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
33
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
34 /* Exported functions --------------------------------------------------------*/
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
35
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
36 void tInfoBootloader_init(void);
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
37 void tInfo_newpage(const char * text);
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
38 void tInfo_write(const char * text);
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
39 void tInfo_button_text(const char *text_left, const char *text_mid, const char *text_right);
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
40
ea1003f63e44 ADD GPL License ...
jDG
parents: 5
diff changeset
41 #endif /* TINFO_BOOTLOADER_H */