2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
29 #include <sys/ioctl.h>
30 #include <linux/can.h>
31 #include <sys/socket.h>
32 #include <json-c/json.h>
33 #include <linux/can/raw.h>
36 #include "openxc.pb.h"
40 #include <afb/afb-binding.h>
41 #include <afb/afb-service-itf.h>
44 // TODO actual max is 32 but dropped to 24 for memory considerations
45 #define MAX_ACCEPTANCE_FILTERS 24
46 // TODO this takes up a ton of memory
47 #define MAX_DYNAMIC_MESSAGE_COUNT 12
49 #define CAN_MESSAGE_SIZE 8
51 #define CAN_ACTIVE_TIMEOUT_S 30
54 * @brief The type signature for a CAN signal decoder.
56 * @desc A SignalDecoder transforms a raw floating point CAN signal into a number,
59 * @param[in] CanSignal signal - The CAN signal that we are decoding.
60 * @param[in] CanSignal signals - The list of all signals.
61 * @param[in] int signalCount - The length of the signals array.
62 * @param[in] float value - The CAN signal parsed from the message as a raw floating point
64 * @param[out] bool send - An output parameter. If the decoding failed or the CAN signal should
65 * not send for some other reason, this should be flipped to false.
67 * @return a decoded value in an openxc_DynamicField struct.
69 typedef openxc_DynamicField (*SignalDecoder)(struct CanSignal* signal,
70 CanSignal* signals, int signalCount, float value, bool* send);
73 * @brief: The type signature for a CAN signal encoder.
75 * @desc A SignalEncoder transforms a number, string or boolean into a raw floating
76 * point value that fits in the CAN signal.
78 * @params[signal] - The CAN signal to encode.
79 * @params[value] - The dynamic field to encode.
80 * @params[send] - An output parameter. If the encoding failed or the CAN signal should
81 * not be encoded for some other reason, this will be flipped to false.
83 typedef uint64_t (*SignalEncoder)(struct CanSignal* signal,
84 openxc_DynamicField* value, bool* send);
87 * @brief The ID format for a CAN message.
89 * STANDARD - standard 11-bit CAN arbitration ID.
90 * EXTENDED - an extended frame, with a 29-bit arbitration ID.
92 enum CanMessageFormat {
96 typedef enum CanMessageFormat CanMessageFormat;
99 * @brief A compact representation of a single CAN message, meant to be used in in/out
102 * param[in] uint32_t id - The ID of the message.
103 * param[in] CanMessageFormat format - the format of the message's ID.
104 * param[in] uint8_t data - The message's data field.
105 * @param[in] uint8_t length - the length of the data array (max 8).
106 *************************
107 * old CanMessage struct *
108 *************************
111 CanMessageFormat format;
112 uint8_t data[CAN_MESSAGE_SIZE];
115 typedef struct CanMessage CanMessage;
117 class can_message_t {
119 const struct afb_binding_interface* interface_;
121 CanMessageFormat format_;
126 can_message_t(const struct afb_binding_interface* interface);
128 uint32_t get_id() const;
129 int get_format() const;
130 const uint8_t* get_data() const;
131 uint8_t get_length() const;
133 void set_id(const uint32_t new_id);
134 void set_format(const CanMessageFormat format);
135 void set_data(const uint8_t new_data);
136 void set_length(const uint8_t new_length);
138 void convert_from_canfd_frame(const canfd_frame& frame);
139 canfd_frame convert_to_canfd_frame();
143 * @brief Object used to handle decoding and manage event queue to be pushed.
145 * @params[in] interface_ - afb_binding_interface pointer to the binder. Used to log messages
146 * @params[in] conf_file_ - configuration file handle used to initialize can_bus_dev_t objects.
150 const struct afb_binding_interface *interface_;
153 std::thread th_decoding_;
154 std::thread th_pushing_;
156 bool has_can_message_;
157 std::queue <can_message_t> can_message_q_;
159 bool has_vehicle_message_;
160 std::queue <openxc_VehicleMessage> vehicle_message_q_;
163 can_bus_t(const struct afb_binding_interface *itf, int& conf_file);
165 std::vector<std::string> read_conf();
167 void start_threads();
169 can_message_t next_can_message();
170 void push_new_can_message(const can_message_t& can_msg);
171 bool has_can_message() const;
173 openxc_VehicleMessage next_vehicle_message();
174 void push_new_vehicle_message(const openxc_VehicleMessage& v_msg);
175 bool has_vehicle_message() const;
179 * @brief Object representing a can device. Handle opening, closing and reading on the
180 * socket. This is the low level object to be use by can_bus_t.
182 * @params[in] std::string device_name_ - name of the linux device handling the can bus. Generally vcan0, can0, etc.
184 class can_bus_dev_t {
186 std::string device_name_;
189 struct sockaddr_can txAddress_;
191 std::thread th_reading_;
195 can_bus_dev_t(const std::string& dev_name);
197 int open(const struct afb_binding_interface* interface);
200 void start_reading(can_bus_t& can_bus);
201 canfd_frame read(const struct afb_binding_interface *interface);
203 int send_can_message(can_message_t& can_msg, const struct afb_binding_interface* interface);
207 * @brief A state encoded (SED) signal's mapping from numerical values to
208 * OpenXC state names.
210 * @param[in] in value - The integer value of the state on the CAN bus.
211 * @param[in] char* name - The corresponding string name for the state in OpenXC.
213 struct CanSignalState {
217 typedef struct CanSignalState CanSignalState;
220 * @brief A CAN signal to decode from the bus and output over USB.
222 * @param[in] message - The message this signal is a part of.
223 * @param[in] genericName - The name of the signal to be output over USB.
224 * @param[in] bitPosition - The starting bit of the signal in its CAN message (assuming
225 * non-inverted bit numbering, i.e. the most significant bit of
227 * @param[in] bitSize - The width of the bit field in the CAN message.
228 * @param[in] factor - The final value will be multiplied by this factor. Use 1 if you
229 * don't need a factor.
230 * @param[in] offset - The final value will be added to this offset. Use 0 if you
231 * don't need an offset.
232 * @param[in] minValue - The minimum value for the processed signal.
233 * @param[in] maxValue - The maximum value for the processed signal.
234 * @param[in] frequencyClock - A FrequencyClock struct to control the maximum frequency to
235 * process and send this signal. To process every value, set the
236 * clock's frequency to 0.
237 * @param[in] sendSame - If true, will re-send even if the value hasn't changed.
238 * @param[in] forceSendChanged - If true, regardless of the frequency, it will send the
239 * value if it has changed.
240 * @param[in] states - An array of CanSignalState describing the mapping
241 * between numerical and string values for valid states.
242 * @param[in] stateCount - The length of the states array.
243 * @param[in] writable - True if the signal is allowed to be written from the USB host
244 * back to CAN. Defaults to false.
245 * @param[in] decoder - An optional function to decode a signal from the bus to a human
246 * readable value. If NULL, the default numerical decoder is used.
247 * @param[in] encoder - An optional function to encode a signal value to be written to
248 * CAN into a byte array. If NULL, the default numerical encoder
250 * @param[in] received - True if this signal has ever been received.
251 * @param[in] lastValue - The last received value of the signal. If 'received' is false,
252 * this value is undefined.
255 struct CanMessageDefinition* message;
256 const char* genericName;
263 FrequencyClock frequencyClock;
265 bool forceSendChanged;
266 const CanSignalState* states;
269 SignalDecoder decoder;
270 SignalEncoder encoder;
274 typedef struct CanSignal CanSignal;
277 * @brief The definition of a CAN message. This includes a lot of metadata, so
278 * to save memory this struct should not be used for storing incoming and
279 * outgoing CAN messages.
281 * @param[in] bus - A pointer to the bus this message is on.
282 * @param[in] id - The ID of the message.
283 * @param[in] format - the format of the message's ID.
284 * @param[in] clock - an optional frequency clock to control the output of this
285 * message, if sent raw, or simply to mark the max frequency for custom
286 * handlers to retriec++ if ? syntaxve.
287 * @param[in] forceSendChanged - If true, regardless of the frequency, it will send CAN
288 * message if it has changed when using raw passthrough.
289 * @param[in] lastValue - The last received value of the message. Defaults to undefined.
290 * This is required for the forceSendChanged functionality, as the stack
291 * needs to compare an incoming CAN message with the previous frame.
293 struct CanMessageDefinition {
296 CanMessageFormat format;
297 FrequencyClock frequencyClock;
298 bool forceSendChanged;
299 uint8_t lastValue[CAN_MESSAGE_SIZE];
301 typedef struct CanMessageDefinition CanMessageDefinition;
304 * @brief A parent wrapper for a particular set of CAN messages and associated
305 * CAN buses(e.g. a vehicle or program).
307 * @param[in] index - A numerical ID for the message set, ideally the index in an array
309 * @param[in] name - The name of the message set.
310 * @param[in] busCount - The number of CAN buses defined for this message set.
311 * @param[in] messageCount - The number of CAN messages (across all buses) defined for
313 * @param[in] signalCount - The number of CAN signals (across all messages) defined for
315 * @param[in] commandCount - The number of CanCommmands defined for this message set.
321 unsigned short messageCount;
322 unsigned short signalCount;
323 unsigned short commandCount;
327 * @brief The type signature for a function to handle a custom OpenXC command.
329 * @param[in] char* name - the name of the received command.
330 * @param[in] openxc_DynamicField* value - the value of the received command, in a DynamicField. The actual type
331 * may be a number, string or bool.
332 * @param[in] openxc_DynamicField* event - an optional event from the received command, in a DynamicField. The
333 * actual type may be a number, string or bool.
334 * @param[in] CanSignal* signals - The list of all signals.
335 * @param[in] int signalCount - The length of the signals array.
337 typedef void (*CommandHandler)(const char* name, openxc_DynamicField* value,
338 openxc_DynamicField* event, CanSignal* signals, int signalCount);
340 /* Public: The structure to represent a supported custom OpenXC command.
342 * For completely customized CAN commands without a 1-1 mapping between an
343 * OpenXC message from the host and a CAN signal, you can define the name of the
344 * command and a custom function to handle it in the VI. An example is
345 * the "turn_signal_status" command in OpenXC, which has a value of "left" or
346 * "right". The vehicle may have separate CAN signals for the left and right
347 * turn signals, so you will need to implement a custom command handler to send
348 * the correct signals.
350 * Command handlers are also useful if you want to trigger multiple CAN messages
351 * or signals from a signal OpenXC message.
353 * genericName - The name of the command.
354 * handler - An function to process the received command's data and perform some
358 const char* genericName;
359 CommandHandler handler;
363 * @brief Pre initialize actions made before CAN bus initialization
365 * @param[in] can_bus_dev_t bus - A CanBus struct defining the bus's metadata
366 * @param[in] bool writable - configure the controller in a writable mode. If false, it will be
367 * configured as "listen only" and will not allow writes or even CAN ACKs.
368 * @param[in] buses - An array of all CAN buses.
369 * @param[in] int busCount - The length of the buses array.
371 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
373 /* Post-initialize actions made after CAN bus initialization and before the
374 * event loop connection.
376 * bus - A CanBus struct defining the bus's metadata
377 * writable - configure the controller in a writable mode. If false, it will be
378 * configured as "listen only" and will not allow writes or even CAN ACKs.
379 * buses - An array of all CAN buses.
380 * busCount - The length of the buses array.
382 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
384 /* Public: Check if the device is connected to an active CAN bus, i.e. it's
385 * received a message in the recent past.
387 * Returns true if a message was received on the CAN bus within
388 * CAN_ACTIVE_TIMEOUT_S seconds.
390 bool isBusActive(can_bus_dev_t* bus);
392 /* Public: Log transfer statistics about all active CAN buses to the debug log.
394 * buses - an array of active CAN buses.
395 * busCount - the length of the buses array.
397 void logBusStatistics(can_bus_dev_t* buses, const int busCount);
400 * @brief Function representing thread activated by can bus objects
402 void can_reader(can_bus_dev_t& can_bus_dev, can_bus_t& can_bus);
403 void can_decode_message(can_bus_t& can_bus);
404 void can_event_push(can_bus_t& can_bus);