Skip to content

Commit 994c348

Browse files
gatekeepgatekeep
committed
convert documentation format to Doxygen;
1 parent 7840a3d commit 994c348

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+2532
-2136
lines changed

‎ADF7021.cpp‎

Lines changed: 48 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
// SPDX-License-Identifier: GPL-2.0-only
2-
/**
3-
* Digital Voice Modem - Hotspot Firmware
4-
* GPLv2 Open Source. Use is subject to license terms.
5-
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6-
*
7-
* @package DVM / Hotspot Firmware
8-
* @derivedfrom MMDVM_HS (https://github.com/g4klx/MMDVM_HS)
9-
* @license GPLv2 License (https://opensource.org/licenses/GPL-2.0)
10-
*
11-
* Copyright (C) 2020,2021 Jonathan Naylor, G4KLX
12-
* Copyright (C) 2016 Jim McLaughlin, KI6ZUM
13-
* Copyright (C) 2016,2017,2018,2019,2020 Andy Uribe, CA6JAU
14-
* Copyright (C) 2017 Danilo, DB4PLE
15-
* Copyright (C) 2021 Bryan Biedenkapp, N2PLL
16-
*
17-
*/
2+
/*
3+
* Digital Voice Modem - Hotspot Firmware
4+
* GPLv2 Open Source. Use is subject to license terms.
5+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6+
*
7+
* Copyright (C) 2020,2021 Jonathan Naylor, G4KLX
8+
* Copyright (C) 2016 Jim McLaughlin, KI6ZUM
9+
* Copyright (C) 2016,2017,2018,2019,2020 Andy Uribe, CA6JAU
10+
* Copyright (C) 2017 Danilo, DB4PLE
11+
* Copyright (C) 2021 Bryan Biedenkapp, N2PLL
12+
*
13+
*/
1814
#include <math.h>
1915

2016
#include "Globals.h"
@@ -74,9 +70,8 @@ uint8_t m_afcRange;
7470
// Global Functions
7571
// ---------------------------------------------------------------------------
7672

