prga.core.builder.block module¶

class prga.core.builder.block.IOBlockBuilder(context, module)¶

Bases: prga.core.builder.block._BaseSliceLikeBuilder

IO block builder.

Parameters:	context (`Context`) – The context of the builder module (`Module`) – The module to be built

create_global(global_, orientation=None, *, name=None, **kwargs)¶

Create and add an input port that is connected to the global wire global_.

Keyword Arguments:
Parameters:	global (`Global`) – The global wire this port is connected to orientation (`Orientation` or `str`) – Orientation of this port
	name (`str`) – Name of this port. If not given, the name of the global wire is used **kwargs – Additional attributes assigned to the port
Returns:	The created port
Return type:	`Port`

create_input(name, width, orientation=None, **kwargs)¶

Create and add a non-global input port to this block.

Keyword Arguments:
Parameters:	name (`str`) – name of the created port width (`int`) – width of the created port orientation (`Orientation` or `str`) – orientation of this port
	**kwargs – Additional attributes assigned to the port
Returns:	The created port
Return type:	`Port`

create_output(name, width, orientation=None, **kwargs)¶

Create and add a non-global output port to this block.

Keyword Arguments:
Parameters:	name (`str`) – name of the created port width (`int`) – width of the created port orientation (`Orientation` or `str`) – orientation of this port
	**kwargs – Additional attributes assigned to the port
Returns:	The created port
Return type:	`Port`

classmethod new(name, **kwargs)¶

Create a new block.

Keyword Arguments:
Parameters:	name (`str`) – Name of the block
	**kwargs – Additional attributes assigned to the block
Returns:	The created block
Return type:	`Module`

class prga.core.builder.block.LogicBlockBuilder(context, module)¶

Bases: prga.core.builder.block._BaseSliceLikeBuilder

Logic block builder.

Parameters:	context (`Context`) – The context of the builder module (`Module`) – The module to be built

classmethod _resolve_orientation_and_position(block, orientation, position)¶: Resolve orientation and position.

create_global(global_, orientation, position=None, *, name=None, **kwargs)¶

Create and add an input port that is connected to a global wire global_.

Keyword Arguments:
Parameters:	global (`Global`) – The global wire this port is connected to orientation (`Orientation` or `str`) – Orientation of this port position (`tuple` [`int`, `int` ]) – Position of this port
	name (`str`) – Name of this port. If not given, the name of the global wire is used **kwargs – Additional attributes assigned to the port
Returns:	The created port
Return type:	`Port`

create_input(name, width, orientation, position=None, *, vpr_equivalent_pins=False, **kwargs)¶

Create and add a non-global input port to this block.

Keyword Arguments:
Parameters:	name (`str`) – name of the created port width (`int`) – width of the created port orientation (`Orientation` or `str`) – orientation of this port position (`tuple` [`int`, `int` ]) – Position of this port
	vpr_equivalent_pins (`bool`) – Add equivalent tag for this port in the output VPR specs **kwargs – Additional attributes assigned to the port
Returns:	The created port
Return type:	`Port`

create_output(name, width, orientation, position=None, **kwargs)¶

Create and add a non-global output port to this block.

Keyword Arguments:
Parameters:	name (`str`) – name of the created port width (`int`) – width of the created port orientation (`Orientation` or `str`) – orientation of this port position (`tuple` [`int`, `int` ]) – Position of this port
	**kwargs – Additional attributes assigned to the port
Returns:	The created output port
Return type:	`Port`

classmethod new(name, width, height, **kwargs)¶

Create a new block for building.

Keyword Arguments:
Parameters:	name (`str`) – Name of the block width (`int`) – Width of the block height (`int`) – Height of the block
	**kwargs – Additional attributes assigned to the block
Returns:	The created block
Return type:	`Module`

class prga.core.builder.block.SliceBuilder(context, module)¶

Bases: prga.core.builder.block._BaseSliceLikeBuilder

Slice builder.

Parameters:	context (`Context`) – The context of the builder module (`Module`) – The module to be built

create_clock(name, **kwargs)¶

Create and add a clock input port to the slice.

Keyword Arguments:
Parameters:	name (`str`) – Name of this clock
	**kwargs – Additional attributes assigned to the port
Returns:	The created clock port
Return type:	`Port`

create_input(name, width, **kwargs)¶

Create and add a non-clock input port to the slice.

Keyword Arguments:
Parameters:	name (`str`) – Name of this port width (`int`) – Number of bits in the port
	**kwargs – Additional attributes assigned to the port
Returns:	The created input port
Return type:	`Port`

create_output(name, width, **kwargs)¶

Create and add a non-clock output port to the slice.

Keyword Arguments:
Parameters:	name (`str`) – Name of this port width (`int`) – Number of bits in the port
	**kwargs – Additional attributes assigned to the port
Returns:	The created output port
Return type:	`Port`

classmethod new(name, **kwargs)¶

Create a new module for building.

Keyword Arguments:
Parameters:	name (`str`) – Name of the module
	**kwargs – Additional attributes assigned to the slice
Returns:	The created module
Return type:	`Module`

class prga.core.builder.block._BaseSliceLikeBuilder(context, module)¶

Bases: prga.core.builder.base.BaseBuilder

Base class for slice-like module builders.

Parameters:	context (`Context`) – The context of the builder module (`Module`) – The module to be built

_set_clock(port)¶

Set port as the clock of the module.

Parameters:	Port – Clock port in this module

At the moment only one clock is supported in the module.

clock¶

Clock of the slice.

Type:	`Port`

connect(sources, sinks, *, fully=False, vpr_pack_patterns=None, **kwargs)¶

Connect sources to sinks.

Keyword Arguments:
Parameters:	sources – Source nets, i.e., an input port, an output pin of an instance, a subset of the above, or a list of a combination of the above sinks – Sink nets, i.e., an output port, an input pin of an instance, a subset of the above, or a list of a combination of the above
	fully (`bool`) – If set to `True`, connections are made between every source and every sink vpr_pack_patterns (`Sequence` [`str`]) – Add pack_pattern tags to the connections **kwargs – Additional attibutes assigned to all connections

instantiate(model, name, reps=None, **kwargs)¶

Instantiate model in the module.

Keyword Arguments:
Parameters:	model (`Module`) – Abstract view of the module to be instantiated name (`str`) – Name of the instance. If `reps` is specified, each instance is named `"{name}_i{index}"` reps (`int`) – If set to a positive int, the specified number of instances are created, added to the mode, and returned. This affects the num_pb attribute in the output VPR specs
	**kwargs – Additional attributes assigned to the instance(s)
Returns:
Return type:	`Instance` or `tuple` [`Instance`]