diff --git a/CMakeLists.txt b/CMakeLists.txt index d15271c..d2373ad 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -44,6 +44,7 @@ set(OPENFPGALOADER_SOURCE src/anlogic.cpp src/anlogicBitParser.cpp src/anlogicCable.cpp + src/dfuFileParser.cpp src/dirtyJtag.cpp src/efinix.cpp src/efinixHexParser.cpp @@ -80,6 +81,7 @@ set(OPENFPGALOADER_HEADERS src/anlogicBitParser.hpp src/anlogicCable.hpp src/cxxopts.hpp + src/dfuFileParser.hpp src/dirtyJtag.hpp src/efinix.hpp src/efinixHexParser.hpp diff --git a/src/dfuFileParser.cpp b/src/dfuFileParser.cpp new file mode 100644 index 0000000..fae25c5 --- /dev/null +++ b/src/dfuFileParser.cpp @@ -0,0 +1,173 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +/* + * Copyright (c) 2021 Gwenhael Goavec-Merou +*/ + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "display.hpp" +#include "dfuFileParser.hpp" + +using namespace std; + +/* USB Device firmware Upgrade Specification, Revision 1.1 B.1 */ +/* p. 42 */ +static const uint32_t crc32tbl[] = { + 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f, + 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, + 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2, + 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, + 0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, + 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172, + 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c, + 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59, + 0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, + 0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, + 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106, + 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433, + 0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, + 0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, + 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950, + 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65, + 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7, + 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0, + 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, + 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, + 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81, + 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a, + 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84, + 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, + 0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, + 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, + 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e, + 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b, + 0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, + 0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, + 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28, + 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d, + 0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f, + 0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, + 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, + 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777, + 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69, + 0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, + 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, + 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, + 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693, + 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94, + 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d}; + +DFUFileParser::DFUFileParser(const string &filename, bool verbose): + ConfigBitstreamParser(filename, ConfigBitstreamParser::BIN_MODE, verbose), + _bcdDFU(0), _idVendor(0), _idProduct(0), _bcdDevice(0), + _dwCRC(0), _bLength(0) +{} + +void DFUFileParser::displayHeader() +{ + cout << "bitstream header infos" << endl; + for (auto it = _hdr.begin(); it != _hdr.end(); it++) { + cout << (*it).first << ": " << (*it).second << endl; + } +} + +/* USB Device firmware Upgrade Specification, Revision 1.1 B */ +/* p.40-47 */ +int DFUFileParser::parseHeader() +{ + string ucDfuSignature; + /* check size: If file size <= 16 + * no space for suffix and/or bitstream + * */ + if (_file_size <= 16) + return -1; + + /* first check DFU signature : + * must be equal to 'DFU' + */ + ucDfuSignature = _raw_data.substr(_file_size-8, 3); + reverse(ucDfuSignature.begin(), ucDfuSignature.end()); + if (ucDfuSignature != "DFU") { + if (_verbose) + printWarn("Not a DFU file"); + return 0; + } + + _dwCRC = (((uint32_t)_raw_data[_file_size - 4] & 0xff) << 0) | + (((uint32_t)_raw_data[_file_size - 3] & 0xff) << 8) | + (((uint32_t)_raw_data[_file_size - 2] & 0xff) << 16) | + (((uint32_t)_raw_data[_file_size - 1] & 0xff) << 24); + _bLength = _raw_data[_file_size - 5]; + _bcdDFU = (_raw_data[_file_size - 10] << 0) | + (_raw_data[_file_size - 9] << 8); + _idVendor = (_raw_data[_file_size - 12] << 0) | + (_raw_data[_file_size - 11] << 8); + _idProduct = (((uint16_t)_raw_data[_file_size - 14] & 0xff) << 0) | + (((uint16_t)_raw_data[_file_size - 13] & 0xff) << 8); + _bcdDevice = (_raw_data[_file_size - 16] << 0) | + (_raw_data[_file_size - 15] << 8); + + /* yes it's silly but it's simpliest way */ + _hdr = {{"dwCRC", string(11, ' ')}, {"bLength", ""}, + {"ucDfuSignature", string(4, ' ')}, {"bcdDFU", string(7, ' ')}, + {"idVendor", string(7, ' ')}, {"idProduct", string(7, ' ')}, + {"bcdDevice", string(7, ' ')}}; + + snprintf(&_hdr["dwCRC"][0], 11, "0x%08x", _dwCRC); + _hdr["bLength"] = to_string(_bLength); + _hdr["ucDfuSignature"] = ucDfuSignature; + snprintf(&_hdr["bcdDFU"][0], 7, "0x%04x", _bcdDFU); + snprintf(&_hdr["idVendor"][0], 7, "0x%04x", _idVendor); + snprintf(&_hdr["idProduct"][0], 7, "0x%04x", _idProduct); + snprintf(&_hdr["bcdDevice"][0], 7, "0X%04x", _bcdDevice); + + return 1; +} + +int DFUFileParser::parse() +{ + _fd.read((char *)&_raw_data[0], sizeof(char) * _file_size); + if (_fd.gcount() != _file_size) { + printError("Error: fail to read " + _filename); + return EXIT_FAILURE; + } + + int ret = parseHeader(); + if (ret < 0) + return EXIT_FAILURE; + + _bit_data.resize(_file_size - _bLength); + copy(_raw_data.begin(), _raw_data.end() - _bLength, _bit_data.begin()); + + /* If file contains suffix check CRC */ + if (ret != 0) { + /* check if CRC match content */ + uint32_t crc = 0xffffffff; + for (int i = 0; i < _file_size-4; i++) + crc = crc32tbl[(crc ^ (uint8_t)_raw_data[i]) & 0xff] ^ (crc >> 8); + + if (crc != _dwCRC) { + printError("Error: CRC didn't match computed value"); + printf("%08x instead of %08x\n", crc, _dwCRC); + return EXIT_FAILURE; + } + } + + _bit_length = _bit_data.size() * 8; + + return EXIT_SUCCESS; +} diff --git a/src/dfuFileParser.hpp b/src/dfuFileParser.hpp new file mode 100644 index 0000000..1d2fbb1 --- /dev/null +++ b/src/dfuFileParser.hpp @@ -0,0 +1,64 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +/* + * Copyright (c) 2021 Gwenhael Goavec-Merou +*/ + +#ifndef SRC_DFUFILEPARSER_HPP_ +#define SRC_DFUFILEPARSER_HPP_ + +#include + +#include "configBitstreamParser.hpp" + +/*! + * \file dfuFileParser + * \class DFUFileParser + * \brief class used to read a DFU data file + * \author Gwenhael Goavec-Merou + */ +class DFUFileParser: public ConfigBitstreamParser { + public: + /*! + * \brief constructor + * \param[in] filename: raw file to read + */ + DFUFileParser(const std::string &filename, bool verbose); + /*! + * \brief display suffix infos + */ + void displayHeader(); + /*! + * \brief read full content of the file, fill the buffer + * \return EXIT_SUCCESS is file is fully read, EXIT_FAILURE otherwhise + */ + int parse() override; + /*! + * \brief read DFU suffix content of the file, fill _hdr structure + * \return EXIT_SUCCESS if suffix is fully read, EXIT_FAILURE otherwhise + */ + int parseHeader(); + /*! + * \brief return vendor id associated + * \return _idVendor + */ + uint16_t vendorID() {return _idVendor;} + /*! + * \brief return product id associated + * \return _idProduct + */ + uint16_t productID() {return _idProduct;} + + private: + /*! + * \brief information in the suffix file part + */ + uint16_t _bcdDFU; /**< specification number */ + uint16_t _idVendor; /**< device VID */ + uint16_t _idProduct; /**< device PID */ + uint16_t _bcdDevice; /**< release number */ + uint32_t _dwCRC; /**< data CRC */ + uint8_t _bLength; /**< DFU suffix length */ +}; + +#endif // SRC_DFUFILEPARSER_HPP_ +