ntv2mcsfile.cpp

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#include "ntv2mcsfile.h"
#include "ntv2bitfile.h"
#include "ajabase/system/debug.h"
#include <iostream>
#include <sys/stat.h>
#include <assert.h>
#include <algorithm>
#if defined (AJALinux) || defined (AJAMac)
    #include <arpa/inet.h>
    #include "string.h"
#endif
#include "ntv2utils.h"
#include <string.h>
#include <fcntl.h>
#if !defined (AJAMac) && !defined (AJALinux) && !defined(AJABareMetal)
    #include <io.h>
#endif
#include <time.h>
using namespace std;



CNTV2MCSfile::CNTV2MCSfile()
{
    Close();    //  Reset everything
}

CNTV2MCSfile::~CNTV2MCSfile()
{
    Close();
}


void CNTV2MCSfile::Close(void)
{
    if (mMCSFileStream.is_open())
        mMCSFileStream.close();
    mFileSize = 0;
    mFileLines.clear();
    mBaseELARLocation = mCurrentLocation = mFileLines.end();
    mCommentString = mMCSInfoString = mCurrentRecord = mBitfileDate = mBitfileTime = mBitfileDesignName = mBitfilePartName = "";
}   


bool CNTV2MCSfile::isReady (void) const
{
    return true;
//  if (mFileLines.size() > 0)
//      return true;
//  else
//      return false;
}

void CNTV2MCSfile::SetLastError (const string & inStr, const bool inAppend)
{
    AJA_sERROR(AJA_DebugUnit_Firmware, inStr);
    if (inAppend)
    {
        if (!mLastError.empty())
            mLastError += "\n";
        mLastError += inStr;
    }
    else
        mLastError = inStr;
}

bool CNTV2MCSfile::Open (const string & inMCSFileName)
{
    Close();
    struct stat fsinfo;
    ::stat(inMCSFileName.c_str(), &fsinfo);
    mFileSize = uint32_t(fsinfo.st_size);
    
    struct tm * fileTimeInfo = localtime(&fsinfo.st_ctime);

    time_t rawGenerationTime;
    time(&rawGenerationTime);
    struct tm * generationTimeInfo = localtime(&rawGenerationTime);
    ostringstream comment;
    comment << "Generation Time: " << asctime(generationTimeInfo) << "  Original MCS Time: " << asctime(fileTimeInfo) << endl;
    mCommentString = comment.str();

    mMCSFileStream.open(inMCSFileName.c_str(), std::ios::in);
    if (mMCSFileStream.fail())
        return false;

    GetFileByteStream();
    GetMCSInfo();

    if (mMCSFileStream.is_open())
        mMCSFileStream.close();
    return true;

}   //  Open


bool CNTV2MCSfile::GetMCSHeaderInfo (const string & inMCSFileName)
{
    Close();
    mMCSFileStream.open(inMCSFileName.c_str(), std::ios::in);
    if (mMCSFileStream.fail())
        return false;

    GetFileByteStream(50);
    GetMCSInfo();
    return true;
}


void CNTV2MCSfile::GetMCSInfo()
{
    uint16_t mainPartitionAddress = 0x0000, mainPartitionOffset = 0x0000;
    UByteSequence mainBitfilePartition;
    GetPartition(mainBitfilePartition, mainPartitionAddress, mainPartitionOffset, false);
    if (mainBitfilePartition.size() > 0)
    {
        CNTV2Bitfile bitfileInfo;
        bitfileInfo.ParseHeaderFromBuffer(&mainBitfilePartition[0], mainBitfilePartition.size());
        mBitfileDate = bitfileInfo.GetDate();
        mBitfileDesignName = bitfileInfo.GetDesignName();
        mBitfilePartName = bitfileInfo.GetPartName();
        mBitfileTime = bitfileInfo.GetTime();
    }
    
    mMCSInfoString = mFileLines[0];
}


string CNTV2MCSfile::GetMCSPackageVersionString (void) const
{
    const size_t pkgNumPos(mMCSInfoString.find("PACKAGE_NUMBER"));
    const size_t datePos(mMCSInfoString.find("DATE"));
    if (pkgNumPos == string::npos  ||  datePos == string::npos)
        return "";
    if (datePos <= pkgNumPos)
        return "";
    return mMCSInfoString.substr(pkgNumPos, datePos - pkgNumPos - 1);
}

