padrick package

Subpackages

• padrick.Generators package
  • Subpackages
    • padrick.Generators.ConstraintsGenerator package
      • Subpackages
      • Submodules
      • padrick.Generators.ConstraintsGenerator.ConstraintsGenerator module
      • padrick.Generators.ConstraintsGenerator.ConstraintsSpec module
      • Module contents
    • padrick.Generators.DocGenerator package
      • Subpackages
      • Submodules
      • padrick.Generators.DocGenerator.DocGenerator module
      • Module contents
    • padrick.Generators.DriverGenerator package
      • Subpackages
      • Submodules
      • padrick.Generators.DriverGenerator.DriverGenerator module
      • Module contents
    • padrick.Generators.FuseSoCGenerator package
      • Submodules
      • padrick.Generators.FuseSoCGenerator.FuseSoCGenerator module
      • padrick.Generators.FuseSoCGenerator.FuseSoCGeneratorConfigFileModel module
      • Module contents
    • padrick.Generators.RTLGenerator package
      • Subpackages
      • Submodules
      • padrick.Generators.RTLGenerator.RTLGenerator module
      • Module contents
  • Submodules
  • padrick.Generators.CLIGeneratorCommands module
  • padrick.Generators.GeneratorSettings module
    • ConstraintsTemplates
    • DocTemplates
    • DriverTemplates
    • GeneratorSettings
      • GeneratorSettings.check_manifest_version()
      • GeneratorSettings.manifest_version
    • RTLTemplates
  • padrick.Generators.PadrickTemplate module
    • PadrickTemplate
      • PadrickTemplate.name
      • PadrickTemplate.render()
      • PadrickTemplate.target_file_name
      • PadrickTemplate.template
    • TemplatePackageResource
      • TemplatePackageResource.package
      • TemplatePackageResource.resource
    • TemplateRenderException
  • Module contents
