#580 work on reactor PLC wired comms

reactor-plc/backplane.lua

@@ -0,0 +1,189 @@
+--
+-- Reactor PLC System Core Peripheral Backplane
+--
+
+local log     = require("scada-common.log")
+local network = require("scada-common.network")
+local ppm     = require("scada-common.ppm")
+local util    = require("scada-common.util")
+
+local databus = require("reactor-plc.databus")
+local plc     = require("reactor-plc.plc")
+
+local println = util.println
+
+---@class plc_backplane
+local backplane = {}
+
+local _bp = {
+    smem = nil,     ---@type plc_shared_memory
+
+    wlan_pref = true,
+    lan_iface = "",
+
+    act_nic = nil,  ---@type nic
+    wl_act = true,
+    wd_nic = nil,   ---@type nic|nil
+    wl_nic = nil    ---@type nic|nil
+}
+
+-- initialize the system peripheral backplane<br>
+---@param config plc_config
+---@param __shared_memory plc_shared_memory
+--- EVENT_CONSUMER: this function consumes events
+function backplane.init(config, __shared_memory)
+    _bp.smem      = __shared_memory
+    _bp.wlan_pref = config.PreferWireless
+    _bp.lan_iface = config.WiredModem
+
+    local plc_dev   = __shared_memory.plc_dev
+    local plc_state = __shared_memory.plc_state
+
+    -- Modem Init
+
+    -- init wired NIC
+    if type(config.WiredModem) == "string" then
+        local modem = ppm.get_modem(_bp.lan_iface)
+        _bp.wd_nic = network.nic(modem)
+
+        log.info("BKPLN: WIRED PHY_" .. util.trinary(modem, "UP ", "DOWN ") .. _bp.lan_iface)
+
+        -- set this as active for now
+        _bp.wl_act = false
+        _bp.act_nic = _bp.wd_nic
+    end
+
+    -- init wireless NIC(s)
+    if config.WirelessModem then
+        local modem, iface = ppm.get_wireless_modem()
+        _bp.wl_nic = network.nic(modem)
+
+        log.info("BKPLN: WIRELESS PHY_" .. util.trinary(modem, "UP ", "DOWN ") .. iface)
+
+        -- set this as active if connected or if both modems are disconnected and this is preferred
+        if (modem and _bp.wlan_pref) or not (_bp.act_nic and _bp.act_nic.is_connected()) then
+            _bp.wl_act = true
+            _bp.act_nic = _bp.wl_nic
+        end
+    end
+
+    plc_state.no_modem = not _bp.act_nic.is_connected()
+
+    databus.tx_hw_modem(not plc_state.no_modem)
+
+    -- comms modem is required if networked
+    if __shared_memory.networked and plc_state.no_modem then
+        println("startup> comms modem not found")
+        log.warning("BKPLN: no comms modem on startup")
+
+        plc_state.degraded = true
+    end
+
+    -- Reactor Init
+
+---@diagnostic disable-next-line: assign-type-mismatch
+    plc_dev.reactor      = ppm.get_fission_reactor()
+    plc_state.no_reactor = plc_dev.reactor == nil
+
+    -- we need a reactor, can at least do some things even if it isn't formed though
+    if plc_state.no_reactor then
+        println("startup> fission reactor not found")
+        log.warning("BKPLN: no reactor on startup")
+
+        plc_state.degraded = true
+        plc_state.reactor_formed = false
+
+        -- mount a virtual peripheral to init the RPS with
+        local _, dev = ppm.mount_virtual()
+        plc_dev.reactor = dev
+
+        log.info("BKPLN: mounted virtual device as reactor")
+    elseif not plc_dev.reactor.isFormed() then
+        println("startup> fission reactor is not formed")
+        log.warning("BKPLN: reactor logic adapter present, but reactor is not formed")
+
+        plc_state.degraded = true
+        plc_state.reactor_formed = false
+    else
+        log.info("BKPLN: reactor detected")
+    end
+end
+
+-- get the active NIC
+---@return nic|nil
+function backplane.active_nic() return _bp.act_nic end
+
+-- handle a backplane peripheral attach
+---@param iface string
+---@param type string
+---@param device table
+---@param print_no_fp function
+function backplane.attach(iface, type, device, print_no_fp)
+    local networked = _bp.smem.networked
+    local state     = _bp.smem.plc_state
+    local dev       = _bp.smem.plc_dev
+    local sys       = _bp.smem.plc_sys
+
+    if state.no_reactor and (type == "fissionReactorLogicAdapter") then
+        -- reconnected reactor
+        dev.reactor = device
+        state.no_reactor = false
+
+        print_no_fp("reactor reconnected")
+        log.info("BKPLN: reactor reconnected")
+
+        -- we need to assume formed here as we cannot check in this main loop
+        -- RPS will identify if it isn't and this will get set false later
+        state.reactor_formed = true
+
+        -- determine if we are still in a degraded state
+        if (not networked or not state.no_modem) and state.reactor_formed then
+            state.degraded = false
+        end
+
+        _bp.smem.q.mq_rps.push_command(MQ__RPS_CMD.SCRAM)
+
+        sys.rps.reconnect_reactor(dev.reactor)
+        if networked then
+            sys.plc_comms.reconnect_reactor(dev.reactor)
+        end
+
+        -- partial reset of RPS, specific to becoming formed/reconnected
+        -- without this, auto control can't resume on chunk load
+        sys.rps.reset_formed()
+    elseif networked and type == "modem" then
+        ---@cast device Modem
+        local is_comms_modem = util.trinary(dev.modem_wired, dev.modem_iface == iface, device.isWireless())
+
+        -- note, check init_ok first since nic will be nil if it is false
+        if is_comms_modem and not (state.init_ok and nic.is_connected()) then
+            -- reconnected modem
+            dev.modem = device
+            state.no_modem = false
+
+            if state.init_ok then nic.connect(device) end
+
+            print_no_fp("comms modem reconnected")
+            log.info("comms modem reconnected")
+
+            -- determine if we are still in a degraded state
+            if not state.no_reactor then
+                state.degraded = false
+            end
+        elseif device.isWireless() then
+            log.info("unused wireless modem connected")
+        else
+            log.info("non-comms wired modem connected")
+        end
+    end
+end
+
+-- handle a backplane peripheral detach
+---@param iface string
+---@param type string
+---@param device table
+---@param print_no_fp function
+function backplane.detach(iface, type, device, print_no_fp)
+end
+
+return backplane