Scripting

cmp logiclock_back_annotate (Tcl Script API Function)

The cmp logiclock_back_annotate function has the following format:

Syntax cmp logiclock_back_annotate   [<logiclock_region> <demote_to_lab> <back_annotate_nodes> <lock_regions>]
Arguments

<logiclock_region>

The name of the LogicLock™ region to be back-annotated. If the name is specified as an empty string by using empty double quotation marks (""), all regions will be back annotated. In addition, if the name of a region is specified and it has child regions, the child regions also will be back-annotated. An optional argument.

<demote_to_lab>

The value that specifies whether to demote the node back-annotations to LABs. Legal values are 0 or 1. The default value is 1, which demotes to LABs. An optional argument.

<back_annotate_nodes>

The value that specifies how to back-annotate the nodes. Legal values are 0 or 1. The default is 1, which back-annotates the nodes. If the value is 0, only region locations and sizes will be back-annotated. An optional argument.

<lock_regions>

The value that specifies whether to lock the location of the back-annotated LogicLock region. If the value is 1, the Quartus® II software locks the location of the back-annotated LogicLock region. If the value is 0, the Quartus II software updates the origin and dimensions of the back-annotated LogicLock region, but does not change the region's state from auto-size to fixed size or from floating to locked. An optional argument, which defaults to 1.

Return Value
Code Name Code String Return
TCL_OK 0 LogicLock back-annotation completed
TCL_ERROR 1 LogicLock back-annotation failed
TCL_ERROR 1 project has no active compiler setting
TCL_ERROR 1 no project is currently open
TCL_ERROR 1 wrong # args: should be "logiclock_back_annotate [logiclock_region demote_to_lab back_annotate_nodes lock_regions]"
Description Back-annotates one or more LogicLock regions in the design. After the Quartus II software finishes auto-sizing and placement of the LogicLock regions during compilation, the back-annotation updates the Entity Settings File (.esf) with the obtained sizes and locations. If you direct the Quartus II software to back-annotate nodes, node locations will also be stored in the ESF.


Back to Top

- PLDWorld -

 
Created by chm2web html help conversion utility.