naps.vendor package

Subpackages

• naps.vendor.generic package
  • Submodules
  • naps.vendor.generic.jtag module
    • JTAG
  • Module contents
• naps.vendor.lattice_ecp5 package
  • Submodules
  • naps.vendor.lattice_ecp5.clocking module
    • ClkDivF
      • ClkDivF.elaborate()
    • EclkSyncB
      • EclkSyncB.elaborate()
    • Pll
      • Pll.elaborate()
      • Pll.is_valid_vco_conf()
      • Pll.output_dividers
      • Pll.output_domain()
      • Pll.toggle_phase_loadreg
      • Pll.toggle_phase_sel
      • Pll.vco_dividers
      • Pll.vco_multipliers
  • naps.vendor.lattice_ecp5.io module
    • DelayF
      • DelayF.backward
      • DelayF.do_move
      • DelayF.elaborate()
      • DelayF.forward
      • DelayF.reset_delay
      • DelayF.set_delay
    • IDDRX1F
      • IDDRX1F.elaborate()
    • IDDRX2F
      • IDDRX2F.elaborate()
  • naps.vendor.lattice_ecp5.jtag module
    • JTAG
      • JTAG.elaborate()
  • Module contents
• naps.vendor.lattice_machxo2 package
  • Submodules
  • naps.vendor.lattice_machxo2.clocking module
    • ClkDiv
      • ClkDiv.elaborate()
    • EClkSync
      • EClkSync.elaborate()
    • Osc
      • Osc.elaborate()
    • Pll
      • Pll.elaborate()
      • Pll.is_valid_vco_conf()
      • Pll.output_dividers
      • Pll.output_domain()
      • Pll.vco_dividers
      • Pll.vco_multipliers
  • naps.vendor.lattice_machxo2.io module
    • ISerdes8
      • ISerdes8.elaborate()
  • naps.vendor.lattice_machxo2.jtag module
    • JTAG
      • JTAG.elaborate()
  • Module contents
• naps.vendor.xilinx_s7 package
  • Submodules
  • naps.vendor.xilinx_s7.clocking module
    • BufG
      • BufG.elaborate()
    • BufIO
      • BufIO.elaborate()
    • ClockDivider
      • ClockDivider.elaborate()
    • Mmcm
      • Mmcm.elaborate()
      • Mmcm.is_valid_vco_conf()
      • Mmcm.output_0_dividers
      • Mmcm.output_dividers
      • Mmcm.output_domain()
      • Mmcm.vco_dividers
      • Mmcm.vco_multipliers
    • Pll
      • Pll.elaborate()
      • Pll.is_valid_vco_conf()
      • Pll.output_dividers
      • Pll.output_domain()
      • Pll.vco_dividers
      • Pll.vco_multipliers
  • naps.vendor.xilinx_s7.io module
    • DDRDeserializer
      • DDRDeserializer.elaborate()
    • DDRSerializer
      • DDRSerializer.elaborate()
    • IDelay
      • IDelay.elaborate()
    • IDelayCtrl
      • IDelayCtrl.elaborate()
    • OSerdes10
      • OSerdes10.elaborate()
  • naps.vendor.xilinx_s7.jtag module
    • JTAG
      • JTAG.elaborate()
  • naps.vendor.xilinx_s7.ps7 module
    • PS7
      • PS7.elaborate()
      • PS7.fck_domain()
      • PS7.get_axi_gp_master()
      • PS7.get_axi_hp_slave()
      • PS7.get_possible_fclk_frequencies()
      • PS7.gp_master_number
      • PS7.hp_slave_number
  • Module contents

Submodules

naps.vendor.instance_helper module

class naps.vendor.instance_helper.HelperedInstance(*args, src_loc_at=0, **kwargs)

Bases: Elaboratable

elaborate(platform)

naps.vendor.instance_helper.InstanceHelper(source_files, instance_name)

exception naps.vendor.instance_helper.PortNotFoundException

Bases: Exception

class naps.vendor.instance_helper.SignalProxy(ports, path='')

Bases: ValueCastable

as_value()

Convert :py:`self` to a value-like object.

This method is called by the Amaranth language to convert :py:`self` to a concrete Value. It will usually return a Value object, but it may also return another value-like object to delegate its functionality.

This method must be idempotent: when called twice on the same object, the result must be exactly the same.

This method may also be called by code that is not a part of the Amaranth language.

Returns

Any other object recognized by Value.cast().

Raises

Exception

When the conversion cannot be done. This exception must be propagated by callers, either directly or as a cause of another exception.

It is recommended that, in cases where this method raises an exception, the shape() method also raises an exception.

eq(other)

shape()

Compute the shape of :py:`self`.

This method is not called by the Amaranth language itself; whenever it needs to discover the shape of a value-castable object, it calls self.as_value().shape(). However, that method must return a Shape, and ValueCastable subclasses may have a richer representation of their shape provided by an instance of a ShapeCastable subclass. This method may return such a representation.

This method must be idempotent: when called twice on the same object, the result must be exactly the same.

The following condition must hold:

Shape.cast(self.shape()) == Value.cast(self).shape()

Returns

A shape-like object.

Raises

Exception

When the conversion cannot be done. This exception must be propagated by callers, either directly or as a cause of another exception.

It is recommended that, in cases where this method raises an exception, the as_value() method also raises an exception.

property used_ports

naps.vendor.platform_agnostic_elaboratable module

class naps.vendor.platform_agnostic_elaboratable.ImplementationMarkerMetaclass(name, bases, namespace, /, **kwargs)

Bases: ABCMeta

property implementation

class naps.vendor.platform_agnostic_elaboratable.PlatformAgnosticElaboratable(*args, src_loc_at=0, **kwargs)

Bases: Elaboratable

A helper to write Platform agnostic code. Searches in the vendor directories for the real elaboratable.

elaborate(platform)

exception naps.vendor.platform_agnostic_elaboratable.PlatformNotSupportedError

Bases: ValueError

exception naps.vendor.platform_agnostic_elaboratable.PrimitiveNotSupportedByPlatformError

Bases: ValueError

Module contents