From f25ae33b7cedea8d76b8e5348114ff54075c6200 Mon Sep 17 00:00:00 2001
From: Bryan Biedenkapp <gatekeep@gmail.com>
Date: Sat, 17 Aug 2024 15:45:52 -0400
Subject: [PATCH] better document FIFO adjustments and queue adjustments;

---
 configs/config.example.yml | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)

diff --git a/configs/config.example.yml b/configs/config.example.yml
index f9b040dc..3bbfb82f 100644
--- a/configs/config.example.yml
+++ b/configs/config.example.yml
@@ -157,7 +157,8 @@ protocols:
         silenceThreshold: 21
         # Maximum number of lost frames before terminating a call.
         frameLossThreshold: 2
-        # Internal data queue size (in DMR packets).
+        # Internal data queue size (in DMR frames). This is the queue used internally to buffer frames before they
+        # are sent to the air interface modem.
         queueSize: 31
         # Flag indicating whether or not verbose logging is enabled.
         verbose: true
@@ -250,7 +251,8 @@ protocols:
         silenceThreshold: 124
         # Maximum number of lost frames before terminating a call.
         frameLossThreshold: 6
-        # Internal data queue size (in P25 packets).
+        # Internal data queue size (in P25 LDU frames). This is the queue used internally to buffer frames before they
+        # are sent to the air interface modem.
         queueSize: 12
         # Flag indicating whether or not verbose logging is enabled.
         verbose: true
@@ -295,7 +297,8 @@ protocols:
         silenceThreshold: 14
         # Maximum number of lost frames before terminating a call.
         frameLossThreshold: 4
-        # Internal data queue size (in NXDN packets).
+        # Internal data queue size (in NXDN frames). This is the queue used internally to buffer frames before they
+        # are sent to the air interface modem.
         queueSize: 31
         # Flag indicating whether or not verbose logging is enabled.
         verbose: true
@@ -487,11 +490,23 @@ system:
         # Amount of packet correlations that should occur before P25 data is returned from the modem to the host.
         # (Note: Changing this value will impact P25 protocol stability, and should not be altered.)
         p25CorrCount: 8
-        # Size (in bytes) of the DMR transmit FIFO buffer.
+        # Size (in bytes) of the DMR transmit FIFO buffer. It is not recommended to adjust this unless absolutely
+        # necessary, excessive sizes will cause delays in transmitted frames due to excessive buffering.
+        #   Calculation Formula: (DMR Frame Size (33 bytes) * x Frames) + Pad Bytes = FIFO Buffer Size Bytes
+        #   Default (Recommended) Value: (33 * 16) + 5 = 560
+        #   "Oversized" Value: (33 * 24) + 5 = 797
         dmrFifoLength: 560
-        # Size (in bytes) of the P25 transmit FIFO buffer.
+        # Size (in bytes) of the P25 transmit FIFO buffer. It is not recommended to adjust this unless absolutely
+        # necessary, excessive sizes will cause delays in transmitted frames due to excessive buffering.
+        #   Calculation Formula: (P25 LDU Frame Size (216 bytes) * x Frames) + Pad Bytes = FIFO Buffer Size Bytes
+        #   Default (Recommended) Value: (216 * 2) + 90 = 522
+        #   "Oversized" Value: (216 * 4) + 90 = 954
         p25FifoLength: 522
-        # Size (in bytes) of the NXDN transmit FIFO buffer.
+        # Size (in bytes) of the NXDN transmit FIFO buffer. It is not recommended to adjust this unless absolutely
+        # necessary, excessive sizes will cause delays in transmitted frames due to excessive buffering.
+        #   Calculation Formula: (NXDN Frame Size (48 bytes) * x Frames) + Pad Bytes = FIFO Buffer Size Bytes
+        #   Default (Recommended) Value: (48 * 11) + 10 = 538
+        #   "Oversized" Value: (48 * 19) + 10 = 922
         nxdnFifoLength: 538
 
         #