2 * Copyright 2015-2016 Max Staudt
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License 2 as published
6 * by the Free Software Foundation.
16 #include <sys/types.h>
17 #include <sys/socket.h>
18 #include <linux/can.h>
19 #include <linux/can/raw.h>
21 #include <sys/ioctl.h>
27 #include "vw-nm-tools.h"
33 static void nm_update_my_next_id(struct NM_Main *nm) {
34 unsigned id = nm->my_id;
40 if (id >= nm->max_nodes) {
44 state = nm->nodes[id].state & NM_MAIN_MASK;
46 if (state == NM_MAIN_ON || state == NM_MAIN_LOGIN) {
47 /* We skip limp home nodes */
48 nm->nodes[nm->my_id].next = id;
51 } while (id != nm->my_id);
56 static void nm_handle_can_frame(struct NM_Main *nm, struct can_frame *frame)
61 /* Is this a valid frame within our logical network? */
62 if (!nm_is_rx_frame_valid(nm, frame)) {
66 printf("Received NM frame from CAN ID %03x\n", frame->can_id);
69 /* Parse sender, its perceived successor, and its state */
70 sender = frame->can_id & (nm->max_nodes - 1);
71 next = frame->data[0];
72 state = frame->data[1];
74 /* TODO: Validate state, it needs to be within the enum */
76 /* Skip our own frames */
77 if (sender == nm->my_id) {
81 /* If we're currently stuck in Limp Home mode, and we can see
82 * someone else's messages: reset counters, reset NM, re-login.
84 if ((nm->nodes[nm->my_id].state & NM_MAIN_MASK)
85 == NM_MAIN_LIMPHOME) {
90 nm->nodes[sender].next = next;
91 nm->nodes[sender].state = state;
93 /* Update our view of the world */
94 nm_update_my_next_id(nm);
96 switch (state & NM_MAIN_MASK) {
98 /* We're not alone, so let's transition to ON for now.
100 nm->nodes[nm->my_id].state = NM_MAIN_ON;
102 /* The AWOL timeout is ONLY reset on
103 * NM_MAIN_ON messages.
105 nm_set_timer_awol(nm);
107 if (next == nm->nodes[nm->my_id].next
108 && nm->nodes[nm->my_id].next != nm->my_id) {
109 /* Sender doesn't know we exist */
111 nm->nodes[nm->my_id].state = NM_MAIN_LOGIN;
113 nm_set_timer_now(nm);
115 /* IMPORTANT: The caller needs to check for
116 * timeouts first, i.e. no other NM frames
117 * are received until our correcting login
120 } else if (next == nm->nodes[nm->my_id].next) {
121 /* where (nm->nodes[nm->my_id].next == nm->my_id) */
123 /* It can happen when:
124 * - our sent frames don't go anywhere
125 * - we just logged in and immediately
126 * afterwards another ECU sent a regular
131 } else if (next == nm->my_id) {
132 /* It's our turn, do a normal timeout.
133 * This is a period in which anyone we missed
134 * can send its re-login frame to correct us.
137 nm_set_timer_normal(nm);
139 /* We just received a random ON message. */
145 /* Note: sender != nm->my_id */
147 /* We're not alone anymore, so let's change state. */
148 nm->nodes[nm->my_id].state = NM_MAIN_ON;
150 /* We don't reset the timeout when somebody logs in.
151 * Instead, we'll simply include them in the next
155 /* Nothing else to do. */
157 case NM_MAIN_LIMPHOME:
158 /* Nothing we can do. Poor guy. */
170 static void nm_buildframe(struct NM_Main *nm, struct can_frame *frame)
172 frame->can_id = nm->can_base + nm->my_id;
174 frame->data[0] = nm->nodes[nm->my_id].next;
175 frame->data[1] = nm->nodes[nm->my_id].state;
181 static void nm_timeout_callback(struct NM_Main *nm, struct can_frame *frame)
183 switch(nm->timer_reason) {
185 /* We're due to log in */
186 nm_buildframe(nm, frame);
188 if ((nm->nodes[nm->my_id].state & NM_MAIN_MASK)
191 printf("BUG: TIMER_NOW expired in non-ON state %u\n",
192 nm->nodes[nm->my_id].state & NM_MAIN_MASK);
195 /* We're going to be ready, let's
196 * change state (RCD 310 behavior)
198 nm->nodes[nm->my_id].state = NM_MAIN_ON;
200 nm_set_timer_normal(nm);
202 case NM_TIMER_NORMAL:
203 /* We're due to send our own ring message */
204 nm_buildframe(nm, frame);
206 if ((nm->nodes[nm->my_id].state & NM_MAIN_MASK)
209 printf("BUG: TIMER_NORMAL expired in non-ON state %u\n",
210 nm->nodes[nm->my_id].state & NM_MAIN_MASK);
213 nm_set_timer_awol(nm);
216 /* The network is silent because a node disappeared
217 * or something bad happened.
218 * Reset everything and start over.
221 nm_buildframe(nm, frame);
223 case NM_TIMER_LIMPHOME:
224 printf("Limp home timer expired again :(\n");
226 nm_buildframe(nm, frame);
227 nm_set_timer_limphome(nm);
235 static int net_init(char *ifname)
239 struct sockaddr_can addr;
241 struct can_filter fi;
243 s = socket(PF_CAN, SOCK_RAW, CAN_RAW);
249 /* Convert interface name to index */
250 memset(&ifr.ifr_name, 0, sizeof(ifr.ifr_name));
251 strncpy(ifr.ifr_name, ifname, IFNAMSIZ);
252 if (ioctl(s, SIOCGIFINDEX, &ifr) < 0) {
253 perror("SIOCGIFINDEX");
257 /* Open the CAN interface */
258 memset(&addr, 0, sizeof(addr));
259 addr.can_family = AF_CAN;
260 addr.can_ifindex = ifr.ifr_ifindex;
261 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
266 recv_own_msgs = 1; /* 0 = disabled (default), 1 = enabled */
267 setsockopt(s, SOL_CAN_RAW, CAN_RAW_RECV_OWN_MSGS,
268 &recv_own_msgs, sizeof(recv_own_msgs));
270 /* Handle only 32 NM IDs at CAN base ID 0x420 */
274 setsockopt(s, SOL_CAN_RAW, CAN_RAW_FILTER, &fi, sizeof(struct can_filter));
280 int main(int argc, char **argv)
288 printf("syntax: %s IFNAME MY_ID\n", argv[0]);
292 my_id = strtoul(argv[2], NULL, 0);
294 nm = nm_alloc(5, my_id, 0x420);
296 printf("Out of memory allocating NM struct.\n");
300 s = net_init(argv[1]);
308 retval = select(s+1, &rdfs, NULL, NULL, &nm->tv);
309 /* We currently rely on Linux timeout behavior here,
310 * i.e. the timeout now reflects the remaining time */
314 } else if (!retval) {
315 /* Timeout, we NEED to check this first */
316 struct can_frame frame;
318 nm_timeout_callback(nm, &frame);
320 } else if (FD_ISSET(s, &rdfs)) {
321 struct can_frame frame;
324 ret = read(s, &frame, sizeof(frame));
326 perror("recvfrom CAN socket");
330 nm_handle_can_frame(nm, &frame);