add missing license headers and file docstrings

PhilippvK · PhilippvK · commit 463da3d17b20 · 2024-08-16T15:15:41.000+02:00
diff --git a/examples/cdsl/rv_s4e b/examples/cdsl/rv_s4e
@@ -1 +1 @@
-Subproject commit f5394e8e0438b0c7e4bf16273efc74b8335215cc
+Subproject commit 4b4561fe20748b9da414080120481a39022e03d3
diff --git a/examples/cdsl/rv_xcorev b/examples/cdsl/rv_xcorev
@@ -1 +1 @@
-Subproject commit f66bf9df6b44ce8541ba529649368b3f3fa55040
+Subproject commit 39700bc7d433ee34246b49468c59a20bbe8b5526
diff --git a/seal5/__init__.py b/seal5/__init__.py
@@ -16,4 +16,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""TODO."""
+"""Seal5 Project."""
diff --git a/seal5/backends/coredsl2/__init__.py b/seal5/backends/coredsl2/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 CoreDSL2 backend"""
diff --git a/seal5/backends/llvmir/__init__.py b/seal5/backends/llvmir/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 LLVMIR backend"""
diff --git a/seal5/backends/patterngen/__init__.py b/seal5/backends/patterngen/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 PatternGen backend"""
diff --git a/seal5/backends/riscv_features/__init__.py b/seal5/backends/riscv_features/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 RISCVFeatures.td backend"""
diff --git a/seal5/backends/riscv_features/templates/__init__.py b/seal5/backends/riscv_features/templates/__init__.py
@@ -1,3 +1,22 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Templates for RISCVFeatures.td patches"""
 import pathlib
 
 template_dir = pathlib.Path(__file__).parent.resolve()
diff --git a/seal5/backends/riscv_gisel_legalizer/__init__.py b/seal5/backends/riscv_gisel_legalizer/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 RISCV GISel Legalizer backend"""
diff --git a/seal5/backends/riscv_instr_info/__init__.py b/seal5/backends/riscv_instr_info/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Backend for RISCVInstrInfo.td"""
diff --git a/seal5/backends/riscv_instr_info/templates/__init__.py b/seal5/backends/riscv_instr_info/templates/__init__.py
@@ -1,3 +1,23 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""MAKO templates for RISCVISAInfo.tf patches"""
+
 import pathlib
 
 template_dir = pathlib.Path(__file__).parent.resolve()
diff --git a/seal5/backends/riscv_isa_info/__init__.py b/seal5/backends/riscv_isa_info/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 RISCVISAInfo.td backend"""
diff --git a/seal5/backends/riscv_register_info/__init__.py b/seal5/backends/riscv_register_info/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 RISCVRegisterInfo.td backend"""
diff --git a/seal5/backends/viewer_seal5/__init__.py b/seal5/backends/viewer_seal5/__init__.py
@@ -1 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 """This module contains the graphical M2-ISA-R module viewer."""
diff --git a/seal5/backends/yaml/__init__.py b/seal5/backends/yaml/__init__.py
@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Seal5 YAML backend."""
diff --git a/seal5/cli/__init__.py b/seal5/cli/__init__.py
@@ -16,4 +16,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""TODO"""
+"""Seal5 Command Line"""
diff --git a/seal5/frontends/coredsl2_seal5/__init__.py b/seal5/frontends/coredsl2_seal5/__init__.py
@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file is part of the M2-ISA-R project: https://github.com/tum-ei-eda/M2-ISA-R
+#
+# Copyright (C) 2022
+# Chair of Electrical Design Automation
+# Technical University of Munich
diff --git a/seal5/transform/collect_immediate_operands/__init__.py b/seal5/transform/collect_immediate_operands/__init__.py
@@ -1,3 +1,21 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 from .collect import main as CollectImmediateOperands
 
 __all__ = ["CollectImmediateOperands"]
diff --git a/seal5/transform/collect_operand_types/__init__.py b/seal5/transform/collect_operand_types/__init__.py
@@ -1,3 +1,21 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 from .collect import main as CollectOperandTypes
 
 __all__ = ["CollectOperandTypes"]
diff --git a/seal5/transform/collect_raises/__init__.py b/seal5/transform/collect_raises/__init__.py
@@ -1,3 +1,21 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 from .collect import main as CollectRaises
 
 __all__ = ["CollectRaises"]
diff --git a/seal5/transform/collect_register_operands/__init__.py b/seal5/transform/collect_register_operands/__init__.py
@@ -1,3 +1,21 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 from .collect import main as CollectRegisterOperands
 
 __all__ = ["CollectRegisterOperands"]
diff --git a/seal5/transform/detect_inouts/__init__.py b/seal5/transform/detect_inouts/__init__.py
@@ -1,3 +1,21 @@
+#
+# Copyright (c) 2023 TUM Department of Electrical and Computer Engineering.
+#
+# This file is part of Seal5.
+# See https://github.com/tum-ei-eda/seal5.git for further info.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 from .collect import main as DetectInouts
 
 __all__ = ["DetectInouts"]
diff --git a/seal5/transform/detect_side_effects/__init__.py b/seal5/transform/detect_side_effects/__init__.py
diff --git a/seal5/transform/drop_unused/__init__.py b/seal5/transform/drop_unused/__init__.py
diff --git a/seal5/transform/eliminate_mod_rfs/__init__.py b/seal5/transform/eliminate_mod_rfs/__init__.py
diff --git a/seal5/transform/eliminate_rd_cmp_zero/__init__.py b/seal5/transform/eliminate_rd_cmp_zero/__init__.py
diff --git a/seal5/transform/explicit_truncations/__init__.py b/seal5/transform/explicit_truncations/__init__.py
diff --git a/seal5/transform/filter_model/__init__.py b/seal5/transform/filter_model/__init__.py
diff --git a/seal5/transform/infer_types/__init__.py b/seal5/transform/infer_types/__init__.py
diff --git a/seal5/transform/optimize_instructions/__init__.py b/seal5/transform/optimize_instructions/__init__.py
diff --git a/seal5/transform/process_settings/__init__.py b/seal5/transform/process_settings/__init__.py
diff --git a/seal5/transform/simplify_trivial_slices/__init__.py b/seal5/transform/simplify_trivial_slices/__init__.py

Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,4 @@`
`16`	`16`	`# See the License for the specific language governing permissions and`
`17`	`17`	`# limitations under the License.`
`18`	`18`	`#`
`19`		`-"""TODO."""`
	`19`	`+"""Seal5 Project."""`