FLI functions by category

---

FLI region functions

FLI process functions

FLI signal functions

FLI driver functions

FLI variable functions

FLI type functions

FLI callback functions

FLI memory management functions

FLI checkpoint/restore functions

FLI time and event functions

FLI communication and command functions

FLI miscellaneous functions

This chapter lists the FLI functions by category and provides a brief description. For information on creating and using foreign architectures and subprograms, see "Introduction" . For complete details on the functions including purpose, syntax, and usage, see "FLI function definitions" .

Table 1: FLI region functions 

Function	Action
mti_CreateRegion()	Creates a new region
mti_FindRegion()	Finds a region by name
mti_FirstLowerRegion()	Gets the first subregion inside of a region
mti_GetCallingRegion()	Gets the current elaboration region during elaboration or the region of the currently active process or signal resolution function or the current environment during simulation
mti_GetCurrentRegion()	Gets the current elaboration region during elaboration or the current environment during simulation
mti_GetGenericList()	Gets a list of the VHDL generics defined for a region
mti_GetTopRegion()	Gets the first top-level region
mti_HigherRegion()	Gets the parent region of a region
mti_NextRegion()	Gets the next region at the same level as a region
mti_GetLibraryName()	Gets the physical name of the library that contains a region
mti_GetPrimaryName()	Gets the primary name of a region (entity, package, or module)
mti_GetRegionFullName()	Gets the full hierarchical name of a region
mti_GetRegionKind()	Gets the type of a region (VHDL or Verilog)
mti_GetRegionName()	Gets the simple name of a region
mti_GetRegionSourceName()	Gets the name of the source file which contains a region
mti_GetSecondaryName()	Gets the secondary name of a VHDL region
mti_GetSecondaryName() (FLI-416)	Gets the secondary name of a VHDL region
mti_GetRegionKind() (FLI-384)	Gets the type of a region (VHDL or Verilog)
mti_GetGenericList() (FLI-332)	Gets a list of the VHDL generics defined for a region

Table 2: FLI process functions 

Function	Action
mti_CreateProcess()	Creates a new VHDL process
mti_CreateProcessWithPriority()	Creates a new VHDL process with a specific priority
mti_FirstProcess()	Gets the first VHDL process in a region
mti_NextProcess()	Gets the next VHDL process in a region
mti_GetProcessName()	Gets the name of a VHDL process
mti_Sensitize()	Sensitizes a VHDL process to a VHDL signal
mti_Desensitize()	Desensitizes a VHDL process to the VHDL signals to which it is sensitive
mti_ScheduleWakeup()	Schedules a VHDL process to wake up at a specific time

Table 3: FLI signal functions 

Function	Action
mti_CreateSignal()	Creates a new VHDL signal
mti_FindPort()	Finds a port signal in a port interface list
mti_FindSignal()	Finds a VHDL signal by name
mti_FirstSignal()	Gets the first VHDL signal in a region
mti_NextSignal()	Gets the next VHDL signal in a region
mti_GetArraySignalValue()	Gets the value of a VHDL signal of type array
mti_GetDrivingSignals()	Gets a handle to all of the signals driving a signal
mti_GetSignalMode()	Gets the mode (direction) of a VHDL signal
mti_GetSignalName()	Gets the simple name of a scalar or top-level composite VHDL signal
mti_GetSignalNameIndirect()	Gets the full simple name of a VHDL signal including array indices and record subelement names
mti_GetSignalRegion()	Gets the region in which a VHDL signal is declared
mti_GetSignalSubelements()	Gets the subelements of a composite VHDL signal
mti_GetSignalType()	Gets the type of a VHDL signal
mti_GetSignalValue()	Gets the value of a scalar VHDL signal of type enumeration, integer, or physical
mti_GetSignalValueIndirect()	Gets the value of a VHDL signal of any type except record
mti_SignalImage()	Gets the string image of a VHDL signal's value
mti_SetSignalValue()	Sets the value of a VHDL signal
mti_ForceSignal()	Forces a value onto a VHDL signal
mti_ReleaseSignal()	Releases a force on a VHDL signal

