Firmware.hpp

Go to the documentation of this file.

#ifndef Firmware_hpp
#define Firmware_hpp

#include <vector>
#include <string>
#include <iostream>

#include <boost/date_time/posix_time/posix_time.hpp>

#include "uhal/log/exception.hpp"

namespace mp7
{
  // Forware declarations
  class Firmware;
  class XilinxBitFile;
}

bool operator== ( const mp7::Firmware& aFirmware1, const mp7::Firmware& aFirmware2 );
bool operator!= ( const mp7::Firmware& aFirmware1, const mp7::Firmware& aFirmware2 );
std::ostream& operator<< ( std::ostream& aStream, const mp7::Firmware& aFirmware );
std::ostream& operator<< ( std::ostream& aStream, const mp7::XilinxBitFile& aBitFile );


namespace mp7
{

  // http://forums.xilinx.com/t5/Spartan-Family-FPGAs/conversion-from-HEX-file-to-bit-for-header-in-multiboot/td-p/161590
  // http://www.xilinx.com/support/documentation/user_guides/ug470_7Series_Config.pdf
  // http://www.xilinx.com/support/documentation/user_guides/ug191.pdf  - Virtex 5


  ExceptionClass ( WrongFileExtension, "File has the wrong file-extension for the class trying to open it" );
  ExceptionClass ( FileNotFound, "File was not found" );
  ExceptionClass ( CorruptedFile, "File was corrupted" );

  class Firmware
  {
      friend std::ostream& ( ::operator<< ) ( std::ostream& aStream, const Firmware& aFirmware );
      friend bool ( ::operator== ) ( const Firmware& aFirmware1, const Firmware& aFirmware2 );
      friend bool ( ::operator!= ) ( const Firmware& aFirmware1, const Firmware& aFirmware2 );
    public:

      Firmware ( const std::string& aFileName );

      virtual ~Firmware( );

      const std::vector<uint8_t>& Bitstream( ) const;

      const std::string& FileName( ) const;

      const bool& isBitSwapped( ) const;

      void BitSwap( );

    protected:
      std::string mFileName;
      std::vector<uint8_t> mBitStream;
      bool mBitSwapped;

    private:
      static const uint8_t mLUT[];

  };

  class XilinxBitStream : public Firmware
  {
    public:

      XilinxBitStream( );


      //         void BPIappend( std::vector<uint32_t>::const_iterator aStart, const std::vector<uint32_t>::const_iterator& aEnd );
      void BigEndianAppend ( std::vector<uint32_t>::const_iterator aStart, const std::vector<uint32_t>::const_iterator& aEnd );


      virtual ~XilinxBitStream( );

    private:

  };

  class XilinxBitFile : public Firmware
  {
      friend std::ostream& ( ::operator<< ) ( std::ostream& aStream, const XilinxBitFile& aBitFile );

    public:

      XilinxBitFile ( const std::string& aFileName );

      virtual ~XilinxBitFile( );

      const std::string& DesignName( ) const;
      const std::string& DeviceName( ) const;
      const boost::posix_time::ptime& TimeStamp( ) const;

      std::string StandardizedFileName() const;

    private:
      void parse ( std::vector<uint8_t>::iterator& aIt, uint16_t& aByteCount, std::string& aString );
      void parse ( std::vector<uint8_t>::iterator& aIt, const char& aExpectedDelimeter, uint16_t& aByteCount, std::string& aString );
      void parse ( std::vector<uint8_t>::iterator& aIt, const char& aExpectedDelimeter, uint16_t& aByteCount, uint32_t& aUint );

      std::string mDesignName;
      std::string mDeviceName;
      boost::posix_time::ptime mTimeStamp;
  };

  class XilinxBinFile : public Firmware
  {
    public:

      XilinxBinFile ( const std::string& aFileName );

      virtual ~XilinxBinFile( );

  };

}
#endif