6 * lib.h - library include for command line tools
8 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of Volkswagen nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * Alternatively, provided that this notice is retained in full, this
24 * software may be distributed under the terms of the GNU General
25 * Public License ("GPL") version 2, in which case the provisions of the
26 * GPL apply INSTEAD OF those given above.
28 * The provided data structures and external interfaces from this code
29 * are not restricted to be used by modules with a GPL compatible license.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
44 * Send feedback to <socketcan-users@lists.berlios.de>
48 int parse_canframe(char *cs, struct can_frame *cf);
50 * Transfers a valid ASCII string decribing a CAN frame into struct can_frame.
54 * can_id can have 3 (standard frame format) or 8 (extended frame format)
57 * data has 0 to 8 hex-values that can (optionally) be seperated by '.'
61 * 123# -> standard CAN-Id = 0x123, dlc = 0
62 * 12345678# -> exended CAN-Id = 0x12345678, dlc = 0
63 * 123#R -> standard CAN-Id = 0x123, dlc = 0, RTR-frame
64 * 7A1#r -> standard CAN-Id = 0x7A1, dlc = 0, RTR-frame
66 * 123#00 -> standard CAN-Id = 0x123, dlc = 1, data[0] = 0x00
67 * 123#1122334455667788 -> standard CAN-Id = 0x123, dlc = 8
68 * 123#11.22.33.44.55.66.77.88 -> standard CAN-Id = 0x123, dlc = 8
69 * 123#11.2233.44556677.88 -> standard CAN-Id = 0x123, dlc = 8
70 * 32345678#112233 -> error frame with CAN_ERR_FLAG (0x2000000) set
72 * Simple facts on this compact ASCII CAN frame representation:
74 * - 3 digits: standard frame format
75 * - 8 digits: extendend frame format OR error frame
76 * - 8 digits with CAN_ERR_FLAG (0x2000000) set: error frame
77 * - an error frame is never a RTR frame
81 void fprint_canframe(FILE *stream , struct can_frame *cf, char *eol, int sep);
82 void sprint_canframe(char *buf , struct can_frame *cf, int sep);
84 * Creates a CAN frame hexadecimal output in compact format.
85 * The CAN data[] is seperated by '.' when sep != 0.
87 * 12345678#112233 -> exended CAN-Id = 0x12345678, dlc = 3, data, sep = 0
88 * 12345678#R -> exended CAN-Id = 0x12345678, RTR
89 * 123#11.22.33.44.55.66.77.88 -> standard CAN-Id = 0x123, dlc = 8, sep = 1
90 * 32345678#112233 -> error frame with CAN_ERR_FLAG (0x2000000) set
94 * fprint_canframe(stdout, &frame, "\n", 0); // with eol to STDOUT
95 * fprint_canframe(stderr, &frame, NULL, 0); // no eol to STDERR
99 void fprint_long_canframe(FILE *stream , struct can_frame *cf, char *eol, int ascii);
100 void sprint_long_canframe(char *buf , struct can_frame *cf, int ascii);
102 * Creates a CAN frame hexadecimal output in user readable format.
104 * 12345678 [3] 11 22 33 -> exended CAN-Id = 0x12345678, dlc = 3, data
105 * 12345678 [0] remote request -> exended CAN-Id = 0x12345678, RTR
106 * 14B0DC51 [8] 4A 94 E8 2A EC 58 55 62 'J..*.XUb' -> (with ASCII output)
107 * 20001111 [7] C6 23 7B 32 69 98 3C ERRORFRAME -> (CAN_ERR_FLAG set)
111 * fprint_long_canframe(stdout, &frame, "\n", 0); // with eol to STDOUT
112 * fprint_long_canframe(stderr, &frame, NULL, 0); // no eol to STDERR