src/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 <string.h>
  23 #include <net/if.h>
  24 #include <sys/ioctl.h>
  25 #include <linux/can/raw.h>
  26
  27 #include "can-bus-dev.hpp"
  28
  29 #include "can-bus.hpp"
  30 #include "can-message.hpp"
  31 #include "../low-can-binding.hpp"
  32
  33 /// @brief Class constructor
  34 /// @param dev_name String representing the device name into the linux /dev tree
  35 can_bus_dev_t::can_bus_dev_t(const std::string& dev_name, int32_t address)
  36         : device_name_{dev_name}, address_{address}
  37 {}
  38
  39 std::string can_bus_dev_t::get_device_name() const
  40 {
  41         return device_name_;
  42 }
  43
  44 uint32_t can_bus_dev_t::get_address() const
  45 {
  46         return address_;
  47 }
  48
  49 /// @brief Open the can socket and returning it
  50 /// @return -1 if something wrong.
  51 int can_bus_dev_t::open()
  52 {
  53         const int canfd_on = 1;
  54         const int timestamp_on = 1;
  55         struct ifreq ifr;
  56         struct timeval timeout;
  57
  58         DEBUG(binder_interface, "CAN Handler socket : %d", can_socket_.socket());
  59         if (can_socket_)
  60                 return 0;
  61
  62         can_socket_.open(PF_CAN, SOCK_RAW, CAN_RAW);
  63         if (can_socket_)
  64         {
  65                 DEBUG(binder_interface, "CAN Handler socket correctly initialized : %d", can_socket_.socket());
  66
  67                 // Set timeout for read
  68                 can_socket_.setopt(SOL_SOCKET, SO_RCVTIMEO, (char *)&timeout, sizeof(timeout));
  69
  70                 // Set timestamp for receveid frame
  71                 if (can_socket_.setopt(SOL_SOCKET, SO_TIMESTAMP, &timestamp_on, sizeof(timestamp_on)) < 0)
  72                         WARNING(binder_interface, "setsockopt SO_TIMESTAMP error: %s", ::strerror(errno));
  73                 DEBUG(binder_interface, "Switch CAN Handler socket to use fd mode");
  74
  75                 // try to switch the socket into CAN_FD mode
  76                 if (can_socket_.setopt(SOL_CAN_RAW, CAN_RAW_FD_FRAMES, &canfd_on, sizeof(canfd_on)) < 0)
  77                 {
  78                         NOTICE(binder_interface, "Can not switch into CAN Extended frame format.");
  79                         is_fdmode_on_ = false;
  80                 }
  81                 else
  82                 {
  83                         DEBUG(binder_interface, "Correctly set up CAN socket to use FD frames.");
  84                         is_fdmode_on_ = true;
  85                 }
  86
  87                 // Attempts to open a socket to CAN bus
  88                 ::strcpy(ifr.ifr_name, device_name_.c_str());
  89                 DEBUG(binder_interface, "ifr_name is : %s", ifr.ifr_name);
  90                 if(::ioctl(can_socket_.socket(), SIOCGIFINDEX, &ifr) < 0)
  91                 {
  92                         ERROR(binder_interface, "ioctl failed. Error was : %s", strerror(errno));
  93                 }
  94                 else
  95                 {
  96                         txAddress_.can_family = AF_CAN;
  97                         txAddress_.can_ifindex = ifr.ifr_ifindex;
  98
  99                         // And bind it to txAddress
 100                         DEBUG(binder_interface, "Bind the socket");
 101                         if (can_socket_.bind((struct sockaddr *)&txAddress_, sizeof(txAddress_)) < 0)
 102                                 ERROR(binder_interface, "Bind failed. %s", strerror(errno));
 103                         else return 0;
 104                 }
 105                 close();
 106         }
 107         else ERROR(binder_interface, "open: socket could not be created. Error was : %s", ::strerror(errno));
 108         return -1;
 109 }
 110
 111 /// @brief Close the bus.
 112 int can_bus_dev_t::close()
 113 {
 114         return can_socket_.close();
 115 }
 116
 117 /// @brief Read the can socket and retrieve canfd_frame
 118 can_message_t can_bus_dev_t::read()
 119 {
 120         ssize_t nbytes;
 121         struct canfd_frame cfd;
 122
 123         // Test that socket is really opened
 124         if (!can_socket_)
 125         {
 126                 ERROR(binder_interface, "read: Socket unavailable. Closing thread.");
 127                 is_running_ = false;
 128         }
 129
 130         nbytes = ::read(can_socket_.socket(), &cfd, CANFD_MTU);
 131
 132         // if we did not fit into CAN sized messages then stop_reading.
 133         if (nbytes != CANFD_MTU && nbytes != CAN_MTU)
 134         {
 135                 if (errno == ENETDOWN)
 136                         ERROR(binder_interface, "read: %s CAN device down", device_name_.c_str());
 137                 ERROR(binder_interface, "read: Incomplete CAN(FD) frame");
 138                 ::memset(&cfd, 0, sizeof(cfd));
 139         }
 140
 141         DEBUG(binder_interface, "read: Found id: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X", cfd.can_id, cfd.len,
 142                                                         cfd.data[0], cfd.data[1], cfd.data[2], cfd.data[3], cfd.data[4], cfd.data[5], cfd.data[6], cfd.data[7]);
 143         return can_message_t::convert_from_canfd_frame(cfd, nbytes);
 144 }
 145
 146 /// @brief start reading threads and set flag is_running_
 147 /// @param[in] can_bus reference can_bus_t. it will be passed to the thread to allow using can_bus_t queue.
 148 void can_bus_dev_t::start_reading(can_bus_t& can_bus)
 149 {
 150         DEBUG(binder_interface, "Launching reading thread");
 151         is_running_ = true;
 152         th_reading_ = std::thread(&can_bus_dev_t::can_reader, this, std::ref(can_bus));
 153         if(!th_reading_.joinable())
 154                 is_running_ = false;
 155 }
 156
 157 /// @brief stop the reading thread setting flag is_running_ to false and and wait that the thread finish its job.
 158 void can_bus_dev_t::stop_reading()
 159 {
 160         is_running_ = false;
 161 }
 162
 163 /// @brief Thread function used to read the can socket.
 164 /// @param[in] can_bus object to be used to read the can socket
 165 void can_bus_dev_t::can_reader(can_bus_t& can_bus)
 166 {
 167         while(is_running_)
 168         {
 169                 can_message_t msg = read();
 170                 {
 171                         std::lock_guard<std::mutex> can_message_lock(can_bus.get_can_message_mutex());
 172                         can_bus.push_new_can_message(msg);
 173                 }
 174                 can_bus.get_new_can_message_cv().notify_one();
 175         }
 176 }
 177
 178 /// @brief Send a can message from a can_message_t object.
 179 /// @param[in] can_msg the can message object to send
 180 int can_bus_dev_t::send(can_message_t& can_msg)
 181 {
 182         ssize_t nbytes;
 183         canfd_frame f;
 184
 185         f = can_msg.convert_to_canfd_frame();
 186
 187         if(can_socket_)
 188         {
 189                 nbytes = ::sendto(can_socket_.socket(), &f, sizeof(struct canfd_frame), 0,
 190                         (struct sockaddr*)&txAddress_, sizeof(txAddress_));
 191                 if (nbytes == -1)
 192                 {
 193                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
 194                         return -1;
 195                 }
 196                 return (int)nbytes;
 197         }
 198         else
 199         {
 200                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
 201                 open();
 202         }
 203         return 0;
 204 }
 205
 206 /// @brief Static method used to send diagnostic CAN message
 207 /// that follow isotp SendShimsMessage signature. This method is launched
 208 /// from diagnostic manager's' same name method. It will use the diagnostic
 209 /// manager configured CAN bus device to send the CAN message.
 210 ///
 211 /// @param[in] arbitration_id - CAN arbitration id.
 212 /// @param[in] data - CAN message payload to send
 213 /// @param[in] size - size of the data to send
 214 bool can_bus_dev_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
 215 {
 216         ssize_t nbytes;
 217         canfd_frame f;
 218
 219         f.can_id = arbitration_id;
 220         f.len = size;
 221         ::memcpy(f.data, data, size);
 222
 223         if(can_socket_)
 224         {
 225                 nbytes = ::sendto(can_socket_.socket(), &f, sizeof(struct canfd_frame), 0,
 226                         (struct sockaddr*)&txAddress_, sizeof(txAddress_));
 227                 if (nbytes == -1)
 228                 {
 229                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
 230                         return -1;
 231                 }
 232                 return (int)nbytes;
 233         }
 234         else
 235         {
 236                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
 237                 open();
 238         }
 239         return 0;
 240 }