candump: add option -e to dump error messages in human readable format

[sojka/can-utils.git] / lib.h

diff --git a/lib.h b/lib.h
index 1b9bfd9010ac154a40036fb388a6336eb6ece800..88ecfefa56cb34a60bba87377a2f7e6abbfaa453 100644 (file)
--- a/lib.h
+++ b/lib.h
@@ -12,8 +12,7 @@
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions, the following disclaimer and
- *    the referenced file 'COPYING'.
+ *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
@@ -23,8 +22,8 @@
  *
  * Alternatively, provided that this notice is retained in full, this
  * software may be distributed under the terms of the GNU General
- * Public License ("GPL") version 2 as distributed in the 'COPYING'
- * file from the main directory of the linux kernel source.
+ * Public License ("GPL") version 2, in which case the provisions of the
+ * GPL apply INSTEAD OF those given above.
  *
  * The provided data structures and external interfaces from this code
  * are not restricted to be used by modules with a GPL compatible license.
@@ -46,6 +45,34 @@
  *
  */
 
+unsigned char asc2nibble(char c);
+/*
+ * Returns the decimal value of a given ASCII hex character.
+ *
+ * While 0..9, a..f, A..F are valid ASCII hex characters.
+ * On invalid characters the value 16 is returned for error handling.
+ */
+
+int hexstring2candata(char *arg, struct can_frame *cf);
+/*
+ * Converts a given ASCII hex string to values in the can_frame data[].
+ *
+ * A valid ASCII hex string consists of an even number of up to 16 chars.
+ * Leading zeros '00' in the ASCII hex string are interpreted.
+ *
+ * Examples:
+ *
+ * "1234"   => data[0] = 0x12, data[1] = 0x34
+ * "001234" => data[0] = 0x00, data[1] = 0x12, data[2] = 0x34
+ *
+ * Return values:
+ * 0 = success
+ * 1 = error (in length or the given characters are no ASCII hex characters)
+ *
+ * Remark: The not written data[] elements remain unchanged.
+ *
+ */
+
 int parse_canframe(char *cs, struct can_frame *cf);
 /*
  * Transfers a valid ASCII string decribing a CAN frame into struct can_frame.
@@ -60,7 +87,7 @@ int parse_canframe(char *cs, struct can_frame *cf);
  * Examples:
  *
  * 123# -> standard CAN-Id = 0x123, dlc = 0
- * 12345678# -> exended CAN-Id = 0x12345678, dlc = 0
+ * 12345678# -> extended CAN-Id = 0x12345678, dlc = 0
  * 123#R -> standard CAN-Id = 0x123, dlc = 0, RTR-frame
  * 7A1#r -> standard CAN-Id = 0x7A1, dlc = 0, RTR-frame
  *
@@ -97,8 +124,15 @@ void sprint_canframe(char *buf , struct can_frame *cf, int sep);
  *
  */
 
-void fprint_long_canframe(FILE *stream , struct can_frame *cf, char *eol, int ascii);
-void sprint_long_canframe(char *buf , struct can_frame *cf, int ascii);
+#define CANLIB_VIEW_ASCII      0x1
+#define CANLIB_VIEW_BINARY     0x2
+#define CANLIB_VIEW_SWAP       0x4
+#define CANLIB_VIEW_ERROR      0x8
+
+#define SWAP_DELIMITER '`'
+
+void fprint_long_canframe(FILE *stream , struct can_frame *cf, char *eol, int view);
+void sprint_long_canframe(char *buf , struct can_frame *cf, int view);
 /*
  * Creates a CAN frame hexadecimal output in user readable format.
  *
@@ -113,3 +147,9 @@ void sprint_long_canframe(char *buf , struct can_frame *cf, int ascii);
  * fprint_long_canframe(stderr, &frame, NULL, 0); // no eol to STDERR
  *
  */
+
+void snprintf_can_error_frame(char *buf, int len, struct can_frame *cf,
+                             char *sep);
+/*
+ * Creates a CAN error frame output in user readable format.
+ */