GNU Linux-libre 4.14.290-gnu1
[releases.git] / drivers / net / can / m_can / m_can.c
1 /*
2  * CAN bus driver for Bosch M_CAN controller
3  *
4  * Copyright (C) 2014 Freescale Semiconductor, Inc.
5  *      Dong Aisheng <b29396@freescale.com>
6  *
7  * Bosch M_CAN user manual can be obtained from:
8  * http://www.bosch-semiconductors.de/media/pdf_1/ipmodules_1/m_can/
9  * mcan_users_manual_v302.pdf
10  *
11  * This file is licensed under the terms of the GNU General Public
12  * License version 2. This program is licensed "as is" without any
13  * warranty of any kind, whether express or implied.
14  */
15
16 #include <linux/clk.h>
17 #include <linux/delay.h>
18 #include <linux/interrupt.h>
19 #include <linux/io.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/netdevice.h>
23 #include <linux/of.h>
24 #include <linux/of_device.h>
25 #include <linux/platform_device.h>
26 #include <linux/iopoll.h>
27 #include <linux/can/dev.h>
28 #include <linux/pinctrl/consumer.h>
29
30 /* napi related */
31 #define M_CAN_NAPI_WEIGHT       64
32
33 /* message ram configuration data length */
34 #define MRAM_CFG_LEN    8
35
36 /* registers definition */
37 enum m_can_reg {
38         M_CAN_CREL      = 0x0,
39         M_CAN_ENDN      = 0x4,
40         M_CAN_CUST      = 0x8,
41         M_CAN_DBTP      = 0xc,
42         M_CAN_TEST      = 0x10,
43         M_CAN_RWD       = 0x14,
44         M_CAN_CCCR      = 0x18,
45         M_CAN_NBTP      = 0x1c,
46         M_CAN_TSCC      = 0x20,
47         M_CAN_TSCV      = 0x24,
48         M_CAN_TOCC      = 0x28,
49         M_CAN_TOCV      = 0x2c,
50         M_CAN_ECR       = 0x40,
51         M_CAN_PSR       = 0x44,
52 /* TDCR Register only available for version >=3.1.x */
53         M_CAN_TDCR      = 0x48,
54         M_CAN_IR        = 0x50,
55         M_CAN_IE        = 0x54,
56         M_CAN_ILS       = 0x58,
57         M_CAN_ILE       = 0x5c,
58         M_CAN_GFC       = 0x80,
59         M_CAN_SIDFC     = 0x84,
60         M_CAN_XIDFC     = 0x88,
61         M_CAN_XIDAM     = 0x90,
62         M_CAN_HPMS      = 0x94,
63         M_CAN_NDAT1     = 0x98,
64         M_CAN_NDAT2     = 0x9c,
65         M_CAN_RXF0C     = 0xa0,
66         M_CAN_RXF0S     = 0xa4,
67         M_CAN_RXF0A     = 0xa8,
68         M_CAN_RXBC      = 0xac,
69         M_CAN_RXF1C     = 0xb0,
70         M_CAN_RXF1S     = 0xb4,
71         M_CAN_RXF1A     = 0xb8,
72         M_CAN_RXESC     = 0xbc,
73         M_CAN_TXBC      = 0xc0,
74         M_CAN_TXFQS     = 0xc4,
75         M_CAN_TXESC     = 0xc8,
76         M_CAN_TXBRP     = 0xcc,
77         M_CAN_TXBAR     = 0xd0,
78         M_CAN_TXBCR     = 0xd4,
79         M_CAN_TXBTO     = 0xd8,
80         M_CAN_TXBCF     = 0xdc,
81         M_CAN_TXBTIE    = 0xe0,
82         M_CAN_TXBCIE    = 0xe4,
83         M_CAN_TXEFC     = 0xf0,
84         M_CAN_TXEFS     = 0xf4,
85         M_CAN_TXEFA     = 0xf8,
86 };
87
88 /* m_can lec values */
89 enum m_can_lec_type {
90         LEC_NO_ERROR = 0,
91         LEC_STUFF_ERROR,
92         LEC_FORM_ERROR,
93         LEC_ACK_ERROR,
94         LEC_BIT1_ERROR,
95         LEC_BIT0_ERROR,
96         LEC_CRC_ERROR,
97         LEC_UNUSED,
98 };
99
100 enum m_can_mram_cfg {
101         MRAM_SIDF = 0,
102         MRAM_XIDF,
103         MRAM_RXF0,
104         MRAM_RXF1,
105         MRAM_RXB,
106         MRAM_TXE,
107         MRAM_TXB,
108         MRAM_CFG_NUM,
109 };
110
111 /* Core Release Register (CREL) */
112 #define CREL_REL_SHIFT          28
113 #define CREL_REL_MASK           (0xF << CREL_REL_SHIFT)
114 #define CREL_STEP_SHIFT         24
115 #define CREL_STEP_MASK          (0xF << CREL_STEP_SHIFT)
116 #define CREL_SUBSTEP_SHIFT      20
117 #define CREL_SUBSTEP_MASK       (0xF << CREL_SUBSTEP_SHIFT)
118
119 /* Data Bit Timing & Prescaler Register (DBTP) */
120 #define DBTP_TDC                BIT(23)
121 #define DBTP_DBRP_SHIFT         16
122 #define DBTP_DBRP_MASK          (0x1f << DBTP_DBRP_SHIFT)
123 #define DBTP_DTSEG1_SHIFT       8
124 #define DBTP_DTSEG1_MASK        (0x1f << DBTP_DTSEG1_SHIFT)
125 #define DBTP_DTSEG2_SHIFT       4
126 #define DBTP_DTSEG2_MASK        (0xf << DBTP_DTSEG2_SHIFT)
127 #define DBTP_DSJW_SHIFT         0
128 #define DBTP_DSJW_MASK          (0xf << DBTP_DSJW_SHIFT)
129
130 /* Test Register (TEST) */
131 #define TEST_LBCK               BIT(4)
132
133 /* CC Control Register(CCCR) */
134 #define CCCR_CMR_MASK           0x3
135 #define CCCR_CMR_SHIFT          10
136 #define CCCR_CMR_CANFD          0x1
137 #define CCCR_CMR_CANFD_BRS      0x2
138 #define CCCR_CMR_CAN            0x3
139 #define CCCR_CME_MASK           0x3
140 #define CCCR_CME_SHIFT          8
141 #define CCCR_CME_CAN            0
142 #define CCCR_CME_CANFD          0x1
143 #define CCCR_CME_CANFD_BRS      0x2
144 #define CCCR_TXP                BIT(14)
145 #define CCCR_TEST               BIT(7)
146 #define CCCR_MON                BIT(5)
147 #define CCCR_CSR                BIT(4)
148 #define CCCR_CSA                BIT(3)
149 #define CCCR_ASM                BIT(2)
150 #define CCCR_CCE                BIT(1)
151 #define CCCR_INIT               BIT(0)
152 #define CCCR_CANFD              0x10
153 /* for version >=3.1.x */
154 #define CCCR_EFBI               BIT(13)
155 #define CCCR_PXHD               BIT(12)
156 #define CCCR_BRSE               BIT(9)
157 #define CCCR_FDOE               BIT(8)
158 /* only for version >=3.2.x */
159 #define CCCR_NISO               BIT(15)
160
161 /* Nominal Bit Timing & Prescaler Register (NBTP) */
162 #define NBTP_NSJW_SHIFT         25
163 #define NBTP_NSJW_MASK          (0x7f << NBTP_NSJW_SHIFT)
164 #define NBTP_NBRP_SHIFT         16
165 #define NBTP_NBRP_MASK          (0x1ff << NBTP_NBRP_SHIFT)
166 #define NBTP_NTSEG1_SHIFT       8
167 #define NBTP_NTSEG1_MASK        (0xff << NBTP_NTSEG1_SHIFT)
168 #define NBTP_NTSEG2_SHIFT       0
169 #define NBTP_NTSEG2_MASK        (0x7f << NBTP_NTSEG2_SHIFT)
170
171 /* Error Counter Register(ECR) */
172 #define ECR_RP                  BIT(15)
173 #define ECR_REC_SHIFT           8
174 #define ECR_REC_MASK            (0x7f << ECR_REC_SHIFT)
175 #define ECR_TEC_SHIFT           0
176 #define ECR_TEC_MASK            0xff
177
178 /* Protocol Status Register(PSR) */
179 #define PSR_BO          BIT(7)
180 #define PSR_EW          BIT(6)
181 #define PSR_EP          BIT(5)
182 #define PSR_LEC_MASK    0x7
183
184 /* Interrupt Register(IR) */
185 #define IR_ALL_INT      0xffffffff
186
187 /* Renamed bits for versions > 3.1.x */
188 #define IR_ARA          BIT(29)
189 #define IR_PED          BIT(28)
190 #define IR_PEA          BIT(27)
191
192 /* Bits for version 3.0.x */
193 #define IR_STE          BIT(31)
194 #define IR_FOE          BIT(30)
195 #define IR_ACKE         BIT(29)
196 #define IR_BE           BIT(28)
197 #define IR_CRCE         BIT(27)
198 #define IR_WDI          BIT(26)
199 #define IR_BO           BIT(25)
200 #define IR_EW           BIT(24)
201 #define IR_EP           BIT(23)
202 #define IR_ELO          BIT(22)
203 #define IR_BEU          BIT(21)
204 #define IR_BEC          BIT(20)
205 #define IR_DRX          BIT(19)
206 #define IR_TOO          BIT(18)
207 #define IR_MRAF         BIT(17)
208 #define IR_TSW          BIT(16)
209 #define IR_TEFL         BIT(15)
210 #define IR_TEFF         BIT(14)
211 #define IR_TEFW         BIT(13)
212 #define IR_TEFN         BIT(12)
213 #define IR_TFE          BIT(11)
214 #define IR_TCF          BIT(10)
215 #define IR_TC           BIT(9)
216 #define IR_HPM          BIT(8)
217 #define IR_RF1L         BIT(7)
218 #define IR_RF1F         BIT(6)
219 #define IR_RF1W         BIT(5)
220 #define IR_RF1N         BIT(4)
221 #define IR_RF0L         BIT(3)
222 #define IR_RF0F         BIT(2)
223 #define IR_RF0W         BIT(1)
224 #define IR_RF0N         BIT(0)
225 #define IR_ERR_STATE    (IR_BO | IR_EW | IR_EP)
226
227 /* Interrupts for version 3.0.x */
228 #define IR_ERR_LEC_30X  (IR_STE | IR_FOE | IR_ACKE | IR_BE | IR_CRCE)
229 #define IR_ERR_BUS_30X  (IR_ERR_LEC_30X | IR_WDI | IR_BEU | IR_BEC | \
230                          IR_TOO | IR_MRAF | IR_TSW | IR_TEFL | IR_RF1L | \
231                          IR_RF0L)
232 #define IR_ERR_ALL_30X  (IR_ERR_STATE | IR_ERR_BUS_30X)
233 /* Interrupts for version >= 3.1.x */
234 #define IR_ERR_LEC_31X  (IR_PED | IR_PEA)
235 #define IR_ERR_BUS_31X      (IR_ERR_LEC_31X | IR_WDI | IR_BEU | IR_BEC | \
236                          IR_TOO | IR_MRAF | IR_TSW | IR_TEFL | IR_RF1L | \
237                          IR_RF0L)
238 #define IR_ERR_ALL_31X  (IR_ERR_STATE | IR_ERR_BUS_31X)
239
240 /* Interrupt Line Select (ILS) */
241 #define ILS_ALL_INT0    0x0
242 #define ILS_ALL_INT1    0xFFFFFFFF
243
244 /* Interrupt Line Enable (ILE) */
245 #define ILE_EINT1       BIT(1)
246 #define ILE_EINT0       BIT(0)
247
248 /* Rx FIFO 0/1 Configuration (RXF0C/RXF1C) */
249 #define RXFC_FWM_SHIFT  24
250 #define RXFC_FWM_MASK   (0x7f << RXFC_FWM_SHIFT)
251 #define RXFC_FS_SHIFT   16
252 #define RXFC_FS_MASK    (0x7f << RXFC_FS_SHIFT)
253
254 /* Rx FIFO 0/1 Status (RXF0S/RXF1S) */
255 #define RXFS_RFL        BIT(25)
256 #define RXFS_FF         BIT(24)
257 #define RXFS_FPI_SHIFT  16
258 #define RXFS_FPI_MASK   0x3f0000
259 #define RXFS_FGI_SHIFT  8
260 #define RXFS_FGI_MASK   0x3f00
261 #define RXFS_FFL_MASK   0x7f
262
263 /* Rx Buffer / FIFO Element Size Configuration (RXESC) */
264 #define M_CAN_RXESC_8BYTES      0x0
265 #define M_CAN_RXESC_64BYTES     0x777
266
267 /* Tx Buffer Configuration(TXBC) */
268 #define TXBC_NDTB_SHIFT         16
269 #define TXBC_NDTB_MASK          (0x3f << TXBC_NDTB_SHIFT)
270 #define TXBC_TFQS_SHIFT         24
271 #define TXBC_TFQS_MASK          (0x3f << TXBC_TFQS_SHIFT)
272
273 /* Tx FIFO/Queue Status (TXFQS) */
274 #define TXFQS_TFQF              BIT(21)
275 #define TXFQS_TFQPI_SHIFT       16
276 #define TXFQS_TFQPI_MASK        (0x1f << TXFQS_TFQPI_SHIFT)
277 #define TXFQS_TFGI_SHIFT        8
278 #define TXFQS_TFGI_MASK         (0x1f << TXFQS_TFGI_SHIFT)
279 #define TXFQS_TFFL_SHIFT        0
280 #define TXFQS_TFFL_MASK         (0x3f << TXFQS_TFFL_SHIFT)
281
282 /* Tx Buffer Element Size Configuration(TXESC) */
283 #define TXESC_TBDS_8BYTES       0x0
284 #define TXESC_TBDS_64BYTES      0x7
285
286 /* Tx Event FIFO Configuration (TXEFC) */
287 #define TXEFC_EFS_SHIFT         16
288 #define TXEFC_EFS_MASK          (0x3f << TXEFC_EFS_SHIFT)
289
290 /* Tx Event FIFO Status (TXEFS) */
291 #define TXEFS_TEFL              BIT(25)
292 #define TXEFS_EFF               BIT(24)
293 #define TXEFS_EFGI_SHIFT        8
294 #define TXEFS_EFGI_MASK         (0x1f << TXEFS_EFGI_SHIFT)
295 #define TXEFS_EFFL_SHIFT        0
296 #define TXEFS_EFFL_MASK         (0x3f << TXEFS_EFFL_SHIFT)
297
298 /* Tx Event FIFO Acknowledge (TXEFA) */
299 #define TXEFA_EFAI_SHIFT        0
300 #define TXEFA_EFAI_MASK         (0x1f << TXEFA_EFAI_SHIFT)
301
302 /* Message RAM Configuration (in bytes) */
303 #define SIDF_ELEMENT_SIZE       4
304 #define XIDF_ELEMENT_SIZE       8
305 #define RXF0_ELEMENT_SIZE       72
306 #define RXF1_ELEMENT_SIZE       72
307 #define RXB_ELEMENT_SIZE        72
308 #define TXE_ELEMENT_SIZE        8
309 #define TXB_ELEMENT_SIZE        72
310
311 /* Message RAM Elements */
312 #define M_CAN_FIFO_ID           0x0
313 #define M_CAN_FIFO_DLC          0x4
314 #define M_CAN_FIFO_DATA(n)      (0x8 + ((n) << 2))
315
316 /* Rx Buffer Element */
317 /* R0 */
318 #define RX_BUF_ESI              BIT(31)
319 #define RX_BUF_XTD              BIT(30)
320 #define RX_BUF_RTR              BIT(29)
321 /* R1 */
322 #define RX_BUF_ANMF             BIT(31)
323 #define RX_BUF_FDF              BIT(21)
324 #define RX_BUF_BRS              BIT(20)
325
326 /* Tx Buffer Element */
327 /* T0 */
328 #define TX_BUF_ESI              BIT(31)
329 #define TX_BUF_XTD              BIT(30)
330 #define TX_BUF_RTR              BIT(29)
331 /* T1 */
332 #define TX_BUF_EFC              BIT(23)
333 #define TX_BUF_FDF              BIT(21)
334 #define TX_BUF_BRS              BIT(20)
335 #define TX_BUF_MM_SHIFT         24
336 #define TX_BUF_MM_MASK          (0xff << TX_BUF_MM_SHIFT)
337
338 /* Tx event FIFO Element */
339 /* E1 */
340 #define TX_EVENT_MM_SHIFT       TX_BUF_MM_SHIFT
341 #define TX_EVENT_MM_MASK        (0xff << TX_EVENT_MM_SHIFT)
342
343 /* address offset and element number for each FIFO/Buffer in the Message RAM */
344 struct mram_cfg {
345         u16 off;
346         u8  num;
347 };
348
349 /* m_can private data structure */
350 struct m_can_priv {
351         struct can_priv can;    /* must be the first member */
352         struct napi_struct napi;
353         struct net_device *dev;
354         struct device *device;
355         struct clk *hclk;
356         struct clk *cclk;
357         void __iomem *base;
358         u32 irqstatus;
359         int version;
360
361         /* message ram configuration */
362         void __iomem *mram_base;
363         struct mram_cfg mcfg[MRAM_CFG_NUM];
364 };
365
366 static inline u32 m_can_read(const struct m_can_priv *priv, enum m_can_reg reg)
367 {
368         return readl(priv->base + reg);
369 }
370
371 static inline void m_can_write(const struct m_can_priv *priv,
372                                enum m_can_reg reg, u32 val)
373 {
374         writel(val, priv->base + reg);
375 }
376
377 static inline u32 m_can_fifo_read(const struct m_can_priv *priv,
378                                   u32 fgi, unsigned int offset)
379 {
380         return readl(priv->mram_base + priv->mcfg[MRAM_RXF0].off +
381                      fgi * RXF0_ELEMENT_SIZE + offset);
382 }
383
384 static inline void m_can_fifo_write(const struct m_can_priv *priv,
385                                     u32 fpi, unsigned int offset, u32 val)
386 {
387         writel(val, priv->mram_base + priv->mcfg[MRAM_TXB].off +
388                fpi * TXB_ELEMENT_SIZE + offset);
389 }
390
391 static inline u32 m_can_txe_fifo_read(const struct m_can_priv *priv,
392                                       u32 fgi,
393                                       u32 offset) {
394         return readl(priv->mram_base + priv->mcfg[MRAM_TXE].off +
395                         fgi * TXE_ELEMENT_SIZE + offset);
396 }
397
398 static inline bool m_can_tx_fifo_full(const struct m_can_priv *priv)
399 {
400                 return !!(m_can_read(priv, M_CAN_TXFQS) & TXFQS_TFQF);
401 }
402
403 static inline void m_can_config_endisable(const struct m_can_priv *priv,
404                                           bool enable)
405 {
406         u32 cccr = m_can_read(priv, M_CAN_CCCR);
407         u32 timeout = 10;
408         u32 val = 0;
409
410         if (enable) {
411                 /* enable m_can configuration */
412                 m_can_write(priv, M_CAN_CCCR, cccr | CCCR_INIT);
413                 udelay(5);
414                 /* CCCR.CCE can only be set/reset while CCCR.INIT = '1' */
415                 m_can_write(priv, M_CAN_CCCR, cccr | CCCR_INIT | CCCR_CCE);
416         } else {
417                 m_can_write(priv, M_CAN_CCCR, cccr & ~(CCCR_INIT | CCCR_CCE));
418         }
419
420         /* there's a delay for module initialization */
421         if (enable)
422                 val = CCCR_INIT | CCCR_CCE;
423
424         while ((m_can_read(priv, M_CAN_CCCR) & (CCCR_INIT | CCCR_CCE)) != val) {
425                 if (timeout == 0) {
426                         netdev_warn(priv->dev, "Failed to init module\n");
427                         return;
428                 }
429                 timeout--;
430                 udelay(1);
431         }
432 }
433
434 static inline void m_can_enable_all_interrupts(const struct m_can_priv *priv)
435 {
436         /* Only interrupt line 0 is used in this driver */
437         m_can_write(priv, M_CAN_ILE, ILE_EINT0);
438 }
439
440 static inline void m_can_disable_all_interrupts(const struct m_can_priv *priv)
441 {
442         m_can_write(priv, M_CAN_ILE, 0x0);
443 }
444
445 static void m_can_read_fifo(struct net_device *dev, u32 rxfs)
446 {
447         struct net_device_stats *stats = &dev->stats;
448         struct m_can_priv *priv = netdev_priv(dev);
449         struct canfd_frame *cf;
450         struct sk_buff *skb;
451         u32 id, fgi, dlc;
452         int i;
453
454         /* calculate the fifo get index for where to read data */
455         fgi = (rxfs & RXFS_FGI_MASK) >> RXFS_FGI_SHIFT;
456         dlc = m_can_fifo_read(priv, fgi, M_CAN_FIFO_DLC);
457         if (dlc & RX_BUF_FDF)
458                 skb = alloc_canfd_skb(dev, &cf);
459         else
460                 skb = alloc_can_skb(dev, (struct can_frame **)&cf);
461         if (!skb) {
462                 stats->rx_dropped++;
463                 return;
464         }
465
466         if (dlc & RX_BUF_FDF)
467                 cf->len = can_dlc2len((dlc >> 16) & 0x0F);
468         else
469                 cf->len = get_can_dlc((dlc >> 16) & 0x0F);
470
471         id = m_can_fifo_read(priv, fgi, M_CAN_FIFO_ID);
472         if (id & RX_BUF_XTD)
473                 cf->can_id = (id & CAN_EFF_MASK) | CAN_EFF_FLAG;
474         else
475                 cf->can_id = (id >> 18) & CAN_SFF_MASK;
476
477         if (id & RX_BUF_ESI) {
478                 cf->flags |= CANFD_ESI;
479                 netdev_dbg(dev, "ESI Error\n");
480         }
481
482         if (!(dlc & RX_BUF_FDF) && (id & RX_BUF_RTR)) {
483                 cf->can_id |= CAN_RTR_FLAG;
484         } else {
485                 if (dlc & RX_BUF_BRS)
486                         cf->flags |= CANFD_BRS;
487
488                 for (i = 0; i < cf->len; i += 4)
489                         *(u32 *)(cf->data + i) =
490                                 m_can_fifo_read(priv, fgi,
491                                                 M_CAN_FIFO_DATA(i / 4));
492         }
493
494         /* acknowledge rx fifo 0 */
495         m_can_write(priv, M_CAN_RXF0A, fgi);
496
497         stats->rx_packets++;
498         stats->rx_bytes += cf->len;
499
500         netif_receive_skb(skb);
501 }
502
503 static int m_can_do_rx_poll(struct net_device *dev, int quota)
504 {
505         struct m_can_priv *priv = netdev_priv(dev);
506         u32 pkts = 0;
507         u32 rxfs;
508
509         rxfs = m_can_read(priv, M_CAN_RXF0S);
510         if (!(rxfs & RXFS_FFL_MASK)) {
511                 netdev_dbg(dev, "no messages in fifo0\n");
512                 return 0;
513         }
514
515         while ((rxfs & RXFS_FFL_MASK) && (quota > 0)) {
516                 m_can_read_fifo(dev, rxfs);
517
518                 quota--;
519                 pkts++;
520                 rxfs = m_can_read(priv, M_CAN_RXF0S);
521         }
522
523         if (pkts)
524                 can_led_event(dev, CAN_LED_EVENT_RX);
525
526         return pkts;
527 }
528
529 static int m_can_handle_lost_msg(struct net_device *dev)
530 {
531         struct net_device_stats *stats = &dev->stats;
532         struct sk_buff *skb;
533         struct can_frame *frame;
534
535         netdev_err(dev, "msg lost in rxf0\n");
536
537         stats->rx_errors++;
538         stats->rx_over_errors++;
539
540         skb = alloc_can_err_skb(dev, &frame);
541         if (unlikely(!skb))
542                 return 0;
543
544         frame->can_id |= CAN_ERR_CRTL;
545         frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
546
547         netif_receive_skb(skb);
548
549         return 1;
550 }
551
552 static int m_can_handle_lec_err(struct net_device *dev,
553                                 enum m_can_lec_type lec_type)
554 {
555         struct m_can_priv *priv = netdev_priv(dev);
556         struct net_device_stats *stats = &dev->stats;
557         struct can_frame *cf;
558         struct sk_buff *skb;
559
560         priv->can.can_stats.bus_error++;
561         stats->rx_errors++;
562
563         /* propagate the error condition to the CAN stack */
564         skb = alloc_can_err_skb(dev, &cf);
565         if (unlikely(!skb))
566                 return 0;
567
568         /* check for 'last error code' which tells us the
569          * type of the last error to occur on the CAN bus
570          */
571         cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
572
573         switch (lec_type) {
574         case LEC_STUFF_ERROR:
575                 netdev_dbg(dev, "stuff error\n");
576                 cf->data[2] |= CAN_ERR_PROT_STUFF;
577                 break;
578         case LEC_FORM_ERROR:
579                 netdev_dbg(dev, "form error\n");
580                 cf->data[2] |= CAN_ERR_PROT_FORM;
581                 break;
582         case LEC_ACK_ERROR:
583                 netdev_dbg(dev, "ack error\n");
584                 cf->data[3] = CAN_ERR_PROT_LOC_ACK;
585                 break;
586         case LEC_BIT1_ERROR:
587                 netdev_dbg(dev, "bit1 error\n");
588                 cf->data[2] |= CAN_ERR_PROT_BIT1;
589                 break;
590         case LEC_BIT0_ERROR:
591                 netdev_dbg(dev, "bit0 error\n");
592                 cf->data[2] |= CAN_ERR_PROT_BIT0;
593                 break;
594         case LEC_CRC_ERROR:
595                 netdev_dbg(dev, "CRC error\n");
596                 cf->data[3] = CAN_ERR_PROT_LOC_CRC_SEQ;
597                 break;
598         default:
599                 break;
600         }
601
602         stats->rx_packets++;
603         stats->rx_bytes += cf->can_dlc;
604         netif_receive_skb(skb);
605
606         return 1;
607 }
608
609 static int __m_can_get_berr_counter(const struct net_device *dev,
610                                     struct can_berr_counter *bec)
611 {
612         struct m_can_priv *priv = netdev_priv(dev);
613         unsigned int ecr;
614
615         ecr = m_can_read(priv, M_CAN_ECR);
616         bec->rxerr = (ecr & ECR_REC_MASK) >> ECR_REC_SHIFT;
617         bec->txerr = (ecr & ECR_TEC_MASK) >> ECR_TEC_SHIFT;
618
619         return 0;
620 }
621
622 static int m_can_clk_start(struct m_can_priv *priv)
623 {
624         int err;
625
626         err = clk_prepare_enable(priv->hclk);
627         if (err)
628                 return err;
629
630         err = clk_prepare_enable(priv->cclk);
631         if (err)
632                 clk_disable_unprepare(priv->hclk);
633
634         return err;
635 }
636
637 static void m_can_clk_stop(struct m_can_priv *priv)
638 {
639         clk_disable_unprepare(priv->cclk);
640         clk_disable_unprepare(priv->hclk);
641 }
642
643 static int m_can_get_berr_counter(const struct net_device *dev,
644                                   struct can_berr_counter *bec)
645 {
646         struct m_can_priv *priv = netdev_priv(dev);
647         int err;
648
649         err = m_can_clk_start(priv);
650         if (err)
651                 return err;
652
653         __m_can_get_berr_counter(dev, bec);
654
655         m_can_clk_stop(priv);
656
657         return 0;
658 }
659
660 static int m_can_handle_state_change(struct net_device *dev,
661                                      enum can_state new_state)
662 {
663         struct m_can_priv *priv = netdev_priv(dev);
664         struct net_device_stats *stats = &dev->stats;
665         struct can_frame *cf;
666         struct sk_buff *skb;
667         struct can_berr_counter bec;
668         unsigned int ecr;
669
670         switch (new_state) {
671         case CAN_STATE_ERROR_WARNING:
672                 /* error warning state */
673                 priv->can.can_stats.error_warning++;
674                 priv->can.state = CAN_STATE_ERROR_WARNING;
675                 break;
676         case CAN_STATE_ERROR_PASSIVE:
677                 /* error passive state */
678                 priv->can.can_stats.error_passive++;
679                 priv->can.state = CAN_STATE_ERROR_PASSIVE;
680                 break;
681         case CAN_STATE_BUS_OFF:
682                 /* bus-off state */
683                 priv->can.state = CAN_STATE_BUS_OFF;
684                 m_can_disable_all_interrupts(priv);
685                 priv->can.can_stats.bus_off++;
686                 can_bus_off(dev);
687                 break;
688         default:
689                 break;
690         }
691
692         /* propagate the error condition to the CAN stack */
693         skb = alloc_can_err_skb(dev, &cf);
694         if (unlikely(!skb))
695                 return 0;
696
697         __m_can_get_berr_counter(dev, &bec);
698
699         switch (new_state) {
700         case CAN_STATE_ERROR_WARNING:
701                 /* error warning state */
702                 cf->can_id |= CAN_ERR_CRTL;
703                 cf->data[1] = (bec.txerr > bec.rxerr) ?
704                         CAN_ERR_CRTL_TX_WARNING :
705                         CAN_ERR_CRTL_RX_WARNING;
706                 cf->data[6] = bec.txerr;
707                 cf->data[7] = bec.rxerr;
708                 break;
709         case CAN_STATE_ERROR_PASSIVE:
710                 /* error passive state */
711                 cf->can_id |= CAN_ERR_CRTL;
712                 ecr = m_can_read(priv, M_CAN_ECR);
713                 if (ecr & ECR_RP)
714                         cf->data[1] |= CAN_ERR_CRTL_RX_PASSIVE;
715                 if (bec.txerr > 127)
716                         cf->data[1] |= CAN_ERR_CRTL_TX_PASSIVE;
717                 cf->data[6] = bec.txerr;
718                 cf->data[7] = bec.rxerr;
719                 break;
720         case CAN_STATE_BUS_OFF:
721                 /* bus-off state */
722                 cf->can_id |= CAN_ERR_BUSOFF;
723                 break;
724         default:
725                 break;
726         }
727
728         stats->rx_packets++;
729         stats->rx_bytes += cf->can_dlc;
730         netif_receive_skb(skb);
731
732         return 1;
733 }
734
735 static int m_can_handle_state_errors(struct net_device *dev, u32 psr)
736 {
737         struct m_can_priv *priv = netdev_priv(dev);
738         int work_done = 0;
739
740         if ((psr & PSR_EW) &&
741             (priv->can.state != CAN_STATE_ERROR_WARNING)) {
742                 netdev_dbg(dev, "entered error warning state\n");
743                 work_done += m_can_handle_state_change(dev,
744                                                        CAN_STATE_ERROR_WARNING);
745         }
746
747         if ((psr & PSR_EP) &&
748             (priv->can.state != CAN_STATE_ERROR_PASSIVE)) {
749                 netdev_dbg(dev, "entered error passive state\n");
750                 work_done += m_can_handle_state_change(dev,
751                                                        CAN_STATE_ERROR_PASSIVE);
752         }
753
754         if ((psr & PSR_BO) &&
755             (priv->can.state != CAN_STATE_BUS_OFF)) {
756                 netdev_dbg(dev, "entered error bus off state\n");
757                 work_done += m_can_handle_state_change(dev,
758                                                        CAN_STATE_BUS_OFF);
759         }
760
761         return work_done;
762 }
763
764 static void m_can_handle_other_err(struct net_device *dev, u32 irqstatus)
765 {
766         if (irqstatus & IR_WDI)
767                 netdev_err(dev, "Message RAM Watchdog event due to missing READY\n");
768         if (irqstatus & IR_BEU)
769                 netdev_err(dev, "Bit Error Uncorrected\n");
770         if (irqstatus & IR_BEC)
771                 netdev_err(dev, "Bit Error Corrected\n");
772         if (irqstatus & IR_TOO)
773                 netdev_err(dev, "Timeout reached\n");
774         if (irqstatus & IR_MRAF)
775                 netdev_err(dev, "Message RAM access failure occurred\n");
776 }
777
778 static inline bool is_lec_err(u32 psr)
779 {
780         psr &= LEC_UNUSED;
781
782         return psr && (psr != LEC_UNUSED);
783 }
784
785 static int m_can_handle_bus_errors(struct net_device *dev, u32 irqstatus,
786                                    u32 psr)
787 {
788         struct m_can_priv *priv = netdev_priv(dev);
789         int work_done = 0;
790
791         if (irqstatus & IR_RF0L)
792                 work_done += m_can_handle_lost_msg(dev);
793
794         /* handle lec errors on the bus */
795         if ((priv->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING) &&
796             is_lec_err(psr))
797                 work_done += m_can_handle_lec_err(dev, psr & LEC_UNUSED);
798
799         /* other unproccessed error interrupts */
800         m_can_handle_other_err(dev, irqstatus);
801
802         return work_done;
803 }
804
805 static int m_can_poll(struct napi_struct *napi, int quota)
806 {
807         struct net_device *dev = napi->dev;
808         struct m_can_priv *priv = netdev_priv(dev);
809         int work_done = 0;
810         u32 irqstatus, psr;
811
812         irqstatus = priv->irqstatus | m_can_read(priv, M_CAN_IR);
813         if (!irqstatus)
814                 goto end;
815
816         /* Errata workaround for issue "Needless activation of MRAF irq"
817          * During frame reception while the MCAN is in Error Passive state
818          * and the Receive Error Counter has the value MCAN_ECR.REC = 127,
819          * it may happen that MCAN_IR.MRAF is set although there was no
820          * Message RAM access failure.
821          * If MCAN_IR.MRAF is enabled, an interrupt to the Host CPU is generated
822          * The Message RAM Access Failure interrupt routine needs to check
823          * whether MCAN_ECR.RP = â€™1’ and MCAN_ECR.REC = 127.
824          * In this case, reset MCAN_IR.MRAF. No further action is required.
825          */
826         if ((priv->version <= 31) && (irqstatus & IR_MRAF) &&
827             (m_can_read(priv, M_CAN_ECR) & ECR_RP)) {
828                 struct can_berr_counter bec;
829
830                 __m_can_get_berr_counter(dev, &bec);
831                 if (bec.rxerr == 127) {
832                         m_can_write(priv, M_CAN_IR, IR_MRAF);
833                         irqstatus &= ~IR_MRAF;
834                 }
835         }
836
837         psr = m_can_read(priv, M_CAN_PSR);
838         if (irqstatus & IR_ERR_STATE)
839                 work_done += m_can_handle_state_errors(dev, psr);
840
841         if (irqstatus & IR_ERR_BUS_30X)
842                 work_done += m_can_handle_bus_errors(dev, irqstatus, psr);
843
844         if (irqstatus & IR_RF0N)
845                 work_done += m_can_do_rx_poll(dev, (quota - work_done));
846
847         if (work_done < quota) {
848                 napi_complete_done(napi, work_done);
849                 m_can_enable_all_interrupts(priv);
850         }
851
852 end:
853         return work_done;
854 }
855
856 static void m_can_echo_tx_event(struct net_device *dev)
857 {
858         u32 txe_count = 0;
859         u32 m_can_txefs;
860         u32 fgi = 0;
861         int i = 0;
862         unsigned int msg_mark;
863
864         struct m_can_priv *priv = netdev_priv(dev);
865         struct net_device_stats *stats = &dev->stats;
866
867         /* read tx event fifo status */
868         m_can_txefs = m_can_read(priv, M_CAN_TXEFS);
869
870         /* Get Tx Event fifo element count */
871         txe_count = (m_can_txefs & TXEFS_EFFL_MASK)
872                         >> TXEFS_EFFL_SHIFT;
873
874         /* Get and process all sent elements */
875         for (i = 0; i < txe_count; i++) {
876                 /* retrieve get index */
877                 fgi = (m_can_read(priv, M_CAN_TXEFS) & TXEFS_EFGI_MASK)
878                         >> TXEFS_EFGI_SHIFT;
879
880                 /* get message marker */
881                 msg_mark = (m_can_txe_fifo_read(priv, fgi, 4) &
882                             TX_EVENT_MM_MASK) >> TX_EVENT_MM_SHIFT;
883
884                 /* ack txe element */
885                 m_can_write(priv, M_CAN_TXEFA, (TXEFA_EFAI_MASK &
886                                                 (fgi << TXEFA_EFAI_SHIFT)));
887
888                 /* update stats */
889                 stats->tx_bytes += can_get_echo_skb(dev, msg_mark);
890                 stats->tx_packets++;
891         }
892 }
893
894 static irqreturn_t m_can_isr(int irq, void *dev_id)
895 {
896         struct net_device *dev = (struct net_device *)dev_id;
897         struct m_can_priv *priv = netdev_priv(dev);
898         struct net_device_stats *stats = &dev->stats;
899         u32 ir;
900
901         ir = m_can_read(priv, M_CAN_IR);
902         if (!ir)
903                 return IRQ_NONE;
904
905         /* ACK all irqs */
906         if (ir & IR_ALL_INT)
907                 m_can_write(priv, M_CAN_IR, ir);
908
909         /* schedule NAPI in case of
910          * - rx IRQ
911          * - state change IRQ
912          * - bus error IRQ and bus error reporting
913          */
914         if ((ir & IR_RF0N) || (ir & IR_ERR_ALL_30X)) {
915                 priv->irqstatus = ir;
916                 m_can_disable_all_interrupts(priv);
917                 napi_schedule(&priv->napi);
918         }
919
920         if (priv->version == 30) {
921                 if (ir & IR_TC) {
922                         /* Transmission Complete Interrupt*/
923                         stats->tx_bytes += can_get_echo_skb(dev, 0);
924                         stats->tx_packets++;
925                         can_led_event(dev, CAN_LED_EVENT_TX);
926                         netif_wake_queue(dev);
927                 }
928         } else  {
929                 if (ir & IR_TEFN) {
930                         /* New TX FIFO Element arrived */
931                         m_can_echo_tx_event(dev);
932                         can_led_event(dev, CAN_LED_EVENT_TX);
933                         if (netif_queue_stopped(dev) &&
934                             !m_can_tx_fifo_full(priv))
935                                 netif_wake_queue(dev);
936                 }
937         }
938
939         return IRQ_HANDLED;
940 }
941
942 static const struct can_bittiming_const m_can_bittiming_const_30X = {
943         .name = KBUILD_MODNAME,
944         .tseg1_min = 2,         /* Time segment 1 = prop_seg + phase_seg1 */
945         .tseg1_max = 64,
946         .tseg2_min = 1,         /* Time segment 2 = phase_seg2 */
947         .tseg2_max = 16,
948         .sjw_max = 16,
949         .brp_min = 1,
950         .brp_max = 1024,
951         .brp_inc = 1,
952 };
953
954 static const struct can_bittiming_const m_can_data_bittiming_const_30X = {
955         .name = KBUILD_MODNAME,
956         .tseg1_min = 2,         /* Time segment 1 = prop_seg + phase_seg1 */
957         .tseg1_max = 16,
958         .tseg2_min = 1,         /* Time segment 2 = phase_seg2 */
959         .tseg2_max = 8,
960         .sjw_max = 4,
961         .brp_min = 1,
962         .brp_max = 32,
963         .brp_inc = 1,
964 };
965
966 static const struct can_bittiming_const m_can_bittiming_const_31X = {
967         .name = KBUILD_MODNAME,
968         .tseg1_min = 2,         /* Time segment 1 = prop_seg + phase_seg1 */
969         .tseg1_max = 256,
970         .tseg2_min = 2,         /* Time segment 2 = phase_seg2 */
971         .tseg2_max = 128,
972         .sjw_max = 128,
973         .brp_min = 1,
974         .brp_max = 512,
975         .brp_inc = 1,
976 };
977
978 static const struct can_bittiming_const m_can_data_bittiming_const_31X = {
979         .name = KBUILD_MODNAME,
980         .tseg1_min = 1,         /* Time segment 1 = prop_seg + phase_seg1 */
981         .tseg1_max = 32,
982         .tseg2_min = 1,         /* Time segment 2 = phase_seg2 */
983         .tseg2_max = 16,
984         .sjw_max = 16,
985         .brp_min = 1,
986         .brp_max = 32,
987         .brp_inc = 1,
988 };
989
990 static int m_can_set_bittiming(struct net_device *dev)
991 {
992         struct m_can_priv *priv = netdev_priv(dev);
993         const struct can_bittiming *bt = &priv->can.bittiming;
994         const struct can_bittiming *dbt = &priv->can.data_bittiming;
995         u16 brp, sjw, tseg1, tseg2;
996         u32 reg_btp;
997
998         brp = bt->brp - 1;
999         sjw = bt->sjw - 1;
1000         tseg1 = bt->prop_seg + bt->phase_seg1 - 1;
1001         tseg2 = bt->phase_seg2 - 1;
1002         reg_btp = (brp << NBTP_NBRP_SHIFT) | (sjw << NBTP_NSJW_SHIFT) |
1003                 (tseg1 << NBTP_NTSEG1_SHIFT) | (tseg2 << NBTP_NTSEG2_SHIFT);
1004         m_can_write(priv, M_CAN_NBTP, reg_btp);
1005
1006         if (priv->can.ctrlmode & CAN_CTRLMODE_FD) {
1007                 brp = dbt->brp - 1;
1008                 sjw = dbt->sjw - 1;
1009                 tseg1 = dbt->prop_seg + dbt->phase_seg1 - 1;
1010                 tseg2 = dbt->phase_seg2 - 1;
1011                 reg_btp = (brp << DBTP_DBRP_SHIFT) | (sjw << DBTP_DSJW_SHIFT) |
1012                         (tseg1 << DBTP_DTSEG1_SHIFT) |
1013                         (tseg2 << DBTP_DTSEG2_SHIFT);
1014                 m_can_write(priv, M_CAN_DBTP, reg_btp);
1015         }
1016
1017         return 0;
1018 }
1019
1020 /* Configure M_CAN chip:
1021  * - set rx buffer/fifo element size
1022  * - configure rx fifo
1023  * - accept non-matching frame into fifo 0
1024  * - configure tx buffer
1025  *              - >= v3.1.x: TX FIFO is used
1026  * - configure mode
1027  * - setup bittiming
1028  */
1029 static void m_can_chip_config(struct net_device *dev)
1030 {
1031         struct m_can_priv *priv = netdev_priv(dev);
1032         u32 cccr, test;
1033
1034         m_can_config_endisable(priv, true);
1035
1036         /* RX Buffer/FIFO Element Size 64 bytes data field */
1037         m_can_write(priv, M_CAN_RXESC, M_CAN_RXESC_64BYTES);
1038
1039         /* Accept Non-matching Frames Into FIFO 0 */
1040         m_can_write(priv, M_CAN_GFC, 0x0);
1041
1042         if (priv->version == 30) {
1043                 /* only support one Tx Buffer currently */
1044                 m_can_write(priv, M_CAN_TXBC, (1 << TXBC_NDTB_SHIFT) |
1045                                 priv->mcfg[MRAM_TXB].off);
1046         } else {
1047                 /* TX FIFO is used for newer IP Core versions */
1048                 m_can_write(priv, M_CAN_TXBC,
1049                             (priv->mcfg[MRAM_TXB].num << TXBC_TFQS_SHIFT) |
1050                             (priv->mcfg[MRAM_TXB].off));
1051         }
1052
1053         /* support 64 bytes payload */
1054         m_can_write(priv, M_CAN_TXESC, TXESC_TBDS_64BYTES);
1055
1056         /* TX Event FIFO */
1057         if (priv->version == 30) {
1058                 m_can_write(priv, M_CAN_TXEFC, (1 << TXEFC_EFS_SHIFT) |
1059                                 priv->mcfg[MRAM_TXE].off);
1060         } else {
1061                 /* Full TX Event FIFO is used */
1062                 m_can_write(priv, M_CAN_TXEFC,
1063                             ((priv->mcfg[MRAM_TXE].num << TXEFC_EFS_SHIFT)
1064                              & TXEFC_EFS_MASK) |
1065                             priv->mcfg[MRAM_TXE].off);
1066         }
1067
1068         /* rx fifo configuration, blocking mode, fifo size 1 */
1069         m_can_write(priv, M_CAN_RXF0C,
1070                     (priv->mcfg[MRAM_RXF0].num << RXFC_FS_SHIFT) |
1071                      priv->mcfg[MRAM_RXF0].off);
1072
1073         m_can_write(priv, M_CAN_RXF1C,
1074                     (priv->mcfg[MRAM_RXF1].num << RXFC_FS_SHIFT) |
1075                      priv->mcfg[MRAM_RXF1].off);
1076
1077         cccr = m_can_read(priv, M_CAN_CCCR);
1078         test = m_can_read(priv, M_CAN_TEST);
1079         test &= ~TEST_LBCK;
1080         if (priv->version == 30) {
1081         /* Version 3.0.x */
1082
1083                 cccr &= ~(CCCR_TEST | CCCR_MON |
1084                         (CCCR_CMR_MASK << CCCR_CMR_SHIFT) |
1085                         (CCCR_CME_MASK << CCCR_CME_SHIFT));
1086
1087                 if (priv->can.ctrlmode & CAN_CTRLMODE_FD)
1088                         cccr |= CCCR_CME_CANFD_BRS << CCCR_CME_SHIFT;
1089
1090         } else {
1091         /* Version 3.1.x or 3.2.x */
1092                 cccr &= ~(CCCR_TEST | CCCR_MON | CCCR_BRSE | CCCR_FDOE |
1093                           CCCR_NISO);
1094
1095                 /* Only 3.2.x has NISO Bit implemented */
1096                 if (priv->can.ctrlmode & CAN_CTRLMODE_FD_NON_ISO)
1097                         cccr |= CCCR_NISO;
1098
1099                 if (priv->can.ctrlmode & CAN_CTRLMODE_FD)
1100                         cccr |= (CCCR_BRSE | CCCR_FDOE);
1101         }
1102
1103         /* Loopback Mode */
1104         if (priv->can.ctrlmode & CAN_CTRLMODE_LOOPBACK) {
1105                 cccr |= CCCR_TEST | CCCR_MON;
1106                 test |= TEST_LBCK;
1107         }
1108
1109         /* Enable Monitoring (all versions) */
1110         if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
1111                 cccr |= CCCR_MON;
1112
1113         /* Write config */
1114         m_can_write(priv, M_CAN_CCCR, cccr);
1115         m_can_write(priv, M_CAN_TEST, test);
1116
1117         /* Enable interrupts */
1118         m_can_write(priv, M_CAN_IR, IR_ALL_INT);
1119         if (!(priv->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING))
1120                 if (priv->version == 30)
1121                         m_can_write(priv, M_CAN_IE, IR_ALL_INT &
1122                                     ~(IR_ERR_LEC_30X));
1123                 else
1124                         m_can_write(priv, M_CAN_IE, IR_ALL_INT &
1125                                     ~(IR_ERR_LEC_31X));
1126         else
1127                 m_can_write(priv, M_CAN_IE, IR_ALL_INT);
1128
1129         /* route all interrupts to INT0 */
1130         m_can_write(priv, M_CAN_ILS, ILS_ALL_INT0);
1131
1132         /* set bittiming params */
1133         m_can_set_bittiming(dev);
1134
1135         m_can_config_endisable(priv, false);
1136 }
1137
1138 static void m_can_start(struct net_device *dev)
1139 {
1140         struct m_can_priv *priv = netdev_priv(dev);
1141
1142         /* basic m_can configuration */
1143         m_can_chip_config(dev);
1144
1145         priv->can.state = CAN_STATE_ERROR_ACTIVE;
1146
1147         m_can_enable_all_interrupts(priv);
1148 }
1149
1150 static int m_can_set_mode(struct net_device *dev, enum can_mode mode)
1151 {
1152         switch (mode) {
1153         case CAN_MODE_START:
1154                 m_can_start(dev);
1155                 netif_wake_queue(dev);
1156                 break;
1157         default:
1158                 return -EOPNOTSUPP;
1159         }
1160
1161         return 0;
1162 }
1163
1164 static void free_m_can_dev(struct net_device *dev)
1165 {
1166         free_candev(dev);
1167 }
1168
1169 /* Checks core release number of M_CAN
1170  * returns 0 if an unsupported device is detected
1171  * else it returns the release and step coded as:
1172  * return value = 10 * <release> + 1 * <step>
1173  */
1174 static int m_can_check_core_release(void __iomem *m_can_base)
1175 {
1176         u32 crel_reg;
1177         u8 rel;
1178         u8 step;
1179         int res;
1180         struct m_can_priv temp_priv = {
1181                 .base = m_can_base
1182         };
1183
1184         /* Read Core Release Version and split into version number
1185          * Example: Version 3.2.1 => rel = 3; step = 2; substep = 1;
1186          */
1187         crel_reg = m_can_read(&temp_priv, M_CAN_CREL);
1188         rel = (u8)((crel_reg & CREL_REL_MASK) >> CREL_REL_SHIFT);
1189         step = (u8)((crel_reg & CREL_STEP_MASK) >> CREL_STEP_SHIFT);
1190
1191         if (rel == 3) {
1192                 /* M_CAN v3.x.y: create return value */
1193                 res = 30 + step;
1194         } else {
1195                 /* Unsupported M_CAN version */
1196                 res = 0;
1197         }
1198
1199         return res;
1200 }
1201
1202 /* Selectable Non ISO support only in version 3.2.x
1203  * This function checks if the bit is writable.
1204  */
1205 static bool m_can_niso_supported(const struct m_can_priv *priv)
1206 {
1207         u32 cccr_reg, cccr_poll;
1208         int niso_timeout;
1209
1210         m_can_config_endisable(priv, true);
1211         cccr_reg = m_can_read(priv, M_CAN_CCCR);
1212         cccr_reg |= CCCR_NISO;
1213         m_can_write(priv, M_CAN_CCCR, cccr_reg);
1214
1215         niso_timeout = readl_poll_timeout((priv->base + M_CAN_CCCR), cccr_poll,
1216                                           (cccr_poll == cccr_reg), 0, 10);
1217
1218         /* Clear NISO */
1219         cccr_reg &= ~(CCCR_NISO);
1220         m_can_write(priv, M_CAN_CCCR, cccr_reg);
1221
1222         m_can_config_endisable(priv, false);
1223
1224         /* return false if time out (-ETIMEDOUT), else return true */
1225         return !niso_timeout;
1226 }
1227
1228 static struct net_device *alloc_m_can_dev(struct platform_device *pdev,
1229                                           void __iomem *addr, u32 tx_fifo_size)
1230 {
1231         struct net_device *dev;
1232         struct m_can_priv *priv;
1233         int m_can_version;
1234         unsigned int echo_buffer_count;
1235
1236         m_can_version = m_can_check_core_release(addr);
1237         /* return if unsupported version */
1238         if (!m_can_version) {
1239                 dev = NULL;
1240                 goto return_dev;
1241         }
1242
1243         /* If version < 3.1.x, then only one echo buffer is used */
1244         echo_buffer_count = ((m_can_version == 30)
1245                                 ? 1U
1246                                 : (unsigned int)tx_fifo_size);
1247
1248         dev = alloc_candev(sizeof(*priv), echo_buffer_count);
1249         if (!dev) {
1250                 dev = NULL;
1251                 goto return_dev;
1252         }
1253         priv = netdev_priv(dev);
1254         netif_napi_add(dev, &priv->napi, m_can_poll, M_CAN_NAPI_WEIGHT);
1255
1256         /* Shared properties of all M_CAN versions */
1257         priv->version = m_can_version;
1258         priv->dev = dev;
1259         priv->base = addr;
1260         priv->can.do_set_mode = m_can_set_mode;
1261         priv->can.do_get_berr_counter = m_can_get_berr_counter;
1262
1263         /* Set M_CAN supported operations */
1264         priv->can.ctrlmode_supported = CAN_CTRLMODE_LOOPBACK |
1265                                         CAN_CTRLMODE_LISTENONLY |
1266                                         CAN_CTRLMODE_BERR_REPORTING |
1267                                         CAN_CTRLMODE_FD;
1268
1269         /* Set properties depending on M_CAN version */
1270         switch (priv->version) {
1271         case 30:
1272                 /* CAN_CTRLMODE_FD_NON_ISO is fixed with M_CAN IP v3.0.x */
1273                 can_set_static_ctrlmode(dev, CAN_CTRLMODE_FD_NON_ISO);
1274                 priv->can.bittiming_const = &m_can_bittiming_const_30X;
1275                 priv->can.data_bittiming_const =
1276                                 &m_can_data_bittiming_const_30X;
1277                 break;
1278         case 31:
1279                 /* CAN_CTRLMODE_FD_NON_ISO is fixed with M_CAN IP v3.1.x */
1280                 can_set_static_ctrlmode(dev, CAN_CTRLMODE_FD_NON_ISO);
1281                 priv->can.bittiming_const = &m_can_bittiming_const_31X;
1282                 priv->can.data_bittiming_const =
1283                                 &m_can_data_bittiming_const_31X;
1284                 break;
1285         case 32:
1286                 priv->can.bittiming_const = &m_can_bittiming_const_31X;
1287                 priv->can.data_bittiming_const =
1288                                 &m_can_data_bittiming_const_31X;
1289                 priv->can.ctrlmode_supported |= (m_can_niso_supported(priv)
1290                                                 ? CAN_CTRLMODE_FD_NON_ISO
1291                                                 : 0);
1292                 break;
1293         default:
1294                 /* Unsupported device: free candev */
1295                 free_m_can_dev(dev);
1296                 dev_err(&pdev->dev, "Unsupported version number: %2d",
1297                         priv->version);
1298                 dev = NULL;
1299                 break;
1300         }
1301
1302 return_dev:
1303         return dev;
1304 }
1305
1306 static int m_can_open(struct net_device *dev)
1307 {
1308         struct m_can_priv *priv = netdev_priv(dev);
1309         int err;
1310
1311         err = m_can_clk_start(priv);
1312         if (err)
1313                 return err;
1314
1315         /* open the can device */
1316         err = open_candev(dev);
1317         if (err) {
1318                 netdev_err(dev, "failed to open can device\n");
1319                 goto exit_disable_clks;
1320         }
1321
1322         /* register interrupt handler */
1323         err = request_irq(dev->irq, m_can_isr, IRQF_SHARED, dev->name,
1324                           dev);
1325         if (err < 0) {
1326                 netdev_err(dev, "failed to request interrupt\n");
1327                 goto exit_irq_fail;
1328         }
1329
1330         /* start the m_can controller */
1331         m_can_start(dev);
1332
1333         can_led_event(dev, CAN_LED_EVENT_OPEN);
1334         napi_enable(&priv->napi);
1335         netif_start_queue(dev);
1336
1337         return 0;
1338
1339 exit_irq_fail:
1340         close_candev(dev);
1341 exit_disable_clks:
1342         m_can_clk_stop(priv);
1343         return err;
1344 }
1345
1346 static void m_can_stop(struct net_device *dev)
1347 {
1348         struct m_can_priv *priv = netdev_priv(dev);
1349
1350         /* disable all interrupts */
1351         m_can_disable_all_interrupts(priv);
1352
1353         /* set the state as STOPPED */
1354         priv->can.state = CAN_STATE_STOPPED;
1355 }
1356
1357 static int m_can_close(struct net_device *dev)
1358 {
1359         struct m_can_priv *priv = netdev_priv(dev);
1360
1361         netif_stop_queue(dev);
1362         napi_disable(&priv->napi);
1363         m_can_stop(dev);
1364         m_can_clk_stop(priv);
1365         free_irq(dev->irq, dev);
1366         close_candev(dev);
1367         can_led_event(dev, CAN_LED_EVENT_STOP);
1368
1369         return 0;
1370 }
1371
1372 static int m_can_next_echo_skb_occupied(struct net_device *dev, int putidx)
1373 {
1374         struct m_can_priv *priv = netdev_priv(dev);
1375         /*get wrap around for loopback skb index */
1376         unsigned int wrap = priv->can.echo_skb_max;
1377         int next_idx;
1378
1379         /* calculate next index */
1380         next_idx = (++putidx >= wrap ? 0 : putidx);
1381
1382         /* check if occupied */
1383         return !!priv->can.echo_skb[next_idx];
1384 }
1385
1386 static netdev_tx_t m_can_start_xmit(struct sk_buff *skb,
1387                                     struct net_device *dev)
1388 {
1389         struct m_can_priv *priv = netdev_priv(dev);
1390         struct canfd_frame *cf = (struct canfd_frame *)skb->data;
1391         u32 id, cccr, fdflags;
1392         int i;
1393         int putidx;
1394
1395         if (can_dropped_invalid_skb(dev, skb))
1396                 return NETDEV_TX_OK;
1397
1398         /* Generate ID field for TX buffer Element */
1399         /* Common to all supported M_CAN versions */
1400         if (cf->can_id & CAN_EFF_FLAG) {
1401                 id = cf->can_id & CAN_EFF_MASK;
1402                 id |= TX_BUF_XTD;
1403         } else {
1404                 id = ((cf->can_id & CAN_SFF_MASK) << 18);
1405         }
1406
1407         if (cf->can_id & CAN_RTR_FLAG)
1408                 id |= TX_BUF_RTR;
1409
1410         if (priv->version == 30) {
1411                 netif_stop_queue(dev);
1412
1413                 /* message ram configuration */
1414                 m_can_fifo_write(priv, 0, M_CAN_FIFO_ID, id);
1415                 m_can_fifo_write(priv, 0, M_CAN_FIFO_DLC,
1416                                  can_len2dlc(cf->len) << 16);
1417
1418                 for (i = 0; i < cf->len; i += 4)
1419                         m_can_fifo_write(priv, 0,
1420                                          M_CAN_FIFO_DATA(i / 4),
1421                                          *(u32 *)(cf->data + i));
1422
1423                 if (priv->can.ctrlmode & CAN_CTRLMODE_FD) {
1424                         cccr = m_can_read(priv, M_CAN_CCCR);
1425                         cccr &= ~(CCCR_CMR_MASK << CCCR_CMR_SHIFT);
1426                         if (can_is_canfd_skb(skb)) {
1427                                 if (cf->flags & CANFD_BRS)
1428                                         cccr |= CCCR_CMR_CANFD_BRS <<
1429                                                 CCCR_CMR_SHIFT;
1430                                 else
1431                                         cccr |= CCCR_CMR_CANFD <<
1432                                                 CCCR_CMR_SHIFT;
1433                         } else {
1434                                 cccr |= CCCR_CMR_CAN << CCCR_CMR_SHIFT;
1435                         }
1436                         m_can_write(priv, M_CAN_CCCR, cccr);
1437                 }
1438                 m_can_write(priv, M_CAN_TXBTIE, 0x1);
1439
1440                 can_put_echo_skb(skb, dev, 0);
1441
1442                 m_can_write(priv, M_CAN_TXBAR, 0x1);
1443                 /* End of xmit function for version 3.0.x */
1444         } else {
1445                 /* Transmit routine for version >= v3.1.x */
1446
1447                 /* Check if FIFO full */
1448                 if (m_can_tx_fifo_full(priv)) {
1449                         /* This shouldn't happen */
1450                         netif_stop_queue(dev);
1451                         netdev_warn(dev,
1452                                     "TX queue active although FIFO is full.");
1453                         return NETDEV_TX_BUSY;
1454                 }
1455
1456                 /* get put index for frame */
1457                 putidx = ((m_can_read(priv, M_CAN_TXFQS) & TXFQS_TFQPI_MASK)
1458                                   >> TXFQS_TFQPI_SHIFT);
1459                 /* Write ID Field to FIFO Element */
1460                 m_can_fifo_write(priv, putidx, M_CAN_FIFO_ID, id);
1461
1462                 /* get CAN FD configuration of frame */
1463                 fdflags = 0;
1464                 if (can_is_canfd_skb(skb)) {
1465                         fdflags |= TX_BUF_FDF;
1466                         if (cf->flags & CANFD_BRS)
1467                                 fdflags |= TX_BUF_BRS;
1468                 }
1469
1470                 /* Construct DLC Field. Also contains CAN-FD configuration
1471                  * use put index of fifo as message marker
1472                  * it is used in TX interrupt for
1473                  * sending the correct echo frame
1474                  */
1475                 m_can_fifo_write(priv, putidx, M_CAN_FIFO_DLC,
1476                                  ((putidx << TX_BUF_MM_SHIFT) &
1477                                   TX_BUF_MM_MASK) |
1478                                  (can_len2dlc(cf->len) << 16) |
1479                                  fdflags | TX_BUF_EFC);
1480
1481                 for (i = 0; i < cf->len; i += 4)
1482                         m_can_fifo_write(priv, putidx, M_CAN_FIFO_DATA(i / 4),
1483                                          *(u32 *)(cf->data + i));
1484
1485                 /* Push loopback echo.
1486                  * Will be looped back on TX interrupt based on message marker
1487                  */
1488                 can_put_echo_skb(skb, dev, putidx);
1489
1490                 /* Enable TX FIFO element to start transfer  */
1491                 m_can_write(priv, M_CAN_TXBAR, (1 << putidx));
1492
1493                 /* stop network queue if fifo full */
1494                         if (m_can_tx_fifo_full(priv) ||
1495                             m_can_next_echo_skb_occupied(dev, putidx))
1496                                 netif_stop_queue(dev);
1497         }
1498
1499         return NETDEV_TX_OK;
1500 }
1501
1502 static const struct net_device_ops m_can_netdev_ops = {
1503         .ndo_open = m_can_open,
1504         .ndo_stop = m_can_close,
1505         .ndo_start_xmit = m_can_start_xmit,
1506         .ndo_change_mtu = can_change_mtu,
1507 };
1508
1509 static int register_m_can_dev(struct net_device *dev)
1510 {
1511         dev->flags |= IFF_ECHO; /* we support local echo */
1512         dev->netdev_ops = &m_can_netdev_ops;
1513
1514         return register_candev(dev);
1515 }
1516
1517 static void m_can_init_ram(struct m_can_priv *priv)
1518 {
1519         int end, i, start;
1520
1521         /* initialize the entire Message RAM in use to avoid possible
1522          * ECC/parity checksum errors when reading an uninitialized buffer
1523          */
1524         start = priv->mcfg[MRAM_SIDF].off;
1525         end = priv->mcfg[MRAM_TXB].off +
1526                 priv->mcfg[MRAM_TXB].num * TXB_ELEMENT_SIZE;
1527         for (i = start; i < end; i += 4)
1528                 writel(0x0, priv->mram_base + i);
1529 }
1530
1531 static void m_can_of_parse_mram(struct m_can_priv *priv,
1532                                 const u32 *mram_config_vals)
1533 {
1534         priv->mcfg[MRAM_SIDF].off = mram_config_vals[0];
1535         priv->mcfg[MRAM_SIDF].num = mram_config_vals[1];
1536         priv->mcfg[MRAM_XIDF].off = priv->mcfg[MRAM_SIDF].off +
1537                         priv->mcfg[MRAM_SIDF].num * SIDF_ELEMENT_SIZE;
1538         priv->mcfg[MRAM_XIDF].num = mram_config_vals[2];
1539         priv->mcfg[MRAM_RXF0].off = priv->mcfg[MRAM_XIDF].off +
1540                         priv->mcfg[MRAM_XIDF].num * XIDF_ELEMENT_SIZE;
1541         priv->mcfg[MRAM_RXF0].num = mram_config_vals[3] &
1542                         (RXFC_FS_MASK >> RXFC_FS_SHIFT);
1543         priv->mcfg[MRAM_RXF1].off = priv->mcfg[MRAM_RXF0].off +
1544                         priv->mcfg[MRAM_RXF0].num * RXF0_ELEMENT_SIZE;
1545         priv->mcfg[MRAM_RXF1].num = mram_config_vals[4] &
1546                         (RXFC_FS_MASK >> RXFC_FS_SHIFT);
1547         priv->mcfg[MRAM_RXB].off = priv->mcfg[MRAM_RXF1].off +
1548                         priv->mcfg[MRAM_RXF1].num * RXF1_ELEMENT_SIZE;
1549         priv->mcfg[MRAM_RXB].num = mram_config_vals[5];
1550         priv->mcfg[MRAM_TXE].off = priv->mcfg[MRAM_RXB].off +
1551                         priv->mcfg[MRAM_RXB].num * RXB_ELEMENT_SIZE;
1552         priv->mcfg[MRAM_TXE].num = mram_config_vals[6];
1553         priv->mcfg[MRAM_TXB].off = priv->mcfg[MRAM_TXE].off +
1554                         priv->mcfg[MRAM_TXE].num * TXE_ELEMENT_SIZE;
1555         priv->mcfg[MRAM_TXB].num = mram_config_vals[7] &
1556                         (TXBC_NDTB_MASK >> TXBC_NDTB_SHIFT);
1557
1558         dev_dbg(priv->device,
1559                 "mram_base %p sidf 0x%x %d xidf 0x%x %d rxf0 0x%x %d rxf1 0x%x %d rxb 0x%x %d txe 0x%x %d txb 0x%x %d\n",
1560                 priv->mram_base,
1561                 priv->mcfg[MRAM_SIDF].off, priv->mcfg[MRAM_SIDF].num,
1562                 priv->mcfg[MRAM_XIDF].off, priv->mcfg[MRAM_XIDF].num,
1563                 priv->mcfg[MRAM_RXF0].off, priv->mcfg[MRAM_RXF0].num,
1564                 priv->mcfg[MRAM_RXF1].off, priv->mcfg[MRAM_RXF1].num,
1565                 priv->mcfg[MRAM_RXB].off, priv->mcfg[MRAM_RXB].num,
1566                 priv->mcfg[MRAM_TXE].off, priv->mcfg[MRAM_TXE].num,
1567                 priv->mcfg[MRAM_TXB].off, priv->mcfg[MRAM_TXB].num);
1568
1569         m_can_init_ram(priv);
1570 }
1571
1572 static int m_can_plat_probe(struct platform_device *pdev)
1573 {
1574         struct net_device *dev;
1575         struct m_can_priv *priv;
1576         struct resource *res;
1577         void __iomem *addr;
1578         void __iomem *mram_addr;
1579         struct clk *hclk, *cclk;
1580         int irq, ret;
1581         struct device_node *np;
1582         u32 mram_config_vals[MRAM_CFG_LEN];
1583         u32 tx_fifo_size;
1584
1585         np = pdev->dev.of_node;
1586
1587         hclk = devm_clk_get(&pdev->dev, "hclk");
1588         cclk = devm_clk_get(&pdev->dev, "cclk");
1589
1590         if (IS_ERR(hclk) || IS_ERR(cclk)) {
1591                 dev_err(&pdev->dev, "no clock found\n");
1592                 ret = -ENODEV;
1593                 goto failed_ret;
1594         }
1595
1596         /* Enable clocks. Necessary to read Core Release in order to determine
1597          * M_CAN version
1598          */
1599         ret = clk_prepare_enable(hclk);
1600         if (ret)
1601                 goto disable_hclk_ret;
1602
1603         ret = clk_prepare_enable(cclk);
1604         if (ret)
1605                 goto disable_cclk_ret;
1606
1607         res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "m_can");
1608         addr = devm_ioremap_resource(&pdev->dev, res);
1609         irq = platform_get_irq_byname(pdev, "int0");
1610
1611         if (IS_ERR(addr) || irq < 0) {
1612                 ret = -EINVAL;
1613                 goto disable_cclk_ret;
1614         }
1615
1616         /* message ram could be shared */
1617         res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "message_ram");
1618         if (!res) {
1619                 ret = -ENODEV;
1620                 goto disable_cclk_ret;
1621         }
1622
1623         mram_addr = devm_ioremap(&pdev->dev, res->start, resource_size(res));
1624         if (!mram_addr) {
1625                 ret = -ENOMEM;
1626                 goto disable_cclk_ret;
1627         }
1628
1629         /* get message ram configuration */
1630         ret = of_property_read_u32_array(np, "bosch,mram-cfg",
1631                                          mram_config_vals,
1632                                          sizeof(mram_config_vals) / 4);
1633         if (ret) {
1634                 dev_err(&pdev->dev, "Could not get Message RAM configuration.");
1635                 goto disable_cclk_ret;
1636         }
1637
1638         /* Get TX FIFO size
1639          * Defines the total amount of echo buffers for loopback
1640          */
1641         tx_fifo_size = mram_config_vals[7];
1642
1643         /* allocate the m_can device */
1644         dev = alloc_m_can_dev(pdev, addr, tx_fifo_size);
1645         if (!dev) {
1646                 ret = -ENOMEM;
1647                 goto disable_cclk_ret;
1648         }
1649         priv = netdev_priv(dev);
1650         dev->irq = irq;
1651         priv->device = &pdev->dev;
1652         priv->hclk = hclk;
1653         priv->cclk = cclk;
1654         priv->can.clock.freq = clk_get_rate(cclk);
1655         priv->mram_base = mram_addr;
1656
1657         platform_set_drvdata(pdev, dev);
1658         SET_NETDEV_DEV(dev, &pdev->dev);
1659
1660         ret = register_m_can_dev(dev);
1661         if (ret) {
1662                 dev_err(&pdev->dev, "registering %s failed (err=%d)\n",
1663                         KBUILD_MODNAME, ret);
1664                 goto failed_free_dev;
1665         }
1666
1667         m_can_of_parse_mram(priv, mram_config_vals);
1668
1669         devm_can_led_init(dev);
1670
1671         dev_info(&pdev->dev, "%s device registered (irq=%d, version=%d)\n",
1672                  KBUILD_MODNAME, dev->irq, priv->version);
1673
1674         /* Probe finished
1675          * Stop clocks. They will be reactivated once the M_CAN device is opened
1676          */
1677
1678         goto disable_cclk_ret;
1679
1680 failed_free_dev:
1681         free_m_can_dev(dev);
1682 disable_cclk_ret:
1683         clk_disable_unprepare(cclk);
1684 disable_hclk_ret:
1685         clk_disable_unprepare(hclk);
1686 failed_ret:
1687         return ret;
1688 }
1689
1690 /* TODO: runtime PM with power down or sleep mode  */
1691
1692 static __maybe_unused int m_can_suspend(struct device *dev)
1693 {
1694         struct net_device *ndev = dev_get_drvdata(dev);
1695         struct m_can_priv *priv = netdev_priv(ndev);
1696
1697         if (netif_running(ndev)) {
1698                 netif_stop_queue(ndev);
1699                 netif_device_detach(ndev);
1700                 m_can_stop(ndev);
1701                 m_can_clk_stop(priv);
1702         }
1703
1704         pinctrl_pm_select_sleep_state(dev);
1705
1706         priv->can.state = CAN_STATE_SLEEPING;
1707
1708         return 0;
1709 }
1710
1711 static __maybe_unused int m_can_resume(struct device *dev)
1712 {
1713         struct net_device *ndev = dev_get_drvdata(dev);
1714         struct m_can_priv *priv = netdev_priv(ndev);
1715
1716         pinctrl_pm_select_default_state(dev);
1717
1718         priv->can.state = CAN_STATE_ERROR_ACTIVE;
1719
1720         if (netif_running(ndev)) {
1721                 int ret;
1722
1723                 ret = m_can_clk_start(priv);
1724                 if (ret)
1725                         return ret;
1726
1727                 m_can_init_ram(priv);
1728                 m_can_start(ndev);
1729                 netif_device_attach(ndev);
1730                 netif_start_queue(ndev);
1731         }
1732
1733         return 0;
1734 }
1735
1736 static void unregister_m_can_dev(struct net_device *dev)
1737 {
1738         unregister_candev(dev);
1739 }
1740
1741 static int m_can_plat_remove(struct platform_device *pdev)
1742 {
1743         struct net_device *dev = platform_get_drvdata(pdev);
1744
1745         unregister_m_can_dev(dev);
1746         platform_set_drvdata(pdev, NULL);
1747
1748         free_m_can_dev(dev);
1749
1750         return 0;
1751 }
1752
1753 static const struct dev_pm_ops m_can_pmops = {
1754         SET_SYSTEM_SLEEP_PM_OPS(m_can_suspend, m_can_resume)
1755 };
1756
1757 static const struct of_device_id m_can_of_table[] = {
1758         { .compatible = "bosch,m_can", .data = NULL },
1759         { /* sentinel */ },
1760 };
1761 MODULE_DEVICE_TABLE(of, m_can_of_table);
1762
1763 static struct platform_driver m_can_plat_driver = {
1764         .driver = {
1765                 .name = KBUILD_MODNAME,
1766                 .of_match_table = m_can_of_table,
1767                 .pm     = &m_can_pmops,
1768         },
1769         .probe = m_can_plat_probe,
1770         .remove = m_can_plat_remove,
1771 };
1772
1773 module_platform_driver(m_can_plat_driver);
1774
1775 MODULE_AUTHOR("Dong Aisheng <b29396@freescale.com>");
1776 MODULE_LICENSE("GPL v2");
1777 MODULE_DESCRIPTION("CAN bus driver for Bosch M_CAN controller");