misc update

comtool-plugin-duifei.py

@@ -0,0 +1,440 @@
+'''
+    @brief This is an example plugin, can receive and send data
+    @author
+    @date
+    @license LGPL-3.0
+'''
+from PyQt5.QtWidgets import QWidget, QVBoxLayout, QHBoxLayout, QTextEdit, QPushButton, QLabel, QScrollArea, QSplitter
+from PyQt5.QtCore import Qt, pyqtSignal
+from PyQt5.QtGui import QFont, QTextCursor
+from struct import Struct
+try:
+    import utils_ui
+    from plugins.base import Plugin_Base
+    from conn import ConnectionStatus
+    from i18n import _
+    from widgets import statusBar
+except ImportError:
+    from COMTool import utils_ui
+    from COMTool.plugins.base import Plugin_Base
+    from COMTool.i18n import _
+    from COMTool.conn import  ConnectionStatus
+    from COMTool.widgets import statusBar
+
+class Plugin(Plugin_Base):
+    id = "DEIFEI"
+    name = _("DUIFEI")
+    showReceiveDataSignal = pyqtSignal(str)
+
+    def onInit(self, config):
+        '''
+            init params
+        '''
+        default = {
+            "version": 1,
+            "customSendItems": [
+                {
+                    "caption": "自检",
+                    "icon": "fa5.question-circle",
+                    "data": "5A 54 E1 DD 00 BE 02 5A FE"
+                },
+                # {
+                #     "caption": "数据发送测试 - 1",
+                #     "icon": "fa5.play-circle",
+                #     "data": ""
+                # },
+                # {
+                #     "caption": "数据发送测试 - 2",
+                #     "icon": "fa5.play-circle",
+                #     "data": ""
+                # },
+                {
+                    "caption": "装订 - 【主】反拦截小功率",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E3 DD 77 11 00 00 00 48 06 5A FE"
+                },
+                {
+                    "caption": "装订 - 【主】反拦截全功率",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E3 DD 66 11 00 00 00 37 06 5A FE"
+                },
+                {
+                    "caption": "装订 - 【主】反拦截静默",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E3 DD 88 11 00 00 00 59 06 5A FE"
+                },
+                {
+                    "caption": "遥测 - 【主】反拦截",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E6 DD 99 00 5C 03 5A FE"
+                },
+                {
+                    "caption": "点名 - 【主】反拦截",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E5 DD 77 00 39 03 5A FE"
+                },
+                {
+                    "caption": "装订 - 【从】拦截小功率",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E3 DD 77 00 00 00 00 37 06 5A FE"
+                },
+                {
+                    "caption": "装订 - 【从】拦截大功率",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E3 DD 66 00 00 00 00 26 06 5A FE"
+                },
+                {
+                    "caption": "装订 - 【从】拦截静默",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 E3 DD 88 00 00 00 00 48 06 5A FE"
+                },
+                {
+                    "caption": "遥测 - 【从】拦截",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 F6 DD 99 00 6C 03 5A FE"
+                },
+                {
+                    "caption": "点名 - 【从】拦截",
+                    "icon": "fa5.play-circle",
+                    "data": "5A 54 F5 DD 77 00 49 03 5A FE"
+                }
+            ]
+        }
+        self.config = config
+        for k in default:
+            if not k in self.config:
+                self.config[k] = default[k]
+
+    def onConnChanged(self, status:ConnectionStatus, msg:str):
+        print("-- connection changed: {}, msg: {}".format(status, msg))
+
+    def onWidgetMain(self, parent):
+        '''
+            main widget, just return a QWidget object
+        '''
+        self.mainWidget = QSplitter(Qt.Vertical)
+        # receive widget
+        self.receiveWidget = QTextEdit("")
+        font = QFont('Consolas, DejaVu Sans Mono, Courier New, monospace, Microsoft YaHei', 10)
+        self.receiveWidget.setFont(font)
+        self.receiveWidget.setLineWrapMode(QTextEdit.NoWrap)
+        # clear button
+        self.clearBtn = QPushButton("")
+        utils_ui.setButtonIcon(self.clearBtn, "mdi6.broom")
+        # send scroll
+        self.customSendScroll = QScrollArea()
+        self.customSendScroll.setMinimumHeight(20)
+        self.customSendScroll.setWidgetResizable(True)
+        self.customSendScroll.setVerticalScrollBarPolicy(Qt.ScrollBarAsNeeded)
+        self.customSendScroll.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
+        cutomSendItemsWraper = QWidget()
+        self.customSendScroll.setWidget(cutomSendItemsWraper)
+
+        # -- wrapper widget
+        cutomSendItemsWraper0 = QWidget()
+        cutomSendItemsWraper0.setProperty("class", "scrollbar2")
+        layout0 = QVBoxLayout()
+        layout0.setContentsMargins(0,8,0,0)
+        cutomSendItemsWraper0.setLayout(layout0)
+        layout0.addWidget(self.customSendScroll)
+        customSendItemsLayoutWrapper = QVBoxLayout()
+        customSendItemsLayoutWrapper.setContentsMargins(0,0,0,0)
+        cutomSendItemsWraper.setLayout(customSendItemsLayoutWrapper)
+
+        # -- items container
+        self.customItems = QWidget()
+        self.customSendItemsLayout = QVBoxLayout()
+        self.customSendItemsLayout.setContentsMargins(0,0,0,0)
+        self.customItems.setLayout(self.customSendItemsLayout)
+        customSendItemsLayoutWrapper.addWidget(self.customItems)
+        customSendItemsLayoutWrapper.addStretch(0)
+
+        # add widgets
+        self.mainWidget.addWidget(self.receiveWidget)
+        self.mainWidget.addWidget(self.clearBtn)
+        self.mainWidget.addWidget(cutomSendItemsWraper0)
+        self.mainWidget.setStretchFactor(0, 2)
+        self.mainWidget.setStretchFactor(1, 1)
+        self.mainWidget.setStretchFactor(2, 11)
+
+        # event
+        def clearReceived():
+            self.receiveWidget.clear();self.statusBar.clear()
+        self.clearBtn.clicked.connect(clearReceived)
+        return self.mainWidget
+
+    def onWidgetStatusBar(self, parent):
+        self.statusBar = statusBar(rxTxCount=True)
+        return self.statusBar
+
+    def onUiInitDone(self):
+        '''
+            UI init done, you can update your widget here
+            this method runs in UI thread, do not block too long
+        '''
+        newItems = []
+        print(self.config["customSendItems"])
+        for item in self.config["customSendItems"]:
+            print(item)
+            item = self.insertSendItem(item, load=True)
+            newItems.append(item)
+        self.config["customSendItems"] = newItems
+        self.showReceiveDataSignal.connect(self.showReceivedData)
+        # frame struct
+        self.structSelfTestRsp = Struct("<BB B BBBbbb BbBBB H")
+        self.structStatusCheckRsp = Struct("<BB Q      HIII      IBBBBI BBHH HHHIIIIII i II 4s      IIII d Q dBB dB H B 3s      BBBbbb BbBBB 2s")
+        self.structFljData = Struct("<dddd IHI fff fff")
+        self.structLjData = Struct("<IHI ffff IHI fff fff fff IHI fff fff fff IHI fff fff fff I")
+        self.structSysInfo = Struct("<IHI H B I B fff fff fff")
+
+    def insertSendItem(self, item = None, load = False):
+        caption = item["caption"]
+        itemWidget = QWidget()
+        layout = QHBoxLayout()
+        layout.setContentsMargins(0,0,0,0)
+        itemWidget.setLayout(layout)
+        send = QPushButton("")
+        label = QLabel(caption)
+        if (not "icon" in item) or not item["icon"]:
+            item["icon"] = "fa.send"
+        utils_ui.setButtonIcon(send, item["icon"])
+        send.setProperty("class", "smallBtn")
+        def sendCustomData(idx):
+            self.sendCustomItem(self.config["customSendItems"][idx])
+        send.clicked.connect(lambda: sendCustomData(self.customSendItemsLayout.indexOf(itemWidget)))
+        layout.addWidget(label)
+        layout.addWidget(send)
+        self.customSendItemsLayout.addWidget(itemWidget)
+        if not load:
+            self.config["customSendItems"].append(item)
+        return item
+
+    def showReceivedData(self, text: str):
+        curScrollValue = self.receiveWidget.verticalScrollBar().value()
+        self.receiveWidget.moveCursor(QTextCursor.End)
+        endScrollValue = self.receiveWidget.verticalScrollBar().value()
+        self.receiveWidget.insertPlainText(text)
+        if curScrollValue < endScrollValue:
+            self.receiveWidget.verticalScrollBar().setValue(curScrollValue)
+        else:
+            self.receiveWidget.moveCursor(QTextCursor.End)
+
+    def onReceived(self, data : bytes):
+        '''
+            call in receive thread, not UI thread
+        '''
+        self.statusBar.addRx(len(data))
+        ## Apply data validation check
+        if len(data) < 7:
+            self.showReceiveDataSignal.emit("\n### Wrong data format: wrong frame header/tail\n")
+            return
+
+        dataLen = data[-3]
+        if data[0] != 0x5A or data[1] != 0x54 or data[-1] != 0xFE or data[-2] != 0x5A:
+            self.showReceiveDataSignal.emit("\n### Wrong data format: wrong length\n")
+
+        checkSum = 0
+        for i in data[2:-4]:
+            checkSum += i
+        if checkSum & 0xFF != data[-4]:
+            self.showReceiveDataSignal.emit("\n### Wrong data format: wrong check sum\n")
+
+        ## Eval data
+        data = data[2:-5].replace(b'\x00\x54\xFE', b'\x54\xFE')
+        # self.printFrame(data)
+        if data[0] == 0xE1:
+            # eval self test
+            self.showReceiveDataSignal.emit(self.evalSelfTestRsp(data) + "\n")
+        elif data[0] == 0xE6 or data[0] == 0xF6:
+            self.showReceiveDataSignal.emit(self.evalStatusCheckRsp(data) + "\n")
+        elif data[0] == 0xE5 or data[0] == 0xF5:
+            self.showReceiveDataSignal.emit('Retrieved Data Frame:\n' + self.printFrame(data) + "\n")
+        else:
+            self.showReceiveDataSignal.emit(f"\n### Unexpected response code 0x{data[0]:02x}.\n")
+
+    def evalSelfTestRsp(self, data: bytes):
+        try:
+            payload = self.structSelfTestRsp.unpack(data)
+        except :
+            return f"\n### evalSelfTestRsp:: Failed to unpack data (data length {len(data)} byte).\n"
+
+        ret = "----------- 自检回令 -----------\n"
+
+        ret += "节点类型: "
+        if payload[1] == 0xDD:
+            ret += f"K频段 (0x{payload[1]:02X})\n"
+        elif payload[1] == 0xEE:
+            ret += f"S频段 (0x{payload[1]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[1]:02X})\n"
+
+        ret += "自检结果: "
+        if payload[2] == 0xAA:
+            ret += f"正常 (0x{payload[2]:02X})\n"
+        elif payload[2] == 0x55:
+            ret += f"异常 (0x{payload[2]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[2]:02X})\n"
+
+        hwOffset = 3
+
+        ret += f"FPGA 电压监测: {bin(payload[hwOffset+0])[2:].zfill(8)}\n"
+        ret += f"时钟锁定状态:   {bin(payload[hwOffset+1])[2:].zfill(8)}\n"
+        ret += f"AD 锁定状态:   {bin(payload[hwOffset+2])[2:].zfill(8)}\n"
+        ret += f"AD 温度 1: {payload[hwOffset+3]:>4d}\n"
+        ret += f"AD 温度 2: {payload[hwOffset+4]:>4d}\n"
+        ret += f"FPGA 温度: {payload[hwOffset+5]:>4d}\n"
+        ret += f"电压监测: {bin(payload[hwOffset+6])[2:].zfill(8)}\n"
+        ret += f"射频温度: {payload[hwOffset+7]:>4d}\n"
+        ret += f"锁定指示: {bin(payload[hwOffset+8])[2:].zfill(8)}\n"
+        ret += f"MGC 1~2: {payload[hwOffset+9] & 0x0f:>2d} - {payload[hwOffset+9] >> 4:>2d}\n"
+        ret += f"MGC 3~4: {payload[hwOffset+10] & 0x0f:>2d} - {payload[hwOffset+10] >> 4:>2d}\n"
+        ret += "--------------------------------\n"
+
+        return ret + '\n' + self.printFrame(data)
+
+    def printFrame(self, data: bytes):
+        ret = ''
+        for i in range(len(data)):
+            ret += f'{data[i]:02X}'
+            ret += '\n' if i%16 == 15 else ' '
+        ret += '\n'
+        return ret
+
+    def evalStatusCheckRsp(self, data: bytes):
+        try:
+            payload = self.structStatusCheckRsp.unpack(data)
+        except :
+            return f"\n### evalStatusCheckRsp:: Failed to unpack data (data length {len(data)} byte).\n"
+
+        ret = "----------- 遥测回令 -----------\n"
+
+        ret += "节点类型: "
+        if payload[1] == 0xDD:
+            ret += f"K频段 (0x{payload[1]:02X})\n"
+        elif payload[1] == 0xEE:
+            ret += f"S频段 (0x{payload[1]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[1]:02X})\n"
+
+        ret += f"时间戳: {payload[2]/1e5:.2f} ms\n"
+
+        sysbusOffset = 3
+        linkOffset = 7
+        phyOffset = 30
+        hwOffset = 44
+
+        ret += "\n  -- 总线状态\n"
+        ret += f"配置装订:    {payload[sysbusOffset + 0]:04X}\n"
+        ret += f"装置点名计数: {payload[sysbusOffset + 1]:>6d}\n"
+        ret += f"业务下发计数: {payload[sysbusOffset + 2]:>6d}\n"
+        ret += f"遥测请求计数: {payload[sysbusOffset + 3]:>6d}\n"
+
+        ret += "\n  -- 链路层状态\n"
+        ret += f"帧号:   {payload[linkOffset + 0]:>6d}\n"
+        ret += f"时隙号: {payload[linkOffset + 1]:>3d}\n"
+
+        ret += "当前角色: "
+        if payload[linkOffset + 2] == 0xAA:
+            ret += f"反拦截 (0x{payload[linkOffset + 2]:02X})\n"
+        elif payload[linkOffset + 2] == 0xCC:
+            ret += f"拦截 (0x{payload[linkOffset + 2]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[linkOffset + 2]:02X})\n"
+
+        ret += "网络连接状态: "
+        if payload[linkOffset + 3] == 0x11:
+            ret += f"已连接 (0x{payload[linkOffset + 3]:02X})\n"
+        elif payload[linkOffset + 3] == 0x00:
+            ret += f"未连接 (0x{payload[linkOffset + 3]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[linkOffset + 3]:02X})\n"
+
+        ret += "网络运行阶段: "
+        if payload[linkOffset + 4] == 0x11:
+            ret += f"扫描建网 (0x{payload[linkOffset + 4]:02X})\n"
+        elif payload[linkOffset + 4] == 0x22:
+            ret += f"业务通信 (0x{payload[linkOffset + 4]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[linkOffset + 4]:02X})\n"
+
+        ret += f"重建/入网计数: {payload[linkOffset + 5]:>6d}\n"
+        ret += f"通信波位号:  {payload[linkOffset + 6]:>2d}\n"
+
+        ret += "通信波束宽度: "
+        if payload[linkOffset + 7] == 0x01:
+            ret += f"120° 宽波束 (0x{payload[linkOffset + 7]:02X})\n"
+        elif payload[linkOffset + 7] == 0x02:
+            ret += f"60° 次波束 (0x{payload[linkOffset + 7]:02X})\n"
+        elif payload[linkOffset + 7] == 0x03:
+            ret += f"25° 次波束 (0x{payload[linkOffset + 7]:02X})\n"
+        elif payload[linkOffset + 7] == 0x04:
+            ret += f"8° 窄波束 (0x{payload[linkOffset + 7]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[linkOffset + 7]:02X})\n"
+
+        ret += f"离轴角: {payload[linkOffset + 8]*0.1:.2f}°\n"
+        ret += f"偏航角: {payload[linkOffset + 9]*0.1:.2f}°\n"
+        ret += f"基准帧发送计数: {payload[linkOffset + 10]:>6d}\n"
+        ret += f"基准帧接收计数: {payload[linkOffset + 11]:>6d}\n"
+        ret += f"基准帧正确计数: {payload[linkOffset + 12]:>6d}\n"
+        ret += f"双向握手帧发送计数: {payload[linkOffset + 13]:>6d}\n"
+        ret += f"双向握手帧接收计数: {payload[linkOffset + 14]:>6d}\n"
+        ret += f"双向握手帧正确计数: {payload[linkOffset + 15]:>6d}\n"
+        ret += f"业务帧发送计数: {payload[linkOffset + 16]:>6d}\n"
+        ret += f"业务帧接收计数: {payload[linkOffset + 17]:>6d}\n"
+        ret += f"业务帧正确计数: {payload[linkOffset + 18]:>6d}\n"
+        ret += f"时间偏差记录: {payload[linkOffset + 19]/1e2:.2f} us\n"
+        ret += f"发送数据 ID: {payload[linkOffset + 20]:>6d}\n"
+        ret += f"接收数据 ID: {payload[linkOffset + 21]:>6d}\n"
+
+        ret += "\n  -- 物理层状态\n"
+        ret += f"捕获计数:    {payload[phyOffset + 0]:>6d}\n"
+        ret += f"帧同步计数:  {payload[phyOffset + 1]:>6d}\n"
+        ret += f"译码计数:    {payload[phyOffset + 2]:>6d}\n"
+        ret += f"CRC 正确计数:{payload[phyOffset + 3]:>6d}\n"
+        ret += f"多普勒估计:  {payload[phyOffset + 4]:.2f} Hz\n"
+        ret += f"正确接收时刻: {payload[phyOffset + 5]/1e2:.2f} us\n"
+        ret += f"捕获峰均比:  {payload[phyOffset + 6]:.2f}\n"
+        ret += f"捕获相位值:  {payload[phyOffset + 7]:>3d}\n"
+        ret += f"捕获频偏通道: {payload[phyOffset + 8]:>3d}\n"
+        ret += f"帧同步峰均比:   {payload[phyOffset + 9]:.2f}\n"
+        ret += f"帧同步频偏通道: {payload[phyOffset + 10]:>3d}\n"
+        ret += f"交织输入数据幅度统计:\t0x{payload[phyOffset + 11]:04X}\n"
+        ret += "天线工作模式: "
+        if payload[phyOffset + 12] == 0x01:
+            ret += f"静默模式 (0x{payload[phyOffset + 12]:02X})\n"
+        elif payload[phyOffset + 12] == 0x02:
+            ret += f"低功率模式 (0x{payload[phyOffset + 12]:02X})\n"
+        elif payload[phyOffset + 12] == 0x03:
+            ret += f"全功率模式 (0x{payload[phyOffset + 12]:02X})\n"
+        else:
+            ret += f"【未知错误】(0x{payload[phyOffset + 12]:02X})\n"
+
+        ret += "\n  -- 硬件状态\n"
+        ret += f"FPGA 电压监测: {bin(payload[hwOffset+0])[2:].zfill(8)}\n"
+        ret += f"时钟锁定状态:   {bin(payload[hwOffset+1])[2:].zfill(8)}\n"
+        ret += f"AD 锁定状态:   {bin(payload[hwOffset+2])[2:].zfill(8)}\n"
+        ret += f"AD 温度 1: {payload[hwOffset+3]:>4d}\n"
+        ret += f"AD 温度 2: {payload[hwOffset+4]:>4d}\n"
+        ret += f"FPGA 温度: {payload[hwOffset+5]:>4d}\n"
+        ret += f"电压监测: {bin(payload[hwOffset+6])[2:].zfill(8)}\n"
+        ret += f"射频温度: {payload[hwOffset+7]:>4d}\n"
+        ret += f"锁定指示: {bin(payload[hwOffset+8])[2:].zfill(8)}\n"
+        ret += f"MGC 1~2: {payload[hwOffset+9] & 0x0f:>2d} - {payload[hwOffset+9] >> 4:>2d}\n"
+        ret += f"MGC 3~4: {payload[hwOffset+10] & 0x0f:>2d} - {payload[hwOffset+10] >> 4:>2d}\n"
+
+        ret += "--------------------------------\n"
+        return ret + '\n' + self.printFrame(data)
+
+    def onSent(self, ok, msg, length, path):
+        if ok:
+            self.statusBar.addTx(length)
+        else:
+            self.hintSignal.emit("error", _("Error"), _("Send data failed!") + " " + msg)
+
+    def sendCustomItem(self, item):
+        data = item["data"]
+        dateBytes = self.parseSendData(data, encoding = self.configGlobal["encoding"], isHexStr = True)
+        if dateBytes:
+            self.send(dateBytes, callback=self.onSent)

df_datalink_ge/bsp/ps7_cortexa9_0/include/xparameters.h

@@ -359,20 +359,20 @@
 /* Definitions for driver GPIO */
 #define XPAR_XGPIO_NUM_INSTANCES 1
 
-/* Definitions for peripheral CONFIG_GPIO */
+/* Definitions for peripheral MPC_GPIO */
-#define XPAR_CONFIG_GPIO_BASEADDR 0x41200000
+#define XPAR_MPC_GPIO_BASEADDR 0x41200000
-#define XPAR_CONFIG_GPIO_HIGHADDR 0x4120FFFF
+#define XPAR_MPC_GPIO_HIGHADDR 0x4120FFFF
-#define XPAR_CONFIG_GPIO_DEVICE_ID 0
+#define XPAR_MPC_GPIO_DEVICE_ID 0
-#define XPAR_CONFIG_GPIO_INTERRUPT_PRESENT 0
+#define XPAR_MPC_GPIO_INTERRUPT_PRESENT 0
-#define XPAR_CONFIG_GPIO_IS_DUAL 1
+#define XPAR_MPC_GPIO_IS_DUAL 1
 
 
 /******************************************************************/
 
-/* Canonical definitions for peripheral CONFIG_GPIO */
+/* Canonical definitions for peripheral MPC_GPIO */
 #define XPAR_GPIO_0_BASEADDR 0x41200000
 #define XPAR_GPIO_0_HIGHADDR 0x4120FFFF
-#define XPAR_GPIO_0_DEVICE_ID XPAR_CONFIG_GPIO_DEVICE_ID
+#define XPAR_GPIO_0_DEVICE_ID XPAR_MPC_GPIO_DEVICE_ID
 #define XPAR_GPIO_0_INTERRUPT_PRESENT 0
 #define XPAR_GPIO_0_IS_DUAL 1
 
@@ -425,17 +425,14 @@
 
 /* Definitions for Fabric interrupts connected to ps7_scugic_0 */
 #define XPAR_FABRIC_PHY_IRQ_INTR 61U
-#define XPAR_FABRIC_FRAME_UART_0_RX_INTR_INTR 62U
+#define XPAR_FABRIC_PHY_5MS_INTR 62U
-#define XPAR_FABRIC_FRAME_UART_0_TX_INTR_INTR 63U
+#define XPAR_FABRIC_PHY_5MS_DELAY_2MS_INTR 63U
-#define XPAR_FABRIC_MPC_IRQ_INTR 64U
+#define XPAR_FABRIC_MPC_RX_IRQ_INTR 64U
-#define XPAR_FABRIC_PHY_5MS_INTR 65U
+#define XPAR_FABRIC_MPC_TX_IRQ_INTR 65U
-#define XPAR_FABRIC_PHY_5MS_DELAY_2MS_INTR 66U
 
 /******************************************************************/
 
 /* Canonical definitions for Fabric interrupts connected to ps7_scugic_0 */
-#define XPAR_FABRIC_FRAME_UART_0_RX_INTR_VEC_ID XPAR_FABRIC_FRAME_UART_0_RX_INTR_INTR
-#define XPAR_FABRIC_FRAME_UART_0_TX_INTR_VEC_ID XPAR_FABRIC_FRAME_UART_0_TX_INTR_INTR
 
 /******************************************************************/
 

df_datalink_ge/bsp/ps7_cortexa9_0/libsrc/gpio_v4_4/src/xgpio_g.c

@@ -43,10 +43,10 @@
 XGpio_Config XGpio_ConfigTable[XPAR_XGPIO_NUM_INSTANCES] =
 {
 	{
-		XPAR_CONFIG_GPIO_DEVICE_ID,
+		XPAR_MPC_GPIO_DEVICE_ID,
-		XPAR_CONFIG_GPIO_BASEADDR,
+		XPAR_MPC_GPIO_BASEADDR,
-		XPAR_CONFIG_GPIO_INTERRUPT_PRESENT,
+		XPAR_MPC_GPIO_INTERRUPT_PRESENT,
-		XPAR_CONFIG_GPIO_IS_DUAL
+		XPAR_MPC_GPIO_IS_DUAL
 	}
 };
 

df_datalink_ge/bsp/system.mss

@@ -18,18 +18,6 @@ BEGIN PROCESSOR
 END
 
 
-BEGIN DRIVER
- PARAMETER DRIVER_NAME = frame_uart
- PARAMETER DRIVER_VER = 1.0
- PARAMETER HW_INSTANCE = Frame_Uart_0
-END
-
-BEGIN DRIVER
- PARAMETER DRIVER_NAME = gpio
- PARAMETER DRIVER_VER = 4.4
- PARAMETER HW_INSTANCE = config_gpio
-END
-
 BEGIN DRIVER
  PARAMETER DRIVER_NAME = generic
  PARAMETER DRIVER_VER = 2.0
@@ -54,6 +42,12 @@ BEGIN DRIVER
  PARAMETER HW_INSTANCE = mpc_bram_interface_mpc_bram_ctrl
 END
 
+BEGIN DRIVER
+ PARAMETER DRIVER_NAME = gpio
+ PARAMETER DRIVER_VER = 4.4
+ PARAMETER HW_INSTANCE = mpc_gpio
+END
+
 BEGIN DRIVER
  PARAMETER DRIVER_NAME = bram
  PARAMETER DRIVER_VER = 4.3

df_datalink_ge/build/makefile

@@ -13,7 +13,7 @@ RM := rm -rf
 -include sources.mk
 -include src/util/subdir.mk
 -include src/time_ctrl/subdir.mk
--include src/systembus/subdir.mk
+-include src/mpc/subdir.mk
 -include src/networking/phy_layer/subdir.mk
 -include src/networking/link_layer/geometry/subdir.mk
 -include src/networking/link_layer/subdir.mk

df_datalink_ge/build/src/mpc/subdir.mk

@@ -4,16 +4,16 @@
 
 # Add inputs and outputs from these tool invocations to the build variables
 C_SRCS += \
-../src/systembus/systembus.c \
+../src/mpc/mpc.c \
-../src/systembus/systembus_uart.c 
+../src/mpc/mpc_hw.c
 
 OBJS += \
-./src/systembus/systembus.o \
+./src/mpc/mpc.o \
-./src/systembus/systembus_uart.o 
+./src/mpc/mpc_hw.o
 
 C_DEPS += \
-./src/systembus/systembus.d \
+./src/mpc/mpc.d \
-./src/systembus/systembus_uart.d 
+./src/mpc/mpc_hw.d
 
 
 # Each subdirectory must supply rules for building sources it contributes

df_datalink_ge/src/config/app_config.h

@@ -35,6 +35,8 @@
 // 2 - print warnings and errors
 // 1 - print only errors
 // other - print nothing
+
+#define APP_EMULATE_DATA
 #define DATALINK_ENABLE_AUTORECONNECT
 #define DATALINK_ENABLE_AUTOTIMESYNC
 //#define DATALINK_ENABLE_BERTEST
@@ -71,9 +73,10 @@
 #define TIME_CONTROLLER_BASEADDR XPAR_TMC_BASEADDR
 
 // System Bus Configs
-//#define SYSBUS_BASE_ADDR	XPAR_SYSTEMBUS_BASEADDR
+#define MPC_BRAM_ID	XPAR_MPC_BRAM_INTERFACE_MPC_BRAM_CTRL_DEVICE_ID
-//#define SYSBUS_TX_INTR_ID	XPAR_FABRIC_SYSTEMBUS_TX_DONE_INTR
+#define MPC_GPIO_ID	XPAR_MPC_GPIO_DEVICE_ID
-//#define SYSBUS_RX_INTR_ID	XPAR_FABRIC_SYSTEMBUS_RX_DONE_INTR
+#define MPC_TX_INTR_ID	XPAR_FABRIC_MPC_TX_IRQ_INTR
+#define MPC_RX_INTR_ID	XPAR_FABRIC_MPC_RX_IRQ_INTR
 
 // Global Timer config
 #define GLOBAL_TIMER_DEVICE_ID	XPAR_GLOBAL_TMR_DEVICE_ID
@@ -93,9 +96,6 @@
 #if !defined(DATALINK_ENABLE_AUTOTIMESYNC)
 	#warning To enbale bit error rate test, auto time-sync should be enabled...
 #endif
-#if defined(DATALINK_ENABLE_AUTORECONNECT)
-	#error Do not support auto reconnnect in bit error rate test mode...
-#endif
 #endif
 
 #endif

df_datalink_ge/src/dev_profile/timer_profile.c

@@ -11,7 +11,7 @@ struct xil_timer_init_param xil_scutimer_init_param = {
 struct timer_init_param scutimer_init_param = {
 	.id = SCUTIMER_DEVICE_ID,
 	.freq_hz = SCU_TIMER_CLK_HZ,
-	.ticks_count = (SCU_TIMER_CLK_HZ/10), //update log every 100ms
+	.ticks_count = (SCU_TIMER_CLK_HZ/2), //update log every 500ms
 	.platform_ops = &xil_timer_ops,
 	.extra = &xil_scutimer_init_param
 };

df_datalink_ge/src/hardware/headless.h

@@ -1,7 +1,7 @@
 /*
  * headless.h
  *
- *  Created on: 2021Äê6ÔÂ8ÈÕ
+ *  Created on: 2021��6��8��
  *      Author: Josh
  */
 
@@ -30,7 +30,8 @@
 /**************************** Type Definitions *******************************/
 
 /***************** Macros (Inline Functions) Definitions *********************/
-
+#define HW_PRINT(...)  __asm__("nop")
+// #define HW_PRINT(...)  printf(__VA_ARGS__)
 /************************** Variable Definitions *****************************/
 
 /************************** Function Prototypes ******************************/

df_datalink_ge/src/main.c

@@ -36,7 +36,7 @@
 #include "timer.h"
 #include "config/app_config.h"
 #include "dev_profile/dev_profile.h"
-#include "systembus/systembus.h"
+#include "mpc/mpc.h"
 #include "networking/phy_layer/phy_layer.h"
 #include "networking/link_layer/link_layer.h"
 // RF-Driver
@@ -48,36 +48,42 @@ int32_t SetupInterruptSystem(struct irq_ctrl_desc *descPtr);
 void Phy_IntrHandler(void *context);
 void PeriodicPull_Handler(void *callBackRef);
 void ScuTimer_IntrHandler(void *context);
-void Systembus_RxIntrHandler(void *context);
+void Mpc_RxIntrHandler(void *context);
-void Systembus_TxIntrHandler(void *context);
+void Mpc_TxIntrHandler(void *context);
 /************************** Constant Definitions *****************************/
-struct callback_desc phy_callback_desc = {
+struct callback_desc phy_callback_desc =
+{
 	.callback = Phy_IntrHandler,
 	.ctx = NULL
 };
 
-struct callback_desc periodicpull_callback_desc = {
+struct callback_desc periodicpull_callback_desc =
+{
 	.callback = PeriodicPull_Handler,
 	.ctx = NULL
 };
 
 
-struct callback_desc sysbus_rx_callback_desc = {
+struct callback_desc mpc_rx_callback_desc =
-	.callback = Systembus_RxIntrHandler,
+{
+	.callback = Mpc_RxIntrHandler,
 	.ctx = NULL
 };
 
-struct callback_desc sysbus_tx_callback_desc = {
+struct callback_desc mpc_tx_callback_desc =
-	.callback = Systembus_TxIntrHandler,
+{
+	.callback = Mpc_TxIntrHandler,
 	.ctx = NULL
 };
 
-struct callback_desc scutm_callback_desc = {
+struct callback_desc scutm_callback_desc =
+{
 	.callback = ScuTimer_IntrHandler,
 	.ctx = NULL
 };
 
-L2_CONFIG linkConfig = {
+L2_CONFIG linkConfig =
+{
 	.myType = L2_NODE_HEAD,
 	.clustId = 1,
 	.myId = 1,
@@ -99,29 +105,78 @@ L2_CONFIG linkConfig = {
 // 	.tmcInstPtr = NULL
 // };
 
-static PHY_CONFIG phyConfig = {
+static PHY_CONFIG phyConfig =
+{
 	.devId = 0,
 	.baseAddr = PHY_BASEADDR,
 	.antBramId = PHY_ANTCONFIG_BRAM_DEVICE_ID,
+	.antInfoBramId = -1,
 	.txBramId = PHY_TXBUFF_BRAM_DEVICE_ID,
 	.rxBramId = PHY_RXBUFF_BRAM_DEVICE_ID,
-	.hwXadcId = PHY_HW_XADC_DEVICE_ID
+	.hwXadcId = PHY_HW_XADC_DEVICE_ID,
+	.get_clk_state = NULL,
+	.get_ad_lock_state = NULL,
+	.get_ad0_temp = NULL,
+	.get_ad1_temp = NULL
 };
 
-TMC_CONFIG tmcConfig = {
+TMC_CONFIG tmcConfig =
+{
 	.baseAddr = TIME_CONTROLLER_BASEADDR,
 	.reset = 10
 };
 
-//static SYSBUS_CONFIG sysbusConfig = {
+static MPC_CONFIG mpcConfig = {
-//	.baseAddr = SYSBUS_BASE_ADDR,
+	.bramId = MPC_BRAM_ID,
-//	.txQueueMax = 16,
+	.gpioId = MPC_GPIO_ID,
-//	.rxQueueMax = 16
+	.txQueueMax = 16,
-//};
+	.rxQueueMax = 16
+};
+
+#ifdef APP_EMULATE_DATA
+uint8_t testDataLj[] =
+{
+	0xEA, 0xDF, 0x3F, 0x27, 0xCE, 0x9B, 0xE6, 0x3F,
+	0xB5, 0xA3, 0x38, 0x47, 0x1D, 0x1D, 0xFA, 0x3F,
+	0x39, 0xB4, 0xC8, 0x76, 0xBE, 0xAB, 0x8E, 0x40,
+	0xC9, 0xE8, 0x80, 0x24, 0xEC, 0xCB, 0x13, 0x40,
+	0x37, 0x38, 0x7F, 0x22, 0x72, 0x06, 0xF0, 0x01,
+	0x00, 0x00, 0xB8, 0xAA, 0x08, 0x47, 0x1E, 0xC6,
+	0xB0, 0x47, 0x54, 0xFD, 0xEB, 0x45, 0xA1, 0x8A,
+	0x86, 0x44, 0x43, 0xB6, 0xC8, 0x44, 0x4E, 0x19,
+	0xA8, 0x42
+};
+
+uint8_t testDataFlj[] =
+{
+	0xFD, 0x1E, 0xA5, 0x22, 0x72, 0x02, 0x5A, 0x02,
+	0x00, 0x00, 0x81, 0x97, 0x39, 0x3F, 0xF1, 0xF4,
+	0xC0, 0x3F, 0x27, 0xF1, 0x65, 0x44, 0x53, 0x5C,
+	0xD3, 0x3F, 0xB5, 0x24, 0xA6, 0x22, 0x72, 0x02,
+	0x83, 0x01, 0x00, 0x00, 0xFC, 0xE0, 0x44, 0x47,
+	0xB7, 0x83, 0x35, 0x47, 0xA4, 0xBF, 0xE5, 0xC4,
+	0xE8, 0xDC, 0xD1, 0x44, 0x5D, 0x5D, 0xE7, 0x44,
+	0x7D, 0x1B, 0xE8, 0xC1, 0x60, 0x97, 0x57, 0x42,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+	0x5D, 0x86, 0xA6, 0x22, 0x72, 0x02, 0xA5, 0x02,
+	0x00, 0x00, 0x97, 0x4E, 0xB5, 0x47, 0xC4, 0x2A,
+	0xB0, 0x47, 0x2D, 0x00, 0x21, 0xC5, 0x8A, 0x85,
+	0xD1, 0x44, 0x23, 0xFD, 0xC8, 0x44, 0xA1, 0xC4,
+	0xEA, 0xC1, 0x91, 0x4E, 0x71, 0xC2, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x6D, 0xAD,
+	0xA6, 0x22, 0x72, 0x02, 0xA5, 0x02, 0x00, 0x00,
+	0xCD, 0x07, 0xD6, 0x47, 0x1D, 0xA4, 0xCE, 0x47,
+	0x6E, 0x61, 0x33, 0xC5, 0x85, 0x55, 0xD1, 0x44,
+	0x9C, 0x16, 0xBD, 0x44, 0x36, 0xC0, 0xEB, 0xC1,
+	0xF0, 0xFF, 0x5B, 0x42, 0x00, 0x00, 0x00, 0x00,
+	0x00, 0x00, 0x00, 0x00, 0x78, 0x25, 0x03, 0x00
+};
+#endif
+
 /************************** Function Prototypes ******************************/
 static struct irq_ctrl_desc *intcDescPtr; // General interrupt controller descriptor
 static struct timer_desc *logTmPtr;
-static SYSBUS *sysbusDescPtr;
+static MPC *mpcDescPtr;
 static PHY_INST *phyInstPtr;
 static TMC_INST *tmcInstPtr = NULL;
 L2_INST *linkInstPtr;
@@ -200,64 +255,64 @@ int32_t SetupInterruptSystem(struct irq_ctrl_desc *descPtr)
 		return Status;
 	}
 
-//	/* Initialize system bus interrupt. */
+	/* Initialize system bus interrupt. */
-//	Status = irq_trigger_level_set(descPtr, SYSBUS_TX_INTR_ID, IRQ_EDGE_RISING);
+	Status = irq_trigger_level_set(descPtr, MPC_TX_INTR_ID, IRQ_EDGE_RISING);
-//	if (Status != SUCCESS)
+	if (Status != SUCCESS)
-//	{
+	{
-//		DBG_ERROR("PHY_INTR trigger level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
+		DBG_ERROR("PHY_INTR trigger level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
-//		return Status;
+		return Status;
-//	}
+	}
-//	// Set interrupt priority
+	// Set interrupt priority
-//	Status = irq_set_priority(descPtr, SYSBUS_TX_INTR_ID, 0x10);
+	Status = irq_set_priority(descPtr, MPC_TX_INTR_ID, 0x10);
-//	if (Status != SUCCESS)
+	if (Status != SUCCESS)
-//	{
+	{
-//		DBG_ERROR("PHY_INTR priority level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
+		DBG_ERROR("PHY_INTR priority level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
-//		return Status;
+		return Status;
-//	}
+	}
-//
+
-//	// Connect the interrupt service routine isr1 to the interrupt controller
+	// Connect the interrupt service routine isr1 to the interrupt controller
-//	Status = irq_register_callback(descPtr, SYSBUS_TX_INTR_ID, &sysbus_tx_callback_desc);
+	Status = irq_register_callback(descPtr, MPC_TX_INTR_ID, &mpc_tx_callback_desc);
-//	if (Status != SUCCESS)
+	if (Status != SUCCESS)
-//	{
+	{
-//		DBG_ERROR("PHY_INTR register callback FAILED, ErrorCode: %" PRId32 ".\n", Status);
+		DBG_ERROR("PHY_INTR register callback FAILED, ErrorCode: %" PRId32 ".\n", Status);
-//		return Status;
+		return Status;
-//	}
+	}
-//	Status = irq_trigger_level_set(descPtr, SYSBUS_RX_INTR_ID, IRQ_EDGE_RISING);
+	Status = irq_trigger_level_set(descPtr, MPC_RX_INTR_ID, IRQ_EDGE_RISING);
-//	if (Status != SUCCESS)
+	if (Status != SUCCESS)
-//	{
+	{
-//		DBG_ERROR("PHY_INTR trigger level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
+		DBG_ERROR("PHY_INTR trigger level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
-//		return Status;
+		return Status;
-//	}
+	}
-//	// Set interrupt priority
+	// Set interrupt priority
-//	Status = irq_set_priority(descPtr, SYSBUS_RX_INTR_ID, 0x18);
+	Status = irq_set_priority(descPtr, MPC_RX_INTR_ID, 0x18);
-//	if (Status != SUCCESS)
+	if (Status != SUCCESS)
-//	{
+	{
-//		DBG_ERROR("PHY_INTR priority level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
+		DBG_ERROR("PHY_INTR priority level set FAILED, ErrorCode: %" PRId32 ".\n", Status);
-//		return Status;
+		return Status;
-//	}
+	}
-//
+
-//	// Connect the interrupt service routine isr1 to the interrupt controller
+	// Connect the interrupt service routine isr1 to the interrupt controller
-//	Status = irq_register_callback(descPtr, SYSBUS_RX_INTR_ID, &sysbus_rx_callback_desc);
+	Status = irq_register_callback(descPtr, MPC_RX_INTR_ID, &mpc_rx_callback_desc);
-//	if (Status != SUCCESS)
+	if (Status != SUCCESS)
-//	{
+	{
-//		DBG_ERROR("PHY_INTR register callback FAILED, ErrorCode: %" PRId32 ".\n", Status);
+		DBG_ERROR("PHY_INTR register callback FAILED, ErrorCode: %" PRId32 ".\n", Status);
-//		return Status;
+		return Status;
-//	}
+	}
-//
+
-//	/* Initialize Scu timer interrupt. */
+	/* Initialize Scu timer interrupt. */
-//	// Connect the interrupt service routine isr1 to the interrupt controller
+	// Connect the interrupt service routine isr1 to the interrupt controller
-//	Status = irq_register_callback(descPtr, SCUTIMER_INTR_ID, &scutm_callback_desc);
+	Status = irq_register_callback(descPtr, SCUTIMER_INTR_ID, &scutm_callback_desc);
-//	if (Status != SUCCESS)
+	if (Status != SUCCESS)
-//	{
+	{
-//		DBG_ERROR("PHY_INTR register callback FAILED, ErrorCode: %" PRId32 ".\n", Status);
+		DBG_ERROR("PHY_INTR register callback FAILED, ErrorCode: %" PRId32 ".\n", Status);
-//		return Status;
+		return Status;
-//	}
+	}
 
 	// Enable interrupts
 	irq_enable(descPtr, PHY_INTR_ID);
 	irq_enable(descPtr, PERIODIC_5MS_INTR_ID);
-//	irq_enable(descPtr, SYSBUS_RX_INTR_ID);
+	irq_enable(descPtr, MPC_RX_INTR_ID);
-//	irq_enable(descPtr, SYSBUS_TX_INTR_ID);
+	irq_enable(descPtr, MPC_TX_INTR_ID);
 	irq_enable(descPtr, SCUTIMER_INTR_ID);
 
 	// Enable Exceptions
@@ -315,13 +370,13 @@ void PeriodicPull_Handler(void *callBackRef)
  * @return  None.
  *
  ******************************************************************************/
-void Systembus_RxIntrHandler(void *context)
+void Mpc_RxIntrHandler(void *context)
 {
 	int32_t Status;
-	Status = SystemBus_RxIntrHandler(sysbusDescPtr);
+	Status = Mpc_RxIrqHandler(mpcDescPtr);
 	if (Status != SUCCESS)
 	{
-		DBG_ERROR("SystemBus_RxIntrHandler exit with error code %" PRId32 ",\n", Status);
+		DBG_ERROR("Mpc_RxIrqHandler exit with error code %" PRId32 ",\n", Status);
 	}
 }
 
@@ -334,13 +389,13 @@ void Systembus_RxIntrHandler(void *context)
  * @return  None.
  *
  ******************************************************************************/
-void Systembus_TxIntrHandler(void *context)
+void Mpc_TxIntrHandler(void *context)
 {
 	int32_t Status;
-	Status = SystemBus_TxIntrHandler(sysbusDescPtr);
+	Status = Mpc_TxIrqHandler(mpcDescPtr);
 	if (Status != SUCCESS)
 	{
-		DBG_ERROR("SystemBus_TxIntrHandler exit with error code %" PRId32 ",\n", Status);
+		DBG_ERROR("Mpc_TxIrqHandler exit with error code %" PRId32 ",\n", Status);
 	}
 }
 
@@ -359,8 +414,31 @@ void ScuTimer_IntrHandler(void *context)
 	xdesc = (struct xil_timer_desc *)(logTmPtr->extra);
 	if (XScuTimer_IsExpired((XScuTimer *)xdesc->instance))
 	{
-		// Update log
+		// Refresh log
-		Phy_UpdateHwSate(phyInstPtr);
+		Phy_RefreshHwSate(phyInstPtr);
+		if (TimeCtrl_GetIntCnt(tmcInstPtr) - phyInstPtr->lastLogTime >= PHY_LOG_EXPIRE)
+		{
+			Phy_UpdateLogging(phyInstPtr);
+		}
+
+		if (Mpc_IsEnable(mpcDescPtr))
+		{
+			if (Mpc_PendRemoteTest(mpcDescPtr) != SUCCESS)
+			{
+				DBG_ERROR("Failed to apply remote test.\n");
+			}
+#ifdef APP_EMULATE_DATA
+			if (L2_GetNodeType(linkInstPtr) == L2_NODE_HEAD)
+			{
+				SysMonitor_UpdateSendPayload(testDataFlj, PAYLOAD_LEN_FLJ_TX);
+			}
+			else
+			{
+				SysMonitor_UpdateSendPayload(testDataLj, PAYLOAD_LEN_LJ_TX);
+			}
+#endif
+		}
+
 		XScuTimer_ClearInterruptStatus((XScuTimer *)xdesc->instance);
 	}
 	else
@@ -420,7 +498,7 @@ int main(void)
 	}
 
 	/* Physical Layer Initialize */
-	Status = Phy_InstInit(&phyInstPtr, &phyConfig);
+	Status = Phy_Init(&phyInstPtr, &phyConfig);
 	if (Status == SUCCESS)
 	{
 		DBG_PRINT("Physical layer Init SUCCESS! \n");
@@ -445,13 +523,13 @@ int main(void)
 		return Status;
 	}
 
-	// /* System Bus Initialize */
+	/* System Bus Initialize */
-	// Status = SystemBus_Init(&sysbusDescPtr, &sysbusConfig);
+	Status = Mpc_Init(&mpcDescPtr, &mpcConfig);
-	// if (Status != SUCCESS)
+	if (Status != SUCCESS)
-	// {
+	{
-	// 	DBG_ERROR("Systembus init FAILED, with error code: %" PRId32 "\n", Status);
+	DBG_ERROR("MPC init FAILED, with error code: %" PRId32 "\n", Status);
-	// 	return Status;
+	return Status;
-	// }
+	}
 
 	/* System Monitor log timer Initialize */
 	Status = timer_init(&logTmPtr, &scutimer_init_param);
@@ -479,30 +557,24 @@ int main(void)
 	DBG_PRINT("Physical started...\n");
 	Phy_Start(phyInstPtr);
 
-	Linklayer_Start(linkInstPtr);
+	while (true)
-
+	{
-	while (true);
+	// System bus handler
-
+	if (Mpc_IsReqPending(mpcDescPtr))
-	// while (true)
+	{
-	// {
+		Status = Mpc_HandleCmd(mpcDescPtr);
-	// 	// System bus handler
+		if (Status != SUCCESS)
-	// 	if (SystemBus_IsReqPendding(sysbusDescPtr))
+		{
-	// 	{
+			DBG_ERROR("Mpc_HandleCmd exit with ErrorCode: %" PRId32 ".\n", Status);
-	// 		Status = SystemBus_HandleCmd(sysbusDescPtr);
+		}
-	// 		if (Status != SUCCESS)
+	}
-	// 		{
+	if (Mpc_IsRsqPending(mpcDescPtr) && (!Mpc_IsTxBusy(mpcDescPtr)))
-	// 			DBG_ERROR("SystemBus_HandleCmd exit with ErrorCode: %" PRId32 ".\n", Status);
+	{
-	// 		}
+		Status = Mpc_MakeResp(mpcDescPtr);
-	// 	}
+		if (Status != SUCCESS)
-	// 	if (SystemBus_IsRsqPendding(sysbusDescPtr) && (!SystemBus_IsTxBusy(sysbusDescPtr)))
+		{
-	// 	{
+			DBG_ERROR("Mpc_HandleCmd exit with ErrorCode: %" PRId32 ".\n", Status);
-	// 		// FIXME: Required by 12 (CASC)
+		}
-	// 		udelay(200);
+	}
-	// 		Status = SystemBus_MakeResp(sysbusDescPtr);
+	}
-	// 		if (Status != SUCCESS)
-	// 		{
-	// 			DBG_ERROR("SystemBus_HandleCmd exit with ErrorCode: %" PRId32 ".\n", Status);
-	// 		}
-	// 	}
-	// }
 } // main

df_datalink_ge/src/mpc/mpc.c

@@ -0,0 +1,550 @@
+/*****************************************************************************/
+/**
+ * Description: MPC protocol implementation file.
+ *
+ * Date: 2023-05-06 10:13
+ * Last Edit Time: [2023-05-06 21:45]
+ *
+ * Revisions: Rev 0.0
+ * History:
+ * [2023-05-06]: Initial version.
+ * [2023-09-13]: Update to 485 protocol-20220816
+ *
+ * Copyright(c) 2021 Beijing Institute of Technology.
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+
+/***************************** Include Files *********************************/
+
+#include <stdlib.h>
+#include <string.h>
+#include <stdint.h>
+#include <stdbool.h>
+#include "mpc.h"
+#include "util.h"
+#include "common.h"
+#include "error.h"
+#include "circ_queue.h"
+#include "xbram.h"
+#include "xgpio.h"
+
+#include "../system_monitor.h"
+
+/************************** Constant Definitions *****************************/
+// Common Field
+// -- Command word
+#define WD_CMD 0x00
+
+// -- Production type
+#define WD_PRD 0x01
+#define PRD_DL_K 0xDD
+#define PRD_DL_S 0xEE
+#define PRD_ALL 0xFF
+
+// Self-Test
+#define CMD_SELF_TEST 0xE1
+// -- Request
+// -- -- --
+// -- Response
+// -- -- Self-Test Result
+#define ST_RSP_LEN 16
+#define WD_ST_RET 0x02
+#define ST_RET_OK 0xAA
+#define ST_RET_ERROR 0x55
+#define ST_RET_INFO_LEN 13
+// -- -- Signal processor PS voltage
+#define WD_SP_FPGA_VOLT 0x03
+// -- -- Signal processor PS AUX voltage
+#define WD_SP_CLK_STATE 0x04
+// -- -- Signal processor DDR voltage
+#define WD_SP_AD_LOCK_STATE 0x05
+// -- -- Signal processor PL voltage
+#define WD_SP_AD_TEMP_0 0x06
+// -- -- Signal processor PL AUX voltage
+#define WD_SP_AD_TEMP_1 0x07
+// -- -- Signal processor Bram voltage
+#define WD_SP_FPGA_TEMP 0x08
+
+// Config load
+#define CMD_CONFIG 0xE3
+// -- Request
+#define WD_EN_CMD 0x02
+#define EN_CMD_ON_HIGH_POWER 0x66
+#define EN_CMD_ON_LOW_POWER 0x77
+#define EN_CMD_SILENT 0x88
+
+#define WD_MODE_CMD 0x03
+#define MODE_CMD_HEAD 0x11
+#define MODE_CMD_MEMBER 0x00
+// -- Response
+// -- -- none response
+
+// Remote Test
+#define RM_TEST_RESP_LEN 158
+// -- Request
+// Remote Test FLJ
+#define CMD_FLJ_RM_TEST 0xE6
+// Remote Test LJ
+#define CMD_LJ_RM_TEST 0xF6
+#define WD_RM_TEST 0x02
+#define RM_TEST_CODE 0x99
+// -- Response
+#define WD_TIME_STAMP 0x02
+#define WD_TIME_STAMP_LEN 8
+#define WD_SYSBUS_LOG 0x0A
+#define WD_SYSBUS_LOG_LEN 14
+#define WD_LINK_LOG 0x18
+#define WD_LINK_LOG_LEN 64
+#define WD_PHY_LOG 0x58
+#define WD_PHY_LOG_LEN 57
+#define WD_HARDWARE_ST 0x91
+#define WD_HARDWARE_ST_LEN 13
+
+// My Production Type
+#define MY_PRD_ID PRD_DL_K
+
+/************************** Function Prototypes ******************************/
+/**************************** Type Definitions *******************************/
+/************************** Variable Definitions *****************************/
+// TODO: better approach?
+#include "../networking/link_layer/link_layer.h"
+#include "../networking/phy_layer/phy_layer.h"
+extern L2_INST *linkInstPtr;
+extern L2_CONFIG linkConfig;
+
+inline bool Mpc_IsEnable(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	return (instPtr->isEnable);
+}
+
+inline bool Mpc_IsReqPending(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	return (!isCircQueueEmpty(instPtr->rxQueue));
+}
+
+inline bool Mpc_IsRsqPending(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	return (!isCircQueueEmpty(instPtr->txQueue));
+}
+
+inline bool Mpc_IsTxBusy(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	return (!instPtr->isTxDone);
+}
+
+inline bool Mpc_IsRxBusy(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	return (!instPtr->isRxDone);
+}
+
+/**
+ * @brief   Generate System Bus SelfTest response.
+ */
+static int32_t Mpc_GenSelfTestRsp(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	MPC_HW_FRAME *mpcRsp;
+	uint8_t *msg;
+	if (Mpc_IsEnable(instPtr) == false)
+	{
+		DBG_ERROR("System is not enabled!\n");
+		return EIGNORE;
+	}
+	mpcRsp = malloc(sizeof(MPC_HW_FRAME));
+	if (mpcRsp == NULL)
+	{
+		DBG_ERROR("Failed to allocate memory for LJ REMOTE TEST Response!\n");
+		return ENOMEM;
+	}
+	mpcRsp->len = ST_RSP_LEN;
+	msg = mpcRsp->data + FRAME_PAYLOAD_POFFSET;
+
+	HWSTATE *hwStatsPtr = &(instPtr->hwState);
+
+	msg[WD_CMD] = CMD_SELF_TEST;
+	msg[WD_PRD] = MY_PRD_ID;
+	SysMonitor_GetHardwareStatus(hwStatsPtr);
+	if (Mpc_IsEnable(instPtr))
+	{
+		msg[WD_ST_RET] = (hwStatsPtr->isSpOk && hwStatsPtr->isAntOk) ? ST_RET_OK : ST_RET_ERROR;
+	}
+	else
+	{
+		msg[WD_ST_RET] = (hwStatsPtr->isSpOk) ? ST_RET_OK : ST_RET_ERROR;
+	}
+	// apply status and omit 2 bytes of overhead.
+	memcpy(msg + WD_SP_FPGA_VOLT, &(hwStatsPtr->spFpgaVolt), ST_RET_INFO_LEN);
+
+	if (CircQueuePush(instPtr->txQueue, (void *)mpcRsp) == false)
+	{
+		free(mpcRsp);
+		DBG_ERROR("SystemBus::TX Queue overflowed!\n");
+		return EQUEUE;
+	}
+	return SUCCESS;
+}
+
+/**
+ * @brief   Apply system configuration
+ */
+static int32_t Mpc_SystemConfig(MPC *instPtr, uint8_t *msg)
+{
+	PHY_INST *phyRef = linkInstPtr->config.phyInstPtr;
+	TMC_INST *tmcRef = linkInstPtr->config.tmcInstPtr;
+	bool reconfig = false;
+
+	if (msg[WD_MODE_CMD] == MODE_CMD_HEAD)
+	{
+		// omit unnecessary reconfiguration
+		reconfig = (L2_NODE_HEAD != L2_GetNodeType(linkInstPtr));
+		linkConfig.myType = L2_NODE_HEAD;
+		linkConfig.myId = 2;
+	}
+
+	else if (msg[WD_MODE_CMD] == MODE_CMD_MEMBER)
+	{
+		// omit unnecessary reconfiguration
+		reconfig = (L2_NODE_MEMBER != L2_GetNodeType(linkInstPtr));
+		linkConfig.myType = L2_NODE_MEMBER;
+		linkConfig.myId = 2;
+	}
+	else
+	{
+		// Ignore current command
+		DBG_ERROR("Unexpected config command 0x%02X:0x%02X",
+				  WD_MODE_CMD, msg[WD_MODE_CMD]);
+		return EIGNORE;
+	}
+
+	if (msg[WD_EN_CMD] == EN_CMD_ON_HIGH_POWER)
+	{
+		// high power config
+		Phy_AntConfigMode(phyRef, PHY_ANT_MODE_POWER_FULL);
+		if (reconfig == true || !Mpc_IsEnable(instPtr))
+		{
+			Linklayer_Reconfig(linkInstPtr, &linkConfig);
+		}
+		Linklayer_Start(linkInstPtr);
+		instPtr->isEnable = true;
+	}
+	else if (msg[WD_EN_CMD] == EN_CMD_ON_LOW_POWER)
+	{
+		// low power config
+		Phy_AntConfigMode(phyRef, PHY_ANT_MODE_POWER_LOW);
+		if (reconfig == true || !Mpc_IsEnable(instPtr))
+		{
+			Linklayer_Reconfig(linkInstPtr, &linkConfig);
+		}
+		Linklayer_Start(linkInstPtr);
+		instPtr->isEnable = true;
+	}
+	else if (msg[WD_EN_CMD] == EN_CMD_SILENT)
+	{
+		// silence config
+		// TODO: better approach?
+		instPtr->isEnable = false;
+		Linklayer_Halt(linkInstPtr);
+		Phy_AntConfigMode(phyRef, PHY_ANT_MODE_STANDBY);
+		TIME_WORD pullTime = {0, 0};
+		pullTime.int_part = TimeCtrl_GetIntCnt(tmcRef) + 1;
+		if (Phy_SetTimeWord(phyRef, &pullTime, PHY_TIME_WORD_POLL) != SUCCESS)
+		{
+			DBG_ERROR("Physical set pull time failed.\n");
+		}
+		Phy_SetupNextSlot(phyRef, PHY_TOR_RX, L1_10KBPS_10MS_FRAME, NULL);
+	}
+	else
+	{
+		// Ignore current command
+		DBG_ERROR("Unexpected config command 0x%02X:0x%02X",
+				  WD_EN_CMD, msg[WD_EN_CMD]);
+		return EIGNORE;
+	}
+	instPtr->mpcLog.lastConfig[0] = msg[WD_MODE_CMD];
+	instPtr->mpcLog.lastConfig[1] = msg[WD_EN_CMD];
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Initialize MPC instance.
+ *
+ * @param   InstPtr A double pointer to MPC instance.
+ * @param   config  A pointer to MPC configurations.
+ *
+ * @return  None.
+ *
+ ******************************************************************************/
+int32_t Mpc_Init(MPC **instPtr, MPC_CONFIG *config)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(config != NULL);
+	MPC_HW_CONFIG mpcHwConfig;
+	int32_t Status;
+	(*instPtr) = malloc(sizeof(MPC));
+	if ((*instPtr) == NULL)
+	{
+		return FAILURE;
+	}
+	(*instPtr)->rxQueue = NULL;
+	(*instPtr)->txQueue = NULL;
+	(*instPtr)->mpchwDesc = NULL;
+	memcpy(&((*instPtr)->config), config, sizeof(MPC_CONFIG));
+	memset(&((*instPtr)->mpcLog), 0x00, sizeof(SYSBUSLOG));
+	memset(&((*instPtr)->linkLog), 0x00, sizeof(LINKLOG));
+	memset(&((*instPtr)->phyLog), 0x00, sizeof(PHYLOG));
+	memset(&((*instPtr)->hwState), 0x00, sizeof(HWSTATE));
+
+	XBram_Config *bramConfigPtr;
+	XBram mpcBram;
+
+	bramConfigPtr = XBram_LookupConfig(config->bramId);
+	if (bramConfigPtr == NULL)
+	{
+		Status = EDCONF;
+		goto mpc_init_error;
+	}
+	Status = XBram_CfgInitialize(&mpcBram, bramConfigPtr,
+								 bramConfigPtr->CtrlBaseAddress);
+	if (Status != SUCCESS)
+	{
+		goto mpc_init_error;
+	}
+	/*
+	 * Execute the BRAM driver selftest.
+	 */
+	Status = XBram_SelfTest(&mpcBram, 0);
+	if (Status != SUCCESS)
+	{
+		goto mpc_init_error;
+	}
+
+	mpcHwConfig.txBuffAddr = mpcBram.Config.MemBaseAddress;
+	mpcHwConfig.rxBuffAddr = mpcBram.Config.MemBaseAddress;
+	mpcHwConfig.gpioId = config->gpioId;
+
+	Status = MpcHw_Init(&((*instPtr)->mpchwDesc), &mpcHwConfig);
+	if (Status != SUCCESS)
+	{
+		Status = ENOMEM;
+		goto mpc_init_error;
+	}
+	if (CircQueueCreate(&((*instPtr)->txQueue), (*instPtr)->config.txQueueMax) == false)
+	{
+		Status = ENOMEM;
+		goto mpc_init_error;
+	}
+	if (CircQueueCreate(&((*instPtr)->rxQueue), (*instPtr)->config.rxQueueMax) == false)
+	{
+		Status = ENOMEM;
+		goto mpc_init_error;
+	}
+	(*instPtr)->isEnable = false; // nothing received.
+	(*instPtr)->isRxDone = false; // nothing received.
+	(*instPtr)->isTxDone = true;  // nothing to be sent.
+	return SUCCESS;
+
+mpc_init_error:
+	free((*instPtr)->mpchwDesc);
+	free((*instPtr)->txQueue);
+	free((*instPtr)->rxQueue);
+	free(*instPtr);
+	return Status;
+}
+
+/*****************************************************************************/
+/**
+ * @brief	Generate a remote test response message.
+ *
+ * @param   instPtr A pointer to MPC instance.
+ *
+ * @return  SUCCESS
+ * 			error code
+ *
+ ******************************************************************************/
+int32_t Mpc_PendRemoteTest(MPC *instPtr)
+{
+	MPC_HW_FRAME *mpcRsp;
+	uint8_t *msg;
+	if (!Mpc_IsEnable(instPtr))
+	{
+		DBG_ERROR("System is not enabled!\n");
+		return EIGNORE;
+	}
+	mpcRsp = malloc(sizeof(MPC_HW_FRAME));
+	if (mpcRsp == NULL)
+	{
+		DBG_ERROR("Failed to allocate memory for LJ REMOTE TEST Response!\n");
+		return ENOMEM;
+	}
+	msg = mpcRsp->data + FRAME_PAYLOAD_POFFSET;
+	mpcRsp->len = RM_TEST_RESP_LEN;
+	if (L2_GetNodeType(linkInstPtr) == L2_NODE_HEAD)
+	{
+		// head node config
+		msg[WD_CMD] = CMD_FLJ_RM_TEST;
+	}
+	else
+	{
+		msg[WD_CMD] = CMD_LJ_RM_TEST;
+	}
+	msg[WD_PRD] = MY_PRD_ID;
+
+	TIME_WORD tmWord;
+	uint64_t time;
+	TimeCtrl_GetCurrentTime(linkInstPtr->config.tmcInstPtr, &tmWord);
+	time = (uint64_t)tmWord.int_part * TIME_FRAC_MAX + tmWord.frac_part;
+	memcpy(msg + WD_TIME_STAMP, &time, WD_TIME_STAMP_LEN);
+	SysMonitor_GetLinklayerLog(&(instPtr->linkLog));
+	SysMonitor_GetPhysicalLayerLog(&(instPtr->phyLog));
+	SysMonitor_GetHardwareStatus(&(instPtr->hwState));
+	memcpy(msg + WD_SYSBUS_LOG, &(instPtr->mpcLog), WD_SYSBUS_LOG_LEN);
+	memcpy(msg + WD_LINK_LOG, &(instPtr->linkLog), WD_LINK_LOG_LEN);
+	memcpy(msg + WD_PHY_LOG, &(instPtr->phyLog), WD_PHY_LOG_LEN);
+	memcpy(msg + WD_HARDWARE_ST, &(instPtr->hwState.spFpgaVolt), WD_HARDWARE_ST_LEN);
+
+	if (CircQueuePush(instPtr->txQueue, (void *)mpcRsp) == false)
+	{
+		free(mpcRsp);
+		DBG_WARNING("SystemBus::TX Queue overflowed!\n");
+		return EQUEUE;
+	}
+	instPtr->mpcLog.remoteCnt++;
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   A handler function. This handler  evaluate the message from system
+ * 			bus receive queue, and make appropriate response.
+ *
+ * @param   instPtr A pointer to MPC instance.
+ *
+ * @return  None
+ *
+ ******************************************************************************/
+int32_t Mpc_HandleCmd(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	int32_t Status;
+	MPC_HW_FRAME *mpcReq;
+	uint8_t *reqMsg;
+	if (CircQueuePop(instPtr->rxQueue, (void **)(&mpcReq)) == false)
+	{
+		DBG_WARNING("SystemBus::Nothing to be handled.\n");
+		return EIGNORE;
+	}
+	reqMsg = mpcReq->data + FRAME_PAYLOAD_POFFSET;
+	if (reqMsg[WD_PRD] != MY_PRD_ID && reqMsg[WD_PRD] != PRD_ALL)
+	{
+		DBG_WARNING("SystemBus::Production code mismatch!\n");
+		return EIGNORE;
+	}
+
+	switch (reqMsg[WD_CMD])
+	{
+	case CMD_CONFIG:
+	{
+		Status = Mpc_SystemConfig(instPtr, reqMsg);
+		if (Status == SUCCESS)
+		{
+			Status = Mpc_GenSelfTestRsp(instPtr);
+		}
+		break;
+	}
+	default:
+	{
+		DBG_ERROR("SystemBus::Unknown command code!\n");
+		Status = FAILURE;
+		break;
+	}
+	}
+	free(mpcReq);
+	return Status;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   This function send a repose frame from MPC tx queue.
+ *
+ * @param   instPtr A pointer to MPC instance.
+ *
+ * @return  None
+ *
+ ******************************************************************************/
+int32_t Mpc_MakeResp(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	int32_t Status;
+	MPC_HW_FRAME *mpcRsp;
+	if (CircQueuePop(instPtr->txQueue, (void **)(&mpcRsp)) == false)
+	{
+		DBG_WARNING("SystemBus::Nothing to be sent.\n");
+		return EIGNORE;
+	}
+	instPtr->isTxDone = false; // A transmission procedure is started.
+	Status = MpcHw_Send(instPtr->mpchwDesc, mpcRsp);
+	free(mpcRsp);
+	return Status;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   This function handles the mpc tx irq events.
+ *
+ * @param   instPtr A pointer to MPC instance.
+ *
+ * @return  None
+ *
+ ******************************************************************************/
+int32_t Mpc_TxIrqHandler(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	// nothing special...
+	instPtr->isTxDone = true; // A transmission procedure finished.
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   This function handles the mpc rx irq events.
+ *
+ * @param   instPtr A pointer to MPC instance.
+ *
+ * @return  None
+ *
+ ******************************************************************************/
+int32_t Mpc_RxIrqHandler(MPC *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	int32_t Status;
+	MPC_HW_FRAME *mpcReq;
+	instPtr->isRxDone = true; // whether reception successes or not, receiving procedure ended.
+	mpcReq = malloc(sizeof(MPC_HW_FRAME));
+	if (mpcReq == NULL)
+	{
+		return ENOMEM;
+	}
+	Status = MpcHw_Recv(instPtr->mpchwDesc, mpcReq);
+	if (Status != SUCCESS)
+	{
+		goto recv_error;
+	}
+	if (CircQueuePush(instPtr->rxQueue, (void *)mpcReq) == false)
+	{
+		DBG_ERROR("SystemBus::RX Queue overflowed!\n");
+		Status = EQUEUE;
+		goto recv_error;
+	}
+	instPtr->isRxDone = false; // another reception is undergoing.
+	return SUCCESS;
+recv_error:
+	free(mpcReq);
+	return Status;
+}

df_datalink_ge/src/mpc/mpc.h

@@ -0,0 +1,71 @@
+/*****************************************************************************/
+/**
+ * Description: MPC protocol head file.
+ *
+ * Date: 2023-05-06 10:12
+ * Last Edit Time: [2023-05-06 10:13]
+ *
+ * Revisions: Rev 0.0
+ * History:
+ * [2023-05-06]: Initial version.
+ *
+ * Copyright(c) 2021 Beijing Institute of Technology.
+ *
+ ******************************************************************************/
+
+#ifndef __MPC_H_
+#define __MPC_H_
+
+/***************************** Include Files *********************************/
+#include <stdint.h>
+#include <stdbool.h>
+#include "mpc_hw.h" // MPC driver
+#include "circ_queue.h"
+#include "../system_monitor.h"
+
+/************************** Constant Definitions *****************************/
+/************************** Data Type Definitions ****************************/
+// Definition of MPC instance.
+typedef struct
+{
+	uint32_t bramId;
+	uint32_t gpioId;
+    uint32_t txQueueMax;
+    uint32_t rxQueueMax;
+} MPC_CONFIG;
+
+typedef struct
+{
+    MPC_CONFIG config;
+    SYSBUSLOG mpcLog; // mpc log
+	LINKLOG linkLog; // Link layer log
+	PHYLOG phyLog; // Physical layer log
+	HWSTATE hwState; // Hardware status
+    MPC_HW *mpchwDesc;
+    CIRC_QUEUE *txQueue;
+    CIRC_QUEUE *rxQueue;
+    bool isEnable;
+    bool isRxDone;
+    bool isTxDone;
+} MPC;
+
+/************************** Function Prototypes ******************************/
+
+int32_t Mpc_Init(MPC **instPtr, MPC_CONFIG *config);
+
+int32_t Mpc_HandleCmd(MPC *instPtr);
+int32_t Mpc_PendRemoteTest(MPC *instPtr);
+int32_t Mpc_MakeResp(MPC *instPtr);
+
+int32_t Mpc_TxIrqHandler(MPC *instPtr);
+int32_t Mpc_RxIrqHandler(MPC *instPtr);
+
+bool Mpc_IsEnable(MPC *instPtr);
+
+bool Mpc_IsReqPending(MPC *instPtr);
+bool Mpc_IsRsqPending(MPC *instPtr);
+
+bool Mpc_IsTxBusy(MPC *instPtr);
+bool Mpc_IsRxBusy(MPC *instPtr);
+
+#endif //__MPC_H_

df_datalink_ge/src/mpc/mpc_hw.c

@@ -0,0 +1,139 @@
+/*****************************************************************************/
+/**
+ * Description: MPC uart driver implementation file.
+ *
+ * Date: 2023-05-06 10:59
+ * LastEditTime: 2023-05-06 21:56
+ * Revisions: Rev 0.0
+ * History:
+ * [2023-05-06]: Initial version.
+ *
+ * Copyright(c) 2022 Beijing Institute of Technology.
+ *
+ ******************************************************************************/
+
+/***************************** Include Files *******************************/
+#include <stdlib.h>
+#include <string.h>
+#include <stdint.h>
+#include <stdbool.h>
+#include "mpc_hw.h"
+#include "common.h"
+
+// Control and status register
+#define MODULE_VERSION 0
+#define MPC_STATUS 4
+#define MPC_SEND_CMD 8
+#define MPC_RECV_CNT 12
+
+// Status code
+#define MPC_STATUS_TX_BUSY 0x00010000
+#define MPC_STATUS_RX_BUSY 0x01000000
+// Data buffer register
+#define MPC_TXBUFF_MAX 512
+#define MPC_RXBUFF_MAX 512
+
+// Frame Data offsets
+#define FRAME_HEAD_LOW 0x02
+#define FRAME_HEAD_HIGH 0x53
+#define FRAME_TAIL_LOW 0x32
+#define FRAME_TAIL_HIGH 0x20
+
+#define FRAME_HEAD_LEN 2
+#define FRAME_TAIL_LEN 2
+#define FRAME_DUMMY_LEN 1	 // Dummy
+#define FRAME_OVERHEAD_LEN 2 // CheckSum, Dummy and
+
+#define MPC_STATUS_CH 1
+#define MPC_CONFIG_CH 2
+
+#define MPC_CONFIG_SEND_TRIG 0x00000002
+/*************************** Function Definitions ****************************/
+
+/*****************************************************************************/
+/**
+ * @brief   Instance initial
+ *
+ * @param   instPtr     A pointer to frame uart instance structure.
+ * @param   config    Base address of frame uart, refer to "xparameters.h"
+ *
+ * @return  None.
+ *
+ ******************************************************************************/
+int MpcHw_Init(MPC_HW **instPtr, MPC_HW_CONFIG *config)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(config != NULL);
+	uint32_t Status;
+	(*instPtr) = malloc(sizeof(MPC_HW));
+	if ((*instPtr) == NULL)
+	{
+		return FAILURE;
+	}
+	(*instPtr)->config.txBuffAddr = config->txBuffAddr;
+	(*instPtr)->config.rxBuffAddr = config->rxBuffAddr;
+	Status = XGpio_Initialize(&((*instPtr)->gpioDesc), config->gpioId);
+	if (Status != SUCCESS) {
+		DBG_ERROR("MPC gpio Initialization Failed.\n");
+		free(*instPtr);
+		return FAILURE;
+	}
+	XGpio_SetDataDirection(&((*instPtr)->gpioDesc), MPC_CONFIG_CH, 0x00000000);
+	XGpio_SetDataDirection(&((*instPtr)->gpioDesc), MPC_STATUS_CH, 0xFFFFFFFF);
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Send a MPC frame.
+ *
+ * @param   instPtr	A pointer to MPC_HW instance structure.
+ * @param   buff	A pointer to send data buffer
+ * @param   dLen	A integer indicate the send data buffer length in byte.
+ *
+ * @return
+ *
+ ******************************************************************************/
+int MpcHw_Send(MPC_HW *instPtr, MPC_HW_FRAME *frame)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(frame != NULL);
+	uint8_t sendLen;
+	uint8_t *sendBuff = (uint8_t*) instPtr->config.txBuffAddr;
+	sendLen = frame->len + FRAME_OVERHEAD_LEN;
+	if (sendLen > MPC_TXBUFF_MAX || frame->len == 0)
+	{
+		return FAILURE;
+	}
+	frame->data[0] = FRAME_HEAD_LOW;
+	frame->data[1] = FRAME_HEAD_HIGH;
+	memcpy(sendBuff, frame->data, sendLen);
+
+	// Start Sending
+	uint32_t gpioVal  = XGpio_DiscreteRead(&(instPtr->gpioDesc), MPC_CONFIG_CH);
+	gpioVal ^= MPC_CONFIG_SEND_TRIG;
+	XGpio_DiscreteWrite(&(instPtr->gpioDesc), MPC_CONFIG_CH, gpioVal);
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Get last MPC frame.
+ *
+ * @param   instPtr     A pointer to MPC_HW instance structure.
+ * @param   buff    A pointer to receive data buffer.
+ *
+ * @return
+ *
+ ******************************************************************************/
+int MpcHw_Recv(MPC_HW *instPtr, MPC_HW_FRAME *frame)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(frame != NULL);
+	uint8_t *recvBuff = (uint8_t *)(instPtr->config.rxBuffAddr);
+	memcpy(frame->data, recvBuff, MPC_FRAME_MAX);
+	frame->len = MPC_FRAME_MAX;
+	frame->isValid = true;
+	return SUCCESS;
+}
+

df_datalink_ge/src/mpc/mpc_hw.h

@@ -0,0 +1,98 @@
+/*****************************************************************************/
+/**
+ * Description: MPC uart driver implementation file.
+ *
+ * Date: 2023-05-06 10:59
+ * LastEditTime: 2023-05-06 21:48
+ * Revisions: Rev 0.0
+ * History:
+ * [2023-05-06]: Initial version.
+ *
+ * Copyright(c) 2022 Beijing Institute of Technology.
+ *
+ ******************************************************************************/
+
+#ifndef __MPC_HW_H
+#define __MPC_HW_H
+
+/**************************** Include Files *****************************/
+#include <stdint.h>
+#include <stdbool.h>
+#include "util.h"
+#include "xgpio.h"
+
+#define MPC_FRAME_MAX 256
+#define FRAME_PAYLOAD_POFFSET 2 // CheckSum, Dummy and DataLen
+/**************************** Type Definitions *****************************/
+/**
+ *
+ * Write a value to a SYSTEMBUS_UART register. A 32 bit write is performed.
+ * If the component is implemented in a smaller width, only the least
+ * significant data is written.
+ *
+ * @param   baseAddr is the base address of the SYSTEMBUS_UARTdevice.
+ * @param   offset is the register offset from the base to write to.
+ * @param   data is the data written to the register.
+ *
+ * @return  None.
+ *
+ * @note
+ * C-style signature:
+ * 	void MPC_HW_mWriteReg(uint32_t BaseAddress, unsigned RegOffset, uint32_t Data)
+ *
+ */
+#define MPC_HW_mWriteReg(baseAddr, offset, data) \
+	IO_Out32((baseAddr) + (offset), (uint32_t)(data))
+
+/**
+ *
+ * Read a value from a SYSTEMBUS_UART register. A 32 bit read is performed.
+ * If the component is implemented in a smaller width, only the least
+ * significant data is read from the register. The most significant data
+ * will be read as 0.
+ *
+ * @param   baseAddr is the base address of the SYSTEMBUS_UART device.
+ * @param   offset is the register offset from the base to write to.
+ *
+ * @return  Data is the data from the register.
+ *
+ * @note
+ * C-style signature:
+ * 	uint32_t MPC_HW_mReadReg(uint32_t BaseAddress, unsigned RegOffset)
+ *
+ */
+#define MPC_HW_mReadReg(baseAddr, offset) \
+	IO_In32((baseAddr) + (offset))
+
+typedef struct
+{
+	uintptr_t txBuffAddr;
+	uintptr_t rxBuffAddr;
+	uint32_t gpioId;
+} MPC_HW_CONFIG;
+
+typedef struct
+{
+	MPC_HW_CONFIG config;
+	XGpio gpioDesc;
+} MPC_HW;
+
+typedef struct
+{
+	uint16_t len;
+	uint8_t checkSum;
+	uint8_t isValid;
+	uint8_t data[MPC_FRAME_MAX];
+} MPC_HW_FRAME;
+
+/************************** Function Prototypes ******************************/
+// Instance initial
+int MpcHw_Init(MPC_HW **instPtr, MPC_HW_CONFIG *config);
+
+// Send a MPC frame.
+int MpcHw_Send(MPC_HW *instPtr, MPC_HW_FRAME *frame);
+
+// Get last MPC frame.
+int MpcHw_Recv(MPC_HW *instPtr, MPC_HW_FRAME *frame);
+
+#endif // __MPC_HW_H

df_datalink_ge/src/systembus

@@ -1 +0,0 @@
-../../df_datalink_sp/src/systembus

df_datalink_sp/bsp/ps7_cortexa9_0/include/xparameters.h

@@ -24,7 +24,7 @@
 
 /* Definitions for interface TMC */
 #define XPAR_TMC_BASEADDR 0x43C30000
-#define XPAR_TMC_HIGHADDR 0x43C3FFFF
+#define XPAR_TMC_HIGHADDR 0x43C30FFF
 
 #include "xparameters_ps.h"
 
@@ -42,28 +42,46 @@
  
 /******************************************************************/
 /* Definitions for driver BRAM */
-#define XPAR_XBRAM_NUM_INSTANCES 3U
+#define XPAR_XBRAM_NUM_INSTANCES 4U
 
-/* Definitions for peripheral PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL */
+/* Definitions for peripheral PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL */
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_DEVICE_ID 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_DEVICE_ID 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_DATA_WIDTH 32U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_DATA_WIDTH 32U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_FAULT_INJECT 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_FAULT_INJECT 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_CE_FAILING_REGISTERS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_CE_FAILING_REGISTERS 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_UE_FAILING_REGISTERS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_UE_FAILING_REGISTERS 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC_STATUS_REGISTERS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC_STATUS_REGISTERS 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_CE_COUNTER_WIDTH 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_CE_COUNTER_WIDTH 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC_ONOFF_REGISTER 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC_ONOFF_REGISTER 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC_ONOFF_RESET_VALUE 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC_ONOFF_RESET_VALUE 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_WRITE_ACCESS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_WRITE_ACCESS 0U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_BASEADDR 0x40004000U
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_BASEADDR 0x42000000U
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_HIGHADDR 0x40005FFFU
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_HIGHADDR 0x42000FFFU
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_CTRL_BASEADDR 0xFFFFFFFFU  
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_CTRL_BASEADDR 0xFFFFFFFFU  
-#define XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_CTRL_HIGHADDR 0xFFFFFFFFU  
+#define XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_CTRL_HIGHADDR 0xFFFFFFFFU  
+
+
+/* Definitions for peripheral PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL */
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_DEVICE_ID 1U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_DATA_WIDTH 32U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_FAULT_INJECT 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_CE_FAILING_REGISTERS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_UE_FAILING_REGISTERS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC_STATUS_REGISTERS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_CE_COUNTER_WIDTH 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC_ONOFF_REGISTER 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC_ONOFF_RESET_VALUE 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_WRITE_ACCESS 0U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_BASEADDR 0x40004000U
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_HIGHADDR 0x40005FFFU
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_CTRL_BASEADDR 0xFFFFFFFFU  
+#define XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_CTRL_HIGHADDR 0xFFFFFFFFU  
 
 
 /* Definitions for peripheral PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL */
-#define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_DEVICE_ID 1U
+#define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_DEVICE_ID 2U
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_DATA_WIDTH 32U
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_ECC 0U
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_FAULT_INJECT 0U
@@ -75,13 +93,13 @@
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_ECC_ONOFF_RESET_VALUE 0U
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_WRITE_ACCESS 0U
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_S_AXI_BASEADDR 0x40000000U
-#define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_S_AXI_HIGHADDR 0x40001FFFU
+#define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_S_AXI_HIGHADDR 0x40000FFFU
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_S_AXI_CTRL_BASEADDR 0xFFFFFFFFU  
 #define XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_S_AXI_CTRL_HIGHADDR 0xFFFFFFFFU  
 
 
 /* Definitions for peripheral PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL */
-#define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_DEVICE_ID 2U
+#define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_DEVICE_ID 3U
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_DATA_WIDTH 32U
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_ECC 0U
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_FAULT_INJECT 0U
@@ -93,15 +111,15 @@
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_ECC_ONOFF_RESET_VALUE 0U
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_WRITE_ACCESS 0U
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_S_AXI_BASEADDR 0x40002000U
-#define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_S_AXI_HIGHADDR 0x40003FFFU
+#define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_S_AXI_HIGHADDR 0x40002FFFU
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_S_AXI_CTRL_BASEADDR 0xFFFFFFFFU  
 #define XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_S_AXI_CTRL_HIGHADDR 0xFFFFFFFFU  
 
 
 /******************************************************************/
 
-/* Canonical definitions for peripheral PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL */
+/* Canonical definitions for peripheral PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL */
-#define XPAR_BRAM_0_DEVICE_ID XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_DEVICE_ID
+#define XPAR_BRAM_0_DEVICE_ID XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_DEVICE_ID
 #define XPAR_BRAM_0_DATA_WIDTH 32U
 #define XPAR_BRAM_0_ECC 0U
 #define XPAR_BRAM_0_FAULT_INJECT 0U
@@ -112,13 +130,13 @@
 #define XPAR_BRAM_0_ECC_ONOFF_REGISTER 0U
 #define XPAR_BRAM_0_ECC_ONOFF_RESET_VALUE 0U
 #define XPAR_BRAM_0_WRITE_ACCESS 0U
-#define XPAR_BRAM_0_BASEADDR 0x40004000U
+#define XPAR_BRAM_0_BASEADDR 0x42000000U
-#define XPAR_BRAM_0_HIGHADDR 0x40005FFFU
+#define XPAR_BRAM_0_HIGHADDR 0x42000FFFU
 #define XPAR_BRAM_0_CTRL_BASEADDR 0xFFFFFFFFU  
 #define XPAR_BRAM_0_CTRL_HIGHADDR 0xFFFFFFFEU  
 
-/* Canonical definitions for peripheral PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL */
+/* Canonical definitions for peripheral PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL */
-#define XPAR_BRAM_1_DEVICE_ID XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_DEVICE_ID
+#define XPAR_BRAM_1_DEVICE_ID XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_DEVICE_ID
 #define XPAR_BRAM_1_DATA_WIDTH 32U
 #define XPAR_BRAM_1_ECC 0U
 #define XPAR_BRAM_1_FAULT_INJECT 0U
@@ -129,13 +147,13 @@
 #define XPAR_BRAM_1_ECC_ONOFF_REGISTER 0U
 #define XPAR_BRAM_1_ECC_ONOFF_RESET_VALUE 0U
 #define XPAR_BRAM_1_WRITE_ACCESS 0U
-#define XPAR_BRAM_1_BASEADDR 0x40000000U
+#define XPAR_BRAM_1_BASEADDR 0x40004000U
-#define XPAR_BRAM_1_HIGHADDR 0x40001FFFU
+#define XPAR_BRAM_1_HIGHADDR 0x40005FFFU
 #define XPAR_BRAM_1_CTRL_BASEADDR 0xFFFFFFFFU  
 #define XPAR_BRAM_1_CTRL_HIGHADDR 0xFFFFFFFEU  
 
-/* Canonical definitions for peripheral PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL */
+/* Canonical definitions for peripheral PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL */
-#define XPAR_BRAM_2_DEVICE_ID XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_DEVICE_ID
+#define XPAR_BRAM_2_DEVICE_ID XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_DEVICE_ID
 #define XPAR_BRAM_2_DATA_WIDTH 32U
 #define XPAR_BRAM_2_ECC 0U
 #define XPAR_BRAM_2_FAULT_INJECT 0U
@@ -146,11 +164,28 @@
 #define XPAR_BRAM_2_ECC_ONOFF_REGISTER 0U
 #define XPAR_BRAM_2_ECC_ONOFF_RESET_VALUE 0U
 #define XPAR_BRAM_2_WRITE_ACCESS 0U
-#define XPAR_BRAM_2_BASEADDR 0x40002000U
+#define XPAR_BRAM_2_BASEADDR 0x40000000U
-#define XPAR_BRAM_2_HIGHADDR 0x40003FFFU
+#define XPAR_BRAM_2_HIGHADDR 0x40000FFFU
 #define XPAR_BRAM_2_CTRL_BASEADDR 0xFFFFFFFFU  
 #define XPAR_BRAM_2_CTRL_HIGHADDR 0xFFFFFFFEU  
 
+/* Canonical definitions for peripheral PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL */
+#define XPAR_BRAM_3_DEVICE_ID XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_DEVICE_ID
+#define XPAR_BRAM_3_DATA_WIDTH 32U
+#define XPAR_BRAM_3_ECC 0U
+#define XPAR_BRAM_3_FAULT_INJECT 0U
+#define XPAR_BRAM_3_CE_FAILING_REGISTERS 0U
+#define XPAR_BRAM_3_UE_FAILING_REGISTERS 0U
+#define XPAR_BRAM_3_ECC_STATUS_REGISTERS 0U
+#define XPAR_BRAM_3_CE_COUNTER_WIDTH 0U
+#define XPAR_BRAM_3_ECC_ONOFF_REGISTER 0U
+#define XPAR_BRAM_3_ECC_ONOFF_RESET_VALUE 0U
+#define XPAR_BRAM_3_WRITE_ACCESS 0U
+#define XPAR_BRAM_3_BASEADDR 0x40002000U
+#define XPAR_BRAM_3_HIGHADDR 0x40002FFFU
+#define XPAR_BRAM_3_CTRL_BASEADDR 0xFFFFFFFFU  
+#define XPAR_BRAM_3_CTRL_HIGHADDR 0xFFFFFFFEU  
+
 
 /******************************************************************/
 
@@ -311,7 +346,7 @@
 
 /* Definitions for peripheral SYSTEMBUS */
 #define XPAR_SYSTEMBUS_BASEADDR 0x43C10000
-#define XPAR_SYSTEMBUS_HIGHADDR 0x43C11FFF
+#define XPAR_SYSTEMBUS_HIGHADDR 0x43C10FFF
 
 
 /******************************************************************/

df_datalink_sp/bsp/ps7_cortexa9_0/libsrc/bram_v4_3/src/xbram_g.c

@@ -43,23 +43,42 @@
 XBram_Config XBram_ConfigTable[] =
 {
 	{
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_DEVICE_ID,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_DEVICE_ID,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_DATA_WIDTH,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_DATA_WIDTH,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_FAULT_INJECT,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_FAULT_INJECT,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_CE_FAILING_REGISTERS,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_CE_FAILING_REGISTERS,
 		0,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_UE_FAILING_REGISTERS,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_UE_FAILING_REGISTERS,
 		0,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC_STATUS_REGISTERS,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC_STATUS_REGISTERS,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_CE_COUNTER_WIDTH,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_CE_COUNTER_WIDTH,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC_ONOFF_REGISTER,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC_ONOFF_REGISTER,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_ECC_ONOFF_RESET_VALUE,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_ECC_ONOFF_RESET_VALUE,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_WRITE_ACCESS,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_WRITE_ACCESS,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_BASEADDR,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_BASEADDR,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_HIGHADDR,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_HIGHADDR,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_CTRL_BASEADDR,
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_CTRL_BASEADDR,
-		XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_S_AXI_CTRL_HIGHADDR
+		XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_S_AXI_CTRL_HIGHADDR
+	},
+	{
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_DEVICE_ID,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_DATA_WIDTH,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_FAULT_INJECT,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_CE_FAILING_REGISTERS,
+		0,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_UE_FAILING_REGISTERS,
+		0,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC_STATUS_REGISTERS,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_CE_COUNTER_WIDTH,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC_ONOFF_REGISTER,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_ECC_ONOFF_RESET_VALUE,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_WRITE_ACCESS,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_BASEADDR,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_HIGHADDR,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_CTRL_BASEADDR,
+		XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_S_AXI_CTRL_HIGHADDR
 	},
 	{
 		XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_DEVICE_ID,

df_datalink_sp/bsp/system.mss

@@ -27,7 +27,13 @@ END
 BEGIN DRIVER
  PARAMETER DRIVER_NAME = bram
  PARAMETER DRIVER_VER = 4.3
- PARAMETER HW_INSTANCE = phy_data_interface_ant_info_bram_ctrl
+ PARAMETER HW_INSTANCE = phy_data_interface_ant_beam_bram_ctrl
+END
+
+BEGIN DRIVER
+ PARAMETER DRIVER_NAME = bram
+ PARAMETER DRIVER_VER = 4.3
+ PARAMETER HW_INSTANCE = phy_data_interface_ant_config_bram_ctrl
 END
 
 BEGIN DRIVER

df_datalink_sp/build/src/subdir.mk

@@ -8,15 +8,18 @@ LD_SRCS += \
 
 C_SRCS += \
 ../src/main.c \
-../src/system_monitor.c 
+../src/system_monitor.c \
+../src/hwconfig.c
 
 OBJS += \
 ./src/main.o \
-./src/system_monitor.o 
+./src/system_monitor.o \
+./src/hwconfig.o
 
 C_DEPS += \
 ./src/main.d \
-./src/system_monitor.d 
+./src/system_monitor.d \
+./src/hwconfig.d
 
 
 # Each subdirectory must supply rules for building sources it contributes

df_datalink_sp/src/config/app_config.h

@@ -10,7 +10,7 @@
  * History:
  * [2021-04-28]: Initial edition.
  *
- * Copyright(c) 2021 Beijing Institute of Technology.
+ * Copyright(c) 2024 Beijing Institute of Technology.
  * Lab of Communication and Networking
  *
  ******************************************************************************/
@@ -54,10 +54,10 @@
 // Physical Layer Configs
 #define PHY_DEVICE_ID 0
 #define PHY_BASEADDR	XPAR_PHYC_BASEADDR
-#define PHY_BEAM_SET_PRESET
 #define PHY_BEAM_FORMING_ENABLE
 // -- Antenna Bram Configs
-#define PHY_ANTCONFIG_BRAM_DEVICE_ID XPAR_PHY_DATA_INTERFACE_ANT_INFO_BRAM_CTRL_DEVICE_ID
+#define PHY_ANTCONFIG_BRAM_DEVICE_ID XPAR_PHY_DATA_INTERFACE_ANT_CONFIG_BRAM_CTRL_DEVICE_ID
+#define PHY_ANTINFO_BRAM_DEVICE_ID XPAR_PHY_DATA_INTERFACE_ANT_BEAM_BRAM_CTRL_DEVICE_ID
 // -- Buffers
 #define PHY_TXBUFF_BRAM_DEVICE_ID XPAR_PHY_DATA_INTERFACE_TX_FRAME_BRAM_CTRL_DEVICE_ID
 #define PHY_RXBUFF_BRAM_DEVICE_ID XPAR_PHY_DATA_INTERFACE_RX_FRAME_BRAM_CTRL_DEVICE_ID
@@ -190,9 +190,6 @@ typedef enum
 #if !defined(DATALINK_ENABLE_AUTOTIMESYNC)
 	#warning To enbale bit error rate test, auto time-sync should be enabled...
 #endif
-#if defined(DATALINK_ENABLE_AUTORECONNECT)
-	#error Do not support auto reconnnect in bit error rate test mode...
-#endif
 #endif
 
 #endif //__APP_CONFIG_H_

df_datalink_sp/src/drivers/axi_core/spi_engine/spi_engine.c

@@ -697,7 +697,6 @@ int32_t spi_engine_write_and_read(struct spi_desc *desc,
 				  uint8_t *data,
 				  uint16_t bytes_number)
 {
-	uint8_t 		i;
 	uint8_t 		word_len;
 	uint8_t 		words_number;
 	int32_t 		ret;

df_datalink_sp/src/hwconfig.c

@@ -0,0 +1,464 @@
+/*****************************************************************************/
+/**
+ * Description: hwconfig.h
+ *
+
+ * Date: 2024-02-20 13:19
+ * Last Edit Time: [2024-02-20 13:19]
+ *
+ * Revisions: Rev 0.0
+ * History:
+ * [2023-05-07]: Initial edition.
+ *
+ * Copyright(c) 2024 Beijing Institute of Technology.
+ *
+ ******************************************************************************/
+
+/***************************** Include Files *********************************/
+// Standard
+#include <stdint.h>
+#include <stdbool.h>
+// Xilinx
+#include "xgpiops.h"
+#include "drivers/rf-transceiver/ad9361_reg/ad9361_reg.h"
+#include "drivers/rf-transceiver/ad9361/ad9361_api.h"
+#include "drivers/axi_core/spi_engine/spi_engine.h"
+// App
+#include "common.h"
+#include "error.h"
+#include "delay.h"
+#include "system_monitor.h"
+#include "hwconfig.h"
+#include "config/app_config.h"
+#include "dev_profile/dev_profile.h"
+
+/************************** Function Prototypes ******************************/
+/*********************** Driver Instance Definitions **************************/
+static struct hmc7044_dev *hmc7044_inst;
+static struct ad9361_reg_dev *ad9361_1_reg_inst;
+static struct ad9361_reg_dev *ad9361_2_reg_inst;
+// static struct ad9361_rf_phy *ad9361_phy;
+// static struct ad9361_rf_phy *ad9361_2_phy;
+
+/*****************************************************************************/
+/**
+ * @brief   Hardware_Init
+ *
+ * @param   none.
+ *
+ * @return  None.
+ *
+ ******************************************************************************/
+int32_t Hardware_Init(void)
+{
+	int32_t Status;
+	XGpioPs Gpio;
+	XGpioPs_Config *ConfigPtr;
+	ConfigPtr = XGpioPs_LookupConfig(AD9361_GPIO_DEVICE_ID);
+	Status = XGpioPs_CfgInitialize(&Gpio, ConfigPtr, ConfigPtr->BaseAddr);
+	if (Status != SUCCESS)
+	{
+		return FAILURE;
+	}
+
+	/**********************************************************/
+	/****************** HMC7044 Configuration *****************/
+	/**********************************************************/
+	Status = hmc7044_init(&hmc7044_inst, &hmc7044_default_init_param);
+	if (Status != SUCCESS)
+	{
+		DBG_ERROR("hmc7044_init() error: %" PRId32 "\n", Status);
+		return FAILURE;
+	}
+
+	/**********************************************************/
+	/***************** AD9361-1 Configuration *****************/
+	/**********************************************************/
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_TXNRX, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_ENABLE, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_EN_AGC, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_RESET_B, AD9361_GPIO_OUTPUT);
+
+	ad9361_reg_init(&ad9361_1_reg_inst, &ad9361_1_reg_default_init_param);
+	XGpioPs_WritePin(&Gpio, AD9361_1_ENABLE, 0);
+	ad9361_reg_config(ad9361_1_reg_inst);
+	XGpioPs_WritePin(&Gpio, AD9361_1_ENABLE, 1);
+
+	//	Status = ad9361_init(&ad9361_phy, &ad9361_default_init_param);
+	//	if (Status != XST_SUCCESS){
+	//		return XST_FAILURE;
+	//	}else{
+	//		printf("Configurate AD9361 Completely!\n");
+	//	}
+	//	ad9361_set_tx_fir_config(ad9361_phy, tx_fir_config);
+	//	ad9361_set_rx_fir_config(ad9361_phy, rx_fir_config);
+
+	/**********************************************************/
+	/***************** AD9361-2 Configuration *****************/
+	/**********************************************************/
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_TXNRX, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_ENABLE, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_EN_AGC, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_RESET_B, AD9361_GPIO_OUTPUT);
+
+	ad9361_reg_init(&ad9361_2_reg_inst, &ad9361_2_reg_default_init_param);
+	XGpioPs_WritePin(&Gpio, AD9361_2_ENABLE, 0);
+	ad9361_reg_config(ad9361_2_reg_inst);
+	XGpioPs_WritePin(&Gpio, AD9361_2_ENABLE, 1);
+
+	//	uint8_t rd_back;
+	//	Status = ad9361_reg_read(ad9361_1_reg_inst, 0x0002, &rd_back);
+	//	Status = ad9361_reg_read(ad9361_2_reg_inst, 0x0002, &rd_back);
+
+	/**********************************************************/
+	/******* AD9361 Baseband Multichip Synchronization ********/
+	/**********************************************************/
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_SYNC, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_RX_FIFO_RST, AD9361_GPIO_OUTPUT);
+
+	// SYNC BBPLL and DIGITAL SAMPLING CLOCKS
+	ad9361_reg_write(ad9361_1_reg_inst, 0x0001, 0x0D); // MCS RF Enable; MCS BBPLL Enable; MCS BB Enable
+	ad9361_reg_write(ad9361_2_reg_inst, 0x0001, 0x0D);
+	ad9361_reg_write(ad9361_1_reg_inst, 0x0047, 0x80); // MCS refclk Scale Enable
+	ad9361_reg_write(ad9361_2_reg_inst, 0x0047, 0x80);
+	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 0);
+	mdelay(20);
+	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 1); // Input a rising-edge pulse to the SYNC_IN pin
+	mdelay(500);
+	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 0);
+	mdelay(2000);
+	ad9361_reg_write(ad9361_1_reg_inst, 0x0001, 0x0B); // MCS RF Enable; MCS Digital CLK Enable ; MCS BB Enable
+	ad9361_reg_write(ad9361_2_reg_inst, 0x0001, 0x0B);
+	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 1); // Input another rising-edge pulse to the SYNC_IN pin
+	mdelay(500);
+	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 0);
+	ad9361_reg_write(ad9361_1_reg_inst, 0x0001, 0x08); // clear MCS bits
+	ad9361_reg_write(ad9361_2_reg_inst, 0x0001, 0x08);
+
+	XGpioPs_WritePin(&Gpio, AD9361_RX_FIFO_RST, 0);
+	mdelay(20);
+	XGpioPs_WritePin(&Gpio, AD9361_RX_FIFO_RST, 1);
+	mdelay(20);
+	XGpioPs_WritePin(&Gpio, AD9361_RX_FIFO_RST, 0);
+
+	/**********************************************************/
+	/********* AD9361 Multichip Rx Phase Calibration **********/
+	/**********************************************************/
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_TX_SWITCH, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_CAL_START, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_CAL_DONE, AD9361_GPIO_INPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_CAL_START, AD9361_GPIO_OUTPUT);
+	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_CAL_DONE, AD9361_GPIO_INPUT);
+
+	// switch to lower frequency
+	Status = Hardware_SwitchFreq(ad9361_1_reg_inst, TX_FREQ_126);
+	XGpioPs_WritePin(&Gpio, AD9361_TX_SWITCH, 1);
+	mdelay(20);
+
+	// switch rx channel
+	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0004, 0x30);
+	Status = ad9361_reg_write(ad9361_2_reg_inst, 0x0004, 0x30);
+
+	// enable dual ad9361 tx channels
+	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0002, 0xE4); // Setup Tx Digital Filters/ Channels
+
+	// switch ad9361 tx channel
+	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0004, 0x70); // Select Rx input pin(A,B,C)/ Tx out pin (A,B)
+	mdelay(20);
+
+	// begin to calibrate the 1st ad9361
+	XGpioPs_WritePin(&Gpio, AD9361_1_CAL_START, 0);
+	XGpioPs_WritePin(&Gpio, AD9361_1_CAL_START, 1);
+	mdelay(1);
+	XGpioPs_WritePin(&Gpio, AD9361_1_CAL_START, 0);
+
+	// read calibration status
+	int32_t time_out_cnt = 0;
+	do
+	{
+		mdelay(1); // Wait 1ms
+		time_out_cnt++;
+	} while (((XGpioPs_ReadPin(&Gpio, AD9361_1_CAL_DONE) == 0) && time_out_cnt <= AD9361_TIMEOUT_TH));
+
+	if (time_out_cnt == AD9361_TIMEOUT_TH)
+	{
+		return FAILURE;
+	}
+
+	// begin to calibrate the 2nd ad9361
+	XGpioPs_WritePin(&Gpio, AD9361_2_CAL_START, 1);
+	mdelay(1);
+	XGpioPs_WritePin(&Gpio, AD9361_2_CAL_START, 0);
+
+	// read calibration status
+	time_out_cnt = 0;
+	do
+	{
+		mdelay(1); // Wait 1ms
+		time_out_cnt++;
+	} while (((XGpioPs_ReadPin(&Gpio, AD9361_2_CAL_DONE) == 0) && time_out_cnt <= AD9361_TIMEOUT_TH));
+
+	if (time_out_cnt == AD9361_TIMEOUT_TH)
+	{
+		return FAILURE;
+	}
+
+	// enable single ad9361 tx channels
+	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0002, 0xA4); // Setup Tx Digital Filters/ Channels
+
+	// switch ad9361 tx & rx channel
+	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0004, 0x03);
+	Status = ad9361_reg_write(ad9361_2_reg_inst, 0x0004, 0x03);
+
+	// switch to higher frequency
+	Status = Hardware_SwitchFreq(ad9361_1_reg_inst, TX_FREQ_4125);
+	XGpioPs_WritePin(&Gpio, AD9361_TX_SWITCH, 0);
+
+	DBG_PRINT("Done.\n");
+
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   Hardware_SwitchFreq
+ *
+ * @param   devSysMonitor_UpdateHardwareStatus(newHwState);
+ * @param   freq
+ *
+ * @return  None.
+ *
+ ******************************************************************************/
+int32_t Hardware_SwitchFreq(struct ad9361_reg_dev *dev, ad9361TxFreq freq)
+{
+	int32_t status = 0;
+	uint8_t value = 0;
+	int32_t time_out_cnt = 0;
+
+	switch (freq)
+	{
+	case TX_FREQ_125:
+	{
+		//************************************************************
+		// Setup Tx Frequency-Dependent Syntheisizer Registers
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x027A, 0x4A); // Set VCO Output level[3:0]
+		status = ad9361_reg_write(dev, 0x0279, 0xC1); // Set Init ALC Value[3:0] and VCO Varactor[3:0]
+		status = ad9361_reg_write(dev, 0x0282, 0x0E); // Set VCO Bias Tcf[1:0] and VCO Bias Ref[2:0]
+		status = ad9361_reg_write(dev, 0x0278, 0x78); // Set VCO Cal Offset[3:0]
+		status = ad9361_reg_write(dev, 0x0285, 0x00); // Set VCO Cal Ref Tcf[2:0]
+		status = ad9361_reg_write(dev, 0x0291, 0x0B); // Set VCO Varactor Reference[3:0]
+		status = ad9361_reg_write(dev, 0x0290, 0x70); // Set VCO Varactor Ref Tcf[2:0] and VCO Varactor Offset[3:0]
+		status = ad9361_reg_write(dev, 0x027B, 0x94); // Set Synth Loop Filter charge pump current (Icp)
+		status = ad9361_reg_write(dev, 0x027E, 0xF4); // Set Synth Loop Filter C2 and C1
+		status = ad9361_reg_write(dev, 0x027F, 0xDF); // Set Synth Loop Filter  R1 and C3
+		status = ad9361_reg_write(dev, 0x0280, 0x0A); // Set Synth Loop Filter R3
+
+		//************************************************************
+		// Write Tx Frequency Words
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x0273, 0x00); // Write Tx Synth Fractional Freq Word[7:0]
+		status = ad9361_reg_write(dev, 0x0274, 0x00); // Write Tx Synth Fractional Freq Word[15:8]
+		status = ad9361_reg_write(dev, 0x0275, 0x00); // Write Tx Synth Fractional Freq Word[22:16]
+		status = ad9361_reg_write(dev, 0x0272, 0x00); // Write Tx Synth Integer Freq Word[10:8]
+		status = ad9361_reg_write(dev, 0x0271, 0xA0); // Write Tx Synth Integer Freq Word[7:0] (starts VCO cal)
+		status = ad9361_reg_write(dev, 0x0005, 0x57); // Set LO divider setting
+
+		//************************************************************
+		// Tx Quadrature Calibration Settings
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x00A0, 0x75); // Set TxQuadcal NCO frequency
+		status = ad9361_reg_write(dev, 0x00A3, 0xC0); // Set TxQuadcal NCO frequency (Only update bits [7:6])
+		status = ad9361_reg_write(dev, 0x00A1, 0x7B); // Tx Quad Cal Configuration, Phase and Gain Cal Enable
+		status = ad9361_reg_write(dev, 0x00A9, 0xFF); // Set Tx Quad Cal Count
+		status = ad9361_reg_write(dev, 0x00A2, 0x7F); // Set Tx Quad Cal Kexp
+		status = ad9361_reg_write(dev, 0x00A5, 0x01); // Set Tx Quad Cal Magnitude Threshhold
+		status = ad9361_reg_write(dev, 0x00A6, 0x01); // Set Tx Quad Cal Magnitude Threshhold
+		status = ad9361_reg_write(dev, 0x00AA, 0x22); // Set Tx Quad Cal Gain Table index
+		status = ad9361_reg_write(dev, 0x00A4, 0xF0); // Set Tx Quad Cal Settle Count
+		status = ad9361_reg_write(dev, 0x00AE, 0x00); // Set Tx Quad Cal LPF Gain index incase Split table mode used
+
+		status = ad9361_reg_write(dev, 0x0169, 0xC0); // Disable Rx Quadrature Calibration before Running Tx Quadrature Calibration
+		status = ad9361_reg_write(dev, 0x0016, 0x10); // Start Tx Quad cal
+
+		break;
+	}
+	case TX_FREQ_126:
+	{
+		//************************************************************
+		// Setup Tx Frequency-Dependent Syntheisizer Registers
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x027A, 0x4A); // Set VCO Output level[3:0]
+		status = ad9361_reg_write(dev, 0x0279, 0xC1); // Set Init ALC Value[3:0] and VCO Varactor[3:0]
+		status = ad9361_reg_write(dev, 0x0282, 0x0E); // Set VCO Bias Tcf[1:0] and VCO Bias Ref[2:0]
+		status = ad9361_reg_write(dev, 0x0278, 0x78); // Set VCO Cal Offset[3:0]
+		status = ad9361_reg_write(dev, 0x0285, 0x00); // Set VCO Cal Ref Tcf[2:0]
+		status = ad9361_reg_write(dev, 0x0291, 0x0B); // Set VCO Varactor Reference[3:0]
+		status = ad9361_reg_write(dev, 0x0290, 0x70); // Set VCO Varactor Ref Tcf[2:0] and VCO Varactor Offset[3:0]
+		status = ad9361_reg_write(dev, 0x027B, 0x93); // Set Synth Loop Filter charge pump current (Icp)
+		status = ad9361_reg_write(dev, 0x027E, 0xF4); // Set Synth Loop Filter C2 and C1
+		status = ad9361_reg_write(dev, 0x027F, 0xDF); // Set Synth Loop Filter  R1 and C3
+		status = ad9361_reg_write(dev, 0x0280, 0x0A); // Set Synth Loop Filter R3
+
+		//************************************************************
+		// Write Tx Frequency Words
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x0273, 0x06); // Write Tx Synth Fractional Freq Word[7:0]
+		status = ad9361_reg_write(dev, 0x0274, 0xD7); // Write Tx Synth Fractional Freq Word[15:8]
+		status = ad9361_reg_write(dev, 0x0275, 0x23); // Write Tx Synth Fractional Freq Word[22:16]
+		status = ad9361_reg_write(dev, 0x0272, 0x00); // Write Tx Synth Integer Freq Word[10:8]
+		status = ad9361_reg_write(dev, 0x0271, 0xA1); // Write Tx Synth Integer Freq Word[7:0] (starts VCO cal)
+		status = ad9361_reg_write(dev, 0x0005, 0x57); // Set LO divider setting
+
+		//************************************************************
+		// Tx Quadrature Calibration Settings
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x00A0, 0x75); // Set TxQuadcal NCO frequency
+		status = ad9361_reg_write(dev, 0x00A3, 0xC0); // Set TxQuadcal NCO frequency (Only update bits [7:6])
+		status = ad9361_reg_write(dev, 0x00A1, 0x7B); // Tx Quad Cal Configuration, Phase and Gain Cal Enable
+		status = ad9361_reg_write(dev, 0x00A9, 0xFF); // Set Tx Quad Cal Count
+		status = ad9361_reg_write(dev, 0x00A2, 0x7F); // Set Tx Quad Cal Kexp
+		status = ad9361_reg_write(dev, 0x00A5, 0x01); // Set Tx Quad Cal Magnitude Threshhold
+		status = ad9361_reg_write(dev, 0x00A6, 0x01); // Set Tx Quad Cal Magnitude Threshhold
+		status = ad9361_reg_write(dev, 0x00AA, 0x22); // Set Tx Quad Cal Gain Table index
+		status = ad9361_reg_write(dev, 0x00A4, 0xF0); // Set Tx Quad Cal Settle Count
+		status = ad9361_reg_write(dev, 0x00AE, 0x00); // Set Tx Quad Cal LPF Gain index incase Split table mode used
+
+		status = ad9361_reg_write(dev, 0x0169, 0xC0); // Disable Rx Quadrature Calibration before Running Tx Quadrature Calibration
+		status = ad9361_reg_write(dev, 0x0016, 0x10); // Start Tx Quad cal
+
+		break;
+	}
+	case TX_FREQ_4125:
+	{
+		//************************************************************
+		// Setup Tx Frequency-Dependent Syntheisizer Registers
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x027A, 0x4A); // Set VCO Output level[3:0]
+		status = ad9361_reg_write(dev, 0x0279, 0xC1); // Set Init ALC Value[3:0] and VCO Varactor[3:0]
+		status = ad9361_reg_write(dev, 0x0282, 0x0E); // Set VCO Bias Tcf[1:0] and VCO Bias Ref[2:0]
+		status = ad9361_reg_write(dev, 0x0278, 0x78); // Set VCO Cal Offset[3:0]
+		status = ad9361_reg_write(dev, 0x0285, 0x00); // Set VCO Cal Ref Tcf[2:0]
+		status = ad9361_reg_write(dev, 0x0291, 0x0B); // Set VCO Varactor Reference[3:0]
+		status = ad9361_reg_write(dev, 0x0290, 0x70); // Set VCO Varactor Ref Tcf[2:0] and VCO Varactor Offset[3:0]
+		status = ad9361_reg_write(dev, 0x027B, 0x93); // Set Synth Loop Filter charge pump current (Icp)
+		status = ad9361_reg_write(dev, 0x027E, 0xF4); // Set Synth Loop Filter C2 and C1
+		status = ad9361_reg_write(dev, 0x027F, 0xDF); // Set Synth Loop Filter  R1 and C3
+		status = ad9361_reg_write(dev, 0x0280, 0x0A); // Set Synth Loop Filter R3
+
+		//************************************************************
+		// Write Rx Frequency Words
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x0273, 0x00); // Write Tx Synth Fractional Freq Word[7:0]
+		status = ad9361_reg_write(dev, 0x0274, 0x00); // Write Tx Synth Fractional Freq Word[15:8]
+		status = ad9361_reg_write(dev, 0x0275, 0x00); // Write Tx Synth Fractional Freq Word[22:16]
+		status = ad9361_reg_write(dev, 0x0272, 0x00); // Write Tx Synth Integer Freq Word[10:8]
+		status = ad9361_reg_write(dev, 0x0271, 0xA5); // Write Tx Synth Integer Freq Word[7:0] (starts VCO cal)
+		status = ad9361_reg_write(dev, 0x0005, 0x07); // Set LO divider setting
+
+		//************************************************************
+		// Tx Quadrature Calibration Settings
+		//************************************************************
+		status = ad9361_reg_write(dev, 0x00A0, 0x75); // Set TxQuadcal NCO frequency
+		status = ad9361_reg_write(dev, 0x00A3, 0xC0); // Set TxQuadcal NCO frequency (Only update bits [7:6])
+		status = ad9361_reg_write(dev, 0x00A1, 0x7B); // Tx Quad Cal Configuration, Phase and Gain Cal Enable
+		status = ad9361_reg_write(dev, 0x00A9, 0xFF); // Set Tx Quad Cal Count
+		status = ad9361_reg_write(dev, 0x00A2, 0x7F); // Set Tx Quad Cal Kexp
+		status = ad9361_reg_write(dev, 0x00A5, 0x01); // Set Tx Quad Cal Magnitude Threshhold
+		status = ad9361_reg_write(dev, 0x00A6, 0x01); // Set Tx Quad Cal Magnitude Threshhold
+		status = ad9361_reg_write(dev, 0x00AA, 0x28); // Set Tx Quad Cal Gain Table index
+		status = ad9361_reg_write(dev, 0x00A4, 0xF0); // Set Tx Quad Cal Settle Count
+		status = ad9361_reg_write(dev, 0x00AE, 0x04); // Set Tx Quad Cal LPF Gain index incase Split table mode used
+
+		status = ad9361_reg_write(dev, 0x0169, 0xC0); // Disable Rx Quadrature Calibration before Running Tx Quadrature Calibration
+		status = ad9361_reg_write(dev, 0x0016, 0x10); // Start Tx Quad cal
+
+		break;
+	}
+
+		// Wait for cal to complete (Done when 0x016[4]==0)
+		time_out_cnt = 0;
+		do
+		{
+			status |= ad9361_reg_read(dev, 0x0016, &value);
+			mdelay(1); // Wait 1ms
+			time_out_cnt++;
+		} while ((value & 0x10) != 0x00 && time_out_cnt <= AD9361_TIMEOUT_TH);
+	}
+
+	return status;
+}
+
+// @ Get AD9361 - 1 temperature (Celsius Degree)
+/**
+ * Read corresponding register to get AD9361 - 1 current temperature.
+ */
+int8_t Hardware_GetAD9361Temp_1(void)
+{
+	int8_t scaleTemp;
+
+	ad9361_reg_write(ad9361_1_reg_inst, 0x001D, 0x01); // disable aux adc
+	ad9361_reg_read(ad9361_1_reg_inst, 0x000E, (uint8_t*)&scaleTemp);
+	ad9361_reg_write(ad9361_1_reg_inst, 0x001D, 0x00); // enable aux adc
+
+	return (int8_t) scaleTemp/1.16;
+}
+
+// @ Get AD9361 - 2 temperature (Celsius Degree)
+/**
+ * Read corresponding register to get AD9361 - 2 current temperature.
+ */
+int8_t Hardware_GetAD9361Temp_2(void)
+{
+	int8_t scaleTemp;
+
+	ad9361_reg_write(ad9361_2_reg_inst, 0x001D, 0x01); // disable aux adc
+	ad9361_reg_read(ad9361_2_reg_inst, 0x000E, (uint8_t*)&scaleTemp);
+	ad9361_reg_write(ad9361_2_reg_inst, 0x001D, 0x00); // enable aux adc
+
+	return (int8_t) scaleTemp/1.16;
+}
+
+// @ Determine AD9361 lock state
+/**
+ * Read corresponding register to determine AD9361(both) lock state.
+ */
+uint8_t Hardware_GetAD9361LockStatus(void)
+{
+	uint8_t ret = 0;
+	uint8_t regVal;
+
+	// bbpll
+	ad9361_reg_read(ad9361_1_reg_inst, 0x005E, &regVal); // [D7] is lock indicator
+	ret |= ((regVal & 0x80) == 0x80) ? CLK_AD0_BBPLL_LOCK : 0;
+	ad9361_reg_read(ad9361_2_reg_inst, 0x005E, &regVal); // [D7] is lock indicator
+	ret |= ((regVal & 0x80) == 0x80) ? CLK_AD1_BBPLL_LOCK : 0;
+
+	// rfpll
+	ad9361_reg_read(ad9361_1_reg_inst, 0x0287, &regVal); // [D1] is lock indicator
+	ret |= ((regVal & 0x02) == 0x02) ? CLK_AD0_RFPLL_LOCK : 0;
+	ad9361_reg_read(ad9361_2_reg_inst, 0x0287, &regVal); // [D1] is lock indicator
+	ret |= ((regVal & 0x02) == 0x02) ? CLK_AD1_RFPLL_LOCK : 0;
+
+	return ret;
+}
+
+// @ Determine HMC7044 lock state
+/**
+ * Read corresponding register to determine clock lock state.
+ */
+uint8_t Hardware_GetHMC7044LockStatus(void)
+{
+	uint8_t ret = 0;
+	uint8_t regVal;
+
+	// pll1
+	hmc7044_read(hmc7044_inst, 0x007C, &regVal); // [D5] is lock indicator
+	ret |= ((regVal & 0xE0) != 0x00) ? CLK_SP_PLL0_LOCK : 0;
+
+	// pll2
+	hmc7044_read(hmc7044_inst, 0x007D, &regVal); // [D0] is lock indicator
+	ret |= ((regVal & 0x01) == 0x01) ? CLK_SP_PLL1_LOCK : 0;
+
+	return ret;
+}

df_datalink_sp/src/hwconfig.h

@@ -0,0 +1,32 @@
+/*****************************************************************************/
+/**
+ * Description: hwconfig.h
+ *
+
+ * Date: 2024-02-20 13:19
+ * Last Edit Time: [2024-02-20 13:19]
+ *
+ * Revisions: Rev 0.0
+ * History:
+ * [2023-05-07]: Initial edition.
+ *
+ * Copyright(c) 2024 Beijing Institute of Technology.
+ *
+ ******************************************************************************/
+
+/***************************** Include Files *********************************/
+// Standard
+#include <stdint.h>
+#include "config/app_config.h"
+#include "drivers/rf-transceiver/ad9361_reg/ad9361_reg.h"
+#include "drivers/rf-transceiver/ad9361/ad9361_api.h"
+
+/************************** Function Prototypes ******************************/
+int32_t Hardware_Init(void);
+int32_t Hardware_SwitchFreq(struct ad9361_reg_dev *dev, ad9361TxFreq freq);
+int8_t Hardware_GetAD9361Temp_1(void);
+int8_t Hardware_GetAD9361Temp_2(void);
+uint8_t Hardware_GetAD9361LockStatus(void);
+uint8_t Hardware_GetHMC7044LockStatus(void);
+
+

df_datalink_sp/src/include/circ_queue.h

@@ -1,33 +1,25 @@
 /*****************************************************************************/
 /**
- * Description: A simple circular FIFO bounded queue
+ * @file circ_queue.h
+ * @author FanHao ([email protected])
+ * @brief A simple circular FIFO bounded queue
+ * @version 0.1
+ * @date 2023-02-23
+ * @note Forked from https://github.com/chrismerck/rpa_queue.git
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
  *
- * Author: Fan Hao
+ ******************************************************************************/
- * Date: 2023-02-23 10:29
+
- * LastEditors: Fan Hao
+/**
- * LastEditTime: 2023-02-23 12:53
+ * @addtogroup Utility
- * Revisions: Rev 0.0
+ * @{
- * History: 
+ */
- * [2023-02-23]: Initial Version.
+
- * 
+/**
- * Copyright(c) 2023 Beijing Institute of Technology.
+ * @defgroup CircularQueue
- * Lab of Communication and Networking
+ * @{
- * NOTE: Forked from https://github.com/chrismerck/rpa_queue.git
+ */
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements.  See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
-******************************************************************************/
 
 #ifndef CIRC_QUEUE_H
 #define CIRC_QUEUE_H
@@ -36,76 +28,77 @@
 #include <stdint.h>
 #include <stddef.h>
 
-
 /**
- * opaque structure
+ * @struct CIRC_QUEUE
+ * @brief Circular queue Instance
  */
-typedef struct {
+typedef struct
+{
     void **data;
-  volatile uint32_t nelts; /**< # elements */
+    volatile uint32_t nelts; ///< number of elements
-  uint32_t in;  /**< next empty location */
+    uint32_t in;             ///< next empty location
-  uint32_t out;   /**< next filled location */
+    uint32_t out;            ///< next filled location
-  uint32_t bounds;/**< max size of queue */
+    uint32_t bounds;         ///< max size of queue
 } CIRC_QUEUE;
 
-
-
 /**
- * create a FIFO queue
+ * @brief create a FIFO queue
  * @param queue The new queue
  * @param queue_capacity maximum size of the queue
  * @param a pool to allocate queue from
  */
 bool CircQueueCreate(CIRC_QUEUE **queue, uint32_t queue_capacity);
 
-/** free queue memory -- call after destroy 
+/**
+ * @brief free queue memory -- call after destroy
  * @note we do not free in destroy() to follow pthreads convention
-*/
+ */
-void CircQueueFree(CIRC_QUEUE * queue);
+void CircQueueFree(CIRC_QUEUE *queue);
 
 /**
- * Detects when the CIRC_QUEUE is full. This utility function is expected
+ * @brief Detects when the CIRC_QUEUE is full. This utility function is expected
  * to be called from within critical sections, and is not threadsafe.
  */
 bool isCircQueueFull(CIRC_QUEUE *queue);
 
 /**
- * Detects when the CIRC_QUEUE is empty. This utility function is expected
+ * @brief Detects when the CIRC_QUEUE is empty. This utility function is expected
  * to be called from within critical sections, and is not threadsafe.
  */
 bool isCircQueueEmpty(CIRC_QUEUE *queue);
 
 /**
- * push/add an object to the queue, blocking if the queue is already full
+ * @brief push/add an object to the queue, blocking if the queue is already full
  *
  * @param queue the queue
  * @param data the data
- * @returns RPA_EINTR the blocking was interrupted (try again)
+ * @return RPA_EINTR the blocking was interrupted (try again)
- * @returns RPA_EOF the queue has been terminated
+ * @return RPA_EOF the queue has been terminated
- * @returns RPA_SUCCESS on a successful push
+ * @return RPA_SUCCESS on a successful push
  */
 bool CircQueuePush(CIRC_QUEUE *queue, void *data);
 
-
 /**
- * pop/get an object from the queue, blocking if the queue is already empty
+ * @brief pop/get an object from the queue, blocking if the queue is already empty
  *
  * @param queue the queue
  * @param data the data
- * @returns RPA_EINTR the blocking was interrupted (try again)
+ * @return RPA_EINTR the blocking was interrupted (try again)
- * @returns RPA_EOF if the queue has been terminated
+ * @return RPA_EOF if the queue has been terminated
- * @returns RPA_SUCCESS on a successful pop
+ * @return RPA_SUCCESS on a successful pop
  */
 bool CircQueuePop(CIRC_QUEUE *queue, void **data);
 
 /**
- * returns the size of the queue.
+ * @brief returns the size of the queue.
  *
- * @warning this is not threadsafe, and is intended for reporting/monitoring
- * of the queue.
  * @param queue the queue
- * @returns the size of the queue
+ * @return the size of the queue
  */
 uint32_t CircQueueSize(CIRC_QUEUE *queue);
 
 #endif /* CIRC_QUEUE_H */
+
+/** @} CircularQueue*/
+
+/** @} Utility*/

df_datalink_sp/src/include/clist.h

@@ -1,9 +1,25 @@
+/*****************************************************************************/
+/**
+ * @file clist.h
+ * @author FanHao ([email protected])
+ * @brief A basic list data structure
+ * @version 0.1
+ * @date 2023-02-23
+ * @note Forked from https://github.com/clibs/list
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
 
-//
+/**
-// clist.h
+ * @addtogroup Utility
-//
+ * @{
-// Copyright (c) 2010 TJ Holowaychuk <[email protected]>
+ */
-//
+
+/**
+ * @defgroup cList
+ * @{
+ */
 
 #ifndef __CLIST_H__
 #define __CLIST_H__
@@ -16,48 +32,48 @@ extern "C"
 #include <stdlib.h>
 #include <stdint.h>
 
-  /*
+	/**
-   * clist_t iterator direction.
+	 * @enum clist_direction_t
+	 * @brief clist_t iterator direction.
 	 */
-
 	typedef enum
 	{
 		LIST_HEAD,
 		LIST_TAIL
 	} clist_direction_t;
 
-  /*
+	/**
-   * clist_t node struct.
+	 * @struct clist_node_t
+	 * @brief clist_t node struct.
 	 */
-
 	typedef struct clist_node
 	{
-    struct clist_node *prev;
+		struct clist_node *prev; ///< previous node
-    struct clist_node *next;
+		struct clist_node *next; ///< next node
 		void *val;
 	} clist_node_t;
 
-  /*
+	/**
-   * clist_t struct.
+	 * @struct clist_t
+	 * @brief clist_t struct.
 	 */
-
 	typedef struct
 	{
-    clist_node_t *head;
+		clist_node_t *head;					 ///< first node
-    clist_node_t *tail;
+		clist_node_t *tail;					 ///< last node
-    uint32_t len;
+		uint32_t len;						 ///< list length
-    void (*free)(void *val);
+		void (*free)(void *val);			 ///< node free function handle
-    int8_t (*compare)(void *a, void *b);
+		int8_t (*compare)(void *a, void *b); ///< node compare function handle
 	} clist_t;
 
-  /*
+	/**
-   * clist_t iterator struct.
+	 * @struct clist_iterator_t
+	 * @brief clist_t iterator struct.
 	 */
-
 	typedef struct
 	{
-    clist_node_t *next;
+		clist_node_t *next;			 ///< next element
-    clist_direction_t direction;
+		clist_direction_t direction; ///< iter direction
 	} clist_iterator_t;
 
 	// Node prototypes.
@@ -116,3 +132,7 @@ extern "C"
 #endif
 
 #endif /* __CLIBS_LIST_H__ */
+
+/** @} cList*/
+
+/** @} Utility*/

df_datalink_sp/src/include/common.h

@@ -1,20 +1,19 @@
 /*****************************************************************************/
 /**
- * Description: Common definitions
+ * @file common.h
- *
+ * @author FanHao ([email protected])
- * Date: 2023-12-21 16:32
+ * @brief Common macros
- * LastEditors: Fan Hao
+ * @version 0.0
- * LastEditTime: 2022-07-16 17:13
+ * @date 2022-07-16
- * Revisions: Rev 0.1
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * History:
+ * Lab of Communication and Network
- * [2023-12-21]: Ensure the code conform ISO C11 standard.
- * [2022-07-16]: New branch for Dijian.
- * [2021-11-16]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @defgroup COMMON_MACRO
+ * @{
+ */
+
 /***************************** Include Files *********************************/
 #ifndef __COMMON_H_
 #define __COMMON_H_
@@ -90,3 +89,5 @@
 /************************** Function Prototypes ******************************/
 void AppAssert(const char *file, int line);
 #endif /* __COMMON_H_ */
+
+/** @} */

df_datalink_sp/src/include/error.h

@@ -1,19 +1,19 @@
 /*****************************************************************************/
 /**
- * Description: Error code definitions.
+ * @file common.h
+ * @author FanHao ([email protected])
+ * @brief Common error numbers
+ * @version 0.0
+ * @date 2022-06-18
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
  *
- * Author: Fan Hao
+ ******************************************************************************/
- * Date: 2022-06-18 16:37
+
- * LastEditors: Fan Hao
+/**
- * LastEditTime: 2022-06-18 17:12
+ * @addtogroup COMMON_MACRO
- * Revisions: Rev 0.0
+ * @{
- * History:
+ */
- * [2022-06-18]: Initial version.
- *
- * Copyright(c) 2022 Beijing Institute of Technology.
- * Lab of Communication and Networking
- *
-******************************************************************************/
 
 #ifndef SRC_ERROR_H_
 #define SRC_ERROR_H_
@@ -24,6 +24,11 @@
 /********************** Macros and Constants Definitions **********************/
 /******************************************************************************/
 
+/**
+ * @name ERRORNO
+ * @{
+ */
+
 #ifdef SUCCESS
 #undef SUCCESS
 #endif
@@ -45,3 +50,7 @@
 #define IS_ERR_VALUE(x)	((x) != SUCCESS)
 
 #endif // ERROR_H_
+
+/** @} ERRORNO*/
+
+/** @} COMMON_MACRO*/

df_datalink_sp/src/include/util.h

@@ -1,41 +1,21 @@
-/*******************************************************************************
+/*****************************************************************************/
+/**
  * @file util.h
- *   @brief  Implementation of utility functions.
+ * @author FanHao ([email protected])
- *   @author DBogdan ([email protected])
+ * @brief Utility functions header file
-********************************************************************************
+ * @version 0.0
- * Copyright 2018(c) Analog Devices, Inc.
+ * @date 2023-05-06
  *
- * All rights reserved.
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
  *
- * Redistribution and use in source and binary forms, with or without
+ ******************************************************************************/
- * modification, are permitted provided that the following conditions are met:
+
- *  - Redistributions of source code must retain the above copyright
+/**
- *    notice, this list of conditions and the following disclaimer.
+ * @defgroup Utility
- *  - Redistributions in binary form must reproduce the above copyright
+ * @{
- *    notice, this list of conditions and the following disclaimer in
+ */
- *    the documentation and/or other materials provided with the
+
- *    distribution.
- *  - Neither the name of Analog Devices, Inc. nor the names of its
- *    contributors may be used to endorse or promote products derived
- *    from this software without specific prior written permission.
- *  - The use of this software may or may not infringe the patent rights
- *    of one or more patent holders.  This license does not release you
- *    from the requirement that you obtain separate licenses from these
- *    patent holders to use this software.
- *  - Use of the software either in source or binary form, must be run
- *    on or directly connected to an Analog Devices Inc. component.
- *
- * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
- * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*******************************************************************************/
 #ifndef __UTIL_H_
 #define __UTIL_H_
 
@@ -193,3 +173,5 @@ bool crc16_check(uint8_t *buffPtr, uint32_t dataLen, uint32_t crcOffset, uint16_
 int crc8_gen(uint8_t *buffPtr, uint32_t dataLen, uint16_t poly, uint8_t *crcVal);
 bool crc8_check(uint8_t *buffPtr, uint32_t dataLen, uint32_t crcOffset, uint16_t poly);
 #endif // __UTIL_H_
+
+/** @} */

df_datalink_sp/src/lscript.ld

@@ -23,9 +23,10 @@ _UNDEF_STACK_SIZE = DEFINED(_UNDEF_STACK_SIZE) ? _UNDEF_STACK_SIZE : 1024;
 
 MEMORY
 {
-   phy_data_interface_rx_frame_bram_ctrl_Mem0 : ORIGIN = 0x40000000, LENGTH = 0x2000
+   phy_data_interface_rx_frame_bram_ctrl_Mem0 : ORIGIN = 0x40000000, LENGTH = 0x1000
-   phy_data_interface_tx_frame_bram_ctrl_Mem0 : ORIGIN = 0x40002000, LENGTH = 0x2000
+   phy_data_interface_tx_frame_bram_ctrl_Mem0 : ORIGIN = 0x40002000, LENGTH = 0x1000
-   phy_data_interface_ant_info_bram_ctrl_Mem0 : ORIGIN = 0x40004000, LENGTH = 0x2000
+   phy_data_interface_ant_config_bram_ctrl_Mem0 : ORIGIN = 0x40004000, LENGTH = 0x2000
+   phy_data_interface_ant_beam_bram_ctrl_Mem0 : ORIGIN = 0x42000000, LENGTH = 0x1000
    ps7_ddr_0 : ORIGIN = 0x100000, LENGTH = 0x1FF00000
    ps7_qspi_linear_0 : ORIGIN = 0xFC000000, LENGTH = 0x1000000
    ps7_ram_0 : ORIGIN = 0x0, LENGTH = 0x30000

df_datalink_sp/src/main.c

@@ -10,7 +10,7 @@
  * History:
  * [2023-05-07]: Initial edition.
  *
- * Copyright(c) 2021 Beijing Institute of Technology.
+ * Copyright(c) 2024 Beijing Institute of Technology.
  *
  ******************************************************************************/
 
@@ -20,19 +20,15 @@
 #include <stdint.h>
 #include <stdbool.h>
 // Xilinx
-#include "sleep.h"
-#include "xil_cache.h"
 #include "xscugic.h"
-#include "xscutimer.h"
-#include "xgpiops.h"
 #include "drivers/platform/xilinx_irq.h"
 #include "drivers/platform/xilinx_timer.h"
-#include "drivers/rf-transceiver/ad9361/ad9361_api.h"
-#include "drivers/axi_core/spi_engine/spi_engine.h"
 // App
 #include "common.h"
 #include "error.h"
 #include "timer.h"
+#include "hwconfig.h"
+#include "system_monitor.h"
 #include "config/app_config.h"
 #include "dev_profile/dev_profile.h"
 #include "systembus/systembus.h"
@@ -46,6 +42,7 @@ void PeriodicPull_Handler(void *callBackRef);
 void ScuTimer_IntrHandler(void *context);
 void Systembus_RxIntrHandler(void *context);
 void Systembus_TxIntrHandler(void *context);
+
 /************************** Constant Definitions *****************************/
 struct callback_desc phy_callback_desc = {
 	.callback = Phy_IntrHandler,
@@ -99,9 +96,14 @@ static PHY_CONFIG phyConfig = {
 	.devId = 0,
 	.baseAddr = PHY_BASEADDR,
 	.antBramId = PHY_ANTCONFIG_BRAM_DEVICE_ID,
+	.antInfoBramId = PHY_ANTINFO_BRAM_DEVICE_ID,
 	.txBramId = PHY_TXBUFF_BRAM_DEVICE_ID,
 	.rxBramId = PHY_RXBUFF_BRAM_DEVICE_ID,
-	.hwXadcId = PHY_HW_XADC_DEVICE_ID
+	.hwXadcId = PHY_HW_XADC_DEVICE_ID,
+	.get_clk_state = Hardware_GetHMC7044LockStatus,
+	.get_ad_lock_state = Hardware_GetAD9361LockStatus,
+	.get_ad0_temp = Hardware_GetAD9361Temp_1,
+	.get_ad1_temp = Hardware_GetAD9361Temp_2
 };
 
 TMC_CONFIG tmcConfig = {
@@ -122,11 +124,7 @@ static PHY_INST *phyInstPtr;
 static TMC_INST *tmcInstPtr = NULL;
 L2_INST *linkInstPtr;
 
-static struct hmc7044_dev *hmc7044_inst;
+
-static struct ad9361_reg_dev *ad9361_1_reg_inst;
-static struct ad9361_reg_dev *ad9361_2_reg_inst;
-// static struct ad9361_rf_phy *ad9361_phy;
-// static struct ad9361_rf_phy *ad9361_2_phy;
 /****************************************************************************/
 /**
  * This function is responsible for initializing the SCUGIC instance, looking
@@ -360,8 +358,13 @@ void ScuTimer_IntrHandler(void *context)
 	xdesc = (struct xil_timer_desc *)(logTmPtr->extra);
 	if (XScuTimer_IsExpired((XScuTimer *)xdesc->instance))
 	{
-		// Update log
+		// Refresh log
-		Phy_UpdateHwSate(phyInstPtr);
+		Phy_RefreshHwSate(phyInstPtr);
+		if (TimeCtrl_GetIntCnt(tmcInstPtr) - phyInstPtr->lastLogTime >= PHY_LOG_EXPIRE)
+		{
+			Phy_UpdateLogging(phyInstPtr);
+		}
+
 		XScuTimer_ClearInterruptStatus((XScuTimer *)xdesc->instance);
 	}
 	else
@@ -370,355 +373,6 @@ void ScuTimer_IntrHandler(void *context)
 	}
 }
 
-/*****************************************************************************/
-/**
- * @brief   Hardware_SwitchFreq
- *
- * @param   dev
- * @param   freq
- *
- * @return  None.
- *
- ******************************************************************************/
-int Hardware_SwitchFreq(struct ad9361_reg_dev *dev, ad9361TxFreq freq)
-{
-	int32_t status = 0;
-	uint8_t value = 0;
-	int32_t time_out_cnt = 0;
-
-	switch (freq)
-	{
-	case TX_FREQ_125:
-	{
-		//************************************************************
-		// Setup Tx Frequency-Dependent Syntheisizer Registers
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x027A, 0x4A); // Set VCO Output level[3:0]
-		status = ad9361_reg_write(dev, 0x0279, 0xC1); // Set Init ALC Value[3:0] and VCO Varactor[3:0]
-		status = ad9361_reg_write(dev, 0x0282, 0x0E); // Set VCO Bias Tcf[1:0] and VCO Bias Ref[2:0]
-		status = ad9361_reg_write(dev, 0x0278, 0x78); // Set VCO Cal Offset[3:0]
-		status = ad9361_reg_write(dev, 0x0285, 0x00); // Set VCO Cal Ref Tcf[2:0]
-		status = ad9361_reg_write(dev, 0x0291, 0x0B); // Set VCO Varactor Reference[3:0]
-		status = ad9361_reg_write(dev, 0x0290, 0x70); // Set VCO Varactor Ref Tcf[2:0] and VCO Varactor Offset[3:0]
-		status = ad9361_reg_write(dev, 0x027B, 0x94); // Set Synth Loop Filter charge pump current (Icp)
-		status = ad9361_reg_write(dev, 0x027E, 0xF4); // Set Synth Loop Filter C2 and C1
-		status = ad9361_reg_write(dev, 0x027F, 0xDF); // Set Synth Loop Filter  R1 and C3
-		status = ad9361_reg_write(dev, 0x0280, 0x0A); // Set Synth Loop Filter R3
-
-		//************************************************************
-		// Write Tx Frequency Words
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x0273, 0x00); // Write Tx Synth Fractional Freq Word[7:0]
-		status = ad9361_reg_write(dev, 0x0274, 0x00); // Write Tx Synth Fractional Freq Word[15:8]
-		status = ad9361_reg_write(dev, 0x0275, 0x00); // Write Tx Synth Fractional Freq Word[22:16]
-		status = ad9361_reg_write(dev, 0x0272, 0x00); // Write Tx Synth Integer Freq Word[10:8]
-		status = ad9361_reg_write(dev, 0x0271, 0xA0); // Write Tx Synth Integer Freq Word[7:0] (starts VCO cal)
-		status = ad9361_reg_write(dev, 0x0005, 0x57); // Set LO divider setting
-
-		//************************************************************
-		// Tx Quadrature Calibration Settings
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x00A0, 0x75); // Set TxQuadcal NCO frequency
-		status = ad9361_reg_write(dev, 0x00A3, 0xC0); // Set TxQuadcal NCO frequency (Only update bits [7:6])
-		status = ad9361_reg_write(dev, 0x00A1, 0x7B); // Tx Quad Cal Configuration, Phase and Gain Cal Enable
-		status = ad9361_reg_write(dev, 0x00A9, 0xFF); // Set Tx Quad Cal Count
-		status = ad9361_reg_write(dev, 0x00A2, 0x7F); // Set Tx Quad Cal Kexp
-		status = ad9361_reg_write(dev, 0x00A5, 0x01); // Set Tx Quad Cal Magnitude Threshhold
-		status = ad9361_reg_write(dev, 0x00A6, 0x01); // Set Tx Quad Cal Magnitude Threshhold
-		status = ad9361_reg_write(dev, 0x00AA, 0x22); // Set Tx Quad Cal Gain Table index
-		status = ad9361_reg_write(dev, 0x00A4, 0xF0); // Set Tx Quad Cal Settle Count
-		status = ad9361_reg_write(dev, 0x00AE, 0x00); // Set Tx Quad Cal LPF Gain index incase Split table mode used
-
-		status = ad9361_reg_write(dev, 0x0169, 0xC0); // Disable Rx Quadrature Calibration before Running Tx Quadrature Calibration
-		status = ad9361_reg_write(dev, 0x0016, 0x10); // Start Tx Quad cal
-
-		break;
-	}
-	case TX_FREQ_126:
-	{
-		//************************************************************
-		// Setup Tx Frequency-Dependent Syntheisizer Registers
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x027A, 0x4A); // Set VCO Output level[3:0]
-		status = ad9361_reg_write(dev, 0x0279, 0xC1); // Set Init ALC Value[3:0] and VCO Varactor[3:0]
-		status = ad9361_reg_write(dev, 0x0282, 0x0E); // Set VCO Bias Tcf[1:0] and VCO Bias Ref[2:0]
-		status = ad9361_reg_write(dev, 0x0278, 0x78); // Set VCO Cal Offset[3:0]
-		status = ad9361_reg_write(dev, 0x0285, 0x00); // Set VCO Cal Ref Tcf[2:0]
-		status = ad9361_reg_write(dev, 0x0291, 0x0B); // Set VCO Varactor Reference[3:0]
-		status = ad9361_reg_write(dev, 0x0290, 0x70); // Set VCO Varactor Ref Tcf[2:0] and VCO Varactor Offset[3:0]
-		status = ad9361_reg_write(dev, 0x027B, 0x93); // Set Synth Loop Filter charge pump current (Icp)
-		status = ad9361_reg_write(dev, 0x027E, 0xF4); // Set Synth Loop Filter C2 and C1
-		status = ad9361_reg_write(dev, 0x027F, 0xDF); // Set Synth Loop Filter  R1 and C3
-		status = ad9361_reg_write(dev, 0x0280, 0x0A); // Set Synth Loop Filter R3
-
-		//************************************************************
-		// Write Tx Frequency Words
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x0273, 0x06); // Write Tx Synth Fractional Freq Word[7:0]
-		status = ad9361_reg_write(dev, 0x0274, 0xD7); // Write Tx Synth Fractional Freq Word[15:8]
-		status = ad9361_reg_write(dev, 0x0275, 0x23); // Write Tx Synth Fractional Freq Word[22:16]
-		status = ad9361_reg_write(dev, 0x0272, 0x00); // Write Tx Synth Integer Freq Word[10:8]
-		status = ad9361_reg_write(dev, 0x0271, 0xA1); // Write Tx Synth Integer Freq Word[7:0] (starts VCO cal)
-		status = ad9361_reg_write(dev, 0x0005, 0x57); // Set LO divider setting
-
-		//************************************************************
-		// Tx Quadrature Calibration Settings
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x00A0, 0x75); // Set TxQuadcal NCO frequency
-		status = ad9361_reg_write(dev, 0x00A3, 0xC0); // Set TxQuadcal NCO frequency (Only update bits [7:6])
-		status = ad9361_reg_write(dev, 0x00A1, 0x7B); // Tx Quad Cal Configuration, Phase and Gain Cal Enable
-		status = ad9361_reg_write(dev, 0x00A9, 0xFF); // Set Tx Quad Cal Count
-		status = ad9361_reg_write(dev, 0x00A2, 0x7F); // Set Tx Quad Cal Kexp
-		status = ad9361_reg_write(dev, 0x00A5, 0x01); // Set Tx Quad Cal Magnitude Threshhold
-		status = ad9361_reg_write(dev, 0x00A6, 0x01); // Set Tx Quad Cal Magnitude Threshhold
-		status = ad9361_reg_write(dev, 0x00AA, 0x22); // Set Tx Quad Cal Gain Table index
-		status = ad9361_reg_write(dev, 0x00A4, 0xF0); // Set Tx Quad Cal Settle Count
-		status = ad9361_reg_write(dev, 0x00AE, 0x00); // Set Tx Quad Cal LPF Gain index incase Split table mode used
-
-		status = ad9361_reg_write(dev, 0x0169, 0xC0); // Disable Rx Quadrature Calibration before Running Tx Quadrature Calibration
-		status = ad9361_reg_write(dev, 0x0016, 0x10); // Start Tx Quad cal
-
-		break;
-	}
-	case TX_FREQ_4125:
-	{
-		//************************************************************
-		// Setup Tx Frequency-Dependent Syntheisizer Registers
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x027A, 0x4A); // Set VCO Output level[3:0]
-		status = ad9361_reg_write(dev, 0x0279, 0xC1); // Set Init ALC Value[3:0] and VCO Varactor[3:0]
-		status = ad9361_reg_write(dev, 0x0282, 0x0E); // Set VCO Bias Tcf[1:0] and VCO Bias Ref[2:0]
-		status = ad9361_reg_write(dev, 0x0278, 0x78); // Set VCO Cal Offset[3:0]
-		status = ad9361_reg_write(dev, 0x0285, 0x00); // Set VCO Cal Ref Tcf[2:0]
-		status = ad9361_reg_write(dev, 0x0291, 0x0B); // Set VCO Varactor Reference[3:0]
-		status = ad9361_reg_write(dev, 0x0290, 0x70); // Set VCO Varactor Ref Tcf[2:0] and VCO Varactor Offset[3:0]
-		status = ad9361_reg_write(dev, 0x027B, 0x93); // Set Synth Loop Filter charge pump current (Icp)
-		status = ad9361_reg_write(dev, 0x027E, 0xF4); // Set Synth Loop Filter C2 and C1
-		status = ad9361_reg_write(dev, 0x027F, 0xDF); // Set Synth Loop Filter  R1 and C3
-		status = ad9361_reg_write(dev, 0x0280, 0x0A); // Set Synth Loop Filter R3
-
-		//************************************************************
-		// Write Rx Frequency Words
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x0273, 0x00); // Write Tx Synth Fractional Freq Word[7:0]
-		status = ad9361_reg_write(dev, 0x0274, 0x00); // Write Tx Synth Fractional Freq Word[15:8]
-		status = ad9361_reg_write(dev, 0x0275, 0x00); // Write Tx Synth Fractional Freq Word[22:16]
-		status = ad9361_reg_write(dev, 0x0272, 0x00); // Write Tx Synth Integer Freq Word[10:8]
-		status = ad9361_reg_write(dev, 0x0271, 0xA5); // Write Tx Synth Integer Freq Word[7:0] (starts VCO cal)
-		status = ad9361_reg_write(dev, 0x0005, 0x07); // Set LO divider setting
-
-		//************************************************************
-		// Tx Quadrature Calibration Settings
-		//************************************************************
-		status = ad9361_reg_write(dev, 0x00A0, 0x75); // Set TxQuadcal NCO frequency
-		status = ad9361_reg_write(dev, 0x00A3, 0xC0); // Set TxQuadcal NCO frequency (Only update bits [7:6])
-		status = ad9361_reg_write(dev, 0x00A1, 0x7B); // Tx Quad Cal Configuration, Phase and Gain Cal Enable
-		status = ad9361_reg_write(dev, 0x00A9, 0xFF); // Set Tx Quad Cal Count
-		status = ad9361_reg_write(dev, 0x00A2, 0x7F); // Set Tx Quad Cal Kexp
-		status = ad9361_reg_write(dev, 0x00A5, 0x01); // Set Tx Quad Cal Magnitude Threshhold
-		status = ad9361_reg_write(dev, 0x00A6, 0x01); // Set Tx Quad Cal Magnitude Threshhold
-		status = ad9361_reg_write(dev, 0x00AA, 0x28); // Set Tx Quad Cal Gain Table index
-		status = ad9361_reg_write(dev, 0x00A4, 0xF0); // Set Tx Quad Cal Settle Count
-		status = ad9361_reg_write(dev, 0x00AE, 0x04); // Set Tx Quad Cal LPF Gain index incase Split table mode used
-
-		status = ad9361_reg_write(dev, 0x0169, 0xC0); // Disable Rx Quadrature Calibration before Running Tx Quadrature Calibration
-		status = ad9361_reg_write(dev, 0x0016, 0x10); // Start Tx Quad cal
-
-		break;
-	}
-
-		// Wait for cal to complete (Done when 0x016[4]==0)
-		time_out_cnt = 0;
-		do
-		{
-			status |= ad9361_reg_read(dev, 0x0016, &value);
-			mdelay(1); // Wait 1ms
-			time_out_cnt++;
-		} while ((value & 0x10) != 0x00 && time_out_cnt <= AD9361_TIMEOUT_TH);
-	}
-
-	return status;
-}
-
-/*****************************************************************************/
-/**
- * @brief   Hardware_Init
- *
- * @param   none.
- *
- * @return  None.
- *
- ******************************************************************************/
-int Hardware_Init(void)
-{
-	int32_t Status;
-	XGpioPs Gpio;
-	XGpioPs_Config *ConfigPtr;
-	ConfigPtr = XGpioPs_LookupConfig(AD9361_GPIO_DEVICE_ID);
-	Status = XGpioPs_CfgInitialize(&Gpio, ConfigPtr, ConfigPtr->BaseAddr);
-	if (Status != SUCCESS)
-	{
-		return FAILURE;
-	}
-
-	/**********************************************************/
-	/****************** HMC7044 Configuration *****************/
-	/**********************************************************/
-	Status = hmc7044_init(&hmc7044_inst, &hmc7044_default_init_param);
-	if (Status != SUCCESS)
-	{
-		DBG_ERROR("hmc7044_init() error: %" PRId32 "\n", Status);
-		return FAILURE;
-	}
-
-	/**********************************************************/
-	/***************** AD9361-1 Configuration *****************/
-	/**********************************************************/
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_TXNRX, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_ENABLE, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_EN_AGC, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_RESET_B, AD9361_GPIO_OUTPUT);
-
-	ad9361_reg_init(&ad9361_1_reg_inst, &ad9361_1_reg_default_init_param);
-	XGpioPs_WritePin(&Gpio, AD9361_1_ENABLE, 0);
-	ad9361_reg_config(ad9361_1_reg_inst);
-	XGpioPs_WritePin(&Gpio, AD9361_1_ENABLE, 1);
-
-	//	Status = ad9361_init(&ad9361_phy, &ad9361_default_init_param);
-	//	if (Status != XST_SUCCESS){
-	//		return XST_FAILURE;
-	//	}else{
-	//		printf("Configurate AD9361 Completely!\n");
-	//	}
-	//	ad9361_set_tx_fir_config(ad9361_phy, tx_fir_config);
-	//	ad9361_set_rx_fir_config(ad9361_phy, rx_fir_config);
-
-	/**********************************************************/
-	/***************** AD9361-2 Configuration *****************/
-	/**********************************************************/
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_TXNRX, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_ENABLE, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_EN_AGC, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_RESET_B, AD9361_GPIO_OUTPUT);
-
-	ad9361_reg_init(&ad9361_2_reg_inst, &ad9361_2_reg_default_init_param);
-	XGpioPs_WritePin(&Gpio, AD9361_2_ENABLE, 0);
-	ad9361_reg_config(ad9361_2_reg_inst);
-	XGpioPs_WritePin(&Gpio, AD9361_2_ENABLE, 1);
-
-	//	uint8_t rd_back;
-	//	Status = ad9361_reg_read(ad9361_1_reg_inst, 0x0002, &rd_back);
-	//	Status = ad9361_reg_read(ad9361_2_reg_inst, 0x0002, &rd_back);
-
-	/**********************************************************/
-	/******* AD9361 Baseband Multichip Synchronization ********/
-	/**********************************************************/
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_SYNC, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_RX_FIFO_RST, AD9361_GPIO_OUTPUT);
-
-	// SYNC BBPLL and DIGITAL SAMPLING CLOCKS
-	ad9361_reg_write(ad9361_1_reg_inst, 0x0001, 0x0D); // MCS RF Enable; MCS BBPLL Enable; MCS BB Enable
-	ad9361_reg_write(ad9361_2_reg_inst, 0x0001, 0x0D);
-	ad9361_reg_write(ad9361_1_reg_inst, 0x0047, 0x80); // MCS refclk Scale Enable
-	ad9361_reg_write(ad9361_2_reg_inst, 0x0047, 0x80);
-	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 0);
-	mdelay(20);
-	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 1); // Input a rising-edge pulse to the SYNC_IN pin
-	mdelay(500);
-	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 0);
-	mdelay(2000);
-	ad9361_reg_write(ad9361_1_reg_inst, 0x0001, 0x0B); // MCS RF Enable; MCS Digital CLK Enable ; MCS BB Enable
-	ad9361_reg_write(ad9361_2_reg_inst, 0x0001, 0x0B);
-	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 1); // Input another rising-edge pulse to the SYNC_IN pin
-	mdelay(500);
-	XGpioPs_WritePin(&Gpio, AD9361_SYNC, 0);
-	ad9361_reg_write(ad9361_1_reg_inst, 0x0001, 0x08); // clear MCS bits
-	ad9361_reg_write(ad9361_2_reg_inst, 0x0001, 0x08);
-
-	XGpioPs_WritePin(&Gpio, AD9361_RX_FIFO_RST, 0);
-	mdelay(20);
-	XGpioPs_WritePin(&Gpio, AD9361_RX_FIFO_RST, 1);
-	mdelay(20);
-	XGpioPs_WritePin(&Gpio, AD9361_RX_FIFO_RST, 0);
-
-	/**********************************************************/
-	/********* AD9361 Multichip Rx Phase Calibration **********/
-	/**********************************************************/
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_TX_SWITCH, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_CAL_START, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_1_CAL_DONE, AD9361_GPIO_INPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_CAL_START, AD9361_GPIO_OUTPUT);
-	XGpioPs_SetDirectionPin(&Gpio, AD9361_2_CAL_DONE, AD9361_GPIO_INPUT);
-
-	// switch to lower frequency
-	Status = Hardware_SwitchFreq(ad9361_1_reg_inst, TX_FREQ_126);
-	XGpioPs_WritePin(&Gpio, AD9361_TX_SWITCH, 1);
-	mdelay(20);
-
-	// switch rx channel
-	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0004, 0x30);
-	Status = ad9361_reg_write(ad9361_2_reg_inst, 0x0004, 0x30);
-
-	// enable dual ad9361 tx channels
-	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0002, 0xE4); // Setup Tx Digital Filters/ Channels
-
-	// switch ad9361 tx channel
-	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0004, 0x70); // Select Rx input pin(A,B,C)/ Tx out pin (A,B)
-	mdelay(20);
-
-	// begin to calibrate the 1st ad9361
-	XGpioPs_WritePin(&Gpio, AD9361_1_CAL_START, 0);
-	XGpioPs_WritePin(&Gpio, AD9361_1_CAL_START, 1);
-	mdelay(1);
-	XGpioPs_WritePin(&Gpio, AD9361_1_CAL_START, 0);
-
-	// read calibration status
-	int32_t time_out_cnt = 0;
-	do
-	{
-		mdelay(1); // Wait 1ms
-		time_out_cnt++;
-	} while (((XGpioPs_ReadPin(&Gpio, AD9361_1_CAL_DONE) == 0) && time_out_cnt <= AD9361_TIMEOUT_TH));
-
-	if (time_out_cnt == AD9361_TIMEOUT_TH)
-	{
-		return FAILURE;
-	}
-
-	// begin to calibrate the 2nd ad9361
-	XGpioPs_WritePin(&Gpio, AD9361_2_CAL_START, 1);
-	mdelay(1);
-	XGpioPs_WritePin(&Gpio, AD9361_2_CAL_START, 0);
-
-	// read calibration status
-	time_out_cnt = 0;
-	do
-	{
-		mdelay(1); // Wait 1ms
-		time_out_cnt++;
-	} while (((XGpioPs_ReadPin(&Gpio, AD9361_2_CAL_DONE) == 0) && time_out_cnt <= AD9361_TIMEOUT_TH));
-
-	if (time_out_cnt == AD9361_TIMEOUT_TH)
-	{
-		return FAILURE;
-	}
-
-	// enable single ad9361 tx channels
-	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0002, 0xA4); // Setup Tx Digital Filters/ Channels
-
-	// switch ad9361 tx & rx channel
-	Status = ad9361_reg_write(ad9361_1_reg_inst, 0x0004, 0x03);
-	Status = ad9361_reg_write(ad9361_2_reg_inst, 0x0004, 0x03);
-
-	// switch to higher frequency
-	Status = Hardware_SwitchFreq(ad9361_1_reg_inst, TX_FREQ_4125);
-	XGpioPs_WritePin(&Gpio, AD9361_TX_SWITCH, 0);
-
-	DBG_PRINT("Done.\n");
-
-	return 0;
-}
-
 /*****************************************************************************/
 /**
  * @brief	Main function, initialize all the device needed, initialize
@@ -771,7 +425,7 @@ int main(void)
 	}
 
 	/* Physical Layer Initialize */
-	Status = Phy_InstInit(&phyInstPtr, &phyConfig);
+	Status = Phy_Init(&phyInstPtr, &phyConfig);
 	if (Status == SUCCESS)
 	{
 		DBG_PRINT("Physical layer Init SUCCESS! \n");
@@ -835,7 +489,7 @@ int main(void)
 	while (true)
 	{
 		// System bus handler
-		if (SystemBus_IsReqPendding(sysbusDescPtr))
+		if (SystemBus_IsReqPending(sysbusDescPtr))
 		{
 			Status = SystemBus_HandleCmd(sysbusDescPtr);
 			if (Status != SUCCESS)
@@ -843,7 +497,7 @@ int main(void)
 				DBG_ERROR("SystemBus_HandleCmd exit with ErrorCode: %" PRId32 ".\n", Status);
 			}
 		}
-		if (SystemBus_IsRsqPendding(sysbusDescPtr) && (!SystemBus_IsTxBusy(sysbusDescPtr)))
+		if (SystemBus_IsRsqPending(sysbusDescPtr) && (!SystemBus_IsTxBusy(sysbusDescPtr)))
 		{
 			// FIXME: Required by 12 (CASC)
 			udelay(4000);

df_datalink_sp/src/networking/link_layer/framing.c

@@ -1,19 +1,25 @@
 /*****************************************************************************/
 /**
- * Description:  Functions for framing operations.
+ * @file framing.h
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer framing functions.
+ * @version 0.0
+ * @date 2023-05-06
  *
- * Date: 2022-07-16 14:17
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditors: Fan Hao
+ * Lab of Communication and Network
- * LastEditTime: 2022-07-16 17:11
- * Revisions: Rev 0.0
- * History:
- * [2022-07-16]: Description of modification.
- *
- * Copyright(c) 2022 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
 
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayer_Framing
+ * @{
+ */
 /***************************** Include Files *********************************/
 #include <stdint.h>
 #include <string.h>
@@ -177,3 +183,7 @@ bool L2_CrcCheck(uint8_t *dataBuff, uint32_t dataLen, L2_CRC_TYPE crcType)
 		return false;
 	}
 }
+
+/** @} LinkLayer_Framing*/
+
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/geometry/coord.c

@@ -1,8 +1,28 @@
-//
+/*****************************************************************************/
-// Copyright (C) 2020 OpenSim Ltd.
+/**
-//
+ * @file coord.c
-// SPDX-License-Identifier: LGPL-3.0-or-later
+ * @author FanHao ([email protected])
-//
+ * @version 0.0
+ * @date 2023-05-06
+ *
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry_Coord
+ * @{
+ */
 
 #include <math.h>
 #include "coord.h"
@@ -209,3 +229,9 @@ COORD Coord_Launch2Inertia(COORD o, COORD p, double A, double B, double we, doub
 
 	return ret;
 }
+
+/** @} LinkLayerGeometry_Coord */
+
+/** @} LinkLayerGeometry */
+
+/** @} LinkLayer */

df_datalink_sp/src/networking/link_layer/geometry/coord.h

@@ -1,20 +1,36 @@
-//
+/*****************************************************************************/
-// Copyright (C) 2020 OpenSim Ltd.
+/**
-//
+ * @file coord.h
-// SPDX-License-Identifier: LGPL-3.0-or-later
+ * @author FanHao ([email protected])
-//
+ * @version 0.0
+ * @date 2023-05-06
+ *
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
 
 #ifndef _COORD_H
 #define _COORD_H
-
 /**
- * @brief Structure for storing 3D coordinates.
+ * @addtogroup LinkLayer
- *
+ * @{
- * Some comparison and basic arithmetic operators are implemented.
- *
- * @ingroup utils
  */
 
+/**
+ * @defgroup LinkLayerGeometry
+ * @{
+ */
+
+/**
+ * @defgroup LinkLayerGeometry_Coord
+ * @{
+ */
+
+/**
+ * @struct COORD
+ * @brief Structure for storing 3D coordinates.
+ */
 typedef struct
 {
 	double x;
@@ -78,3 +94,9 @@ COORD Coord_GetNormalized(COORD a);
 double Coord_Angle(COORD a, COORD b);
 
 #endif
+
+/** @} LinkLayerGeometry_Coord */
+
+/** @} LinkLayerGeometry */
+
+/** @} LinkLayer */

df_datalink_sp/src/networking/link_layer/geometry/eulerangles.c

@@ -1,8 +1,29 @@
-//
+/*****************************************************************************/
-// Copyright (C) 2020 OpenSim Ltd.
+/**
-//
+ * @file eulerangles.c
-// SPDX-License-Identifier: LGPL-3.0-or-later
+ * @author FanHao ([email protected])
-//
+ * @version 0.0
+ * @date 2023-05-06
+ *
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry_EulerAngles
+ * @{
+ */
 
 #include <math.h>
 #include "eulerangles.h"
@@ -59,3 +80,9 @@ EULERANGLES EulerAngles_GetNormalize(EULERANGLES e)
 	EulerAngles_Normalize(&e);
 	return e;
 }
+
+/** @} LinkLayerGeometry_EulerAngles */
+
+/** @} LinkLayerGeometry */
+
+/** @} LinkLayer */

df_datalink_sp/src/networking/link_layer/geometry/eulerangles.h

@@ -1,3 +1,30 @@
+/*****************************************************************************/
+/**
+ * @file eulerangles.h
+ * @author FanHao ([email protected])
+ * @version 0.0
+ * @date 2023-05-06
+ *
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry
+ * @{
+ */
+
+/**
+ * @defgroup LinkLayerGeometry_EulerAngles
+ * @{
+ */
+
 #ifndef __EULERANGLES_H
 #define __EULERANGLES_H
 
@@ -16,6 +43,11 @@
  * rotation along the Y axis rotates Z into X (leans forward), positive rotation
  * along the X axis rotates Y into Z (leans right).
  */
+
+/**
+ * @struct EULERANGLES
+ * @brief Structure for standard quaternion
+ */
 typedef struct
 {
 	double alpha; // unit rad
@@ -53,3 +85,9 @@ void EulerAngles_Normalize(EULERANGLES *e);
 EULERANGLES EulerAngles_GetNormalize(EULERANGLES e);
 
 #endif
+
+/** @} LinkLayerGeometry_EulerAngles */
+
+/** @} LinkLayerGeometry */
+
+/** @} LinkLayer */

df_datalink_sp/src/networking/link_layer/geometry/quaternion.c

@@ -1,8 +1,29 @@
-//
+/*****************************************************************************/
-// Copyright (C) 2014 OpenSim Ltd.
+/**
-//
+ * @file quaternion.c
-// SPDX-License-Identifier: LGPL-3.0-or-later
+ * @author FanHao ([email protected])
-//
+ * @version 0.0
+ * @date 2023-05-06
+ *
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry_Quaternion
+ * @{
+ */
 
 #include <math.h>
 #include <stdint.h>
@@ -28,6 +49,7 @@ const SOFT_DOUBLE EPS_DOUBLE = {.raw = 0x3CB0000000000000};
 
 const QUATERNION QUATERNION_IDENTITY = {1.0, 0.0, 0.0, 0.0};
 const QUATERNION QUATERNION_NIL = {NAN, NAN, NAN, NAN};
+
 /** @brief Subtracts two quaternions. */
 QUATERNION Quaternion_Sub(QUATERNION q1, QUATERNION q2)
 {
@@ -450,3 +472,9 @@ QUATERNION Quaternion_Slerp(QUATERNION q1, QUATERNION q2, double t)
 		return Quaternion_Lerp(q1, q3, t);
 	}
 }
+
+/** @} LinkLayerGeometry_Quaternion */
+
+/** @} LinkLayerGeometry */
+
+/** @} LinkLayer */

df_datalink_sp/src/networking/link_layer/geometry/quaternion.h

@@ -1,3 +1,29 @@
+/*****************************************************************************/
+/**
+ * @file quaternion.h
+ * @author FanHao ([email protected])
+ * @version 0.0
+ * @date 2023-05-06
+ *
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayerGeometry
+ * @{
+ */
+
+/**
+ * @defgroup LinkLayerGeometry_Quaternion
+ * @{
+ */
 
 #ifndef __QUATERNION_H
 #define __QUATERNION_H
@@ -5,7 +31,10 @@
 #include "coord.h"
 #include "eulerangles.h"
 
-// borrowed and adapted from https://github.com/MegaManSE/willperone/blob/master/Math/quaternion.h
+/**
+ * @struct QUATERNION
+ * @brief Structure for standard quaternion
+ */
 typedef struct
 {
 	double s;
@@ -107,3 +136,9 @@ QUATERNION Quaternion_Lerp(QUATERNION q1, QUATERNION q2, double t);
 QUATERNION Quaternion_Slerp(QUATERNION q1, QUATERNION q2, double t);
 
 #endif
+
+/** @} LinkLayerGeometry_Quaternion */
+
+/** @} LinkLayerGeometry */
+
+/** @} LinkLayer */

df_datalink_sp/src/networking/link_layer/link_layer.h

@@ -1,19 +1,21 @@
 /*****************************************************************************/
 /**
- * Description: Header file for df linklayer functions
+ * @file link_layer.h
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer header file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2021-11-13 13:33
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditTime: 2022-07-16 10:12
+ * Lab of Communication and Network
- * Revisions: Rev 0.1
- * History:
- * [2022-07-16]: New branch for DiJian.
- * [2021-11-23]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
 
+/**
+ * @defgroup LinkLayer
+ * @{
+ */
+
 #ifndef __LINK_LAYER_H_
 #define __LINK_LAYER_H_
 
@@ -30,76 +32,96 @@
 #define AssertL2Event(instPtr, event) Linklayer_EventHandler(instPtr, event)
 /**************************** Type Definitions *******************************/
 
+/**
+ * @struct L2_CONFIG
+ * @brief A struct holds all linklayer initialization parameters
+ */
 typedef struct
 {
-	L2_NODE_TYPE myType;
+	L2_NODE_TYPE myType;  ///< node type
-	bool isInterHead;
+	bool isInterHead;	  ///< indicate if node is head node
-	uint8_t clustId;
+	uint8_t clustId;	  ///< node cluster id
-	uint8_t myId;
+	uint8_t myId;		  ///< node id
-	uint8_t headId;
+	uint8_t headId;		  ///< head node id
-	uint8_t bkpHeadId;
+	uint8_t bkpHeadId;	  ///< backup head id
-	uint8_t netScale;
+	uint8_t netScale;	  ///< net scale
-	PHY_INST *phyInstPtr;
+	PHY_INST *phyInstPtr; ///< pointer to system physical layer instance
-	TMC_INST *tmcInstPtr;
+	TMC_INST *tmcInstPtr; ///< pointer to system timer controller layer instance
 } L2_CONFIG;
 
+/**
+ * @struct L2_LOG
+ *  @brief A struct holds linklayer operating log
+ */
 typedef struct
 {
-	uint32_t frameRx;
+	uint32_t frameRx;	   ///< total rx frame count
-	uint32_t frameTx;
+	uint32_t frameTx;	   ///< total tx frame count
-	uint32_t frameRecv;
+	uint32_t frameRecv;	   ///< total received frame count
-	uint32_t frameCorrect;
+	uint32_t frameCorrect; ///< total correctly received frame count
 
-	uint32_t advRxCnt;
+	uint32_t advRxCnt;		///< advertise rx frame count
-	uint32_t advTxCnt;
+	uint32_t advTxCnt;		///< advertise tx frame count
-	uint32_t advRecvCnt;
+	uint32_t advRecvCnt;	///< advertise received frame count
-	uint32_t advCorrectCnt;
+	uint32_t advCorrectCnt; ///< advertise correctly received frame count
 
-	uint32_t cfmRxCnt;
+	uint32_t cfmRxCnt;		///< confirm rx frame count
-	uint32_t cfmTxCnt;
+	uint32_t cfmTxCnt;		///< confirm tx frame count
-	uint32_t cfmRecvCnt;
+	uint32_t cfmRecvCnt;	///< confirm received frame count
-	uint32_t cfmCorrectCnt;
+	uint32_t cfmCorrectCnt; ///< confirm correctly received frame count
 
-	uint32_t svcRxCnt;
+	uint32_t svcRxCnt;		///< service rx frame count
-	uint32_t svcTxCnt;
+	uint32_t svcTxCnt;		///< service tx frame count
-	uint32_t svcRecvCnt;
+	uint32_t svcRecvCnt;	///< service received frame count
-	uint32_t svcCorrectCnt;
+	uint32_t svcCorrectCnt; ///< service correctly received frame count
+
+	int64_t timeDev;	   ///< last time deviation estimation result
+	uint8_t lastBeamWidth; ///< last beam width
+	uint32_t reconnectCnt; ///< reconnect trial count
+
+	PAYLOAD rxLog;
+	PAYLOAD txLog;
 } L2_LOG;
 
+/**
+ * @struct L2_INST
+ * @brief A linklayer instance
+ */
 typedef struct
 {
-	L2_CONFIG config;
+	L2_CONFIG config;			 ///< linklayer configuration parameters
-	L2_NODE_INFO myInfo;
+	L2_NODE_INFO myInfo;		 ///< current node info
-	NODE_LIST *nodeList;
+	NODE_LIST *nodeList;		 ///< discovered node list
-	L2_SCHD_POOL *schdEventPool;
+	L2_SCHD_POOL *schdEventPool; ///< event schedule pool
-	uint32_t netStartTime;
+	uint32_t netStartTime;		 ///< network start time
-	bool isEnable;			   // if the node is connected to the network
+	bool isEnable;				 ///< indicates if the node is connected to the network
-	bool dataAvail;			   // if there is a valid received frame data in rx buffer
+	bool dataAvail;				 ///< indicates if there is a valid received frame data in rx buffer
-	bool cxn2Net;			   // if the node is connected to the network
+	bool cxn2Net;				 ///< indicates if the node is connected to the network
-	L2_RCD frameNum;		   // stores the last current and next frame number.
+	L2_RCD frameNum;			 ///< stores the last current and next frame number.
-	L2_RCD slotNum;			   // stores the last current and next slot number.
+	L2_RCD slotNum;				 ///< stores the last current and next slot number.
-	L2_RCD frame;			   // stores the last current and next link layer frame type.
+	L2_RCD frame;				 ///< stores the last current and next link layer frame type.
-	L2_RCD tor;				   // stores the last current and next link layer tx/rx state.
+	L2_RCD tor;					 ///< stores the last current and next link layer tx/rx state.
-	L2_NODE_STATE mainState;   // the main state of link layer state
+	L2_NODE_STATE mainState;	 ///< the main state of link layer state
-	L2_NODE_STATE nextState;   // next state of link layer state, which will be applied to mainState every second.
+	L2_NODE_STATE nextState;	 ///< next state of link layer state, which will be applied to mainState every second.
-	L2_RTNE_CONFIG rtneConfig; // current routine table configuration and status.
+	L2_RTNE_CONFIG rtneConfig;	 ///< current routine table configuration and status.
-	L2_SCAN_FSM *scanFSM;   // FSM of scan net (link set up)
+	L2_SCAN_FSM *scanFSM;		 ///< FSM of scan net (link set up)
-	L2_SVC_FSM *serviceFSM; // FSM of service net (data service)
+	L2_SVC_FSM *serviceFSM;		 ///< FSM of service net (data service)
-	uint8_t *sendPktData;
+	uint8_t *sendPktData;		 ///< send data buffer
-	uint8_t *recvPktData;
+	uint8_t *recvPktData;		 ///< received data buffer
-	L2_LOG log;
+	L2_LOG log;					 ///< Linklayer operating log
 	// for system log
-	SYSINFO sysInfo;
+	SYSINFO sysInfo; ///< system info
-	SLOTLOG txSlotLog;
+	LINKLOG linkLog; ///< linklayer log for system monitor
-	SLOTLOG rxSlotLog;
-	PRTCLLOG prtcLog;
 } L2_INST;
 
 /************************** Variable Definitions *****************************/
 extern L2_RTNE_TABLE_ENTRY *initTable[L2_INIT_RTNE_PERIOD];
 extern L2_RTNE_TABLE_ENTRY *normalTable[L2_NORMAL_RTNE_PERIOD];
 /************************** Function Prototypes ******************************/
-// Main
+/**
+ * @defgroup LinkLayer_Main
+ * @{
+ */
 int32_t Linklayer_Init(L2_INST **instPtr, const L2_CONFIG *config);
 int32_t Linklayer_Reconfig(L2_INST *instPtr, const L2_CONFIG *config);
 void Linklayer_Destroy(L2_INST *instPtr);
@@ -110,45 +132,72 @@ int32_t Linklayer_EventHandler(L2_INST *instPtr, const L2_EVENT *l2Event);
 int32_t Linklayer_PktHandler(L2_INST *instPtr, L2_FRAME_TYPE frameType);
 int32_t L2_SteerBeam2Node(L2_INST *instPtr, uint8_t nodeId);
 int32_t L2_SetupNextSlot(L2_INST *instPtr, L2_TOR_TYPE txrxMode, L2_FRAME_TYPE frameType);
-void L2_FrameStateUpdate(L2_INST *instPtr);
+/** @} LinkLayer_Main*/
-L2_FRAME_TYPE L2_GetLastOptFrameType(L2_INST *instPtr);
-L1_FRAME_TYPE L2_L2frame2L1frame(L2_FRAME_TYPE l2Frame);
 
-// Scheduling Event
+/**
+ * @defgroup LinkLayer_Framing
+ * @{
+ */
+void L2_FrameInsertChunk(uint8_t *frame, size_t offset, size_t bytes, const void *chunk);
+void L2_FrameGetChunk(uint8_t *frame, size_t offset, size_t bytes, void *chunk);
+int32_t L2_CrcAppend(uint8_t *dataBuff, uint32_t dataLen, uint32_t crcPos, L2_CRC_TYPE crcType);
+bool L2_CrcCheck(uint8_t *dataBuff, uint32_t dataLen, L2_CRC_TYPE crcType);
+/** @} LinkLayer_Framing*/
+
+/**
+ * @defgroup LinkLayer_Scheduler
+ * @{
+ */
 void L2_EventPoolHandler(L2_INST *instPtr);
 int32_t L2_ScheduleEventAt(L2_INST *instPtr, L2_SCHD_EVENT *schdEvent, uint32_t frameNo, uint32_t slotNo);
 int32_t L2_ScheduleEventAfter(L2_INST *instPtr, L2_SCHD_EVENT *schdEvent, uint32_t numSlots);
 int32_t L2_RescheduleEventAt(L2_INST *instPtr, L2_SCHD_EVENT *schdEvent, uint32_t frameNo, uint32_t slotNo);
 int32_t L2_RescheduleEventAfter(L2_INST *instPtr, L2_SCHD_EVENT *schdEvent, uint32_t numSlots);
+/** @} LinkLayer_Scheduler*/
 
-// Framing
+/**
-void L2_FrameInsertChunk(uint8_t *frame, size_t offset, size_t bytes, const void *chunk);
+ * @defgroup LinkLayer_Scan
-void L2_FrameGetChunk(uint8_t *frame, size_t offset, size_t bytes, void *chunk);
+ * @{
-int32_t L2_CrcAppend(uint8_t *dataBuff, uint32_t dataLen, uint32_t crcPos, L2_CRC_TYPE crcType);
+ */
-bool L2_CrcCheck(uint8_t *dataBuff, uint32_t dataLen, L2_CRC_TYPE crcType);
-
-// Scanning
 int32_t L2_Scan_Init(L2_SCAN_FSM **scanFSMPtr);
+void L2_Scan_RefreashScanTable(L2_INST *instPtr);
 void L2_Scan_Reset(L2_SCAN_FSM *scanFSMPtr);
 void L2_Scan_Destroy(L2_SCAN_FSM *scanFSMPtr);
 int32_t L2_Scan_Proc(L2_INST *instPtr);
 int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg);
 int32_t L2_Scan_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *schedEntry);
+/** @} LinkLayer_Scan*/
 
-// Service
+/**
+ * @defgroup LinkLayer_Service
+ * @{
+ */
 int32_t L2_Service_Init(L2_SVC_FSM **svcFSMPtr);
 void L2_Service_Reset(L2_SVC_FSM *svcFSMPtr);
 void L2_Service_Destroy(L2_SVC_FSM *svcFSMPtr);
 int32_t L2_Service_PktHandler(L2_INST *instPtr, uint8_t *msg);
 int32_t L2_Service_Proc(L2_INST *instPtr);
 int32_t L2_Service_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *schedEntry);
+/** @} LinkLayer_Service*/
 
-// Miscellaneous
+/**
+ * @defgroup LinkLayer_TimeSync
+ * @{
+ */
+int32_t L2_GetTimeDeviation(L2_INST *instPtr, uint32_t frameNum, uint32_t slotNum, bool relative, int64_t *timeDev);
+void L2_TimeAdjust(L2_INST *instPtr, const int64_t *timeDev);
+/** @} LinkLayer_TimeSync*/
+
+/**
+ * @defgroup LinkLayer_Utility
+ * @{
+ */
 uint8_t L2_GetNodeId(L2_INST *instPtr);
 uint8_t L2_GetClusterId(L2_INST *instPtr);
 uint8_t L2_GetHeadId(L2_INST *instPtr);
 L2_NODE_TYPE L2_GetNodeType(L2_INST *instPtr);
 L2_NODE_STATE L2_GetMainState(L2_INST *instPtr);
+bool L2_isStarted(L2_INST *instPtr);
 bool L2_isDataAvail(L2_INST *instPtr);
 bool L2_isCxn2Net(L2_INST *instPtr);
 uint32_t L2_GetFrameLen(L2_FRAME_TYPE l2FrameType);
@@ -164,9 +213,10 @@ uint32_t L2_GetNextFrameNum(L2_INST *instPtr);
 uint32_t L2_GetNextSlotNum(L2_INST *instPtr);
 L2_FRAME_TYPE L2_GetNextFrameType(L2_INST *instPtr);
 L2_TOR_TYPE L2_GetNextTor(L2_INST *instPtr);
-
+L2_FRAME_TYPE L2_GetLastOptFrameType(L2_INST *instPtr);
-// Time syncronization
+L1_FRAME_TYPE L2_L2frame2L1frame(L2_FRAME_TYPE l2Frame);
-int32_t L2_TimeAlign(L2_INST *instPtr, uint32_t frameNum, uint32_t slotNum, bool relative);
+/** @} LinkLayer_Utility*/
-
 
 #endif /* __LINK_LAYER_H_ */
+
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/link_layer_types.h

@@ -1,17 +1,19 @@
 /*****************************************************************************/
 /**
- * Description: A brief description of this file
+ * @file link_layer_types.h
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer types definition.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2022-08-28 22:53
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditTime: 2022-08-29 00:45
+ * Lab of Communication and Network
- * Revisions: Rev 0.0
- * History:
- * [2022-08-29]: Initial version.
- *
- * Copyright(c) 2022 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @defgroup LinkLayer
+ * @{
+ */
 
 #ifndef __LINK_LAYER_DEF_H_
 #define __LINK_LAYER_DEF_H_
@@ -22,7 +24,14 @@
 #include "geometry/coord.h"
 #include "geometry/quaternion.h"
 #include "../phy_layer/phy_layer.h"
+#ifndef EMULATION
+#include "../config/app_config.h"
+#endif
 /************************** Constant Definitions *****************************/
+/**
+ * @name Linklayer_Common_Constants
+ * @{
+ */
 // Common node ID definition
 #define L2_BROADCAST_ID 0xFF
 #define L2_NONE_ID 0
@@ -36,7 +45,7 @@
 #define L2_FRAMENO_NONE 0
 
 // Common number of slots definition
-#define L2_SLOTS_PER_FRAME 200
+#define L2_SLOTS_PER_FRAME 100
 #define L2_SLOTS_PER_SUBFRAME 20
 
 #define L2_NUM_SLOTS_NONE UINT32_MAX
@@ -45,9 +54,14 @@
 #define L2_NUM_SLOTS_10MS 2
 #define L2_NUM_SLOTS_5MS 1
 #define L2_NUM_SLOTS_SKIP 0
+/** @} Linklayer_Common_Constants*/
 
 /**************************** Type Definitions *******************************/
 
+/**
+ * @struct L2_RCD
+ * @brief Linklayer recode buffer
+ */
 typedef struct
 {
 	uint32_t last;
@@ -55,7 +69,8 @@ typedef struct
 	uint32_t next;
 } L2_RCD;
 
-/** @name Tx/Rx mode code
+/**
+ * @enum L2_TOR_TYPE
  */
 typedef enum
 {
@@ -64,7 +79,8 @@ typedef enum
 	L2_TOR_RX = 2
 } L2_TOR_TYPE;
 
-/** @name Prior information type definition
+/**
+ * @enum L2_NODE_TYPE
  */
 typedef enum
 {
@@ -74,7 +90,8 @@ typedef enum
 	L2_NODE_BACKUP = 3
 } L2_NODE_TYPE;
 
-/** @name Node state type definition
+/**
+ * @enum L2_NODE_STATE
  */
 typedef enum
 {
@@ -86,23 +103,24 @@ typedef enum
 	L2_SEEK_STATE = 5
 } L2_NODE_STATE;
 
-/** @name Node information type definition
+/**
- * The following types define the detail node info which needed by the link layer.
+ * @struct L2_NODE_INFO
+ * @brief Node information struct contains the detail node info which needed by the link layer.
  */
 typedef struct
 {
-	uint8_t nodeId;
+	uint8_t nodeId;		   ///< node ID
-	uint8_t clustId;
+	uint8_t clustId;	   ///< node cluster ID
-	uint8_t headId;
+	uint8_t headId;		   ///< cluster head ID
-	L2_NODE_TYPE nodeType;
+	L2_NODE_TYPE nodeType; ///< node type
-	uint8_t beamNo;
+	uint8_t beamNo;		   ///< beam number to this node
-	COORD pos;
+	COORD pos;			   ///< node position
-	COORD speed;
+	COORD speed;		   ///< node speed
-	QUATERNION attitude;
+	QUATERNION attitude;   ///< node attitude
 } L2_NODE_INFO;
 
-/** @name L2 event enum
+/**
- * A enum of L2 event types.
+ * @enum L2_EVENT_TYPE
  */
 typedef enum
 {
@@ -120,17 +138,18 @@ typedef enum
 	L2_ROUTINE_UPDATE = 11
 } L2_EVENT_TYPE;
 
-/** @name L2 event
+/**
- * A definition of L2 event instance.
+ * @struct L2_EVENT
+ * @brief Linklayer event instance
  */
 typedef struct
 {
-	L2_EVENT_TYPE event;
+	L2_EVENT_TYPE event; ///< event type
-	void *msg;
+	void *msg;			 ///< event message
 } L2_EVENT;
 
-/** @name Slot types
+/**
- * A definition of different slots.
+ * @enum L2_SLOT_TYPE
  */
 typedef enum
 {
@@ -142,8 +161,8 @@ typedef enum
 	L2_SLOT_SERVICE = 5,
 } L2_SLOT_TYPE;
 
-/** @name Frame types
+/**
- * A definition of different frame types.
+ * @enum L2_FRAME_TYPE
  */
 typedef enum
 {
@@ -154,8 +173,8 @@ typedef enum
 	L2_SVC_FRAME = 4
 } L2_FRAME_TYPE;
 
-/** @name Frame types
+/**
- * A definition of different frame types.
+ * @enum L2_CRC_TYPE
  */
 typedef enum
 {
@@ -165,17 +184,21 @@ typedef enum
 	L2_CRC8_31 = 3
 } L2_CRC_TYPE;
 
-/** @name Schedule subtable entry
+/**
- * A definition of Schedule subtable entry.
+ * @struct L2_RTNE_TABLE_ENTRY
+ * @brief Linklayer routine table entry
  */
 typedef struct
 {
-	L2_SLOT_TYPE slotType : 8;
+	L2_SLOT_TYPE slotType : 8; ///< slot type
-	uint8_t slotSeq;
+	uint8_t slotSeq;		   ///< slot sequence number
-	uint8_t src;
+	uint8_t src;			   ///< source node ID
-	uint8_t dst;
+	uint8_t dst;			   ///< destination node ID
 } L2_RTNE_TABLE_ENTRY;
 
+/**
+ * @enum SCAN_STAGE
+ */
 typedef enum
 {
 	L2_SCAN_NONE_STAGE = 0,
@@ -184,44 +207,56 @@ typedef enum
 	L2_SCAN_CFM_STAGE = 3
 } SCAN_STAGE;
 
-/** @name Scan procedure FSM
+/**
+ * @struct L2_SCAN_FSM
+ * @brief Linklayer scan process FSM instance
  */
 typedef struct
 {
-	bool isLocked;	// init acq done.
+	bool isLocked;		  ///< indicates if init acq done(beam locked).
-	bool isAdvRecvd; // bm received.
+	bool isAdvRecvd;	  ///< indicates if advertisement frame done(beam locked).
-	bool isAckPending;	// 2way acq done.
+	bool isAckPending;	  ///< indicates if confirm message acked
-	uint8_t scanCnt;
+	uint8_t scanCnt;	  ///< scan count
-	uint8_t beamNo;
+	uint8_t advTimeout;	  ///< adv receive try count
-	uint8_t advTimeout;
+	uint8_t cfmTimeout;	  ///< cmf receive try count
-	uint8_t cfmTimeout;
+	SCAN_STAGE scanStage; ///< scan stage \n
-	SCAN_STAGE scanStage;  // only for member node
+						  /// only for member node
+	uint8_t beamNo;		  ///< locked beam number
+	uint8_t tableNo;	  ///< scan table index
 } L2_SCAN_FSM;
 
-
+/**
-/** @name Service procedure FSM
+ * @struct L2_SVC_FSM
+ * @brief Linklayer service process FSM
  */
 typedef struct
 {
-	PAYLOAD rxLog;
+	uint32_t txCnt;	 ///< tx frame count
-	PAYLOAD txLog;
+	uint32_t rxCnt;	 ///< rx frame count
-	uint32_t pktRecv;
+	uint32_t rxdCnt; ///< received frame count
-	uint32_t pktCorrect;
 #ifdef DATALINK_ENABLE_BERTEST
-	uint32_t bitTotal;
+	uint32_t bitTotal; ///< received bits count
-	uint32_t bitError;
+	uint32_t bitError; ///< error bits count
+	double lossRate;   ///< packet loss rate
+	double errorRate;  ///< bit error rate
 #endif
 } L2_SVC_FSM;
 
+/**
+ * @struct L2_RTNE_CONFIG
+ * @brief Linklayer routine table configuration
+ */
 typedef struct
 {
-	L2_RTNE_TABLE_ENTRY **rtneTable;
+	L2_RTNE_TABLE_ENTRY **rtneTable; ///< routine table
-	uint32_t rtnePrd;
+	uint32_t rtnePrd;				 ///< period of routine table
-	L2_RTNE_TABLE_ENTRY *last;
+	L2_RTNE_TABLE_ENTRY *last;		 ///< last routine entry
-	L2_RTNE_TABLE_ENTRY *curr;
+	L2_RTNE_TABLE_ENTRY *curr;		 ///< curent routine entry
-	L2_RTNE_TABLE_ENTRY *next;
+	L2_RTNE_TABLE_ENTRY *next;		 ///< next routine entry
 } L2_RTNE_CONFIG;
 
 /************************** Variable Definitions *****************************/
 
 #endif /* __LINK_LAYER_DEF_H_ */
+
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/msg_def.h

@@ -1,17 +1,25 @@
 /*****************************************************************************/
 /**
- * Description: Header of 814 linklayer messages
+ * @file msg_def.c
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer message definition constants.
+ * @version 0.0
+ * @date 2023-05-06
  *
- * Date: 2022-07-14 00:08
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditTime: 2022-07-14 22:52
+ * Lab of Communication and Network
- * Revisions: Rev 0.0
- * History:
- * [2022-07-14]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @name LinkLayer_MSG_Constants
+ * @{
+ */
 #ifndef __L2_MSG_DEF_H_
 #define __L2_MSG_DEF_H_
 
@@ -79,6 +87,10 @@
 #define L2_MSG_CFM_SRC_SPEEDY_LEN 4
 #define L2_MSG_CFM_SRC_SPEEDZ 28
 #define L2_MSG_CFM_SRC_SPEEDZ_LEN 4
+#define L2_MSG_CFM_PAYLOAD_ID 32
+#define L2_MSG_CFM_PAYLOAD_ID_LEN 4
+#define L2_MSG_CFM_PAYLOAD 36
+#define L2_MSG_CFM_PAYLOAD_LEN 230
 #define L2_MSG_CFM_CRC 266
 #define L2_MSG_CFM_CRC_LEN 2
 
@@ -111,5 +123,8 @@
 #define L2_MSG_SVC_CRC 266
 #define L2_MSG_SVC_CRC_LEN 2
 
-
 #endif //__L2_MSG_DEF_H_
+
+/** @} LinkLayer_MSG_Constants*/
+
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/node_list.c

@@ -1,19 +1,25 @@
 /*****************************************************************************/
 /**
- * Description: Implementations of 814 linklayer local record.
+ * @file node_list.c
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer node list implementation file
+ * @version 0.0
+ * @date 2023-05-06
  *
- * Date: 2022-07-14 00:08
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditors: Fan Hao
+ * Lab of Communication and Network
- * LastEditTime: 2022-07-14 22:52
- * Revisions: Rev 0.0
- * History:
- * [2022-07-14]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
 
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayer_NodeList
+ * @{
+ */
 /***************************** Include Files *********************************/
 #include <stdlib.h>
 #include <string.h>
@@ -94,7 +100,7 @@ int32_t L2_NodeList_Init(NODE_LIST **list)
  * @brief   Clear all nodes in the node list, free allocated memory.
  *
  * @param   list
- *NONE
+ * @return NONE
  *
  ******************************************************************************/
 void L2_NodeList_Clear(NODE_LIST *list)
@@ -123,13 +129,17 @@ void L2_NodeList_Destroy(NODE_LIST *list)
  * @param   list
  * @param   nodeId
  *
- * @return  Node entry
+ * @return  Node entry \n
  *          NULL if node dose not exist.
  *
  ******************************************************************************/
 NODE_ENTRY *L2_GetNodeById(NODE_LIST *list, uint8_t nodeId)
 {
 	ASSERT(list != NULL);
+	if (nodeId == L2_BROADCAST_ID || nodeId == L2_NONE_ID)
+	{
+		return NULL;
+	}
 	util_entry.nodeInfo.nodeId = nodeId;
 	clist_node_t *node = clist_find(list, &util_entry);
 	if (node == NULL)
@@ -150,7 +160,7 @@ NODE_ENTRY *L2_GetNodeById(NODE_LIST *list, uint8_t nodeId)
  * @param   nodeId
  * @param   nodeType
  *
- * @return  SUCCESS Node was added successfully.
+ * @return  SUCCESS Node was added successfully.\n
  *          Other       Error occurred.(Node already exist, memory alloc error ect.)
  *
  ******************************************************************************/
@@ -197,7 +207,7 @@ NODE_ENTRY *L2_AppendNode(NODE_LIST *list, uint8_t nodeId, L2_NODE_TYPE nodeType
  * @param   list
  * @param   nodeId
  *
- * @return  SUCCESS Node has been successfully deleted.
+ * @return  SUCCESS Node has been successfully deleted.\n
  *          Other       Node not exist.
  *
  ******************************************************************************/
@@ -223,7 +233,7 @@ int32_t L2_DeleteNodeById(NODE_LIST *list, uint8_t nodeId)
  * @param   list
  * @param   nodeId
  *
- * @return  true node in the list
+ * @return  true node in the list\n
  *          false node not in the list
  *
  ******************************************************************************/
@@ -241,7 +251,7 @@ bool L2_isNodeInList(NODE_LIST *list, uint8_t nodeId)
  * @param   nodeId
  * @param	dst     A pointer to store distance.
  *
- * @return  SUCCESS distance has been successfully store in dst
+ * @return  SUCCESS distance has been successfully store in dst\n
  *          FAILURE Node dose not exit.
  *
  ******************************************************************************/
@@ -269,7 +279,7 @@ int32_t L2_GetDistance(NODE_LIST *list, COORD myCoord, uint8_t nodeId, double *d
  * @param   nodeId
  * @param   newPos A structure stores the corresponding node position info.
  *
- * @return  SUCCESS update successfully.
+ * @return  SUCCESS update successfully.\n
  *          FAILURE node not exist.
  *
  ******************************************************************************/
@@ -296,7 +306,7 @@ int32_t L2_UpdateNodePos(NODE_LIST *list, uint8_t nodeId, const COORD *newPos)
  * @param   nodeId
  * @param   newPos A structure stores the corresponding node position info.
  *
- * @return  SUCCESS update successfully.
+ * @return  SUCCESS update successfully.\n
  *          FAILURE node not exist.
  *
  ******************************************************************************/
@@ -323,7 +333,7 @@ int32_t L2_GetNodePos(NODE_LIST *list, uint8_t nodeId, COORD *pos)
  * @param   nodeId
  * @param   newSpeed A structure stores the corresponding node speed info.
  *
- * @return  SUCCESS update successfully.
+ * @return  SUCCESS update successfully.\n
  *          FAILURE node not exist.
  *
  ******************************************************************************/
@@ -350,7 +360,7 @@ int32_t L2_UpdateNodeSpeed(NODE_LIST *list, uint8_t nodeId, const COORD *newSpee
  * @param   nodeId
  * @param   newSpeed A structure stores the corresponding node speed info.
  *
- * @return  SUCCESS update successfully.
+ * @return  SUCCESS update successfully.\n
  *          FAILURE node not exist.
  *
  ******************************************************************************/
@@ -376,7 +386,7 @@ int32_t L2_GetNodeSpeed(NODE_LIST *list, uint8_t nodeId, COORD *speed)
  * @param   nodeId
  * @param   devi
  *
- * @return  SUCCESS update successfully.
+ * @return  SUCCESS update successfully.\n
  *          FAILURE Node not exist.
  *
  ******************************************************************************/
@@ -428,7 +438,7 @@ int32_t L2_IncNodeTTL(NODE_LIST *list, uint8_t nodeId, uint32_t inc)
  * @param   list
  * @param   nodeId
  *
- * @return  SUCCESS TTL has been successfully cleared.
+ * @return  SUCCESS TTL has been successfully cleared.\n
  *          FAILURE Node not exist.
  *
  ******************************************************************************/
@@ -482,7 +492,7 @@ int32_t L2_GetNodeTTL(NODE_LIST *list, uint8_t nodeId, uint32_t *ttl)
  * @param   operation  A pointer to a function handled "NODE_ENTRY*" as input
  *                  which defines the operations need to be apply.
  *
- * @return SUCCESS Operations has been applied successfully to all nodes.
+ * @return SUCCESS Operations has been applied successfully to all nodes.\n
  *         Other       Error occurred.
  *
  ******************************************************************************/
@@ -541,3 +551,7 @@ int32_t L2_IterDeleteNode(NODE_LIST *list, bool (*condition)(NODE_ENTRY *))
 	clist_iterator_destroy(iter);
 	return SUCCESS;
 }
+
+/** @} LinkLayer_NodeList*/
+
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/node_list.h

@@ -1,19 +1,27 @@
 /*****************************************************************************/
 /**
- * Description: Header of 814 linklayer local record.
+ * @file node_list.h
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer node list header file
+ * @version 0.0
+ * @date 2023-05-06
  *
- * Date: 2022-07-14 00:08
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditors: Fan Hao
+ * Lab of Communication and Network
- * LastEditTime: 2022-07-14 22:52
- * Revisions: Rev 0.0
- * History:
- * [2022-07-14]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
 
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @defgroup LinkLayer_NodeList
+ * @{
+ */
+
+
 /***************************** Include Files *********************************/
 #ifndef NODE_LIST_H_
 #define NODE_LIST_H_
@@ -29,7 +37,11 @@
 /************************** Constant Definitions *****************************/
 /***************** Macros (Inline Functions) Definitions *********************/
 /**************************** Type Definitions *******************************/
-typedef struct NODE_LIST_ENTRY
+/**
+ * @struct NODE_ENTRY
+ * @brief Linklayer discovered node list node entry
+ */
+typedef struct
 {
 	L2_NODE_INFO nodeInfo;
 	uint32_t ttlCnt;
@@ -62,3 +74,6 @@ int32_t L2_IterEditNode(NODE_LIST *list, const void *param, int32_t (*operation)
 int32_t L2_IterDeleteNode(NODE_LIST *list, bool (*condition)(NODE_ENTRY *));
 
 #endif /* NODE_LIST_H_ */
+
+/** @} LinkLayer_NodeList*/
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/routine_table.c

@@ -1,17 +1,26 @@
 /*****************************************************************************/
 /**
- * Description: Time allocations for df datalink,
+ * @file routine_table.c
- * Date: 2022-07-16 17:05
+ * @author FanHao ([email protected])
- * LastEditTime: 2022-07-16 17:05
+ * @brief DF Linklayer node list implementation file
- * Revisions: Rev 0.1
+ * @version 0.0
- * History:
+ * @date 2023-05-06
- * [2021-11-13]: Initial version.
  *
- * Copyright(c) 2021 Beijing Institute of Technology.
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * Lab of Communication and Networking
+ * Lab of Communication and Network
  *
  ******************************************************************************/
 
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @name RoutineTable
+ * @{
+ */
+
 #include <inttypes.h>
 #include "link_layer.h"
 #include "link_layer_types.h"
@@ -38,6 +47,7 @@ L2_RTNE_TABLE_ENTRY intraScanSubT[L2_SLOTS_PER_FRAME] = {
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x00, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
+
 // SubFrame 1
 	{L2_SLOT_SCAN, 0x00, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
@@ -59,6 +69,7 @@ L2_RTNE_TABLE_ENTRY intraScanSubT[L2_SLOTS_PER_FRAME] = {
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x00, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
+
 // SubFrame 2
 	{L2_SLOT_SCAN, 0x00, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
@@ -80,6 +91,7 @@ L2_RTNE_TABLE_ENTRY intraScanSubT[L2_SLOTS_PER_FRAME] = {
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x00, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
+
 // SubFrame 3
 	{L2_SLOT_SCAN, 0x00, 0x01, 0xFF},
 	{L2_SLOT_SCAN, 0x01, 0x01, 0xFF},
@@ -101,132 +113,28 @@ L2_RTNE_TABLE_ENTRY intraScanSubT[L2_SLOTS_PER_FRAME] = {
 	{L2_SLOT_ADVERTISE, 0x03, 0x01, 0xFF},
 	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
+
 // SubFrame 4
 	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
 	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
 	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
 	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
 	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
 	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
 	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
 	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
 	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
 	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
 	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
 	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
 	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-// SubFrame 5
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-// SubFrame 6
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-// SubFrame 7
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-// SubFrame 8
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-// SubFrame 9
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x01, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x02, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x03, 0xFF, 0x01},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x00, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x01, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x02, 0x01, 0xFF},
-	{L2_SLOT_CONFIRM, 0x03, 0x01, 0xFF},
 };
 
 L2_RTNE_TABLE_ENTRY normalSub[L2_SLOTS_PER_FRAME] = {
@@ -235,220 +143,110 @@ L2_RTNE_TABLE_ENTRY normalSub[L2_SLOTS_PER_FRAME] = {
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
 
 // SubFrame 1
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 
 // SubFrame 2
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
 
 // SubFrame 3
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 
 // SubFrame 4
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
 	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
 	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
 	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
+	{L2_SLOT_IDLE, 0x00, 0x00, 0x00},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-
-// SubFrame 5
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-
-// SubFrame 6
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-
-// SubFrame 7
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-
-// SubFrame 8
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-
-// SubFrame 9
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x00, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x01, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x02, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x03, 0x01, 0x02},
-	{L2_SLOT_SERVICE, 0x00, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x01, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x02, 0x02, 0x01},
-	{L2_SLOT_SERVICE, 0x03, 0x02, 0x01},
 };
 
 L2_RTNE_TABLE_ENTRY *initTable[L2_INIT_RTNE_PERIOD] =
@@ -460,3 +258,6 @@ L2_RTNE_TABLE_ENTRY *normalTable[L2_NORMAL_RTNE_PERIOD] =
 {
 	normalSub
 };
+
+/** @} RoutineTable*/
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/scan.c

@@ -1,18 +1,24 @@
 /*****************************************************************************/
 /**
- * Description: Implementations of df linklayer scan net.
+ * @file scan.c
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer scan implementation file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2021-11-10 19:04
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditTime: 2022-07-16 17:04
+ * Lab of Communication and Network
- * Revisions: Rev 0.1
- * History:
- * [2022-07-16]: New branch for DiJian.
- * [2021-11-10]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayer_Scan
+ * @{
+ */
 
 /***************************** Include Files *********************************/
 #include <string.h>
@@ -26,15 +32,97 @@
 
 /************************** Constant Definitions *****************************/
 #define ADV_LISTEN_TIMEOUT 40
-#define CFM_LISTEN_TIMEOUT 25
+#define CFM_LISTEN_TIMEOUT 5
 #define ADV_FRAME_SLOTS 4
-#define CFM_FRAME_SLOTS 4
+#define CFM_FRAME_SLOTS 5
 /***************** Macros (In-line Functions) Definitions *********************/
 
 /**************************** Type Definitions *******************************/
 
 /************************** Variable Definitions *****************************/
+// Pair by regex
+// Regex: ((\{\.oaxis = [0-9]+[ ,]+\.raxis = [0-9]+[ ]*\}, ){2})
+PHY_ANT_ANGLE antNrrwPattern_0[L1_NUM_ANT_NRRW_PATTERN] =
+{
+	{.oaxis = 0  , .raxis = 0   },
+	{.oaxis = 139, .raxis = 2225},
+	{.oaxis = 152, .raxis = 850 },
+	{.oaxis = 138, .raxis = 3155},
+	{.oaxis = 159, .raxis = 1680},
+	{.oaxis = 168, .raxis = 285 },
+	{.oaxis = 195, .raxis = 2630},
+	{.oaxis = 211, .raxis = 1204},
+	{.oaxis = 225, .raxis = 3429},
+	{.oaxis = 249, .raxis = 2022},
+	{.oaxis = 272, .raxis = 629 },
+	{.oaxis = 265, .raxis = 2934},
+	{.oaxis = 277, .raxis = 1499},
+	{.oaxis = 289, .raxis = 124 },
+	{.oaxis = 300, .raxis = 2349},
+	{.oaxis = 311, .raxis = 959 },
+	{.oaxis = 321, .raxis = 3199},
+	{.oaxis = 331, .raxis = 1824},
+	{.oaxis = 341, .raxis = 389 },
+	{.oaxis = 351, .raxis = 2674},
+	{.oaxis = 360, .raxis = 1268},
+	{.oaxis = 364, .raxis = 3483},
+	{.oaxis = 378, .raxis = 2118},
+	{.oaxis = 387, .raxis = 733 },
+	{.oaxis = 416, .raxis = 3028},
+	{.oaxis = 404, .raxis = 1623},
+	{.oaxis = 433, .raxis = 248 },
+	{.oaxis = 421, .raxis = 2473},
+	{.oaxis = 429, .raxis = 1098},
+	{.oaxis = 437, .raxis = 3303},
+	{.oaxis = 445, .raxis = 1948},
+	{.oaxis = 443, .raxis = 543 },
+	{.oaxis = 450, .raxis = 2828},
+	{.oaxis = 448, .raxis = 1422},
+	{.oaxis = 455, .raxis = 47  },
+	{.oaxis = 453, .raxis = 2272},
+	{.oaxis = 450, .raxis = 897 }
+};
 
+PHY_ANT_ANGLE antNrrwPattern_1[L1_NUM_ANT_NRRW_PATTERN] =
+{
+	{.oaxis = 0  , .raxis = 0   },
+	{.oaxis = 139, .raxis = 1155},
+	{.oaxis = 152, .raxis = 3380},
+	{.oaxis = 138, .raxis = 2085},
+	{.oaxis = 159, .raxis = 610 },
+	{.oaxis = 168, .raxis = 2815},
+	{.oaxis = 195, .raxis = 1560},
+	{.oaxis = 211, .raxis = 134 },
+	{.oaxis = 225, .raxis = 2359},
+	{.oaxis = 249, .raxis = 952 },
+	{.oaxis = 272, .raxis = 3159},
+	{.oaxis = 265, .raxis = 1864},
+	{.oaxis = 277, .raxis = 429 },
+	{.oaxis = 289, .raxis = 2654},
+	{.oaxis = 300, .raxis = 1279},
+	{.oaxis = 311, .raxis = 3489},
+	{.oaxis = 321, .raxis = 2129},
+	{.oaxis = 331, .raxis = 754 },
+	{.oaxis = 341, .raxis = 2919},
+	{.oaxis = 351, .raxis = 1604},
+	{.oaxis = 360, .raxis = 198 },
+	{.oaxis = 364, .raxis = 2413},
+	{.oaxis = 378, .raxis = 1048},
+	{.oaxis = 387, .raxis = 3263},
+	{.oaxis = 416, .raxis = 1958},
+	{.oaxis = 404, .raxis = 553 },
+	{.oaxis = 433, .raxis = 2778},
+	{.oaxis = 421, .raxis = 1403},
+	{.oaxis = 429, .raxis = 28  },
+	{.oaxis = 437, .raxis = 2233},
+	{.oaxis = 445, .raxis = 878 },
+	{.oaxis = 443, .raxis = 3073},
+	{.oaxis = 450, .raxis = 1758},
+	{.oaxis = 448, .raxis = 352 },
+	{.oaxis = 455, .raxis = 2577},
+	{.oaxis = 453, .raxis = 1202},
+	{.oaxis = 450, .raxis = 3427},
+};
 /************************** Function Prototypes ******************************/
 static void LockStateUpdate(L2_SCAN_FSM *scanFsmPtr, bool state);
 static void AdvRecvStateUpdate(L2_SCAN_FSM *scanFsmPtr, bool state);
@@ -112,20 +200,38 @@ static void StageUpdate(L2_SCAN_FSM *scanFsmPtr, SCAN_STAGE newStage)
 static int32_t Scan_InitScanHandler(L2_INST *instPtr)
 {
 	ASSERT(instPtr != NULL);
+	PHY_INST *phyRef = instPtr->config.phyInstPtr;
 	L2_SCAN_FSM *scanFsmPtr = instPtr->scanFSM;
 	DBG_INFO("** Net-Setup - InitScan Procedure (Attempts: %" PRIu8 ")**\n", scanFsmPtr->scanCnt);
 
+	if (scanFsmPtr->scanCnt == 0)
+	{
+		// Update scan beam table
+		L2_Scan_RefreashScanTable(instPtr);
+	}
+	else if (Phy_IsFrameDetected(phyRef))
+	{
+		// last scan beam number
+		scanFsmPtr->beamNo = Phy_LastScanBeamNo(phyRef);
+		// Update scan beam table
+		L2_Scan_RefreashScanTable(instPtr);
+	}
+
 	if (scanFsmPtr->isLocked == true)
 	{
-		StageUpdate(scanFsmPtr, L2_SCAN_ADV_STAGE);
+		scanFsmPtr->beamNo = Phy_LastScanBeamNo(phyRef);
-		/* Antenna setting (reserved.) */
+		Phy_SetBeamNo(phyRef, scanFsmPtr->beamNo, PHY_ANT_BEAM_16);
 		L2_SetupNextSlot(instPtr, L2_TOR_RX, L2_ADV_FRAME);
+		StageUpdate(scanFsmPtr, L2_SCAN_ADV_STAGE);
+		instPtr->log.lastBeamWidth = PHY_ANT_BEAM_16;
 	} /* Otherwise remain L2_SCAN_INIT_STAGE */
 	else
 	{
-		/* Antenna setting (reserved.) */
+		/* Antenna steering (reserved, automatically accomplished by physical layer) */
+		Phy_SetBeamNo(phyRef, scanFsmPtr->beamNo, PHY_ANT_BEAM_16);
 		L2_SetupNextSlot(instPtr, L2_TOR_RX, L2_SCAN_FRAME);
 		scanFsmPtr->scanCnt++;
+		instPtr->log.lastBeamWidth = PHY_ANT_BEAM_16;
 	}
 	return SUCCESS;
 }
@@ -143,16 +249,22 @@ static int32_t Scan_InitScanHandler(L2_INST *instPtr)
  ******************************************************************************/
 static int32_t Scan_AdvHandler(L2_INST *instPtr)
 {
+	ASSERT(instPtr != NULL);
 	L2_SCAN_FSM *scanFsmPtr = instPtr->scanFSM;
+	PHY_INST *phyRef = instPtr->config.phyInstPtr;
 	DBG_INFO("** Net-Setup - Advertisement Procedure (Timeout: %" PRIu8 ") **\n", scanFsmPtr->advTimeout);
 
 	// if received a valid bm frame.
 	if (scanFsmPtr->isAdvRecvd == true)
 	{
-		scanFsmPtr->advTimeout = 0; /* reset listen counter. */
+		// last scan beam number
-		DBG_INFO("Received Adv frame, skipping 10ms for turn around...\n");
+		scanFsmPtr->beamNo = Phy_LastScanBeamNo(phyRef);
-		// TODO: check functionality.
+		// reset listen counter.
+		scanFsmPtr->advTimeout = 0;
+
+		// Update scan stage
 		StageUpdate(scanFsmPtr, L2_SCAN_CFM_STAGE);
+		DBG_INFO("Received Adv frame, skipping 10ms for turn around...\n");
 		return SUCCESS;
 	}
 	// no valid bm frame was received.
@@ -161,16 +273,20 @@ static int32_t Scan_AdvHandler(L2_INST *instPtr)
 		/* if time out reached, go back to init scan stage. */
 		if (scanFsmPtr->advTimeout > ADV_LISTEN_TIMEOUT)
 		{
-			/* Antenna setting (reserved.) */
+			/* Antenna steering (reserved, automatically accomplished by physical layer) */
+			Phy_SetBeamNo(phyRef, scanFsmPtr->beamNo, PHY_ANT_BEAM_16);
 			L2_SetupNextSlot(instPtr, L2_TOR_RX, L2_SCAN_FRAME);
 			DBG_WARNING("Adv timeout, restart net scan from L2_SCAN_INIT_STAGE.\n");
 			L2_Scan_Reset(scanFsmPtr);
+			instPtr->log.lastBeamWidth = PHY_ANT_BEAM_16;
 		}
 		else
 		{
-			/* Antenna setting (reserved.) */
+			/* Antenna steering (reserved, automatically accomplished by physical layer) */
+			Phy_SetBeamNo(phyRef, scanFsmPtr->beamNo, PHY_ANT_BEAM_16);
 			L2_SetupNextSlot(instPtr, L2_TOR_RX, L2_ADV_FRAME);
 			scanFsmPtr->advTimeout++;
+			instPtr->log.lastBeamWidth = PHY_ANT_BEAM_16;
 		}
 		return SUCCESS;
 	}
@@ -187,7 +303,9 @@ static int32_t Scan_AdvHandler(L2_INST *instPtr)
  ******************************************************************************/
 static int32_t Scan_CfmHandler(L2_INST *instPtr)
 {
+	ASSERT(instPtr != NULL);
 	L2_SCAN_FSM *scanFsmPtr = instPtr->scanFSM;
+	PHY_INST *phyRef = instPtr->config.phyInstPtr;
 	DBG_INFO("** Net-Setup - Confirm Procedure (Timeout: %" PRIu8 ") **\n", scanFsmPtr->cfmTimeout);
 
 	// 2 way acq failed, back to init stage.
@@ -201,9 +319,12 @@ static int32_t Scan_CfmHandler(L2_INST *instPtr)
 	{
 		// using pull mode to receive confirm frame
 		// since first time sync procedure is accomplished in ADV stage.
-		Phy_SetMode(instPtr->config.phyInstPtr, PHY_MODE_PULL);
+		Phy_SetBeamWidth(phyRef, PHY_ANT_BEAM_16);
+		Phy_SetBeamNo(phyRef, scanFsmPtr->beamNo, PHY_ANT_BEAM_16);
+		Phy_SetMode(phyRef, PHY_MODE_PULL);
 		L2_SetupNextSlot(instPtr, L2_TOR_RX, L2_CFM_FRAME);
 		scanFsmPtr->cfmTimeout++; // increase counter.
+		instPtr->log.lastBeamWidth = PHY_ANT_BEAM_16;
 	}
 	return SUCCESS;
 }
@@ -225,12 +346,13 @@ static int32_t ScanMsg_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 	int32_t Status;
 	uint32_t dataChunk;
 	uint8_t *buff = instPtr->sendPktData;
-	if(type < L2_ADV_FRAME || type > L2_CFM_FRAME) 
+	if (type < L2_ADV_FRAME || type > L2_CFM_FRAME)
 	{
 		DBG_ERROR("Unexpected frame type: %" PRId8 ".\n", type);
 		return EPARAM;
 	}
 
+	// Common section of link layer package
 	dataChunk = L2_GetNextFrameNum(instPtr);
 	L2_FrameInsertChunk(buff, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &dataChunk);
 	dataChunk = L2_GetNextSlotNum(instPtr);
@@ -278,6 +400,23 @@ static int32_t ScanMsg_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 		L2_FrameInsertChunk(buff, L2_MSG_CFM_SRC_SPEEDY, L2_MSG_CFM_SRC_SPEEDY_LEN, &(instPtr->sysInfo.vY));
 		L2_FrameInsertChunk(buff, L2_MSG_CFM_SRC_SPEEDZ, L2_MSG_CFM_SRC_SPEEDZ_LEN, &(instPtr->sysInfo.vZ));
 
+		// Packing extra payload
+		uint32_t dataId;
+		if (L2_GetNodeType(instPtr) == L2_NODE_HEAD)
+		{
+			SysMonitor_GetSendPayload(buff + L2_MSG_CFM_PAYLOAD, &dataId, PAYLOAD_LEN_FLJ_TX);
+		}
+		else
+		{
+			SysMonitor_GetSendPayload(buff + L2_MSG_CFM_PAYLOAD, &dataId, PAYLOAD_LEN_LJ_TX);
+		}
+
+		L2_FrameInsertChunk(buff, L2_MSG_CFM_PAYLOAD_ID, L2_MSG_CFM_PAYLOAD_ID_LEN, &dataId);
+		if (dataId == DATA_ID_NONE)
+		{
+			memset(buff + L2_MSG_CFM_PAYLOAD, 0xAA, L2_MSG_CFM_PAYLOAD_LEN);
+		}
+
 		// Append CRC
 		Status = L2_CrcAppend(buff, L2_CMF_PACK_LEN - L2_MSG_CFM_CRC_LEN, L2_MSG_CFM_CRC, L2_CRC16_1021);
 		if (Status != SUCCESS)
@@ -285,6 +424,10 @@ static int32_t ScanMsg_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 			DBG_ERROR("Fail to append CRC, error code: %" PRId32 ".\n", Status);
 			return Status;
 		}
+
+		// Logging...
+		memcpy(instPtr->log.txLog.data, buff, L2_CMF_PACK_LEN);
+		instPtr->log.txLog.dataId = dataId;
 		break;
 	}
 	default:
@@ -296,68 +439,11 @@ static int32_t ScanMsg_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 	return SUCCESS;
 }
 
-/*****************************************************************************/
-/**
- * @brief   Initialize scan FSM.
- *
- * @param   instPtr
- *
- * @return
- *
- ******************************************************************************/
-int32_t L2_Scan_Init(L2_SCAN_FSM **scanFSMPtr)
-{
-	ASSERT(scanFSMPtr != NULL);
-	*scanFSMPtr = (L2_SCAN_FSM *)malloc(sizeof(L2_SCAN_FSM));
-	if (*scanFSMPtr == NULL)
-	{
-		DBG_ERROR("Failed to allocate memory for scanFsmPtr.\n");
-		return ENOMEM;
-	}
-	L2_Scan_Reset(*scanFSMPtr);
-	return SUCCESS;
-}
-
-/*****************************************************************************/
-/**
- * @brief  Reset ScanNet FSM
- *
- * @param   scanFsmPtr a pointer to scan net  finite state machine
- *
- * @return  NONE
- *
- ******************************************************************************/
-void L2_Scan_Reset(L2_SCAN_FSM *scanFSMPtr)
-{
-	ASSERT(scanFSMPtr != NULL);
-	scanFSMPtr->isLocked = false;
-	scanFSMPtr->isAdvRecvd = false;
-	scanFSMPtr->isAckPending = false;
-	scanFSMPtr->scanCnt = 0;
-	scanFSMPtr->beamNo = 0;
-	scanFSMPtr->advTimeout = 0;
-	scanFSMPtr->cfmTimeout = 0;
-	scanFSMPtr->scanStage = L2_SCAN_NONE_STAGE;
-}
-
-/*****************************************************************************/
-/**
- * @brief  Destroy ScanNet FSM, free memory
- *
- * @param   scanFsmPtr a pointer to scan net  finite state machine
- *
- * @return  NONE
- *
- ******************************************************************************/
-void L2_Scan_Destroy(L2_SCAN_FSM *scanFSMPtr)
-{
-	free(scanFSMPtr);
-}
-
 /*****************************************************************************/
 /**
  * @brief   Scan net packet handler.
  *
+ * @param   instPtr	a pointer to linklayer layer instance
  * @param   msg A pointer to frame data buffer.
  *
  * @return
@@ -369,15 +455,19 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 	ASSERT(msg != NULL);
 	int32_t Status;
 	L2_SCAN_FSM *scanFsmPtr = instPtr->scanFSM;
-	L2_FRAME_TYPE frameType = L2_GetLastOptFrameType(instPtr);
+	L2_FRAME_TYPE frameType = L2_NONE_FRAME;
+	L2_FrameGetChunk(msg, L2_MSG_TYPE, L2_MSG_TYPE_LEN, &frameType);
 	switch (frameType)
 	{
 	case L2_SCAN_FRAME:
-		LockStateUpdate(scanFsmPtr, true);
-		StageUpdate(scanFsmPtr, L2_SCAN_ADV_STAGE);
 	case L2_ADV_FRAME:
 	{
-		if (instPtr->config.myType == L2_NODE_HEAD)
+		if (L2_GetLastOptFrameType(instPtr) == L2_SCAN_FRAME)
+		{
+			LockStateUpdate(scanFsmPtr, true);
+			StageUpdate(scanFsmPtr, L2_SCAN_ADV_STAGE);
+		}
+		if (L2_GetNodeType(instPtr) == L2_NODE_HEAD)
 		{
 			DBG_ERROR("Unexpected call from head node, only member Node can handle L2_SCAN_FRAME and L2_ADV_FRAME.\n");
 			Status = EUNEXP;
@@ -390,7 +480,7 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 		if (node == NULL)
 		{
 			node = L2_AppendNode(instPtr->nodeList, nodeId, L2_NODE_MEMBER);
-			if(node == NULL) 
+			if (node == NULL)
 			{
 				DBG_ERROR("Failed to append new node [id: %" PRId8 "]", nodeId);
 				Status = ENOMEM;
@@ -400,18 +490,17 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 		// Update node info.
 		float nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_ADV_SRC_POSX, L2_MSG_ADV_SRC_POSX_LEN, &nodePos);
-		node->nodeInfo.pos.x = (double) nodePos;
+		node->nodeInfo.pos.x = (double)nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_ADV_SRC_POSY, L2_MSG_ADV_SRC_POSY_LEN, &nodePos);
-		node->nodeInfo.pos.y = (double) nodePos;
+		node->nodeInfo.pos.y = (double)nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_ADV_SRC_POSZ, L2_MSG_ADV_SRC_POSZ_LEN, &nodePos);
-		node->nodeInfo.pos.z = (double) nodePos;
+		node->nodeInfo.pos.z = (double)nodePos;
+		node->nodeInfo.beamNo = Phy_LastScanBeamNo(instPtr->config.phyInstPtr);
 
 		// Reset node ttl
 		node->ttlCnt = 0;
 
-		if (L2_isCxn2Net(instPtr) == false)
+		uint32_t netstartTime;
-		{
-			uint32_t netstartTime, frameNum, slotNum = 0;
 		// Update net start time.
 		L2_FrameGetChunk(msg, L2_MSG_ADV_SRC_NETSTART_TIME, L2_MSG_ADV_SRC_NETSTART_TIME_LEN, &netstartTime);
 		L2_EVENT netSetupDoneEvent = {
@@ -419,12 +508,20 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 			.msg = &netstartTime};
 		AssertL2Event(instPtr, &netSetupDoneEvent);
 
-			// Time sync.
+		// Calculate time deviation
+		uint32_t frameNum, slotNum = 0;
 		L2_FrameGetChunk(msg, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &frameNum);
 		L2_FrameGetChunk(msg, L2_MSG_SLOT_NUM, L2_MSG_SLOT_NUM_LEN, &slotNum);
-			// TODO: Check
+		Status = L2_GetTimeDeviation(instPtr, frameNum, slotNum, true, &(instPtr->log.timeDev));
-			L2_TimeAlign(instPtr, frameNum, slotNum, true);
+		if (Status != SUCCESS)
+		{
+			DBG_ERROR("Failed to compute time deviation.\n")
+			break;
 		}
+
+		// Time sync.
+		L2_TimeAdjust(instPtr, &(instPtr->log.timeDev));
+
 		// trigger flag
 		AdvRecvStateUpdate(scanFsmPtr, true);
 		Status = SUCCESS;
@@ -439,7 +536,7 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 		if (node == NULL)
 		{
 			node = L2_AppendNode(instPtr->nodeList, nodeId, L2_NODE_MEMBER);
-			if(node == NULL) 
+			if (node == NULL)
 			{
 				DBG_ERROR("Failed to append new node [id: %" PRId8 "]", nodeId);
 				Status = ENOMEM;
@@ -449,22 +546,33 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 		// Update node info.
 		float nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_CFM_SRC_POSX, L2_MSG_CFM_SRC_POSX_LEN, &nodePos);
-		node->nodeInfo.pos.x = (double) nodePos;
+		node->nodeInfo.pos.x = (double)nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_CFM_SRC_POSY, L2_MSG_CFM_SRC_POSY_LEN, &nodePos);
-		node->nodeInfo.pos.y = (double) nodePos;
+		node->nodeInfo.pos.y = (double)nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_CFM_SRC_POSZ, L2_MSG_CFM_SRC_POSZ_LEN, &nodePos);
-		node->nodeInfo.pos.z = (double) nodePos;
+		node->nodeInfo.pos.z = (double)nodePos;
 		float nodeSpeed;
 		L2_FrameGetChunk(msg, L2_MSG_CFM_SRC_SPEEDX, L2_MSG_CFM_SRC_SPEEDX_LEN, &nodeSpeed);
-		node->nodeInfo.speed.x = (double) nodePos;
+		node->nodeInfo.speed.x = (double)nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_CFM_SRC_SPEEDY, L2_MSG_CFM_SRC_SPEEDY_LEN, &nodeSpeed);
-		node->nodeInfo.speed.y = (double) nodePos;
+		node->nodeInfo.speed.y = (double)nodePos;
 		L2_FrameGetChunk(msg, L2_MSG_CFM_SRC_SPEEDZ, L2_MSG_CFM_SRC_SPEEDZ_LEN, &nodeSpeed);
-		node->nodeInfo.speed.z = (double) nodePos;
+		node->nodeInfo.speed.z = (double)nodePos;
 
 		// Reset node ttl
 		node->ttlCnt = 0;
 
+		// Calculate time deviation
+		uint32_t frameNum, slotNum = 0;
+		L2_FrameGetChunk(msg, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &frameNum);
+		L2_FrameGetChunk(msg, L2_MSG_SLOT_NUM, L2_MSG_SLOT_NUM_LEN, &slotNum);
+		Status = L2_GetTimeDeviation(instPtr, frameNum, slotNum, true, &(instPtr->log.timeDev));
+		if (Status != SUCCESS)
+		{
+			DBG_ERROR("Failed to compute time deviation.\n")
+			break;
+		}
+
 		if (L2_GetNodeType(instPtr) != L2_NODE_HEAD)
 		{
 			// check if net setup finished.
@@ -501,7 +609,27 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 				l2Event.msg = &newState;
 				AssertL2Event(instPtr, &l2Event);
 			}
+			// Time sync.
+			L2_TimeAdjust(instPtr, &(instPtr->log.timeDev));
 		}
+
+		// Get data payload
+		uint32_t dataId;
+		L2_FrameGetChunk(msg, L2_MSG_CFM_PAYLOAD_ID, L2_MSG_CFM_PAYLOAD_ID_LEN, &dataId);
+
+		if (L2_GetNodeType(instPtr) == L2_NODE_HEAD)
+		{
+			SysMonitor_UpdateRecvPayload(msg + L2_MSG_CFM_PAYLOAD, dataId, PAYLOAD_LEN_FLJ_RX);
+		}
+		else
+		{
+			SysMonitor_UpdateRecvPayload(msg + L2_MSG_CFM_PAYLOAD, dataId, PAYLOAD_LEN_LJ_RX);
+		}
+
+		// Logging...
+		memcpy(instPtr->log.rxLog.data, msg, L2_CMF_PACK_LEN);
+		instPtr->log.rxLog.dataId = dataId;
+
 		Status = SUCCESS;
 		break;
 	}
@@ -513,6 +641,90 @@ int32_t L2_Scan_PktHandler(L2_INST *instPtr, uint8_t *msg)
 	return Status;
 }
 
+/*****************************************************************************/
+/**
+ * @brief   Initialize scan FSM.
+ *
+ * @param   instPtr
+ *
+ * @return
+ *
+ ******************************************************************************/
+int32_t L2_Scan_Init(L2_SCAN_FSM **scanFSMPtr)
+{
+	ASSERT(scanFSMPtr != NULL);
+	*scanFSMPtr = (L2_SCAN_FSM *)malloc(sizeof(L2_SCAN_FSM));
+	if (*scanFSMPtr == NULL)
+	{
+		DBG_ERROR("Failed to allocate memory for scanFsmPtr.\n");
+		return ENOMEM;
+	}
+	L2_Scan_Reset(*scanFSMPtr);
+	(*scanFSMPtr)->beamNo = 0;
+	(*scanFSMPtr)->tableNo = 0;
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief  Reset ScanNet FSM
+ *
+ * @param   scanFsmPtr a pointer to scan net  finite state machine
+ *
+ * @return  NONE
+ *
+ ******************************************************************************/
+void L2_Scan_Reset(L2_SCAN_FSM *scanFSMPtr)
+{
+	ASSERT(scanFSMPtr != NULL);
+	scanFSMPtr->isLocked = false;
+	scanFSMPtr->isAdvRecvd = false;
+	scanFSMPtr->isAckPending = false;
+	scanFSMPtr->scanCnt = 0;
+	scanFSMPtr->advTimeout = 0;
+	scanFSMPtr->cfmTimeout = 0;
+	scanFSMPtr->scanStage = L2_SCAN_NONE_STAGE;
+}
+
+/*****************************************************************************/
+/**
+ * @brief  Destroy ScanNet FSM, free memory
+ *
+ * @param   scanFsmPtr a pointer to scan net  finite state machine
+ *
+ * @return  NONE
+ *
+ ******************************************************************************/
+void L2_Scan_Destroy(L2_SCAN_FSM *scanFSMPtr)
+{
+	free(scanFSMPtr);
+}
+
+/*****************************************************************************/
+/**
+ * @brief  Refresh scan beam table.
+ *
+ * @param   instPtr	a pointer to linklayer layer instance
+ *
+ * @return  NONE
+ *
+ ******************************************************************************/
+void L2_Scan_RefreashScanTable(L2_INST *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	L2_SCAN_FSM *scanFsmPtr = instPtr->scanFSM;
+	PHY_INST *phyRef = instPtr->config.phyInstPtr;
+	if (scanFsmPtr->tableNo == 0)
+	{
+		Phy_SetBeamTable(phyRef, antNrrwPattern_0, scanFsmPtr->beamNo);
+		scanFsmPtr->tableNo = 1;
+	}
+	else
+	{
+		Phy_SetBeamTable(phyRef, antNrrwPattern_1, scanFsmPtr->beamNo);
+		scanFsmPtr->tableNo = 0;
+	}
+}
 
 /*****************************************************************************/
 /**
@@ -572,6 +784,8 @@ int32_t L2_Scan_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *rtneEntry)
 	ASSERT(instPtr != NULL);
 	L2_TOR_TYPE torState;
 	int32_t Status;
+	const NODE_ENTRY *commNode;
+	PHY_INST *phyRef = instPtr->config.phyInstPtr;
 	DBG_INFO("-------- Scan Routine --------\n");
 
 	if (rtneEntry->slotSeq != 0)
@@ -584,15 +798,25 @@ int32_t L2_Scan_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *rtneEntry)
 		if (rtneEntry->dst == L2_GetNodeId(instPtr) || rtneEntry->dst == L2_BROADCAST_ID)
 		{
 			torState = L2_TOR_RX;
+			commNode = L2_GetNodeById(instPtr->nodeList, rtneEntry->src);
 		}
 		else if (rtneEntry->src == L2_GetNodeId(instPtr) || rtneEntry->src == L2_BROADCAST_ID)
 		{
 			torState = L2_TOR_TX;
+			commNode = L2_GetNodeById(instPtr->nodeList, rtneEntry->dst);
 		}
 		else
 		{
 			torState = L2_TOR_SUSPEND;
 		}
+
+		// Setup antenna beam
+		Phy_SetBeamWidth(phyRef, PHY_ANT_BEAM_16);
+		instPtr->log.lastBeamWidth = PHY_ANT_BEAM_16;
+		if (commNode != NULL)
+		{
+			Phy_SetBeamNo(phyRef, commNode->nodeInfo.beamNo, PHY_ANT_BEAM_16);
+		}
 	}
 	else
 	{
@@ -608,6 +832,9 @@ int32_t L2_Scan_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *rtneEntry)
 		{
 			torState = L2_TOR_SUSPEND;
 		}
+		// Setup antenna beam
+		Phy_SetBeamWidth(phyRef, PHY_ANT_BEAM_120);
+		instPtr->log.lastBeamWidth = PHY_ANT_BEAM_120;
 	}
 
 	switch (rtneEntry->slotType)
@@ -672,3 +899,6 @@ int32_t L2_Scan_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *rtneEntry)
 routine_err:
 	return Status;
 }
+
+/** @} LinkLayer_Scan*/
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/schdevent.c

@@ -1,19 +1,24 @@
 /*****************************************************************************/
 /**
- * Description: Event scheduling implementation
+ * @file schdevent.c
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer Event scheduling implementation file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2023-12-21 13:32
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditors: Fan Hao
+ * Lab of Communication and Network
- * LastEditTime: 2023-12-21 13:32
- * Revisions: Rev 0.0
- * History:
- * [2023-12-21]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
 
+/**
+ * @addtogroup LinkLayer_Scheduler
+ * @{
+ */
 /***************************** Include Files *********************************/
 #include <stdlib.h>
 #include "schdevent.h"
@@ -428,3 +433,6 @@ inline bool L2_isEventScheduled(const L2_SCHD_EVENT *schdEvent)
 	ASSERT(schdEvent != NULL);
 	return schdEvent->isSchd;
 }
+
+/** @} LinkLayer_Scheduler*/
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/schdevent.h

@@ -1,18 +1,24 @@
 /*****************************************************************************/
 /**
- * Description: Event scheduling implementation
+ * @file schdevent.c
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer Event scheduling header file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2023-12-21 13:32
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditors: Fan Hao
+ * Lab of Communication and Network
- * LastEditTime: 2023-12-21 13:32
- * Revisions: Rev 0.0
- * History:
- * [2023-12-21]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
+
+/**
+ * @addtogroup LinkLayer_Scheduler
+ * @{
+ */
 #ifndef SCHDEVENT_H_
 #define SCHDEVENT_H_
 
@@ -24,8 +30,9 @@
 #include "clist.h"
 /***************** Macros (Inline Functions) Definitions *********************/
 /**************************** Type Definitions *******************************/
-/** @name L2 event
+/**
- * A definition of L2 event instance.
+ * @struct L2_SCHD_EVENT
+ * @brief Linklayer scheduled event descriptor
  */
 typedef struct
 {
@@ -38,8 +45,9 @@ typedef struct
 	uint32_t schdSlot;
 } L2_SCHD_EVENT;
 
-/** @name L2 event
+/**
- * A definition of L2 event instance.
+ * @struct L2_SCHD_POOL
+ * @brief Linklayer schedule event pool instance
  */
 typedef struct
 {
@@ -63,3 +71,6 @@ bool L2_isEventScheduled(const L2_SCHD_EVENT *schdEvent);
 int32_t L2_CancelEvent(L2_SCHD_EVENT *schdEvent);
 
 #endif // SCHDEVENT_H_
+
+/** @} LinkLayer_Scheduler*/
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/service.c

@@ -1,18 +1,24 @@
 /*****************************************************************************/
 /**
- * Description: Implementations for df datalink service net.
+ * @file service.c
- * Date: 2021-11-16 00:08
+ * @author FanHao ([email protected])
- * LastEditTime: 2022-07-16 17:04
+ * @brief DF Linklayer service implementation file.
- * Revisions: Rev 0.1
+ * @version 0.0
- * History:
+ * @date 2023-05-06
- * [2022-07-16]: New branch for DiJian.
- * [2021-11-16]: Initial version.
  *
- * Copyright(c) 2021 Beijing Institute of Technology.
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * Lab of Communication and Networking
+ * Lab of Communication and Network
  *
  ******************************************************************************/
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
 
+/**
+ * @addtogroup LinkLayer_Service
+ * @{
+ */
 /***************************** Include Files *********************************/
 #include <string.h>
 #include <stdint.h>
@@ -88,6 +94,7 @@ static int32_t Service_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 	uint32_t dataChunk;
 	uint8_t *buff = instPtr->sendPktData;
 
+	// Common section of link layer package
 	dataChunk = L2_GetNextFrameNum(instPtr);
 	L2_FrameInsertChunk(buff, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &dataChunk);
 	dataChunk = L2_GetNextSlotNum(instPtr);
@@ -113,13 +120,13 @@ static int32_t Service_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 		L2_FrameInsertChunk(buff, L2_MSG_SVC_SRC_SPEEDZ, L2_MSG_SVC_SRC_SPEEDZ_LEN, &(instPtr->sysInfo.vZ));
 
 		uint32_t dataId;
-		if(L2_GetNodeType(instPtr) == L2_NODE_HEAD)
+		if (L2_GetNodeType(instPtr) == L2_NODE_HEAD)
 		{
-			SysMonitor_GetSendPayloadFLJRaw(buff + L2_MSG_SVC_PAYLOAD, &dataId);
+			SysMonitor_GetSendPayload(buff + L2_MSG_SVC_PAYLOAD, &dataId, PAYLOAD_LEN_FLJ_TX);
 		}
 		else
 		{
-			SysMonitor_GetSendPayloadLJRaw(buff + L2_MSG_SVC_PAYLOAD, &dataId);
+			SysMonitor_GetSendPayload(buff + L2_MSG_SVC_PAYLOAD, &dataId, PAYLOAD_LEN_LJ_TX);
 		}
 
 		L2_FrameInsertChunk(buff, L2_MSG_SVC_PAYLOAD_ID, L2_MSG_SVC_PAYLOAD_ID_LEN, &dataId);
@@ -128,19 +135,15 @@ static int32_t Service_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 			L2_FrameInsertChunk(buff, L2_MSG_SVC_PAYLOAD, L2_MSG_SVC_PAYLOAD_LEN, testData);
 		}
 
-		// // packing payload
-		// uint32_t dataId;
-		// dataId = DATA_ID_TEST;
-		// L2_FrameInsertChunk(buff, L2_MSG_SVC_PAYLOAD_ID, L2_MSG_SVC_PAYLOAD_ID_LEN, &dataId);
-		// L2_FrameInsertChunk(buff, L2_MSG_SVC_PAYLOAD, L2_MSG_SVC_PAYLOAD_LEN, testData);
-
-
 		Status = L2_CrcAppend(buff, L2_SVC_PACK_LEN - L2_MSG_SVC_CRC_LEN, L2_MSG_SVC_CRC, L2_CRC16_1021);
 		if (Status != SUCCESS)
 		{
 			DBG_ERROR("Fail to append CRC...\n");
 			return Status;
 		}
+
+		memcpy(instPtr->log.txLog.data, buff, L2_SVC_PACK_LEN);
+		instPtr->log.txLog.dataId = dataId;
 		break;
 	}
 	default:
@@ -157,6 +160,135 @@ static int32_t Service_Packing(L2_INST *instPtr, L2_FRAME_TYPE type, uint8_t dst
 #endif
 }
 
+/*****************************************************************************/
+/**
+ * @brief   Handle service received packet. Send data up to MPC
+ *
+ * @param   msg A point32_ter the the message frame.
+ *
+ * @return  SUCCESS message has been successfully handled.
+ *          other       error occurred.
+ *
+ ******************************************************************************/
+int32_t L2_Service_PktHandler(L2_INST *instPtr, uint8_t *msg)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(msg != NULL);
+	int32_t Status;
+#ifndef DATALINK_ENABLE_BERTEST
+	L2_FRAME_TYPE frameType = L2_NONE_FRAME;
+	L2_FrameGetChunk(msg, L2_MSG_TYPE, L2_MSG_TYPE_LEN, &frameType);
+	switch (frameType)
+	{
+	case L2_SVC_FRAME:
+	{
+		uint8_t nodeId;
+		L2_FrameGetChunk(msg, L2_MSG_SRC_ID, L2_MSG_SRC_ID_LEN, &nodeId);
+		NODE_ENTRY *node;
+		node = L2_GetNodeById(instPtr->nodeList, nodeId);
+		if (node == NULL)
+		{
+			node = L2_AppendNode(instPtr->nodeList, nodeId, L2_NODE_MEMBER);
+			if (node == NULL)
+			{
+				DBG_ERROR("Failed to append new node [id: %" PRIu8 "]", nodeId);
+				Status = ENOMEM;
+				break;
+			}
+		}
+
+		// Update node info.
+		float nodePos;
+		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_POSX, L2_MSG_SVC_SRC_POSX_LEN, &nodePos);
+		node->nodeInfo.pos.x = (double)nodePos;
+		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_POSY, L2_MSG_SVC_SRC_POSY_LEN, &nodePos);
+		node->nodeInfo.pos.y = (double)nodePos;
+		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_POSZ, L2_MSG_SVC_SRC_POSZ_LEN, &nodePos);
+		node->nodeInfo.pos.z = (double)nodePos;
+		float nodeSpeed;
+		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_SPEEDX, L2_MSG_SVC_SRC_SPEEDX_LEN, &nodeSpeed);
+		node->nodeInfo.speed.x = (double)nodePos;
+		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_SPEEDY, L2_MSG_SVC_SRC_SPEEDY_LEN, &nodeSpeed);
+		node->nodeInfo.speed.y = (double)nodePos;
+		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_SPEEDZ, L2_MSG_SVC_SRC_SPEEDZ_LEN, &nodeSpeed);
+		node->nodeInfo.speed.z = (double)nodePos;
+
+		// Reset node ttl
+		node->ttlCnt = 0;
+
+		// Calculate time deviation
+		uint32_t frameNum, slotNum = 0;
+		L2_FrameGetChunk(msg, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &frameNum);
+		L2_FrameGetChunk(msg, L2_MSG_SLOT_NUM, L2_MSG_SLOT_NUM_LEN, &slotNum);
+		Status = L2_GetTimeDeviation(instPtr, frameNum, slotNum, true, &(instPtr->log.timeDev));
+		if (Status != SUCCESS)
+		{
+			DBG_ERROR("Failed to compute time deviation.\n")
+			break;
+		}
+
+		uint32_t dataId;
+		L2_FrameGetChunk(msg, L2_MSG_SVC_PAYLOAD_ID, L2_MSG_SVC_PAYLOAD_ID_LEN, &dataId);
+
+		if (L2_GetNodeType(instPtr) == L2_NODE_HEAD)
+		{
+			SysMonitor_UpdateRecvPayload(msg + L2_MSG_SVC_PAYLOAD, dataId, PAYLOAD_LEN_FLJ_RX);
+		}
+		else
+		{
+			SysMonitor_UpdateRecvPayload(msg + L2_MSG_SVC_PAYLOAD, dataId, PAYLOAD_LEN_LJ_RX);
+		}
+
+		// Logging
+		memcpy(instPtr->log.rxLog.data, msg, L2_SVC_PACK_LEN);
+		instPtr->log.rxLog.dataId = dataId;
+		instPtr->serviceFSM->rxdCnt++;
+
+#ifdef DATALINK_ENABLE_AUTOTIMESYNC
+		// Implement a auto time sync.
+		if (L2_GetNodeType(instPtr) != L2_NODE_HEAD)
+		{
+			// Time sync.
+			L2_TimeAdjust(instPtr, &(instPtr->log.timeDev));
+		}
+#endif
+		break;
+	}
+	default:
+		DBG_ERROR("Unsupported frame type: %" PRIu8 ".\n", frameType);
+		break;
+	}
+	return Status;
+#else
+	uint32_t errorBits = 0;
+	for (int i = 0; i < L2_SVC_PACK_LEN; i++)
+	{
+		errorBits += count_ones(msg[i] ^ testData[i]);
+	}
+
+	instPtr->serviceFSM->bitError += errorBits;
+	instPtr->serviceFSM->bitTotal += L2_SVC_PACK_LEN * 8;
+
+	// Calculate time deviation
+	uint32_t frameNum, slotNum = 0;
+	L2_FrameGetChunk(msg, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &frameNum);
+	L2_FrameGetChunk(msg, L2_MSG_SLOT_NUM, L2_MSG_SLOT_NUM_LEN, &slotNum);
+	Status = L2_GetTimeDeviation(instPtr, frameNum, slotNum, true, &(instPtr->log.timeDev));
+	if (Status != SUCCESS)
+	{
+		DBG_ERROR("Failed to compute time deviation.\n")
+		return Status;
+	}
+	// Implement a auto time sync.
+	if (L2_GetNodeType(instPtr) != L2_NODE_HEAD)
+	{
+		// Time sync.
+		L2_TimeAdjust(instPtr, &(instPtr->log.timeDev));
+	}
+	return SUCCESS;
+#endif
+}
+
 /*****************************************************************************/
 /**
  * @brief   Initialize service net FSM
@@ -191,11 +323,14 @@ int32_t L2_Service_Init(L2_SVC_FSM **svcFSMPtr)
 void L2_Service_Reset(L2_SVC_FSM *svcFSMPtr)
 {
 	ASSERT(svcFSMPtr != NULL);
-	memset((&svcFSMPtr->rxLog), 0x00, sizeof(PAYLOAD));
+	svcFSMPtr->txCnt = 0;
-	memset((&svcFSMPtr->txLog), 0x00, sizeof(PAYLOAD));
+	svcFSMPtr->rxCnt = 0;
+	svcFSMPtr->rxdCnt = 0;
 #ifdef DATALINK_ENABLE_BERTEST
 	svcFSMPtr->bitTotal = 0;
 	svcFSMPtr->bitError = 0;
+	svcFSMPtr->lossRate = 0;
+	svcFSMPtr->errorRate = 0;
 #endif
 }
 
@@ -213,115 +348,6 @@ void L2_Service_Destroy(L2_SVC_FSM *serviceFSM)
 	free(serviceFSM);
 }
 
-/*****************************************************************************/
-/**
- * @brief   Handle service received packet. Send data up to MPC
- *
- * @param   msg A point32_ter the the message frame.
- *
- * @return  SUCCESS message has been successfully handled.
- *          other       error occurred.
- *
- ******************************************************************************/
-int32_t L2_Service_PktHandler(L2_INST *instPtr, uint8_t *msg)
-{
-	ASSERT(instPtr != NULL);
-	ASSERT(msg != NULL);
-#ifndef DATALINK_ENABLE_BERTEST
-	int32_t Status;
-	uint8_t frameType;
-	L2_FrameGetChunk(msg, L2_MSG_TYPE, L2_MSG_TYPE_LEN, &frameType);
-	switch (frameType)
-	{
-	case L2_SVC_FRAME:
-	{
-		uint8_t nodeId;
-		L2_FrameGetChunk(msg, L2_MSG_SRC_ID, L2_MSG_SRC_ID_LEN, &nodeId);
-		NODE_ENTRY *node;
-		node = L2_GetNodeById(instPtr->nodeList, nodeId);
-		if (node == NULL)
-		{
-			node = L2_AppendNode(instPtr->nodeList, nodeId, L2_NODE_MEMBER);
-			if(node == NULL) 
-			{
-				DBG_ERROR("Failed to append new node [id: %" PRIu8 "]", nodeId);
-				Status = ENOMEM;
-				break;
-			}
-		}
-
-		// Update node info.
-		float nodePos;
-		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_POSX, L2_MSG_SVC_SRC_POSX_LEN, &nodePos);
-		node->nodeInfo.pos.x = (double) nodePos;
-		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_POSY, L2_MSG_SVC_SRC_POSY_LEN, &nodePos);
-		node->nodeInfo.pos.y = (double) nodePos;
-		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_POSZ, L2_MSG_SVC_SRC_POSZ_LEN, &nodePos);
-		node->nodeInfo.pos.z = (double) nodePos;
-		float nodeSpeed;
-		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_SPEEDX, L2_MSG_SVC_SRC_SPEEDX_LEN, &nodeSpeed);
-		node->nodeInfo.speed.x = (double) nodePos;
-		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_SPEEDY, L2_MSG_SVC_SRC_SPEEDY_LEN, &nodeSpeed);
-		node->nodeInfo.speed.y = (double) nodePos;
-		L2_FrameGetChunk(msg, L2_MSG_SVC_SRC_SPEEDZ, L2_MSG_SVC_SRC_SPEEDZ_LEN, &nodeSpeed);
-		node->nodeInfo.speed.z = (double) nodePos;
-
-		// Reset node ttl
-		node->ttlCnt = 0;
-
-		uint32_t dataId;
-		L2_FrameGetChunk(msg, L2_MSG_SVC_PAYLOAD_ID, L2_MSG_SVC_PAYLOAD_ID_LEN, &dataId);
-
-		if(dataId != DATA_ID_NONE)
-		{
-			if(L2_GetNodeType(instPtr) == L2_NODE_HEAD) 
-			{
-				SysMonitor_UpdateRecvPayloadFLJRaw(msg+L2_MSG_SVC_PAYLOAD);
-			}
-			else
-			{
-				SysMonitor_UpdateRecvPayloadLJRaw(msg+L2_MSG_SVC_PAYLOAD);
-			}
-		}
-		
-#ifdef DATALINK_ENABLE_AUTOTIMESYNC
-		// Implement a auto time sync.
-		if (L2_GetNodeType(instPtr) != L2_NODE_HEAD) 
-		{
-			uint32_t frameNum, slotNum;
-			L2_FrameGetChunk(msg, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &frameNum);
-			L2_FrameGetChunk(msg, L2_MSG_SLOT_NUM, L2_MSG_SLOT_NUM_LEN, &slotNum);
-			L2_TimeAlign(instPtr, frameNum, slotNum, true);
-		}
-#endif
-		break;
-	}
-	default:
-		DBG_ERROR("Unsupported frame type: %" PRIu8 ".\n", frameType);
-		break;
-	}
-	return Status;
-#else 
-	uint32_t errorBits = 0;
-	for (int i = 0; i < SVC_PACK_LEN; i++)
-	{
-		errorBits += count_ones(msg[i] ^ testData[i]);
-	}
-
-	instPtr->serviceFsm.bitError += errorBits;
-	instPtr->serviceFsm.bitTotal += SVC_PACK_LEN * 8;
-
-	// Implement a auto time sync.
-	if (L2_GetNodeType(instPtr) != L2_NODE_HEAD) 
-	{
-		uint32_t frameNum, slotNum;
-		L2_FrameGetChunk(msg, L2_MSG_FRAME_NUM, L2_MSG_FRAME_NUM_LEN, &frameNum);
-		L2_FrameGetChunk(msg, L2_MSG_SLOT_NUM, L2_MSG_SLOT_NUM_LEN, &slotNum);
-		L2_TimeAlign(instPtr, frameNum, slotNum, true);
-	}
-#endif
-}
-
 /*****************************************************************************/
 /**
  * @brief   Service FSM Routine.
@@ -342,36 +368,55 @@ int32_t L2_Service_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *rtneEntr
 		return SUCCESS; // skip
 	}
 
-	PHY_INST* phyRef = instPtr->config.phyInstPtr;
+	PHY_INST *phyRef = instPtr->config.phyInstPtr;
+	L2_SVC_FSM *svcFSMPtr = instPtr->serviceFSM;
 	L2_TOR_TYPE torState;
+	const NODE_ENTRY *commNode;
 	if (rtneEntry->src == L2_GetNodeId(instPtr))
 	{
 		torState = L2_TOR_TX;
+		commNode = L2_GetNodeById(instPtr->nodeList, rtneEntry->dst);
 	}
 	else if (rtneEntry->dst == L2_GetNodeId(instPtr))
 	{
 		torState = L2_TOR_RX;
+		commNode = L2_GetNodeById(instPtr->nodeList, rtneEntry->src);
 	}
 	else
 	{
 		torState = L2_TOR_SUSPEND;
 	}
 
+	// Setup antenna beam
+	if (L2_GetNodeType(instPtr) != L2_NODE_HEAD && commNode != NULL)
+	{
+		Phy_SetBeamWidth(phyRef, PHY_ANT_BEAM_16);
+		Phy_SetBeamNo(phyRef, commNode->nodeInfo.beamNo, PHY_ANT_BEAM_16);
+		instPtr->log.lastBeamWidth = PHY_ANT_BEAM_16;
+	}
+	else
+	{
+		Phy_SetBeamWidth(phyRef, PHY_ANT_BEAM_120);
+		instPtr->log.lastBeamWidth = PHY_ANT_BEAM_120;
+	}
+
 	switch (rtneEntry->slotType)
 	{
 	case L2_SLOT_SERVICE:
 		if (torState == L2_TOR_TX)
 		{
+			svcFSMPtr->txCnt++;
 #ifndef DATALINK_ENABLE_BERTEST
 			// Packing service data
 			Service_Packing(instPtr, L2_SVC_FRAME, rtneEntry->dst);
 #else
-			memcpy(instPtr->sendPktData, testData, SVC_PACK_LEN);
+			memcpy(instPtr->sendPktData, testData, L2_SVC_PACK_LEN);
 #endif
 		}
-		// FIXME: Steer antenna to point to destination.
+		else
-		Phy_SetBeamAngle(phyRef, 0.0, 0.0);
+		{
-		Phy_SetBeamWidth(phyRef, PHY_ANT_BEAM_8);
+			svcFSMPtr->rxCnt++;
+		}
 		L2_SetupNextSlot(instPtr, torState, L2_SVC_FRAME);
 		break;
 	default:
@@ -380,12 +425,14 @@ int32_t L2_Service_Routine(L2_INST *instPtr, const L2_RTNE_TABLE_ENTRY *rtneEntr
 	}
 #ifdef DATALINK_ENABLE_BERTEST
 	uint32_t pktLoss;
-	double errorRate, lossRate;
+	pktLoss = svcFSMPtr->rxCnt - svcFSMPtr->rxdCnt;
-	pktLoss = instPtr->log.svcRecvCnt - instPtr->log.svcCorrectCnt;
+	svcFSMPtr->lossRate = (svcFSMPtr->rxCnt == 0) ? 0 : (double)pktLoss / (double)svcFSMPtr->rxCnt;
-	lossRate = (instPtr->log.svcRecvCnt == 0) ? 0 : (double)pktLoss / (double)instPtr->serviceFsm.pktRecv;
+	svcFSMPtr->errorRate = (svcFSMPtr->bitTotal == 0) ? 0 : (double)svcFSMPtr->bitError / (double)svcFSMPtr->bitTotal;
-	errorRate = (instPtr->serviceFsm.bitTotal == 0) ? 0 : (double)instPtr->serviceFsm.bitError / (double)instPtr->serviceFsm.bitTotal;
+	DBG_PRINT("Packet Loss Rate -- Total: %lu, Loss: %lu.\n", instPtr->log.svcRxCnt, pktLoss);
-	DBG_PRINT("Packet Loss Rate -- Total: %lu, Loss: %lu.\n", instPtr->serviceFsm.pktRecv, pktLoss);
+	DBG_PRINT("Bit Error Rate -- Total:%lu, Error:%lu.\n", svcFSMPtr->bitTotal, svcFSMPtr->bitError);
-	DBG_PRINT("Bit Error Rate -- Total:%lu, Error:%lu.\n", instPtr->serviceFsm.bitTotal, instPtr->serviceFsm.bitError);
 #endif
 	return SUCCESS;
 }
+
+/** @} LinkLayer_Service*/
+/** @} LinkLayer*/

df_datalink_sp/src/networking/link_layer/time_sync.c

@@ -1,21 +1,24 @@
 /*****************************************************************************/
 /**
- * Description: Time sync implementation file.
+ * @file time_sync.c
+ * @author FanHao ([email protected])
+ * @brief DF Linklayer time sync implementation file.
+ * @version 0.0
+ * @date 2023-05-06
  *
- * Author: Author's name
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * Date: 2021-12-04 16:32
+ * Lab of Communication and Network
- * LastEditors: FanHao
- * LastEditTime: 2022-07-10 20:43
- * Revisions: Rev 0.0
- * History:
- * [2022-07-10]: New branch for Dijian.
- * [2021-12-04]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @addtogroup LinkLayer
+ * @{
+ */
 
+/**
+ * @addtogroup LinkLayer_TimeSync
+ * @{
+ */
 /***************************** Include Files *********************************/
 #include <string.h>
 #include <stdlib.h>
@@ -32,22 +35,25 @@
 
 /*****************************************************************************/
 /**
- * @brief    a slot alignment, base on physical layer information.
+ * @brief    Get time deviation to the specified frame and slot number.
  *
  * @param   instPtr	a pointer to linklayer layer instance
  * @param   frameNum
  * @param   slotNum
+ * @param   relative
+ * @param   timeDev
  *
- * @return  SUCCESS Initialize successfully.
+ * @return  SUCCESS
- *          FAILURE Initialization failed, allocate memory fail or initial
+ * 			EIGNORE there is no received frame
- *          bram controller fail.
  *
  ******************************************************************************/
-// TODO: Check
+int32_t L2_GetTimeDeviation(L2_INST *instPtr, uint32_t frameNum, uint32_t slotNum, bool relative, int64_t *timeDev)
-int32_t L2_TimeAlign(L2_INST *instPtr, uint32_t frameNum, uint32_t slotNum, bool relative)
 {
+	ASSERT(instPtr != NULL);
+	ASSERT(timeDev != NULL);
 	L1_FRAME_TYPE lastRecvdFrame;
-	lastRecvdFrame = Phy_GetLastRecvFrameType(instPtr->config.phyInstPtr);
+	PHY_INST *phyRef = instPtr->config.phyInstPtr;
+	lastRecvdFrame = Phy_GetLastRecvFrameType(phyRef);
 	if (lastRecvdFrame == L1_NONE_FRAME)
 	{
 		DBG_ERROR("Invalid TimeAlign operation, no frame was received.");
@@ -57,8 +63,7 @@ int32_t L2_TimeAlign(L2_INST *instPtr, uint32_t frameNum, uint32_t slotNum, bool
 	DBG_INFO("Starting TimeAlign operation...\n");
 	// read nextSendTime from physical layer
 	uint64_t currTime, expectTime;
-	int64_t timeDiff;
+	TIME_WORD timeStamp;
-	TIME_WORD timeStamp, slotTimerAdjmet;
 	expectTime = ((uint64_t)(frameNum * L2_SLOTS_PER_FRAME + slotNum)) * TIME_FRAC_MAX;
 	expectTime += Phy_GetTimeComp(lastRecvdFrame);
 
@@ -67,14 +72,34 @@ int32_t L2_TimeAlign(L2_INST *instPtr, uint32_t frameNum, uint32_t slotNum, bool
 		expectTime += (uint64_t)instPtr->netStartTime * L2_SLOTS_PER_FRAME * TIME_FRAC_MAX;
 	}
 
-	Phy_GetLastReceivedFrameSyncTimeStamp(instPtr->config.phyInstPtr, &timeStamp);
+	Phy_GetLastReceivedFrameSyncTimeStamp(phyRef, &timeStamp);
 	currTime = (uint64_t)timeStamp.frac_part;
 	currTime += ((uint64_t)timeStamp.int_part) * TIME_FRAC_MAX;
 
-	timeDiff = (int64_t)(expectTime - currTime);
+	*timeDev = (int64_t)(expectTime - currTime);
-
-	slotTimerAdjmet.int_part = (uint32_t)(timeDiff / TIME_FRAC_MAX);
-	slotTimerAdjmet.frac_part = (uint32_t)(timeDiff % TIME_FRAC_MAX);
-	TimeCtrl_TimeAdjust(instPtr->config.tmcInstPtr, &slotTimerAdjmet, TM_ADJ_ADD);
 	return SUCCESS;
 }
+
+/*****************************************************************************/
+/**
+ * @brief    Implement time adjustment by applying time deviation.
+ *
+ * @param   instPtr	a pointer to linklayer layer instance
+ * @param   timeDev
+ *
+ * @return  NONE
+ *
+ ******************************************************************************/
+void L2_TimeAdjust(L2_INST *instPtr, const int64_t *timeDev)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(timeDev != NULL);
+	TIME_WORD slotTimerAdjmet;
+	slotTimerAdjmet.int_part = (uint32_t)(*timeDev / TIME_FRAC_MAX);
+	slotTimerAdjmet.frac_part = (uint32_t)(*timeDev % TIME_FRAC_MAX);
+	TimeCtrl_TimeAdjust(instPtr->config.tmcInstPtr, &slotTimerAdjmet, TM_ADJ_ADD);
+}
+
+/** @} LinkLayer_TimeSync*/
+
+/** @} LinkLayer*/

df_datalink_sp/src/networking/phy_layer/phy_antenna.c

@@ -15,12 +15,26 @@
  * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @addtogroup PhysicalLayer
+ * @{
+ */
+
+/**
+ * @addtogroup PhysicalLayer_AntennaControl
+ * @{
+ */
 #include <string.h>
 #include <stdint.h>
 #include <math.h>
 #include "error.h"
 #include "phy_layer.h"
 
+/**
+ * @name PhysicalLayer_AntennaConfig_Constants
+ * @{
+ */
+
 #define ANT_PI 3.14159265358979323846
 
 #define ANT_COINFO_HEAD 0xAA
@@ -29,16 +43,19 @@
 #define CTRL_WORD_DEFAULT 0x00
 
 #define ANT_MODE_BEAM_MASK 0xF0
-#define ANT_MODE_NARROR_BEAM 0x00 // 8
+#define ANT_BEAM_NARROR 0x00	  // 8
-#define ANT_MODE_WIDE_BEAM_1 0x10 // 25
+#define ANT_BEAM_SUBNARROR_0 0x10 // 25
-#define ANT_MODE_WIDE_BEAM_2 0x20 // 60
+#define ANT_BEAM_SUBNARROR_1 0x20 // 60
-#define ANT_MODE_WIDE_BEAM_3 0x30 // 120
+#define ANT_BEAM_WIDE 0x30		  // 120
 
-#define ANT_MODE_HIGH_POWER 0x00
+#define ANT_MODE_POWER_MASK 0x0F
-#define ANT_MODE_LOW_POWER 0x04
+#define ANT_POWER_FULL 0x00
-#define ANT_MODE_STANDBY 0x0F
+#define ANT_POWER_LOW 0x04
-#define ATN_MODE_DEFAULT (ANT_MODE_WIDE_BEAM_1 | ANT_MODE_LOW_POWER)
+#define ANT_POWER_STANDBY 0x0F
-#define ATN_MODE_HIGH (ANT_MODE_WIDE_BEAM_1 | ANT_MODE_HIGH_POWER)
+#define ATN_MODE_SILENT (ANT_BEAM_SUBNARROR_0 | ANT_POWER_STANDBY)
+#define ATN_MODE_LOWPOWER (ANT_BEAM_SUBNARROR_0 | ANT_POWER_LOW)
+#define ATN_MODE_FULLPOWER (ANT_BEAM_SUBNARROR_0 | ANT_POWER_FULL)
+#define ATN_MODE_DEFAULT ATN_MODE_SILENT
 
 #define DEFAULT_CENTRTAL_FREQ 0x06D7 // 26.25GHz
 
@@ -54,17 +71,12 @@
 
 // Pair by regex
 // Regex: (([0-9]+, ){8})
-uint16_t hopPattern_Config[L1_FRAME_MAX_HOPS] = 
+const uint16_t hopPattern_2KBPS_20MS[L1_FRAME_2KBPS_20MS_HOPS] =
-{
-	0
-};
-
-uint16_t hopPattern_2KBPS_20MS[L1_FRAME_2KBPS_20MS_HOPS] = 
 {
 	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,
 	350, 394, 438, 481, 525, 569, 613, 656,
@@ -79,116 +91,53 @@ uint16_t hopPattern_2KBPS_100MS[L1_FRAME_2KBPS_100MS_HOPS] =
 	3500
 };
 
-uint16_t hopPattern_10KBPS_10MS[L1_FRAME_10KBPS_10MS_HOPS] = 
+const uint16_t hopPattern_10KBPS_10MS[L1_FRAME_10KBPS_10MS_HOPS] =
 {
 	1500
 };
 
-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
+};
+
+const uint16_t hopPattern_40KBPS_10MS[L1_FRAME_40KBPS_10MS_HOPS] =
+{
+	1600, 1650, 1700, 1750, 1800, 1850, 1900, 1550,
 	1500
 };
 
-uint16_t hopPattern_40KBPS_10MS[L1_FRAME_40KBPS_10MS_HOPS] = 
+const uint16_t hopPattern_40KBPS_20MS[L1_FRAME_40KBPS_20MS_HOPS] =
 {
-	1600
+	1700, 1800, 1900, 2000, 1700, 1700, 1700, 1700,
+	1700, 1700, 1700, 1700, 1700, 1700, 1700, 1700,
+	1700, 1700, 1700
 };
 
-uint16_t hopPattern_40KBPS_20MS[L1_FRAME_40KBPS_20MS_HOPS] = 
+const uint16_t hopPattern_200KBPS_5MS[L1_FRAME_200KBPS_5MS_HOPS] =
-{
-	1600
-};
-
-uint16_t hopPattern_200KBPS_5MS[L1_FRAME_200KBPS_5MS_HOPS] =
 {
 	500, 1600, 1700, 1800, 1900, 2000, 1500, 1600,
 	1700, 1800, 1900, 2000, 1500, 1600, 1700, 1800,
 	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,
 	700, 800, 900, 1000, 500, 600, 700, 800,
 	900, 1000, 500, 500
 };
 
-// Pair by regex
+/** @} PhysicalLayer_AntennaConfig_Constants*/
-// Regex: ((\{\.oaxis = [0-9]+[ ,]+\.raxis = [0-9]+[ ]*\}, ){2})
+
-#ifdef PHY_BEAM_SET_PRESET
-PHY_ANT_ANGLE antSubnrrwPattern[L1_NUM_ANT_SUBNRRW_PATTERN] = 
-{
-	{.oaxis = 0 , .raxis = 222}, {.oaxis = 10, .raxis = 85 },
-	{.oaxis = 14, .raxis = 307}, {.oaxis = 17, .raxis = 170},
-	{.oaxis = 19, .raxis = 32 }, {.oaxis = 21, .raxis = 255},
-	{.oaxis = 24, .raxis = 117}, {.oaxis = 25, .raxis = 340},
-	{.oaxis = 27, .raxis = 202}, {.oaxis = 29, .raxis = 65 },
-	{.oaxis = 31, .raxis = 287}, {.oaxis = 32, .raxis = 150},
-	{.oaxis = 34, .raxis = 12 }, {.oaxis = 35, .raxis = 235},
-	{.oaxis = 36, .raxis = 97 }, {.oaxis = 38, .raxis = 320},
-	{.oaxis = 39, .raxis = 182}, {.oaxis = 40, .raxis = 45 },
-	{.oaxis = 41, .raxis = 267}, {.oaxis = 43, .raxis = 130},
-	{.oaxis = 44, .raxis = 352}, {.oaxis = 45, .raxis = 215},
-	{.oaxis = 46, .raxis = 77 }, {.oaxis = 47, .raxis = 300},
-	{.oaxis = 48, .raxis = 162}, {.oaxis = 49, .raxis = 25 },
-	{.oaxis = 50, .raxis = 247}, {.oaxis = 51, .raxis = 110},
-	{.oaxis = 52, .raxis = 332}, {.oaxis = 53, .raxis = 195},
-	{.oaxis = 54, .raxis = 57 }, {.oaxis = 55, .raxis = 280},
-	{.oaxis = 56, .raxis = 142}, {.oaxis = 57, .raxis = 5  },
-	{.oaxis = 58, .raxis = 227}, {.oaxis = 59, .raxis = 90 },
-	{.oaxis = 60, .raxis = 312}
-};
-PHY_ANT_ANGLE antNrrwPattern[L1_NUM_ANT_NRRW_PATTERN] = 
-{
-	{.oaxis = 0 , .raxis = 222}, {.oaxis = 7 , .raxis = 85 },
-	{.oaxis = 10, .raxis = 307}, {.oaxis = 13, .raxis = 170},
-	{.oaxis = 15, .raxis = 32 }, {.oaxis = 17, .raxis = 255},
-	{.oaxis = 18, .raxis = 117}, {.oaxis = 20, .raxis = 340},
-	{.oaxis = 21, .raxis = 202}, {.oaxis = 22, .raxis = 65 },
-	{.oaxis = 24, .raxis = 287}, {.oaxis = 25, .raxis = 150},
-	{.oaxis = 26, .raxis = 12 }, {.oaxis = 27, .raxis = 235},
-	{.oaxis = 28, .raxis = 97 }, {.oaxis = 29, .raxis = 320},
-	{.oaxis = 30, .raxis = 182}, {.oaxis = 31, .raxis = 45 },
-	{.oaxis = 32, .raxis = 267}, {.oaxis = 33, .raxis = 130},
-	{.oaxis = 34, .raxis = 352}, {.oaxis = 34, .raxis = 215},
-	{.oaxis = 35, .raxis = 77 }, {.oaxis = 36, .raxis = 300},
-	{.oaxis = 37, .raxis = 162}, {.oaxis = 38, .raxis = 25 },
-	{.oaxis = 38, .raxis = 247}, {.oaxis = 39, .raxis = 110},
-	{.oaxis = 40, .raxis = 332}, {.oaxis = 41, .raxis = 195},
-	{.oaxis = 41, .raxis = 57 }, {.oaxis = 42, .raxis = 280},
-	{.oaxis = 43, .raxis = 142}, {.oaxis = 44, .raxis = 5  },
-	{.oaxis = 44, .raxis = 227}, {.oaxis = 45, .raxis = 90 },
-	{.oaxis = 46, .raxis = 312}, {.oaxis = 46, .raxis = 175},
-	{.oaxis = 47, .raxis = 37 }, {.oaxis = 48, .raxis = 260},
-	{.oaxis = 48, .raxis = 122}, {.oaxis = 49, .raxis = 345},
-	{.oaxis = 49, .raxis = 207}, {.oaxis = 50, .raxis = 70 },
-	{.oaxis = 51, .raxis = 292}, {.oaxis = 51, .raxis = 155},
-	{.oaxis = 52, .raxis = 17 }, {.oaxis = 53, .raxis = 240},
-	{.oaxis = 53, .raxis = 102}, {.oaxis = 54, .raxis = 325},
-	{.oaxis = 54, .raxis = 187}, {.oaxis = 55, .raxis = 50 },
-	{.oaxis = 55, .raxis = 272}, {.oaxis = 56, .raxis = 135},
-	{.oaxis = 57, .raxis = 357}, {.oaxis = 57, .raxis = 220},
-	{.oaxis = 58, .raxis = 82 }, {.oaxis = 58, .raxis = 305},
-	{.oaxis = 59, .raxis = 167}, {.oaxis = 59, .raxis = 30 },
-	{.oaxis = 60, .raxis = 252}
-};
-#else
-PHY_ANT_ANGLE antSubnrrwPattern[L1_NUM_ANT_SUBNRRW_PATTERN]  = 
-{
-	0
-};
-PHY_ANT_ANGLE antNrrwPattern[L1_NUM_ANT_NRRW_PATTERN] = 
-{
-	0
-};
-#endif
 /*****************************************************************************/
 /**
- * @brief
+ * @brief	Initialize antenna configurations (load preset values)
  *
- * @param   antConfig
+ * @param   antConfig	pointer to antenna configure
  *
- * @return
+ * @return	None.
  *
  ******************************************************************************/
 void Phy_AntConfigInit(PHY_ANT_CONFIG *antConfig)
@@ -242,32 +191,80 @@ void Phy_AntConfigInit(PHY_ANT_CONFIG *antConfig)
 	// ***********************
 }
 
+/*****************************************************************************/
+/**
+ * @brief	Update antenna power mode setting
+ *
+ * @param   instPtr	pointer to physical layer instance
+ * @param   mode	new antenna mode
+ *
+ * @return	None.
+ *
+ ******************************************************************************/
 void Phy_AntConfigMode(PHY_INST *instPtr, PHY_ANT_MODE mode)
 {
 	ASSERT(instPtr != NULL);
 	uint8_t config = instPtr->antConfig.antMode & ANT_MODE_BEAM_MASK;
 	switch (mode)
 	{
-	case PHY_ANT_MODE_SILENT:
+	case PHY_ANT_MODE_STANDBY:
-		config |= ANT_MODE_STANDBY;
+		config |= ANT_POWER_STANDBY;
 		break;
-	case PHY_ANT_MODE_LOW_POWER:
+	case PHY_ANT_MODE_POWER_LOW:
-		config |= ANT_MODE_LOW_POWER;
+		config |= ANT_POWER_LOW;
 		break;
-	case PHY_ANT_MODE_HIGH_POWER:
+	case PHY_ANT_MODE_POWER_FULL:
-		config |= ANT_MODE_HIGH_POWER;
+		config |= ANT_POWER_FULL;
 		break;
 	default:
 		DBG_ERROR("Unknown antenna mode: %" PRIu8 ", remain previous mode.\n", mode);
 		return;
 	}
+	instPtr->phyLog.antMode = mode;
 	instPtr->antConfig.antMode = config;
+	// Sync logs to system monitor
+	SysMonitor_UpdatePhysicalLayerLog(&(instPtr->phyLog));
 }
 
-int32_t Phy_SetBeamNo(PHY_INST *instPtr, int32_t beamNo)
+/*****************************************************************************/
+/**
+ * @brief	Update antenna beam width setting
+ *
+ * @param   instPtr	pointer to physical layer instance
+ * @param   table	new beam table
+ * @param   offset	table offset
+ *
+ * @return	None
+ *
+ ******************************************************************************/
+void Phy_SetBeamTable(PHY_INST *instPtr, PHY_ANT_ANGLE *table, uint32_t offset)
 {
 	ASSERT(instPtr != NULL);
-	if (instPtr->beamWd.next == PHY_ANT_BEAM_8)
+	ASSERT(table != NULL);
+	for (int i = 0; i < L1_NUM_ANT_NRRW_PATTERN; i++)
+	{
+		instPtr->antNrrwPattern[i] = table[(i + offset) % L1_NUM_ANT_NRRW_PATTERN];
+	}
+	memcpy((uint32_t *)instPtr->antInfoAddr, instPtr->antNrrwPattern,
+		   L1_NUM_ANT_NRRW_PATTERN * sizeof(PHY_ANT_ANGLE));
+}
+
+/*****************************************************************************/
+/**
+ * @brief	Update antenna point direction using predefined beam table
+ *
+ * @param   instPtr	pointer to physical layer instance
+ * @param   beamNo	new beam index
+ *
+ * @return	SUCCESS.
+ * 			FAILURE beamNo exceeds the table size
+ *
+ ******************************************************************************/
+int32_t Phy_SetBeamNo(PHY_INST *instPtr, int32_t beamNo, PHY_ANT_BEAM_WIDTH beamWidth)
+{
+	ASSERT(instPtr != NULL);
+
+	if (beamWidth == PHY_ANT_BEAM_16)
 	{
 		if (beamNo >= L1_NUM_ANT_NRRW_PATTERN)
 		{
@@ -276,26 +273,10 @@ int32_t Phy_SetBeamNo(PHY_INST *instPtr, int32_t beamNo)
 		else
 		{
 			instPtr->beamNo.next = beamNo;
-			instPtr->antConfig.oaxis[1] = (uint8_t)(antNrrwPattern[beamNo].oaxis);
+			instPtr->antConfig.oaxis[0] = (uint8_t)(instPtr->antNrrwPattern[beamNo].oaxis >> 8);
-			instPtr->antConfig.oaxis[0] = (uint8_t)((antNrrwPattern[beamNo].oaxis) >> 8);
+			instPtr->antConfig.oaxis[1] = (uint8_t)(instPtr->antNrrwPattern[beamNo].oaxis);
-			instPtr->antConfig.raxis[1] = (uint8_t)(antNrrwPattern[beamNo].raxis);
+			instPtr->antConfig.raxis[0] = (uint8_t)(instPtr->antNrrwPattern[beamNo].raxis >> 8);
-			instPtr->antConfig.raxis[0] = (uint8_t)((antNrrwPattern[beamNo].raxis) >> 8);
+			instPtr->antConfig.raxis[1] = (uint8_t)(instPtr->antNrrwPattern[beamNo].raxis);
-			return SUCCESS;
-		}
-	}
-	else if (instPtr->beamWd.next == PHY_ANT_BEAM_25)
-	{
-		if (beamNo >= L1_NUM_ANT_SUBNRRW_PATTERN)
-		{
-			return FAILURE;
-		}
-		else
-		{
-			instPtr->beamNo.next = beamNo;
-			instPtr->antConfig.oaxis[1] = (uint8_t)(antSubnrrwPattern[beamNo].oaxis);
-			instPtr->antConfig.oaxis[0] = (uint8_t)((antSubnrrwPattern[beamNo].oaxis) >> 8);
-			instPtr->antConfig.raxis[1] = (uint8_t)(antSubnrrwPattern[beamNo].raxis);
-			instPtr->antConfig.raxis[0] = (uint8_t)((antSubnrrwPattern[beamNo].raxis) >> 8);
 			return SUCCESS;
 		}
 	}
@@ -304,15 +285,26 @@ int32_t Phy_SetBeamNo(PHY_INST *instPtr, int32_t beamNo)
 		// Beam number assign not support.
 		// Assign default angle (0,0)
 		instPtr->beamNo.next = 0;
-		instPtr->antConfig.oaxis[1] = 0;
 		instPtr->antConfig.oaxis[0] = 0;
-		instPtr->antConfig.raxis[1] = 0;
+		instPtr->antConfig.oaxis[1] = 0;
 		instPtr->antConfig.raxis[0] = 0;
+		instPtr->antConfig.raxis[1] = 0;
 		DBG_WARNING("Using default beam number...\n");
 		return SUCCESS;
 	}
 }
 
+/*****************************************************************************/
+/**
+ * @brief	Update antenna beam width setting
+ *
+ * @param   instPtr		pointer to physical layer instance
+ * @param   beamWidth	new beam width
+ *
+ * @return	SUCCESS.
+ * 			EPARAM - the direction is exceeds predefined range
+ *
+ ******************************************************************************/
 int32_t Phy_SetBeamWidth(PHY_INST *instPtr, PHY_ANT_BEAM_WIDTH beamWidth)
 {
 	ASSERT(instPtr != NULL);
@@ -320,28 +312,38 @@ int32_t Phy_SetBeamWidth(PHY_INST *instPtr, PHY_ANT_BEAM_WIDTH beamWidth)
 	switch (beamWidth)
 	{
 	case PHY_ANT_BEAM_120:
-		beamConfig |= ANT_MODE_WIDE_BEAM_3;
+		beamConfig |= ANT_BEAM_WIDE;
 		break;
 	case PHY_ANT_BEAM_60:
-		beamConfig |= ANT_MODE_WIDE_BEAM_2;
+		beamConfig |= ANT_BEAM_SUBNARROR_1;
 		break;
 	case PHY_ANT_BEAM_25:
-		beamConfig |= ANT_MODE_WIDE_BEAM_1;
+		beamConfig |= ANT_BEAM_SUBNARROR_0;
 		break;
-	case PHY_ANT_BEAM_8:
+	case PHY_ANT_BEAM_16:
-		beamConfig |= ANT_MODE_NARROR_BEAM;
+		beamConfig |= ANT_BEAM_NARROR;
 		break;
 	default:
 		DBG_ERROR("Beam width code: 0x%08X is illegal.\n\r", beamWidth);
 		return EPARAM;
-		break;
 	}
 	instPtr->antConfig.antMode = beamConfig;
 	instPtr->beamWd.next = beamWidth;
 	return SUCCESS;
 }
 
-// Common version radius double input
+/*****************************************************************************/
+/**
+ * @brief	Set antenna to a specific direction
+ *
+ * @param   instPtr	pointer to physical layer instance
+ * @param   offAx	elevation angle
+ * @param   rndAx	azimuth angle
+ *
+ * @return	SUCCESS.
+ * 			EPARAM - the direction is exceeds predefined range
+ *
+ ******************************************************************************/
 int32_t Phy_SetBeamAngle(PHY_INST *instPtr, double offAx, double rndAx)
 {
 	ASSERT(instPtr != NULL);
@@ -357,9 +359,13 @@ int32_t Phy_SetBeamAngle(PHY_INST *instPtr, double offAx, double rndAx)
 	}
 	offAxDeg = offAxDeg * 10;
 	rndAxDeg = rndAxDeg * 10;
-	instPtr->antConfig.oaxis[1] = (uint8_t)offAxDeg;
 	instPtr->antConfig.oaxis[0] = (uint8_t)(offAxDeg >> 8);
-	instPtr->antConfig.raxis[1] = (uint8_t)rndAxDeg;
+	instPtr->antConfig.oaxis[1] = (uint8_t)offAxDeg;
 	instPtr->antConfig.raxis[0] = (uint8_t)(rndAxDeg >> 8);
+	instPtr->antConfig.raxis[1] = (uint8_t)rndAxDeg;
 	return SUCCESS;
 }
+
+/** @} PhysicalLayer_AntennaControl*/
+
+/** @} PhysicalLayer*/

df_datalink_sp/src/networking/phy_layer/phy_layer.h

@@ -1,42 +1,40 @@
 /*****************************************************************************/
 /**
- * Description: Physical layer control definitions and function prototypes.
+ * @file phy_layer.c
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief Physical layer control header file.
+ * @version 0.0
+ * @date 2023-04-24
  *
- * Date: 2021-12-04 16:32
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditTime: 2024-01-20 17:41
+ * Lab of Communication and Network
- * Revisions: Rev 0.1
- * History:
- * [2021-12-08]: Initial version.
- * [2022-06-18]: New branch for glink control purpose:
- * 				 -Add poll mode, physical layer will start Tx/Rx procedure
- * 				  at specific time stamp.
- * 				 -Add 61/37 beam switch
- * 				 -Code simplification.
- * [2023-04-24]: Feature add:
- * 				- Read frame type from PL status register.
- * [2024-01-20]: New branch for DUIFEI.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
 
+/**
+ * @defgroup PhysicalLayer
+ * @{
+ */
+
 #ifndef PHY_CTRL_H_
 #define PHY_CTRL_H_
 
 /***************************** Include Files *********************************/
 #include <stdint.h>
-#include "phy_reg.h"
 #include "common.h"
 #ifndef EMULATION
 #include "xbram.h"
 #include "xadcps.h"
+#include "../config/app_config.h"
 #endif
 #include "../../system_monitor.h"
 #include "../../time_ctrl/time_ctrl.h"
 /************************** Constant Definitions *****************************/
-#define L1_NUM_ANT_SUBNRRW_PATTERN 37
+/**
-#define L1_NUM_ANT_NRRW_PATTERN 61
+ * @name PhysicalLayer_Common_Constant
+ * @{
+ */
+#define L1_NUM_ANT_NRRW_PATTERN 37
 #define L1_INIT_BEAM_NO 0
 #define L1_INIT_ANT_WD PHY_ANT_BEAM_120
 #define L1_INIT_ANT_NO 0
@@ -53,11 +51,13 @@
 #define L1_FRAME_40KBPS_10MS_HOPS 9
 #define L1_FRAME_200KBPS_5MS_HOPS 20
 #define L1_FRAME_1M2BPS_5MS_HOPS 20
-
+#define PHY_LOG_EXPIRE 40 // 50*5ms
-#define PHY_TIME_WORD_H_MAX UINT32_MAX
+/** @} */
-#define PHY_TIME_WORD_L_MAX 0x0007A120 // 5ms/10ns
 /***************** Macros (Inline Functions) Definitions *********************/
 /**************************** Type Definitions *******************************/
+/**
+ * @enum L1_FRAME_TYPE
+ */
 typedef enum
 {
 	L1_NONE_FRAME = 0,
@@ -71,71 +71,63 @@ typedef enum
 	L1_1M2BPS_5MS_FRAME = 8
 } L1_FRAME_TYPE;
 
+/**
+ * @struct PHY_ANT_CONFIG
+ * @brief PhysicalLayer antenna config
+ */
 typedef struct
 {
 	/*** Ant Control ***/
-	/* Antenna control frame head 0xAA */
+	uint8_t ctrlWord;	 ///< Antenna control frame head 0xAA\n
-	/* default 0, reserved for further use */
+						 /// default 0, reserved for further use
-	uint8_t ctrlWord;
+	uint8_t antMode;	 ///< high 4 bits specified beam mode.\n
-	/* high 4 bits specified beam mode.
+						 /// low 4 bits specified power control
-	 * low 4 bits specified power control */
+	uint8_t oaxis[2];	 ///< off-axis angle range is 0~60 \n
-	uint8_t antMode;
+						 /// 0.1 degree each LSB
-	/* off-axis angle range is 0~60,
+	uint8_t raxis[2];	 ///< round-axis angle range is 0~360, \n
-	 * 0.1 degree each LSB */
+						 /// 0.1 degree each LSB
-	uint8_t oaxis[2];
+	uint8_t antFreq[2];	 ///< 0~3500Mhz, step 1MHz
-	/* round-axis angle range is 0~360,
+	uint8_t trSlect;	 ///< in single tr mode, 0~63 specified tr channel \n
-	 * 0.1 degree each LSB */
+						 /// in single subarray mode, 0~3 specified the subarray
-	uint8_t raxis[2];
+						 /// ! Only in debug mode!
-	/* 0~3500Mhz, step 1MHz */
+	uint8_t antAtt;		 ///< Antenna attenuation 0~31, 0.5dB each LSB, Only in debug mode
-	uint8_t antFreq[2];
+	uint8_t phase;		 ///< 0~63, 5.625 degree each LSB, Only in debug mode
-	/* in single tr mode, 0~63 specified tr channel
+	uint8_t rxtxMode;	 ///< Only for debug \n
-	 * in single subarray mode, 0~3 specified the subarray
+						 /// default 0x00
-	 * Only in debug mode*/
+	uint8_t calibrMode;	 ///< 0x00 Normal, 0x01 single tr calibration
-	uint8_t trSlect;
+	uint8_t antReserved; ///< reserved for further use
-	/* Antenna attenuation 0~31, 0.5dB each LSB, Only in debug mode */
-	uint8_t antAtt;
-	/* 0~63, 5.625 degree each LSB, Only in debug mode*/
-	uint8_t phase;
-	/* Only for debug */
-	/* default 0x00 */
-	uint8_t rxtxMode;
-	/* 0x00 Normal, 0x01 single tr calibration */
-	uint8_t calibrMode;
-	/* reserved for further use */
-	uint8_t antReserved;
 
 	/*** RF Control ***/
-	/* [7:4]RF enable: 0-On, 1-Off(Default); [3:0]Work mode: 0(default) */
+	uint8_t rfCtrl;		 ///< [7:4]RF enable: 0-On, 1-Off(Default); [3:0]Work mode: 0(default)
-	uint8_t rfCtrl;
+	uint8_t rfFreq[2];	 ///< 0~3500Mhz, step 1MHz
-	/* 0~3500Mhz, step 1MHz */
+	uint8_t rfTxMgc;	 ///< RF MGC control: 0~31, 1dB each LSB
-	uint8_t rfFreq[2];
+	uint8_t rf12CalMgc;	 ///< RF channel 1&2 calibration mgc\n
-	/* RF MGC control: 0~31, 1dB each LSB*/
+						 /// [7:4] Channle1 - max 15db, 1dB each LSB \n
-	uint8_t rfTxMgc;
+						 /// [3:0] Channle2 - max 15db, 1dB each LSB
-	/* RF channel 1&2 calibration mgc: [7:4] Channle1 - max 15db, 1dB each LSB
+	uint8_t rf34CalMgc;	 ///< RF channel 3&4 calibration mgc\n
-	 * 								   [3:0] Channle2 - max 15db, 1dB each LSB*/
+						 /// [7:4] Channle3 - max 15db, 1dB each LSB
-	uint8_t rf12CalMgc;
+						 /// [3:0] Channle4 - max 15db, 1dB each LSB
-	/* RF channel 3&4 calibration mgc: [7:4] Channle3 - max 15db, 1dB each LSB
+	uint8_t rcvMgc;		 ///< Receive channel 1-4 MGC: 0~31, 1dB each LSB
-	 * 								   [3:0] Channle4 - max 15db, 1dB each LSB*/
+	uint8_t rfMonitor;	 ///< Receive monitor, 0-normal, 1-switch to monitor port
-	uint8_t rf34CalMgc;
+	uint8_t rfReserved0; ///< reserved for further use
-	/* Receive channel 1-4 MGC: 0~31, 1dB each LSB */
+	uint8_t rfReserved1; ///< reserved for further use
-	uint8_t rcvMgc;
-	/* Receive monitor, 0-normal, 1-switch to monitor port */
-	uint8_t rfMonitor;
-	/* reserved for further use */
-	uint8_t rfReserved0;
-	uint8_t rfReserved1;
 } PHY_ANT_CONFIG;
 
+/**
+ * @struct PHY_ANT_ANGLE
+ * @brief Describe the PhysicalLayer antenna angle
+ */
 typedef struct
 {
-	/* off-axis angle range is 0~60,
+	uint16_t oaxis; ///< off-axis angle range is 0~60
-	 * 0.1 degree each LSB */
+					/// 0.1 degree each LSB
-	uint16_t oaxis;
+	uint16_t raxis; ///< round-axis angle range is 0~360
-	/* round-axis angle range is 0~360,
+					/// 0.1 degree each LSB
-	 * 0.1 degree each LSB */
-	uint16_t raxis;
 } PHY_ANT_ANGLE;
 
+/**
+ * @enum PHY_TIME_WORD_TYPE
+ */
 typedef enum
 {
 	PHY_TIME_WORD_NONE = 0,
@@ -143,15 +135,21 @@ typedef enum
 	PHY_TIME_WORD_LISTEN_TIMEOUT = 2
 } PHY_TIME_WORD_TYPE;
 
+/**
+ * @enum PHY_ANT_BEAM_WIDTH
+ */
 typedef enum
 {
 	PHY_ANT_BEAM_NONE = 0,
 	PHY_ANT_BEAM_120 = 1,
 	PHY_ANT_BEAM_60 = 2,
 	PHY_ANT_BEAM_25 = 3,
-	PHY_ANT_BEAM_8 = 4
+	PHY_ANT_BEAM_16 = 4
 } PHY_ANT_BEAM_WIDTH;
 
+/**
+ * @enum PHY_TOR_TYPE
+ */
 typedef enum
 {
 	PHY_TOR_SUSPEND = 0,
@@ -159,6 +157,9 @@ typedef enum
 	PHY_TOR_RX = 2
 } PHY_TOR_TYPE;
 
+/**
+ * @enum PHY_MODE
+ */
 typedef enum
 {
 	PHY_MODE_NONE = 0,
@@ -167,24 +168,21 @@ typedef enum
 	PHY_MODE_PULL = 3
 } PHY_MODE;
 
+/**
+ * @enum PHY_ANT_MODE
+ */
 typedef enum
 {
 	PHY_ANT_MODE_NONE = 0,
-	PHY_ANT_MODE_SILENT = 1,
+	PHY_ANT_MODE_STANDBY = 1,
-	PHY_ANT_MODE_LOW_POWER = 2,
+	PHY_ANT_MODE_POWER_LOW = 2,
-	PHY_ANT_MODE_HIGH_POWER = 3,
+	PHY_ANT_MODE_POWER_FULL = 3,
 } PHY_ANT_MODE;
 
-typedef struct
+/**
-{
+ * @struct PHY_RCD
-	uint32_t devId;
+ * @brief Physical Layer recode buffer
-	uint32_t txBramId;
+ */
-	uint32_t rxBramId;
-	uint32_t antBramId;
-	uint32_t hwXadcId;
-	uintptr_t baseAddr;
-} PHY_CONFIG;
-
 typedef struct
 {
 	int32_t last;
@@ -192,83 +190,102 @@ typedef struct
 	int32_t next;
 } PHY_RCD;
 
+/**
+ * @struct PHY_CONFIG
+ * @brief struct holds all physical layer initialization parameters
+ */
 typedef struct
 {
-	PHY_CONFIG phyCofig; // Device address configs
+	uint32_t devId;			///< device ID
-	uintptr_t recvDataAddr;
+	uint32_t txBramId;		///< tx bram ID
-	uintptr_t sendDataAddr;
+	uint32_t rxBramId;		///< rx bram ID
-	uintptr_t antConfigAddr;
+	uint32_t antBramId;		///< antenna config bram ID
-	bool isPhyEn;			  // if physical layer running
+	uint32_t antInfoBramId; ///< antenna beam info bram ID
-	bool isAcq;				  // if last reception acquisition success
+	uint32_t hwXadcId;		///< hardware xadc device ID
-	bool isFrameSync;		  // if last reception frame sync success
+	uintptr_t baseAddr;		///< Physical layer controller base address
-	bool isDecode;			  // if last reception decode success
-	bool isValid;			  // if last reception frame data valid (crc check pass)
-	bool isPresetHop;		  // if using preset frequency hop
-	TIME_WORD recvSlotTime;	  // last slot start time stamp
-	TIME_WORD recvFsTime;	  // last frame sync time stamp
-	PHY_RCD antNo;			  // antenna number record
-	PHY_RCD beamNo;			  // beam number record
-	PHY_RCD beamWd;			  // beam width record
-	PHY_RCD tor;			  // tx rx state record
-	PHY_RCD frameType;		  // frame type record
-	uint32_t sendDataOffset;  // antenna configuration bram offset (to implement ping-pong data flow)
-	uint32_t antConfigOffset; // antenna configuration bram offset (to implement ping-pong data flow)
-	PHY_ANT_CONFIG antConfig; // antenna configuration pointer
 #ifndef EMULATION
-	XAdcPs hwXadc;
+	uint8_t (*get_clk_state)(void);		///< function handle returns hardware clock state
+	uint8_t (*get_ad_lock_state)(void); ///< function handle returns adc lock state
+	int8_t (*get_ad0_temp)(void);		///< function handle returns adc0 temperature state
+	int8_t (*get_ad1_temp)(void);		///< function handle returns adc1 temperature state
 #endif
-	HWSTATE hwSate;
+} PHY_CONFIG;
+
+/**
+ * @struct PHY_INST
+ * @brief Physical Layer operating instance
+ */
+typedef struct
+{
+	PHY_CONFIG phyCofig;	  ///< physical layer configuration parameters
+	uintptr_t recvDataAddr;	  ///< receive data bram address
+	uintptr_t sendDataAddr;	  ///< send data bram address
+	uintptr_t antConfigAddr;  ///< antenna config data bram address
+	uintptr_t antInfoAddr;	  ///< antenna beam info data bram address
+	bool isPhyEn;			  ///< indicates if physical layer running
+	bool isAcq;				  ///< indicates if last reception acquisition success
+	bool isFrameSync;		  ///< indicates if last reception frame sync success
+	bool isDecode;			  ///< indicates if last reception decode success
+	bool isValid;			  ///< indicates if last reception frame data valid (crc check pass)
+	TIME_WORD recvSlotTime;	  ///< last slot start time stamp
+	TIME_WORD recvFsTime;	  ///< last frame sync time stamp
+	PHY_RCD antNo;			  ///< antenna number record
+	PHY_RCD beamNo;			  ///< beam number record
+	PHY_RCD beamWd;			  ///< beam width record
+	PHY_RCD tor;			  ///< tx rx state record
+	PHY_RCD frameType;		  ///< frame type record
+	uint32_t sendDataOffset;  ///< antenna configuration bram offset (to implement ping-pong data flow)
+	uint32_t antConfigOffset; ///< antenna configuration bram offset (to implement ping-pong data flow)
+	PHY_ANT_CONFIG antConfig; ///< antenna configuration pointer
+#ifndef EMULATION
+	XAdcPs hwXadc; ///< hardware Xadc instance
+#endif
+	PHY_ANT_ANGLE antNrrwPattern[L1_NUM_ANT_NRRW_PATTERN]; ///< antenna beam scan pattern
+	HWSTATE hwSate;										   ///< hardware state log
+	PHYLOG phyLog;										   ///< physical state log
+	uint32_t lastLogTime;								   /// physical state log time stamp
 } 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];
-
-extern PHY_ANT_ANGLE antSubnrrwPattern[L1_NUM_ANT_SUBNRRW_PATTERN];
-extern PHY_ANT_ANGLE antNrrwPattern[L1_NUM_ANT_NRRW_PATTERN];
-
 /************************** Function Prototypes ******************************/
-int32_t Phy_InstInit(PHY_INST **instPtr, PHY_CONFIG *phyConfig);
+
+/**
+ * @defgroup PhysicalLayer_Main
+ * @{
+ */
+int32_t Phy_Init(PHY_INST **instPtr, PHY_CONFIG *phyConfig);
 void Phy_Destroy(PHY_INST *instPtr);
-
-void Phy_UpdateState(PHY_INST *instPtr);
-void Phy_UpdateHwSate(PHY_INST *instPtr);
-
 void Phy_Start(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);
+void Phy_UpdateState(PHY_INST *instPtr);
 void Phy_PeekRecvData(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_IsFrameReceived(PHY_INST *instPtr);
 bool Phy_IsFrameValid(PHY_INST *instPtr);
 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_GetTimeComp(L1_FRAME_TYPE frameType);
+L1_FRAME_TYPE Phy_GetLastRecvFrameType(PHY_INST *instPtr);
+L1_FRAME_TYPE Phy_GetLastSendFrameType(PHY_INST *instPtr);
+/** @} PhysicalLayer_Utility*/
 
-void Phy_AntConfigInit(PHY_ANT_CONFIG *antConfig);
+/**
-void Phy_AntConfigMode(PHY_INST *instPtr, PHY_ANT_MODE mode);
+ * @defgroup PhysicalLayer_Receive_Estimations
-int32_t Phy_SetBeamWidth(PHY_INST *instPtr, PHY_ANT_BEAM_WIDTH beamWidth);
+ * @{
-int32_t Phy_SetBeamNo(PHY_INST *instPtr, int32_t beamNo);
+ */
-int32_t Phy_SetBeamAngle(PHY_INST *phyInstPtr, double offAx, double rndAx);
+uint8_t Phy_LastScanBeamNo(PHY_INST *instPtr);
-int32_t Phy_SetTimeWord(PHY_INST *instPtr, const TIME_WORD *tmWord, PHY_TIME_WORD_TYPE tmType);
-
 double Phy_GetFreqEst(PHY_INST *instPtr);
 double Phy_GetCoarseFreqEst(PHY_INST *instPtr);
 double Phy_GetFineFreqEst(PHY_INST *instPtr);
@@ -276,4 +293,20 @@ void Phy_GetFrameSyncTimeStamp(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_GetLastReceivedSlotStartTimeStamp(PHY_INST *instPtr, TIME_WORD *slotStart);
-#endif /* PHY_CTRL_H_ */
+/** @} PhysicalLayer_Receive_Estimations*/
+
+/**
+ * @defgroup PhysicalLayer_AntennaControl
+ * @{
+ */
+void Phy_AntConfigInit(PHY_ANT_CONFIG *antConfig);
+void Phy_AntConfigMode(PHY_INST *instPtr, PHY_ANT_MODE mode);
+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_SetBeamNo(PHY_INST *instPtr, int32_t beamNo, PHY_ANT_BEAM_WIDTH beamWidth);
+int32_t Phy_SetBeamAngle(PHY_INST *phyInstPtr, double offAx, double rndAx);
+/** @} PhysicalLayer_AntennaControl*/
+
+#endif // PHY_CTRL_H_
+
+/** @} PhysicalLayer*/

df_datalink_sp/src/networking/phy_layer/phy_reg.h

@@ -1,24 +1,24 @@
 /*****************************************************************************/
 /**
- * Description: Physical layer register definitions
+ * @file phy_layer.h
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief Physical layer controller register definition
+ * @version 0.0
+ * @date 2023-04-24
  *
- * Author: Fan Hao
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * Date: 2021-11-16 00:08
+ * Lab of Communication and Network
- * LastEditors: Fan Hao
- * LastEditTime: 2023-04-24 17:32
- * Revisions: Rev 0.1
- * History:
- * [2021-11-16]: Initial version.
- * [2022-06-18]: New branch for glink control purpose:
- *               -Add poll modephysical layer will start Tx/Rx procedure
- * 				  at specific time stamp.
- * [2023-04-24]: Porting for DUIFEI.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
+/**
+ * @defgroup PhysicalLayer
+ * @{
+ */
 
+/**
+ * @name  PhysicalLayer_REG_Constants
+ * @{
+ */
 #ifndef PHY_REG_H_
 #define PHY_REG_H_
 
@@ -26,20 +26,23 @@
 #include "util.h"
 
 /***************** Macros (Inline Functions) Definitions *********************/
-#define PhyRead(instPtr, addr) IO_In32(instPtr->phyCofig.baseAddr + addr)
+#define PhyRead(instPtr, addr) IO_In32((instPtr)->phyCofig.baseAddr + addr)
-#define PhyWrite(instPtr, addr, value) IO_Out32(instPtr->phyCofig.baseAddr + addr, value)
+#define PhyWrite(instPtr, addr, value) IO_Out32((instPtr)->phyCofig.baseAddr + addr, value)
 
 /************************** Constant Definitions *****************************/
 /**
  * Register: PHY_MAIN_CTRL
  */
-#define PHY_MAIN_CTRL 0X00000000U
+#define PHY_MAIN_CTRL 0x00000000U
 #define PHY_MAIN_CTRL_EN_SHIFT 0
 #define PHY_MAIN_CTRL_EN_WIDTH 1
 #define PHY_MAIN_CTRL_EN_MASK 0x00000001U
 #define PHY_MAIN_CTRL_MODE_SHIFT 8
 #define PHY_MAIN_CTRL_MODE_WIDTH 8
 #define PHY_MAIN_CTRL_MODE_MASK 0x0000FF00U
+#define PHY_MAIN_CTRL_NSCAN_SHIFT 16
+#define PHY_MAIN_CTRL_NSCAN_WIDTH 8
+#define PHY_MAIN_CTRL_NSCAN_MASK 0x00FF0000U
 
 #define PHY_MAIN_CTRL_EN_EN 0x00000001U
 #define PHY_MAIN_CTRL_EN_DSBL 0x00000000U
@@ -275,70 +278,220 @@
 #define BEAM_AXIS_AZ_MASK 0xFFFF0000U
 
 /**
- * Register: ANT_STATUS_0
+ * Register: ANT_STATUS
  */
-#define ANT_STATUS 0x00000048U
+#define ANT_STATUS 0x00000100U
-#define ANT_STATUS_CODE_SHIFT 0
+#define ANT_STATUS_ANT_VOLT_SHIFT 0
-#define ANT_STATUS_CODE_WIDTH 8
-#define ANT_STATUS_CODE_MASK 0x000000FFU
-#define ANT_STATUS_NIL_VOLT_SHIFT 8
-#define ANT_STATUS_NIL_VOLT_WIDTH 8
-#define ANT_STATUS_NIL_VOLT_MASK 0x0000FF00U
-#define ANT_STATUS_RF_VOLT_SHIFT 16
-#define ANT_STATUS_RF_VOLT_WIDTH 8
-#define ANT_STATUS_RF_VOLT_MASK 0x00FF0000U
-#define ANT_STATUS_ANT_VOLT_SHIFT 24
 #define ANT_STATUS_ANT_VOLT_WIDTH 8
-#define ANT_STATUS_ANT_VOLT_MASK 0xFF000000U
+#define ANT_STATUS_ANT_VOLT_MASK 0x000000FFU
+#define ANT_STATUS_ANT_VOLT_OK 0x00000001U
+
+#define ANT_STATUS_RF_VOLT_SHIFT 8
+#define ANT_STATUS_RF_VOLT_WIDTH 8
+#define ANT_STATUS_RF_VOLT_MASK 0x0000FF00U
+#define ANT_STATUS_RF_VOLT_OK 0x00000100U
+
+#define ANT_STATUS_NIL_VOLT_SHIFT 16
+#define ANT_STATUS_NIL_VOLT_WIDTH 8
+#define ANT_STATUS_NIL_VOLT_MASK 0x00FF0000U
+#define ANT_STATUS_NIL_VOLT_OK 0x00010000U
+
+#define ANT_STATUS_CODE_SHIFT 24
+#define ANT_STATUS_CODE_WIDTH 8
+#define ANT_STATUS_CODE_MASK 0xFF000000U
+#define ANT_STATUS_CODE_OK 0x00000000U
 
 /**
  * Register: ANT_FRAME_CNT
  */
-#define ANT_FRAME_CNT 0x0000004CU
+#define ANT_FRAME_CNT 0x00000104U
 #define ANT_FRAME_CNT_SHIFT 0
 #define ANT_FRAME_CNT_WIDTH 32
 #define ANT_FRAME_CNT_MASK 0xFFFFFFFFU
 
 /**
- * Register: RF_STATUS
+ * Register: ANT_RF_STATUS
  */
-#define RF_STATUS 0x00000050U
+#define ANT_RF_STATUS 0x00000108U
-#define RF_STATUS_TEMP_SHIFT 0
+#define ANT_RF_STATUS_TEMP_SHIFT 0
-#define RF_STATUS_TEMP_WIDTH 8
+#define ANT_RF_STATUS_TEMP_WIDTH 8
-#define RF_STATUS_TEMP_MASK 0x000000FFU
+#define ANT_RF_STATUS_TEMP_MASK 0x000000FFU
-#define RF_STATUS_BDLOCK_SHIFT 8
+
-#define RF_STATUS_BDLOCK_WIDTH 8
+#define ANT_RF_STATUS_BBLOCK_SHIFT 8
-#define RF_STATUS_BDLOCK_MASK 0x0000FF00U
+#define ANT_RF_STATUS_BBLOCK_WIDTH 8
-#define RF_STATUS_PLLA_SHIFT 16
+#define ANT_RF_STATUS_BBLOCK_MASK 0x0000FF00U
-#define RF_STATUS_PLLA_WIDTH 8
+#define ANT_RF_STATUS_BBLOCK_OK 0x00000100U
-#define RF_STATUS_PLLA_MASK 0x00FF0000U
+
-#define RF_STATUS_PLLB_SHIFT 24
+#define ANT_RF_STATUS_PLLA_SHIFT 16
-#define RF_STATUS_PLLB_WIDTH 8
+#define ANT_RF_STATUS_PLLA_WIDTH 8
-#define RF_STATUS_PLLB_MASK 0xFF000000U
+#define ANT_RF_STATUS_PLLA_MASK 0x00FF0000U
+#define ANT_RF_STATUS_PLLA_OK 0x00010000U
+
+#define ANT_RF_STATUS_PLLB_SHIFT 24
+#define ANT_RF_STATUS_PLLB_WIDTH 8
+#define ANT_RF_STATUS_PLLB_MASK 0xFF000000U
+#define ANT_RF_STATUS_PLLB_OK 0x01000000U
 
 /**
- * Register: RF_MGC
+ * Register: ANT_RF_MGC
  */
-#define RF_MGC 0x00000054U
+#define ANT_RF_MGC 0x0000010CU
-#define RF_MGC_CH1_SHIFT 0
+#define ANT_RF_MGC_CH1_SHIFT 0
-#define RF_MGC_CH1_WIDTH 4
+#define ANT_RF_MGC_CH1_WIDTH 4
-#define RF_MGC_CH1_MASK 0x0000000FU
+#define ANT_RF_MGC_CH1_MASK 0x0000000FU
-#define RF_MGC_CH2_SHIFT 8
+#define ANT_RF_MGC_CH2_SHIFT 8
-#define RF_MGC_CH2_WIDTH 4
+#define ANT_RF_MGC_CH2_WIDTH 4
-#define RF_MGC_CH2_MASK 0x00000F00U
+#define ANT_RF_MGC_CH2_MASK 0x00000F00U
-#define RF_MGC_CH3_SHIFT 16
+#define ANT_RF_MGC_CH3_SHIFT 16
-#define RF_MGC_CH3_WIDTH 4
+#define ANT_RF_MGC_CH3_WIDTH 4
-#define RF_MGC_CH3_MASK 0x000F0000U
+#define ANT_RF_MGC_CH3_MASK 0x000F0000U
-#define RF_MGC_CH4_SHIFT 24
+#define ANT_RF_MGC_CH4_SHIFT 24
-#define RF_MGC_CH4_WIDTH 4
+#define ANT_RF_MGC_CH4_WIDTH 4
-#define RF_MGC_CH4_MASK 0x0F000000U
+#define ANT_RF_MGC_CH4_MASK 0x0F000000U
 
 /**
- * Register: RF_FRAME_CNT
+ * Register: ANT_RF_FRAME_CNT
  */
-#define RF_FRAME_CNT 0x00000058U
+#define ANT_RF_FRAME_CNT 0x00000110U
-#define RF_FRAME_CNT_SHIFT 0
+#define ANT_RF_FRAME_CNT_SHIFT 0
-#define RF_FRAME_CNT_WIDTH 32
+#define ANT_RF_FRAME_CNT_WIDTH 32
-#define RF_FRAME_CNT_MASK 0xFFFFFFFFU
+#define ANT_RF_FRAME_CNT_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_ACQ_CNT
+ */
+#define PHY_ACQ_CNT 0x00000114U
+#define PHY_ACQ_CNT_SHIFT 0
+#define PHY_ACQ_CNT_WIDTH 32
+#define PHY_ACQ_CNT_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_FRAME_SYNC_CNT
+ */
+#define PHY_FRAME_SYNC_CNT 0x00000118U
+#define PHY_FRAME_SYNC_CNT_SHIFT 0
+#define PHY_FRAME_SYNC_CNT_WIDTH 32
+#define PHY_FRAME_SYNC_CNT_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_DECODE_CNT
+ */
+#define PHY_DECODE_CNT 0x0000011CU
+#define PHY_DECODE_CNT_SHIFT 0
+#define PHY_DECODE_CNT_WIDTH 32
+#define PHY_DECODE_CNT_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_CRC_OK_CNT
+ */
+#define PHY_CRC_OK_CNT 0x00000120U
+#define PHY_CRC_OK_CNT_SHIFT 0
+#define PHY_CRC_OK_CNT_WIDTH 32
+#define PHY_CRC_OK_CNT_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_ACQ_PEAK_H
+ */
+#define PHY_ACQ_PEAK_H 0x00000124U
+#define PHY_ACQ_PEAK_H_SHIFT 0
+#define PHY_ACQ_PEAK_H_WIDTH 32
+#define PHY_ACQ_PEAK_H_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_ACQ_PEAK_L
+ */
+#define PHY_ACQ_PEAK_L 0x00000128U
+#define PHY_ACQ_PEAK_L_SHIFT 0
+#define PHY_ACQ_PEAK_L_WIDTH 32
+#define PHY_ACQ_PEAK_L_MASK 0xFFFFFFFFU
+
+
+/**
+ * Register: PHY_ACQ_MEAN_H
+ */
+#define PHY_ACQ_MEAN_H 0x0000012CU
+#define PHY_ACQ_MEAN_H_SHIFT 0
+#define PHY_ACQ_MEAN_H_WIDTH 32
+#define PHY_ACQ_MEAN_H_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_ACQ_MEAN_L
+ */
+#define PHY_ACQ_MEAN_L 0x00000130U
+#define PHY_ACQ_MEAN_L_SHIFT 0
+#define PHY_ACQ_MEAN_L_WIDTH 32
+#define PHY_ACQ_MEAN_L_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_ACQ_FREQEST
+ */
+#define PHY_ACQ_FREQEST 0x00000134U
+#define PHY_ACQ_FREQEST_SHIFT 0
+#define PHY_ACQ_FREQEST_WIDTH 32
+#define PHY_ACQ_FREQEST_MASK 0xFFFFFFFFU
+
+#define PHY_ACQ_FREQEST_PHASE_SHIFT 0
+#define PHY_ACQ_FREQEST_PHASE_WIDTH 8
+#define PHY_ACQ_FREQEST_PHASE_MASK 0x000000FFU
+#define PHY_ACQ_FREQEST_CHANNEL_SHIFT 8
+#define PHY_ACQ_FREQEST_CHANNEL_WIDTH 8
+#define PHY_ACQ_FREQEST_CHANNEL_MASK 0x0000FF00U
+
+/**
+ * Register: PHY_FRAME_SYNC_PEAK_H
+ */
+#define PHY_FRAME_SYNC_PEAK_H 0x00000138U
+#define PHY_FRAME_SYNC_PEAK_H_SHIFT 0
+#define PHY_FRAME_SYNC_PEAK_H_WIDTH 32
+#define PHY_FRAME_SYNC_PEAK_H_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_FRAME_SYNC_PEAK_L
+ */
+#define PHY_FRAME_SYNC_PEAK_L 0x0000013CU
+#define PHY_FRAME_SYNC_PEAK_L_SHIFT 0
+#define PHY_FRAME_SYNC_PEAK_L_WIDTH 32
+#define PHY_FRAME_SYNC_PEAK_L_MASK 0xFFFFFFFFU
+
+
+/**
+ * Register: PHY_FRAME_SYNC_MEAN_H
+ */
+#define PHY_FRAME_SYNC_MEAN_H 0x00000140U
+#define PHY_FRAME_SYNC_MEAN_H_SHIFT 0
+#define PHY_FRAME_SYNC_MEAN_H_WIDTH 32
+#define PHY_FRAME_SYNC_MEAN_H_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_FRAME_SYNC_MEAN_L
+ */
+#define PHY_FRAME_SYNC_MEAN_L 0x00000144U
+#define PHY_FRAME_SYNC_MEAN_L_SHIFT 0
+#define PHY_FRAME_SYNC_MEAN_L_WIDTH 32
+#define PHY_FRAME_SYNC_MEAN_L_MASK 0xFFFFFFFFU
+
+/**
+ * Register: PHY_FRAME_SYNC_FREQEST
+ */
+#define PHY_FRAME_SYNC_FREQEST 0x00000148U
+#define PHY_FRAME_SYNC_FREQEST_SHIFT 0
+#define PHY_FRAME_SYNC_FREQEST_WIDTH 32
+#define PHY_FRAME_SYNC_FREQEST_MASK 0xFFFFFFFFU
+
+#define PHY_FRAME_SYNC_FREQEST_CHANNEL_SHIFT 0
+#define PHY_FRAME_SYNC_FREQEST_CHANNEL_WIDTH 8
+#define PHY_FRAME_SYNC_FREQEST_CHANNEL_MASK 0x000000FFU
+
+/**
+ * Register: PHY_DEINTLV_AMPEST
+ */
+#define PHY_DEINTLV_AMPEST 0x0000014CU
+#define PHY_DEINTLV_AMPEST_SHIFT 0
+#define PHY_DEINTLV_AMPEST_WIDTH 16
+#define PHY_DEINTLV_AMPEST_MASK 0x0000FFFFU
 
 #endif /* PHY_REG_H_ */
+
+/** @} PhysicalLayer_REG_Constants*/
+
+/** @} PhysicalLayer*/

df_datalink_sp/src/system_monitor.c

@@ -1,9 +1,19 @@
+/**
+ * @addtogroup SystemMonitor
+ * @{
+ */
+
+/***************************** Include Files *********************************/
 #include <string.h>
 #include <stdlib.h>
 #include <stdint.h>
 #include "common.h"
 #include "system_monitor.h"
-
+/************************** Constant Definitions *****************************/
+/**
+ * @name SystemMonitor_Private_Constants
+ * @{
+ */
 #define BUFF_A 0x00
 #define BUFF_B 0x01
 #define BUFF_NONE 0xFF
@@ -13,38 +23,47 @@
 #define SLOTLOG_PACK_LEN 88	 // bytes
 #define PRTCLLOG_PACK_ELN 24 // bytes
 #define HWSTATE_PACK_ELN 12	 // bytes
-
+/** @} SystemMonitor_Private_Constants*/
+/************************** Data Type Definitions ****************************/
+/**
+ * @struct PINGPONG
+ * @brief PingPing Control
+ */
 typedef struct
 {
-	uint8_t latest;
+	uint8_t latest; ///< latest available index
-	uint8_t rBusy;
+	uint8_t rBusy;	///< current read busy index
-	uint8_t wBusy;
+	uint8_t wBusy;	///< current write busy index
 } PINGPONG;
 
+/**
+ * @struct SYSMONITOR
+ * @brief System Monitor struct holds all the system log info
+ */
 typedef struct
 {
-	PINGPONG recvPLCtrl;
+	PINGPONG recvCtrl;
-	PAYLOAD recvPL[2];
+	PAYLOAD recv[2];
-	PINGPONG sendPLCtrl;
+	PINGPONG sendCtrl;
-	PAYLOAD sendPL[2];
+	PAYLOAD send[2];
 	PINGPONG sysInfoCtrl;
 	SYSINFO sysInfo[2];
-	PINGPONG sendLogCtrl;
+	PINGPONG linkLogCtrl;
-	SLOTLOG sendLog[2];
+	LINKLOG linkLog[2];
-	PINGPONG recvLogCtrl;
+	PINGPONG phyLogCtrl;
-	SLOTLOG recvLog[2];
+	PHYLOG phyLog[2];
-	PINGPONG protocolLogCtrl;
-	PRTCLLOG protocolLog[2];
 	PINGPONG hwStateCtrl;
 	HWSTATE hwState[2];
 } SYSMONITOR;
 
+/************************** Function Prototypes ******************************/
+static uint8_t GetWritable(PINGPONG ctrllor);
+static uint8_t GetReadable(PINGPONG ctrllor);
+/************************** Variable Definitions *****************************/
 static SYSMONITOR *sysMonitorInst;
 
-uint8_t GetWritable(PINGPONG ctrllor);
+/*********************** Function Implementations  ***************************/
-uint8_t GetReadable(PINGPONG ctrllor);
+inline static uint8_t GetWritable(PINGPONG ctrllor)
-
-inline uint8_t GetWritable(PINGPONG ctrllor)
 {
 	// Allow only one write.
 	ASSERT(ctrllor.wBusy == BUFF_NONE);
@@ -54,7 +73,7 @@ inline uint8_t GetWritable(PINGPONG ctrllor)
 		return ((ctrllor.rBusy == BUFF_B) ? BUFF_A : BUFF_B);
 }
 
-inline uint8_t GetReadable(PINGPONG ctrllor)
+inline static uint8_t GetReadable(PINGPONG ctrllor)
 {
 	if (ctrllor.wBusy == BUFF_NONE || ctrllor.wBusy != ctrllor.latest)
 		return ((ctrllor.latest == BUFF_NONE) ? BUFF_A : BUFF_B);
@@ -62,7 +81,11 @@ inline uint8_t GetReadable(PINGPONG ctrllor)
 		return ((ctrllor.wBusy == BUFF_B) ? BUFF_A : BUFF_B);
 }
 
-// System monitor initialise
+/**
+ * @brief Initialize System monitor
+ *
+ * @return SUCCESS
+ */
 int32_t SysMonitor_Init(void)
 {
 	sysMonitorInst = calloc(1, sizeof(SYSMONITOR));
@@ -70,33 +93,39 @@ int32_t SysMonitor_Init(void)
 	{
 		return ENOMEM;
 	}
-	memset(&(sysMonitorInst->recvPLCtrl), BUFF_NONE, sizeof(PINGPONG));
+	memset(&(sysMonitorInst->recvCtrl), BUFF_NONE, sizeof(PINGPONG));
-	memset(&(sysMonitorInst->sendPLCtrl), BUFF_NONE, sizeof(PINGPONG));
+	memset(&(sysMonitorInst->sendCtrl), BUFF_NONE, sizeof(PINGPONG));
 	memset(&(sysMonitorInst->sysInfoCtrl), BUFF_NONE, sizeof(PINGPONG));
-	memset(&(sysMonitorInst->sendLogCtrl), BUFF_NONE, sizeof(PINGPONG));
+	memset(&(sysMonitorInst->linkLogCtrl), BUFF_NONE, sizeof(PINGPONG));
-	memset(&(sysMonitorInst->recvLogCtrl), BUFF_NONE, sizeof(PINGPONG));
+	memset(&(sysMonitorInst->phyLogCtrl), BUFF_NONE, sizeof(PINGPONG));
-	memset(&(sysMonitorInst->protocolLogCtrl), BUFF_NONE, sizeof(PINGPONG));
 	memset(&(sysMonitorInst->hwStateCtrl), BUFF_NONE, sizeof(PINGPONG));
 
-	sysMonitorInst->recvPL[0].dataId_flj = DATA_ID_NONE;
+	sysMonitorInst->recv[0].dataId = DATA_ID_NONE;
-	sysMonitorInst->recvPL[0].dataId_lj = DATA_ID_NONE;
+	sysMonitorInst->recv[1].dataId = DATA_ID_NONE;
-	sysMonitorInst->recvPL[1].dataId_flj = DATA_ID_NONE;
+	sysMonitorInst->send[0].dataId = DATA_ID_NONE;
-	sysMonitorInst->recvPL[1].dataId_lj = DATA_ID_NONE;
+	sysMonitorInst->send[1].dataId = DATA_ID_NONE;
-	sysMonitorInst->sendPL[0].dataId_flj = DATA_ID_NONE;
-	sysMonitorInst->sendPL[0].dataId_lj = DATA_ID_NONE;
-	sysMonitorInst->sendPL[1].dataId_flj = DATA_ID_NONE;
-	sysMonitorInst->sendPL[1].dataId_lj = DATA_ID_NONE;
 	return SUCCESS;
 }
 
-// System monitor initialise
+/**
+ * @brief Destroy system monitor release all allocated memory
+ */
 void SysMonitor_Destroy(void)
 {
 	free(sysMonitorInst);
 }
 
-// @System Info
+/**
-void SysMonitor_UpdateSysinfo(SYSINFO *info)
+ * @name SystemInfo_API
+ * @{
+ */
+
+/**
+ * @brief Update system info.
+ *
+ * @param info
+ */
+void SysMonitor_UpdateSysinfo(const SYSINFO *info)
 {
 	uint8_t buffIndx;
 	buffIndx = GetWritable(sysMonitorInst->sysInfoCtrl);
@@ -106,49 +135,11 @@ void SysMonitor_UpdateSysinfo(SYSINFO *info)
 	sysMonitorInst->sysInfoCtrl.wBusy = BUFF_NONE;
 }
 
-void SysMonitor_UpdateSysinfoRaw(uint8_t *buff)
+/**
-{
+ * @brief Get system info.
-	ASSERT(sysMonitorInst != NULL);
+ *
-	uint8_t buffIndx;
+ * @param info
-	buffIndx = GetWritable(sysMonitorInst->sysInfoCtrl);
+ */
-	sysMonitorInst->sysInfoCtrl.wBusy = buffIndx;
-	// Decapsulate Systeminfo
-	SYSINFO *infoEntry = &(sysMonitorInst->sysInfo[buffIndx]);
-	memcpy(&(infoEntry->psBDS), buff, sizeof(infoEntry->psBDS));
-	buff += sizeof(infoEntry->psBDS);
-	memcpy(&(infoEntry->pBDS), buff, sizeof(infoEntry->pBDS));
-	buff += sizeof(infoEntry->pBDS);
-	memcpy(&(infoEntry->psGPS), buff, sizeof(infoEntry->psGPS));
-	buff += sizeof(infoEntry->psGPS);
-	memcpy(&(infoEntry->pGPS), buff, sizeof(infoEntry->pGPS));
-	buff += sizeof(infoEntry->pGPS);
-	memcpy(&(infoEntry->tmInd), buff, sizeof(infoEntry->tmInd));
-	buff += sizeof(infoEntry->tmInd);
-	memcpy(&(infoEntry->tmFly), buff, sizeof(infoEntry->tmFly));
-	buff += sizeof(infoEntry->tmFly);
-	memcpy(&(infoEntry->stFly), buff, sizeof(infoEntry->stFly));
-	buff += sizeof(infoEntry->stFly);
-	memcpy(&(infoEntry->posX), buff, sizeof(infoEntry->posX));
-	buff += sizeof(infoEntry->posX);
-	memcpy(&(infoEntry->posY), buff, sizeof(infoEntry->posY));
-	buff += sizeof(infoEntry->posY);
-	memcpy(&(infoEntry->posZ), buff, sizeof(infoEntry->posZ));
-	buff += sizeof(infoEntry->posZ);
-	memcpy(&(infoEntry->vX), buff, sizeof(infoEntry->vX));
-	buff += sizeof(infoEntry->vX);
-	memcpy(&(infoEntry->vY), buff, sizeof(infoEntry->vY));
-	buff += sizeof(infoEntry->vY);
-	memcpy(&(infoEntry->vZ), buff, sizeof(infoEntry->vZ));
-	buff += sizeof(infoEntry->vZ);
-	memcpy(&(infoEntry->pitch), buff, sizeof(infoEntry->pitch));
-	buff += sizeof(infoEntry->pitch);
-	memcpy(&(infoEntry->yaw), buff, sizeof(infoEntry->yaw));
-	buff += sizeof(infoEntry->yaw);
-	memcpy(&(infoEntry->roll), buff, sizeof(infoEntry->roll));
-	sysMonitorInst->sysInfoCtrl.latest = buffIndx;
-	sysMonitorInst->sysInfoCtrl.wBusy = BUFF_NONE;
-}
-
 void SysMonitor_GetSysinfo(SYSINFO *info)
 {
 	ASSERT(sysMonitorInst != NULL);
@@ -162,398 +153,222 @@ void SysMonitor_GetSysinfo(SYSINFO *info)
 	memcpy(info, &(sysMonitorInst->sysInfo[buffIndx]), sizeof(SYSINFO));
 	sysMonitorInst->sysInfoCtrl.rBusy = buffIndex_old;
 }
-
+/** @} SystemInfo_API*/
-void SysMonitor_GetSysinfoRaw(uint8_t *buff)
-{
-	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->sysInfoCtrl.rBusy;
-	if (buffIndex_old != BUFF_NONE)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->sysInfoCtrl);
-	sysMonitorInst->sysInfoCtrl.rBusy = buffIndx;
-
-	// Encapsulate Systeminfo
-	SYSINFO *infoEntry = &(sysMonitorInst->sysInfo[buffIndx]);
-	memcpy(buff, &(infoEntry->psBDS), sizeof(infoEntry->psBDS));
-	buff += sizeof(infoEntry->psBDS);
-	memcpy(buff, &(infoEntry->pBDS), sizeof(infoEntry->pBDS));
-	buff += sizeof(infoEntry->pBDS);
-	memcpy(buff, &(infoEntry->psGPS), sizeof(infoEntry->psGPS));
-	buff += sizeof(infoEntry->psGPS);
-	memcpy(buff, &(infoEntry->pGPS), sizeof(infoEntry->pGPS));
-	buff += sizeof(infoEntry->pGPS);
-	memcpy(buff, &(infoEntry->tmInd), sizeof(infoEntry->tmInd));
-	buff += sizeof(infoEntry->tmInd);
-	memcpy(buff, &(infoEntry->tmFly), sizeof(infoEntry->tmFly));
-	buff += sizeof(infoEntry->tmFly);
-	memcpy(buff, &(infoEntry->stFly), sizeof(infoEntry->stFly));
-	buff += sizeof(infoEntry->stFly);
-	memcpy(buff, &(infoEntry->posX), sizeof(infoEntry->posX));
-	buff += sizeof(infoEntry->posX);
-	memcpy(buff, &(infoEntry->posY), sizeof(infoEntry->posY));
-	buff += sizeof(infoEntry->posY);
-	memcpy(buff, &(infoEntry->posZ), sizeof(infoEntry->posZ));
-	buff += sizeof(infoEntry->posZ);
-	memcpy(buff, &(infoEntry->vX), sizeof(infoEntry->vX));
-	buff += sizeof(infoEntry->vX);
-	memcpy(buff, &(infoEntry->vY), sizeof(infoEntry->vY));
-	buff += sizeof(infoEntry->vY);
-	memcpy(buff, &(infoEntry->vZ), sizeof(infoEntry->vZ));
-	buff += sizeof(infoEntry->vZ);
-	memcpy(buff, &(infoEntry->pitch), sizeof(infoEntry->pitch));
-	buff += sizeof(infoEntry->pitch);
-	memcpy(buff, &(infoEntry->yaw), sizeof(infoEntry->yaw));
-	buff += sizeof(infoEntry->yaw);
-	memcpy(buff, &(infoEntry->roll), sizeof(infoEntry->roll));
-	sysMonitorInst->sysInfoCtrl.rBusy = buffIndex_old;
-}
-//  @Send Payload
-/**
- * Update send FLJ payload by raw data.
- */
-void SysMonitor_UpdateSendPayloadFLJRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx;
-	buffIndx = GetWritable(sysMonitorInst->sendPLCtrl);
-	sysMonitorInst->sendPLCtrl.wBusy = buffIndx;
-	memcpy(sysMonitorInst->sendPL[buffIndx].data_flj, buff, sizeof(uint8_t) * PAYLOAD_FLJ_TX);
-	sysMonitorInst->sendPL[buffIndx].dataId_flj++;
-	sysMonitorInst->sendPLCtrl.latest = buffIndx;
-	sysMonitorInst->sendPLCtrl.wBusy = BUFF_NONE;
-}
 
 /**
- * Get send FLJ payload as raw data.
+ * @name ServicePayload_API
+ * @{
  */
-void SysMonitor_GetSendPayloadFLJRaw(uint8_t *buff, uint32_t *id)
+
+/**
+ * @brief Update send payload by
+ *
+ * @param buff
+ * @param len
+ */
+void SysMonitor_UpdateSendPayload(const uint8_t *buff, size_t len)
 {
 	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx, buffIndex_old;
+	if (len > PAYLOAD_LEN_MAX)
-	buffIndex_old = sysMonitorInst->sendPLCtrl.rBusy;
-	if (buffIndex_old != BUFF_NONE)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->sendPLCtrl);
-	sysMonitorInst->sendPLCtrl.rBusy = buffIndx;
-	if (sysMonitorInst->sendPL[buffIndx].dataId_flj != DATA_ID_NONE)
 	{
-		memcpy(buff, sysMonitorInst->sendPL[buffIndx].data_flj, sizeof(uint8_t) * PAYLOAD_FLJ_TX);
+		return;
 	}
-	*id = sysMonitorInst->sendPL[buffIndx].dataId_flj;
-	sysMonitorInst->sendPLCtrl.rBusy = buffIndex_old;
-}
-
-/**
- * Update LJ send payload by raw data.
- */
-void SysMonitor_UpdateSendPayloadLJRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
 	uint8_t buffIndx;
-	buffIndx = GetWritable(sysMonitorInst->sendPLCtrl);
+	buffIndx = GetWritable(sysMonitorInst->sendCtrl);
-	sysMonitorInst->sendPLCtrl.wBusy = buffIndx;
+	sysMonitorInst->sendCtrl.wBusy = buffIndx;
-	memcpy(sysMonitorInst->sendPL[buffIndx].data_lj, buff, sizeof(uint8_t) * PAYLOAD_LJ_TX);
+	memcpy(sysMonitorInst->send[buffIndx].data, buff, len);
-	sysMonitorInst->sendPL[buffIndx].dataId_lj++;
+	sysMonitorInst->send[buffIndx].dataId++;
-	sysMonitorInst->sendPLCtrl.latest = buffIndx;
+	sysMonitorInst->sendCtrl.latest = buffIndx;
-	sysMonitorInst->sendPLCtrl.wBusy = BUFF_NONE;
+	sysMonitorInst->sendCtrl.wBusy = BUFF_NONE;
 }
 
 /**
- * Get send LJ payload as raw data.
+ * @brief Get the latest send payload.
+ *
+ * @param buff
+ * @param id
+ * @param len
  */
-void SysMonitor_GetSendPayloadLJRaw(uint8_t *buff, uint32_t *id)
+void SysMonitor_GetSendPayload(uint8_t *buff, uint32_t *id, size_t len)
 {
 	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx, buffIndex_old;
+	ASSERT(buff != NULL);
-	buffIndex_old = sysMonitorInst->sendPLCtrl.rBusy;
+	ASSERT(id != NULL);
-	if (buffIndex_old != BUFF_NONE)
+	if (len > PAYLOAD_LEN_MAX)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->sendPLCtrl);
-	sysMonitorInst->sendPLCtrl.rBusy = buffIndx;
-	if (sysMonitorInst->sendPL[buffIndx].dataId_lj != DATA_ID_NONE) 
 	{
-		memcpy(buff, sysMonitorInst->sendPL[buffIndx].data_lj, sizeof(uint8_t) * PAYLOAD_LJ_TX);
+		return;
 	}
-	*id = sysMonitorInst->sendPL[buffIndx].dataId_lj;
-	sysMonitorInst->sendPLCtrl.rBusy = buffIndex_old;
-}
-
-//  @Receive Payload
-/**
- * Update receive FLJ payload by raw data.
- */
-void SysMonitor_UpdateRecvPayloadFLJRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx;
-	buffIndx = GetWritable(sysMonitorInst->recvPLCtrl);
-	sysMonitorInst->recvPLCtrl.wBusy = buffIndx;
-	memcpy(sysMonitorInst->recvPL[buffIndx].data_flj, buff, sizeof(uint8_t) * PAYLOAD_FLJ_RX);
-	sysMonitorInst->recvPL[buffIndx].dataId_flj++;
-	sysMonitorInst->recvPLCtrl.latest = buffIndx;
-	sysMonitorInst->recvPLCtrl.wBusy = BUFF_NONE;
-}
-
-/**
- * Get send FLJ payload as raw data.
- */
-void SysMonitor_GetRecvPayloadFLJRaw(uint8_t *buff, uint32_t *id)
-{
-	ASSERT(sysMonitorInst != NULL);
 	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->recvPLCtrl.rBusy;
+	buffIndex_old = sysMonitorInst->sendCtrl.rBusy;
 	if (buffIndex_old != BUFF_NONE)
 		buffIndx = buffIndex_old; // Keep it busy
 	else
-		buffIndx = GetReadable(sysMonitorInst->recvPLCtrl);
+		buffIndx = GetReadable(sysMonitorInst->sendCtrl);
-	sysMonitorInst->recvPLCtrl.rBusy = buffIndx;
+	sysMonitorInst->sendCtrl.rBusy = buffIndx;
-	if (sysMonitorInst->recvPL[buffIndx].dataId_flj != DATA_ID_NONE)
+	if (sysMonitorInst->send[buffIndx].dataId != DATA_ID_NONE)
 	{
-		memcpy(buff, sysMonitorInst->recvPL[buffIndx].data_flj, sizeof(uint8_t) * PAYLOAD_FLJ_RX);
+		memcpy(buff, sysMonitorInst->send[buffIndx].data, len);
 	}
-	*id = sysMonitorInst->recvPL[buffIndx].dataId_flj;
+	*id = sysMonitorInst->send[buffIndx].dataId;
-	sysMonitorInst->recvPLCtrl.rBusy = buffIndex_old;
+	sysMonitorInst->sendCtrl.rBusy = buffIndex_old;
 }
 
 /**
- * Update receive LJ payload by raw data.
+ * @brief Update receive payload.
+ *
+ * @param buff
+ * @param id
+ * @param len
  */
-void SysMonitor_UpdateRecvPayloadLJRaw(uint8_t *buff)
+void SysMonitor_UpdateRecvPayload(const uint8_t *buff, uint32_t id, size_t len)
 {
 	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx;
+	ASSERT(buff != NULL);
-	buffIndx = GetWritable(sysMonitorInst->recvPLCtrl);
+	if (id == DATA_ID_NONE || len > PAYLOAD_LEN_MAX)
-	sysMonitorInst->recvPLCtrl.wBusy = buffIndx;
-	memcpy(sysMonitorInst->recvPL[buffIndx].data_lj, buff, sizeof(uint8_t) * PAYLOAD_LJ_RX);
-	sysMonitorInst->recvPL[buffIndx].dataId_lj++;
-	sysMonitorInst->recvPLCtrl.latest = buffIndx;
-	sysMonitorInst->recvPLCtrl.wBusy = BUFF_NONE;
-}
-
-/**
- * Get send LJ payload as raw data.
- */
-void SysMonitor_GetRecvPayloadLJRaw(uint8_t *buff, uint32_t *id)
-{
-	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->recvPLCtrl.rBusy;
-	if (buffIndex_old != BUFF_NONE)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->recvPLCtrl);
-	sysMonitorInst->recvPLCtrl.rBusy = buffIndx;
-	if (sysMonitorInst->recvPL[buffIndx].dataId_lj != DATA_ID_NONE) 
 	{
-		memcpy(buff, sysMonitorInst->recvPL[buffIndx].data_lj, sizeof(uint8_t) * PAYLOAD_LJ_RX);
+		return;
 	}
-	*id = sysMonitorInst->recvPL[buffIndx].dataId_lj;
-	sysMonitorInst->recvPLCtrl.rBusy = buffIndex_old;
-}
-
-//  @Send Slot log
-/**
- * Log send slot information
- */
-void SysMonitor_UpdateSendSlotLog(SLOTLOG *log)
-{
-	ASSERT(sysMonitorInst != NULL);
 	uint8_t buffIndx;
-	buffIndx = GetWritable(sysMonitorInst->sendLogCtrl);
+	buffIndx = GetWritable(sysMonitorInst->recvCtrl);
-	sysMonitorInst->sendLogCtrl.wBusy = buffIndx;
+	sysMonitorInst->recvCtrl.wBusy = buffIndx;
-	memcpy(&(sysMonitorInst->sendLog[buffIndx]), log, sizeof(SLOTLOG));
+	memcpy(sysMonitorInst->recv[buffIndx].data, buff, len);
-	sysMonitorInst->sendLogCtrl.latest = buffIndx;
+	sysMonitorInst->recv[buffIndx].dataId = id;
-	sysMonitorInst->sendLogCtrl.wBusy = BUFF_NONE;
+	sysMonitorInst->recvCtrl.latest = buffIndx;
+	sysMonitorInst->recvCtrl.wBusy = BUFF_NONE;
 }
 
 /**
- * Get the latest send slot log
+ * @brief Get the latest receive payload.
+ *
+ * @param buff
+ * @param id
+ * @param len
  */
-void SysMonitor_GetSendSlotLog(SLOTLOG *log)
+void SysMonitor_GetRecvPayload(uint8_t *buff, uint32_t *id, size_t len)
 {
 	ASSERT(sysMonitorInst != NULL);
+	ASSERT(buff != NULL);
+	ASSERT(id != NULL);
+	if (len > PAYLOAD_LEN_MAX)
+	{
+		return;
+	}
 	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->sendLogCtrl.rBusy;
+	buffIndex_old = sysMonitorInst->recvCtrl.rBusy;
 	if (buffIndex_old != BUFF_NONE)
 		buffIndx = buffIndex_old; // Keep it busy
 	else
-		buffIndx = GetReadable(sysMonitorInst->sendLogCtrl);
+		buffIndx = GetReadable(sysMonitorInst->recvCtrl);
-	sysMonitorInst->sendLogCtrl.rBusy = buffIndx;
+	sysMonitorInst->recvCtrl.rBusy = buffIndx;
-	memcpy(log, &(sysMonitorInst->sendLog[buffIndx]), sizeof(SLOTLOG));
+	if (sysMonitorInst->recv[buffIndx].dataId != DATA_ID_NONE)
-	sysMonitorInst->sendLogCtrl.rBusy = buffIndex_old;
+	{
+		memcpy(buff, sysMonitorInst->recv[buffIndx].data, len);
+	}
+	*id = sysMonitorInst->recv[buffIndx].dataId;
+	sysMonitorInst->recvCtrl.rBusy = buffIndex_old;
 }
+/** @} ServicePayload_API*/
 
 /**
- * Get the latest send slot log as raw data
+ * @name Linklayer_Log_API
+ * @{
  */
-void SysMonitor_GetSendSlotLogRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->sendLogCtrl.rBusy;
-	if (buffIndex_old != BUFF_NONE)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->sendLogCtrl);
-	sysMonitorInst->sendLogCtrl.rBusy = buffIndx;
 
-	// Encapsulate log
-	SLOTLOG *logEntry = &(sysMonitorInst->sendLog[buffIndx]);
-	memcpy(buff, &(logEntry->tuNo), sizeof(logEntry->tuNo));
-	buff += sizeof(logEntry->tuNo);
-	memcpy(buff, &(logEntry->slotNo), sizeof(logEntry->slotNo));
-	buff += sizeof(logEntry->slotNo);
-	memcpy(buff, &(logEntry->frameType), sizeof(logEntry->frameType));
-	buff += sizeof(logEntry->frameType);
-	memcpy(buff, &(logEntry->payload), sizeof(logEntry->payload));
-	buff += sizeof(logEntry->payload);
-	memcpy(buff, &(logEntry->tmStamp), sizeof(logEntry->tmStamp));
-	buff += sizeof(logEntry->tmStamp);
-	memcpy(buff, &(logEntry->tmDevi), sizeof(logEntry->tmDevi));
-	buff += sizeof(logEntry->tmDevi);
-	memcpy(buff, &(logEntry->freqDevi), sizeof(logEntry->freqDevi));
-	sysMonitorInst->sendLogCtrl.rBusy = buffIndex_old;
-}
-
-// @Receive Slot log
 /**
- * Log receive slot information
+ * @brief Update link layer log
+ *
+ * @param log
  */
-void SysMonitor_UpdateRecvSlotLog(SLOTLOG *log)
+void SysMonitor_UpdateLinklayerLog(const LINKLOG *log)
 {
 	ASSERT(sysMonitorInst != NULL);
+	ASSERT(log != NULL);
 	uint8_t buffIndx;
-	buffIndx = GetWritable(sysMonitorInst->recvLogCtrl);
+	buffIndx = GetWritable(sysMonitorInst->linkLogCtrl);
-	sysMonitorInst->recvLogCtrl.wBusy = buffIndx;
+	sysMonitorInst->linkLogCtrl.wBusy = buffIndx;
-	memcpy(&(sysMonitorInst->recvLog[buffIndx]), log, sizeof(SLOTLOG));
+	memcpy(&(sysMonitorInst->linkLog[buffIndx]), log, sizeof(LINKLOG));
-	sysMonitorInst->recvLogCtrl.latest = buffIndx;
+	sysMonitorInst->linkLogCtrl.latest = buffIndx;
-	sysMonitorInst->recvLogCtrl.wBusy = BUFF_NONE;
+	sysMonitorInst->linkLogCtrl.wBusy = BUFF_NONE;
 }
 
 /**
- * Get the latest receive slot information
+ * @brief Get the latest link layer log
+ *
+ * @param log
  */
-void SysMonitor_GetRecvSlotLog(SLOTLOG *log)
+void SysMonitor_GetLinklayerLog(LINKLOG *log)
 {
 	ASSERT(sysMonitorInst != NULL);
+	ASSERT(log != NULL);
 	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->recvLogCtrl.rBusy;
+	buffIndex_old = sysMonitorInst->linkLogCtrl.rBusy;
 	if (buffIndex_old != BUFF_NONE)
 		buffIndx = buffIndex_old; // Keep it busy
 	else
-		buffIndx = GetReadable(sysMonitorInst->recvLogCtrl);
+		buffIndx = GetReadable(sysMonitorInst->linkLogCtrl);
-	sysMonitorInst->recvLogCtrl.rBusy = buffIndx;
+	sysMonitorInst->linkLogCtrl.rBusy = buffIndx;
-	memcpy(log, &(sysMonitorInst->recvLog[buffIndx]), sizeof(SLOTLOG));
+	memcpy(log, &(sysMonitorInst->linkLog[buffIndx]), sizeof(LINKLOG));
-	sysMonitorInst->recvLogCtrl.rBusy = buffIndex_old;
+	sysMonitorInst->linkLogCtrl.rBusy = buffIndex_old;
 }
+/** @} Linklayer_Log_API*/
 
 /**
- * Get the latest receive slot information as raw data
+ * @name PhysicalLayer_Log_API
+ * @{
  */
-void SysMonitor_GetRecvSlotLogRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->recvLogCtrl.rBusy;
-	if (buffIndex_old != BUFF_NONE)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->recvLogCtrl);
-	sysMonitorInst->recvLogCtrl.rBusy = buffIndx;
 
-	// Encapsulate log
-	SLOTLOG *logEntry = &(sysMonitorInst->recvLog[buffIndx]);
-	memcpy(buff, &(logEntry->tuNo), sizeof(logEntry->tuNo));
-	buff += sizeof(logEntry->tuNo);
-	memcpy(buff, &(logEntry->slotNo), sizeof(logEntry->slotNo));
-	buff += sizeof(logEntry->slotNo);
-	memcpy(buff, &(logEntry->frameType), sizeof(logEntry->frameType));
-	buff += sizeof(logEntry->frameType);
-	memcpy(buff, &(logEntry->payload), sizeof(logEntry->payload));
-	buff += sizeof(logEntry->payload);
-	memcpy(buff, &(logEntry->tmStamp), sizeof(logEntry->tmStamp));
-	buff += sizeof(logEntry->tmStamp);
-	memcpy(buff, &(logEntry->tmDevi), sizeof(logEntry->tmDevi));
-	buff += sizeof(logEntry->tmDevi);
-	memcpy(buff, &(logEntry->freqDevi), sizeof(logEntry->freqDevi));
-	sysMonitorInst->recvLogCtrl.rBusy = buffIndex_old;
-}
-
-// @Protocol log
 /**
- * Log protocol running status.
+ * @brief Update physical layer log
+ *
+ * @param log
  */
-void SysMonitor_UpdateProtocolLog(PRTCLLOG *log)
+void SysMonitor_UpdatePhysicalLayerLog(const PHYLOG *log)
 {
 	ASSERT(sysMonitorInst != NULL);
+	ASSERT(log != NULL);
 	uint8_t buffIndx;
-	buffIndx = GetWritable(sysMonitorInst->protocolLogCtrl);
+	buffIndx = GetWritable(sysMonitorInst->phyLogCtrl);
-	sysMonitorInst->protocolLogCtrl.wBusy = buffIndx;
+	sysMonitorInst->phyLogCtrl.wBusy = buffIndx;
-	memcpy(&(sysMonitorInst->protocolLog[buffIndx]), log, sizeof(PRTCLLOG));
+	memcpy(&(sysMonitorInst->phyLog[buffIndx]), log, sizeof(PHYLOG));
-	sysMonitorInst->protocolLogCtrl.latest = buffIndx;
+	sysMonitorInst->phyLogCtrl.latest = buffIndx;
-	sysMonitorInst->protocolLogCtrl.wBusy = BUFF_NONE;
+	sysMonitorInst->phyLogCtrl.wBusy = BUFF_NONE;
 }
 
 /**
- * Get the protocol running log.
+ * @brief Get the latest physical layer log
+ *
+ * @param log
  */
-void SysMonitor_GetProtocolLog(PRTCLLOG *log)
+void SysMonitor_GetPhysicalLayerLog(PHYLOG *log)
 {
 	ASSERT(sysMonitorInst != NULL);
+	ASSERT(log != NULL);
 	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->protocolLogCtrl.rBusy;
+	buffIndex_old = sysMonitorInst->phyLogCtrl.rBusy;
 	if (buffIndex_old != BUFF_NONE)
 		buffIndx = buffIndex_old; // Keep it busy
 	else
-		buffIndx = GetReadable(sysMonitorInst->protocolLogCtrl);
+		buffIndx = GetReadable(sysMonitorInst->phyLogCtrl);
-	sysMonitorInst->protocolLogCtrl.rBusy = buffIndx;
+	sysMonitorInst->phyLogCtrl.rBusy = buffIndx;
-	memcpy(log, &(sysMonitorInst->protocolLog[buffIndx]), sizeof(PRTCLLOG));
+	memcpy(log, &(sysMonitorInst->phyLog[buffIndx]), sizeof(PHYLOG));
-	sysMonitorInst->protocolLogCtrl.rBusy = buffIndex_old;
+	sysMonitorInst->phyLogCtrl.rBusy = buffIndex_old;
 }
+/** @} */
 
 /**
- * Get the protocol running log as raw data.
+ * @name HardwareState_Log_API
+ * @{
  */
-void SysMonitor_GetProtocolLogRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->protocolLogCtrl.rBusy;
-	if (buffIndex_old != BUFF_NONE)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->protocolLogCtrl);
-	sysMonitorInst->protocolLogCtrl.rBusy = buffIndx;
 
-	// Encapsulate log
-	PRTCLLOG *logEntry = &(sysMonitorInst->protocolLog[buffIndx]);
-	memcpy(buff, &(logEntry->tmSys), sizeof(logEntry->tmSys));
-	buff += sizeof(logEntry->tmSys);
-	memcpy(buff, &(logEntry->phySt), sizeof(logEntry->phySt));
-	buff += sizeof(logEntry->phySt);
-	memcpy(buff, &(logEntry->tmLocal), sizeof(logEntry->tmLocal));
-	buff += sizeof(logEntry->tmLocal);
-	memcpy(buff, &(logEntry->beamNo), sizeof(logEntry->beamNo));
-	buff += sizeof(logEntry->beamNo);
-	memcpy(buff, &(logEntry->beamWidth), sizeof(logEntry->beamWidth));
-	buff += sizeof(logEntry->beamWidth);
-	memcpy(buff, &(logEntry->stage), sizeof(logEntry->stage));
-	buff += sizeof(logEntry->stage);
-	memcpy(buff, &(logEntry->recvCnt), sizeof(logEntry->recvCnt));
-	buff += sizeof(logEntry->recvCnt);
-	sysMonitorInst->protocolLogCtrl.rBusy = buffIndex_old;
-}
-
-// @Hardware state
 /**
- * Log hardware running status.
+ * @brief Log hardware running status.
+ *
+ * @param state
  */
-void SysMonitor_UpdateHardwareStatus(HWSTATE *state)
+void SysMonitor_UpdateHardwareStatus(const HWSTATE *state)
 {
 	ASSERT(sysMonitorInst != NULL);
+	ASSERT(state != NULL);
 	uint8_t buffIndx;
 	buffIndx = GetWritable(sysMonitorInst->hwStateCtrl);
 	sysMonitorInst->hwStateCtrl.wBusy = buffIndx;
@@ -563,11 +378,14 @@ void SysMonitor_UpdateHardwareStatus(HWSTATE *state)
 }
 
 /**
- * Get the latest hardware running status.
+ * @brief Get the latest hardware running status.
+ *
+ * @param state
  */
 void SysMonitor_GetHardwareStatus(HWSTATE *state)
 {
 	ASSERT(sysMonitorInst != NULL);
+	ASSERT(state != NULL);
 	uint8_t buffIndx, buffIndex_old;
 	buffIndex_old = sysMonitorInst->hwStateCtrl.rBusy;
 	if (buffIndex_old != BUFF_NONE)
@@ -579,64 +397,6 @@ void SysMonitor_GetHardwareStatus(HWSTATE *state)
 	sysMonitorInst->hwStateCtrl.rBusy = buffIndex_old;
 }
 
-/**
+/** @} HardwareState_Log_API */
- * Get the latest hardware running status as raw data.
- */
-void SysMonitor_GetHardwareStatusRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
-	uint8_t buffIndx, buffIndex_old;
-	buffIndex_old = sysMonitorInst->hwStateCtrl.rBusy;
-	if (buffIndex_old != BUFF_NONE)
-		buffIndx = buffIndex_old; // Keep it busy
-	else
-		buffIndx = GetReadable(sysMonitorInst->hwStateCtrl);
-	sysMonitorInst->hwStateCtrl.rBusy = buffIndx;
 
-	// Encapsulate state
+/** @} SystemMonitor*/
-	HWSTATE *stateEntry = &(sysMonitorInst->hwState[buffIndx]);
-	memcpy(buff, &(stateEntry->spVolt), sizeof(stateEntry->spVolt));
-	buff += sizeof(stateEntry->spVolt);
-	memcpy(buff, &(stateEntry->spTemp), sizeof(stateEntry->spTemp));
-	buff += sizeof(stateEntry->spTemp);
-	memcpy(buff, &(stateEntry->chipSt), sizeof(stateEntry->chipSt));
-	buff += sizeof(stateEntry->chipSt);
-	memcpy(buff, &(stateEntry->antVolt), sizeof(stateEntry->antVolt));
-	buff += sizeof(stateEntry->antVolt);
-	memcpy(buff, &(stateEntry->antTemp), sizeof(stateEntry->antTemp));
-	buff += sizeof(stateEntry->antTemp);
-	memcpy(buff, &(stateEntry->antPll), sizeof(stateEntry->antPll));
-	buff += sizeof(stateEntry->antPll);
-	memcpy(buff, &(stateEntry->antMgc), sizeof(stateEntry->antMgc));
-	buff += sizeof(stateEntry->antMgc);
-	memcpy(buff, &(stateEntry->antSt), sizeof(stateEntry->antSt));
-	sysMonitorInst->hwStateCtrl.rBusy = buffIndex_old;
-}
-
-// @System log
-/**
- * Get the latest system running log.
- */
-void SysMonitor_GetSyslog(SYSLOG *log)
-{
-	ASSERT(sysMonitorInst != NULL);
-	SysMonitor_GetSendSlotLog(&(log->sendLog));
-	SysMonitor_GetRecvSlotLog(&(log->recvLog));
-	SysMonitor_GetProtocolLog(&(log->protocolLog));
-	SysMonitor_GetHardwareStatus(&(log->hwSate));
-}
-
-/**
- * Get the latest system running log as raw data.
- */
-void SysMonitor_GetSyslogRaw(uint8_t *buff)
-{
-	ASSERT(sysMonitorInst != NULL);
-	SysMonitor_GetSendSlotLogRaw(buff);
-	buff += SLOTLOG_PACK_LEN;
-	SysMonitor_GetRecvSlotLogRaw(buff);
-	buff += SLOTLOG_PACK_LEN;
-	SysMonitor_GetProtocolLogRaw(buff);
-	buff += PRTCLLOG_PACK_ELN;
-	SysMonitor_GetHardwareStatusRaw(buff);
-}

df_datalink_sp/src/system_monitor.h

@@ -1,164 +1,240 @@
+/**
+ * @defgroup SystemMonitor
+ * @{
+ */
+
 #ifndef __SYSTEM_MONITOR_H_
 #define __SYSTEM_MONITOR_H_
 
+/***************************** Include Files *********************************/
 #include <stdint.h>
 #include <stdbool.h>
+#include "util.h"
 
-#define PAYLOAD_LEN 256
+/************************* Constant Definitions ******************************/
-#define PAYLOAD_FLJ_RX 168
+/**
-#define PAYLOAD_FLJ_TX 66
+ * @name SystemMonitor_Constants
-#define PAYLOAD_LJ_RX 66
+ * @{
-#define PAYLOAD_LJ_TX 168
+ */
+#define PAYLOAD_LEN_MAX 256
+#define PAYLOAD_LEN_FLJ_RX 168
+#define PAYLOAD_LEN_FLJ_TX 66
+#define PAYLOAD_LEN_LJ_RX 66
+#define PAYLOAD_LEN_LJ_TX 168
 
 #define DATA_ID_NONE UINT32_MAX
 #define DATA_ID_TEST 0x02030203
 
-typedef struct
+#define VOLTAGE_LSB 0.01 // volt
-{
+#define VOLTAGE_MAX 2.55 // volt
-	// FIXME: To Complete
-	uint8_t dummy;
-} SYSCONFIG;
 
-typedef struct
+#define VOLT_PS_STD 1.0
+#define VOLT_PSAUX_STD 1.8
+#define VOLT_DDR_STD 1.5
+#define VOLT_PL_STD 1.0
+#define VOLT_PLAUX_STD 1.8
+#define VOLT_BRAM_STD 1.0
+
+#define VOLT_PS_OK BIT(0)
+#define VOLT_PSAUX_OK BIT(1)
+#define VOLT_DDR_OK BIT(2)
+#define VOLT_PL_OK BIT(3)
+#define VOLT_PLAUX_OK BIT(4)
+#define VOLT_BRAM_OK BIT(5)
+
+#define VOLT_ANT_PROC_OK BIT(0)
+#define VOLT_ANT_RF_OK BIT(2)
+#define VOLT_ANT_NIL_OK BIT(4)
+#define ANT_STATE_OK BIT(6)
+
+// Xilinx Recommended
+// #define IS_PS_VALID(x) (x <= 1.05 && x >= 0.95)
+// #define IS_PSAUX_VALID(x) (x <= 1.89 && x >= 1.71)
+// #define IS_DDR_VALID(x) (x <= 1.89 && x >= 1.14)
+// #define IS_PL_VALID(x) (x <= 1.03 && x >= 0.97)
+// #define IS_PLAUX_VALID(x) (x <= 1.89 && x >= 1.71)
+// #define IS_BRAM_VALID(x) (x <= 1.03 && x >= 0.97)
+#define IS_PS_VALID(x) (x <= 1.05 && x >= 0.95)
+#define IS_PSAUX_VALID(x) (x <= 1.89 && x >= 1.71)
+#define IS_DDR_VALID(x) (x <= 1.89 && x >= 1.14)
+#define IS_PL_VALID(x) (x <= 1.03 && x >= 0.96)
+#define IS_PLAUX_VALID(x) (x <= 1.89 && x >= 1.71)
+#define IS_BRAM_VALID(x) (x <= 1.03 && x >= 0.96)
+
+#define CLK_SP_PLL0_LOCK BIT(0)
+#define CLK_SP_PLL1_LOCK BIT(2)
+
+#define CLK_AD0_BBPLL_LOCK BIT(0)
+#define CLK_AD0_RFPLL_LOCK BIT(2)
+#define CLK_AD1_BBPLL_LOCK BIT(4)
+#define CLK_AD1_RFPLL_LOCK BIT(6)
+
+#define CLK_ANT_BBPLL_LOCK BIT(0)
+#define CLK_ANT_RFPLL0_LOCK BIT(2)
+#define CLK_ANT_RFPLL1_LOCK BIT(4)
+
+#define TEMPERATURE_LSB 1.0	   // Celsius degree
+#define TEMPERATURE_MAX 127.0  // Celsius degree
+#define TEMPERATURE_MIN -128.0 // Celsius degree
+/** @} SystemMonitor_Constants */
+
+/************************* Data Type Definitions ****************************/
+
+/**
+ * @struct SYSINFO
+ * @brief System Infomation log
+ */
+typedef struct __attribute__((packed))
 {
-	// -- unit: ms, 0~604799999
+	uint32_t psBDS; ///< -- unit: ms, 0~604799999
-	uint32_t psBDS;
+	uint16_t pBDS;	///< -- unit: week, 0~0~8191
-	// -- unit: week, 0~0~8191
+	uint32_t psGPS; ///< -- unit: ms, 0~604799999
-	uint16_t pBDS;
+	uint16_t pGPS;	///< -- unit: week, 0~0~8191
-	// -- unit: ms, 0~604799999
+	uint8_t tmInd;	///< Time validation indicator \n
-	uint32_t psGPS;
+					// -- [0] GPS\n
-	// -- unit: week, 0~0~8191
+					// -- [1] reserve.\n
-	uint16_t pGPS;
+					// -- [2] UTC\n
-	// Time validation indicator
+					// -- [3] BDS\n
-	// -- [0] GPS
+	float tmFly;	///< Time of flying uint: s
-	// -- [1] reserve.
+	uint8_t stFly;	///< Status of flying \n
-	// -- [2] UTC
+					// [7:6] departure status 11 - departed/00 - not departed \n
-	// -- [3] BDS
+					// [5:4] ready status 11 - ready/00 - not ready \n
-	uint8_t tmInd;
+					// [3:2] attitude status 11 - attitude ok/00 - attitude not ok \n
-	// Time of flying
-	// uint: s
-	float tmFly;
-	// Status of flying
-	// [7:6] departure status 11 - departed/00 - not departed
-	// [5:4] ready status 11 - ready/00 - not ready
-	// [3:2] attitude status 11 - attitude ok/00 - attitude not ok
 					// [1:0] attitude adjust status 11 - adjusted/00 - not adjusted
-	uint8_t stFly;
+	float posX;		///< coord X Position in launch coordinate system
-	// Position in launch coordinate system
+	float posY;		///< coord Y Position in launch coordinate system
-	float posX;
+	float posZ;		///< coord Z Position in launch coordinate system
-	float posY;
+	float vX;		///< Speed X in launch coordinate system
-	float posZ;
+	float vY;		///< Speed Y in launch coordinate system
-	// Speed in launch coordinate system
+	float vZ;		///< Speed Z in launch coordinate system
-	float vX;
+	float pitch;	///< Pitch Attitude in launch inertia coordinate system
-	float vY;
+	float yaw;		///< Yaw Attitude in launch inertia coordinate system
-	float vZ;
+	float roll;		///< Roll Attitude in launch inertia coordinate system
-	// Attitude in launch inertia coordinate system
-	float pitch;
-	float yaw;
-	float roll;
 } SYSINFO;
 
-typedef struct
+/**
+ * @struct SYSBUSLOG
+ * @brief System Info holds the system bus log
+ */
+typedef struct __attribute__((packed))
 {
-	uint32_t dataId_lj;
+	// SystemBus log
-	uint8_t data_lj[PAYLOAD_LEN];
-	uint32_t dataId_flj;
-	uint8_t data_flj[PAYLOAD_LEN];
-} PAYLOAD;
 
-typedef struct
+	uint8_t lastConfig[2]; ///< Last valid config \n
+						   //  byte 0: 0x11 FLJ, 0x00 LJ \n
+						   //   byte 1: 0x66 Full Power, 0x88 Low Power
+	uint32_t pollCnt;	   ///< number of poll commands
+	uint32_t svcCnt;	   ///< number of service commands
+	uint32_t remoteCnt;	   ///< number of remote check commands
+} SYSBUSLOG;
+
+/**
+ * @struct LINKLOG
+ * @brief Linklayer Log struct holds the Linklayer log
+ */
+typedef struct __attribute__((packed))
 {
 	// Network log
-	uint32_t tuNo;
+	uint32_t tuNum;			///< current time unite number
-	uint8_t slotNo;
+	uint8_t slotNum;		///< current slot number
-	uint8_t frameType;
+	uint8_t nodeType;		///< current node type
-	// Payload
+	uint8_t cxnStatus;		///< current connection status
-	uint8_t payload[PAYLOAD_LEN];
+	uint8_t linkStage;		///< current linklayer working stage
-	// Time sync info
+	uint32_t recxnCnt;		///< reconnect trial count
-	uint64_t tmStamp;
+	uint8_t beamNo;			///< current working beam number
-	uint32_t tmDevi;
+	uint8_t beamWidth;		///< current working beam width
-	uint32_t freqDevi;
+	uint16_t beamAz;		///< current working beam angle Az
-} SLOTLOG;
+	uint16_t beamEl;		///< current working beam angle Ez
+	uint16_t advTxCnt;		///< adv frame send count
+	uint16_t advRecvCnt;	///< adv frame received count
+	uint16_t advCorrectCnt; ///< adv frame received correctly count
+	uint32_t cfmTxCnt;		///< cfm frame send count
+	uint32_t cfmRecvCnt;	///< cfm frame received count
+	uint32_t cfmCorrectCnt; ///< adv frame received correctly count
+	uint32_t svcTxCnt;		///< svc frame send count
+	uint32_t svcRecvCnt;	///< svc frame received count
+	uint32_t svcCorrectCnt; ///< svc frame received correctly count
+	int32_t timeDev;		///< last time deviation result
+	uint32_t sendId;		///< last send data id
+	uint32_t recvId;		///< last received data id
+	uint8_t reserve[4];		///< reserved data
+} LINKLOG;
 
-typedef struct
+/**
+ * @struct PHYLOG
+ * @brief Physical Layer Log struct holds the Linklayer log
+ */
+typedef struct __attribute__((packed))
 {
-	// Protocol log
+	uint32_t acqCnt;		///< aquisition count
-	// -- System time
+	uint32_t fsyncCnt;		///< frame sync count
-	uint32_t tmSys;
+	uint32_t decodeCnt;		///< decode count
-	// -- Physical layer status
+	uint32_t crcCnt;		///< crc valid count
-	uint8_t phySt;
+	double doppler;			///< last doppler estimation result
-	// -- Link layer status
+	uint64_t recvStamp;		///< last frame arrival time
-	uint64_t tmLocal;
+	double acqPAPR;			///< last acquisition peak-average ration
-	uint16_t beamNo;
+	uint8_t acqPhase;		///< last acquisition phase estimation
-	uint8_t beamWidth;
+	uint8_t acqFreqCh;		///< last acquisition frequency deviation estimation
-	// -- Network layer status
+	double fsyncPAPR;		///< last frame sync peak-average ration
-	uint8_t stage;
+	uint8_t fsyncFreqCh;	///< last frame sync frequency estimation
-	uint32_t recvCnt;
+	uint16_t deintlvAmpEst; ///< de-interleave amplitude estimation
-	uint32_t recvCorrect;
+	uint8_t antMode;		///< current antenna working mode
-} PRTCLLOG;
+	uint8_t reserve[3];		///< reserved data
+} PHYLOG;
 
-typedef struct
+/**
+ * @struct HWSTATE
+ * @brief Hardware Status Log struct holds all hardware status
+ */
+typedef struct __attribute__((packed))
 {
-	// Hardware log
+	bool isSpOk;  ///< signal processor state
+	bool isAntOk; ///< antenna state
 	// -- Signal processor status
-	uint16_t spVolt;
+	uint8_t spFpgaVolt;	   ///< Signal processor voltage state indicator
-	uint16_t spTemp;
+	uint8_t spClkState;	   ///< Signal processor clock state indicator
-	uint8_t chipSt;
+	uint8_t spAdLockState; ///< Signal processor adc lock state indicator
+	uint8_t spAdTemp_0;	   ///< Signal processor adc0 temperature
+	uint8_t spAdTemp_1;	   ///< Signal processor adc1 temperature
+	uint8_t spFpgaTemp;	   ///< Signal processor FPGA temperature
 	// -- Antenna status
-	uint8_t antVolt;
+	uint8_t antVolt; ///< Antenna voltage state indicator
-	uint8_t antTemp;
+	uint8_t antTemp; ///< Antenna rf temperature
-	uint8_t antPll;
+	uint8_t antPll;	 ///< Antenna rf lock state indicator
-	uint16_t antMgc;
+	uint8_t antMgc0; ///< Antenna rf mgc0~1 indicator
-	uint8_t antSt;
+	uint8_t antMgc1; ///< Antenna rf mgc2~3 indicator
+	uint8_t reserve[2];
 } HWSTATE;
 
+/**
+ * @struct PAYLOAD
+ * @brief Payload struct holds the service payload
+ */
 typedef struct
 {
-	// Send slot log
+	uint32_t dataId;
-	SLOTLOG sendLog;
+	uint8_t data[PAYLOAD_LEN_MAX];
-
+} PAYLOAD;
-	// Receive slot log
-	SLOTLOG recvLog;
-
-	// Protocol log
-	PRTCLLOG protocolLog;
-
-	// Hardware status
-	HWSTATE hwSate;
-} SYSLOG;
 
+/************************** Function Prototypes ******************************/
 int32_t SysMonitor_Init(void);
 void SysMonitor_Destroy(void);
 
-void SysMonitor_UpdateSysinfo(SYSINFO *info);
+void SysMonitor_UpdateSysinfo(const SYSINFO *info);
-void SysMonitor_UpdateSysinfoRaw(uint8_t *buff);
 void SysMonitor_GetSysinfo(SYSINFO *info);
-void SysMonitor_GetSysinfoRaw(uint8_t *buff);
 
-void SysMonitor_UpdateSendPayloadFLJRaw(uint8_t *buff);
+void SysMonitor_UpdateSendPayload(const uint8_t *buff, size_t len);
-void SysMonitor_UpdateRecvPayloadFLJRaw(uint8_t *buff);
+void SysMonitor_UpdateRecvPayload(const uint8_t *buff, uint32_t id, size_t len);
-void SysMonitor_UpdateSendPayloadLJRaw(uint8_t *buff);
+void SysMonitor_GetSendPayload(uint8_t *buff, uint32_t *id, size_t len);
-void SysMonitor_UpdateRecvPayloadLJRaw(uint8_t *buff);
+void SysMonitor_GetRecvPayload(uint8_t *buff, uint32_t *id, size_t len);
-void SysMonitor_GetSendPayloadFLJRaw(uint8_t *buff, uint32_t *id);
-void SysMonitor_GetRecvPayloadFLJRaw(uint8_t *buff, uint32_t *id);
-void SysMonitor_GetSendPayloadLJRaw(uint8_t *buff, uint32_t *id);
-void SysMonitor_GetRecvPayloadLJRaw(uint8_t *buff, uint32_t *id);
 
-void SysMonitor_UpdateSendSlotLog(SLOTLOG *log);
+void SysMonitor_UpdateLinklayerLog(const LINKLOG *log);
-void SysMonitor_UpdateRecvSlotLog(SLOTLOG *log);
+void SysMonitor_UpdatePhysicalLayerLog(const PHYLOG *log);
-void SysMonitor_UpdateProtocolLog(PRTCLLOG *log);
+void SysMonitor_UpdateHardwareStatus(const HWSTATE *state);
-void SysMonitor_GetSendSlotLog(SLOTLOG *log);
+void SysMonitor_GetLinklayerLog(LINKLOG *log);
-void SysMonitor_GetRecvSlotLog(SLOTLOG *log);
+void SysMonitor_GetPhysicalLayerLog(PHYLOG *log);
-void SysMonitor_GetProtocolLog(PRTCLLOG *log);
-void SysMonitor_GetSendSlotLogRaw(uint8_t *buff);
-void SysMonitor_GetRecvSlotLogRaw(uint8_t *buff);
-void SysMonitor_GetProtocolLogRaw(uint8_t *buff);
-
-void SysMonitor_UpdateHardwareStatus(HWSTATE *state);
 void SysMonitor_GetHardwareStatus(HWSTATE *state);
-void SysMonitor_GetHardwareStatusRaw(uint8_t *buff);
-
-void SysMonitor_GetSyslog(SYSLOG *log);
-void SysMonitor_GetSyslogRaw(uint8_t *buff);
 
 #endif //__SYSTEM_MONITOR_H_
+
+/** @} */

df_datalink_sp/src/systembus/systembus.c

@@ -1,22 +1,21 @@
 /*****************************************************************************/
 /**
- * Description: System bus protocol implementation file.
+ * @file systembus.c
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief System bus protocol implementation file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2023-05-06 10:13
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * Last Edit Time: [2023-05-06 21:45]
- *
- * Revisions: Rev 0.0
- * History:
- * [2023-05-06]: Initial version.
- * [2023-09-13]: Update to 485 protocol-20220816
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
  * Lab of Communication and Network
  *
  ******************************************************************************/
 
+/**
+ * @addtogroup SystemBus
+ * @{
+ */
 /***************************** Include Files *********************************/
-
 #include <stdlib.h>
 #include <string.h>
 #include <stdint.h>
@@ -27,10 +26,18 @@
 #include "common.h"
 #include "error.h"
 #include "circ_queue.h"
-
 #include "../system_monitor.h"
 
+/**
+ * @addtogroup SystemBus_Protocol_Routine
+ * @{
+ */
+
 /************************** Constant Definitions *****************************/
+/**
+ * @name SystemBus_MSG_Constants
+ * @{
+ */
 // Common Field
 // -- Command word
 #define WD_CMD 0x00
@@ -51,25 +58,32 @@
 #define WD_ST_RET 0x02
 #define ST_RET_OK 0xAA
 #define ST_RET_ERROR 0x55
-// -- -- Signal processor voltage
+#define ST_RET_INFO_LEN 13
-#define WD_SP_VOLT 0x03
+// -- -- Signal processor PS voltage
-// -- -- Signal processor temperature
+#define WD_SP_FPGA_VOLT 0x03
-#define WD_SP_TEMP 0x04
+// -- -- Signal processor PS AUX voltage
-// -- -- Signal processor chip status
+#define WD_SP_CLK_STATE 0x04
-#define WD_SP_CS 0x05
+// -- -- Signal processor DDR voltage
-// -- -- Signal processor antenna voltage
+#define WD_SP_AD_LOCK_STATE 0x05
-#define WD_ANT_VOLT 0x06
+// -- -- Signal processor PL voltage
-// -- -- Signal processor antenna temperature
+#define WD_SP_AD_TEMP_0 0x06
-#define WD_ANT_TEMP 0x07
+// -- -- Signal processor PL AUX voltage
+#define WD_SP_AD_TEMP_1 0x07
+// -- -- Signal processor Bram voltage
+#define WD_SP_FPGA_TEMP 0x08
+
+// -- -- Signal processor antenna voltage status
+#define WD_ANT_VOLT 0x09
+
+// -- -- Signal processor antenna RF temperature
+#define WD_ANT_RF_TEMP 0x0A
 // -- -- Signal processor antenna PLL lock status
-#define WD_ANT_PLL 0x08
+#define WD_ANT_RF_PLL 0x0B
 // -- -- Signal processor antenna MGC
-#define WD_ANT_MGC_L 0x09
+#define WD_ANT_MGC_0 0x0C
-#define WD_ANT_MGC_H 0x0A
+#define WD_ANT_MGC_1 0x0D
-// -- -- Signal processor antenna status
+// -- -- Reserved
-#define WD_ANT_ST 0x0B
+#define WD_ANT_RESERVE 0x0E
-// -- -- Dummy must be 0x00
-#define WD_ST_DUMMY 0x0C
 
 // Data Send Test Command
 #define CMD_DATA_TEST_A 0xE2
@@ -94,7 +108,8 @@
 // -- Request
 #define WD_EN_CMD 0x02
 #define EN_CMD_ON_HIGH_POWER 0x66
-#define EN_CMD_ON_LOW_POWER 0x88
+#define EN_CMD_ON_LOW_POWER 0x77
+#define EN_CMD_SILENT 0x88
 
 #define WD_MODE_CMD 0x03
 #define MODE_CMD_HEAD 0x11
@@ -150,6 +165,17 @@
 #define WD_FLJ_RM_TEST 0x02
 #define FLJ_RM_TEST_CODE 0x99
 // -- Response
+#define WD_FLJ_TIME_STAMP 0x02
+#define WD_FLJ_TIME_STAMP_LEN 8
+#define WD_FLJ_SYSBUS_LOG 0x0A
+#define WD_FLJ_SYSBUS_LOG_LEN 14
+#define WD_FLJ_LINK_LOG 0x18
+#define WD_FLJ_LINK_LOG_LEN 64
+#define WD_FLJ_PHY_LOG 0x58
+#define WD_FLJ_PHY_LOG_LEN 57
+#define WD_FLJ_HARDWARE_ST 0x91
+#define WD_FLJ_HARDWARE_ST_LEN 13
+
 #define FLJ_RM_TEST_RESP_LEN 158
 
 // Remote Test LJ
@@ -158,13 +184,28 @@
 #define WD_LJ_RM_TEST 0x02
 #define LJ_RM_TEST_CODE 0x99
 // -- Response
-#define LJ_RM_TEST_RESP_LEN 158
+#define WD_LJ_TIME_STAMP 0x02
+#define WD_LJ_TIME_STAMP_LEN 8
+#define WD_LJ_SYSBUS_LOG 0x0A
+#define WD_LJ_SYSBUS_LOG_LEN 14
+#define WD_LJ_LINK_LOG 0x18
+#define WD_LJ_LINK_LOG_LEN 64
+#define WD_LJ_PHY_LOG 0x58
+#define WD_LJ_PHY_LOG_LEN 57
+#define WD_LJ_HARDWARE_ST 0x91
+#define WD_LJ_HARDWARE_ST_LEN 13
 
+#define LJ_RM_TEST_RESP_LEN 158
 
 // My Production Type
 #define MY_PRD_ID PRD_DL_K
-
+/** @} SystemBus_MSG_Constants*/
 /************************** Function Prototypes ******************************/
+static int32_t SystemBus_GenSelfTestRsp(SYSBUS *instPtr);
+static int32_t SystemBus_SystemConfig(SYSBUS *instPtr, uint8_t *msg);
+static int32_t SystemBus_Echo(SYSBUS *instPtr, SYSBUS_UART_FRAME *frame);
+static int32_t SystemBus_GenPollRsp(SYSBUS *instPtr, uint8_t *msg);
+static int32_t SystemBus_GenRemoteTestRsp(SYSBUS *instPtr, uint8_t *msg);
 /**************************** Type Definitions *******************************/
 /************************** Variable Definitions *****************************/
 // TODO: better approach?
@@ -173,13 +214,13 @@
 extern L2_INST *linkInstPtr;
 extern L2_CONFIG linkConfig;
 
-inline bool SystemBus_IsReqPendding(SYSBUS *instPtr)
+inline bool SystemBus_IsReqPending(SYSBUS *instPtr)
 {
 	ASSERT(instPtr != NULL);
 	return (!isCircQueueEmpty(instPtr->rxQueue));
 }
 
-inline bool SystemBus_IsRsqPendding(SYSBUS *instPtr)
+inline bool SystemBus_IsRsqPending(SYSBUS *instPtr)
 {
 	ASSERT(instPtr != NULL);
 	return (!isCircQueueEmpty(instPtr->txQueue));
@@ -196,6 +237,419 @@ inline bool SystemBus_IsRxBusy(SYSBUS *instPtr)
 	return SysbusUart_IsRxBusy(instPtr->uartInst);
 }
 
+/**
+ * @brief   Generate System Bus SelfTest response.
+ */
+static int32_t SystemBus_GenSelfTestRsp(SYSBUS *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	SYSBUS_UART_FRAME *sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
+	if (sysbusRsp == NULL)
+	{
+		DBG_ERROR("Failed to allocate memory for SELF TEST Response!\n");
+		return ENOMEM;
+	}
+	HWSTATE *hwStatsPtr = &(instPtr->hwState);
+	sysbusRsp->len = ST_RSP_LEN;
+	memset(sysbusRsp->data, 0x00, ST_RSP_LEN);
+	sysbusRsp->data[WD_CMD] = CMD_SELF_TEST;
+	sysbusRsp->data[WD_PRD] = MY_PRD_ID;
+	SysMonitor_GetHardwareStatus(hwStatsPtr);
+	if (L2_isStarted(linkInstPtr))
+	{
+		sysbusRsp->data[WD_ST_RET] = (hwStatsPtr->isSpOk && hwStatsPtr->isAntOk) ? ST_RET_OK : ST_RET_ERROR;
+	}
+	else
+	{
+		sysbusRsp->data[WD_ST_RET] = (hwStatsPtr->isSpOk) ? ST_RET_OK : ST_RET_ERROR;
+	}
+	// apply status and omit 2 bytes of overhead.
+	memcpy(sysbusRsp->data + WD_SP_FPGA_VOLT, &(hwStatsPtr->spFpgaVolt), ST_RET_INFO_LEN);
+
+	if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
+	{
+		free(sysbusRsp);
+		DBG_ERROR("SystemBus::TX Queue overflowed!\n");
+		return EQUEUE;
+	}
+	return SUCCESS;
+}
+
+/**
+ * @brief   Apply system configuration
+ */
+static int32_t SystemBus_SystemConfig(SYSBUS *instPtr, uint8_t *msg)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(msg != NULL);
+	PHY_INST *phyRef = linkInstPtr->config.phyInstPtr;
+	TMC_INST *tmcRef = linkInstPtr->config.tmcInstPtr;
+	bool reconfig = false;
+
+	if (msg[WD_MODE_CMD] == MODE_CMD_HEAD)
+	{
+		// head node config
+		reconfig = (L2_NODE_HEAD != L2_GetNodeType(linkInstPtr));
+		linkConfig.myType = L2_NODE_HEAD;
+		linkConfig.myId = 1;
+	}
+
+	else if (msg[WD_MODE_CMD] == MODE_CMD_MEMBER)
+	{
+		// member node config
+		reconfig = (L2_NODE_MEMBER != L2_GetNodeType(linkInstPtr));
+		linkConfig.myType = L2_NODE_MEMBER;
+		linkConfig.myId = 2;
+	}
+	else
+	{
+		// Ignore current command
+		DBG_ERROR("Unexpected config command 0x%02X:0x%02X",
+				  WD_MODE_CMD, msg[WD_MODE_CMD]);
+		return EPARAM;
+	}
+
+	if (msg[WD_EN_CMD] == EN_CMD_ON_HIGH_POWER)
+	{
+		// full power config
+		Phy_AntConfigMode(phyRef, PHY_ANT_MODE_POWER_FULL);
+		if (reconfig || !L2_isStarted(linkInstPtr))
+		{
+			Linklayer_Reconfig(linkInstPtr, &linkConfig);
+		}
+		Linklayer_Start(linkInstPtr);
+	}
+	else if (msg[WD_EN_CMD] == EN_CMD_ON_LOW_POWER)
+	{
+		// low power config
+		Phy_AntConfigMode(phyRef, PHY_ANT_MODE_POWER_LOW);
+		if (reconfig || !L2_isStarted(linkInstPtr))
+		{
+			Linklayer_Reconfig(linkInstPtr, &linkConfig);
+		}
+		Linklayer_Start(linkInstPtr);
+	}
+	else if (msg[WD_EN_CMD] == EN_CMD_SILENT)
+	{
+		// silence config
+		// TODO: better approach?
+		Linklayer_Halt(linkInstPtr);
+		Phy_AntConfigMode(phyRef, PHY_ANT_MODE_STANDBY);
+		TIME_WORD pullTime = {0, 0};
+		pullTime.int_part = TimeCtrl_GetIntCnt(tmcRef) + 1;
+		if (Phy_SetTimeWord(phyRef, &pullTime, PHY_TIME_WORD_POLL) != SUCCESS)
+		{
+			DBG_ERROR("Physical set pull time failed.\n");
+		}
+		Phy_SetupNextSlot(phyRef, PHY_TOR_RX, L1_10KBPS_10MS_FRAME, NULL);
+	}
+	else
+	{
+		// Ignore current command
+		DBG_ERROR("Unexpected config command 0x%02X:0x%02X",
+				  WD_EN_CMD, msg[WD_EN_CMD]);
+		return EIGNORE;
+	}
+	instPtr->sysbusLog.lastConfig[0] = msg[WD_MODE_CMD];
+	instPtr->sysbusLog.lastConfig[1] = msg[WD_EN_CMD];
+	return SUCCESS;
+}
+
+/**
+ * @brief   Echo System Bus frame
+ */
+static int32_t SystemBus_Echo(SYSBUS *instPtr, SYSBUS_UART_FRAME *frame)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(frame != NULL);
+	SYSBUS_UART_FRAME *sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
+	if (sysbusRsp == NULL)
+	{
+		DBG_ERROR("Failed to allocate memory for DATA TEST A Response!\n");
+		return ENOMEM;
+	}
+	sysbusRsp->len = frame->len;
+	memcpy(sysbusRsp->data, frame->data, sysbusRsp->len);
+	if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
+	{
+		free(sysbusRsp);
+		DBG_ERROR("SystemBus::TX Queue overflowed!\n");
+		return EQUEUE;
+	}
+	return SUCCESS;
+}
+
+/**
+ * @brief   Generate System Bus poll call command response
+ */
+static int32_t SystemBus_GenPollRsp(SYSBUS *instPtr, uint8_t *msg)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(msg != NULL);
+	size_t dataLen;
+	uint8_t *payload;
+	SYSBUS_UART_FRAME *sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
+	if (sysbusRsp == NULL)
+	{
+		DBG_ERROR("Failed to allocate memory for FLJ POLL Response!\n");
+		return ENOMEM;
+	}
+
+	if (msg[WD_CMD] == CMD_FLJ_POLL)
+	{
+		sysbusRsp->len = FLJ_POLL_RESP_LEN;
+		sysbusRsp->data[WD_CMD] = CMD_FLJ_POLL;
+		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
+		dataLen = PAYLOAD_LEN_FLJ_RX;
+		payload = sysbusRsp->data + FLJ_DATA_OFFSET;
+	}
+	else if (msg[WD_CMD] == CMD_LJ_POLL)
+	{
+		sysbusRsp->len = LJ_POLL_RESP_LEN;
+		sysbusRsp->data[WD_CMD] = CMD_LJ_POLL;
+		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
+		dataLen = PAYLOAD_LEN_LJ_RX;
+		payload = sysbusRsp->data + LJ_DATA_OFFSET;
+	}
+	else
+	{
+		DBG_ERROR("Unexpected command 0x%02X.\n", msg[WD_CMD]);
+		free(sysbusRsp);
+		return EUNEXP;
+	}
+	uint32_t dataId;
+	SysMonitor_GetRecvPayload(payload, &dataId, dataLen); // omit control info
+	if (dataId == DATA_ID_NONE)
+	{
+		free(sysbusRsp);
+		DBG_WARNING("SystemBus::no RX data!\n");
+		return SUCCESS;
+	}
+	if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
+	{
+		free(sysbusRsp);
+		DBG_WARNING("SystemBus::TX Queue overflowed!\n");
+		return EQUEUE;
+	}
+	instPtr->sysbusLog.pollCnt++;
+	return SUCCESS;
+}
+
+/**
+ * @brief   Generate System Bus remote test command response
+ */
+static int32_t SystemBus_GenRemoteTestRsp(SYSBUS *instPtr, uint8_t *msg)
+{
+	ASSERT(instPtr != NULL);
+	ASSERT(msg != NULL);
+	SYSBUS_UART_FRAME *sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
+	if (sysbusRsp == NULL)
+	{
+		DBG_ERROR("Failed to allocate memory for LJ REMOTE TEST Response!\n");
+		return ENOMEM;
+	}
+
+	TIME_WORD tmWord;
+	uint64_t time;
+	TimeCtrl_GetCurrentTime(linkInstPtr->config.tmcInstPtr, &tmWord);
+	time = (uint64_t)tmWord.int_part * TIME_FRAC_MAX + tmWord.frac_part;
+
+	if (msg[WD_CMD] == CMD_FLJ_RM_TEST)
+	{
+		sysbusRsp->len = FLJ_RM_TEST_RESP_LEN;
+		memset(sysbusRsp->data, 0x00, FLJ_RM_TEST_RESP_LEN);
+		sysbusRsp->data[WD_CMD] = CMD_FLJ_RM_TEST;
+		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
+
+		memcpy(sysbusRsp->data + WD_FLJ_TIME_STAMP, &time, WD_FLJ_TIME_STAMP_LEN);
+		SysMonitor_GetLinklayerLog(&(instPtr->linkLog));
+		SysMonitor_GetPhysicalLayerLog(&(instPtr->phyLog));
+		SysMonitor_GetHardwareStatus(&(instPtr->hwState));
+		memcpy(sysbusRsp->data + WD_FLJ_SYSBUS_LOG, &(instPtr->sysbusLog), WD_FLJ_SYSBUS_LOG_LEN);
+		memcpy(sysbusRsp->data + WD_FLJ_LINK_LOG, &(instPtr->linkLog), WD_FLJ_LINK_LOG_LEN);
+		memcpy(sysbusRsp->data + WD_FLJ_PHY_LOG, &(instPtr->phyLog), WD_FLJ_PHY_LOG_LEN);
+		memcpy(sysbusRsp->data + WD_FLJ_HARDWARE_ST, &(instPtr->hwState.spFpgaVolt), WD_FLJ_HARDWARE_ST_LEN);
+	}
+	else if (msg[WD_CMD] == CMD_LJ_RM_TEST)
+	{
+		sysbusRsp->len = LJ_RM_TEST_RESP_LEN;
+		sysbusRsp->data[WD_CMD] = CMD_LJ_RM_TEST;
+		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
+
+		memcpy(sysbusRsp->data + WD_LJ_TIME_STAMP, &time, WD_LJ_TIME_STAMP_LEN);
+		SysMonitor_GetLinklayerLog(&(instPtr->linkLog));
+		SysMonitor_GetPhysicalLayerLog(&(instPtr->phyLog));
+		SysMonitor_GetHardwareStatus(&(instPtr->hwState));
+		memcpy(sysbusRsp->data + WD_LJ_SYSBUS_LOG, &(instPtr->sysbusLog), WD_LJ_SYSBUS_LOG_LEN);
+		memcpy(sysbusRsp->data + WD_LJ_LINK_LOG, &(instPtr->linkLog), WD_LJ_LINK_LOG_LEN);
+		memcpy(sysbusRsp->data + WD_LJ_PHY_LOG, &(instPtr->phyLog), WD_LJ_PHY_LOG_LEN);
+		memcpy(sysbusRsp->data + WD_LJ_HARDWARE_ST, &(instPtr->hwState.spFpgaVolt), WD_LJ_HARDWARE_ST_LEN);
+	}
+	else
+	{
+		DBG_ERROR("Unexpected command 0x%02X.\n", msg[WD_CMD]);
+		free(sysbusRsp);
+		return EUNEXP;
+	}
+
+	if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
+	{
+		free(sysbusRsp);
+		DBG_WARNING("SystemBus::TX Queue overflowed!\n");
+		return EQUEUE;
+	}
+	instPtr->sysbusLog.remoteCnt++;
+	return SUCCESS;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   A handler function. This handler  evaluate the message from system
+ * 			bus receive queue, and make appropriate response.
+ *
+ * @param   instPtr A pointer to System Bus instance.
+ *
+ * @return  None
+ *
+ ******************************************************************************/
+int32_t SystemBus_HandleCmd(SYSBUS *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	int32_t Status;
+	SYSBUS_UART_FRAME *sysbusReq;
+	uint8_t *msg;
+	if (CircQueuePop(instPtr->rxQueue, (void **)(&sysbusReq)) == false)
+	{
+		DBG_WARNING("SystemBus::Nothing to be handled.\n");
+		return EIGNORE;
+	}
+	msg = sysbusReq->data;
+	if (msg[WD_PRD] != MY_PRD_ID && msg[WD_PRD] != PRD_ALL)
+	{
+		DBG_WARNING("SystemBus::Production code mismatch!\n");
+		return EIGNORE;
+	}
+
+	switch (msg[WD_CMD])
+	{
+	case CMD_SELF_TEST:
+	{
+		Status = SystemBus_GenSelfTestRsp(instPtr);
+		break;
+	}
+	case CMD_DATA_TEST_A:
+	case CMD_DATA_TEST_B:
+	{
+		Status = SystemBus_Echo(instPtr, sysbusReq);
+		break;
+	}
+	case CMD_CONFIG:
+	{
+		Status = SystemBus_SystemConfig(instPtr, msg);
+		break;
+	}
+	case CMD_SYS_INFO:
+	{
+		SysMonitor_UpdateSysinfo((SYSINFO *)(msg + SYS_INFO_OFFSET));
+		Status = SUCCESS;
+		break;
+	}
+	case CMD_FLJ_SEND:
+	{
+		SysMonitor_UpdateSendPayload(msg + FLJ_DATA_OFFSET, PAYLOAD_LEN_FLJ_TX); // omit control info
+		instPtr->sysbusLog.svcCnt++;
+		Status = SUCCESS;
+		break;
+	}
+	case CMD_LJ_SEND:
+	{
+		SysMonitor_UpdateSendPayload(msg + LJ_DATA_OFFSET, PAYLOAD_LEN_LJ_TX); // omit control info
+		instPtr->sysbusLog.svcCnt++;
+		Status = SUCCESS;
+		break;
+	}
+	case CMD_FLJ_POLL:
+	{
+		if (msg[WD_FLJ_POLL] != FLJ_POLL_CODE)
+		{
+			DBG_ERROR("SystemBus::Invalid roll call code!\n");
+			Status = EIGNORE;
+			break;
+		}
+		Status = SystemBus_GenPollRsp(instPtr, msg);
+		break;
+	}
+	case CMD_LJ_POLL:
+	{
+		if (msg[WD_LJ_POLL] != LJ_POLL_CODE)
+		{
+			DBG_WARNING("SystemBus::Invalid roll call code!\n");
+			Status = EIGNORE;
+			break;
+		}
+		Status = SystemBus_GenPollRsp(instPtr, msg);
+		break;
+	}
+	case CMD_FLJ_RM_TEST:
+	{
+		if (msg[WD_FLJ_RM_TEST] != FLJ_RM_TEST_CODE)
+		{
+			DBG_WARNING("SystemBus::Invalid remote test code!\n");
+			Status = EIGNORE;
+			break;
+		}
+		Status = SystemBus_GenRemoteTestRsp(instPtr, msg);
+		break;
+	}
+	case CMD_LJ_RM_TEST:
+	{
+		if (msg[WD_LJ_RM_TEST] != LJ_RM_TEST_CODE)
+		{
+			DBG_WARNING("SystemBus::Invalid remote test code!\n");
+			Status = EIGNORE;
+			break;
+		}
+		Status = SystemBus_GenRemoteTestRsp(instPtr, msg);
+		break;
+	}
+	default:
+	{
+		DBG_ERROR("SystemBus::Unknown command code!\n");
+		Status = FAILURE;
+		break;
+	}
+	}
+	free(sysbusReq);
+	return Status;
+}
+
+/*****************************************************************************/
+/**
+ * @brief   This function send a repose frame from system bus tx queue.
+ *
+ * @param   instPtr A pointer to System Bus instance.
+ *
+ * @return  None
+ *
+ ******************************************************************************/
+int32_t SystemBus_MakeResp(SYSBUS *instPtr)
+{
+	ASSERT(instPtr != NULL);
+	int32_t Status;
+	SYSBUS_UART_FRAME *sysbusRsp;
+	if (CircQueuePop(instPtr->txQueue, (void **)(&sysbusRsp)) == false)
+	{
+		DBG_WARNING("SystemBus::Nothing to be sent.\n");
+		return EIGNORE;
+	}
+	instPtr->isTxDone = false; // A transmission procedure is started.
+	Status = SysbusUart_Send(instPtr->uartInst, sysbusRsp);
+	free(sysbusRsp);
+	return Status;
+}
+
+/** @} */
+
 /*****************************************************************************/
 /**
  * @brief   Initialize System Bus instance.
@@ -221,6 +675,10 @@ int32_t SystemBus_Init(SYSBUS **instPtr, SYSBUS_CONFIG *config)
 	(*instPtr)->txQueue = NULL;
 	(*instPtr)->uartInst = NULL;
 	memcpy(&((*instPtr)->config), config, sizeof(SYSBUS_CONFIG));
+	memset(&((*instPtr)->sysbusLog), 0x00, sizeof(SYSBUSLOG));
+	memset(&((*instPtr)->linkLog), 0x00, sizeof(LINKLOG));
+	memset(&((*instPtr)->phyLog), 0x00, sizeof(PHYLOG));
+	memset(&((*instPtr)->hwState), 0x00, sizeof(HWSTATE));
 	uartConfig.baseAddr = config->baseAddr;
 	Status = SysbusUart_Init(&((*instPtr)->uartInst), &uartConfig);
 	if (Status != SUCCESS)
@@ -250,355 +708,6 @@ sysbus_init_error:
 	return Status;
 }
 
-/*****************************************************************************/
-/**
- * @brief   A handler function. This handler  evaluate the message from system
- * 			bus receive queue, and make appropriate response.
- *
- * @param   instPtr A pointer to System Bus instance.
- *
- * @return  None
- *
- ******************************************************************************/
-int32_t SystemBus_HandleCmd(SYSBUS *instPtr)
-{
-	ASSERT(instPtr != NULL);
-	int32_t Status;
-	SYSBUS_UART_FRAME *sysbusReq, *sysbusRsp;
-	uint8_t *data;
-	if (CircQueuePop(instPtr->rxQueue, (void **)(&sysbusReq)) == false)
-	{
-		DBG_WARNING("SystemBus::Nothing to be handled.\n");
-		return EIGNORE;
-	}
-	data = sysbusReq->data;
-	if (data[WD_PRD] != MY_PRD_ID && data[WD_PRD] != PRD_ALL)
-	{
-		DBG_WARNING("SystemBus::Production code mismatch!\n");
-		return EIGNORE;
-	}
-	switch (data[WD_CMD])
-	{
-	case CMD_SELF_TEST:
-	{
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		if (sysbusRsp == NULL) {
-			DBG_ERROR("Failed to allocate memory for SELF TEST Response!\n");
-			Status = ENOMEM;
-			break;
-		}
-		sysbusRsp->len = ST_RSP_LEN;
-		memset(sysbusRsp->data, 0x00, ST_RSP_LEN);
-		sysbusRsp->data[WD_CMD] = CMD_SELF_TEST;
-		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
-
-		// FIXME: run self-test and insert result
-		sysbusRsp->data[WD_ST_RET] = ST_RET_OK;
-		if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
-		{
-			free(sysbusRsp);
-			DBG_ERROR("SystemBus::TX Queue overflowed!\n");
-			Status = EQUEUE;
-			break;
-		}
-		Status = SUCCESS;
-		break;
-	}
-	case CMD_DATA_TEST_A:
-	{
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		if (sysbusRsp == NULL) {
-			DBG_ERROR("Failed to allocate memory for DATA TEST A Response!\n");
-			Status = ENOMEM;
-			break;
-		}
-		sysbusRsp->len = DATA_TEST_RSP_A_LEN;
-		memcpy(sysbusRsp->data, sysbusReq->data, DATA_TEST_RSP_A_LEN);
-		if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
-		{
-			free(sysbusRsp);
-			DBG_ERROR("SystemBus::TX Queue overflowed!\n");
-			Status = EQUEUE;
-			break;
-		}
-		Status = SUCCESS;
-		break;
-	}
-	case CMD_DATA_TEST_B:
-	{
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		if (sysbusRsp == NULL) {
-			DBG_ERROR("Failed to allocate memory for DATA TEST B Response!\n");
-			Status = ENOMEM;
-			break;
-		}
-		sysbusRsp->len = DATA_TEST_RSP_B_LEN;
-		memcpy(sysbusRsp->data, sysbusReq->data, DATA_TEST_RSP_B_LEN);
-		if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
-		{
-			free(sysbusRsp);
-			DBG_ERROR("SystemBus::TX Queue overflowed!\n");
-			Status = EQUEUE;
-			break;
-		}
-		Status = SUCCESS;
-		break;
-	}
-	case CMD_CONFIG:
-	{	
-		PHY_INST *phyRef = linkInstPtr->config.phyInstPtr;
-		TMC_INST *tmcRef = linkInstPtr->config.tmcInstPtr;
-		
-		if (data[WD_MODE_CMD] == MODE_CMD_HEAD) 
-		{
-			// head node config
-			linkConfig.myType = L2_NODE_HEAD;
-			linkConfig.myId = 1;
-			Linklayer_Reconfig(linkInstPtr, &linkConfig);
-		}
-		else if (data[WD_MODE_CMD] == MODE_CMD_MEMBER) 
-		{
-			// member node config
-			linkConfig.myType = L2_NODE_MEMBER;
-			linkConfig.myId = 2;
-			Linklayer_Reconfig(linkInstPtr, &linkConfig);
-		}
-		else 
-		{
-			// FIXME: 
-			// Halt linklayer
-			Linklayer_Halt(linkInstPtr);
-			DBG_ERROR("Unexpected config command 0x%02X:0x%02X", 
-				WD_MODE_CMD, data[WD_MODE_CMD]);
-		}
-
-		if(data[WD_EN_CMD] == EN_CMD_ON_HIGH_POWER) 
-		{
-			// high power config
-			Phy_AntConfigMode(phyRef, PHY_ANT_MODE_HIGH_POWER);
-			Linklayer_Start(linkInstPtr);
-
-		}
-		else if(data[WD_EN_CMD] == EN_CMD_ON_LOW_POWER)
-		{
-			// low power config
-			Phy_AntConfigMode(phyRef, PHY_ANT_MODE_LOW_POWER);
-			Linklayer_Start(linkInstPtr);
-		}
-		else 
-		{
-			// silence config
-			// TODO: better approach?
-			Linklayer_Halt(linkInstPtr);
-			Phy_AntConfigMode(phyRef, PHY_ANT_MODE_SILENT);
-			TIME_WORD pullTime = {0, 0};
-			pullTime.int_part = TimeCtrl_GetIntCnt(tmcRef) + 1;
-			Status = Phy_SetTimeWord(phyRef, &pullTime, PHY_TIME_WORD_POLL);
-			if (Status != SUCCESS)
-			{
-				DBG_ERROR("Physical set pull time failed, with error code: %" PRId32 ".\n", Status);
-			}
-			Phy_SetupNextSlot(phyRef, PHY_TOR_RX, L1_10KBPS_10MS_FRAME, NULL);
-		}
-
-		_nop_(); // for debug
-		Status = SUCCESS;
-		break;
-	}
-	case CMD_SYS_INFO:
-	{
-		SysMonitor_UpdateSysinfoRaw(data + SYS_INFO_OFFSET);
-		Status = SUCCESS;
-		break;
-	}
-	// TODO
-	case CMD_FLJ_SEND:
-	{
-		SysMonitor_UpdateSendPayloadFLJRaw(data + FLJ_DATA_OFFSET); // omit control info
-		break;
-	}
-	case CMD_LJ_SEND:
-	{
-		SysMonitor_UpdateSendPayloadLJRaw(data + LJ_DATA_OFFSET); // omit control info
-		break;
-	}
-	case CMD_FLJ_POLL:
-	{
-		if (data[WD_FLJ_POLL] != FLJ_POLL_CODE)
-		{
-			DBG_ERROR("SystemBus::Invalid roll call code!\n");
-			Status = EIGNORE;
-			break;
-		}
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		if (sysbusRsp == NULL) {
-			DBG_ERROR("Failed to allocate memory for FLJ POLL Response!\n");
-			Status = ENOMEM;
-			break;
-		}
-		sysbusRsp->len = FLJ_POLL_RESP_LEN;
-		sysbusRsp->data[WD_CMD] = CMD_FLJ_POLL;
-		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
-		uint32_t dataId;
-		SysMonitor_GetRecvPayloadFLJRaw(sysbusRsp->data + FLJ_DATA_OFFSET, &dataId); // omit control info
-		if (dataId == DATA_ID_NONE) 
-		{
-			free(sysbusRsp);
-			DBG_WARNING("SystemBus::no RX data!\n");
-			Status = SUCCESS;
-			break;
-		}
-		if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
-		{
-			free(sysbusRsp);
-			DBG_WARNING("SystemBus::TX Queue overflowed!\n");
-			Status = EQUEUE;
-			break;
-		}
-		Status = SUCCESS;
-		break;
-	}
-	case CMD_LJ_POLL:
-	{
-		if (data[WD_LJ_POLL] != LJ_POLL_CODE)
-		{
-			DBG_WARNING("SystemBus::Invalid roll call code!\n");
-			Status = EIGNORE;
-			break;
-		}
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		if (sysbusRsp == NULL) {
-			DBG_ERROR("Failed to allocate memory for LJ POLL Response!\n");
-			Status = ENOMEM;
-			break;
-		}
-		sysbusRsp->len = LJ_POLL_RESP_LEN;
-		sysbusRsp->data[WD_CMD] = CMD_LJ_POLL;
-		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
-		uint32_t dataId;
-		SysMonitor_GetRecvPayloadLJRaw(sysbusRsp->data + LJ_DATA_OFFSET, &dataId); // omit control info
-		if (dataId == DATA_ID_NONE) 
-		{
-			free(sysbusRsp);
-			DBG_WARNING("SystemBus::no RX data!\n");
-			Status = SUCCESS;
-			break;
-		}
-		if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false)
-		{
-			free(sysbusRsp);
-			DBG_WARNING("SystemBus::TX Queue overflowed!\n");
-			Status = EQUEUE;
-			break;
-		}
-		Status = SUCCESS;
-		break;
-	}
-	case CMD_FLJ_RM_TEST:
-	{
-		if (data[WD_FLJ_RM_TEST] != FLJ_RM_TEST_CODE)
-		{
-			DBG_WARNING("SystemBus::Invalid remote test code!\n");
-			Status = EIGNORE;
-			break;
-		}
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		if (sysbusRsp == NULL) {
-			DBG_ERROR("Failed to allocate memory for FLJ REMOTE TEST Response!\n");
-			Status = ENOMEM;
-			break;
-		}
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		sysbusRsp->len = FLJ_RM_TEST_RESP_LEN;
-		memset(sysbusRsp->data, 0x00, FLJ_RM_TEST_RESP_LEN);
-		sysbusRsp->data[WD_CMD] = CMD_FLJ_RM_TEST;
-		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
-		
-		if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false){
-			free(sysbusRsp);
-			DBG_WARNING("SystemBus::TX Queue overflowed!\n");
-			Status = EQUEUE;
-			break;
-		}
-		Status = SUCCESS;
-		break;
-	}
-	case CMD_LJ_RM_TEST:
-	{
-		if (data[WD_LJ_RM_TEST] != LJ_RM_TEST_CODE)
-		{
-			DBG_WARNING("SystemBus::Invalid remote test code!\n");
-			Status = EIGNORE;
-			break;
-		}
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		if (sysbusRsp == NULL) {
-			DBG_ERROR("Failed to allocate memory for LJ REMOTE TEST Response!\n");
-			Status = ENOMEM;
-			break;
-		}
-		sysbusRsp = malloc(sizeof(SYSBUS_UART_FRAME));
-		sysbusRsp->len = LJ_RM_TEST_RESP_LEN;
-		memset(sysbusRsp->data, 0x00, LJ_RM_TEST_RESP_LEN);
-		sysbusRsp->data[WD_CMD] = CMD_LJ_RM_TEST;
-		sysbusRsp->data[WD_PRD] = MY_PRD_ID;
-		
-		if (CircQueuePush(instPtr->txQueue, (void *)sysbusRsp) == false){
-			free(sysbusRsp);
-			DBG_WARNING("SystemBus::TX Queue overflowed!\n");
-			Status = EQUEUE;
-			break;
-		}
-		Status = SUCCESS;
-		break;
-	}
-	default:
-	{
-		DBG_ERROR("SystemBus::Unknown command code!\n");
-		break;
-	}
-	}
-	free(sysbusReq);
-	return Status;
-}
-
-int32_t SystemBus_FLJ_PeriodUpdate(SYSBUS *instPtr)
-{
-	// TODO
-	return SUCCESS;
-}
-
-int32_t SystemBus_LJ_PeriodUpdate(SYSBUS *instPtr)
-{
-	// TODO
-	return SUCCESS;
-}
-
-/*****************************************************************************/
-/**
- * @brief   This function send a repose frame from system bus tx queue.
- *
- * @param   instPtr A pointer to System Bus instance.
- *
- * @return  None
- *
- ******************************************************************************/
-int32_t SystemBus_MakeResp(SYSBUS *instPtr)
-{
-	ASSERT(instPtr != NULL);
-	int32_t Status;
-	SYSBUS_UART_FRAME *sysbusRsp;
-	if (CircQueuePop(instPtr->txQueue, (void **)(&sysbusRsp)) == false)
-	{
-		DBG_WARNING("SystemBus::Nothing to be sent.\n");
-		return EIGNORE;
-	}
-	instPtr->isTxDone = false; // A transmission procedure is started.
-	Status = SysbusUart_Send(instPtr->uartInst, sysbusRsp);
-	free(sysbusRsp);
-	return Status;
-}
-
 /*****************************************************************************/
 /**
  * @brief   This function handles the systembus tx irq events.
@@ -628,10 +737,9 @@ int32_t SystemBus_TxIntrHandler(SYSBUS *instPtr)
 int32_t SystemBus_RxIntrHandler(SYSBUS *instPtr)
 {
 	ASSERT(instPtr != NULL);
-	int32_t Status;
-	SYSBUS_UART_FRAME *sysbusReq;
 	instPtr->isRxDone = true; // whether reception successes or not, receiving procedure ended.
-	sysbusReq = malloc(sizeof(SYSBUS_UART_FRAME));
+	int32_t Status;
+	SYSBUS_UART_FRAME *sysbusReq = malloc(sizeof(SYSBUS_UART_FRAME));
 	if (sysbusReq == NULL)
 	{
 		return ENOMEM;
@@ -653,3 +761,5 @@ recv_error:
 	free(sysbusReq);
 	return Status;
 }
+
+/** @} SystemBus*/

df_datalink_sp/src/systembus/systembus.h

@@ -1,65 +1,83 @@
 /*****************************************************************************/
 /**
- * Description: System bus protocol head file.
+ * @file systembus.h
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief System bus protocol header file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2023-05-06 10:12
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * Last Edit Time: [2023-05-06 10:13]
+ * Lab of Communication and Network
- *
- * Revisions: Rev 0.0
- * History:
- * [2023-05-06]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
  *
  ******************************************************************************/
 
+/**
+ * @defgroup SystemBus
+ * @{
+ */
 #ifndef __SYSTEMBUS_H_
 #define __SYSTEMBUS_H_
 
 /***************************** Include Files *********************************/
-#include "systembus_uart.h" // SystemBus UART driver
-#include "circ_queue.h"
 #include <stdint.h>
 #include <stdbool.h>
+#include "systembus_uart.h" // SystemBus UART driver
+#include "circ_queue.h"
+#include "../system_monitor.h"
 
 /************************** Constant Definitions *****************************/
 /************************** Data Type Definitions ****************************/
-// Definition of SystemBus instance.
+
+/**
+ * @struct SYSBUS_CONFIG
+ * @brief SystemBus Config struct holds SystemBus initialization parameters
+ */
 typedef struct
 {
-    uintptr_t baseAddr;
+	uintptr_t baseAddr;	 ///< base address in memory
-    uint32_t txQueueMax;
+	uint32_t txQueueMax; ///< maximum tx queue length
-    uint32_t rxQueueMax;
+	uint32_t rxQueueMax; ///< maximum rx queue length
 } SYSBUS_CONFIG;
 
+/**
+ * @struct SYSBUS
+ * @brief SystemBus Instance struct
+ */
 typedef struct
 {
-    SYSBUS_CONFIG config;
+	SYSBUS_CONFIG config;  ///< SystemBus initialization parameters
-    SYSBUS_UART *uartInst;
+	SYSBUSLOG sysbusLog;   ///< SystemBus log
-    CIRC_QUEUE *txQueue;
+	LINKLOG linkLog;	   ///< Link layer log
-    CIRC_QUEUE *rxQueue;
+	PHYLOG phyLog;		   ///< Physical layer log
-    bool isRxDone;
+	HWSTATE hwState;	   ///< Hardware status
-    bool isTxDone;
+	SYSBUS_UART *uartInst; ///< physical uart controller instance
+	CIRC_QUEUE *txQueue;   ///< tx queue
+	CIRC_QUEUE *rxQueue;   ///< rx queue
+	bool isRxDone;		   ///< tx done indicator
+	bool isTxDone;		   ///< rx done indicator
 } SYSBUS;
 
 /************************** Function Prototypes ******************************/
 
 int32_t SystemBus_Init(SYSBUS **instPtr, SYSBUS_CONFIG *config);
 
+/**
+ * @defgroup SystemBus_Protocol_Routine
+ * @{
+ */
 int32_t SystemBus_HandleCmd(SYSBUS *instPtr);
-
-int32_t SystemBus_FLJ_PeriodUpdate(SYSBUS *instPtr);
-int32_t SystemBus_LJ_PeriodUpdate(SYSBUS *instPtr);
-
 int32_t SystemBus_MakeResp(SYSBUS *instPtr);
+/** @} */
 
 int32_t SystemBus_TxIntrHandler(SYSBUS *instPtr);
 int32_t SystemBus_RxIntrHandler(SYSBUS *instPtr);
 
-bool SystemBus_IsReqPendding(SYSBUS *instPtr);
+bool SystemBus_IsReqPending(SYSBUS *instPtr);
-bool SystemBus_IsRsqPendding(SYSBUS *instPtr);
+bool SystemBus_IsRsqPending(SYSBUS *instPtr);
 
 bool SystemBus_IsTxBusy(SYSBUS *instPtr);
 bool SystemBus_IsRxBusy(SYSBUS *instPtr);
 
 #endif //__SYSTEMBUS_H_
+
+/** @} SystemBus*/

df_datalink_sp/src/systembus/systembus_uart.c

@@ -1,18 +1,26 @@
 /*****************************************************************************/
 /**
- * Description: System bus uart driver implementation file.
+ * @file systembus_uart.h
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief System bus uart driver implementation file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2023-05-06 10:59
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditTime: 2023-05-06 21:56
+ * Lab of Communication and Network
- * Revisions: Rev 0.0
- * History:
- * [2023-05-06]: Initial version.
- *
- * Copyright(c) 2022 Beijing Institute of Technology.
  *
  ******************************************************************************/
+/**
+ * @addtogroup SystemBus
+ * @{
+ */
+
+/**
+ * @addtogroup SystemBus_UART
+ * @{
+ */
+
 
-/***************************** Include Files *******************************/
 #include <stdlib.h>
 #include <string.h>
 #include <stdint.h>
@@ -20,6 +28,10 @@
 #include "systembus_uart.h"
 #include "common.h"
 
+/**
+ * @name SystemBus_UART_Driver_Constants
+ * @{
+ */
 // Control and status register
 #define MODULE_VERSION 0
 #define UART_STATUS 4
@@ -30,9 +42,9 @@
 #define UART_STATUS_TX_BUSY 0x00010000
 #define UART_STATUS_RX_BUSY 0x01000000
 // Data buffer register
-#define UART_TXBUFF_LOW 1024
+#define UART_TXBUFF_OFFSET 1024
 #define UART_TXBUFF_MAX 1024
-#define UART_RXBUFF_LOW 2048
+#define UART_RXBUFF_OFFSET 2048
 #define UART_RXBUFF_MAX 1024
 
 // Frame Data offsets
@@ -47,7 +59,7 @@
 #define FRAME_CHECK_LEN 1	 // CheckSum
 #define FRAME_INFO_LEN 3	 // CheckSum, Dummy and DataLen
 #define FRAME_OVERHEAD_LEN 7 // CheckSum, Dummy and DataLen
-/*************************** Function Definitions ****************************/
+/** @} SystemBus_UART_Driver_Constants*/
 
 /*****************************************************************************/
 /**
@@ -133,7 +145,7 @@ int SysbusUart_Send(SYSBUS_UART *instPtr, SYSBUS_UART_FRAME *frame)
 		free(sendBuff);
 		return FAILURE;
 	}
-	memcpy((void *)(instPtr->config.baseAddr + UART_TXBUFF_LOW), sendBuff, (sendLen + sizeof(uint32_t) - 1) / sizeof(uint32_t) * sizeof(uint32_t));
+	memcpy((void *)(instPtr->config.baseAddr + UART_TXBUFF_OFFSET), sendBuff, (sendLen + sizeof(uint32_t) - 1) / sizeof(uint32_t) * sizeof(uint32_t));
 	free(sendBuff);
 	// Start Sending
 	SYSTEMBUS_UART_mWriteReg(instPtr->config.baseAddr, UART_SEND_CMD, sendLen);
@@ -169,7 +181,7 @@ int SysbusUart_Recv(SYSBUS_UART *instPtr, SYSBUS_UART_FRAME *frame)
 	{
 		return ENOMEM;
 	}
-	memcpy(dBuff, (void *)(instPtr->config.baseAddr + UART_RXBUFF_LOW), sizeof(uint32_t) * dWLen);
+	memcpy(dBuff, (void *)(instPtr->config.baseAddr + UART_RXBUFF_OFFSET), sizeof(uint32_t) * dWLen);
 	plBuff = dBuff + FRAME_HEAD_LEN;
 	checkSumCal = 0;
 	checkSum = plBuff[dLen + FRAME_DUMMY_LEN];
@@ -246,3 +258,7 @@ bool SysbusUart_IsTxBusy(SYSBUS_UART *instPtr)
 		return false;
 	}
 }
+
+/** @} SystemBus_UART*/
+
+/** @} SystemBus*/

df_datalink_sp/src/systembus/systembus_uart.h

@@ -1,17 +1,25 @@
 /*****************************************************************************/
 /**
- * Description: System bus uart driver implementation file.
+ * @file systembus_uart.h
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief System bus uart driver header file.
+ * @version 0.1
+ * @date 2023-05-06
  *
- * Date: 2023-05-06 10:59
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * LastEditTime: 2023-05-06 21:48
+ * Lab of Communication and Network
- * Revisions: Rev 0.0
- * History:
- * [2023-05-06]: Initial version.
- *
- * Copyright(c) 2022 Beijing Institute of Technology.
  *
  ******************************************************************************/
 
+/**
+ * @addtogroup SystemBus
+ * @{
+ */
+
+/**
+ * @defgroup SystemBus_UART
+ * @{
+ */
 #ifndef SYSTEMBUS_UART_H
 #define SYSTEMBUS_UART_H
 
@@ -61,22 +69,33 @@
 	IO_In32((baseAddr) + (offset))
 
 /************************** Data Type Definitions ****************************/
+/**
+ * @struct SYSBUS_UART_CONFIG
+ * @brief SystemBus UART driver initialization parameters
+ */
 typedef struct
 {
 	uintptr_t baseAddr;
 } SYSBUS_UART_CONFIG;
 
+/**
+ * @struct  SYSBUS_UART
+ * @brief SystemBus UART driver instance
+ */
 typedef struct
 {
 	SYSBUS_UART_CONFIG config;
 } SYSBUS_UART;
 
+/**
+ * @struct  SYSBUS_UART_FRAME
+ * @brief SystemBus UART frame definition
+ */
 typedef struct
 {
-	uint8_t len;
+	uint16_t len;
 	uint8_t checkSum;
 	uint8_t isValid;
-	uint8_t dummy;
 	uint8_t data[256];
 } SYSBUS_UART_FRAME;
 
@@ -97,3 +116,7 @@ bool SysbusUart_IsRxBusy(SYSBUS_UART *instPtr);
 bool SysbusUart_IsTxBusy(SYSBUS_UART *instPtr);
 
 #endif // SYSTEMBUS_UART_H
+
+/** @} SystemBus_UART*/
+
+/** @} SystemBus*/

df_datalink_sp/src/time_ctrl/time_ctrl.c

@@ -1,20 +1,21 @@
 /*****************************************************************************/
 /**
- * Description: Time sync implementation file.
+ * @file time_ctrl.c
- *
+ * @author FanHao (hao_fan_bit_ee@163.com)
- * Author: Author's name
+ * @brief Time sync controller driver implementation file.
- * Date: 2023-12-20 16:32
+ * @version 0.0
- * LastEditors: FanHao
+ * @date 2023-12-20
- * LastEditTime: 2023-12-22 20:43
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * Revisions: Rev 0.0
+ * Lab of Communication and Network
- * History:
- * [2023-12-20]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
 
+/**
+ * @addtogroup TimeController_Driver
+ * @{
+ */
+
+
 /***************************** Include Files *********************************/
 #include <string.h>
 #include "time_ctrl.h"
@@ -23,6 +24,10 @@
 #include "util.h"
 
 /************************** Constant Definitions *****************************/
+/**
+ * @name TimeController_REG_Constants
+ * @{
+ */
 #define VERSION_REG 0x00000004
 #define TIME_INT_REG 0x00000008
 #define TIME_FRAC_REG 0x0000000C
@@ -36,6 +41,9 @@
 #define CNTSTEP_OPT 0x0000002c
 
 #define TM_RESET_CODE 0x5253542E
+
+/** @} TimeController_REG_Constants*/
+
 /***************** Macros (Inline Functions) Definitions *********************/
 #define TMC_Read(instPtr, addr) IO_In32(instPtr->config.baseAddr + addr)
 #define TMC_Write(instPtr, addr, value) IO_Out32(instPtr->config.baseAddr + addr, value)
@@ -296,3 +304,5 @@ void TimeCtrl_CalculateTimeGap(const TIME_WORD *a, const TIME_WORD *b, TIME_WORD
 	gap->frac_part = (TIME_FRAC)(timeDiff % TIME_FRAC_MAX);
 	gap->frac_part = (TIME_INT)(timeDiff / TIME_FRAC_MAX);
 }
+
+/** @} TimeController_Driver*/

df_datalink_sp/src/time_ctrl/time_ctrl.h

@@ -1,19 +1,20 @@
 /*****************************************************************************/
 /**
- * Description: A simplified version of timesync for datalink 814 (Dijian)
+ * @file time_ctrl.h
- *
+ * @author FanHao (hao_fan_bit_ee@163.com)
- * Date: 2023-12-20-04 16:32
+ * @brief Time sync controller driver header file.
- * LastEditors: Fan Hao
+ * @version 0.0
- * LastEditTime: 2023-12-20 16:32
+ * @date 2023-12-20
- * Revisions: Rev 0.0
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
- * History:
+ * Lab of Communication and Network
- * [2023-12-20]: Initial version.
- *
- * Copyright(c) 2021 Beijing Institute of Technology.
- * Lab of Communication and Networking
  *
  ******************************************************************************/
 
+/**
+ * @defgroup TimeController_Driver
+ * @{
+ */
+
 #ifndef TIME_CTRL_H_
 #define TIME_CTRL_H_
 
@@ -23,30 +24,44 @@
 #define TIME_FRAC_MAX 500000 // how many 10ns in a 5ms
 /***************** Macros (Inline Functions) Definitions *********************/
 /**************************** Type Definitions *******************************/
+/**
+ * @enum TIMECTRL_ADJ_TYPE
+ * @brief defines the time adjustment methods
+ */
 typedef enum
 {
-	TM_ADJ_NONE = 0,
+	TM_ADJ_NONE = 0, ///< none
-	TM_ADJ_ADD = 1,
+	TM_ADJ_ADD = 1, ///< adjust time by add
-	TM_ADJ_SET = 2
+	TM_ADJ_SET = 2  ///< adjust time by set
 } TIMECTRL_ADJ_TYPE;
 
 typedef uint32_t TIME_FRAC;
 typedef uint32_t TIME_INT;
 
+/**
+ * @struct TIME_WORD
+ * @brief Time controller time word
+ */
 typedef struct
 {
-	/* 5ms each LSB */
+	TIME_INT int_part; ///< 5ms each LSB
-	TIME_INT int_part;
+	TIME_FRAC frac_part; ///< 10ns each LSB
-	/* 10ns each LSB */
-	TIME_FRAC frac_part;
 } TIME_WORD;
 
+/**
+ * @struct TMC_CONFIG
+ * @brief TmcConfig holds the initialization parameters of time controller
+ */
 typedef struct
 {
 	uintptr_t baseAddr;
 	uint32_t reset; // time for reset (unit: us)
 } TMC_CONFIG;
 
+/**
+ * @struct TMC_INST
+ * @brief An instance struct of time controller
+ */
 typedef struct
 {
 	TMC_CONFIG config;
@@ -72,3 +87,5 @@ void TimeCtrl_TimeAdjust(TMC_INST *instPtr, const TIME_WORD *tmWord, TIMECTRL_AD
 void TimeCtrl_CalculateTimeGap(const TIME_WORD *a, const TIME_WORD *b, TIME_WORD *gap);
 
 #endif /* TIME_SYNC_H_ */
+
+/** @} */

df_datalink_sp/src/util/circ_queue.c

@@ -1,34 +1,25 @@
 /*****************************************************************************/
 /**
- * Description: A simple circular FIFO bounded queue
+ * @file circ_queue.c
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief A simple circular FIFO bounded queue
+ * @version 0.1
+ * @date 2023-02-23
+ * @note Forked from https://github.com/chrismerck/rpa_queue.git
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
  *
- * Author: Fan Hao
- * Date: 2023-02-23 10:29
- * LastEditors: Fan Hao
- * LastEditTime: 2023-02-23 13:18
- * Revisions: Rev 0.0
- * History:
- * [2023-02-23]: Initial Version.
- *
- * Copyright(c) 2023 Beijing Institute of Technology.
- * Lab of Communication and Networking
- * NOTE: Forked from https://github.com/chrismerck/rpa_queue.git
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements.  See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
  ******************************************************************************/
 
+/**
+ * @addtogroup Utility
+ * @{
+ */
+
+/**
+ * @addtogroup CircularQueue
+ * @{
+ */
 #include "circ_queue.h"
 #include "common.h"
 #include <stdio.h>
@@ -56,7 +47,7 @@ void CircQueueFree(CIRC_QUEUE *queue)
 }
 
 /**
- * Initialize the CIRC_QUEUE.
+ * @brief Initialize the CIRC_QUEUE.
  */
 bool CircQueueCreate(CIRC_QUEUE **q, uint32_t queueCapacity)
 {
@@ -87,7 +78,7 @@ error:
 }
 
 /**
- * Push new data onto the queue.
+ * @brief Push new data onto the queue.
  */
 bool CircQueuePush(CIRC_QUEUE *queue, void *data)
 {
@@ -110,7 +101,7 @@ bool CircQueuePush(CIRC_QUEUE *queue, void *data)
 }
 
 /**
- * Return current number of element in queue.
+ * @brief Return current number of element in queue.
  */
 inline uint32_t CircQueueSize(CIRC_QUEUE *queue)
 {
@@ -118,7 +109,7 @@ inline uint32_t CircQueueSize(CIRC_QUEUE *queue)
 }
 
 /**
- * Retrieves the next item from the queue.
+ * @brief Retrieves the next item from the queue.
  */
 bool CircQueuePop(CIRC_QUEUE *queue, void **data)
 {
@@ -139,3 +130,5 @@ bool CircQueuePop(CIRC_QUEUE *queue, void **data)
 	}
 	return true;
 }
+/** @} CircularQueue*/
+/** @} Utility*/

df_datalink_sp/src/util/clist.c

@@ -1,3 +1,25 @@
+/*****************************************************************************/
+/**
+ * @file clist.c
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief A basic list data structure
+ * @version 0.1
+ * @date 2023-02-23
+ * @note Forked from https://github.com/clibs/list
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+
+/**
+ * @addtogroup Utility
+ * @{
+ */
+
+/**
+ * @addtogroup cList
+ * @{
+ */
 #ifndef LIST_MALLOC
 #define LIST_MALLOC malloc
 #endif
@@ -6,19 +28,12 @@
 #define LIST_FREE free
 #endif
 
-//
-// list.c
-//
-// Copyright (c) 2010 TJ Holowaychuk <[email protected]>
-//
-
 #include <stdint.h>
 #include "clist.h"
 
-/*
+/**
- * Allocates a new clist_node_t. NULL on failure.
+ * @brief a new clist_node_t. NULL on failure.
  */
-
 clist_node_t *
 clist_node_new(void *val)
 {
@@ -31,10 +46,9 @@ clist_node_new(void *val)
 	return self;
 }
 
-/*
+/**
- * Allocate a new clist_t. NULL on failure.
+ * @brief Allocate a new clist_t. NULL on failure.
  */
-
 clist_t *
 clist_new(void)
 {
@@ -49,14 +63,12 @@ clist_new(void)
 	return self;
 }
 
-/*
+/**
- * Remove all the node in list.
+ * @brief Remove all the node in list.
- * @self: Pointer to the list
+ * @param self: Pointer to the list
  */
-
 void clist_clear(clist_t *self)
 {
-  uint32_t len = self->len;
 	clist_node_t *next;
 	clist_node_t *curr = self->head;
 
@@ -72,24 +84,21 @@ void clist_clear(clist_t *self)
 	self->head = NULL;
 }
 
-/*
+/**
- * Free the list.
+ * @brief Free the list.
- * @self: Pointer to the list
+ * @param self: Pointer to the list
  */
-
 void clist_destroy(clist_t *self)
 {
 	clist_clear(self);
 	LIST_FREE(self);
 }
 
-/*
+/**
- * Append the given node to the list
+ * @brief Append the given node to the list and return the node, NULL on failure.
- * and return the node, NULL on failure.
+ * @param self: Pointer to the list for popping node
- * @self: Pointer to the list for popping node
+ * @param node: the node to push
- * @node: the node to push
  */
-
 clist_node_t *
 clist_rpush(clist_t *self, clist_node_t *node)
 {
@@ -113,9 +122,9 @@ clist_rpush(clist_t *self, clist_node_t *node)
 	return node;
 }
 
-/*
+/**
- * Return / detach the last node in the list, or NULL.
+ * @brief Return / detach the last node in the list, or NULL.
- * @self: Pointer to the list for popping node
+ * @param self: Pointer to the list for popping node
  */
 
 clist_node_t *
@@ -139,9 +148,9 @@ clist_rpop(clist_t *self)
 	return node;
 }
 
-/*
+/**
- * Return / detach the first node in the list, or NULL.
+ * @brief Return / detach the first node in the list, or NULL.
- * @self: Pointer to the list for popping node
+ * @param self: Pointer to the list for popping node
  */
 
 clist_node_t *
@@ -165,11 +174,10 @@ clist_lpop(clist_t *self)
 	return node;
 }
 
-/*
+/**
- * Prepend the given node to the list
+ * @brief Prepend the given node to the list and return the node, NULL on failure.
- * and return the node, NULL on failure.
+ * @param self: Pointer to the list for pushing node
- * @self: Pointer to the list for pushing node
+ * @param node: the node to push
- * @node: the node to push
  */
 
 clist_node_t *
@@ -195,10 +203,10 @@ clist_lpush(clist_t *self, clist_node_t *node)
 	return node;
 }
 
-/*
+/**
- * Return the node associated to val or NULL.
+ * @brief Return the node associated to val or NULL.
- * @self: Pointer to the list for finding given value
+ * @param self: Pointer to the list for finding given value
- * @val: Value to find
+ * @param val: Value to find
  */
 
 clist_node_t *
@@ -231,10 +239,10 @@ clist_find(clist_t *self, void *val)
 	return NULL;
 }
 
-/*
+/**
- * Return the node at the given index or NULL.
+ * @brief Return the node at the given index or NULL.
- * @self: Pointer to the list for finding given index
+ * @param self: Pointer to the list for finding given index
- * @index: the index of node in the list
+ * @param index: the index of node in the list
  */
 
 clist_node_t *
@@ -261,10 +269,10 @@ clist_at(clist_t *self, int index)
 	return NULL;
 }
 
-/*
+/**
- * Remove the given node from the list, freeing it and it's value.
+ * @brief Remove the given node from the list, freeing it and it's value.
- * @self: Pointer to the list to delete a node
+ * @param self: Pointer to the list to delete a node
- * @node: Pointer the node to be deleted
+ * @param node: Pointer the node to be deleted
  */
 
 void clist_remove(clist_t *self, clist_node_t *node)
@@ -284,8 +292,8 @@ void clist_remove(clist_t *self, clist_node_t *node)
 	--self->len;
 }
 
-/*
+/**
- * Allocate a new clist_iterator_t. NULL on failure.
+ * @brief Allocate a new clist_iterator_t. NULL on failure.\n
  * Accepts a direction, which may be LIST_HEAD or LIST_TAIL.
  */
 
@@ -298,8 +306,8 @@ clist_iterator_new(clist_t *list, clist_direction_t direction)
 	return clist_iterator_new_from_node(node, direction);
 }
 
-/*
+/**
- * Allocate a new clist_iterator_t with the given start
+ * @brief Allocate a new clist_iterator_t with the given start
  * node. NULL on failure.
  */
 
@@ -314,8 +322,8 @@ clist_iterator_new_from_node(clist_node_t *node, clist_direction_t direction)
 	return self;
 }
 
-/*
+/**
- * Return the next clist_node_t or NULL when no more
+ * @brief Return the next clist_node_t or NULL when no more
  * nodes remain in the list.
  */
 
@@ -332,8 +340,8 @@ clist_iterator_next(clist_iterator_t *self)
 	return curr;
 }
 
-/*
+/**
- * Free the list iterator.
+ * @brief Free the list iterator.
  */
 
 void clist_iterator_destroy(clist_iterator_t *self)
@@ -341,3 +349,5 @@ void clist_iterator_destroy(clist_iterator_t *self)
 	LIST_FREE(self);
 	self = NULL;
 }
+/** @} cList*/
+/** @} Utility*/

df_datalink_sp/src/util/common.c

@@ -10,11 +10,14 @@
  * [2022-07-16]: New branch for Dijian.
  * [2021-11-16]: Initial version.
  *
- * Copyright(c) 2021 Beijing Institute of Technology.
+ * Copyright(c) 2024 Beijing Institute of Technology.
  * Lab of Communication and Networking
  *
  ******************************************************************************/
-
+/**
+ * @addtogroup COMMON_MACRO
+ * @{
+ */
 /***************************** Include Files *********************************/
 #include "common.h"
 #include "error.h"
@@ -44,3 +47,5 @@ void AppAssert(const char *file, int line)
 	while (1)
 		;
 }
+
+/** @} */

df_datalink_sp/src/util/crc.c

@@ -11,11 +11,14 @@
  * [2022-07-17]: Add CRC16_0x8005 CRC8_0x31.
  * [2022-01-06]: Initial verion (Basic CRC-16).
  *
- * Copyright(c) 2021 Beijing Institute of Technology.
+ * Copyright(c) 2024 Beijing Institute of Technology.
  * Lab of Communication and Networking
  *
  ******************************************************************************/
-
+/**
+ * @addtogroup Utility
+ * @{
+ */
 #include "util.h"
 #include "error.h"
 
@@ -437,3 +440,5 @@ bool crc16_check(uint8_t *buffPtr, uint32_t dataLen, uint32_t crcOffset, uint16_
 		return false;
 	}
 }
+
+/** @}*/

df_datalink_sp/src/util/list.c

@@ -1,5 +1,5 @@
 /*******************************************************************************
-*   @file   list.c
+ *   @file   list.c
  *   @brief  List library implementation
  *   @author Mihail Chindris (mihail.chindris@analog.com)
 ********************************************************************************

df_datalink_sp/src/util/util.c

@@ -1,15 +1,30 @@
-/******************************************************************************/
+/*****************************************************************************/
+/**
+ * @file util.c
+ * @author FanHao (hao_fan_bit_ee@163.com)
+ * @brief Utility functions implementation file
+ * @version 0.0
+ * @date 2023-05-06
+ *
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
+ *
+ ******************************************************************************/
+
 /***************************** Include Files **********************************/
-/******************************************************************************/
+
+/**
+ * @addtogroup Utility
+ * @{
+ */
+
 #include <string.h>
 #include <stdlib.h>
 // #include <arm_acle.h>
 #include "util.h"
 #include "error.h"
 
-/******************************************************************************/
 /************************** Functions Implementation **************************/
-/******************************************************************************/
 #ifdef __BITSWAP_TABLE
 static uint8_t byte_flipLR[256] =
 {
@@ -48,17 +63,26 @@ static uint8_t byte_flipLR[256] =
 };
 #endif
 
+/**
+ * @brief Write a 32bit word to specific memory address
+ */
 inline void IO_Out32(uintptr_t addr, uint32_t value)
 {
 	volatile uint32_t *localAddr = (volatile uint32_t *)addr;
 	*localAddr = value;
 }
 
+/**
+ * @brief Read a 32bit word from specific memory address
+ */
 inline uint32_t IO_In32(uintptr_t addr)
 {
 	return *(volatile uint32_t *)addr;
 }
 
+/**
+ * @brief Swap a byte word bit-wise
+ */
 uint8_t byte_bit_swap(uint8_t byte)
 {
 #ifdef __BITSWAP_TABLE
@@ -68,6 +92,9 @@ uint8_t byte_bit_swap(uint8_t byte)
 #endif
 }
 
+/**
+ * @brief Swap 32bit word bit-wise
+ */
 uint32_t word_bit_swap(uint32_t word)
 {
 #ifdef __BITSWAP_TABLE
@@ -85,6 +112,9 @@ uint32_t word_bit_swap(uint32_t word)
 #endif
 }
 
+/**
+ * @brief Count ones in an 32bit word
+ */
 uint32_t count_ones(uint32_t word)
 {
 #ifdef __GNUC__
@@ -101,13 +131,16 @@ uint32_t count_ones(uint32_t word)
 #endif
 }
 
+/**
+ * @brief Convert fix ;oint number to float number
+ */
 double fix2double(int32_t val, uint8_t frac_bits)
 {
 	return (((double)val) / (BIT(frac_bits)));
 }
 
 /**
- * Find first set bit in word.
+ * @brief Find first set bit in word.
  */
 uint32_t find_first_set_bit(uint32_t word)
 {
@@ -136,7 +169,7 @@ uint32_t find_first_set_bit(uint32_t word)
 }
 
 /**
- * Find last set bit in word.
+ * @brief Find last set bit in word.
  */
 uint32_t find_last_set_bit(uint32_t word)
 {
@@ -166,7 +199,7 @@ uint32_t find_last_set_bit(uint32_t word)
 }
 
 /**
- * Locate the closest element in an array.
+ * @brief Locate the closest element in an array.
  */
 uint32_t find_closest(int32_t val,
 					  const int32_t *array,
@@ -189,7 +222,7 @@ uint32_t find_closest(int32_t val,
 }
 
 /**
- * Shift the value and apply the specified mask.
+ * @brief Shift the value and apply the specified mask.
  */
 uint32_t field_prep(uint32_t mask, uint32_t val)
 {
@@ -197,7 +230,7 @@ uint32_t field_prep(uint32_t mask, uint32_t val)
 }
 
 /**
- * Get a field specified by a mask from a word.
+ * @brief Get a field specified by a mask from a word.
  */
 uint32_t field_get(uint32_t mask, uint32_t word)
 {
@@ -205,7 +238,7 @@ uint32_t field_get(uint32_t mask, uint32_t word)
 }
 
 /**
- * Log base 2 of the given number.
+ * @brief Log base 2 of the given number.
  */
 int32_t log_base_2(uint32_t x)
 {
@@ -213,7 +246,7 @@ int32_t log_base_2(uint32_t x)
 }
 
 /**
- * Find greatest common divisor of the given two numbers.
+ * @brief Find greatest common divisor of the given two numbers.
  */
 uint32_t greatest_common_divisor(uint32_t a,
 								 uint32_t b)
@@ -232,7 +265,7 @@ uint32_t greatest_common_divisor(uint32_t a,
 }
 
 /**
- * Calculate best rational approximation for a given fraction.
+ * @brief Calculate best rational approximation for a given fraction.
  */
 void rational_best_approximation(uint32_t given_numerator,
 								 uint32_t given_denominator,
@@ -257,7 +290,7 @@ void rational_best_approximation(uint32_t given_numerator,
 }
 
 /**
- * Calculate the number of set bits.
+ * @brief Calculate the number of set bits.
  */
 uint32_t hweight8(uint32_t word)
 {
@@ -274,7 +307,7 @@ uint32_t hweight8(uint32_t word)
 }
 
 /**
- * Calculate the quotient and the remainder of an integer division.
+ * @brief Calculate the quotient and the remainder of an integer division.
  */
 uint64_t do_div(uint64_t *n,
 				uint64_t base)
@@ -288,7 +321,7 @@ uint64_t do_div(uint64_t *n,
 }
 
 /**
- * Unsigned 64bit divide with 64bit divisor and remainder
+ * @brief Unsigned 64bit divide with 64bit divisor and remainder
  */
 uint64_t div64_u64_rem(uint64_t dividend, uint64_t divisor, uint64_t *remainder)
 {
@@ -298,7 +331,7 @@ uint64_t div64_u64_rem(uint64_t dividend, uint64_t divisor, uint64_t *remainder)
 }
 
 /**
- * Unsigned 64bit divide with 32bit divisor with remainder
+ * @brief Unsigned 64bit divide with 32bit divisor with remainder
  */
 uint64_t div_u64_rem(uint64_t dividend, uint32_t divisor, uint32_t *remainder)
 {
@@ -308,7 +341,7 @@ uint64_t div_u64_rem(uint64_t dividend, uint32_t divisor, uint32_t *remainder)
 }
 
 /**
- * Signed 64bit divide with 32bit divisor with remainder
+ * @brief Signed 64bit divide with 32bit divisor with remainder
  */
 int64_t div_s64_rem(int64_t dividend, int32_t divisor, int32_t *remainder)
 {
@@ -317,7 +350,7 @@ int64_t div_s64_rem(int64_t dividend, int32_t divisor, int32_t *remainder)
 }
 
 /**
- * Unsigned 64bit divide with 32bit divisor
+ * @brief Unsigned 64bit divide with 32bit divisor
  */
 uint64_t div_u64(uint64_t dividend, uint32_t divisor)
 {
@@ -327,7 +360,7 @@ uint64_t div_u64(uint64_t dividend, uint32_t divisor)
 }
 
 /**
- * Signed 64bit divide with 32bit divisor
+ * @brief Signed 64bit divide with 32bit divisor
  */
 int64_t div_s64(int64_t dividend, int32_t divisor)
 {
@@ -336,7 +369,7 @@ int64_t div_s64(int64_t dividend, int32_t divisor)
 }
 
 /**
- * Converts from string to int32_t
+ * @brief Converts from string to int32_t
  * @param *str
  * @return int32_t
  */
@@ -352,7 +385,7 @@ int32_t str_to_int32(const char *str)
 }
 
 /**
- * Converts from string to uint32_t
+ * @brief Converts from string to uint32_t
  * @param *str
  * @return uint32_t
  */
@@ -366,3 +399,5 @@ uint32_t srt_to_uint32(const char *str)
 	else
 		return value;
 }
+
+/** @} */

df_datalink_sp/unit_test/linklayer_emulate_unit_test.c

@@ -68,7 +68,7 @@ void linklayer_setup(void)
 	ASSERT_EQUAL(SUCCESS, Status);
 	Status = TimeCtrl_Init(&tmcInstPtr, &tmcConfig);
 	ASSERT_EQUAL(SUCCESS, Status);
-	Status = Phy_InstInit(&phyInstPtr, &l1Config);
+	Status = Phy_Init(&phyInstPtr, &l1Config);
 	ASSERT_EQUAL(SUCCESS, Status);
 
 	// Update l2 config

makecopy

@@ -10,5 +10,5 @@ cp -rL $PROJECT_DIR/df_datalink_sp/src $DST_DIR/df_datalink_sp
 cp -rL $PROJECT_DIR/df_datalink_ge/src $DST_DIR/df_datalink_ge
 
 cd $DST_DIR/df_datalink_ge/networking/phy_layer
-sed -i "s/antConfig->rfTxMgc = 0;/antConfig->rfTxMgc = $GE_TXATT;/g" ./phy_antenna.c
+sed -i'' -e "s/antConfig->rfTxMgc = 0;/antConfig->rfTxMgc = $GE_TXATT;/g" ./phy_antenna.c
-sed -i "s/antConfig->rcvMgc = 0;/antConfig->rcvMgc = $GE_RXATT;/g" ./phy_antenna.c
+sed -i'' -e "s/antConfig->rcvMgc = 0;/antConfig->rcvMgc = $GE_RXATT;/g" ./phy_antenna.c