• padrick.Model package
  • Submodules
  • padrick.Model.CommonValidators module
    • check_sv_literal()
  • padrick.Model.Constants module
  • padrick.Model.PadDomain module
    • PadDomain
      • PadDomain.check_each_pad_instance_name_is_unique()
      • PadDomain.check_padsignal_with_same_name_have_same_size_and_direction()
      • PadDomain.check_port_group_names_are_unique()
      • PadDomain.check_static_connection_signals_are_not_bidirectional()
      • PadDomain.description
      • PadDomain.dynamic_pad_signals
      • PadDomain.dynamic_pad_signals_pad2soc
      • PadDomain.dynamic_pad_signals_soc2pad
      • PadDomain.error_on_empty_port_groups_but_existing_dynamic_pads()
      • PadDomain.error_on_nonempty_port_groups_but_without_any_dynamic_pads()
      • PadDomain.expand_multi_pads()
      • PadDomain.expand_multi_port_groups()
      • PadDomain.get_dynamic_pad_signals_for_mux_group()
      • PadDomain.get_dynamic_pad_signals_pad2soc_for_mux_group()
      • PadDomain.get_dynamic_pad_signals_soc2pad_for_mux_group()
      • PadDomain.get_dynamic_pads_in_mux_groups()
      • PadDomain.get_ports_in_mux_groups()
      • PadDomain.name
      • PadDomain.normalize_pad_mux_groups()
      • PadDomain.normalize_port_mux_groups()
      • PadDomain.override_port_mux_group()
      • PadDomain.override_signals
      • PadDomain.pad_list
      • PadDomain.pad_mux_group_sets
      • PadDomain.pad_types
      • PadDomain.port_groups
      • PadDomain.port_mux_group_sets
      • PadDomain.static_connection_signals
      • PadDomain.static_connection_signals_pad2soc
      • PadDomain.static_connection_signals_soc2pad
      • PadDomain.user_attr
      • PadDomain.validate_and_link_default_ports()
      • PadDomain.warn_about_orphan_pads_and_ports()
  • padrick.Model.PadInstance module
    • PadInstance
      • PadInstance.Config
      • PadInstance.connections
      • PadInstance.default_port
      • PadInstance.description
      • PadInstance.dynamic_pad_signals
      • PadInstance.dynamic_pad_signals_pad2soc
      • PadInstance.dynamic_pad_signals_soc2pad
      • PadInstance.expand_padinstance()
      • PadInstance.is_static
      • PadInstance.landing_pads
      • PadInstance.link_and_validate_connections()
      • PadInstance.lookup_pad_type()
      • PadInstance.multiple
      • PadInstance.mux_group_name
      • PadInstance.mux_groups
      • PadInstance.mux_groups_must_not_contain_uppercase_letters()
      • PadInstance.name
      • PadInstance.no_connections_for_pad_signal_of_kind_pad()
      • PadInstance.override_signals
      • PadInstance.pad_type
      • PadInstance.static_connection_signals
      • PadInstance.static_pad_signal_connections
      • PadInstance.static_pad_signals
      • PadInstance.user_attr
  • padrick.Model.PadSignal module
    • ConnectionType
      • ConnectionType.dynamic
      • ConnectionType.static
    • PadSignal
      • PadSignal.Config
      • PadSignal.and_override_signal
      • PadSignal.conn_type
      • PadSignal.default_reset_value
      • PadSignal.default_static_value
      • PadSignal.description
      • PadSignal.direction
      • PadSignal.kind
      • PadSignal.must_contain_conn_type_unsless_kind_pad()
      • PadSignal.must_contain_default_values_if_kind_input()
      • PadSignal.must_not_contain_default_value_if_landing_pad()
      • PadSignal.or_override_signal
      • PadSignal.static_signals
      • PadSignal.user_attr
      • PadSignal.validate_output_pad()
    • PadSignalKind
      • PadSignalKind.input
      • PadSignalKind.output
      • PadSignalKind.pad
    • Signal
      • Signal.direction
      • Signal.name
      • Signal.size
    • SignalDirection
      • SignalDirection.bidir
      • SignalDirection.pads2soc
      • SignalDirection.soc2pads
  • padrick.Model.PadType module
    • PadType
      • PadType.Config
      • PadType.check_unique_padtype_name()
      • PadType.check_valid_mako_template()
      • PadType.description
      • PadType.get_pad_signal()
      • PadType.must_contain_at_least_one_landing_pad()
      • PadType.name
      • PadType.pad_signals
      • PadType.template
      • PadType.user_attr
  • padrick.Model.Padframe module
    • Padframe
      • Padframe.manifest_version
      • Padframe.name
      • Padframe.description
      • Padframe.pad_domains
      • Padframe.Config
      • Padframe.check_manifest_version()
      • Padframe.description
      • Padframe.manifest_version
      • Padframe.name
      • Padframe.pad_domains
      • Padframe.user_attr
  • padrick.Model.ParseContext module
    • ParseContext
      • ParseContext.find_pad_signal_instances()
      • ParseContext.find_pad_type()
      • ParseContext.register_pad_type()
      • ParseContext.set_context()
  • padrick.Model.Port module
    • Port
      • Port.Config
      • Port.connections
      • Port.description
      • Port.expand_port()
      • Port.link_and_validate_connections()
      • Port.multiple
      • Port.mux_group_name
      • Port.mux_groups
      • Port.mux_groups_must_not_contain_uppercase_letters()
      • Port.name
      • Port.port_signals
      • Port.port_signals_chip2pad
      • Port.port_signals_pad2chip
      • Port.user_attr
  • padrick.Model.PortGroup module
    • PortGroup
      • PortGroup.Config
      • PortGroup.check_all_pad2soc_ports_have_default()
      • PortGroup.check_pad2soc_ports_are_not_multiple_connected()
      • PortGroup.check_port_signals_are_not_bidirectional()
      • PortGroup.check_ports_are_unique()
      • PortGroup.description
      • PortGroup.expand_default_value_for_connection_defaults()
      • PortGroup.expand_multi_ports()
      • PortGroup.expand_port_group()
      • PortGroup.get_ports_in_mux_groups()
      • PortGroup.multiple
      • PortGroup.mux_groups
      • PortGroup.name
      • PortGroup.output_defaults
      • PortGroup.port_signals
      • PortGroup.port_signals_pads2soc
      • PortGroup.port_signals_soc2pads
      • PortGroup.ports
      • PortGroup.user_attr
      • PortGroup.validate_and_link_output_defaults()
  • padrick.Model.SignalExpressionType module
    • SignalExpressionType
      • SignalExpressionType.ast
      • SignalExpressionType.evaluate_template()
      • SignalExpressionType.expression
      • SignalExpressionType.get_mapped_expr()
      • SignalExpressionType.is_const_expr
      • SignalExpressionType.is_empty
      • SignalExpressionType.is_single_signal
      • SignalExpressionType.signal_collection
      • SignalExpressionType.validate()
    • SignalNameRemapTransformer
      • SignalNameRemapTransformer.signal_name()
  • padrick.Model.TemplatedIdentifier module
    • TemplatedIdentifierType
      • TemplatedIdentifierType.ast
      • TemplatedIdentifierType.evaluate_template()
      • TemplatedIdentifierType.identifier
      • TemplatedIdentifierType.validate()
    • parse_expression()
  • padrick.Model.TemplatedIndexGrammar module
    • TemplatedIdxEvaluator
      • TemplatedIdxEvaluator.INDEX_VAR()
      • TemplatedIdxEvaluator.constant()
      • TemplatedIdxEvaluator.idx_expression()
      • TemplatedIdxEvaluator.idx_template()
      • TemplatedIdxEvaluator.number_to_base26()
      • TemplatedIdxEvaluator.term()
    • TemplatedIdxToStringTransformer
      • TemplatedIdxToStringTransformer.idx_template()
  • padrick.Model.TemplatedPortIdentifier module
    • TemplatedPortIdentifierType
      • TemplatedPortIdentifierType.evaluate_template()
      • TemplatedPortIdentifierType.identifier
      • TemplatedPortIdentifierType.validate()
  • padrick.Model.TemplatedString module
    • TemplatedStringType
      • TemplatedStringType.ast
      • TemplatedStringType.evaluate_template()
      • TemplatedStringType.identifier
      • TemplatedStringType.validate()
  • padrick.Model.UserAttrs module
    • UserAttrs
      • UserAttrs.expand_user_attrs()
      • UserAttrs.items()
      • UserAttrs.keys()
      • UserAttrs.values()
  • padrick.Model.Utilities module
    • cached_property()
    • sort_pads()
    • sort_ports()
    • sort_signals()
  • Module contents
• padrick.Utils package
  • Submodules
  • padrick.Utils.WorkingDir module
    • working_dir()
  • Module contents

Submodules

padrick.CLIEntryPoint module

padrick.ConfigParser module

padrick.ConfigParser.get_error_context(config_file: Path, line, column, context_before=4, context_after=4)

padrick.ConfigParser.get_file_location(config_data: CommentedMap, error_location: List[Union[str, int]]) → Tuple[Tuple[int, int], Mapping]

padrick.ConfigParser.get_human_readable_error_path(config_data: dict, error_location: List[Union[str, int]])

padrick.ConfigParser.parse_config(cls: T, config_file: Path, include_base_dir: Optional[Path] = None, ignore_includes=False) → Optional[T]

Module contents