--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/HexFile.h	Thu Nov 27 18:40:28 2025 +0100
@@ -0,0 +1,92 @@
+//////////////////////////////////////////////////////////////////////////////
+/// \file   HexFile.h
+/// \brief  Read .hex file in "Intel HEX" format.
+/// \author JD Gascuel.
+///
+/// \copyright (c) 2012-2016, JD Gascuel. All rights reserved.
+/// $Id$
+//////////////////////////////////////////////////////////////////////////////
+//
+// BSD 2-Clause License:
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions
+// are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+//    this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+//    this list of conditions and the following disclaimer in the documentation
+//    and/or other materials provided with the distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+// THE POSSIBILITY OF SUCH DAMAGE.
+//
+//////////////////////////////////////////////////////////////////////////////
+// HISTORY
+//  2012-02-12 : [jDG] Creation for Frog Companion firmware upload.
+//  2012-09-22 : [jDG] Updated for OSTC Companion (OSTC3).
+//  2014-07-07 : [jDG] Cleanups for Subsurface google-summer-of-code.
+//  2014-07-25 : [jDG] BSD 2-clause license.
+
+#include <QtGlobal>
+#include <QFile>
+
+class QProgressBar;
+
+/////////////////////////////////////////////////////////////////////////////
+/// \brief  Read .hex file in "Intel HEX" format.
+///
+/// \note that OSTC3 firmware is NOT distributed in Intel HEX format,
+///       but is first flatened, then encrypted, then written back
+///       in a similar looking format.
+class  HexFile
+{
+    QFile   _file;
+    size_t  _memSize;
+    size_t  _baseAddress;   ///< Base for extended address modes.
+
+    unsigned char* _buffer;
+
+    /// \brief Read and interpret on line of the HEX file.
+    void readLine();
+
+public:
+    /// \brief Create an empty object.
+    HexFile();
+    ~HexFile();
+
+    /// \brief Allocate initialized space.
+    bool allocate(size_t memSize, unsigned char fill = 0xFF);
+    bool sqwiz(size_t newMemSize);
+
+    /// \brief Load the .hex file into the internal buffer.
+    /// \return TRUE is ok, FAlSE if some error occurs.
+    void load(const QString& fileName);
+
+    /// \brief Return a pointer to the loaded data.
+    const unsigned char* data() const;
+
+    /// \brief Returns the 4 bytes checksum of the loaded data.
+    ///
+    /// This is a simple Adler32 checksum: The lower 16bits are the sum of
+    /// all the bytes (modulo 65536). And the second 16bits are the sum of
+    /// the running sum itself (also modulo 65536).
+    unsigned int checksum() const;
+
+    /// \brief Save to encrypted HEX file.
+    void saveEncrypted(const QString& fileName, unsigned char secretKey[16]);
+
+    /// \brief Reload encrypted HEX file.
+    void loadEncrypted(const QString& fileName, unsigned char secretKey[16]);
+};