1 // SPDX-License-Identifier: GPL-2.0
2 // CAN bus driver for Bosch M_CAN controller
3 // Copyright (C) 2014 Freescale Semiconductor, Inc.
4 // Dong Aisheng <b29396@freescale.com>
5 // Copyright (C) 2018-19 Texas Instruments Incorporated - http://www.ti.com/
7 /* Bosch M_CAN user manual can be obtained from:
8 * https://github.com/linux-can/can-doc/tree/master/m_can
11 #include <linux/bitfield.h>
12 #include <linux/interrupt.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/netdevice.h>
18 #include <linux/of_device.h>
19 #include <linux/platform_device.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/iopoll.h>
22 #include <linux/can/dev.h>
23 #include <linux/pinctrl/consumer.h>
24 #include <linux/phy/phy.h>
28 /* registers definition */
44 /* TDCR Register only available for version >=3.1.x */
81 #define M_CAN_NAPI_WEIGHT 64
83 /* message ram configuration data length */
84 #define MRAM_CFG_LEN 8
86 /* Core Release Register (CREL) */
87 #define CREL_REL_MASK GENMASK(31, 28)
88 #define CREL_STEP_MASK GENMASK(27, 24)
89 #define CREL_SUBSTEP_MASK GENMASK(23, 20)
91 /* Data Bit Timing & Prescaler Register (DBTP) */
92 #define DBTP_TDC BIT(23)
93 #define DBTP_DBRP_MASK GENMASK(20, 16)
94 #define DBTP_DTSEG1_MASK GENMASK(12, 8)
95 #define DBTP_DTSEG2_MASK GENMASK(7, 4)
96 #define DBTP_DSJW_MASK GENMASK(3, 0)
98 /* Transmitter Delay Compensation Register (TDCR) */
99 #define TDCR_TDCO_MASK GENMASK(14, 8)
100 #define TDCR_TDCF_MASK GENMASK(6, 0)
102 /* Test Register (TEST) */
103 #define TEST_LBCK BIT(4)
105 /* CC Control Register (CCCR) */
106 #define CCCR_TXP BIT(14)
107 #define CCCR_TEST BIT(7)
108 #define CCCR_DAR BIT(6)
109 #define CCCR_MON BIT(5)
110 #define CCCR_CSR BIT(4)
111 #define CCCR_CSA BIT(3)
112 #define CCCR_ASM BIT(2)
113 #define CCCR_CCE BIT(1)
114 #define CCCR_INIT BIT(0)
115 /* for version 3.0.x */
116 #define CCCR_CMR_MASK GENMASK(11, 10)
117 #define CCCR_CMR_CANFD 0x1
118 #define CCCR_CMR_CANFD_BRS 0x2
119 #define CCCR_CMR_CAN 0x3
120 #define CCCR_CME_MASK GENMASK(9, 8)
121 #define CCCR_CME_CAN 0
122 #define CCCR_CME_CANFD 0x1
123 #define CCCR_CME_CANFD_BRS 0x2
124 /* for version >=3.1.x */
125 #define CCCR_EFBI BIT(13)
126 #define CCCR_PXHD BIT(12)
127 #define CCCR_BRSE BIT(9)
128 #define CCCR_FDOE BIT(8)
129 /* for version >=3.2.x */
130 #define CCCR_NISO BIT(15)
131 /* for version >=3.3.x */
132 #define CCCR_WMM BIT(11)
133 #define CCCR_UTSU BIT(10)
135 /* Nominal Bit Timing & Prescaler Register (NBTP) */
136 #define NBTP_NSJW_MASK GENMASK(31, 25)
137 #define NBTP_NBRP_MASK GENMASK(24, 16)
138 #define NBTP_NTSEG1_MASK GENMASK(15, 8)
139 #define NBTP_NTSEG2_MASK GENMASK(6, 0)
141 /* Timestamp Counter Configuration Register (TSCC) */
142 #define TSCC_TCP_MASK GENMASK(19, 16)
143 #define TSCC_TSS_MASK GENMASK(1, 0)
144 #define TSCC_TSS_DISABLE 0x0
145 #define TSCC_TSS_INTERNAL 0x1
146 #define TSCC_TSS_EXTERNAL 0x2
148 /* Timestamp Counter Value Register (TSCV) */
149 #define TSCV_TSC_MASK GENMASK(15, 0)
151 /* Error Counter Register (ECR) */
152 #define ECR_RP BIT(15)
153 #define ECR_REC_MASK GENMASK(14, 8)
154 #define ECR_TEC_MASK GENMASK(7, 0)
156 /* Protocol Status Register (PSR) */
157 #define PSR_BO BIT(7)
158 #define PSR_EW BIT(6)
159 #define PSR_EP BIT(5)
160 #define PSR_LEC_MASK GENMASK(2, 0)
162 /* Interrupt Register (IR) */
163 #define IR_ALL_INT 0xffffffff
165 /* Renamed bits for versions > 3.1.x */
166 #define IR_ARA BIT(29)
167 #define IR_PED BIT(28)
168 #define IR_PEA BIT(27)
170 /* Bits for version 3.0.x */
171 #define IR_STE BIT(31)
172 #define IR_FOE BIT(30)
173 #define IR_ACKE BIT(29)
174 #define IR_BE BIT(28)
175 #define IR_CRCE BIT(27)
176 #define IR_WDI BIT(26)
177 #define IR_BO BIT(25)
178 #define IR_EW BIT(24)
179 #define IR_EP BIT(23)
180 #define IR_ELO BIT(22)
181 #define IR_BEU BIT(21)
182 #define IR_BEC BIT(20)
183 #define IR_DRX BIT(19)
184 #define IR_TOO BIT(18)
185 #define IR_MRAF BIT(17)
186 #define IR_TSW BIT(16)
187 #define IR_TEFL BIT(15)
188 #define IR_TEFF BIT(14)
189 #define IR_TEFW BIT(13)
190 #define IR_TEFN BIT(12)
191 #define IR_TFE BIT(11)
192 #define IR_TCF BIT(10)
194 #define IR_HPM BIT(8)
195 #define IR_RF1L BIT(7)
196 #define IR_RF1F BIT(6)
197 #define IR_RF1W BIT(5)
198 #define IR_RF1N BIT(4)
199 #define IR_RF0L BIT(3)
200 #define IR_RF0F BIT(2)
201 #define IR_RF0W BIT(1)
202 #define IR_RF0N BIT(0)
203 #define IR_ERR_STATE (IR_BO | IR_EW | IR_EP)
205 /* Interrupts for version 3.0.x */
206 #define IR_ERR_LEC_30X (IR_STE | IR_FOE | IR_ACKE | IR_BE | IR_CRCE)
207 #define IR_ERR_BUS_30X (IR_ERR_LEC_30X | IR_WDI | IR_ELO | IR_BEU | \
208 IR_BEC | IR_TOO | IR_MRAF | IR_TSW | IR_TEFL | \
210 #define IR_ERR_ALL_30X (IR_ERR_STATE | IR_ERR_BUS_30X)
212 /* Interrupts for version >= 3.1.x */
213 #define IR_ERR_LEC_31X (IR_PED | IR_PEA)
214 #define IR_ERR_BUS_31X (IR_ERR_LEC_31X | IR_WDI | IR_ELO | IR_BEU | \
215 IR_BEC | IR_TOO | IR_MRAF | IR_TSW | IR_TEFL | \
217 #define IR_ERR_ALL_31X (IR_ERR_STATE | IR_ERR_BUS_31X)
219 /* Interrupt Line Select (ILS) */
220 #define ILS_ALL_INT0 0x0
221 #define ILS_ALL_INT1 0xFFFFFFFF
223 /* Interrupt Line Enable (ILE) */
224 #define ILE_EINT1 BIT(1)
225 #define ILE_EINT0 BIT(0)
227 /* Rx FIFO 0/1 Configuration (RXF0C/RXF1C) */
228 #define RXFC_FWM_MASK GENMASK(30, 24)
229 #define RXFC_FS_MASK GENMASK(22, 16)
231 /* Rx FIFO 0/1 Status (RXF0S/RXF1S) */
232 #define RXFS_RFL BIT(25)
233 #define RXFS_FF BIT(24)
234 #define RXFS_FPI_MASK GENMASK(21, 16)
235 #define RXFS_FGI_MASK GENMASK(13, 8)
236 #define RXFS_FFL_MASK GENMASK(6, 0)
238 /* Rx Buffer / FIFO Element Size Configuration (RXESC) */
239 #define RXESC_RBDS_MASK GENMASK(10, 8)
240 #define RXESC_F1DS_MASK GENMASK(6, 4)
241 #define RXESC_F0DS_MASK GENMASK(2, 0)
242 #define RXESC_64B 0x7
244 /* Tx Buffer Configuration (TXBC) */
245 #define TXBC_TFQS_MASK GENMASK(29, 24)
246 #define TXBC_NDTB_MASK GENMASK(21, 16)
248 /* Tx FIFO/Queue Status (TXFQS) */
249 #define TXFQS_TFQF BIT(21)
250 #define TXFQS_TFQPI_MASK GENMASK(20, 16)
251 #define TXFQS_TFGI_MASK GENMASK(12, 8)
252 #define TXFQS_TFFL_MASK GENMASK(5, 0)
254 /* Tx Buffer Element Size Configuration (TXESC) */
255 #define TXESC_TBDS_MASK GENMASK(2, 0)
256 #define TXESC_TBDS_64B 0x7
258 /* Tx Event FIFO Configuration (TXEFC) */
259 #define TXEFC_EFS_MASK GENMASK(21, 16)
261 /* Tx Event FIFO Status (TXEFS) */
262 #define TXEFS_TEFL BIT(25)
263 #define TXEFS_EFF BIT(24)
264 #define TXEFS_EFGI_MASK GENMASK(12, 8)
265 #define TXEFS_EFFL_MASK GENMASK(5, 0)
267 /* Tx Event FIFO Acknowledge (TXEFA) */
268 #define TXEFA_EFAI_MASK GENMASK(4, 0)
270 /* Message RAM Configuration (in bytes) */
271 #define SIDF_ELEMENT_SIZE 4
272 #define XIDF_ELEMENT_SIZE 8
273 #define RXF0_ELEMENT_SIZE 72
274 #define RXF1_ELEMENT_SIZE 72
275 #define RXB_ELEMENT_SIZE 72
276 #define TXE_ELEMENT_SIZE 8
277 #define TXB_ELEMENT_SIZE 72
279 /* Message RAM Elements */
280 #define M_CAN_FIFO_ID 0x0
281 #define M_CAN_FIFO_DLC 0x4
282 #define M_CAN_FIFO_DATA(n) (0x8 + ((n) << 2))
284 /* Rx Buffer Element */
286 #define RX_BUF_ESI BIT(31)
287 #define RX_BUF_XTD BIT(30)
288 #define RX_BUF_RTR BIT(29)
290 #define RX_BUF_ANMF BIT(31)
291 #define RX_BUF_FDF BIT(21)
292 #define RX_BUF_BRS BIT(20)
293 #define RX_BUF_RXTS_MASK GENMASK(15, 0)
295 /* Tx Buffer Element */
297 #define TX_BUF_ESI BIT(31)
298 #define TX_BUF_XTD BIT(30)
299 #define TX_BUF_RTR BIT(29)
301 #define TX_BUF_EFC BIT(23)
302 #define TX_BUF_FDF BIT(21)
303 #define TX_BUF_BRS BIT(20)
304 #define TX_BUF_MM_MASK GENMASK(31, 24)
305 #define TX_BUF_DLC_MASK GENMASK(19, 16)
307 /* Tx event FIFO Element */
309 #define TX_EVENT_MM_MASK GENMASK(31, 24)
310 #define TX_EVENT_TXTS_MASK GENMASK(15, 0)
312 /* The ID and DLC registers are adjacent in M_CAN FIFO memory,
313 * and we can save a (potentially slow) bus round trip by combining
314 * reads and writes to them.
321 static inline u32 m_can_read(struct m_can_classdev *cdev, enum m_can_reg reg)
323 return cdev->ops->read_reg(cdev, reg);
326 static inline void m_can_write(struct m_can_classdev *cdev, enum m_can_reg reg,
329 cdev->ops->write_reg(cdev, reg, val);
333 m_can_fifo_read(struct m_can_classdev *cdev,
334 u32 fgi, unsigned int offset, void *val, size_t val_count)
336 u32 addr_offset = cdev->mcfg[MRAM_RXF0].off + fgi * RXF0_ELEMENT_SIZE +
339 return cdev->ops->read_fifo(cdev, addr_offset, val, val_count);
343 m_can_fifo_write(struct m_can_classdev *cdev,
344 u32 fpi, unsigned int offset, const void *val, size_t val_count)
346 u32 addr_offset = cdev->mcfg[MRAM_TXB].off + fpi * TXB_ELEMENT_SIZE +
349 return cdev->ops->write_fifo(cdev, addr_offset, val, val_count);
352 static inline int m_can_fifo_write_no_off(struct m_can_classdev *cdev,
355 return cdev->ops->write_fifo(cdev, fpi, &val, 1);
359 m_can_txe_fifo_read(struct m_can_classdev *cdev, u32 fgi, u32 offset, u32 *val)
361 u32 addr_offset = cdev->mcfg[MRAM_TXE].off + fgi * TXE_ELEMENT_SIZE +
364 return cdev->ops->read_fifo(cdev, addr_offset, val, 1);
367 static inline bool m_can_tx_fifo_full(struct m_can_classdev *cdev)
369 return !!(m_can_read(cdev, M_CAN_TXFQS) & TXFQS_TFQF);
372 static void m_can_config_endisable(struct m_can_classdev *cdev, bool enable)
374 u32 cccr = m_can_read(cdev, M_CAN_CCCR);
378 /* Clear the Clock stop request if it was set */
383 /* enable m_can configuration */
384 m_can_write(cdev, M_CAN_CCCR, cccr | CCCR_INIT);
386 /* CCCR.CCE can only be set/reset while CCCR.INIT = '1' */
387 m_can_write(cdev, M_CAN_CCCR, cccr | CCCR_INIT | CCCR_CCE);
389 m_can_write(cdev, M_CAN_CCCR, cccr & ~(CCCR_INIT | CCCR_CCE));
392 /* there's a delay for module initialization */
394 val = CCCR_INIT | CCCR_CCE;
396 while ((m_can_read(cdev, M_CAN_CCCR) & (CCCR_INIT | CCCR_CCE)) != val) {
398 netdev_warn(cdev->net, "Failed to init module\n");
406 static inline void m_can_enable_all_interrupts(struct m_can_classdev *cdev)
408 /* Only interrupt line 0 is used in this driver */
409 m_can_write(cdev, M_CAN_ILE, ILE_EINT0);
412 static inline void m_can_disable_all_interrupts(struct m_can_classdev *cdev)
414 m_can_write(cdev, M_CAN_ILE, 0x0);
417 /* Retrieve internal timestamp counter from TSCV.TSC, and shift it to 32-bit
420 static u32 m_can_get_timestamp(struct m_can_classdev *cdev)
425 tscv = m_can_read(cdev, M_CAN_TSCV);
426 tsc = FIELD_GET(TSCV_TSC_MASK, tscv);
431 static void m_can_clean(struct net_device *net)
433 struct m_can_classdev *cdev = netdev_priv(net);
438 net->stats.tx_errors++;
439 if (cdev->version > 30)
440 putidx = FIELD_GET(TXFQS_TFQPI_MASK,
441 m_can_read(cdev, M_CAN_TXFQS));
443 can_free_echo_skb(cdev->net, putidx, NULL);
448 /* For peripherals, pass skb to rx-offload, which will push skb from
449 * napi. For non-peripherals, RX is done in napi already, so push
450 * directly. timestamp is used to ensure good skb ordering in
451 * rx-offload and is ignored for non-peripherals.
453 static void m_can_receive_skb(struct m_can_classdev *cdev,
457 if (cdev->is_peripheral) {
458 struct net_device_stats *stats = &cdev->net->stats;
461 err = can_rx_offload_queue_sorted(&cdev->offload, skb,
464 stats->rx_fifo_errors++;
466 netif_receive_skb(skb);
470 static int m_can_read_fifo(struct net_device *dev, u32 rxfs)
472 struct net_device_stats *stats = &dev->stats;
473 struct m_can_classdev *cdev = netdev_priv(dev);
474 struct canfd_frame *cf;
476 struct id_and_dlc fifo_header;
481 /* calculate the fifo get index for where to read data */
482 fgi = FIELD_GET(RXFS_FGI_MASK, rxfs);
483 err = m_can_fifo_read(cdev, fgi, M_CAN_FIFO_ID, &fifo_header, 2);
487 if (fifo_header.dlc & RX_BUF_FDF)
488 skb = alloc_canfd_skb(dev, &cf);
490 skb = alloc_can_skb(dev, (struct can_frame **)&cf);
496 if (fifo_header.dlc & RX_BUF_FDF)
497 cf->len = can_fd_dlc2len((fifo_header.dlc >> 16) & 0x0F);
499 cf->len = can_cc_dlc2len((fifo_header.dlc >> 16) & 0x0F);
501 if (fifo_header.id & RX_BUF_XTD)
502 cf->can_id = (fifo_header.id & CAN_EFF_MASK) | CAN_EFF_FLAG;
504 cf->can_id = (fifo_header.id >> 18) & CAN_SFF_MASK;
506 if (fifo_header.id & RX_BUF_ESI) {
507 cf->flags |= CANFD_ESI;
508 netdev_dbg(dev, "ESI Error\n");
511 if (!(fifo_header.dlc & RX_BUF_FDF) && (fifo_header.id & RX_BUF_RTR)) {
512 cf->can_id |= CAN_RTR_FLAG;
514 if (fifo_header.dlc & RX_BUF_BRS)
515 cf->flags |= CANFD_BRS;
517 err = m_can_fifo_read(cdev, fgi, M_CAN_FIFO_DATA(0),
518 cf->data, DIV_ROUND_UP(cf->len, 4));
523 /* acknowledge rx fifo 0 */
524 m_can_write(cdev, M_CAN_RXF0A, fgi);
527 stats->rx_bytes += cf->len;
529 timestamp = FIELD_GET(RX_BUF_RXTS_MASK, fifo_header.dlc);
531 m_can_receive_skb(cdev, skb, timestamp);
536 netdev_err(dev, "FIFO read returned %d\n", err);
540 static int m_can_do_rx_poll(struct net_device *dev, int quota)
542 struct m_can_classdev *cdev = netdev_priv(dev);
547 rxfs = m_can_read(cdev, M_CAN_RXF0S);
548 if (!(rxfs & RXFS_FFL_MASK)) {
549 netdev_dbg(dev, "no messages in fifo0\n");
553 while ((rxfs & RXFS_FFL_MASK) && (quota > 0)) {
554 err = m_can_read_fifo(dev, rxfs);
560 rxfs = m_can_read(cdev, M_CAN_RXF0S);
564 can_led_event(dev, CAN_LED_EVENT_RX);
569 static int m_can_handle_lost_msg(struct net_device *dev)
571 struct m_can_classdev *cdev = netdev_priv(dev);
572 struct net_device_stats *stats = &dev->stats;
574 struct can_frame *frame;
577 netdev_err(dev, "msg lost in rxf0\n");
580 stats->rx_over_errors++;
582 skb = alloc_can_err_skb(dev, &frame);
586 frame->can_id |= CAN_ERR_CRTL;
587 frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
589 if (cdev->is_peripheral)
590 timestamp = m_can_get_timestamp(cdev);
592 m_can_receive_skb(cdev, skb, timestamp);
597 static int m_can_handle_lec_err(struct net_device *dev,
598 enum m_can_lec_type lec_type)
600 struct m_can_classdev *cdev = netdev_priv(dev);
601 struct net_device_stats *stats = &dev->stats;
602 struct can_frame *cf;
606 cdev->can.can_stats.bus_error++;
609 /* propagate the error condition to the CAN stack */
610 skb = alloc_can_err_skb(dev, &cf);
614 /* check for 'last error code' which tells us the
615 * type of the last error to occur on the CAN bus
617 cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR;
620 case LEC_STUFF_ERROR:
621 netdev_dbg(dev, "stuff error\n");
622 cf->data[2] |= CAN_ERR_PROT_STUFF;
625 netdev_dbg(dev, "form error\n");
626 cf->data[2] |= CAN_ERR_PROT_FORM;
629 netdev_dbg(dev, "ack error\n");
630 cf->data[3] = CAN_ERR_PROT_LOC_ACK;
633 netdev_dbg(dev, "bit1 error\n");
634 cf->data[2] |= CAN_ERR_PROT_BIT1;
637 netdev_dbg(dev, "bit0 error\n");
638 cf->data[2] |= CAN_ERR_PROT_BIT0;
641 netdev_dbg(dev, "CRC error\n");
642 cf->data[3] = CAN_ERR_PROT_LOC_CRC_SEQ;
649 stats->rx_bytes += cf->len;
651 if (cdev->is_peripheral)
652 timestamp = m_can_get_timestamp(cdev);
654 m_can_receive_skb(cdev, skb, timestamp);
659 static int __m_can_get_berr_counter(const struct net_device *dev,
660 struct can_berr_counter *bec)
662 struct m_can_classdev *cdev = netdev_priv(dev);
665 ecr = m_can_read(cdev, M_CAN_ECR);
666 bec->rxerr = FIELD_GET(ECR_REC_MASK, ecr);
667 bec->txerr = FIELD_GET(ECR_TEC_MASK, ecr);
672 static int m_can_clk_start(struct m_can_classdev *cdev)
674 if (cdev->pm_clock_support == 0)
677 return pm_runtime_resume_and_get(cdev->dev);
680 static void m_can_clk_stop(struct m_can_classdev *cdev)
682 if (cdev->pm_clock_support)
683 pm_runtime_put_sync(cdev->dev);
686 static int m_can_get_berr_counter(const struct net_device *dev,
687 struct can_berr_counter *bec)
689 struct m_can_classdev *cdev = netdev_priv(dev);
692 err = m_can_clk_start(cdev);
696 __m_can_get_berr_counter(dev, bec);
698 m_can_clk_stop(cdev);
703 static int m_can_handle_state_change(struct net_device *dev,
704 enum can_state new_state)
706 struct m_can_classdev *cdev = netdev_priv(dev);
707 struct net_device_stats *stats = &dev->stats;
708 struct can_frame *cf;
710 struct can_berr_counter bec;
715 case CAN_STATE_ERROR_WARNING:
716 /* error warning state */
717 cdev->can.can_stats.error_warning++;
718 cdev->can.state = CAN_STATE_ERROR_WARNING;
720 case CAN_STATE_ERROR_PASSIVE:
721 /* error passive state */
722 cdev->can.can_stats.error_passive++;
723 cdev->can.state = CAN_STATE_ERROR_PASSIVE;
725 case CAN_STATE_BUS_OFF:
727 cdev->can.state = CAN_STATE_BUS_OFF;
728 m_can_disable_all_interrupts(cdev);
729 cdev->can.can_stats.bus_off++;
736 /* propagate the error condition to the CAN stack */
737 skb = alloc_can_err_skb(dev, &cf);
741 __m_can_get_berr_counter(dev, &bec);
744 case CAN_STATE_ERROR_WARNING:
745 /* error warning state */
746 cf->can_id |= CAN_ERR_CRTL;
747 cf->data[1] = (bec.txerr > bec.rxerr) ?
748 CAN_ERR_CRTL_TX_WARNING :
749 CAN_ERR_CRTL_RX_WARNING;
750 cf->data[6] = bec.txerr;
751 cf->data[7] = bec.rxerr;
753 case CAN_STATE_ERROR_PASSIVE:
754 /* error passive state */
755 cf->can_id |= CAN_ERR_CRTL;
756 ecr = m_can_read(cdev, M_CAN_ECR);
758 cf->data[1] |= CAN_ERR_CRTL_RX_PASSIVE;
760 cf->data[1] |= CAN_ERR_CRTL_TX_PASSIVE;
761 cf->data[6] = bec.txerr;
762 cf->data[7] = bec.rxerr;
764 case CAN_STATE_BUS_OFF:
766 cf->can_id |= CAN_ERR_BUSOFF;
773 stats->rx_bytes += cf->len;
775 if (cdev->is_peripheral)
776 timestamp = m_can_get_timestamp(cdev);
778 m_can_receive_skb(cdev, skb, timestamp);
783 static int m_can_handle_state_errors(struct net_device *dev, u32 psr)
785 struct m_can_classdev *cdev = netdev_priv(dev);
788 if (psr & PSR_EW && cdev->can.state != CAN_STATE_ERROR_WARNING) {
789 netdev_dbg(dev, "entered error warning state\n");
790 work_done += m_can_handle_state_change(dev,
791 CAN_STATE_ERROR_WARNING);
794 if (psr & PSR_EP && cdev->can.state != CAN_STATE_ERROR_PASSIVE) {
795 netdev_dbg(dev, "entered error passive state\n");
796 work_done += m_can_handle_state_change(dev,
797 CAN_STATE_ERROR_PASSIVE);
800 if (psr & PSR_BO && cdev->can.state != CAN_STATE_BUS_OFF) {
801 netdev_dbg(dev, "entered error bus off state\n");
802 work_done += m_can_handle_state_change(dev,
809 static void m_can_handle_other_err(struct net_device *dev, u32 irqstatus)
811 if (irqstatus & IR_WDI)
812 netdev_err(dev, "Message RAM Watchdog event due to missing READY\n");
813 if (irqstatus & IR_ELO)
814 netdev_err(dev, "Error Logging Overflow\n");
815 if (irqstatus & IR_BEU)
816 netdev_err(dev, "Bit Error Uncorrected\n");
817 if (irqstatus & IR_BEC)
818 netdev_err(dev, "Bit Error Corrected\n");
819 if (irqstatus & IR_TOO)
820 netdev_err(dev, "Timeout reached\n");
821 if (irqstatus & IR_MRAF)
822 netdev_err(dev, "Message RAM access failure occurred\n");
825 static inline bool is_lec_err(u32 psr)
829 return psr && (psr != LEC_UNUSED);
832 static inline bool m_can_is_protocol_err(u32 irqstatus)
834 return irqstatus & IR_ERR_LEC_31X;
837 static int m_can_handle_protocol_error(struct net_device *dev, u32 irqstatus)
839 struct net_device_stats *stats = &dev->stats;
840 struct m_can_classdev *cdev = netdev_priv(dev);
841 struct can_frame *cf;
845 /* propagate the error condition to the CAN stack */
846 skb = alloc_can_err_skb(dev, &cf);
848 /* update tx error stats since there is protocol error */
851 /* update arbitration lost status */
852 if (cdev->version >= 31 && (irqstatus & IR_PEA)) {
853 netdev_dbg(dev, "Protocol error in Arbitration fail\n");
854 cdev->can.can_stats.arbitration_lost++;
856 cf->can_id |= CAN_ERR_LOSTARB;
857 cf->data[0] |= CAN_ERR_LOSTARB_UNSPEC;
861 if (unlikely(!skb)) {
862 netdev_dbg(dev, "allocation of skb failed\n");
866 if (cdev->is_peripheral)
867 timestamp = m_can_get_timestamp(cdev);
869 m_can_receive_skb(cdev, skb, timestamp);
874 static int m_can_handle_bus_errors(struct net_device *dev, u32 irqstatus,
877 struct m_can_classdev *cdev = netdev_priv(dev);
880 if (irqstatus & IR_RF0L)
881 work_done += m_can_handle_lost_msg(dev);
883 /* handle lec errors on the bus */
884 if ((cdev->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING) &&
886 work_done += m_can_handle_lec_err(dev, psr & LEC_UNUSED);
888 /* handle protocol errors in arbitration phase */
889 if ((cdev->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING) &&
890 m_can_is_protocol_err(irqstatus))
891 work_done += m_can_handle_protocol_error(dev, irqstatus);
893 /* other unproccessed error interrupts */
894 m_can_handle_other_err(dev, irqstatus);
899 static int m_can_rx_handler(struct net_device *dev, int quota)
901 struct m_can_classdev *cdev = netdev_priv(dev);
906 irqstatus = cdev->irqstatus | m_can_read(cdev, M_CAN_IR);
910 /* Errata workaround for issue "Needless activation of MRAF irq"
911 * During frame reception while the MCAN is in Error Passive state
912 * and the Receive Error Counter has the value MCAN_ECR.REC = 127,
913 * it may happen that MCAN_IR.MRAF is set although there was no
914 * Message RAM access failure.
915 * If MCAN_IR.MRAF is enabled, an interrupt to the Host CPU is generated
916 * The Message RAM Access Failure interrupt routine needs to check
917 * whether MCAN_ECR.RP = ’1’ and MCAN_ECR.REC = 127.
918 * In this case, reset MCAN_IR.MRAF. No further action is required.
920 if (cdev->version <= 31 && irqstatus & IR_MRAF &&
921 m_can_read(cdev, M_CAN_ECR) & ECR_RP) {
922 struct can_berr_counter bec;
924 __m_can_get_berr_counter(dev, &bec);
925 if (bec.rxerr == 127) {
926 m_can_write(cdev, M_CAN_IR, IR_MRAF);
927 irqstatus &= ~IR_MRAF;
931 psr = m_can_read(cdev, M_CAN_PSR);
933 if (irqstatus & IR_ERR_STATE)
934 work_done += m_can_handle_state_errors(dev, psr);
936 if (irqstatus & IR_ERR_BUS_30X)
937 work_done += m_can_handle_bus_errors(dev, irqstatus, psr);
939 if (irqstatus & IR_RF0N) {
940 rx_work_or_err = m_can_do_rx_poll(dev, (quota - work_done));
941 if (rx_work_or_err < 0)
942 return rx_work_or_err;
944 work_done += rx_work_or_err;
950 static int m_can_rx_peripheral(struct net_device *dev)
952 struct m_can_classdev *cdev = netdev_priv(dev);
955 work_done = m_can_rx_handler(dev, M_CAN_NAPI_WEIGHT);
957 /* Don't re-enable interrupts if the driver had a fatal error
958 * (e.g., FIFO read failure).
961 m_can_enable_all_interrupts(cdev);
966 static int m_can_poll(struct napi_struct *napi, int quota)
968 struct net_device *dev = napi->dev;
969 struct m_can_classdev *cdev = netdev_priv(dev);
972 work_done = m_can_rx_handler(dev, quota);
974 /* Don't re-enable interrupts if the driver had a fatal error
975 * (e.g., FIFO read failure).
977 if (work_done >= 0 && work_done < quota) {
978 napi_complete_done(napi, work_done);
979 m_can_enable_all_interrupts(cdev);
985 /* Echo tx skb and update net stats. Peripherals use rx-offload for
986 * echo. timestamp is used for peripherals to ensure correct ordering
987 * by rx-offload, and is ignored for non-peripherals.
989 static void m_can_tx_update_stats(struct m_can_classdev *cdev,
990 unsigned int msg_mark,
993 struct net_device *dev = cdev->net;
994 struct net_device_stats *stats = &dev->stats;
996 if (cdev->is_peripheral)
998 can_rx_offload_get_echo_skb(&cdev->offload,
1003 stats->tx_bytes += can_get_echo_skb(dev, msg_mark, NULL);
1005 stats->tx_packets++;
1008 static int m_can_echo_tx_event(struct net_device *dev)
1014 unsigned int msg_mark;
1016 struct m_can_classdev *cdev = netdev_priv(dev);
1018 /* read tx event fifo status */
1019 m_can_txefs = m_can_read(cdev, M_CAN_TXEFS);
1021 /* Get Tx Event fifo element count */
1022 txe_count = FIELD_GET(TXEFS_EFFL_MASK, m_can_txefs);
1024 /* Get and process all sent elements */
1025 for (i = 0; i < txe_count; i++) {
1026 u32 txe, timestamp = 0;
1029 /* retrieve get index */
1030 fgi = FIELD_GET(TXEFS_EFGI_MASK, m_can_read(cdev, M_CAN_TXEFS));
1032 /* get message marker, timestamp */
1033 err = m_can_txe_fifo_read(cdev, fgi, 4, &txe);
1035 netdev_err(dev, "TXE FIFO read returned %d\n", err);
1039 msg_mark = FIELD_GET(TX_EVENT_MM_MASK, txe);
1040 timestamp = FIELD_GET(TX_EVENT_TXTS_MASK, txe);
1042 /* ack txe element */
1043 m_can_write(cdev, M_CAN_TXEFA, FIELD_PREP(TXEFA_EFAI_MASK,
1047 m_can_tx_update_stats(cdev, msg_mark, timestamp);
1053 static irqreturn_t m_can_isr(int irq, void *dev_id)
1055 struct net_device *dev = (struct net_device *)dev_id;
1056 struct m_can_classdev *cdev = netdev_priv(dev);
1059 if (pm_runtime_suspended(cdev->dev))
1061 ir = m_can_read(cdev, M_CAN_IR);
1066 if (ir & IR_ALL_INT)
1067 m_can_write(cdev, M_CAN_IR, ir);
1069 if (cdev->ops->clear_interrupts)
1070 cdev->ops->clear_interrupts(cdev);
1072 /* schedule NAPI in case of
1074 * - state change IRQ
1075 * - bus error IRQ and bus error reporting
1077 if ((ir & IR_RF0N) || (ir & IR_ERR_ALL_30X)) {
1078 cdev->irqstatus = ir;
1079 m_can_disable_all_interrupts(cdev);
1080 if (!cdev->is_peripheral)
1081 napi_schedule(&cdev->napi);
1082 else if (m_can_rx_peripheral(dev) < 0)
1086 if (cdev->version == 30) {
1088 /* Transmission Complete Interrupt*/
1091 if (cdev->is_peripheral)
1092 timestamp = m_can_get_timestamp(cdev);
1093 m_can_tx_update_stats(cdev, 0, timestamp);
1095 can_led_event(dev, CAN_LED_EVENT_TX);
1096 netif_wake_queue(dev);
1100 /* New TX FIFO Element arrived */
1101 if (m_can_echo_tx_event(dev) != 0)
1104 can_led_event(dev, CAN_LED_EVENT_TX);
1105 if (netif_queue_stopped(dev) &&
1106 !m_can_tx_fifo_full(cdev))
1107 netif_wake_queue(dev);
1111 if (cdev->is_peripheral)
1112 can_rx_offload_threaded_irq_finish(&cdev->offload);
1117 m_can_disable_all_interrupts(cdev);
1121 static const struct can_bittiming_const m_can_bittiming_const_30X = {
1122 .name = KBUILD_MODNAME,
1123 .tseg1_min = 2, /* Time segment 1 = prop_seg + phase_seg1 */
1125 .tseg2_min = 1, /* Time segment 2 = phase_seg2 */
1133 static const struct can_bittiming_const m_can_data_bittiming_const_30X = {
1134 .name = KBUILD_MODNAME,
1135 .tseg1_min = 2, /* Time segment 1 = prop_seg + phase_seg1 */
1137 .tseg2_min = 1, /* Time segment 2 = phase_seg2 */
1145 static const struct can_bittiming_const m_can_bittiming_const_31X = {
1146 .name = KBUILD_MODNAME,
1147 .tseg1_min = 2, /* Time segment 1 = prop_seg + phase_seg1 */
1149 .tseg2_min = 2, /* Time segment 2 = phase_seg2 */
1157 static const struct can_bittiming_const m_can_data_bittiming_const_31X = {
1158 .name = KBUILD_MODNAME,
1159 .tseg1_min = 1, /* Time segment 1 = prop_seg + phase_seg1 */
1161 .tseg2_min = 1, /* Time segment 2 = phase_seg2 */
1169 static int m_can_set_bittiming(struct net_device *dev)
1171 struct m_can_classdev *cdev = netdev_priv(dev);
1172 const struct can_bittiming *bt = &cdev->can.bittiming;
1173 const struct can_bittiming *dbt = &cdev->can.data_bittiming;
1174 u16 brp, sjw, tseg1, tseg2;
1179 tseg1 = bt->prop_seg + bt->phase_seg1 - 1;
1180 tseg2 = bt->phase_seg2 - 1;
1181 reg_btp = FIELD_PREP(NBTP_NBRP_MASK, brp) |
1182 FIELD_PREP(NBTP_NSJW_MASK, sjw) |
1183 FIELD_PREP(NBTP_NTSEG1_MASK, tseg1) |
1184 FIELD_PREP(NBTP_NTSEG2_MASK, tseg2);
1185 m_can_write(cdev, M_CAN_NBTP, reg_btp);
1187 if (cdev->can.ctrlmode & CAN_CTRLMODE_FD) {
1191 tseg1 = dbt->prop_seg + dbt->phase_seg1 - 1;
1192 tseg2 = dbt->phase_seg2 - 1;
1194 /* TDC is only needed for bitrates beyond 2.5 MBit/s.
1195 * This is mentioned in the "Bit Time Requirements for CAN FD"
1196 * paper presented at the International CAN Conference 2013
1198 if (dbt->bitrate > 2500000) {
1201 /* Use the same value of secondary sampling point
1202 * as the data sampling point
1204 ssp = dbt->sample_point;
1206 /* Equation based on Bosch's M_CAN User Manual's
1207 * Transmitter Delay Compensation Section
1209 tdco = (cdev->can.clock.freq / 1000) *
1212 /* Max valid TDCO value is 127 */
1214 netdev_warn(dev, "TDCO value of %u is beyond maximum. Using maximum possible value\n",
1219 reg_btp |= DBTP_TDC;
1220 m_can_write(cdev, M_CAN_TDCR,
1221 FIELD_PREP(TDCR_TDCO_MASK, tdco));
1224 reg_btp |= FIELD_PREP(DBTP_DBRP_MASK, brp) |
1225 FIELD_PREP(DBTP_DSJW_MASK, sjw) |
1226 FIELD_PREP(DBTP_DTSEG1_MASK, tseg1) |
1227 FIELD_PREP(DBTP_DTSEG2_MASK, tseg2);
1229 m_can_write(cdev, M_CAN_DBTP, reg_btp);
1235 /* Configure M_CAN chip:
1236 * - set rx buffer/fifo element size
1237 * - configure rx fifo
1238 * - accept non-matching frame into fifo 0
1239 * - configure tx buffer
1240 * - >= v3.1.x: TX FIFO is used
1243 * - configure timestamp generation
1245 static void m_can_chip_config(struct net_device *dev)
1247 struct m_can_classdev *cdev = netdev_priv(dev);
1250 m_can_config_endisable(cdev, true);
1252 /* RX Buffer/FIFO Element Size 64 bytes data field */
1253 m_can_write(cdev, M_CAN_RXESC,
1254 FIELD_PREP(RXESC_RBDS_MASK, RXESC_64B) |
1255 FIELD_PREP(RXESC_F1DS_MASK, RXESC_64B) |
1256 FIELD_PREP(RXESC_F0DS_MASK, RXESC_64B));
1258 /* Accept Non-matching Frames Into FIFO 0 */
1259 m_can_write(cdev, M_CAN_GFC, 0x0);
1261 if (cdev->version == 30) {
1262 /* only support one Tx Buffer currently */
1263 m_can_write(cdev, M_CAN_TXBC, FIELD_PREP(TXBC_NDTB_MASK, 1) |
1264 cdev->mcfg[MRAM_TXB].off);
1266 /* TX FIFO is used for newer IP Core versions */
1267 m_can_write(cdev, M_CAN_TXBC,
1268 FIELD_PREP(TXBC_TFQS_MASK,
1269 cdev->mcfg[MRAM_TXB].num) |
1270 cdev->mcfg[MRAM_TXB].off);
1273 /* support 64 bytes payload */
1274 m_can_write(cdev, M_CAN_TXESC,
1275 FIELD_PREP(TXESC_TBDS_MASK, TXESC_TBDS_64B));
1278 if (cdev->version == 30) {
1279 m_can_write(cdev, M_CAN_TXEFC,
1280 FIELD_PREP(TXEFC_EFS_MASK, 1) |
1281 cdev->mcfg[MRAM_TXE].off);
1283 /* Full TX Event FIFO is used */
1284 m_can_write(cdev, M_CAN_TXEFC,
1285 FIELD_PREP(TXEFC_EFS_MASK,
1286 cdev->mcfg[MRAM_TXE].num) |
1287 cdev->mcfg[MRAM_TXE].off);
1290 /* rx fifo configuration, blocking mode, fifo size 1 */
1291 m_can_write(cdev, M_CAN_RXF0C,
1292 FIELD_PREP(RXFC_FS_MASK, cdev->mcfg[MRAM_RXF0].num) |
1293 cdev->mcfg[MRAM_RXF0].off);
1295 m_can_write(cdev, M_CAN_RXF1C,
1296 FIELD_PREP(RXFC_FS_MASK, cdev->mcfg[MRAM_RXF1].num) |
1297 cdev->mcfg[MRAM_RXF1].off);
1299 cccr = m_can_read(cdev, M_CAN_CCCR);
1300 test = m_can_read(cdev, M_CAN_TEST);
1302 if (cdev->version == 30) {
1305 cccr &= ~(CCCR_TEST | CCCR_MON | CCCR_DAR |
1306 FIELD_PREP(CCCR_CMR_MASK, FIELD_MAX(CCCR_CMR_MASK)) |
1307 FIELD_PREP(CCCR_CME_MASK, FIELD_MAX(CCCR_CME_MASK)));
1309 if (cdev->can.ctrlmode & CAN_CTRLMODE_FD)
1310 cccr |= FIELD_PREP(CCCR_CME_MASK, CCCR_CME_CANFD_BRS);
1313 /* Version 3.1.x or 3.2.x */
1314 cccr &= ~(CCCR_TEST | CCCR_MON | CCCR_BRSE | CCCR_FDOE |
1315 CCCR_NISO | CCCR_DAR);
1317 /* Only 3.2.x has NISO Bit implemented */
1318 if (cdev->can.ctrlmode & CAN_CTRLMODE_FD_NON_ISO)
1321 if (cdev->can.ctrlmode & CAN_CTRLMODE_FD)
1322 cccr |= (CCCR_BRSE | CCCR_FDOE);
1326 if (cdev->can.ctrlmode & CAN_CTRLMODE_LOOPBACK) {
1327 cccr |= CCCR_TEST | CCCR_MON;
1331 /* Enable Monitoring (all versions) */
1332 if (cdev->can.ctrlmode & CAN_CTRLMODE_LISTENONLY)
1335 /* Disable Auto Retransmission (all versions) */
1336 if (cdev->can.ctrlmode & CAN_CTRLMODE_ONE_SHOT)
1340 m_can_write(cdev, M_CAN_CCCR, cccr);
1341 m_can_write(cdev, M_CAN_TEST, test);
1343 /* Enable interrupts */
1344 m_can_write(cdev, M_CAN_IR, IR_ALL_INT);
1345 if (!(cdev->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING))
1346 if (cdev->version == 30)
1347 m_can_write(cdev, M_CAN_IE, IR_ALL_INT &
1350 m_can_write(cdev, M_CAN_IE, IR_ALL_INT &
1353 m_can_write(cdev, M_CAN_IE, IR_ALL_INT);
1355 /* route all interrupts to INT0 */
1356 m_can_write(cdev, M_CAN_ILS, ILS_ALL_INT0);
1358 /* set bittiming params */
1359 m_can_set_bittiming(dev);
1361 /* enable internal timestamp generation, with a prescalar of 16. The
1362 * prescalar is applied to the nominal bit timing
1364 m_can_write(cdev, M_CAN_TSCC, FIELD_PREP(TSCC_TCP_MASK, 0xf));
1366 m_can_config_endisable(cdev, false);
1368 if (cdev->ops->init)
1369 cdev->ops->init(cdev);
1372 static void m_can_start(struct net_device *dev)
1374 struct m_can_classdev *cdev = netdev_priv(dev);
1376 /* basic m_can configuration */
1377 m_can_chip_config(dev);
1379 cdev->can.state = CAN_STATE_ERROR_ACTIVE;
1381 m_can_enable_all_interrupts(cdev);
1384 static int m_can_set_mode(struct net_device *dev, enum can_mode mode)
1387 case CAN_MODE_START:
1390 netif_wake_queue(dev);
1399 /* Checks core release number of M_CAN
1400 * returns 0 if an unsupported device is detected
1401 * else it returns the release and step coded as:
1402 * return value = 10 * <release> + 1 * <step>
1404 static int m_can_check_core_release(struct m_can_classdev *cdev)
1411 /* Read Core Release Version and split into version number
1412 * Example: Version 3.2.1 => rel = 3; step = 2; substep = 1;
1414 crel_reg = m_can_read(cdev, M_CAN_CREL);
1415 rel = (u8)FIELD_GET(CREL_REL_MASK, crel_reg);
1416 step = (u8)FIELD_GET(CREL_STEP_MASK, crel_reg);
1419 /* M_CAN v3.x.y: create return value */
1422 /* Unsupported M_CAN version */
1429 /* Selectable Non ISO support only in version 3.2.x
1430 * This function checks if the bit is writable.
1432 static bool m_can_niso_supported(struct m_can_classdev *cdev)
1434 u32 cccr_reg, cccr_poll = 0;
1435 int niso_timeout = -ETIMEDOUT;
1438 m_can_config_endisable(cdev, true);
1439 cccr_reg = m_can_read(cdev, M_CAN_CCCR);
1440 cccr_reg |= CCCR_NISO;
1441 m_can_write(cdev, M_CAN_CCCR, cccr_reg);
1443 for (i = 0; i <= 10; i++) {
1444 cccr_poll = m_can_read(cdev, M_CAN_CCCR);
1445 if (cccr_poll == cccr_reg) {
1454 cccr_reg &= ~(CCCR_NISO);
1455 m_can_write(cdev, M_CAN_CCCR, cccr_reg);
1457 m_can_config_endisable(cdev, false);
1459 /* return false if time out (-ETIMEDOUT), else return true */
1460 return !niso_timeout;
1463 static int m_can_dev_setup(struct m_can_classdev *cdev)
1465 struct net_device *dev = cdev->net;
1468 m_can_version = m_can_check_core_release(cdev);
1469 /* return if unsupported version */
1470 if (!m_can_version) {
1471 dev_err(cdev->dev, "Unsupported version number: %2d",
1476 if (!cdev->is_peripheral)
1477 netif_napi_add(dev, &cdev->napi,
1478 m_can_poll, M_CAN_NAPI_WEIGHT);
1480 /* Shared properties of all M_CAN versions */
1481 cdev->version = m_can_version;
1482 cdev->can.do_set_mode = m_can_set_mode;
1483 cdev->can.do_get_berr_counter = m_can_get_berr_counter;
1485 /* Set M_CAN supported operations */
1486 cdev->can.ctrlmode_supported = CAN_CTRLMODE_LOOPBACK |
1487 CAN_CTRLMODE_LISTENONLY |
1488 CAN_CTRLMODE_BERR_REPORTING |
1490 CAN_CTRLMODE_ONE_SHOT;
1492 /* Set properties depending on M_CAN version */
1493 switch (cdev->version) {
1495 /* CAN_CTRLMODE_FD_NON_ISO is fixed with M_CAN IP v3.0.x */
1496 can_set_static_ctrlmode(dev, CAN_CTRLMODE_FD_NON_ISO);
1497 cdev->can.bittiming_const = &m_can_bittiming_const_30X;
1498 cdev->can.data_bittiming_const = &m_can_data_bittiming_const_30X;
1501 /* CAN_CTRLMODE_FD_NON_ISO is fixed with M_CAN IP v3.1.x */
1502 can_set_static_ctrlmode(dev, CAN_CTRLMODE_FD_NON_ISO);
1503 cdev->can.bittiming_const = &m_can_bittiming_const_31X;
1504 cdev->can.data_bittiming_const = &m_can_data_bittiming_const_31X;
1508 /* Support both MCAN version v3.2.x and v3.3.0 */
1509 cdev->can.bittiming_const = &m_can_bittiming_const_31X;
1510 cdev->can.data_bittiming_const = &m_can_data_bittiming_const_31X;
1512 cdev->can.ctrlmode_supported |=
1513 (m_can_niso_supported(cdev) ?
1514 CAN_CTRLMODE_FD_NON_ISO : 0);
1517 dev_err(cdev->dev, "Unsupported version number: %2d",
1522 if (cdev->ops->init)
1523 cdev->ops->init(cdev);
1528 static void m_can_stop(struct net_device *dev)
1530 struct m_can_classdev *cdev = netdev_priv(dev);
1532 /* disable all interrupts */
1533 m_can_disable_all_interrupts(cdev);
1535 /* Set init mode to disengage from the network */
1536 m_can_config_endisable(cdev, true);
1538 /* set the state as STOPPED */
1539 cdev->can.state = CAN_STATE_STOPPED;
1542 static int m_can_close(struct net_device *dev)
1544 struct m_can_classdev *cdev = netdev_priv(dev);
1546 netif_stop_queue(dev);
1548 if (!cdev->is_peripheral)
1549 napi_disable(&cdev->napi);
1552 m_can_clk_stop(cdev);
1553 free_irq(dev->irq, dev);
1555 if (cdev->is_peripheral) {
1556 cdev->tx_skb = NULL;
1557 destroy_workqueue(cdev->tx_wq);
1561 if (cdev->is_peripheral)
1562 can_rx_offload_disable(&cdev->offload);
1565 can_led_event(dev, CAN_LED_EVENT_STOP);
1567 phy_power_off(cdev->transceiver);
1572 static int m_can_next_echo_skb_occupied(struct net_device *dev, int putidx)
1574 struct m_can_classdev *cdev = netdev_priv(dev);
1575 /*get wrap around for loopback skb index */
1576 unsigned int wrap = cdev->can.echo_skb_max;
1579 /* calculate next index */
1580 next_idx = (++putidx >= wrap ? 0 : putidx);
1582 /* check if occupied */
1583 return !!cdev->can.echo_skb[next_idx];
1586 static netdev_tx_t m_can_tx_handler(struct m_can_classdev *cdev)
1588 struct canfd_frame *cf = (struct canfd_frame *)cdev->tx_skb->data;
1589 struct net_device *dev = cdev->net;
1590 struct sk_buff *skb = cdev->tx_skb;
1591 u32 id, dlc, cccr, fdflags;
1595 cdev->tx_skb = NULL;
1597 /* Generate ID field for TX buffer Element */
1598 /* Common to all supported M_CAN versions */
1599 if (cf->can_id & CAN_EFF_FLAG) {
1600 id = cf->can_id & CAN_EFF_MASK;
1603 id = ((cf->can_id & CAN_SFF_MASK) << 18);
1606 if (cf->can_id & CAN_RTR_FLAG)
1609 if (cdev->version == 30) {
1610 netif_stop_queue(dev);
1612 /* message ram configuration */
1613 err = m_can_fifo_write(cdev, 0, M_CAN_FIFO_ID, &id, 1);
1617 dlc = can_fd_len2dlc(cf->len) << 16;
1618 err = m_can_fifo_write(cdev, 0, M_CAN_FIFO_DLC, &dlc, 1);
1622 for (i = 0; i < cf->len; i += 4) {
1623 err = m_can_fifo_write(cdev, 0, M_CAN_FIFO_DATA(i / 4), cf->data + i, 1);
1628 can_put_echo_skb(skb, dev, 0, 0);
1630 if (cdev->can.ctrlmode & CAN_CTRLMODE_FD) {
1631 cccr = m_can_read(cdev, M_CAN_CCCR);
1632 cccr &= ~CCCR_CMR_MASK;
1633 if (can_is_canfd_skb(skb)) {
1634 if (cf->flags & CANFD_BRS)
1635 cccr |= FIELD_PREP(CCCR_CMR_MASK,
1636 CCCR_CMR_CANFD_BRS);
1638 cccr |= FIELD_PREP(CCCR_CMR_MASK,
1641 cccr |= FIELD_PREP(CCCR_CMR_MASK, CCCR_CMR_CAN);
1643 m_can_write(cdev, M_CAN_CCCR, cccr);
1645 m_can_write(cdev, M_CAN_TXBTIE, 0x1);
1646 m_can_write(cdev, M_CAN_TXBAR, 0x1);
1647 /* End of xmit function for version 3.0.x */
1649 /* Transmit routine for version >= v3.1.x */
1651 /* Check if FIFO full */
1652 if (m_can_tx_fifo_full(cdev)) {
1653 /* This shouldn't happen */
1654 netif_stop_queue(dev);
1656 "TX queue active although FIFO is full.");
1658 if (cdev->is_peripheral) {
1660 dev->stats.tx_dropped++;
1661 return NETDEV_TX_OK;
1663 return NETDEV_TX_BUSY;
1667 /* get put index for frame */
1668 putidx = FIELD_GET(TXFQS_TFQPI_MASK,
1669 m_can_read(cdev, M_CAN_TXFQS));
1670 /* Write ID Field to FIFO Element */
1671 err = m_can_fifo_write(cdev, putidx, M_CAN_FIFO_ID, &id, 1);
1675 /* get CAN FD configuration of frame */
1677 if (can_is_canfd_skb(skb)) {
1678 fdflags |= TX_BUF_FDF;
1679 if (cf->flags & CANFD_BRS)
1680 fdflags |= TX_BUF_BRS;
1683 /* Construct DLC Field. Also contains CAN-FD configuration
1684 * use put index of fifo as message marker
1685 * it is used in TX interrupt for
1686 * sending the correct echo frame
1688 dlc = FIELD_PREP(TX_BUF_MM_MASK, putidx) |
1689 FIELD_PREP(TX_BUF_DLC_MASK, can_fd_len2dlc(cf->len)) |
1690 fdflags | TX_BUF_EFC;
1691 err = m_can_fifo_write(cdev, putidx, M_CAN_FIFO_DLC, &dlc, 1);
1695 for (i = 0; i < cf->len; i += 4) {
1696 err = m_can_fifo_write(cdev, putidx, M_CAN_FIFO_DATA(i / 4),
1702 /* Push loopback echo.
1703 * Will be looped back on TX interrupt based on message marker
1705 can_put_echo_skb(skb, dev, putidx, 0);
1707 /* Enable TX FIFO element to start transfer */
1708 m_can_write(cdev, M_CAN_TXBAR, (1 << putidx));
1710 /* stop network queue if fifo full */
1711 if (m_can_tx_fifo_full(cdev) ||
1712 m_can_next_echo_skb_occupied(dev, putidx))
1713 netif_stop_queue(dev);
1716 return NETDEV_TX_OK;
1719 netdev_err(dev, "FIFO write returned %d\n", err);
1720 m_can_disable_all_interrupts(cdev);
1721 return NETDEV_TX_BUSY;
1724 static void m_can_tx_work_queue(struct work_struct *ws)
1726 struct m_can_classdev *cdev = container_of(ws, struct m_can_classdev,
1729 m_can_tx_handler(cdev);
1732 static netdev_tx_t m_can_start_xmit(struct sk_buff *skb,
1733 struct net_device *dev)
1735 struct m_can_classdev *cdev = netdev_priv(dev);
1737 if (can_dropped_invalid_skb(dev, skb))
1738 return NETDEV_TX_OK;
1740 if (cdev->is_peripheral) {
1742 netdev_err(dev, "hard_xmit called while tx busy\n");
1743 return NETDEV_TX_BUSY;
1746 if (cdev->can.state == CAN_STATE_BUS_OFF) {
1749 /* Need to stop the queue to avoid numerous requests
1750 * from being sent. Suggested improvement is to create
1751 * a queueing mechanism that will queue the skbs and
1752 * process them in order.
1755 netif_stop_queue(cdev->net);
1756 queue_work(cdev->tx_wq, &cdev->tx_work);
1760 return m_can_tx_handler(cdev);
1763 return NETDEV_TX_OK;
1766 static int m_can_open(struct net_device *dev)
1768 struct m_can_classdev *cdev = netdev_priv(dev);
1771 err = phy_power_on(cdev->transceiver);
1775 err = m_can_clk_start(cdev);
1777 goto out_phy_power_off;
1779 /* open the can device */
1780 err = open_candev(dev);
1782 netdev_err(dev, "failed to open can device\n");
1783 goto exit_disable_clks;
1786 if (cdev->is_peripheral)
1787 can_rx_offload_enable(&cdev->offload);
1789 /* register interrupt handler */
1790 if (cdev->is_peripheral) {
1791 cdev->tx_skb = NULL;
1792 cdev->tx_wq = alloc_workqueue("mcan_wq",
1793 WQ_FREEZABLE | WQ_MEM_RECLAIM, 0);
1799 INIT_WORK(&cdev->tx_work, m_can_tx_work_queue);
1801 err = request_threaded_irq(dev->irq, NULL, m_can_isr,
1805 err = request_irq(dev->irq, m_can_isr, IRQF_SHARED, dev->name,
1810 netdev_err(dev, "failed to request interrupt\n");
1814 /* start the m_can controller */
1817 can_led_event(dev, CAN_LED_EVENT_OPEN);
1819 if (!cdev->is_peripheral)
1820 napi_enable(&cdev->napi);
1822 netif_start_queue(dev);
1827 if (cdev->is_peripheral)
1828 destroy_workqueue(cdev->tx_wq);
1830 if (cdev->is_peripheral)
1831 can_rx_offload_disable(&cdev->offload);
1834 m_can_clk_stop(cdev);
1836 phy_power_off(cdev->transceiver);
1840 static const struct net_device_ops m_can_netdev_ops = {
1841 .ndo_open = m_can_open,
1842 .ndo_stop = m_can_close,
1843 .ndo_start_xmit = m_can_start_xmit,
1844 .ndo_change_mtu = can_change_mtu,
1847 static int register_m_can_dev(struct net_device *dev)
1849 dev->flags |= IFF_ECHO; /* we support local echo */
1850 dev->netdev_ops = &m_can_netdev_ops;
1852 return register_candev(dev);
1855 static void m_can_of_parse_mram(struct m_can_classdev *cdev,
1856 const u32 *mram_config_vals)
1858 cdev->mcfg[MRAM_SIDF].off = mram_config_vals[0];
1859 cdev->mcfg[MRAM_SIDF].num = mram_config_vals[1];
1860 cdev->mcfg[MRAM_XIDF].off = cdev->mcfg[MRAM_SIDF].off +
1861 cdev->mcfg[MRAM_SIDF].num * SIDF_ELEMENT_SIZE;
1862 cdev->mcfg[MRAM_XIDF].num = mram_config_vals[2];
1863 cdev->mcfg[MRAM_RXF0].off = cdev->mcfg[MRAM_XIDF].off +
1864 cdev->mcfg[MRAM_XIDF].num * XIDF_ELEMENT_SIZE;
1865 cdev->mcfg[MRAM_RXF0].num = mram_config_vals[3] &
1866 FIELD_MAX(RXFC_FS_MASK);
1867 cdev->mcfg[MRAM_RXF1].off = cdev->mcfg[MRAM_RXF0].off +
1868 cdev->mcfg[MRAM_RXF0].num * RXF0_ELEMENT_SIZE;
1869 cdev->mcfg[MRAM_RXF1].num = mram_config_vals[4] &
1870 FIELD_MAX(RXFC_FS_MASK);
1871 cdev->mcfg[MRAM_RXB].off = cdev->mcfg[MRAM_RXF1].off +
1872 cdev->mcfg[MRAM_RXF1].num * RXF1_ELEMENT_SIZE;
1873 cdev->mcfg[MRAM_RXB].num = mram_config_vals[5];
1874 cdev->mcfg[MRAM_TXE].off = cdev->mcfg[MRAM_RXB].off +
1875 cdev->mcfg[MRAM_RXB].num * RXB_ELEMENT_SIZE;
1876 cdev->mcfg[MRAM_TXE].num = mram_config_vals[6];
1877 cdev->mcfg[MRAM_TXB].off = cdev->mcfg[MRAM_TXE].off +
1878 cdev->mcfg[MRAM_TXE].num * TXE_ELEMENT_SIZE;
1879 cdev->mcfg[MRAM_TXB].num = mram_config_vals[7] &
1880 FIELD_MAX(TXBC_NDTB_MASK);
1883 "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",
1884 cdev->mcfg[MRAM_SIDF].off, cdev->mcfg[MRAM_SIDF].num,
1885 cdev->mcfg[MRAM_XIDF].off, cdev->mcfg[MRAM_XIDF].num,
1886 cdev->mcfg[MRAM_RXF0].off, cdev->mcfg[MRAM_RXF0].num,
1887 cdev->mcfg[MRAM_RXF1].off, cdev->mcfg[MRAM_RXF1].num,
1888 cdev->mcfg[MRAM_RXB].off, cdev->mcfg[MRAM_RXB].num,
1889 cdev->mcfg[MRAM_TXE].off, cdev->mcfg[MRAM_TXE].num,
1890 cdev->mcfg[MRAM_TXB].off, cdev->mcfg[MRAM_TXB].num);
1893 int m_can_init_ram(struct m_can_classdev *cdev)
1898 /* initialize the entire Message RAM in use to avoid possible
1899 * ECC/parity checksum errors when reading an uninitialized buffer
1901 start = cdev->mcfg[MRAM_SIDF].off;
1902 end = cdev->mcfg[MRAM_TXB].off +
1903 cdev->mcfg[MRAM_TXB].num * TXB_ELEMENT_SIZE;
1905 for (i = start; i < end; i += 4) {
1906 err = m_can_fifo_write_no_off(cdev, i, 0x0);
1913 EXPORT_SYMBOL_GPL(m_can_init_ram);
1915 int m_can_class_get_clocks(struct m_can_classdev *cdev)
1919 cdev->hclk = devm_clk_get(cdev->dev, "hclk");
1920 cdev->cclk = devm_clk_get(cdev->dev, "cclk");
1922 if (IS_ERR(cdev->cclk)) {
1923 dev_err(cdev->dev, "no clock found\n");
1929 EXPORT_SYMBOL_GPL(m_can_class_get_clocks);
1931 struct m_can_classdev *m_can_class_allocate_dev(struct device *dev,
1934 struct m_can_classdev *class_dev = NULL;
1935 u32 mram_config_vals[MRAM_CFG_LEN];
1936 struct net_device *net_dev;
1940 ret = fwnode_property_read_u32_array(dev_fwnode(dev),
1943 sizeof(mram_config_vals) / 4);
1945 dev_err(dev, "Could not get Message RAM configuration.");
1950 * Defines the total amount of echo buffers for loopback
1952 tx_fifo_size = mram_config_vals[7];
1954 /* allocate the m_can device */
1955 net_dev = alloc_candev(sizeof_priv, tx_fifo_size);
1957 dev_err(dev, "Failed to allocate CAN device");
1961 class_dev = netdev_priv(net_dev);
1962 class_dev->net = net_dev;
1963 class_dev->dev = dev;
1964 SET_NETDEV_DEV(net_dev, dev);
1966 m_can_of_parse_mram(class_dev, mram_config_vals);
1970 EXPORT_SYMBOL_GPL(m_can_class_allocate_dev);
1972 void m_can_class_free_dev(struct net_device *net)
1976 EXPORT_SYMBOL_GPL(m_can_class_free_dev);
1978 int m_can_class_register(struct m_can_classdev *cdev)
1982 if (cdev->pm_clock_support) {
1983 ret = m_can_clk_start(cdev);
1988 if (cdev->is_peripheral) {
1989 ret = can_rx_offload_add_manual(cdev->net, &cdev->offload,
1995 ret = m_can_dev_setup(cdev);
1997 goto rx_offload_del;
1999 ret = register_m_can_dev(cdev->net);
2001 dev_err(cdev->dev, "registering %s failed (err=%d)\n",
2002 cdev->net->name, ret);
2003 goto rx_offload_del;
2006 devm_can_led_init(cdev->net);
2008 of_can_transceiver(cdev->net);
2010 dev_info(cdev->dev, "%s device registered (irq=%d, version=%d)\n",
2011 KBUILD_MODNAME, cdev->net->irq, cdev->version);
2014 * Stop clocks. They will be reactivated once the M_CAN device is opened
2016 m_can_clk_stop(cdev);
2021 if (cdev->is_peripheral)
2022 can_rx_offload_del(&cdev->offload);
2024 m_can_clk_stop(cdev);
2028 EXPORT_SYMBOL_GPL(m_can_class_register);
2030 void m_can_class_unregister(struct m_can_classdev *cdev)
2032 if (cdev->is_peripheral)
2033 can_rx_offload_del(&cdev->offload);
2034 unregister_candev(cdev->net);
2036 EXPORT_SYMBOL_GPL(m_can_class_unregister);
2038 int m_can_class_suspend(struct device *dev)
2040 struct m_can_classdev *cdev = dev_get_drvdata(dev);
2041 struct net_device *ndev = cdev->net;
2043 if (netif_running(ndev)) {
2044 netif_stop_queue(ndev);
2045 netif_device_detach(ndev);
2047 m_can_clk_stop(cdev);
2050 pinctrl_pm_select_sleep_state(dev);
2052 cdev->can.state = CAN_STATE_SLEEPING;
2056 EXPORT_SYMBOL_GPL(m_can_class_suspend);
2058 int m_can_class_resume(struct device *dev)
2060 struct m_can_classdev *cdev = dev_get_drvdata(dev);
2061 struct net_device *ndev = cdev->net;
2063 pinctrl_pm_select_default_state(dev);
2065 cdev->can.state = CAN_STATE_ERROR_ACTIVE;
2067 if (netif_running(ndev)) {
2070 ret = m_can_clk_start(cdev);
2074 m_can_init_ram(cdev);
2076 netif_device_attach(ndev);
2077 netif_start_queue(ndev);
2082 EXPORT_SYMBOL_GPL(m_can_class_resume);
2084 MODULE_AUTHOR("Dong Aisheng <b29396@freescale.com>");
2085 MODULE_AUTHOR("Dan Murphy <dmurphy@ti.com>");
2086 MODULE_LICENSE("GPL v2");
2087 MODULE_DESCRIPTION("CAN bus driver for Bosch M_CAN controller");