lib.h

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