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 /// @param[in] bcm boolean value indicating wether or not we initialize a Broadcast CAN Manager socket.
  54 ///
  55 /// @return socket value or -1 if something wrong.
  56 int can_bus_dev_t::open(bool bcm)
  57 {
  58         DEBUG(binder_interface, "open_raw: CAN Handler socket : %d", can_socket_.socket());
  59         return can_socket_.open(device_name_, bcm);
  60 }
  61
  62 /// @brief Set some option on the socket, timestamp and canfd frame usage.
  63 void can_bus_dev_t::configure()
  64 {
  65         if (can_socket_)
  66         {
  67                 const int timestamp_on = 1;
  68                 const int canfd_on = 1;
  69
  70                 DEBUG(binder_interface, "open_raw: CAN Handler socket correctly initialized : %d", can_socket_.socket());
  71
  72                 // Set timestamp for receveid frame
  73                 if (can_socket_.setopt(SOL_SOCKET, SO_TIMESTAMP, &timestamp_on, sizeof(timestamp_on)) < 0)
  74                         WARNING(binder_interface, "open_raw: setsockopt SO_TIMESTAMP error: %s", ::strerror(errno));
  75                 DEBUG(binder_interface, "open_raw: Switch CAN Handler socket to use fd mode");
  76
  77                 // try to switch the socket into CAN_FD mode
  78                 if (can_socket_.setopt(SOL_CAN_RAW, CAN_RAW_FD_FRAMES, &canfd_on, sizeof(canfd_on)) < 0)
  79                 {
  80                         NOTICE(binder_interface, "open_raw: Can not switch into CAN Extended frame format.");
  81                         is_fdmode_on_ = false;
  82                 }
  83                 else
  84                 {
  85                         DEBUG(binder_interface, "open_raw: Correctly set up CAN socket to use FD frames.");
  86                         is_fdmode_on_ = true;
  87                 }
  88         }
  89         else
  90         {
  91                 ERROR(binder_interface, "open_raw: socket could not be created. Error was : %s", ::strerror(errno));
  92         }
  93 }
  94
  95 /// @brief Close the bus.
  96 ///
  97 /// @return interger return value of socket.close() function
  98 int can_bus_dev_t::close()
  99 {
 100         return can_socket_.close();
 101 }
 102
 103 /// @brief Read the can socket and retrieve canfd_frame.
 104 ///
 105 ///  Read operation are blocking and we try to read CANFD frame
 106 ///  rather than classic CAN frame. CANFD frame are retro compatible.
 107 can_message_t can_bus_dev_t::read()
 108 {
 109         ssize_t nbytes;
 110         struct canfd_frame cfd;
 111
 112         // Test that socket is really opened
 113         if (!can_socket_)
 114         {
 115                 ERROR(binder_interface, "read: Socket unavailable. Closing thread.");
 116                 is_running_ = false;
 117         }
 118
 119         nbytes = ::read(can_socket_.socket(), &cfd, CANFD_MTU);
 120
 121         // if we did not fit into CAN sized messages then stop_reading.
 122         if (nbytes != CANFD_MTU && nbytes != CAN_MTU)
 123         {
 124                 if (errno == ENETDOWN)
 125                         ERROR(binder_interface, "read: %s CAN device down", device_name_.c_str());
 126                 ERROR(binder_interface, "read: Incomplete CAN(FD) frame");
 127                 ::memset(&cfd, 0, sizeof(cfd));
 128         }
 129
 130         DEBUG(binder_interface, "read: Found id: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X", cfd.can_id, cfd.len,
 131                                                         cfd.data[0], cfd.data[1], cfd.data[2], cfd.data[3], cfd.data[4], cfd.data[5], cfd.data[6], cfd.data[7]);
 132         return can_message_t::convert_from_canfd_frame(cfd, nbytes);
 133 }
 134
 135 /// @brief start reading threads and set flag is_running_
 136 /// @param[in] can_bus reference can_bus_t. it will be passed to the thread to allow using can_bus_t queue.
 137 void can_bus_dev_t::start_reading(can_bus_t& can_bus)
 138 {
 139         DEBUG(binder_interface, "Launching reading thread");
 140         is_running_ = true;
 141         th_reading_ = std::thread(&can_bus_dev_t::can_reader, this, std::ref(can_bus));
 142         if(!th_reading_.joinable())
 143                 is_running_ = false;
 144 }
 145
 146 /// @brief stop the reading thread setting flag is_running_ to false and and wait that the thread finish its job.
 147 void can_bus_dev_t::stop_reading()
 148 {
 149         is_running_ = false;
 150 }
 151
 152 /// @brief Thread function used to read the can socket.
 153 /// @param[in] can_bus - object to be used to read the can socket
 154 void can_bus_dev_t::can_reader(can_bus_t& can_bus)
 155 {
 156         while(is_running_)
 157         {
 158                 can_message_t msg = read();
 159                 {
 160                         std::lock_guard<std::mutex> can_message_lock(can_bus.get_can_message_mutex());
 161                         can_bus.push_new_can_message(msg);
 162                 }
 163                 can_bus.get_new_can_message_cv().notify_one();
 164         }
 165 }
 166
 167 /// @brief Send a can message from a can_message_t object.
 168 /// @param[in] can_msg - the can message object to send
 169 ///
 170 /// @return 0 if message snet, -1 if something wrong.
 171 int can_bus_dev_t::send(can_message_t& can_msg)
 172 {
 173         ssize_t nbytes;
 174         canfd_frame f;
 175
 176         f = can_msg.convert_to_canfd_frame();
 177
 178         if(can_socket_)
 179         {
 180                 nbytes = can_socket_.send(f);
 181                 if (nbytes == -1)
 182                 {
 183                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
 184                         return -1;
 185                 }
 186                 return (int)nbytes;
 187         }
 188         else
 189         {
 190                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
 191                 open(true);
 192                 return -1;
 193         }
 194         return 0;
 195 }
 196
 197 /// @brief Static method used to send diagnostic CAN message
 198 /// that follow isotp SendShimsMessage signature. This method is launched
 199 /// from diagnostic manager's' same name method. It will use the diagnostic
 200 /// manager configured CAN bus device to send the CAN message.
 201 ///
 202 /// @param[in] arbitration_id - CAN arbitration id.
 203 /// @param[in] data - CAN message payload to send
 204 /// @param[in] size - size of the data to send
 205 ///
 206 /// @return True if message sent, false if not.
 207 bool can_bus_dev_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
 208 {
 209         ssize_t nbytes;
 210         canfd_frame f;
 211
 212         f.can_id = arbitration_id;
 213         f.len = size;
 214         ::memcpy(f.data, data, size);
 215
 216         if(can_socket_)
 217         {
 218                 nbytes = can_socket_.send(f);
 219                 if (nbytes == -1)
 220                 {
 221                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
 222                         return false;
 223                 }
 224                 return true;
 225         }
 226         else
 227         {
 228                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
 229                 open(true);
 230         }
 231         return false;
 232 }