AJA NTV2 SDK  18.1.0.2262
NTV2 SDK 18.1.0.2262
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
CNTV2KonaFlashProgram Class Reference

#include <ntv2konaflashprogram.h>

Collaboration diagram for CNTV2KonaFlashProgram:
[legend]

Public Member Functions

 CNTV2KonaFlashProgram (CNTV2Card &card)
 
virtual ~CNTV2KonaFlashProgram ()
 
virtual bool SetBoard (uint32_t index=0)
 
virtual CNTV2Card & device (void) const
 
bool ReadHeader (FlashBlockID flashBlock)
 
bool SetBitFile (const std::string &inBitfileName, std::ostream &outMsgs, const FlashBlockID blockNumber=AUTO_FLASHBLOCK)
 
std::string Program (bool fullVerify=(0))
 
bool ProgramCustom (const std::string &sCustomFileName, const uint32_t addr, std::ostream &outMsgs)
 
bool ProgramKonaxMB (const std::string &sCustomFileName, const uint32_t addr, std::ostream &outMsgs)
 
bool EraseBlock (FlashBlockID blockNumber)
 
bool EraseChip (UWord chip=0)
 
bool CreateSRecord (bool bChangeEndian)
 
bool CreateEDIDIntelRecord ()
 
void SetQuietMode ()
 
bool VerifyFlash (FlashBlockID flashBlockNumber, bool fullVerify=(0))
 
bool ReadFlash (NTV2Buffer &outBuffer, const FlashBlockID flashID, CNTV2FlashProgress &inFlashProgress=CNTV2FlashProgress::nullUpdater)
 
bool SetBankSelect (BankSelect bankNumber)
 
bool SetFlashBlockIDBank (FlashBlockID blockID)
 
bool ROMHasBankSelect ()
 
uint32_t ReadBankSelect ()
 
bool IsInstalledFWRunning (bool &outIsRunning, std::ostream &outErrorMsgs)
 
bool WriteCommand (_FLASH_COMMAND inCommand)
 
std::string GetDesignName (void) const
 
std::string GetPartName (void) const
 
std::string GetDate (void) const
 
std::string GetTime (void) const
 
const NTV2BitfileHeaderParser & Parser (void) const
 
uint32_t GetNumBytes (void) const
 
bool CreateBankRecord (BankSelect bankID)
 
bool ProgramMACAddresses (MacAddr *mac1, MacAddr *mac2)
 
bool ReadMACAddresses (MacAddr &mac1, MacAddr &mac2)
 
bool ProgramLicenseInfo (const std::string &licenseString)
 
bool ReadLicenseInfo (std::string &licenseString)
 
void DisplayData (const uint32_t address, const uint32_t len)
 
bool ProgramInfoFromString (std::string infoString)
 
bool FullProgram (std::vector< uint8_t > &dataBuffer)
 
bool WaitForFlashNOTBusy ()
 
bool ProgramFlashValue (uint32_t address, uint32_t value)
 
bool FastProgramFlash256 (uint32_t address, uint32_t *buffer)
 
bool EraseSector (uint32_t sectorAddress)
 
bool CheckFlashErasedWithBlockID (FlashBlockID flashBlockNumber)
 
uint32_t ReadDeviceID ()
 
bool SetDeviceProperties ()
 
void DetermineFlashTypeAndBlockNumberFromFileName (const std::string &bitFileName)
 
uint32_t GetSectorAddressForSector (FlashBlockID flashBlockNumber, uint32_t sectorNumber)
 
uint32_t GetBaseAddressForProgramming (FlashBlockID flashBlockNumber)
 
uint32_t GetNumberOfSectors (FlashBlockID flashBlockNumber)
 
bool SetWarmBootFirmwareReload (bool enable)
 

Static Public Member Functions

static std::string FlashBlockIDToString (const FlashBlockID inID, const bool inShortDisplay=(0))
 

Protected Attributes

CNTV2Card & _card
 
NTV2Buffer _bitFileBuffer
 
uint8_t * _customFileBuffer
 
uint32_t _bitFileSize
 
NTV2BitfileHeaderParser _parser
 
std::string _bitFileName
 
std::string _mcsInfo
 
