Wireshark  4.3.0
The Wireshark network protocol analyzer
packet-socketcan.h
1 /* packet-socketcan.h
2  *
3  * Wireshark - Network traffic analyzer
4  * By Gerald Combs <gerald@wireshark.org>
5  * Copyright 1998 Gerald Combs
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  */
9 
10 #ifndef __PACKET_SOCKETCAN_H__
11 #define __PACKET_SOCKETCAN_H__
12 
13 #include <epan/tvbuff.h>
14 #include <epan/packet_info.h>
15 #include <epan/proto.h>
16 
17 /* Flags for CAN FD frames. */
18 #define CANFD_BRS 0x01 /* Bit Rate Switch (second bitrate for payload data) */
19 #define CANFD_ESI 0x02 /* Error State Indicator of the transmitting node */
20 #define CANFD_FDF 0x04 /* FD flag - if set, this is an FD frame */
21 
22 /* Structure that gets passed between dissectors. */
23 typedef struct can_info {
24  guint32 id;
25  guint32 len;
26  gboolean fd;
27  guint16 bus_id;
28 } can_info_t;
29 
30 /* controller area network (CAN) kernel definitions
31  * These masks are usually defined within <linux/can.h> but are not
32  * available on non-Linux platforms; that's the reason for the
33  * redefinitions below
34  *
35  * special address description flags for the CAN_ID */
36 #define CAN_EFF_FLAG 0x80000000 /* EFF/SFF is set in the MSB */
37 #define CAN_RTR_FLAG 0x40000000 /* remote transmission request */
38 #define CAN_ERR_FLAG 0x20000000 /* error frame */
39 
40 #define CAN_FLAG_MASK (CAN_EFF_FLAG | CAN_RTR_FLAG | CAN_ERR_FLAG)
41 
42 #define CAN_EFF_MASK 0x1FFFFFFF /* extended frame format (EFF) has a 29 bit identifier */
43 #define CAN_SFF_MASK 0x000007FF /* standard frame format (SFF) has a 11 bit identifier */
44 
45 #define CAN_ERR_DLC 8 /* dlc for error message frames */
46 
47 /* error class (mask) in can_id */
48 #define CAN_ERR_TX_TIMEOUT 0x00000001U /* TX timeout (by netdevice driver) */
49 #define CAN_ERR_LOSTARB 0x00000002U /* lost arbitration / data[0] */
50 #define CAN_ERR_CTRL 0x00000004U /* controller problems / data[1] */
51 #define CAN_ERR_PROT 0x00000008U /* protocol violations / data[2..3] */
52 #define CAN_ERR_TRX 0x00000010U /* transceiver status / data[4] */
53 #define CAN_ERR_ACK 0x00000020U /* received no ACK on transmission */
54 #define CAN_ERR_BUSOFF 0x00000040U /* bus off */
55 #define CAN_ERR_BUSERROR 0x00000080U /* bus error (may flood!) */
56 #define CAN_ERR_RESTARTED 0x00000100U /* controller restarted */
57 #define CAN_ERR_RESERVED 0x1FFFFE00U /* reserved bits */
58 
59 /* error in CAN protocol (type) / data[2] */
60 #define CAN_ERR_PROT_UNSPEC 0x00 /* unspecified */
61 #define CAN_ERR_PROT_BIT 0x01 /* single bit error */
62 #define CAN_ERR_PROT_FORM 0x02 /* frame format error */
63 #define CAN_ERR_PROT_STUFF 0x04 /* bit stuffing error */
64 #define CAN_ERR_PROT_BIT0 0x08 /* unable to send dominant bit */
65 #define CAN_ERR_PROT_BIT1 0x10 /* unable to send recessive bit */
66 #define CAN_ERR_PROT_OVERLOAD 0x20 /* bus overload */
67 #define CAN_ERR_PROT_ACTIVE 0x40 /* active error announcement */
68 #define CAN_ERR_PROT_TX 0x80 /* error occurred on transmission */
69 
70 /* error in CAN protocol (location) / data[3] */
71 #define CAN_ERR_PROT_LOC_UNSPEC 0x00 /* unspecified */
72 #define CAN_ERR_PROT_LOC_SOF 0x03 /* start of frame */
73 #define CAN_ERR_PROT_LOC_ID28_21 0x02 /* ID bits 28 - 21 (SFF: 10 - 3) */
74 #define CAN_ERR_PROT_LOC_ID20_18 0x06 /* ID bits 20 - 18 (SFF: 2 - 0 )*/
75 #define CAN_ERR_PROT_LOC_SRTR 0x04 /* substitute RTR (SFF: RTR) */
76 #define CAN_ERR_PROT_LOC_IDE 0x05 /* identifier extension */
77 #define CAN_ERR_PROT_LOC_ID17_13 0x07 /* ID bits 17-13 */
78 #define CAN_ERR_PROT_LOC_ID12_05 0x0F /* ID bits 12-5 */
79 #define CAN_ERR_PROT_LOC_ID04_00 0x0E /* ID bits 4-0 */
80 #define CAN_ERR_PROT_LOC_RTR 0x0C /* RTR */
81 #define CAN_ERR_PROT_LOC_RES1 0x0D /* reserved bit 1 */
82 #define CAN_ERR_PROT_LOC_RES0 0x09 /* reserved bit 0 */
83 #define CAN_ERR_PROT_LOC_DLC 0x0B /* data length code */
84 #define CAN_ERR_PROT_LOC_DATA 0x0A /* data section */
85 #define CAN_ERR_PROT_LOC_CRC_SEQ 0x08 /* CRC sequence */
86 #define CAN_ERR_PROT_LOC_CRC_DEL 0x18 /* CRC delimiter */
87 #define CAN_ERR_PROT_LOC_ACK 0x19 /* ACK slot */
88 #define CAN_ERR_PROT_LOC_ACK_DEL 0x1B /* ACK delimiter */
89 #define CAN_ERR_PROT_LOC_EOF 0x1A /* end of frame */
90 #define CAN_ERR_PROT_LOC_INTERM 0x12 /* intermission */
91 
92 gboolean socketcan_call_subdissectors(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, struct can_info *can_info, const gboolean use_heuristics_first);
93 gboolean socketcan_set_source_and_destination_columns(packet_info* pinfo, can_info_t *caninfo);
94 
95 #endif /* __PACKET_SOCKETCAN_H__ */
96 
97 /*
98  * Editor modelines - https://www.wireshark.org/tools/modelines.html
99  *
100  * Local variables:
101  * c-basic-offset: 4
102  * tab-width: 8
103  * indent-tabs-mode: nil
104  * End:
105  *
106  * vi: set shiftwidth=4 tabstop=8 expandtab:
107  * :indentSize=4:tabSize=8:noTabs=true:
108  */
Definition: packet_info.h:44
Definition: proto.h:897
Definition: packet-socketcan.h:23
Definition: tvbuff-int.h:35