From 3b80f37d70c5459b9773b7a5e8f5fc3b218ae0ad Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Thu, 7 Oct 2021 19:52:24 +0200
Subject: [PATCH] L2SS-434: Improved presentation of mask attributes
---
docs/source/devices/devices.rst | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)
diff --git a/docs/source/devices/devices.rst b/docs/source/devices/devices.rst
index 65ef7b1a0..473860415 100644
--- a/docs/source/devices/devices.rst
+++ b/docs/source/devices/devices.rst
@@ -4,23 +4,26 @@ Devices
RECV
----------
-The ``recv == Device("LTS/RECV/1")`` device controls the RCUs, the LBA antennas, and HBA tiles. Central to its operation are the masks:
+The ``recv == Device("LTS/RECV/1")`` device controls the RCUs, the LBA antennas, and HBA tiles. Central to its operation are the masks (see also :ref:`attribute-masks`):
-- The ``RCU_mask_RW`` attribute is an array of ``bool[N_RCUs]``. It controls which RCUs will actually be configured, when fields referring to RCUs are set.
-- The ``Ant_mask_RW`` attribute is an array of ``bool[N_RCUs][N_Antennas_per_RCU]``. It controls which antennas will actually be configured, when fields referring to antennas are set.
+:RCU_mask_RW: Controls which RCUs will actually be configured when attributes referring to RCUs are written.
-See :ref:`attribute-masks` for how the masks are used.
+ :type: ``bool[N_RCUs]``
+
+:Ant_mask_RW: Controls which antennas will actually be configured when attributes referring to antennas are written.
+
+ :type: ``bool[N_RCUs][N_Antennas_per_RCU]``
Typically, ``N_RCUs == 32``, and ``N_Antennas_per_RCU == 3``.
SDP
-----------
-The ``sdp == Device("LTS/SDP/1")``` device controls the digital signal processing in SDP, performed by the firmware on the FPGAs on the Uniboards. Central to its operation is the mask:
+The ``sdp == Device("LTS/SDP/1")``` device controls the digital signal processing in SDP, performed by the firmware on the FPGAs on the Uniboards. Central to its operation is the mask (see also :ref:`attribute-masks`):
-- The ``TR_fpga_mask_RW`` attribute is an array of ``bool[N_fpgas]``. It controls which FPGAs will actually be configured, when fields referring to FPGAs are set.
+:TR_fpga_mask_RW: Controls which FPGAs will actually be configured when attributes referring to FPGAs are written.
-See :ref:`attribute-masks` for how the masks are used.
+ :type: ``bool[N_fpgas]``
Typically, ``N_fpgas == 16``.
--
GitLab