can-utils: trivial: fix typos concerning "separation" and "useful"
[profile/ivi/can-utils.git] / lib.h
1 /*
2  * lib.h - library include for command line tools
3  *
4  * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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.
18  *
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.
23  *
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.
26  *
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
38  * DAMAGE.
39  *
40  * Send feedback to <linux-can@vger.kernel.org>
41  *
42  */
43
44 /* buffer sizes for CAN frame string representations */
45
46 #define CL_ID (sizeof("12345678##1"))
47 #define CL_DATA sizeof(".AA")
48 #define CL_BINDATA sizeof(".10101010")
49
50  /* CAN FD ASCII hex short representation with DATA_SEPERATORs */
51 #define CL_CFSZ (2*CL_ID + 64*CL_DATA)
52
53 /* CAN FD ASCII hex long representation with binary output */
54 #define CL_LONGCFSZ (2*CL_ID + sizeof("   [255]  ") + (64*CL_BINDATA))
55
56 /* CAN DLC to real data length conversion helpers especially for CAN FD */
57
58 /* get data length from can_dlc with sanitized can_dlc */
59 unsigned char can_dlc2len(unsigned char can_dlc);
60
61 /* map the sanitized data length to an appropriate data length code */
62 unsigned char can_len2dlc(unsigned char len);
63
64 unsigned char asc2nibble(char c);
65 /*
66  * Returns the decimal value of a given ASCII hex character.
67  *
68  * While 0..9, a..f, A..F are valid ASCII hex characters.
69  * On invalid characters the value 16 is returned for error handling.
70  */
71
72 int hexstring2data(char *arg, unsigned char *data, int maxdlen);
73 /*
74  * Converts a given ASCII hex string to a (binary) byte string.
75  *
76  * A valid ASCII hex string consists of an even number of up to 16 chars.
77  * Leading zeros '00' in the ASCII hex string are interpreted.
78  *
79  * Examples:
80  *
81  * "1234"   => data[0] = 0x12, data[1] = 0x34
82  * "001234" => data[0] = 0x00, data[1] = 0x12, data[2] = 0x34
83  *
84  * Return values:
85  * 0 = success
86  * 1 = error (in length or the given characters are no ASCII hex characters)
87  *
88  * Remark: The not written data[] elements are initialized with zero.
89  *
90  */
91
92 int parse_canframe(char *cs, struct canfd_frame *cf);
93 /*
94  * Transfers a valid ASCII string decribing a CAN frame into struct canfd_frame.
95  *
96  * CAN 2.0 frames
97  * - string layout <can_id>#{R{len}|data}
98  * - {data} has 0 to 8 hex-values that can (optionally) be separated by '.'
99  * - {len} can take values from 0 to 8 and can be omitted if zero
100  * - return value on successful parsing: CAN_MTU
101  *
102  * CAN FD frames
103  * - string layout <can_id>##<flags>{data}
104  * - <flags> a single ASCII Hex value (0 .. F) which defines canfd_frame.flags
105  * - {data} has 0 to 64 hex-values that can (optionally) be separated by '.'
106  * - return value on successful parsing: CANFD_MTU
107  *
108  * Return value on detected problems: 0
109  *
110  * <can_id> can have 3 (standard frame format) or 8 (extended frame format)
111  * hexadecimal chars
112  *
113  *
114  * Examples:
115  *
116  * 123# -> standard CAN-Id = 0x123, len = 0
117  * 12345678# -> extended CAN-Id = 0x12345678, len = 0
118  * 123#R -> standard CAN-Id = 0x123, len = 0, RTR-frame
119  * 123#R0 -> standard CAN-Id = 0x123, len = 0, RTR-frame
120  * 123#R7 -> standard CAN-Id = 0x123, len = 7, RTR-frame
121  * 7A1#r -> standard CAN-Id = 0x7A1, len = 0, RTR-frame
122  *
123  * 123#00 -> standard CAN-Id = 0x123, len = 1, data[0] = 0x00
124  * 123#1122334455667788 -> standard CAN-Id = 0x123, len = 8
125  * 123#11.22.33.44.55.66.77.88 -> standard CAN-Id = 0x123, len = 8
126  * 123#11.2233.44556677.88 -> standard CAN-Id = 0x123, len = 8
127  * 32345678#112233 -> error frame with CAN_ERR_FLAG (0x2000000) set
128  *
129  * 123##0112233 -> CAN FD frame standard CAN-Id = 0x123, flags = 0, len = 3
130  * 123##1112233 -> CAN FD frame, flags = CANFD_BRS, len = 3
131  * 123##2112233 -> CAN FD frame, flags = CANFD_ESI, len = 3
132  * 123##3 -> CAN FD frame, flags = (CANFD_ESI | CANFD_BRS), len = 0
133  *     ^^
134  *     CAN FD extension to handle the canfd_frame.flags content
135  *
136  * Simple facts on this compact ASCII CAN frame representation:
137  *
138  * - 3 digits: standard frame format
139  * - 8 digits: extendend frame format OR error frame
140  * - 8 digits with CAN_ERR_FLAG (0x2000000) set: error frame
141  * - an error frame is never a RTR frame
142  * - CAN FD frames do not have a RTR bit
143  */
144
145 void fprint_canframe(FILE *stream , struct canfd_frame *cf, char *eol, int sep, int maxdlen);
146 void sprint_canframe(char *buf , struct canfd_frame *cf, int sep, int maxdlen);
147 /*
148  * Creates a CAN frame hexadecimal output in compact format.
149  * The CAN data[] is separated by '.' when sep != 0.
150  *
151  * The type of the CAN frame (CAN 2.0 / CAN FD) is specified by maxdlen:
152  * maxdlen = 8 -> CAN2.0 frame
153  * maxdlen = 64 -> CAN FD frame
154  *
155  * 12345678#112233 -> extended CAN-Id = 0x12345678, len = 3, data, sep = 0
156  * 12345678#R -> extended CAN-Id = 0x12345678, RTR, len = 0
157  * 12345678#R5 -> extended CAN-Id = 0x12345678, RTR, len = 5
158  * 123#11.22.33.44.55.66.77.88 -> standard CAN-Id = 0x123, dlc = 8, sep = 1
159  * 32345678#112233 -> error frame with CAN_ERR_FLAG (0x2000000) set
160  * 123##0112233 -> CAN FD frame standard CAN-Id = 0x123, flags = 0, len = 3
161  * 123##2112233 -> CAN FD frame, flags = CANFD_ESI, len = 3
162  *
163  * Examples:
164  *
165  * fprint_canframe(stdout, &frame, "\n", 0); // with eol to STDOUT
166  * fprint_canframe(stderr, &frame, NULL, 0); // no eol to STDERR
167  *
168  */
169
170 #define CANLIB_VIEW_ASCII       0x1
171 #define CANLIB_VIEW_BINARY      0x2
172 #define CANLIB_VIEW_SWAP        0x4
173 #define CANLIB_VIEW_ERROR       0x8
174 #define CANLIB_VIEW_INDENT_SFF  0x10
175
176 #define SWAP_DELIMITER '`'
177
178 void fprint_long_canframe(FILE *stream , struct canfd_frame *cf, char *eol, int view, int maxdlen);
179 void sprint_long_canframe(char *buf , struct canfd_frame *cf, int view, int maxdlen);
180 /*
181  * Creates a CAN frame hexadecimal output in user readable format.
182  *
183  * The type of the CAN frame (CAN 2.0 / CAN FD) is specified by maxdlen:
184  * maxdlen = 8 -> CAN2.0 frame
185  * maxdlen = 64 -> CAN FD frame
186  *
187  * 12345678   [3]  11 22 33 -> extended CAN-Id = 0x12345678, dlc = 3, data
188  * 12345678   [0]  remote request -> extended CAN-Id = 0x12345678, RTR
189  * 14B0DC51   [8]  4A 94 E8 2A EC 58 55 62   'J..*.XUb' -> (with ASCII output)
190  * 20001111   [7]  C6 23 7B 32 69 98 3C      ERRORFRAME -> (CAN_ERR_FLAG set)
191  * 12345678  [03]  11 22 33 -> CAN FD with extended CAN-Id = 0x12345678, dlc = 3
192  *
193  * 123   [3]  11 22 33         -> CANLIB_VIEW_INDENT_SFF == 0
194  *      123   [3]  11 22 33    -> CANLIB_VIEW_INDENT_SFF == set
195  *
196  * Examples:
197  *
198  * // CAN FD frame with eol to STDOUT
199  * fprint_long_canframe(stdout, &frame, "\n", 0, CANFD_MAX_DLEN);
200  *
201  * // CAN 2.0 frame without eol to STDERR
202  * fprint_long_canframe(stderr, &frame, NULL, 0, CAN_MAX_DLEN);
203  *
204  */
205
206 void snprintf_can_error_frame(char *buf, size_t len, struct canfd_frame *cf,
207                               char *sep);
208 /*
209  * Creates a CAN error frame output in user readable format.
210  */