uint32_t _spiDeviceID
 
uint32_t _flashSize
 
uint32_t _bankSize
 
uint32_t _sectorSize
 
uint32_t _mainOffset
 
uint32_t _failSafeOffset
 
uint32_t _macOffset
 
uint32_t _mcsInfoOffset
 
uint32_t _licenseOffset
 
uint32_t _soc1Offset
 
uint32_t _soc2Offset
 
uint32_t _numSectorsMain
 
uint32_t _numSectorsSOC1
 
uint32_t _numSectorsSOC2
 
uint32_t _numSectorsFailSafe
 
uint32_t _numBytes
 
FlashBlockID _flashID
 
uint32_t _deviceID
 
bool _bQuiet
 
std::vector< uint8_t > _partitionBuffer
 
uint32_t _failSafePadding
 
CNTV2SpiFlash * _spiFlash
 
bool _hasExtendedCommandSupport
 

Detailed Description

Definition at line 45 of file ntv2konaflashprogram.h.

Constructor & Destructor Documentation

◆ CNTV2KonaFlashProgram()

CNTV2KonaFlashProgram::CNTV2KonaFlashProgram ( CNTV2Card &  card)

Definition at line 70 of file ntv2konaflashprogram.cpp.

◆ ~CNTV2KonaFlashProgram()

CNTV2KonaFlashProgram::~CNTV2KonaFlashProgram ( )
virtual

Definition at line 99 of file ntv2konaflashprogram.cpp.

Member Function Documentation

◆ CheckFlashErasedWithBlockID()

bool CNTV2KonaFlashProgram::CheckFlashErasedWithBlockID ( FlashBlockID  flashBlockNumber)

Definition at line 845 of file ntv2konaflashprogram.cpp.

◆ CreateBankRecord()

bool CNTV2KonaFlashProgram::CreateBankRecord ( BankSelect  bankID)

Definition at line 980 of file ntv2konaflashprogram.cpp.

◆ CreateEDIDIntelRecord()

bool CNTV2KonaFlashProgram::CreateEDIDIntelRecord ( )

Definition at line 1068 of file ntv2konaflashprogram.cpp.

◆ CreateSRecord()

bool CNTV2KonaFlashProgram::CreateSRecord ( bool  bChangeEndian)

Definition at line 880 of file ntv2konaflashprogram.cpp.

◆ DetermineFlashTypeAndBlockNumberFromFileName()

void CNTV2KonaFlashProgram::DetermineFlashTypeAndBlockNumberFromFileName ( const std::string &  bitFileName)

Definition at line 446 of file ntv2konaflashprogram.cpp.

◆ device()

virtual CNTV2Card& CNTV2KonaFlashProgram::device ( void  ) const
inlinevirtual

Definition at line 54 of file ntv2konaflashprogram.h.

◆ DisplayData()

void CNTV2KonaFlashProgram::DisplayData ( const uint32_t  address,
const uint32_t  len 
)

Definition at line 2228 of file ntv2konaflashprogram.cpp.

◆ EraseBlock()

bool CNTV2KonaFlashProgram::EraseBlock ( FlashBlockID  blockNumber)

Definition at line 625 of file ntv2konaflashprogram.cpp.

◆ EraseChip()

bool CNTV2KonaFlashProgram::EraseChip ( UWord  chip = 0)

Definition at line 682 of file ntv2konaflashprogram.cpp.

◆ EraseSector()

bool CNTV2KonaFlashProgram::EraseSector ( uint32_t  sectorAddress)

Definition at line 673 of file ntv2konaflashprogram.cpp.

◆ FastProgramFlash256()

bool CNTV2KonaFlashProgram::FastProgramFlash256 ( uint32_t  address,
uint32_t *  buffer 
)

Definition at line 598 of file ntv2konaflashprogram.cpp.

◆ FlashBlockIDToString()

string CNTV2KonaFlashProgram::FlashBlockIDToString ( const FlashBlockID  inID,
const bool  inShortDisplay = (0) 
)
static

Definition at line 53 of file ntv2konaflashprogram.cpp.

◆ FullProgram()

bool CNTV2KonaFlashProgram::FullProgram ( std::vector< uint8_t > &  dataBuffer)

