]> rtime.felk.cvut.cz Git - socketcan-devel.git/blob - kernel/2.6/drivers/net/can/mcp251x.c
19e4733fe63e8b877df5ac4936fc8c0e8a6ae540
[socketcan-devel.git] / kernel / 2.6 / drivers / net / can / mcp251x.c
1 /*
2  * CAN bus driver for Microchip 251x CAN Controller with SPI Interface
3  *
4  * MCP2510 support and bug fixes by Christian Pellegrin
5  * <chripell@evolware.org>
6  *
7  * Copyright 2009 Christian Pellegrin EVOL S.r.l.
8  *
9  * Copyright 2007 Raymarine UK, Ltd. All Rights Reserved.
10  * Written under contract by:
11  *   Chris Elston, Katalix Systems, Ltd.
12  *
13  * Based on Microchip MCP251x CAN controller driver written by
14  * David Vrabel, Copyright 2006 Arcom Control Systems Ltd.
15  *
16  * Based on CAN bus driver for the CCAN controller written by
17  * - Sascha Hauer, Marc Kleine-Budde, Pengutronix
18  * - Simon Kallweit, intefo AG
19  * Copyright 2007
20  *
21  * This program is free software; you can redistribute it and/or modify
22  * it under the terms of the version 2 of the GNU General Public License
23  * as published by the Free Software Foundation
24  *
25  * This program is distributed in the hope that it will be useful,
26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28  * GNU General Public License for more details.
29  *
30  * You should have received a copy of the GNU General Public License
31  * along with this program; if not, write to the Free Software
32  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
33  *
34  *
35  *
36  * Your platform definition file should specify something like:
37  *
38  * static struct mcp251x_platform_data mcp251x_info = {
39  *         .oscillator_frequency = 8000000,
40  *         .board_specific_setup = &mcp251x_setup,
41  *         .model = CAN_MCP251X_MCP2510,
42  *         .power_enable = mcp251x_power_enable,
43  *         .transceiver_enable = NULL,
44  * };
45  *
46  * static struct spi_board_info spi_board_info[] = {
47  *         {
48  *                 .modalias = "mcp251x",
49  *                 .platform_data = &mcp251x_info,
50  *                 .irq = IRQ_EINT13,
51  *                 .max_speed_hz = 2*1000*1000,
52  *                 .chip_select = 2,
53  *         },
54  * };
55  *
56  * Please see mcp251x.h for a description of the fields in
57  * struct mcp251x_platform_data.
58  *
59  */
60
61 #include <linux/completion.h>
62 #include <linux/delay.h>
63 #include <linux/device.h>
64 #include <linux/dma-mapping.h>
65 #include <linux/freezer.h>
66 #include <linux/interrupt.h>
67 #include <linux/io.h>
68 #include <linux/kernel.h>
69 #include <linux/module.h>
70 #include <linux/netdevice.h>
71 #include <linux/platform_device.h>
72 #include <linux/spi/spi.h>
73 #include <linux/uaccess.h>
74 #include <socketcan/can.h>
75 #include <socketcan/can/core.h>
76 #include <socketcan/can/dev.h>
77 #include <socketcan/can/platform/mcp251x.h>
78
79 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,22)
80 #error This driver does not support Kernel versions < 2.6.22
81 #endif
82
83 /* SPI interface instruction set */
84 #define INSTRUCTION_WRITE       0x02
85 #define INSTRUCTION_READ        0x03
86 #define INSTRUCTION_BIT_MODIFY  0x05
87 #define INSTRUCTION_LOAD_TXB(n) (0x40 + 2 * (n))
88 #define INSTRUCTION_READ_RXB(n) (((n) == 0) ? 0x90 : 0x94)
89 #define INSTRUCTION_RESET       0xC0
90
91 /* MPC251x registers */
92 #define CANSTAT       0x0e
93 #define CANCTRL       0x0f
94 #  define CANCTRL_REQOP_MASK        0xe0
95 #  define CANCTRL_REQOP_CONF        0x80
96 #  define CANCTRL_REQOP_LISTEN_ONLY 0x60
97 #  define CANCTRL_REQOP_LOOPBACK    0x40
98 #  define CANCTRL_REQOP_SLEEP       0x20
99 #  define CANCTRL_REQOP_NORMAL      0x00
100 #  define CANCTRL_OSM               0x08
101 #  define CANCTRL_ABAT              0x10
102 #define TEC           0x1c
103 #define REC           0x1d
104 #define CNF1          0x2a
105 #  define CNF1_SJW_SHIFT   6
106 #define CNF2          0x29
107 #  define CNF2_BTLMODE     0x80
108 #  define CNF2_SAM         0x40
109 #  define CNF2_PS1_SHIFT   3
110 #define CNF3          0x28
111 #  define CNF3_SOF         0x08
112 #  define CNF3_WAKFIL      0x04
113 #  define CNF3_PHSEG2_MASK 0x07
114 #define CANINTE       0x2b
115 #  define CANINTE_MERRE 0x80
116 #  define CANINTE_WAKIE 0x40
117 #  define CANINTE_ERRIE 0x20
118 #  define CANINTE_TX2IE 0x10
119 #  define CANINTE_TX1IE 0x08
120 #  define CANINTE_TX0IE 0x04
121 #  define CANINTE_RX1IE 0x02
122 #  define CANINTE_RX0IE 0x01
123 #define CANINTF       0x2c
124 #  define CANINTF_MERRF 0x80
125 #  define CANINTF_WAKIF 0x40
126 #  define CANINTF_ERRIF 0x20
127 #  define CANINTF_TX2IF 0x10
128 #  define CANINTF_TX1IF 0x08
129 #  define CANINTF_TX0IF 0x04
130 #  define CANINTF_RX1IF 0x02
131 #  define CANINTF_RX0IF 0x01
132 #define EFLG          0x2d
133 #  define EFLG_EWARN    0x01
134 #  define EFLG_RXWAR    0x02
135 #  define EFLG_TXWAR    0x04
136 #  define EFLG_RXEP     0x08
137 #  define EFLG_TXEP     0x10
138 #  define EFLG_TXBO     0x20
139 #  define EFLG_RX0OVR   0x40
140 #  define EFLG_RX1OVR   0x80
141 #define TXBCTRL(n)  (((n) * 0x10) + 0x30 + TXBCTRL_OFF)
142 #  define TXBCTRL_ABTF  0x40
143 #  define TXBCTRL_MLOA  0x20
144 #  define TXBCTRL_TXERR 0x10
145 #  define TXBCTRL_TXREQ 0x08
146 #define TXBSIDH(n)  (((n) * 0x10) + 0x30 + TXBSIDH_OFF)
147 #  define SIDH_SHIFT    3
148 #define TXBSIDL(n)  (((n) * 0x10) + 0x30 + TXBSIDL_OFF)
149 #  define SIDL_SID_MASK    7
150 #  define SIDL_SID_SHIFT   5
151 #  define SIDL_EXIDE_SHIFT 3
152 #  define SIDL_EID_SHIFT   16
153 #  define SIDL_EID_MASK    3
154 #define TXBEID8(n)  (((n) * 0x10) + 0x30 + TXBEID8_OFF)
155 #define TXBEID0(n)  (((n) * 0x10) + 0x30 + TXBEID0_OFF)
156 #define TXBDLC(n)   (((n) * 0x10) + 0x30 + TXBDLC_OFF)
157 #  define DLC_RTR_SHIFT    6
158 #define TXBCTRL_OFF 0
159 #define TXBSIDH_OFF 1
160 #define TXBSIDL_OFF 2
161 #define TXBEID8_OFF 3
162 #define TXBEID0_OFF 4
163 #define TXBDLC_OFF  5
164 #define TXBDAT_OFF  6
165 #define RXBCTRL(n)  (((n) * 0x10) + 0x60 + RXBCTRL_OFF)
166 #  define RXBCTRL_BUKT  0x04
167 #  define RXBCTRL_RXM0  0x20
168 #  define RXBCTRL_RXM1  0x40
169 #define RXBSIDH(n)  (((n) * 0x10) + 0x60 + RXBSIDH_OFF)
170 #  define RXBSIDH_SHIFT 3
171 #define RXBSIDL(n)  (((n) * 0x10) + 0x60 + RXBSIDL_OFF)
172 #  define RXBSIDL_IDE   0x08
173 #  define RXBSIDL_EID   3
174 #  define RXBSIDL_SHIFT 5
175 #define RXBEID8(n)  (((n) * 0x10) + 0x60 + RXBEID8_OFF)
176 #define RXBEID0(n)  (((n) * 0x10) + 0x60 + RXBEID0_OFF)
177 #define RXBDLC(n)   (((n) * 0x10) + 0x60 + RXBDLC_OFF)
178 #  define RXBDLC_LEN_MASK  0x0f
179 #  define RXBDLC_RTR       0x40
180 #define RXBCTRL_OFF 0
181 #define RXBSIDH_OFF 1
182 #define RXBSIDL_OFF 2
183 #define RXBEID8_OFF 3
184 #define RXBEID0_OFF 4
185 #define RXBDLC_OFF  5
186 #define RXBDAT_OFF  6
187
188 #define GET_BYTE(val, byte)                     \
189         (((val) >> ((byte) * 8)) & 0xff)
190 #define SET_BYTE(val, byte)                     \
191         (((val) & 0xff) << ((byte) * 8))
192
193 /*
194  * Buffer size required for the largest SPI transfer (i.e., reading a
195  * frame)
196  */
197 #define CAN_FRAME_MAX_DATA_LEN  8
198 #define SPI_TRANSFER_BUF_LEN    (6 + CAN_FRAME_MAX_DATA_LEN)
199 #define CAN_FRAME_MAX_BITS      128
200
201 #define TX_ECHO_SKB_MAX 1
202
203 #define DEVICE_NAME "mcp251x"
204
205 static int mcp251x_enable_dma; /* Enable SPI DMA. Default: 0 (Off) */
206 module_param(mcp251x_enable_dma, int, S_IRUGO);
207 MODULE_PARM_DESC(mcp251x_enable_dma, "Enable SPI DMA. Default: 0 (Off)");
208
209 static struct can_bittiming_const mcp251x_bittiming_const = {
210         .name = DEVICE_NAME,
211         .tseg1_min = 3,
212         .tseg1_max = 16,
213         .tseg2_min = 2,
214         .tseg2_max = 8,
215         .sjw_max = 4,
216         .brp_min = 1,
217         .brp_max = 64,
218         .brp_inc = 1,
219 };
220
221 struct mcp251x_priv {
222         struct can_priv    can;
223         struct net_device *net;
224         struct spi_device *spi;
225
226         struct mutex spi_lock; /* SPI buffer lock */
227         u8 *spi_tx_buf;
228         u8 *spi_rx_buf;
229         dma_addr_t spi_tx_dma;
230         dma_addr_t spi_rx_dma;
231
232         struct sk_buff *tx_skb;
233         int tx_len;
234         struct workqueue_struct *wq;
235         struct work_struct tx_work;
236         struct work_struct irq_work;
237
238         int force_quit;
239         int after_suspend;
240 #define AFTER_SUSPEND_UP 1
241 #define AFTER_SUSPEND_DOWN 2
242 #define AFTER_SUSPEND_POWER 4
243 #define AFTER_SUSPEND_RESTART 8
244         int restart_tx;
245 };
246
247 static void mcp251x_clean(struct net_device *net)
248 {
249         struct mcp251x_priv *priv = netdev_priv(net);
250
251         net->stats.tx_errors++;
252         if (priv->tx_skb)
253                 dev_kfree_skb(priv->tx_skb);
254         if (priv->tx_len)
255                 can_free_echo_skb(priv->net, 0);
256         priv->tx_skb = NULL;
257         priv->tx_len = 0;
258 }
259
260 /*
261  * Note about handling of error return of mcp251x_spi_trans: accessing
262  * registers via SPI is not really different conceptually than using
263  * normal I/O assembler instructions, although it's much more
264  * complicated from a practical POV. So it's not advisable to always
265  * check the return value of this function. Imagine that every
266  * read{b,l}, write{b,l} and friends would be bracketed in "if ( < 0)
267  * error();", it would be a great mess (well there are some situation
268  * when exception handling C++ like could be useful after all). So we
269  * just check that transfers are OK at the beginning of our
270  * conversation with the chip and to avoid doing really nasty things
271  * (like injecting bogus packets in the network stack).
272  */
273 static int mcp251x_spi_trans(struct spi_device *spi, int len)
274 {
275         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
276         struct spi_transfer t = {
277                 .tx_buf = priv->spi_tx_buf,
278                 .rx_buf = priv->spi_rx_buf,
279                 .len = len,
280                 .cs_change = 0,
281         };
282         struct spi_message m;
283         int ret;
284
285         spi_message_init(&m);
286
287         if (mcp251x_enable_dma) {
288                 t.tx_dma = priv->spi_tx_dma;
289                 t.rx_dma = priv->spi_rx_dma;
290                 m.is_dma_mapped = 1;
291         }
292
293         spi_message_add_tail(&t, &m);
294
295         ret = spi_sync(spi, &m);
296         if (ret)
297                 dev_err(&spi->dev, "spi transfer failed: ret = %d\n", ret);
298         return ret;
299 }
300
301 static u8 mcp251x_read_reg(struct spi_device *spi, uint8_t reg)
302 {
303         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
304         u8 val = 0;
305
306         mutex_lock(&priv->spi_lock);
307
308         priv->spi_tx_buf[0] = INSTRUCTION_READ;
309         priv->spi_tx_buf[1] = reg;
310
311         mcp251x_spi_trans(spi, 3);
312         val = priv->spi_rx_buf[2];
313
314         mutex_unlock(&priv->spi_lock);
315
316         return val;
317 }
318
319 static void mcp251x_write_reg(struct spi_device *spi, u8 reg, uint8_t val)
320 {
321         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
322
323         mutex_lock(&priv->spi_lock);
324
325         priv->spi_tx_buf[0] = INSTRUCTION_WRITE;
326         priv->spi_tx_buf[1] = reg;
327         priv->spi_tx_buf[2] = val;
328
329         mcp251x_spi_trans(spi, 3);
330
331         mutex_unlock(&priv->spi_lock);
332 }
333
334 static void mcp251x_write_bits(struct spi_device *spi, u8 reg,
335                                u8 mask, uint8_t val)
336 {
337         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
338
339         mutex_lock(&priv->spi_lock);
340
341         priv->spi_tx_buf[0] = INSTRUCTION_BIT_MODIFY;
342         priv->spi_tx_buf[1] = reg;
343         priv->spi_tx_buf[2] = mask;
344         priv->spi_tx_buf[3] = val;
345
346         mcp251x_spi_trans(spi, 4);
347
348         mutex_unlock(&priv->spi_lock);
349 }
350
351 static void mcp251x_hw_tx_frame(struct spi_device *spi, u8 *buf,
352                                 int len, int tx_buf_idx)
353 {
354         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
355         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
356
357         if (pdata->model == CAN_MCP251X_MCP2510) {
358                 int i;
359
360                 for (i = 1; i < TXBDAT_OFF + len; i++)
361                         mcp251x_write_reg(spi, TXBCTRL(tx_buf_idx) + i,
362                                           buf[i]);
363         } else {
364                 mutex_lock(&priv->spi_lock);
365
366                 memcpy(priv->spi_tx_buf, buf, TXBDAT_OFF + len);
367                 mcp251x_spi_trans(spi, TXBDAT_OFF + len);
368
369                 mutex_unlock(&priv->spi_lock);
370         }
371 }
372
373 static void mcp251x_hw_tx(struct spi_device *spi, struct can_frame *frame,
374                           int tx_buf_idx)
375 {
376         u32 sid, eid, exide, rtr;
377         u8 buf[SPI_TRANSFER_BUF_LEN];
378
379         exide = (frame->can_id & CAN_EFF_FLAG) ? 1 : 0; /* Extended ID Enable */
380         if (exide)
381                 sid = (frame->can_id & CAN_EFF_MASK) >> 18;
382         else
383                 sid = frame->can_id & CAN_SFF_MASK; /* Standard ID */
384         eid = frame->can_id & CAN_EFF_MASK; /* Extended ID */
385         rtr = (frame->can_id & CAN_RTR_FLAG) ? 1 : 0; /* Remote transmission */
386
387         buf[TXBCTRL_OFF] = INSTRUCTION_LOAD_TXB(tx_buf_idx);
388         buf[TXBSIDH_OFF] = sid >> SIDH_SHIFT;
389         buf[TXBSIDL_OFF] = ((sid & SIDL_SID_MASK) << SIDL_SID_SHIFT) |
390                 (exide << SIDL_EXIDE_SHIFT) |
391                 ((eid >> SIDL_EID_SHIFT) & SIDL_EID_MASK);
392         buf[TXBEID8_OFF] = GET_BYTE(eid, 1);
393         buf[TXBEID0_OFF] = GET_BYTE(eid, 0);
394         buf[TXBDLC_OFF] = (rtr << DLC_RTR_SHIFT) | frame->can_dlc;
395         memcpy(buf + TXBDAT_OFF, frame->data, frame->can_dlc);
396         mcp251x_hw_tx_frame(spi, buf, frame->can_dlc, tx_buf_idx);
397         mcp251x_write_reg(spi, TXBCTRL(tx_buf_idx), TXBCTRL_TXREQ);
398 }
399
400 static void mcp251x_hw_rx_frame(struct spi_device *spi, u8 *buf,
401                                 int buf_idx)
402 {
403         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
404         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
405
406         if (pdata->model == CAN_MCP251X_MCP2510) {
407                 int i, len;
408
409                 for (i = 1; i < RXBDAT_OFF; i++)
410                         buf[i] = mcp251x_read_reg(spi, RXBCTRL(buf_idx) + i);
411
412                 len = get_can_dlc(buf[RXBDLC_OFF] & RXBDLC_LEN_MASK);
413                 for (; i < (RXBDAT_OFF + len); i++)
414                         buf[i] = mcp251x_read_reg(spi, RXBCTRL(buf_idx) + i);
415         } else {
416                 mutex_lock(&priv->spi_lock);
417
418                 priv->spi_tx_buf[RXBCTRL_OFF] = INSTRUCTION_READ_RXB(buf_idx);
419                 mcp251x_spi_trans(spi, SPI_TRANSFER_BUF_LEN);
420                 memcpy(buf, priv->spi_rx_buf, SPI_TRANSFER_BUF_LEN);
421
422                 mutex_unlock(&priv->spi_lock);
423         }
424 }
425
426 static void mcp251x_hw_rx(struct spi_device *spi, int buf_idx)
427 {
428         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
429         struct sk_buff *skb;
430         struct can_frame *frame;
431         u8 buf[SPI_TRANSFER_BUF_LEN];
432
433         skb = alloc_can_skb(priv->net, &frame);
434         if (!skb) {
435                 dev_err(&spi->dev, "cannot allocate RX skb\n");
436                 priv->net->stats.rx_dropped++;
437                 return;
438         }
439
440         mcp251x_hw_rx_frame(spi, buf, buf_idx);
441         if (buf[RXBSIDL_OFF] & RXBSIDL_IDE) {
442                 /* Extended ID format */
443                 frame->can_id = CAN_EFF_FLAG;
444                 frame->can_id |=
445                         /* Extended ID part */
446                         SET_BYTE(buf[RXBSIDL_OFF] & RXBSIDL_EID, 2) |
447                         SET_BYTE(buf[RXBEID8_OFF], 1) |
448                         SET_BYTE(buf[RXBEID0_OFF], 0) |
449                         /* Standard ID part */
450                         (((buf[RXBSIDH_OFF] << RXBSIDH_SHIFT) |
451                           (buf[RXBSIDL_OFF] >> RXBSIDL_SHIFT)) << 18);
452                 /* Remote transmission request */
453                 if (buf[RXBDLC_OFF] & RXBDLC_RTR)
454                         frame->can_id |= CAN_RTR_FLAG;
455         } else {
456                 /* Standard ID format */
457                 frame->can_id =
458                         (buf[RXBSIDH_OFF] << RXBSIDH_SHIFT) |
459                         (buf[RXBSIDL_OFF] >> RXBSIDL_SHIFT);
460         }
461         /* Data length */
462         frame->can_dlc = get_can_dlc(buf[RXBDLC_OFF] & RXBDLC_LEN_MASK);
463         memcpy(frame->data, buf + RXBDAT_OFF, frame->can_dlc);
464
465         priv->net->stats.rx_packets++;
466         priv->net->stats.rx_bytes += frame->can_dlc;
467         netif_rx(skb);
468 }
469
470 static void mcp251x_hw_sleep(struct spi_device *spi)
471 {
472         mcp251x_write_reg(spi, CANCTRL, CANCTRL_REQOP_SLEEP);
473 }
474
475 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
476 static int mcp251x_hard_start_xmit(struct sk_buff *skb, struct net_device *net)
477 #else
478 static netdev_tx_t mcp251x_hard_start_xmit(struct sk_buff *skb,
479                                            struct net_device *net)
480 #endif
481 {
482         struct mcp251x_priv *priv = netdev_priv(net);
483         struct spi_device *spi = priv->spi;
484
485         if (priv->tx_skb || priv->tx_len) {
486                 dev_warn(&spi->dev, "hard_xmit called while tx busy\n");
487                 netif_stop_queue(net);
488                 return NETDEV_TX_BUSY;
489         }
490
491         if (can_dropped_invalid_skb(net, skb))
492                 return NETDEV_TX_OK;
493
494         netif_stop_queue(net);
495         priv->tx_skb = skb;
496         net->trans_start = jiffies;
497         queue_work(priv->wq, &priv->tx_work);
498
499         return NETDEV_TX_OK;
500 }
501
502 static int mcp251x_do_set_mode(struct net_device *net, enum can_mode mode)
503 {
504         struct mcp251x_priv *priv = netdev_priv(net);
505
506         switch (mode) {
507         case CAN_MODE_START:
508                 /* We have to delay work since SPI I/O may sleep */
509                 priv->can.state = CAN_STATE_ERROR_ACTIVE;
510                 priv->restart_tx = 1;
511                 if (priv->can.restart_ms == 0)
512                         priv->after_suspend = AFTER_SUSPEND_RESTART;
513                 queue_work(priv->wq, &priv->irq_work);
514                 break;
515         default:
516                 return -EOPNOTSUPP;
517         }
518
519         return 0;
520 }
521
522 static void mcp251x_set_normal_mode(struct spi_device *spi)
523 {
524         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
525         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
526         unsigned long timeout;
527
528         /* Enable interrupts */
529         mcp251x_write_reg(spi, CANINTE,
530                           CANINTE_ERRIE | CANINTE_TX2IE | CANINTE_TX1IE |
531                           CANINTE_TX0IE | CANINTE_RX1IE | CANINTE_RX0IE);
532
533         if (priv->can.ctrlmode & CAN_CTRLMODE_LOOPBACK) {
534                 /* Put device into loopback mode */
535                 mcp251x_write_reg(spi, CANCTRL, CANCTRL_REQOP_LOOPBACK);
536         } else {
537                 /* Put device into normal mode */
538                 mcp251x_write_reg(spi, CANCTRL, CANCTRL_REQOP_NORMAL |
539                                   ((pdata->model == CAN_MCP251X_MCP2515 &&
540                                     priv->can.ctrlmode & CAN_CTRLMODE_ONE_SHOT) ?
541                                    CANCTRL_OSM : 0));
542
543                 /* Wait for the device to enter normal mode */
544                 timeout = jiffies + HZ;
545                 while (mcp251x_read_reg(spi, CANSTAT) & CANCTRL_REQOP_MASK) {
546                         schedule();
547                         if (time_after(jiffies, timeout)) {
548                                 dev_err(&spi->dev, "MCP251x didn't"
549                                         " enter in normal mode\n");
550                                 return;
551                         }
552                 }
553         }
554         priv->can.state = CAN_STATE_ERROR_ACTIVE;
555 }
556
557 static int mcp251x_do_set_bittiming(struct net_device *net)
558 {
559         struct mcp251x_priv *priv = netdev_priv(net);
560         struct can_bittiming *bt = &priv->can.bittiming;
561         struct spi_device *spi = priv->spi;
562
563         mcp251x_write_reg(spi, CNF1, ((bt->sjw - 1) << CNF1_SJW_SHIFT) |
564                           (bt->brp - 1));
565         mcp251x_write_reg(spi, CNF2, CNF2_BTLMODE |
566                           (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES ?
567                            CNF2_SAM : 0) |
568                           ((bt->phase_seg1 - 1) << CNF2_PS1_SHIFT) |
569                           (bt->prop_seg - 1));
570         mcp251x_write_bits(spi, CNF3, CNF3_PHSEG2_MASK,
571                            (bt->phase_seg2 - 1));
572         dev_info(&spi->dev, "CNF: 0x%02x 0x%02x 0x%02x\n",
573                  mcp251x_read_reg(spi, CNF1),
574                  mcp251x_read_reg(spi, CNF2),
575                  mcp251x_read_reg(spi, CNF3));
576
577         return 0;
578 }
579
580 static int mcp251x_setup(struct net_device *net, struct mcp251x_priv *priv,
581                          struct spi_device *spi)
582 {
583         mcp251x_do_set_bittiming(net);
584
585         /* Enable RX0->RX1 buffer roll over and disable filters */
586         mcp251x_write_reg(spi, RXBCTRL(0),
587                           RXBCTRL_BUKT | RXBCTRL_RXM0 | RXBCTRL_RXM1);
588         mcp251x_write_reg(spi, RXBCTRL(1),
589                           RXBCTRL_RXM0 | RXBCTRL_RXM1);
590         return 0;
591 }
592
593 static void mcp251x_hw_reset(struct spi_device *spi)
594 {
595         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
596         int ret;
597         unsigned long timeout;
598
599         mutex_lock(&priv->spi_lock);
600
601         priv->spi_tx_buf[0] = INSTRUCTION_RESET;
602
603         ret = spi_write(spi, priv->spi_tx_buf, 1);
604         if (ret)
605                 dev_err(&spi->dev, "reset failed: ret = %d\n", ret);
606
607         mutex_unlock(&priv->spi_lock);
608
609         /* Wait for reset to finish */
610         timeout = jiffies + HZ;
611         mdelay(10);
612         while ((mcp251x_read_reg(spi, CANSTAT) & CANCTRL_REQOP_MASK)
613                != CANCTRL_REQOP_CONF) {
614                 schedule();
615                 if (time_after(jiffies, timeout)) {
616                         dev_err(&spi->dev, "MCP251x didn't"
617                                 " enter in conf mode after reset\n");
618                         break;
619                 }
620         }
621 }
622
623 static int mcp251x_hw_probe(struct spi_device *spi)
624 {
625         int st1, st2;
626
627         mcp251x_hw_reset(spi);
628
629         /*
630          * Please note that these are "magic values" based on after
631          * reset defaults taken from data sheet which allows us to see
632          * if we really have a chip on the bus (we avoid common all
633          * zeroes or all ones situations)
634          */
635         st1 = mcp251x_read_reg(spi, CANSTAT) & 0xEE;
636         st2 = mcp251x_read_reg(spi, CANCTRL) & 0x17;
637
638         dev_dbg(&spi->dev, "CANSTAT 0x%02x CANCTRL 0x%02x\n", st1, st2);
639
640         /* Check for power up default values */
641         return (st1 == 0x80 && st2 == 0x07) ? 1 : 0;
642 }
643
644 static irqreturn_t mcp251x_can_isr(int irq, void *dev_id)
645 {
646         struct net_device *net = (struct net_device *)dev_id;
647         struct mcp251x_priv *priv = netdev_priv(net);
648
649         /* Schedule bottom half */
650         if (!work_pending(&priv->irq_work))
651                 queue_work(priv->wq, &priv->irq_work);
652
653         return IRQ_HANDLED;
654 }
655
656 static int mcp251x_open(struct net_device *net)
657 {
658         struct mcp251x_priv *priv = netdev_priv(net);
659         struct spi_device *spi = priv->spi;
660         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
661         int ret;
662
663         ret = open_candev(net);
664         if (ret) {
665                 dev_err(&spi->dev, "unable to set initial baudrate!\n");
666                 return ret;
667         }
668
669         if (pdata->transceiver_enable)
670                 pdata->transceiver_enable(1);
671
672         priv->force_quit = 0;
673         priv->tx_skb = NULL;
674         priv->tx_len = 0;
675
676         ret = request_irq(spi->irq, mcp251x_can_isr,
677                           IRQF_TRIGGER_FALLING, DEVICE_NAME, net);
678         if (ret) {
679                 dev_err(&spi->dev, "failed to acquire irq %d\n", spi->irq);
680                 if (pdata->transceiver_enable)
681                         pdata->transceiver_enable(0);
682                 close_candev(net);
683                 return ret;
684         }
685
686         mcp251x_hw_reset(spi);
687         ret = mcp251x_setup(net, priv, spi);
688         if (ret) {
689                 free_irq(spi->irq, net);
690                 mcp251x_hw_sleep(spi);
691                 if (pdata->transceiver_enable)
692                         pdata->transceiver_enable(0);
693                 close_candev(net);
694                 return ret;
695         }
696         mcp251x_set_normal_mode(spi);
697         netif_wake_queue(net);
698
699         return 0;
700 }
701
702 static int mcp251x_stop(struct net_device *net)
703 {
704         struct mcp251x_priv *priv = netdev_priv(net);
705         struct spi_device *spi = priv->spi;
706         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
707
708         close_candev(net);
709
710         /* Disable and clear pending interrupts */
711         mcp251x_write_reg(spi, CANINTE, 0x00);
712         mcp251x_write_reg(spi, CANINTF, 0x00);
713
714         priv->force_quit = 1;
715         free_irq(spi->irq, net);
716         flush_workqueue(priv->wq);
717
718         mcp251x_write_reg(spi, TXBCTRL(0), 0);
719         if (priv->tx_skb || priv->tx_len)
720                 mcp251x_clean(net);
721
722         mcp251x_hw_sleep(spi);
723
724         if (pdata->transceiver_enable)
725                 pdata->transceiver_enable(0);
726
727         priv->can.state = CAN_STATE_STOPPED;
728
729         return 0;
730 }
731
732 static void mcp251x_tx_work_handler(struct work_struct *ws)
733 {
734         struct mcp251x_priv *priv = container_of(ws, struct mcp251x_priv,
735                                                  tx_work);
736         struct spi_device *spi = priv->spi;
737         struct net_device *net = priv->net;
738         struct can_frame *frame;
739
740         if (priv->tx_skb) {
741                 frame = (struct can_frame *)priv->tx_skb->data;
742
743                 if (priv->can.state == CAN_STATE_BUS_OFF) {
744                         mcp251x_clean(net);
745                         netif_wake_queue(net);
746                         return;
747                 }
748                 if (frame->can_dlc > CAN_FRAME_MAX_DATA_LEN)
749                         frame->can_dlc = CAN_FRAME_MAX_DATA_LEN;
750                 mcp251x_hw_tx(spi, frame, 0);
751                 priv->tx_len = 1 + frame->can_dlc;
752                 can_put_echo_skb(priv->tx_skb, net, 0);
753                 priv->tx_skb = NULL;
754         }
755 }
756
757 static void mcp251x_irq_work_handler(struct work_struct *ws)
758 {
759         struct mcp251x_priv *priv = container_of(ws, struct mcp251x_priv,
760                                                  irq_work);
761         struct spi_device *spi = priv->spi;
762         struct net_device *net = priv->net;
763         u8 intf;
764         enum can_state new_state;
765
766         if (priv->after_suspend) {
767                 mdelay(10);
768                 mcp251x_hw_reset(spi);
769                 mcp251x_setup(net, priv, spi);
770                 if (priv->after_suspend & AFTER_SUSPEND_RESTART) {
771                         mcp251x_set_normal_mode(spi);
772                 } else if (priv->after_suspend & AFTER_SUSPEND_UP) {
773                         netif_device_attach(net);
774                         /* Clean since we lost tx buffer */
775                         if (priv->tx_skb || priv->tx_len) {
776                                 mcp251x_clean(net);
777                                 netif_wake_queue(net);
778                         }
779                         mcp251x_set_normal_mode(spi);
780                 } else {
781                         mcp251x_hw_sleep(spi);
782                 }
783                 priv->after_suspend = 0;
784         }
785
786         if (priv->can.restart_ms == 0 && priv->can.state == CAN_STATE_BUS_OFF)
787                 return;
788
789         while (!priv->force_quit && !freezing(current)) {
790                 u8 eflag;
791                 int can_id = 0, data1 = 0;
792
793                 if (priv->restart_tx) {
794                         priv->restart_tx = 0;
795                         mcp251x_write_reg(spi, TXBCTRL(0), 0);
796                         if (priv->tx_skb || priv->tx_len)
797                                 mcp251x_clean(net);
798                         netif_wake_queue(net);
799                         can_id |= CAN_ERR_RESTARTED;
800                 }
801
802                 intf = mcp251x_read_reg(spi, CANINTF);
803
804                 if (intf & CANINTF_RX0IF) {
805                         mcp251x_hw_rx(spi, 0);
806                         /* Free one buffer ASAP */
807                         mcp251x_write_bits(spi, CANINTF, intf & CANINTF_RX0IF, 0x00);
808                 }
809
810                 if (intf & CANINTF_RX1IF)
811                         mcp251x_hw_rx(spi, 1);
812
813                 mcp251x_write_bits(spi, CANINTF, intf, 0x00);
814
815                 eflag = mcp251x_read_reg(spi, EFLG);
816                 mcp251x_write_reg(spi, EFLG, 0x00);
817
818                 /* Update can state */
819                 if (eflag & EFLG_TXBO) {
820                         new_state = CAN_STATE_BUS_OFF;
821                         can_id |= CAN_ERR_BUSOFF;
822                 } else if (eflag & EFLG_TXEP) {
823                         new_state = CAN_STATE_ERROR_PASSIVE;
824                         can_id |= CAN_ERR_CRTL;
825                         data1 |= CAN_ERR_CRTL_TX_PASSIVE;
826                 } else if (eflag & EFLG_RXEP) {
827                         new_state = CAN_STATE_ERROR_PASSIVE;
828                         can_id |= CAN_ERR_CRTL;
829                         data1 |= CAN_ERR_CRTL_RX_PASSIVE;
830                 } else if (eflag & EFLG_TXWAR) {
831                         new_state = CAN_STATE_ERROR_WARNING;
832                         can_id |= CAN_ERR_CRTL;
833                         data1 |= CAN_ERR_CRTL_TX_WARNING;
834                 } else if (eflag & EFLG_RXWAR) {
835                         new_state = CAN_STATE_ERROR_WARNING;
836                         can_id |= CAN_ERR_CRTL;
837                         data1 |= CAN_ERR_CRTL_RX_WARNING;
838                 } else {
839                         new_state = CAN_STATE_ERROR_ACTIVE;
840                 }
841
842                 /* Update can state statistics */
843                 switch (priv->can.state) {
844                 case CAN_STATE_ERROR_ACTIVE:
845                         if (new_state >= CAN_STATE_ERROR_WARNING &&
846                             new_state <= CAN_STATE_BUS_OFF)
847                                 priv->can.can_stats.error_warning++;
848                 case CAN_STATE_ERROR_WARNING:   /* fallthrough */
849                         if (new_state >= CAN_STATE_ERROR_PASSIVE &&
850                             new_state <= CAN_STATE_BUS_OFF)
851                                 priv->can.can_stats.error_passive++;
852                         break;
853                 default:
854                         break;
855                 }
856                 priv->can.state = new_state;
857
858                 if ((intf & CANINTF_ERRIF) || (can_id & CAN_ERR_RESTARTED)) {
859                         struct sk_buff *skb;
860                         struct can_frame *frame;
861
862                         /* Create error frame */
863                         skb = alloc_can_err_skb(net, &frame);
864                         if (skb) {
865                                 /* Set error frame flags based on bus state */
866                                 frame->can_id = can_id;
867                                 frame->data[1] = data1;
868
869                                 /* Update net stats for overflows */
870                                 if (eflag & (EFLG_RX0OVR | EFLG_RX1OVR)) {
871                                         if (eflag & EFLG_RX0OVR)
872                                                 net->stats.rx_over_errors++;
873                                         if (eflag & EFLG_RX1OVR)
874                                                 net->stats.rx_over_errors++;
875                                         frame->can_id |= CAN_ERR_CRTL;
876                                         frame->data[1] |=
877                                                 CAN_ERR_CRTL_RX_OVERFLOW;
878                                 }
879
880                                 netif_rx(skb);
881                         } else {
882                                 dev_info(&spi->dev,
883                                          "cannot allocate error skb\n");
884                         }
885                 }
886
887                 if (priv->can.state == CAN_STATE_BUS_OFF) {
888                         if (priv->can.restart_ms == 0) {
889                                 can_bus_off(net);
890                                 mcp251x_hw_sleep(spi);
891                                 return;
892                         }
893                 }
894
895                 if (intf == 0)
896                         break;
897
898                 if (intf & (CANINTF_TX2IF | CANINTF_TX1IF | CANINTF_TX0IF)) {
899                         net->stats.tx_packets++;
900                         net->stats.tx_bytes += priv->tx_len - 1;
901                         if (priv->tx_len) {
902                                 can_get_echo_skb(net, 0);
903                                 priv->tx_len = 0;
904                         }
905                         netif_wake_queue(net);
906                 }
907         }
908 }
909
910 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
911 static const struct net_device_ops mcp251x_netdev_ops = {
912         .ndo_open = mcp251x_open,
913         .ndo_stop = mcp251x_stop,
914         .ndo_start_xmit = mcp251x_hard_start_xmit,
915 };
916 #endif
917
918 static int __devinit mcp251x_can_probe(struct spi_device *spi)
919 {
920         struct net_device *net;
921         struct mcp251x_priv *priv;
922         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
923         int ret = -ENODEV;
924
925         if (!pdata)
926                 /* Platform data is required for osc freq */
927                 goto error_out;
928
929         /* Allocate can/net device */
930         net = alloc_candev(sizeof(struct mcp251x_priv), TX_ECHO_SKB_MAX);
931         if (!net) {
932                 ret = -ENOMEM;
933                 goto error_alloc;
934         }
935
936 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
937         net->netdev_ops = &mcp251x_netdev_ops;
938 #else
939         net->open = mcp251x_open;
940         net->stop = mcp251x_stop;
941         net->hard_start_xmit = mcp251x_hard_start_xmit;
942 #endif
943         net->flags |= IFF_ECHO;
944
945         priv = netdev_priv(net);
946         priv->can.bittiming_const = &mcp251x_bittiming_const;
947         priv->can.do_set_mode = mcp251x_do_set_mode;
948         priv->can.clock.freq = pdata->oscillator_frequency / 2;
949         priv->net = net;
950         dev_set_drvdata(&spi->dev, priv);
951
952         priv->spi = spi;
953         mutex_init(&priv->spi_lock);
954
955         /* If requested, allocate DMA buffers */
956         if (mcp251x_enable_dma) {
957                 spi->dev.coherent_dma_mask = ~0;
958
959                 /*
960                  * Minimum coherent DMA allocation is PAGE_SIZE, so allocate
961                  * that much and share it between Tx and Rx DMA buffers.
962                  */
963                 priv->spi_tx_buf = dma_alloc_coherent(&spi->dev,
964                                                       PAGE_SIZE,
965                                                       &priv->spi_tx_dma,
966                                                       GFP_DMA);
967
968                 if (priv->spi_tx_buf) {
969                         priv->spi_rx_buf = (u8 *)(priv->spi_tx_buf +
970                                                   (PAGE_SIZE / 2));
971                         priv->spi_rx_dma = (dma_addr_t)(priv->spi_tx_dma +
972                                                         (PAGE_SIZE / 2));
973                 } else {
974                         /* Fall back to non-DMA */
975                         mcp251x_enable_dma = 0;
976                 }
977         }
978
979         /* Allocate non-DMA buffers */
980         if (!mcp251x_enable_dma) {
981                 priv->spi_tx_buf = kmalloc(SPI_TRANSFER_BUF_LEN, GFP_KERNEL);
982                 if (!priv->spi_tx_buf) {
983                         ret = -ENOMEM;
984                         goto error_tx_buf;
985                 }
986                 priv->spi_rx_buf = kmalloc(SPI_TRANSFER_BUF_LEN, GFP_KERNEL);
987                 if (!priv->spi_rx_buf) {
988                         ret = -ENOMEM;
989                         goto error_rx_buf;
990                 }
991         }
992
993         if (pdata->power_enable)
994                 pdata->power_enable(1);
995
996         /* Call out to platform specific setup */
997         if (pdata->board_specific_setup)
998                 pdata->board_specific_setup(spi);
999
1000         SET_NETDEV_DEV(net, &spi->dev);
1001
1002         priv->wq = create_freezeable_workqueue("mcp251x_wq");
1003
1004         INIT_WORK(&priv->tx_work, mcp251x_tx_work_handler);
1005         INIT_WORK(&priv->irq_work, mcp251x_irq_work_handler);
1006
1007         /* Configure the SPI bus */
1008         spi->mode = SPI_MODE_0;
1009         spi->bits_per_word = 8;
1010         spi_setup(spi);
1011
1012         if (!mcp251x_hw_probe(spi)) {
1013                 dev_info(&spi->dev, "Probe failed\n");
1014                 goto error_probe;
1015         }
1016         mcp251x_hw_sleep(spi);
1017
1018         if (pdata->transceiver_enable)
1019                 pdata->transceiver_enable(0);
1020
1021         ret = register_candev(net);
1022         if (!ret) {
1023                 dev_info(&spi->dev, "probed\n");
1024                 return ret;
1025         }
1026 error_probe:
1027         if (!mcp251x_enable_dma)
1028                 kfree(priv->spi_rx_buf);
1029 error_rx_buf:
1030         if (!mcp251x_enable_dma)
1031                 kfree(priv->spi_tx_buf);
1032 error_tx_buf:
1033         free_candev(net);
1034         if (mcp251x_enable_dma)
1035                 dma_free_coherent(&spi->dev, PAGE_SIZE,
1036                                   priv->spi_tx_buf, priv->spi_tx_dma);
1037 error_alloc:
1038         if (pdata->power_enable)
1039                 pdata->power_enable(0);
1040         dev_err(&spi->dev, "probe failed\n");
1041 error_out:
1042         return ret;
1043 }
1044
1045 static int __devexit mcp251x_can_remove(struct spi_device *spi)
1046 {
1047         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
1048         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
1049         struct net_device *net = priv->net;
1050
1051         unregister_candev(net);
1052         free_candev(net);
1053
1054         priv->force_quit = 1;
1055         flush_workqueue(priv->wq);
1056         destroy_workqueue(priv->wq);
1057
1058         if (mcp251x_enable_dma) {
1059                 dma_free_coherent(&spi->dev, PAGE_SIZE,
1060                                   priv->spi_tx_buf, priv->spi_tx_dma);
1061         } else {
1062                 kfree(priv->spi_tx_buf);
1063                 kfree(priv->spi_rx_buf);
1064         }
1065
1066         if (pdata->power_enable)
1067                 pdata->power_enable(0);
1068
1069         return 0;
1070 }
1071
1072 #ifdef CONFIG_PM
1073 static int mcp251x_can_suspend(struct spi_device *spi, pm_message_t state)
1074 {
1075         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
1076         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
1077         struct net_device *net = priv->net;
1078
1079         if (netif_running(net)) {
1080                 netif_device_detach(net);
1081
1082                 mcp251x_hw_sleep(spi);
1083                 if (pdata->transceiver_enable)
1084                         pdata->transceiver_enable(0);
1085                 priv->after_suspend = AFTER_SUSPEND_UP;
1086         } else {
1087                 priv->after_suspend = AFTER_SUSPEND_DOWN;
1088         }
1089
1090         if (pdata->power_enable) {
1091                 pdata->power_enable(0);
1092                 priv->after_suspend |= AFTER_SUSPEND_POWER;
1093         }
1094
1095         return 0;
1096 }
1097
1098 static int mcp251x_can_resume(struct spi_device *spi)
1099 {
1100         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
1101         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
1102
1103         if (priv->after_suspend & AFTER_SUSPEND_POWER) {
1104                 pdata->power_enable(1);
1105                 queue_work(priv->wq, &priv->irq_work);
1106         } else {
1107                 if (priv->after_suspend & AFTER_SUSPEND_UP) {
1108                         if (pdata->transceiver_enable)
1109                                 pdata->transceiver_enable(1);
1110                         queue_work(priv->wq, &priv->irq_work);
1111                 } else {
1112                         priv->after_suspend = 0;
1113                 }
1114         }
1115         return 0;
1116 }
1117 #else
1118 #define mcp251x_can_suspend NULL
1119 #define mcp251x_can_resume NULL
1120 #endif
1121
1122 static struct spi_driver mcp251x_can_driver = {
1123         .driver = {
1124                 .name = DEVICE_NAME,
1125                 .bus = &spi_bus_type,
1126                 .owner = THIS_MODULE,
1127         },
1128
1129         .probe = mcp251x_can_probe,
1130         .remove = __devexit_p(mcp251x_can_remove),
1131         .suspend = mcp251x_can_suspend,
1132         .resume = mcp251x_can_resume,
1133 };
1134
1135 static int __init mcp251x_can_init(void)
1136 {
1137         return spi_register_driver(&mcp251x_can_driver);
1138 }
1139
1140 static void __exit mcp251x_can_exit(void)
1141 {
1142         spi_unregister_driver(&mcp251x_can_driver);
1143 }
1144
1145 module_init(mcp251x_can_init);
1146 module_exit(mcp251x_can_exit);
1147
1148 MODULE_AUTHOR("Chris Elston <celston@katalix.com>, "
1149               "Christian Pellegrin <chripell@evolware.org>");
1150 MODULE_DESCRIPTION("Microchip 251x CAN driver");
1151 MODULE_LICENSE("GPL v2");