From 793cbbd3e8e7b982af2ad24bea1e7fed163b934d Mon Sep 17 00:00:00 2001
From: Daniel van der Schuur <schuur@astron.nl>
Date: Wed, 23 Jan 2019 09:59:36 +0000
Subject: [PATCH] -Added author, purpose, description.
---
.../common/src/vhdl/common_lfsr_sequences_pkg.vhd | 11 ++++++++++-
libraries/base/common/src/vhdl/common_pkg.vhd | 12 +++++++++++-
libraries/base/common/src/vhdl/common_str_pkg.vhd | 12 ++++++++++--
libraries/base/common/tb/vhdl/tb_common_pkg.vhd | 11 ++++++++++-
4 files changed, 41 insertions(+), 5 deletions(-)
diff --git a/libraries/base/common/src/vhdl/common_lfsr_sequences_pkg.vhd b/libraries/base/common/src/vhdl/common_lfsr_sequences_pkg.vhd
index f4b15c5e2a..a0872d1629 100644
--- a/libraries/base/common/src/vhdl/common_lfsr_sequences_pkg.vhd
+++ b/libraries/base/common/src/vhdl/common_lfsr_sequences_pkg.vhd
@@ -1,6 +1,6 @@
--------------------------------------------------------------------------------
--
--- Copyright (C) 2009
+-- Copyright (C) 2019
-- ASTRON (Netherlands Institute for Radio Astronomy) <http://www.astron.nl/>
-- JIVE (Joint Institute for VLBI in Europe) <http://www.jive.nl/>
-- P.O.Box 2, 7990 AA Dwingeloo, The Netherlands
@@ -19,6 +19,15 @@
-- along with this program. If not, see <http://www.gnu.org/licenses/>.
--
--------------------------------------------------------------------------------
+
+-- Author:
+-- . Eric Kooistra
+-- Purpose:
+-- . Linear Feedback Shift Register based pseudo random sequence generation.
+-- Interface:
+-- . [n/a]
+-- Description:
+-- . Based on Xilinx application note xapp052.
LIBRARY IEEE;
USE IEEE.std_logic_1164.ALL;
diff --git a/libraries/base/common/src/vhdl/common_pkg.vhd b/libraries/base/common/src/vhdl/common_pkg.vhd
index 4ceb214df3..32995bba78 100644
--- a/libraries/base/common/src/vhdl/common_pkg.vhd
+++ b/libraries/base/common/src/vhdl/common_pkg.vhd
@@ -1,6 +1,6 @@
-------------------------------------------------------------------------------
--
--- Copyright (C) 2009
+-- Copyright (C) 2019
-- ASTRON (Netherlands Institute for Radio Astronomy) <http://www.astron.nl/>
-- P.O.Box 2, 7990 AA Dwingeloo, The Netherlands
--
@@ -19,6 +19,16 @@
--
-------------------------------------------------------------------------------
+-- Author:
+-- . Eric Kooistra
+-- Purpose:
+-- . Collection of commonly used base funtions
+-- Interface:
+-- . [n/a]
+-- Description:
+-- . This is a package containing generic constants and functions.
+-- . More information can be found in the comments near the code.
+
LIBRARY IEEE;
USE IEEE.STD_LOGIC_1164.ALL;
USE IEEE.NUMERIC_STD.ALL;
diff --git a/libraries/base/common/src/vhdl/common_str_pkg.vhd b/libraries/base/common/src/vhdl/common_str_pkg.vhd
index 2d8c72da6e..324bd41c21 100644
--- a/libraries/base/common/src/vhdl/common_str_pkg.vhd
+++ b/libraries/base/common/src/vhdl/common_str_pkg.vhd
@@ -1,6 +1,6 @@
-------------------------------------------------------------------------------
--
--- Copyright (C) 2012
+-- Copyright (C) 2019
-- ASTRON (Netherlands Institute for Radio Astronomy) <http://www.astron.nl/>
-- P.O.Box 2, 7990 AA Dwingeloo, The Netherlands
--
@@ -19,6 +19,15 @@
--
-------------------------------------------------------------------------------
+-- Author:
+-- . Daniel van der Schuur
+-- Purpose:
+-- . Collection of commonly used string funtions
+-- Interface:
+-- . [n/a]
+-- Description:
+-- . None
+
LIBRARY IEEE, common_lib;
USE IEEE.STD_LOGIC_1164.ALL;
USE IEEE.NUMERIC_STD.ALL;
@@ -203,7 +212,6 @@ PACKAGE BODY common_str_pkg IS
END hex_nibble_to_slv;
FUNCTION int_to_str(int: INTEGER) RETURN STRING IS
--- CONSTANT c_max_len_int : NATURAL := 20;
VARIABLE v_line: LINE;
VARIABLE v_str: STRING(1 TO nof_digits_int(int)):= (OTHERS => ' ');
BEGIN
diff --git a/libraries/base/common/tb/vhdl/tb_common_pkg.vhd b/libraries/base/common/tb/vhdl/tb_common_pkg.vhd
index db6e7b3faa..00aac656e5 100644
--- a/libraries/base/common/tb/vhdl/tb_common_pkg.vhd
+++ b/libraries/base/common/tb/vhdl/tb_common_pkg.vhd
@@ -1,6 +1,6 @@
-------------------------------------------------------------------------------
--
--- Copyright (C) 2011
+-- Copyright (C) 2019
-- ASTRON (Netherlands Institute for Radio Astronomy) <http://www.astron.nl/>
-- JIVE (Joint Institute for VLBI in Europe) <http://www.jive.nl/>
-- P.O.Box 2, 7990 AA Dwingeloo, The Netherlands
@@ -20,6 +20,15 @@
--
-------------------------------------------------------------------------------
+-- Author:
+-- . Eric Kooistra
+-- Purpose:
+-- . Collection of commonly used base funtions for simulations
+-- Interface:
+-- . [n/a]
+-- Description:
+-- . More information can be found in the comments near the code.
+
LIBRARY IEEE;
USE IEEE.std_logic_1164.ALL;
USE IEEE.NUMERIC_STD.ALL;
--
GitLab