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 "can/can-bus.hpp"
  26 #include "utils/timer.hpp"
  27
  28 #define CAN_MESSAGE_SIZE 8
  29
  30 /**
  31  * @enum CanMessageFormat
  32  * @brief The ID format for a CAN message.
  33  */
  34 class enum CanMessageFormat {
  35         STANDARD, /*!< STANDARD - standard 11-bit CAN arbitration ID. */
  36         EXTENDED, /*!< EXTENDED - an extended frame, with a 29-bit arbitration ID. */
  37         ERROR,    /*!< ERROR - ERROR code used at initialization to signify that it isn't usable'*/
  38 };
  39
  40 /*************************
  41  * old CanMessage struct *
  42  *************************
  43 struct CanMessage {
  44         uint32_t id;
  45         CanMessageFormat format;
  46         uint8_t data[CAN_MESSAGE_SIZE];
  47         uint8_t length;
  48 };
  49 typedef struct CanMessage CanMessage;
  50 */
  51
  52 /**
  53  * @class can_message_t
  54  *
  55  * @brief A compact representation of a single CAN message, meant to be used in in/out
  56  * buffers.
  57  */
  58 class can_message_t {
  59         private:
  60                 uint32_t id_; /*!< id_ - The ID of the message. */
  61                 bool rtr_flag_; /*!< rtr_flag_ - Telling if the frame has RTR flag positionned. Then frame hasn't data field*/
  62                 uint8_t length_; /*!< length_ - the length of the data array (max 8). */
  63                 uint8_t flags_; /*!< flags_ - flags of a CAN FD frame. Needed if we catch FD frames.*/
  64                 CanMessageFormat format_; /*!< format_ - the format of the message's ID.*/
  65                 std::vector<uint8_t> data_; /*!< data_ - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
  66
  67                 uint8_t maxdlen_; /*!< maxdlen_ - Max data length deduce from number of bytes read from the socket.*/
  68
  69         public:
  70                 can_message_t();
  71
  72                 uint32_t get_id() const;
  73                 bool get_rtr_flag_() const;
  74                 int get_format() const;
  75                 uint8_t get_flags() const;
  76                 const uint8_t* get_data() const;
  77                 uint8_t get_length() const;
  78
  79                 void set_format(const CanMessageFormat new_format);
  80
  81                 bool is_correct_to_send();
  82
  83     static can_message_t convert_to_canfd_frame(const struct canfd_frame& frame, size_t nbytes);
  84                 canfd_frame convert_to_canfd_frame();
  85 };
  86
  87 /**
  88  * @struct CanMessageDefinition
  89  *
  90  * @brief The definition of a CAN message. This includes a lot of metadata, so
  91  * to save memory this struct should not be used for storing incoming and
  92  * outgoing CAN messages.
  93  */
  94 struct CanMessageDefinition {
  95         //can_bus_dev_t bus; /*!< bus - A pointer to the bus this message is on. */
  96         uint32_t id; /*!<  id - The ID of the message.*/
  97         CanMessageFormat format; /*!< format - the format of the message's ID.*/
  98         FrequencyClock frequencyClock; /*!<  clock - an optional frequency clock to control the output of this
  99                                                                         *       message, if sent raw, or simply to mark the max frequency for custom
 100                                                                         *       handlers to retriec++ if ? syntaxve.*/
 101         bool forceSendChanged; /*!< forceSendChanged - If true, regardless of the frequency, it will send CAN
 102                                                         *       message if it has changed when using raw passthrough.*/
 103         uint8_t lastValue[CAN_MESSAGE_SIZE]; /*!< lastValue - The last received value of the message. Defaults to undefined.
 104                                                                                 *       This is required for the forceSendChanged functionality, as the stack
 105                                                                                 *       needs to compare an incoming CAN message with the previous frame.*/
 106 };
 107 typedef struct CanMessageDefinition CanMessageDefinition;
 108
 109 class can_message_definition_t
 110 {
 111         private:
 112         can_bus_dev_t& bus_; /*!< bus_ - A pointer to the bus this message is on. */
 113         uint32_t id_; /*!< id_ - The ID of the message.*/
 114         CanMessageFormat format_; /*!< format_ - the format of the message's ID.*/
 115         FrequencyClock clock_; /*!<  clock_ - an optional frequency clock to control the output of this
 116                                                         *       message, if sent raw, or simply to mark the max frequency for custom
 117                                                         *       handlers to retriec++ if ? syntaxve.*/
 118         bool force_send_changed_; /*!< force_send_changed_ - If true, regardless of the frequency, it will send CAN
 119                                                          *      message if it has changed when using raw passthrough.*/
 120         uint8_t last_value_[CAN_MESSAGE_SIZE]; /*!< last_value_ - The last received value of the message. Defaults to undefined.
 121                                                                                   *     This is required for the forceSendChanged functionality, as the stack
 122                                                                                   *     needs to compare an incoming CAN message with the previous frame.*/
 123
 124         public:
 125                 uint32_t get_id();
 126 };
 127
 128 /**
 129  * @struct CanMessageSet
 130  *
 131  * @brief A parent wrapper for a particular set of CAN messages and associated
 132  *      CAN buses(e.g. a vehicle or program).
 133  */
 134  typedef struct {
 135         uint8_t index; /*!<index - A numerical ID for the message set, ideally the index in an array
 136                                         *       for fast lookup*/
 137         const std::string name; /*!< name - The name of the message set.*/
 138         uint8_t busCount; /*!< busCount - The number of CAN buses defined for this message set.*/
 139         unsigned short messageCount; /*!< messageCount - The number of CAN messages (across all buses) defined for
 140                                                                         *       this message set.*/
 141         unsigned short signalCount; /*!< signalCount - The number of CAN signals (across all messages) defined for
 142                                                                 *       this message set.*/
 143         unsigned short commandCount; /*!< commandCount - The number of CanCommmands defined for this message set.*/
 144 } CanMessageSet;
 145
 146 class can_message_set_t
 147 {
 148         private:
 149                 uint8_t index_; /*!<index_ - A numerical ID for the message set, ideally the index in an array
 150                                                 *       for fast lookup*/
 151                 const std::string name_; /*!< name_ - The name of the message set.*/
 152                 uint8_t can_bus_count_; /*!< can_bus_count_ - The number of CAN buses defined for this message set.*/
 153                 unsigned short can_message_count_; /*!< can_message_count_ - The number of CAN messages (across all buses) defined for
 154                                                                                 *       this message set.*/
 155                 unsigned short can_signal_count_; /*!< can_signal_count_ - The number of CAN signals (across all messages) defined for
 156                                                                         *       this message set.*/
 157                 unsigned short can_command_count_; /*!< can_command_count_ - The number of CanCommmands defined for this message set.*/
 158                 unsigned short obd2_signal_count_; /*!< obd2_signal_count_ - The number of obd2 signals defined for this message set.*/
 159 };
 160
 161 /** Public: Return the currently active CAN configuration. */
 162 CanMessageSet* getActiveMessageSet();
 163
 164 /** Public: Retrive a list of all possible CAN configurations.
 165  *
 166  * Returns a pointer to an array of all configurations.
 167  */
 168 CanMessageSet* getMessageSets();
 169
 170 /** Public: Return the length of the array returned by getMessageSets() */
 171 int getMessageSetCount();
 172
 173 /* Public: Return an array of all CAN messages to be processed in the active
 174  * configuration.
 175  */
 176 CanMessageDefinition* getMessages();
 177
 178 /* Public: Return the length of the array returned by getMessages(). */
 179 int getMessageCount();