search

Origen-SDK / origen_sim

Plugin to enable Origen patterns to be run in a dynamic Verilog simulation
MIT License
1 stars 4 forks source link

tcl_inputs not working in environment as documented, need override #50

Open redxeth opened 3 years ago

redxeth commented 3 years ago

All,

We are trying to add the -memories option to our probe in the TCL file. The template for this file shows an option called :tcl_inputs that is also indicated in the guide:

  sim.tcl_inputs %Q(
    probe -create -shm origen.dut.mems.user -all -memories -variables -unpacked 262144 -depth all
    probe -create -shm origen.dut.mems.cache -all -memories -variables -unpacked 262144 -depth all
  )

Unfortunately, it does not appear that this option works as it is not at all referenced in simulator.rb.

There is a :setup options that is brought in and used in the template. So perhaps the :tcl_inputs option was done in error? I don't see any history of it in the repository. Does anyone have any history?

So would like to discuss how to best proceed. Remove all references to tcl_inputs and replace the mention in the guide to :setup to start I would think.

Second, the template shows this to be an additional probe, not a replacement for the probe already defined at the start of the template. Should we add a way for overriding even the first probe included by default, for expert users?

ginty commented 3 years ago

Hi @redxeth,

I can't remember the evolution of this, but from looking at it I think the intention might have been to keep tcl_inputs around for backwards compatibility (though not very well it seems!) and move to a new more generic name setup.

I would vote for treating this as a documentation bug and changing it to setup.

No objection to adding any more customization options that you want. This kind of thing is always a trade-off between trying to add the options that the power users need, while not bamboozling normal users with too many choices.