4 * Copyright (C) 2009 Renesas Solutions Corp.
5 * Kuninori Morimoto <morimoto.kuninori@renesas.com>
8 * Copyright 2006-2009 Analog Devices Inc.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
16 #include <linux/interrupt.h>
17 #include <linux/module.h>
18 #include <linux/platform_device.h>
19 #include <linux/slab.h>
20 #include <net/irda/wrapper.h>
21 #include <net/irda/irda_device.h>
22 #include <asm/clock.h>
24 #define DRIVER_NAME "sh_sir"
26 #define RX_PHASE (1 << 0)
27 #define TX_PHASE (1 << 1)
28 #define TX_COMP_PHASE (1 << 2) /* tx complete */
29 #define NONE_PHASE (1 << 31)
31 #define IRIF_RINTCLR 0x0016 /* DMA rx interrupt source clear */
32 #define IRIF_TINTCLR 0x0018 /* DMA tx interrupt source clear */
33 #define IRIF_SIR0 0x0020 /* IrDA-SIR10 control */
34 #define IRIF_SIR1 0x0022 /* IrDA-SIR10 baudrate error correction */
35 #define IRIF_SIR2 0x0024 /* IrDA-SIR10 baudrate count */
36 #define IRIF_SIR3 0x0026 /* IrDA-SIR10 status */
37 #define IRIF_SIR_FRM 0x0028 /* Hardware frame processing set */
38 #define IRIF_SIR_EOF 0x002A /* EOF value */
39 #define IRIF_SIR_FLG 0x002C /* Flag clear */
40 #define IRIF_UART_STS2 0x002E /* UART status 2 */
41 #define IRIF_UART0 0x0030 /* UART control */
42 #define IRIF_UART1 0x0032 /* UART status */
43 #define IRIF_UART2 0x0034 /* UART mode */
44 #define IRIF_UART3 0x0036 /* UART transmit data */
45 #define IRIF_UART4 0x0038 /* UART receive data */
46 #define IRIF_UART5 0x003A /* UART interrupt mask */
47 #define IRIF_UART6 0x003C /* UART baud rate error correction */
48 #define IRIF_UART7 0x003E /* UART baud rate count set */
49 #define IRIF_CRC0 0x0040 /* CRC engine control */
50 #define IRIF_CRC1 0x0042 /* CRC engine input data */
51 #define IRIF_CRC2 0x0044 /* CRC engine calculation */
52 #define IRIF_CRC3 0x0046 /* CRC engine output data 1 */
53 #define IRIF_CRC4 0x0048 /* CRC engine output data 2 */
56 #define IRTPW (1 << 1) /* transmit pulse width select */
57 #define IRERRC (1 << 0) /* Clear receive pulse width error */
60 #define IRERR (1 << 0) /* received pulse width Error */
63 #define EOFD (1 << 9) /* EOF detection flag */
64 #define FRER (1 << 8) /* Frame Error bit */
65 #define FRP (1 << 0) /* Frame processing set */
68 #define IRSME (1 << 6) /* Receive Sum Error flag */
69 #define IROVE (1 << 5) /* Receive Overrun Error flag */
70 #define IRFRE (1 << 4) /* Receive Framing Error flag */
71 #define IRPRE (1 << 3) /* Receive Parity Error flag */
74 #define TBEC (1 << 2) /* Transmit Data Clear */
75 #define RIE (1 << 1) /* Receive Enable */
76 #define TIE (1 << 0) /* Transmit Enable */
79 #define URSME (1 << 6) /* Receive Sum Error Flag */
80 #define UROVE (1 << 5) /* Receive Overrun Error Flag */
81 #define URFRE (1 << 4) /* Receive Framing Error Flag */
82 #define URPRE (1 << 3) /* Receive Parity Error Flag */
83 #define RBF (1 << 2) /* Receive Buffer Full Flag */
84 #define TSBE (1 << 1) /* Transmit Shift Buffer Empty Flag */
85 #define TBE (1 << 0) /* Transmit Buffer Empty flag */
86 #define TBCOMP (TSBE | TBE)
89 #define RSEIM (1 << 6) /* Receive Sum Error Flag IRQ Mask */
90 #define RBFIM (1 << 2) /* Receive Buffer Full Flag IRQ Mask */
91 #define TSBEIM (1 << 1) /* Transmit Shift Buffer Empty Flag IRQ Mask */
92 #define TBEIM (1 << 0) /* Transmit Buffer Empty Flag IRQ Mask */
93 #define RX_MASK (RSEIM | RBFIM)
96 #define CRC_RST (1 << 15) /* CRC Engine Reset */
97 #define CRC_CT_MASK 0x0FFF
99 /************************************************************************
105 ************************************************************************/
107 void __iomem
*membase
;
111 struct net_device
*ndev
;
113 struct irlap_cb
*irlap
;
120 /************************************************************************
126 ************************************************************************/
127 static void sh_sir_write(struct sh_sir_self
*self
, u32 offset
, u16 data
)
129 iowrite16(data
, self
->membase
+ offset
);
132 static u16
sh_sir_read(struct sh_sir_self
*self
, u32 offset
)
134 return ioread16(self
->membase
+ offset
);
137 static void sh_sir_update_bits(struct sh_sir_self
*self
, u32 offset
,
142 old
= sh_sir_read(self
, offset
);
143 new = (old
& ~mask
) | data
;
145 sh_sir_write(self
, offset
, new);
148 /************************************************************************
154 ************************************************************************/
155 static void sh_sir_crc_reset(struct sh_sir_self
*self
)
157 sh_sir_write(self
, IRIF_CRC0
, CRC_RST
);
160 static void sh_sir_crc_add(struct sh_sir_self
*self
, u8 data
)
162 sh_sir_write(self
, IRIF_CRC1
, (u16
)data
);
165 static u16
sh_sir_crc_cnt(struct sh_sir_self
*self
)
167 return CRC_CT_MASK
& sh_sir_read(self
, IRIF_CRC0
);
170 static u16
sh_sir_crc_out(struct sh_sir_self
*self
)
172 return sh_sir_read(self
, IRIF_CRC4
);
175 static int sh_sir_crc_init(struct sh_sir_self
*self
)
177 struct device
*dev
= &self
->ndev
->dev
;
181 sh_sir_crc_reset(self
);
183 sh_sir_crc_add(self
, 0xCC);
184 sh_sir_crc_add(self
, 0xF5);
185 sh_sir_crc_add(self
, 0xF1);
186 sh_sir_crc_add(self
, 0xA7);
188 val
= sh_sir_crc_cnt(self
);
190 dev_err(dev
, "CRC count error %x\n", val
);
194 val
= sh_sir_crc_out(self
);
196 dev_err(dev
, "CRC result error%x\n", val
);
204 sh_sir_crc_reset(self
);
208 /************************************************************************
214 ************************************************************************/
215 #define SCLK_BASE 1843200 /* 1.8432MHz */
217 static u32
sh_sir_find_sclk(struct clk
*irda_clk
)
219 struct cpufreq_frequency_table
*freq_table
= irda_clk
->freq_table
;
220 struct cpufreq_frequency_table
*pos
;
221 struct clk
*pclk
= clk_get(NULL
, "peripheral_clk");
222 u32 limit
, min
= 0xffffffff, tmp
;
225 limit
= clk_get_rate(pclk
);
228 /* IrDA can not set over peripheral_clk */
229 cpufreq_for_each_valid_entry(pos
, freq_table
) {
230 u32 freq
= pos
->frequency
;
232 /* IrDA should not over peripheral_clk */
236 tmp
= freq
% SCLK_BASE
;
239 index
= pos
- freq_table
;
243 return freq_table
[index
].frequency
;
246 #define ERR_ROUNDING(a) ((a + 5000) / 10000)
247 static int sh_sir_set_baudrate(struct sh_sir_self
*self
, u32 baudrate
)
250 struct device
*dev
= &self
->ndev
->dev
;
257 /* Baud Rate Error Correction x 10000 */
258 u32 rate_err_array
[] = {
260 2500, 3125, 3750, 4375,
261 5000, 5625, 6250, 6875,
262 7500, 8125, 8750, 9375,
268 * it support 9600 only now
274 dev_err(dev
, "un-supported baudrate %d\n", baudrate
);
278 clk
= clk_get(NULL
, "irda_clk");
280 dev_err(dev
, "can not get irda_clk\n");
284 clk_set_rate(clk
, sh_sir_find_sclk(clk
));
285 rate
= clk_get_rate(clk
);
288 dev_dbg(dev
, "selected sclk = %d\n", rate
);
293 * 1843200 = system rate / (irbca + (irbc + 1))
296 irbc
= rate
/ SCLK_BASE
;
298 tmp
= rate
- (SCLK_BASE
* irbc
);
301 rerr
= tmp
/ SCLK_BASE
;
305 for (i
= 0; i
< ARRAY_SIZE(rate_err_array
); i
++) {
306 tmp
= abs(rate_err_array
[i
] - rerr
);
313 tmp
= rate
/ (irbc
+ ERR_ROUNDING(rate_err_array
[irbca
]));
314 if ((SCLK_BASE
/ 100) < abs(tmp
- SCLK_BASE
))
315 dev_warn(dev
, "IrDA freq error margin over %d\n", tmp
);
317 dev_dbg(dev
, "target = %d, result = %d, infrared = %d.%d\n",
318 SCLK_BASE
, tmp
, irbc
, rate_err_array
[irbca
]);
320 irbca
= (irbca
& 0xF) << 4;
321 irbc
= (irbc
- 1) & 0xF;
324 dev_err(dev
, "sh_sir can not set 0 in IRIF_SIR2\n");
328 sh_sir_write(self
, IRIF_SIR0
, IRTPW
| IRERRC
);
329 sh_sir_write(self
, IRIF_SIR1
, irbca
);
330 sh_sir_write(self
, IRIF_SIR2
, irbc
);
335 * BaudRate[bps] = system rate / (uabca + (uabc + 1) x 16)
338 uabc
= rate
/ baudrate
;
339 uabc
= (uabc
/ 16) - 1;
340 uabc
= (uabc
+ 1) * 16;
342 tmp
= rate
- (uabc
* baudrate
);
345 rerr
= tmp
/ baudrate
;
349 for (i
= 0; i
< ARRAY_SIZE(rate_err_array
); i
++) {
350 tmp
= abs(rate_err_array
[i
] - rerr
);
357 tmp
= rate
/ (uabc
+ ERR_ROUNDING(rate_err_array
[uabca
]));
358 if ((baudrate
/ 100) < abs(tmp
- baudrate
))
359 dev_warn(dev
, "UART freq error margin over %d\n", tmp
);
361 dev_dbg(dev
, "target = %d, result = %d, uart = %d.%d\n",
363 uabc
, rate_err_array
[uabca
]);
365 uabca
= (uabca
& 0xF) << 4;
366 uabc
= (uabc
/ 16) - 1;
368 sh_sir_write(self
, IRIF_UART6
, uabca
);
369 sh_sir_write(self
, IRIF_UART7
, uabc
);
374 /************************************************************************
380 ************************************************************************/
381 static int __sh_sir_init_iobuf(iobuff_t
*io
, int size
)
383 io
->head
= kmalloc(size
, GFP_KERNEL
);
388 io
->in_frame
= FALSE
;
389 io
->state
= OUTSIDE_FRAME
;
395 static void sh_sir_remove_iobuf(struct sh_sir_self
*self
)
397 kfree(self
->rx_buff
.head
);
398 kfree(self
->tx_buff
.head
);
400 self
->rx_buff
.head
= NULL
;
401 self
->tx_buff
.head
= NULL
;
404 static int sh_sir_init_iobuf(struct sh_sir_self
*self
, int rxsize
, int txsize
)
408 if (self
->rx_buff
.head
||
409 self
->tx_buff
.head
) {
410 dev_err(&self
->ndev
->dev
, "iobuff has already existed.");
414 err
= __sh_sir_init_iobuf(&self
->rx_buff
, rxsize
);
418 err
= __sh_sir_init_iobuf(&self
->tx_buff
, txsize
);
422 sh_sir_remove_iobuf(self
);
427 /************************************************************************
433 ************************************************************************/
434 static void sh_sir_clear_all_err(struct sh_sir_self
*self
)
436 /* Clear error flag for receive pulse width */
437 sh_sir_update_bits(self
, IRIF_SIR0
, IRERRC
, IRERRC
);
439 /* Clear frame / EOF error flag */
440 sh_sir_write(self
, IRIF_SIR_FLG
, 0xffff);
442 /* Clear all status error */
443 sh_sir_write(self
, IRIF_UART_STS2
, 0);
446 static void sh_sir_set_phase(struct sh_sir_self
*self
, int phase
)
468 sh_sir_write(self
, IRIF_UART5
, uart5
);
469 sh_sir_write(self
, IRIF_UART0
, uart0
);
472 static int sh_sir_is_which_phase(struct sh_sir_self
*self
)
474 u16 val
= sh_sir_read(self
, IRIF_UART5
);
480 return TX_COMP_PHASE
;
488 static void sh_sir_tx(struct sh_sir_self
*self
, int phase
)
492 if (0 >= self
->tx_buff
.len
) {
493 sh_sir_set_phase(self
, TX_COMP_PHASE
);
495 sh_sir_write(self
, IRIF_UART3
, self
->tx_buff
.data
[0]);
497 self
->tx_buff
.data
++;
501 sh_sir_set_phase(self
, RX_PHASE
);
502 netif_wake_queue(self
->ndev
);
505 dev_err(&self
->ndev
->dev
, "should not happen\n");
510 static int sh_sir_read_data(struct sh_sir_self
*self
)
516 val
= sh_sir_read(self
, IRIF_UART1
);
520 if (val
& (URSME
| UROVE
| URFRE
| URPRE
))
523 return (int)sh_sir_read(self
, IRIF_UART4
);
529 dev_err(&self
->ndev
->dev
, "UART1 %04x : STATUS %04x\n",
530 val
, sh_sir_read(self
, IRIF_UART_STS2
));
532 /* read data register for clear error */
533 sh_sir_read(self
, IRIF_UART4
);
538 static void sh_sir_rx(struct sh_sir_self
*self
)
544 data
= sh_sir_read_data(self
);
548 async_unwrap_char(self
->ndev
, &self
->ndev
->stats
,
549 &self
->rx_buff
, (u8
)data
);
550 self
->ndev
->last_rx
= jiffies
;
552 if (EOFD
& sh_sir_read(self
, IRIF_SIR_FRM
))
559 static irqreturn_t
sh_sir_irq(int irq
, void *dev_id
)
561 struct sh_sir_self
*self
= dev_id
;
562 struct device
*dev
= &self
->ndev
->dev
;
563 int phase
= sh_sir_is_which_phase(self
);
568 sh_sir_tx(self
, phase
);
571 if (sh_sir_read(self
, IRIF_SIR3
))
572 dev_err(dev
, "rcv pulse width error occurred\n");
575 sh_sir_clear_all_err(self
);
578 dev_err(dev
, "unknown interrupt\n");
584 /************************************************************************
587 net_device_ops function
590 ************************************************************************/
591 static int sh_sir_hard_xmit(struct sk_buff
*skb
, struct net_device
*ndev
)
593 struct sh_sir_self
*self
= netdev_priv(ndev
);
594 int speed
= irda_get_next_speed(skb
);
598 dev_err(&ndev
->dev
, "support 9600 only (%d)\n", speed
);
602 netif_stop_queue(ndev
);
604 self
->tx_buff
.data
= self
->tx_buff
.head
;
605 self
->tx_buff
.len
= 0;
607 self
->tx_buff
.len
= async_wrap_skb(skb
, self
->tx_buff
.data
,
608 self
->tx_buff
.truesize
);
610 sh_sir_set_phase(self
, TX_PHASE
);
616 static int sh_sir_ioctl(struct net_device
*ndev
, struct ifreq
*ifreq
, int cmd
)
621 * This function is needed for irda framework.
622 * But nothing to do now
627 static struct net_device_stats
*sh_sir_stats(struct net_device
*ndev
)
629 struct sh_sir_self
*self
= netdev_priv(ndev
);
631 return &self
->ndev
->stats
;
634 static int sh_sir_open(struct net_device
*ndev
)
636 struct sh_sir_self
*self
= netdev_priv(ndev
);
639 clk_enable(self
->clk
);
640 err
= sh_sir_crc_init(self
);
644 sh_sir_set_baudrate(self
, 9600);
646 self
->irlap
= irlap_open(ndev
, &self
->qos
, DRIVER_NAME
);
653 * Now enable the interrupt then start the queue
655 sh_sir_update_bits(self
, IRIF_SIR_FRM
, FRP
, FRP
);
656 sh_sir_read(self
, IRIF_UART1
); /* flag clear */
657 sh_sir_read(self
, IRIF_UART4
); /* flag clear */
658 sh_sir_set_phase(self
, RX_PHASE
);
660 netif_start_queue(ndev
);
662 dev_info(&self
->ndev
->dev
, "opened\n");
667 clk_disable(self
->clk
);
672 static int sh_sir_stop(struct net_device
*ndev
)
674 struct sh_sir_self
*self
= netdev_priv(ndev
);
678 irlap_close(self
->irlap
);
682 netif_stop_queue(ndev
);
684 dev_info(&ndev
->dev
, "stopped\n");
689 static const struct net_device_ops sh_sir_ndo
= {
690 .ndo_open
= sh_sir_open
,
691 .ndo_stop
= sh_sir_stop
,
692 .ndo_start_xmit
= sh_sir_hard_xmit
,
693 .ndo_do_ioctl
= sh_sir_ioctl
,
694 .ndo_get_stats
= sh_sir_stats
,
697 /************************************************************************
700 platform_driver function
703 ************************************************************************/
704 static int sh_sir_probe(struct platform_device
*pdev
)
706 struct net_device
*ndev
;
707 struct sh_sir_self
*self
;
708 struct resource
*res
;
713 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
714 irq
= platform_get_irq(pdev
, 0);
715 if (!res
|| irq
< 0) {
716 dev_err(&pdev
->dev
, "Not enough platform resources.\n");
720 ndev
= alloc_irdadev(sizeof(*self
));
724 self
= netdev_priv(ndev
);
725 self
->membase
= ioremap_nocache(res
->start
, resource_size(res
));
726 if (!self
->membase
) {
728 dev_err(&pdev
->dev
, "Unable to ioremap.\n");
732 err
= sh_sir_init_iobuf(self
, IRDA_SKB_MAX_MTU
, IRDA_SIR_MAX_FRAME
);
736 snprintf(clk_name
, sizeof(clk_name
), "irda%d", pdev
->id
);
737 self
->clk
= clk_get(&pdev
->dev
, clk_name
);
738 if (IS_ERR(self
->clk
)) {
739 dev_err(&pdev
->dev
, "cannot get clock \"%s\"\n", clk_name
);
744 irda_init_max_qos_capabilies(&self
->qos
);
746 ndev
->netdev_ops
= &sh_sir_ndo
;
750 self
->qos
.baud_rate
.bits
&= IR_9600
; /* FIXME */
751 self
->qos
.min_turn_time
.bits
= 1; /* 10 ms or more */
753 irda_qos_bits_to_value(&self
->qos
);
755 err
= register_netdev(ndev
);
759 platform_set_drvdata(pdev
, ndev
);
760 err
= devm_request_irq(&pdev
->dev
, irq
, sh_sir_irq
, 0, "sh_sir", self
);
762 dev_warn(&pdev
->dev
, "Unable to attach sh_sir interrupt\n");
766 dev_info(&pdev
->dev
, "SuperH IrDA probed\n");
773 sh_sir_remove_iobuf(self
);
775 iounmap(self
->membase
);
782 static int sh_sir_remove(struct platform_device
*pdev
)
784 struct net_device
*ndev
= platform_get_drvdata(pdev
);
785 struct sh_sir_self
*self
= netdev_priv(ndev
);
790 unregister_netdev(ndev
);
792 sh_sir_remove_iobuf(self
);
793 iounmap(self
->membase
);
799 static struct platform_driver sh_sir_driver
= {
800 .probe
= sh_sir_probe
,
801 .remove
= sh_sir_remove
,
807 module_platform_driver(sh_sir_driver
);
809 MODULE_AUTHOR("Kuninori Morimoto <morimoto.kuninori@renesas.com>");
810 MODULE_DESCRIPTION("SuperH IrDA driver");
811 MODULE_LICENSE("GPL");