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 <queue>
  21 #include <thread>
  22 #include <linux/can.h>
  23
  24 #include "timer.hpp"
  25 #include "openxc.pb.h"
  26 #include "low-can-binding.hpp"
  27
  28 // TODO actual max is 32 but dropped to 24 for memory considerations
  29 #define MAX_ACCEPTANCE_FILTERS 24
  30 // TODO this takes up a ton of memory
  31 #define MAX_DYNAMIC_MESSAGE_COUNT 12
  32
  33 #define CAN_MESSAGE_SIZE 8
  34
  35 #define CAN_ACTIVE_TIMEOUT_S 30
  36
  37 /**
  38  * @brief The type signature for a CAN signal decoder.
  39  *
  40  * @desc A SignalDecoder transforms a raw floating point CAN signal into a number,
  41  * string or boolean.
  42  *
  43  * @param[in] CanSignal signal - The CAN signal that we are decoding.
  44  * @param[in] CanSignal signals - The list of all signals.
  45  * @param[in] int signalCount - The length of the signals array.
  46  * @param[in] float value - The CAN signal parsed from the message as a raw floating point
  47  *      value.
  48  * @param[out] bool send - An output parameter. If the decoding failed or the CAN signal should
  49  *      not send for some other reason, this should be flipped to false.
  50  *
  51  * @return a decoded value in an openxc_DynamicField struct.
  52  */
  53 typedef openxc_DynamicField (*SignalDecoder)(struct CanSignal* signal,
  54                 CanSignal* signals, int signalCount, float value, bool* send);
  55
  56 /**
  57  * @brief: The type signature for a CAN signal encoder.
  58  *
  59  * @desc A SignalEncoder transforms a number, string or boolean into a raw floating
  60  * point value that fits in the CAN signal.
  61  *
  62  * @params[signal] - The CAN signal to encode.
  63  * @params[value] - The dynamic field to encode.
  64  * @params[send] - An output parameter. If the encoding failed or the CAN signal should
  65  * not be encoded for some other reason, this will be flipped to false.
  66  */
  67 typedef uint64_t (*SignalEncoder)(struct CanSignal* signal,
  68                 openxc_DynamicField* value, bool* send);
  69
  70 /**
  71  * @enum CanMessageFormat
  72  * @brief The ID format for a CAN message.
  73  */
  74 enum CanMessageFormat {
  75         STANDARD, /*!< STANDARD - standard 11-bit CAN arbitration ID. */
  76         EXTENDED, /*!< EXTENDED - an extended frame, with a 29-bit arbitration ID. */
  77         ERROR,    /*!< ERROR - ERROR code used at initialization to signify that it isn't usable'*/
  78 };
  79 typedef enum CanMessageFormat CanMessageFormat;
  80
  81 /**
  82  * @class can_message_t
  83  *
  84  * @brief A compact representation of a single CAN message, meant to be used in in/out
  85  * buffers.
  86  */
  87
  88 /*************************
  89  * old CanMessage struct *
  90  *************************
  91 struct CanMessage {
  92         uint32_t id;
  93         CanMessageFormat format;
  94         uint8_t data[CAN_MESSAGE_SIZE];
  95         uint8_t length;
  96 };
  97 typedef struct CanMessage CanMessage;
  98 */
  99 class can_message_t {
 100         private:
 101                 uint32_t id_; /*!< uint32_t id - The ID of the message. */
 102                 uint8_t length_; /*!<  uint8_t length - the length of the data array (max 8). */
 103                 CanMessageFormat format_; /*!< CanMessageFormat format - the format of the message's ID.*/
 104                 uint8_t data_[CAN_MESSAGE_SIZE]; /*!< uint8_t data  - The message's data field with a size of 8 which is the standard about CAN bus messages.*/
 105
 106         public:
 107                 /**
 108                  * @brief Class constructor
 109                  *
 110                  * Constructor about can_message_t class.
 111                  */
 112                 can_message_t();
 113
 114                 /**
 115                  * @brief Retrieve id_ member value.
 116                  *
 117                  * @return uint32_t id_ class member
 118                  */
 119                 uint32_t get_id() const;
 120
 121                 /**
 122                  * @brief Retrieve format_ member value.
 123                  *
 124                  * @return CanMessageFormat format_ class member
 125                  */
 126                 int get_format() const;
 127
 128                 /**
 129                  * @brief Retrieve data_ member value.
 130                  *
 131                  * @return uint8_t data_ pointer class member
 132                  */
 133                 const uint8_t* get_data() const;
 134
 135                 /**
 136                  * @brief Retrieve length_ member value.
 137                  *
 138                  * @return uint8_t length_ class member
 139                  */
 140                 uint8_t get_length() const;
 141
 142                 /**
 143                  * @brief Control whether the object is correctly initialized
 144                  *  to be sent over the CAN bus
 145                  *
 146                  * @return true if object correctly initialized and false if not...
 147                  */
 148                 bool is_correct_to_send();
 149
 150                 /**
 151                  * @brief Set id_ member value.
 152                  *
 153                  * Preferred way to initialize these members by using
 154                  * convert_from_canfd_frame method.
 155                  *
 156                  * @param uint32_t id_ class member
 157                  */
 158                 void set_id(const uint32_t new_id);
 159
 160                 /**
 161                  * @brief Set format_ member value.
 162                  *
 163                  * Preferred way to initialize these members by using
 164                  * convert_from_canfd_frame method.
 165                  *
 166                  * @param CanMessageFormat format_ class member
 167                  */
 168                 void set_format(const CanMessageFormat format);
 169
 170                 /**
 171                  * @brief Set data_ member value.
 172                  *
 173                  * Preferred way to initialize these members by using
 174                  * convert_from_canfd_frame method.
 175                  *
 176                  * @param uint8_t data_ array with a max size of 8 elements.
 177                  */
 178                 void set_data(const uint8_t new_data);
 179
 180                 /**
 181                  * @brief Set length_ member value.
 182                  *
 183                  * Preferred way to initialize these members by using
 184                  * convert_from_canfd_frame method.
 185                  *
 186                  * @param uint8_t length_ array with a max size of 8 elements.
 187                  */
 188                 void set_length(const uint8_t new_length);
 189
 190                 /**
 191                  * @brief Take a canfd_frame struct to initialize class members
 192                  *
 193                  * This is the preferred way to initialize class members.
 194                  *
 195                  * @param canfd_frame struct read from can bus device.
 196                  */
 197                 void convert_from_canfd_frame(const canfd_frame& frame);
 198
 199                 /**
 200                  * @brief Take all initialized class's members and build an
 201                  * canfd_frame struct that can be use to send a CAN message over
 202                  * the bus.
 203                  *
 204                  * @return canfd_frame struct built from class members.
 205                  */
 206                 canfd_frame convert_to_canfd_frame();
 207 };
 208
 209 /**
 210  * @class can_bus_t
 211  * @brief Object used to handle decoding and manage event queue to be pushed.
 212  *
 213  * This object is also used to initialize can_bus_dev_t object after reading
 214  * json conf file describing the CAN devices to use. Thus, those object will read
 215  * on the device the CAN frame and push them into the can_bus_t can_message_q_ queue.
 216  *
 217  * That queue will be later used to be decoded and pushed to subscribers.
 218  */
 219 class can_bus_t {
 220         private:
 221                 int conf_file_; /*!< conf_file_ - configuration file handle used to initialize can_bus_dev_t objects.*/
 222
 223                 std::thread th_decoding_; /*!< thread that'll handle decoding a can frame */
 224                 std::thread th_pushing_; /*!<  thread that'll handle pushing decoded can frame to subscribers */
 225
 226                 bool has_can_message_; /*!< boolean members that control whether or not there is can_message into the queue */
 227                 std::queue <can_message_t> can_message_q_; /*!< queue that'll store can_message_t to decoded */
 228
 229                 bool has_vehicle_message_; /*!< boolean members that control whether or not there is openxc_VehicleMessage into the queue */
 230                 std::queue <openxc_VehicleMessage> vehicle_message_q_; /*!< queue that'll store openxc_VehicleMessage to pushed */
 231
 232         public:
 233                 /**
 234                  * @brief Class constructor
 235                  *
 236                  * @param struct afb_binding_interface *interface between daemon and binding
 237                  * @param int file handle to the json configuration file.
 238                  */
 239                 can_bus_t(int& conf_file);
 240
 241                 /**
 242                  * @brief Will initialize can_bus_dev_t objects after reading
 243                  * the configuration file passed in the constructor.
 244                  */
 245                 int init_can_dev();
 246
 247                 /**
 248                  * @brief read the conf_file_ and will parse json objects
 249                  * in it searching for canbus objects devices name.
 250                  *
 251                  * @return Vector of can bus device name string.
 252                  */
 253                  std::vector<std::string> read_conf();
 254
 255                 /**
 256                  * @brief Will initialize threads that will decode
 257                  *  and push subscribed events.
 258                  */
 259                 void start_threads();
 260
 261                 /**
 262                  * @brief Return first can_message_t on the queue
 263                  *
 264                  * @return a can_message_t
 265                  */
 266                 can_message_t next_can_message();
 267
 268                 /**
 269                  * @brief Push a can_message_t into the queue
 270                  *
 271                  * @param the const reference can_message_t object to push into the queue
 272                  */
 273                 void push_new_can_message(const can_message_t& can_msg);
 274
 275                 /**
 276                  * @brief Return a boolean telling if there is any can_message into the queue
 277                  *
 278                  * @return true if there is at least a can_message_t, false if not.
 279                  */
 280                 bool has_can_message() const;
 281
 282                 /**
 283                  * @brief Return first openxc_VehicleMessage on the queue
 284                  *
 285                  * @return a openxc_VehicleMessage containing a decoded can message
 286                  */
 287                 openxc_VehicleMessage next_vehicle_message();
 288
 289                 /**
 290                  * @brief Push a openxc_VehicleMessage into the queue
 291                  *
 292                  * @param the const reference openxc_VehicleMessage object to push into the queue
 293                  */
 294                 void push_new_vehicle_message(const openxc_VehicleMessage& v_msg);
 295
 296                 /**
 297                  * @brief Return a boolean telling if there is any openxc_VehicleMessage into the queue
 298                  *
 299                  * @return true if there is at least a openxc_VehicleMessage, false if not.
 300                  */
 301                 bool has_vehicle_message() const;
 302 };
 303
 304 /**
 305  * @class can_bus_dev_t
 306  *
 307  * @brief Object representing a can device. Handle opening, closing and reading on the
 308  *  socket. This is the low level object to be use by can_bus_t.
 309  */
 310 class can_bus_dev_t {
 311         private:
 312                 std::string device_name_; /*!< std::string device_name_ - name of the linux device handling the can bus. Generally vcan0, can0, etc. */
 313                 int can_socket_; /*!< socket handler for the can device */
 314                 bool is_fdmode_on_; /*!< boolean telling if whether or not the can socket use fdmode. */
 315                 struct sockaddr_can txAddress_; /*!< internal member using to bind to the socket */
 316
 317                 std::thread th_reading_; /*!< Thread handling read the socket can device filling can_message_q_ queue of can_bus_t */
 318                 bool is_running_; /*!< boolean telling whether or not reading is running or not */
 319
 320         public:
 321                 /**
 322                  * @brief Class constructor
 323                  *
 324                  * @param const string representing the device name into the linux /dev tree
 325                  */
 326                 can_bus_dev_t(const std::string& dev_name);
 327
 328                 /**
 329                  * @brief Open the can socket and returning it
 330                  *
 331                  * @return
 332                  */
 333                 int open();
 334
 335                 /**
 336                  * @brief Open the can socket and returning it
 337                  *
 338                  * @return
 339                  */
 340                 int close();
 341
 342                 /**
 343                  * @brief Telling if the reading thread is running
 344                  *
 345                  * @return true if read is running, false if not.
 346                  */
 347                 bool is_running();
 348
 349                 /**
 350                 * @brief start reading threads and set flag is_running_
 351                 *
 352                 * @param can_bus_t reference can_bus_t. it will be passed to the thread
 353                 *  to allow using can_bus_t queue.
 354                 */
 355                 void start_reading(can_bus_t& can_bus);
 356
 357                 /**
 358                 * @brief Read the can socket and retrieve canfd_frame
 359                 *
 360                 * @param const struct afb_binding_interface* interface pointer. Used to be able to log
 361                 *  using application framework logger.
 362                 */
 363                 canfd_frame read();
 364
 365                 /**
 366                 * @brief Send a can message from a can_message_t object.
 367                 *
 368                 * @param const can_message_t& can_msg: the can message object to send
 369                 * @param const struct afb_binding_interface* interface pointer. Used to be able to log
 370                 *  using application framework logger.
 371                 */
 372                 int send_can_message(can_message_t& can_msg);
 373 };
 374
 375 /**
 376  * @struct CanSignalState
 377  *
 378  * @brief A state encoded (SED) signal's mapping from numerical values to
 379  * OpenXC state names.
 380  */
 381 struct CanSignalState {
 382         const int value; /*!< int value - The integer value of the state on the CAN bus.*/
 383         const char* name; /*!< char* name  - The corresponding string name for the state in OpenXC. */
 384 };
 385 typedef struct CanSignalState CanSignalState;
 386
 387 /**
 388  * @struct CanSignal
 389  *
 390  * @brief A CAN signal to decode from the bus and output over USB.
 391  */
 392 struct CanSignal {
 393         struct CanMessageDefinition* message; /*!< message         - The message this signal is a part of. */
 394         const char* genericName; /*!< genericName - The name of the signal to be output over USB.*/
 395         uint8_t bitPosition; /*!< bitPosition - The starting bit of the signal in its CAN message (assuming
 396                                                 *       non-inverted bit numbering, i.e. the most significant bit of
 397                                                 *       each byte is 0) */
 398         uint8_t bitSize; /*!< bitSize - The width of the bit field in the CAN message. */
 399         float factor; /*!< factor - The final value will be multiplied by this factor. Use 1 if you
 400                                 *       don't need a factor. */
 401         float offset; /*!< offset          - The final value will be added to this offset. Use 0 if you
 402                                 *       don't need an offset. */
 403         float minValue; /*!< minValue    - The minimum value for the processed signal.*/
 404         float maxValue; /*!< maxValue    - The maximum value for the processed signal. */
 405         FrequencyClock frequencyClock; /*!< frequencyClock - A FrequencyClock struct to control the maximum frequency to
 406                                                                 *       process and send this signal. To process every value, set the
 407                                                                 *       clock's frequency to 0. */
 408         bool sendSame; /*!< sendSame    - If true, will re-send even if the value hasn't changed.*/
 409         bool forceSendChanged; /*!< forceSendChanged - If true, regardless of the frequency, it will send the
 410                                                 *       value if it has changed. */
 411         const CanSignalState* states; /*!< states          - An array of CanSignalState describing the mapping
 412                                                                 *       between numerical and string values for valid states. */
 413         uint8_t stateCount; /*!< stateCount  - The length of the states array. */
 414         bool writable; /*!< writable    - True if the signal is allowed to be written from the USB host
 415                                 *       back to CAN. Defaults to false.*/
 416         SignalDecoder decoder; /*!< decoder        - An optional function to decode a signal from the bus to a human
 417                                                 *       readable value. If NULL, the default numerical decoder is used. */
 418         SignalEncoder encoder; /*!< encoder        - An optional function to encode a signal value to be written to
 419                                                 *       CAN into a byte array. If NULL, the default numerical encoder
 420                                                 *       is used. */
 421         bool received; /*!< received    - True if this signal has ever been received.*/
 422         float lastValue; /*!< lastValue   - The last received value of the signal. If 'received' is false,
 423                                         *       this value is undefined. */
 424 };
 425 typedef struct CanSignal CanSignal;
 426
 427 /**
 428  * @struct CanMessageDefinition
 429  *
 430  * @brief The definition of a CAN message. This includes a lot of metadata, so
 431  * to save memory this struct should not be used for storing incoming and
 432  * outgoing CAN messages.
 433  */
 434 struct CanMessageDefinition {
 435         struct CanBus* bus; /*!< bus - A pointer to the bus this message is on. */
 436         uint32_t id; /*!<  id - The ID of the message.*/
 437         CanMessageFormat format; /*!< format - the format of the message's ID.*/
 438         FrequencyClock frequencyClock; /*!<  clock - an optional frequency clock to control the output of this
 439                                                                         *       message, if sent raw, or simply to mark the max frequency for custom
 440                                                                         *       handlers to retriec++ if ? syntaxve.*/
 441         bool forceSendChanged; /*!< forceSendChanged - If true, regardless of the frequency, it will send CAN
 442                                                         *       message if it has changed when using raw passthrough.*/
 443         uint8_t lastValue[CAN_MESSAGE_SIZE]; /*!< lastValue - The last received value of the message. Defaults to undefined.
 444                                                                                 *       This is required for the forceSendChanged functionality, as the stack
 445                                                                                 *       needs to compare an incoming CAN message with the previous frame.*/
 446 };
 447 typedef struct CanMessageDefinition CanMessageDefinition;
 448
 449 /**
 450  * @struct CanMessageSet
 451  *
 452  * @brief A parent wrapper for a particular set of CAN messages and associated
 453  *      CAN buses(e.g. a vehicle or program).
 454  */
 455  typedef struct {
 456         uint8_t index; /*!<index - A numerical ID for the message set, ideally the index in an array
 457                                         *       for fast lookup*/
 458         const char* name; /*!< name - The name of the message set.*/
 459         uint8_t busCount; /*!< busCount - The number of CAN buses defined for this message set.*/
 460         unsigned short messageCount; /*!< messageCount - The number of CAN messages (across all buses) defined for
 461                                                                         *       this message set.*/
 462         unsigned short signalCount; /*!< signalCount - The number of CAN signals (across all messages) defined for
 463                                                                 *       this message set.*/
 464         unsigned short commandCount; /*!< commandCount - The number of CanCommmands defined for this message set.*/
 465 } CanMessageSet;
 466
 467 /**
 468  * @brief The type signature for a function to handle a custom OpenXC command.
 469  *
 470  * @param[in] char* name - the name of the received command.
 471  * @param[in] openxc_DynamicField* value - the value of the received command, in a DynamicField. The actual type
 472  *              may be a number, string or bool.
 473  * @param[in] openxc_DynamicField* event - an optional event from the received command, in a DynamicField. The
 474  *              actual type may be a number, string or bool.
 475  * @param[in] CanSignal* signals - The list of all signals.
 476  * @param[in] int signalCount - The length of the signals array.
 477  */
 478 typedef void (*CommandHandler)(const char* name, openxc_DynamicField* value,
 479                 openxc_DynamicField* event, CanSignal* signals, int signalCount);
 480
 481 /* @struct CanCommand
 482  * @brief The structure to represent a supported custom OpenXC command.
 483  *
 484  * @desc For completely customized CAN commands without a 1-1 mapping between an
 485  * OpenXC message from the host and a CAN signal, you can define the name of the
 486  * command and a custom function to handle it in the VI. An example is
 487  * the "turn_signal_status" command in OpenXC, which has a value of "left" or
 488  * "right". The vehicle may have separate CAN signals for the left and right
 489  * turn signals, so you will need to implement a custom command handler to send
 490  * the correct signals.
 491  *
 492  * Command handlers are also useful if you want to trigger multiple CAN messages
 493  * or signals from a signal OpenXC message.
 494  */
 495 typedef struct {
 496         const char* genericName; /*!< genericName - The name of the command.*/
 497         CommandHandler handler; /*!< handler - An function to process the received command's data and perform some
 498                                                         *       action.*/
 499 } CanCommand;
 500
 501 /**
 502  * @fn void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 503  * @brief Pre initialize actions made before CAN bus initialization
 504  *
 505  * @param[in] can_bus_dev_t bus - A CanBus struct defining the bus's metadata
 506  * @param[in] bool writable - configure the controller in a writable mode. If false, it will be
 507  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 508  * @param[in] buses - An array of all CAN buses.
 509  * @param[in] int busCount - The length of the buses array.
 510  */
 511 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 512
 513 /**
 514  * @fn void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 515  * @brief Post-initialize actions made after CAN bus initialization
 516  *
 517  * @param[in] bus - A CanBus struct defining the bus's metadata
 518  * @param[in] writable - configure the controller in a writable mode. If false, it will be
 519  *              configured as "listen only" and will not allow writes or even CAN ACKs.
 520  * @param[in] buses - An array of all CAN buses.
 521  * @param[in] busCount - The length of the buses array.
 522  */
 523 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 524
 525 /**
 526  * @fn bool isBusActive(can_bus_dev_t* bus);
 527  * @brief Check if the device is connected to an active CAN bus, i.e. it's
 528  * received a message in the recent past.
 529  *
 530  * @return true if a message was received on the CAN bus within
 531  * CAN_ACTIVE_TIMEOUT_S seconds.
 532  */
 533 bool isBusActive(can_bus_dev_t* bus);
 534
 535 /**
 536  * @fn void logBusStatistics(can_bus_dev_t* buses, const int busCount);
 537  * @brief Log transfer statistics about all active CAN buses to the debug log.
 538  *
 539  * @param[in] buses - an array of active CAN buses.
 540  * @param[in] busCount - the length of the buses array.
 541  */
 542 void logBusStatistics(can_bus_dev_t* buses, const int busCount);
 543
 544 /**
 545  * @fn void can_reader(can_bus_dev_t& can_bus_dev, can_bus_t& can_bus);
 546  *
 547  * @brief Thread function used to read the can socket.
 548  *
 549  * @param[in] can_bus_dev_t object to be used to read the can socket
 550  * @param[in] can_bus_t object used to fill can_message_q_ queue
 551  */
 552 void can_reader(can_bus_dev_t& can_bus_dev, can_bus_t& can_bus);
 553
 554 /**
 555  * @fn void can_decode_message(can_bus_t& can_bus);
 556  *
 557  * @brief Thread function used to decode can messages read into the can_message_q_
 558  *
 559  * @param[in] can_bus_t object used to pop can_message_q_ queue and fill decoded message
 560  * into vehicle_message_q_ queue.
 561  */
 562 void can_decode_message(can_bus_t& can_bus);
 563
 564 /**
 565  * @fn void can_decode_message(can_bus_t& can_bus);
 566  *
 567  * @brief Thread function used to push afb_event
 568  *
 569  * @param[in] can_bus_t object used to pop can_message_q_ queue and fill decoded message
 570  * into vehicle_message_q_ queue.
 571  */
 572 void can_event_push(can_bus_t& can_bus);