Make REUSE copyright notice the same as in other VILLASframework projects and fix comments (#82)

This edits the headers in every file so the copyright notice mentions RWTH Aachen University. We also update some copyright years and fix various comments so the header is the same across all of VILLASframework.

* Harmonize comment and code-style

Signed-off-by: Steffen Vogel <[email protected]>

* Harmonize comment and code-style

Signed-off-by: Steffen Vogel <[email protected]>

---------

Signed-off-by: Steffen Vogel <[email protected]>

Author: stv0g

.dockerignore

@@ -1,6 +1,6 @@
 # Project-wide dockerignore file
 #
-# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
 
 *

.editorconfig

@@ -1,6 +1,6 @@
 # EditorConfig is awesome: http://EditorConfig.org
 #
-# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
 
 # top-most EditorConfig file

.gitignore

@@ -1,6 +1,6 @@
 # Project-wide gitignore file
 #
-# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
 
 build/

.gitlab-ci.yml

@@ -1,6 +1,6 @@
 # GitLab CI configuration
 #
-# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
 
 variables:
@@ -10,24 +10,11 @@ variables:
   DOCKER_IMAGE_DEV: villas/fpga-dev
 
 stages:
-- lint
 - prepare
 - build
 - test
 
-# Stage: lint
-##############################################################################
-
-reuse:
-  stage: lint
-  image:
-    name: fsfe/reuse:latest
-    entrypoint: [""]
-  script:
-  - reuse lint
-
 # Stage: prepare
-##############################################################################
 
 # Build docker image which is used to build & test VILLASnode
 docker-dev:
@@ -38,7 +25,6 @@ docker-dev:
   - docker
 
 # Stage: build
-##############################################################################
 
 build:source:
   stage: build
@@ -54,7 +40,6 @@ build:source:
   - docker
 
 # Stage: test
-##############################################################################
 
 test:unit:
   stage: test
@@ -102,3 +87,11 @@ test:cppcheck:
     paths:
     - cppcheck.log
     expose_as: cppcheck
+
+test:reuse:
+  stage: test
+  image:
+    name: fsfe/reuse:latest
+    entrypoint: [""]
+  script:
+  - reuse lint

.gitmodules

@@ -1,6 +1,6 @@
 # Git submodule list
 #
-# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
 
 [submodule "common"]

.reuse/dep5

@@ -4,5 +4,5 @@ Upstream-Contact: Steffen Vogel <[email protected]>
 Source: https://fein-aachen.org/en/projects/villas-fpga/
 
 Files: .vscode/* doc/pictures/* etc/**.json
-Copyright: 2018-2022, Institute for Automation of Complex Power Systems, EONERC
+Copyright: 2018-2023, Institute for Automation of Complex Power Systems, RWTH Aachen University
 License: Apache-2.0

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+<!--
+SPDX-FileCopyrightText: 2023 OPAL-RT Germany GmbH
+SPDX-License-Identifier: Apache-2.0
+-->
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
@@ -23,8 +28,3 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Sourcecode import from VILLASnode project:  
   http://git.rwth-aachen.de/VILLASframework/VILLASnode
-
-## License
-
-SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
-SPDX-License-Identifier: Apache-2.0

CMakeLists.txt

@@ -1,9 +1,8 @@
 ## CMakeLists.txt
 #
 # Author: Daniel Krebs <[email protected]>
-# SPDX-FileCopyrightText: 2018 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2018 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
-##############################################################################
 
 cmake_minimum_required(VERSION 3.5)
 

Dockerfile

@@ -9,9 +9,8 @@
 #   make docker
 #
 # Author: Steffen Vogel <[email protected]>
-# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
-###################################################################################
 
 FROM rockylinux:9
 

LICENSES/BSD-3-Clause.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Institute for Automation of Complex Power Systems, EONERC.
+Copyright (c) 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

LICENSES/WTFPL.txt

@@ -1,7 +1,7 @@
 DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
 Version 2, December 2004
 
-Copyright (C) 2017 Institute for Automation of Complex Power Systems, EONERC
+Copyright (C) 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 
 Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.
 

README.md

@@ -9,20 +9,14 @@ VILLASfpga supports Xilinx FPGAs connected to a Linux system via PCI-Express or
 
 User documentation is available here: <https://villas.fein-aachen.org/doc/fpga.html>
 
-## Copyright
-
-- 2022 Niklas Eiling <[email protected]>
-- 2018-2022 Steffen Vogel <[email protected]>
-- 2018 Daniel Krebs <[email protected]>
-
 ## License
 
 This project is released under the terms of the [Apache 2.0](LICENSE) license:
 
-SPDX-FileCopyrightText: 2022-2023 Niklas Eiling
-SPDX-FileCopyrightText: 2018-2023 Steffen Vogel
-SPDX-FileCopyrightText: 2018 Daniel Krebs
-SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2022-2023 Niklas Eiling <[email protected]>
+- SPDX-FileCopyrightText: 2018-2023 Steffen Vogel <[email protected]>
+- SPDX-FileCopyrightText: 2018 Daniel Krebs <[email protected]>
+- SPDX-License-Identifier: Apache-2.0
 
 We kindly ask all academic publications employing components of VILLASframework to cite one of the following papers:
 

cmake/FindCriterion.cmake

@@ -5,9 +5,8 @@
 #  CRITERION_INCLUDE_DIRS - The Criterion include directories
 #  CRITERION_LIBRARIES - The libraries needed to use Criterion
 #
-# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: WTFPL
-##############################################################################
 
 find_package(PkgConfig)
 
@@ -20,7 +19,8 @@ set(CRITERION_LIBRARIES ${CRITERION_LIBRARY})
 set(CRITERION_INCLUDE_DIRS ${CRITERION_INCLUDE_DIR})
 
 include(FindPackageHandleStandardArgs)
-# handle the QUIET and REQUIRED arguments and set CRITERION_FOUND to TRUE
+
+# Handle the QUIET and REQUIRED arguments and set CRITERION_FOUND to TRUE
 # if all listed variables are TRUE
 find_package_handle_standard_args(Criterion DEFAULT_MSG
                                   CRITERION_LIBRARY CRITERION_INCLUDE_DIR)

gpu/CMakeLists.txt

@@ -1,9 +1,8 @@
 ## CMakeLists.txt
 #
 # Author: Daniel Krebs <[email protected]>
-# SPDX-FileCopyrightText: 2018 Institute for Automation of Complex Power Systems, EONERC
+# SPDX-FileCopyrightText: 2018 Institute for Automation of Complex Power Systems, RWTH Aachen University
 # SPDX-License-Identifier: Apache-2.0
-##############################################################################
 
 cmake_minimum_required(VERSION 3.8)
 

gpu/include/villas/gpu.hpp

@@ -1,9 +1,9 @@
-/** GPU managment.
+/* GPU managment.
  *
  * Author: Daniel Krebs <[email protected]>
- * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
- *********************************************************************************/
+ */
 
 #pragma once
 
@@ -96,5 +96,5 @@ class GpuFactory : public Plugin {
 	Logger logger;
 };
 
-} /* namespace villas */
-} /* namespace gpu */
+} // namespace villas
+} // namespace gpu

