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