include/linux/can/bcm.h

   1 /*
   2  * linux/can/bcm.h
   3  *
   4  * Definitions for CAN Broadcast Manager (BCM)
   5  *
   6  * Author: Oliver Hartkopp <oliver.hartkopp@volkswagen.de>
   7  * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
   8  * All rights reserved.
   9  *
  10  * Send feedback to <socketcan-users@lists.berlios.de>
  11  *
  12  */
  13
  14 #ifndef CAN_BCM_H
  15 #define CAN_BCM_H
  16
  17 #include <linux/types.h>
  18
  19 /**
  20  * struct bcm_msg_head - head of messages to/from the broadcast manager
  21  * @opcode:    opcode, see enum below.
  22  * @flags:     special flags, see below.
  23  * @count:     number of frames to send before changing interval.
  24  * @ival1:     interval for the first @count frames.
  25  * @ival2:     interval for the following frames.
  26  * @can_id:    CAN ID of frames to be sent or received.
  27  * @nframes:   number of frames appended to the message head.
  28  * @frames:    array of CAN frames.
  29  */
  30 struct bcm_msg_head {
  31         __u32 opcode;
  32         __u32 flags;
  33         __u32 count;
  34         struct timeval ival1, ival2;
  35         canid_t can_id;
  36         __u32 nframes;
  37         struct can_frame frames[0];
  38 };
  39
  40 enum {
  41         TX_SETUP = 1,   /* create (cyclic) transmission task */
  42         TX_DELETE,      /* remove (cyclic) transmission task */
  43         TX_READ,        /* read properties of (cyclic) transmission task */
  44         TX_SEND,        /* send one CAN frame */
  45         RX_SETUP,       /* create RX content filter subscription */
  46         RX_DELETE,      /* remove RX content filter subscription */
  47         RX_READ,        /* read properties of RX content filter subscription */
  48         TX_STATUS,      /* reply to TX_READ request */
  49         TX_EXPIRED,     /* notification on performed transmissions (count=0) */
  50         RX_STATUS,      /* reply to RX_READ request */
  51         RX_TIMEOUT,     /* cyclic message is absent */
  52         RX_CHANGED      /* updated CAN frame (detected content change) */
  53 };
  54
  55 #define SETTIMER            0x0001
  56 #define STARTTIMER          0x0002
  57 #define TX_COUNTEVT         0x0004
  58 #define TX_ANNOUNCE         0x0008
  59 #define TX_CP_CAN_ID        0x0010
  60 #define RX_FILTER_ID        0x0020
  61 #define RX_CHECK_DLC        0x0040
  62 #define RX_NO_AUTOTIMER     0x0080
  63 #define RX_ANNOUNCE_RESUME  0x0100
  64 #define TX_RESET_MULTI_IDX  0x0200
  65 #define RX_RTR_FRAME        0x0400
  66
  67 #endif /* CAN_BCM_H */