src/can/can-message.hpp

   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 #pragma once
  19
  20 #include <vector>
  21 #include <string>
  22 #include <cstdint>
  23 #include <linux/can.h>
  24
  25 #include "utils/timer.hpp"
  26
  27 #define CAN_MESSAGE_SIZE 8
  28
  29 class can_bus_dev_t;
  30
  31 /**
  32  * @enum can_message_format_t
  33  * @brief The ID format for a CAN message.
  34  */
  35 enum class can_message_format_t {
  36         STANDARD, /*!< STANDARD - standard 11-bit CAN arbitration ID. */
  37         EXTENDED, /*!< EXTENDED - an extended frame, with a 29-bit arbitration ID. */
  38         ERROR,    /*!< ERROR - ERROR code used at initialization to signify that it isn't usable'*/
  39 };
  40
  41 /**
  42  * @class can_message_t
  43  *
  44  * @brief A compact representation of a single CAN message, meant to be used in in/out
  45  * buffers.
  46  */
  47 class can_message_t {
  48 private:
  49         uint8_t maxdlen_; /*!< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
  50         uint32_t id_; /*!< id_ - The ID of the message. */
  51         uint8_t length_; /*!< length_ - the length of the data array (max 8). */
  52         can_message_format_t format_; /*!< format_ - the format of the message's ID.*/
  53         bool rtr_flag_; /*!< rtr_flag_ - Telling if the frame has RTR flag positionned. Then frame hasn't data field*/
  54         uint8_t flags_; /*!< flags_ - flags of a CAN FD frame. Needed if we catch FD frames.*/
  55         std::vector<uint8_t> data_; /*!< data_ - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
  56
  57 public:
  58         can_message_t();
  59         can_message_t(uint8_t maxdlen, uint32_t id, uint8_t length, can_message_format_t format, bool rtr_flag_, uint8_t flags, std::vector<uint8_t> data);
  60
  61         uint32_t get_id() const;
  62         bool get_rtr_flag_() const;
  63         can_message_format_t get_format() const;
  64         uint8_t get_flags() const;
  65         const uint8_t* get_data() const;
  66         uint8_t get_length() const;
  67
  68         void set_format(const can_message_format_t new_format);
  69
  70         bool is_correct_to_send();
  71
  72 static can_message_t convert_from_canfd_frame(const struct canfd_frame& frame, size_t nbytes);
  73         canfd_frame convert_to_canfd_frame();
  74 };
  75
  76 /**
  77  * @class can_message_definition_t
  78  *
  79  * @brief The definition of a CAN message. This includes a lot of metadata, so
  80  * to save memory this struct should not be used for storing incoming and
  81  * outgoing CAN messages.
  82  */
  83 class can_message_definition_t
  84 {
  85         private:
  86         can_bus_dev_t& bus_; /*!< bus_ - A pointer to the bus this message is on. */
  87         uint32_t id_; /*!< id_ - The ID of the message.*/
  88         can_message_format_t format_; /*!< format_ - the format of the message's ID.*/
  89         frequency_clock_t clock_; /*!<  clock_ - an optional frequency clock to control the output of this
  90                                                         *      message, if sent raw, or simply to mark the max frequency for custom
  91                                                         *      handlers to retrieve.*/
  92         bool force_send_changed_; /*!< force_send_changed_ - If true, regardless of the frequency, it will send CAN
  93                                                          *      message if it has changed when using raw passthrough.*/
  94         std::vector<uint8_t> last_value_; /*!< last_value_ - The last received value of the message. Defaults to undefined.
  95                                                                                   *     This is required for the forceSendChanged functionality, as the stack
  96                                                                                   *     needs to compare an incoming CAN message with the previous frame.*/
  97
  98         public:
  99           can_message_definition_t(can_bus_dev_t& cbd);
 100                 uint32_t get_id() const;
 101 };
 102
 103 /** Public: Retrive a list of all possible CAN configurations.
 104  *
 105  * Returns a pointer to an array of all configurations.
 106  */
 107 can_message_set_t* getMessageSets();
 108
 109 /** Public: Return the length of the array returned by getMessageSets() */
 110 int getMessageSetCount();
 111
 112 /* Public: Return an array of all CAN messages to be processed in the active
 113  * configuration.
 114  */
 115 can_message_definition_t* getMessages();
 116
 117 /* Public: Return the length of the array returned by getMessages(). */
 118 int getMessageCount();