From 1761d061f06f9be9f8b2ff86354f2612dac93b08 Mon Sep 17 00:00:00 2001
From: Reinier van der Walle <walle@astron.nl>
Date: Fri, 11 Jun 2021 12:08:23 +0200
Subject: [PATCH] Added description to dp_sync_recover

---
 libraries/base/dp/src/vhdl/dp_sync_recover.vhd | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/libraries/base/dp/src/vhdl/dp_sync_recover.vhd b/libraries/base/dp/src/vhdl/dp_sync_recover.vhd
index 9b556fdb5b..8bbb413521 100644
--- a/libraries/base/dp/src/vhdl/dp_sync_recover.vhd
+++ b/libraries/base/dp/src/vhdl/dp_sync_recover.vhd
@@ -20,16 +20,16 @@
 
 -------------------------------------------------------------------------------
 -- Author : R vd Walle
--- Purpose : * Insert extra sync pulses. 
--- Description:
---   Every nof_blk_per_sync block a sync pulse is created at the output. The block
---   counter resets if a sync arrives at the input or when nof_blk_per_sync is reached.
---   nof_blk_per_sync is controllable using M&C.
---
+-- Purpose : Recover DP control signals (sync, valid, sop, eop, bsn) from input with only valid and sync. 
+-- Description: dp_sync_recover generates the control signals based on in_sosi.sync, in_sosi.bsn and val.
+--  . A data counter is used to count the valids from the input "val" and compare to g_nof_data_per_block to generate sop/eop.
+--  . A block counter is used generate the BSN 
+--  . The BSN at sync of in_sosi is captured to determine when to generate the sync at the output.
+--  . out_sosi.valid is directly connected to val.
 -- Remarks:
--- . There is no support for back pressure. 
--- . It does not compensate for missing data or extra data. There is NO reset function. It assumes that the 
---   incoming data is perfectly aligned. Use a dp_sync_checker to assure the incoming data is perfect.      
+--  . The val input signal should be connected to the desired valid of the output. It determines when 
+--    the first block will start.
+--  . g_initial_bsn can be used to start with a non-zero bsn
 -------------------------------------------------------------------------------
 
 LIBRARY IEEE, common_lib;
-- 
GitLab