Browse Source

fw-api: CL 17023988 - update fw common interface files

HTT stats: auto-generate documentation
Convert certain comments in htt.h and htt_stats.h from /* to doxygen-style /**.Add scripts and doxygen configuration files for using doxygen to generate documentation of HTT stats definitions.

Change-Id: If11ba7104918568726d6cf10f66745622cbcc6ae
CRs-Fixed: 2262693
spuligil 3 years ago
parent
commit
f9a852dd02
2 changed files with 255 additions and 197 deletions
  1. 5 2
      fw/htt.h
  2. 250 195
      fw/htt_stats.h

+ 5 - 2
fw/htt.h

@@ -273,7 +273,7 @@
  */
 #define HTT_T2H_MSG_TYPE_RC_UPDATE_IND DEPRECATED_HTT_T2H_MSG_TYPE_RC_UPDATE_IND
 
-/*
+/**
  * htt_dbg_stats_type -
  * bit positions for each stats type within a stats type bitmask
  * The bitmask contains 24 bits.
@@ -579,6 +579,7 @@ typedef struct {
     };
 } htt_tlv_hdr_t;
 
+/** HTT stats TLV tag values */
 typedef enum {
     HTT_STATS_TX_PDEV_CMN_TAG                      = 0,  /* htt_tx_pdev_stats_cmn_tlv */
     HTT_STATS_TX_PDEV_UNDERRUN_TAG                 = 1,  /* htt_tx_pdev_stats_urrn_tlv_v */
@@ -727,7 +728,9 @@ typedef enum {
 
 
     HTT_STATS_MAX_TAG,
-} htt_tlv_tag_t;
+} htt_stats_tlv_tag_t;
+/* retain deprecated enum name as an alias for the current enum name */
+typedef htt_stats_tlv_tag_t htt_tlv_tag_t;
 
 #define HTT_STATS_TLV_TAG_M 0x00000fff
 #define HTT_STATS_TLV_TAG_S 0

File diff suppressed because it is too large
+ 250 - 195
fw/htt_stats.h


Some files were not shown because too many files changed in this diff