21.3.56 get_tool_state
(Ask a Question)Description
This Tcl command is used to get the state of a tool in the Libero Design Flow. It can be run on all tools which have a tool state in the UI such as green check mark/error/out of date/has not run yet/tool run with warnings, and so on.
get_tool_state -name {tool_name}Arguments
| Parameter | Type | Description | 
|---|---|---|
| name | string | Specifies the name of tool for which you wish to get the tool state. It is mandatory.
  | 
Error Codes
Error Code  | Description  | 
|---|---|
None  | Required parameter 'name' is missing.  | 
None  | Parameter 'param_name' is not defined. Valid command formatting is 'get_tool_state -name "tool name"'.  | 
Supported Families
| Supported Families | 
|---|
| PolarFire® | 
| RTG4™ | 
| SmartFusion® 2 | 
| IGLOO® 2 | 
The following table shows the possible tool states/tool tips. 
Important: The tool states described may not be applicable to all tools.
| Tool State/Tool tip | Description | 
|---|---|
| Tool successfully run | When the execution is successful. | 
| Device/Project settings have changed | When the Device/Project settings that affect the tool are modified. | 
| Tool configuration has changed | When a tool's configuration options are changed. | 
| Tool failed | When a tool execution fails. | 
| Tool has not run yet | When a tool has not run yet. | 
| Tool inputs are out of date | When a parent tool state is cleaned, or when a design source is modified, or something in another tool is modified that the current tool is dependent on. | 
| Tool executed | When a tool has run successfully. | 
| Tool has timing violations/Timing constraints have not been met | When the Verify Timing tool has run successfully but the design has timing violations. | 
| Tool successfully run/Timing constraints have been met | When the Verify Timing tool has run successfully and there are no timing violations for the design. | 
The following table shows all the tools for which this command is applicable.
| Tool Name (Tcl) | Tool Display Name | Supported Families | 
|---|---|---|
| SYNTHESIZE | Synthesize | SmartFusion® 2, IGLOO® 2, RTG4™, PolarFire® | 
| COMPILE | Compile | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| PLACEROUTE | Place and Route | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| VERIFYTIMING | Verify Timing | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| VERIFYPOWER | Verify Power | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| PROGRAMDEVICE | Run PROGRAM Action | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| GENERATE_MEMORY_MAP | Generate Memory Map | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| GENERATEPROGRAMMINGFILE | Generate Bitstream | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| EXPORTPROGRAMMINGFILE | Export Bitstream | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| EXPORTPROGRAMMINGJOB | Export FlashPro Express Job | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| EXPORTJOBDATA | Export Job Manager Data | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| EXPORTNETLIST | File > Export > Netlist... | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| EXPORTSMARTDEBUGDATA | Export SmartDebug Data | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| PUBLISHBLOCK | Publish Block | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| EXPORTSDF | Generate Back Annotated Files | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
| GENERATEPROGRAMMINGDATA | Generate FPGA Array Data | SmartFusion 2, IGLOO 2, RTG4, PolarFire | 
Example
The following example gets the state of synthesize tool in the Libero Design flow.
set state [get_tool_state -name {SYNTHESIZE}]
puts "$state"
Output: Tool successfully run