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.
15 #include <linux/module.h>
16 #include <linux/platform_device.h>
17 #include <net/irda/wrapper.h>
18 #include <net/irda/irda_device.h>
19 #include <asm/clock.h>
21 #define DRIVER_NAME "sh_sir"
23 #define RX_PHASE (1 << 0)
24 #define TX_PHASE (1 << 1)
25 #define TX_COMP_PHASE (1 << 2) /* tx complete */
26 #define NONE_PHASE (1 << 31)
28 #define IRIF_RINTCLR 0x0016 /* DMA rx interrupt source clear */
29 #define IRIF_TINTCLR 0x0018 /* DMA tx interrupt source clear */
30 #define IRIF_SIR0 0x0020 /* IrDA-SIR10 control */
31 #define IRIF_SIR1 0x0022 /* IrDA-SIR10 baudrate error correction */
32 #define IRIF_SIR2 0x0024 /* IrDA-SIR10 baudrate count */
33 #define IRIF_SIR3 0x0026 /* IrDA-SIR10 status */
34 #define IRIF_SIR_FRM 0x0028 /* Hardware frame processing set */
35 #define IRIF_SIR_EOF 0x002A /* EOF value */
36 #define IRIF_SIR_FLG 0x002C /* Flag clear */
37 #define IRIF_UART_STS2 0x002E /* UART status 2 */
38 #define IRIF_UART0 0x0030 /* UART control */
39 #define IRIF_UART1 0x0032 /* UART status */
40 #define IRIF_UART2 0x0034 /* UART mode */
41 #define IRIF_UART3 0x0036 /* UART transmit data */
42 #define IRIF_UART4 0x0038 /* UART receive data */
43 #define IRIF_UART5 0x003A /* UART interrupt mask */
44 #define IRIF_UART6 0x003C /* UART baud rate error correction */
45 #define IRIF_UART7 0x003E /* UART baud rate count set */
46 #define IRIF_CRC0 0x0040 /* CRC engine control */
47 #define IRIF_CRC1 0x0042 /* CRC engine input data */
48 #define IRIF_CRC2 0x0044 /* CRC engine calculation */
49 #define IRIF_CRC3 0x0046 /* CRC engine output data 1 */
50 #define IRIF_CRC4 0x0048 /* CRC engine output data 2 */
53 #define IRTPW (1 << 1) /* transmit pulse width select */
54 #define IRERRC (1 << 0) /* Clear receive pulse width error */
57 #define IRERR (1 << 0) /* received pulse width Error */
60 #define EOFD (1 << 9) /* EOF detection flag */
61 #define FRER (1 << 8) /* Frame Error bit */
62 #define FRP (1 << 0) /* Frame processing set */
65 #define IRSME (1 << 6) /* Receive Sum Error flag */
66 #define IROVE (1 << 5) /* Receive Overrun Error flag */
67 #define IRFRE (1 << 4) /* Receive Framing Error flag */
68 #define IRPRE (1 << 3) /* Receive Parity Error flag */
71 #define TBEC (1 << 2) /* Transmit Data Clear */
72 #define RIE (1 << 1) /* Receive Enable */
73 #define TIE (1 << 0) /* Transmit Enable */
76 #define URSME (1 << 6) /* Receive Sum Error Flag */
77 #define UROVE (1 << 5) /* Receive Overrun Error Flag */
78 #define URFRE (1 << 4) /* Receive Framing Error Flag */
79 #define URPRE (1 << 3) /* Receive Parity Error Flag */
80 #define RBF (1 << 2) /* Receive Buffer Full Flag */
81 #define TSBE (1 << 1) /* Transmit Shift Buffer Empty Flag */
82 #define TBE (1 << 0) /* Transmit Buffer Empty flag */
83 #define TBCOMP (TSBE | TBE)
86 #define RSEIM (1 << 6) /* Receive Sum Error Flag IRQ Mask */
87 #define RBFIM (1 << 2) /* Receive Buffer Full Flag IRQ Mask */
88 #define TSBEIM (1 << 1) /* Transmit Shift Buffer Empty Flag IRQ Mask */
89 #define TBEIM (1 << 0) /* Transmit Buffer Empty Flag IRQ Mask */
90 #define RX_MASK (RSEIM | RBFIM)
93 #define CRC_RST (1 << 15) /* CRC Engine Reset */
94 #define CRC_CT_MASK 0x0FFF
96 /************************************************************************
102 ************************************************************************/
104 void __iomem *membase;
108 struct net_device *ndev;
110 struct irlap_cb *irlap;
117 /************************************************************************
123 ************************************************************************/
124 static void sh_sir_write(struct sh_sir_self *self, u32 offset, u16 data)
126 iowrite16(data, self->membase + offset);
129 static u16 sh_sir_read(struct sh_sir_self *self, u32 offset)
131 return ioread16(self->membase + offset);
134 static void sh_sir_update_bits(struct sh_sir_self *self, u32 offset,
139 old = sh_sir_read(self, offset);
140 new = (old & ~mask) | data;
142 sh_sir_write(self, offset, new);
145 /************************************************************************
151 ************************************************************************/
152 static void sh_sir_crc_reset(struct sh_sir_self *self)
154 sh_sir_write(self, IRIF_CRC0, CRC_RST);
157 static void sh_sir_crc_add(struct sh_sir_self *self, u8 data)
159 sh_sir_write(self, IRIF_CRC1, (u16)data);
162 static u16 sh_sir_crc_cnt(struct sh_sir_self *self)
164 return CRC_CT_MASK & sh_sir_read(self, IRIF_CRC0);
167 static u16 sh_sir_crc_out(struct sh_sir_self *self)
169 return sh_sir_read(self, IRIF_CRC4);
172 static int sh_sir_crc_init(struct sh_sir_self *self)
174 struct device *dev = &self->ndev->dev;
178 sh_sir_crc_reset(self);
180 sh_sir_crc_add(self, 0xCC);
181 sh_sir_crc_add(self, 0xF5);
182 sh_sir_crc_add(self, 0xF1);
183 sh_sir_crc_add(self, 0xA7);
185 val = sh_sir_crc_cnt(self);
187 dev_err(dev, "CRC count error %x\n", val);
191 val = sh_sir_crc_out(self);
193 dev_err(dev, "CRC result error%x\n", val);
201 sh_sir_crc_reset(self);
205 /************************************************************************
211 ************************************************************************/
212 #define SCLK_BASE 1843200 /* 1.8432MHz */
214 static u32 sh_sir_find_sclk(struct clk *irda_clk)
216 struct cpufreq_frequency_table *freq_table = irda_clk->freq_table;
217 struct clk *pclk = clk_get(NULL, "peripheral_clk");
218 u32 limit, min = 0xffffffff, tmp;
221 limit = clk_get_rate(pclk);
224 /* IrDA can not set over peripheral_clk */
226 freq_table[i].frequency != CPUFREQ_TABLE_END;
228 u32 freq = freq_table[i].frequency;
230 if (freq == CPUFREQ_ENTRY_INVALID)
233 /* IrDA should not over peripheral_clk */
237 tmp = freq % SCLK_BASE;
244 return freq_table[index].frequency;
247 #define ERR_ROUNDING(a) ((a + 5000) / 10000)
248 static int sh_sir_set_baudrate(struct sh_sir_self *self, u32 baudrate)
251 struct device *dev = &self->ndev->dev;
258 /* Baud Rate Error Correction x 10000 */
259 u32 rate_err_array[] = {
260 0000, 0625, 1250, 1875,
261 2500, 3125, 3750, 4375,
262 5000, 5625, 6250, 6875,
263 7500, 8125, 8750, 9375,
269 * it support 9600 only now
275 dev_err(dev, "un-supported baudrate %d\n", baudrate);
279 clk = clk_get(NULL, "irda_clk");
281 dev_err(dev, "can not get irda_clk\n");
285 clk_set_rate(clk, sh_sir_find_sclk(clk));
286 rate = clk_get_rate(clk);
289 dev_dbg(dev, "selected sclk = %d\n", rate);
294 * 1843200 = system rate / (irbca + (irbc + 1))
297 irbc = rate / SCLK_BASE;
299 tmp = rate - (SCLK_BASE * irbc);
302 rerr = tmp / SCLK_BASE;
306 for (i = 0; i < ARRAY_SIZE(rate_err_array); i++) {
307 tmp = abs(rate_err_array[i] - rerr);
314 tmp = rate / (irbc + ERR_ROUNDING(rate_err_array[irbca]));
315 if ((SCLK_BASE / 100) < abs(tmp - SCLK_BASE))
316 dev_warn(dev, "IrDA freq error margin over %d\n", tmp);
318 dev_dbg(dev, "target = %d, result = %d, infrared = %d.%d\n",
319 SCLK_BASE, tmp, irbc, rate_err_array[irbca]);
321 irbca = (irbca & 0xF) << 4;
322 irbc = (irbc - 1) & 0xF;
325 dev_err(dev, "sh_sir can not set 0 in IRIF_SIR2\n");
329 sh_sir_write(self, IRIF_SIR0, IRTPW | IRERRC);
330 sh_sir_write(self, IRIF_SIR1, irbca);
331 sh_sir_write(self, IRIF_SIR2, irbc);
336 * BaudRate[bps] = system rate / (uabca + (uabc + 1) x 16)
339 uabc = rate / baudrate;
340 uabc = (uabc / 16) - 1;
341 uabc = (uabc + 1) * 16;
343 tmp = rate - (uabc * baudrate);
346 rerr = tmp / baudrate;
350 for (i = 0; i < ARRAY_SIZE(rate_err_array); i++) {
351 tmp = abs(rate_err_array[i] - rerr);
358 tmp = rate / (uabc + ERR_ROUNDING(rate_err_array[uabca]));
359 if ((baudrate / 100) < abs(tmp - baudrate))
360 dev_warn(dev, "UART freq error margin over %d\n", tmp);
362 dev_dbg(dev, "target = %d, result = %d, uart = %d.%d\n",
364 uabc, rate_err_array[uabca]);
366 uabca = (uabca & 0xF) << 4;
367 uabc = (uabc / 16) - 1;
369 sh_sir_write(self, IRIF_UART6, uabca);
370 sh_sir_write(self, IRIF_UART7, uabc);
375 /************************************************************************
381 ************************************************************************/
382 static int __sh_sir_init_iobuf(iobuff_t *io, int size)
384 io->head = kmalloc(size, GFP_KERNEL);
389 io->in_frame = FALSE;
390 io->state = OUTSIDE_FRAME;
396 static void sh_sir_remove_iobuf(struct sh_sir_self *self)
398 kfree(self->rx_buff.head);
399 kfree(self->tx_buff.head);
401 self->rx_buff.head = NULL;
402 self->tx_buff.head = NULL;
405 static int sh_sir_init_iobuf(struct sh_sir_self *self, int rxsize, int txsize)
409 if (self->rx_buff.head ||
410 self->tx_buff.head) {
411 dev_err(&self->ndev->dev, "iobuff has already existed.");
415 err = __sh_sir_init_iobuf(&self->rx_buff, rxsize);
419 err = __sh_sir_init_iobuf(&self->tx_buff, txsize);
423 sh_sir_remove_iobuf(self);
428 /************************************************************************
434 ************************************************************************/
435 static void sh_sir_clear_all_err(struct sh_sir_self *self)
437 /* Clear error flag for receive pulse width */
438 sh_sir_update_bits(self, IRIF_SIR0, IRERRC, IRERRC);
440 /* Clear frame / EOF error flag */
441 sh_sir_write(self, IRIF_SIR_FLG, 0xffff);
443 /* Clear all status error */
444 sh_sir_write(self, IRIF_UART_STS2, 0);
447 static void sh_sir_set_phase(struct sh_sir_self *self, int phase)
469 sh_sir_write(self, IRIF_UART5, uart5);
470 sh_sir_write(self, IRIF_UART0, uart0);
473 static int sh_sir_is_which_phase(struct sh_sir_self *self)
475 u16 val = sh_sir_read(self, IRIF_UART5);
481 return TX_COMP_PHASE;
489 static void sh_sir_tx(struct sh_sir_self *self, int phase)
493 if (0 >= self->tx_buff.len) {
494 sh_sir_set_phase(self, TX_COMP_PHASE);
496 sh_sir_write(self, IRIF_UART3, self->tx_buff.data[0]);
498 self->tx_buff.data++;
502 sh_sir_set_phase(self, RX_PHASE);
503 netif_wake_queue(self->ndev);
506 dev_err(&self->ndev->dev, "should not happen\n");
511 static int sh_sir_read_data(struct sh_sir_self *self)
517 val = sh_sir_read(self, IRIF_UART1);
521 if (val & (URSME | UROVE | URFRE | URPRE))
524 return (int)sh_sir_read(self, IRIF_UART4);
530 dev_err(&self->ndev->dev, "UART1 %04x : STATUS %04x\n",
531 val, sh_sir_read(self, IRIF_UART_STS2));
533 /* read data register for clear error */
534 sh_sir_read(self, IRIF_UART4);
539 static void sh_sir_rx(struct sh_sir_self *self)
545 data = sh_sir_read_data(self);
549 async_unwrap_char(self->ndev, &self->ndev->stats,
550 &self->rx_buff, (u8)data);
551 self->ndev->last_rx = jiffies;
553 if (EOFD & sh_sir_read(self, IRIF_SIR_FRM))
560 static irqreturn_t sh_sir_irq(int irq, void *dev_id)
562 struct sh_sir_self *self = dev_id;
563 struct device *dev = &self->ndev->dev;
564 int phase = sh_sir_is_which_phase(self);
569 sh_sir_tx(self, phase);
572 if (sh_sir_read(self, IRIF_SIR3))
573 dev_err(dev, "rcv pulse width error occurred\n");
576 sh_sir_clear_all_err(self);
579 dev_err(dev, "unknown interrupt\n");
585 /************************************************************************
588 net_device_ops function
591 ************************************************************************/
592 static int sh_sir_hard_xmit(struct sk_buff *skb, struct net_device *ndev)
594 struct sh_sir_self *self = netdev_priv(ndev);
595 int speed = irda_get_next_speed(skb);
599 dev_err(&ndev->dev, "support 9600 only (%d)\n", speed);
603 netif_stop_queue(ndev);
605 self->tx_buff.data = self->tx_buff.head;
606 self->tx_buff.len = 0;
608 self->tx_buff.len = async_wrap_skb(skb, self->tx_buff.data,
609 self->tx_buff.truesize);
611 sh_sir_set_phase(self, TX_PHASE);
617 static int sh_sir_ioctl(struct net_device *ndev, struct ifreq *ifreq, int cmd)
622 * This function is needed for irda framework.
623 * But nothing to do now
628 static struct net_device_stats *sh_sir_stats(struct net_device *ndev)
630 struct sh_sir_self *self = netdev_priv(ndev);
632 return &self->ndev->stats;
635 static int sh_sir_open(struct net_device *ndev)
637 struct sh_sir_self *self = netdev_priv(ndev);
640 clk_enable(self->clk);
641 err = sh_sir_crc_init(self);
645 sh_sir_set_baudrate(self, 9600);
647 self->irlap = irlap_open(ndev, &self->qos, DRIVER_NAME);
652 * Now enable the interrupt then start the queue
654 sh_sir_update_bits(self, IRIF_SIR_FRM, FRP, FRP);
655 sh_sir_read(self, IRIF_UART1); /* flag clear */
656 sh_sir_read(self, IRIF_UART4); /* flag clear */
657 sh_sir_set_phase(self, RX_PHASE);
659 netif_start_queue(ndev);
661 dev_info(&self->ndev->dev, "opened\n");
666 clk_disable(self->clk);
671 static int sh_sir_stop(struct net_device *ndev)
673 struct sh_sir_self *self = netdev_priv(ndev);
677 irlap_close(self->irlap);
681 netif_stop_queue(ndev);
683 dev_info(&ndev->dev, "stoped\n");
688 static const struct net_device_ops sh_sir_ndo = {
689 .ndo_open = sh_sir_open,
690 .ndo_stop = sh_sir_stop,
691 .ndo_start_xmit = sh_sir_hard_xmit,
692 .ndo_do_ioctl = sh_sir_ioctl,
693 .ndo_get_stats = sh_sir_stats,
696 /************************************************************************
699 platform_driver function
702 ************************************************************************/
703 static int __devinit sh_sir_probe(struct platform_device *pdev)
705 struct net_device *ndev;
706 struct sh_sir_self *self;
707 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 base = ioremap_nocache(res->start, resource_size(res));
727 dev_err(&pdev->dev, "Unable to ioremap.\n");
731 self = netdev_priv(ndev);
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);
743 irda_init_max_qos_capabilies(&self->qos);
745 ndev->netdev_ops = &sh_sir_ndo;
748 self->membase = base;
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);
761 if (request_irq(irq, sh_sir_irq, IRQF_DISABLED, "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 __devexit 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);
795 platform_set_drvdata(pdev, NULL);
800 static struct platform_driver sh_sir_driver = {
801 .probe = sh_sir_probe,
802 .remove = __devexit_p(sh_sir_remove),
808 static int __init sh_sir_init(void)
810 return platform_driver_register(&sh_sir_driver);
813 static void __exit sh_sir_exit(void)
815 platform_driver_unregister(&sh_sir_driver);
818 module_init(sh_sir_init);
819 module_exit(sh_sir_exit);
821 MODULE_AUTHOR("Kuninori Morimoto <morimoto.kuninori@renesas.com>");
822 MODULE_DESCRIPTION("SuperH IrDA driver");
823 MODULE_LICENSE("GPL");