Mercurial > public > ostc4

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 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 */