string CNTV2MCSfile::GetMCSPackageDateString (void) const
{
    const size_t datePos(mMCSInfoString.find("DATE"));
    if (datePos == string::npos)
        return "";
    return mMCSInfoString.substr(datePos + 5, mMCSInfoString.npos - datePos + 5);
}


bool CNTV2MCSfile::InsertBitFile (const string & inBitFileName, const string & inMCSFileName, const string & inUserMessage)
{
    CNTV2Bitfile    bitfile;
    CNTV2MCSfile    mcsFile;
    ostringstream   oss;
    char iRecord[100];
    uint64_t recordSize = 0;
    UWord baseAddress = 0x0000;
    UWord ExtendedBaseAddress = 0x0000;
    UByte checksum = 0;
    UByte recordType = 0x00;

    if (!Open(inMCSFileName))
    {
        oss << "CNTV2MCSfile::InsertBitFile: mcsFile '" << inMCSFileName << "' not found";
        SetLastError(oss.str());
        return false;
    }

    //Read in the bitfile
    if (!bitfile.Open(inBitFileName))
    {
        oss << "CNTV2MCSfile::InsertBitFile: Bitfile '" << inBitFileName << "' not found";
        SetLastError(oss.str());
        return false;
    }

    const size_t bitfileLength(bitfile.GetFileStreamLength());
    NTV2Buffer bitfileBuffer(bitfileLength + 512);
    if (!bitfileBuffer)
    {
        oss << "CNTV2MCSfile::InsertBitFile: Unable to allocate " << DEC(bitfileLength+512) << "-byte bitfile buffer";
        SetLastError(oss.str());
        return false;
    }

    bitfileBuffer.Fill(0xFFFFFF);
    const size_t    readBytes(bitfile.GetFileByteStream(bitfileBuffer));
    const string    designName(bitfile.GetDesignName());
    if (readBytes != bitfileLength)
    {
        oss << "CNTV2MCSfile::InsertBitFile:  Invalid bitfile length, read " << readBytes << " bytes, expected " << bitfileLength;
        SetLastError(oss.str());
        return false;
    }

    //  First, write out the bitfile, then add the date and comment, and then the mcs file...
    size_t bitfileBufferNdx(0);
    uint64_t bytesLeftToWrite (bitfileLength);
    while (bytesLeftToWrite)
    {
        recordSize = bytesLeftToWrite > 16 ? 16 : bytesLeftToWrite;
        int i = 0;
        int index = 0;
        checksum = 0;

        if (baseAddress == 0x0000)
        {
            //Insert ELAR
            string ELARString(":02000004000000");
            ::snprintf(&ELARString[9],sizeof(ELARString)-9, "%04X", ExtendedBaseAddress);
            for (i = 1;  i < 13;  i++)
                checksum += UByte(ELARString[i]) - 0x30;
            checksum = (~checksum) + 1;
            ::snprintf(&ELARString[13],sizeof(ELARString)-13, "%02X", checksum);
            IRecordOutput(ELARString.c_str());
            ExtendedBaseAddress++;
            checksum = 0;
        }

        iRecord[0] = ':';

        ::snprintf(&iRecord[1],sizeof(iRecord)-1, "%02X", UByte(recordSize));
        checksum += UByte(recordSize);

        UWord addr = baseAddress;
        UByte aa = ((addr >> 8) & 0xff);
        ::snprintf(&iRecord[3],sizeof(iRecord)-3, "%02X", aa);
        checksum += aa;

        aa = ((addr)& 0xff);
        ::snprintf(&iRecord[5],sizeof(iRecord)-5, "%02X", aa);
        checksum += aa;

        ::snprintf(&iRecord[7],sizeof(iRecord)-7, "%02X", recordType);

        index = 9;

        while (i < int(recordSize))
        {
            unsigned char dd = bitfileBuffer.U8(int(bitfileBufferNdx++));
            ::snprintf(&iRecord[index],sizeof(iRecord)-index, "%02X", dd);
            checksum += dd;
            i++;
            index += 2;
            bytesLeftToWrite--;
        }

        baseAddress += 0x0010;
        checksum = (~checksum) + 1;
        ::snprintf(&iRecord[index],sizeof(iRecord)-index, "%02X", checksum);

        IRecordOutput(iRecord);
    }   //  while bytesLeftToWrite > 0

    //Insert the date at the 3rd to last partition in Bank 2
    if (!inUserMessage.empty())
        mCommentString.append(inUserMessage);
    uint32_t commentSize = static_cast<uint32_t>(mCommentString.length());
    bytesLeftToWrite = commentSize;
    //32M - 3*256*1024
    ExtendedBaseAddress = 0x01f4;
    baseAddress = 0x0000;
    uint32_t commentIndex = 0;
    while (bytesLeftToWrite > 0)
    {
        recordSize = bytesLeftToWrite > 16 ? 16 : bytesLeftToWrite;
        int i = 0;
        int index = 0;
        checksum = 0;

        if (ExtendedBaseAddress == 0x01f4)
        {
            //Insert ELAR
            string ELARString(":02000004000000");
            ::snprintf(&ELARString[9],sizeof(ELARString)-9, "%04X", ExtendedBaseAddress);
            for (i = 1;  i < 13;  i++)
                checksum += ELARString[i] - 0x30;
            checksum = (~checksum) + 1;
            ::snprintf(&ELARString[13],sizeof(ELARString)-13, "%02X", checksum);
            IRecordOutput(ELARString.c_str());
            ExtendedBaseAddress++;
            checksum = 0;
        }

        iRecord[0] = ':';

        ::snprintf(&iRecord[1],sizeof(iRecord)-1, "%02X", UByte(recordSize));
        checksum += UByte(recordSize);

        UWord addr = baseAddress;
        UByte aa = ((addr >> 8) & 0xff);
        ::snprintf(&iRecord[3],sizeof(iRecord)-3, "%02X", aa);
        checksum += aa;

        aa = ((addr)& 0xff);
        ::snprintf(&iRecord[5],sizeof(iRecord)-5, "%02X", aa);
        checksum += aa;

        ::snprintf(&iRecord[7],sizeof(iRecord)-7, "%02X", recordType);

        index = 9;
        while (i < int(recordSize))
        {
            unsigned char dd = mCommentString.at(commentIndex);
            ::snprintf(&iRecord[index],sizeof(iRecord)-index, "%02X", dd);
            checksum += dd;
            i++;
            index += 2;
            bytesLeftToWrite--;
            commentIndex++;
        }

        baseAddress += 0x0010;
        checksum = (~checksum) + 1;
        ::snprintf(&iRecord[index],sizeof(iRecord)-index, "%02X", checksum);
        IRecordOutput(iRecord);
    }

    //Finished with bitfile now just read a line and output a line from the mcs file
    //32M offset is assumed to be the start of SOC stuff
    if (!FindExtendedLinearAddressRecord(0x0200))
    {
        SetLastError("FindExtendedLinearAddressRecord failed");
        return false;
    }
    mCurrentLocation = mBaseELARLocation;
    while (mCurrentLocation != mFileLines.end())
    {
        IRecordOutput(mCurrentLocation->c_str());
        mCurrentLocation++;
    }
    return true;
}


