tincr Namespace Reference

All of the Tcl procs provided in the design package are members of the tincr namespace. More...

Namespaces
	bel_pins
	The bel_pins ensemble encapsulates the bel_pin class from Vivado's Tcl data structure.
	bels
	The bels ensemble encapsulates the bel class from Vivado's Tcl data structure.
	cells
	The cells ensemble encapsulates the cell class from Vivado's Tcl data structure.
	clocks
	The clocks ensemble encapsulates the clock class from Vivado's Tcl data structure.
	designs
	The designs ensemble encapsulates the design class from Vivado's Tcl data structure.
	lib_cells
	The lib_cells ensemble encapsulates the lib_cell class from Vivado's Tcl data structure.
	lib_pins
	The lib_pins ensemble encapsulates the lib_pin class from Vivado's Tcl data structure.
	libs
	The libs ensemble encapsulates the lib class from Vivado's Tcl data structure.
	macros
	The macros ensemble encapsulates the macro class from Vivado's Tcl data structure.
	nets
	The nets ensemble encapsulates the net class from Vivado's Tcl data structure.
	nodes
	The noes ensemble encapsulates the node class from Vivado's Tcl data structure.
	package_pins
	The package_pins ensemble encapsulates the package_pin class from Vivado's Tcl data structure.
	parts
	The parts ensemble encapsulates the part class from Vivado's Tcl data structure.
	pblocks
	The pblocks ensemble encapsulates the pblock class from Vivado's Tcl data structure.
	pins
	The pins ensemble encapsulates the pin class from Vivado's Tcl data structure.
	pips
	The pips ensemble encapsulates the pip class from Vivado's Tcl data structure.
	ports
	The ports ensemble encapsulates the port class from Vivado's Tcl data structure.
	site_pins
	The site_pins ensemble encapsulates the site_pin class from Vivado's Tcl data structure.
	site_pips
	The site_pips ensemble encapsulates the site_pip class from Vivado's Tcl data structure.
	sites
	The sites ensemble encapsulates the site class from Vivado's Tcl data structure.
	tiles
	The tiles ensemble encapsulates the tile class from Vivado's Tcl data structure.
	wires
	The wires ensemble encapsulates the wire class from Vivado's Tcl data structure.

Functions
	random_placer ?seed??verbose?
	parse_argsx flags options statements args
	refresh_packages
	diff_files args
	print args
	parse_options _args
	parse_flags_and_options _args
	parse_args options flags optional required arguments
	extract_flag flag var_name args_name
	parse_args2 flags options statements args
	parse_arguments provided_args args
	generate_namespace_export_list args
	binary_search list search
	dict_difference dict1 dict2?nesting_level?
	count_dict_leaves dict nesting_levels?count_as?
	lequal l1 l2
	list_match search values
	foreach_element cmd list
	build_list args
	lpop varName
	lremove varName index
	min args
	max args
	minimum_index list
	maximum_index list
	contains_substring string substring
	ends_with string1 string2
	starts_with string1 string2
	is_valid_filename filename
	add_extension args
	report_runtime cmd?format?
	average_runtime args
	format_time value?format?
	catch_info cmd
	compare_objects obj1 obj2
	diff_objects obj1 obj2
	list_properties objects?property_regex?
	print_object_properties obj
	process_handler chan
	spawn_vivado_run script
	run_in_temporary_project args
	organize_by elements?property?
	get_name obj
	get_type obj
	get_class obj
	write_tcp filename
	read_tcp args
	write_design_info args
	write_placement_xdc args
	write_routing_xdc args
	get_design_info args
	write_xdlrc args
	write_xdlrc_tile tile outfile brief
	append_primitive_def site_type outfile
	write_primitive_defs args
	write_partial_primitive_def site filename?includeConfigs?
	get_primitive_def_cover_set parts?trials?
	write_all_partial_primitive_defs ?includeConfigs?
	extract_all_partial_primitive_defs path?includeConfigs?

Detailed Description

All of the Tcl procs provided in the design package are members of the tincr namespace.

All of the Tcl procs provided in the BYU packages are members of the byu namespace.

Function Documentation

tincr::append_primitive_def			site_type outfile

Appends the primitive definition corresponding to site_type of the current device to the output stream provided by output.

Parameters

site_type	The site type of the corresponding primitive definition.
outfile	The output stream that the primitive definition is to be written to.

tincr::compare_objects			obj1 obj2

Imports all commands currently in the ::byu namespace into the global namespace. This is simply an alias of the command namespace import tincr::*

tincr::extract_all_partial_primitive_defs			path ?includeConfigs?

Produce a partial .def file for each primitive site of each part in the xilinx family. This function should be called only when a new xilinx series is released.

Parameters

cfg	Add this option if you want to include cfg strings in your primitive def files.
path	The path you want the family directories and files to be written to.

tincr::get_primitive_def_cover_set			parts ?trials?

Get the minimum set cover of parts that together contain all of the possible site types for the list of given parts.

Parameters

parts	The set of parts that comprise the universal set of site types.
trial	The number of trials (default is 300).

Returns

A subset of parts that comprise the universal set of site types.

tincr::parse_argsx			flags options statements args

Parses a list of arguments and generates a Usage statement when wrong tincr::parse_args {?{a|b}? c} {d ?e? {f|{g h}}} {i ?j? {k l}...}

tincr::report_runtime			cmd ?format?

Format a string so that it is valid XML. This replaces illegal characters with their proper entity references. This function is implemented as an alias of a string map function.

tincr::write_partial_primitive_def			site filename ?includeConfigs?

Produce a partial (everything but connections) .def file for the given primitive site. All config strings will be put inside of bel elements.

Parameters

site	The site object you want to create a .def file for. Sites instanced by alternate types are acceptable.
filename	The output file.
includeConfigs	A boolean telling the proc whether or not to include configuration elements in the resulting .def file.

tincr::write_primitive_defs			args

Appends all primitive defs of the current part to the end of a specified file.

Parameters

filename	Where to write the primitive definitions.
part	Part to generate the primitive definitions for.
append	Append to the existing file.

tincr::write_tcp			filename

Writes a Tincr checkpoint to file. A Tincr checkpoint is able to store a basic design, its placement, and routing in a human-readble format. consists of five files: an EDIF netlist representation and XDC files that constrain the placement and routing of the design. Currently, designs with route-throughs are not supported, though this functionality is planned for a future release of Tincr.

Parameters

filename

The path and filename where the Tincr checkpoint is to be written.