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