2 * linux/drivers/net/irda/pxaficp_ir.c
4 * Based on sa1100_ir.c by Russell King
6 * Changes copyright (C) 2003-2005 MontaVista Software, Inc.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 * Infra-red driver (SIR/FIR) for the PXA2xx embedded microprocessor
15 #include <linux/module.h>
16 #include <linux/netdevice.h>
17 #include <linux/platform_device.h>
18 #include <linux/clk.h>
20 #include <net/irda/irda.h>
21 #include <net/irda/irmod.h>
22 #include <net/irda/wrapper.h>
23 #include <net/irda/irda_device.h>
26 #include <mach/irda.h>
27 #include <mach/hardware.h>
28 #include <mach/pxa-regs.h>
30 #define IrSR_RXPL_NEG_IS_ZERO (1<<4)
31 #define IrSR_RXPL_POS_IS_ZERO 0x0
32 #define IrSR_TXPL_NEG_IS_ZERO (1<<3)
33 #define IrSR_TXPL_POS_IS_ZERO 0x0
34 #define IrSR_XMODE_PULSE_1_6 (1<<2)
35 #define IrSR_XMODE_PULSE_3_16 0x0
36 #define IrSR_RCVEIR_IR_MODE (1<<1)
37 #define IrSR_RCVEIR_UART_MODE 0x0
38 #define IrSR_XMITIR_IR_MODE (1<<0)
39 #define IrSR_XMITIR_UART_MODE 0x0
41 #define IrSR_IR_RECEIVE_ON (\
42 IrSR_RXPL_NEG_IS_ZERO | \
43 IrSR_TXPL_POS_IS_ZERO | \
44 IrSR_XMODE_PULSE_3_16 | \
45 IrSR_RCVEIR_IR_MODE | \
46 IrSR_XMITIR_UART_MODE)
48 #define IrSR_IR_TRANSMIT_ON (\
49 IrSR_RXPL_NEG_IS_ZERO | \
50 IrSR_TXPL_POS_IS_ZERO | \
51 IrSR_XMODE_PULSE_3_16 | \
52 IrSR_RCVEIR_UART_MODE | \
58 unsigned long last_oscr;
60 unsigned char *dma_rx_buff;
61 unsigned char *dma_tx_buff;
62 dma_addr_t dma_rx_buff_phy;
63 dma_addr_t dma_tx_buff_phy;
64 unsigned int dma_tx_buff_len;
68 struct net_device_stats stats;
69 struct irlap_cb *irlap;
76 struct pxaficp_platform_data *pdata;
82 static inline void pxa_irda_disable_clk(struct pxa_irda *si)
85 clk_disable(si->cur_clk);
89 static inline void pxa_irda_enable_firclk(struct pxa_irda *si)
91 si->cur_clk = si->fir_clk;
92 clk_enable(si->fir_clk);
95 static inline void pxa_irda_enable_sirclk(struct pxa_irda *si)
97 si->cur_clk = si->sir_clk;
98 clk_enable(si->sir_clk);
102 #define IS_FIR(si) ((si)->speed >= 4000000)
103 #define IRDA_FRAME_SIZE_LIMIT 2047
105 inline static void pxa_irda_fir_dma_rx_start(struct pxa_irda *si)
107 DCSR(si->rxdma) = DCSR_NODESC;
108 DSADR(si->rxdma) = __PREG(ICDR);
109 DTADR(si->rxdma) = si->dma_rx_buff_phy;
110 DCMD(si->rxdma) = DCMD_INCTRGADDR | DCMD_FLOWSRC | DCMD_WIDTH1 | DCMD_BURST32 | IRDA_FRAME_SIZE_LIMIT;
111 DCSR(si->rxdma) |= DCSR_RUN;
114 inline static void pxa_irda_fir_dma_tx_start(struct pxa_irda *si)
116 DCSR(si->txdma) = DCSR_NODESC;
117 DSADR(si->txdma) = si->dma_tx_buff_phy;
118 DTADR(si->txdma) = __PREG(ICDR);
119 DCMD(si->txdma) = DCMD_INCSRCADDR | DCMD_FLOWTRG | DCMD_ENDIRQEN | DCMD_WIDTH1 | DCMD_BURST32 | si->dma_tx_buff_len;
120 DCSR(si->txdma) |= DCSR_RUN;
124 * Set the IrDA communications speed.
126 static int pxa_irda_set_speed(struct pxa_irda *si, int speed)
129 unsigned int divisor;
132 case 9600: case 19200: case 38400:
133 case 57600: case 115200:
135 /* refer to PXA250/210 Developer's Manual 10-7 */
136 /* BaudRate = 14.7456 MHz / (16*Divisor) */
137 divisor = 14745600 / (16 * speed);
139 local_irq_save(flags);
143 DCSR(si->rxdma) &= ~DCSR_RUN;
146 pxa_irda_disable_clk(si);
148 /* set board transceiver to SIR mode */
149 si->pdata->transceiver_mode(si->dev, IR_SIRMODE);
151 /* enable the STUART clock */
152 pxa_irda_enable_sirclk(si);
155 /* disable STUART first */
158 /* access DLL & DLH */
160 STDLL = divisor & 0xff;
161 STDLH = divisor >> 8;
165 STISR = IrSR_IR_RECEIVE_ON | IrSR_XMODE_PULSE_1_6;
166 STIER = IER_UUE | IER_RLSE | IER_RAVIE | IER_RTIOE;
168 local_irq_restore(flags);
172 local_irq_save(flags);
177 pxa_irda_disable_clk(si);
179 /* disable FICP first */
182 /* set board transceiver to FIR mode */
183 si->pdata->transceiver_mode(si->dev, IR_FIRMODE);
185 /* enable the FICP clock */
186 pxa_irda_enable_firclk(si);
189 pxa_irda_fir_dma_rx_start(si);
190 ICCR0 = ICCR0_ITR | ICCR0_RXE;
192 local_irq_restore(flags);
202 /* SIR interrupt service routine. */
203 static irqreturn_t pxa_irda_sir_irq(int irq, void *dev_id)
205 struct net_device *dev = dev_id;
206 struct pxa_irda *si = netdev_priv(dev);
211 switch (iir & 0x0F) {
212 case 0x06: /* Receiver Line Status */
214 while (lsr & LSR_FIFOE) {
216 if (lsr & (LSR_OE | LSR_PE | LSR_FE | LSR_BI)) {
217 printk(KERN_DEBUG "pxa_ir: sir receiving error\n");
218 si->stats.rx_errors++;
220 si->stats.rx_frame_errors++;
222 si->stats.rx_fifo_errors++;
224 si->stats.rx_bytes++;
225 async_unwrap_char(dev, &si->stats, &si->rx_buff, data);
229 dev->last_rx = jiffies;
230 si->last_oscr = OSCR;
233 case 0x04: /* Received Data Available */
236 case 0x0C: /* Character Timeout Indication */
238 si->stats.rx_bytes++;
239 async_unwrap_char(dev, &si->stats, &si->rx_buff, STRBR);
240 } while (STLSR & LSR_DR);
241 dev->last_rx = jiffies;
242 si->last_oscr = OSCR;
245 case 0x02: /* Transmit FIFO Data Request */
246 while ((si->tx_buff.len) && (STLSR & LSR_TDRQ)) {
247 STTHR = *si->tx_buff.data++;
248 si->tx_buff.len -= 1;
251 if (si->tx_buff.len == 0) {
252 si->stats.tx_packets++;
253 si->stats.tx_bytes += si->tx_buff.data -
256 /* We need to ensure that the transmitter has finished. */
257 while ((STLSR & LSR_TEMT) == 0)
259 si->last_oscr = OSCR;
262 * Ok, we've finished transmitting. Now enable
263 * the receiver. Sometimes we get a receive IRQ
264 * immediately after a transmit...
267 pxa_irda_set_speed(si, si->newspeed);
270 /* enable IR Receiver, disable IR Transmitter */
271 STISR = IrSR_IR_RECEIVE_ON | IrSR_XMODE_PULSE_1_6;
272 /* enable STUART and receive interrupts */
273 STIER = IER_UUE | IER_RLSE | IER_RAVIE | IER_RTIOE;
276 netif_wake_queue(dev);
284 /* FIR Receive DMA interrupt handler */
285 static void pxa_irda_fir_dma_rx_irq(int channel, void *data)
287 int dcsr = DCSR(channel);
289 DCSR(channel) = dcsr & ~DCSR_RUN;
291 printk(KERN_DEBUG "pxa_ir: fir rx dma bus error %#x\n", dcsr);
294 /* FIR Transmit DMA interrupt handler */
295 static void pxa_irda_fir_dma_tx_irq(int channel, void *data)
297 struct net_device *dev = data;
298 struct pxa_irda *si = netdev_priv(dev);
301 dcsr = DCSR(channel);
302 DCSR(channel) = dcsr & ~DCSR_RUN;
304 if (dcsr & DCSR_ENDINTR) {
305 si->stats.tx_packets++;
306 si->stats.tx_bytes += si->dma_tx_buff_len;
308 si->stats.tx_errors++;
311 while (ICSR1 & ICSR1_TBY)
313 si->last_oscr = OSCR;
316 * HACK: It looks like the TBY bit is dropped too soon.
317 * Without this delay things break.
322 pxa_irda_set_speed(si, si->newspeed);
328 pxa_irda_fir_dma_rx_start(si);
329 while ((ICSR1 & ICSR1_RNE) && i--)
331 ICCR0 = ICCR0_ITR | ICCR0_RXE;
334 printk(KERN_ERR "pxa_ir: cannot clear Rx FIFO!\n");
336 netif_wake_queue(dev);
339 /* EIF(Error in FIFO/End in Frame) handler for FIR */
340 static void pxa_irda_fir_irq_eif(struct pxa_irda *si, struct net_device *dev, int icsr0)
342 unsigned int len, stat, data;
344 /* Get the current data position. */
345 len = DTADR(si->rxdma) - si->dma_rx_buff_phy;
348 /* Read Status, and then Data. */
353 if (stat & (ICSR1_CRE | ICSR1_ROR)) {
354 si->stats.rx_errors++;
355 if (stat & ICSR1_CRE) {
356 printk(KERN_DEBUG "pxa_ir: fir receive CRC error\n");
357 si->stats.rx_crc_errors++;
359 if (stat & ICSR1_ROR) {
360 printk(KERN_DEBUG "pxa_ir: fir receive overrun\n");
361 si->stats.rx_over_errors++;
364 si->dma_rx_buff[len++] = data;
366 /* If we hit the end of frame, there's no point in continuing. */
367 if (stat & ICSR1_EOF)
369 } while (ICSR0 & ICSR0_EIF);
371 if (stat & ICSR1_EOF) {
375 if (icsr0 & ICSR0_FRE) {
376 printk(KERN_ERR "pxa_ir: dropping erroneous frame\n");
377 si->stats.rx_dropped++;
381 skb = alloc_skb(len+1,GFP_ATOMIC);
383 printk(KERN_ERR "pxa_ir: fir out of memory for receive skb\n");
384 si->stats.rx_dropped++;
388 /* Align IP header to 20 bytes */
390 skb_copy_to_linear_data(skb, si->dma_rx_buff, len);
393 /* Feed it to IrLAP */
395 skb_reset_mac_header(skb);
396 skb->protocol = htons(ETH_P_IRDA);
399 si->stats.rx_packets++;
400 si->stats.rx_bytes += len;
402 dev->last_rx = jiffies;
406 /* FIR interrupt handler */
407 static irqreturn_t pxa_irda_fir_irq(int irq, void *dev_id)
409 struct net_device *dev = dev_id;
410 struct pxa_irda *si = netdev_priv(dev);
414 DCSR(si->rxdma) &= ~DCSR_RUN;
415 si->last_oscr = OSCR;
418 if (icsr0 & (ICSR0_FRE | ICSR0_RAB)) {
419 if (icsr0 & ICSR0_FRE) {
420 printk(KERN_DEBUG "pxa_ir: fir receive frame error\n");
421 si->stats.rx_frame_errors++;
423 printk(KERN_DEBUG "pxa_ir: fir receive abort\n");
424 si->stats.rx_errors++;
426 ICSR0 = icsr0 & (ICSR0_FRE | ICSR0_RAB);
429 if (icsr0 & ICSR0_EIF) {
430 /* An error in FIFO occured, or there is a end of frame */
431 pxa_irda_fir_irq_eif(si, dev, icsr0);
435 pxa_irda_fir_dma_rx_start(si);
436 while ((ICSR1 & ICSR1_RNE) && i--)
438 ICCR0 = ICCR0_ITR | ICCR0_RXE;
441 printk(KERN_ERR "pxa_ir: cannot clear Rx FIFO!\n");
446 /* hard_xmit interface of irda device */
447 static int pxa_irda_hard_xmit(struct sk_buff *skb, struct net_device *dev)
449 struct pxa_irda *si = netdev_priv(dev);
450 int speed = irda_get_next_speed(skb);
453 * Does this packet contain a request to change the interface
454 * speed? If so, remember it until we complete the transmission
457 if (speed != si->speed && speed != -1)
458 si->newspeed = speed;
461 * If this is an empty frame, we can bypass a lot.
466 pxa_irda_set_speed(si, speed);
472 netif_stop_queue(dev);
475 si->tx_buff.data = si->tx_buff.head;
476 si->tx_buff.len = async_wrap_skb(skb, si->tx_buff.data, si->tx_buff.truesize);
478 /* Disable STUART interrupts and switch to transmit mode. */
480 STISR = IrSR_IR_TRANSMIT_ON | IrSR_XMODE_PULSE_1_6;
482 /* enable STUART and transmit interrupts */
483 STIER = IER_UUE | IER_TIE;
485 unsigned long mtt = irda_get_mtt(skb);
487 si->dma_tx_buff_len = skb->len;
488 skb_copy_from_linear_data(skb, si->dma_tx_buff, skb->len);
491 while ((unsigned)(OSCR - si->last_oscr)/4 < mtt)
494 /* stop RX DMA, disable FICP */
495 DCSR(si->rxdma) &= ~DCSR_RUN;
498 pxa_irda_fir_dma_tx_start(si);
499 ICCR0 = ICCR0_ITR | ICCR0_TXE;
503 dev->trans_start = jiffies;
507 static int pxa_irda_ioctl(struct net_device *dev, struct ifreq *ifreq, int cmd)
509 struct if_irda_req *rq = (struct if_irda_req *)ifreq;
510 struct pxa_irda *si = netdev_priv(dev);
516 if (capable(CAP_NET_ADMIN)) {
518 * We are unable to set the speed if the
519 * device is not running.
521 if (netif_running(dev)) {
522 ret = pxa_irda_set_speed(si,
525 printk(KERN_INFO "pxa_ir: SIOCSBANDWIDTH: !netif_running\n");
533 if (capable(CAP_NET_ADMIN)) {
534 irda_device_set_media_busy(dev, TRUE);
541 rq->ifr_receiving = IS_FIR(si) ? 0
542 : si->rx_buff.state != OUTSIDE_FRAME;
553 static struct net_device_stats *pxa_irda_stats(struct net_device *dev)
555 struct pxa_irda *si = netdev_priv(dev);
559 static void pxa_irda_startup(struct pxa_irda *si)
561 /* Disable STUART interrupts */
563 /* enable STUART interrupt to the processor */
565 /* configure SIR frame format: StartBit - Data 7 ... Data 0 - Stop Bit */
566 STLCR = LCR_WLS0 | LCR_WLS1;
567 /* enable FIFO, we use FIFO to improve performance */
568 STFCR = FCR_TRFIFOE | FCR_ITL_32;
572 /* configure FICP ICCR2 */
573 ICCR2 = ICCR2_TXP | ICCR2_TRIG_32;
576 DRCMR(17) = si->rxdma | DRCMR_MAPVLD;
577 DRCMR(18) = si->txdma | DRCMR_MAPVLD;
579 /* force SIR reinitialization */
581 pxa_irda_set_speed(si, 9600);
583 printk(KERN_DEBUG "pxa_ir: irda startup\n");
586 static void pxa_irda_shutdown(struct pxa_irda *si)
590 local_irq_save(flags);
592 /* disable STUART and interrupt */
594 /* disable STUART SIR mode */
598 DCSR(si->txdma) &= ~DCSR_RUN;
599 DCSR(si->rxdma) &= ~DCSR_RUN;
603 /* disable the STUART or FICP clocks */
604 pxa_irda_disable_clk(si);
609 local_irq_restore(flags);
611 /* power off board transceiver */
612 si->pdata->transceiver_mode(si->dev, IR_OFF);
614 printk(KERN_DEBUG "pxa_ir: irda shutdown\n");
617 static int pxa_irda_start(struct net_device *dev)
619 struct pxa_irda *si = netdev_priv(dev);
624 err = request_irq(IRQ_STUART, pxa_irda_sir_irq, 0, dev->name, dev);
628 err = request_irq(IRQ_ICP, pxa_irda_fir_irq, 0, dev->name, dev);
633 * The interrupt must remain disabled for now.
635 disable_irq(IRQ_STUART);
636 disable_irq(IRQ_ICP);
639 si->rxdma = pxa_request_dma("FICP_RX",DMA_PRIO_LOW, pxa_irda_fir_dma_rx_irq, dev);
643 si->txdma = pxa_request_dma("FICP_TX",DMA_PRIO_LOW, pxa_irda_fir_dma_tx_irq, dev);
648 si->dma_rx_buff = dma_alloc_coherent(si->dev, IRDA_FRAME_SIZE_LIMIT,
649 &si->dma_rx_buff_phy, GFP_KERNEL );
650 if (!si->dma_rx_buff)
651 goto err_dma_rx_buff;
653 si->dma_tx_buff = dma_alloc_coherent(si->dev, IRDA_FRAME_SIZE_LIMIT,
654 &si->dma_tx_buff_phy, GFP_KERNEL );
655 if (!si->dma_tx_buff)
656 goto err_dma_tx_buff;
658 /* Setup the serial port for the initial speed. */
659 pxa_irda_startup(si);
662 * Open a new IrLAP layer instance.
664 si->irlap = irlap_open(dev, &si->qos, "pxa");
670 * Now enable the interrupt and start the queue
672 enable_irq(IRQ_STUART);
674 netif_start_queue(dev);
676 printk(KERN_DEBUG "pxa_ir: irda driver opened\n");
681 pxa_irda_shutdown(si);
682 dma_free_coherent(si->dev, IRDA_FRAME_SIZE_LIMIT, si->dma_tx_buff, si->dma_tx_buff_phy);
684 dma_free_coherent(si->dev, IRDA_FRAME_SIZE_LIMIT, si->dma_rx_buff, si->dma_rx_buff_phy);
686 pxa_free_dma(si->txdma);
688 pxa_free_dma(si->rxdma);
690 free_irq(IRQ_ICP, dev);
692 free_irq(IRQ_STUART, dev);
698 static int pxa_irda_stop(struct net_device *dev)
700 struct pxa_irda *si = netdev_priv(dev);
702 netif_stop_queue(dev);
704 pxa_irda_shutdown(si);
708 irlap_close(si->irlap);
712 free_irq(IRQ_STUART, dev);
713 free_irq(IRQ_ICP, dev);
715 pxa_free_dma(si->rxdma);
716 pxa_free_dma(si->txdma);
719 dma_free_coherent(si->dev, IRDA_FRAME_SIZE_LIMIT, si->dma_tx_buff, si->dma_tx_buff_phy);
721 dma_free_coherent(si->dev, IRDA_FRAME_SIZE_LIMIT, si->dma_rx_buff, si->dma_rx_buff_phy);
723 printk(KERN_DEBUG "pxa_ir: irda driver closed\n");
727 static int pxa_irda_suspend(struct platform_device *_dev, pm_message_t state)
729 struct net_device *dev = platform_get_drvdata(_dev);
732 if (dev && netif_running(dev)) {
733 si = netdev_priv(dev);
734 netif_device_detach(dev);
735 pxa_irda_shutdown(si);
741 static int pxa_irda_resume(struct platform_device *_dev)
743 struct net_device *dev = platform_get_drvdata(_dev);
746 if (dev && netif_running(dev)) {
747 si = netdev_priv(dev);
748 pxa_irda_startup(si);
749 netif_device_attach(dev);
750 netif_wake_queue(dev);
757 static int pxa_irda_init_iobuf(iobuff_t *io, int size)
759 io->head = kmalloc(size, GFP_KERNEL | GFP_DMA);
760 if (io->head != NULL) {
762 io->in_frame = FALSE;
763 io->state = OUTSIDE_FRAME;
766 return io->head ? 0 : -ENOMEM;
769 static int pxa_irda_probe(struct platform_device *pdev)
771 struct net_device *dev;
773 unsigned int baudrate_mask;
776 if (!pdev->dev.platform_data)
779 err = request_mem_region(__PREG(STUART), 0x24, "IrDA") ? 0 : -EBUSY;
783 err = request_mem_region(__PREG(FICP), 0x1c, "IrDA") ? 0 : -EBUSY;
787 dev = alloc_irdadev(sizeof(struct pxa_irda));
791 si = netdev_priv(dev);
792 si->dev = &pdev->dev;
793 si->pdata = pdev->dev.platform_data;
795 si->sir_clk = clk_get(&pdev->dev, "UARTCLK");
796 si->fir_clk = clk_get(&pdev->dev, "FICPCLK");
797 if (IS_ERR(si->sir_clk) || IS_ERR(si->fir_clk)) {
798 err = PTR_ERR(IS_ERR(si->sir_clk) ? si->sir_clk : si->fir_clk);
803 * Initialise the SIR buffers
805 err = pxa_irda_init_iobuf(&si->rx_buff, 14384);
808 err = pxa_irda_init_iobuf(&si->tx_buff, 4000);
812 if (si->pdata->startup)
813 err = si->pdata->startup(si->dev);
817 dev->hard_start_xmit = pxa_irda_hard_xmit;
818 dev->open = pxa_irda_start;
819 dev->stop = pxa_irda_stop;
820 dev->do_ioctl = pxa_irda_ioctl;
821 dev->get_stats = pxa_irda_stats;
823 irda_init_max_qos_capabilies(&si->qos);
826 if (si->pdata->transceiver_cap & IR_SIRMODE)
827 baudrate_mask |= IR_9600|IR_19200|IR_38400|IR_57600|IR_115200;
828 if (si->pdata->transceiver_cap & IR_FIRMODE)
829 baudrate_mask |= IR_4000000 << 8;
831 si->qos.baud_rate.bits &= baudrate_mask;
832 si->qos.min_turn_time.bits = 7; /* 1ms or more */
834 irda_qos_bits_to_value(&si->qos);
836 err = register_netdev(dev);
839 dev_set_drvdata(&pdev->dev, dev);
842 if (si->pdata->shutdown)
843 si->pdata->shutdown(si->dev);
845 kfree(si->tx_buff.head);
847 kfree(si->rx_buff.head);
849 if (si->sir_clk && !IS_ERR(si->sir_clk))
850 clk_put(si->sir_clk);
851 if (si->fir_clk && !IS_ERR(si->fir_clk))
852 clk_put(si->fir_clk);
855 release_mem_region(__PREG(FICP), 0x1c);
857 release_mem_region(__PREG(STUART), 0x24);
863 static int pxa_irda_remove(struct platform_device *_dev)
865 struct net_device *dev = platform_get_drvdata(_dev);
868 struct pxa_irda *si = netdev_priv(dev);
869 unregister_netdev(dev);
870 if (si->pdata->shutdown)
871 si->pdata->shutdown(si->dev);
872 kfree(si->tx_buff.head);
873 kfree(si->rx_buff.head);
874 clk_put(si->fir_clk);
875 clk_put(si->sir_clk);
879 release_mem_region(__PREG(STUART), 0x24);
880 release_mem_region(__PREG(FICP), 0x1c);
885 static struct platform_driver pxa_ir_driver = {
888 .owner = THIS_MODULE,
890 .probe = pxa_irda_probe,
891 .remove = pxa_irda_remove,
892 .suspend = pxa_irda_suspend,
893 .resume = pxa_irda_resume,
896 static int __init pxa_irda_init(void)
898 return platform_driver_register(&pxa_ir_driver);
901 static void __exit pxa_irda_exit(void)
903 platform_driver_unregister(&pxa_ir_driver);
906 module_init(pxa_irda_init);
907 module_exit(pxa_irda_exit);
909 MODULE_LICENSE("GPL");
910 MODULE_ALIAS("platform:pxa2xx-ir");