can: rcar_can: unify error messages
[linux-2.6/btrfs-unstable.git] / drivers / net / can / rcar_can.c
blob7bd54191f962a4ad3079eabdcefb0d001a14bf0b
1 /* Renesas R-Car CAN device driver
3 * Copyright (C) 2013 Cogent Embedded, Inc. <source@cogentembedded.com>
4 * Copyright (C) 2013 Renesas Solutions Corp.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/types.h>
15 #include <linux/interrupt.h>
16 #include <linux/errno.h>
17 #include <linux/netdevice.h>
18 #include <linux/platform_device.h>
19 #include <linux/can/led.h>
20 #include <linux/can/dev.h>
21 #include <linux/clk.h>
22 #include <linux/can/platform/rcar_can.h>
23 #include <linux/of.h>
25 #define RCAR_CAN_DRV_NAME "rcar_can"
27 /* Mailbox configuration:
28 * mailbox 60 - 63 - Rx FIFO mailboxes
29 * mailbox 56 - 59 - Tx FIFO mailboxes
30 * non-FIFO mailboxes are not used
32 #define RCAR_CAN_N_MBX 64 /* Number of mailboxes in non-FIFO mode */
33 #define RCAR_CAN_RX_FIFO_MBX 60 /* Mailbox - window to Rx FIFO */
34 #define RCAR_CAN_TX_FIFO_MBX 56 /* Mailbox - window to Tx FIFO */
35 #define RCAR_CAN_FIFO_DEPTH 4
37 /* Mailbox registers structure */
38 struct rcar_can_mbox_regs {
39 u32 id; /* IDE and RTR bits, SID and EID */
40 u8 stub; /* Not used */
41 u8 dlc; /* Data Length Code - bits [0..3] */
42 u8 data[8]; /* Data Bytes */
43 u8 tsh; /* Time Stamp Higher Byte */
44 u8 tsl; /* Time Stamp Lower Byte */
47 struct rcar_can_regs {
48 struct rcar_can_mbox_regs mb[RCAR_CAN_N_MBX]; /* Mailbox registers */
49 u32 mkr_2_9[8]; /* Mask Registers 2-9 */
50 u32 fidcr[2]; /* FIFO Received ID Compare Register */
51 u32 mkivlr1; /* Mask Invalid Register 1 */
52 u32 mier1; /* Mailbox Interrupt Enable Register 1 */
53 u32 mkr_0_1[2]; /* Mask Registers 0-1 */
54 u32 mkivlr0; /* Mask Invalid Register 0*/
55 u32 mier0; /* Mailbox Interrupt Enable Register 0 */
56 u8 pad_440[0x3c0];
57 u8 mctl[64]; /* Message Control Registers */
58 u16 ctlr; /* Control Register */
59 u16 str; /* Status register */
60 u8 bcr[3]; /* Bit Configuration Register */
61 u8 clkr; /* Clock Select Register */
62 u8 rfcr; /* Receive FIFO Control Register */
63 u8 rfpcr; /* Receive FIFO Pointer Control Register */
64 u8 tfcr; /* Transmit FIFO Control Register */
65 u8 tfpcr; /* Transmit FIFO Pointer Control Register */
66 u8 eier; /* Error Interrupt Enable Register */
67 u8 eifr; /* Error Interrupt Factor Judge Register */
68 u8 recr; /* Receive Error Count Register */
69 u8 tecr; /* Transmit Error Count Register */
70 u8 ecsr; /* Error Code Store Register */
71 u8 cssr; /* Channel Search Support Register */
72 u8 mssr; /* Mailbox Search Status Register */
73 u8 msmr; /* Mailbox Search Mode Register */
74 u16 tsr; /* Time Stamp Register */
75 u8 afsr; /* Acceptance Filter Support Register */
76 u8 pad_857;
77 u8 tcr; /* Test Control Register */
78 u8 pad_859[7];
79 u8 ier; /* Interrupt Enable Register */
80 u8 isr; /* Interrupt Status Register */
81 u8 pad_862;
82 u8 mbsmr; /* Mailbox Search Mask Register */
85 struct rcar_can_priv {
86 struct can_priv can; /* Must be the first member! */
87 struct net_device *ndev;
88 struct napi_struct napi;
89 struct rcar_can_regs __iomem *regs;
90 struct clk *clk;
91 struct clk *can_clk;
92 u8 tx_dlc[RCAR_CAN_FIFO_DEPTH];
93 u32 tx_head;
94 u32 tx_tail;
95 u8 clock_select;
96 u8 ier;
99 static const struct can_bittiming_const rcar_can_bittiming_const = {
100 .name = RCAR_CAN_DRV_NAME,
101 .tseg1_min = 4,
102 .tseg1_max = 16,
103 .tseg2_min = 2,
104 .tseg2_max = 8,
105 .sjw_max = 4,
106 .brp_min = 1,
107 .brp_max = 1024,
108 .brp_inc = 1,
111 /* Control Register bits */
112 #define RCAR_CAN_CTLR_BOM (3 << 11) /* Bus-Off Recovery Mode Bits */
113 #define RCAR_CAN_CTLR_BOM_ENT (1 << 11) /* Entry to halt mode */
114 /* at bus-off entry */
115 #define RCAR_CAN_CTLR_SLPM (1 << 10)
116 #define RCAR_CAN_CTLR_CANM (3 << 8) /* Operating Mode Select Bit */
117 #define RCAR_CAN_CTLR_CANM_HALT (1 << 9)
118 #define RCAR_CAN_CTLR_CANM_RESET (1 << 8)
119 #define RCAR_CAN_CTLR_CANM_FORCE_RESET (3 << 8)
120 #define RCAR_CAN_CTLR_MLM (1 << 3) /* Message Lost Mode Select */
121 #define RCAR_CAN_CTLR_IDFM (3 << 1) /* ID Format Mode Select Bits */
122 #define RCAR_CAN_CTLR_IDFM_MIXED (1 << 2) /* Mixed ID mode */
123 #define RCAR_CAN_CTLR_MBM (1 << 0) /* Mailbox Mode select */
125 /* Status Register bits */
126 #define RCAR_CAN_STR_RSTST (1 << 8) /* Reset Status Bit */
128 /* FIFO Received ID Compare Registers 0 and 1 bits */
129 #define RCAR_CAN_FIDCR_IDE (1 << 31) /* ID Extension Bit */
130 #define RCAR_CAN_FIDCR_RTR (1 << 30) /* Remote Transmission Request Bit */
132 /* Receive FIFO Control Register bits */
133 #define RCAR_CAN_RFCR_RFEST (1 << 7) /* Receive FIFO Empty Status Flag */
134 #define RCAR_CAN_RFCR_RFE (1 << 0) /* Receive FIFO Enable */
136 /* Transmit FIFO Control Register bits */
137 #define RCAR_CAN_TFCR_TFUST (7 << 1) /* Transmit FIFO Unsent Message */
138 /* Number Status Bits */
139 #define RCAR_CAN_TFCR_TFUST_SHIFT 1 /* Offset of Transmit FIFO Unsent */
140 /* Message Number Status Bits */
141 #define RCAR_CAN_TFCR_TFE (1 << 0) /* Transmit FIFO Enable */
143 #define RCAR_CAN_N_RX_MKREGS1 2 /* Number of mask registers */
144 /* for Rx mailboxes 0-31 */
145 #define RCAR_CAN_N_RX_MKREGS2 8
147 /* Bit Configuration Register settings */
148 #define RCAR_CAN_BCR_TSEG1(x) (((x) & 0x0f) << 20)
149 #define RCAR_CAN_BCR_BPR(x) (((x) & 0x3ff) << 8)
150 #define RCAR_CAN_BCR_SJW(x) (((x) & 0x3) << 4)
151 #define RCAR_CAN_BCR_TSEG2(x) ((x) & 0x07)
153 /* Mailbox and Mask Registers bits */
154 #define RCAR_CAN_IDE (1 << 31)
155 #define RCAR_CAN_RTR (1 << 30)
156 #define RCAR_CAN_SID_SHIFT 18
158 /* Mailbox Interrupt Enable Register 1 bits */
159 #define RCAR_CAN_MIER1_RXFIE (1 << 28) /* Receive FIFO Interrupt Enable */
160 #define RCAR_CAN_MIER1_TXFIE (1 << 24) /* Transmit FIFO Interrupt Enable */
162 /* Interrupt Enable Register bits */
163 #define RCAR_CAN_IER_ERSIE (1 << 5) /* Error (ERS) Interrupt Enable Bit */
164 #define RCAR_CAN_IER_RXFIE (1 << 4) /* Reception FIFO Interrupt */
165 /* Enable Bit */
166 #define RCAR_CAN_IER_TXFIE (1 << 3) /* Transmission FIFO Interrupt */
167 /* Enable Bit */
168 /* Interrupt Status Register bits */
169 #define RCAR_CAN_ISR_ERSF (1 << 5) /* Error (ERS) Interrupt Status Bit */
170 #define RCAR_CAN_ISR_RXFF (1 << 4) /* Reception FIFO Interrupt */
171 /* Status Bit */
172 #define RCAR_CAN_ISR_TXFF (1 << 3) /* Transmission FIFO Interrupt */
173 /* Status Bit */
175 /* Error Interrupt Enable Register bits */
176 #define RCAR_CAN_EIER_BLIE (1 << 7) /* Bus Lock Interrupt Enable */
177 #define RCAR_CAN_EIER_OLIE (1 << 6) /* Overload Frame Transmit */
178 /* Interrupt Enable */
179 #define RCAR_CAN_EIER_ORIE (1 << 5) /* Receive Overrun Interrupt Enable */
180 #define RCAR_CAN_EIER_BORIE (1 << 4) /* Bus-Off Recovery Interrupt Enable */
181 #define RCAR_CAN_EIER_BOEIE (1 << 3) /* Bus-Off Entry Interrupt Enable */
182 #define RCAR_CAN_EIER_EPIE (1 << 2) /* Error Passive Interrupt Enable */
183 #define RCAR_CAN_EIER_EWIE (1 << 1) /* Error Warning Interrupt Enable */
184 #define RCAR_CAN_EIER_BEIE (1 << 0) /* Bus Error Interrupt Enable */
186 /* Error Interrupt Factor Judge Register bits */
187 #define RCAR_CAN_EIFR_BLIF (1 << 7) /* Bus Lock Detect Flag */
188 #define RCAR_CAN_EIFR_OLIF (1 << 6) /* Overload Frame Transmission */
189 /* Detect Flag */
190 #define RCAR_CAN_EIFR_ORIF (1 << 5) /* Receive Overrun Detect Flag */
191 #define RCAR_CAN_EIFR_BORIF (1 << 4) /* Bus-Off Recovery Detect Flag */
192 #define RCAR_CAN_EIFR_BOEIF (1 << 3) /* Bus-Off Entry Detect Flag */
193 #define RCAR_CAN_EIFR_EPIF (1 << 2) /* Error Passive Detect Flag */
194 #define RCAR_CAN_EIFR_EWIF (1 << 1) /* Error Warning Detect Flag */
195 #define RCAR_CAN_EIFR_BEIF (1 << 0) /* Bus Error Detect Flag */
197 /* Error Code Store Register bits */
198 #define RCAR_CAN_ECSR_EDPM (1 << 7) /* Error Display Mode Select Bit */
199 #define RCAR_CAN_ECSR_ADEF (1 << 6) /* ACK Delimiter Error Flag */
200 #define RCAR_CAN_ECSR_BE0F (1 << 5) /* Bit Error (dominant) Flag */
201 #define RCAR_CAN_ECSR_BE1F (1 << 4) /* Bit Error (recessive) Flag */
202 #define RCAR_CAN_ECSR_CEF (1 << 3) /* CRC Error Flag */
203 #define RCAR_CAN_ECSR_AEF (1 << 2) /* ACK Error Flag */
204 #define RCAR_CAN_ECSR_FEF (1 << 1) /* Form Error Flag */
205 #define RCAR_CAN_ECSR_SEF (1 << 0) /* Stuff Error Flag */
207 #define RCAR_CAN_NAPI_WEIGHT 4
208 #define MAX_STR_READS 0x100
210 static void tx_failure_cleanup(struct net_device *ndev)
212 int i;
214 for (i = 0; i < RCAR_CAN_FIFO_DEPTH; i++)
215 can_free_echo_skb(ndev, i);
218 static void rcar_can_error(struct net_device *ndev)
220 struct rcar_can_priv *priv = netdev_priv(ndev);
221 struct net_device_stats *stats = &ndev->stats;
222 struct can_frame *cf;
223 struct sk_buff *skb;
224 u8 eifr, txerr = 0, rxerr = 0;
226 /* Propagate the error condition to the CAN stack */
227 skb = alloc_can_err_skb(ndev, &cf);
229 eifr = readb(&priv->regs->eifr);
230 if (eifr & (RCAR_CAN_EIFR_EWIF | RCAR_CAN_EIFR_EPIF)) {
231 txerr = readb(&priv->regs->tecr);
232 rxerr = readb(&priv->regs->recr);
233 if (skb) {
234 cf->can_id |= CAN_ERR_CRTL;
235 cf->data[6] = txerr;
236 cf->data[7] = rxerr;
239 if (eifr & RCAR_CAN_EIFR_BEIF) {
240 int rx_errors = 0, tx_errors = 0;
241 u8 ecsr;
243 netdev_dbg(priv->ndev, "Bus error interrupt:\n");
244 if (skb) {
245 cf->can_id |= CAN_ERR_BUSERROR | CAN_ERR_PROT;
246 cf->data[2] = CAN_ERR_PROT_UNSPEC;
248 ecsr = readb(&priv->regs->ecsr);
249 if (ecsr & RCAR_CAN_ECSR_ADEF) {
250 netdev_dbg(priv->ndev, "ACK Delimiter Error\n");
251 tx_errors++;
252 writeb(~RCAR_CAN_ECSR_ADEF, &priv->regs->ecsr);
253 if (skb)
254 cf->data[3] |= CAN_ERR_PROT_LOC_ACK_DEL;
256 if (ecsr & RCAR_CAN_ECSR_BE0F) {
257 netdev_dbg(priv->ndev, "Bit Error (dominant)\n");
258 tx_errors++;
259 writeb(~RCAR_CAN_ECSR_BE0F, &priv->regs->ecsr);
260 if (skb)
261 cf->data[2] |= CAN_ERR_PROT_BIT0;
263 if (ecsr & RCAR_CAN_ECSR_BE1F) {
264 netdev_dbg(priv->ndev, "Bit Error (recessive)\n");
265 tx_errors++;
266 writeb(~RCAR_CAN_ECSR_BE1F, &priv->regs->ecsr);
267 if (skb)
268 cf->data[2] |= CAN_ERR_PROT_BIT1;
270 if (ecsr & RCAR_CAN_ECSR_CEF) {
271 netdev_dbg(priv->ndev, "CRC Error\n");
272 rx_errors++;
273 writeb(~RCAR_CAN_ECSR_CEF, &priv->regs->ecsr);
274 if (skb)
275 cf->data[3] |= CAN_ERR_PROT_LOC_CRC_SEQ;
277 if (ecsr & RCAR_CAN_ECSR_AEF) {
278 netdev_dbg(priv->ndev, "ACK Error\n");
279 tx_errors++;
280 writeb(~RCAR_CAN_ECSR_AEF, &priv->regs->ecsr);
281 if (skb) {
282 cf->can_id |= CAN_ERR_ACK;
283 cf->data[3] |= CAN_ERR_PROT_LOC_ACK;
286 if (ecsr & RCAR_CAN_ECSR_FEF) {
287 netdev_dbg(priv->ndev, "Form Error\n");
288 rx_errors++;
289 writeb(~RCAR_CAN_ECSR_FEF, &priv->regs->ecsr);
290 if (skb)
291 cf->data[2] |= CAN_ERR_PROT_FORM;
293 if (ecsr & RCAR_CAN_ECSR_SEF) {
294 netdev_dbg(priv->ndev, "Stuff Error\n");
295 rx_errors++;
296 writeb(~RCAR_CAN_ECSR_SEF, &priv->regs->ecsr);
297 if (skb)
298 cf->data[2] |= CAN_ERR_PROT_STUFF;
301 priv->can.can_stats.bus_error++;
302 ndev->stats.rx_errors += rx_errors;
303 ndev->stats.tx_errors += tx_errors;
304 writeb(~RCAR_CAN_EIFR_BEIF, &priv->regs->eifr);
306 if (eifr & RCAR_CAN_EIFR_EWIF) {
307 netdev_dbg(priv->ndev, "Error warning interrupt\n");
308 priv->can.state = CAN_STATE_ERROR_WARNING;
309 priv->can.can_stats.error_warning++;
310 /* Clear interrupt condition */
311 writeb(~RCAR_CAN_EIFR_EWIF, &priv->regs->eifr);
312 if (skb)
313 cf->data[1] = txerr > rxerr ? CAN_ERR_CRTL_TX_WARNING :
314 CAN_ERR_CRTL_RX_WARNING;
316 if (eifr & RCAR_CAN_EIFR_EPIF) {
317 netdev_dbg(priv->ndev, "Error passive interrupt\n");
318 priv->can.state = CAN_STATE_ERROR_PASSIVE;
319 priv->can.can_stats.error_passive++;
320 /* Clear interrupt condition */
321 writeb(~RCAR_CAN_EIFR_EPIF, &priv->regs->eifr);
322 if (skb)
323 cf->data[1] = txerr > rxerr ? CAN_ERR_CRTL_TX_PASSIVE :
324 CAN_ERR_CRTL_RX_PASSIVE;
326 if (eifr & RCAR_CAN_EIFR_BOEIF) {
327 netdev_dbg(priv->ndev, "Bus-off entry interrupt\n");
328 tx_failure_cleanup(ndev);
329 priv->ier = RCAR_CAN_IER_ERSIE;
330 writeb(priv->ier, &priv->regs->ier);
331 priv->can.state = CAN_STATE_BUS_OFF;
332 /* Clear interrupt condition */
333 writeb(~RCAR_CAN_EIFR_BOEIF, &priv->regs->eifr);
334 priv->can.can_stats.bus_off++;
335 can_bus_off(ndev);
336 if (skb)
337 cf->can_id |= CAN_ERR_BUSOFF;
339 if (eifr & RCAR_CAN_EIFR_ORIF) {
340 netdev_dbg(priv->ndev, "Receive overrun error interrupt\n");
341 ndev->stats.rx_over_errors++;
342 ndev->stats.rx_errors++;
343 writeb(~RCAR_CAN_EIFR_ORIF, &priv->regs->eifr);
344 if (skb) {
345 cf->can_id |= CAN_ERR_CRTL;
346 cf->data[1] = CAN_ERR_CRTL_RX_OVERFLOW;
349 if (eifr & RCAR_CAN_EIFR_OLIF) {
350 netdev_dbg(priv->ndev,
351 "Overload Frame Transmission error interrupt\n");
352 ndev->stats.rx_over_errors++;
353 ndev->stats.rx_errors++;
354 writeb(~RCAR_CAN_EIFR_OLIF, &priv->regs->eifr);
355 if (skb) {
356 cf->can_id |= CAN_ERR_PROT;
357 cf->data[2] |= CAN_ERR_PROT_OVERLOAD;
361 if (skb) {
362 stats->rx_packets++;
363 stats->rx_bytes += cf->can_dlc;
364 netif_rx(skb);
368 static void rcar_can_tx_done(struct net_device *ndev)
370 struct rcar_can_priv *priv = netdev_priv(ndev);
371 struct net_device_stats *stats = &ndev->stats;
372 u8 isr;
374 while (1) {
375 u8 unsent = readb(&priv->regs->tfcr);
377 unsent = (unsent & RCAR_CAN_TFCR_TFUST) >>
378 RCAR_CAN_TFCR_TFUST_SHIFT;
379 if (priv->tx_head - priv->tx_tail <= unsent)
380 break;
381 stats->tx_packets++;
382 stats->tx_bytes += priv->tx_dlc[priv->tx_tail %
383 RCAR_CAN_FIFO_DEPTH];
384 priv->tx_dlc[priv->tx_tail % RCAR_CAN_FIFO_DEPTH] = 0;
385 can_get_echo_skb(ndev, priv->tx_tail % RCAR_CAN_FIFO_DEPTH);
386 priv->tx_tail++;
387 netif_wake_queue(ndev);
389 /* Clear interrupt */
390 isr = readb(&priv->regs->isr);
391 writeb(isr & ~RCAR_CAN_ISR_TXFF, &priv->regs->isr);
392 can_led_event(ndev, CAN_LED_EVENT_TX);
395 static irqreturn_t rcar_can_interrupt(int irq, void *dev_id)
397 struct net_device *ndev = dev_id;
398 struct rcar_can_priv *priv = netdev_priv(ndev);
399 u8 isr;
401 isr = readb(&priv->regs->isr);
402 if (!(isr & priv->ier))
403 return IRQ_NONE;
405 if (isr & RCAR_CAN_ISR_ERSF)
406 rcar_can_error(ndev);
408 if (isr & RCAR_CAN_ISR_TXFF)
409 rcar_can_tx_done(ndev);
411 if (isr & RCAR_CAN_ISR_RXFF) {
412 if (napi_schedule_prep(&priv->napi)) {
413 /* Disable Rx FIFO interrupts */
414 priv->ier &= ~RCAR_CAN_IER_RXFIE;
415 writeb(priv->ier, &priv->regs->ier);
416 __napi_schedule(&priv->napi);
420 return IRQ_HANDLED;
423 static void rcar_can_set_bittiming(struct net_device *dev)
425 struct rcar_can_priv *priv = netdev_priv(dev);
426 struct can_bittiming *bt = &priv->can.bittiming;
427 u32 bcr;
429 bcr = RCAR_CAN_BCR_TSEG1(bt->phase_seg1 + bt->prop_seg - 1) |
430 RCAR_CAN_BCR_BPR(bt->brp - 1) | RCAR_CAN_BCR_SJW(bt->sjw - 1) |
431 RCAR_CAN_BCR_TSEG2(bt->phase_seg2 - 1);
432 /* Don't overwrite CLKR with 32-bit BCR access; CLKR has 8-bit access.
433 * All the registers are big-endian but they get byte-swapped on 32-bit
434 * read/write (but not on 8-bit, contrary to the manuals)...
436 writel((bcr << 8) | priv->clock_select, &priv->regs->bcr);
439 static void rcar_can_start(struct net_device *ndev)
441 struct rcar_can_priv *priv = netdev_priv(ndev);
442 u16 ctlr;
443 int i;
445 /* Set controller to known mode:
446 * - FIFO mailbox mode
447 * - accept all messages
448 * - overrun mode
449 * CAN is in sleep mode after MCU hardware or software reset.
451 ctlr = readw(&priv->regs->ctlr);
452 ctlr &= ~RCAR_CAN_CTLR_SLPM;
453 writew(ctlr, &priv->regs->ctlr);
454 /* Go to reset mode */
455 ctlr |= RCAR_CAN_CTLR_CANM_FORCE_RESET;
456 writew(ctlr, &priv->regs->ctlr);
457 for (i = 0; i < MAX_STR_READS; i++) {
458 if (readw(&priv->regs->str) & RCAR_CAN_STR_RSTST)
459 break;
461 rcar_can_set_bittiming(ndev);
462 ctlr |= RCAR_CAN_CTLR_IDFM_MIXED; /* Select mixed ID mode */
463 ctlr |= RCAR_CAN_CTLR_BOM_ENT; /* Entry to halt mode automatically */
464 /* at bus-off */
465 ctlr |= RCAR_CAN_CTLR_MBM; /* Select FIFO mailbox mode */
466 ctlr |= RCAR_CAN_CTLR_MLM; /* Overrun mode */
467 writew(ctlr, &priv->regs->ctlr);
469 /* Accept all SID and EID */
470 writel(0, &priv->regs->mkr_2_9[6]);
471 writel(0, &priv->regs->mkr_2_9[7]);
472 /* In FIFO mailbox mode, write "0" to bits 24 to 31 */
473 writel(0, &priv->regs->mkivlr1);
474 /* Accept all frames */
475 writel(0, &priv->regs->fidcr[0]);
476 writel(RCAR_CAN_FIDCR_IDE | RCAR_CAN_FIDCR_RTR, &priv->regs->fidcr[1]);
477 /* Enable and configure FIFO mailbox interrupts */
478 writel(RCAR_CAN_MIER1_RXFIE | RCAR_CAN_MIER1_TXFIE, &priv->regs->mier1);
480 priv->ier = RCAR_CAN_IER_ERSIE | RCAR_CAN_IER_RXFIE |
481 RCAR_CAN_IER_TXFIE;
482 writeb(priv->ier, &priv->regs->ier);
484 /* Accumulate error codes */
485 writeb(RCAR_CAN_ECSR_EDPM, &priv->regs->ecsr);
486 /* Enable error interrupts */
487 writeb(RCAR_CAN_EIER_EWIE | RCAR_CAN_EIER_EPIE | RCAR_CAN_EIER_BOEIE |
488 (priv->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING ?
489 RCAR_CAN_EIER_BEIE : 0) | RCAR_CAN_EIER_ORIE |
490 RCAR_CAN_EIER_OLIE, &priv->regs->eier);
491 priv->can.state = CAN_STATE_ERROR_ACTIVE;
493 /* Go to operation mode */
494 writew(ctlr & ~RCAR_CAN_CTLR_CANM, &priv->regs->ctlr);
495 for (i = 0; i < MAX_STR_READS; i++) {
496 if (!(readw(&priv->regs->str) & RCAR_CAN_STR_RSTST))
497 break;
499 /* Enable Rx and Tx FIFO */
500 writeb(RCAR_CAN_RFCR_RFE, &priv->regs->rfcr);
501 writeb(RCAR_CAN_TFCR_TFE, &priv->regs->tfcr);
504 static int rcar_can_open(struct net_device *ndev)
506 struct rcar_can_priv *priv = netdev_priv(ndev);
507 int err;
509 err = clk_prepare_enable(priv->clk);
510 if (err) {
511 netdev_err(ndev,
512 "failed to enable peripheral clock, error %d\n",
513 err);
514 goto out;
516 err = clk_prepare_enable(priv->can_clk);
517 if (err) {
518 netdev_err(ndev, "failed to enable CAN clock, error %d\n",
519 err);
520 goto out_clock;
522 err = open_candev(ndev);
523 if (err) {
524 netdev_err(ndev, "open_candev() failed, error %d\n", err);
525 goto out_can_clock;
527 napi_enable(&priv->napi);
528 err = request_irq(ndev->irq, rcar_can_interrupt, 0, ndev->name, ndev);
529 if (err) {
530 netdev_err(ndev, "request_irq(%d) failed, error %d\n",
531 ndev->irq, err);
532 goto out_close;
534 can_led_event(ndev, CAN_LED_EVENT_OPEN);
535 rcar_can_start(ndev);
536 netif_start_queue(ndev);
537 return 0;
538 out_close:
539 napi_disable(&priv->napi);
540 close_candev(ndev);
541 out_can_clock:
542 clk_disable_unprepare(priv->can_clk);
543 out_clock:
544 clk_disable_unprepare(priv->clk);
545 out:
546 return err;
549 static void rcar_can_stop(struct net_device *ndev)
551 struct rcar_can_priv *priv = netdev_priv(ndev);
552 u16 ctlr;
553 int i;
555 /* Go to (force) reset mode */
556 ctlr = readw(&priv->regs->ctlr);
557 ctlr |= RCAR_CAN_CTLR_CANM_FORCE_RESET;
558 writew(ctlr, &priv->regs->ctlr);
559 for (i = 0; i < MAX_STR_READS; i++) {
560 if (readw(&priv->regs->str) & RCAR_CAN_STR_RSTST)
561 break;
563 writel(0, &priv->regs->mier0);
564 writel(0, &priv->regs->mier1);
565 writeb(0, &priv->regs->ier);
566 writeb(0, &priv->regs->eier);
567 /* Go to sleep mode */
568 ctlr |= RCAR_CAN_CTLR_SLPM;
569 writew(ctlr, &priv->regs->ctlr);
570 priv->can.state = CAN_STATE_STOPPED;
573 static int rcar_can_close(struct net_device *ndev)
575 struct rcar_can_priv *priv = netdev_priv(ndev);
577 netif_stop_queue(ndev);
578 rcar_can_stop(ndev);
579 free_irq(ndev->irq, ndev);
580 napi_disable(&priv->napi);
581 clk_disable_unprepare(priv->can_clk);
582 clk_disable_unprepare(priv->clk);
583 close_candev(ndev);
584 can_led_event(ndev, CAN_LED_EVENT_STOP);
585 return 0;
588 static netdev_tx_t rcar_can_start_xmit(struct sk_buff *skb,
589 struct net_device *ndev)
591 struct rcar_can_priv *priv = netdev_priv(ndev);
592 struct can_frame *cf = (struct can_frame *)skb->data;
593 u32 data, i;
595 if (can_dropped_invalid_skb(ndev, skb))
596 return NETDEV_TX_OK;
598 if (cf->can_id & CAN_EFF_FLAG) /* Extended frame format */
599 data = (cf->can_id & CAN_EFF_MASK) | RCAR_CAN_IDE;
600 else /* Standard frame format */
601 data = (cf->can_id & CAN_SFF_MASK) << RCAR_CAN_SID_SHIFT;
603 if (cf->can_id & CAN_RTR_FLAG) { /* Remote transmission request */
604 data |= RCAR_CAN_RTR;
605 } else {
606 for (i = 0; i < cf->can_dlc; i++)
607 writeb(cf->data[i],
608 &priv->regs->mb[RCAR_CAN_TX_FIFO_MBX].data[i]);
611 writel(data, &priv->regs->mb[RCAR_CAN_TX_FIFO_MBX].id);
613 writeb(cf->can_dlc, &priv->regs->mb[RCAR_CAN_TX_FIFO_MBX].dlc);
615 priv->tx_dlc[priv->tx_head % RCAR_CAN_FIFO_DEPTH] = cf->can_dlc;
616 can_put_echo_skb(skb, ndev, priv->tx_head % RCAR_CAN_FIFO_DEPTH);
617 priv->tx_head++;
618 /* Start Tx: write 0xff to the TFPCR register to increment
619 * the CPU-side pointer for the transmit FIFO to the next
620 * mailbox location
622 writeb(0xff, &priv->regs->tfpcr);
623 /* Stop the queue if we've filled all FIFO entries */
624 if (priv->tx_head - priv->tx_tail >= RCAR_CAN_FIFO_DEPTH)
625 netif_stop_queue(ndev);
627 return NETDEV_TX_OK;
630 static const struct net_device_ops rcar_can_netdev_ops = {
631 .ndo_open = rcar_can_open,
632 .ndo_stop = rcar_can_close,
633 .ndo_start_xmit = rcar_can_start_xmit,
634 .ndo_change_mtu = can_change_mtu,
637 static void rcar_can_rx_pkt(struct rcar_can_priv *priv)
639 struct net_device_stats *stats = &priv->ndev->stats;
640 struct can_frame *cf;
641 struct sk_buff *skb;
642 u32 data;
643 u8 dlc;
645 skb = alloc_can_skb(priv->ndev, &cf);
646 if (!skb) {
647 stats->rx_dropped++;
648 return;
651 data = readl(&priv->regs->mb[RCAR_CAN_RX_FIFO_MBX].id);
652 if (data & RCAR_CAN_IDE)
653 cf->can_id = (data & CAN_EFF_MASK) | CAN_EFF_FLAG;
654 else
655 cf->can_id = (data >> RCAR_CAN_SID_SHIFT) & CAN_SFF_MASK;
657 dlc = readb(&priv->regs->mb[RCAR_CAN_RX_FIFO_MBX].dlc);
658 cf->can_dlc = get_can_dlc(dlc);
659 if (data & RCAR_CAN_RTR) {
660 cf->can_id |= CAN_RTR_FLAG;
661 } else {
662 for (dlc = 0; dlc < cf->can_dlc; dlc++)
663 cf->data[dlc] =
664 readb(&priv->regs->mb[RCAR_CAN_RX_FIFO_MBX].data[dlc]);
667 can_led_event(priv->ndev, CAN_LED_EVENT_RX);
669 stats->rx_bytes += cf->can_dlc;
670 stats->rx_packets++;
671 netif_receive_skb(skb);
674 static int rcar_can_rx_poll(struct napi_struct *napi, int quota)
676 struct rcar_can_priv *priv = container_of(napi,
677 struct rcar_can_priv, napi);
678 int num_pkts;
680 for (num_pkts = 0; num_pkts < quota; num_pkts++) {
681 u8 rfcr, isr;
683 isr = readb(&priv->regs->isr);
684 /* Clear interrupt bit */
685 if (isr & RCAR_CAN_ISR_RXFF)
686 writeb(isr & ~RCAR_CAN_ISR_RXFF, &priv->regs->isr);
687 rfcr = readb(&priv->regs->rfcr);
688 if (rfcr & RCAR_CAN_RFCR_RFEST)
689 break;
690 rcar_can_rx_pkt(priv);
691 /* Write 0xff to the RFPCR register to increment
692 * the CPU-side pointer for the receive FIFO
693 * to the next mailbox location
695 writeb(0xff, &priv->regs->rfpcr);
697 /* All packets processed */
698 if (num_pkts < quota) {
699 napi_complete(napi);
700 priv->ier |= RCAR_CAN_IER_RXFIE;
701 writeb(priv->ier, &priv->regs->ier);
703 return num_pkts;
706 static int rcar_can_do_set_mode(struct net_device *ndev, enum can_mode mode)
708 switch (mode) {
709 case CAN_MODE_START:
710 rcar_can_start(ndev);
711 netif_wake_queue(ndev);
712 return 0;
713 default:
714 return -EOPNOTSUPP;
718 static int rcar_can_get_berr_counter(const struct net_device *dev,
719 struct can_berr_counter *bec)
721 struct rcar_can_priv *priv = netdev_priv(dev);
722 int err;
724 err = clk_prepare_enable(priv->clk);
725 if (err)
726 return err;
727 bec->txerr = readb(&priv->regs->tecr);
728 bec->rxerr = readb(&priv->regs->recr);
729 clk_disable_unprepare(priv->clk);
730 return 0;
733 static const char * const clock_names[] = {
734 [CLKR_CLKP1] = "clkp1",
735 [CLKR_CLKP2] = "clkp2",
736 [CLKR_CLKEXT] = "can_clk",
739 static int rcar_can_probe(struct platform_device *pdev)
741 struct rcar_can_platform_data *pdata;
742 struct rcar_can_priv *priv;
743 struct net_device *ndev;
744 struct resource *mem;
745 void __iomem *addr;
746 u32 clock_select = CLKR_CLKP1;
747 int err = -ENODEV;
748 int irq;
750 if (pdev->dev.of_node) {
751 of_property_read_u32(pdev->dev.of_node,
752 "renesas,can-clock-select", &clock_select);
753 } else {
754 pdata = dev_get_platdata(&pdev->dev);
755 if (!pdata) {
756 dev_err(&pdev->dev, "No platform data provided!\n");
757 goto fail;
759 clock_select = pdata->clock_select;
762 irq = platform_get_irq(pdev, 0);
763 if (irq < 0) {
764 dev_err(&pdev->dev, "No IRQ resource\n");
765 err = irq;
766 goto fail;
769 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
770 addr = devm_ioremap_resource(&pdev->dev, mem);
771 if (IS_ERR(addr)) {
772 err = PTR_ERR(addr);
773 goto fail;
776 ndev = alloc_candev(sizeof(struct rcar_can_priv), RCAR_CAN_FIFO_DEPTH);
777 if (!ndev) {
778 dev_err(&pdev->dev, "alloc_candev() failed\n");
779 err = -ENOMEM;
780 goto fail;
783 priv = netdev_priv(ndev);
785 priv->clk = devm_clk_get(&pdev->dev, "clkp1");
786 if (IS_ERR(priv->clk)) {
787 err = PTR_ERR(priv->clk);
788 dev_err(&pdev->dev, "cannot get peripheral clock, error %d\n",
789 err);
790 goto fail_clk;
793 if (clock_select >= ARRAY_SIZE(clock_names)) {
794 err = -EINVAL;
795 dev_err(&pdev->dev, "invalid CAN clock selected\n");
796 goto fail_clk;
798 priv->can_clk = devm_clk_get(&pdev->dev, clock_names[clock_select]);
799 if (IS_ERR(priv->can_clk)) {
800 err = PTR_ERR(priv->can_clk);
801 dev_err(&pdev->dev, "cannot get CAN clock, error %d\n", err);
802 goto fail_clk;
805 ndev->netdev_ops = &rcar_can_netdev_ops;
806 ndev->irq = irq;
807 ndev->flags |= IFF_ECHO;
808 priv->ndev = ndev;
809 priv->regs = addr;
810 priv->clock_select = clock_select;
811 priv->can.clock.freq = clk_get_rate(priv->can_clk);
812 priv->can.bittiming_const = &rcar_can_bittiming_const;
813 priv->can.do_set_mode = rcar_can_do_set_mode;
814 priv->can.do_get_berr_counter = rcar_can_get_berr_counter;
815 priv->can.ctrlmode_supported = CAN_CTRLMODE_BERR_REPORTING;
816 platform_set_drvdata(pdev, ndev);
817 SET_NETDEV_DEV(ndev, &pdev->dev);
819 netif_napi_add(ndev, &priv->napi, rcar_can_rx_poll,
820 RCAR_CAN_NAPI_WEIGHT);
821 err = register_candev(ndev);
822 if (err) {
823 dev_err(&pdev->dev, "register_candev() failed, error %d\n",
824 err);
825 goto fail_candev;
828 devm_can_led_init(ndev);
830 dev_info(&pdev->dev, "device registered (regs @ %p, IRQ%d)\n",
831 priv->regs, ndev->irq);
833 return 0;
834 fail_candev:
835 netif_napi_del(&priv->napi);
836 fail_clk:
837 free_candev(ndev);
838 fail:
839 return err;
842 static int rcar_can_remove(struct platform_device *pdev)
844 struct net_device *ndev = platform_get_drvdata(pdev);
845 struct rcar_can_priv *priv = netdev_priv(ndev);
847 unregister_candev(ndev);
848 netif_napi_del(&priv->napi);
849 free_candev(ndev);
850 return 0;
853 static int __maybe_unused rcar_can_suspend(struct device *dev)
855 struct net_device *ndev = dev_get_drvdata(dev);
856 struct rcar_can_priv *priv = netdev_priv(ndev);
857 u16 ctlr;
859 if (netif_running(ndev)) {
860 netif_stop_queue(ndev);
861 netif_device_detach(ndev);
863 ctlr = readw(&priv->regs->ctlr);
864 ctlr |= RCAR_CAN_CTLR_CANM_HALT;
865 writew(ctlr, &priv->regs->ctlr);
866 ctlr |= RCAR_CAN_CTLR_SLPM;
867 writew(ctlr, &priv->regs->ctlr);
868 priv->can.state = CAN_STATE_SLEEPING;
870 clk_disable(priv->clk);
871 return 0;
874 static int __maybe_unused rcar_can_resume(struct device *dev)
876 struct net_device *ndev = dev_get_drvdata(dev);
877 struct rcar_can_priv *priv = netdev_priv(ndev);
878 u16 ctlr;
879 int err;
881 err = clk_enable(priv->clk);
882 if (err) {
883 netdev_err(ndev, "clk_enable() failed, error %d\n", err);
884 return err;
887 ctlr = readw(&priv->regs->ctlr);
888 ctlr &= ~RCAR_CAN_CTLR_SLPM;
889 writew(ctlr, &priv->regs->ctlr);
890 ctlr &= ~RCAR_CAN_CTLR_CANM;
891 writew(ctlr, &priv->regs->ctlr);
892 priv->can.state = CAN_STATE_ERROR_ACTIVE;
894 if (netif_running(ndev)) {
895 netif_device_attach(ndev);
896 netif_start_queue(ndev);
898 return 0;
901 static SIMPLE_DEV_PM_OPS(rcar_can_pm_ops, rcar_can_suspend, rcar_can_resume);
903 static const struct of_device_id rcar_can_of_table[] __maybe_unused = {
904 { .compatible = "renesas,can-r8a7778" },
905 { .compatible = "renesas,can-r8a7779" },
906 { .compatible = "renesas,can-r8a7790" },
907 { .compatible = "renesas,can-r8a7791" },
910 MODULE_DEVICE_TABLE(of, rcar_can_of_table);
912 static struct platform_driver rcar_can_driver = {
913 .driver = {
914 .name = RCAR_CAN_DRV_NAME,
915 .of_match_table = of_match_ptr(rcar_can_of_table),
916 .pm = &rcar_can_pm_ops,
918 .probe = rcar_can_probe,
919 .remove = rcar_can_remove,
922 module_platform_driver(rcar_can_driver);
924 MODULE_AUTHOR("Cogent Embedded, Inc.");
925 MODULE_LICENSE("GPL");
926 MODULE_DESCRIPTION("CAN driver for Renesas R-Car SoC");
927 MODULE_ALIAS("platform:" RCAR_CAN_DRV_NAME);