src/can/can-bus.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 <mutex>
  21 #include <queue>
  22 #include <thread>
  23 #include <linux/can.h>
  24 #include <condition_variable>
  25
  26 #include "openxc.pb.h"
  27 #include "utils/timer.hpp"
  28 #include "can/can-signals.hpp"
  29 #include "can/can-message.hpp"
  30
  31 #include "low-can-binding.hpp"
  32
  33 // TODO actual max is 32 but dropped to 24 for memory considerations
  34 #define MAX_ACCEPTANCE_FILTERS 24
  35 // TODO this takes up a ton of memory
  36 #define MAX_DYNAMIC_MESSAGE_COUNT 12
  37
  38 #define CAN_ACTIVE_TIMEOUT_S 30
  39
  40 class can_bus_dev_t;
  41
  42 /**
  43  * @class can_bus_t
  44  * @brief Object used to handle decoding and manage event queue to be pushed.
  45  *
  46  * This object is also used to initialize can_bus_dev_t object after reading
  47  * json conf file describing the CAN devices to use. Thus, those object will read
  48  * on the device the CAN frame and push them into the can_bus_t can_message_q_ queue.
  49  *
  50  * That queue will be later used to be decoded and pushed to subscribers.
  51  */
  52 class can_bus_t {
  53         private:
  54                 int conf_file_; /*!< conf_file_ - configuration file handle used to initialize can_bus_dev_t objects.*/
  55
  56                 void can_decode_message();
  57                 std::thread th_decoding_; /*!< thread that'll handle decoding a can frame */
  58                 bool is_decoding_; /*!< boolean member controling thread while loop*/
  59
  60                 void can_event_push();
  61                 std::thread th_pushing_; /*!<  thread that'll handle pushing decoded can frame to subscribers */
  62                 bool is_pushing_; /*!< boolean member controling thread while loop*/
  63
  64                 std::condition_variable new_can_message_cv_; /*!< condition_variable use to wait until there is a new CAN message to read*/
  65                 std::mutex can_message_mutex_; /*!< mutex protecting the can_message_q_ queue.*/
  66                 std::queue <can_message_t> can_message_q_; /*!< queue that'll store can_message_t to decoded */
  67
  68                 std::condition_variable new_decoded_can_message_; /*!< condition_variable use to wait until there is a new vehicle message to read from the queue vehicle_message_q_*/
  69                 std::mutex decoded_can_message_mutex_;  /*!< mutex protecting the vehicle_message_q_ queue.*/
  70                 std::queue <openxc_VehicleMessage> vehicle_message_q_; /*!< queue that'll store openxc_VehicleMessage to pushed */
  71
  72                 std::map<std::string, std::shared_ptr<can_bus_dev_t>> can_devices_m_; /*!< Can device map containing all can_bus_dev_t objects initialized during init_can_dev function*/
  73
  74         public:
  75                 can_bus_t(int conf_file);
  76
  77                 int init_can_dev();
  78                 std::vector<std::string> read_conf();
  79
  80
  81                 void start_threads();
  82                 void stop_threads();
  83
  84                 can_message_t next_can_message();
  85                 void push_new_can_message(const can_message_t& can_msg);
  86                 std::mutex& get_can_message_mutex();
  87                 std::condition_variable& get_new_can_message_cv();
  88
  89                 openxc_VehicleMessage next_vehicle_message();
  90                 void push_new_vehicle_message(const openxc_VehicleMessage& v_msg);
  91
  92                 std::map<std::string, std::shared_ptr<can_bus_dev_t>> get_can_devices();
  93 };
  94
  95
  96 /**
  97  * @class can_bus_dev_t
  98  *
  99  * @brief Object representing a can device. Handle opening, closing and reading on the
 100  *  socket. This is the low level object to be use by can_bus_t.
 101  */
 102 class can_bus_dev_t {
 103         private:
 104                 int32_t id_; /*!< int32_t id_ - an identifier used through binding that refer to that device*/
 105                 std::string device_name_; /*!< std::string device_name_ - name of the linux device handling the can bus. Generally vcan0, can0, etc. */
 106                 int can_socket_; /*!< socket handler for the can device */
 107                 bool is_fdmode_on_; /*!< boolean telling if whether or not the can socket use fdmode. */
 108                 struct sockaddr_can txAddress_; /*!< internal member using to bind to the socket */
 109
 110                 std::thread th_reading_; /*!< Thread handling read the socket can device filling can_message_q_ queue of can_bus_t */
 111                 bool is_running_; /*!< boolean telling whether or not reading is running or not */
 112                 void can_reader(can_bus_t& can_bus);
 113
 114         public:
 115                 can_bus_dev_t(const std::string& dev_name);
 116
 117                 int open();
 118                 int close();
 119
 120                 void start_reading(can_bus_t& can_bus);
 121
 122                 void stop_reading();
 123
 124                 std::pair<struct canfd_frame&, size_t> read();
 125
 126                 int send_can_message(can_message_t& can_msg);
 127 };
 128
 129 /** TODO: implement this function as method into can_bus class
 130  * @fn void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 131  * @brief Pre initialize actions made before CAN bus initialization
 132  *
 133  * @param[in] can_bus_dev_t bus - A CanBus struct defining the bus's metadata
 134  * @param[in] bool writable - configure the controller in a writable mode. If false, it will be
 135  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 136  * @param[in] buses - An array of all CAN buses.
 137  * @param[in] int busCount - The length of the buses array.
 138  */
 139 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 140
 141 /** TODO: implement this function as method into can_bus class
 142  * @fn void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 143  * @brief Post-initialize actions made after CAN bus initialization
 144  *
 145  * @param[in] bus - A CanBus struct defining the bus's metadata
 146  * @param[in] writable - configure the controller in a writable mode. If false, it will be
 147  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 148  * @param[in] buses - An array of all CAN buses.
 149  * @param[in] busCount - The length of the buses array.
 150  */
 151 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 152
 153 /** TODO: implement this function as method into can_bus class
 154  * @fn bool isBusActive(can_bus_dev_t* bus);
 155  * @brief Check if the device is connected to an active CAN bus, i.e. it's
 156  * received a message in the recent past.
 157  *
 158  * @return true if a message was received on the CAN bus within
 159  * CAN_ACTIVE_TIMEOUT_S seconds.
 160  */
 161 bool isBusActive(can_bus_dev_t* bus);
 162
 163 /** TODO: implement this function as method into can_bus class
 164  *
 165  * @fn void logBusStatistics(can_bus_dev_t* buses, const int busCount);
 166  * @brief Log transfer statistics about all active CAN buses to the debug log.
 167  *
 168  * @param[in] buses - an array of active CAN buses.
 169  * @param[in] busCount - the length of the buses array.
 170  */
 171 void logBusStatistics(can_bus_dev_t* buses, const int busCount);