From dd9b3d7ee62019d75764be7e49468976708f16fd Mon Sep 17 00:00:00 2001 From: Andre Hartmann Date: Thu, 18 Jul 2019 10:08:29 +0200 Subject: PeakCAN: Update documentation for added CAN FD functions When adding the CAN FD functions to the PeakCAN plugin in ac8509d992f4, the documentation was not updated properly. This patch catches up on that. Change-Id: Ib3d05d4aa8405226ede9616bd56ead1a8f98ea88 Reviewed-by: Alex Blasche --- src/serialbus/doc/src/peakcan.qdoc | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/src/serialbus/doc/src/peakcan.qdoc b/src/serialbus/doc/src/peakcan.qdoc index c8f52c9..fd12ab7 100644 --- a/src/serialbus/doc/src/peakcan.qdoc +++ b/src/serialbus/doc/src/peakcan.qdoc @@ -95,11 +95,26 @@ \header \li Configuration parameter key \li Description + \row + \li QCanBusDevice::CanFdKey + \li This configuration option determines whether CAN FD frames may be sent or + received. By default, this option is disabled. CAN FD compatible hardware + is needed to enable this option. \row \li QCanBusDevice::BitRateKey \li Determines the bit rate of the CAN bus connection. The following bit rates are supported: 5000, 10000, 20000, 33000, 47000, 50000, 83000, 95000, - 100000, 125000, 250000, 500000, 800000, 1000000. Note that this configuration - parameter can only be adjusted while the QCanBusDevice is not connected. + 100000, 125000, 250000, 500000, 800000, 1000000. + If the QCanBusDevice::CanFdKey option is enabled, the bit rates are limited + to 125000, 250000, 500000, or 1000000. + Note that this configuration parameter can only be adjusted while the + QCanBusDevice is not connected. + \row + \li QCanBusDevice::DataBitRateKey + \li Determines the data bit rate of the CAN FD bus connection. The + QCanBusDevice::CanFdKey option must be enabled to allow setting this option. + Possible data bitrates are 2000000, 4000000, 8000000, or 10000000. Note that + this configuration parameter can only be adjusted while the QCanBusDevice is + not connected. \endtable */ -- cgit v1.2.3 From 4fb3e302a30c675b3d515d6eb5dd08301727d4c1 Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Thu, 18 Jul 2019 13:11:43 +0200 Subject: Doc: Add precision to QCanBusFrame::setFrameId description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Done-with: Jochen Bauer Fixes: QTBUG-75502 Change-Id: I3a91c9b0c52985f5fe3ea357c8813c27ddbfd28d Reviewed-by: André Hartmann Reviewed-by: Denis Shienkov Reviewed-by: Sze Howe Koh --- src/serialbus/qcanbusframe.cpp | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/serialbus/qcanbusframe.cpp b/src/serialbus/qcanbusframe.cpp index 8ba0cc7..c62539e 100644 --- a/src/serialbus/qcanbusframe.cpp +++ b/src/serialbus/qcanbusframe.cpp @@ -80,9 +80,15 @@ QT_BEGIN_NAMESPACE /*! \fn QCanBusFrame::setFrameId(quint32 newFrameId) - Sets the identifier of the CAN frame to \a newFrameId. The maximum size of a CAN frame - identifier is 11 bits, which can be extended up to 29 bits by supporting the \e {CAN extended frame - format}. The \e {CAN extended frame format} setting is automatically adapted to match \a newFrameId. + Sets the identifier of the CAN frame to \a newFrameId. + + The maximum size of a CAN frame identifier is 11 bits, which can be + extended up to 29 bits by supporting the \e {CAN extended frame format}. + The \e {CAN extended frame format} setting is automatically set when a + \a newFrameId with more than 11 bits in size is given. + + When the format is extended and a \a newFrameId with up to 11 bits or less + is passed, the \e {CAN extended frame format} setting is \a not changed. \sa frameId(), hasExtendedFrameFormat() */ -- cgit v1.2.3