Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0
0002  *
0003  * mcp251xfd - Microchip MCP251xFD Family CAN controller driver
0004  *
0005  * Copyright (c) 2019, 2020, 2021 Pengutronix,
0006  *               Marc Kleine-Budde <kernel@pengutronix.de>
0007  * Copyright (c) 2019 Martin Sperl <kernel@martin.sperl.org>
0008  */
0009 
0010 #ifndef _MCP251XFD_H
0011 #define _MCP251XFD_H
0012 
0013 #include <linux/bitfield.h>
0014 #include <linux/can/core.h>
0015 #include <linux/can/dev.h>
0016 #include <linux/can/rx-offload.h>
0017 #include <linux/gpio/consumer.h>
0018 #include <linux/kernel.h>
0019 #include <linux/netdevice.h>
0020 #include <linux/regmap.h>
0021 #include <linux/regulator/consumer.h>
0022 #include <linux/spi/spi.h>
0023 #include <linux/timecounter.h>
0024 #include <linux/workqueue.h>
0025 
0026 /* MPC251x registers */
0027 
0028 /* CAN FD Controller Module SFR */
0029 #define MCP251XFD_REG_CON 0x00
0030 #define MCP251XFD_REG_CON_TXBWS_MASK GENMASK(31, 28)
0031 #define MCP251XFD_REG_CON_ABAT BIT(27)
0032 #define MCP251XFD_REG_CON_REQOP_MASK GENMASK(26, 24)
0033 #define MCP251XFD_REG_CON_MODE_MIXED 0
0034 #define MCP251XFD_REG_CON_MODE_SLEEP 1
0035 #define MCP251XFD_REG_CON_MODE_INT_LOOPBACK 2
0036 #define MCP251XFD_REG_CON_MODE_LISTENONLY 3
0037 #define MCP251XFD_REG_CON_MODE_CONFIG 4
0038 #define MCP251XFD_REG_CON_MODE_EXT_LOOPBACK 5
0039 #define MCP251XFD_REG_CON_MODE_CAN2_0 6
0040 #define MCP251XFD_REG_CON_MODE_RESTRICTED 7
0041 #define MCP251XFD_REG_CON_OPMOD_MASK GENMASK(23, 21)
0042 #define MCP251XFD_REG_CON_TXQEN BIT(20)
0043 #define MCP251XFD_REG_CON_STEF BIT(19)
0044 #define MCP251XFD_REG_CON_SERR2LOM BIT(18)
0045 #define MCP251XFD_REG_CON_ESIGM BIT(17)
0046 #define MCP251XFD_REG_CON_RTXAT BIT(16)
0047 #define MCP251XFD_REG_CON_BRSDIS BIT(12)
0048 #define MCP251XFD_REG_CON_BUSY BIT(11)
0049 #define MCP251XFD_REG_CON_WFT_MASK GENMASK(10, 9)
0050 #define MCP251XFD_REG_CON_WFT_T00FILTER 0x0
0051 #define MCP251XFD_REG_CON_WFT_T01FILTER 0x1
0052 #define MCP251XFD_REG_CON_WFT_T10FILTER 0x2
0053 #define MCP251XFD_REG_CON_WFT_T11FILTER 0x3
0054 #define MCP251XFD_REG_CON_WAKFIL BIT(8)
0055 #define MCP251XFD_REG_CON_PXEDIS BIT(6)
0056 #define MCP251XFD_REG_CON_ISOCRCEN BIT(5)
0057 #define MCP251XFD_REG_CON_DNCNT_MASK GENMASK(4, 0)
0058 
0059 #define MCP251XFD_REG_NBTCFG 0x04
0060 #define MCP251XFD_REG_NBTCFG_BRP_MASK GENMASK(31, 24)
0061 #define MCP251XFD_REG_NBTCFG_TSEG1_MASK GENMASK(23, 16)
0062 #define MCP251XFD_REG_NBTCFG_TSEG2_MASK GENMASK(14, 8)
0063 #define MCP251XFD_REG_NBTCFG_SJW_MASK GENMASK(6, 0)
0064 
0065 #define MCP251XFD_REG_DBTCFG 0x08
0066 #define MCP251XFD_REG_DBTCFG_BRP_MASK GENMASK(31, 24)
0067 #define MCP251XFD_REG_DBTCFG_TSEG1_MASK GENMASK(20, 16)
0068 #define MCP251XFD_REG_DBTCFG_TSEG2_MASK GENMASK(11, 8)
0069 #define MCP251XFD_REG_DBTCFG_SJW_MASK GENMASK(3, 0)
0070 
0071 #define MCP251XFD_REG_TDC 0x0c
0072 #define MCP251XFD_REG_TDC_EDGFLTEN BIT(25)
0073 #define MCP251XFD_REG_TDC_SID11EN BIT(24)
0074 #define MCP251XFD_REG_TDC_TDCMOD_MASK GENMASK(17, 16)
0075 #define MCP251XFD_REG_TDC_TDCMOD_AUTO 2
0076 #define MCP251XFD_REG_TDC_TDCMOD_MANUAL 1
0077 #define MCP251XFD_REG_TDC_TDCMOD_DISABLED 0
0078 #define MCP251XFD_REG_TDC_TDCO_MASK GENMASK(14, 8)
0079 #define MCP251XFD_REG_TDC_TDCV_MASK GENMASK(5, 0)
0080 
0081 #define MCP251XFD_REG_TBC 0x10
0082 
0083 #define MCP251XFD_REG_TSCON 0x14
0084 #define MCP251XFD_REG_TSCON_TSRES BIT(18)
0085 #define MCP251XFD_REG_TSCON_TSEOF BIT(17)
0086 #define MCP251XFD_REG_TSCON_TBCEN BIT(16)
0087 #define MCP251XFD_REG_TSCON_TBCPRE_MASK GENMASK(9, 0)
0088 
0089 #define MCP251XFD_REG_VEC 0x18
0090 #define MCP251XFD_REG_VEC_RXCODE_MASK GENMASK(30, 24)
0091 #define MCP251XFD_REG_VEC_TXCODE_MASK GENMASK(22, 16)
0092 #define MCP251XFD_REG_VEC_FILHIT_MASK GENMASK(12, 8)
0093 #define MCP251XFD_REG_VEC_ICODE_MASK GENMASK(6, 0)
0094 
0095 #define MCP251XFD_REG_INT 0x1c
0096 #define MCP251XFD_REG_INT_IF_MASK GENMASK(15, 0)
0097 #define MCP251XFD_REG_INT_IE_MASK GENMASK(31, 16)
0098 #define MCP251XFD_REG_INT_IVMIE BIT(31)
0099 #define MCP251XFD_REG_INT_WAKIE BIT(30)
0100 #define MCP251XFD_REG_INT_CERRIE BIT(29)
0101 #define MCP251XFD_REG_INT_SERRIE BIT(28)
0102 #define MCP251XFD_REG_INT_RXOVIE BIT(27)
0103 #define MCP251XFD_REG_INT_TXATIE BIT(26)
0104 #define MCP251XFD_REG_INT_SPICRCIE BIT(25)
0105 #define MCP251XFD_REG_INT_ECCIE BIT(24)
0106 #define MCP251XFD_REG_INT_TEFIE BIT(20)
0107 #define MCP251XFD_REG_INT_MODIE BIT(19)
0108 #define MCP251XFD_REG_INT_TBCIE BIT(18)
0109 #define MCP251XFD_REG_INT_RXIE BIT(17)
0110 #define MCP251XFD_REG_INT_TXIE BIT(16)
0111 #define MCP251XFD_REG_INT_IVMIF BIT(15)
0112 #define MCP251XFD_REG_INT_WAKIF BIT(14)
0113 #define MCP251XFD_REG_INT_CERRIF BIT(13)
0114 #define MCP251XFD_REG_INT_SERRIF BIT(12)
0115 #define MCP251XFD_REG_INT_RXOVIF BIT(11)
0116 #define MCP251XFD_REG_INT_TXATIF BIT(10)
0117 #define MCP251XFD_REG_INT_SPICRCIF BIT(9)
0118 #define MCP251XFD_REG_INT_ECCIF BIT(8)
0119 #define MCP251XFD_REG_INT_TEFIF BIT(4)
0120 #define MCP251XFD_REG_INT_MODIF BIT(3)
0121 #define MCP251XFD_REG_INT_TBCIF BIT(2)
0122 #define MCP251XFD_REG_INT_RXIF BIT(1)
0123 #define MCP251XFD_REG_INT_TXIF BIT(0)
0124 /* These IRQ flags must be cleared by SW in the CAN_INT register */
0125 #define MCP251XFD_REG_INT_IF_CLEARABLE_MASK \
0126     (MCP251XFD_REG_INT_IVMIF | MCP251XFD_REG_INT_WAKIF | \
0127      MCP251XFD_REG_INT_CERRIF |  MCP251XFD_REG_INT_SERRIF | \
0128      MCP251XFD_REG_INT_MODIF)
0129 
0130 #define MCP251XFD_REG_RXIF 0x20
0131 #define MCP251XFD_REG_TXIF 0x24
0132 #define MCP251XFD_REG_RXOVIF 0x28
0133 #define MCP251XFD_REG_TXATIF 0x2c
0134 #define MCP251XFD_REG_TXREQ 0x30
0135 
0136 #define MCP251XFD_REG_TREC 0x34
0137 #define MCP251XFD_REG_TREC_TXBO BIT(21)
0138 #define MCP251XFD_REG_TREC_TXBP BIT(20)
0139 #define MCP251XFD_REG_TREC_RXBP BIT(19)
0140 #define MCP251XFD_REG_TREC_TXWARN BIT(18)
0141 #define MCP251XFD_REG_TREC_RXWARN BIT(17)
0142 #define MCP251XFD_REG_TREC_EWARN BIT(16)
0143 #define MCP251XFD_REG_TREC_TEC_MASK GENMASK(15, 8)
0144 #define MCP251XFD_REG_TREC_REC_MASK GENMASK(7, 0)
0145 
0146 #define MCP251XFD_REG_BDIAG0 0x38
0147 #define MCP251XFD_REG_BDIAG0_DTERRCNT_MASK GENMASK(31, 24)
0148 #define MCP251XFD_REG_BDIAG0_DRERRCNT_MASK GENMASK(23, 16)
0149 #define MCP251XFD_REG_BDIAG0_NTERRCNT_MASK GENMASK(15, 8)
0150 #define MCP251XFD_REG_BDIAG0_NRERRCNT_MASK GENMASK(7, 0)
0151 
0152 #define MCP251XFD_REG_BDIAG1 0x3c
0153 #define MCP251XFD_REG_BDIAG1_DLCMM BIT(31)
0154 #define MCP251XFD_REG_BDIAG1_ESI BIT(30)
0155 #define MCP251XFD_REG_BDIAG1_DCRCERR BIT(29)
0156 #define MCP251XFD_REG_BDIAG1_DSTUFERR BIT(28)
0157 #define MCP251XFD_REG_BDIAG1_DFORMERR BIT(27)
0158 #define MCP251XFD_REG_BDIAG1_DBIT1ERR BIT(25)
0159 #define MCP251XFD_REG_BDIAG1_DBIT0ERR BIT(24)
0160 #define MCP251XFD_REG_BDIAG1_TXBOERR BIT(23)
0161 #define MCP251XFD_REG_BDIAG1_NCRCERR BIT(21)
0162 #define MCP251XFD_REG_BDIAG1_NSTUFERR BIT(20)
0163 #define MCP251XFD_REG_BDIAG1_NFORMERR BIT(19)
0164 #define MCP251XFD_REG_BDIAG1_NACKERR BIT(18)
0165 #define MCP251XFD_REG_BDIAG1_NBIT1ERR BIT(17)
0166 #define MCP251XFD_REG_BDIAG1_NBIT0ERR BIT(16)
0167 #define MCP251XFD_REG_BDIAG1_BERR_MASK \
0168     (MCP251XFD_REG_BDIAG1_DLCMM | MCP251XFD_REG_BDIAG1_ESI | \
0169      MCP251XFD_REG_BDIAG1_DCRCERR | MCP251XFD_REG_BDIAG1_DSTUFERR | \
0170      MCP251XFD_REG_BDIAG1_DFORMERR | MCP251XFD_REG_BDIAG1_DBIT1ERR | \
0171      MCP251XFD_REG_BDIAG1_DBIT0ERR | MCP251XFD_REG_BDIAG1_TXBOERR | \
0172      MCP251XFD_REG_BDIAG1_NCRCERR | MCP251XFD_REG_BDIAG1_NSTUFERR | \
0173      MCP251XFD_REG_BDIAG1_NFORMERR | MCP251XFD_REG_BDIAG1_NACKERR | \
0174      MCP251XFD_REG_BDIAG1_NBIT1ERR | MCP251XFD_REG_BDIAG1_NBIT0ERR)
0175 #define MCP251XFD_REG_BDIAG1_EFMSGCNT_MASK GENMASK(15, 0)
0176 
0177 #define MCP251XFD_REG_TEFCON 0x40
0178 #define MCP251XFD_REG_TEFCON_FSIZE_MASK GENMASK(28, 24)
0179 #define MCP251XFD_REG_TEFCON_FRESET BIT(10)
0180 #define MCP251XFD_REG_TEFCON_UINC BIT(8)
0181 #define MCP251XFD_REG_TEFCON_TEFTSEN BIT(5)
0182 #define MCP251XFD_REG_TEFCON_TEFOVIE BIT(3)
0183 #define MCP251XFD_REG_TEFCON_TEFFIE BIT(2)
0184 #define MCP251XFD_REG_TEFCON_TEFHIE BIT(1)
0185 #define MCP251XFD_REG_TEFCON_TEFNEIE BIT(0)
0186 
0187 #define MCP251XFD_REG_TEFSTA 0x44
0188 #define MCP251XFD_REG_TEFSTA_TEFOVIF BIT(3)
0189 #define MCP251XFD_REG_TEFSTA_TEFFIF BIT(2)
0190 #define MCP251XFD_REG_TEFSTA_TEFHIF BIT(1)
0191 #define MCP251XFD_REG_TEFSTA_TEFNEIF BIT(0)
0192 
0193 #define MCP251XFD_REG_TEFUA 0x48
0194 
0195 #define MCP251XFD_REG_TXQCON 0x50
0196 #define MCP251XFD_REG_TXQCON_PLSIZE_MASK GENMASK(31, 29)
0197 #define MCP251XFD_REG_TXQCON_PLSIZE_8 0
0198 #define MCP251XFD_REG_TXQCON_PLSIZE_12 1
0199 #define MCP251XFD_REG_TXQCON_PLSIZE_16 2
0200 #define MCP251XFD_REG_TXQCON_PLSIZE_20 3
0201 #define MCP251XFD_REG_TXQCON_PLSIZE_24 4
0202 #define MCP251XFD_REG_TXQCON_PLSIZE_32 5
0203 #define MCP251XFD_REG_TXQCON_PLSIZE_48 6
0204 #define MCP251XFD_REG_TXQCON_PLSIZE_64 7
0205 #define MCP251XFD_REG_TXQCON_FSIZE_MASK GENMASK(28, 24)
0206 #define MCP251XFD_REG_TXQCON_TXAT_UNLIMITED 3
0207 #define MCP251XFD_REG_TXQCON_TXAT_THREE_SHOT 1
0208 #define MCP251XFD_REG_TXQCON_TXAT_ONE_SHOT 0
0209 #define MCP251XFD_REG_TXQCON_TXAT_MASK GENMASK(22, 21)
0210 #define MCP251XFD_REG_TXQCON_TXPRI_MASK GENMASK(20, 16)
0211 #define MCP251XFD_REG_TXQCON_FRESET BIT(10)
0212 #define MCP251XFD_REG_TXQCON_TXREQ BIT(9)
0213 #define MCP251XFD_REG_TXQCON_UINC BIT(8)
0214 #define MCP251XFD_REG_TXQCON_TXEN BIT(7)
0215 #define MCP251XFD_REG_TXQCON_TXATIE BIT(4)
0216 #define MCP251XFD_REG_TXQCON_TXQEIE BIT(2)
0217 #define MCP251XFD_REG_TXQCON_TXQNIE BIT(0)
0218 
0219 #define MCP251XFD_REG_TXQSTA 0x54
0220 #define MCP251XFD_REG_TXQSTA_TXQCI_MASK GENMASK(12, 8)
0221 #define MCP251XFD_REG_TXQSTA_TXABT BIT(7)
0222 #define MCP251XFD_REG_TXQSTA_TXLARB BIT(6)
0223 #define MCP251XFD_REG_TXQSTA_TXERR BIT(5)
0224 #define MCP251XFD_REG_TXQSTA_TXATIF BIT(4)
0225 #define MCP251XFD_REG_TXQSTA_TXQEIF BIT(2)
0226 #define MCP251XFD_REG_TXQSTA_TXQNIF BIT(0)
0227 
0228 #define MCP251XFD_REG_TXQUA 0x58
0229 
0230 #define MCP251XFD_REG_FIFOCON(x) (0x50 + 0xc * (x))
0231 #define MCP251XFD_REG_FIFOCON_PLSIZE_MASK GENMASK(31, 29)
0232 #define MCP251XFD_REG_FIFOCON_PLSIZE_8 0
0233 #define MCP251XFD_REG_FIFOCON_PLSIZE_12 1
0234 #define MCP251XFD_REG_FIFOCON_PLSIZE_16 2
0235 #define MCP251XFD_REG_FIFOCON_PLSIZE_20 3
0236 #define MCP251XFD_REG_FIFOCON_PLSIZE_24 4
0237 #define MCP251XFD_REG_FIFOCON_PLSIZE_32 5
0238 #define MCP251XFD_REG_FIFOCON_PLSIZE_48 6
0239 #define MCP251XFD_REG_FIFOCON_PLSIZE_64 7
0240 #define MCP251XFD_REG_FIFOCON_FSIZE_MASK GENMASK(28, 24)
0241 #define MCP251XFD_REG_FIFOCON_TXAT_MASK GENMASK(22, 21)
0242 #define MCP251XFD_REG_FIFOCON_TXAT_ONE_SHOT 0
0243 #define MCP251XFD_REG_FIFOCON_TXAT_THREE_SHOT 1
0244 #define MCP251XFD_REG_FIFOCON_TXAT_UNLIMITED 3
0245 #define MCP251XFD_REG_FIFOCON_TXPRI_MASK GENMASK(20, 16)
0246 #define MCP251XFD_REG_FIFOCON_FRESET BIT(10)
0247 #define MCP251XFD_REG_FIFOCON_TXREQ BIT(9)
0248 #define MCP251XFD_REG_FIFOCON_UINC BIT(8)
0249 #define MCP251XFD_REG_FIFOCON_TXEN BIT(7)
0250 #define MCP251XFD_REG_FIFOCON_RTREN BIT(6)
0251 #define MCP251XFD_REG_FIFOCON_RXTSEN BIT(5)
0252 #define MCP251XFD_REG_FIFOCON_TXATIE BIT(4)
0253 #define MCP251XFD_REG_FIFOCON_RXOVIE BIT(3)
0254 #define MCP251XFD_REG_FIFOCON_TFERFFIE BIT(2)
0255 #define MCP251XFD_REG_FIFOCON_TFHRFHIE BIT(1)
0256 #define MCP251XFD_REG_FIFOCON_TFNRFNIE BIT(0)
0257 
0258 #define MCP251XFD_REG_FIFOSTA(x) (0x54 + 0xc * (x))
0259 #define MCP251XFD_REG_FIFOSTA_FIFOCI_MASK GENMASK(12, 8)
0260 #define MCP251XFD_REG_FIFOSTA_TXABT BIT(7)
0261 #define MCP251XFD_REG_FIFOSTA_TXLARB BIT(6)
0262 #define MCP251XFD_REG_FIFOSTA_TXERR BIT(5)
0263 #define MCP251XFD_REG_FIFOSTA_TXATIF BIT(4)
0264 #define MCP251XFD_REG_FIFOSTA_RXOVIF BIT(3)
0265 #define MCP251XFD_REG_FIFOSTA_TFERFFIF BIT(2)
0266 #define MCP251XFD_REG_FIFOSTA_TFHRFHIF BIT(1)
0267 #define MCP251XFD_REG_FIFOSTA_TFNRFNIF BIT(0)
0268 
0269 #define MCP251XFD_REG_FIFOUA(x) (0x58 + 0xc * (x))
0270 
0271 #define MCP251XFD_REG_FLTCON(x) (0x1d0 + 0x4 * (x))
0272 #define MCP251XFD_REG_FLTCON_FLTEN3 BIT(31)
0273 #define MCP251XFD_REG_FLTCON_F3BP_MASK GENMASK(28, 24)
0274 #define MCP251XFD_REG_FLTCON_FLTEN2 BIT(23)
0275 #define MCP251XFD_REG_FLTCON_F2BP_MASK GENMASK(20, 16)
0276 #define MCP251XFD_REG_FLTCON_FLTEN1 BIT(15)
0277 #define MCP251XFD_REG_FLTCON_F1BP_MASK GENMASK(12, 8)
0278 #define MCP251XFD_REG_FLTCON_FLTEN0 BIT(7)
0279 #define MCP251XFD_REG_FLTCON_F0BP_MASK GENMASK(4, 0)
0280 #define MCP251XFD_REG_FLTCON_FLTEN(x) (BIT(7) << 8 * ((x) & 0x3))
0281 #define MCP251XFD_REG_FLTCON_FLT_MASK(x) (GENMASK(7, 0) << (8 * ((x) & 0x3)))
0282 #define MCP251XFD_REG_FLTCON_FBP(x, fifo) ((fifo) << 8 * ((x) & 0x3))
0283 
0284 #define MCP251XFD_REG_FLTOBJ(x) (0x1f0 + 0x8 * (x))
0285 #define MCP251XFD_REG_FLTOBJ_EXIDE BIT(30)
0286 #define MCP251XFD_REG_FLTOBJ_SID11 BIT(29)
0287 #define MCP251XFD_REG_FLTOBJ_EID_MASK GENMASK(28, 11)
0288 #define MCP251XFD_REG_FLTOBJ_SID_MASK GENMASK(10, 0)
0289 
0290 #define MCP251XFD_REG_FLTMASK(x) (0x1f4 + 0x8 * (x))
0291 #define MCP251XFD_REG_MASK_MIDE BIT(30)
0292 #define MCP251XFD_REG_MASK_MSID11 BIT(29)
0293 #define MCP251XFD_REG_MASK_MEID_MASK GENMASK(28, 11)
0294 #define MCP251XFD_REG_MASK_MSID_MASK GENMASK(10, 0)
0295 
0296 /* RAM */
0297 #define MCP251XFD_RAM_START 0x400
0298 #define MCP251XFD_RAM_SIZE SZ_2K
0299 
0300 /* Message Object */
0301 #define MCP251XFD_OBJ_ID_SID11 BIT(29)
0302 #define MCP251XFD_OBJ_ID_EID_MASK GENMASK(28, 11)
0303 #define MCP251XFD_OBJ_ID_SID_MASK GENMASK(10, 0)
0304 #define MCP251XFD_OBJ_FLAGS_SEQ_MCP2518FD_MASK GENMASK(31, 9)
0305 #define MCP251XFD_OBJ_FLAGS_SEQ_MCP2517FD_MASK GENMASK(15, 9)
0306 #define MCP251XFD_OBJ_FLAGS_SEQ_MASK MCP251XFD_OBJ_FLAGS_SEQ_MCP2518FD_MASK
0307 #define MCP251XFD_OBJ_FLAGS_ESI BIT(8)
0308 #define MCP251XFD_OBJ_FLAGS_FDF BIT(7)
0309 #define MCP251XFD_OBJ_FLAGS_BRS BIT(6)
0310 #define MCP251XFD_OBJ_FLAGS_RTR BIT(5)
0311 #define MCP251XFD_OBJ_FLAGS_IDE BIT(4)
0312 #define MCP251XFD_OBJ_FLAGS_DLC_MASK GENMASK(3, 0)
0313 
0314 #define MCP251XFD_REG_FRAME_EFF_SID_MASK GENMASK(28, 18)
0315 #define MCP251XFD_REG_FRAME_EFF_EID_MASK GENMASK(17, 0)
0316 
0317 /* MCP2517/18FD SFR */
0318 #define MCP251XFD_REG_OSC 0xe00
0319 #define MCP251XFD_REG_OSC_SCLKRDY BIT(12)
0320 #define MCP251XFD_REG_OSC_OSCRDY BIT(10)
0321 #define MCP251XFD_REG_OSC_PLLRDY BIT(8)
0322 #define MCP251XFD_REG_OSC_CLKODIV_10 3
0323 #define MCP251XFD_REG_OSC_CLKODIV_4 2
0324 #define MCP251XFD_REG_OSC_CLKODIV_2 1
0325 #define MCP251XFD_REG_OSC_CLKODIV_1 0
0326 #define MCP251XFD_REG_OSC_CLKODIV_MASK GENMASK(6, 5)
0327 #define MCP251XFD_REG_OSC_SCLKDIV BIT(4)
0328 #define MCP251XFD_REG_OSC_LPMEN BIT(3)  /* MCP2518FD only */
0329 #define MCP251XFD_REG_OSC_OSCDIS BIT(2)
0330 #define MCP251XFD_REG_OSC_PLLEN BIT(0)
0331 
0332 #define MCP251XFD_REG_IOCON 0xe04
0333 #define MCP251XFD_REG_IOCON_INTOD BIT(30)
0334 #define MCP251XFD_REG_IOCON_SOF BIT(29)
0335 #define MCP251XFD_REG_IOCON_TXCANOD BIT(28)
0336 #define MCP251XFD_REG_IOCON_PM1 BIT(25)
0337 #define MCP251XFD_REG_IOCON_PM0 BIT(24)
0338 #define MCP251XFD_REG_IOCON_GPIO1 BIT(17)
0339 #define MCP251XFD_REG_IOCON_GPIO0 BIT(16)
0340 #define MCP251XFD_REG_IOCON_LAT1 BIT(9)
0341 #define MCP251XFD_REG_IOCON_LAT0 BIT(8)
0342 #define MCP251XFD_REG_IOCON_XSTBYEN BIT(6)
0343 #define MCP251XFD_REG_IOCON_TRIS1 BIT(1)
0344 #define MCP251XFD_REG_IOCON_TRIS0 BIT(0)
0345 
0346 #define MCP251XFD_REG_CRC 0xe08
0347 #define MCP251XFD_REG_CRC_FERRIE BIT(25)
0348 #define MCP251XFD_REG_CRC_CRCERRIE BIT(24)
0349 #define MCP251XFD_REG_CRC_FERRIF BIT(17)
0350 #define MCP251XFD_REG_CRC_CRCERRIF BIT(16)
0351 #define MCP251XFD_REG_CRC_IF_MASK GENMASK(17, 16)
0352 #define MCP251XFD_REG_CRC_MASK GENMASK(15, 0)
0353 
0354 #define MCP251XFD_REG_ECCCON 0xe0c
0355 #define MCP251XFD_REG_ECCCON_PARITY_MASK GENMASK(14, 8)
0356 #define MCP251XFD_REG_ECCCON_DEDIE BIT(2)
0357 #define MCP251XFD_REG_ECCCON_SECIE BIT(1)
0358 #define MCP251XFD_REG_ECCCON_ECCEN BIT(0)
0359 
0360 #define MCP251XFD_REG_ECCSTAT 0xe10
0361 #define MCP251XFD_REG_ECCSTAT_ERRADDR_MASK GENMASK(27, 16)
0362 #define MCP251XFD_REG_ECCSTAT_IF_MASK GENMASK(2, 1)
0363 #define MCP251XFD_REG_ECCSTAT_DEDIF BIT(2)
0364 #define MCP251XFD_REG_ECCSTAT_SECIF BIT(1)
0365 
0366 #define MCP251XFD_REG_DEVID 0xe14   /* MCP2518FD only */
0367 #define MCP251XFD_REG_DEVID_ID_MASK GENMASK(7, 4)
0368 #define MCP251XFD_REG_DEVID_REV_MASK GENMASK(3, 0)
0369 
0370 /* SPI commands */
0371 #define MCP251XFD_SPI_INSTRUCTION_RESET 0x0000
0372 #define MCP251XFD_SPI_INSTRUCTION_WRITE 0x2000
0373 #define MCP251XFD_SPI_INSTRUCTION_READ 0x3000
0374 #define MCP251XFD_SPI_INSTRUCTION_WRITE_CRC 0xa000
0375 #define MCP251XFD_SPI_INSTRUCTION_READ_CRC 0xb000
0376 #define MCP251XFD_SPI_INSTRUCTION_WRITE_CRC_SAFE 0xc000
0377 #define MCP251XFD_SPI_ADDRESS_MASK GENMASK(11, 0)
0378 
0379 #define MCP251XFD_SYSCLOCK_HZ_MAX 40000000
0380 #define MCP251XFD_SYSCLOCK_HZ_MIN 1000000
0381 #define MCP251XFD_SPICLOCK_HZ_MAX 20000000
0382 #define MCP251XFD_TIMESTAMP_WORK_DELAY_SEC 45
0383 static_assert(MCP251XFD_TIMESTAMP_WORK_DELAY_SEC <
0384           CYCLECOUNTER_MASK(32) / MCP251XFD_SYSCLOCK_HZ_MAX / 2);
0385 #define MCP251XFD_OSC_PLL_MULTIPLIER 10
0386 #define MCP251XFD_OSC_STAB_SLEEP_US (3 * USEC_PER_MSEC)
0387 #define MCP251XFD_OSC_STAB_TIMEOUT_US (10 * MCP251XFD_OSC_STAB_SLEEP_US)
0388 #define MCP251XFD_POLL_SLEEP_US (10)
0389 #define MCP251XFD_POLL_TIMEOUT_US (USEC_PER_MSEC)
0390 
0391 /* Misc */
0392 #define MCP251XFD_NAPI_WEIGHT 32
0393 #define MCP251XFD_SOFTRESET_RETRIES_MAX 3
0394 #define MCP251XFD_READ_CRC_RETRIES_MAX 3
0395 #define MCP251XFD_ECC_CNT_MAX 2
0396 #define MCP251XFD_SANITIZE_SPI 1
0397 #define MCP251XFD_SANITIZE_CAN 1
0398 
0399 /* FIFO and Ring */
0400 #define MCP251XFD_FIFO_TEF_NUM 1U
0401 #define MCP251XFD_FIFO_RX_NUM 3U
0402 #define MCP251XFD_FIFO_TX_NUM 1U
0403 
0404 #define MCP251XFD_FIFO_DEPTH 32U
0405 
0406 #define MCP251XFD_RX_OBJ_NUM_MIN 16U
0407 #define MCP251XFD_RX_OBJ_NUM_MAX (MCP251XFD_FIFO_RX_NUM * MCP251XFD_FIFO_DEPTH)
0408 #define MCP251XFD_RX_FIFO_DEPTH_MIN 4U
0409 #define MCP251XFD_RX_FIFO_DEPTH_COALESCE_MIN 8U
0410 
0411 #define MCP251XFD_TX_OBJ_NUM_MIN 2U
0412 #define MCP251XFD_TX_OBJ_NUM_MAX 16U
0413 #define MCP251XFD_TX_OBJ_NUM_CAN_DEFAULT 8U
0414 #define MCP251XFD_TX_OBJ_NUM_CANFD_DEFAULT 4U
0415 #define MCP251XFD_TX_FIFO_DEPTH_MIN 2U
0416 #define MCP251XFD_TX_FIFO_DEPTH_COALESCE_MIN 2U
0417 
0418 static_assert(MCP251XFD_FIFO_TEF_NUM == 1U);
0419 static_assert(MCP251XFD_FIFO_TEF_NUM == MCP251XFD_FIFO_TX_NUM);
0420 static_assert(MCP251XFD_FIFO_RX_NUM <= 4U);
0421 
0422 /* Silence TX MAB overflow warnings */
0423 #define MCP251XFD_QUIRK_MAB_NO_WARN BIT(0)
0424 /* Use CRC to access registers */
0425 #define MCP251XFD_QUIRK_CRC_REG BIT(1)
0426 /* Use CRC to access RX/TEF-RAM */
0427 #define MCP251XFD_QUIRK_CRC_RX BIT(2)
0428 /* Use CRC to access TX-RAM */
0429 #define MCP251XFD_QUIRK_CRC_TX BIT(3)
0430 /* Enable ECC for RAM */
0431 #define MCP251XFD_QUIRK_ECC BIT(4)
0432 /* Use Half Duplex SPI transfers */
0433 #define MCP251XFD_QUIRK_HALF_DUPLEX BIT(5)
0434 
0435 struct mcp251xfd_hw_tef_obj {
0436     u32 id;
0437     u32 flags;
0438     u32 ts;
0439 };
0440 
0441 /* The tx_obj_raw version is used in spi async, i.e. without
0442  * regmap. We have to take care of endianness ourselves.
0443  */
0444 struct __packed mcp251xfd_hw_tx_obj_raw {
0445     __le32 id;
0446     __le32 flags;
0447     u8 data[sizeof_field(struct canfd_frame, data)];
0448 };
0449 
0450 struct mcp251xfd_hw_tx_obj_can {
0451     u32 id;
0452     u32 flags;
0453     u8 data[sizeof_field(struct can_frame, data)];
0454 };
0455 
0456 struct mcp251xfd_hw_tx_obj_canfd {
0457     u32 id;
0458     u32 flags;
0459     u8 data[sizeof_field(struct canfd_frame, data)];
0460 };
0461 
0462 struct mcp251xfd_hw_rx_obj_can {
0463     u32 id;
0464     u32 flags;
0465     u32 ts;
0466     u8 data[sizeof_field(struct can_frame, data)];
0467 };
0468 
0469 struct mcp251xfd_hw_rx_obj_canfd {
0470     u32 id;
0471     u32 flags;
0472     u32 ts;
0473     u8 data[sizeof_field(struct canfd_frame, data)];
0474 };
0475 
0476 struct __packed mcp251xfd_buf_cmd {
0477     __be16 cmd;
0478 };
0479 
0480 struct __packed mcp251xfd_buf_cmd_crc {
0481     __be16 cmd;
0482     u8 len;
0483 };
0484 
0485 union mcp251xfd_tx_obj_load_buf {
0486     struct __packed {
0487         struct mcp251xfd_buf_cmd cmd;
0488         struct mcp251xfd_hw_tx_obj_raw hw_tx_obj;
0489     } nocrc;
0490     struct __packed {
0491         struct mcp251xfd_buf_cmd_crc cmd;
0492         struct mcp251xfd_hw_tx_obj_raw hw_tx_obj;
0493         __be16 crc;
0494     } crc;
0495 } ____cacheline_aligned;
0496 
0497 union mcp251xfd_write_reg_buf {
0498     struct __packed {
0499         struct mcp251xfd_buf_cmd cmd;
0500         u8 data[4];
0501     } nocrc;
0502     struct __packed {
0503         struct mcp251xfd_buf_cmd_crc cmd;
0504         u8 data[4];
0505         __be16 crc;
0506     } crc;
0507 } ____cacheline_aligned;
0508 
0509 struct mcp251xfd_tx_obj {
0510     struct spi_message msg;
0511     struct spi_transfer xfer[2];
0512     union mcp251xfd_tx_obj_load_buf buf;
0513 };
0514 
0515 struct mcp251xfd_tef_ring {
0516     unsigned int head;
0517     unsigned int tail;
0518 
0519     /* u8 obj_num equals tx_ring->obj_num */
0520     /* u8 obj_size equals sizeof(struct mcp251xfd_hw_tef_obj) */
0521 
0522     union mcp251xfd_write_reg_buf irq_enable_buf;
0523     struct spi_transfer irq_enable_xfer;
0524     struct spi_message irq_enable_msg;
0525 
0526     union mcp251xfd_write_reg_buf uinc_buf;
0527     union mcp251xfd_write_reg_buf uinc_irq_disable_buf;
0528     struct spi_transfer uinc_xfer[MCP251XFD_TX_OBJ_NUM_MAX];
0529 };
0530 
0531 struct mcp251xfd_tx_ring {
0532     unsigned int head;
0533     unsigned int tail;
0534 
0535     u16 base;
0536     u8 nr;
0537     u8 fifo_nr;
0538     u8 obj_num;
0539     u8 obj_size;
0540 
0541     struct mcp251xfd_tx_obj obj[MCP251XFD_TX_OBJ_NUM_MAX];
0542     union mcp251xfd_write_reg_buf rts_buf;
0543 };
0544 
0545 struct mcp251xfd_rx_ring {
0546     unsigned int head;
0547     unsigned int tail;
0548 
0549     u16 base;
0550     u8 nr;
0551     u8 fifo_nr;
0552     u8 obj_num;
0553     u8 obj_size;
0554 
0555     union mcp251xfd_write_reg_buf irq_enable_buf;
0556     struct spi_transfer irq_enable_xfer;
0557     struct spi_message irq_enable_msg;
0558 
0559     union mcp251xfd_write_reg_buf uinc_buf;
0560     union mcp251xfd_write_reg_buf uinc_irq_disable_buf;
0561     struct spi_transfer uinc_xfer[MCP251XFD_FIFO_DEPTH];
0562     struct mcp251xfd_hw_rx_obj_canfd obj[];
0563 };
0564 
0565 struct __packed mcp251xfd_map_buf_nocrc {
0566     struct mcp251xfd_buf_cmd cmd;
0567     u8 data[256];
0568 } ____cacheline_aligned;
0569 
0570 struct __packed mcp251xfd_map_buf_crc {
0571     struct mcp251xfd_buf_cmd_crc cmd;
0572     u8 data[256 - 4];
0573     __be16 crc;
0574 } ____cacheline_aligned;
0575 
0576 struct mcp251xfd_ecc {
0577     u32 ecc_stat;
0578     int cnt;
0579 };
0580 
0581 struct mcp251xfd_regs_status {
0582     u32 intf;
0583     u32 rxif;
0584 };
0585 
0586 enum mcp251xfd_model {
0587     MCP251XFD_MODEL_MCP2517FD = 0x2517,
0588     MCP251XFD_MODEL_MCP2518FD = 0x2518,
0589     MCP251XFD_MODEL_MCP251863 = 0x251863,
0590     MCP251XFD_MODEL_MCP251XFD = 0xffffffff, /* autodetect model */
0591 };
0592 
0593 struct mcp251xfd_devtype_data {
0594     enum mcp251xfd_model model;
0595     u32 quirks;
0596 };
0597 
0598 enum mcp251xfd_flags {
0599     MCP251XFD_FLAGS_DOWN,
0600     MCP251XFD_FLAGS_FD_MODE,
0601 
0602     __MCP251XFD_FLAGS_SIZE__
0603 };
0604 
0605 struct mcp251xfd_priv {
0606     struct can_priv can;
0607     struct can_rx_offload offload;
0608     struct net_device *ndev;
0609 
0610     struct regmap *map_reg;         /* register access */
0611     struct regmap *map_rx;          /* RX/TEF RAM access */
0612 
0613     struct regmap *map_nocrc;
0614     struct mcp251xfd_map_buf_nocrc *map_buf_nocrc_rx;
0615     struct mcp251xfd_map_buf_nocrc *map_buf_nocrc_tx;
0616 
0617     struct regmap *map_crc;
0618     struct mcp251xfd_map_buf_crc *map_buf_crc_rx;
0619     struct mcp251xfd_map_buf_crc *map_buf_crc_tx;
0620 
0621     struct spi_device *spi;
0622     u32 spi_max_speed_hz_orig;
0623     u32 spi_max_speed_hz_fast;
0624     u32 spi_max_speed_hz_slow;
0625 
0626     struct mcp251xfd_tef_ring tef[MCP251XFD_FIFO_TEF_NUM];
0627     struct mcp251xfd_rx_ring *rx[MCP251XFD_FIFO_RX_NUM];
0628     struct mcp251xfd_tx_ring tx[MCP251XFD_FIFO_TX_NUM];
0629 
0630     DECLARE_BITMAP(flags, __MCP251XFD_FLAGS_SIZE__);
0631 
0632     u8 rx_ring_num;
0633     u8 rx_obj_num;
0634     u8 rx_obj_num_coalesce_irq;
0635     u8 tx_obj_num_coalesce_irq;
0636 
0637     u32 rx_coalesce_usecs_irq;
0638     u32 tx_coalesce_usecs_irq;
0639     struct hrtimer rx_irq_timer;
0640     struct hrtimer tx_irq_timer;
0641 
0642     struct mcp251xfd_ecc ecc;
0643     struct mcp251xfd_regs_status regs_status;
0644 
0645     struct cyclecounter cc;
0646     struct timecounter tc;
0647     struct delayed_work timestamp;
0648 
0649     struct gpio_desc *rx_int;
0650     struct clk *clk;
0651     bool pll_enable;
0652     struct regulator *reg_vdd;
0653     struct regulator *reg_xceiver;
0654 
0655     struct mcp251xfd_devtype_data devtype_data;
0656     struct can_berr_counter bec;
0657 };
0658 
0659 #define MCP251XFD_IS(_model) \
0660 static inline bool \
0661 mcp251xfd_is_##_model(const struct mcp251xfd_priv *priv) \
0662 { \
0663     return priv->devtype_data.model == MCP251XFD_MODEL_MCP##_model; \
0664 }
0665 
0666 MCP251XFD_IS(2517FD);
0667 MCP251XFD_IS(2518FD);
0668 MCP251XFD_IS(251863);
0669 MCP251XFD_IS(251XFD);
0670 
0671 static inline bool mcp251xfd_is_fd_mode(const struct mcp251xfd_priv *priv)
0672 {
0673     /* listen-only mode works like FD mode */
0674     return priv->can.ctrlmode & (CAN_CTRLMODE_LISTENONLY | CAN_CTRLMODE_FD);
0675 }
0676 
0677 static inline u8 mcp251xfd_first_byte_set(u32 mask)
0678 {
0679     return (mask & 0x0000ffff) ?
0680         ((mask & 0x000000ff) ? 0 : 1) :
0681         ((mask & 0x00ff0000) ? 2 : 3);
0682 }
0683 
0684 static inline u8 mcp251xfd_last_byte_set(u32 mask)
0685 {
0686     return (mask & 0xffff0000) ?
0687         ((mask & 0xff000000) ? 3 : 2) :
0688         ((mask & 0x0000ff00) ? 1 : 0);
0689 }
0690 
0691 static inline __be16 mcp251xfd_cmd_reset(void)
0692 {
0693     return cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_RESET);
0694 }
0695 
0696 static inline void
0697 mcp251xfd_spi_cmd_read_nocrc(struct mcp251xfd_buf_cmd *cmd, u16 addr)
0698 {
0699     cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_READ | addr);
0700 }
0701 
0702 static inline void
0703 mcp251xfd_spi_cmd_write_nocrc(struct mcp251xfd_buf_cmd *cmd, u16 addr)
0704 {
0705     cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_WRITE | addr);
0706 }
0707 
0708 static inline bool mcp251xfd_reg_in_ram(unsigned int reg)
0709 {
0710     static const struct regmap_range range =
0711         regmap_reg_range(MCP251XFD_RAM_START,
0712                  MCP251XFD_RAM_START + MCP251XFD_RAM_SIZE - 4);
0713 
0714     return regmap_reg_in_range(reg, &range);
0715 }
0716 
0717 static inline void
0718 __mcp251xfd_spi_cmd_crc_set_len(struct mcp251xfd_buf_cmd_crc *cmd,
0719                 u16 len, bool in_ram)
0720 {
0721     /* Number of u32 for RAM access, number of u8 otherwise. */
0722     if (in_ram)
0723         cmd->len = len >> 2;
0724     else
0725         cmd->len = len;
0726 }
0727 
0728 static inline void
0729 mcp251xfd_spi_cmd_crc_set_len_in_ram(struct mcp251xfd_buf_cmd_crc *cmd, u16 len)
0730 {
0731     __mcp251xfd_spi_cmd_crc_set_len(cmd, len, true);
0732 }
0733 
0734 static inline void
0735 mcp251xfd_spi_cmd_crc_set_len_in_reg(struct mcp251xfd_buf_cmd_crc *cmd, u16 len)
0736 {
0737     __mcp251xfd_spi_cmd_crc_set_len(cmd, len, false);
0738 }
0739 
0740 static inline void
0741 mcp251xfd_spi_cmd_read_crc_set_addr(struct mcp251xfd_buf_cmd_crc *cmd, u16 addr)
0742 {
0743     cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_READ_CRC | addr);
0744 }
0745 
0746 static inline void
0747 mcp251xfd_spi_cmd_read_crc(struct mcp251xfd_buf_cmd_crc *cmd,
0748                u16 addr, u16 len)
0749 {
0750     mcp251xfd_spi_cmd_read_crc_set_addr(cmd, addr);
0751     __mcp251xfd_spi_cmd_crc_set_len(cmd, len, mcp251xfd_reg_in_ram(addr));
0752 }
0753 
0754 static inline void
0755 mcp251xfd_spi_cmd_write_crc_set_addr(struct mcp251xfd_buf_cmd_crc *cmd,
0756                      u16 addr)
0757 {
0758     cmd->cmd = cpu_to_be16(MCP251XFD_SPI_INSTRUCTION_WRITE_CRC | addr);
0759 }
0760 
0761 static inline void
0762 mcp251xfd_spi_cmd_write_crc(struct mcp251xfd_buf_cmd_crc *cmd,
0763                 u16 addr, u16 len)
0764 {
0765     mcp251xfd_spi_cmd_write_crc_set_addr(cmd, addr);
0766     __mcp251xfd_spi_cmd_crc_set_len(cmd, len, mcp251xfd_reg_in_ram(addr));
0767 }
0768 
0769 static inline u8 *
0770 mcp251xfd_spi_cmd_write(const struct mcp251xfd_priv *priv,
0771             union mcp251xfd_write_reg_buf *write_reg_buf,
0772             u16 addr)
0773 {
0774     u8 *data;
0775 
0776     if (priv->devtype_data.quirks & MCP251XFD_QUIRK_CRC_REG) {
0777         mcp251xfd_spi_cmd_write_crc_set_addr(&write_reg_buf->crc.cmd,
0778                              addr);
0779         data = write_reg_buf->crc.data;
0780     } else {
0781         mcp251xfd_spi_cmd_write_nocrc(&write_reg_buf->nocrc.cmd,
0782                           addr);
0783         data = write_reg_buf->nocrc.data;
0784     }
0785 
0786     return data;
0787 }
0788 
0789 static inline int mcp251xfd_get_timestamp(const struct mcp251xfd_priv *priv,
0790                       u32 *timestamp)
0791 {
0792     return regmap_read(priv->map_reg, MCP251XFD_REG_TBC, timestamp);
0793 }
0794 
0795 static inline u16 mcp251xfd_get_tef_obj_addr(u8 n)
0796 {
0797     return MCP251XFD_RAM_START +
0798         sizeof(struct mcp251xfd_hw_tef_obj) * n;
0799 }
0800 
0801 static inline u16
0802 mcp251xfd_get_tx_obj_addr(const struct mcp251xfd_tx_ring *ring, u8 n)
0803 {
0804     return ring->base + ring->obj_size * n;
0805 }
0806 
0807 static inline u16
0808 mcp251xfd_get_rx_obj_addr(const struct mcp251xfd_rx_ring *ring, u8 n)
0809 {
0810     return ring->base + ring->obj_size * n;
0811 }
0812 
0813 static inline int
0814 mcp251xfd_tx_tail_get_from_chip(const struct mcp251xfd_priv *priv,
0815                 u8 *tx_tail)
0816 {
0817     u32 fifo_sta;
0818     int err;
0819 
0820     err = regmap_read(priv->map_reg,
0821               MCP251XFD_REG_FIFOSTA(priv->tx->fifo_nr),
0822               &fifo_sta);
0823     if (err)
0824         return err;
0825 
0826     *tx_tail = FIELD_GET(MCP251XFD_REG_FIFOSTA_FIFOCI_MASK, fifo_sta);
0827 
0828     return 0;
0829 }
0830 
0831 static inline u8 mcp251xfd_get_tef_head(const struct mcp251xfd_priv *priv)
0832 {
0833     return priv->tef->head & (priv->tx->obj_num - 1);
0834 }
0835 
0836 static inline u8 mcp251xfd_get_tef_tail(const struct mcp251xfd_priv *priv)
0837 {
0838     return priv->tef->tail & (priv->tx->obj_num - 1);
0839 }
0840 
0841 static inline u8 mcp251xfd_get_tef_len(const struct mcp251xfd_priv *priv)
0842 {
0843     return priv->tef->head - priv->tef->tail;
0844 }
0845 
0846 static inline u8 mcp251xfd_get_tef_linear_len(const struct mcp251xfd_priv *priv)
0847 {
0848     u8 len;
0849 
0850     len = mcp251xfd_get_tef_len(priv);
0851 
0852     return min_t(u8, len, priv->tx->obj_num - mcp251xfd_get_tef_tail(priv));
0853 }
0854 
0855 static inline u8 mcp251xfd_get_tx_head(const struct mcp251xfd_tx_ring *ring)
0856 {
0857     return ring->head & (ring->obj_num - 1);
0858 }
0859 
0860 static inline u8 mcp251xfd_get_tx_tail(const struct mcp251xfd_tx_ring *ring)
0861 {
0862     return ring->tail & (ring->obj_num - 1);
0863 }
0864 
0865 static inline u8 mcp251xfd_get_tx_free(const struct mcp251xfd_tx_ring *ring)
0866 {
0867     return ring->obj_num - (ring->head - ring->tail);
0868 }
0869 
0870 static inline int
0871 mcp251xfd_get_tx_nr_by_addr(const struct mcp251xfd_tx_ring *tx_ring, u8 *nr,
0872                 u16 addr)
0873 {
0874     if (addr < mcp251xfd_get_tx_obj_addr(tx_ring, 0) ||
0875         addr >= mcp251xfd_get_tx_obj_addr(tx_ring, tx_ring->obj_num))
0876         return -ENOENT;
0877 
0878     *nr = (addr - mcp251xfd_get_tx_obj_addr(tx_ring, 0)) /
0879         tx_ring->obj_size;
0880 
0881     return 0;
0882 }
0883 
0884 static inline u8 mcp251xfd_get_rx_head(const struct mcp251xfd_rx_ring *ring)
0885 {
0886     return ring->head & (ring->obj_num - 1);
0887 }
0888 
0889 static inline u8 mcp251xfd_get_rx_tail(const struct mcp251xfd_rx_ring *ring)
0890 {
0891     return ring->tail & (ring->obj_num - 1);
0892 }
0893 
0894 static inline u8 mcp251xfd_get_rx_len(const struct mcp251xfd_rx_ring *ring)
0895 {
0896     return ring->head - ring->tail;
0897 }
0898 
0899 static inline u8
0900 mcp251xfd_get_rx_linear_len(const struct mcp251xfd_rx_ring *ring)
0901 {
0902     u8 len;
0903 
0904     len = mcp251xfd_get_rx_len(ring);
0905 
0906     return min_t(u8, len, ring->obj_num - mcp251xfd_get_rx_tail(ring));
0907 }
0908 
0909 #define mcp251xfd_for_each_tx_obj(ring, _obj, n) \
0910     for ((n) = 0, (_obj) = &(ring)->obj[(n)]; \
0911          (n) < (ring)->obj_num; \
0912          (n)++, (_obj) = &(ring)->obj[(n)])
0913 
0914 #define mcp251xfd_for_each_rx_ring(priv, ring, n) \
0915     for ((n) = 0, (ring) = *((priv)->rx + (n)); \
0916          (n) < (priv)->rx_ring_num; \
0917          (n)++, (ring) = *((priv)->rx + (n)))
0918 
0919 int mcp251xfd_chip_fifo_init(const struct mcp251xfd_priv *priv);
0920 u16 mcp251xfd_crc16_compute2(const void *cmd, size_t cmd_size,
0921                  const void *data, size_t data_size);
0922 u16 mcp251xfd_crc16_compute(const void *data, size_t data_size);
0923 void mcp251xfd_ethtool_init(struct mcp251xfd_priv *priv);
0924 int mcp251xfd_regmap_init(struct mcp251xfd_priv *priv);
0925 extern const struct can_ram_config mcp251xfd_ram_config;
0926 int mcp251xfd_ring_init(struct mcp251xfd_priv *priv);
0927 void mcp251xfd_ring_free(struct mcp251xfd_priv *priv);
0928 int mcp251xfd_ring_alloc(struct mcp251xfd_priv *priv);
0929 int mcp251xfd_handle_rxif(struct mcp251xfd_priv *priv);
0930 int mcp251xfd_handle_tefif(struct mcp251xfd_priv *priv);
0931 void mcp251xfd_skb_set_timestamp(const struct mcp251xfd_priv *priv,
0932                  struct sk_buff *skb, u32 timestamp);
0933 void mcp251xfd_timestamp_init(struct mcp251xfd_priv *priv);
0934 void mcp251xfd_timestamp_stop(struct mcp251xfd_priv *priv);
0935 
0936 netdev_tx_t mcp251xfd_start_xmit(struct sk_buff *skb,
0937                  struct net_device *ndev);
0938 
0939 #if IS_ENABLED(CONFIG_DEV_COREDUMP)
0940 void mcp251xfd_dump(const struct mcp251xfd_priv *priv);
0941 #else
0942 static inline void mcp251xfd_dump(const struct mcp251xfd_priv *priv)
0943 {
0944 }
0945 #endif
0946 
0947 #endif