gpu/kernels.hpp

@@ -1,9 +1,9 @@
-/** GPU Kernels.
+/* GPU Kernels.
  *
  * Author: Daniel Krebs <[email protected]>
- * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
- *********************************************************************************/
+ */
 
 #pragma once
 
@@ -19,5 +19,5 @@ kernel_mailbox(volatile uint32_t *mailbox, volatile uint32_t* counter);
 __global__ void
 kernel_memcpy(volatile uint8_t* dst, volatile uint8_t* src, size_t length);
 
-} /* namespace villas */
-} /* namespace gpu */
+} // namespace villas
+} // namespace gpu

gpu/src/gpu.cpp

@@ -1,9 +1,9 @@
-/** GPU managment.
+/* GPU managment.
  *
  * Author: Daniel Krebs <[email protected]>
- * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
- *********************************************************************************/
+ */
 
 #include <cstdio>
 #include <cstdint>

gpu/src/kernels.cu

@@ -1,7 +1,7 @@
 /** GPU Kernels.
  *
  * Author: Daniel Krebs <[email protected]>
- * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
  *********************************************************************************/
 

include/villas/fpga/card.hpp

@@ -1,12 +1,13 @@
-/** FPGA card
+/* FPGA card
  *
  * This class represents a FPGA device.
  *
  * Author: Steffen Vogel <[email protected]>
  * Author: Daniel Krebs <[email protected]>
- * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
- *********************************************************************************/
+ */
+
 #pragma once
 
 #include <set>
