2 * isotpdump.c - dump and explain ISO15765-2 protocol CAN frames
4 * Copyright (c) 2008 Volkswagen Group Electronic Research
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of Volkswagen nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * Alternatively, provided that this notice is retained in full, this
20 * software may be distributed under the terms of the GNU General
21 * Public License ("GPL") version 2, in which case the provisions of the
22 * GPL apply INSTEAD OF those given above.
24 * The provided data structures and external interfaces from this code
25 * are not restricted to be used by modules with a GPL compatible license.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
40 * Send feedback to <linux-can@vger.kernel.org>
52 #include <sys/types.h>
53 #include <sys/socket.h>
54 #include <sys/ioctl.h>
56 #include <linux/can.h>
57 #include <linux/can/raw.h>
60 #define NO_CAN_ID 0xFFFFFFFFU
62 const char fc_info [4][9] = { "CTS", "WT", "OVFLW", "reserved" };
63 const int canfd_on = 1;
65 void print_usage(char *prg)
67 fprintf(stderr, "\nUsage: %s [options] <CAN interface>\n", prg);
68 fprintf(stderr, "Options: -s <can_id> (source can_id. Use 8 digits for extended IDs)\n");
69 fprintf(stderr, " -d <can_id> (destination can_id. Use 8 digits for extended IDs)\n");
70 fprintf(stderr, " -x <addr> (extended addressing mode. Use 'any' for all addresses)\n");
71 fprintf(stderr, " -X <addr> (extended addressing mode (rx addr). Use 'any' for all)\n");
72 fprintf(stderr, " -c (color mode)\n");
73 fprintf(stderr, " -a (print data also in ASCII-chars)\n");
74 fprintf(stderr, " -t <type> (timestamp: (a)bsolute/(d)elta/(z)ero/(A)bsolute w date)\n");
75 fprintf(stderr, "\nCAN IDs and addresses are given and expected in hexadecimal values.\n");
76 fprintf(stderr, "\n");
79 int main(int argc, char **argv)
82 struct sockaddr_can addr;
83 struct can_filter rfilter[2];
84 struct canfd_frame frame;
86 canid_t src = NO_CAN_ID;
87 canid_t dst = NO_CAN_ID;
98 unsigned long fflen = 0;
101 struct timeval tv, last_tv;
108 while ((opt = getopt(argc, argv, "s:d:ax:X:ct:?")) != -1) {
111 src = strtoul(optarg, (char **)NULL, 16);
112 if (strlen(optarg) > 7)
117 dst = strtoul(optarg, (char **)NULL, 16);
118 if (strlen(optarg) > 7)
132 if (!strncmp(optarg, "any", 3))
135 extaddr = strtoul(optarg, (char **)NULL, 16) & 0xFF;
140 if (!strncmp(optarg, "any", 3))
143 rx_extaddr = strtoul(optarg, (char **)NULL, 16) & 0xFF;
147 timestamp = optarg[0];
148 if ((timestamp != 'a') && (timestamp != 'A') &&
149 (timestamp != 'd') && (timestamp != 'z')) {
150 printf("%s: unknown timestamp mode '%c' - ignored\n",
151 basename(argv[0]), optarg[0]);
157 print_usage(basename(argv[0]));
162 fprintf(stderr, "Unknown option %c\n", opt);
163 print_usage(basename(argv[0]));
169 if (rx_ext && !ext) {
170 print_usage(basename(argv[0]));
174 if ((argc - optind) != 1 || src == NO_CAN_ID || dst == NO_CAN_ID) {
175 print_usage(basename(argv[0]));
179 if ((s = socket(PF_CAN, SOCK_RAW, CAN_RAW)) < 0) {
184 /* try to switch the socket into CAN FD mode */
185 setsockopt(s, SOL_CAN_RAW, CAN_RAW_FD_FRAMES, &canfd_on, sizeof(canfd_on));
187 if (src & CAN_EFF_FLAG) {
188 rfilter[0].can_id = src & (CAN_EFF_MASK | CAN_EFF_FLAG);
189 rfilter[0].can_mask = (CAN_EFF_MASK|CAN_EFF_FLAG|CAN_RTR_FLAG);
191 rfilter[0].can_id = src & CAN_SFF_MASK;
192 rfilter[0].can_mask = (CAN_SFF_MASK|CAN_EFF_FLAG|CAN_RTR_FLAG);
195 if (dst & CAN_EFF_FLAG) {
196 rfilter[1].can_id = dst & (CAN_EFF_MASK | CAN_EFF_FLAG);
197 rfilter[1].can_mask = (CAN_EFF_MASK|CAN_EFF_FLAG|CAN_RTR_FLAG);
199 rfilter[1].can_id = dst & CAN_SFF_MASK;
200 rfilter[1].can_mask = (CAN_SFF_MASK|CAN_EFF_FLAG|CAN_RTR_FLAG);
203 setsockopt(s, SOL_CAN_RAW, CAN_RAW_FILTER, &rfilter, sizeof(rfilter));
205 strcpy(ifr.ifr_name, argv[optind]);
206 ioctl(s, SIOCGIFINDEX, &ifr);
207 ifindex = ifr.ifr_ifindex;
209 addr.can_family = AF_CAN;
210 addr.can_ifindex = ifindex;
212 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
218 nbytes = read(s, &frame, sizeof(frame));
222 } else if (nbytes != CAN_MTU && nbytes != CANFD_MTU) {
223 fprintf(stderr, "read: incomplete CAN frame %lu %d\n", sizeof(frame), nbytes);
227 if (frame.can_id == src && ext && !extany && extaddr != frame.data[0])
230 if (frame.can_id == dst && rx_ext && !rx_extany && rx_extaddr != frame.data[0])
234 printf("%s", (frame.can_id == src)? FGRED:FGBLUE);
237 ioctl(s, SIOCGSTAMP, &tv);
242 case 'a': /* absolute with timestamp */
243 printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
246 case 'A': /* absolute with date */
251 tm = *localtime(&tv.tv_sec);
252 strftime(timestring, 24, "%Y-%m-%d %H:%M:%S", &tm);
253 printf("(%s.%06ld) ", timestring, tv.tv_usec);
257 case 'd': /* delta */
258 case 'z': /* starting with zero */
262 if (last_tv.tv_sec == 0) /* first init */
264 diff.tv_sec = tv.tv_sec - last_tv.tv_sec;
265 diff.tv_usec = tv.tv_usec - last_tv.tv_usec;
266 if (diff.tv_usec < 0)
267 diff.tv_sec--, diff.tv_usec += 1000000;
269 diff.tv_sec = diff.tv_usec = 0;
270 printf("(%ld.%06ld) ", diff.tv_sec, diff.tv_usec);
272 if (timestamp == 'd')
273 last_tv = tv; /* update for delta calculation */
277 default: /* no timestamp output */
282 if (frame.can_id & CAN_EFF_FLAG)
283 printf(" %s %8X", argv[optind], frame.can_id & CAN_EFF_MASK);
285 printf(" %s %3X", argv[optind], frame.can_id & CAN_SFF_MASK);
288 printf("{%02X}", frame.data[0]);
290 if (nbytes == CAN_MTU)
291 printf(" [%d] ", frame.len);
293 printf(" [%02d] ", frame.len);
296 n_pci = frame.data[ext];
298 switch (n_pci & 0xF0) {
301 printf("[SF] ln: %-4d data:", n_pci & 0xF);
304 printf("[SF] ln: %-4d data:", frame.data[ext + 1]);
310 fflen = ((n_pci & 0x0F)<<8) + frame.data[ext+1];
314 fflen = (frame.data[ext+2]<<24) +
315 (frame.data[ext+3]<<16) +
316 (frame.data[ext+4]<<8) +
320 printf("[FF] ln: %-4lu data:", fflen);
324 printf("[CF] sn: %X data:", n_pci & 0x0F);
330 printf("[FC] FC: %d ", n_pci);
335 printf("= %s # ", fc_info[n_pci]);
337 printf("BS: %d %s# ", frame.data[ext+1],
338 (frame.data[ext+1])? "":"= off ");
340 i = frame.data[ext+2];
341 printf("STmin: 0x%02X = ", i);
345 else if (i > 0xF0 && i < 0xFA)
346 printf("%d us", (i & 0x0F) * 100);
355 if (datidx && frame.len > datidx) {
357 for (i = datidx; i < frame.len; i++) {
358 printf("%02X ", frame.data[i]);
362 printf("%*s", ((7-ext) - (frame.len-datidx))*3 + 5 ,
364 for (i = datidx; i < frame.len; i++) {
365 printf("%c",((frame.data[i] > 0x1F) &&
366 (frame.data[i] < 0x7F))?
367 frame.data[i] : '.');
374 printf("%s", ATTRESET);