Development Tools User’s Guide
259
Intel
®
IXP2400/IXP2800 Network Processors
Simulator APIs
XACT_alloc_user_sim_state
Creates a user-specified simulation state
XACT_start_of_cycle
Tests the current simulation time to see if it
corresponds to the time when the specified clock
domain starts a new cycle
XACT_full_cycle_simulated
Tests the current simulation time to see if it
corresponds to the time when the specified clock has
been fully simulated
XACT_clock_cycle
Returns the clock cycle number for the specified clock
XACT_clock_cycle_with_remainder
Returns the clock cycle number for the specified clock
and tests for error occurrences
XACT_get_top_level_inst
Gets the cell_name/inst_name pair names of all cells
instantiated at the top level by the “inst” command
XACT_Define_Callback_Create_Chip
Calls callback when a chip of the specified name has
been called
XACT_Define_Callback_Init_Sim
Calls callback when the simulation has been
instantiated and initialized via the “init” command
XACT_Define_Automatic_Sim_Halt
Calls callback when the simulator has prematurely
halted model for the reason specified by the input
argument
XACT_Define_Callback_Sim_Reset
Calls callback when the simulation has be reset via the
“sim_reset” command
XACT_Define_Callback_Sim_Delete
Calls callback when the simulation has been destroyed
via the “sim_delete_ command
XACT_Define_Callback_Sim_In_Progress
Defines callback that is invoked whenever the
simulator starts or stops a simulating step
XACT_Define_Callback_Default_Go_Clock_domain
Defines callback to be invoked whenever default clock
domain for “go” simulation changes
XACT_Define_Callback_State_Transition
Defines a callback to be invoked when a specified state
makes a transition
XACT_Define_Cancel_Callback_State_Transition
Defines the callback to cancel any further state
transition callbacks when the specified state changes
XACT_Cancel_State_Transition_Callback
Cancels the predefined state transition callback
XACT_Define_Handle_Invalidation_Callback
Notifies the user when a handle is about to become
invalidated
XACT_output_to_console
Prints string to transactor console output
XACT_printf
printf function which outputs to transactor console
XACT_printf_error
printf function which outputs transactor errors to
transactor console
XACT_register_console_function
Registers a foreign function with the transactor’s C
interpreter
XACT_register_console_function_w_arrayed_args
Registers a foreign function with the transactor's C
interpreter
XACT_unregister_console_function
Unregisters a routine that has been previously
registered via the XACT register console function
XACT_ExecuteCommandStr
Executes the string as a console command
Table 12. XACT API Functions (Continued) (Sheet 2 of 3)
Function Name
Function Description