From b0dc4b9749347d9309bea2106d495520f7694887 Mon Sep 17 00:00:00 2001
From: Eric Kooistra <kooistra@astron.nl>
Date: Wed, 30 Aug 2023 14:27:20 +0200
Subject: [PATCH] Add more description to the reorder transpose functions.

---
 libraries/base/reorder/src/vhdl/reorder_pkg.vhd | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/libraries/base/reorder/src/vhdl/reorder_pkg.vhd b/libraries/base/reorder/src/vhdl/reorder_pkg.vhd
index 4db2a54945..dc310b6389 100644
--- a/libraries/base/reorder/src/vhdl/reorder_pkg.vhd
+++ b/libraries/base/reorder/src/vhdl/reorder_pkg.vhd
@@ -78,6 +78,17 @@ package reorder_pkg is
 
   -----------------------------------------------------------------------------
   -- Reorder transpose
+  --
+  -- There are several functions that yield the same transpose, but for
+  -- different purposes.
+  -- . func_reorder_transpose_indices() and
+  --   func_reorder_transpose_indices_impl() calculate a lookup table of all
+  --   indices in advance using loops.
+  -- . func_reorder_transpose_packet() applies func_reorder_transpose_indices()
+  --   on a packet list of octet values, for in a test bench.
+  -- . func_reorder_transpose() and func_reorder_transpose_look_up()
+  --   sequentially calculate the next index per clock cycle and use
+  --   t_reorder_transpose, for in a synthesis component.
   -----------------------------------------------------------------------------
 
   -- Block and data counters to derive select_copi.address for transpose
-- 
GitLab