summaryrefslogtreecommitdiff
path: root/cleopatre/devkit
diff options
context:
space:
mode:
authorJean-Philippe NOEL2013-07-01 16:50:57 +0200
committerJean-Philippe NOEL2013-07-12 13:30:07 +0200
commit9bf96217c7b03b7b3071d0920a73dffdaab115f6 (patch)
treec281586fd26aad8420eff847963a20fe6b68be9e /cleopatre/devkit
parent5da62de34e6ab65f62c24aaec231708cb9f90f8c (diff)
cleopatre: update vs_get_ce_stats documentation, closes #3876
Diffstat (limited to 'cleopatre/devkit')
-rw-r--r--cleopatre/devkit/doc/chapter_vs_get_stats_debug_mme.rst319
-rw-r--r--cleopatre/devkit/doc/internal_mme_specs.rst2
2 files changed, 321 insertions, 0 deletions
diff --git a/cleopatre/devkit/doc/chapter_vs_get_stats_debug_mme.rst b/cleopatre/devkit/doc/chapter_vs_get_stats_debug_mme.rst
new file mode 100644
index 0000000000..2a68a1367f
--- /dev/null
+++ b/cleopatre/devkit/doc/chapter_vs_get_stats_debug_mme.rst
@@ -0,0 +1,319 @@
+The statistics available with the **debug** level are the following:
+
+.. list-table::
+ :widths: 30 60
+ :header-rows: 1
+
+ * - Field
+ - Description
+
+ * - phy_watchdog_expired
+ - Watchdog expired due to hardware bug
+
+ * - phy_resys_restarted
+ - RESYS restarted due to hardware bug
+
+.. list-table::
+ :widths: 30 60
+ :header-rows: 0
+
+ * - pbproc_prp_lost
+ - Number of lost contention in PRP
+
+ * - pbproc_cw_lost
+ - Number of lost contention in Contention Window
+
+ * - pbproc_aifs
+ - Number of AIFS
+
+ * - pbproc_rx_out_of_alloc
+ - RX number of packet out of an allocation or too near AIFS
+
+ * - pbproc_rx_rsof_out_of_alloc
+ - RX number of RSOF out of allocation or too near AIFS (EoC only)
+
+ * - pbproc_rx_pool_shortage
+ - RX number of frame with no enough PB in pool
+
+ * - pbproc_rx_handle_fc
+ - RX number of handle Frame Control
+
+ * - pbproc_rx_beacon
+ - RX number of beacon
+
+ * - pbproc_rx_data
+ - RX number of data (SOF, RSOF (EoC only))
+
+ * - pbproc_rx_data_wack
+ - RX number of data with acknoledge
+
+ * - pbproc_rx_data_woack
+ - RX number of data without acknoledge
+
+ * - pbproc_rx_data_burst_stop
+ - RX number of data burst interrupted
+
+ * - pbproc_rx_data_error
+ - RX number of bad data MPDU
+
+ * - pbproc_rx_data_empty
+ - RX number of empty frames
+
+ * - pbproc_rx_data_bad_symb_nb
+ - RX number of bad symbol
+
+ * - pbproc_rx_sound
+ - RX number of sound frame
+
+ * - pbproc_rx_sound_complete
+ - RX number of sound frames complet flag sent
+
+ * - pbproc_rx_sound_drop
+ - RX number of sound frames dropped (no channel data requested or no more PB)
+
+ * - pbproc_rx_rts
+ - RX number of RTS for us
+
+ * - pbproc_rx_nfu
+ - RX number of packets not for us
+
+ * - pbproc_rx_fc_unknown
+ - RX number of unknown Frame Control
+
+ * - pbproc_rx_crc_error
+ - RX number of Frame Control with CRC error
+
+ * - pbproc_tx_invalid
+ - TX number of invalid frames (nothing to send)
+
+ * - pbproc_tx_late
+ - TX number of packets who are late
+
+ * - pbproc_tx_data
+ - TX number of data or beacon
+
+ * - pbproc_tx_data_cancel
+ - TX number of data canceled due to lost access
+
+ * - pbproc_tx_data_burst
+ - TX number of MPDU with non zero mpdu_cnt
+
+ * - pbproc_tx_data_burst_interrupted
+ - TX number of interrupted bursts
+
+ * - pbproc_tx_data_wack
+ - TX number of data with acknoledge
+
+ * - pbproc_tx_data_woack
+ - TX number of data without acknoledge
+
+ * - pbproc_tx_data_beacon
+ - TX number of beacons
+
+ * - pbproc_tx_data_wack_ack
+ - TX number of data with acknoledge, acknoledge received
+
+ * - pbproc_tx_data_wack_noack
+ - TX number of data with acknoledge, acknoledge not received
+
+ * - pbproc_tx_data_re_sync
+ - TX number of data sent in RE_SYNC state
+
+ * - pbproc_tx_sound
+ - TX number of sound frame
+
+ * - pbproc_tx_sound_ack
+ - TX number of sound frame with acknoledge received
+
+ * - pbproc_tx_sound_noack
+ - TX number of sound frame with acnkoledge not received
+
+ * - pbproc_tx_data_empty
+ - TX number of packets sent empty
+
+ * - pbproc_tx_data_pb_total
+ - TX total number of PBs sent
+
+.. list-table::
+ :widths: 30 60
+ :header-rows: 0
+
+ * - sar_pb_pool_not_filled
+ - Number of time that PB pool was not filled
+
+ * - sar_mfs_tx_mme_pb_expired_nb
+ - Number of expired PB in MME MFS TX
+
+ * - sar_mfs_tx_data_pb_expired_nb
+ - Number of expired PB in DATA MFS TX
+
+ * - sar_mfs_rx_mme_pb_expired_nb
+ - Number of expired PB in MME MFS RX
+
+ * - sar_mfs_rx_data_pb_expired_nb
+ - Number of expired DATA in MME MFS RX
+
+ * - sar_mfs_data_mfs_cmd_init_nb
+ - Number of MFS COMMAND INIT for DATA MFS
+
+ * - sar_mfs_mme_mfs_cmd_init_nb
+ - Number of MFS COMMAND INIT for MME MFS
+
+ * - sar_pb_data_duplicated
+ - Number of DATA PB duplicated
+
+ * - sar_pb_mme_duplicated
+ - Number of MME PB duplicated
+
+ * - sar_pb_data_before_ssn_min
+ - Number of DATA PB dropped because their SSN are lower than the SSN min and are therefore considered as already received
+
+ This statistic is incremented in one of the 2 following situations:
+
+ - The TX has not received the PB ACK sent by the RX and has resent a PB already received by the RX
+ - The SSN windows are not synchronized between the TX and the RX, which can cause some packet losses
+
+ * - sar_pb_mme_before_ssn_min
+ - Number of MME PB dropped because their SSN are lower than the SSN min and are therefore considered as already received
+
+ This statistic is incremented in one of the 2 following situations:
+
+ - The TX has not received the PB ACK sent by the RX and has resent a PB already received by the RX
+ - The SSN windows are not synchronized between the TX and the RX, which can cause some packet losses
+
+ * - sar_tx_msdu_dropped_nb
+ - Number of TX MSDU dropped
+
+ * - sar_rx_msdu_dropped_nb
+ - Number of RX MSDU dropped
+
+.. list-table::
+ :widths: 30 60
+ :header-rows: 0
+
+ * - SAR_PB_STATS_LOAD
+ - Enable the PB CRC MAP recovery
+
+ * - MAC_LIMITATION
+ - Number of MAC address authorized to be connected to the STA on ethernet side
+
+.. list-table::
+ :widths: 30 60
+ :header-rows: 0
+
+ * - cl_rx_data
+ - Number of received data frames on CL (EoC only)
+
+ * - cl_rx_data_multicast
+ - Number of received multicast frames on CL (EoC only)
+
+ * - cl_rx_mme
+ - Number of received MME on CL (EoC only)
+
+ * - cl_tx_data
+ - Number of transmitted data frames (EoC only)
+
+ * - cl_tx_data_drop_auth
+ - Number of transmitted data frames dropped, not auth (EoC only)
+
+ * - cl_tx_data_drop_mfs
+ - Number of transmitted data frames dropped, mfs overload (EoC only)
+
+ * - cl_tx_data_multicast
+ - Number of transmitted multicast frames (EoC only)
+
+ * - cl_tx_mme
+ - Number of transmitted MME frames (EoC only)
+
+.. list-table::
+ :widths: 30 60
+ :header-rows: 0
+
+ * - bsu_neighbor_beacon_nb
+ - Number of beacon received from a neighbor network
+
+ * - bsu_neighbor_beacon_last_mac
+ - Last MAC address received from a neighbor network
+
+.. list-table::
+ :widths: 35 60
+ :header-rows: 0
+
+ * - ce_rx_resend_tm
+ - RX number of tonemap resend.
+
+ * - CE_RX_INTERVALS_BEHAVIOR
+ - Intervals activation. 0 to disable, 1 to enable intervals
+
+ * - CE_RX_INTERVALS_FSM_NB
+ - Number of interval FSMs. The maximum number of intervals is 6
+
+ * - CE_RX_INTERVALS_REPETITION_NB
+ - Number of FSMs repetition on the whole beacon period. Default 4, total number of intervals (FSM_NB * REPETITION_NB) is 32 max.
+
+ * - CE_RX_BL_NSR_MARGIN
+ - Margins for bit loading. To convert a dB value to this one, you need to apply the following formula: round (10^(value_in_db / 10) * 2^6). The value 64 means that it's disable
+
+ * - CE_RX_BL_BER_MARGIN_1_2
+ - BER target margins for FEC rate of 1/2
+
+ * - CE_RX_BL_BER_MARGIN_16_21
+ - BER target margins for FEC rate of 16/21
+
+ * - CE_RX_BL_MIN_TIME_BETWEEN CE_RESTART_BER_MS
+ - Time to wait before restarting the CE because BER means are too low (in milliseconds)
+
+ * - CE_RX_BL_BER_LOWER_BOUND
+ - CE is restarted if BER is too low: under a certain percent of the BER consing: if (both BER sliding means[slow & fast] < (ber_consign * -ber_consign * CE_RX_BL_BER_LOWER_BOUND / 128). This value is expressed in 128 (not in percent)
+
+ * - CE_RX_BL_PBER_MEAN_INIT
+ -
+
+ * - CE_RX_BL_PBER_SLIDING_MEAN_COEF
+ -
+
+ * - CE_RX_BL_PB_FALSE_FACTOR
+ -
+
+ * - CE_RX_BL_PB_TOTAL_FACTOR
+ -
+
+ * - CE_RX_BL_MIN_PB_PER_FRAME
+ -
+
+ * - CE_RX_BL_MIN_FRAME_WITH_HIGH PB_ERR_RATE
+ - Minimum (inclusive) consecutive frame with PB error rate high enough to make the CE restart
+
+ * - CE_RX_BL_MIN_TIME_BETWEEN_CE RESTART_PBER_MS
+ - Time to wait before restarting the CE because PBER means are too low (in milliseconds)
+
+ * - CE_RX_BL_MIN_TIME_BETWEEN_CE RESTART_BER_MARGIN_UPDATE
+ - Time to wait before restarting the BER margin update because BER means are too low (in milliseconds)
+
+ * - CE_RX_BL_BER_MARGIN_UPDATE PBER_LIMIT_MIN
+ - PBER lower limit. 0 to disable, 1 for default configuration
+
+ * - CE_RX_BL_BER_MARGIN_UPDATE PBER_LIMIT_MAX
+ - PBER upper limit. 2^32 * -1 to disable, 3330 for default value
+
+ * - CE_RX_BL_BER_MARGIN_UPDATE MIN_NB_PB
+ -
+
+ * - CE_RX_BL_BMU_POLY_SUP_A
+ -
+
+ * - CE_RX_BL_BMU_POLY_SUP_B
+ -
+
+ * - CE_RX_BL_BMU_POLY_INF_A
+ -
+
+ * - CE_RX_BL_BMU_POLY_INF_B
+ -
+
+.. list-table::
+ :widths: 30 60
+ :header-rows: 0
+
+ * - OUTPUT_LEVEL_ALL
+ - STA output level (dBµV)
diff --git a/cleopatre/devkit/doc/internal_mme_specs.rst b/cleopatre/devkit/doc/internal_mme_specs.rst
index e9fce26295..80f6185d96 100644
--- a/cleopatre/devkit/doc/internal_mme_specs.rst
+++ b/cleopatre/devkit/doc/internal_mme_specs.rst
@@ -33,6 +33,8 @@ References
.. include:: ../../doc/mme_specs/chapter_vs_mme.rst
+.. include:: chapter_vs_get_stats_debug_mme.rst
+
.. include:: ../../doc/mme_specs/chapter_ms_mme.rst
.. include:: chapter_drv_mme.rst