Table 4: FLI driver functions

Function	Action
mti_CreateDriver()	Creates a driver on a VHDL signal
mti_FindDriver()	Finds out if a VHDL signal has any drivers on it
mti_GetDriverNames()	Gets the names of all drivers on a VHDL signal
mti_GetDriverSubelements()	Gets the subelements of a composite driver
mti_GetDriverValues()	Gets the values of all drivers on a VHDL signal
mti_ScheduleDriver()	Schedules a driver to drive a value onto a VHDL signal
mti_SetDriverOwner()	Sets the owning process of a driver

Table 5: FLI variable functions 

Function	Action
mti_FindVar()	Finds a VHDL variable, generic, or constant by name
mti_FirstVar()	Gets the first VHDL variable, generic, or constant in a process
mti_NextVar()	Gets the next VHDL variable, generic, or constant in a process
mti_GetArrayVarValue()	Gets the value of a VHDL variable of type array
mti_GetVarAddr()	Gets a pointer to a VHDL variable's value space
mti_GetVarImage()	Gets the string image of a VHDL variable's value (by name)
mti_GetVarImageById()	Gets the string image of a VHDL variable's value (by ID)
mti_GetVarName()	Gets the simple name of a VHDL variable
mti_GetVarSubelements()	Gets the subelements of a composite VHDL variable
mti_GetVarType()	Gets the type of a VHDL variable
mti_GetVarValue()	Get the value of a scalar VHDL variable of type enumeration, integer, or physical
mti_GetVarValueIndirect()	Gets the value of a VHDL variable of any type except record
mti_SetVarValue()	Sets the value of a VHDL variable

Table 6: FLI type functions

Function	Action
mti_CreateArrayType()	Creates an array type
mti_CreateEnumType()	Creates an enumeration type
mti_CreateRealType()	Creates a real type
mti_CreateScalarType()	Creates a scalar type
mti_CreateTimeType()	Creates a time type
mti_GetArrayElementType()	Gets the type of an array type's subelements
mti_GetNumRecordElements()	Gets the number of subelements in a record type
mti_GetEnumValues()	Gets the values of an enumeration type
mti_GetPhysicalData()	Gets the unit information of a physical type
mti_GetTypeKind()	Gets the kind of a type
mti_Image()	Gets the string image of a value of a specific type
mti_TickDir()	Gets the direction of a type
mti_TickHigh()	Gets the high value of a ranged type
mti_TickLeft()	Gets the left value of a ranged type
mti_TickLength()	Gets the length of a type
mti_TickLow()	Gets the low value of a ranged type
mti_TickRight()	Gets the right value of a ranged type

Table 7: FLI callback functions 

Function	Action
mti_AddEnvCB()	Adds an environment change callback
mti_AddLoadDoneCB()	Adds an elaboration done callback
mti_AddQuitCB()	Adds a simulator exit callback
mti_AddRestartCB()	Adds a simulator restart callback
mti_AddRestoreCB()	Adds a simulator restore callback
mti_AddRestoreDoneCB()	Adds a simulator restore done callback
mti_AddSaveCB()	Adds a simulator checkpoint callback
mti_AddSimStatusCB()	Adds a simulator run status change callback
mti_AddInputReadyCB()	Adds or removes a file/pipe input ready callback
mti_AddOutputReadyCB()	Adds or removes a file/pipe output ready callback
mti_AddSocketInputReadyCB()	Adds or removes a socket input ready callback
mti_AddSocketOutputReadyCB()	Adds or removes a socket output ready callback
mti_RemoveEnvCB()	Removes an environment change callback
mti_RemoveLoadDoneCB()	Removes an elaboration done callback
mti_RemoveQuitCB()	Removes a simulator exit callback
mti_RemoveRestartCB()	Removes a simulator restart callback
mti_RemoveRestoreCB()	Removes a simulator restore callback
mti_RemoveRestoreDoneCB()	Removes a simulator restore done callback
mti_RemoveSaveCB()	Removes a simulator checkpoint callback
mti_RemoveSimStatusCB()	Removes a simulator run status change callback

