src/can-utils.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 <map>
  21 #include <queue>
  22 #include <vector>
  23 #include <cstdio>
  24 #include <string>
  25 #include <thread>
  26 #include <fcntl.h>
  27 #include <unistd.h>
  28 #include <net/if.h>
  29 #include <sys/ioctl.h>
  30 #include <linux/can.h>
  31 #include <sys/socket.h>
  32 #include <linux/can/raw.h>
  33
  34 #include "timer.hpp"
  35 #include "openxc.pb.h"
  36
  37 extern "C"
  38 {
  39         #include <afb/afb-binding.h>
  40         #include <afb/afb-service-itf.h>
  41 }
  42
  43 // TODO actual max is 32 but dropped to 24 for memory considerations
  44 #define MAX_ACCEPTANCE_FILTERS 24
  45 // TODO this takes up a ton of memory
  46 #define MAX_DYNAMIC_MESSAGE_COUNT 12
  47
  48 #define CAN_MESSAGE_SIZE 8
  49
  50 #define CAN_ACTIVE_TIMEOUT_S 30
  51
  52 /**
  53  * @brief Function representing thread activated by can bus objects
  54  */
  55 void can_reader(can_bus_dev_t& can_bus);
  56 void can_decode_message(can_bus_t& can_bus);
  57 void can_event_push(can_bus_t& can_bus);
  58
  59 /**
  60  * @brief The type signature for a CAN signal decoder.
  61  *
  62  * @desc A SignalDecoder transforms a raw floating point CAN signal into a number,
  63  * string or boolean.
  64  *
  65  * @param[in] CanSignal signal - The CAN signal that we are decoding.
  66  * @param[in] CanSignal signals - The list of all signals.
  67  * @param[in] int signalCount - The length of the signals array.
  68  * @param[in] float value - The CAN signal parsed from the message as a raw floating point
  69  *      value.
  70  * @param[out] bool send - An output parameter. If the decoding failed or the CAN signal should
  71  *      not send for some other reason, this should be flipped to false.
  72  *
  73  * @return a decoded value in an openxc_DynamicField struct.
  74  */
  75 typedef openxc_DynamicField (*SignalDecoder)(struct CanSignal* signal,
  76                 CanSignal* signals, int signalCount, float value, bool* send);
  77
  78 /**
  79  * @brief: The type signature for a CAN signal encoder.
  80  *
  81  * @desc A SignalEncoder transforms a number, string or boolean into a raw floating
  82  * point value that fits in the CAN signal.
  83  *
  84  * @params[signal] - The CAN signal to encode.
  85  * @params[value] - The dynamic field to encode.
  86  * @params[send] - An output parameter. If the encoding failed or the CAN signal should
  87  * not be encoded for some other reason, this will be flipped to false.
  88  */
  89 typedef uint64_t (*SignalEncoder)(struct CanSignal* signal,
  90                 openxc_DynamicField* value, bool* send);
  91
  92 /**
  93  * @brief The ID format for a CAN message.
  94  *
  95  * STANDARD - standard 11-bit CAN arbitration ID.
  96  * EXTENDED - an extended frame, with a 29-bit arbitration ID.
  97  */
  98 enum CanMessageFormat {
  99         STANDARD,
 100         EXTENDED,
 101 };
 102 typedef enum CanMessageFormat CanMessageFormat;
 103
 104 /**
 105  * @brief A compact representation of a single CAN message, meant to be used in in/out
 106  * buffers.
 107  *
 108  * param[in] uint32_t id - The ID of the message.
 109  * param[in] CanMessageFormat format - the format of the message's ID.
 110  * param[in] uint8_t data  - The message's data field.
 111  * @param[in] uint8_t length - the length of the data array (max 8).
 112 *************************
 113 * old CanMessage struct *
 114 *************************
 115 struct CanMessage {
 116         uint32_t id;
 117         CanMessageFormat format;
 118         uint8_t data[CAN_MESSAGE_SIZE];
 119         uint8_t length;
 120 };
 121 typedef struct CanMessage CanMessage;
 122 */
 123 class can_message_t {
 124         private:
 125                 const struct afb_binding_interface *interface_;
 126                 uint32_t id_;
 127                 CanMessageFormat format_;
 128                 uint8_t data_[CAN_MESSAGE_SIZE];
 129                 uint8_t length_;
 130
 131         public:
 132                 uint32_t get_id() const;
 133                 int get_format() const;
 134                 uint8_t get_data() const;
 135                 uint8_t get_lenght() const;
 136
 137                 void set_id(uint32_t id);
 138                 void set_format(CanMessageFormat format);
 139                 void set_data(uint8_t data);
 140                 void set_lenght(uint8_t length);
 141
 142                 void convert_from_canfd_frame(canfd_frame frame);
 143                 canfd_frame convert_to_canfd_frame();
 144 };
 145
 146 /**
 147  * @brief Object representing a can device. Handle opening, closing and reading on the
 148  * socket. This is the low level object to be use by can_bus_t.
 149  *
 150  * @params[in] std::string device_name_ - name of the linux device handling the can bus. Generally vcan0, can0, etc.
 151  */
 152 class can_bus_dev_t {
 153         private:
 154                 std::string device_name_;
 155                 int can_socket_;
 156                 bool is_fdmode_on_;
 157                 struct sockaddr_can txAddress_;
 158
 159                 bool has_can_message_;
 160                 std::queue <can_message_t> can_message_q_;
 161
 162                 std::thread th_reading_;
 163                 bool is_running_;
 164
 165         public:
 166                 can_bus_dev_t(const std::string& dev_name);
 167
 168                 int open(const struct afb_binding_interface* interface);
 169                 int close();
 170                 bool is_running();
 171                 void start_reading();
 172                 canfd_frame read(const struct afb_binding_interface *interface);
 173
 174                 can_message_t next_can_message();
 175                 void push_new_can_message(const can_message_t& can_msg);
 176                 bool has_can_message() const;
 177 };
 178
 179 /**
 180  * @brief Object used to handle decoding and manage event queue to be pushed.
 181  *
 182  * @params[in] interface_ - afb_binding_interface pointer to the binder. Used to log messages
 183  * @params[in] conf_file_ - configuration file handle used to initialize can_bus_dev_t objects.
 184  */
 185 class can_bus_t {
 186         private:
 187                 const struct afb_binding_interface *interface_;
 188                 int conf_file_;
 189
 190                 std::thread th_decoding_;
 191                 std::thread th_pushing_;
 192
 193                 bool has_vehicle_message_;
 194                 std::queue <openxc_VehicleMessage> vehicle_message_q_;
 195
 196         public:
 197                 can_bus_t(const struct afb_binding_interface *itf, int& conf_file);
 198                 int init_can_dev();
 199                 std::vector<std::string> read_conf();
 200
 201                 void start_threads();
 202
 203                 int send_can_message(can_message_t can_msg);
 204
 205                 openxc_VehicleMessage& next_vehicle_message();
 206                 void push_new_vehicle_message(const openxc_VehicleMessage& v_msg);
 207                 bool has_vehicle_message() const;
 208 };
 209
 210 /**
 211  * @brief A state encoded (SED) signal's mapping from numerical values to
 212  * OpenXC state names.
 213  *
 214  * @param[in] in value - The integer value of the state on the CAN bus.
 215  * @param[in] char* name  - The corresponding string name for the state in OpenXC.
 216  */
 217 struct CanSignalState {
 218         const int value;
 219         const char* name;
 220 };
 221 typedef struct CanSignalState CanSignalState;
 222
 223 /**
 224  * @brief A CAN signal to decode from the bus and output over USB.
 225  *
 226  * @param[in] message      - The message this signal is a part of.
 227  * @param[in] genericName - The name of the signal to be output over USB.
 228  * @param[in] bitPosition - The starting bit of the signal in its CAN message (assuming
 229  *                               non-inverted bit numbering, i.e. the most significant bit of
 230  *                               each byte is 0)
 231  * @param[in] bitSize      - The width of the bit field in the CAN message.
 232  * @param[in] factor       - The final value will be multiplied by this factor. Use 1 if you
 233  *                               don't need a factor.
 234  * @param[in] offset       - The final value will be added to this offset. Use 0 if you
 235  *                               don't need an offset.
 236  * @param[in] minValue    - The minimum value for the processed signal.
 237  * @param[in] maxValue    - The maximum value for the processed signal.
 238  * @param[in] frequencyClock - A FrequencyClock struct to control the maximum frequency to
 239  *                              process and send this signal. To process every value, set the
 240  *                              clock's frequency to 0.
 241  * @param[in] sendSame    - If true, will re-send even if the value hasn't changed.
 242  * @param[in] forceSendChanged - If true, regardless of the frequency, it will send the
 243  *                              value if it has changed.
 244  * @param[in] states       - An array of CanSignalState describing the mapping
 245  *                               between numerical and string values for valid states.
 246  * @param[in] stateCount  - The length of the states array.
 247  * @param[in] writable    - True if the signal is allowed to be written from the USB host
 248  *                               back to CAN. Defaults to false.
 249  * @param[in] decoder      - An optional function to decode a signal from the bus to a human
 250  *                              readable value. If NULL, the default numerical decoder is used.
 251  * @param[in] encoder      - An optional function to encode a signal value to be written to
 252  *                                CAN into a byte array. If NULL, the default numerical encoder
 253  *                                is used.
 254  * @param[in] received    - True if this signal has ever been received.
 255  * @param[in] lastValue   - The last received value of the signal. If 'received' is false,
 256  *              this value is undefined.
 257  */
 258 struct CanSignal {
 259         struct CanMessageDefinition* message;
 260         const char* genericName;
 261         uint8_t bitPosition;
 262         uint8_t bitSize;
 263         float factor;
 264         float offset;
 265         float minValue;
 266         float maxValue;
 267         FrequencyClock frequencyClock;
 268         bool sendSame;
 269         bool forceSendChanged;
 270         const CanSignalState* states;
 271         uint8_t stateCount;
 272         bool writable;
 273         SignalDecoder decoder;
 274         SignalEncoder encoder;
 275         bool received;
 276         float lastValue;
 277 };
 278 typedef struct CanSignal CanSignal;
 279
 280 /**
 281  * @brief The definition of a CAN message. This includes a lot of metadata, so
 282  * to save memory this struct should not be used for storing incoming and
 283  * outgoing CAN messages.
 284  *
 285  * @param[in] bus - A pointer to the bus this message is on.
 286  * @param[in] id - The ID of the message.
 287  * @param[in] format - the format of the message's ID.
 288  * @param[in] clock - an optional frequency clock to control the output of this
 289  *              message, if sent raw, or simply to mark the max frequency for custom
 290  *              handlers to retrieve.
 291  * @param[in] forceSendChanged - If true, regardless of the frequency, it will send CAN
 292  *              message if it has changed when using raw passthrough.
 293  * @param[in] lastValue - The last received value of the message. Defaults to undefined.
 294  *              This is required for the forceSendChanged functionality, as the stack
 295  *              needs to compare an incoming CAN message with the previous frame.
 296  */
 297 struct CanMessageDefinition {
 298         struct CanBus* bus;
 299         uint32_t id;
 300         CanMessageFormat format;
 301         FrequencyClock frequencyClock;
 302         bool forceSendChanged;
 303         uint8_t lastValue[CAN_MESSAGE_SIZE];
 304 };
 305 typedef struct CanMessageDefinition CanMessageDefinition;
 306
 307 /**
 308  * @brief A parent wrapper for a particular set of CAN messages and associated
 309  *      CAN buses(e.g. a vehicle or program).
 310  *
 311  *      @param[in] index - A numerical ID for the message set, ideally the index in an array
 312  *              for fast lookup
 313  *      @param[in] name - The name of the message set.
 314  *      @param[in] busCount - The number of CAN buses defined for this message set.
 315  *      @param[in] messageCount - The number of CAN messages (across all buses) defined for
 316  *              this message set.
 317  *      @param[in] signalCount - The number of CAN signals (across all messages) defined for
 318  *              this message set.
 319  *      @param[in] commandCount - The number of CanCommmands defined for this message set.
 320  */
 321  typedef struct {
 322         uint8_t index;
 323         const char* name;
 324         uint8_t busCount;
 325         unsigned short messageCount;
 326         unsigned short signalCount;
 327         unsigned short commandCount;
 328 } CanMessageSet;
 329
 330 /**
 331  * @brief The type signature for a function to handle a custom OpenXC command.
 332  *
 333  * @param[in] char* name - the name of the received command.
 334  * @param[in] openxc_DynamicField* value - the value of the received command, in a DynamicField. The actual type
 335  *              may be a number, string or bool.
 336  * @param[in] openxc_DynamicField* event - an optional event from the received command, in a DynamicField. The
 337  *              actual type may be a number, string or bool.
 338  * @param[in] CanSignal* signals - The list of all signals.
 339  * @param[in] int signalCount - The length of the signals array.
 340  */
 341 typedef void (*CommandHandler)(const char* name, openxc_DynamicField* value,
 342                 openxc_DynamicField* event, CanSignal* signals, int signalCount);
 343
 344 /* Public: The structure to represent a supported custom OpenXC command.
 345  *
 346  * For completely customized CAN commands without a 1-1 mapping between an
 347  * OpenXC message from the host and a CAN signal, you can define the name of the
 348  * command and a custom function to handle it in the VI. An example is
 349  * the "turn_signal_status" command in OpenXC, which has a value of "left" or
 350  * "right". The vehicle may have separate CAN signals for the left and right
 351  * turn signals, so you will need to implement a custom command handler to send
 352  * the correct signals.
 353  *
 354  * Command handlers are also useful if you want to trigger multiple CAN messages
 355  * or signals from a signal OpenXC message.
 356  *
 357  * genericName - The name of the command.
 358  * handler - An function to process the received command's data and perform some
 359  *              action.
 360  */
 361 typedef struct {
 362         const char* genericName;
 363         CommandHandler handler;
 364 } CanCommand;
 365
 366 /**
 367  * @brief Pre initialize actions made before CAN bus initialization
 368  *
 369  * @param[in] can_bus_dev_t bus - A CanBus struct defining the bus's metadata
 370  * @param[in] bool writable - configure the controller in a writable mode. If false, it will be
 371  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 372  * @param[in] buses - An array of all CAN buses.
 373  * @param[in] int busCount - The length of the buses array.
 374  */
 375 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 376
 377 /* Post-initialize actions made after CAN bus initialization and before the
 378  * event loop connection.
 379  *
 380  * bus - A CanBus struct defining the bus's metadata
 381  * writable - configure the controller in a writable mode. If false, it will be
 382  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 383  * buses - An array of all CAN buses.
 384  * busCount - The length of the buses array.
 385  */
 386 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 387
 388 /* Public: Check if the device is connected to an active CAN bus, i.e. it's
 389  * received a message in the recent past.
 390  *
 391  * Returns true if a message was received on the CAN bus within
 392  * CAN_ACTIVE_TIMEOUT_S seconds.
 393  */
 394 bool isBusActive(can_bus_dev_t* bus);
 395
 396 /* Public: Log transfer statistics about all active CAN buses to the debug log.
 397  *
 398  * buses - an array of active CAN buses.
 399  * busCount - the length of the buses array.
 400  */
 401 void logBusStatistics(can_bus_dev_t* buses, const int busCount);