hw_clk.cpp File Reference

!hw_clk command More...

#include "pch.h"

Functions
VOID	CommandHwClkHelp ()
	help of the !hw_clk command
BOOLEAN	CommandHwClkPerformTest (vector< CommandToken > CommandTokens, const TCHAR *InstanceFilePathToRead, const TCHAR *InstanceFilePathToSave, const TCHAR *HardwareScriptFilePathToSave, UINT32 InitialBramBufferSize)
	!hw_clk perform test
VOID	CommandHwClk (vector< CommandToken > CommandTokens, string Command)
	!hw_clk command handler

Variables
HWDBG_INSTANCE_INFORMATION	g_HwdbgInstanceInfo
	Instance information of the current hwdbg debuggee.

Detailed Description

!hw_clk command

Author

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

Version

0.9

Date

2024-05-29

Copyright

This project is released under the GNU Public License v3.

Function Documentation

CommandHwClk()

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

!hw_clk command handler

Parameters

CommandTokens
Command

Returns

VOID

{
    if (CommandTokens.size() >= 2)
    {
        //
        // Perform test with default file path and initial BRAM buffer size
        //
        CommandHwClkPerformTest(CommandTokens,
                               HWDBG_TEST_READ_INSTANCE_INFO_PATH,
                               HWDBG_TEST_WRITE_INSTANCE_INFO_PATH,
                               HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH,
                               DEFAULT_INITIAL_BRAM_BUFFER_SIZE);
    }
    else
    {
        ShowMessages("incorrect use of the '%s'\n\n",
                     GetCaseSensitiveStringFromCommandToken(CommandTokens.at(0)).c_str());
        CommandHwClkHelp();
        return;
    }
}

CommandHwClkHelp()

VOID CommandHwClkHelp

(

)

help of the !hw_clk command

Returns

VOID

{
    ShowMessages("!hw_clk : performs actions related to hwdbg hardware debugging events for each clock cycle.\n\n");
 
    ShowMessages("syntax : \t!hw_clk  [script { Script (string) }]\n");
 
    ShowMessages("\n");
    ShowMessages("\t\te.g : !hw_clk script { @hw_pin1 = 0; }\n");
}

CommandHwClkPerformTest()

BOOLEAN CommandHwClkPerformTest	(	vector< CommandToken >	CommandTokens,
		const TCHAR *	InstanceFilePathToRead,
		const TCHAR *	InstanceFilePathToSave,
		const TCHAR *	HardwareScriptFilePathToSave,
		UINT32	InitialBramBufferSize )

!hw_clk perform test

Parameters

CommandTokens
InstanceFilePathToRead
InstanceFilePathToSave
HardwareScriptFilePathToSave
InitialBramBufferSize

Returns

BOOLEAN

{
    UINT32                             EventLength;
    DEBUGGER_EVENT_PARSING_ERROR_CAUSE EventParsingErrorCause;
    PDEBUGGER_GENERAL_EVENT_DETAIL     Event                       = NULL;
    PDEBUGGER_GENERAL_ACTION           ActionBreakToDebugger       = NULL;
    PDEBUGGER_GENERAL_ACTION           ActionCustomCode            = NULL;
    PDEBUGGER_GENERAL_ACTION           ActionScript                = NULL;
    UINT32                             ActionBreakToDebuggerLength = 0;
    UINT32                             ActionCustomCodeLength      = 0;
    UINT32                             ActionScriptLength          = 0;
    CHAR *                             ScriptBuffer                = NULL;
    BOOLEAN                            Result                      = FALSE;
 
    //
    // Load the instance info
    //
    if (!HwdbgLoadInstanceInfo(InstanceFilePathToRead, InitialBramBufferSize))
    {
        //
        // No need for freeing memory so return directly
        //
        return FALSE;
    }
 
    //
    // Interpret and fill the general event and action fields for the target script
    //
    if (!InterpretGeneralEventAndActionsFields(
            &CommandTokens,
            (VMM_EVENT_TYPE_ENUM)NULL, // not an event
            &Event,
            &EventLength,
            &ActionBreakToDebugger,
            &ActionBreakToDebuggerLength,
            &ActionCustomCode,
            &ActionCustomCodeLength,
            &ActionScript,
            &ActionScriptLength,
            &EventParsingErrorCause))
    {
        //
        // No need for freeing memory so return directly
        //
        return FALSE;
    }
 
    //
    // Print the actual script
    //
    ScriptBuffer = (CHAR *)((UINT64)ActionScript + sizeof(DEBUGGER_GENERAL_ACTION));
    HwdbgScriptPrintScriptBuffer(ScriptBuffer, ActionScript->ScriptBufferSize);
 
    //
    // Create hwdbg script
    //
    if (!HwdbgScriptCreateHwdbgScript(ScriptBuffer,
                                      ActionScript->ScriptBufferSize,
                                      HardwareScriptFilePathToSave))
    {
        ShowMessages("err, unable to create hwdbg script\n");
        Result = FALSE;
        goto FreeAndReturnResult;
    }
 
    //
    // Write an additional updated test instance info request into a file
    //
    if (!HwdbgWriteTestInstanceInfoRequestIntoFile(&g_HwdbgInstanceInfo,
                                                   InstanceFilePathToSave))
    {
        ShowMessages("err, unable to write instance info request\n");
        Result = FALSE;
        goto FreeAndReturnResult;
    }
 
    //
    // The test is performed successfully
    //
    Result = TRUE;
 
FreeAndReturnResult:
 
    //
    // Free the allocated memory
    //
    FreeEventsAndActionsMemory(Event, ActionBreakToDebugger, ActionCustomCode, ActionScript);
 
    //
    // Return the result
    //
    return Result;
}

Variable Documentation

g_HwdbgInstanceInfo

HWDBG_INSTANCE_INFORMATION g_HwdbgInstanceInfo

extern

Instance information of the current hwdbg debuggee.