hw.cpp File Reference

!hw command More...

#include "pch.h"

Functions
VOID	CommandHwHelp ()
	help of the !hw command
VOID	CommandHw (vector< CommandToken > CommandTokens, string Command)
	!hw command handler

Variables
BOOLEAN	g_HwdbgInstanceInfoIsValid
	Shows whether the instance info is valid (received) or not.

Detailed Description

!hw command

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.11

Date

2024-09-29

Copyright

This project is released under the GNU Public License v3.

Function Documentation

CommandHw()

VOID CommandHw	(	vector< CommandToken >	CommandTokens,
		string	Command )

!hw command handler

Parameters

CommandTokens
Command

Returns

VOID

{
    if (CommandTokens.size() >= 2 && CompareLowerCaseStrings(CommandTokens.at(1), "script"))
    {
        //
        // Perform test with default file path and initial BRAM buffer size
        //
        HwdbgScriptRunScript(GetCaseSensitiveStringFromCommandToken(CommandTokens.at(2)).c_str(),
                             HWDBG_TEST_READ_INSTANCE_INFO_PATH,
                             HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH,
                             DEFAULT_INITIAL_BRAM_BUFFER_SIZE);
    }
    else if (CommandTokens.size() >= 2 &&
             (CompareLowerCaseStrings(CommandTokens.at(1), "eval") || CompareLowerCaseStrings(CommandTokens.at(1), "evaluation")))
    {
        //
        // Perform test evaluation
        //
        ScriptEngineWrapperTestParserForHwdbg(GetCaseSensitiveStringFromCommandToken(CommandTokens.at(2)));
    }
    else if (CommandTokens.size() == 2 && CompareLowerCaseStrings(CommandTokens.at(1), "unload"))
    {
        //
        // Unload the script
        //
        g_HwdbgInstanceInfoIsValid = FALSE;
    }
    else
    {
        ShowMessages("incorrect use of the '%s'\n\n",
                     GetCaseSensitiveStringFromCommandToken(CommandTokens.at(0)).c_str());
        CommandHwHelp();
        return;
    }
}

CommandHwHelp()

VOID CommandHwHelp

(

)

help of the !hw command

Returns

VOID

{
    ShowMessages("!hw : runs a hardware script in the target device.\n\n");
 
    ShowMessages("syntax : \t!hw script [script { Script (string) }]\n");
    ShowMessages("syntax : \t!hw script [unload]\n");
 
    ShowMessages("\n");
    ShowMessages("\t\te.g : !hw script { @hw_pin1 = 0; }\n");
    ShowMessages("\t\te.g : !hw unload\n");
}

Variable Documentation

g_HwdbgInstanceInfoIsValid

BOOLEAN g_HwdbgInstanceInfoIsValid

extern

Shows whether the instance info is valid (received) or not.