LinCAN driver major structured comments and documentation update

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

diff --git a/lincan/include/can.h b/lincan/include/can.h
index 071deae0a4681c918862efef10591bd77532f2bb..344dcf67ed767ae136db5175fd897cf134c16c10 100644 (file)
--- a/lincan/include/can.h
+++ b/lincan/include/can.h
@@ -1,3 +1,6 @@
+#ifndef _CANMSG_T_H
+#define _CANMSG_T_H
+
 #include <linux/types.h>
 #include <linux/ioctl.h>
 
@@ -7,15 +10,35 @@
 
 #define CAN_MSG_LENGTH 8
 
+/**
+ * struct canmsg_t - structure representing CAN message
+ * @flags:  message flags, %MSG_RTR .. message is Remote Transmission Request,
+ *     %MSG_EXT .. message with extended ID, %MSG_OVR indication of queue
+ *     overflow condition
+ * @cob:    communication object number (not used)
+ * @id:     ID of CAN message
+ * @timestamp: not used
+ * @length: length of used data
+ * @data:   data bytes buffer
+ *
+ * Header: can.h
+ */
 struct canmsg_t {
        short           flags;
        int             cob;
        unsigned long   id;
        unsigned long   timestamp;
        unsigned int    length;
-       char            data[CAN_MSG_LENGTH];
+       unsigned char   data[CAN_MSG_LENGTH];
 } PACKED;
 
+struct canfilt_t {
+       int             flags;
+       int             cob;
+       unsigned long   id;
+       unsigned long   mask;
+};
+
 /* Definitions to use for canmsg_t flags */
 #define MSG_RTR (1<<0)
 #define MSG_OVR (1<<1)
@@ -24,22 +47,25 @@ struct canmsg_t {
 /* CAN ioctl magic number */
 #define CAN_IOC_MAGIC 'd'
 
-unsigned long bittiming;
-unsigned short channel;
+typedef unsigned long bittiming_t;
+typedef unsigned short channel_t;
 
 /* CAN ioctl functions */
-#define CMD_START _IOW(CAN_IOC_MAGIC, 1, channel)
-#define CMD_STOP _IOW(CAN_IOC_MAGIC, 2, channel)
+#define CMD_START _IOW(CAN_IOC_MAGIC, 1, channel_t)
+#define CMD_STOP _IOW(CAN_IOC_MAGIC, 2, channel_t)
 //#define CMD_RESET 3
 
-#define CONF_BAUD _IOW(CAN_IOC_MAGIC, 4, bittiming)
+#define CONF_BAUD _IOW(CAN_IOC_MAGIC, 4, bittiming_t)
 //#define CONF_ACCM
 //#define CONF_XTDACCM
 //#define CONF_TIMING
 //#define CONF_OMODE
 #define CONF_FILTER _IOW(CAN_IOC_MAGIC, 8, unsigned char)
+
 //#define CONF_FENABLE
 //#define CONF_FDISABLE
 
-
 #define STAT _IO(CAN_IOC_MAGIC, 9)
+#define CONF_FILTER_QUE0 _IOW(CAN_IOC_MAGIC, 10, struct canfilt_t)
+
+#endif /*_CANMSG_T_H*/