Definition at line 2266 of file ntv2konaflashprogram.cpp.

◆ GetBaseAddressForProgramming()

uint32_t CNTV2KonaFlashProgram::GetBaseAddressForProgramming ( FlashBlockID  flashBlockNumber)
inline

Definition at line 104 of file ntv2konaflashprogram.h.

◆ GetDate()

std::string CNTV2KonaFlashProgram::GetDate ( void  ) const
inline

Definition at line 76 of file ntv2konaflashprogram.h.

◆ GetDesignName()

std::string CNTV2KonaFlashProgram::GetDesignName ( void  ) const
inline

Definition at line 74 of file ntv2konaflashprogram.h.

◆ GetNumberOfSectors()

uint32_t CNTV2KonaFlashProgram::GetNumberOfSectors ( FlashBlockID  flashBlockNumber)
inline

Definition at line 120 of file ntv2konaflashprogram.h.

◆ GetNumBytes()

uint32_t CNTV2KonaFlashProgram::GetNumBytes ( void  ) const
inline

Definition at line 79 of file ntv2konaflashprogram.h.

◆ GetPartName()

std::string CNTV2KonaFlashProgram::GetPartName ( void  ) const
inline

Definition at line 75 of file ntv2konaflashprogram.h.

◆ GetSectorAddressForSector()

uint32_t CNTV2KonaFlashProgram::GetSectorAddressForSector ( FlashBlockID  flashBlockNumber,
uint32_t  sectorNumber 
)
inline

Definition at line 99 of file ntv2konaflashprogram.h.

◆ GetTime()

std::string CNTV2KonaFlashProgram::GetTime ( void  ) const
inline

Definition at line 77 of file ntv2konaflashprogram.h.

◆ IsInstalledFWRunning()

bool CNTV2KonaFlashProgram::IsInstalledFWRunning ( bool &  outIsRunning,
std::ostream &  outErrorMsgs 
)

Definition at line 139 of file ntv2konaflashprogram.cpp.

◆ Parser()

const NTV2BitfileHeaderParser& CNTV2KonaFlashProgram::Parser ( void  ) const
inline

Definition at line 78 of file ntv2konaflashprogram.h.

◆ Program()

string CNTV2KonaFlashProgram::Program ( bool  fullVerify = (0))

Definition at line 517 of file ntv2konaflashprogram.cpp.

◆ ProgramCustom()

bool CNTV2KonaFlashProgram::ProgramCustom ( const std::string &  sCustomFileName,
const uint32_t  addr,
std::ostream &  outMsgs 
)

Definition at line 1958 of file ntv2konaflashprogram.cpp.

◆ ProgramFlashValue()

bool CNTV2KonaFlashProgram::ProgramFlashValue ( uint32_t  address,
uint32_t  value 
)

Definition at line 586 of file ntv2konaflashprogram.cpp.

◆ ProgramInfoFromString()

bool CNTV2KonaFlashProgram::ProgramInfoFromString ( std::string  infoString)

◆ ProgramKonaxMB()

bool CNTV2KonaFlashProgram::ProgramKonaxMB ( const std::string &  sCustomFileName,
const uint32_t  addr,
std::ostream &  outMsgs 
)

Definition at line 2120 of file ntv2konaflashprogram.cpp.

◆ ProgramLicenseInfo()

bool CNTV2KonaFlashProgram::ProgramLicenseInfo ( const std::string &  licenseString)

Definition at line 1317 of file ntv2konaflashprogram.cpp.

◆ ProgramMACAddresses()

bool CNTV2KonaFlashProgram::ProgramMACAddresses ( MacAddr *  mac1,
MacAddr *  mac2 
)

Definition at line 1134 of file ntv2konaflashprogram.cpp.

◆ ReadBankSelect()

uint32_t CNTV2KonaFlashProgram::ReadBankSelect ( )

Definition at line 1473 of file ntv2konaflashprogram.cpp.

◆ ReadDeviceID()

uint32_t CNTV2KonaFlashProgram::ReadDeviceID ( )

Definition at line 613 of file ntv2konaflashprogram.cpp.

◆ ReadFlash()

