X-Git-Url: http://rtime.felk.cvut.cz/gitweb/lincan.git/blobdiff_plain/786c7d54e8d820e89997e507c29ea716c0d55fd9..659b098309c2bca57ac60a35a1b9900d6f28e74d:/lincan/include/can.h diff --git a/lincan/include/can.h b/lincan/include/can.h index 6ccb6dc..8247c35 100644 --- a/lincan/include/can.h +++ b/lincan/include/can.h @@ -1,3 +1,6 @@ +#ifndef _CANMSG_T_H +#define _CANMSG_T_H + #include #include @@ -7,6 +10,21 @@ #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, + * %MSG_LOCAL .. message originates from this node. + * @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; @@ -16,10 +34,51 @@ struct canmsg_t { unsigned char data[CAN_MSG_LENGTH]; } PACKED; -/* Definitions to use for canmsg_t flags */ -#define MSG_RTR (1<<0) -#define MSG_OVR (1<<1) -#define MSG_EXT (1<<2) +/** + * 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_OVR .. indication of queue overflow condition, + * %MSG_LOCAL .. message originates from this node. + * there are corresponding mask bits + * %MSG_RTR_MASK, %MSG_EXT_MASK, %MSG_LOCAL_MASK. + * %MSG_PROCESSLOCAL enables local messages processing in the + * combination with global setting + * @queid: CAN queue identification in the case of the multiple + * queues per one user (open instance) + * @cob: communication object number (not used) + * @id: selected required value of cared ID id bits + * @mask: select bits significand for the comparation; + * 1 .. take care about corresponding ID bit, 0 .. don't care + * + * Header: can.h + */ +struct canfilt_t { + int flags; + int queid; + int cob; + unsigned long id; + unsigned long mask; +}; + +/* Definitions to use for canmsg_t and canfilt_t flags */ +#define MSG_RTR (1<<0) +#define MSG_OVR (1<<1) +#define MSG_EXT (1<<2) +#define MSG_LOCAL (1<<3) +/* If you change above lines, check canque_filtid2internal function */ + +/* Additional definitions used for canfilt_t only */ +#define MSG_FILT_MASK_SHIFT 8 +#define MSG_RTR_MASK (MSG_RTR<