view Common/Inc/FirmwareData.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 5f11787b4f42
children
line wrap: on
line source

///////////////////////////////////////////////////////////////////////////////
/// -*- coding: UTF-8 -*-
///
/// \file   Common/Inc/FirmwareData.h
/// \brief  Firmware Signature (version, makers, date, etc.)
/// \author Heinrichs Weikamp, jDG
/// \date   2017-12-31
///
/// $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 FIRMWARE_DATA_H
#define FIRMWARE_DATA_H

#include <stdint.h>

/// @brief Firmware Signature
///
/// Contains
typedef struct {
	uint8_t versionFirst;				///< Major version number
	uint8_t versionSecond;				///< Minor version number
	uint8_t versionThird;
	uint8_t versionBeta;
	uint8_t signature[4];
	uint8_t release_year;
	uint8_t release_month;
	uint8_t release_day;
	uint8_t release_sub;
	char release_info[48];
	char magic[4];
} SFirmwareData;

enum FirmwareMagic {
		FIRMWARE_MAGIC_FIRST     = 0x00, ///< type[0]
		FIRMWARE_MAGIC_SECOND    = 0x00, ///< type[1]
		FIRMWARE_MAGIC_FIRMWARE  = 0xEE,
		FIRMWARE_MAGIC_CPU2_RTE  = 0xE2,
		FIRMWARE_MAGIC_FONT      = 0xF0,
		FIRMWARE_MAGIC_END       = 0xFF  ///< type[2]
};

extern const SFirmwareData font_FirmwareData;
extern const SFirmwareData bootloader_FirmwareData;
extern const SFirmwareData firmware_FirmwareData;

extern const SFirmwareData cpu2_FirmwareData;

#endif /* FIRMWARE_DATA_H */