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