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.
23 #include <linux/can.h>
24 #include <condition_variable>
27 #include "openxc.pb.h"
28 #include "can-signals.hpp"
29 #include "can-message.hpp"
30 #include "low-can-binding.hpp"
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
37 #define CAN_ACTIVE_TIMEOUT_S 30
43 * @brief Object used to handle decoding and manage event queue to be pushed.
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.
49 * That queue will be later used to be decoded and pushed to subscribers.
53 int conf_file_; /*!< conf_file_ - configuration file handle used to initialize can_bus_dev_t objects.*/
56 * @brief thread to decoding raw CAN messages.
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.
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*/
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.
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*/
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 */
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 */
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*/
90 * @brief Class constructor
92 * @param struct afb_binding_interface *interface between daemon and binding
93 * @param int file handle to the json configuration file.
95 can_bus_t(int conf_file);
98 * @brief Will initialize can_bus_dev_t objects after reading
99 * the configuration file passed in the constructor.
104 * @brief read the conf_file_ and will parse json objects
105 * in it searching for canbus objects devices name.
107 * @return Vector of can bus device name string.
109 std::vector<std::string> read_conf();
112 * @brief Will initialize threads that will decode
113 * and push subscribed events.
115 void start_threads();
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.
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
130 * @return true if decoding thread is running, false if not.
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
140 * @return true if pushing thread is running, false if not.
145 * @brief Return first can_message_t on the queue
147 * @return a can_message_t
149 can_message_t next_can_message();
152 * @brief Push a can_message_t into the queue
154 * @param the const reference can_message_t object to push into the queue
156 void push_new_can_message(const can_message_t& can_msg);
159 * @brief return can_message_mutex_ member
161 * @return return can_message_mutex_ member
163 std::mutex& get_can_message_mutex();
166 * @brief return new_can_message_ member
168 * @return return new_can_message_ member
170 std::condition_variable& get_new_can_message();
172 bool has_can_message();
175 * @brief Return first openxc_VehicleMessage on the queue
177 * @return a openxc_VehicleMessage containing a decoded can message
179 openxc_VehicleMessage next_vehicle_message();
182 * @brief Push a openxc_VehicleMessage into the queue
184 * @param the const reference openxc_VehicleMessage object to push into the queue
186 void push_new_vehicle_message(const openxc_VehicleMessage& v_msg);
189 * @brief Return a map with the can_bus_dev_t initialized
191 * @return map can_bus_dev_m_ map
193 std::map<std::string, std::shared_ptr<can_bus_dev_t>> get_can_devices();
198 * @class can_bus_dev_t
200 * @brief Object representing a can device. Handle opening, closing and reading on the
201 * socket. This is the low level object to be use by can_bus_t.
203 class can_bus_dev_t {
205 std::string device_name_; /*!< std::string device_name_ - name of the linux device handling the can bus. Generally vcan0, can0, etc. */
206 int can_socket_; /*!< socket handler for the can device */
207 bool is_fdmode_on_; /*!< boolean telling if whether or not the can socket use fdmode. */
208 struct sockaddr_can txAddress_; /*!< internal member using to bind to the socket */
210 std::thread th_reading_; /*!< Thread handling read the socket can device filling can_message_q_ queue of can_bus_t */
211 bool is_running_; /*!< boolean telling whether or not reading is running or not */
215 * @brief Thread function used to read the can socket.
217 * @param[in] can_bus_dev_t object to be used to read the can socket
218 * @param[in] can_bus_t object used to fill can_message_q_ queue
220 void can_reader(can_bus_t& can_bus);
224 * @brief Class constructor
226 * @param const string representing the device name into the linux /dev tree
228 can_bus_dev_t(const std::string& dev_name);
231 * @brief Open the can socket and returning it
238 * @brief Open the can socket and returning it
245 * @brief Telling if the reading thread is running
246 * This is the boolean value on which the while loop
247 * take its condition. Set it to false will stop the
250 * @return true if reading thread is running, false if not.
255 * @brief start reading threads and set flag is_running_
257 * @param can_bus_t reference can_bus_t. it will be passed to the thread
258 * to allow using can_bus_t queue.
260 void start_reading(can_bus_t& can_bus);
263 * @brief stop the reading thread setting flag is_running_ to false and
264 * and wait that the thread finish its job.
269 * @brief Read the can socket and retrieve canfd_frame
271 * @param const struct afb_binding_interface* interface pointer. Used to be able to log
272 * using application framework logger.
274 std::pair<struct canfd_frame&, size_t> read();
277 * @brief Send a can message from a can_message_t object.
279 * @param const can_message_t& can_msg: the can message object to send
280 * @param const struct afb_binding_interface* interface pointer. Used to be able to log
281 * using application framework logger.
283 int send_can_message(can_message_t& can_msg);
286 /** TODO: implement this function as method into can_bus class
287 * @fn void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
288 * @brief Pre initialize actions made before CAN bus initialization
290 * @param[in] can_bus_dev_t bus - A CanBus struct defining the bus's metadata
291 * @param[in] bool writable - configure the controller in a writable mode. If false, it will be
292 * configured as "listen only" and will not allow writes or even CAN ACKs.
293 * @param[in] buses - An array of all CAN buses.
294 * @param[in] int busCount - The length of the buses array.
296 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
298 /** TODO: implement this function as method into can_bus class
299 * @fn void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
300 * @brief Post-initialize actions made after CAN bus initialization
302 * @param[in] bus - A CanBus struct defining the bus's metadata
303 * @param[in] writable - configure the controller in a writable mode. If false, it will be
304 * configured as "listen only" and will not allow writes or even CAN ACKs.
305 * @param[in] buses - An array of all CAN buses.
306 * @param[in] busCount - The length of the buses array.
308 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
310 /** TODO: implement this function as method into can_bus class
311 * @fn bool isBusActive(can_bus_dev_t* bus);
312 * @brief Check if the device is connected to an active CAN bus, i.e. it's
313 * received a message in the recent past.
315 * @return true if a message was received on the CAN bus within
316 * CAN_ACTIVE_TIMEOUT_S seconds.
318 bool isBusActive(can_bus_dev_t* bus);
320 /** TODO: implement this function as method into can_bus class
322 * @fn void logBusStatistics(can_bus_dev_t* buses, const int busCount);
323 * @brief Log transfer statistics about all active CAN buses to the debug log.
325 * @param[in] buses - an array of active CAN buses.
326 * @param[in] busCount - the length of the buses array.
328 void logBusStatistics(can_bus_dev_t* buses, const int busCount);