xref: /freebsd/contrib/libpcap/pcap/can_socketcan.h (revision 53bb5613a8a15363718b6e6de8d965bf9a2c5469)
1 /*-
2  * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from the Stanford/CMU enet packet filter,
6  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
7  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
8  * Berkeley Laboratory.
9  *
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. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  */
38 
39 #ifndef lib_pcap_can_socketcan_h
40 #define lib_pcap_can_socketcan_h
41 
42 #include <pcap/pcap-inttypes.h>
43 
44 /*
45  * SocketCAN header for CAN and CAN FD frames, as per
46  * Documentation/networking/can.rst in the Linux source.
47  */
48 typedef struct {
49 	uint32_t can_id;
50 	uint8_t payload_length;
51 	uint8_t fd_flags;
52 	uint8_t reserved1;
53 	uint8_t reserved2;
54 } pcap_can_socketcan_hdr;
55 
56 /* Bits in the fd_flags field */
57 #define CANFD_BRS   0x01 /* bit rate switch (second bitrate for payload data) */
58 #define CANFD_ESI   0x02 /* error state indicator of the transmitting node */
59 #define CANFD_FDF   0x04 /* mark CAN FD for dual use of CAN format */
60 
61 /*
62  * SocketCAN header for CAN XL frames, as per Linux's can.h header.
63  * This is different from pcap_can_socketcan_hdr; the flags field
64  * overlaps with the payload_length field in pcap_can_socketcan_hdr -
65  * the payload_length field in a CAN or CAN FD frame never has the
66  * 0x80 bit set, and the flags field in a CAN XL frame always has
67  * it set, allowing code reading the frame to determine whether
68  * it's CAN XL or not.
69  */
70 typedef struct {
71 	uint32_t priority_vcid;
72 	uint8_t flags;
73 	uint8_t sdu_type;
74 	uint16_t payload_length;
75 	uint32_t acceptance_field;
76 } pcap_can_socketcan_xl_hdr;
77 
78 /* Bits in the flags field */
79 #define CANXL_SEC   0x01 /* Simple Extended Context */
80 #define CANXL_XLF   0x80 /* mark to distinguish CAN XL from CAN/CAN FD frames */
81 
82 #endif
83