@@ -52,5 +53,5 @@ class Card
         Logger logger;
 };
 
-} /* namespace fpga */
-} /* namespace villas */
+} // namespace fpga
+} // namespace villas

include/villas/fpga/config.h

@@ -1,12 +1,12 @@
-/** Compile time configuration
+/* Compile time configuration
  *
  * This file contains some compiled-in settings.
  * This settings are not part of the configuration file.
  *
  * Author: Steffen Vogel <[email protected]>
- * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
- *********************************************************************************/
+ */
 
 #pragma once
 
@@ -15,6 +15,6 @@
 #define FPGA_PCI_VID_XILINX	0x10ee
 #define FPGA_PCI_PID_VFPGA	0x7022
 
-/** AXI Bus frequency for all components
+/* AXI Bus frequency for all components
  * except RTDS AXI Stream bridge which runs at RTDS_HZ (100 Mhz) */
 #define FPGA_AXI_HZ		125000000 // 125 MHz

include/villas/fpga/core.hpp

@@ -1,12 +1,12 @@
-/** Interlectual Property component.
+/* Interlectual Property component.
  *
  * This class represents a module within the FPGA.
  *
  * Author: Steffen Vogel <[email protected]>
  * Author: Daniel Krebs <[email protected]>
- * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2017 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
- *********************************************************************************/
+ */
 
 #pragma once
 
@@ -342,6 +342,6 @@ virtual
 	};
 };
 
-} /* namespace ip */
-} /* namespace fpga */
-} /* namespace villas */
+} // namespace ip
+} // namespace fpga
+} // namespace villas

include/villas/fpga/dma.h

@@ -1,9 +1,9 @@
-/** C bindings for VILLASfpga
+/* C bindings for VILLASfpga
  *
  * Author: Niklas Eiling <[email protected]>
  * SPDX-FileCopyrightText: 2023 Niklas Eiling <[email protected]>
  * SPDX-License-Identifier: Apache-2.0
- ******************************************************************************/
+ */
 
 #ifndef _VILLASFPGA_DMA_H
 #define _VILLASFPGA_DMA_H
@@ -36,4 +36,4 @@ int villasfpga_write_complete(villasfpga_handle handle, size_t *size);
 } // extern "C"
 #endif
 
-#endif /* _VILLASFPGA_DMA_H */
+#endif // _VILLASFPGA_DMA_H

include/villas/fpga/ips/aurora.hpp

@@ -1,9 +1,9 @@
-/** Driver for wrapper around Aurora (acs.eonerc.rwth-aachen.de:user:aurora)
+/* Driver for wrapper around Aurora (acs.eonerc.rwth-aachen.de:user:aurora)
  *
  * Author: Hatim Kanchwala <[email protected]>
- * SPDX-FileCopyrightText: 2020 Institute for Automation of Complex Power Systems, EONERC
+ * SPDX-FileCopyrightText: 2020 Institute for Automation of Complex Power Systems, RWTH Aachen University
  * SPDX-License-Identifier: Apache-2.0
- *********************************************************************************/
+ */
 
 #pragma once
 
@@ -50,6 +50,6 @@ class Aurora : public Node {
 	static constexpr const char registerMemory[] = "reg0";
 };
 
-} /* namespace ip */
-} /* namespace fpga */
-} /* namespace villas */
+} // namespace ip
+} // namespace fpga
+} // namespace villas