Skip to content

Commit db5068f

Browse files
committed
Improve documentation in lorabase.h
1 parent 26326e4 commit db5068f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/lmic/lorabase.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -589,20 +589,20 @@ enum {
589589

590590
// Bit fields byte#3 of MCMD_LinkADRReq payload
591591
enum {
592-
MCMD_LinkADRReq_Redundancy_RFU = 0x80,
593-
MCMD_LinkADRReq_Redundancy_ChMaskCntl_MASK= 0x70,
594-
MCMD_LinkADRReq_Redundancy_NbTrans_MASK = 0x0F,
592+
MCMD_LinkADRReq_Redundancy_RFU = 0x80, ///< mask for RFU bit
593+
MCMD_LinkADRReq_Redundancy_ChMaskCntl_MASK= 0x70, ///< mask for the channel-mask control field.
594+
MCMD_LinkADRReq_Redundancy_NbTrans_MASK = 0x0F, ///< mask for the `NbTrans` (repetition) field.
595595

596-
MCMD_LinkADRReq_ChMaskCntl_EULIKE_DIRECT = 0x00, // direct masking for EU
597-
MCMD_LinkADRReq_ChMaskCntl_EULIKE_ALL_ON = 0x60, // EU: enable everything.
596+
MCMD_LinkADRReq_ChMaskCntl_EULIKE_DIRECT = 0x00, ///< EU-like: direct masking for EU
597+
MCMD_LinkADRReq_ChMaskCntl_EULIKE_ALL_ON = 0x60, ///< EU-like: enable everything.
598598

599-
MCMD_LinkADRReq_ChMaskCntl_USLIKE_500K = 0x40, // mask is for the 8 us-like 500 kHz channels
600-
MCMD_LinkADRReq_ChMaskCntl_USLIKE_SPECIAL = 0x50, // first special for us-like
601-
MCMD_LinkADRReq_ChMaskCntl_USLIKE_BANK = 0x50, // special: bits are banks.
602-
MCMD_LinkADRReq_ChMaskCntl_USLIKE_125ON = 0x60, // special channel page enable, bits applied to 64..71
603-
MCMD_LinkADRReq_ChMaskCntl_USLIKE_125OFF = 0x70, // special channel page: disble 125K, bits apply to 64..71
599+
MCMD_LinkADRReq_ChMaskCntl_USLIKE_500K = 0x40, ///< US-like: mask is for the 8 us-like 500 kHz channels
600+
MCMD_LinkADRReq_ChMaskCntl_USLIKE_SPECIAL = 0x50, ///< US-like: first special for us-like
601+
MCMD_LinkADRReq_ChMaskCntl_USLIKE_BANK = 0x50, ///< US-like: special: bits are banks.
602+
MCMD_LinkADRReq_ChMaskCntl_USLIKE_125ON = 0x60, ///< US-like: special channel page enable, bits applied to 64..71
603+
MCMD_LinkADRReq_ChMaskCntl_USLIKE_125OFF = 0x70, ///< US-like: special channel page: disable 125K, bits apply to 64..71
604604

605-
MCMD_LinkADRReq_ChMaskCntl_CN470_ALL_ON = 0x60, // turn all on for China.
605+
MCMD_LinkADRReq_ChMaskCntl_CN470_ALL_ON = 0x60, ///< CN-470: turn all on for China.
606606
};
607607

608608
// Bit fields byte#0 of MCMD_LinkADRReq payload

0 commit comments

Comments
 (0)