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