void CNTV2MCSfile::IRecordOutput (const char *pIRecord)
{
    //_setmode(_fileno(stdout), _O_U8TEXT);
    ::printf("%s\n", pIRecord);
}


// Get maximum of fileLength bytes worth of configuration stream data in buffer.
// Return value:
//   number of bytes of data copied into buffer. This can be <= bufferLength
//   zero means configuration stream has finished.
//   Return value < 0 indicates error
uint32_t CNTV2MCSfile::GetFileByteStream (uint32_t numberOfLines)
{
    const uint32_t maxNumLines = 2000000;
    string line;

    if (!mMCSFileStream.is_open())
        return 0;

    mMCSFileStream.seekg(0, std::ios::beg);
    if (numberOfLines == 0)
    {
        mFileLines.resize(maxNumLines);
        numberOfLines = maxNumLines;
    }
    else
        mFileLines.resize(numberOfLines+1);

    uint32_t index = 0;
    mMCSFileStream.sync_with_stdio(false);
    while (getline(mMCSFileStream, line) && index < numberOfLines)
    {
        mFileLines[index] = line;
        index++;
    }
    if (numberOfLines < maxNumLines)
        mFileLines[index] = ":00000001FF";
    return mFileSize;

}   //  GetFileByteStream


bool CNTV2MCSfile::FindExtendedLinearAddressRecord (uint16_t address /*= 0x0000*/)
{
    string ELARString(":02000004000000");
    ::snprintf(&ELARString[9],sizeof(ELARString)-9, "%04X", address);
    uint8_t checksum = 0;
    for (int i = 1;  i < 13;  i++)
        checksum += ELARString[i] - 0x30;
    checksum = (~checksum) + 1;
    ::snprintf(&ELARString[13],sizeof(ELARString)-13, "%02X", checksum);

    // Do a search for a match, don't search on the checksum
    string needle(ELARString, 0, 13);
    NTV2StringListIter it = mFileLines.begin();
    mBaseELARLocation = mFileLines.end();
    while (it != mFileLines.end())
    {
        string hay(*it, 0, 13);
        if (needle == hay)
        {
            mBaseELARLocation = it;
            break;
        }
        ++it;
    }
    return mBaseELARLocation != mFileLines.end();
}


