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