]> rtime.felk.cvut.cz Git - socketcan-devel.git/blob - kernel/2.6/drivers/net/can/mcp251x.c
1f6d772f8c9b41e73ea78e7e8f0de141759a9713
[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         struct completion awake;
238         int wake;
239         int force_quit;
240         int after_suspend;
241 #define AFTER_SUSPEND_UP 1
242 #define AFTER_SUSPEND_DOWN 2
243 #define AFTER_SUSPEND_POWER 4
244 #define AFTER_SUSPEND_RESTART 8
245         int restart_tx;
246 };
247
248 static void mcp251x_clean(struct net_device *net)
249 {
250         struct mcp251x_priv *priv = netdev_priv(net);
251
252         net->stats.tx_errors++;
253         if (priv->tx_skb)
254                 dev_kfree_skb(priv->tx_skb);
255         if (priv->tx_len)
256                 can_free_echo_skb(priv->net, 0);
257         priv->tx_skb = NULL;
258         priv->tx_len = 0;
259 }
260
261 /*
262  * Note about handling of error return of mcp251x_spi_trans: accessing
263  * registers via SPI is not really different conceptually than using
264  * normal I/O assembler instructions, although it's much more
265  * complicated from a practical POV. So it's not advisable to always
266  * check the return value of this function. Imagine that every
267  * read{b,l}, write{b,l} and friends would be bracketed in "if ( < 0)
268  * error();", it would be a great mess (well there are some situation
269  * when exception handling C++ like could be useful after all). So we
270  * just check that transfers are OK at the beginning of our
271  * conversation with the chip and to avoid doing really nasty things
272  * (like injecting bogus packets in the network stack).
273  */
274 static int mcp251x_spi_trans(struct spi_device *spi, int len)
275 {
276         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
277         struct spi_transfer t = {
278                 .tx_buf = priv->spi_tx_buf,
279                 .rx_buf = priv->spi_rx_buf,
280                 .len = len,
281                 .cs_change = 0,
282         };
283         struct spi_message m;
284         int ret;
285
286         spi_message_init(&m);
287
288         if (mcp251x_enable_dma) {
289                 t.tx_dma = priv->spi_tx_dma;
290                 t.rx_dma = priv->spi_rx_dma;
291                 m.is_dma_mapped = 1;
292         }
293
294         spi_message_add_tail(&t, &m);
295
296         ret = spi_sync(spi, &m);
297         if (ret)
298                 dev_err(&spi->dev, "spi transfer failed: ret = %d\n", ret);
299         return ret;
300 }
301
302 static u8 mcp251x_read_reg(struct spi_device *spi, uint8_t reg)
303 {
304         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
305         u8 val = 0;
306
307         mutex_lock(&priv->spi_lock);
308
309         priv->spi_tx_buf[0] = INSTRUCTION_READ;
310         priv->spi_tx_buf[1] = reg;
311
312         mcp251x_spi_trans(spi, 3);
313         val = priv->spi_rx_buf[2];
314
315         mutex_unlock(&priv->spi_lock);
316
317         return val;
318 }
319
320 static void mcp251x_write_reg(struct spi_device *spi, u8 reg, uint8_t val)
321 {
322         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
323
324         mutex_lock(&priv->spi_lock);
325
326         priv->spi_tx_buf[0] = INSTRUCTION_WRITE;
327         priv->spi_tx_buf[1] = reg;
328         priv->spi_tx_buf[2] = val;
329
330         mcp251x_spi_trans(spi, 3);
331
332         mutex_unlock(&priv->spi_lock);
333 }
334
335 static void mcp251x_write_bits(struct spi_device *spi, u8 reg,
336                                u8 mask, uint8_t val)
337 {
338         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
339
340         mutex_lock(&priv->spi_lock);
341
342         priv->spi_tx_buf[0] = INSTRUCTION_BIT_MODIFY;
343         priv->spi_tx_buf[1] = reg;
344         priv->spi_tx_buf[2] = mask;
345         priv->spi_tx_buf[3] = val;
346
347         mcp251x_spi_trans(spi, 4);
348
349         mutex_unlock(&priv->spi_lock);
350 }
351
352 static void mcp251x_hw_tx_frame(struct spi_device *spi, u8 *buf,
353                                 int len, int tx_buf_idx)
354 {
355         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
356         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
357
358         if (pdata->model == CAN_MCP251X_MCP2510) {
359                 int i;
360
361                 for (i = 1; i < TXBDAT_OFF + len; i++)
362                         mcp251x_write_reg(spi, TXBCTRL(tx_buf_idx) + i,
363                                           buf[i]);
364         } else {
365                 mutex_lock(&priv->spi_lock);
366                 memcpy(priv->spi_tx_buf, buf, TXBDAT_OFF + len);
367                 mcp251x_spi_trans(spi, TXBDAT_OFF + len);
368                 mutex_unlock(&priv->spi_lock);
369         }
370 }
371
372 static void mcp251x_hw_tx(struct spi_device *spi, struct can_frame *frame,
373                           int tx_buf_idx)
374 {
375         u32 sid, eid, exide, rtr;
376         u8 buf[SPI_TRANSFER_BUF_LEN];
377
378         exide = (frame->can_id & CAN_EFF_FLAG) ? 1 : 0; /* Extended ID Enable */
379         if (exide)
380                 sid = (frame->can_id & CAN_EFF_MASK) >> 18;
381         else
382                 sid = frame->can_id & CAN_SFF_MASK; /* Standard ID */
383         eid = frame->can_id & CAN_EFF_MASK; /* Extended ID */
384         rtr = (frame->can_id & CAN_RTR_FLAG) ? 1 : 0; /* Remote transmission */
385
386         buf[TXBCTRL_OFF] = INSTRUCTION_LOAD_TXB(tx_buf_idx);
387         buf[TXBSIDH_OFF] = sid >> SIDH_SHIFT;
388         buf[TXBSIDL_OFF] = ((sid & SIDL_SID_MASK) << SIDL_SID_SHIFT) |
389                 (exide << SIDL_EXIDE_SHIFT) |
390                 ((eid >> SIDL_EID_SHIFT) & SIDL_EID_MASK);
391         buf[TXBEID8_OFF] = GET_BYTE(eid, 1);
392         buf[TXBEID0_OFF] = GET_BYTE(eid, 0);
393         buf[TXBDLC_OFF] = (rtr << DLC_RTR_SHIFT) | frame->can_dlc;
394         memcpy(buf + TXBDAT_OFF, frame->data, frame->can_dlc);
395         mcp251x_hw_tx_frame(spi, buf, frame->can_dlc, tx_buf_idx);
396         mcp251x_write_reg(spi, TXBCTRL(tx_buf_idx), TXBCTRL_TXREQ);
397 }
398
399 static void mcp251x_hw_rx_frame(struct spi_device *spi, u8 *buf,
400                                 int buf_idx)
401 {
402         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
403         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
404
405         if (pdata->model == CAN_MCP251X_MCP2510) {
406                 int i, len;
407
408                 for (i = 1; i < RXBDAT_OFF; i++)
409                         buf[i] = mcp251x_read_reg(spi, RXBCTRL(buf_idx) + i);
410
411                 len = get_can_dlc(buf[RXBDLC_OFF] & RXBDLC_LEN_MASK);
412                 for (; i < (RXBDAT_OFF + len); i++)
413                         buf[i] = mcp251x_read_reg(spi, RXBCTRL(buf_idx) + i);
414         } else {
415                 mutex_lock(&priv->spi_lock);
416
417                 priv->spi_tx_buf[RXBCTRL_OFF] = INSTRUCTION_READ_RXB(buf_idx);
418                 mcp251x_spi_trans(spi, SPI_TRANSFER_BUF_LEN);
419                 memcpy(buf, priv->spi_rx_buf, SPI_TRANSFER_BUF_LEN);
420
421                 mutex_unlock(&priv->spi_lock);
422         }
423 }
424
425 static void mcp251x_hw_rx(struct spi_device *spi, int buf_idx)
426 {
427         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
428         struct sk_buff *skb;
429         struct can_frame *frame;
430         u8 buf[SPI_TRANSFER_BUF_LEN];
431
432         skb = alloc_can_skb(priv->net, &frame);
433         if (!skb) {
434                 dev_err(&spi->dev, "cannot allocate RX skb\n");
435                 priv->net->stats.rx_dropped++;
436                 return;
437         }
438
439         mcp251x_hw_rx_frame(spi, buf, buf_idx);
440         if (buf[RXBSIDL_OFF] & RXBSIDL_IDE) {
441                 /* Extended ID format */
442                 frame->can_id = CAN_EFF_FLAG;
443                 frame->can_id |=
444                         /* Extended ID part */
445                         SET_BYTE(buf[RXBSIDL_OFF] & RXBSIDL_EID, 2) |
446                         SET_BYTE(buf[RXBEID8_OFF], 1) |
447                         SET_BYTE(buf[RXBEID0_OFF], 0) |
448                         /* Standard ID part */
449                         (((buf[RXBSIDH_OFF] << RXBSIDH_SHIFT) |
450                           (buf[RXBSIDL_OFF] >> RXBSIDL_SHIFT)) << 18);
451                 /* Remote transmission request */
452                 if (buf[RXBDLC_OFF] & RXBDLC_RTR)
453                         frame->can_id |= CAN_RTR_FLAG;
454         } else {
455                 /* Standard ID format */
456                 frame->can_id =
457                         (buf[RXBSIDH_OFF] << RXBSIDH_SHIFT) |
458                         (buf[RXBSIDL_OFF] >> RXBSIDL_SHIFT);
459         }
460         /* Data length */
461         frame->can_dlc = get_can_dlc(buf[RXBDLC_OFF] & RXBDLC_LEN_MASK);
462         memcpy(frame->data, buf + RXBDAT_OFF, frame->can_dlc);
463
464         priv->net->stats.rx_packets++;
465         priv->net->stats.rx_bytes += frame->can_dlc;
466         netif_rx(skb);
467 }
468
469 static void mcp251x_hw_sleep(struct spi_device *spi)
470 {
471         mcp251x_write_reg(spi, CANCTRL, CANCTRL_REQOP_SLEEP);
472 }
473
474 static void mcp251x_hw_wakeup(struct spi_device *spi)
475 {
476         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
477
478         priv->wake = 1;
479
480         /* Can only wake up by generating a wake-up interrupt. */
481         mcp251x_write_bits(spi, CANINTE, CANINTE_WAKIE, CANINTE_WAKIE);
482         mcp251x_write_bits(spi, CANINTF, CANINTF_WAKIF, CANINTF_WAKIF);
483
484         /* Wait until the device is awake */
485         if (!wait_for_completion_timeout(&priv->awake, HZ))
486                 dev_err(&spi->dev, "MCP251x didn't wake-up\n");
487 }
488
489 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,32)
490 static int mcp251x_hard_start_xmit(struct sk_buff *skb, struct net_device *net)
491 #else
492 static netdev_tx_t mcp251x_hard_start_xmit(struct sk_buff *skb,
493                                            struct net_device *net)
494 #endif
495 {
496         struct mcp251x_priv *priv = netdev_priv(net);
497         struct spi_device *spi = priv->spi;
498
499         if (priv->tx_skb || priv->tx_len) {
500                 dev_warn(&spi->dev, "hard_xmit called while tx busy\n");
501                 netif_stop_queue(net);
502                 return NETDEV_TX_BUSY;
503         }
504
505         if (skb->len != sizeof(struct can_frame)) {
506                 dev_err(&spi->dev, "dropping packet - bad length\n");
507                 dev_kfree_skb(skb);
508                 net->stats.tx_dropped++;
509                 return NETDEV_TX_OK;
510         }
511
512         netif_stop_queue(net);
513         priv->tx_skb = skb;
514         net->trans_start = jiffies;
515         queue_work(priv->wq, &priv->tx_work);
516
517         return NETDEV_TX_OK;
518 }
519
520 static int mcp251x_do_set_mode(struct net_device *net, enum can_mode mode)
521 {
522         struct mcp251x_priv *priv = netdev_priv(net);
523
524         switch (mode) {
525         case CAN_MODE_START:
526                 /* We have to delay work since SPI I/O may sleep */
527                 priv->can.state = CAN_STATE_ERROR_ACTIVE;
528                 priv->restart_tx = 1;
529                 if (priv->can.restart_ms == 0)
530                         priv->after_suspend = AFTER_SUSPEND_RESTART;
531                 queue_work(priv->wq, &priv->irq_work);
532                 break;
533         default:
534                 return -EOPNOTSUPP;
535         }
536
537         return 0;
538 }
539
540 static void mcp251x_set_normal_mode(struct spi_device *spi)
541 {
542         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
543         unsigned long timeout;
544
545         /* Enable interrupts */
546         mcp251x_write_reg(spi, CANINTE,
547                           CANINTE_ERRIE | CANINTE_TX2IE | CANINTE_TX1IE |
548                           CANINTE_TX0IE | CANINTE_RX1IE | CANINTE_RX0IE |
549                           CANINTF_MERRF);
550
551         if (priv->can.ctrlmode & CAN_CTRLMODE_LOOPBACK) {
552                 /* Put device into loopback mode */
553                 mcp251x_write_reg(spi, CANCTRL, CANCTRL_REQOP_LOOPBACK);
554         } else {
555                 /* Put device into normal mode */
556                 mcp251x_write_reg(spi, CANCTRL, CANCTRL_REQOP_NORMAL);
557
558                 /* Wait for the device to enter normal mode */
559                 timeout = jiffies + HZ;
560                 while (mcp251x_read_reg(spi, CANSTAT) & CANCTRL_REQOP_MASK) {
561                         schedule();
562                         if (time_after(jiffies, timeout)) {
563                                 dev_err(&spi->dev, "MCP251x didn't"
564                                         " enter in normal mode\n");
565                                 return;
566                         }
567                 }
568         }
569         priv->can.state = CAN_STATE_ERROR_ACTIVE;
570 }
571
572 static int mcp251x_do_set_bittiming(struct net_device *net)
573 {
574         struct mcp251x_priv *priv = netdev_priv(net);
575         struct can_bittiming *bt = &priv->can.bittiming;
576         struct spi_device *spi = priv->spi;
577
578         mcp251x_write_reg(spi, CNF1, ((bt->sjw - 1) << CNF1_SJW_SHIFT) |
579                           (bt->brp - 1));
580         mcp251x_write_reg(spi, CNF2, CNF2_BTLMODE |
581                           (priv->can.ctrlmode & CAN_CTRLMODE_3_SAMPLES ?
582                            CNF2_SAM : 0) |
583                           ((bt->phase_seg1 - 1) << CNF2_PS1_SHIFT) |
584                           (bt->prop_seg - 1));
585         mcp251x_write_bits(spi, CNF3, CNF3_PHSEG2_MASK,
586                            (bt->phase_seg2 - 1));
587         dev_info(&spi->dev, "CNF: 0x%02x 0x%02x 0x%02x\n",
588                  mcp251x_read_reg(spi, CNF1),
589                  mcp251x_read_reg(spi, CNF2),
590                  mcp251x_read_reg(spi, CNF3));
591
592         return 0;
593 }
594
595 static int mcp251x_setup(struct net_device *net, struct mcp251x_priv *priv,
596                          struct spi_device *spi)
597 {
598         mcp251x_do_set_bittiming(net);
599
600         /* Enable RX0->RX1 buffer roll over and disable filters */
601         mcp251x_write_bits(spi, RXBCTRL(0),
602                            RXBCTRL_BUKT | RXBCTRL_RXM0 | RXBCTRL_RXM1,
603                            RXBCTRL_BUKT | RXBCTRL_RXM0 | RXBCTRL_RXM1);
604         mcp251x_write_bits(spi, RXBCTRL(1),
605                            RXBCTRL_RXM0 | RXBCTRL_RXM1,
606                            RXBCTRL_RXM0 | RXBCTRL_RXM1);
607         return 0;
608 }
609
610 static void mcp251x_hw_reset(struct spi_device *spi)
611 {
612         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
613         int ret;
614
615         mutex_lock(&priv->spi_lock);
616
617         priv->spi_tx_buf[0] = INSTRUCTION_RESET;
618
619         ret = spi_write(spi, priv->spi_tx_buf, 1);
620
621         mutex_unlock(&priv->spi_lock);
622
623         if (ret)
624                 dev_err(&spi->dev, "reset failed: ret = %d\n", ret);
625         /* Wait for reset to finish */
626         mdelay(10);
627 }
628
629 static int mcp251x_hw_probe(struct spi_device *spi)
630 {
631         int st1, st2;
632
633         mcp251x_hw_reset(spi);
634
635         /*
636          * Please note that these are "magic values" based on after
637          * reset defaults taken from data sheet which allows us to see
638          * if we really have a chip on the bus (we avoid common all
639          * zeroes or all ones situations)
640          */
641         st1 = mcp251x_read_reg(spi, CANSTAT) & 0xEE;
642         st2 = mcp251x_read_reg(spi, CANCTRL) & 0x17;
643
644         dev_dbg(&spi->dev, "CANSTAT 0x%02x CANCTRL 0x%02x\n", st1, st2);
645
646         /* Check for power up default values */
647         return (st1 == 0x80 && st2 == 0x07) ? 1 : 0;
648 }
649
650 static irqreturn_t mcp251x_can_isr(int irq, void *dev_id)
651 {
652         struct net_device *net = (struct net_device *)dev_id;
653         struct mcp251x_priv *priv = netdev_priv(net);
654
655         /* Schedule bottom half */
656         if (!work_pending(&priv->irq_work))
657                 queue_work(priv->wq, &priv->irq_work);
658
659         return IRQ_HANDLED;
660 }
661
662 static int mcp251x_open(struct net_device *net)
663 {
664         struct mcp251x_priv *priv = netdev_priv(net);
665         struct spi_device *spi = priv->spi;
666         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
667         int ret;
668
669         ret = open_candev(net);
670         if (ret) {
671                 dev_err(&spi->dev, "unable to set initial baudrate!\n");
672                 return ret;
673         }
674
675         if (pdata->transceiver_enable)
676                 pdata->transceiver_enable(1);
677
678         priv->force_quit = 0;
679         priv->tx_skb = NULL;
680         priv->tx_len = 0;
681
682         ret = request_irq(spi->irq, mcp251x_can_isr,
683                           IRQF_TRIGGER_FALLING, DEVICE_NAME, net);
684         if (ret) {
685                 dev_err(&spi->dev, "failed to acquire irq %d\n", spi->irq);
686                 if (pdata->transceiver_enable)
687                         pdata->transceiver_enable(0);
688                 close_candev(net);
689                 return ret;
690         }
691
692         mcp251x_hw_wakeup(spi);
693         mcp251x_hw_reset(spi);
694         ret = mcp251x_setup(net, priv, spi);
695         if (ret) {
696                 free_irq(spi->irq, net);
697                 mcp251x_hw_sleep(spi);
698                 if (pdata->transceiver_enable)
699                         pdata->transceiver_enable(0);
700                 close_candev(net);
701                 return ret;
702         }
703         mcp251x_set_normal_mode(spi);
704         netif_wake_queue(net);
705
706         return 0;
707 }
708
709 static int mcp251x_stop(struct net_device *net)
710 {
711         struct mcp251x_priv *priv = netdev_priv(net);
712         struct spi_device *spi = priv->spi;
713         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
714
715         close_candev(net);
716
717         /* Disable and clear pending interrupts */
718         mcp251x_write_reg(spi, CANINTE, 0x00);
719         mcp251x_write_reg(spi, CANINTF, 0x00);
720
721         priv->force_quit = 1;
722         free_irq(spi->irq, net);
723         flush_workqueue(priv->wq);
724
725         mcp251x_write_reg(spi, TXBCTRL(0), 0);
726         if (priv->tx_skb || priv->tx_len)
727                 mcp251x_clean(net);
728
729         mcp251x_hw_sleep(spi);
730
731         if (pdata->transceiver_enable)
732                 pdata->transceiver_enable(0);
733
734         priv->can.state = CAN_STATE_STOPPED;
735
736         return 0;
737 }
738
739 static void mcp251x_tx_work_handler(struct work_struct *ws)
740 {
741         struct mcp251x_priv *priv = container_of(ws, struct mcp251x_priv,
742                                                  tx_work);
743         struct spi_device *spi = priv->spi;
744         struct net_device *net = priv->net;
745         struct can_frame *frame;
746
747         if (priv->tx_skb) {
748                 frame = (struct can_frame *)priv->tx_skb->data;
749
750                 if (priv->can.state == CAN_STATE_BUS_OFF) {
751                         mcp251x_clean(net);
752                         netif_wake_queue(net);
753                         return;
754                 }
755                 if (frame->can_dlc > CAN_FRAME_MAX_DATA_LEN)
756                         frame->can_dlc = CAN_FRAME_MAX_DATA_LEN;
757                 mcp251x_hw_tx(spi, frame, 0);
758                 priv->tx_len = 1 + frame->can_dlc;
759                 can_put_echo_skb(priv->tx_skb, net, 0);
760                 priv->tx_skb = NULL;
761         }
762 }
763
764 static void mcp251x_irq_work_handler(struct work_struct *ws)
765 {
766         struct mcp251x_priv *priv = container_of(ws, struct mcp251x_priv,
767                                                  irq_work);
768         struct spi_device *spi = priv->spi;
769         struct net_device *net = priv->net;
770         u8 txbnctrl;
771         u8 intf;
772         enum can_state new_state;
773
774         if (priv->after_suspend) {
775                 mdelay(10);
776                 mcp251x_hw_reset(spi);
777                 mcp251x_setup(net, priv, spi);
778                 if (priv->after_suspend & AFTER_SUSPEND_RESTART) {
779                         mcp251x_set_normal_mode(spi);
780                 } else if (priv->after_suspend & AFTER_SUSPEND_UP) {
781                         netif_device_attach(net);
782                         /* Clean since we lost tx buffer */
783                         if (priv->tx_skb || priv->tx_len) {
784                                 mcp251x_clean(net);
785                                 netif_wake_queue(net);
786                         }
787                         mcp251x_set_normal_mode(spi);
788                 } else {
789                         mcp251x_hw_sleep(spi);
790                 }
791                 priv->after_suspend = 0;
792         }
793
794         if (priv->can.restart_ms == 0 && priv->can.state == CAN_STATE_BUS_OFF)
795                 return;
796
797         while (!priv->force_quit && !freezing(current)) {
798                 u8 eflag = mcp251x_read_reg(spi, EFLG);
799                 int can_id = 0, data1 = 0;
800
801                 mcp251x_write_reg(spi, EFLG, 0x00);
802
803                 if (priv->restart_tx) {
804                         priv->restart_tx = 0;
805                         mcp251x_write_reg(spi, TXBCTRL(0), 0);
806                         if (priv->tx_skb || priv->tx_len)
807                                 mcp251x_clean(net);
808                         netif_wake_queue(net);
809                         can_id |= CAN_ERR_RESTARTED;
810                 }
811
812                 if (priv->wake) {
813                         /* Wait whilst the device wakes up */
814                         mdelay(10);
815                         priv->wake = 0;
816                 }
817
818                 intf = mcp251x_read_reg(spi, CANINTF);
819                 mcp251x_write_bits(spi, CANINTF, intf, 0x00);
820
821                 /* Update can state */
822                 if (eflag & EFLG_TXBO) {
823                         new_state = CAN_STATE_BUS_OFF;
824                         can_id |= CAN_ERR_BUSOFF;
825                 } else if (eflag & EFLG_TXEP) {
826                         new_state = CAN_STATE_ERROR_PASSIVE;
827                         can_id |= CAN_ERR_CRTL;
828                         data1 |= CAN_ERR_CRTL_TX_PASSIVE;
829                 } else if (eflag & EFLG_RXEP) {
830                         new_state = CAN_STATE_ERROR_PASSIVE;
831                         can_id |= CAN_ERR_CRTL;
832                         data1 |= CAN_ERR_CRTL_RX_PASSIVE;
833                 } else if (eflag & EFLG_TXWAR) {
834                         new_state = CAN_STATE_ERROR_WARNING;
835                         can_id |= CAN_ERR_CRTL;
836                         data1 |= CAN_ERR_CRTL_TX_WARNING;
837                 } else if (eflag & EFLG_RXWAR) {
838                         new_state = CAN_STATE_ERROR_WARNING;
839                         can_id |= CAN_ERR_CRTL;
840                         data1 |= CAN_ERR_CRTL_RX_WARNING;
841                 } else {
842                         new_state = CAN_STATE_ERROR_ACTIVE;
843                 }
844
845                 /* Update can state statistics */
846                 switch (priv->can.state) {
847                 case CAN_STATE_ERROR_ACTIVE:
848                         if (new_state >= CAN_STATE_ERROR_WARNING &&
849                             new_state <= CAN_STATE_BUS_OFF)
850                                 priv->can.can_stats.error_warning++;
851                 case CAN_STATE_ERROR_WARNING:   /* fallthrough */
852                         if (new_state >= CAN_STATE_ERROR_PASSIVE &&
853                             new_state <= CAN_STATE_BUS_OFF)
854                                 priv->can.can_stats.error_passive++;
855                         break;
856                 default:
857                         break;
858                 }
859                 priv->can.state = new_state;
860
861                 if ((intf & CANINTF_ERRIF) || (can_id & CAN_ERR_RESTARTED)) {
862                         struct sk_buff *skb;
863                         struct can_frame *frame;
864
865                         /* Create error frame */
866                         skb = alloc_can_err_skb(net, &frame);
867                         if (skb) {
868                                 /* Set error frame flags based on bus state */
869                                 frame->can_id = can_id;
870                                 frame->data[1] = data1;
871
872                                 /* Update net stats for overflows */
873                                 if (eflag & (EFLG_RX0OVR | EFLG_RX1OVR)) {
874                                         if (eflag & EFLG_RX0OVR)
875                                                 net->stats.rx_over_errors++;
876                                         if (eflag & EFLG_RX1OVR)
877                                                 net->stats.rx_over_errors++;
878                                         frame->can_id |= CAN_ERR_CRTL;
879                                         frame->data[1] |=
880                                                 CAN_ERR_CRTL_RX_OVERFLOW;
881                                 }
882
883                                 netif_rx(skb);
884                         } else {
885                                 dev_info(&spi->dev,
886                                          "cannot allocate error skb\n");
887                         }
888                 }
889
890                 if (priv->can.state == CAN_STATE_BUS_OFF) {
891                         if (priv->can.restart_ms == 0) {
892                                 can_bus_off(net);
893                                 mcp251x_hw_sleep(spi);
894                                 return;
895                         }
896                 }
897
898                 if (intf == 0)
899                         break;
900
901                 if (intf & CANINTF_WAKIF)
902                         complete(&priv->awake);
903
904                 if (intf & CANINTF_MERRF) {
905                         /* If there are pending Tx buffers, restart queue */
906                         txbnctrl = mcp251x_read_reg(spi, TXBCTRL(0));
907                         if (!(txbnctrl & TXBCTRL_TXREQ)) {
908                                 if (priv->tx_skb || priv->tx_len)
909                                         mcp251x_clean(net);
910                                 netif_wake_queue(net);
911                         }
912                 }
913
914                 if (intf & (CANINTF_TX2IF | CANINTF_TX1IF | CANINTF_TX0IF)) {
915                         net->stats.tx_packets++;
916                         net->stats.tx_bytes += priv->tx_len - 1;
917                         if (priv->tx_len) {
918                                 can_get_echo_skb(net, 0);
919                                 priv->tx_len = 0;
920                         }
921                         netif_wake_queue(net);
922                 }
923
924                 if (intf & CANINTF_RX0IF)
925                         mcp251x_hw_rx(spi, 0);
926
927                 if (intf & CANINTF_RX1IF)
928                         mcp251x_hw_rx(spi, 1);
929         }
930 }
931
932 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
933 static const struct net_device_ops mcp251x_netdev_ops = {
934         .ndo_open = mcp251x_open,
935         .ndo_stop = mcp251x_stop,
936         .ndo_start_xmit = mcp251x_hard_start_xmit,
937 };
938 #endif
939
940 static int __devinit mcp251x_can_probe(struct spi_device *spi)
941 {
942         struct net_device *net;
943         struct mcp251x_priv *priv;
944         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
945         int ret = -ENODEV;
946
947         if (!pdata)
948                 /* Platform data is required for osc freq */
949                 goto error_out;
950
951         /* Allocate can/net device */
952         net = alloc_candev(sizeof(struct mcp251x_priv), TX_ECHO_SKB_MAX);
953         if (!net) {
954                 ret = -ENOMEM;
955                 goto error_alloc;
956         }
957
958 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,28)
959         net->netdev_ops = &mcp251x_netdev_ops;
960 #else
961         net->open = mcp251x_open;
962         net->stop = mcp251x_stop;
963         net->hard_start_xmit = mcp251x_hard_start_xmit;
964 #endif
965         net->flags |= IFF_ECHO;
966
967         priv = netdev_priv(net);
968         priv->can.bittiming_const = &mcp251x_bittiming_const;
969         priv->can.do_set_mode = mcp251x_do_set_mode;
970         priv->can.clock.freq = pdata->oscillator_frequency / 2;
971         priv->net = net;
972         dev_set_drvdata(&spi->dev, priv);
973
974         priv->spi = spi;
975         mutex_init(&priv->spi_lock);
976
977         /* If requested, allocate DMA buffers */
978         if (mcp251x_enable_dma) {
979                 spi->dev.coherent_dma_mask = ~0;
980
981                 /*
982                  * Minimum coherent DMA allocation is PAGE_SIZE, so allocate
983                  * that much and share it between Tx and Rx DMA buffers.
984                  */
985                 priv->spi_tx_buf = dma_alloc_coherent(&spi->dev,
986                                                       PAGE_SIZE,
987                                                       &priv->spi_tx_dma,
988                                                       GFP_DMA);
989
990                 if (priv->spi_tx_buf) {
991                         priv->spi_rx_buf = (u8 *)(priv->spi_tx_buf +
992                                                   (PAGE_SIZE / 2));
993                         priv->spi_rx_dma = (dma_addr_t)(priv->spi_tx_dma +
994                                                         (PAGE_SIZE / 2));
995                 } else {
996                         /* Fall back to non-DMA */
997                         mcp251x_enable_dma = 0;
998                 }
999         }
1000
1001         /* Allocate non-DMA buffers */
1002         if (!mcp251x_enable_dma) {
1003                 priv->spi_tx_buf = kmalloc(SPI_TRANSFER_BUF_LEN, GFP_KERNEL);
1004                 if (!priv->spi_tx_buf) {
1005                         ret = -ENOMEM;
1006                         goto error_tx_buf;
1007                 }
1008                 priv->spi_rx_buf = kmalloc(SPI_TRANSFER_BUF_LEN, GFP_KERNEL);
1009                 if (!priv->spi_rx_buf) {
1010                         ret = -ENOMEM;
1011                         goto error_rx_buf;
1012                 }
1013         }
1014
1015         if (pdata->power_enable)
1016                 pdata->power_enable(1);
1017
1018         /* Call out to platform specific setup */
1019         if (pdata->board_specific_setup)
1020                 pdata->board_specific_setup(spi);
1021
1022         SET_NETDEV_DEV(net, &spi->dev);
1023
1024         priv->wq = create_freezeable_workqueue("mcp251x_wq");
1025
1026         INIT_WORK(&priv->tx_work, mcp251x_tx_work_handler);
1027         INIT_WORK(&priv->irq_work, mcp251x_irq_work_handler);
1028
1029         init_completion(&priv->awake);
1030
1031         /* Configure the SPI bus */
1032         spi->mode = SPI_MODE_0;
1033         spi->bits_per_word = 8;
1034         spi_setup(spi);
1035
1036         if (!mcp251x_hw_probe(spi)) {
1037                 dev_info(&spi->dev, "Probe failed\n");
1038                 goto error_probe;
1039         }
1040         mcp251x_hw_sleep(spi);
1041
1042         if (pdata->transceiver_enable)
1043                 pdata->transceiver_enable(0);
1044
1045         ret = register_candev(net);
1046         if (!ret) {
1047                 dev_info(&spi->dev, "probed\n");
1048                 return ret;
1049         }
1050 error_probe:
1051         if (!mcp251x_enable_dma)
1052                 kfree(priv->spi_rx_buf);
1053 error_rx_buf:
1054         if (!mcp251x_enable_dma)
1055                 kfree(priv->spi_tx_buf);
1056 error_tx_buf:
1057         free_candev(net);
1058         if (mcp251x_enable_dma)
1059                 dma_free_coherent(&spi->dev, PAGE_SIZE,
1060                                   priv->spi_tx_buf, priv->spi_tx_dma);
1061 error_alloc:
1062         if (pdata->power_enable)
1063                 pdata->power_enable(0);
1064         dev_err(&spi->dev, "probe failed\n");
1065 error_out:
1066         return ret;
1067 }
1068
1069 static int __devexit mcp251x_can_remove(struct spi_device *spi)
1070 {
1071         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
1072         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
1073         struct net_device *net = priv->net;
1074
1075         unregister_candev(net);
1076         free_candev(net);
1077
1078         priv->force_quit = 1;
1079         flush_workqueue(priv->wq);
1080         destroy_workqueue(priv->wq);
1081
1082         if (mcp251x_enable_dma) {
1083                 dma_free_coherent(&spi->dev, PAGE_SIZE,
1084                                   priv->spi_tx_buf, priv->spi_tx_dma);
1085         } else {
1086                 kfree(priv->spi_tx_buf);
1087                 kfree(priv->spi_rx_buf);
1088         }
1089
1090         if (pdata->power_enable)
1091                 pdata->power_enable(0);
1092
1093         return 0;
1094 }
1095
1096 #ifdef CONFIG_PM
1097 static int mcp251x_can_suspend(struct spi_device *spi, pm_message_t state)
1098 {
1099         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
1100         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
1101         struct net_device *net = priv->net;
1102
1103         if (netif_running(net)) {
1104                 netif_device_detach(net);
1105
1106                 mcp251x_hw_sleep(spi);
1107                 if (pdata->transceiver_enable)
1108                         pdata->transceiver_enable(0);
1109                 priv->after_suspend = AFTER_SUSPEND_UP;
1110         } else {
1111                 priv->after_suspend = AFTER_SUSPEND_DOWN;
1112         }
1113
1114         if (pdata->power_enable) {
1115                 pdata->power_enable(0);
1116                 priv->after_suspend |= AFTER_SUSPEND_POWER;
1117         }
1118
1119         return 0;
1120 }
1121
1122 static int mcp251x_can_resume(struct spi_device *spi)
1123 {
1124         struct mcp251x_platform_data *pdata = spi->dev.platform_data;
1125         struct mcp251x_priv *priv = dev_get_drvdata(&spi->dev);
1126
1127         if (priv->after_suspend & AFTER_SUSPEND_POWER) {
1128                 pdata->power_enable(1);
1129                 queue_work(priv->wq, &priv->irq_work);
1130         } else {
1131                 if (priv->after_suspend & AFTER_SUSPEND_UP) {
1132                         if (pdata->transceiver_enable)
1133                                 pdata->transceiver_enable(1);
1134                         queue_work(priv->wq, &priv->irq_work);
1135                 } else {
1136                         priv->after_suspend = 0;
1137                 }
1138         }
1139         return 0;
1140 }
1141 #else
1142 #define mcp251x_can_suspend NULL
1143 #define mcp251x_can_resume NULL
1144 #endif
1145
1146 static struct spi_driver mcp251x_can_driver = {
1147         .driver = {
1148                 .name = DEVICE_NAME,
1149                 .bus = &spi_bus_type,
1150                 .owner = THIS_MODULE,
1151         },
1152
1153         .probe = mcp251x_can_probe,
1154         .remove = __devexit_p(mcp251x_can_remove),
1155         .suspend = mcp251x_can_suspend,
1156         .resume = mcp251x_can_resume,
1157 };
1158
1159 static int __init mcp251x_can_init(void)
1160 {
1161         return spi_register_driver(&mcp251x_can_driver);
1162 }
1163
1164 static void __exit mcp251x_can_exit(void)
1165 {
1166         spi_unregister_driver(&mcp251x_can_driver);
1167 }
1168
1169 module_init(mcp251x_can_init);
1170 module_exit(mcp251x_can_exit);
1171
1172 MODULE_AUTHOR("Chris Elston <celston@katalix.com>, "
1173               "Christian Pellegrin <chripell@evolware.org>");
1174 MODULE_DESCRIPTION("Microchip 251x CAN driver");
1175 MODULE_LICENSE("GPL v2");