low-can-binding/diagnostic/active-diagnostic-request.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <map>
  19 #include <fnmatch.h>
  20
  21 #include "active-diagnostic-request.hpp"
  22
  23 #include "../configuration.hpp"
  24
  25 #define ERROR_PID 0xFF
  26
  27 std::string active_diagnostic_request_t::prefix_ = "diagnostic_messages";
  28
  29 bool active_diagnostic_request_t::operator==(const active_diagnostic_request_t& b)
  30 {
  31         return (bus_ == b.bus_ && id_ == b.id_ && handle_ == b.handle_);
  32 }
  33
  34 active_diagnostic_request_t& active_diagnostic_request_t::operator=(const active_diagnostic_request_t& adr)
  35 {
  36         if (this != &adr)
  37         {
  38                 bus_ = adr.bus_;
  39                 id_ = adr.id_;
  40                 handle_ = adr.handle_;
  41                 name_ = adr.name_;
  42                 decoder_ = adr.decoder_;
  43                 callback_ = adr.callback_;
  44                 recurring_ = adr.recurring_;
  45                 wait_for_multiple_responses_ = adr.wait_for_multiple_responses_;
  46                 in_flight_ = adr.in_flight_;
  47                 frequency_clock_ = adr.frequency_clock_;
  48                 timeout_clock_ = adr.timeout_clock_;
  49         }
  50
  51         return *this;
  52 }
  53
  54 active_diagnostic_request_t::active_diagnostic_request_t()
  55         : bus_{nullptr}, id_{0}, handle_{nullptr}, name_{""},
  56           decoder_{nullptr}, callback_{nullptr}, recurring_{false}, wait_for_multiple_responses_{false},
  57           in_flight_{false}, frequency_clock_{frequency_clock_t()}, timeout_clock_{frequency_clock_t()}
  58 {}
  59
  60 active_diagnostic_request_t::active_diagnostic_request_t(const std::string& bus, DiagnosticRequest* request,
  61                 const std::string& name, bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
  62                 const DiagnosticResponseCallback callback, float frequencyHz)
  63         : bus_{bus}, id_{request->arbitration_id}, handle_{nullptr}, name_{name},
  64           decoder_{decoder}, callback_{callback}, recurring_{frequencyHz ? true : false}, wait_for_multiple_responses_{wait_for_multiple_responses},
  65           in_flight_{false}, frequency_clock_{frequency_clock_t(frequencyHz)}, timeout_clock_{frequency_clock_t(10)}
  66 {}
  67
  68 uint32_t active_diagnostic_request_t::get_id() const
  69 {
  70         return id_;
  71 }
  72
  73 const std::shared_ptr<can_bus_dev_t> active_diagnostic_request_t::get_can_bus_dev() const
  74 {
  75         return can_bus_t::get_can_device(bus_);
  76 }
  77
  78 uint16_t active_diagnostic_request_t::get_pid() const
  79 {
  80         if (handle_->request.has_pid)
  81                 return handle_->request.pid;
  82         return ERROR_PID;
  83 }
  84
  85 DiagnosticRequestHandle* active_diagnostic_request_t::get_handle()
  86 {
  87         return handle_;
  88 }
  89
  90 const std::string active_diagnostic_request_t::get_name() const
  91 {
  92         return name_;
  93 }
  94
  95 std::string& active_diagnostic_request_t::get_prefix()
  96 {
  97         return active_diagnostic_request_t::prefix_;
  98 }
  99
 100 DiagnosticResponseDecoder& active_diagnostic_request_t::get_decoder()
 101 {
 102         return decoder_;
 103 }
 104
 105 DiagnosticResponseCallback& active_diagnostic_request_t::get_callback()
 106 {
 107         return callback_;
 108 }
 109
 110 bool active_diagnostic_request_t::get_recurring() const
 111 {
 112         return recurring_;
 113 }
 114
 115 bool active_diagnostic_request_t::get_in_flight() const
 116 {
 117         return in_flight_;
 118 }
 119
 120 frequency_clock_t& active_diagnostic_request_t::get_frequency_clock()
 121 {
 122         return frequency_clock_;
 123 }
 124
 125 frequency_clock_t& active_diagnostic_request_t::get_timeout_clock()
 126 {
 127         return timeout_clock_;
 128 }
 129
 130 void active_diagnostic_request_t::set_handle(DiagnosticShims& shims, DiagnosticRequest* request)
 131 {
 132         handle_ = new DiagnosticRequestHandle(generate_diagnostic_request(&shims, request, nullptr));
 133 }
 134
 135 void active_diagnostic_request_t::set_in_flight(bool val)
 136 {
 137         in_flight_ = val;
 138 }
 139
 140 ///
 141 /// @brief Check if requested signal name is a diagnostic message. If the name
 142 ///  begin with the diagnostic message prefix then true else false.
 143 ///
 144 /// @param[in] name - A signal name.
 145 ///
 146 /// @return true if name began with the diagnostic message prefix else false.
 147 ///
 148 bool active_diagnostic_request_t::is_diagnostic_signal(const std::string& name)
 149 {
 150         const std::string p = active_diagnostic_request_t::prefix_ + "*";
 151         if(::fnmatch(p.c_str(), name.c_str(), FNM_CASEFOLD) == 0)
 152                 return true;
 153         return false;
 154 }
 155
 156 /// @brief Check is the request should be sent or not
 157 ///
 158 /// @return true if the request is not running or recurring nor completed,
 159 /// or it's recurring, its clock elapsed
 160 /// so it's time to send another one.
 161 bool active_diagnostic_request_t::should_send()
 162 {
 163         return !in_flight_ && ( (!recurring_ && !request_completed()) ||
 164                         (recurring_ && frequency_clock_.elapsed(true)) );
 165 }
 166
 167 /// @brief check if the timeout clock has elapsed
 168 ///
 169 /// @return true if elapsed, so it is a timeout, else false.
 170 bool active_diagnostic_request_t::timed_out()
 171 {
 172         // don't use staggered start with the timeout clock
 173         return timeout_clock_.elapsed(false);
 174 }
 175
 176 /// @brief Returns true if a sufficient response has been received for a
 177 /// diagnostic request.
 178 ///
 179 /// This is true when at least one response has been received and the request is
 180 /// configured to not wait for multiple responses. Functional broadcast requests
 181 /// may often wish to wait the full 100ms for modules to respond.
 182 bool active_diagnostic_request_t::response_received() const
 183 {
 184         return !wait_for_multiple_responses_ &&
 185                                 handle_->completed;
 186 }
 187
 188 /// @brief Returns true if the request has timed out waiting for a response,
 189 /// or a sufficient number of responses has been received.
 190 bool active_diagnostic_request_t::request_completed()
 191 {
 192         return response_received() ||
 193                 (timed_out() && diagnostic_request_sent(handle_));
 194 }