]>
Commit | Line | Data |
---|---|---|
ffd980f9 OH |
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 | * | |
2485602f UKK |
10 | * Redistribution and use in source and binary forms, with or without |
11 | * modification, are permitted provided that the following conditions | |
12 | * are met: | |
13 | * 1. Redistributions of source code must retain the above copyright | |
14 | * notice, this list of conditions and the following disclaimer. | |
15 | * 2. Redistributions in binary form must reproduce the above copyright | |
16 | * notice, this list of conditions and the following disclaimer in the | |
17 | * documentation and/or other materials provided with the distribution. | |
18 | * 3. Neither the name of Volkswagen nor the names of its contributors | |
19 | * may be used to endorse or promote products derived from this software | |
20 | * without specific prior written permission. | |
21 | * | |
22 | * Alternatively, provided that this notice is retained in full, this | |
23 | * software may be distributed under the terms of the GNU General | |
24 | * Public License ("GPL") version 2, in which case the provisions of the | |
25 | * GPL apply INSTEAD OF those given above. | |
26 | * | |
27 | * The provided data structures and external interfaces from this code | |
28 | * are not restricted to be used by modules with a GPL compatible license. | |
29 | * | |
30 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
31 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
32 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
33 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
34 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
35 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
36 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
37 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
38 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
39 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
40 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH | |
41 | * DAMAGE. | |
ffd980f9 OH |
42 | */ |
43 | ||
42193e3e OH |
44 | #ifndef _UAPI_CAN_BCM_H |
45 | #define _UAPI_CAN_BCM_H | |
ffd980f9 | 46 | |
9d6aa4c7 | 47 | #include <linux/types.h> |
767df1c7 | 48 | #include <linux/can.h> |
9d6aa4c7 | 49 | |
ba61a8d9 AB |
50 | struct bcm_timeval { |
51 | long tv_sec; | |
52 | long tv_usec; | |
53 | }; | |
54 | ||
ffd980f9 OH |
55 | /** |
56 | * struct bcm_msg_head - head of messages to/from the broadcast manager | |
57 | * @opcode: opcode, see enum below. | |
58 | * @flags: special flags, see below. | |
59 | * @count: number of frames to send before changing interval. | |
60 | * @ival1: interval for the first @count frames. | |
61 | * @ival2: interval for the following frames. | |
62 | * @can_id: CAN ID of frames to be sent or received. | |
63 | * @nframes: number of frames appended to the message head. | |
64 | * @frames: array of CAN frames. | |
65 | */ | |
66 | struct bcm_msg_head { | |
4195e317 OH |
67 | __u32 opcode; |
68 | __u32 flags; | |
69 | __u32 count; | |
ba61a8d9 | 70 | struct bcm_timeval ival1, ival2; |
ffd980f9 | 71 | canid_t can_id; |
4195e317 | 72 | __u32 nframes; |
ffd980f9 OH |
73 | struct can_frame frames[0]; |
74 | }; | |
75 | ||
76 | enum { | |
77 | TX_SETUP = 1, /* create (cyclic) transmission task */ | |
78 | TX_DELETE, /* remove (cyclic) transmission task */ | |
79 | TX_READ, /* read properties of (cyclic) transmission task */ | |
80 | TX_SEND, /* send one CAN frame */ | |
81 | RX_SETUP, /* create RX content filter subscription */ | |
82 | RX_DELETE, /* remove RX content filter subscription */ | |
83 | RX_READ, /* read properties of RX content filter subscription */ | |
84 | TX_STATUS, /* reply to TX_READ request */ | |
85 | TX_EXPIRED, /* notification on performed transmissions (count=0) */ | |
86 | RX_STATUS, /* reply to RX_READ request */ | |
87 | RX_TIMEOUT, /* cyclic message is absent */ | |
88 | RX_CHANGED /* updated CAN frame (detected content change) */ | |
89 | }; | |
90 | ||
91 | #define SETTIMER 0x0001 | |
92 | #define STARTTIMER 0x0002 | |
93 | #define TX_COUNTEVT 0x0004 | |
94 | #define TX_ANNOUNCE 0x0008 | |
95 | #define TX_CP_CAN_ID 0x0010 | |
96 | #define RX_FILTER_ID 0x0020 | |
97 | #define RX_CHECK_DLC 0x0040 | |
98 | #define RX_NO_AUTOTIMER 0x0080 | |
99 | #define RX_ANNOUNCE_RESUME 0x0100 | |
100 | #define TX_RESET_MULTI_IDX 0x0200 | |
101 | #define RX_RTR_FRAME 0x0400 | |
6f3b911d | 102 | #define CAN_FD_FRAME 0x0800 |
ffd980f9 | 103 | |
42193e3e | 104 | #endif /* !_UAPI_CAN_BCM_H */ |