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.
22 #include "openxc.pb.h"
24 // TODO actual max is 32 but dropped to 24 for memory considerations
25 #define MAX_ACCEPTANCE_FILTERS 24
26 // TODO this takes up a ton of memory
27 #define MAX_DYNAMIC_MESSAGE_COUNT 12
29 #define CAN_MESSAGE_SIZE 8
31 #define CAN_ACTIVE_TIMEOUT_S 30
33 #define QUEUE_DECLARE(type, max_length) \
34 static const int queue_##type##_max_length = max_length; \
35 static const int queue_##type##_max_internal_length = max_length + 1; \
36 typedef struct queue_##type##_s { \
39 type elements[max_length + 1]; \
42 bool queue_##type##_push(queue_##type* queue, type value); \
44 type queue_##type##_pop(queue_##type* queue); \
46 type queue_##type##_peek(queue_##type* queue); \
47 void queue_##type##_init(queue_##type* queue); \
48 int queue_##type##_length(queue_##type* queue); \
49 int queue_##type##_available(queue_##type* queue); \
50 bool queue_##type##_full(queue_##type* queue); \
51 bool queue_##type##_empty(queue_##type* queue); \
52 void queue_##type##_snapshot(queue_##type* queue, type* snapshot, int max);
54 /* Public: The type signature for a CAN signal decoder.
56 * A SignalDecoder transforms a raw floating point CAN signal into a number,
59 * signal - The CAN signal that we are decoding.
60 * signals - The list of all signals.
61 * signalCount - The length of the signals array.
62 * value - The CAN signal parsed from the message as a raw floating point
64 * 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 * Returns 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);
72 /* Public: The type signature for a CAN signal encoder.
74 * A SignalEncoder transforms a number, string or boolean into a raw floating
75 * point value that fits in the CAN signal.
77 * signal - The CAN signal to encode.
78 * value - The dynamic field to encode.
79 * send - An output parameter. If the encoding failed or the CAN signal should
80 * not be encoded for some other reason, this will be flipped to false.
82 typedef uint64_t (*SignalEncoder)(struct CanSignal* signal,
83 openxc_DynamicField* value, bool* send);
85 /* CanBus represent a can device definition gotten from configuraiton file */
88 /* Got from conf file */
89 std::string deviceName;
93 struct sockaddr_can txAddress;
95 std::thread th_reading;
96 std::thread th_decoding;
97 std::thread th_pushing;
103 void start_threads();
106 /* Public: The ID format for a CAN message.
108 * STANDARD - standard 11-bit CAN arbitration ID.
109 * EXTENDED - an extended frame, with a 29-bit arbitration ID.
111 enum CanMessageFormat_c {
115 typedef enum CanMessageFormat_c CanMessageFormat;
117 /* Public: A state encoded (SED) signal's mapping from numerical values to
118 * OpenXC state names.
120 * value - The integer value of the state on the CAN bus.
121 * name - The corresponding string name for the state in OpenXC.
122 struct CanSignalState {
126 typedef struct CanSignalState CanSignalState;
128 class CanSignalState_c {
134 /* Public: A CAN signal to decode from the bus and output over USB.
136 * message - The message this signal is a part of.
137 * genericName - The name of the signal to be output over USB.
138 * bitPosition - The starting bit of the signal in its CAN message (assuming
139 * non-inverted bit numbering, i.e. the most significant bit of
141 * bitSize - The width of the bit field in the CAN message.
142 * factor - The final value will be multiplied by this factor. Use 1 if you
143 * don't need a factor.
144 * offset - The final value will be added to this offset. Use 0 if you
145 * don't need an offset.
146 * minValue - The minimum value for the processed signal.
147 * maxValue - The maximum value for the processed signal.
148 * frequencyClock - A FrequencyClock struct to control the maximum frequency to
149 * process and send this signal. To process every value, set the
150 * clock's frequency to 0.
151 * sendSame - If true, will re-send even if the value hasn't changed.
152 * forceSendChanged - If true, regardless of the frequency, it will send the
153 * value if it has changed.
154 * states - An array of CanSignalState describing the mapping
155 * between numerical and string values for valid states.
156 * stateCount - The length of the states array.
157 * writable - True if the signal is allowed to be written from the USB host
158 * back to CAN. Defaults to false.
159 * decoder - An optional function to decode a signal from the bus to a human
160 * readable value. If NULL, the default numerical decoder is used.
161 * encoder - An optional function to encode a signal value to be written to
162 * CAN into a byte array. If NULL, the default numerical encoder
164 * received - True if this signal has ever been received.
165 * lastValue - The last received value of the signal. If 'received' is false,
166 * this value is undefined.
168 struct CanMessageDefinition* message;
169 const char* genericName;
176 FrequencyClock frequencyClock;
178 bool forceSendChanged;
179 const CanSignalState* states;
182 SignalDecoder decoder;
183 SignalEncoder encoder;
187 typedef struct CanSignal CanSignal;
192 CanMessageDefinition *message;
193 const char *generic_name;
194 uint8_t bit_position;
200 FrequencyClock_t clock;
202 bool force_send_changed;
203 const CanSignalState *states;
206 SignalDecoder decoder;
207 SignalEncoder encoder;
212 /* Public: The definition of a CAN message. This includes a lot of metadata, so
213 * to save memory this struct should not be used for storing incoming and
214 * outgoing CAN messages.
216 * bus - A pointer to the bus this message is on.
217 * id - The ID of the message.
218 * format - the format of the message's ID.
219 * clock - an optional frequency clock to control the output of this
220 * message, if sent raw, or simply to mark the max frequency for custom
221 * handlers to retrieve.
222 * forceSendChanged - If true, regardless of the frequency, it will send CAN
223 * message if it has changed when using raw passthrough.
224 * lastValue - The last received value of the message. Defaults to undefined.
225 * This is required for the forceSendChanged functionality, as the stack
226 * needs to compare an incoming CAN message with the previous frame.
227 struct CanMessageDefinition {
230 CanMessageFormat format;
231 FrequencyClock frequencyClock;
232 bool forceSendChanged;
233 uint8_t lastValue[CAN_MESSAGE_SIZE];
235 typedef struct CanMessageDefinition CanMessageDefinition;
237 class CanMessageDefinition_c {
241 CanMessageFormat format;
242 FrequencyClock_t clock;
243 bool force_send_changed;
244 uint8_t last_value[CAN_MESSAGE_SIZE];
247 /* A compact representation of a single CAN message, meant to be used in in/out
250 * id - The ID of the message.
251 * format - the format of the message's ID.
252 * data - The message's data field.
253 * length - the length of the data array (max 8).
256 CanMessageFormat format;
257 uint8_t data[CAN_MESSAGE_SIZE];
260 typedef struct CanMessage CanMessage;
265 CanMessageFormat format;
266 uint8_t data[CAN_MESSAGE_SIZE];
273 uint8_t get_lenght();
275 void set_id(uint32_t id);
276 void set_format(CanMessageFormat format);
277 void set_data(uint8_t data);
278 void set_lenght(uint8_t length);
280 void convert_canfd_frame_to_CanMessage(canfd_frame frame);
283 QUEUE_DECLARE(CanMessage_c, 8);
285 /* Private: An entry in the list of acceptance filters for each CanBus.
287 * This struct is meant to be used with a LIST type from <sys/queue.h>.
289 * filter - the value for the CAN acceptance filter.
290 * activeUserCount - The number of active consumers of this filter's messages.
291 * When 0, this filter can be removed.
292 * format - the format of the ID for the filter.
293 struct AcceptanceFilterListEntry {
295 uint8_t activeUserCount;
296 CanMessageFormat format;
297 LIST_ENTRY(AcceptanceFilterListEntry) entries;
301 /* Private: A type of list containing CAN acceptance filters.
302 LIST_HEAD(AcceptanceFilterList, AcceptanceFilterListEntry);
304 struct CanMessageDefinitionListEntry {
305 CanMessageDefinition definition;
306 LIST_ENTRY(CanMessageDefinitionListEntry) entries;
308 LIST_HEAD(CanMessageDefinitionList, CanMessageDefinitionListEntry);
311 /** Public: A parent wrapper for a particular set of CAN messages and associated
312 * CAN buses(e.g. a vehicle or program).
314 * index - A numerical ID for the message set, ideally the index in an array
316 * name - The name of the message set.
317 * busCount - The number of CAN buses defined for this message set.
318 * messageCount - The number of CAN messages (across all buses) defined for
320 * signalCount - The number of CAN signals (across all messages) defined for
322 * commandCount - The number of CanCommmands defined for this message set.
327 unsigned short messageCount;
328 unsigned short signalCount;
329 unsigned short commandCount;
332 class CanMessageSet_c {
337 unsigned short messageCount;
338 unsigned short signalCount;
339 unsigned short commandCount;
342 /* Public: The type signature for a function to handle a custom OpenXC command.
344 * name - the name of the received command.
345 * value - the value of the received command, in a DynamicField. The actual type
346 * may be a number, string or bool.
347 * event - an optional event from the received command, in a DynamicField. The
348 * actual type may be a number, string or bool.
349 * signals - The list of all signals.
350 * signalCount - The length of the signals array.
352 typedef void (*CommandHandler)(const char* name, openxc_DynamicField* value,
353 openxc_DynamicField* event, CanSignal* signals, int signalCount);
355 /* Public: The structure to represent a supported custom OpenXC command.
357 * For completely customized CAN commands without a 1-1 mapping between an
358 * OpenXC message from the host and a CAN signal, you can define the name of the
359 * command and a custom function to handle it in the VI. An example is
360 * the "turn_signal_status" command in OpenXC, which has a value of "left" or
361 * "right". The vehicle may have separate CAN signals for the left and right
362 * turn signals, so you will need to implement a custom command handler to send
363 * the correct signals.
365 * Command handlers are also useful if you want to trigger multiple CAN messages
366 * or signals from a signal OpenXC message.
368 * genericName - The name of the command.
369 * handler - An function to process the received command's data and perform some
372 const char* genericName;
373 CommandHandler handler;
379 const char* genericName;
380 CommandHandler handler;
383 /* Pre initialize actions made before CAN bus initialization
385 * bus - A CanBus struct defining the bus's metadata
386 * writable - configure the controller in a writable mode. If false, it will be
387 * configured as "listen only" and will not allow writes or even CAN ACKs.
388 * buses - An array of all CAN buses.
389 * busCount - The length of the buses array.
391 void pre_initialize(CanBus* bus, bool writable, CanBus* buses, const int busCount);
393 /* Post-initialize actions made after CAN bus initialization and before the
394 * event loop connection.
396 * bus - A CanBus struct defining the bus's metadata
397 * writable - configure the controller in a writable mode. If false, it will be
398 * configured as "listen only" and will not allow writes or even CAN ACKs.
399 * buses - An array of all CAN buses.
400 * busCount - The length of the buses array.
402 void post_initialize(CanBus* bus, bool writable, CanBus* buses, const int busCount);
404 /* Public: Check if the device is connected to an active CAN bus, i.e. it's
405 * received a message in the recent past.
407 * Returns true if a message was received on the CAN bus within
408 * CAN_ACTIVE_TIMEOUT_S seconds.
410 bool isBusActive(CanBus* bus);
412 /* Public: Log transfer statistics about all active CAN buses to the debug log.
414 * buses - an array of active CAN buses.
415 * busCount - the length of the buses array.
417 void logBusStatistics(CanBus* buses, const int busCount);