Table 8: FLI memory management functions

Function	Action
mti_Malloc()	Allocates simulator-managed memory
mti_Realloc()	Re-allocates simulator-managed memory
mti_Free()	Frees simulator-managed memory
mti_VsimFree()	Frees memory allocated by an FLI function that would normally be freed with the free() C-library function

Table 9: FLI checkpoint/restore functions

Function	Action
mti_GetCheckpointFilename()	Gets the name of the current checkpoint file
mti_IsRestore()	Determines if a restore operation is in progress
mti_IsColdRestore()	Determines if a cold restore operation is in progress
mti_SaveBlock()	Saves a block of data to the checkpoint file
mti_SaveChar()	Saves a byte of data to the checkpoint file
mti_SaveLong()	Saves sizeof(long) bytes of data to the checkpoint file
mti_SaveShort()	Saves sizeof(short) bytes of data to the checkpoint file
mti_SaveString()	Saves a null-terminated string to the checkpoint file
mti_RestoreBlock()	Gets a block of data from the checkpoint file
mti_RestoreChar()	Gets a byte of data from the checkpoint file
mti_RestoreLong()	Gets sizeof(long) bytes of data from the checkpoint file
mti_RestoreShort()	Gets sizeof(short) bytes of data from the checkpoint file
mti_RestoreString()	Gets a null-terminated string from the checkpoint file
mti_RestoreProcess()	Restores a process that was created by mti_CreateProcess()

Table 10: FLI time and event functions

Function	Action
mti_Delta()	Gets the simulator iteration count for the current time step
mti_Now()	Gets the low order 32 bits of the 64-bit current simulation time
mti_NowUpper()	Gets the high order 32 bits of the 64-bit current simulation time
mti_NowIndirect()	Gets the upper and lower 32 bits of the 64-bit current simulation time
mti_GetNextEventTime()	Gets the next event time (from a foreign subprogram or callback)
mti_GetNextNextEventTime()	Gets the next event time (from a VHDL process)
mti_GetResolutionLimit()	Gets the simulator resolution limit
mti_GetRunStopTime()	Gets the stop time of the current simulation run

Table 11: FLI communication and command functions

Function	Action
mti_AddCommand()	Adds a user-defined simulator command
mti_AddTclCommand()	Adds a user-defined Tcl-style simulator command
mti_Interp()	Gets the Tcl_Interp pointer used in the simulator
mti_Command()	Executes a simulator command
mti_Cmd()	Executes a simulator command with Tcl return status and no transcribing
mti_AskStdin()	Prompts the user for an input string
mti_PrintMessage()	Prints a message to the main transcript window
mti_PrintFormatted()	Prints a formatted message to the main transcript window
mti_Break()	Requests the simulator to halt
mti_FatalError()	Requests the simulator to halt with a fatal error
mti_Quit()	Requests the simulator to exit immediately

Table 12: FLI miscellaneous functions

Function	Action
mti_GetProductVersion()	Gets the name and version of the simulator
mti_GetWlfFilename()	Gets the name of the waveform logfile (.wlf)
mti_FindProjectEntry()	Gets the value of an entry in the project (.ini) file
mti_WriteProjectEntry()	Writes an entry to the project (.ini) file
mti_IsFirstInit()	Detects the first call to the initialization function
mti_KeepLoaded()	Requests that the current shared library not be unloaded on restart or load of a new design

Model Technology Inc. Voice: (503) 641-1340 Fax: (503)526-5410 http://www.model.com sales@model.com