From 0cce1537426db16c4c4e4842008a8f5bfe7f0acf Mon Sep 17 00:00:00 2001
From: Eric Kooistra <kooistra@astron.nl>
Date: Thu, 5 Aug 2021 11:25:55 +0200
Subject: [PATCH] Improved comment for proc_dp_verify_sync() for fractional
 sync periods.

---
 ...{dp_bsn_sync_interval.vhd => dp_bsn_sync_scheduler.vhd} | 0
 libraries/base/dp/tb/vhdl/tb_dp_bsn_source_v2.vhd          | 7 +++++--
 ..._bsn_sync_interval.vhd => tb_dp_bsn_sync_scheduler.vhd} | 0
 3 files changed, 5 insertions(+), 2 deletions(-)
 rename libraries/base/dp/src/vhdl/{dp_bsn_sync_interval.vhd => dp_bsn_sync_scheduler.vhd} (100%)
 rename libraries/base/dp/tb/vhdl/{tb_dp_bsn_sync_interval.vhd => tb_dp_bsn_sync_scheduler.vhd} (100%)

diff --git a/libraries/base/dp/src/vhdl/dp_bsn_sync_interval.vhd b/libraries/base/dp/src/vhdl/dp_bsn_sync_scheduler.vhd
similarity index 100%
rename from libraries/base/dp/src/vhdl/dp_bsn_sync_interval.vhd
rename to libraries/base/dp/src/vhdl/dp_bsn_sync_scheduler.vhd
diff --git a/libraries/base/dp/tb/vhdl/tb_dp_bsn_source_v2.vhd b/libraries/base/dp/tb/vhdl/tb_dp_bsn_source_v2.vhd
index f66e76f493..7f15f845fc 100644
--- a/libraries/base/dp/tb/vhdl/tb_dp_bsn_source_v2.vhd
+++ b/libraries/base/dp/tb/vhdl/tb_dp_bsn_source_v2.vhd
@@ -223,8 +223,11 @@ BEGIN
   proc_dp_verify_sop_and_eop(clk, bs_sosi.valid, bs_sosi.sop, bs_sosi.eop, hold_bs_sop);  -- Verify that sop and eop come in pairs
   proc_dp_verify_sync(clk, verify_sync, bs_sosi.sync, bs_sosi.sop, expected_sync_dly);  -- Verify sync at sop and at expected_sync
 
-  -- Verify sync at sop and at expected_sync, but now using the
-  -- proc_dp_verify_sync() variant that can verify fractional sync periods
+  -- Verify sync at sop and at expected_sync again:
+  -- . now using the proc_dp_verify_sync() variant for dp_bsn_source_v2 that
+  --   can verify fractional sync periods.
+  -- . the proc_dp_verify_sync() v2 variant was made later, so in fact
+  --   this tb_dp_bsn_source_v2 verifies this new v2 procedure.
   proc_dp_verify_sync(TO_UINT(bsn_init),
                       g_pps_interval,
                       g_block_size,
diff --git a/libraries/base/dp/tb/vhdl/tb_dp_bsn_sync_interval.vhd b/libraries/base/dp/tb/vhdl/tb_dp_bsn_sync_scheduler.vhd
similarity index 100%
rename from libraries/base/dp/tb/vhdl/tb_dp_bsn_sync_interval.vhd
rename to libraries/base/dp/tb/vhdl/tb_dp_bsn_sync_scheduler.vhd
-- 
GitLab