Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Glossary

These are commonly used terms across the PandABlocks documentation. Terms from the web control UI and from the FPGA/firmware layer are merged here as the canonical reference; all other repos link to this page.

App

An .ini file that specifies the type and number of Block instances to build together into an FPGA image (an .ipk package — or, pre-5.0, a legacy Zpkg — loadable on a PandABlocks device).

Attribute

A property of a Block. Attributes are divided into four categories:

Attribute Group

A logical grouping of related Attribute instances within a Block, presented as a collapsible section in the Block Information Panel.

Block

A piece of FPGA logic (or a software equivalent) that has a number of Field instances and performs specified calculations on each FPGA clock tick. In the web control UI a Block is the graphical manifestation of a component within a Design, encapsulating its attributes, methods and connectivity to other blocks.

Blocks may represent:

  • Input and output controllers (interfaces to the FPGA)

  • Configurable clocks

  • Logic lookup tables and logic gates

  • Soft blocks such as a SEQ, or hardware-connected blocks such as TTLIN

Block Information Panel

Panel in the web control UI showing the Attribute and Method details of the currently selected Block.

Child Block

A Block that appears within the Layout of a Parent Block.

Design

The complete technical description of a system: the Block instances it contains, their Attribute values, and the Link connections between them. A Design is represented graphically as a Layout in the web interface.

Design Element

Any Block, Attribute or Link currently in focus within the Layout view.

Field

An input, output or parameter of a Block.

Flowgraph

Synonym for Layout — the graphical representation of a Design showing all Design Element connections.

FMC

FPGA Mezzanine Card — a standard expansion connector for FPGA carrier boards. Several PandABlocks FPGA bitstreams target specific FMC cards.

Input Attribute

An attribute that identifies the value (or stream of values) received into a Block via a Sink Port. There is a 1:1 mapping between an Input Attribute and a Sink Port.

Input Port

Synonym for Sink Port.

Layout

The graphical representation of a Design in the web control, showing Block instances and the Link connections between them.

A connection that transfers data from a Source Port on one Block to a Sink Port on another. Links can only be made between ports of the same logical type (e.g. bit→bit, position→position).

Method

An action that can be performed by a Block, such as ARM or DISARM.

Module

A directory in PandABlocks-FPGA containing Block definitions, logic, simulations and timing files. A module typically contains a single soft Block definition or a set of hardware Blocks for a particular Target Platform, SFP or FMC card.

Output Attribute

An attribute that identifies the value (or stream of values) transmitted via a Source Port out of a Block. There is a 1:1 mapping between an Output Attribute and a Source Port.

Output Port

Synonym for Source Port.

PandABlocks Device

A Zynq 7030 (or compatible) based device loaded with the PandABlocks firmware, running the PandABlocks server framework.

PandABox

A PandABlocks Device manufactured jointly by Diamond Light Source and SOLEIL. Schematics are on Open Hardware.

Parameter Attribute

An attribute whose value can be set by a user to influence the behaviour of a Block.

Parent Block

A Block that aggregates one or more Child Block instances each performing an activity in support of the parent’s functionality.

Readback Attribute

An attribute whose value is set automatically by the execution environment. Readback attributes cannot be set manually via the UI.

Root Block

The outermost entity displayed in the web control UI. Selecting the top-level Design block shows the whole system; navigating into a child presents that child as the root.

SFP

Small Form-factor Pluggable transceiver — a standard optical/electrical interface used on some PandABlocks hardware.

Sink Port

A port on a Block that accepts incoming data. Every Sink Port has a pre-defined type declared in the Block specification.

Source Port

A port on a Block that transmits data generated within that Block. Every Source Port has a pre-defined type declared in the Block specification.

Target Platform

The physical Zynq-based hardware loaded with PandABlocks firmware, such as a PandABox or a Picozed Carrier.

Zpkg

A specially formatted tar file of built files that can be deployed to a PandABlocks device (legacy pre-5.0 format; replaced by opkg .ipk packages from release 5.0 onwards).