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