low-can-binding/can/message/can-message.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include "./can-message.hpp"
  19
  20 #include <cstring>
  21
  22 #include "../../binding/low-can-hat.hpp"
  23
  24 ///
  25 /// @brief Class constructor
  26 ///
  27 /// can_message_t class constructor.
  28 ///
  29 can_message_t::can_message_t()
  30         : message_t(),
  31          id_{0},
  32          rtr_flag_{false}
  33 {}
  34
  35 can_message_t::can_message_t(uint32_t maxdlen,
  36         uint32_t id,
  37         uint32_t length,
  38         bool rtr_flag,
  39         uint32_t flags,
  40         std::vector<uint8_t>& data,
  41         uint64_t timestamp)
  42         : message_t(maxdlen, length, flags, data, timestamp),
  43         id_{id},
  44         rtr_flag_{rtr_flag}
  45 {}
  46
  47 ///
  48 /// @brief Retrieve id_ member value.
  49 ///
  50 /// @return id_ class member
  51 ///
  52 uint32_t can_message_t::get_id() const
  53 {
  54         return id_;
  55 }
  56
  57
  58 void can_message_t::set_id(const canid_t id)
  59 {
  60         id_ = id;
  61 }
  62
  63 /// @brief Control whether the object is correctly initialized
  64 ///  to be sent over the CAN bus
  65 ///
  66 /// @return True if object correctly initialized and false if not.
  67 bool can_message_t::is_correct_to_send()
  68 {
  69         if (id_ != 0 && length_ != 0 && !(flags_&INVALID_FLAG))
  70         {
  71                 int i;
  72                 for(i=0;i<length_;i++)
  73                         if(data_[i] != 0)
  74                                 return true;
  75         }
  76         return false;
  77 }
  78
  79 /// @brief Take a canfd_frame struct to initialize class members
  80 ///
  81 /// This is the preferred way to initialize class members.
  82 ///
  83 /// @param[in] frame - canfd_frame to convert coming from a read of CAN socket
  84 /// @param[in] nbytes - bytes read from socket read operation.
  85 ///
  86 /// @return A can_message_t object fully initialized with canfd_frame values.
  87 std::shared_ptr<can_message_t> can_message_t::convert_from_frame(const struct canfd_frame& frame, size_t nbytes, uint64_t timestamp)
  88 {
  89         uint32_t maxdlen = 0, length = 0;
  90         uint32_t flags = 0;
  91         uint32_t id;
  92         bool rtr_flag;
  93         std::vector<uint8_t> data;
  94
  95         switch(nbytes)
  96         {
  97                 case CANFD_MTU:
  98                         AFB_DEBUG("Got an CAN FD frame");
  99                         maxdlen = CANFD_MAX_DLEN;
 100                         break;
 101                 case CAN_MTU:
 102                         AFB_DEBUG("Got a legacy CAN frame");
 103                         maxdlen = CAN_MAX_DLEN;
 104                         break;
 105                 default:
 106                         AFB_ERROR("unsupported CAN frame");
 107                         break;
 108         }
 109
 110         if (frame.can_id & CAN_ERR_FLAG)
 111         {
 112                 flags = flags|INVALID_FLAG;
 113                 id = frame.can_id & (CAN_ERR_MASK|CAN_ERR_FLAG);
 114         }
 115         else if (frame.can_id & CAN_EFF_FLAG)
 116         {
 117                 id = frame.can_id & CAN_EFF_MASK;
 118         }
 119         else
 120         {
 121                 id = frame.can_id & CAN_SFF_MASK;
 122         }
 123
 124         /* Overwrite length_ if RTR flags is detected.
 125          * standard CAN frames may have RTR enabled. There are no ERR frames with RTR */
 126         if (frame.can_id & CAN_RTR_FLAG)
 127         {
 128                 rtr_flag = true;
 129                 if(frame.len && frame.len <= CAN_MAX_DLC)
 130                 {
 131                         if(rtr_flag)
 132                                 length = frame.len& 0xF;
 133                         else
 134                         {
 135                                 length = (frame.len > maxdlen) ? maxdlen : frame.len;
 136                         }
 137                 }
 138         }
 139         else
 140         {
 141                 length = (frame.len > maxdlen) ? maxdlen : frame.len;
 142
 143                 /* Flags field only present for CAN FD frames*/
 144                 /*if(maxdlen == CANFD_MAX_DLEN)
 145                                 flags = frame.flags & 0xF;*/
 146
 147                 if (data.capacity() < maxdlen)
 148                         data.reserve(maxdlen);
 149                                 int i;
 150
 151                         data.clear();
 152                         /* maxdlen_ is now set at CAN_MAX_DLEN or CANFD_MAX_DLEN, respectively 8 and 64 bytes*/
 153                         for(i=0;i<maxdlen;i++)
 154                         {
 155                                 data.push_back(frame.data[i]);
 156                         };
 157
 158                 AFB_DEBUG("Found id: %X, format: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X",
 159                                                                 id, (uint32_t)flags, length, data[0], data[1], data[2], data[3], data[4], data[5], data[6], data[7]);
 160         }
 161
 162         return std::make_shared<can_message_t>(can_message_t(maxdlen, id, length, rtr_flag, flags, data, timestamp));
 163 }
 164
 165 /// @brief Take all initialized class members and build a
 166 /// canfd_frame struct that can be use to send a CAN message over
 167 /// the bus.
 168 ///
 169 /// @return canfd_frame struct built from class members.
 170 struct canfd_frame can_message_t::convert_to_canfd_frame()
 171 {
 172         canfd_frame frame;
 173
 174         if(is_correct_to_send())
 175         {
 176                 frame.can_id = get_id();
 177                 frame.len = (uint8_t) get_length();
 178                 ::memcpy(frame.data, get_data(), length_);
 179         }
 180         else
 181                 AFB_ERROR("can_message_t not correctly initialized to be sent");
 182
 183         return frame;
 184 }
 185
 186 /// @brief Take all initialized class members and build a
 187 /// canfd_frame struct that can be use to send a CAN message over
 188 /// the bus.
 189 ///
 190 /// @return canfd_frame struct built from class members.
 191 struct std::vector<canfd_frame> can_message_t::convert_to_canfd_frame_vector()
 192 {
 193         std::vector<canfd_frame> ret;
 194         if(is_correct_to_send())
 195         {
 196                 if(flags_ & CAN_FD_FRAME)
 197                 {
 198                         int i=0;
 199                         do
 200                         {
 201                                 canfd_frame frame;
 202                                 frame.can_id = id_;
 203                                 frame.len = 64;
 204                                 std::vector<uint8_t> data = get_data_vector((i*64),(i*64)+63);
 205                                 if(data.size()<64)
 206                                 {
 207                                         ::memset(frame.data,0,sizeof(frame.data));
 208                                         ::memcpy(frame.data,data.data(),data.size());
 209                                 }
 210                                 else
 211                                 {
 212                                         ::memcpy(frame.data,data.data(),64);
 213                                 }
 214                                 ret.push_back(frame);
 215                                 i++;
 216                         } while (i<(length_ >> 6));
 217                 }
 218                 else
 219                 {
 220                         int i=0;
 221                         do
 222                         {
 223                                 canfd_frame frame;
 224                                 frame.can_id = id_;
 225                                 frame.len = 8;
 226                                 std::vector<uint8_t> data = get_data_vector(i*8,(i*8)+7);
 227                                 if(data.size()<8)
 228                                 {
 229                                         ::memset(frame.data,0,sizeof(frame.data));
 230                                         ::memcpy(frame.data,data.data(),data.size());
 231                                 }
 232                                 else
 233                                 {
 234                                         ::memset(frame.data,0,sizeof(frame.data));
 235                                         ::memcpy(frame.data,data.data(),8);
 236                                 }
 237                                 ret.push_back(frame);
 238                                 i++;
 239                         } while (i<(length_ >> 3));
 240                 }
 241         }
 242         else
 243                 AFB_ERROR("can_message_t not correctly initialized to be sent");
 244
 245         return ret;
 246 }
 247
 248 /// @brief Take all initialized class members and build a
 249 /// can_frame struct that can be use to send a CAN message over
 250 /// the bus.
 251 ///
 252 /// @return can_frame struct built from class members.
 253 struct can_frame can_message_t::convert_to_can_frame()
 254 {
 255         can_frame frame;
 256
 257         if(is_correct_to_send())
 258         {
 259                 frame.can_id = get_id();
 260                 frame.can_dlc = (uint8_t) get_length();
 261                 ::memcpy(frame.data, get_data(), length_);
 262         }
 263         else
 264                 AFB_ERROR("can_message_t not correctly initialized to be sent");
 265
 266         return frame;
 267 }
 268
 269 bool can_message_t::is_set()
 270 {
 271         return (id_ != 0 && length_ != 0);
 272 }
 273
 274 std::string can_message_t::get_debug_message()
 275 {
 276         std::string ret = "";
 277         ret = ret + "Here is the next can message : id " + std::to_string(id_)  + " length " + std::to_string(length_) + ", data ";
 278         for (size_t i = 0; i < data_.size(); i++)
 279         {
 280                 ret = ret + std::to_string(data_[i]);
 281         }
 282
 283         return ret;
 284 }
 285
 286 struct bcm_msg& can_message_t::get_bcm_msg()
 287 {
 288         return bcm_msg_;
 289 }
 290
 291 void can_message_t::set_bcm_msg(struct bcm_msg bcm_msg)
 292 {
 293         bcm_msg_ = bcm_msg;
 294 }