HyperDbg's Hardware Debugger (hwdbg) types and constants. More...

Classes
struct	_HWDBG_PORT_INFORMATION_ITEMS
	The structure of port information (each item) in hwdbg. More...
struct	_HWDBG_INSTANCE_INFORMATION
	The structure of script capabilities information in hwdbg. More...
struct	_HWDBG_INSTANCE_INFORMATION::_HWDBG_SCRIPT_CAPABILITIES
struct	_HWDBG_SCRIPT_BUFFER
	The structure of script buffer in hwdbg. More...

Macros
#define	DEFAULT_INITIAL_DEBUGGEE_TO_DEBUGGER_OFFSET 0x200
	Initial debuggee to debugger offset.
#define	DEFAULT_INITIAL_DEBUGGER_TO_DEBUGGEE_OFFSET 0x0
	Initial debugger to debuggee offset.
#define	DEFAULT_INITIAL_BRAM_BUFFER_SIZE 256
	Initial default buffer size (BRAN Size).
#define	HWDBG_TEST_READ_INSTANCE_INFO_PATH "..\\..\\..\\..\\hwdbg\\sim\\hwdbg\\DebuggerModuleTestingBRAM\\bram_instance_info.txt"
	Path to read the sample of the instance info.
#define	HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\script_buffer.hex.txt"
	Path to write the sample of the script buffer.
#define	HWDBG_TEST_WRITE_INSTANCE_INFO_PATH "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\instance_info.hex.txt"
	Path to write the sample of the instance info requests.

Typedefs
typedef enum _HWDBG_ACTION_ENUMS	HWDBG_ACTION_ENUMS
	Different action of hwdbg.
typedef enum _HWDBG_RESPONSE_ENUMS	HWDBG_RESPONSE_ENUMS
	Different responses come from hwdbg.
typedef enum _HWDBG_SUCCESS_OR_ERROR_ENUMS	HWDBG_SUCCESS_OR_ERROR_ENUMS
	Different success or error codes in hwdbg.
typedef struct _HWDBG_PORT_INFORMATION_ITEMS	HWDBG_PORT_INFORMATION_ITEMS
	The structure of port information (each item) in hwdbg.
typedef struct _HWDBG_INSTANCE_INFORMATION	HWDBG_INSTANCE_INFORMATION
	The structure of script capabilities information in hwdbg.
typedef struct _HWDBG_SCRIPT_BUFFER	HWDBG_SCRIPT_BUFFER
	The structure of script buffer in hwdbg.

Enumerations
enum	_HWDBG_ACTION_ENUMS { hwdbgActionSendInstanceInfo = 1 , hwdbgActionConfigureScriptBuffer = 2 }
	Different action of hwdbg. More...
enum	_HWDBG_RESPONSE_ENUMS { hwdbgResponseSuccessOrErrorMessage = 1 , hwdbgResponseInstanceInfo = 2 }
	Different responses come from hwdbg. More...
enum	_HWDBG_SUCCESS_OR_ERROR_ENUMS { hwdbgOperationWasSuccessful = 0x7FFFFFFF , hwdbgErrorInvalidPacket = 1 }
	Different success or error codes in hwdbg. More...

Detailed Description

HyperDbg's Hardware Debugger (hwdbg) types and constants.

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

This file contains definitions of hwdbg elements used in HyperDbg

Version: 0.9

Date: 2024-04-28

Copyright: This project is released under the GNU Public License v3.

Macro Definition Documentation

◆ DEFAULT_INITIAL_BRAM_BUFFER_SIZE

#define DEFAULT_INITIAL_BRAM_BUFFER_SIZE 256

Initial default buffer size (BRAN Size).

Number of 4-Byte integers (256 * 4 Byte * 8 bits = 8-kilobits)

◆ DEFAULT_INITIAL_DEBUGGEE_TO_DEBUGGER_OFFSET

#define DEFAULT_INITIAL_DEBUGGEE_TO_DEBUGGER_OFFSET 0x200

Initial debuggee to debugger offset.

◆ DEFAULT_INITIAL_DEBUGGER_TO_DEBUGGEE_OFFSET

#define DEFAULT_INITIAL_DEBUGGER_TO_DEBUGGEE_OFFSET 0x0

Initial debugger to debuggee offset.

◆ HWDBG_TEST_READ_INSTANCE_INFO_PATH

#define HWDBG_TEST_READ_INSTANCE_INFO_PATH "..\\..\\..\\..\\hwdbg\\sim\\hwdbg\\DebuggerModuleTestingBRAM\\bram_instance_info.txt"

Path to read the sample of the instance info.

◆ HWDBG_TEST_WRITE_INSTANCE_INFO_PATH

#define HWDBG_TEST_WRITE_INSTANCE_INFO_PATH "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\instance_info.hex.txt"

Path to write the sample of the instance info requests.

◆ HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH

#define HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\script_buffer.hex.txt"

Path to write the sample of the script buffer.

Typedef Documentation

◆ HWDBG_ACTION_ENUMS

typedef enum _HWDBG_ACTION_ENUMS HWDBG_ACTION_ENUMS

Different action of hwdbg.

Warning: This file should be changed along with hwdbg files

◆ HWDBG_INSTANCE_INFORMATION

typedef struct _HWDBG_INSTANCE_INFORMATION HWDBG_INSTANCE_INFORMATION

The structure of script capabilities information in hwdbg.

◆ HWDBG_PORT_INFORMATION_ITEMS

typedef struct _HWDBG_PORT_INFORMATION_ITEMS HWDBG_PORT_INFORMATION_ITEMS

The structure of port information (each item) in hwdbg.

◆ HWDBG_RESPONSE_ENUMS

typedef enum _HWDBG_RESPONSE_ENUMS HWDBG_RESPONSE_ENUMS

Different responses come from hwdbg.

Warning: This file should be changed along with hwdbg files

◆ HWDBG_SCRIPT_BUFFER

typedef struct _HWDBG_SCRIPT_BUFFER HWDBG_SCRIPT_BUFFER

The structure of script buffer in hwdbg.

◆ HWDBG_SUCCESS_OR_ERROR_ENUMS

typedef enum _HWDBG_SUCCESS_OR_ERROR_ENUMS HWDBG_SUCCESS_OR_ERROR_ENUMS

Different success or error codes in hwdbg.

Warning: This file should be changed along with hwdbg files

Enumeration Type Documentation

◆ _HWDBG_ACTION_ENUMS

enum _HWDBG_ACTION_ENUMS