tincr::pins Namespace Reference

The pins ensemble encapsulates the pin class from Vivado's Tcl data structure. More...

Functions
	test args
	test_proc proc args
	new name direction ?cell?
	delete pin
	rename pin name
	get args
	info pin ?info?
	remove pin
	connect_net pin net
	disconnect_net pin net
	get_pin_type pin

Detailed Description

The pins ensemble encapsulates the pin class from Vivado's Tcl data structure.

Function Documentation

connect_net()

tincr::pins::connect_net			pin net

Connect a pin to a net.

Parameters

pin	The pin object.
net	The net object.

delete()

tincr::pins::delete			pin

Delete a pin.

Parameters

name	The pin to delete.

disconnect_net()

tincr::pins::disconnect_net			pin net

Disconnect a pin from a net.

Parameters

pin	The pin object.
net	The net object.

get_pin_type()

tincr::pins::get_pin_type			pin

Gets the type of the pin according to Vivado. DATA is the default pin type where no other pin type is specified. Other valid pin types include CLEAR, CLOCK, ENABLE, PRESET, RESET, SET, SETRESET, AND WRITE_ENABLE TODO: on each new release of Vivado, verify this function is still correct. This has to be manually verified.

Parameters

pin

Cell pin

Returns

The type of cell pin

new()

tincr::pins::new			name direction ?cell?

Create a new pin.

Parameters

name	The name of the new pin.
direction	The direction of the new pin. Valid values are IN, OUT, and INOUT.
cell	The name of the cell to add this pin to, if one.

Returns

The newly created pin object.

remove()

tincr::pins::remove			pin

Remove a pin from a cell.

Parameters

pin	The pin to remove.

Returns

True (1) if successful, false (0) otherwise.

rename()

tincr::pins::rename			pin name

Rename a pin.

Parameters

pin	The pin to rename.
name	The new name.

test()

tincr::pins::test			args

Executes all unit tests for every proc in the pins ensemble.

Parameters

args	The configuration arguments that will be passed to the tcltest unit testing suite.

test_proc()

tincr::pins::test_proc			proc args

Executes all unit tests for a particular proc in the pins ensemble.

Parameters

proc	The proc to run the unit tests for.
args	The configuration arguments that will be passed to the tcltest unit testing suite.