Update Comment: Better Doxygen Style
This commit is contained in:
@@ -43,10 +43,10 @@
|
|||||||
#define CTRL_WORD_DEFAULT 0x00
|
#define CTRL_WORD_DEFAULT 0x00
|
||||||
|
|
||||||
#define ANT_MODE_BEAM_MASK 0xF0
|
#define ANT_MODE_BEAM_MASK 0xF0
|
||||||
#define ANT_BEAM_NARROR 0x00 // 8
|
#define ANT_BEAM_NARROR 0x00 // 8
|
||||||
#define ANT_BEAM_SUBNARROR_0 0x10 // 25
|
#define ANT_BEAM_SUBNARROR_0 0x10 // 25
|
||||||
#define ANT_BEAM_SUBNARROR_1 0x20 // 60
|
#define ANT_BEAM_SUBNARROR_1 0x20 // 60
|
||||||
#define ANT_BEAM_WIDE 0x30 // 120
|
#define ANT_BEAM_WIDE 0x30 // 120
|
||||||
|
|
||||||
#define ANT_MODE_POWER_MASK 0x0F
|
#define ANT_MODE_POWER_MASK 0x0F
|
||||||
#define ANT_POWER_FULL 0x00
|
#define ANT_POWER_FULL 0x00
|
||||||
@@ -68,25 +68,20 @@
|
|||||||
#define CALIBRMODE_SINGLE_TR_CAL 0x01
|
#define CALIBRMODE_SINGLE_TR_CAL 0x01
|
||||||
|
|
||||||
#define RF_CTRL_DEFAULT 0x00
|
#define RF_CTRL_DEFAULT 0x00
|
||||||
/** @} PhysicalLayer_AntennaConfig_Constants*/
|
|
||||||
|
|
||||||
// Pair by regex
|
// Pair by regex
|
||||||
// Regex: (([0-9]+, ){8})
|
// Regex: (([0-9]+, ){8})
|
||||||
uint16_t hopPattern_Config[L1_FRAME_MAX_HOPS] =
|
|
||||||
{
|
|
||||||
0
|
|
||||||
};
|
|
||||||
|
|
||||||
uint16_t hopPattern_2KBPS_20MS[L1_FRAME_2KBPS_20MS_HOPS] =
|
const uint16_t hopPattern_2KBPS_20MS[L1_FRAME_2KBPS_20MS_HOPS] =
|
||||||
{
|
{
|
||||||
1500
|
1500
|
||||||
};
|
};
|
||||||
|
|
||||||
uint16_t hopPattern_2KBPS_100MS[L1_FRAME_2KBPS_100MS_HOPS] =
|
const uint16_t hopPattern_2KBPS_100MS[L1_FRAME_2KBPS_100MS_HOPS] =
|
||||||
{
|
{
|
||||||
0, 44, 88, 131, 175, 219, 263, 306,
|
0, 44, 88, 131, 175, 219, 263, 306,
|
||||||
350, 394, 438, 481, 525, 569, 613, 656,
|
350, 394, 438, 481, 525, 569, 613, 656,
|
||||||
700, 744, 788, 831, 875, 919, 963, 1006,
|
700, 744, 788, 831, 875, 919, 963, 1006,
|
||||||
1050, 1094, 1138, 1181, 1225, 1269, 1313, 1356,
|
1050, 1094, 1138, 1181, 1225, 1269, 1313, 1356,
|
||||||
1400, 1444, 1488, 1531, 1575, 1619, 1663, 1706,
|
1400, 1444, 1488, 1531, 1575, 1619, 1663, 1706,
|
||||||
1750, 1794, 1838, 1881, 1925, 1969, 2013, 2056,
|
1750, 1794, 1838, 1881, 1925, 1969, 2013, 2056,
|
||||||
@@ -97,57 +92,58 @@ uint16_t hopPattern_2KBPS_100MS[L1_FRAME_2KBPS_100MS_HOPS] =
|
|||||||
3500
|
3500
|
||||||
};
|
};
|
||||||
|
|
||||||
uint16_t hopPattern_10KBPS_10MS[L1_FRAME_10KBPS_10MS_HOPS] =
|
const uint16_t hopPattern_10KBPS_10MS[L1_FRAME_10KBPS_10MS_HOPS] =
|
||||||
{
|
{
|
||||||
1500
|
1500
|
||||||
};
|
};
|
||||||
|
|
||||||
//uint16_t hopPattern_10KBPS_20MS[L1_FRAME_10KBPS_20MS_HOPS] =
|
// uint16_t hopPattern_10KBPS_20MS[L1_FRAME_10KBPS_20MS_HOPS] =
|
||||||
//{
|
//{
|
||||||
// 1500, 1600, 1700, 1800, 1900, 1400, 1300, 1200,
|
// 1500, 1600, 1700, 1800, 1900, 1400, 1300, 1200,
|
||||||
// 1100, 1000, 900
|
// 1100, 1000, 900
|
||||||
//};
|
// };
|
||||||
|
|
||||||
uint16_t hopPattern_10KBPS_20MS[L1_FRAME_10KBPS_20MS_HOPS] =
|
const uint16_t hopPattern_10KBPS_20MS[L1_FRAME_10KBPS_20MS_HOPS] =
|
||||||
{
|
{
|
||||||
1500, 1500, 1500, 1500, 1500, 1500, 1500, 1500,
|
1500, 1500, 1500, 1500, 1500, 1500, 1500, 1500,
|
||||||
1500, 1500, 1500
|
1500, 1500, 1500
|
||||||
};
|
};
|
||||||
|
|
||||||
uint16_t hopPattern_40KBPS_10MS[L1_FRAME_40KBPS_10MS_HOPS] =
|
const uint16_t hopPattern_40KBPS_10MS[L1_FRAME_40KBPS_10MS_HOPS] =
|
||||||
{
|
{
|
||||||
1600, 1650, 1700, 1750, 1800, 1850, 1900, 1550,
|
1600, 1650, 1700, 1750, 1800, 1850, 1900, 1550,
|
||||||
1500
|
1500
|
||||||
};
|
};
|
||||||
|
|
||||||
//uint16_t hopPattern_40KBPS_20MS[L1_FRAME_40KBPS_20MS_HOPS] =
|
// uint16_t hopPattern_40KBPS_20MS[L1_FRAME_40KBPS_20MS_HOPS] =
|
||||||
//{
|
//{
|
||||||
// 1600, 1650, 1700, 1750, 1800, 1850, 1900, 1550,
|
// 1600, 1650, 1700, 1750, 1800, 1850, 1900, 1550,
|
||||||
// 1500, 1450, 1400, 1350, 1300, 1250, 1200, 1150,
|
// 1500, 1450, 1400, 1350, 1300, 1250, 1200, 1150,
|
||||||
// 1100, 1050, 1000
|
// 1100, 1050, 1000
|
||||||
//};
|
// };
|
||||||
|
|
||||||
uint16_t hopPattern_40KBPS_20MS[L1_FRAME_40KBPS_20MS_HOPS] =
|
const uint16_t hopPattern_40KBPS_20MS[L1_FRAME_40KBPS_20MS_HOPS] =
|
||||||
{
|
{
|
||||||
1700, 1800, 1900, 2000, 1700, 1700, 1700, 1700,
|
1700, 1800, 1900, 2000, 1700, 1700, 1700, 1700,
|
||||||
1700, 1700, 1700, 1700, 1700, 1700, 1700, 1700,
|
1700, 1700, 1700, 1700, 1700, 1700, 1700, 1700,
|
||||||
1700, 1700, 1700
|
1700, 1700, 1700
|
||||||
};
|
};
|
||||||
|
|
||||||
uint16_t hopPattern_200KBPS_5MS[L1_FRAME_200KBPS_5MS_HOPS] =
|
const uint16_t hopPattern_200KBPS_5MS[L1_FRAME_200KBPS_5MS_HOPS] =
|
||||||
{
|
{
|
||||||
500, 1600, 1700, 1800, 1900, 2000, 1500, 1600,
|
500, 1600, 1700, 1800, 1900, 2000, 1500, 1600,
|
||||||
1700, 1800, 1900, 2000, 1500, 1600, 1700, 1800,
|
1700, 1800, 1900, 2000, 1500, 1600, 1700, 1800,
|
||||||
1900, 2000, 1500, 1500
|
1900, 2000, 1500, 1500
|
||||||
};
|
};
|
||||||
|
|
||||||
uint16_t hopPattern_1M2BPS_5MS[L1_FRAME_1M2BPS_5MS_HOPS] =
|
const uint16_t hopPattern_1M2BPS_5MS[L1_FRAME_1M2BPS_5MS_HOPS] =
|
||||||
{
|
{
|
||||||
500, 600, 700, 800, 900, 1000, 500, 600,
|
500, 600, 700, 800, 900, 1000, 500, 600,
|
||||||
700, 800, 900, 1000, 500, 600, 700, 800,
|
700, 800, 900, 1000, 500, 600, 700, 800,
|
||||||
900, 1000, 500, 500
|
900, 1000, 500, 500
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/** @} PhysicalLayer_AntennaConfig_Constants*/
|
||||||
|
|
||||||
/*****************************************************************************/
|
/*****************************************************************************/
|
||||||
/**
|
/**
|
||||||
@@ -261,10 +257,10 @@ void Phy_SetBeamTable(PHY_INST *instPtr, PHY_ANT_ANGLE *table, uint32_t offset)
|
|||||||
ASSERT(table != NULL);
|
ASSERT(table != NULL);
|
||||||
for (int i = 0; i < L1_NUM_ANT_NRRW_PATTERN; i++)
|
for (int i = 0; i < L1_NUM_ANT_NRRW_PATTERN; i++)
|
||||||
{
|
{
|
||||||
instPtr->antNrrwPattern[i] = table[(i+offset) % L1_NUM_ANT_NRRW_PATTERN];
|
instPtr->antNrrwPattern[i] = table[(i + offset) % L1_NUM_ANT_NRRW_PATTERN];
|
||||||
}
|
}
|
||||||
memcpy((uint32_t*)instPtr->antInfoAddr, instPtr->antNrrwPattern,
|
memcpy((uint32_t *)instPtr->antInfoAddr, instPtr->antNrrwPattern,
|
||||||
L1_NUM_ANT_NRRW_PATTERN*sizeof(PHY_ANT_ANGLE));
|
L1_NUM_ANT_NRRW_PATTERN * sizeof(PHY_ANT_ANGLE));
|
||||||
}
|
}
|
||||||
|
|
||||||
/*****************************************************************************/
|
/*****************************************************************************/
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -224,7 +224,6 @@ typedef struct
|
|||||||
bool isFrameSync; ///< indicates if last reception frame sync success
|
bool isFrameSync; ///< indicates if last reception frame sync success
|
||||||
bool isDecode; ///< indicates if last reception decode success
|
bool isDecode; ///< indicates if last reception decode success
|
||||||
bool isValid; ///< indicates if last reception frame data valid (crc check pass)
|
bool isValid; ///< indicates if last reception frame data valid (crc check pass)
|
||||||
bool isPresetHop; ///< indicates if using preset frequency hop
|
|
||||||
TIME_WORD recvSlotTime; ///< last slot start time stamp
|
TIME_WORD recvSlotTime; ///< last slot start time stamp
|
||||||
TIME_WORD recvFsTime; ///< last frame sync time stamp
|
TIME_WORD recvFsTime; ///< last frame sync time stamp
|
||||||
PHY_RCD antNo; ///< antenna number record
|
PHY_RCD antNo; ///< antenna number record
|
||||||
@@ -244,45 +243,45 @@ typedef struct
|
|||||||
uint32_t lastLogTime; /// physical state log time stamp
|
uint32_t lastLogTime; /// physical state log time stamp
|
||||||
} PHY_INST;
|
} PHY_INST;
|
||||||
|
|
||||||
/************************** Variable Definitions *****************************/
|
|
||||||
extern uint16_t hopPattern_Config[L1_FRAME_MAX_HOPS];
|
|
||||||
extern uint16_t hopPattern_2KBPS_20MS[L1_FRAME_2KBPS_20MS_HOPS];
|
|
||||||
extern uint16_t hopPattern_2KBPS_100MS[L1_FRAME_2KBPS_100MS_HOPS];
|
|
||||||
extern uint16_t hopPattern_10KBPS_10MS[L1_FRAME_10KBPS_10MS_HOPS];
|
|
||||||
extern uint16_t hopPattern_10KBPS_20MS[L1_FRAME_10KBPS_20MS_HOPS];
|
|
||||||
extern uint16_t hopPattern_40KBPS_10MS[L1_FRAME_40KBPS_10MS_HOPS];
|
|
||||||
extern uint16_t hopPattern_40KBPS_20MS[L1_FRAME_40KBPS_20MS_HOPS];
|
|
||||||
extern uint16_t hopPattern_200KBPS_5MS[L1_FRAME_200KBPS_5MS_HOPS];
|
|
||||||
extern uint16_t hopPattern_1M2BPS_5MS[L1_FRAME_1M2BPS_5MS_HOPS];
|
|
||||||
|
|
||||||
/************************** Function Prototypes ******************************/
|
/************************** Function Prototypes ******************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup PhysicalLayer_Main
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
int32_t Phy_Init(PHY_INST **instPtr, PHY_CONFIG *phyConfig);
|
int32_t Phy_Init(PHY_INST **instPtr, PHY_CONFIG *phyConfig);
|
||||||
void Phy_Destroy(PHY_INST *instPtr);
|
void Phy_Destroy(PHY_INST *instPtr);
|
||||||
|
|
||||||
void Phy_UpdateState(PHY_INST *instPtr);
|
|
||||||
void Phy_UpdateLogging(PHY_INST *instPtr);
|
|
||||||
void Phy_RefreshHwSate(PHY_INST *instPtr);
|
|
||||||
|
|
||||||
void Phy_Start(PHY_INST *instPtr);
|
void Phy_Start(PHY_INST *instPtr);
|
||||||
void Phy_Halt(PHY_INST *instPtr);
|
void Phy_Halt(PHY_INST *instPtr);
|
||||||
int32_t Phy_SetMode(PHY_INST *instPtr, PHY_MODE modeCod);
|
|
||||||
|
|
||||||
|
int32_t Phy_SetMode(PHY_INST *instPtr, PHY_MODE modeCod);
|
||||||
|
int32_t Phy_SetTimeWord(PHY_INST *instPtr, const TIME_WORD *tmWord, PHY_TIME_WORD_TYPE tmType);
|
||||||
int32_t Phy_SetupNextSlot(PHY_INST *instPtr, PHY_TOR_TYPE txrxMode, L1_FRAME_TYPE frameType, uint8_t *dataBuff);
|
int32_t Phy_SetupNextSlot(PHY_INST *instPtr, PHY_TOR_TYPE txrxMode, L1_FRAME_TYPE frameType, uint8_t *dataBuff);
|
||||||
|
void Phy_UpdateState(PHY_INST *instPtr);
|
||||||
void Phy_PeekRecvData(PHY_INST *instPtr, uint8_t *dataBuff);
|
void Phy_PeekRecvData(PHY_INST *instPtr, uint8_t *dataBuff);
|
||||||
void Phy_RetrieveRecvData(PHY_INST *instPtr, uint8_t *dataBuff);
|
void Phy_RetrieveRecvData(PHY_INST *instPtr, uint8_t *dataBuff);
|
||||||
|
void Phy_UpdateLogging(PHY_INST *instPtr);
|
||||||
|
void Phy_RefreshHwSate(PHY_INST *instPtr);
|
||||||
|
/** @} PhysicalLayer_Main*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup PhysicalLayer_Utility
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
bool Phy_IsFrameDetected(PHY_INST *instPtr);
|
bool Phy_IsFrameDetected(PHY_INST *instPtr);
|
||||||
bool Phy_IsFrameReceived(PHY_INST *instPtr);
|
bool Phy_IsFrameReceived(PHY_INST *instPtr);
|
||||||
bool Phy_IsFrameValid(PHY_INST *instPtr);
|
bool Phy_IsFrameValid(PHY_INST *instPtr);
|
||||||
uint32_t Phy_GetFrameLen(L1_FRAME_TYPE frameType);
|
uint32_t Phy_GetFrameLen(L1_FRAME_TYPE frameType);
|
||||||
|
|
||||||
L1_FRAME_TYPE Phy_GetLastRecvFrameType(PHY_INST *instPtr);
|
|
||||||
L1_FRAME_TYPE Phy_GetLastSendFrameType(PHY_INST *instPtr);
|
|
||||||
|
|
||||||
int32_t Phy_SetHopPattern(void *patternBuff, uint32_t patternLen);
|
|
||||||
uint32_t Phy_GetHopLength(L1_FRAME_TYPE frameType);
|
uint32_t Phy_GetHopLength(L1_FRAME_TYPE frameType);
|
||||||
uint32_t Phy_GetTimeComp(L1_FRAME_TYPE frameType);
|
uint32_t Phy_GetTimeComp(L1_FRAME_TYPE frameType);
|
||||||
|
L1_FRAME_TYPE Phy_GetLastRecvFrameType(PHY_INST *instPtr);
|
||||||
|
L1_FRAME_TYPE Phy_GetLastSendFrameType(PHY_INST *instPtr);
|
||||||
|
/** @} PhysicalLayer_Utility*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup PhysicalLayer_Receive_Estimations
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
uint8_t Phy_LastScanBeamNo(PHY_INST *instPtr);
|
uint8_t Phy_LastScanBeamNo(PHY_INST *instPtr);
|
||||||
double Phy_GetFreqEst(PHY_INST *instPtr);
|
double Phy_GetFreqEst(PHY_INST *instPtr);
|
||||||
double Phy_GetCoarseFreqEst(PHY_INST *instPtr);
|
double Phy_GetCoarseFreqEst(PHY_INST *instPtr);
|
||||||
@@ -291,6 +290,7 @@ void Phy_GetFrameSyncTimeStamp(PHY_INST *instPtr, TIME_WORD *frameSyncT);
|
|||||||
void Phy_GetLastReceivedFrameSyncTimeStamp(PHY_INST *instPtr, TIME_WORD *frameSyncT);
|
void Phy_GetLastReceivedFrameSyncTimeStamp(PHY_INST *instPtr, TIME_WORD *frameSyncT);
|
||||||
void Phy_GetSlotStartTimeStamp(PHY_INST *instPtr, TIME_WORD *slotStart);
|
void Phy_GetSlotStartTimeStamp(PHY_INST *instPtr, TIME_WORD *slotStart);
|
||||||
void Phy_GetLastReceivedSlotStartTimeStamp(PHY_INST *instPtr, TIME_WORD *slotStart);
|
void Phy_GetLastReceivedSlotStartTimeStamp(PHY_INST *instPtr, TIME_WORD *slotStart);
|
||||||
|
/** @} PhysicalLayer_Receive_Estimations*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup PhysicalLayer_AntennaControl
|
* @defgroup PhysicalLayer_AntennaControl
|
||||||
@@ -302,8 +302,8 @@ void Phy_SetBeamTable(PHY_INST *instPtr, PHY_ANT_ANGLE *table, uint32_t offset);
|
|||||||
int32_t Phy_SetBeamWidth(PHY_INST *instPtr, PHY_ANT_BEAM_WIDTH beamWidth);
|
int32_t Phy_SetBeamWidth(PHY_INST *instPtr, PHY_ANT_BEAM_WIDTH beamWidth);
|
||||||
int32_t Phy_SetBeamNo(PHY_INST *instPtr, int32_t beamNo, PHY_ANT_BEAM_WIDTH beamWidth);
|
int32_t Phy_SetBeamNo(PHY_INST *instPtr, int32_t beamNo, PHY_ANT_BEAM_WIDTH beamWidth);
|
||||||
int32_t Phy_SetBeamAngle(PHY_INST *phyInstPtr, double offAx, double rndAx);
|
int32_t Phy_SetBeamAngle(PHY_INST *phyInstPtr, double offAx, double rndAx);
|
||||||
int32_t Phy_SetTimeWord(PHY_INST *instPtr, const TIME_WORD *tmWord, PHY_TIME_WORD_TYPE tmType);
|
|
||||||
/** @} PhysicalLayer_AntennaControl*/
|
/** @} PhysicalLayer_AntennaControl*/
|
||||||
|
|
||||||
#endif // PHY_CTRL_H_
|
#endif // PHY_CTRL_H_
|
||||||
|
|
||||||
/** @} PhysicalLayer*/
|
/** @} PhysicalLayer*/
|
||||||
Reference in New Issue
Block a user