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 #include <linux/can/bcm.h>
  24 #include <cmath>
  25
  26 #include "can-bus.hpp"
  27 #include "can-message.hpp"
  28 #include "../low-can-binding.hpp"
  29 #include "canutil/write.h"
  30 #include "../bitfield/bitfield.h"
  31
  32 /// @brief Class constructor
  33 ///
  34 /// @param[in] dev_name - String representing the device name into the linux /dev tree
  35 /// @param[in] index - integer identifier of the bus, set using init_can_dev from can_bus_t.
  36 can_bus_dev_t::can_bus_dev_t(const std::string& dev_name, int index)
  37         : device_name_{dev_name}, index_{index}
  38 {}
  39
  40 std::string can_bus_dev_t::get_device_name() const
  41 {
  42         return device_name_;
  43 }
  44
  45 int can_bus_dev_t::get_index() const
  46 {
  47         return index_;
  48 }
  49 utils::socketcan_t& can_bus_dev_t::get_socket()
  50 {
  51         return can_socket_;
  52 }
  53
  54 /// @brief Open the can socket and returning it
  55 ///
  56 ///  We try to open CAN socket and apply the following options
  57 ///  timestamp received messages and pass the socket to FD mode.
  58 ///
  59 /// @return socket value or -1 if something wrong.
  60 int can_bus_dev_t::open()
  61 {
  62         return can_socket_.open(device_name_);
  63 }
  64
  65 /// @brief Set some option on the socket, timestamp and canfd frame usage.
  66 void can_bus_dev_t::configure()
  67 {
  68         if (can_socket_)
  69         {
  70                 const int timestamp_on = 1;
  71
  72                 DEBUG(binder_interface, "%s: CAN Handler socket correctly initialized : %d", __FUNCTION__, can_socket_.socket());
  73                 if (can_socket_.setopt(SOL_SOCKET, SO_TIMESTAMP, &timestamp_on, sizeof(timestamp_on)) < 0)
  74                         WARNING(binder_interface, "%s: setsockopt SO_TIMESTAMP error: %s", __FUNCTION__, ::strerror(errno));
  75         }
  76         else
  77         {
  78                 ERROR(binder_interface, "open_raw: socket could not be created. Error was : %s", ::strerror(errno));
  79         }
  80 }
  81
  82 /// @brief Close the bus.
  83 ///
  84 /// @return interger return value of socket.close() function
  85 int can_bus_dev_t::close()
  86 {
  87         return can_socket_.close();
  88 }
  89
  90 /// @brief Read the can socket and retrieve canfd_frame.
  91 ///
  92 ///  Read operation are blocking and we try to read CANFD frame
  93 ///  rather than classic CAN frame. CANFD frame are retro compatible.
  94 can_message_t can_bus_dev_t::read()
  95 {
  96         ssize_t nbytes;
  97         struct canfd_frame cfd;
  98
  99         // Test that socket is really opened
 100         if (!can_socket_)
 101         {
 102                 ERROR(binder_interface, "read: Socket unavailable. Closing thread.");
 103                 is_running_ = false;
 104         }
 105
 106         nbytes = ::read(can_socket_.socket(), &cfd, CANFD_MTU);
 107
 108         // if we did not fit into CAN sized messages then stop_reading.
 109         if (nbytes != CANFD_MTU && nbytes != CAN_MTU)
 110         {
 111                 if (errno == ENETDOWN)
 112                         ERROR(binder_interface, "read: %s CAN device down", device_name_.c_str());
 113                 ERROR(binder_interface, "read: Incomplete CAN(FD) frame");
 114                 ::memset(&cfd, 0, sizeof(cfd));
 115         }
 116
 117         DEBUG(binder_interface, "%s: Found id: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X", __FUNCTION__, cfd.can_id, cfd.len,
 118                                                         cfd.data[0], cfd.data[1], cfd.data[2], cfd.data[3], cfd.data[4], cfd.data[5], cfd.data[6], cfd.data[7]);
 119         return can_message_t::convert_from_canfd_frame(cfd, nbytes);
 120 }
 121
 122 /// @brief Create a RX_SETUP receive job using the BCM socket.
 123 ///
 124 /// @return 0 if ok else -1
 125 int can_bus_dev_t::create_rx_filter(const can_signal_t& s)
 126 {
 127         uint32_t can_id  = s.get_message().get_id();
 128
 129         struct utils::canfd_bcm_msg bcm_msg;
 130
 131         uint8_t bit_size = s.get_bit_size();
 132         float val = (float)exp2(bit_size)-1;
 133
 134         bcm_msg.msg_head.opcode  = RX_SETUP;
 135         bcm_msg.msg_head.can_id  = can_id;
 136         bcm_msg.msg_head.nframes = 1;
 137         bitfield_encode_float(val, s.get_bit_position(), bit_size, s.get_factor(), s.get_offset(), bcm_msg.frames[0].data, CANFD_MAX_DLEN);
 138
 139         if(can_socket_ << bcm_msg)
 140                 return 0;
 141         return -1;
 142 }
 143
 144 /// @brief start reading threads and set flag is_running_
 145 /// @param[in] can_bus reference can_bus_t. it will be passed to the thread to allow using can_bus_t queue.
 146 void can_bus_dev_t::start_reading(can_bus_t& can_bus)
 147 {
 148         DEBUG(binder_interface, "%s: Launching reading thread", __FUNCTION__);
 149         is_running_ = true;
 150         th_reading_ = std::thread(&can_bus_dev_t::can_reader, this, std::ref(can_bus));
 151         if(!th_reading_.joinable())
 152                 is_running_ = false;
 153 }
 154
 155 /// @brief stop the reading thread setting flag is_running_ to false and and wait that the thread finish its job.
 156 void can_bus_dev_t::stop_reading()
 157 {
 158         is_running_ = false;
 159 }
 160
 161 /// @brief Thread function used to read the can socket.
 162 /// @param[in] can_bus - object to be used to read the can socket
 163 void can_bus_dev_t::can_reader(can_bus_t& can_bus)
 164 {
 165         while(is_running_)
 166         {
 167                 can_message_t msg = read();
 168                 {
 169                         std::lock_guard<std::mutex> can_message_lock(can_bus.get_can_message_mutex());
 170                         can_bus.push_new_can_message(msg);
 171                 }
 172                 can_bus.get_new_can_message_cv().notify_one();
 173         }
 174 }
 175
 176 /// @brief Send a can message from a can_message_t object.
 177 /// @param[in] can_msg - the can message object to send
 178 ///
 179 /// @return 0 if message snet, -1 if something wrong.
 180 int can_bus_dev_t::send(can_message_t& can_msg)
 181 {
 182         canfd_frame f;
 183         f = can_msg.convert_to_canfd_frame();
 184
 185         if(can_socket_)
 186         {
 187                 can_socket_ << f;
 188                 if(!can_socket_)
 189                 {
 190                         ERROR(binder_interface, "%s: Sending CAN frame failed.", __FUNCTION__);
 191                         return -1;
 192                 }
 193         }
 194         else
 195         {
 196                 ERROR(binder_interface, "%s: socket not initialized. Attempt to reopen can device socket.", __FUNCTION__);
 197                 open();
 198                 return -1;
 199         }
 200         return 0;
 201 }
 202
 203 /// @brief Static method used to send diagnostic CAN message
 204 /// that follow isotp SendShimsMessage signature. This method is launched
 205 /// from diagnostic manager's' same name method. It will use the diagnostic
 206 /// manager configured CAN bus device to send the CAN message.
 207 ///
 208 /// @param[in] arbitration_id - CAN arbitration id.
 209 /// @param[in] data - CAN message payload to send
 210 /// @param[in] size - size of the data to send
 211 ///
 212 /// @return True if message sent, false if not.
 213 bool can_bus_dev_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
 214 {
 215         canfd_frame f;
 216
 217         f.can_id = arbitration_id;
 218         f.len = size;
 219         ::memcpy(f.data, data, size);
 220
 221         if(can_socket_)
 222         {
 223                 can_socket_ << f;
 224                 if (!can_socket_)
 225                 {
 226                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
 227                         return false;
 228                 }
 229         }
 230         else
 231         {
 232                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
 233                 open();
 234                 return false;
 235         }
 236         return true;
 237 }