bool CNTV2KonaFlashProgram::ReadFlash ( NTV2Buffer &  outBuffer,
const FlashBlockID  flashID,
CNTV2FlashProgress &  inFlashProgress = CNTV2FlashProgress::nullUpdater 
)

Definition at line 755 of file ntv2konaflashprogram.cpp.

◆ ReadHeader()

bool CNTV2KonaFlashProgram::ReadHeader ( FlashBlockID  flashBlock)

Definition at line 453 of file ntv2konaflashprogram.cpp.

◆ ReadLicenseInfo()

bool CNTV2KonaFlashProgram::ReadLicenseInfo ( std::string &  licenseString)

Definition at line 1380 of file ntv2konaflashprogram.cpp.

◆ ReadMACAddresses()

bool CNTV2KonaFlashProgram::ReadMACAddresses ( MacAddr &  mac1,
MacAddr &  mac2 
)

Definition at line 1228 of file ntv2konaflashprogram.cpp.

◆ ROMHasBankSelect()

bool CNTV2KonaFlashProgram::ROMHasBankSelect ( void  )

Definition at line 2160 of file ntv2konaflashprogram.cpp.

◆ SetBankSelect()

bool CNTV2KonaFlashProgram::SetBankSelect ( BankSelect  bankNumber)

Definition at line 1456 of file ntv2konaflashprogram.cpp.

◆ SetBitFile()

bool CNTV2KonaFlashProgram::SetBitFile ( const std::string &  inBitfileName,
std::ostream &  outMsgs,
const FlashBlockID  blockNumber = AUTO_FLASHBLOCK 
)

Definition at line 407 of file ntv2konaflashprogram.cpp.

◆ SetBoard()

bool CNTV2KonaFlashProgram::SetBoard ( uint32_t  index = 0)
virtual

Definition at line 189 of file ntv2konaflashprogram.cpp.

◆ SetDeviceProperties()

bool CNTV2KonaFlashProgram::SetDeviceProperties ( )

Definition at line 202 of file ntv2konaflashprogram.cpp.

◆ SetFlashBlockIDBank()

bool CNTV2KonaFlashProgram::SetFlashBlockIDBank ( FlashBlockID  blockID)

Definition at line 2132 of file ntv2konaflashprogram.cpp.

◆ SetQuietMode()

void CNTV2KonaFlashProgram::SetQuietMode ( )

Definition at line 105 of file ntv2konaflashprogram.cpp.

◆ SetWarmBootFirmwareReload()

bool CNTV2KonaFlashProgram::SetWarmBootFirmwareReload ( bool  enable)

Definition at line 2326 of file ntv2konaflashprogram.cpp.

◆ VerifyFlash()

bool CNTV2KonaFlashProgram::VerifyFlash ( FlashBlockID  flashBlockNumber,
bool  fullVerify = (0) 
)

Definition at line 696 of file ntv2konaflashprogram.cpp.

◆ WaitForFlashNOTBusy()

bool CNTV2KonaFlashProgram::WaitForFlashNOTBusy ( )

Definition at line 821 of file ntv2konaflashprogram.cpp.

◆ WriteCommand()

bool CNTV2KonaFlashProgram::WriteCommand ( _FLASH_COMMAND  inCommand)

Definition at line 112 of file ntv2konaflashprogram.cpp.

Member Data Documentation

◆ _bankSize

uint32_t CNTV2KonaFlashProgram::_bankSize
protected

Definition at line 163 of file ntv2konaflashprogram.h.

◆ _bitFileBuffer

NTV2Buffer CNTV2KonaFlashProgram::_bitFileBuffer
protected

Definition at line 155 of file ntv2konaflashprogram.h.

◆ _bitFileName

std::string CNTV2KonaFlashProgram::_bitFileName
protected

Definition at line 159 of file ntv2konaflashprogram.h.

◆ _bitFileSize

uint32_t CNTV2KonaFlashProgram::_bitFileSize
protected

Definition at line 157 of file ntv2konaflashprogram.h.

◆ _bQuiet

bool CNTV2KonaFlashProgram::_bQuiet
protected

Definition at line 179 of file ntv2konaflashprogram.h.

◆ _card

CNTV2Card& CNTV2KonaFlashProgram::_card
protected

Definition at line 154 of file ntv2konaflashprogram.h.

