INexusDevice interface

No description yet.

public interface INexusDevice : IDeviceInformation

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IDeviceInformation

Methods

Method	Returns	Description
AddSoftBreakpoint	ISoftBreakpoint
BitmapHandle	UIntPtr
ClearAllSoftBreakpoints	void
ConfigureFpgaProject	bool
ContinueFromTemporarySuspend	void
ContinueProcessor	void
CoreGen_OutputExtension	string
CreateViewer	bool
CustomAction_Execute	void
CustomAction_GetState	void
EPM_Download	bool
EPM_GetTestResult	int
EPM_InititateTest	bool
EPM_SetPercentCallBack	void
Flash_Configure	void
Flash_Program	int
Flash_Reset	bool
Flash_ResetForBitStream	bool
FlowStage_Build	IProcessFlow
FlowStage_Download	IProcessFlow
GetDeviceState	TDeviceState
GetDriverStatus	TNexusDriverStatus
GetHexFilePath	string
GetMemorySpace	IMemorySpace
GetMemorySpace_Program	IMemorySpace
GetProcessorRegister	IProcessorRegister
GetProcessorRegister_PC	IProcessorRegister
GetProcessorRegister_SP	IProcessorRegister
GetSoftBreakpoint	ISoftBreakpoint
GetUniqueId	string
GetViewer	IInstrumentView
InvalidateResources	bool
JTagChannel	IJTagChannel
JTagIndex	int
JtagPort	IJtagPort
LittleEndian	bool
MemorySpaceCount	int
NexusDriver	INexusDriver
PauseProcessor	void
ProcessorIsPaused	bool
ProcessorIsReset	bool
ProcessorIsRunning	bool
ProcessorRegisterCount	int
ProgramDevice	int
ReadNexusRegisterAtAddress	uint
ReadStringNexusRegisterAtAddress	string
ReadUserCode	uint
ReleaseResources	void
RemoveSoftBreakpoint	bool
ResetDevice	bool
ResetNexusRegisters	void
ResetProcessor	void
RunDiagnostic	bool
RunSingleStepInSubstitutionRegister	void
RunSteps	void
SetJTagChannel	void
SetJTagIndex	void
SetJtagPort	void
ShowAboutDialog	void
ShowConfiguration	bool
ShowCurrentSensePanel	void
SingleStepProcessor	void
SoftBreakpointCount	int
StatusString	string
Supports	bool
TemporarySuspend	void
VendorToolsDescriptor	string
VendorToolsPresent	bool
VendorToolsUpToDate	bool
WriteNexusRegisterAtAddress	void
WriteStringNexusRegisterAtAddress	void

AddSoftBreakpoint

No description yet.

ISoftBreakpoint AddSoftBreakpoint(int argMemorySpace, long argddress);

Parameter	Type	Passing
argMemorySpace	int	value
argddress	long	value

Returns: ISoftBreakpoint

Extension method of INexusDeviceHelper (using SCH;).

BitmapHandle

No description yet.

UIntPtr BitmapHandle();

Returns: UIntPtr

Extension method of INexusDeviceHelper (using SCH;).

ClearAllSoftBreakpoints

No description yet.

void ClearAllSoftBreakpoints();

Returns: nothing (void)

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 INexusDeviceHelper (using SCH;) with typed parameters; the second is declared by the interface.

ContinueFromTemporarySuspend

No description yet.

void ContinueFromTemporarySuspend();

Returns: nothing (void)

ContinueProcessor

No description yet.

void ContinueProcessor();

Returns: nothing (void)

CoreGen_OutputExtension

No description yet.

string CoreGen_OutputExtension();

Returns: string

CreateViewer

No description yet.

bool CreateViewer();

Returns: bool

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)

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 INexusDeviceHelper (using SCH;) with typed parameters; the second is declared by the interface.

Flash_Configure

No description yet.

void Flash_Configure();

Returns: nothing (void)

Flash_Program

No description yet.

int Flash_Program(string argBitFilename);

Parameter	Type	Passing
argBitFilename	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 INexusDeviceHelper (using SCH;).

FlowStage_Download

No description yet.

IProcessFlow FlowStage_Download();

Returns: IProcessFlow

Extension method of INexusDeviceHelper (using SCH;).

GetDeviceState

No description yet.

TDeviceState GetDeviceState();

Returns: TDeviceState

Extension method of INexusDeviceHelper (using SCH;).

GetDriverStatus

No description yet.

TNexusDriverStatus GetDriverStatus();

Returns: TNexusDriverStatus

Extension method of INexusDeviceHelper (using SCH;).

GetHexFilePath

No description yet.

string GetHexFilePath();

Returns: string

GetMemorySpace

No description yet.

