Node Schema

DesignFormat stores each node using a standard schema, with every node’s schema inheriting from a single base class DFBase.

This section of the documentation details the full schema, along with examples of how each node may be described:

• DFAddressMap - declares an address map within a block containing a number of DFAddressMapInitiators and DFAddressMapTargets that are associated to the boundary IO.

• DFAddressMapConstraint - represents a constraint between an DFAddressMapInitiator and a DFAddressMapTarget.

• DFAddressMapInitiator - represents a bus initiator into an DFAddressMap.

• DFAddressMapTarget - represents a bus target from an DFAddressMap.

• DFBase - the base class from which all other schema classes inherit.

• DFBlock - describes a hardware block with ports, children, connectivity, registers, and an address map.

• DFCommand - details a command handled by the hardware such as microcode or an instruction.

• DFCommandField - represents a field within a DFCommand that carries specific information.

• DFConnection - a connection between two DFPorts or a DFPort and a DFConstantTie.

• DFConstantTie - ties a DFPort to a constant value.

• DFDefine - a named constant value.

• DFInterconnect - describes a signal type for ports and connections, from a single wire to a complex bus.

• DFInterconnectComponent - one component of a DFInterconnect which can be simple (just a wire) or complex (referring to another DFInterconnect).

• DFPort - a single port on a DFBlock, which instantiates a DFInterconnect.

• DFProject - the root container for an elaborated design.

• DFRegister - represents a register formed of a collection of DFRegisterField.

• DFRegisterField - a single field within a DFRegister.

• DFRegisterGroup - a named collection of DFRegisters.