PeakRDL-halcpp API Reference

For the full user documentation, tutorials, and usage guides, see the PeakRDL-halcpp documentation site.

This page covers the Python API reference only.

Contents:

• peakrdl_halcpp package
  • Subpackages
    • peakrdl_halcpp.include package
      • List of files:
    • peakrdl_halcpp.templates package
      • List of files:
  • Submodules
  • peakrdl_halcpp.exporter module
    • HalExporter
      • HalExporter.__init__()
      • HalExporter.cpp_dir
      • HalExporter.base_headers
      • HalExporter.copy_base_headers()
      • HalExporter.export()
      • HalExporter.process_template()
  • peakrdl_halcpp.halnode module
    • HalBaseNode
      • HalBaseNode.inst_name_hal
      • HalBaseNode.orig_type_name_hal
      • HalBaseNode.orig_type_name
      • HalBaseNode.is_bus
      • HalBaseNode.get_docstring()
      • HalBaseNode.halunrolled()
      • HalBaseNode.halchildren()
      • HalBaseNode.haldescendants()
    • HalFieldNode
      • HalFieldNode.__init__()
      • HalFieldNode.address_offset
      • HalFieldNode.cpp_access_type
      • HalFieldNode.get_enums()
    • HalRegNode
      • HalRegNode.__init__()
      • HalRegNode.cpp_access_type
      • HalRegNode.address_offset
      • HalRegNode.width
      • HalRegNode.get_template_line()
      • HalRegNode.get_cls_tmpl_params()
    • HalRegfileNode
      • HalRegfileNode.__init__()
      • HalRegfileNode.cpp_access_type
      • HalRegfileNode.address_offset
      • HalRegfileNode.get_template_line()
      • HalRegfileNode.get_cls_tmpl_params()
    • HalMemNode
      • HalMemNode.__init__()
      • HalMemNode.address_offset
      • HalMemNode.get_template_line()
      • HalMemNode.get_cls_tmpl_params()
    • HalAddrmapNode
      • HalAddrmapNode.__init__()
      • HalAddrmapNode.bus_offset
      • HalAddrmapNode.is_top_node
      • HalAddrmapNode.address_offset
      • HalAddrmapNode.is_bus
      • HalAddrmapNode.is_mem_addrmap
      • HalAddrmapNode.get_template_line()
      • HalAddrmapNode.get_cls_tmpl_params()
  • peakrdl_halcpp.halutils module
    • HalUtils
      • HalUtils.__init__()
      • HalUtils.ext_modules
      • HalUtils.get_include_file()
      • HalUtils.has_extern()
      • HalUtils.get_extern()
      • HalUtils.generate_file_header()