src/diagnostic/diagnostic-manager.hpp

   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 #pragma once
  19
  20 #include <systemd/sd-event.h>
  21 #include <vector>
  22
  23 #include "uds/uds.h"
  24 #include "openxc.pb.h"
  25 #include "../can/can-bus-dev.hpp"
  26 #include "../can/can-message.hpp"
  27 #include "active-diagnostic-request.hpp"
  28
  29 #include "../low-can-binding.hpp"
  30
  31 /* Private: Each CAN bus needs its own set of shim functions, so this should
  32  * match the maximum CAN controller count.
  33  */
  34 #define MAX_SHIM_COUNT can_bus_t.get_can_devices().size()
  35 #define DIAGNOSTIC_RESPONSE_ARBITRATION_ID_OFFSET 0x8
  36
  37 class active_diagnostic_request_t;
  38
  39 /**
  40  * @brief The core structure for running the diagnostics module on the VI.
  41  *
  42  * @desc This stores details about the active requests and shims required to connect
  43  * the diagnostics library to the VI's CAN peripheral.
  44  */
  45 class diagnostic_manager_t {
  46 protected:
  47         static bool shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size);
  48         static void shims_logger(const char* m, ...);
  49         static void shims_timer();
  50
  51 private:
  52         DiagnosticShims shims_; /*!< shims_ - An array of shim functions for each CAN bus that plug the diagnostics
  53                                                          * library (uds-c) into the VI's CAN peripheral.*/
  54         std::shared_ptr<can_bus_dev_t> bus_; /*!< bus_ - A pointer to the CAN bus that should be used for all standard OBD-II requests, if the bus is not
  55                                                   * explicitly spcified in the request. If NULL, all requests require an explicit bus.*/
  56         std::vector<active_diagnostic_request_t*> recurring_requests_; /*!< recurringRequests - A list of active recurring diagnostic requests.*/
  57         std::vector<active_diagnostic_request_t*> non_recurring_requests_; /*!< nonrecurringRequests - A list of active one-time diagnostic requests. When a
  58                                                                                                                                            * response is received for a non-recurring request or it times out, it is removed*/
  59         bool initialized_; /*!< * initialized - True if the DiagnosticsManager has been initialized with shims. It will interface with the uds-c lib*/
  60
  61         void init_diagnostic_shims();
  62         void reset();
  63 public:
  64         diagnostic_manager_t();
  65
  66         bool initialize(std::shared_ptr<can_bus_dev_t> cbd);
  67
  68         std::shared_ptr<can_bus_dev_t> get_can_bus_dev();
  69         DiagnosticShims& get_shims();
  70
  71         void find_and_erase(active_diagnostic_request_t* entry, std::vector<active_diagnostic_request_t*>& requests_list);
  72         void cancel_request(active_diagnostic_request_t* entry);
  73         void cleanup_request(active_diagnostic_request_t* entry, bool force);
  74         void cleanup_active_requests(bool force);
  75         active_diagnostic_request_t* find_recurring_request(const DiagnosticRequest* request);
  76
  77         bool validate_optional_request_attributes(float frequencyHz);
  78
  79         void checkSupportedPids(const active_diagnostic_request_t& request,
  80                 const DiagnosticResponse& response, float parsedPayload);
  81
  82         bool add_request(DiagnosticRequest* request, const std::string name,
  83                 bool waitForMultipleResponses, const DiagnosticResponseDecoder decoder,
  84                 const DiagnosticResponseCallback callback);
  85
  86         bool add_recurring_request(DiagnosticRequest* request, const char* name,
  87                 bool waitForMultipleResponses, const DiagnosticResponseDecoder decoder,
  88                 const DiagnosticResponseCallback callback, float frequencyHz);
  89
  90         bool is_diagnostic_response(const active_diagnostic_request_t& adr, const can_message_t& cm) const;
  91         active_diagnostic_request_t* is_diagnostic_response(const can_message_t& can_message);
  92
  93         openxc_VehicleMessage relay_diagnostic_response(active_diagnostic_request_t* adr, const DiagnosticResponse& response) const;
  94
  95         bool conflicting(active_diagnostic_request_t* request, active_diagnostic_request_t* candidate) const;
  96         bool clear_to_send(active_diagnostic_request_t* request) const;
  97         static int send_request(sd_event_source *s, uint64_t usec, void *userdata);
  98 };