247 lines
25 KiB
HTML
247 lines
25 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>LCOV - coverage.info - core/dbc_decoder.h</title>
|
|
<link rel="stylesheet" type="text/css" href="../gcov.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<table width="100%" border=0 cellspacing=0 cellpadding=0>
|
|
<tr><td class="title">LCOV - code coverage report</td></tr>
|
|
<tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr>
|
|
|
|
<tr>
|
|
<td width="100%">
|
|
<table cellpadding=1 border=0 width="100%">
|
|
<tr>
|
|
<td width="10%" class="headerItem">Current view:</td>
|
|
<td width="10%" class="headerValue"><a href="../index.html" title="Click to go to top-level">top level</a> - <a href="index.html" title="Click to go to directory core">core</a> - dbc_decoder.h<span style="font-size: 80%;"> (source / <a href="dbc_decoder.h.func-c.html" title="Click to go to function table">functions</a>)</span></td>
|
|
<td width="5%"></td>
|
|
<td width="5%"></td>
|
|
<td width="5%" class="headerCovTableHead">Coverage</td>
|
|
<td width="5%" class="headerCovTableHead" title="Covered + Uncovered code">Total</td>
|
|
<td width="5%" class="headerCovTableHead" title="Exercised code only">Hit</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="headerItem">Test:</td>
|
|
<td class="headerValue">coverage.info</td>
|
|
<td></td>
|
|
<td class="headerItem">Lines:</td>
|
|
<td class="headerCovTableEntryHi">100.0 %</td>
|
|
<td class="headerCovTableEntry">5</td>
|
|
<td class="headerCovTableEntry">5</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="headerItem">Test Date:</td>
|
|
<td class="headerValue">2026-10-20 13:34:58</td>
|
|
<td></td>
|
|
<td class="headerItem">Functions:</td>
|
|
<td class="headerCovTableEntryHi">100.0 %</td>
|
|
<td class="headerCovTableEntry">4</td>
|
|
<td class="headerCovTableEntry">4</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="headerItem">Branches:</td>
|
|
<td class="headerCovTableEntryMed">75.0 %</td>
|
|
<td class="headerCovTableEntry">4</td>
|
|
<td class="headerCovTableEntry">3</td>
|
|
</tr>
|
|
<tr><td><img src="../glass.png" width=3 height=3 alt=""></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr>
|
|
</table>
|
|
|
|
<table cellpadding=0 cellspacing=0 border=0>
|
|
<tr>
|
|
<td><br></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<pre class="sourceHeading"> Branch data Line data Source code</pre>
|
|
<pre class="source">
|
|
<span id="L1"><span class="lineNum"> 1</span> : : /**</span>
|
|
<span id="L2"><span class="lineNum"> 2</span> : : * @file dbc_decoder.h</span>
|
|
<span id="L3"><span class="lineNum"> 3</span> : : * @brief CAN frame decoding API and result types.</span>
|
|
<span id="L4"><span class="lineNum"> 4</span> : : *</span>
|
|
<span id="L5"><span class="lineNum"> 5</span> : : * Created: 2026-03-13</span>
|
|
<span id="L6"><span class="lineNum"> 6</span> : : * Author: Deeaitch (Dim. Himro)</span>
|
|
<span id="L7"><span class="lineNum"> 7</span> : : *</span>
|
|
<span id="L8"><span class="lineNum"> 8</span> : : * Licensed under the MIT License.</span>
|
|
<span id="L9"><span class="lineNum"> 9</span> : : * See LICENSE file in the project root for full license text.</span>
|
|
<span id="L10"><span class="lineNum"> 10</span> : : */</span>
|
|
<span id="L11"><span class="lineNum"> 11</span> : : </span>
|
|
<span id="L12"><span class="lineNum"> 12</span> : : #ifndef DBC_DECODER_H</span>
|
|
<span id="L13"><span class="lineNum"> 13</span> : : #define DBC_DECODER_H</span>
|
|
<span id="L14"><span class="lineNum"> 14</span> : : </span>
|
|
<span id="L15"><span class="lineNum"> 15</span> : : #include <cstdint></span>
|
|
<span id="L16"><span class="lineNum"> 16</span> : : #include <variant></span>
|
|
<span id="L17"><span class="lineNum"> 17</span> : : #include <vector></span>
|
|
<span id="L18"><span class="lineNum"> 18</span> : : </span>
|
|
<span id="L19"><span class="lineNum"> 19</span> : : #include "decode_database.h"</span>
|
|
<span id="L20"><span class="lineNum"> 20</span> : : </span>
|
|
<span id="L21"><span class="lineNum"> 21</span> : : /**</span>
|
|
<span id="L22"><span class="lineNum"> 22</span> : : * @brief Raw CAN frame used for runtime or trace decoding.</span>
|
|
<span id="L23"><span class="lineNum"> 23</span> : : */</span>
|
|
<span id="L24"><span class="lineNum"> 24</span> : : struct RawCanFrame {</span>
|
|
<span id="L25"><span class="lineNum"> 25</span> : : std::uint32_t canId = 0U; /**< Normalized CAN ID. */</span>
|
|
<span id="L26"><span class="lineNum"> 26</span> : : bool isExtended = false; /**< true for extended frame. */</span>
|
|
<span id="L27"><span class="lineNum"> 27</span> : : std::vector<std::uint8_t> data; /**< Payload bytes. */</span>
|
|
<span id="L28"><span class="lineNum"> 28</span> : : </span>
|
|
<span id="L29"><span class="lineNum"> 29</span> :<span class="tlaGNC"> 2220 : RawCanFrame() = default;</span></span>
|
|
<span id="L30"><span class="lineNum"> 30</span> : : };</span>
|
|
<span id="L31"><span class="lineNum"> 31</span> : : </span>
|
|
<span id="L32"><span class="lineNum"> 32</span> : : /** @brief Outcome of signal extraction and physical conversion. */</span>
|
|
<span id="L33"><span class="lineNum"> 33</span> : : enum class SignalDecodeStatus {</span>
|
|
<span id="L34"><span class="lineNum"> 34</span> : : InvalidDefinition,</span>
|
|
<span id="L35"><span class="lineNum"> 35</span> : : InsufficientPayload,</span>
|
|
<span id="L36"><span class="lineNum"> 36</span> : : SelectorUnavailable,</span>
|
|
<span id="L37"><span class="lineNum"> 37</span> : : Inactive,</span>
|
|
<span id="L38"><span class="lineNum"> 38</span> : : Valid,</span>
|
|
<span id="L39"><span class="lineNum"> 39</span> : : PhysicalConversionFailed</span>
|
|
<span id="L40"><span class="lineNum"> 40</span> : : };</span>
|
|
<span id="L41"><span class="lineNum"> 41</span> : : </span>
|
|
<span id="L42"><span class="lineNum"> 42</span> : : /** Frame summary: short payload takes precedence over individual signal errors. */</span>
|
|
<span id="L43"><span class="lineNum"> 43</span> : : enum class FrameDecodeStatus {</span>
|
|
<span id="L44"><span class="lineNum"> 44</span> : : UnknownFrame,</span>
|
|
<span id="L45"><span class="lineNum"> 45</span> : : InsufficientPayload,</span>
|
|
<span id="L46"><span class="lineNum"> 46</span> : : SignalErrors,</span>
|
|
<span id="L47"><span class="lineNum"> 47</span> : : Valid,</span>
|
|
<span id="L48"><span class="lineNum"> 48</span> : : AmbiguousFrame</span>
|
|
<span id="L49"><span class="lineNum"> 49</span> : : };</span>
|
|
<span id="L50"><span class="lineNum"> 50</span> : : </span>
|
|
<span id="L51"><span class="lineNum"> 51</span> : : /**</span>
|
|
<span id="L52"><span class="lineNum"> 52</span> : : * @brief One decoded signal value.</span>
|
|
<span id="L53"><span class="lineNum"> 53</span> : : */</span>
|
|
<span id="L54"><span class="lineNum"> 54</span> : : struct DecodedSignalValue {</span>
|
|
<span id="L55"><span class="lineNum"> 55</span> : : std::shared_ptr<const DecodeSignal> definition; /**< Owning immutable definition. */</span>
|
|
<span id="L56"><span class="lineNum"> 56</span> : : SignalKey key; /**< Stable application identifier. */</span>
|
|
<span id="L57"><span class="lineNum"> 57</span> : : RawSignalValue rawValue = std::uint64_t(0U); /**< Exact raw value for Valid or PhysicalConversionFailed. */</span>
|
|
<span id="L58"><span class="lineNum"> 58</span> : : double physicalValue = 0.0; /**< Conversion result, possibly NaN/Inf on failure. */</span>
|
|
<span id="L59"><span class="lineNum"> 59</span> : : bool valid = false; /**< true if decoding succeeded. */</span>
|
|
<span id="L60"><span class="lineNum"> 60</span> : : SignalDecodeStatus status = SignalDecodeStatus::InvalidDefinition; /**< Detailed signal outcome. */</span>
|
|
<span id="L61"><span class="lineNum"> 61</span> : : </span>
|
|
<span id="L62"><span class="lineNum"> 62</span> : : /** Lookup using the raw integer; nullptr for invalid or unmapped values. */</span>
|
|
<span id="L63"><span class="lineNum"> 63</span> :<span class="tlaGNC"> 79 : const std::string *GetValueDescription() const {</span></span>
|
|
<span id="L64"><span class="lineNum"> 64</span> [<span class="tlaGBC" title="Branch 0 was taken 64 times"> + </span><span class="tlaGBC" title="Branch 1 was taken 15 times"> + </span><span class="tlaGBC" title="Branch 2 was taken 64 times"> + </span><span class="tlaUNC" title="Branch 3 was not taken"> - </span>]:<span class="tlaGNC"> 79 : return valid && definition ? FindValueDescription(definition->valueDescriptions, rawValue) : nullptr;</span></span>
|
|
<span id="L65"><span class="lineNum"> 65</span> : : }</span>
|
|
<span id="L66"><span class="lineNum"> 66</span> : : </span>
|
|
<span id="L67"><span class="lineNum"> 67</span> :<span class="tlaGNC"> 6380 : DecodedSignalValue() = default;</span></span>
|
|
<span id="L68"><span class="lineNum"> 68</span> : : };</span>
|
|
<span id="L69"><span class="lineNum"> 69</span> : : </span>
|
|
<span id="L70"><span class="lineNum"> 70</span> : : /**</span>
|
|
<span id="L71"><span class="lineNum"> 71</span> : : * @brief Fully decoded frame.</span>
|
|
<span id="L72"><span class="lineNum"> 72</span> : : */</span>
|
|
<span id="L73"><span class="lineNum"> 73</span> : : struct DecodedFrameValue {</span>
|
|
<span id="L74"><span class="lineNum"> 74</span> : : std::shared_ptr<const DecodeFrame> definition; /**< Owning immutable definition. */</span>
|
|
<span id="L75"><span class="lineNum"> 75</span> : : FrameKey key; /**< Matched definition key; received key if unmatched. */</span>
|
|
<span id="L76"><span class="lineNum"> 76</span> : : std::vector<DecodedSignalValue> signals; /**< Decoded signal values. */</span>
|
|
<span id="L77"><span class="lineNum"> 77</span> : : bool valid = false; /**< true if frame was matched. */</span>
|
|
<span id="L78"><span class="lineNum"> 78</span> : : FrameDecodeStatus status = FrameDecodeStatus::UnknownFrame; /**< Inspect signals for individual failures. */</span>
|
|
<span id="L79"><span class="lineNum"> 79</span> : : </span>
|
|
<span id="L80"><span class="lineNum"> 80</span> :<span class="tlaGNC"> 6409 : DecodedFrameValue() = default;</span></span>
|
|
<span id="L81"><span class="lineNum"> 81</span> : : };</span>
|
|
<span id="L82"><span class="lineNum"> 82</span> : : </span>
|
|
<span id="L83"><span class="lineNum"> 83</span> : : /**</span>
|
|
<span id="L84"><span class="lineNum"> 84</span> : : * @brief Runtime CAN decoder using prebuilt decode database.</span>
|
|
<span id="L85"><span class="lineNum"> 85</span> : : */</span>
|
|
<span id="L86"><span class="lineNum"> 86</span> : : class DbcDecoder {</span>
|
|
<span id="L87"><span class="lineNum"> 87</span> : : public:</span>
|
|
<span id="L88"><span class="lineNum"> 88</span> : : /**</span>
|
|
<span id="L89"><span class="lineNum"> 89</span> : : * @brief Find exact CAN ID first, then unique PGN among explicitly J1939 definitions.</span>
|
|
<span id="L90"><span class="lineNum"> 90</span> : : * @param database Runtime decode database.</span>
|
|
<span id="L91"><span class="lineNum"> 91</span> : : * @param canId Normalized CAN ID.</span>
|
|
<span id="L92"><span class="lineNum"> 92</span> : : * @param isExtended true for extended frame.</span>
|
|
<span id="L93"><span class="lineNum"> 93</span> : : * @return Owning immutable handle, or nullptr for missing/ambiguous matches. Safe across reload.</span>
|
|
<span id="L94"><span class="lineNum"> 94</span> : : */</span>
|
|
<span id="L95"><span class="lineNum"> 95</span> : : std::shared_ptr<const DecodeFrame> FindFrame(const DecodeDatabase &database,</span>
|
|
<span id="L96"><span class="lineNum"> 96</span> : : std::uint32_t canId,</span>
|
|
<span id="L97"><span class="lineNum"> 97</span> : : bool isExtended) const;</span>
|
|
<span id="L98"><span class="lineNum"> 98</span> : : </span>
|
|
<span id="L99"><span class="lineNum"> 99</span> : : /**</span>
|
|
<span id="L100"><span class="lineNum"> 100</span> : : * @brief Decode one raw CAN frame.</span>
|
|
<span id="L101"><span class="lineNum"> 101</span> : : * @param database Runtime decode database.</span>
|
|
<span id="L102"><span class="lineNum"> 102</span> : : * @param frame Raw CAN frame.</span>
|
|
<span id="L103"><span class="lineNum"> 103</span> : : * Short payloads decode available signals; bytes beyond declared DLC are ignored.</span>
|
|
<span id="L104"><span class="lineNum"> 104</span> : : * @return Decoded frame value.</span>
|
|
<span id="L105"><span class="lineNum"> 105</span> : : */</span>
|
|
<span id="L106"><span class="lineNum"> 106</span> : : DecodedFrameValue Decode(const DecodeDatabase &database,</span>
|
|
<span id="L107"><span class="lineNum"> 107</span> : : const RawCanFrame &frame) const;</span>
|
|
<span id="L108"><span class="lineNum"> 108</span> : : </span>
|
|
<span id="L109"><span class="lineNum"> 109</span> : : /**</span>
|
|
<span id="L110"><span class="lineNum"> 110</span> : : * @brief Decode selected signals in selection order using stable keys.</span>
|
|
<span id="L111"><span class="lineNum"> 111</span> : : * An empty selection returns no signals. Multiplex selectors are read internally.</span>
|
|
<span id="L112"><span class="lineNum"> 112</span> : : * Frame status summarizes selected signals; short payload still takes precedence.</span>
|
|
<span id="L113"><span class="lineNum"> 113</span> : : * Unknown/ambiguous frames return before checking the selection.</span>
|
|
<span id="L114"><span class="lineNum"> 114</span> : : * For PGN matches, selection keys must belong to the matched DBC definition.</span>
|
|
<span id="L115"><span class="lineNum"> 115</span> : : * @throws std::invalid_argument for a foreign frame key, unknown signal, or duplicate key.</span>
|
|
<span id="L116"><span class="lineNum"> 116</span> : : */</span>
|
|
<span id="L117"><span class="lineNum"> 117</span> : : DecodedFrameValue Decode(const DecodeDatabase &database,</span>
|
|
<span id="L118"><span class="lineNum"> 118</span> : : const RawCanFrame &frame,</span>
|
|
<span id="L119"><span class="lineNum"> 119</span> : : const std::vector<SignalKey> &selection) const;</span>
|
|
<span id="L120"><span class="lineNum"> 120</span> : : </span>
|
|
<span id="L121"><span class="lineNum"> 121</span> : : private:</span>
|
|
<span id="L122"><span class="lineNum"> 122</span> : : static PgnLookupResult ResolveFrame(const DecodeDatabase &database,</span>
|
|
<span id="L123"><span class="lineNum"> 123</span> : : std::uint32_t canId, bool isExtended);</span>
|
|
<span id="L124"><span class="lineNum"> 124</span> : : </span>
|
|
<span id="L125"><span class="lineNum"> 125</span> : : DecodedFrameValue DecodeImpl(const DecodeDatabase &database,</span>
|
|
<span id="L126"><span class="lineNum"> 126</span> : : const RawCanFrame &frame,</span>
|
|
<span id="L127"><span class="lineNum"> 127</span> : : const std::vector<SignalKey> *selection) const;</span>
|
|
<span id="L128"><span class="lineNum"> 128</span> : : </span>
|
|
<span id="L129"><span class="lineNum"> 129</span> : : static bool IsValidDefinition(const DecodeSignal &signal, std::uint8_t dlc);</span>
|
|
<span id="L130"><span class="lineNum"> 130</span> : : </span>
|
|
<span id="L131"><span class="lineNum"> 131</span> : : struct SelectorState {</span>
|
|
<span id="L132"><span class="lineNum"> 132</span> : : const DecodeSignal *definition = nullptr;</span>
|
|
<span id="L133"><span class="lineNum"> 133</span> : : bool valid = false;</span>
|
|
<span id="L134"><span class="lineNum"> 134</span> : : bool available = false;</span>
|
|
<span id="L135"><span class="lineNum"> 135</span> : : std::uint64_t value = 0U;</span>
|
|
<span id="L136"><span class="lineNum"> 136</span> : : };</span>
|
|
<span id="L137"><span class="lineNum"> 137</span> : : </span>
|
|
<span id="L138"><span class="lineNum"> 138</span> : : static SelectorState ReadSelector(const DecodeFrame &definition, const RawCanFrame &frame);</span>
|
|
<span id="L139"><span class="lineNum"> 139</span> : : static DecodedSignalValue DecodeOneSignal(const DecodeSignal &signal,</span>
|
|
<span id="L140"><span class="lineNum"> 140</span> : : std::uint8_t dlc,</span>
|
|
<span id="L141"><span class="lineNum"> 141</span> : : const RawCanFrame &frame,</span>
|
|
<span id="L142"><span class="lineNum"> 142</span> : : const SelectorState &selector);</span>
|
|
<span id="L143"><span class="lineNum"> 143</span> : : </span>
|
|
<span id="L144"><span class="lineNum"> 144</span> : : static bool ExtractUnsigned(const std::vector<std::uint8_t> &data,</span>
|
|
<span id="L145"><span class="lineNum"> 145</span> : : const DecodeSignal &signal,</span>
|
|
<span id="L146"><span class="lineNum"> 146</span> : : std::uint64_t &value);</span>
|
|
<span id="L147"><span class="lineNum"> 147</span> : : </span>
|
|
<span id="L148"><span class="lineNum"> 148</span> : : static bool ExtractIntel(const std::vector<std::uint8_t> &data,</span>
|
|
<span id="L149"><span class="lineNum"> 149</span> : : std::uint32_t startBit,</span>
|
|
<span id="L150"><span class="lineNum"> 150</span> : : std::uint32_t length,</span>
|
|
<span id="L151"><span class="lineNum"> 151</span> : : std::uint64_t &value);</span>
|
|
<span id="L152"><span class="lineNum"> 152</span> : : </span>
|
|
<span id="L153"><span class="lineNum"> 153</span> : : static bool ExtractMotorola(const std::vector<std::uint8_t> &data,</span>
|
|
<span id="L154"><span class="lineNum"> 154</span> : : std::uint32_t startBit,</span>
|
|
<span id="L155"><span class="lineNum"> 155</span> : : std::uint32_t length,</span>
|
|
<span id="L156"><span class="lineNum"> 156</span> : : std::uint64_t &value);</span>
|
|
<span id="L157"><span class="lineNum"> 157</span> : : </span>
|
|
<span id="L158"><span class="lineNum"> 158</span> : : static std::int64_t SignExtend(std::uint64_t value, std::uint32_t bitLength);</span>
|
|
<span id="L159"><span class="lineNum"> 159</span> : : };</span>
|
|
<span id="L160"><span class="lineNum"> 160</span> : : </span>
|
|
<span id="L161"><span class="lineNum"> 161</span> : : #endif /* DBC_DECODER_H */</span>
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
|
|
<table width="100%" border=0 cellspacing=0 cellpadding=0>
|
|
<tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr>
|
|
<tr><td class="versionInfo">Generated by: <a href="https://github.com//linux-test-project/lcov" target="_parent">LCOV version 2.0-1</a></td></tr>
|
|
</table>
|
|
<br>
|
|
|
|
</body>
|
|
</html>
|