bool CNTV2MCSfile::GetCurrentParsedRecord (IntelRecordInfo & recordInfo)
{
    IntelRecordInfo currentRecordInfo;
    bool status = ParseCurrentRecord(currentRecordInfo);
    if (status)
    {
        recordInfo.byteCount = currentRecordInfo.byteCount;
        recordInfo.recordType = currentRecordInfo.recordType;
        recordInfo.linearAddress = currentRecordInfo.linearAddress;
        memcpy(recordInfo.dataBuffer, currentRecordInfo.dataBuffer, 16);
        recordInfo.checkSum = currentRecordInfo.checkSum;
    }
    return status;
}


bool CNTV2MCSfile::ParseCurrentRecord (IntelRecordInfo & recordInfo)
{
    if (mCurrentLocation->size() == 0)
    {
        recordInfo.recordType = IRT_UNKNOWN;
        return false;
    }

    if (!mCurrentLocation[0].compare(":"))
    {
        recordInfo.recordType = IRT_UNKNOWN;
        return false;
    }

    uint32_t rType = 0;
    uint16_t byteCount16 = 0;
    ::sscanf(mCurrentLocation[0].c_str(), ":%02hX%04hX%02X", &byteCount16, &recordInfo.linearAddress, &rType);
    recordInfo.byteCount = uint8_t(byteCount16);
    recordInfo.segmentAddress = 0; //Fix this for the correct base address
    switch (rType)
    {
        default:        recordInfo.recordType = IRT_UNKNOWN;    break;
        case 0x00:      recordInfo.recordType = IRT_DR;         break;
        case 0x01:      recordInfo.recordType = IRT_EOFR;       break;
        case 0x02:      recordInfo.recordType = IRT_ESAR;       break;

        case 0x04:      recordInfo.recordType = IRT_ELAR;
                        ::sscanf(mCurrentLocation[0].c_str(), ":%02hX%04hX%02X%04hX", &byteCount16, &recordInfo.linearAddress, &rType, &recordInfo.linearAddress);
                        recordInfo.byteCount = uint8_t(byteCount16);
                        break;
    }
    return true;
}


uint32_t CNTV2MCSfile::GetPartition (UByteSequence & partitionBuffer, uint16_t baseELARaddress, uint16_t & partitionOffset, bool nextPartition)
{
    if (!isReady())
        return 0;
    IntelRecordInfo recordInfo;

    if (!nextPartition)
    {
        //32M offset is assumed to be the start of SOC stuff
        if (!FindExtendedLinearAddressRecord(baseELARaddress))
            return 0;
        mCurrentLocation = mBaseELARLocation;
    }
    else
    {
        ParseCurrentRecord(recordInfo);
        baseELARaddress = recordInfo.linearAddress;
        mBaseELARLocation = mCurrentLocation;
    }

    uint16_t lastELARAddress = baseELARaddress;
    mCurrentLocation++;
    ParseCurrentRecord(recordInfo);
    if (recordInfo.recordType == IRT_DR)
        partitionOffset = recordInfo.linearAddress;
    while (recordInfo.recordType == IRT_DR)
    {
        string temp(mCurrentLocation[0].c_str());
        for (int i(0);  i < recordInfo.byteCount*2;  i+=2)
        {
            uint32_t c = 0;
            ::sscanf(&mCurrentLocation[0].c_str()[9 + i], "%02X", &c);
            partitionBuffer.push_back(uint8_t(c & 0x000000FF));
        }
        mCurrentLocation++;
        ParseCurrentRecord(recordInfo);
        if (recordInfo.recordType == IRT_DR)
            continue;
        //We need to check if this is another ELAR with the same partition
        if (recordInfo.recordType == IRT_ELAR)
        {
            //if this is part of last packet
            lastELARAddress++;
            if (recordInfo.linearAddress == lastELARAddress)
            {
                mCurrentLocation++;
                ParseCurrentRecord(recordInfo);
                continue;
            }
            return uint32_t(partitionBuffer.size());    //We are at the next partition
        }
        return uint32_t(partitionBuffer.size());
    }
    return uint32_t(partitionBuffer.size());
}