# {py:mod}`acacia.system` ```{py:module} acacia.system ``` ```{autodoc2-docstring} acacia.system :parser: myst :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`SystemState ` - ```{autodoc2-docstring} acacia.system.SystemState :parser: myst :summary: ``` * - {py:obj}`System ` - ```{autodoc2-docstring} acacia.system.System :parser: myst :summary: ``` ```` ### API ```{py:exception} AcaciaSystemError() :canonical: acacia.system.AcaciaSystemError Bases: {py:obj}`RuntimeError` ``` `````{py:class} SystemState :canonical: acacia.system.SystemState Bases: {py:obj}`enum.Enum` ```{autodoc2-docstring} acacia.system.SystemState :parser: myst ``` ````{py:attribute} SPECIFICATION :canonical: acacia.system.SystemState.SPECIFICATION :value: > 0 ```{autodoc2-docstring} acacia.system.SystemState.SPECIFICATION :parser: myst ``` ```` ````{py:attribute} ASSEMBLY :canonical: acacia.system.SystemState.ASSEMBLY :value: > 1 ```{autodoc2-docstring} acacia.system.SystemState.ASSEMBLY :parser: myst ``` ```` ````{py:attribute} ALLOCATION :canonical: acacia.system.SystemState.ALLOCATION :value: > 2 ```{autodoc2-docstring} acacia.system.SystemState.ALLOCATION :parser: myst ``` ```` ````{py:attribute} FINAL :canonical: acacia.system.SystemState.FINAL :value: > 3 ```{autodoc2-docstring} acacia.system.SystemState.FINAL :parser: myst ``` ```` ````` `````{py:class} System(sys_arch: acacia.arch.Arch, paddr_top: int, dtb: typing.Optional[acacia.dtb.DeviceTreeBlob] = None) :canonical: acacia.system.System ```{autodoc2-docstring} acacia.system.System :parser: myst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} acacia.system.System.__init__ :parser: myst ``` ````{py:method} assemble() :canonical: acacia.system.System.assemble ```{autodoc2-docstring} acacia.system.System.assemble :parser: myst ``` ```` ````{py:method} resolve_subsystems() :canonical: acacia.system.System.resolve_subsystems ```{autodoc2-docstring} acacia.system.System.resolve_subsystems :parser: myst ``` ```` ````{py:method} auto_allocate() :canonical: acacia.system.System.auto_allocate ```{autodoc2-docstring} acacia.system.System.auto_allocate :parser: myst ``` ```` ````{py:method} make_config_structs(build_dir: pathlib.Path = pathlib.Path('./'), dump: bool = False) :canonical: acacia.system.System.make_config_structs ```{autodoc2-docstring} acacia.system.System.make_config_structs :parser: myst ``` ```` ````{py:method} render() -> xml.etree.ElementTree.Element :canonical: acacia.system.System.render ```{autodoc2-docstring} acacia.system.System.render :parser: myst ``` ```` ````{py:method} write_xml_file(path: pathlib.Path) :canonical: acacia.system.System.write_xml_file ```{autodoc2-docstring} acacia.system.System.write_xml_file :parser: myst ``` ```` ````{py:property} microkit_alloc_allowed :canonical: acacia.system.System.microkit_alloc_allowed :type: bool ```{autodoc2-docstring} acacia.system.System.microkit_alloc_allowed :parser: myst ``` ```` ````{py:property} manual_alloc_allowed :canonical: acacia.system.System.manual_alloc_allowed :type: bool ```{autodoc2-docstring} acacia.system.System.manual_alloc_allowed :parser: myst ``` ```` ````{py:property} system_assembled :canonical: acacia.system.System.system_assembled :type: bool ```{autodoc2-docstring} acacia.system.System.system_assembled :parser: myst ``` ```` ````{py:method} __repr__() -> str :canonical: acacia.system.System.__repr__ ```` `````