SRecConverter.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
 
#ifndef IMT_BASE_LIB_SRECCONVERTER_SRECCONVERTER_H
#define IMT_BASE_LIB_SRECCONVERTER_SRECCONVERTER_H
 
#include <array>
#include <Imt.Base.Core.Platform/Nonmovable.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Lib.SRecConverter/DataRecord.h>
#include <string>
#include <vector>
 
namespace imt {
namespace base {
namespace lib {
namespace srecconverter {
 
// AXIVION Next Construct AutosarC++19_03-M2.10.1: Name of main class proviced in namespace is same as namespace.
class SRecConverter final : private ::imt::base::core::platform::Nonmovable {
 
public:
 
    SRecConverter(uint32_t const pageSizeKb, uint32_t const flashSizeKb);
 
    bool convert(std::string const& fileName);
 
    uint8_t getPageCount() const;
 
    std::vector<uint8_t> getPageNumberList() const;
 
    uint32_t getRecordCount() const;
 
    DataRecord const* getDataRecord(uint32_t const recordNr) const;
 
    uint32_t getDataSize() const;
 
private:
 
    // Defines the record types
    enum class RecordType : uint8_t {
        // AXIVION Construct CodingStyle-Naming.Enumerator: Allowed naming, compatibility purposes
        Record_Header = 0,     // S0 -> block header type
        Record_Data_2Byte = 1, // S1 -> data block with 2 address bytes
        Record_Data_3Byte = 2, // S2 -> data block with 3 address bytes
        Record_Data_4Byte = 3, // S3 -> data block with 4 address bytes
        Record_Row_Count = 5,  // S5 -> number of data rows
        Record_End_4Byte = 7,  // S7 -> end of block with 4 address bytes
        Record_End_3Byte = 8,  // S8 -> end of block with 3 address bytes
        Record_End_2Byte = 9,  // S9 -> end of block with 2 address bytes
        Record_Unknown = 99,
        Record_Empty = 100
    };
 
    // Struct
    static uint32_t const MAX_PRG_DATA_LEN {16U};
 
    // AXIVION Next Line AutosarC++19_03-A2.7.3: used for internal (private) only
    struct SingleLineDataRecord {
        // AXIVION Next Line AutosarC++19_03-A2.7.3: used for internal (private) only
        uint32_t m_address; // 4 bytes, address
        // AXIVION Next Line AutosarC++19_03-A2.7.3: used for internal (private) only
        std::array<uint8_t, MAX_PRG_DATA_LEN> m_data; // 16 bytes, array with program data
        // AXIVION Next Line AutosarC++19_03-A2.7.3: used for internal (private) only
        uint16_t m_length; // data length
    };
 
    bool readFileAndFillSingleLinesToList(std::string const& fileName);
 
    bool createSingleLineRecord(std::vector<std::string>& fileSingleLineDataList);
 
    bool createDataRecords(std::vector<SingleLineDataRecord>& singleLineDataRecordList);
 
    void createPageNumberList(uint32_t const pageSizeKb, std::vector<DataRecord>& dataRecordList);
 
    bool isFlashSizeValid() const;
 
    static RecordType getRecordType(std::string const& line);
 
    static void fillProgramData(std::string const& line, uint32_t const length, uint8_t* const pData);
 
    static uint32_t getInt(std::string const& str);
 
    static constexpr uint32_t RECORD_TYPE_INDEX {1U}; // start index
    static constexpr uint32_t RECORD_TYPE_LEN {1U};   // nr of signs
    static constexpr uint32_t DATA_LENGTH_INDEX {RECORD_TYPE_INDEX + RECORD_TYPE_LEN};
    static constexpr uint32_t DATA_LENGTH_LEN {2U};
    static constexpr uint32_t ADDRESS_INDEX {DATA_LENGTH_INDEX + DATA_LENGTH_LEN};
    static constexpr uint32_t ADDRESS_LEN {8U};
    static constexpr uint32_t DATA_INDEX {ADDRESS_INDEX + ADDRESS_LEN};
    static constexpr uint32_t ADDRESS_SIZE {4U};  // byte, 32-Bit address
    static constexpr uint32_t CHECKSUM_SIZE {1U}; // byte, 8-Bit checksum
    static constexpr uint32_t RECORD_SIZE {DataRecord::MAX_RECORD_SIZE};
    static constexpr uint32_t FLASH_START_ADDRESS {0x08000000U};
    static constexpr uint32_t BYTES_PER_KILOBYTE {1024U}; // 1024byte equals 1kByte
 
    uint32_t const m_pageSizeKb;
    uint32_t const m_flashSizeKb;
    std::vector<std::string> m_fileSingleLineDataList;
    std::vector<SingleLineDataRecord> m_singleLineDataRecordList;
    std::vector<DataRecord> m_dataRecordList;
    std::vector<uint8_t> m_pageNumberList;
    // AXIVION Next Codeline AutosarC++19_03-A12.1.3: All data members initialized in custom constructor
    uint32_t m_dataSize;
};
 
} // namespace srecconverter
} // namespace lib
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_LIB_SRECCONVERTER_SRECCONVERTER_H