1 /*********************************************************************
5 * Description: Driver for the NSC PC'108 and PC'338 IrDA chipsets
7 * Author: Dag Brattli <dagb@cs.uit.no>
8 * Created at: Sat Nov 7 21:43:15 1998
9 * Modified at: Wed Mar 1 11:29:34 2000
10 * Modified by: Dag Brattli <dagb@cs.uit.no>
12 * Copyright (c) 1998-2000 Dag Brattli <dagb@cs.uit.no>
13 * Copyright (c) 1998 Lichen Wang, <lwang@actisys.com>
14 * Copyright (c) 1998 Actisys Corp., www.actisys.com
15 * Copyright (c) 2000-2004 Jean Tourrilhes <jt@hpl.hp.com>
18 * This program is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU General Public License as
20 * published by the Free Software Foundation; either version 2 of
21 * the License, or (at your option) any later version.
23 * Neither Dag Brattli nor University of Tromsø admit liability nor
24 * provide warranty for any of this software. This material is
25 * provided "AS-IS" and at no charge.
27 * Notice that all functions that needs to access the chip in _any_
28 * way, must save BSR register on entry, and restore it on exit.
29 * It is _very_ important to follow this policy!
33 * bank = inb(iobase+BSR);
35 * do_your_stuff_here();
37 * outb(bank, iobase+BSR);
39 * If you find bugs in this file, its very likely that the same bug
40 * will also be in w83977af_ir.c since the implementations are quite
43 ********************************************************************/
45 #include <linux/module.h>
47 #include <linux/kernel.h>
48 #include <linux/types.h>
49 #include <linux/skbuff.h>
50 #include <linux/netdevice.h>
51 #include <linux/ioport.h>
52 #include <linux/delay.h>
53 #include <linux/slab.h>
54 #include <linux/init.h>
55 #include <linux/rtnetlink.h>
56 #include <linux/dma-mapping.h>
57 #include <linux/pnp.h>
58 #include <linux/platform_device.h>
62 #include <asm/byteorder.h>
64 #include <net/irda/wrapper.h>
65 #include <net/irda/irda.h>
66 #include <net/irda/irda_device.h>
70 #define CHIP_IO_EXTENT 8
71 #define BROKEN_DONGLE_ID
73 static char *driver_name = "nsc-ircc";
75 /* Power Management */
76 #define NSC_IRCC_DRIVER_NAME "nsc-ircc"
77 static int nsc_ircc_suspend(struct platform_device *dev, pm_message_t state);
78 static int nsc_ircc_resume(struct platform_device *dev);
80 static struct platform_driver nsc_ircc_driver = {
81 .suspend = nsc_ircc_suspend,
82 .resume = nsc_ircc_resume,
84 .name = NSC_IRCC_DRIVER_NAME,
88 /* Module parameters */
89 static int qos_mtt_bits = 0x07; /* 1 ms or more */
92 /* Use BIOS settions by default, but user may supply module parameters */
93 static unsigned int io[] = { ~0, ~0, ~0, ~0, ~0 };
94 static unsigned int irq[] = { 0, 0, 0, 0, 0 };
95 static unsigned int dma[] = { 0, 0, 0, 0, 0 };
97 static int nsc_ircc_probe_108(nsc_chip_t *chip, chipio_t *info);
98 static int nsc_ircc_probe_338(nsc_chip_t *chip, chipio_t *info);
99 static int nsc_ircc_probe_39x(nsc_chip_t *chip, chipio_t *info);
100 static int nsc_ircc_init_108(nsc_chip_t *chip, chipio_t *info);
101 static int nsc_ircc_init_338(nsc_chip_t *chip, chipio_t *info);
102 static int nsc_ircc_init_39x(nsc_chip_t *chip, chipio_t *info);
104 static int nsc_ircc_pnp_probe(struct pnp_dev *dev, const struct pnp_device_id *id);
107 /* These are the known NSC chips */
108 static nsc_chip_t chips[] = {
109 /* Name, {cfg registers}, chip id index reg, chip id expected value, revision mask */
110 { "PC87108", { 0x150, 0x398, 0xea }, 0x05, 0x10, 0xf0,
111 nsc_ircc_probe_108, nsc_ircc_init_108 },
112 { "PC87338", { 0x398, 0x15c, 0x2e }, 0x08, 0xb0, 0xf8,
113 nsc_ircc_probe_338, nsc_ircc_init_338 },
114 /* Contributed by Steffen Pingel - IBM X40 */
115 { "PC8738x", { 0x164e, 0x4e, 0x2e }, 0x20, 0xf4, 0xff,
116 nsc_ircc_probe_39x, nsc_ircc_init_39x },
117 /* Contributed by Jan Frey - IBM A30/A31 */
118 { "PC8739x", { 0x2e, 0x4e, 0x0 }, 0x20, 0xea, 0xff,
119 nsc_ircc_probe_39x, nsc_ircc_init_39x },
120 /* IBM ThinkPads using PC8738x (T60/X60/Z60) */
121 { "IBM-PC8738x", { 0x2e, 0x4e, 0x0 }, 0x20, 0xf4, 0xff,
122 nsc_ircc_probe_39x, nsc_ircc_init_39x },
123 /* IBM ThinkPads using PC8394T (T43/R52/?) */
124 { "IBM-PC8394T", { 0x2e, 0x4e, 0x0 }, 0x20, 0xf9, 0xff,
125 nsc_ircc_probe_39x, nsc_ircc_init_39x },
129 static struct nsc_ircc_cb *dev_self[] = { NULL, NULL, NULL, NULL, NULL };
131 static char *dongle_types[] = {
132 "Differential serial interface",
133 "Differential serial interface",
138 "Single-ended serial interface",
140 "HP HSDL-2300, HP HSDL-3600/HSDL-3610",
141 "IBM31T1100 or Temic TFDS6000/TFDS6500",
144 "HP HSDL-1100/HSDL-2100",
145 "HP HSDL-1100/HSDL-2100",
146 "Supports SIR Mode only",
147 "No dongle connected",
151 static chipio_t pnp_info;
152 static const struct pnp_device_id nsc_ircc_pnp_table[] = {
153 { .id = "NSC6001", .driver_data = 0 },
154 { .id = "HWPC224", .driver_data = 0 },
155 { .id = "IBM0071", .driver_data = NSC_FORCE_DONGLE_TYPE9 },
159 MODULE_DEVICE_TABLE(pnp, nsc_ircc_pnp_table);
161 static struct pnp_driver nsc_ircc_pnp_driver = {
164 .id_table = nsc_ircc_pnp_table,
165 .probe = nsc_ircc_pnp_probe,
169 /* Some prototypes */
170 static int nsc_ircc_open(chipio_t *info);
171 static int nsc_ircc_close(struct nsc_ircc_cb *self);
172 static int nsc_ircc_setup(chipio_t *info);
173 static void nsc_ircc_pio_receive(struct nsc_ircc_cb *self);
174 static int nsc_ircc_dma_receive(struct nsc_ircc_cb *self);
175 static int nsc_ircc_dma_receive_complete(struct nsc_ircc_cb *self, int iobase);
176 static int nsc_ircc_hard_xmit_sir(struct sk_buff *skb, struct net_device *dev);
177 static int nsc_ircc_hard_xmit_fir(struct sk_buff *skb, struct net_device *dev);
178 static int nsc_ircc_pio_write(int iobase, __u8 *buf, int len, int fifo_size);
179 static void nsc_ircc_dma_xmit(struct nsc_ircc_cb *self, int iobase);
180 static __u8 nsc_ircc_change_speed(struct nsc_ircc_cb *self, __u32 baud);
181 static int nsc_ircc_is_receiving(struct nsc_ircc_cb *self);
182 static int nsc_ircc_read_dongle_id (int iobase);
183 static void nsc_ircc_init_dongle_interface (int iobase, int dongle_id);
185 static int nsc_ircc_net_open(struct net_device *dev);
186 static int nsc_ircc_net_close(struct net_device *dev);
187 static int nsc_ircc_net_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
190 static int pnp_registered;
191 static int pnp_succeeded;
194 * Function nsc_ircc_init ()
196 * Initialize chip. Just try to find out how many chips we are dealing with
199 static int __init nsc_ircc_init(void)
209 ret = platform_driver_register(&nsc_ircc_driver);
211 IRDA_ERROR("%s, Can't register driver!\n", driver_name);
215 /* Register with PnP subsystem to detect disable ports */
216 ret = pnp_register_driver(&nsc_ircc_pnp_driver);
223 /* Probe for all the NSC chipsets we know about */
224 for (chip = chips; chip->name ; chip++) {
225 IRDA_DEBUG(2, "%s(), Probing for %s ...\n", __func__,
228 /* Try all config registers for this chip */
229 for (cfg = 0; cfg < ARRAY_SIZE(chip->cfg); cfg++) {
230 cfg_base = chip->cfg[cfg];
234 /* Read index register */
237 IRDA_DEBUG(2, "%s() no chip at 0x%03x\n", __func__, cfg_base);
241 /* Read chip identification register */
242 outb(chip->cid_index, cfg_base);
243 id = inb(cfg_base+1);
244 if ((id & chip->cid_mask) == chip->cid_value) {
245 IRDA_DEBUG(2, "%s() Found %s chip, revision=%d\n",
246 __func__, chip->name, id & ~chip->cid_mask);
249 * If we found a correct PnP setting,
253 memset(&info, 0, sizeof(chipio_t));
254 info.cfg_base = cfg_base;
255 info.fir_base = pnp_info.fir_base;
256 info.dma = pnp_info.dma;
257 info.irq = pnp_info.irq;
259 if (info.fir_base < 0x2000) {
260 IRDA_MESSAGE("%s, chip->init\n", driver_name);
261 chip->init(chip, &info);
263 chip->probe(chip, &info);
265 if (nsc_ircc_open(&info) >= 0)
270 * Opening based on PnP values failed.
271 * Let's fallback to user values, or probe
275 IRDA_DEBUG(2, "%s, PnP init failed\n", driver_name);
276 memset(&info, 0, sizeof(chipio_t));
277 info.cfg_base = cfg_base;
278 info.fir_base = io[i];
283 * If the user supplies the base address, then
284 * we init the chip, if not we probe the values
287 if (io[i] < 0x2000) {
288 chip->init(chip, &info);
290 chip->probe(chip, &info);
292 if (nsc_ircc_open(&info) >= 0)
297 IRDA_DEBUG(2, "%s(), Wrong chip id=0x%02x\n", __func__, id);
303 platform_driver_unregister(&nsc_ircc_driver);
304 pnp_unregister_driver(&nsc_ircc_pnp_driver);
312 * Function nsc_ircc_cleanup ()
314 * Close all configured chips
317 static void __exit nsc_ircc_cleanup(void)
321 for (i = 0; i < ARRAY_SIZE(dev_self); i++) {
323 nsc_ircc_close(dev_self[i]);
326 platform_driver_unregister(&nsc_ircc_driver);
329 pnp_unregister_driver(&nsc_ircc_pnp_driver);
334 static const struct net_device_ops nsc_ircc_sir_ops = {
335 .ndo_open = nsc_ircc_net_open,
336 .ndo_stop = nsc_ircc_net_close,
337 .ndo_start_xmit = nsc_ircc_hard_xmit_sir,
338 .ndo_do_ioctl = nsc_ircc_net_ioctl,
341 static const struct net_device_ops nsc_ircc_fir_ops = {
342 .ndo_open = nsc_ircc_net_open,
343 .ndo_stop = nsc_ircc_net_close,
344 .ndo_start_xmit = nsc_ircc_hard_xmit_fir,
345 .ndo_do_ioctl = nsc_ircc_net_ioctl,
349 * Function nsc_ircc_open (iobase, irq)
351 * Open driver instance
354 static int __init nsc_ircc_open(chipio_t *info)
356 struct net_device *dev;
357 struct nsc_ircc_cb *self;
361 IRDA_DEBUG(2, "%s()\n", __func__);
364 for (chip_index = 0; chip_index < ARRAY_SIZE(dev_self); chip_index++) {
365 if (!dev_self[chip_index])
369 if (chip_index == ARRAY_SIZE(dev_self)) {
370 IRDA_ERROR("%s(), maximum number of supported chips reached!\n", __func__);
374 IRDA_MESSAGE("%s, Found chip at base=0x%03x\n", driver_name,
377 if ((nsc_ircc_setup(info)) == -1)
380 IRDA_MESSAGE("%s, driver loaded (Dag Brattli)\n", driver_name);
382 dev = alloc_irdadev(sizeof(struct nsc_ircc_cb));
384 IRDA_ERROR("%s(), can't allocate memory for "
385 "control block!\n", __func__);
389 self = netdev_priv(dev);
391 spin_lock_init(&self->lock);
393 /* Need to store self somewhere */
394 dev_self[chip_index] = self;
395 self->index = chip_index;
398 self->io.cfg_base = info->cfg_base;
399 self->io.fir_base = info->fir_base;
400 self->io.irq = info->irq;
401 self->io.fir_ext = CHIP_IO_EXTENT;
402 self->io.dma = info->dma;
403 self->io.fifo_size = 32;
405 /* Reserve the ioports that we need */
406 ret = request_region(self->io.fir_base, self->io.fir_ext, driver_name);
408 IRDA_WARNING("%s(), can't get iobase of 0x%03x\n",
409 __func__, self->io.fir_base);
414 /* Initialize QoS for this device */
415 irda_init_max_qos_capabilies(&self->qos);
417 /* The only value we must override it the baudrate */
418 self->qos.baud_rate.bits = IR_9600|IR_19200|IR_38400|IR_57600|
419 IR_115200|IR_576000|IR_1152000 |(IR_4000000 << 8);
421 self->qos.min_turn_time.bits = qos_mtt_bits;
422 irda_qos_bits_to_value(&self->qos);
424 /* Max DMA buffer size needed = (data_size + 6) * (window_size) + 6; */
425 self->rx_buff.truesize = 14384;
426 self->tx_buff.truesize = 14384;
428 /* Allocate memory if needed */
430 dma_alloc_coherent(NULL, self->rx_buff.truesize,
431 &self->rx_buff_dma, GFP_KERNEL);
432 if (self->rx_buff.head == NULL) {
437 memset(self->rx_buff.head, 0, self->rx_buff.truesize);
440 dma_alloc_coherent(NULL, self->tx_buff.truesize,
441 &self->tx_buff_dma, GFP_KERNEL);
442 if (self->tx_buff.head == NULL) {
446 memset(self->tx_buff.head, 0, self->tx_buff.truesize);
448 self->rx_buff.in_frame = FALSE;
449 self->rx_buff.state = OUTSIDE_FRAME;
450 self->tx_buff.data = self->tx_buff.head;
451 self->rx_buff.data = self->rx_buff.head;
453 /* Reset Tx queue info */
454 self->tx_fifo.len = self->tx_fifo.ptr = self->tx_fifo.free = 0;
455 self->tx_fifo.tail = self->tx_buff.head;
457 /* Override the network functions we need to use */
458 dev->netdev_ops = &nsc_ircc_sir_ops;
460 err = register_netdev(dev);
462 IRDA_ERROR("%s(), register_netdev() failed!\n", __func__);
465 IRDA_MESSAGE("IrDA: Registered device %s\n", dev->name);
467 /* Check if user has supplied a valid dongle id or not */
468 if ((dongle_id <= 0) ||
469 (dongle_id >= ARRAY_SIZE(dongle_types))) {
470 dongle_id = nsc_ircc_read_dongle_id(self->io.fir_base);
472 IRDA_MESSAGE("%s, Found dongle: %s\n", driver_name,
473 dongle_types[dongle_id]);
475 IRDA_MESSAGE("%s, Using dongle: %s\n", driver_name,
476 dongle_types[dongle_id]);
479 self->io.dongle_id = dongle_id;
480 nsc_ircc_init_dongle_interface(self->io.fir_base, dongle_id);
482 self->pldev = platform_device_register_simple(NSC_IRCC_DRIVER_NAME,
483 self->index, NULL, 0);
484 if (IS_ERR(self->pldev)) {
485 err = PTR_ERR(self->pldev);
488 platform_set_drvdata(self->pldev, self);
493 unregister_netdev(dev);
495 dma_free_coherent(NULL, self->tx_buff.truesize,
496 self->tx_buff.head, self->tx_buff_dma);
498 dma_free_coherent(NULL, self->rx_buff.truesize,
499 self->rx_buff.head, self->rx_buff_dma);
501 release_region(self->io.fir_base, self->io.fir_ext);
504 dev_self[chip_index] = NULL;
509 * Function nsc_ircc_close (self)
511 * Close driver instance
514 static int __exit nsc_ircc_close(struct nsc_ircc_cb *self)
518 IRDA_DEBUG(4, "%s()\n", __func__);
520 IRDA_ASSERT(self != NULL, return -1;);
522 iobase = self->io.fir_base;
524 platform_device_unregister(self->pldev);
526 /* Remove netdevice */
527 unregister_netdev(self->netdev);
529 /* Release the PORT that this driver is using */
530 IRDA_DEBUG(4, "%s(), Releasing Region %03x\n",
531 __func__, self->io.fir_base);
532 release_region(self->io.fir_base, self->io.fir_ext);
534 if (self->tx_buff.head)
535 dma_free_coherent(NULL, self->tx_buff.truesize,
536 self->tx_buff.head, self->tx_buff_dma);
538 if (self->rx_buff.head)
539 dma_free_coherent(NULL, self->rx_buff.truesize,
540 self->rx_buff.head, self->rx_buff_dma);
542 dev_self[self->index] = NULL;
543 free_netdev(self->netdev);
549 * Function nsc_ircc_init_108 (iobase, cfg_base, irq, dma)
551 * Initialize the NSC '108 chip
554 static int nsc_ircc_init_108(nsc_chip_t *chip, chipio_t *info)
556 int cfg_base = info->cfg_base;
559 outb(2, cfg_base); /* Mode Control Register (MCTL) */
560 outb(0x00, cfg_base+1); /* Disable device */
562 /* Base Address and Interrupt Control Register (BAIC) */
563 outb(CFG_108_BAIC, cfg_base);
564 switch (info->fir_base) {
565 case 0x3e8: outb(0x14, cfg_base+1); break;
566 case 0x2e8: outb(0x15, cfg_base+1); break;
567 case 0x3f8: outb(0x16, cfg_base+1); break;
568 case 0x2f8: outb(0x17, cfg_base+1); break;
569 default: IRDA_ERROR("%s(), invalid base_address", __func__);
572 /* Control Signal Routing Register (CSRT) */
574 case 3: temp = 0x01; break;
575 case 4: temp = 0x02; break;
576 case 5: temp = 0x03; break;
577 case 7: temp = 0x04; break;
578 case 9: temp = 0x05; break;
579 case 11: temp = 0x06; break;
580 case 15: temp = 0x07; break;
581 default: IRDA_ERROR("%s(), invalid irq", __func__);
583 outb(CFG_108_CSRT, cfg_base);
586 case 0: outb(0x08+temp, cfg_base+1); break;
587 case 1: outb(0x10+temp, cfg_base+1); break;
588 case 3: outb(0x18+temp, cfg_base+1); break;
589 default: IRDA_ERROR("%s(), invalid dma", __func__);
592 outb(CFG_108_MCTL, cfg_base); /* Mode Control Register (MCTL) */
593 outb(0x03, cfg_base+1); /* Enable device */
599 * Function nsc_ircc_probe_108 (chip, info)
604 static int nsc_ircc_probe_108(nsc_chip_t *chip, chipio_t *info)
606 int cfg_base = info->cfg_base;
609 /* Read address and interrupt control register (BAIC) */
610 outb(CFG_108_BAIC, cfg_base);
611 reg = inb(cfg_base+1);
613 switch (reg & 0x03) {
615 info->fir_base = 0x3e8;
618 info->fir_base = 0x2e8;
621 info->fir_base = 0x3f8;
624 info->fir_base = 0x2f8;
627 info->sir_base = info->fir_base;
628 IRDA_DEBUG(2, "%s(), probing fir_base=0x%03x\n", __func__,
631 /* Read control signals routing register (CSRT) */
632 outb(CFG_108_CSRT, cfg_base);
633 reg = inb(cfg_base+1);
635 switch (reg & 0x07) {
661 IRDA_DEBUG(2, "%s(), probing irq=%d\n", __func__, info->irq);
663 /* Currently we only read Rx DMA but it will also be used for Tx */
664 switch ((reg >> 3) & 0x03) {
678 IRDA_DEBUG(2, "%s(), probing dma=%d\n", __func__, info->dma);
680 /* Read mode control register (MCTL) */
681 outb(CFG_108_MCTL, cfg_base);
682 reg = inb(cfg_base+1);
684 info->enabled = reg & 0x01;
685 info->suspended = !((reg >> 1) & 0x01);
691 * Function nsc_ircc_init_338 (chip, info)
693 * Initialize the NSC '338 chip. Remember that the 87338 needs two
694 * consecutive writes to the data registers while CPU interrupts are
695 * disabled. The 97338 does not require this, but shouldn't be any
696 * harm if we do it anyway.
698 static int nsc_ircc_init_338(nsc_chip_t *chip, chipio_t *info)
706 * Function nsc_ircc_probe_338 (chip, info)
711 static int nsc_ircc_probe_338(nsc_chip_t *chip, chipio_t *info)
713 int cfg_base = info->cfg_base;
717 /* Read funtion enable register (FER) */
718 outb(CFG_338_FER, cfg_base);
719 reg = inb(cfg_base+1);
721 info->enabled = (reg >> 2) & 0x01;
723 /* Check if we are in Legacy or PnP mode */
724 outb(CFG_338_PNP0, cfg_base);
725 reg = inb(cfg_base+1);
727 pnp = (reg >> 3) & 0x01;
729 IRDA_DEBUG(2, "(), Chip is in PnP mode\n");
730 outb(0x46, cfg_base);
731 reg = (inb(cfg_base+1) & 0xfe) << 2;
733 outb(0x47, cfg_base);
734 reg |= ((inb(cfg_base+1) & 0xfc) << 8);
736 info->fir_base = reg;
738 /* Read function address register (FAR) */
739 outb(CFG_338_FAR, cfg_base);
740 reg = inb(cfg_base+1);
742 switch ((reg >> 4) & 0x03) {
744 info->fir_base = 0x3f8;
747 info->fir_base = 0x2f8;
758 switch ((reg >> 6) & 0x03) {
761 info->fir_base = 0x3e8;
763 info->fir_base = 0x2e8;
767 info->fir_base = 0x338;
769 info->fir_base = 0x238;
773 info->fir_base = 0x2e8;
775 info->fir_base = 0x2e0;
779 info->fir_base = 0x220;
781 info->fir_base = 0x228;
786 info->sir_base = info->fir_base;
788 /* Read PnP register 1 (PNP1) */
789 outb(CFG_338_PNP1, cfg_base);
790 reg = inb(cfg_base+1);
792 info->irq = reg >> 4;
794 /* Read PnP register 3 (PNP3) */
795 outb(CFG_338_PNP3, cfg_base);
796 reg = inb(cfg_base+1);
798 info->dma = (reg & 0x07) - 1;
800 /* Read power and test register (PTR) */
801 outb(CFG_338_PTR, cfg_base);
802 reg = inb(cfg_base+1);
804 info->suspended = reg & 0x01;
811 * Function nsc_ircc_init_39x (chip, info)
813 * Now that we know it's a '39x (see probe below), we need to
814 * configure it so we can use it.
816 * The NSC '338 chip is a Super I/O chip with a "bank" architecture,
817 * the configuration of the different functionality (serial, parallel,
818 * floppy...) are each in a different bank (Logical Device Number).
819 * The base address, irq and dma configuration registers are common
820 * to all functionalities (index 0x30 to 0x7F).
821 * There is only one configuration register specific to the
822 * serial port, CFG_39X_SPC.
825 * Note : this code was written by Jan Frey <janfrey@web.de>
827 static int nsc_ircc_init_39x(nsc_chip_t *chip, chipio_t *info)
829 int cfg_base = info->cfg_base;
832 /* User is sure about his config... accept it. */
833 IRDA_DEBUG(2, "%s(): nsc_ircc_init_39x (user settings): "
834 "io=0x%04x, irq=%d, dma=%d\n",
835 __func__, info->fir_base, info->irq, info->dma);
837 /* Access bank for SP2 */
838 outb(CFG_39X_LDN, cfg_base);
839 outb(0x02, cfg_base+1);
843 /* We want to enable the device if not enabled */
844 outb(CFG_39X_ACT, cfg_base);
845 enabled = inb(cfg_base+1) & 0x01;
848 /* Enable the device */
849 outb(CFG_39X_SIOCF1, cfg_base);
850 outb(0x01, cfg_base+1);
851 /* May want to update info->enabled. Jean II */
854 /* Enable UART bank switching (bit 7) ; Sets the chip to normal
855 * power mode (wake up from sleep mode) (bit 1) */
856 outb(CFG_39X_SPC, cfg_base);
857 outb(0x82, cfg_base+1);
863 * Function nsc_ircc_probe_39x (chip, info)
865 * Test if we really have a '39x chip at the given address
867 * Note : this code was written by Jan Frey <janfrey@web.de>
869 static int nsc_ircc_probe_39x(nsc_chip_t *chip, chipio_t *info)
871 int cfg_base = info->cfg_base;
872 int reg1, reg2, irq, irqt, dma1, dma2;
875 IRDA_DEBUG(2, "%s(), nsc_ircc_probe_39x, base=%d\n",
878 /* This function should be executed with irq off to avoid
879 * another driver messing with the Super I/O bank - Jean II */
881 /* Access bank for SP2 */
882 outb(CFG_39X_LDN, cfg_base);
883 outb(0x02, cfg_base+1);
885 /* Read infos about SP2 ; store in info struct */
886 outb(CFG_39X_BASEH, cfg_base);
887 reg1 = inb(cfg_base+1);
888 outb(CFG_39X_BASEL, cfg_base);
889 reg2 = inb(cfg_base+1);
890 info->fir_base = (reg1 << 8) | reg2;
892 outb(CFG_39X_IRQNUM, cfg_base);
893 irq = inb(cfg_base+1);
894 outb(CFG_39X_IRQSEL, cfg_base);
895 irqt = inb(cfg_base+1);
898 outb(CFG_39X_DMA0, cfg_base);
899 dma1 = inb(cfg_base+1);
900 outb(CFG_39X_DMA1, cfg_base);
901 dma2 = inb(cfg_base+1);
904 outb(CFG_39X_ACT, cfg_base);
905 info->enabled = enabled = inb(cfg_base+1) & 0x01;
907 outb(CFG_39X_SPC, cfg_base);
908 susp = 1 - ((inb(cfg_base+1) & 0x02) >> 1);
910 IRDA_DEBUG(2, "%s(): io=0x%02x%02x, irq=%d (type %d), rxdma=%d, txdma=%d, enabled=%d (suspended=%d)\n", __func__, reg1,reg2,irq,irqt,dma1,dma2,enabled,susp);
914 /* We want to enable the device if not enabled */
915 outb(CFG_39X_ACT, cfg_base);
916 enabled = inb(cfg_base+1) & 0x01;
919 /* Enable the device */
920 outb(CFG_39X_SIOCF1, cfg_base);
921 outb(0x01, cfg_base+1);
922 /* May want to update info->enabled. Jean II */
925 /* Enable UART bank switching (bit 7) ; Sets the chip to normal
926 * power mode (wake up from sleep mode) (bit 1) */
927 outb(CFG_39X_SPC, cfg_base);
928 outb(0x82, cfg_base+1);
935 static int nsc_ircc_pnp_probe(struct pnp_dev *dev, const struct pnp_device_id *id)
937 memset(&pnp_info, 0, sizeof(chipio_t));
942 if (id->driver_data & NSC_FORCE_DONGLE_TYPE9)
945 /* There doesn't seem to be any way of getting the cfg_base.
946 * On my box, cfg_base is in the PnP descriptor of the
947 * motherboard. Oh well... Jean II */
949 if (pnp_port_valid(dev, 0) &&
950 !(pnp_port_flags(dev, 0) & IORESOURCE_DISABLED))
951 pnp_info.fir_base = pnp_port_start(dev, 0);
953 if (pnp_irq_valid(dev, 0) &&
954 !(pnp_irq_flags(dev, 0) & IORESOURCE_DISABLED))
955 pnp_info.irq = pnp_irq(dev, 0);
957 if (pnp_dma_valid(dev, 0) &&
958 !(pnp_dma_flags(dev, 0) & IORESOURCE_DISABLED))
959 pnp_info.dma = pnp_dma(dev, 0);
961 IRDA_DEBUG(0, "%s() : From PnP, found firbase 0x%03X ; irq %d ; dma %d.\n",
962 __func__, pnp_info.fir_base, pnp_info.irq, pnp_info.dma);
964 if((pnp_info.fir_base == 0) ||
965 (pnp_info.irq == -1) || (pnp_info.dma == -1)) {
966 /* Returning an error will disable the device. Yuck ! */
976 * Function nsc_ircc_setup (info)
978 * Returns non-negative on success.
981 static int nsc_ircc_setup(chipio_t *info)
984 int iobase = info->fir_base;
986 /* Read the Module ID */
987 switch_bank(iobase, BANK3);
988 version = inb(iobase+MID);
990 IRDA_DEBUG(2, "%s() Driver %s Found chip version %02x\n",
991 __func__, driver_name, version);
994 if (0x20 != (version & 0xf0)) {
995 IRDA_ERROR("%s, Wrong chip version %02x\n",
996 driver_name, version);
1000 /* Switch to advanced mode */
1001 switch_bank(iobase, BANK2);
1002 outb(ECR1_EXT_SL, iobase+ECR1);
1003 switch_bank(iobase, BANK0);
1005 /* Set FIFO threshold to TX17, RX16, reset and enable FIFO's */
1006 switch_bank(iobase, BANK0);
1007 outb(FCR_RXTH|FCR_TXTH|FCR_TXSR|FCR_RXSR|FCR_FIFO_EN, iobase+FCR);
1009 outb(0x03, iobase+LCR); /* 8 bit word length */
1010 outb(MCR_SIR, iobase+MCR); /* Start at SIR-mode, also clears LSR*/
1012 /* Set FIFO size to 32 */
1013 switch_bank(iobase, BANK2);
1014 outb(EXCR2_RFSIZ|EXCR2_TFSIZ, iobase+EXCR2);
1016 /* IRCR2: FEND_MD is not set */
1017 switch_bank(iobase, BANK5);
1018 outb(0x02, iobase+4);
1020 /* Make sure that some defaults are OK */
1021 switch_bank(iobase, BANK6);
1022 outb(0x20, iobase+0); /* Set 32 bits FIR CRC */
1023 outb(0x0a, iobase+1); /* Set MIR pulse width */
1024 outb(0x0d, iobase+2); /* Set SIR pulse width to 1.6us */
1025 outb(0x2a, iobase+4); /* Set beginning frag, and preamble length */
1027 /* Enable receive interrupts */
1028 switch_bank(iobase, BANK0);
1029 outb(IER_RXHDL_IE, iobase+IER);
1035 * Function nsc_ircc_read_dongle_id (void)
1037 * Try to read dongle indentification. This procedure needs to be executed
1038 * once after power-on/reset. It also needs to be used whenever you suspect
1039 * that the user may have plugged/unplugged the IrDA Dongle.
1041 static int nsc_ircc_read_dongle_id (int iobase)
1046 bank = inb(iobase+BSR);
1049 switch_bank(iobase, BANK7);
1051 /* IRCFG4: IRSL0_DS and IRSL21_DS are cleared */
1052 outb(0x00, iobase+7);
1054 /* ID0, 1, and 2 are pulled up/down very slowly */
1057 /* IRCFG1: read the ID bits */
1058 dongle_id = inb(iobase+4) & 0x0f;
1060 #ifdef BROKEN_DONGLE_ID
1061 if (dongle_id == 0x0a)
1064 /* Go back to bank 0 before returning */
1065 switch_bank(iobase, BANK0);
1067 outb(bank, iobase+BSR);
1073 * Function nsc_ircc_init_dongle_interface (iobase, dongle_id)
1075 * This function initializes the dongle for the transceiver that is
1076 * used. This procedure needs to be executed once after
1077 * power-on/reset. It also needs to be used whenever you suspect that
1078 * the dongle is changed.
1080 static void nsc_ircc_init_dongle_interface (int iobase, int dongle_id)
1084 /* Save current bank */
1085 bank = inb(iobase+BSR);
1088 switch_bank(iobase, BANK7);
1090 /* IRCFG4: set according to dongle_id */
1091 switch (dongle_id) {
1092 case 0x00: /* same as */
1093 case 0x01: /* Differential serial interface */
1094 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1095 __func__, dongle_types[dongle_id]);
1097 case 0x02: /* same as */
1098 case 0x03: /* Reserved */
1099 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1100 __func__, dongle_types[dongle_id]);
1102 case 0x04: /* Sharp RY5HD01 */
1104 case 0x05: /* Reserved, but this is what the Thinkpad reports */
1105 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1106 __func__, dongle_types[dongle_id]);
1108 case 0x06: /* Single-ended serial interface */
1109 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1110 __func__, dongle_types[dongle_id]);
1112 case 0x07: /* Consumer-IR only */
1113 IRDA_DEBUG(0, "%s(), %s is not for IrDA mode\n",
1114 __func__, dongle_types[dongle_id]);
1116 case 0x08: /* HP HSDL-2300, HP HSDL-3600/HSDL-3610 */
1117 IRDA_DEBUG(0, "%s(), %s\n",
1118 __func__, dongle_types[dongle_id]);
1120 case 0x09: /* IBM31T1100 or Temic TFDS6000/TFDS6500 */
1121 outb(0x28, iobase+7); /* Set irsl[0-2] as output */
1123 case 0x0A: /* same as */
1124 case 0x0B: /* Reserved */
1125 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1126 __func__, dongle_types[dongle_id]);
1128 case 0x0C: /* same as */
1129 case 0x0D: /* HP HSDL-1100/HSDL-2100 */
1131 * Set irsl0 as input, irsl[1-2] as output, and separate
1132 * inputs are used for SIR and MIR/FIR
1134 outb(0x48, iobase+7);
1136 case 0x0E: /* Supports SIR Mode only */
1137 outb(0x28, iobase+7); /* Set irsl[0-2] as output */
1139 case 0x0F: /* No dongle connected */
1140 IRDA_DEBUG(0, "%s(), %s\n",
1141 __func__, dongle_types[dongle_id]);
1143 switch_bank(iobase, BANK0);
1144 outb(0x62, iobase+MCR);
1147 IRDA_DEBUG(0, "%s(), invalid dongle_id %#x",
1148 __func__, dongle_id);
1151 /* IRCFG1: IRSL1 and 2 are set to IrDA mode */
1152 outb(0x00, iobase+4);
1154 /* Restore bank register */
1155 outb(bank, iobase+BSR);
1157 } /* set_up_dongle_interface */
1160 * Function nsc_ircc_change_dongle_speed (iobase, speed, dongle_id)
1162 * Change speed of the attach dongle
1165 static void nsc_ircc_change_dongle_speed(int iobase, int speed, int dongle_id)
1169 /* Save current bank */
1170 bank = inb(iobase+BSR);
1173 switch_bank(iobase, BANK7);
1175 /* IRCFG1: set according to dongle_id */
1176 switch (dongle_id) {
1177 case 0x00: /* same as */
1178 case 0x01: /* Differential serial interface */
1179 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1180 __func__, dongle_types[dongle_id]);
1182 case 0x02: /* same as */
1183 case 0x03: /* Reserved */
1184 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1185 __func__, dongle_types[dongle_id]);
1187 case 0x04: /* Sharp RY5HD01 */
1189 case 0x05: /* Reserved */
1190 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1191 __func__, dongle_types[dongle_id]);
1193 case 0x06: /* Single-ended serial interface */
1194 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1195 __func__, dongle_types[dongle_id]);
1197 case 0x07: /* Consumer-IR only */
1198 IRDA_DEBUG(0, "%s(), %s is not for IrDA mode\n",
1199 __func__, dongle_types[dongle_id]);
1201 case 0x08: /* HP HSDL-2300, HP HSDL-3600/HSDL-3610 */
1202 IRDA_DEBUG(0, "%s(), %s\n",
1203 __func__, dongle_types[dongle_id]);
1204 outb(0x00, iobase+4);
1206 outb(0x01, iobase+4);
1208 case 0x09: /* IBM31T1100 or Temic TFDS6000/TFDS6500 */
1209 outb(0x01, iobase+4);
1211 if (speed == 4000000) {
1212 /* There was a cli() there, but we now are already
1213 * under spin_lock_irqsave() - JeanII */
1214 outb(0x81, iobase+4);
1215 outb(0x80, iobase+4);
1217 outb(0x00, iobase+4);
1219 case 0x0A: /* same as */
1220 case 0x0B: /* Reserved */
1221 IRDA_DEBUG(0, "%s(), %s not defined by irda yet\n",
1222 __func__, dongle_types[dongle_id]);
1224 case 0x0C: /* same as */
1225 case 0x0D: /* HP HSDL-1100/HSDL-2100 */
1227 case 0x0E: /* Supports SIR Mode only */
1229 case 0x0F: /* No dongle connected */
1230 IRDA_DEBUG(0, "%s(), %s is not for IrDA mode\n",
1231 __func__, dongle_types[dongle_id]);
1233 switch_bank(iobase, BANK0);
1234 outb(0x62, iobase+MCR);
1237 IRDA_DEBUG(0, "%s(), invalid data_rate\n", __func__);
1239 /* Restore bank register */
1240 outb(bank, iobase+BSR);
1244 * Function nsc_ircc_change_speed (self, baud)
1246 * Change the speed of the device
1248 * This function *must* be called with irq off and spin-lock.
1250 static __u8 nsc_ircc_change_speed(struct nsc_ircc_cb *self, __u32 speed)
1252 struct net_device *dev = self->netdev;
1256 __u8 ier; /* Interrupt enable register */
1258 IRDA_DEBUG(2, "%s(), speed=%d\n", __func__, speed);
1260 IRDA_ASSERT(self != NULL, return 0;);
1262 iobase = self->io.fir_base;
1264 /* Update accounting for new speed */
1265 self->io.speed = speed;
1267 /* Save current bank */
1268 bank = inb(iobase+BSR);
1270 /* Disable interrupts */
1271 switch_bank(iobase, BANK0);
1272 outb(0, iobase+IER);
1275 switch_bank(iobase, BANK2);
1277 outb(0x00, iobase+BGDH);
1279 case 9600: outb(0x0c, iobase+BGDL); break;
1280 case 19200: outb(0x06, iobase+BGDL); break;
1281 case 38400: outb(0x03, iobase+BGDL); break;
1282 case 57600: outb(0x02, iobase+BGDL); break;
1283 case 115200: outb(0x01, iobase+BGDL); break;
1285 switch_bank(iobase, BANK5);
1287 /* IRCR2: MDRS is set */
1288 outb(inb(iobase+4) | 0x04, iobase+4);
1291 IRDA_DEBUG(0, "%s(), handling baud of 576000\n", __func__);
1295 IRDA_DEBUG(0, "%s(), handling baud of 1152000\n", __func__);
1299 IRDA_DEBUG(0, "%s(), handling baud of 4000000\n", __func__);
1303 IRDA_DEBUG(0, "%s(), unknown baud rate of %d\n",
1308 /* Set appropriate speed mode */
1309 switch_bank(iobase, BANK0);
1310 outb(mcr | MCR_TX_DFR, iobase+MCR);
1312 /* Give some hits to the transceiver */
1313 nsc_ircc_change_dongle_speed(iobase, speed, self->io.dongle_id);
1315 /* Set FIFO threshold to TX17, RX16 */
1316 switch_bank(iobase, BANK0);
1317 outb(0x00, iobase+FCR);
1318 outb(FCR_FIFO_EN, iobase+FCR);
1319 outb(FCR_RXTH| /* Set Rx FIFO threshold */
1320 FCR_TXTH| /* Set Tx FIFO threshold */
1321 FCR_TXSR| /* Reset Tx FIFO */
1322 FCR_RXSR| /* Reset Rx FIFO */
1323 FCR_FIFO_EN, /* Enable FIFOs */
1326 /* Set FIFO size to 32 */
1327 switch_bank(iobase, BANK2);
1328 outb(EXCR2_RFSIZ|EXCR2_TFSIZ, iobase+EXCR2);
1330 /* Enable some interrupts so we can receive frames */
1331 switch_bank(iobase, BANK0);
1332 if (speed > 115200) {
1333 /* Install FIR xmit handler */
1334 dev->netdev_ops = &nsc_ircc_fir_ops;
1336 nsc_ircc_dma_receive(self);
1338 /* Install SIR xmit handler */
1339 dev->netdev_ops = &nsc_ircc_sir_ops;
1342 /* Set our current interrupt mask */
1343 outb(ier, iobase+IER);
1346 outb(bank, iobase+BSR);
1348 /* Make sure interrupt handlers keep the proper interrupt mask */
1353 * Function nsc_ircc_hard_xmit (skb, dev)
1355 * Transmit the frame!
1358 static int nsc_ircc_hard_xmit_sir(struct sk_buff *skb, struct net_device *dev)
1360 struct nsc_ircc_cb *self;
1361 unsigned long flags;
1366 self = netdev_priv(dev);
1368 IRDA_ASSERT(self != NULL, return 0;);
1370 iobase = self->io.fir_base;
1372 netif_stop_queue(dev);
1374 /* Make sure tests *& speed change are atomic */
1375 spin_lock_irqsave(&self->lock, flags);
1377 /* Check if we need to change the speed */
1378 speed = irda_get_next_speed(skb);
1379 if ((speed != self->io.speed) && (speed != -1)) {
1380 /* Check for empty frame. */
1382 /* If we just sent a frame, we get called before
1383 * the last bytes get out (because of the SIR FIFO).
1384 * If this is the case, let interrupt handler change
1385 * the speed itself... Jean II */
1386 if (self->io.direction == IO_RECV) {
1387 nsc_ircc_change_speed(self, speed);
1388 /* TODO : For SIR->SIR, the next packet
1389 * may get corrupted - Jean II */
1390 netif_wake_queue(dev);
1392 self->new_speed = speed;
1393 /* Queue will be restarted after speed change
1394 * to make sure packets gets through the
1395 * proper xmit handler - Jean II */
1397 dev->trans_start = jiffies;
1398 spin_unlock_irqrestore(&self->lock, flags);
1402 self->new_speed = speed;
1405 /* Save current bank */
1406 bank = inb(iobase+BSR);
1408 self->tx_buff.data = self->tx_buff.head;
1410 self->tx_buff.len = async_wrap_skb(skb, self->tx_buff.data,
1411 self->tx_buff.truesize);
1413 dev->stats.tx_bytes += self->tx_buff.len;
1415 /* Add interrupt on tx low level (will fire immediately) */
1416 switch_bank(iobase, BANK0);
1417 outb(IER_TXLDL_IE, iobase+IER);
1419 /* Restore bank register */
1420 outb(bank, iobase+BSR);
1422 dev->trans_start = jiffies;
1423 spin_unlock_irqrestore(&self->lock, flags);
1430 static int nsc_ircc_hard_xmit_fir(struct sk_buff *skb, struct net_device *dev)
1432 struct nsc_ircc_cb *self;
1433 unsigned long flags;
1439 self = netdev_priv(dev);
1440 iobase = self->io.fir_base;
1442 netif_stop_queue(dev);
1444 /* Make sure tests *& speed change are atomic */
1445 spin_lock_irqsave(&self->lock, flags);
1447 /* Check if we need to change the speed */
1448 speed = irda_get_next_speed(skb);
1449 if ((speed != self->io.speed) && (speed != -1)) {
1450 /* Check for empty frame. */
1452 /* If we are currently transmitting, defer to
1453 * interrupt handler. - Jean II */
1454 if(self->tx_fifo.len == 0) {
1455 nsc_ircc_change_speed(self, speed);
1456 netif_wake_queue(dev);
1458 self->new_speed = speed;
1459 /* Keep queue stopped :
1460 * the speed change operation may change the
1461 * xmit handler, and we want to make sure
1462 * the next packet get through the proper
1463 * Tx path, so block the Tx queue until
1464 * the speed change has been done.
1467 dev->trans_start = jiffies;
1468 spin_unlock_irqrestore(&self->lock, flags);
1472 /* Change speed after current frame */
1473 self->new_speed = speed;
1477 /* Save current bank */
1478 bank = inb(iobase+BSR);
1480 /* Register and copy this frame to DMA memory */
1481 self->tx_fifo.queue[self->tx_fifo.free].start = self->tx_fifo.tail;
1482 self->tx_fifo.queue[self->tx_fifo.free].len = skb->len;
1483 self->tx_fifo.tail += skb->len;
1485 dev->stats.tx_bytes += skb->len;
1487 skb_copy_from_linear_data(skb, self->tx_fifo.queue[self->tx_fifo.free].start,
1489 self->tx_fifo.len++;
1490 self->tx_fifo.free++;
1492 /* Start transmit only if there is currently no transmit going on */
1493 if (self->tx_fifo.len == 1) {
1494 /* Check if we must wait the min turn time or not */
1495 mtt = irda_get_mtt(skb);
1497 /* Check how much time we have used already */
1498 do_gettimeofday(&self->now);
1499 diff = self->now.tv_usec - self->stamp.tv_usec;
1503 /* Check if the mtt is larger than the time we have
1504 * already used by all the protocol processing
1510 * Use timer if delay larger than 125 us, and
1511 * use udelay for smaller values which should
1515 /* Adjust for timer resolution */
1519 switch_bank(iobase, BANK4);
1520 outb(mtt & 0xff, iobase+TMRL);
1521 outb((mtt >> 8) & 0x0f, iobase+TMRH);
1524 outb(IRCR1_TMR_EN, iobase+IRCR1);
1525 self->io.direction = IO_XMIT;
1527 /* Enable timer interrupt */
1528 switch_bank(iobase, BANK0);
1529 outb(IER_TMR_IE, iobase+IER);
1531 /* Timer will take care of the rest */
1537 /* Enable DMA interrupt */
1538 switch_bank(iobase, BANK0);
1539 outb(IER_DMA_IE, iobase+IER);
1541 /* Transmit frame */
1542 nsc_ircc_dma_xmit(self, iobase);
1545 /* Not busy transmitting anymore if window is not full,
1546 * and if we don't need to change speed */
1547 if ((self->tx_fifo.free < MAX_TX_WINDOW) && (self->new_speed == 0))
1548 netif_wake_queue(self->netdev);
1550 /* Restore bank register */
1551 outb(bank, iobase+BSR);
1553 dev->trans_start = jiffies;
1554 spin_unlock_irqrestore(&self->lock, flags);
1561 * Function nsc_ircc_dma_xmit (self, iobase)
1563 * Transmit data using DMA
1566 static void nsc_ircc_dma_xmit(struct nsc_ircc_cb *self, int iobase)
1570 /* Save current bank */
1571 bsr = inb(iobase+BSR);
1574 switch_bank(iobase, BANK0);
1575 outb(inb(iobase+MCR) & ~MCR_DMA_EN, iobase+MCR);
1577 self->io.direction = IO_XMIT;
1579 /* Choose transmit DMA channel */
1580 switch_bank(iobase, BANK2);
1581 outb(ECR1_DMASWP|ECR1_DMANF|ECR1_EXT_SL, iobase+ECR1);
1583 irda_setup_dma(self->io.dma,
1584 ((u8 *)self->tx_fifo.queue[self->tx_fifo.ptr].start -
1585 self->tx_buff.head) + self->tx_buff_dma,
1586 self->tx_fifo.queue[self->tx_fifo.ptr].len,
1589 /* Enable DMA and SIR interaction pulse */
1590 switch_bank(iobase, BANK0);
1591 outb(inb(iobase+MCR)|MCR_TX_DFR|MCR_DMA_EN|MCR_IR_PLS, iobase+MCR);
1593 /* Restore bank register */
1594 outb(bsr, iobase+BSR);
1598 * Function nsc_ircc_pio_xmit (self, iobase)
1600 * Transmit data using PIO. Returns the number of bytes that actually
1604 static int nsc_ircc_pio_write(int iobase, __u8 *buf, int len, int fifo_size)
1609 IRDA_DEBUG(4, "%s()\n", __func__);
1611 /* Save current bank */
1612 bank = inb(iobase+BSR);
1614 switch_bank(iobase, BANK0);
1615 if (!(inb_p(iobase+LSR) & LSR_TXEMP)) {
1616 IRDA_DEBUG(4, "%s(), warning, FIFO not empty yet!\n",
1619 /* FIFO may still be filled to the Tx interrupt threshold */
1623 /* Fill FIFO with current frame */
1624 while ((fifo_size-- > 0) && (actual < len)) {
1625 /* Transmit next byte */
1626 outb(buf[actual++], iobase+TXD);
1629 IRDA_DEBUG(4, "%s(), fifo_size %d ; %d sent of %d\n",
1630 __func__, fifo_size, actual, len);
1633 outb(bank, iobase+BSR);
1639 * Function nsc_ircc_dma_xmit_complete (self)
1641 * The transfer of a frame in finished. This function will only be called
1642 * by the interrupt handler
1645 static int nsc_ircc_dma_xmit_complete(struct nsc_ircc_cb *self)
1651 IRDA_DEBUG(2, "%s()\n", __func__);
1653 iobase = self->io.fir_base;
1655 /* Save current bank */
1656 bank = inb(iobase+BSR);
1659 switch_bank(iobase, BANK0);
1660 outb(inb(iobase+MCR) & ~MCR_DMA_EN, iobase+MCR);
1662 /* Check for underrrun! */
1663 if (inb(iobase+ASCR) & ASCR_TXUR) {
1664 self->netdev->stats.tx_errors++;
1665 self->netdev->stats.tx_fifo_errors++;
1667 /* Clear bit, by writing 1 into it */
1668 outb(ASCR_TXUR, iobase+ASCR);
1670 self->netdev->stats.tx_packets++;
1673 /* Finished with this frame, so prepare for next */
1674 self->tx_fifo.ptr++;
1675 self->tx_fifo.len--;
1677 /* Any frames to be sent back-to-back? */
1678 if (self->tx_fifo.len) {
1679 nsc_ircc_dma_xmit(self, iobase);
1681 /* Not finished yet! */
1684 /* Reset Tx FIFO info */
1685 self->tx_fifo.len = self->tx_fifo.ptr = self->tx_fifo.free = 0;
1686 self->tx_fifo.tail = self->tx_buff.head;
1689 /* Make sure we have room for more frames and
1690 * that we don't need to change speed */
1691 if ((self->tx_fifo.free < MAX_TX_WINDOW) && (self->new_speed == 0)) {
1692 /* Not busy transmitting anymore */
1693 /* Tell the network layer, that we can accept more frames */
1694 netif_wake_queue(self->netdev);
1698 outb(bank, iobase+BSR);
1704 * Function nsc_ircc_dma_receive (self)
1706 * Get ready for receiving a frame. The device will initiate a DMA
1707 * if it starts to receive a frame.
1710 static int nsc_ircc_dma_receive(struct nsc_ircc_cb *self)
1715 iobase = self->io.fir_base;
1717 /* Reset Tx FIFO info */
1718 self->tx_fifo.len = self->tx_fifo.ptr = self->tx_fifo.free = 0;
1719 self->tx_fifo.tail = self->tx_buff.head;
1721 /* Save current bank */
1722 bsr = inb(iobase+BSR);
1725 switch_bank(iobase, BANK0);
1726 outb(inb(iobase+MCR) & ~MCR_DMA_EN, iobase+MCR);
1728 /* Choose DMA Rx, DMA Fairness, and Advanced mode */
1729 switch_bank(iobase, BANK2);
1730 outb(ECR1_DMANF|ECR1_EXT_SL, iobase+ECR1);
1732 self->io.direction = IO_RECV;
1733 self->rx_buff.data = self->rx_buff.head;
1735 /* Reset Rx FIFO. This will also flush the ST_FIFO */
1736 switch_bank(iobase, BANK0);
1737 outb(FCR_RXSR|FCR_FIFO_EN, iobase+FCR);
1739 self->st_fifo.len = self->st_fifo.pending_bytes = 0;
1740 self->st_fifo.tail = self->st_fifo.head = 0;
1742 irda_setup_dma(self->io.dma, self->rx_buff_dma, self->rx_buff.truesize,
1746 switch_bank(iobase, BANK0);
1747 outb(inb(iobase+MCR)|MCR_DMA_EN, iobase+MCR);
1749 /* Restore bank register */
1750 outb(bsr, iobase+BSR);
1756 * Function nsc_ircc_dma_receive_complete (self)
1758 * Finished with receiving frames
1762 static int nsc_ircc_dma_receive_complete(struct nsc_ircc_cb *self, int iobase)
1764 struct st_fifo *st_fifo;
1765 struct sk_buff *skb;
1770 st_fifo = &self->st_fifo;
1772 /* Save current bank */
1773 bank = inb(iobase+BSR);
1775 /* Read all entries in status FIFO */
1776 switch_bank(iobase, BANK5);
1777 while ((status = inb(iobase+FRM_ST)) & FRM_ST_VLD) {
1778 /* We must empty the status FIFO no matter what */
1779 len = inb(iobase+RFLFL) | ((inb(iobase+RFLFH) & 0x1f) << 8);
1781 if (st_fifo->tail >= MAX_RX_WINDOW) {
1782 IRDA_DEBUG(0, "%s(), window is full!\n", __func__);
1786 st_fifo->entries[st_fifo->tail].status = status;
1787 st_fifo->entries[st_fifo->tail].len = len;
1788 st_fifo->pending_bytes += len;
1792 /* Try to process all entries in status FIFO */
1793 while (st_fifo->len > 0) {
1794 /* Get first entry */
1795 status = st_fifo->entries[st_fifo->head].status;
1796 len = st_fifo->entries[st_fifo->head].len;
1797 st_fifo->pending_bytes -= len;
1801 /* Check for errors */
1802 if (status & FRM_ST_ERR_MSK) {
1803 if (status & FRM_ST_LOST_FR) {
1804 /* Add number of lost frames to stats */
1805 self->netdev->stats.rx_errors += len;
1808 self->netdev->stats.rx_errors++;
1810 self->rx_buff.data += len;
1812 if (status & FRM_ST_MAX_LEN)
1813 self->netdev->stats.rx_length_errors++;
1815 if (status & FRM_ST_PHY_ERR)
1816 self->netdev->stats.rx_frame_errors++;
1818 if (status & FRM_ST_BAD_CRC)
1819 self->netdev->stats.rx_crc_errors++;
1821 /* The errors below can be reported in both cases */
1822 if (status & FRM_ST_OVR1)
1823 self->netdev->stats.rx_fifo_errors++;
1825 if (status & FRM_ST_OVR2)
1826 self->netdev->stats.rx_fifo_errors++;
1829 * First we must make sure that the frame we
1830 * want to deliver is all in main memory. If we
1831 * cannot tell, then we check if the Rx FIFO is
1832 * empty. If not then we will have to take a nap
1833 * and try again later.
1835 if (st_fifo->pending_bytes < self->io.fifo_size) {
1836 switch_bank(iobase, BANK0);
1837 if (inb(iobase+LSR) & LSR_RXDA) {
1838 /* Put this entry back in fifo */
1841 st_fifo->pending_bytes += len;
1842 st_fifo->entries[st_fifo->head].status = status;
1843 st_fifo->entries[st_fifo->head].len = len;
1845 * DMA not finished yet, so try again
1846 * later, set timer value, resolution
1849 switch_bank(iobase, BANK4);
1850 outb(0x02, iobase+TMRL); /* x 125 us */
1851 outb(0x00, iobase+TMRH);
1854 outb(IRCR1_TMR_EN, iobase+IRCR1);
1856 /* Restore bank register */
1857 outb(bank, iobase+BSR);
1859 return FALSE; /* I'll be back! */
1864 * Remember the time we received this frame, so we can
1865 * reduce the min turn time a bit since we will know
1866 * how much time we have used for protocol processing
1868 do_gettimeofday(&self->stamp);
1870 skb = dev_alloc_skb(len+1);
1872 IRDA_WARNING("%s(), memory squeeze, "
1873 "dropping frame.\n",
1875 self->netdev->stats.rx_dropped++;
1877 /* Restore bank register */
1878 outb(bank, iobase+BSR);
1883 /* Make sure IP header gets aligned */
1884 skb_reserve(skb, 1);
1886 /* Copy frame without CRC */
1887 if (self->io.speed < 4000000) {
1888 skb_put(skb, len-2);
1889 skb_copy_to_linear_data(skb,
1893 skb_put(skb, len-4);
1894 skb_copy_to_linear_data(skb,
1899 /* Move to next frame */
1900 self->rx_buff.data += len;
1901 self->netdev->stats.rx_bytes += len;
1902 self->netdev->stats.rx_packets++;
1904 skb->dev = self->netdev;
1905 skb_reset_mac_header(skb);
1906 skb->protocol = htons(ETH_P_IRDA);
1910 /* Restore bank register */
1911 outb(bank, iobase+BSR);
1917 * Function nsc_ircc_pio_receive (self)
1919 * Receive all data in receiver FIFO
1922 static void nsc_ircc_pio_receive(struct nsc_ircc_cb *self)
1927 iobase = self->io.fir_base;
1929 /* Receive all characters in Rx FIFO */
1931 byte = inb(iobase+RXD);
1932 async_unwrap_char(self->netdev, &self->netdev->stats,
1933 &self->rx_buff, byte);
1934 } while (inb(iobase+LSR) & LSR_RXDA); /* Data available */
1938 * Function nsc_ircc_sir_interrupt (self, eir)
1940 * Handle SIR interrupt
1943 static void nsc_ircc_sir_interrupt(struct nsc_ircc_cb *self, int eir)
1947 /* Check if transmit FIFO is low on data */
1948 if (eir & EIR_TXLDL_EV) {
1949 /* Write data left in transmit buffer */
1950 actual = nsc_ircc_pio_write(self->io.fir_base,
1953 self->io.fifo_size);
1954 self->tx_buff.data += actual;
1955 self->tx_buff.len -= actual;
1957 self->io.direction = IO_XMIT;
1959 /* Check if finished */
1960 if (self->tx_buff.len > 0)
1961 self->ier = IER_TXLDL_IE;
1964 self->netdev->stats.tx_packets++;
1965 netif_wake_queue(self->netdev);
1966 self->ier = IER_TXEMP_IE;
1970 /* Check if transmission has completed */
1971 if (eir & EIR_TXEMP_EV) {
1972 /* Turn around and get ready to receive some data */
1973 self->io.direction = IO_RECV;
1974 self->ier = IER_RXHDL_IE;
1975 /* Check if we need to change the speed?
1976 * Need to be after self->io.direction to avoid race with
1977 * nsc_ircc_hard_xmit_sir() - Jean II */
1978 if (self->new_speed) {
1979 IRDA_DEBUG(2, "%s(), Changing speed!\n", __func__);
1980 self->ier = nsc_ircc_change_speed(self,
1982 self->new_speed = 0;
1983 netif_wake_queue(self->netdev);
1985 /* Check if we are going to FIR */
1986 if (self->io.speed > 115200) {
1987 /* No need to do anymore SIR stuff */
1993 /* Rx FIFO threshold or timeout */
1994 if (eir & EIR_RXHDL_EV) {
1995 nsc_ircc_pio_receive(self);
1997 /* Keep receiving */
1998 self->ier = IER_RXHDL_IE;
2003 * Function nsc_ircc_fir_interrupt (self, eir)
2005 * Handle MIR/FIR interrupt
2008 static void nsc_ircc_fir_interrupt(struct nsc_ircc_cb *self, int iobase,
2013 bank = inb(iobase+BSR);
2015 /* Status FIFO event*/
2016 if (eir & EIR_SFIF_EV) {
2017 /* Check if DMA has finished */
2018 if (nsc_ircc_dma_receive_complete(self, iobase)) {
2019 /* Wait for next status FIFO interrupt */
2020 self->ier = IER_SFIF_IE;
2022 self->ier = IER_SFIF_IE | IER_TMR_IE;
2024 } else if (eir & EIR_TMR_EV) { /* Timer finished */
2026 switch_bank(iobase, BANK4);
2027 outb(0, iobase+IRCR1);
2029 /* Clear timer event */
2030 switch_bank(iobase, BANK0);
2031 outb(ASCR_CTE, iobase+ASCR);
2033 /* Check if this is a Tx timer interrupt */
2034 if (self->io.direction == IO_XMIT) {
2035 nsc_ircc_dma_xmit(self, iobase);
2037 /* Interrupt on DMA */
2038 self->ier = IER_DMA_IE;
2040 /* Check (again) if DMA has finished */
2041 if (nsc_ircc_dma_receive_complete(self, iobase)) {
2042 self->ier = IER_SFIF_IE;
2044 self->ier = IER_SFIF_IE | IER_TMR_IE;
2047 } else if (eir & EIR_DMA_EV) {
2048 /* Finished with all transmissions? */
2049 if (nsc_ircc_dma_xmit_complete(self)) {
2050 if(self->new_speed != 0) {
2051 /* As we stop the Tx queue, the speed change
2052 * need to be done when the Tx fifo is
2053 * empty. Ask for a Tx done interrupt */
2054 self->ier = IER_TXEMP_IE;
2056 /* Check if there are more frames to be
2058 if (irda_device_txqueue_empty(self->netdev)) {
2059 /* Prepare for receive */
2060 nsc_ircc_dma_receive(self);
2061 self->ier = IER_SFIF_IE;
2063 IRDA_WARNING("%s(), potential "
2064 "Tx queue lockup !\n",
2068 /* Not finished yet, so interrupt on DMA again */
2069 self->ier = IER_DMA_IE;
2071 } else if (eir & EIR_TXEMP_EV) {
2072 /* The Tx FIFO has totally drained out, so now we can change
2073 * the speed... - Jean II */
2074 self->ier = nsc_ircc_change_speed(self, self->new_speed);
2075 self->new_speed = 0;
2076 netif_wake_queue(self->netdev);
2077 /* Note : nsc_ircc_change_speed() restarted Rx fifo */
2080 outb(bank, iobase+BSR);
2084 * Function nsc_ircc_interrupt (irq, dev_id, regs)
2086 * An interrupt from the chip has arrived. Time to do some work
2089 static irqreturn_t nsc_ircc_interrupt(int irq, void *dev_id)
2091 struct net_device *dev = dev_id;
2092 struct nsc_ircc_cb *self;
2096 self = netdev_priv(dev);
2098 spin_lock(&self->lock);
2100 iobase = self->io.fir_base;
2102 bsr = inb(iobase+BSR); /* Save current bank */
2104 switch_bank(iobase, BANK0);
2105 self->ier = inb(iobase+IER);
2106 eir = inb(iobase+EIR) & self->ier; /* Mask out the interesting ones */
2108 outb(0, iobase+IER); /* Disable interrupts */
2111 /* Dispatch interrupt handler for the current speed */
2112 if (self->io.speed > 115200)
2113 nsc_ircc_fir_interrupt(self, iobase, eir);
2115 nsc_ircc_sir_interrupt(self, eir);
2118 outb(self->ier, iobase+IER); /* Restore interrupts */
2119 outb(bsr, iobase+BSR); /* Restore bank register */
2121 spin_unlock(&self->lock);
2122 return IRQ_RETVAL(eir);
2126 * Function nsc_ircc_is_receiving (self)
2128 * Return TRUE is we are currently receiving a frame
2131 static int nsc_ircc_is_receiving(struct nsc_ircc_cb *self)
2133 unsigned long flags;
2138 IRDA_ASSERT(self != NULL, return FALSE;);
2140 spin_lock_irqsave(&self->lock, flags);
2142 if (self->io.speed > 115200) {
2143 iobase = self->io.fir_base;
2145 /* Check if rx FIFO is not empty */
2146 bank = inb(iobase+BSR);
2147 switch_bank(iobase, BANK2);
2148 if ((inb(iobase+RXFLV) & 0x3f) != 0) {
2149 /* We are receiving something */
2152 outb(bank, iobase+BSR);
2154 status = (self->rx_buff.state != OUTSIDE_FRAME);
2156 spin_unlock_irqrestore(&self->lock, flags);
2162 * Function nsc_ircc_net_open (dev)
2167 static int nsc_ircc_net_open(struct net_device *dev)
2169 struct nsc_ircc_cb *self;
2174 IRDA_DEBUG(4, "%s()\n", __func__);
2176 IRDA_ASSERT(dev != NULL, return -1;);
2177 self = netdev_priv(dev);
2179 IRDA_ASSERT(self != NULL, return 0;);
2181 iobase = self->io.fir_base;
2183 if (request_irq(self->io.irq, nsc_ircc_interrupt, 0, dev->name, dev)) {
2184 IRDA_WARNING("%s, unable to allocate irq=%d\n",
2185 driver_name, self->io.irq);
2189 * Always allocate the DMA channel after the IRQ, and clean up on
2192 if (request_dma(self->io.dma, dev->name)) {
2193 IRDA_WARNING("%s, unable to allocate dma=%d\n",
2194 driver_name, self->io.dma);
2195 free_irq(self->io.irq, dev);
2199 /* Save current bank */
2200 bank = inb(iobase+BSR);
2202 /* turn on interrupts */
2203 switch_bank(iobase, BANK0);
2204 outb(IER_LS_IE | IER_RXHDL_IE, iobase+IER);
2206 /* Restore bank register */
2207 outb(bank, iobase+BSR);
2209 /* Ready to play! */
2210 netif_start_queue(dev);
2212 /* Give self a hardware name */
2213 sprintf(hwname, "NSC-FIR @ 0x%03x", self->io.fir_base);
2216 * Open new IrLAP layer instance, now that everything should be
2217 * initialized properly
2219 self->irlap = irlap_open(dev, &self->qos, hwname);
2225 * Function nsc_ircc_net_close (dev)
2230 static int nsc_ircc_net_close(struct net_device *dev)
2232 struct nsc_ircc_cb *self;
2236 IRDA_DEBUG(4, "%s()\n", __func__);
2238 IRDA_ASSERT(dev != NULL, return -1;);
2240 self = netdev_priv(dev);
2241 IRDA_ASSERT(self != NULL, return 0;);
2244 netif_stop_queue(dev);
2246 /* Stop and remove instance of IrLAP */
2248 irlap_close(self->irlap);
2251 iobase = self->io.fir_base;
2253 disable_dma(self->io.dma);
2255 /* Save current bank */
2256 bank = inb(iobase+BSR);
2258 /* Disable interrupts */
2259 switch_bank(iobase, BANK0);
2260 outb(0, iobase+IER);
2262 free_irq(self->io.irq, dev);
2263 free_dma(self->io.dma);
2265 /* Restore bank register */
2266 outb(bank, iobase+BSR);
2272 * Function nsc_ircc_net_ioctl (dev, rq, cmd)
2274 * Process IOCTL commands for this device
2277 static int nsc_ircc_net_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
2279 struct if_irda_req *irq = (struct if_irda_req *) rq;
2280 struct nsc_ircc_cb *self;
2281 unsigned long flags;
2284 IRDA_ASSERT(dev != NULL, return -1;);
2286 self = netdev_priv(dev);
2288 IRDA_ASSERT(self != NULL, return -1;);
2290 IRDA_DEBUG(2, "%s(), %s, (cmd=0x%X)\n", __func__, dev->name, cmd);
2293 case SIOCSBANDWIDTH: /* Set bandwidth */
2294 if (!capable(CAP_NET_ADMIN)) {
2298 spin_lock_irqsave(&self->lock, flags);
2299 nsc_ircc_change_speed(self, irq->ifr_baudrate);
2300 spin_unlock_irqrestore(&self->lock, flags);
2302 case SIOCSMEDIABUSY: /* Set media busy */
2303 if (!capable(CAP_NET_ADMIN)) {
2307 irda_device_set_media_busy(self->netdev, TRUE);
2309 case SIOCGRECEIVING: /* Check if we are receiving right now */
2310 /* This is already protected */
2311 irq->ifr_receiving = nsc_ircc_is_receiving(self);
2319 static int nsc_ircc_suspend(struct platform_device *dev, pm_message_t state)
2321 struct nsc_ircc_cb *self = platform_get_drvdata(dev);
2323 unsigned long flags;
2324 int iobase = self->io.fir_base;
2326 if (self->io.suspended)
2329 IRDA_DEBUG(1, "%s, Suspending\n", driver_name);
2332 if (netif_running(self->netdev)) {
2333 netif_device_detach(self->netdev);
2334 spin_lock_irqsave(&self->lock, flags);
2335 /* Save current bank */
2336 bank = inb(iobase+BSR);
2338 /* Disable interrupts */
2339 switch_bank(iobase, BANK0);
2340 outb(0, iobase+IER);
2342 /* Restore bank register */
2343 outb(bank, iobase+BSR);
2345 spin_unlock_irqrestore(&self->lock, flags);
2346 free_irq(self->io.irq, self->netdev);
2347 disable_dma(self->io.dma);
2349 self->io.suspended = 1;
2355 static int nsc_ircc_resume(struct platform_device *dev)
2357 struct nsc_ircc_cb *self = platform_get_drvdata(dev);
2358 unsigned long flags;
2360 if (!self->io.suspended)
2363 IRDA_DEBUG(1, "%s, Waking up\n", driver_name);
2366 nsc_ircc_setup(&self->io);
2367 nsc_ircc_init_dongle_interface(self->io.fir_base, self->io.dongle_id);
2369 if (netif_running(self->netdev)) {
2370 if (request_irq(self->io.irq, nsc_ircc_interrupt, 0,
2371 self->netdev->name, self->netdev)) {
2372 IRDA_WARNING("%s, unable to allocate irq=%d\n",
2373 driver_name, self->io.irq);
2376 * Don't fail resume process, just kill this
2379 unregister_netdevice(self->netdev);
2381 spin_lock_irqsave(&self->lock, flags);
2382 nsc_ircc_change_speed(self, self->io.speed);
2383 spin_unlock_irqrestore(&self->lock, flags);
2384 netif_device_attach(self->netdev);
2388 spin_lock_irqsave(&self->lock, flags);
2389 nsc_ircc_change_speed(self, 9600);
2390 spin_unlock_irqrestore(&self->lock, flags);
2392 self->io.suspended = 0;
2398 MODULE_AUTHOR("Dag Brattli <dagb@cs.uit.no>");
2399 MODULE_DESCRIPTION("NSC IrDA Device Driver");
2400 MODULE_LICENSE("GPL");
2403 module_param(qos_mtt_bits, int, 0);
2404 MODULE_PARM_DESC(qos_mtt_bits, "Minimum Turn Time");
2405 module_param_array(io, int, NULL, 0);
2406 MODULE_PARM_DESC(io, "Base I/O addresses");
2407 module_param_array(irq, int, NULL, 0);
2408 MODULE_PARM_DESC(irq, "IRQ lines");
2409 module_param_array(dma, int, NULL, 0);
2410 MODULE_PARM_DESC(dma, "DMA channels");
2411 module_param(dongle_id, int, 0);
2412 MODULE_PARM_DESC(dongle_id, "Type-id of used dongle");
2414 module_init(nsc_ircc_init);
2415 module_exit(nsc_ircc_cleanup);