Add QCanBusDevice::busStatus()

The original terminology is Error active, Error warning,
Error Passive and Bus Off. We map them to GoodStatus,
WarningStatus, ErrorStatus and BusOffStatus here.

[ChangeLog][QCanBusDevice] Added the function busStatus()
to query the CAN bus status from the CAN bus device.

Fixes: QTBUG-70766
Change-Id: I22b99e2a02a6b22509005dd177796b861d536281
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>

3 files changed, 69 insertions, 0 deletions

diff --git a/src/plugins/canbus/vectorcan/vectorcan_symbols_p.h b/src/plugins/canbus/vectorcan/vectorcan_symbols_p.h
index 3f2501f..8c1ad52 100644
--- a/src/plugins/canbus/vectorcan/vectorcan_symbols_p.h
+++ b/src/plugins/canbus/vectorcan/vectorcan_symbols_p.h
@@ -249,9 +249,27 @@ static_assert(sizeof(s_xl_can_msg) == 32, "Invalid size of s_xl_can_msg structur
 #define XL_TRANSCEIVER_EVENT_ERROR      1
 #define XL_TRANSCEIVER_EVENT_CHANGED    2
 
+#define XL_CHIPSTAT_BUSOFF              0x01
+#define XL_CHIPSTAT_ERROR_PASSIVE       0x02
+#define XL_CHIPSTAT_ERROR_WARNING       0x04
+#define XL_CHIPSTAT_ERROR_ACTIVE        0x08
+
+#define XL_CAN_STATE_FLAG_SJA_MODE      0x00000001
+
+// CAN Chip status
+struct s_xl_chip_state {
+    unsigned char busStatus;
+    unsigned char txErrorCounter;
+    unsigned char rxErrorCounter;
+    unsigned char chipState;           // raw Status Register Value
+    unsigned int  flags;
+};
+static_assert(sizeof(s_xl_chip_state) == 8, "Invalid size of s_xl_chip_state structure");
+
 // basic bus message structure
 union s_xl_tag_data {
     struct s_xl_can_msg msg;
+    struct s_xl_chip_state chipState;
 };
 
 // event type definition (48 bytes)
@@ -456,6 +474,7 @@ GENERATE_SYMBOL_VARIABLE(XLstatus, xlCanSetChannelBitrate, XLportHandle, XLacces
 GENERATE_SYMBOL_VARIABLE(XLstatus, xlCanTransmit, XLportHandle, XLaccess, quint32 *, void *)
 GENERATE_SYMBOL_VARIABLE(XLstatus, xlReceive, XLportHandle, quint32 *, XLevent *)
 GENERATE_SYMBOL_VARIABLE(XLstatus, xlSetNotification, XLportHandle, XLhandle *, int)
+GENERATE_SYMBOL_VARIABLE(XLstatus, xlCanRequestChipState, XLportHandle, XLaccess)
 GENERATE_SYMBOL_VARIABLE(char *, xlGetErrorString, XLstatus)
 
 inline bool resolveSymbols(QLibrary *vectorcanLibrary)
@@ -481,6 +500,7 @@ inline bool resolveSymbols(QLibrary *vectorcanLibrary)
     RESOLVE_SYMBOL(xlCanTransmit)
     RESOLVE_SYMBOL(xlReceive)
     RESOLVE_SYMBOL(xlSetNotification)
+    RESOLVE_SYMBOL(xlCanRequestChipState)
     RESOLVE_SYMBOL(xlGetErrorString)
 
     return true;
diff --git a/src/plugins/canbus/vectorcan/vectorcanbackend.cpp b/src/plugins/canbus/vectorcan/vectorcanbackend.cpp
index 24dbe2c..9d3bdef 100644
--- a/src/plugins/canbus/vectorcan/vectorcanbackend.cpp
+++ b/src/plugins/canbus/vectorcan/vectorcanbackend.cpp
@@ -446,6 +446,9 @@ VectorCanBackend::VectorCanBackend(const QString &name, QObject *parent)
 
     d->setupChannel(name);
     d->setupDefaultConfigurations();
+
+    std::function<CanBusStatus()> g = std::bind(&VectorCanBackend::busStatus, this);
+    setCanBusStatusGetter(g);
 }
 
 VectorCanBackend::~VectorCanBackend()
@@ -540,4 +543,48 @@ QString VectorCanBackend::interpretErrorFrame(const QCanBusFrame &errorFrame)
     return QString();
 }
 
+QCanBusDevice::CanBusStatus VectorCanBackend::busStatus()
+{
+    Q_D(VectorCanBackend);
+
+    const XLstatus requestStatus = ::xlCanRequestChipState(d->portHandle, d->channelMask);
+    if (Q_UNLIKELY(requestStatus != XL_SUCCESS)) {
+        const QString errorString = d->systemErrorString(requestStatus);
+        qCWarning(QT_CANBUS_PLUGINS_VECTORCAN, "Can not query CAN bus status: %ls.",
+                  qUtf16Printable(errorString));
+        setError(errorString, QCanBusDevice::CanBusError::ReadError);
+        return QCanBusDevice::CanBusStatus::Unknown;
+    }
+
+    quint32 eventCount = 1;
+    XLevent event;
+    ::memset(&event, 0, sizeof(event));
+
+    const XLstatus receiveStatus = ::xlReceive(d->portHandle, &eventCount, &event);
+    if (Q_UNLIKELY(receiveStatus != XL_SUCCESS)) {
+        const QString errorString = d->systemErrorString(receiveStatus);
+        qCWarning(QT_CANBUS_PLUGINS_VECTORCAN, "Can not query CAN bus status: %ls.",
+                  qUtf16Printable(errorString));
+        setError(errorString, QCanBusDevice::CanBusError::ReadError);
+        return QCanBusDevice::CanBusStatus::Unknown;
+    }
+
+    if (Q_LIKELY(event.tag == XL_CHIP_STATE)) {
+        switch (event.tagData.chipState.busStatus) {
+        case XL_CHIPSTAT_BUSOFF:
+            return QCanBusDevice::CanBusStatus::BusOff;
+        case XL_CHIPSTAT_ERROR_PASSIVE:
+            return QCanBusDevice::CanBusStatus::Error;
+        case XL_CHIPSTAT_ERROR_WARNING:
+            return QCanBusDevice::CanBusStatus::Warning;
+        case XL_CHIPSTAT_ERROR_ACTIVE:
+            return QCanBusDevice::CanBusStatus::Good;
+        }
+    }
+
+    qCWarning(QT_CANBUS_PLUGINS_VECTORCAN, "Unknown CAN bus status: %u",
+              uint(event.tagData.chipState.busStatus));
+    return QCanBusDevice::CanBusStatus::Unknown;
+}
+
 QT_END_NAMESPACE
diff --git a/src/plugins/canbus/vectorcan/vectorcanbackend.h b/src/plugins/canbus/vectorcan/vectorcanbackend.h
index 165d369..89b9da6 100644
--- a/src/plugins/canbus/vectorcan/vectorcanbackend.h
+++ b/src/plugins/canbus/vectorcan/vectorcanbackend.h
@@ -71,6 +71,8 @@ public:
     static QList<QCanBusDeviceInfo> interfaces();
 
 private:
+    QCanBusDevice::CanBusStatus busStatus();
+
     VectorCanBackendPrivate * const d_ptr;
 };