lib.h

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