2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <systemd/sd-event.h>
22 #include "diagnostic-manager.hpp"
24 #include "../utils/openxc-utils.hpp"
25 #include "../utils/signals.hpp"
26 #include "../binding/application.hpp"
28 #define MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ 10
29 #define MAX_SIMULTANEOUS_DIAG_REQUESTS 50
30 // There are only 8 slots of in flight diagnostic requests
31 #define MAX_SIMULTANEOUS_IN_FLIGHT_REQUESTS 8
32 #define TIMERFD_ACCURACY 0
35 diagnostic_manager_t::diagnostic_manager_t()
40 diagnostic_manager_t::~diagnostic_manager_t()
42 for(auto r: recurring_requests_)
46 for(auto r: non_recurring_requests_)
52 /// @brief Diagnostic manager isn't initialized at launch but after
53 /// CAN bus devices initialization. For the moment, it is only possible
54 /// to have 1 diagnostic bus which are the first bus declared in the JSON
55 /// description file. Configuration instance will return it.
57 /// this will initialize DiagnosticShims and cancel all active requests
59 bool diagnostic_manager_t::initialize()
61 // Mandatory to set the bus before intialize shims.
62 bus_ = application_t::instance().get_diagnostic_bus();
64 init_diagnostic_shims();
68 AFB_DEBUG("Diagnostic Manager initialized");
72 /// @brief initialize shims used by UDS lib and set initialized_ to true.
73 /// It is needed before used the diagnostic manager fully because shims are
74 /// required by most member functions.
75 void diagnostic_manager_t::init_diagnostic_shims()
77 shims_ = diagnostic_init_shims(shims_logger, shims_send, NULL);
78 AFB_DEBUG("Shims initialized");
81 /// @brief Force cleanup all active requests.
82 void diagnostic_manager_t::reset()
84 AFB_DEBUG("Clearing existing diagnostic requests");
85 cleanup_active_requests(true);
88 /// @brief send function use by diagnostic library. It will open a BCM CAN socket TX_SETUP type.
89 /// That socket will send cyclic messages configured from a diagnostic request.
91 /// @param[in] arbitration_id - CAN arbitration ID to use when send message. OBD2 broadcast ID
92 /// is 0x7DF by example.
93 /// @param[in] data - The data payload for the message. NULL is valid if size is also 0.
94 /// @param[in] size - The size of the data payload, in bytes.
96 /// @return true if the CAN message was sent successfully.
97 bool diagnostic_manager_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
99 diagnostic_manager_t& dm = application_t::instance().get_diagnostic_manager();
100 active_diagnostic_request_t* current_adr = dm.get_last_recurring_requests();
101 utils::socketcan_bcm_t& tx_socket = current_adr->get_socket();
103 // Make sure that socket has been opened.
106 dm.get_bus_device_name());
108 struct utils::simple_bcm_msg bcm_msg;
109 struct can_frame cfd;
111 memset(&cfd, 0, sizeof(cfd));
112 memset(&bcm_msg.msg_head, 0, sizeof(bcm_msg.msg_head));
114 struct timeval freq = current_adr->get_frequency_clock().get_timeval_from_period();
116 bcm_msg.msg_head.opcode = TX_SETUP;
117 bcm_msg.msg_head.can_id = arbitration_id;
118 bcm_msg.msg_head.flags = SETTIMER|STARTTIMER|TX_CP_CAN_ID;
119 bcm_msg.msg_head.ival2.tv_sec = freq.tv_sec;
120 bcm_msg.msg_head.ival2.tv_usec = freq.tv_usec;
121 bcm_msg.msg_head.nframes = 1;
123 ::memcpy(cfd.data, data, size);
125 bcm_msg.frames = cfd;
127 tx_socket << bcm_msg;
133 /// @brief The type signature for an optional logging function, if the user
134 /// wishes to provide one. It should print, store or otherwise display the
137 /// message - A format string to log using the given parameters.
138 /// ... (vargs) - the parameters for the format string.
140 void diagnostic_manager_t::shims_logger(const char* format, ...)
143 va_start(args, format);
146 vsnprintf(buffer, 256, format, args);
148 AFB_DEBUG("%s", buffer);
152 const std::string diagnostic_manager_t::get_bus_name() const
157 const std::string diagnostic_manager_t::get_bus_device_name() const
159 return application_t::instance().get_can_bus_manager()
160 .get_can_device_name(bus_);
163 active_diagnostic_request_t* diagnostic_manager_t::get_last_recurring_requests() const
165 return recurring_requests_.back();
168 /// @brief Return diagnostic manager shims member.
169 DiagnosticShims& diagnostic_manager_t::get_shims()
174 /// @brief Search for a specific active diagnostic request in the provided requests list
175 /// and erase it from the vector. This is useful at unsubscription to clean up the list otherwize
176 /// all received CAN messages will be passed to DiagnosticRequestHandle of all active diagnostic request
177 /// contained in the vector but no event if connected to, so we will decode uneeded request.
179 /// @param[in] entry - a pointer of an active_diagnostic_request instance to clean up
180 /// @param[in] requests_list - a vector where to make the search and cleaning.
181 void diagnostic_manager_t::find_and_erase(active_diagnostic_request_t* entry, std::vector<active_diagnostic_request_t*>& requests_list)
183 auto i = std::find(requests_list.begin(), requests_list.end(), entry);
184 if ( i != requests_list.end())
185 requests_list.erase(i);
188 /// @brief Free memory allocated on active_diagnostic_request_t object and close the socket.
189 void diagnostic_manager_t::cancel_request(active_diagnostic_request_t* entry)
191 entry->get_socket().close();
196 /// @brief Cleanup a specific request if it isn't running and get complete. As it is almost
197 /// impossible to get that state for a recurring request without waiting for that, you can
198 /// force the cleaning operation.
200 /// @param[in] entry - the request to clean
201 /// @param[in] force - Force the cleaning or not ?
202 void diagnostic_manager_t::cleanup_request(active_diagnostic_request_t* entry, bool force)
204 if(entry != nullptr && (force || entry->response_received()))
206 char request_string[128] = {0};
207 diagnostic_request_to_string(&entry->get_handle()->request,
208 request_string, sizeof(request_string));
209 if(force && entry->get_recurring())
211 cancel_request(entry);
212 find_and_erase(entry, recurring_requests_);
213 AFB_DEBUG("Cancelling completed, recurring request: %s", request_string);
215 else if (!entry->get_recurring())
217 AFB_DEBUG("Cancelling completed, non-recurring request: %s", request_string);
218 cancel_request(entry);
219 find_and_erase(entry, non_recurring_requests_);
224 /// @brief Clean up all requests lists, recurring and not recurring.
226 /// @param[in] force - Force the cleaning or not ? If true, that will do
227 /// the same effect as a call to reset().
228 void diagnostic_manager_t::cleanup_active_requests(bool force)
230 for(auto& entry : non_recurring_requests_)
232 if (entry != nullptr)
233 cleanup_request(entry, force);
236 for(auto& entry : recurring_requests_)
238 if (entry != nullptr)
239 cleanup_request(entry, force);
243 /// @brief Will return the active_diagnostic_request_t pointer for theDiagnosticRequest or nullptr if
246 /// @param[in] request - Search key, method will go through recurring list to see if it find that request
247 /// holded by the DiagnosticHandle member.
248 active_diagnostic_request_t* diagnostic_manager_t::find_recurring_request(DiagnosticRequest& request)
250 for (auto& entry : recurring_requests_)
254 if(diagnostic_request_equals(&entry->get_handle()->request, &request))
261 /// @brief Add and send a new one-time diagnostic request. DON'T USED AT THIS TIME
263 /// A one-time (aka non-recurring) request can existing in parallel with a
264 /// recurring request for the same PID or mode, that's not a problem.
266 /// For an example, see the docs for addRecurringRequest. This function is very
267 /// similar but leaves out the frequencyHz parameter.
269 /// @param[in] request - The parameters for the request.
270 /// @param[in] name - Human readable name this response, to be used when
271 /// publishing received responses.
272 /// @param[in] wait_for_multiple_responses - If false, When any response is received
273 /// for this request it will be removed from the active list. If true, the
274 /// request will remain active until the timeout clock expires, to allow it
275 /// to receive multiple response. Functional broadcast requests will always
276 /// waint for the timeout, regardless of this parameter.
277 /// @param[in] decoder - An optional DiagnosticResponseDecoder to parse the payload of
278 /// responses to this request. If the decoder is NULL, the output will
279 /// include the raw payload instead of a parsed value.
280 /// @param[in] callback - An optional DiagnosticResponseCallback to be notified whenever a
281 /// response is received for this request.
283 /// @return true if the request was added successfully. Returns false if there
284 /// wasn't a free active request entry.
285 active_diagnostic_request_t* diagnostic_manager_t::add_request(DiagnosticRequest* request, const std::string& name,
286 bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
287 const DiagnosticResponseCallback callback)
289 cleanup_active_requests(false);
291 active_diagnostic_request_t* entry = nullptr;
293 if (non_recurring_requests_.size() <= MAX_SIMULTANEOUS_DIAG_REQUESTS)
295 active_diagnostic_request_t* entry = new active_diagnostic_request_t(bus_, request->arbitration_id, name,
296 wait_for_multiple_responses, decoder, callback, 0, false);
297 entry->set_handle(shims_, request);
299 char request_string[128] = {0};
300 diagnostic_request_to_string(&entry->get_handle()->request, request_string,
301 sizeof(request_string));
303 // Erase any existing request not already cleaned.
304 cleanup_request(entry, true);
305 AFB_DEBUG("Added one-time diagnostic request on bus %s: %s",
306 bus_.c_str(), request_string);
308 non_recurring_requests_.push_back(entry);
312 AFB_WARNING("There isn't enough request entry. Vector exhausted %d/%d", (int)non_recurring_requests_.size(), MAX_SIMULTANEOUS_DIAG_REQUESTS);
313 non_recurring_requests_.resize(MAX_SIMULTANEOUS_DIAG_REQUESTS);
318 /// @brief Validate frequency asked don't get higher than the maximum of a classical
319 /// CAN bus OBD2 request.
321 /// @param[in] frequencyHz - frequency asked for sending diagnostic requests.
323 /// @return True if frequency is below the Maximum false if not.
324 bool diagnostic_manager_t::validate_optional_request_attributes(float frequencyHz)
326 if(frequencyHz > MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ) {
327 AFB_DEBUG("Requested recurring diagnostic frequency %lf is higher than maximum of %d",
328 frequencyHz, MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ);
334 /// @brief Add and send a new recurring diagnostic request.
336 /// At most one recurring request can be active for the same arbitration ID, mode
337 /// and (if set) PID on the same bus at one time. If you try and call
338 /// add_recurring_request with the same key, it will return an error.
340 /// @param[in] request - The parameters for the request.
341 /// @param[in] name - An optional human readable name this response, to be used when
342 /// publishing received responses. If the name is NULL, the published output
343 /// will use the raw OBD-II response format.
344 /// @param[in] wait_for_multiple_responses - If false, When any response is received
345 /// for this request it will be removed from the active list. If true, the
346 /// request will remain active until the timeout clock expires, to allow it
347 /// to receive multiple response. Functional broadcast requests will always
348 /// waint for the timeout, regardless of this parameter.
349 /// @param[in] decoder - An optional DiagnosticResponseDecoder to parse the payload of
350 /// responses to this request. If the decoder is NULL, the output will
351 /// include the raw payload instead of a parsed value.
352 /// @param[in] callback - An optional DiagnosticResponseCallback to be notified whenever a
353 /// response is received for this request.
354 /// @param[in] frequencyHz - The frequency (in Hz) to send the request. A frequency above
355 /// MAX_RECURRING_DIAGNOSTIC_FREQUENCY_HZ is not allowed, and will make this
356 /// function return false.
358 /// @return true if the request was added successfully. Returns false if there
359 /// was too much already running requests, or if the frequency was too high.
360 active_diagnostic_request_t* diagnostic_manager_t::add_recurring_request(DiagnosticRequest* request, const char* name,
361 bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
362 const DiagnosticResponseCallback callback, float frequencyHz, bool permanent)
364 active_diagnostic_request_t* entry = nullptr;
366 if(!validate_optional_request_attributes(frequencyHz))
369 cleanup_active_requests(false);
371 if(find_recurring_request(*request) == nullptr)
373 if(recurring_requests_.size() <= MAX_SIMULTANEOUS_DIAG_REQUESTS)
375 entry = new active_diagnostic_request_t(bus_, request->arbitration_id, name,
376 wait_for_multiple_responses, decoder, callback, frequencyHz, permanent);
377 recurring_requests_.push_back(entry);
379 entry->set_handle(shims_, request);
380 start_diagnostic_request(&shims_, entry->get_handle());
384 AFB_WARNING("There isn't enough request entry. Vector exhausted %d/%d", (int)recurring_requests_.size(), MAX_SIMULTANEOUS_DIAG_REQUESTS);
385 recurring_requests_.resize(MAX_SIMULTANEOUS_DIAG_REQUESTS);
389 { AFB_DEBUG("Can't add request, one already exists with same key");}
393 /// @brief Will decode the diagnostic response and build the final openxc_VehicleMessage to return.
395 /// @param[in] adr - A pointer to an active diagnostic request holding a valid diagnostic handle
396 /// @param[in] response - The response to decode from which the Vehicle message will be built and returned
398 /// @return A filled openxc_VehicleMessage or a zeroed struct if there is an error.
399 openxc_VehicleMessage diagnostic_manager_t::relay_diagnostic_response(active_diagnostic_request_t* adr, const DiagnosticResponse& response, const uint64_t timestamp)
401 openxc_VehicleMessage message = build_VehicleMessage();
402 float value = (float)diagnostic_payload_to_integer(&response);
404 struct utils::signals_found found_signals;
405 found_signals = utils::signals_manager_t::instance().find_signals(build_DynamicField((double) adr->get_pid()));
407 if(adr->get_decoder() != nullptr)
409 value = adr->get_decoder()(&response, value);
412 if((response.success && adr->get_name().size()) > 0)
414 // If name, include 'value' instead of payload, and leave of response
416 message = build_VehicleMessage(build_SimpleMessage(adr->get_name(), build_DynamicField(value)));
417 message.has_diagnostic_response = true;
418 message.diagnostic_response = build_VehicleMessage(adr, response, value).diagnostic_response;
422 // If no name, only send full details of response but still include 'value'
423 // instead of 'payload' if they provided a decoder. The one case you
424 // can't get is the full detailed response with 'value'. We could add
425 // another parameter for that but it's onerous to carry that around.
426 message = build_VehicleMessage(adr, response, value);
429 // If not success but completed then the pid isn't supported
430 if(!response.success)
432 found_signals.diagnostic_messages.front()->set_supported(false);
433 cleanup_request(adr, true);
434 AFB_NOTICE("PID not supported or ill formed. Please unsubscribe from it. Error code : %d", response.negative_response_code);
435 message = build_VehicleMessage(build_SimpleMessage(adr->get_name(), build_DynamicField("This PID isn't supported by your vehicle.")));
438 if(adr->get_callback() != nullptr)
440 adr->get_callback()(adr, &response, value);
443 // Reset the completed flag handle to make sure that it will be reprocessed the next time.
444 adr->get_handle()->success = false;
446 // Save value and timestamp of diagnostic message
447 if(!found_signals.diagnostic_messages.empty())
449 // Then, for each diag_message found
450 for(const auto& diag_mess: found_signals.diagnostic_messages)
452 // Save value and timestamp for this message
453 diag_mess->set_received(true);
454 diag_mess->set_last_value(value);
455 diag_mess->set_timestamp(timestamp);
462 /// @brief Will take the CAN message and pass it to the receive functions that will process
463 /// diagnostic handle for each active diagnostic request then depending on the result we will
464 /// return pass the diagnostic response to decode it.
466 /// @param[in] entry - A pointer to an active diagnostic request holding a valid diagnostic handle
467 /// @param[in] cm - A raw CAN message.
469 /// @return A pointer to a filled openxc_VehicleMessage or a nullptr if nothing has been found.
470 openxc_VehicleMessage diagnostic_manager_t::relay_diagnostic_handle(active_diagnostic_request_t* entry, const can_message_t& cm)
472 DiagnosticResponse response = diagnostic_receive_can_frame(&shims_, entry->get_handle(), cm.get_id(), cm.get_data(), cm.get_length());
473 if(response.completed && entry->get_handle()->completed)
475 if(entry->get_handle()->success)
476 return relay_diagnostic_response(entry, response, cm.get_timestamp());
478 else if(!response.completed && response.multi_frame)
480 // Reset the timeout clock while completing the multi-frame receive
481 entry->get_timeout_clock().tick(
482 entry->get_timeout_clock().get_time_function()());
485 return build_VehicleMessage();
488 /// @brief Find the active diagnostic request with the correct DiagnosticRequestHandle
489 /// member that will understand the CAN message using diagnostic_receive_can_frame function
490 /// from UDS-C library. Then decode it with an ad-hoc method.
492 /// @param[in] cm - Raw CAN message received
494 /// @return VehicleMessage with decoded value.
495 openxc_VehicleMessage diagnostic_manager_t::find_and_decode_adr(const can_message_t& cm)
497 openxc_VehicleMessage vehicle_message = build_VehicleMessage();
499 for ( auto entry : non_recurring_requests_)
501 vehicle_message = relay_diagnostic_handle(entry, cm);
502 if (is_valid(vehicle_message))
503 return vehicle_message;
506 for ( auto entry : recurring_requests_)
508 vehicle_message = relay_diagnostic_handle(entry, cm);
509 if (is_valid(vehicle_message))
510 return vehicle_message;
513 return vehicle_message;
516 /// @brief Tell if the CAN message received is a diagnostic response.
517 /// Request broadcast ID use 0x7DF and assigned ID goes from 0x7E0 to Ox7E7. That allows up to 8 ECU to respond
518 /// at the same time. The response is the assigned ID + 0x8, so response ID can goes from 0x7E8 to 0x7EF.
520 /// @param[in] cm - CAN message received from the socket.
522 /// @return True if the active diagnostic request match the response.
523 bool diagnostic_manager_t::is_diagnostic_response(const can_message_t& cm)
525 if (cm.get_id() >= 0x7e8 && cm.get_id() <= 0x7ef)