1 /* SPDX-License-Identifier: ((GPL-2.0-only WIT 1
2 /*
3 * linux/can/error.h
4 *
5 * Definitions of the CAN error messages to be
6 *
7 * Author: Oliver Hartkopp <oliver.hartkopp@vo
8 * Copyright (c) 2002-2007 Volkswagen Group El
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary
12 * modification, are permitted provided that t
13 * are met:
14 * 1. Redistributions of source code must reta
15 * notice, this list of conditions and the
16 * 2. Redistributions in binary form must repr
17 * notice, this list of conditions and the
18 * documentation and/or other materials pro
19 * 3. Neither the name of Volkswagen nor the n
20 * may be used to endorse or promote produc
21 * without specific prior written permissio
22 *
23 * Alternatively, provided that this notice is
24 * software may be distributed under the terms
25 * Public License ("GPL") version 2, in which
26 * GPL apply INSTEAD OF those given above.
27 *
28 * The provided data structures and external i
29 * are not restricted to be used by modules wi
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTI
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCH
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIR
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGE
37 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * THEORY OF LIABILITY, WHETHER IN CONTRACT, S
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE PO
42 * DAMAGE.
43 */
44
45 #ifndef _UAPI_CAN_ERROR_H
46 #define _UAPI_CAN_ERROR_H
47
48 #define CAN_ERR_DLC 8 /* dlc for error message
49
50 /* error class (mask) in can_id */
51 #define CAN_ERR_TX_TIMEOUT 0x00000001U /* TX
52 #define CAN_ERR_LOSTARB 0x00000002U /* lo
53 #define CAN_ERR_CRTL 0x00000004U /* co
54 #define CAN_ERR_PROT 0x00000008U /* pr
55 #define CAN_ERR_TRX 0x00000010U /* tr
56 #define CAN_ERR_ACK 0x00000020U /* re
57 #define CAN_ERR_BUSOFF 0x00000040U /* bu
58 #define CAN_ERR_BUSERROR 0x00000080U /* bu
59 #define CAN_ERR_RESTARTED 0x00000100U /* co
60 #define CAN_ERR_CNT 0x00000200U /* TX
61 /* RX
62
63 /* arbitration lost in bit ... / data[0] */
64 #define CAN_ERR_LOSTARB_UNSPEC 0x00 /* unspe
65 /* else
66
67 /* error status of CAN-controller / data[1] */
68 #define CAN_ERR_CRTL_UNSPEC 0x00 /* unspe
69 #define CAN_ERR_CRTL_RX_OVERFLOW 0x01 /* RX bu
70 #define CAN_ERR_CRTL_TX_OVERFLOW 0x02 /* TX bu
71 #define CAN_ERR_CRTL_RX_WARNING 0x04 /* reach
72 #define CAN_ERR_CRTL_TX_WARNING 0x08 /* reach
73 #define CAN_ERR_CRTL_RX_PASSIVE 0x10 /* reach
74 #define CAN_ERR_CRTL_TX_PASSIVE 0x20 /* reach
75 /* (at l
76 /* the p
77 #define CAN_ERR_CRTL_ACTIVE 0x40 /* recov
78
79 /* error in CAN protocol (type) / data[2] */
80 #define CAN_ERR_PROT_UNSPEC 0x00 /* unspe
81 #define CAN_ERR_PROT_BIT 0x01 /* singl
82 #define CAN_ERR_PROT_FORM 0x02 /* frame
83 #define CAN_ERR_PROT_STUFF 0x04 /* bit s
84 #define CAN_ERR_PROT_BIT0 0x08 /* unabl
85 #define CAN_ERR_PROT_BIT1 0x10 /* unabl
86 #define CAN_ERR_PROT_OVERLOAD 0x20 /* bus o
87 #define CAN_ERR_PROT_ACTIVE 0x40 /* activ
88 #define CAN_ERR_PROT_TX 0x80 /* error
89
90 /* error in CAN protocol (location) / data[3]
91 #define CAN_ERR_PROT_LOC_UNSPEC 0x00 /* unspe
92 #define CAN_ERR_PROT_LOC_SOF 0x03 /* start
93 #define CAN_ERR_PROT_LOC_ID28_21 0x02 /* ID bi
94 #define CAN_ERR_PROT_LOC_ID20_18 0x06 /* ID bi
95 #define CAN_ERR_PROT_LOC_SRTR 0x04 /* subst
96 #define CAN_ERR_PROT_LOC_IDE 0x05 /* ident
97 #define CAN_ERR_PROT_LOC_ID17_13 0x07 /* ID bi
98 #define CAN_ERR_PROT_LOC_ID12_05 0x0F /* ID bi
99 #define CAN_ERR_PROT_LOC_ID04_00 0x0E /* ID bi
100 #define CAN_ERR_PROT_LOC_RTR 0x0C /* RTR *
101 #define CAN_ERR_PROT_LOC_RES1 0x0D /* reser
102 #define CAN_ERR_PROT_LOC_RES0 0x09 /* reser
103 #define CAN_ERR_PROT_LOC_DLC 0x0B /* data
104 #define CAN_ERR_PROT_LOC_DATA 0x0A /* data
105 #define CAN_ERR_PROT_LOC_CRC_SEQ 0x08 /* CRC s
106 #define CAN_ERR_PROT_LOC_CRC_DEL 0x18 /* CRC d
107 #define CAN_ERR_PROT_LOC_ACK 0x19 /* ACK s
108 #define CAN_ERR_PROT_LOC_ACK_DEL 0x1B /* ACK d
109 #define CAN_ERR_PROT_LOC_EOF 0x1A /* end o
110 #define CAN_ERR_PROT_LOC_INTERM 0x12 /* inter
111
112 /* error status of CAN-transceiver / data[4] *
113 /*
114 #define CAN_ERR_TRX_UNSPEC 0x00 /*
115 #define CAN_ERR_TRX_CANH_NO_WIRE 0x04 /*
116 #define CAN_ERR_TRX_CANH_SHORT_TO_BAT 0x05 /*
117 #define CAN_ERR_TRX_CANH_SHORT_TO_VCC 0x06 /*
118 #define CAN_ERR_TRX_CANH_SHORT_TO_GND 0x07 /*
119 #define CAN_ERR_TRX_CANL_NO_WIRE 0x40 /*
120 #define CAN_ERR_TRX_CANL_SHORT_TO_BAT 0x50 /*
121 #define CAN_ERR_TRX_CANL_SHORT_TO_VCC 0x60 /*
122 #define CAN_ERR_TRX_CANL_SHORT_TO_GND 0x70 /*
123 #define CAN_ERR_TRX_CANL_SHORT_TO_CANH 0x80 /*
124
125 /* data[5] is reserved (do not use) */
126
127 /* TX error counter / data[6] */
128 /* RX error counter / data[7] */
129
130 /* CAN state thresholds
131 *
132 * Error counter Error state
133 * -----------------------------------
134 * 0 - 95 Error-active
135 * 96 - 127 Error-warning
136 * 128 - 255 Error-passive
137 * 256 and greater Bus-off
138 */
139 #define CAN_ERROR_WARNING_THRESHOLD 96
140 #define CAN_ERROR_PASSIVE_THRESHOLD 128
141 #define CAN_BUS_OFF_THRESHOLD 256
142
143 #endif /* _UAPI_CAN_ERROR_H */
144
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.