LinCAN sources go through big white-space cleanup.

[lincan.git] / lincan / include / canmsg.h

diff --git a/lincan/include/canmsg.h b/lincan/include/canmsg.h
index 8277b9e1b2d2b8428d4bd0f8b34b91824bf4cdc4..faf846e0aaca52cec17b56ed756bf8f1016bc9cd 100644 (file)
--- a/lincan/include/canmsg.h
+++ b/lincan/include/canmsg.h
@@ -1,3 +1,36 @@
+/**************************************************************************/
+/* File: canmsg.h - common kernel-space and user-space CAN message struct */
+/*                                                                        */
+/* LinCAN - (Not only) Linux CAN bus driver                               */
+/* Copyright (C) 2002-2009 DCE FEE CTU Prague <http://dce.felk.cvut.cz>   */
+/* Copyright (C) 2002-2009 Pavel Pisa <pisa@cmp.felk.cvut.cz>             */
+/* Funded by OCERA and FRESCOR IST projects                               */
+/*                                                                        */
+/* LinCAN is free software; you can redistribute it and/or modify it      */
+/* under terms of the GNU General Public License as published by the      */
+/* Free Software Foundation; either version 2, or (at your option) any    */
+/* later version.  LinCAN is distributed in the hope that it will be      */
+/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
+/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
+/* General Public License for more details. You should have received a    */
+/* copy of the GNU General Public License along with LinCAN; see file     */
+/* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
+/* Cambridge, MA 02139, USA.                                              */
+/*                                                                        */
+/* To allow use of LinCAN in the compact embedded systems firmware        */
+/* and RT-executives (RTEMS for example), main authors agree with next    */
+/* special exception:                                                     */
+/*                                                                        */
+/* Including LinCAN header files in a file, instantiating LinCAN generics */
+/* or templates, or linking other files with LinCAN objects to produce    */
+/* an application image/executable, does not by itself cause the          */
+/* resulting application image/executable to be covered by                */
+/* the GNU General Public License.                                        */
+/* This exception does not however invalidate any other reasons           */
+/* why the executable file might be covered by the GNU Public License.    */
+/* Publication of enhanced or derived LinCAN files is required although.  */
+/**************************************************************************/
+
 #ifndef _CANMSG_T_H
 #define _CANMSG_T_H
 
@@ -8,6 +41,7 @@
 
 #else /* __KERNEL__ */
 
+#include <inttypes.h>
 #include <sys/time.h>
 #include <sys/types.h>
 
@@ -17,10 +51,10 @@
 extern "C" {
 #endif
 
-/* 
+/*
  * CAN_MSG_VERSION_2 enables new canmsg_t layout compatible with
  * can4linux project from http://www.port.de/
- * 
+ *
  */
 #define CAN_MSG_VERSION_2
 
@@ -31,11 +65,13 @@ extern "C" {
 
 typedef struct timeval canmsg_tstamp_t ;
 
+typedef unsigned long canmsg_id_t;
+
 /**
  * struct canmsg_t - structure representing CAN message
  * @flags:  message flags
  *      %MSG_RTR .. message is Remote Transmission Request,
- *     %MSG_EXT .. message with extended ID, 
+ *     %MSG_EXT .. message with extended ID,
  *      %MSG_OVR .. indication of queue overflow condition,
  *     %MSG_LOCAL .. message originates from this node.
  * @cob:    communication object number (not used)
@@ -49,7 +85,7 @@ typedef struct timeval canmsg_tstamp_t ;
 struct canmsg_t {
        int             flags;
        int             cob;
-       unsigned long   id;
+       canmsg_id_t     id;
        canmsg_tstamp_t timestamp;
        unsigned short  length;
        unsigned char   data[CAN_MSG_LENGTH];
@@ -63,7 +99,7 @@ struct canmsg_t {
 struct canmsg_t {
        short           flags;
        int             cob;
-       unsigned long   id;
+       canmsg_id_t     id;
        unsigned long   timestamp;
        unsigned int    length;
        unsigned char   data[CAN_MSG_LENGTH];
@@ -76,7 +112,7 @@ typedef struct canmsg_t canmsg_t;
  * struct canfilt_t - structure for acceptance filter setup
  * @flags:  message flags
  *      %MSG_RTR .. message is Remote Transmission Request,
- *     %MSG_EXT .. message with extended ID, 
+ *     %MSG_EXT .. message with extended ID,
  *      %MSG_OVR .. indication of queue overflow condition,
  *     %MSG_LOCAL .. message originates from this node.
  *     there are corresponding mask bits
@@ -96,8 +132,8 @@ struct canfilt_t {
        int             flags;
        int             queid;
        int             cob;
-       unsigned long   id;
-       unsigned long   mask;
+       canmsg_id_t     id;
+       canmsg_id_t     mask;
 };
 
 typedef struct canfilt_t canfilt_t;