◆ _customFileBuffer

uint8_t* CNTV2KonaFlashProgram::_customFileBuffer
protected

Definition at line 156 of file ntv2konaflashprogram.h.

◆ _deviceID

uint32_t CNTV2KonaFlashProgram::_deviceID
protected

Definition at line 178 of file ntv2konaflashprogram.h.

◆ _failSafeOffset

uint32_t CNTV2KonaFlashProgram::_failSafeOffset
protected

Definition at line 166 of file ntv2konaflashprogram.h.

◆ _failSafePadding

uint32_t CNTV2KonaFlashProgram::_failSafePadding
protected

Definition at line 185 of file ntv2konaflashprogram.h.

◆ _flashID

FlashBlockID CNTV2KonaFlashProgram::_flashID
protected

Definition at line 177 of file ntv2konaflashprogram.h.

◆ _flashSize

uint32_t CNTV2KonaFlashProgram::_flashSize
protected

Definition at line 162 of file ntv2konaflashprogram.h.

◆ _hasExtendedCommandSupport

bool CNTV2KonaFlashProgram::_hasExtendedCommandSupport
protected

Definition at line 187 of file ntv2konaflashprogram.h.

◆ _licenseOffset

uint32_t CNTV2KonaFlashProgram::_licenseOffset
protected

Definition at line 169 of file ntv2konaflashprogram.h.

◆ _macOffset

uint32_t CNTV2KonaFlashProgram::_macOffset
protected

Definition at line 167 of file ntv2konaflashprogram.h.

◆ _mainOffset

uint32_t CNTV2KonaFlashProgram::_mainOffset
protected

Definition at line 165 of file ntv2konaflashprogram.h.

◆ _mcsInfo

std::string CNTV2KonaFlashProgram::_mcsInfo
protected

Definition at line 160 of file ntv2konaflashprogram.h.

◆ _mcsInfoOffset

uint32_t CNTV2KonaFlashProgram::_mcsInfoOffset
protected

Definition at line 168 of file ntv2konaflashprogram.h.

◆ _numBytes

uint32_t CNTV2KonaFlashProgram::_numBytes
protected

Definition at line 176 of file ntv2konaflashprogram.h.

◆ _numSectorsFailSafe

uint32_t CNTV2KonaFlashProgram::_numSectorsFailSafe
protected

Definition at line 175 of file ntv2konaflashprogram.h.

◆ _numSectorsMain

uint32_t CNTV2KonaFlashProgram::_numSectorsMain
protected

Definition at line 172 of file ntv2konaflashprogram.h.

◆ _numSectorsSOC1

uint32_t CNTV2KonaFlashProgram::_numSectorsSOC1
protected

Definition at line 173 of file ntv2konaflashprogram.h.

◆ _numSectorsSOC2

uint32_t CNTV2KonaFlashProgram::_numSectorsSOC2
protected

Definition at line 174 of file ntv2konaflashprogram.h.

◆ _parser

NTV2BitfileHeaderParser CNTV2KonaFlashProgram::_parser
protected

Definition at line 158 of file ntv2konaflashprogram.h.

◆ _partitionBuffer

std::vector<uint8_t> CNTV2KonaFlashProgram::_partitionBuffer
protected

Definition at line 184 of file ntv2konaflashprogram.h.

◆ _sectorSize

uint32_t CNTV2KonaFlashProgram::_sectorSize
protected

Definition at line 164 of file ntv2konaflashprogram.h.

◆ _soc1Offset

uint32_t CNTV2KonaFlashProgram::_soc1Offset
protected

Definition at line 170 of file ntv2konaflashprogram.h.

◆ _soc2Offset

uint32_t CNTV2KonaFlashProgram::_soc2Offset
protected

Definition at line 171 of file ntv2konaflashprogram.h.

◆ _spiDeviceID

uint32_t CNTV2KonaFlashProgram::_spiDeviceID
protected

Definition at line 161 of file ntv2konaflashprogram.h.

◆ _spiFlash

CNTV2SpiFlash* CNTV2KonaFlashProgram::_spiFlash
protected

Definition at line 186 of file ntv2konaflashprogram.h.

The documentation for this class was generated from the following files: