Introduced new functions:

[socketcan-devel.git] / can-utils / lib.h

diff --git a/can-utils/lib.h b/can-utils/lib.h
index 70d440d445c193dc44c61fbe7305ca79727131a9..07daa247393f15bf992f1af5418235a52e15fe5e 100644 (file)
--- a/can-utils/lib.h
+++ b/can-utils/lib.h
@@ -5,15 +5,14 @@
 /*
  * lib.h - library include for command line tools
  *
- * Copyright (c) 2002-2005 Volkswagen Group Electronic Research
+ * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * 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 and 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.
@@ -97,8 +124,11 @@ 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
+
+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.
  *