aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPau Espin Pedrol <pespin@sysmocom.de>2019-07-29 20:11:25 +0200
committerPau Espin Pedrol <pespin@sysmocom.de>2019-08-01 13:45:55 +0200
commit68a78099a06ac6ad3d4ebc8fc6c6a7c357e183dd (patch)
tree966de410d06b27000ef788be00b6fa7899bed6d4 /doc
parent50c78dfe8583d66095e37c278bcb9333dc59ddc5 (diff)
lms: Drop rx_underruns rate ctr, add tx_drop_* rate ctr
After discussion in [1] and further look at the code, it became obvios rx_underrun events are not happening in general for any SDR (don't exist), so let's drop that counter. Instead, add Tx Dropped Packet counters, which were not accounted prior to this commit. [1] https://github.com/osmocom/osmo-trx/commit/bde55afd29fc9aae10eb11f6515821afa39b772d Change-Id: Iff1535c219a4695a511d383d7c4b06ef6eff959d
Diffstat (limited to 'doc')
-rw-r--r--doc/manuals/chapters/counters_generated.adoc17
-rw-r--r--doc/manuals/vty/trx_vty_reference.xml22
2 files changed, 25 insertions, 14 deletions
diff --git a/doc/manuals/chapters/counters_generated.adoc b/doc/manuals/chapters/counters_generated.adoc
index 6955b18..98634ff 100644
--- a/doc/manuals/chapters/counters_generated.adoc
+++ b/doc/manuals/chapters/counters_generated.adoc
@@ -1,5 +1,6 @@
+
// autogenerated by show asciidoc counters
-These counters and their description based on OsmoTRX 1.0.0.43-3f7c0 (OsmoTRX).
+These counters and their description are based on OsmoTRX 1.0.0.95-9527 (OsmoTRX).
=== Rate Counters
@@ -9,9 +10,17 @@ These counters and their description based on OsmoTRX 1.0.0.43-3f7c0 (OsmoTRX).
[options="header"]
|===
| Name | Reference | Description
-| device:rx_underruns | <<trx:chan_device:rx_underruns>> | Number of Rx underruns
-| device:rx_overruns | <<trx:chan_device:rx_overruns>> | Number of Rx overruns
-| device:tx_underruns | <<trx:chan_device:tx_underruns>> | Number of Tx underruns
+| device:rx_overruns | <<trx:chan_device:rx_overruns>> | Number of Rx overruns in FIFO queue
+| device:tx_underruns | <<trx:chan_device:tx_underruns>> | Number of Tx underruns in FIFO queue
| device:rx_drop_events | <<trx:chan_device:rx_drop_events>> | Number of times Rx samples were dropped by HW
| device:rx_drop_samples | <<trx:chan_device:rx_drop_samples>> | Number of Rx samples dropped by HW
+| device:tx_drop_events | <<trx:chan_device:tx_drop_events>> | Number of times Tx samples were dropped by HW
+| device:tx_drop_samples | <<trx:chan_device:tx_drop_samples>> | Number of Tx samples dropped by HW
|===
+== Osmo Stat Items
+
+// generating tables for osmo_stat_items
+== Osmo Counters
+
+// generating tables for osmo_counters
+// there are no ungrouped osmo_counters
diff --git a/doc/manuals/vty/trx_vty_reference.xml b/doc/manuals/vty/trx_vty_reference.xml
index ce6d335..38d64c1 100644
--- a/doc/manuals/vty/trx_vty_reference.xml
+++ b/doc/manuals/vty/trx_vty_reference.xml
@@ -1247,26 +1247,21 @@
<param name='&lt;1-32&gt;' doc='Real time priority' />
</params>
</command>
- <command id='stack-size &lt;0-2147483647&gt;'>
- <params>
- <param name='stack-size' doc='Set the stack size for the spawned threads' />
- <param name='&lt;0-2147483647&gt;' doc='Stack size in BYTE' />
- </params>
- </command>
<command id='filler dummy'>
<params>
<param name='filler' doc='Enable C0 filler table' />
<param name='dummy' doc='Dummy method' />
</params>
</command>
- <command id='ctr-error-threshold (rx_underruns|rx_overruns|tx_underruns|rx_drop_events|rx_drop_samples) &lt;0-65535&gt; (per-second|per-minute|per-hour|per-day)'>
+ <command id='ctr-error-threshold (rx_overruns|tx_underruns|rx_drop_events|rx_drop_samples|tx_drop_events|tx_drop_samples) &lt;0-65535&gt; (per-second|per-minute|per-hour|per-day)'>
<params>
<param name='ctr-error-threshold' doc='Threshold rate for error counter' />
- <param name='rx_underruns' doc='Set threshold value for rate_ctr device:rx_underruns' />
<param name='rx_overruns' doc='Set threshold value for rate_ctr device:rx_overruns' />
<param name='tx_underruns' doc='Set threshold value for rate_ctr device:tx_underruns' />
<param name='rx_drop_events' doc='Set threshold value for rate_ctr device:rx_drop_events' />
<param name='rx_drop_samples' doc='Set threshold value for rate_ctr device:rx_drop_samples' />
+ <param name='tx_drop_events' doc='Set threshold value for rate_ctr device:tx_drop_events' />
+ <param name='tx_drop_samples' doc='Set threshold value for rate_ctr device:tx_drop_samples' />
<param name='&lt;0-65535&gt;' doc='Value to set for threshold' />
<param name='per-second' doc='Threshold value sampled per-second' />
<param name='per-minute' doc='Threshold value sampled per-minute' />
@@ -1274,15 +1269,16 @@
<param name='per-day' doc='Threshold value sampled per-day' />
</params>
</command>
- <command id='no ctr-error-threshold (rx_underruns|rx_overruns|tx_underruns|rx_drop_events|rx_drop_samples) &lt;0-65535&gt; (per-second|per-minute|per-hour|per-day)'>
+ <command id='no ctr-error-threshold (rx_overruns|tx_underruns|rx_drop_events|rx_drop_samples|tx_drop_events|tx_drop_samples) &lt;0-65535&gt; (per-second|per-minute|per-hour|per-day)'>
<params>
<param name='no' doc='Negate a command or set its defaults' />
<param name='ctr-error-threshold' doc='Threshold rate for error counter' />
- <param name='rx_underruns' doc='Set threshold value for rate_ctr device:rx_underruns' />
<param name='rx_overruns' doc='Set threshold value for rate_ctr device:rx_overruns' />
<param name='tx_underruns' doc='Set threshold value for rate_ctr device:tx_underruns' />
<param name='rx_drop_events' doc='Set threshold value for rate_ctr device:rx_drop_events' />
<param name='rx_drop_samples' doc='Set threshold value for rate_ctr device:rx_drop_samples' />
+ <param name='tx_drop_events' doc='Set threshold value for rate_ctr device:tx_drop_events' />
+ <param name='tx_drop_samples' doc='Set threshold value for rate_ctr device:tx_drop_samples' />
<param name='&lt;0-65535&gt;' doc='Value to set for threshold' />
<param name='per-second' doc='Threshold value sampled per-second' />
<param name='per-minute' doc='Threshold value sampled per-minute' />
@@ -1290,6 +1286,12 @@
<param name='per-day' doc='Threshold value sampled per-day' />
</params>
</command>
+ <command id='stack-size &lt;0-2147483647&gt;'>
+ <params>
+ <param name='stack-size' doc='Set the stack size per thread in BYTE, 0 = OS default' />
+ <param name='&lt;0-2147483647&gt;' doc='Stack size per thread in BYTE' />
+ </params>
+ </command>
<command id='chan &lt;0-100&gt;'>
<params>
<param name='chan' doc='Select a channel to configure' />