INexusDriver interface

No description yet.

public interface INexusDriver : IDeviceInformation

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IDeviceInformation

Derived: IARMNexusDriver

Properties

Property	Type	Access	Description
EmbeddedConstraintFile	string	get; set
NexusDevice	INexusDevice	get; set
ProcessorRegisterValue	uint	get; set
ProcessorRegisterWideValue	string	get; set

EmbeddedConstraintFile

No description yet.

string GetEmbeddedConstraintFile();
void SetEmbeddedConstraintFile(string argConstraintFile);

Type: string · Access: read/write

NexusDevice

No description yet.

INexusDevice GetNexusDevice();
bool SetNexusDevice(INexusDevice argNexusDevice);

Type: INexusDevice · Access: read/write

The accessors are extension methods of INexusDriverHelper (using SCH;).

ProcessorRegisterValue

No description yet.

uint GetProcessorRegisterValue(int argRegisterIndex);
bool SetProcessorRegisterValue(int argRegisterIndex, uint argValue);

Type: uint · Access: read/write · Index: argRegisterIndex (int)

ProcessorRegisterWideValue

No description yet.

string GetProcessorRegisterWideValue(int argRegisterIndex);
bool SetProcessorRegisterWideValue(int argRegisterIndex, string argValue);

Type: string · Access: read/write · Index: argRegisterIndex (int)

Methods

Method	Returns	Description
_Finalize	bool
AddSoftBreakpoint	uint
ClockCoreGenerator	IClockCoreGenerator
ClockCoreTemplateGenerator	IClockCoreTemplateGenerator
ClockGeneratorTargetCore	ITargetCoreGenerator
ConfigureFpgaProject	bool
ContinueProcessor	void
CoreGen_OutputExtension	string
CreateRackViewer	void
CustomAction_Execute	void
CustomAction_GetState	void
CustomCoreGenerator	ICustomCoreGenerator
EPM_Download	bool
EPM_GetTestResult	int
EPM_InititateTest	bool
EPM_SetPercentCallBack	void
FinishDownload	bool
Flash_Configure	void
Flash_Program	int
Flash_Reset	bool
Flash_ResetForBitStream	bool
FlowStage_Build	IProcessFlow
FlowStage_Download	IProcessFlow
GetBitmapHandle	UIntPtr
GetDeviceState	TDeviceState
GetDeviceTypeForLicenseCheck	string
GetFolder_Library	string
GetMemorySpace_Program	int
GetMemorySpaceBytesPerUnit	uint
GetMemorySpaceCount	int
GetMemorySpaceKind	TMemoryKind
GetMemorySpaceLength	long
GetMemorySpaceName	string
GetMemorySpaceShortName	string
GetMemorySpaceWidth	uint
GetProcessorRegisterCount	int
GetProcessorRegisterName	string
GetProcessorRegisterShortName	string
GetProcessorRegisterWidth	uint
GetRackViewer	IInstrumentView
GetRegisterIndex_PC	int
GetRegisterIndex_SP	int
GetSoftBreakpointAddressByteAlign	int
InitDownload	bool
InvalidateResources	bool
LittleEndian	bool
PauseProcessor	void
ProcessorIsPaused	bool
ProcessorIsReset	bool
ProcessorIsRunning	bool
ProcessorIsUsingReducedInstructionSet	bool
ProgramDevice	int
ReadUserCode	uint
ReleaseResources	void
RemoveSoftBreakpoint	bool
ResetDevice	bool
ResetNexusRegisters	void
ResetProcessor	void
RestoreProcessorState	bool
RunDiagnostic	bool
RunSingleStepInSubstitutionRegister	void
RunSteps	void
SaveProcessorState	bool
ShowAboutDialog	void
ShowConfiguration	bool
ShowCurrentSensePanel	void
SingleStepProcessor	void
Supports	bool
VendorToolsDescriptor	string
VendorToolsPresent	bool
VendorToolsUpToDate	bool

_Finalize

No description yet.

bool _Finalize();

Returns: bool

AddSoftBreakpoint

No description yet.

uint AddSoftBreakpoint(int argMemorySpace, long argddress);

Parameter	Type	Passing
argMemorySpace	int	value
argddress	long	value

Returns: uint

ClockCoreGenerator

No description yet.

IClockCoreGenerator ClockCoreGenerator();

Returns: IClockCoreGenerator

Extension method of INexusDriverHelper (using SCH;).

ClockCoreTemplateGenerator

No description yet.

IClockCoreTemplateGenerator ClockCoreTemplateGenerator();

Returns: IClockCoreTemplateGenerator

Extension method of INexusDriverHelper (using SCH;).

ClockGeneratorTargetCore

No description yet.

ITargetCoreGenerator ClockGeneratorTargetCore();

Returns: ITargetCoreGenerator

Extension method of INexusDriverHelper (using SCH;).

