CAN-binder/low-can-binding/can/can-bus-dev.cpp

   1 /*
   2 * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
   3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4 * Author "Loïc Collignon" <loic.collignon@iot.bzh>
   5 *
   6 * Licensed under the Apache License, Version 2.0 (the "License");
   7 * you may not use this file except in compliance with the License.
   8 * You may obtain a copy of the License at
   9 *
  10 *       http://www.apache.org/licenses/LICENSE-2.0
  11 *
  12 * Unless required by applicable law or agreed to in writing, software
  13 * distributed under the License is distributed on an "AS IS" BASIS,
  14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 * See the License for the specific language governing permissions and
  16 * limitations under the License.
  17 */
  18
  19 #include <map>
  20 #include <mutex>
  21 #include <unistd.h>
  22 #include <linux/can/raw.h>
  23
  24 #include "can-bus-dev.hpp"
  25
  26 #include "can-bus.hpp"
  27 #include "can-message.hpp"
  28 #include "../low-can-binding.hpp"
  29
  30 /// @brief Class constructor
  31 ///
  32 /// @param[in] dev_name - String representing the device name into the linux /dev tree
  33 /// @param[in] address - integer identifier of the bus, set using init_can_dev from can_bus_t.
  34 can_bus_dev_t::can_bus_dev_t(const std::string& dev_name, int32_t address)
  35         : device_name_{dev_name}, address_{address}
  36 {}
  37
  38 std::string can_bus_dev_t::get_device_name() const
  39 {
  40         return device_name_;
  41 }
  42
  43 uint32_t can_bus_dev_t::get_address() const
  44 {
  45         return address_;
  46 }
  47
  48 /// @brief Open the can socket and returning it
  49 ///
  50 ///  We try to open CAN socket and apply the following options
  51 ///  timestamp received messages and pass the socket to FD mode.
  52 ///
  53 /// @return socket value or -1 if something wrong.
  54 int can_bus_dev_t::open()
  55 {
  56         return can_socket_.open(device_name_);
  57 }
  58
  59 /// @brief Set some option on the socket, timestamp and canfd frame usage.
  60 void can_bus_dev_t::configure()
  61 {
  62         if (can_socket_)
  63         {
  64                 const int timestamp_on = 1;
  65
  66                 DEBUG(binder_interface, "%s: CAN Handler socket correctly initialized : %d", __FUNCTION__, can_socket_.socket());
  67                 if (can_socket_.setopt(SOL_SOCKET, SO_TIMESTAMP, &timestamp_on, sizeof(timestamp_on)) < 0)
  68                         WARNING(binder_interface, "%s: setsockopt SO_TIMESTAMP error: %s", __FUNCTION__, ::strerror(errno));
  69         }
  70         else
  71         {
  72                 ERROR(binder_interface, "open_raw: socket could not be created. Error was : %s", ::strerror(errno));
  73         }
  74 }
  75
  76 /// @brief Close the bus.
  77 ///
  78 /// @return interger return value of socket.close() function
  79 int can_bus_dev_t::close()
  80 {
  81         return can_socket_.close();
  82 }
  83
  84 /// @brief Read the can socket and retrieve canfd_frame.
  85 ///
  86 ///  Read operation are blocking and we try to read CANFD frame
  87 ///  rather than classic CAN frame. CANFD frame are retro compatible.
  88 can_message_t can_bus_dev_t::read()
  89 {
  90         ssize_t nbytes;
  91         struct canfd_frame cfd;
  92
  93         // Test that socket is really opened
  94         if (!can_socket_)
  95         {
  96                 ERROR(binder_interface, "read: Socket unavailable. Closing thread.");
  97                 is_running_ = false;
  98         }
  99
 100         nbytes = ::read(can_socket_.socket(), &cfd, CANFD_MTU);
 101
 102         // if we did not fit into CAN sized messages then stop_reading.
 103         if (nbytes != CANFD_MTU && nbytes != CAN_MTU)
 104         {
 105                 if (errno == ENETDOWN)
 106                         ERROR(binder_interface, "read: %s CAN device down", device_name_.c_str());
 107                 ERROR(binder_interface, "read: Incomplete CAN(FD) frame");
 108                 ::memset(&cfd, 0, sizeof(cfd));
 109         }
 110
 111         DEBUG(binder_interface, "%s: Found id: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X", __FUNCTION__, cfd.can_id, cfd.len,
 112                                                         cfd.data[0], cfd.data[1], cfd.data[2], cfd.data[3], cfd.data[4], cfd.data[5], cfd.data[6], cfd.data[7]);
 113         return can_message_t::convert_from_canfd_frame(cfd, nbytes);
 114 }
 115
 116 /// @brief start reading threads and set flag is_running_
 117 /// @param[in] can_bus reference can_bus_t. it will be passed to the thread to allow using can_bus_t queue.
 118 void can_bus_dev_t::start_reading(can_bus_t& can_bus)
 119 {
 120         DEBUG(binder_interface, "%s: Launching reading thread", __FUNCTION__);
 121         is_running_ = true;
 122         th_reading_ = std::thread(&can_bus_dev_t::can_reader, this, std::ref(can_bus));
 123         if(!th_reading_.joinable())
 124                 is_running_ = false;
 125 }
 126
 127 /// @brief stop the reading thread setting flag is_running_ to false and and wait that the thread finish its job.
 128 void can_bus_dev_t::stop_reading()
 129 {
 130         is_running_ = false;
 131 }
 132
 133 /// @brief Thread function used to read the can socket.
 134 /// @param[in] can_bus - object to be used to read the can socket
 135 void can_bus_dev_t::can_reader(can_bus_t& can_bus)
 136 {
 137         while(is_running_)
 138         {
 139                 can_message_t msg = read();
 140                 {
 141                         std::lock_guard<std::mutex> can_message_lock(can_bus.get_can_message_mutex());
 142                         can_bus.push_new_can_message(msg);
 143                 }
 144                 can_bus.get_new_can_message_cv().notify_one();
 145         }
 146 }
 147
 148 /// @brief Send a can message from a can_message_t object.
 149 /// @param[in] can_msg - the can message object to send
 150 ///
 151 /// @return 0 if message snet, -1 if something wrong.
 152 int can_bus_dev_t::send(can_message_t& can_msg)
 153 {
 154         canfd_frame f;
 155         f = can_msg.convert_to_canfd_frame();
 156
 157         if(can_socket_)
 158         {
 159                 can_socket_ << f;
 160                 if(!can_socket_)
 161                 {
 162                         ERROR(binder_interface, "%s: Sending CAN frame failed.", __FUNCTION__);
 163                         return -1;
 164                 }
 165         }
 166         else
 167         {
 168                 ERROR(binder_interface, "%s: socket not initialized. Attempt to reopen can device socket.", __FUNCTION__);
 169                 open();
 170                 return -1;
 171         }
 172         return 0;
 173 }
 174
 175 /// @brief Static method used to send diagnostic CAN message
 176 /// that follow isotp SendShimsMessage signature. This method is launched
 177 /// from diagnostic manager's' same name method. It will use the diagnostic
 178 /// manager configured CAN bus device to send the CAN message.
 179 ///
 180 /// @param[in] arbitration_id - CAN arbitration id.
 181 /// @param[in] data - CAN message payload to send
 182 /// @param[in] size - size of the data to send
 183 ///
 184 /// @return True if message sent, false if not.
 185 bool can_bus_dev_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
 186 {
 187         canfd_frame f;
 188
 189         f.can_id = arbitration_id;
 190         f.len = size;
 191         ::memcpy(f.data, data, size);
 192
 193         if(can_socket_)
 194         {
 195                 can_socket_ << f;
 196                 if (!can_socket_)
 197                 {
 198                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
 199                         return false;
 200                 }
 201         }
 202         else
 203         {
 204                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
 205                 open();
 206                 return false;
 207         }
 208         return true;
 209 }