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 unsigned char asc2nibble(char c);
  49 /*
  50  * Returns the decimal value of a given ASCII hex character.
  51  *
  52  * While 0..9, a..f, A..F are valid ASCII hex characters.
  53  * On invalid characters the value 16 is returned for error handling.
  54  */
  55
  56 int hexstring2candata(char *arg, struct can_frame *cf);
  57 /*
  58  * Converts a given ASCII hex string to values in the can_frame data[].
  59  *
  60  * A valid ASCII hex string consists of an even number of up to 16 chars.
  61  * Leading zeros '00' in the ASCII hex string are interpreted.
  62  *
  63  * Examples:
  64  *
  65  * "1234"   => data[0] = 0x12, data[1] = 0x34
  66  * "001234" => data[0] = 0x00, data[1] = 0x12, data[2] = 0x34
  67  *
  68  * Return values:
  69  * 0 = success
  70  * 1 = error (in length or the given characters are no ASCII hex characters)
  71  *
  72  * Remark: The not written data[] elements remain unchanged.
  73  *
  74  */
  75
  76 int parse_canframe(char *cs, struct can_frame *cf);
  77 /*
  78  * Transfers a valid ASCII string decribing a CAN frame into struct can_frame.
  79  *
  80  * <can_id>#{R|data}
  81  *
  82  * can_id can have 3 (standard frame format) or 8 (extended frame format)
  83  *        hexadecimal chars
  84  *
  85  * data has 0 to 8 hex-values that can (optionally) be seperated by '.'
  86  *
  87  * Examples:
  88  *
  89  * 123# -> standard CAN-Id = 0x123, dlc = 0
  90  * 12345678# -> extended CAN-Id = 0x12345678, dlc = 0
  91  * 123#R -> standard CAN-Id = 0x123, dlc = 0, RTR-frame
  92  * 7A1#r -> standard CAN-Id = 0x7A1, dlc = 0, RTR-frame
  93  *
  94  * 123#00 -> standard CAN-Id = 0x123, dlc = 1, data[0] = 0x00
  95  * 123#1122334455667788 -> standard CAN-Id = 0x123, dlc = 8
  96  * 123#11.22.33.44.55.66.77.88 -> standard CAN-Id = 0x123, dlc = 8
  97  * 123#11.2233.44556677.88 -> standard CAN-Id = 0x123, dlc = 8
  98  * 32345678#112233 -> error frame with CAN_ERR_FLAG (0x2000000) set
  99  *
 100  * Simple facts on this compact ASCII CAN frame representation:
 101  *
 102  * - 3 digits: standard frame format
 103  * - 8 digits: extendend frame format OR error frame
 104  * - 8 digits with CAN_ERR_FLAG (0x2000000) set: error frame
 105  * - an error frame is never a RTR frame
 106  *
 107  */
 108
 109 void fprint_canframe(FILE *stream , struct can_frame *cf, char *eol, int sep);
 110 void sprint_canframe(char *buf , struct can_frame *cf, int sep);
 111 /*
 112  * Creates a CAN frame hexadecimal output in compact format.
 113  * The CAN data[] is seperated by '.' when sep != 0.
 114  *
 115  * 12345678#112233 -> exended CAN-Id = 0x12345678, dlc = 3, data, sep = 0
 116  * 12345678#R -> exended CAN-Id = 0x12345678, RTR
 117  * 123#11.22.33.44.55.66.77.88 -> standard CAN-Id = 0x123, dlc = 8, sep = 1
 118  * 32345678#112233 -> error frame with CAN_ERR_FLAG (0x2000000) set
 119  *
 120  * Examples:
 121  *
 122  * fprint_canframe(stdout, &frame, "\n", 0); // with eol to STDOUT
 123  * fprint_canframe(stderr, &frame, NULL, 0); // no eol to STDERR
 124  *
 125  */
 126
 127 #define CANLIB_VIEW_ASCII       0x1
 128 #define CANLIB_VIEW_BINARY      0x2
 129 #define CANLIB_VIEW_SWAP        0x4
 130 #define CANLIB_VIEW_ERROR       0x8
 131
 132 #define SWAP_DELIMITER '`'
 133
 134 void fprint_long_canframe(FILE *stream , struct can_frame *cf, char *eol, int view);
 135 void sprint_long_canframe(char *buf , struct can_frame *cf, int view);
 136 /*
 137  * Creates a CAN frame hexadecimal output in user readable format.
 138  *
 139  * 12345678  [3] 11 22 33 -> exended CAN-Id = 0x12345678, dlc = 3, data
 140  * 12345678  [0] remote request -> exended CAN-Id = 0x12345678, RTR
 141  * 14B0DC51  [8] 4A 94 E8 2A EC 58 55 62   'J..*.XUb' -> (with ASCII output)
 142  * 20001111  [7] C6 23 7B 32 69 98 3C      ERRORFRAME -> (CAN_ERR_FLAG set)
 143  *
 144  * Examples:
 145  *
 146  * fprint_long_canframe(stdout, &frame, "\n", 0); // with eol to STDOUT
 147  * fprint_long_canframe(stderr, &frame, NULL, 0); // no eol to STDERR
 148  *
 149  */
 150
 151 void snprintf_can_error_frame(char *buf, size_t len, struct can_frame *cf,
 152                               char *sep);
 153 /*
 154  * Creates a CAN error frame output in user readable format.
 155  */