ConfigureFpgaProject

No description yet.

bool ConfigureFpgaProject(IProject argProject);
bool ConfigureFpgaProject(object argProject);

Parameter	Type	Passing
argProject	IProject	value

Returns: bool

The first overload is an extension method of INexusDriverHelper (using SCH;) with typed parameters; the second is declared by the interface.

ContinueProcessor

No description yet.

void ContinueProcessor();

Returns: nothing (void)

CoreGen_OutputExtension

No description yet.

string CoreGen_OutputExtension();

Returns: string

CreateRackViewer

No description yet.

void CreateRackViewer();

Returns: nothing (void)

CustomAction_Execute

No description yet.

void CustomAction_Execute(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: nothing (void)

CustomAction_GetState

No description yet.

void CustomAction_GetState(int argIndex, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, ref string argImageFile);

Parameter	Type	Passing
argIndex	int	value
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImageFile	string	ref

Returns: nothing (void)

CustomCoreGenerator

No description yet.

ICustomCoreGenerator CustomCoreGenerator(TModuleType argModuleType);

Parameter	Type	Passing
argModuleType	TModuleType	value

Returns: ICustomCoreGenerator

Extension method of INexusDriverHelper (using SCH;).

EPM_Download

No description yet.

bool EPM_Download(string argddress, string argFileName, string argLocation);

Parameter	Type	Passing
argddress	string	value
argFileName	string	value
argLocation	string	value

Returns: bool

EPM_GetTestResult

No description yet.

int EPM_GetTestResult(int argTestReg);

Parameter	Type	Passing
argTestReg	int	value

Returns: int

EPM_InititateTest

No description yet.

bool EPM_InititateTest();

Returns: bool

EPM_SetPercentCallBack

No description yet.

void EPM_SetPercentCallBack(IPercentCallback argCallBack);
void EPM_SetPercentCallBack(object argCallBack);

Parameter	Type	Passing
argCallBack	IPercentCallback	value

Returns: nothing (void)

The first overload is an extension method of INexusDriverHelper (using SCH;) with typed parameters; the second is declared by the interface.

FinishDownload

No description yet.

bool FinishDownload(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: bool

Flash_Configure

No description yet.

void Flash_Configure();

Returns: nothing (void)

Flash_Program

No description yet.

int Flash_Program(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: int

Flash_Reset

No description yet.

bool Flash_Reset();

Returns: bool

Flash_ResetForBitStream

No description yet.

bool Flash_ResetForBitStream();

Returns: bool

FlowStage_Build

No description yet.

IProcessFlow FlowStage_Build();

Returns: IProcessFlow

Extension method of INexusDriverHelper (using SCH;).

FlowStage_Download

No description yet.

IProcessFlow FlowStage_Download();

Returns: IProcessFlow

Extension method of INexusDriverHelper (using SCH;).

GetBitmapHandle

No description yet.

UIntPtr GetBitmapHandle();

Returns: UIntPtr

Extension method of INexusDriverHelper (using SCH;).

GetDeviceState

No description yet.

TDeviceState GetDeviceState();

Returns: TDeviceState

Extension method of INexusDriverHelper (using SCH;).

GetDeviceTypeForLicenseCheck

No description yet.

string GetDeviceTypeForLicenseCheck();

Returns: string

GetFolder_Library

No description yet.

string GetFolder_Library();

Returns: string

GetMemorySpace_Program

No description yet.

int GetMemorySpace_Program();

Returns: int

GetMemorySpaceBytesPerUnit

No description yet.

uint GetMemorySpaceBytesPerUnit(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: uint

GetMemorySpaceCount

No description yet.

int GetMemorySpaceCount();

Returns: int

GetMemorySpaceKind

No description yet.

TMemoryKind GetMemorySpaceKind(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: TMemoryKind

Extension method of INexusDriverHelper (using SCH;).

GetMemorySpaceLength

No description yet.

long GetMemorySpaceLength(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: long

GetMemorySpaceName

No description yet.

string GetMemorySpaceName(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: string

GetMemorySpaceShortName

No description yet.

string GetMemorySpaceShortName(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: string

GetMemorySpaceWidth

No description yet.

uint GetMemorySpaceWidth(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: uint

GetProcessorRegisterCount

No description yet.

int GetProcessorRegisterCount();

Returns: int

GetProcessorRegisterName

No description yet.

string GetProcessorRegisterName(int argRegisterIndex);

Parameter	Type	Passing
argRegisterIndex	int	value

Returns: string

GetProcessorRegisterShortName

No description yet.

string GetProcessorRegisterShortName(int argRegisterIndex);

Parameter	Type	Passing
argRegisterIndex	int	value

Returns: string

GetProcessorRegisterWidth

No description yet.

uint GetProcessorRegisterWidth(int argRegisterIndex);

Parameter	Type	Passing
argRegisterIndex	int	value

Returns: uint

GetRackViewer

No description yet.

IInstrumentView GetRackViewer();

Returns: IInstrumentView

Extension method of INexusDriverHelper (using SCH;).

GetRegisterIndex_PC

No description yet.

int GetRegisterIndex_PC();

Returns: int

GetRegisterIndex_SP

No description yet.

int GetRegisterIndex_SP();

Returns: int

GetSoftBreakpointAddressByteAlign

No description yet.

int GetSoftBreakpointAddressByteAlign();

Returns: int

InitDownload

No description yet.

bool InitDownload(int argMemorySpaceIndex);

Parameter	Type	Passing
argMemorySpaceIndex	int	value

Returns: bool

InvalidateResources

No description yet.

bool InvalidateResources();

Returns: bool

LittleEndian

No description yet.

bool LittleEndian();

Returns: bool

PauseProcessor

No description yet.

void PauseProcessor();

Returns: nothing (void)

ProcessorIsPaused

No description yet.

bool ProcessorIsPaused();

Returns: bool

ProcessorIsReset

No description yet.

bool ProcessorIsReset();

Returns: bool

ProcessorIsRunning

No description yet.

bool ProcessorIsRunning();

Returns: bool

ProcessorIsUsingReducedInstructionSet

No description yet.

bool ProcessorIsUsingReducedInstructionSet();

Returns: bool

ProgramDevice

No description yet.

int ProgramDevice(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: int

ReadUserCode

No description yet.

uint ReadUserCode();

Returns: uint

ReleaseResources

No description yet.

void ReleaseResources();

Returns: nothing (void)

RemoveSoftBreakpoint

No description yet.

bool RemoveSoftBreakpoint(int argMemorySpace, long argddress, uint argReplaced);

Parameter	Type	Passing
argMemorySpace	int	value
argddress	long	value
argReplaced	uint	value

Returns: bool

ResetDevice

No description yet.

bool ResetDevice();

Returns: bool

ResetNexusRegisters

No description yet.

void ResetNexusRegisters();

Returns: nothing (void)

ResetProcessor

No description yet.

void ResetProcessor();

Returns: nothing (void)

RestoreProcessorState

No description yet.

bool RestoreProcessorState();

Returns: bool

RunDiagnostic

No description yet.

bool RunDiagnostic();

Returns: bool

RunSingleStepInSubstitutionRegister

No description yet.

void RunSingleStepInSubstitutionRegister();

Returns: nothing (void)

RunSteps

No description yet.

void RunSteps(int argStepCount);

Parameter	Type	Passing
argStepCount	int	value

Returns: nothing (void)

SaveProcessorState

No description yet.

bool SaveProcessorState();

Returns: bool

ShowAboutDialog

No description yet.

void ShowAboutDialog();

Returns: nothing (void)

ShowConfiguration

No description yet.

bool ShowConfiguration();

Returns: bool

ShowCurrentSensePanel

No description yet.

void ShowCurrentSensePanel();

Returns: nothing (void)

SingleStepProcessor

No description yet.

void SingleStepProcessor();

Returns: nothing (void)

Supports

No description yet.

bool Supports(string argction);

Parameter	Type	Passing
argction	string	value

Returns: bool

VendorToolsDescriptor

No description yet.

string VendorToolsDescriptor();

Returns: string

VendorToolsPresent

No description yet.

bool VendorToolsPresent();

Returns: bool

VendorToolsUpToDate

No description yet.

bool VendorToolsUpToDate();

Returns: bool

Inherited members

• From IDeviceInformation: GetBaseName, GetBSDLEntity, GetBSDLFilename, GetClockManagerCount, GetConfigMemorySize, GetDeviceDescription, GetDeviceDisplayName, GetDeviceIOCount, GetDeviceName, GetDeviceParameter, GetDevicePin, GetDevicePinCount, GetDiffPairCount, GetDownloadFileExtensions, GetDSPMultiplierCount, GetEquivalentGatesForBase, GetFamilyDescription, GetFamilyName, GetGlobalClockCount, GetHighSpeedDiffPairCount, GetIdCode, GetInstructionLength, GetIOStandard, GetIOStandardCount, GetLibraryName, GetMaxIOForBase, GetMemorySize, GetOptionDesignatorDescription, GetOptionDesignatorId, GetOptionDesignatorName, GetPackageDescription, GetPackageDimensions, GetPackageId, GetPackageName, GetPackageTypeDescription, GetPackageTypeId, GetPackageTypeName, GetSpeedGradeDescription, GetSpeedGradeId, GetSpeedGradeName, GetTemperatureGradeDescription, GetTemperatureGradeId, GetTemperatureGradeName, GetTerminationSupport, GetVendorName, GetVendorPrimitiveLibraryName

Returned by

INexusDevice.NexusDriver

Accepted by

IToolchainManagerConfigurationListener.Event_ConfigurationChange