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