IMemorySpace GetMemorySpace(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IMemorySpace

Extension method of INexusDeviceHelper (using SCH;).

GetMemorySpace_Program

No description yet.

IMemorySpace GetMemorySpace_Program();

Returns: IMemorySpace

Extension method of INexusDeviceHelper (using SCH;).

GetProcessorRegister

No description yet.

IProcessorRegister GetProcessorRegister(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IProcessorRegister

Extension method of INexusDeviceHelper (using SCH;).

GetProcessorRegister_PC

No description yet.

IProcessorRegister GetProcessorRegister_PC();

Returns: IProcessorRegister

Extension method of INexusDeviceHelper (using SCH;).

GetProcessorRegister_SP

No description yet.

IProcessorRegister GetProcessorRegister_SP();

Returns: IProcessorRegister

Extension method of INexusDeviceHelper (using SCH;).

GetSoftBreakpoint

No description yet.

ISoftBreakpoint GetSoftBreakpoint(int argMemorySpace, long argddress);

Parameter	Type	Passing
argMemorySpace	int	value
argddress	long	value

Returns: ISoftBreakpoint

Extension method of INexusDeviceHelper (using SCH;).

GetUniqueId

No description yet.

string GetUniqueId();

Returns: string

GetViewer

No description yet.

IInstrumentView GetViewer();

Returns: IInstrumentView

Extension method of INexusDeviceHelper (using SCH;).

InvalidateResources

No description yet.

bool InvalidateResources();

Returns: bool

JTagChannel

No description yet.

IJTagChannel JTagChannel();

Returns: IJTagChannel

Extension method of INexusDeviceHelper (using SCH;).

JTagIndex

No description yet.

int JTagIndex();

Returns: int

JtagPort

No description yet.

IJtagPort JtagPort();

Returns: IJtagPort

Extension method of INexusDeviceHelper (using SCH;).

LittleEndian

No description yet.

bool LittleEndian();

Returns: bool

MemorySpaceCount

No description yet.

int MemorySpaceCount();

Returns: int

NexusDriver

No description yet.

INexusDriver NexusDriver();

Returns: INexusDriver

Extension method of INexusDeviceHelper (using SCH;).

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

ProcessorRegisterCount

No description yet.

int ProcessorRegisterCount();

Returns: int

ProgramDevice

No description yet.

int ProgramDevice(string argBitFilename);

Parameter	Type	Passing
argBitFilename	string	value

Returns: int

ReadNexusRegisterAtAddress

No description yet.

uint ReadNexusRegisterAtAddress(byte argddress, int argBitCount);

Parameter	Type	Passing
argddress	byte	value
argBitCount	int	value

Returns: uint

ReadStringNexusRegisterAtAddress

No description yet.

string ReadStringNexusRegisterAtAddress(byte argddress, int argBitCount);

Parameter	Type	Passing
argddress	byte	value
argBitCount	int	value

Returns: string

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);

Parameter	Type	Passing
argMemorySpace	int	value
argddress	long	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)

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)

SetJTagChannel

No description yet.

void SetJTagChannel(IJTagChannel argJTagChannel);
void SetJTagChannel(object argJTagChannel);

Parameter	Type	Passing
argJTagChannel	IJTagChannel	value

Returns: nothing (void)

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

SetJTagIndex

No description yet.

void SetJTagIndex(int argJTagIndex);

Parameter	Type	Passing
argJTagIndex	int	value

Returns: nothing (void)

SetJtagPort

No description yet.

void SetJtagPort(IJtagPort argPort);
void SetJtagPort(object argPort);

Parameter	Type	Passing
argPort	IJtagPort	value

Returns: nothing (void)

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

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)

SoftBreakpointCount

No description yet.

int SoftBreakpointCount();

Returns: int

StatusString

No description yet.

string StatusString();

Returns: string

Supports

No description yet.

bool Supports(string argction);

Parameter	Type	Passing
argction	string	value

Returns: bool

TemporarySuspend

No description yet.

void TemporarySuspend();

Returns: nothing (void)

VendorToolsDescriptor

No description yet.

string VendorToolsDescriptor();

Returns: string

VendorToolsPresent

No description yet.

bool VendorToolsPresent();

Returns: bool

VendorToolsUpToDate

No description yet.

bool VendorToolsUpToDate();

Returns: bool

WriteNexusRegisterAtAddress

No description yet.

void WriteNexusRegisterAtAddress(byte argddress, int argBitCount, uint argData);

Parameter	Type	Passing
argddress	byte	value
argBitCount	int	value
argData	uint	value

Returns: nothing (void)

WriteStringNexusRegisterAtAddress

No description yet.

void WriteStringNexusRegisterAtAddress(byte argddress, string argData);

Parameter	Type	Passing
argddress	byte	value
argData	string	value

Returns: nothing (void)

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

IDeviceLink.GetNexusDevice, IDeviceManager.GetDevice, IDeviceManager.GetDeviceFromDeviceId, IDriverManager.GetDeviceInterface, IMemorySpace.GetNexusDevice, INexusBreakpoint.GetNexusDevice, INexusDriver.NexusDevice, IProcessorRegister.GetNexusDevice, ISoftBreakpoint.GetNexusDevice

Accepted by

IMemoryDownloader.DownloadProgramMemory, IMemoryDownloader.SetupProgramMemory, IMemoryDownloader.VerifyProgramMemory, IDeviceManager.ReleaseDevice, INexusCore.DownloadProgramMemory, INexusCore.VerifyProgramMemory, INexusWorkbench.GetCoreFromDevice, INexusWorkbench.GetProjectFromDevice