77-
/// <summary>
78-
///
79-
/// </summary>
73+
/* */
74+
8075
static void AD7021_IOCTL_Shift()
8176
{
8277
for (int i = 31; i >= 0; i--) {
@@ -95,20 +90,17 @@ static void AD7021_IOCTL_Shift()
9590
io.SDATA(LOW);
9691
}
9792

98-
/// <summary>
99-
///
100-
/// </summary>
93+
/* */
94+
10195
static void AD7021_IOCTL_SLEPulse()
10296
{
10397
io.SLE1(HIGH);
10498
io.delayBit();
10599
io.SLE1(LOW);
106100
}
107101

108-
/// <summary>
109-
///
110-
/// </summary>
111-
/// <param name="doSle"></param>
102+
/* */
103+
112104
static void AD7021_1_IOCTL(bool doSle = true)
113105
{
114106
AD7021_IOCTL_Shift();
@@ -118,20 +110,17 @@ static void AD7021_1_IOCTL(bool doSle = true)
118110
}
119111

120112
#if defined(DUPLEX)
121-
/// <summary>
122-
///
123-
/// </summary>
113+
/* */
114+
124115
static void AD7021_2_IOCTL_SLEPulse()
125116
{
126117
io.SLE2(HIGH);
127118
io.delayBit();
128119
io.SLE2(LOW);
129120
}
130121

131-
/// <summary>
132-
///
133-
/// </summary>
134-
/// <param name="doSle"></param>
122+
/* */
123+
135124
static void AD7021_2_IOCTL(bool doSle = true)
136125
{
137126
AD7021_IOCTL_Shift();
@@ -145,9 +134,8 @@ static void AD7021_2_IOCTL(bool doSle = true)
145134
// Public Class Members
146135
// ---------------------------------------------------------------------------
147136

148-
/// <summary>
149-
/// Hardware interrupt handler.
150-
/// </summary>
137+
/* Hardware interrupt handler. */
138+
151139
void IO::interrupt1()
152140
{
153141
uint8_t bit = 0U;
@@ -256,9 +244,8 @@ void IO::interrupt1()
256244
}
257245

258246
#if defined(DUPLEX)
259-
/// <summary>
260-
/// Hardware interrupt handler.
261-
/// </summary>
247+
/* Hardware interrupt handler. */
248+
262249
void IO::interrupt2()
263250
{
264251
uint8_t bit = 0U;
@@ -276,11 +263,8 @@ void IO::interrupt2()
276263
}
277264
#endif
278265

279-
/// <summary>
280-
/// Sets the ADF7021 RF configuration.
281-
/// </summary>
282-
/// <param name="modemState"></param>
283-
/// <param name="reset"></param>
266+
/* Sets the ADF7021 RF configuration. */
267+
284268
void IO::rf1Conf(DVM_STATE modemState, bool reset)
285269
{
286270
uint32_t txFrequencyTmp, rxFrequencyTmp;
@@ -482,11 +466,8 @@ void IO::rf1Conf(DVM_STATE modemState, bool reset)
482466
}
483467

484468
#if defined(DUPLEX)
485-
/// <summary>
486-
/// Sets the ADF7021 RF configuration.
487-
/// </summary>
488-
/// <param name="modemState"></param>
489-
/// <param name="reset"></param>
469+
/* Sets the ADF7021 RF configuration. */
470+
490471
void IO::rf2Conf(DVM_STATE modemState)
491472
{
492473
DEBUG3("IO::rf2Conf() ADF2 (Rx); modemState/rxGain", modemState, m_gainMode);
@@ -609,30 +590,17 @@ void IO::rf2Conf(DVM_STATE modemState)
609590
}
610591
#endif // DUPLEX
611592

612-
/// <summary>
613-
///
614-
/// </summary>
615-
/// <param name="dmrTXLevel"></param>
616-
/// <param name="p25TXLevel"></param>
617-
/// <param name="nxdnTXLevel"></param>
593+
/* Sets the deviation levels. */
594+
618595
void IO::setDeviations(uint8_t dmrTXLevel, uint8_t p25TXLevel, uint8_t nxdnTXLevel)
619596
{
620597
dmrDev = uint16_t((ADF7021_DEV_DMR * uint16_t(dmrTXLevel)) / 128U);
621598
p25Dev = uint16_t((ADF7021_DEV_P25 * uint16_t(p25TXLevel)) / 128U);
622599
nxdnDev = uint16_t((ADF7021_DEV_NXDN * uint16_t(nxdnTXLevel)) / 128U);
623600
}
624601

625-
/// <summary>
626-
/// Sets the RF adjustment parameters.
627-
/// </summary>
628-
/// <param name="dmrDevAdj"></param>
629-
/// <param name="p25DevAdj"></param>
630-
/// <param name="dmrDiscBWAdj"></param>
631-
/// <param name="p25DiscBWAdj"></param>
632-
/// <param name="nxdnDiscBWAdj"></param>
633-
/// <param name="dmrPostBWAdj"></param>
634-
/// <param name="p25PostBWAdj"></param>
635-
/// <param name="nxdnPostBWAdj"></param>
602+
/* Sets the RF adjustment parameters. */
603+
636604
void IO::setRFAdjust(int8_t dmrDiscBWAdj, int8_t p25DiscBWAdj, int8_t nxdnDiscBWAdj, int8_t dmrPostBWAdj, int8_t p25PostBWAdj, int8_t nxdnPostBWADJ)
637605
{
638606
m_dmrDiscBWAdj = dmrDiscBWAdj;
@@ -646,13 +614,8 @@ void IO::setRFAdjust(int8_t dmrDiscBWAdj, int8_t p25DiscBWAdj, int8_t nxdnDiscBW
646614
DEBUG4("IO::setRFAdjust() RF adjustment, postBW", dmrPostBWAdj, p25PostBWAdj, nxdnPostBWADJ);
647615
}
648616

649-
/// <summary>
650-
/// Sets the RF AFC parameters.
651-
/// </summary>
652-
/// <param name="afcEnable"></param>
653-
/// <param name="afcKI"></param>
654-
/// <param name="afcKP"></param>
655-
/// <param name="afcRange"></param>
617+
/* Sets the RF AFC parameters. */
618+
656619
void IO::setAFCParams(bool afcEnable, uint8_t afcKI, uint8_t afcKP, uint8_t afcRange)
657620
{
658621
m_afcEnable = afcEnable;
@@ -663,9 +626,8 @@ void IO::setAFCParams(bool afcEnable, uint8_t afcKI, uint8_t afcKP, uint8_t afcR
663626
DEBUG5("IO::setAFCParams() AFC params", afcEnable, afcKI, afcKP, afcRange);
664627
}
665628

666-
/// <summary>
667-
///
668-
/// </summary>
629+
/* */
630+
669631
void IO::updateCal(DVM_STATE modemState)
670632
{
671633
uint32_t ADF7021_REG2;
@@ -726,10 +688,8 @@ void IO::updateCal(DVM_STATE modemState)
726688
setRX();
727689
}
728690

729-
/// <summary>
730-
///
731-
/// </summary>
732-
/// <returns></returns>
691+
/* */
692+
733693
uint16_t IO::readRSSI()
734694
{
735695
uint32_t AD7021_RB;
@@ -818,9 +778,8 @@ uint16_t IO::readRSSI()
818778
// Private Class Members
819779
// ---------------------------------------------------------------------------
820780

821-
/// <summary>
822-
///
823-
/// </summary>
781+
/* */
782+
824783
void IO::configureBand()
825784
{
826785
/*
@@ -890,10 +849,8 @@ void IO::configureBand()
890849
DEBUG3("IO::configureBand() ADF freq band; reg1/f_div", ADF7021_REG1, f_div);
891850
}
892851

893-
/// <summary>
894-
///
895-
/// </summary>
896-
/// <param name="modemState"></param>
852+
/* */
853+
897854
void IO::configureTxRx(DVM_STATE modemState)
898855
{
899856
uint16_t dmrDiscBW = ADF7021_DISC_BW_DMR, dmrPostBW = ADF7021_POST_BW_DMR;
@@ -1375,9 +1332,8 @@ void IO::configureTxRx(DVM_STATE modemState)
13751332
(uint16_t)((ADF7021_PFD * p25Dev) / (f_div * 65536)), (uint16_t)((ADF7021_PFD * nxdnDev) / (f_div * 65536)), m_rfPower);
13761333
}
13771334

1378-
/// <summary>
1379-
///
1380-
/// </summary>
1335+
/* */
1336+
13811337
void IO::setTX()
13821338
{
13831339
// PTT pin on (doing it earlier helps to measure timing impact)
@@ -1396,10 +1352,8 @@ void IO::setTX()
13961352
while(CLK());
13971353
}
13981354

1399-
/// <summary>
1400-
///
1401-
/// </summary>
1402-
/// <param name="doSle"></param>
1355+
/* */
1356+
14031357
void IO::setRX(bool doSle)
14041358
{
14051359
// PTT pin off (doing it earlier helps to measure timing impact)

‎ADF7021.h‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
// SPDX-License-Identifier: GPL-2.0-only
2+
/*
3+
* Digital Voice Modem - Hotspot Firmware
4+
* GPLv2 Open Source. Use is subject to license terms.
5+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6+
*
7+
* Copyright (C) 2020 Jonathan Naylor, G4KLX
8+
* Copyright (C) 2016 Jim McLaughlin, KI6ZUM
9+
* Copyright (C) 2016,2017,2018 Andy Uribe, CA6JAU
10+
* Copyright (C) 2017 Danilo, DB4PLE
11+
* Copyright (C) 2021 Bryan Biedenkapp, N2PLL
12+
*
13+
*/
214
/**
3-
* Digital Voice Modem - Hotspot Firmware
4-
* GPLv2 Open Source. Use is subject to license terms.
5-
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6-
*
7-
* @package DVM / Hotspot Firmware
8-
* @derivedfrom MMDVM_HS (https://github.com/g4klx/MMDVM_HS)
9-
* @license GPLv2 License (https://opensource.org/licenses/GPL-2.0)
10-
*
11-
* Copyright (C) 2020 Jonathan Naylor, G4KLX
12-
* Copyright (C) 2016 Jim McLaughlin, KI6ZUM
13-
* Copyright (C) 2016,2017,2018 Andy Uribe, CA6JAU
14-
* Copyright (C) 2017 Danilo, DB4PLE
15-
* Copyright (C) 2021 Bryan Biedenkapp, N2PLL
16-
*
17-
*/
15+
* @file ADF7021.h
16+
* @ingroup hotspot_fw
17+
*/
1818
#if !defined(__ADF7021_H__)
1919
#define __ADF7021_H__
2020

@@ -24,6 +24,11 @@
2424
// Constants
2525
// ---------------------------------------------------------------------------
2626

27+
/**
28+
* @addtogroup hotspot_fw
29+
* @{
30+
*/
31+
2732
#define LOW 0
2833
#define HIGH 1
2934

@@ -312,4 +317,5 @@
312317
#endif // ADF7021_N_VER
313318

314319
#endif // ENABLE_ADF7021
320+
/** @} */
315321
#endif // __ADF7021_H__

0 commit comments

Comments
 (0)