unpreferredName static method

  1. @protected
String unpreferredName(
  1. String name

Makes a signal name "unpreferred" when considering between multiple possible signal names.

When logic is synthesized out (e.g. to SystemVerilog), there are cases where two signals might be logically equivalent (e.g. directly connected to each other). In those scenarios, one of the two signals is collapsed into the other. If one of the two signals is "unpreferred", it will choose the other one for the final signal name. Marking signals as "unpreferred" can have the effect of making generated output easier to read.


static String unpreferredName(String name) => _unpreferredPrefix + name;