1 /* SPDX-License-Identifier: GPL-2.0
2  *
3  * mcp251xfd - Microchip MCP251xFD Family CAN controller driver
4  *
5  * Copyright (c) 2019, 2020, 2021 Pengutronix,
6  *               Marc Kleine-Budde <kernel@pengutronix.de>
7  * Copyright (c) 2019 Martin Sperl <kernel@martin.sperl.org>
8  */
9 
10 #ifndef _MCP251XFD_H
11 #define _MCP251XFD_H
12 
13 #include <linux/bitfield.h>
14 #include <linux/can/core.h>
15 #include <linux/can/dev.h>
16 #include <linux/can/rx-offload.h>
17 #include <linux/gpio/consumer.h>
18 #include <linux/kernel.h>
19 #include <linux/netdevice.h>
20 #include <linux/regmap.h>
21 #include <linux/regulator/consumer.h>
22 #include <linux/spi/spi.h>
23 #include <linux/timecounter.h>
24 #include <linux/workqueue.h>
25 
26 /* MPC251x registers */
27 
28 /* CAN FD Controller Module SFR */
29 #define MCP251XFD_REG_CON 0x00
30 #define MCP251XFD_REG_CON_TXBWS_MASK GENMASK(31, 28)
31 #define MCP251XFD_REG_CON_ABAT BIT(27)
32 #define MCP251XFD_REG_CON_REQOP_MASK GENMASK(26, 24)
33 #define MCP251XFD_REG_CON_MODE_MIXED 0
34 #define MCP251XFD_REG_CON_MODE_SLEEP 1
35 #define MCP251XFD_REG_CON_MODE_INT_LOOPBACK 2
36 #define MCP251XFD_REG_CON_MODE_LISTENONLY 3
37 #define MCP251XFD_REG_CON_MODE_CONFIG 4
38 #define MCP251XFD_REG_CON_MODE_EXT_LOOPBACK 5
39 #define MCP251XFD_REG_CON_MODE_CAN2_0 6
40 #define MCP251XFD_REG_CON_MODE_RESTRICTED 7
41 #define MCP251XFD_REG_CON_OPMOD_MASK GENMASK(23, 21)
42 #define MCP251XFD_REG_CON_TXQEN BIT(20)
43 #define MCP251XFD_REG_CON_STEF BIT(19)
44 #define MCP251XFD_REG_CON_SERR2LOM BIT(18)
45 #define MCP251XFD_REG_CON_ESIGM BIT(17)
46 #define MCP251XFD_REG_CON_RTXAT BIT(16)
47 #define MCP251XFD_REG_CON_BRSDIS BIT(12)
48 #define MCP251XFD_REG_CON_BUSY BIT(11)
49 #define MCP251XFD_REG_CON_WFT_MASK GENMASK(10, 9)
50 #define MCP251XFD_REG_CON_WFT_T00FILTER 0x0
51 #define MCP251XFD_REG_CON_WFT_T01FILTER 0x1
52 #define MCP251XFD_REG_CON_WFT_T10FILTER 0x2
53 #define MCP251XFD_REG_CON_WFT_T11FILTER 0x3
54 #define MCP251XFD_REG_CON_WAKFIL BIT(8)
55 #define MCP251XFD_REG_CON_PXEDIS BIT(6)
56 #define MCP251XFD_REG_CON_ISOCRCEN BIT(5)
57 #define MCP251XFD_REG_CON_DNCNT_MASK GENMASK(4, 0)
58 
59 #define MCP251XFD_REG_NBTCFG 0x04
60 #define MCP251XFD_REG_NBTCFG_BRP_MASK GENMASK(31, 24)
61 #define MCP251XFD_REG_NBTCFG_TSEG1_MASK GENMASK(23, 16)
62 #define MCP251XFD_REG_NBTCFG_TSEG2_MASK GENMASK(14, 8)
63 #define MCP251XFD_REG_NBTCFG_SJW_MASK GENMASK(6, 0)
64 
65 #define MCP251XFD_REG_DBTCFG 0x08
66 #define MCP251XFD_REG_DBTCFG_BRP_MASK GENMASK(31, 24)
67 #define MCP251XFD_REG_DBTCFG_TSEG1_MASK GENMASK(20, 16)
68 #define MCP251XFD_REG_DBTCFG_TSEG2_MASK GENMASK(11, 8)
69 #define MCP251XFD_REG_DBTCFG_SJW_MASK GENMASK(3, 0)
70 
71 #define MCP251XFD_REG_TDC 0x0c
72 #define MCP251XFD_REG_TDC_EDGFLTEN BIT(25)
73 #define MCP251XFD_REG_TDC_SID11EN BIT(24)
74 #define MCP251XFD_REG_TDC_TDCMOD_MASK GENMASK(17, 16)
75 #define MCP251XFD_REG_TDC_TDCMOD_AUTO 2
76 #define MCP251XFD_REG_TDC_TDCMOD_MANUAL 1
77 #define MCP251XFD_REG_TDC_TDCMOD_DISABLED 0
78 #define MCP251XFD_REG_TDC_TDCO_MASK GENMASK(14, 8)
79 #define MCP251XFD_REG_TDC_TDCV_MASK GENMASK(5, 0)
80 
81 #define MCP251XFD_REG_TBC 0x10
82 
83 #define MCP251XFD_REG_TSCON 0x14
84 #define MCP251XFD_REG_TSCON_TSRES BIT(18)
85 #define MCP251XFD_REG_TSCON_TSEOF BIT(17)
86 #define MCP251XFD_REG_TSCON_TBCEN BIT(16)
87 #define MCP251XFD_REG_TSCON_TBCPRE_MASK GENMASK(9, 0)
88 
89 #define MCP251XFD_REG_VEC 0x18
90 #define MCP251XFD_REG_VEC_RXCODE_MASK GENMASK(30, 24)
91 #define MCP251XFD_REG_VEC_TXCODE_MASK GENMASK(22, 16)
92 #define MCP251XFD_REG_VEC_FILHIT_MASK GENMASK(12, 8)
93 #define MCP251XFD_REG_VEC_ICODE_MASK GENMASK(6, 0)
94 
95 #define MCP251XFD_REG_INT 0x1c
96 #define MCP251XFD_REG_INT_IF_MASK GENMASK(15, 0)
97 #define MCP251XFD_REG_INT_IE_MASK GENMASK(31, 16)
98 #define MCP251XFD_REG_INT_IVMIE BIT(31)
99 #define MCP251XFD_REG_INT_WAKIE BIT(30)
100 #define MCP251XFD_REG_INT_CERRIE BIT(29)
101 #define MCP251XFD_REG_INT_SERRIE BIT(28)
102 #define MCP251XFD_REG_INT_RXOVIE BIT(27)
103 #define MCP251XFD_REG_INT_TXATIE BIT(26)
104 #define MCP251XFD_REG_INT_SPICRCIE BIT(25)
105 #define MCP251XFD_REG_INT_ECCIE BIT(24)
106 #define MCP251XFD_REG_INT_TEFIE BIT(20)
107 #define MCP251XFD_REG_INT_MODIE BIT(19)
108 #define MCP251XFD_REG_INT_TBCIE BIT(18)
109 #define MCP251XFD_REG_INT_RXIE BIT(17)
110 #define MCP251XFD_REG_INT_TXIE BIT(16)
111 #define MCP251XFD_REG_INT_IVMIF BIT(15)
112 #define MCP251XFD_REG_INT_WAKIF BIT(14)
113 #define MCP251XFD_REG_INT_CERRIF BIT(13)
114 #define MCP251XFD_REG_INT_SERRIF BIT(12)
115 #define MCP251XFD_REG_INT_RXOVIF BIT(11)
116 #define MCP251XFD_REG_INT_TXATIF BIT(10)
117 #define MCP251XFD_REG_INT_SPICRCIF BIT(9)
118 #define MCP251XFD_REG_INT_ECCIF BIT(8)
119 #define MCP251XFD_REG_INT_TEFIF BIT(4)
120 #define MCP251XFD_REG_INT_MODIF BIT(3)
121 #define MCP251XFD_REG_INT_TBCIF BIT(2)
122 #define MCP251XFD_REG_INT_RXIF BIT(1)
123 #define MCP251XFD_REG_INT_TXIF BIT(0)
124 /* These IRQ flags must be cleared by SW in the CAN_INT register */
125 #define MCP251XFD_REG_INT_IF_CLEARABLE_MASK \
126 	(MCP251XFD_REG_INT_IVMIF | MCP251XFD_REG_INT_WAKIF | \
127 	 MCP251XFD_REG_INT_CERRIF |  MCP251XFD_REG_INT_SERRIF | \
128 	 MCP251XFD_REG_INT_MODIF)
129 
130 #define MCP251XFD_REG_RXIF 0x20
131 #define MCP251XFD_REG_TXIF 0x24
132 #define MCP251XFD_REG_RXOVIF 0x28
133 #define MCP251XFD_REG_TXATIF 0x2c
134 #define MCP251XFD_REG_TXREQ 0x30
135 
136 #define MCP251XFD_REG_TREC 0x34
137 #define MCP251XFD_REG_TREC_TXBO BIT(21)
138 #define MCP251XFD_REG_TREC_TXBP BIT(20)
139 #define MCP251XFD_REG_TREC_RXBP BIT(19)
140 #define MCP251XFD_REG_TREC_TXWARN BIT(18)
141 #define MCP251XFD_REG_TREC_RXWARN BIT(17)
142 #define MCP251XFD_REG_TREC_EWARN BIT(16)
143 #define MCP251XFD_REG_TREC_TEC_MASK GENMASK(15, 8)
144 #define MCP251XFD_REG_TREC_REC_MASK GENMASK(7, 0)
145 
146 #define MCP251XFD_REG_BDIAG0 0x38
147 #define MCP251XFD_REG_BDIAG0_DTERRCNT_MASK GENMASK(31, 24)
148 #define MCP251XFD_REG_BDIAG0_DRERRCNT_MASK GENMASK(23, 16)
149 #define MCP251XFD_REG_BDIAG0_NTERRCNT_MASK GENMASK(15, 8)
150 #define MCP251XFD_REG_BDIAG0_NRERRCNT_MASK GENMASK(7, 0)
151 
152 #define MCP251XFD_REG_BDIAG1 0x3c
153 #define MCP251XFD_REG_BDIAG1_DLCMM BIT(31)
154 #define MCP251XFD_REG_BDIAG1_ESI BIT(30)
155 #define MCP251XFD_REG_BDIAG1_DCRCERR BIT(29)
156 #define MCP251XFD_REG_BDIAG1_DSTUFERR BIT(28)
157 #define MCP251XFD_REG_BDIAG1_DFORMERR BIT(27)
158 #define MCP251XFD_REG_BDIAG1_DBIT1ERR BIT(25)
159 #define MCP251XFD_REG_BDIAG1_DBIT0ERR BIT(24)
160 #define MCP251XFD_REG_BDIAG1_TXBOERR BIT(23)
161 #define MCP251XFD_REG_BDIAG1_NCRCERR BIT(21)
162 #define MCP251XFD_REG_BDIAG1_NSTUFERR BIT(20)
163 #define MCP251XFD_REG_BDIAG1_NFORMERR BIT(19)
164 #define MCP251XFD_REG_BDIAG1_NACKERR BIT(18)
165 #define MCP251XFD_REG_BDIAG1_NBIT1ERR BIT(17)
166 #define MCP251XFD_REG_BDIAG1_NBIT0ERR BIT(16)
167 #define MCP251XFD_REG_BDIAG1_BERR_MASK \
168 	(MCP251XFD_REG_BDIAG1_DLCMM | MCP251XFD_REG_BDIAG1_ESI | \
169 	 MCP251XFD_REG_BDIAG1_DCRCERR | MCP251XFD_REG_BDIAG1_DSTUFERR | \
170 	 MCP251XFD_REG_BDIAG1_DFORMERR | MCP251XFD_REG_BDIAG1_DBIT1ERR | \
171 	 MCP251XFD_REG_BDIAG1_DBIT0ERR | MCP251XFD_REG_BDIAG1_TXBOERR | \
172 	 MCP251XFD_REG_BDIAG1_NCRCERR | MCP251XFD_REG_BDIAG1_NSTUFERR | \
173 	 MCP251XFD_REG_BDIAG1_NFORMERR | MCP251XFD_REG_BDIAG1_NACKERR | \
174 	 MCP251XFD_REG_BDIAG1_NBIT1ERR | MCP251XFD_REG_BDIAG1_NBIT0ERR)
175 #define MCP251XFD_REG_BDIAG1_EFMSGCNT_MASK GENMASK(15, 0)
176 
177 #define MCP251XFD_REG_TEFCON 0x40
178 #define MCP251XFD_REG_TEFCON_FSIZE_MASK GENMASK(28, 24)
179 #define MCP251XFD_REG_TEFCON_FRESET BIT(10)
180 #define MCP251XFD_REG_TEFCON_UINC BIT(8)
181 #define MCP251XFD_REG_TEFCON_TEFTSEN BIT(5)
182 #define MCP251XFD_REG_TEFCON_TEFOVIE BIT(3)
183 #define MCP251XFD_REG_TEFCON_TEFFIE BIT(2)
184 #define MCP251XFD_REG_TEFCON_TEFHIE BIT(1)
185 #define MCP251XFD_REG_TEFCON_TEFNEIE BIT(0)
186 
187 #define MCP251XFD_REG_TEFSTA 0x44
188 #define MCP251XFD_REG_TEFSTA_TEFOVIF BIT(3)
189 #define MCP251XFD_REG_TEFSTA_TEFFIF BIT(2)
190 #define MCP251XFD_REG_TEFSTA_TEFHIF BIT(1)
191 #define MCP251XFD_REG_TEFSTA_TEFNEIF BIT(0)
192 
193 #define MCP251XFD_REG_TEFUA 0x48
194 
195 #define MCP251XFD_REG_TXQCON 0x50
196 #define MCP251XFD_REG_TXQCON_PLSIZE_MASK GENMASK(31, 29)
197 #define MCP251XFD_REG_TXQCON_PLSIZE_8 0
198 #define MCP251XFD_REG_TXQCON_PLSIZE_12 1
199 #define MCP251XFD_REG_TXQCON_PLSIZE_16 2
200 #define MCP251XFD_REG_TXQCON_PLSIZE_20 3
201 #define MCP251XFD_REG_TXQCON_PLSIZE_24 4
202 #define MCP251XFD_REG_TXQCON_PLSIZE_32 5
203 #define MCP251XFD_REG_TXQCON_PLSIZE_48 6
204 #define MCP251XFD_REG_TXQCON_PLSIZE_64 7
205 #define MCP251XFD_REG_TXQCON_FSIZE_MASK GENMASK(28, 24)
206 #define MCP251XFD_REG_TXQCON_TXAT_UNLIMITED 3
207 #define MCP251XFD_REG_TXQCON_TXAT_THREE_SHOT 1
208 #define MCP251XFD_REG_TXQCON_TXAT_ONE_SHOT 0
209 #define MCP251XFD_REG_TXQCON_TXAT_MASK GENMASK(22, 21)
210 #define MCP251XFD_REG_TXQCON_TXPRI_MASK GENMASK(20, 16)
211 #define MCP251XFD_REG_TXQCON_FRESET BIT(10)
212 #define MCP251XFD_REG_TXQCON_TXREQ BIT(9)
213 #define MCP251XFD_REG_TXQCON_UINC BIT(8)
214 #define MCP251XFD_REG_TXQCON_TXEN BIT(7)
215 #define MCP251XFD_REG_TXQCON_TXATIE BIT(4)
216 #define MCP251XFD_REG_TXQCON_TXQEIE BIT(2)
217 #define MCP251XFD_REG_TXQCON_TXQNIE BIT(0)
218 
219 #define MCP251XFD_REG_TXQSTA 0x54
220 #define MCP251XFD_REG_TXQSTA_TXQCI_MASK GENMASK(12, 8)
221 #define MCP251XFD_REG_TXQSTA_TXABT BIT(7)
222 #define MCP251XFD_REG_TXQSTA_TXLARB BIT(6)
223 #define MCP251XFD_REG_TXQSTA_TXERR BIT(5)
224 #define MCP251XFD_REG_TXQSTA_TXATIF BIT(4)
225 #define MCP251XFD_REG_TXQSTA_TXQEIF BIT(2)
226 #define MCP251XFD_REG_TXQSTA_TXQNIF BIT(0)
227 
228 #define MCP251XFD_REG_TXQUA 0x58
229 
230 #define MCP251XFD_REG_FIFOCON(x) (0x50 + 0xc * (x))
231 #define MCP251XFD_REG_FIFOCON_PLSIZE_MASK GENMASK(31, 29)
232 #define MCP251XFD_REG_FIFOCON_PLSIZE_8 0
233 #define MCP251XFD_REG_FIFOCON_PLSIZE_12 1
234 #define MCP251XFD_REG_FIFOCON_PLSIZE_16 2
235 #define MCP251XFD_REG_FIFOCON_PLSIZE_20 3
236 #define MCP251XFD_REG_FIFOCON_PLSIZE_24 4
237 #define MCP251XFD_REG_FIFOCON_PLSIZE_32 5
238 #define MCP251XFD_REG_FIFOCON_PLSIZE_48 6
239 #define MCP251XFD_REG_FIFOCON_PLSIZE_64 7
240 #define MCP251XFD_REG_FIFOCON_FSIZE_MASK GENMASK(28, 24)
241 #define MCP251XFD_REG_FIFOCON_TXAT_MASK GENMASK(22, 21)
242 #define MCP251XFD_REG_FIFOCON_TXAT_ONE_SHOT 0
243 #define MCP251XFD_REG_FIFOCON_TXAT_THREE_SHOT 1
244 #define MCP251XFD_REG_FIFOCON_TXAT_UNLIMITED 3
245 #define MCP251XFD_REG_FIFOCON_TXPRI_MASK GENMASK(20, 16)
246 #define MCP251XFD_REG_FIFOCON_FRESET BIT(10)
247 #define MCP251XFD_REG_FIFOCON_TXREQ BIT(9)
248 #define MCP251XFD_REG_FIFOCON_UINC BIT(8)
249 #define MCP251XFD_REG_FIFOCON_TXEN BIT(7)
250 #define MCP251XFD_REG_FIFOCON_RTREN BIT(6)
251 #define MCP251XFD_REG_FIFOCON_RXTSEN BIT(5)
252 #define MCP251XFD_REG_FIFOCON_TXATIE BIT(4)
253 #define MCP251XFD_REG_FIFOCON_RXOVIE BIT(3)
254 #define MCP251XFD_REG_FIFOCON_TFERFFIE BIT(2)
255 #define MCP251XFD_REG_FIFOCON_TFHRFHIE BIT(1)
256 #define MCP251XFD_REG_FIFOCON_TFNRFNIE BIT(0)
257 
258 #define MCP251XFD_REG_FIFOSTA(x) (0x54 + 0xc * (x))
259 #define MCP251XFD_REG_FIFOSTA_FIFOCI_MASK GENMASK(12, 8)
260 #define MCP251XFD_REG_FIFOSTA_TXABT BIT(7)
261 #define MCP251XFD_REG_FIFOSTA_TXLARB BIT(6)
262 #define MCP251XFD_REG_FIFOSTA_TXERR BIT(5)
263 #define MCP251XFD_REG_FIFOSTA_TXATIF BIT(4)
264 #define MCP251XFD_REG_FIFOSTA_RXOVIF BIT(3)
265 #define MCP251XFD_REG_FIFOSTA_TFERFFIF BIT(2)
266 #define MCP251XFD_REG_FIFOSTA_TFHRFHIF BIT(1)
267 #define MCP251XFD_REG_FIFOSTA_TFNRFNIF BIT(0)
268 
269 #define MCP251XFD_REG_FIFOUA(x) (0x58 + 0xc * (x))
270 
271 #define MCP251XFD_REG_FLTCON(x) (0x1d0 + 0x4 * (x))
272 #define MCP251XFD_REG_FLTCON_FLTEN3 BIT(31)
273 #define MCP251XFD_REG_FLTCON_F3BP_MASK GENMASK(28, 24)
274 #define MCP251XFD_REG_FLTCON_FLTEN2 BIT(23)
275 #define MCP251XFD_REG_FLTCON_F2BP_MASK GENMASK(20, 16)
276 #define MCP251XFD_REG_FLTCON_FLTEN1 BIT(15)
277 #define MCP251XFD_REG_FLTCON_F1BP_MASK GENMASK(12, 8)
278 #define MCP251XFD_REG_FLTCON_FLTEN0 BIT(7)
279 #define MCP251XFD_REG_FLTCON_F0BP_MASK GENMASK(4, 0)
280 #define MCP251XFD_REG_FLTCON_FLTEN(x) (BIT(7) << 8 * ((x) & 0x3))
281 #define MCP251XFD_REG_FLTCON_FLT_MASK(x) (GENMASK(7, 0) << (8 * ((x) & 0x3)))
282 #define MCP251XFD_REG_FLTCON_FBP(x, fifo) ((fifo) << 8 * ((x) & 0x3))
283 
284 #define MCP251XFD_REG_FLTOBJ(x) (0x1f0 + 0x8 * (x))
285 #define MCP251XFD_REG_FLTOBJ_EXIDE BIT(30)
286 #define MCP251XFD_REG_FLTOBJ_SID11 BIT(29)
287 #define MCP251XFD_REG_FLTOBJ_EID_MASK GENMASK(28, 11)
288 #define MCP251XFD_REG_FLTOBJ_SID_MASK GENMASK(10, 0)
289 
290 #define MCP251XFD_REG_FLTMASK(x) (0x1f4 + 0x8 * (x))
291 #define MCP251XFD_REG_MASK_MIDE BIT(30)
292 #define MCP251XFD_REG_MASK_MSID11 BIT(29)
293 #define MCP251XFD_REG_MASK_MEID_MASK GENMASK(28, 11)
294 #define MCP251XFD_REG_MASK_MSID_MASK GENMASK(10, 0)
295 
296 /* RAM */
297 #define MCP251XFD_RAM_START 0x400
298 #define MCP251XFD_RAM_SIZE SZ_2K
299 
300 /* Message Object */
301 #define MCP251XFD_OBJ_ID_SID11 BIT(29)
302 #define MCP251XFD_OBJ_ID_EID_MASK GENMASK(28, 11)
303 #define MCP251XFD_OBJ_ID_SID_MASK GENMASK(10, 0)
304 #define MCP251XFD_OBJ_FLAGS_SEQ_MCP2518FD_MASK GENMASK(31, 9)
305 #define MCP251XFD_OBJ_FLAGS_SEQ_MCP2517FD_MASK GENMASK(15, 9)
306 #define MCP251XFD_OBJ_FLAGS_SEQ_MASK MCP251XFD_OBJ_FLAGS_SEQ_MCP2518FD_MASK
307 #define MCP251XFD_OBJ_FLAGS_ESI BIT(8)
308 #define MCP251XFD_OBJ_FLAGS_FDF BIT(7)
309 #define MCP251XFD_OBJ_FLAGS_BRS BIT(6)
310 #define MCP251XFD_OBJ_FLAGS_RTR BIT(5)
311 #define MCP251XFD_OBJ_FLAGS_IDE BIT(4)
312 #define MCP251XFD_OBJ_FLAGS_DLC_MASK GENMASK(3, 0)
313 
314 #define MCP251XFD_REG_FRAME_EFF_SID_MASK GENMASK(28, 18)
315 #define MCP251XFD_REG_FRAME_EFF_EID_MASK GENMASK(17, 0)
316 
317 /* MCP2517/18FD SFR */
318 #define MCP251XFD_REG_OSC 0xe00
319 #define MCP251XFD_REG_OSC_SCLKRDY BIT(12)
320 #define MCP251XFD_REG_OSC_OSCRDY BIT(10)
321 #define MCP251XFD_REG_OSC_PLLRDY BIT(8)
322 #define MCP251XFD_REG_OSC_CLKODIV_10 3
323 #define MCP251XFD_REG_OSC_CLKODIV_4 2
324 #define MCP251XFD_REG_OSC_CLKODIV_2 1
325 #define MCP251XFD_REG_OSC_CLKODIV_1 0
326 #define MCP251XFD_REG_OSC_CLKODIV_MASK GENMASK(6, 5)
327 #define MCP251XFD_REG_OSC_SCLKDIV BIT(4)
328 #define MCP251XFD_REG_OSC_LPMEN BIT(3)	/* MCP2518FD only */
329 #define MCP251XFD_REG_OSC_OSCDIS BIT(2)
330 #define MCP251XFD_REG_OSC_PLLEN BIT(0)
331 
332 #define MCP251XFD_REG_IOCON 0xe04
333 #define MCP251XFD_REG_IOCON_INTOD BIT(30)
334 #define MCP251XFD_REG_IOCON_SOF BIT(29)
335 #define MCP251XFD_REG_IOCON_TXCANOD BIT(28)
336 #define MCP251XFD_REG_IOCON_PM1 BIT(25)
337 #define MCP251XFD_REG_IOCON_PM0 BIT(24)
338 #define MCP251XFD_REG_IOCON_GPIO1 BIT(17)
339 #define MCP251XFD_REG_IOCON_GPIO0 BIT(16)
340 #define MCP251XFD_REG_IOCON_LAT1 BIT(9)
341 #define MCP251XFD_REG_IOCON_LAT0 BIT(8)
342 #define MCP251XFD_REG_IOCON_XSTBYEN BIT(6)
343 #define MCP251XFD_REG_IOCON_TRIS1 BIT(1)
344 #define MCP251XFD_REG_IOCON_TRIS0 BIT(0)
345 
346 #define MCP251XFD_REG_CRC 0xe08
347 #define MCP251XFD_REG_CRC_FERRIE BIT(25)
348 #define MCP251XFD_REG_CRC_CRCERRIE BIT(24)
349 #define MCP251XFD_REG_CRC_FERRIF BIT(17)
350 #define MCP251XFD_REG_CRC_CRCERRIF BIT(16)
351 #define MCP251XFD_REG_CRC_IF_MASK GENMASK(17, 16)
352 #define MCP251XFD_REG_CRC_MASK GENMASK(15, 0)
353 
354 #define MCP251XFD_REG_ECCCON 0xe0c
355 #define MCP251XFD_REG_ECCCON_PARITY_MASK GENMASK(14, 8)
356 #define MCP251XFD_REG_ECCCON_DEDIE BIT(2)
357 #define MCP251XFD_REG_ECCCON_SECIE BIT(1)
358 #define MCP251XFD_REG_ECCCON_ECCEN BIT(0)
359 
360 #define MCP251XFD_REG_ECCSTAT 0xe10
361 #define MCP251XFD_REG_ECCSTAT_ERRADDR_MASK GENMASK(27, 16)
362 #define MCP251XFD_REG_ECCSTAT_IF_MASK GENMASK(2, 1)
363 #define MCP251XFD_REG_ECCSTAT_DEDIF BIT(2)
364 #define MCP251XFD_REG_ECCSTAT_SECIF BIT(1)
365 
366 #define MCP251XFD_REG_DEVID 0xe14	/* MCP2518FD only */
367 #define MCP251XFD_REG_DEVID_ID_MASK GENMASK(7, 4)
368 #define MCP251XFD_REG_DEVID_REV_MASK GENMASK(3, 0)
369 
370 /* SPI commands */
371 #define MCP251XFD_SPI_INSTRUCTION_RESET 0x0000
372 #define MCP251XFD_SPI_INSTRUCTION_WRITE 0x2000
373 #define MCP251XFD_SPI_INSTRUCTION_READ 0x3000
374 #define MCP251XFD_SPI_INSTRUCTION_WRITE_CRC 0xa000
375 #define MCP251XFD_SPI_INSTRUCTION_READ_CRC 0xb000
376 #define MCP251XFD_SPI_INSTRUCTION_WRITE_CRC_SAFE 0xc000
377 #define MCP251XFD_SPI_ADDRESS_MASK GENMASK(11, 0)
378 
379 #define MCP251XFD_SYSCLOCK_HZ_MAX 40000000
380 #define MCP251XFD_SYSCLOCK_HZ_MIN 1000000
381 #define MCP251XFD_SPICLOCK_HZ_MAX 20000000
382 #define MCP251XFD_TIMESTAMP_WORK_DELAY_SEC 45
383 static_assert(MCP251XFD_TIMESTAMP_WORK_DELAY_SEC <
384 	      CYCLECOUNTER_MASK(32) / MCP251XFD_SYSCLOCK_HZ_MAX / 2);
385 #define MCP251XFD_OSC_PLL_MULTIPLIER 10
386 #define MCP251XFD_OSC_STAB_SLEEP_US (3 * USEC_PER_MSEC)
387 #define MCP251XFD_OSC_STAB_TIMEOUT_US (10 * MCP251XFD_OSC_STAB_SLEEP_US)
388 #define MCP251XFD_POLL_SLEEP_US (10)
389 #define MCP251XFD_POLL_TIMEOUT_US (USEC_PER_MSEC)
390 
391 /* Misc */
392 #define MCP251XFD_NAPI_WEIGHT 32
393 #define MCP251XFD_SOFTRESET_RETRIES_MAX 3
394 #define MCP251XFD_READ_CRC_RETRIES_MAX 3
395 #define MCP251XFD_ECC_CNT_MAX 2
396 #define MCP251XFD_SANITIZE_SPI 1
397 #define MCP251XFD_SANITIZE_CAN 1
398 
399 /* FIFO and Ring */
400 #define MCP251XFD_FIFO_TEF_NUM 1U
401 #define MCP251XFD_FIFO_RX_NUM 3U
402 #define MCP251XFD_FIFO_TX_NUM 1U
403 
404 #define MCP251XFD_FIFO_DEPTH 32U
405 
406 #define MCP251XFD_RX_OBJ_NUM_MIN 16U
407 #define MCP251XFD_RX_OBJ_NUM_MAX (MCP251XFD_FIFO_RX_NUM * MCP251XFD_FIFO_DEPTH)
408 #define MCP251XFD_RX_FIFO_DEPTH_MIN 4U
409 #define MCP251XFD_RX_FIFO_DEPTH_COALESCE_MIN 8U
410 
411 #define MCP251XFD_TX_OBJ_NUM_MIN 2U
412 #define MCP251XFD_TX_OBJ_NUM_MAX 16U
413 #define MCP251XFD_TX_OBJ_NUM_CAN_DEFAULT 8U
414 #define MCP251XFD_TX_OBJ_NUM_CANFD_DEFAULT 4U
415 #define MCP251XFD_TX_FIFO_DEPTH_MIN 2U
416 #define MCP251XFD_TX_FIFO_DEPTH_COALESCE_MIN 2U
417 
418 static_assert(MCP251XFD_FIFO_TEF_NUM == 1U);
419 static_assert(MCP251XFD_FIFO_TEF_NUM == MCP251XFD_FIFO_TX_NUM);
420 static_assert(MCP251XFD_FIFO_RX_NUM <= 4U);
421 
422 /* Silence TX MAB overflow warnings */
423 #define MCP251XFD_QUIRK_MAB_NO_WARN BIT(0)
424 /* Use CRC to access registers */
425 #define MCP251XFD_QUIRK_CRC_REG BIT(1)
426 /* Use CRC to access RX/TEF-RAM */
427 #define MCP251XFD_QUIRK_CRC_RX BIT(2)
428 /* Use CRC to access TX-RAM */
429 #define MCP251XFD_QUIRK_CRC_TX BIT(3)
430 /* Enable ECC for RAM */
431 #define MCP251XFD_QUIRK_ECC BIT(4)
432 /* Use Half Duplex SPI transfers */
433 #define MCP251XFD_QUIRK_HALF_DUPLEX BIT(5)
434 
435 struct mcp251xfd_hw_tef_obj {
436 	u32 id;
437 	u32 flags;
438 	u32 ts;
439 };
440 
441 /* The tx_obj_raw version is used in spi async, i.e. without
442  * regmap. We have to take care of endianness ourselves.
443  */
444 struct __packed mcp251xfd_hw_tx_obj_raw {
445 	__le32 id;
446 	__le32 flags;
447 	u8 data[sizeof_field(struct canfd_frame, data)];
448 };
449 
450 struct mcp251xfd_hw_tx_obj_can {
451 	u32 id;
452 	u32 flags;
453 	u8 data[sizeof_field(struct can_frame, data)];
454 };
455 
456 struct mcp251xfd_hw_tx_obj_canfd {
457 	u32 id;
458 	u32 flags;
459 	u8 data[sizeof_field(struct canfd_frame, data)];
460 };
461 
462 struct mcp251xfd_hw_rx_obj_can {
463 	u32 id;
464 	u32 flags;
465 	u32 ts;
466 	u8 data[sizeof_field(struct can_frame, data)];
467 };
468 
469 struct mcp251xfd_hw_rx_obj_canfd {
470 	u32 id;
471 	u32 flags;
472 	u32 ts;
473 	u8 data[sizeof_field(struct canfd_frame, data)];
474 };
475 
476 struct __packed mcp251xfd_buf_cmd {
477 	__be16 cmd;
478 };
479 
480 struct __packed mcp251xfd_buf_cmd_crc {
481 	__be16 cmd;
482 	u8 len;
483 };
484 
485 union mcp251xfd_tx_obj_load_buf {
486 	struct __packed {
487 		struct mcp251xfd_buf_cmd cmd;
488 		struct mcp251xfd_hw_tx_obj_raw hw_tx_obj;
489 	} nocrc;
490 	struct __packed {
491 		struct mcp251xfd_buf_cmd_crc cmd;
492 		struct mcp251xfd_hw_tx_obj_raw hw_tx_obj;
493 		__be16 crc;
494 	} crc;
495 } ____cacheline_aligned;
496 
497 union mcp251xfd_write_reg_buf {
498 	struct __packed {
499 		struct mcp251xfd_buf_cmd cmd;
500 		u8 data[4];
501 	} nocrc;
502 	struct __packed {
503 		struct mcp251xfd_buf_cmd_crc cmd;
504 		u8 data[4];
505 		__be16 crc;
506 	} crc;
507 } ____cacheline_aligned;
508 
509 struct mcp251xfd_tx_obj {
510 	struct spi_message msg;
511 	struct spi_transfer xfer[2];
512 	union mcp251xfd_tx_obj_load_buf buf;
513 };
514 
515 struct mcp251xfd_tef_ring {
516 	unsigned int head;
517 	unsigned int tail;
518 
519 	/* u8 obj_num equals tx_ring->obj_num */
520 	/* u8 obj_size equals sizeof(struct mcp251xfd_hw_tef_obj) */
521 
522 	union mcp251xfd_write_reg_buf irq_enable_buf;
523 	struct spi_transfer irq_enable_xfer;
524 	struct spi_message irq_enable_msg;
525 
526 	union mcp251xfd_write_reg_buf uinc_buf;
527 	union mcp251xfd_write_reg_buf uinc_irq_disable_buf;
528 	struct spi_transfer uinc_xfer[MCP251XFD_TX_OBJ_NUM_MAX];
529 };
530 
531 struct mcp251xfd_tx_ring {
532 	unsigned int head;
533 	unsigned int tail;
534 
535 	u16 base;
536 	u8 nr;
537 	u8 fifo_nr;
538 	u8 obj_num;
539 	u8 obj_size;
540 
541 	struct mcp251xfd_tx_obj obj[MCP251XFD_TX_OBJ_NUM_MAX];
542 	union mcp251xfd_write_reg_buf rts_buf;
543 };
544 
545 struct mcp251xfd_rx_ring {
546 	unsigned int head;
547 	unsigned int tail;
548 
549 	u16 base;
550 	u8 nr;
551 	u8 fifo_nr;
552 	u8 obj_num;
553 	u8 obj_size;
554 
555 	union mcp251xfd_write_reg_buf irq_enable_buf;
556 	struct spi_transfer irq_enable_xfer;
557 	struct spi_message irq_enable_msg;
558 
559 	union mcp251xfd_write_reg_buf uinc_buf;
560 	union mcp251xfd_write_reg_buf uinc_irq_disable_buf;
561 	struct spi_transfer uinc_xfer[MCP251XFD_FIFO_DEPTH];
562 	struct mcp251xfd_hw_rx_obj_canfd obj[];
563 };
564 
565 struct __packed mcp251xfd_map_buf_nocrc {
566 	struct mcp251xfd_buf_cmd cmd;
567 	u8 data[256];
568 } ____cacheline_aligned;
569 
570 struct __packed mcp251xfd_map_buf_crc {
571 	struct mcp251xfd_buf_cmd_crc cmd;
572 	u8 data[256 - 4];
573 	__be16 crc;
574 } ____cacheline_aligned;
575 
576 struct mcp251xfd_ecc {
577 	u32 ecc_stat;
578 	int cnt;
579 };
580 
581 struct mcp251xfd_regs_status {
582 	u32 intf;
583 	u32 rxif;
584 };
585 
586 enum mcp251xfd_model {
587 	MCP251XFD_MODEL_MCP2517FD = 0x2517,
588 	MCP251XFD_MODEL_MCP2518FD = 0x2518,
589 	MCP251XFD_MODEL_MCP251863 = 0x251863,
590 	MCP251XFD_MODEL_MCP251XFD = 0xffffffff,	/* autodetect model */
591 };
592 
593 struct mcp251xfd_devtype_data {
594 	enum mcp251xfd_model model;
595 	u32 quirks;
596 };
597 
598 enum mcp251xfd_flags {
599 	MCP251XFD_FLAGS_DOWN,
600 	MCP251XFD_FLAGS_FD_MODE,
601 
602 	__MCP251XFD_FLAGS_SIZE__
603 };
604 
605 struct mcp251xfd_priv {
606 	struct can_priv can;
607 	struct can_rx_offload offload;
608 	struct net_device *ndev;
609 
610 	struct regmap *map_reg;			/* register access */
611 	struct regmap *map_rx;			/* RX/TEF RAM access */
612 
613 	struct regmap *map_nocrc;
614 	struct mcp251xfd_map_buf_nocrc *map_buf_nocrc_rx;
615 	struct mcp251xfd_map_buf_nocrc *map_buf_nocrc_tx;
616 
617 	struct regmap *map_crc;
618 	struct mcp251xfd_map_buf_crc *map_buf_crc_rx;
619 	struct mcp251xfd_map_buf_crc *map_buf_crc_tx;
620 
621 	struct spi_device *spi;
622 	u32 spi_max_speed_hz_orig;
623 	u32 spi_max_speed_hz_fast;
624 	u32 spi_max_speed_hz_slow;
625 
626 	struct mcp251xfd_tef_ring tef[MCP251XFD_FIFO_TEF_NUM];
627 	struct mcp251xfd_rx_ring *rx[MCP251XFD_FIFO_RX_NUM];
628 	struct mcp251xfd_tx_ring tx[MCP251XFD_FIFO_TX_NUM];
629 
630 	DECLARE_BITMAP(flags, __MCP251XFD_FLAGS_SIZE__);
631 
632 	u8 rx_ring_num;
633 	u8 rx_obj_num;
634 	u8 rx_obj_num_coalesce_irq;
635 	u8 tx_obj_num_coalesce_irq;
636 
637 	u32 rx_coalesce_usecs_irq;
638 	u32 tx_coalesce_usecs_irq;
639 	struct hrtimer rx_irq_timer;
640 	struct hrtimer tx_irq_timer;
641 
642 	struct mcp251xfd_ecc ecc;
643 	struct mcp251xfd_regs_status regs_status;
644 
645 	struct cyclecounter cc;
646 	struct timecounter tc;
647 	struct delayed_work timestamp;
648 
649 	struct gpio_desc *rx_int;
650 	struct clk *clk;
651 	bool pll_enable;
652 	struct regulator *reg_vdd;
653 	struct regulator *reg_xceiver;
654 
655 	struct mcp251xfd_devtype_data devtype_data;
656 	struct can_berr_counter bec;
657 };
658 
659 #define MCP251XFD_IS(_model) \
660 static inline bool \
661 mcp251xfd_is_##_model(const struct mcp251xfd_priv *priv) \
662 { \
663 	return priv->devtype_data.model == MCP251XFD_MODEL_MCP##_model; \
664 }
665 
666 MCP251XFD_IS(2517FD);
667 MCP251XFD_IS(2518FD);
668 MCP251XFD_IS(251863);
669 MCP251XFD_IS(251XFD);
670 
671 static inline bool mcp251xfd_is_fd_mode(const struct mcp251xfd_priv *priv)
672 {
673 	/* listen-only mode works like FD mode */
674 	return priv->can.ctrlmode & (CAN_CTRLMODE_LISTENONLY | CAN_CTRLMODE_FD);
675 }
676 
677 static inline u8 mcp251xfd_first_byte_set(u32 mask)
678 {
679 	return (mask & 0x0000ffff) ?
680 		((mask & 0x000000ff) ? 0 : 1) :
681 		((mask & 0x00ff0000) ? 2 : 3);
682 }
683 
684 static inline u8 mcp251xfd_last_byte_set(u32 mask)
685 {
686 	return (mask & 0xffff0000) ?
687 		((mask & 0xff000000) ? 3 : 2) :
688 		((mask & 0x0000ff00) ? 1 : 0);
689 }
690 
691 static inline __be16 mcp251xfd_cmd_reset(void)
692 {
693 	return cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_RESET);
694 }
695 
696 static inline void
697 mcp251xfd_spi_cmd_read_nocrc(struct mcp251xfd_buf_cmd *cmd, u16 addr)
698 {
699 	cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_READ | addr);
700 }
701 
702 static inline void
703 mcp251xfd_spi_cmd_write_nocrc(struct mcp251xfd_buf_cmd *cmd, u16 addr)
704 {
705 	cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_WRITE | addr);
706 }
707 
708 static inline bool mcp251xfd_reg_in_ram(unsigned int reg)
709 {
710 	static const struct regmap_range range =
711 		regmap_reg_range(MCP251XFD_RAM_START,
712 				 MCP251XFD_RAM_START + MCP251XFD_RAM_SIZE - 4);
713 
714 	return regmap_reg_in_range(reg, &range);
715 }
716 
717 static inline void
718 __mcp251xfd_spi_cmd_crc_set_len(struct mcp251xfd_buf_cmd_crc *cmd,
719 				u16 len, bool in_ram)
720 {
721 	/* Number of u32 for RAM access, number of u8 otherwise. */
722 	if (in_ram)
723 		cmd->len = len >> 2;
724 	else
725 		cmd->len = len;
726 }
727 
728 static inline void
729 mcp251xfd_spi_cmd_crc_set_len_in_ram(struct mcp251xfd_buf_cmd_crc *cmd, u16 len)
730 {
731 	__mcp251xfd_spi_cmd_crc_set_len(cmd, len, true);
732 }
733 
734 static inline void
735 mcp251xfd_spi_cmd_crc_set_len_in_reg(struct mcp251xfd_buf_cmd_crc *cmd, u16 len)
736 {
737 	__mcp251xfd_spi_cmd_crc_set_len(cmd, len, false);
738 }
739 
740 static inline void
741 mcp251xfd_spi_cmd_read_crc_set_addr(struct mcp251xfd_buf_cmd_crc *cmd, u16 addr)
742 {
743 	cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_READ_CRC | addr);
744 }
745 
746 static inline void
747 mcp251xfd_spi_cmd_read_crc(struct mcp251xfd_buf_cmd_crc *cmd,
748 			   u16 addr, u16 len)
749 {
750 	mcp251xfd_spi_cmd_read_crc_set_addr(cmd, addr);
751 	__mcp251xfd_spi_cmd_crc_set_len(cmd, len, mcp251xfd_reg_in_ram(addr));
752 }
753 
754 static inline void
755 mcp251xfd_spi_cmd_write_crc_set_addr(struct mcp251xfd_buf_cmd_crc *cmd,
756 				     u16 addr)
757 {
758 	cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_WRITE_CRC | addr);
759 }
760 
761 static inline void
762 mcp251xfd_spi_cmd_write_crc(struct mcp251xfd_buf_cmd_crc *cmd,
763 			    u16 addr, u16 len)
764 {
765 	mcp251xfd_spi_cmd_write_crc_set_addr(cmd, addr);
766 	__mcp251xfd_spi_cmd_crc_set_len(cmd, len, mcp251xfd_reg_in_ram(addr));
767 }
768 
769 static inline u8 *
770 mcp251xfd_spi_cmd_write(const struct mcp251xfd_priv *priv,
771 			union mcp251xfd_write_reg_buf *write_reg_buf,
772 			u16 addr)
773 {
774 	u8 *data;
775 
776 	if (priv->devtype_data.quirks & MCP251XFD_QUIRK_CRC_REG) {
777 		mcp251xfd_spi_cmd_write_crc_set_addr(&write_reg_buf->crc.cmd,
778 						     addr);
779 		data = write_reg_buf->crc.data;
780 	} else {
781 		mcp251xfd_spi_cmd_write_nocrc(&write_reg_buf->nocrc.cmd,
782 					      addr);
783 		data = write_reg_buf->nocrc.data;
784 	}
785 
786 	return data;
787 }
788 
789 static inline int mcp251xfd_get_timestamp(const struct mcp251xfd_priv *priv,
790 					  u32 *timestamp)
791 {
792 	return regmap_read(priv->map_reg, MCP251XFD_REG_TBC, timestamp);
793 }
794 
795 static inline u16 mcp251xfd_get_tef_obj_addr(u8 n)
796 {
797 	return MCP251XFD_RAM_START +
798 		sizeof(struct mcp251xfd_hw_tef_obj) * n;
799 }
800 
801 static inline u16
802 mcp251xfd_get_tx_obj_addr(const struct mcp251xfd_tx_ring *ring, u8 n)
803 {
804 	return ring->base + ring->obj_size * n;
805 }
806 
807 static inline u16
808 mcp251xfd_get_rx_obj_addr(const struct mcp251xfd_rx_ring *ring, u8 n)
809 {
810 	return ring->base + ring->obj_size * n;
811 }
812 
813 static inline int
814 mcp251xfd_tx_tail_get_from_chip(const struct mcp251xfd_priv *priv,
815 				u8 *tx_tail)
816 {
817 	u32 fifo_sta;
818 	int err;
819 
820 	err = regmap_read(priv->map_reg,
821 			  MCP251XFD_REG_FIFOSTA(priv->tx->fifo_nr),
822 			  &fifo_sta);
823 	if (err)
824 		return err;
825 
826 	*tx_tail = FIELD_GET(MCP251XFD_REG_FIFOSTA_FIFOCI_MASK, fifo_sta);
827 
828 	return 0;
829 }
830 
831 static inline u8 mcp251xfd_get_tef_head(const struct mcp251xfd_priv *priv)
832 {
833 	return priv->tef->head & (priv->tx->obj_num - 1);
834 }
835 
836 static inline u8 mcp251xfd_get_tef_tail(const struct mcp251xfd_priv *priv)
837 {
838 	return priv->tef->tail & (priv->tx->obj_num - 1);
839 }
840 
841 static inline u8 mcp251xfd_get_tef_len(const struct mcp251xfd_priv *priv)
842 {
843 	return priv->tef->head - priv->tef->tail;
844 }
845 
846 static inline u8 mcp251xfd_get_tef_linear_len(const struct mcp251xfd_priv *priv)
847 {
848 	u8 len;
849 
850 	len = mcp251xfd_get_tef_len(priv);
851 
852 	return min_t(u8, len, priv->tx->obj_num - mcp251xfd_get_tef_tail(priv));
853 }
854 
855 static inline u8 mcp251xfd_get_tx_head(const struct mcp251xfd_tx_ring *ring)
856 {
857 	return ring->head & (ring->obj_num - 1);
858 }
859 
860 static inline u8 mcp251xfd_get_tx_tail(const struct mcp251xfd_tx_ring *ring)
861 {
862 	return ring->tail & (ring->obj_num - 1);
863 }
864 
865 static inline u8 mcp251xfd_get_tx_free(const struct mcp251xfd_tx_ring *ring)
866 {
867 	return ring->obj_num - (ring->head - ring->tail);
868 }
869 
870 static inline int
871 mcp251xfd_get_tx_nr_by_addr(const struct mcp251xfd_tx_ring *tx_ring, u8 *nr,
872 			    u16 addr)
873 {
874 	if (addr < mcp251xfd_get_tx_obj_addr(tx_ring, 0) ||
875 	    addr >= mcp251xfd_get_tx_obj_addr(tx_ring, tx_ring->obj_num))
876 		return -ENOENT;
877 
878 	*nr = (addr - mcp251xfd_get_tx_obj_addr(tx_ring, 0)) /
879 		tx_ring->obj_size;
880 
881 	return 0;
882 }
883 
884 static inline u8 mcp251xfd_get_rx_head(const struct mcp251xfd_rx_ring *ring)
885 {
886 	return ring->head & (ring->obj_num - 1);
887 }
888 
889 static inline u8 mcp251xfd_get_rx_tail(const struct mcp251xfd_rx_ring *ring)
890 {
891 	return ring->tail & (ring->obj_num - 1);
892 }
893 
894 static inline u8 mcp251xfd_get_rx_len(const struct mcp251xfd_rx_ring *ring)
895 {
896 	return ring->head - ring->tail;
897 }
898 
899 static inline u8
900 mcp251xfd_get_rx_linear_len(const struct mcp251xfd_rx_ring *ring)
901 {
902 	u8 len;
903 
904 	len = mcp251xfd_get_rx_len(ring);
905 
906 	return min_t(u8, len, ring->obj_num - mcp251xfd_get_rx_tail(ring));
907 }
908 
909 #define mcp251xfd_for_each_tx_obj(ring, _obj, n) \
910 	for ((n) = 0, (_obj) = &(ring)->obj[(n)]; \
911 	     (n) < (ring)->obj_num; \
912 	     (n)++, (_obj) = &(ring)->obj[(n)])
913 
914 #define mcp251xfd_for_each_rx_ring(priv, ring, n) \
915 	for ((n) = 0, (ring) = *((priv)->rx + (n)); \
916 	     (n) < (priv)->rx_ring_num; \
917 	     (n)++, (ring) = *((priv)->rx + (n)))
918 
919 int mcp251xfd_chip_fifo_init(const struct mcp251xfd_priv *priv);
920 u16 mcp251xfd_crc16_compute2(const void *cmd, size_t cmd_size,
921 			     const void *data, size_t data_size);
922 u16 mcp251xfd_crc16_compute(const void *data, size_t data_size);
923 void mcp251xfd_ethtool_init(struct mcp251xfd_priv *priv);
924 int mcp251xfd_regmap_init(struct mcp251xfd_priv *priv);
925 extern const struct can_ram_config mcp251xfd_ram_config;
926 int mcp251xfd_ring_init(struct mcp251xfd_priv *priv);
927 void mcp251xfd_ring_free(struct mcp251xfd_priv *priv);
928 int mcp251xfd_ring_alloc(struct mcp251xfd_priv *priv);
929 int mcp251xfd_handle_rxif(struct mcp251xfd_priv *priv);
930 int mcp251xfd_handle_tefif(struct mcp251xfd_priv *priv);
931 void mcp251xfd_skb_set_timestamp(const struct mcp251xfd_priv *priv,
932 				 struct sk_buff *skb, u32 timestamp);
933 void mcp251xfd_timestamp_init(struct mcp251xfd_priv *priv);
934 void mcp251xfd_timestamp_stop(struct mcp251xfd_priv *priv);
935 
936 netdev_tx_t mcp251xfd_start_xmit(struct sk_buff *skb,
937 				 struct net_device *ndev);
938 
939 #if IS_ENABLED(CONFIG_DEV_COREDUMP)
940 void mcp251xfd_dump(const struct mcp251xfd_priv *priv);
941 #else
942 static inline void mcp251xfd_dump(const struct mcp251xfd_priv *priv)
943 {
944 }
945 #endif
946 
947 #endif
948