src/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 "timer.hpp"
  27 #include "openxc.pb.h"
  28 #include "can-signals.hpp"
  29 #include "can-message.hpp"
  30 #include "low-can-binding.hpp"
  31
  32 // TODO actual max is 32 but dropped to 24 for memory considerations
  33 #define MAX_ACCEPTANCE_FILTERS 24
  34 // TODO this takes up a ton of memory
  35 #define MAX_DYNAMIC_MESSAGE_COUNT 12
  36
  37 #define CAN_ACTIVE_TIMEOUT_S 30
  38
  39 /**
  40  * @class can_bus_t
  41  * @brief Object used to handle decoding and manage event queue to be pushed.
  42  *
  43  * This object is also used to initialize can_bus_dev_t object after reading
  44  * json conf file describing the CAN devices to use. Thus, those object will read
  45  * on the device the CAN frame and push them into the can_bus_t can_message_q_ queue.
  46  *
  47  * That queue will be later used to be decoded and pushed to subscribers.
  48  */
  49 class can_bus_t {
  50         private:
  51                 int conf_file_; /*!< conf_file_ - configuration file handle used to initialize can_bus_dev_t objects.*/
  52
  53                 /**
  54                  * @brief thread to decoding raw CAN messages.
  55                  *
  56                  * @desc It will take from the can_message_q_ queue the next can message to process then it will search
  57                  *  about signal subscribed if there is a valid afb_event for it. We only decode signal for which a
  58                  *  subscription has been made. Can message will be decoded using translateSignal that will pass it to the
  59                  *  corresponding decoding function if there is one assigned for that signal. If not, it will be the default
  60                  *  noopDecoder function that will operate on it.
  61                  */
  62                 void can_decode_message();
  63                 std::thread th_decoding_; /*!< thread that'll handle decoding a can frame */
  64                 bool is_decoding_; /*!< boolean member controling thread while loop*/
  65
  66                 /**
  67                  * @brief thread to push events to suscribers. It will read subscribed_signals map to look
  68                  * which are events that has to be pushed.
  69                  */
  70                 void can_event_push();
  71                 std::thread th_pushing_; /*!<  thread that'll handle pushing decoded can frame to subscribers */
  72                 bool is_pushing_; /*!< boolean member controling thread while loop*/
  73
  74                 std::condition_variable new_can_message_; /*!< condition_variable use to wait until there is a new CAN message to read*/
  75                 std::mutex can_message_mutex_; /*!< mutex protecting the can_message_q_ queue.*/
  76                 bool has_can_message_; /*!< boolean members that control whether or not there is can_message into the queue */
  77                 std::queue <can_message_t> can_message_q_; /*!< queue that'll store can_message_t to decoded */
  78
  79                 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_*/
  80                 std::mutex decoded_can_message_mutex_;  /*!< mutex protecting the vehicle_message_q_ queue.*/
  81                 bool has_vehicle_message_; /*!< boolean members that control whether or not there is openxc_VehicleMessage into the queue */
  82                 std::queue <openxc_VehicleMessage> vehicle_message_q_; /*!< queue that'll store openxc_VehicleMessage to pushed */
  83
  84         public:
  85                 /**
  86                  * @brief Class constructor
  87                  *
  88                  * @param struct afb_binding_interface *interface between daemon and binding
  89                  * @param int file handle to the json configuration file.
  90                  */
  91                 can_bus_t(int& conf_file);
  92
  93                 /**
  94                  * @brief Will initialize can_bus_dev_t objects after reading
  95                  * the configuration file passed in the constructor.
  96                  */
  97                 int init_can_dev();
  98
  99                 /**
 100                  * @brief read the conf_file_ and will parse json objects
 101                  * in it searching for canbus objects devices name.
 102                  *
 103                  * @return Vector of can bus device name string.
 104                  */
 105                 std::vector<std::string> read_conf();
 106
 107                 /**
 108                  * @brief Will initialize threads that will decode
 109                  *  and push subscribed events.
 110                  */
 111                 void start_threads();
 112
 113                 /**
 114                  * @brief Will stop all threads holded by can_bus_t object
 115                  *  which are decoding and pushing then will wait that's
 116                  * they'll finish their job.
 117                  */
 118                 void stop_threads();
 119
 120                 /**
 121                  * @brief Telling if the decoding thread is running.
 122                  *  This is the boolean value on which the while loop
 123                  *  take its condition. Set it to false will stop the
 124                  *  according thread.
 125                  *
 126                  * @return true if decoding thread is running, false if not.
 127                  */
 128                 bool is_decoding();
 129
 130                 /**
 131                  * @brief Telling if the pushing thread is running
 132                  *  This is the boolean value on which the while loop
 133                  *  take its condition. Set it to false will stop the
 134                  *  according thread.
 135                  *
 136                  * @return true if pushing thread is running, false if not.
 137                  */
 138                 bool is_pushing();
 139
 140                 /**
 141                  * @brief Return first can_message_t on the queue
 142                  *
 143                  * @return a can_message_t
 144                  */
 145                 can_message_t next_can_message();
 146
 147                 /**
 148                  * @brief Push a can_message_t into the queue
 149                  *
 150                  * @param the const reference can_message_t object to push into the queue
 151                  */
 152                 void push_new_can_message(const can_message_t& can_msg);
 153
 154                 /**
 155                  * @brief Return a boolean telling if there is any can_message into the queue
 156                  *
 157                  * @return true if there is at least a can_message_t, false if not.
 158                  */
 159                 std::mutex& get_can_message_mutex();
 160                 std::condition_variable& get_new_can_message();
 161
 162
 163                 /**
 164                  * @brief Return first openxc_VehicleMessage on the queue
 165                  *
 166                  * @return a openxc_VehicleMessage containing a decoded can message
 167                  */
 168                 openxc_VehicleMessage next_vehicle_message();
 169
 170                 /**
 171                  * @brief Push a openxc_VehicleMessage into the queue
 172                  *
 173                  * @param the const reference openxc_VehicleMessage object to push into the queue
 174                  */
 175                 void push_new_vehicle_message(const openxc_VehicleMessage& v_msg);
 176 };
 177
 178 /**
 179  * @class can_bus_dev_t
 180  *
 181  * @brief Object representing a can device. Handle opening, closing and reading on the
 182  *  socket. This is the low level object to be use by can_bus_t.
 183  */
 184 class can_bus_dev_t {
 185         private:
 186                 std::string device_name_; /*!< std::string device_name_ - name of the linux device handling the can bus. Generally vcan0, can0, etc. */
 187                 int can_socket_; /*!< socket handler for the can device */
 188                 bool is_fdmode_on_; /*!< boolean telling if whether or not the can socket use fdmode. */
 189                 struct sockaddr_can txAddress_; /*!< internal member using to bind to the socket */
 190
 191                 std::thread th_reading_; /*!< Thread handling read the socket can device filling can_message_q_ queue of can_bus_t */
 192                 bool is_running_; /*!< boolean telling whether or not reading is running or not */
 193
 194                 /**
 195                 *
 196                 * @brief Thread function used to read the can socket.
 197                 *
 198                 * @param[in] can_bus_dev_t object to be used to read the can socket
 199                 * @param[in] can_bus_t object used to fill can_message_q_ queue
 200                 */
 201                 void can_reader(can_bus_t& can_bus);
 202
 203         public:
 204                 /**
 205                  * @brief Class constructor
 206                  *
 207                  * @param const string representing the device name into the linux /dev tree
 208                  */
 209                 can_bus_dev_t(const std::string& dev_name);
 210
 211                 /**
 212                  * @brief Open the can socket and returning it
 213                  *
 214                  * @return
 215                  */
 216                 int open();
 217
 218                 /**
 219                  * @brief Open the can socket and returning it
 220                  *
 221                  * @return
 222                  */
 223                 int close();
 224
 225                 /**
 226                  * @brief Telling if the reading thread is running
 227                  *  This is the boolean value on which the while loop
 228                  *  take its condition. Set it to false will stop the
 229                  *  according thread.
 230                  *
 231                  * @return true if reading thread is running, false if not.
 232                  */
 233                 bool is_running();
 234
 235                 /**
 236                  * @brief start reading threads and set flag is_running_
 237                  *
 238                  * @param can_bus_t reference can_bus_t. it will be passed to the thread
 239                  *  to allow using can_bus_t queue.
 240                  */
 241                 void start_reading(can_bus_t& can_bus);
 242
 243                 /**
 244                  * @brief stop the reading thread setting flag is_running_ to false and
 245                  * and wait that the thread finish its job.
 246                  */
 247                 void stop_reading();
 248
 249                 /**
 250                 * @brief Read the can socket and retrieve canfd_frame
 251                 *
 252                 * @param const struct afb_binding_interface* interface pointer. Used to be able to log
 253                 *  using application framework logger.
 254                 */
 255                 canfd_frame read();
 256
 257                 /**
 258                 * @brief Send a can message from a can_message_t object.
 259                 *
 260                 * @param const can_message_t& can_msg: the can message object to send
 261                 * @param const struct afb_binding_interface* interface pointer. Used to be able to log
 262                 *  using application framework logger.
 263                 */
 264                 int send_can_message(can_message_t& can_msg);
 265 };
 266
 267 /**
 268  * @brief Return an array of the metadata for the 2 CAN buses you want to
 269  * monitor. The size of this array is fixed at 2.
 270  */
 271 can_bus_dev_t getCanBuses();
 272
 273 /**
 274  * @fn void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 275  * @brief Pre initialize actions made before CAN bus initialization
 276  *
 277  * @param[in] can_bus_dev_t bus - A CanBus struct defining the bus's metadata
 278  * @param[in] bool writable - configure the controller in a writable mode. If false, it will be
 279  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 280  * @param[in] buses - An array of all CAN buses.
 281  * @param[in] int busCount - The length of the buses array.
 282  */
 283 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 284
 285 /**
 286  * @fn void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 287  * @brief Post-initialize actions made after CAN bus initialization
 288  *
 289  * @param[in] bus - A CanBus struct defining the bus's metadata
 290  * @param[in] writable - configure the controller in a writable mode. If false, it will be
 291  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 292  * @param[in] buses - An array of all CAN buses.
 293  * @param[in] busCount - The length of the buses array.
 294  */
 295 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 296
 297 /**
 298  * @fn bool isBusActive(can_bus_dev_t* bus);
 299  * @brief Check if the device is connected to an active CAN bus, i.e. it's
 300  * received a message in the recent past.
 301  *
 302  * @return true if a message was received on the CAN bus within
 303  * CAN_ACTIVE_TIMEOUT_S seconds.
 304  */
 305 bool isBusActive(can_bus_dev_t* bus);
 306
 307 /**
 308  * @fn void logBusStatistics(can_bus_dev_t* buses, const int busCount);
 309  * @brief Log transfer statistics about all active CAN buses to the debug log.
 310  *
 311  * @param[in] buses - an array of active CAN buses.
 312  * @param[in] busCount - the length of the buses array.
 313  */
 314 void logBusStatistics(can_bus_dev_t* buses, const int busCount);
 315
 316 /**
 317  * @fn void can_decode_message(can_bus_t& can_bus);
 318  *
 319  * @brief Thread function used to decode can messages read into the can_message_q_
 320  *
 321  * @param[in] can_bus_t object used to pop can_message_q_ queue and fill decoded message
 322  * into vehicle_message_q_ queue.
 323  */
 324 void can_decode_message(can_bus_t& can_bus);
 325
 326 /**
 327  * @fn void can_decode_message(can_bus_t& can_bus);
 328  *
 329  * @brief Thread function used to push afb_event
 330  *
 331  * @param[in] can_bus_t object used to pop can_message_q_ queue and fill decoded message
 332  * into vehicle_message_q_ queue.
 333  */
 334 void can_event_push(can_bus_t& can_bus);