src/can-signals.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 <string>
  24 #include <thread>
  25 #include <linux/can.h>
  26
  27 #include "timer.hpp"
  28 #include "openxc.pb.h"
  29 #include "can-utils.hpp"
  30
  31 extern "C"
  32 {
  33         #include <afb/afb-binding.h>
  34         #include <afb/afb-event-itf.h>
  35 }
  36
  37 #define MESSAGE_SET_ID 0
  38
  39 /**
  40  * @brief Can signal event map making access to afb_event
  41  * externaly to an openxc existing structure.
  42  *
  43  * @desc Event map is making relation between CanSignal generic name
  44  * and the afb_event struct used by application framework to pushed
  45  * to the subscriber.
  46  */
  47 static std::map<std::string, struct afb_event> subscribed_signals;
  48
  49 /** Public: Return the currently active CAN configuration. */
  50 CanMessageSet* getActiveMessageSet();
  51
  52 /** Public: Retrive a list of all possible CAN configurations.
  53  *
  54  * Returns a pointer to an array of all configurations.
  55  */
  56 CanMessageSet* getMessageSets();
  57
  58 /** Public: Return the length of the array returned by getMessageSets() */
  59 int getMessageSetCount();
  60
  61 /* Public: Return the number of CAN buses configured in the active
  62  * configuration. This is limited to 2, as the hardware controller only has 2
  63  * CAN channels.
  64  */
  65 int getCanBusCount();
  66
  67 /* Public: Return an array of all CAN messages to be processed in the active
  68  * configuration.
  69  */
  70 CanMessageDefinition* getMessages();
  71
  72 /* Public: Return signals from an signals array filtered on name.
  73  */
  74 const std::vector<CanSignal> getSignals();
  75
  76 /* Public: Return an array of all OpenXC CAN commands enabled in the active
  77  * configuration that can write back to CAN with a custom handler.
  78  *
  79  * * Commands not defined here are handled using a 1-1 mapping from the signals
  80  * list.
  81  *              */
  82 CanCommand* getCommands();
  83
  84 /* Public: Return the length of the array returned by getCommandCount(). */
  85 int getCommandCount();
  86
  87 /* Public: Return the length of the array returned by getSignals(). */
  88 size_t getSignalCount();
  89
  90 /* Public: Return the length of the array returned by getMessages(). */
  91 int getMessageCount();
  92
  93 /**
  94  * @brief Return an array of the metadata for the 2 CAN buses you want to
  95  * monitor. The size of this array is fixed at 2.
  96  */
  97 CanBus* getCanBuses();
  98
  99 /**
 100  * @brief Find one or many signals based on its name or id
 101  * passed through openxc_DynamicField.
 102  *
 103  * @param[in] openxc_DynamicField& - a const reference with the key to search into signal.
 104  * Key is either a signal name or its CAN arbitration id.
 105  *
 106  * @return std::vector<std::string> return found CanSignal generic name vector.
 107  */
 108 std::vector<CanSignal> find_can_signals(const openxc_DynamicField &key);
 109
 110 /**
 111  * @brief Retrieve can arbitration id of a given CanSignal
 112  *
 113  * @param[in] CanSignal& - a const reference to a CanSignal
 114  *
 115  * @return uint32_t - unsigned integer representing the arbitration id.
 116  */
 117 inline uint32_t get_CanSignal_id(const CanSignal& sig);
 118
 119 /**
 120  * @brief return the subscribed_signals map.
 121  *
 122  * return std::map<std::string, struct afb_event> - map of subscribed signals.
 123  */
 124 const std::map<std::string, struct afb_event> get_subscribed_signals();