2 * speedfax.c low level stuff for Sedlbauer Speedfax+ cards
3 * based on the ISAR DSP
4 * Thanks to Sedlbauer AG for informations and HW
6 * Author Karsten Keil <keil@isdn4linux.de>
8 * Copyright 2009 by Karsten Keil <keil@isdn4linux.de>
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.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <linux/interrupt.h>
26 #include <linux/module.h>
27 #include <linux/slab.h>
28 #include <linux/pci.h>
29 #include <linux/delay.h>
30 #include <linux/mISDNhw.h>
31 #include <linux/firmware.h>
35 #define SPEEDFAX_REV "2.0"
37 #define PCI_SUBVENDOR_SPEEDFAX_PYRAMID 0x51
38 #define PCI_SUBVENDOR_SPEEDFAX_PCI 0x54
39 #define PCI_SUB_ID_SEDLBAUER 0x01
41 #define SFAX_PCI_ADDR 0xc8
42 #define SFAX_PCI_ISAC 0xd0
43 #define SFAX_PCI_ISAR 0xe0
45 /* TIGER 100 Registers */
47 #define TIGER_RESET_ADDR 0x00
48 #define TIGER_EXTERN_RESET_ON 0x01
49 #define TIGER_EXTERN_RESET_OFF 0x00
50 #define TIGER_AUX_CTRL 0x02
51 #define TIGER_AUX_DATA 0x03
52 #define TIGER_AUX_IRQMASK 0x05
53 #define TIGER_AUX_STATUS 0x07
56 #define SFAX_AUX_IOMASK 0xdd /* 1 and 5 are inputs */
57 #define SFAX_ISAR_RESET_BIT_OFF 0x00
58 #define SFAX_ISAR_RESET_BIT_ON 0x01
59 #define SFAX_TIGER_IRQ_BIT 0x02
60 #define SFAX_LED1_BIT 0x08
61 #define SFAX_LED2_BIT 0x10
63 #define SFAX_PCI_RESET_ON (SFAX_ISAR_RESET_BIT_ON)
64 #define SFAX_PCI_RESET_OFF (SFAX_LED1_BIT | SFAX_LED2_BIT)
68 static u32 irqloops = 4;
71 struct list_head list;
73 char name[MISDN_MAX_IDLEN];
77 struct _ioport p_isac;
78 struct _ioport p_isar;
80 spinlock_t lock; /* HW access lock */
85 static LIST_HEAD(Cards);
86 static DEFINE_RWLOCK(card_lock); /* protect Cards */
89 _set_debug(struct sfax_hw *card)
91 card->isac.dch.debug = debug;
92 card->isar.ch[0].bch.debug = debug;
93 card->isar.ch[1].bch.debug = debug;
97 set_debug(const char *val, const struct kernel_param *kp)
100 struct sfax_hw *card;
102 ret = param_set_uint(val, kp);
104 read_lock(&card_lock);
105 list_for_each_entry(card, &Cards, list)
107 read_unlock(&card_lock);
112 MODULE_AUTHOR("Karsten Keil");
113 MODULE_LICENSE("GPL v2");
114 MODULE_VERSION(SPEEDFAX_REV);
116 module_param_call(debug, set_debug, param_get_uint, &debug, S_IRUGO | S_IWUSR);
117 MODULE_PARM_DESC(debug, "Speedfax debug mask");
118 module_param(irqloops, uint, S_IRUGO | S_IWUSR);
119 MODULE_PARM_DESC(irqloops, "Speedfax maximal irqloops (default 4)");
121 IOFUNC_IND(ISAC, sfax_hw, p_isac)
122 IOFUNC_IND(ISAR, sfax_hw, p_isar)
125 speedfax_irq(int intno, void *dev_id)
127 struct sfax_hw *sf = dev_id;
131 spin_lock(&sf->lock);
132 val = inb(sf->cfg + TIGER_AUX_STATUS);
133 if (val & SFAX_TIGER_IRQ_BIT) { /* for us or shared ? */
134 spin_unlock(&sf->lock);
135 return IRQ_NONE; /* shared */
138 val = ReadISAR_IND(sf, ISAR_IRQBIT);
140 if (val & ISAR_IRQSTA)
141 mISDNisar_irq(&sf->isar);
142 val = ReadISAC_IND(sf, ISAC_ISTA);
144 mISDNisac_irq(&sf->isac, val);
145 val = ReadISAR_IND(sf, ISAR_IRQBIT);
146 if ((val & ISAR_IRQSTA) && cnt--)
149 pr_debug("%s: %d irqloops cpu%d\n", sf->name,
150 irqloops - cnt, smp_processor_id());
151 if (irqloops && !cnt)
152 pr_notice("%s: %d IRQ LOOP cpu%d\n", sf->name,
153 irqloops, smp_processor_id());
154 spin_unlock(&sf->lock);
159 enable_hwirq(struct sfax_hw *sf)
161 WriteISAC_IND(sf, ISAC_MASK, 0);
162 WriteISAR_IND(sf, ISAR_IRQBIT, ISAR_IRQMSK);
163 outb(SFAX_TIGER_IRQ_BIT, sf->cfg + TIGER_AUX_IRQMASK);
167 disable_hwirq(struct sfax_hw *sf)
169 WriteISAC_IND(sf, ISAC_MASK, 0xFF);
170 WriteISAR_IND(sf, ISAR_IRQBIT, 0);
171 outb(0, sf->cfg + TIGER_AUX_IRQMASK);
175 reset_speedfax(struct sfax_hw *sf)
178 pr_debug("%s: resetting card\n", sf->name);
179 outb(TIGER_EXTERN_RESET_ON, sf->cfg + TIGER_RESET_ADDR);
180 outb(SFAX_PCI_RESET_ON, sf->cfg + TIGER_AUX_DATA);
182 outb(TIGER_EXTERN_RESET_OFF, sf->cfg + TIGER_RESET_ADDR);
183 sf->aux_data = SFAX_PCI_RESET_OFF;
184 outb(sf->aux_data, sf->cfg + TIGER_AUX_DATA);
189 sfax_ctrl(struct sfax_hw *sf, u32 cmd, u_long arg)
197 case HW_ACTIVATE_IND:
199 sf->aux_data &= ~SFAX_LED1_BIT;
201 sf->aux_data &= ~SFAX_LED2_BIT;
202 outb(sf->aux_data, sf->cfg + TIGER_AUX_DATA);
206 sf->aux_data |= SFAX_LED1_BIT;
208 sf->aux_data |= SFAX_LED2_BIT;
209 outb(sf->aux_data, sf->cfg + TIGER_AUX_DATA);
212 pr_info("%s: %s unknown command %x %lx\n",
213 sf->name, __func__, cmd, arg);
221 channel_ctrl(struct sfax_hw *sf, struct mISDN_ctrl_req *cq)
226 case MISDN_CTRL_GETOP:
227 cq->op = MISDN_CTRL_LOOP | MISDN_CTRL_L1_TIMER3;
229 case MISDN_CTRL_LOOP:
230 /* cq->channel: 0 disable, 1 B1 loop 2 B2 loop, 3 both */
231 if (cq->channel < 0 || cq->channel > 3) {
235 ret = sf->isac.ctrl(&sf->isac, HW_TESTLOOP, cq->channel);
237 case MISDN_CTRL_L1_TIMER3:
238 ret = sf->isac.ctrl(&sf->isac, HW_TIMER3_VALUE, cq->p1);
241 pr_info("%s: unknown Op %x\n", sf->name, cq->op);
249 sfax_dctrl(struct mISDNchannel *ch, u32 cmd, void *arg)
251 struct mISDNdevice *dev = container_of(ch, struct mISDNdevice, D);
252 struct dchannel *dch = container_of(dev, struct dchannel, dev);
253 struct sfax_hw *sf = dch->hw;
254 struct channel_req *rq;
257 pr_debug("%s: cmd:%x %p\n", sf->name, cmd, arg);
261 if (rq->protocol == ISDN_P_TE_S0)
262 err = sf->isac.open(&sf->isac, rq);
264 err = sf->isar.open(&sf->isar, rq);
267 if (!try_module_get(THIS_MODULE))
268 pr_info("%s: cannot get module\n", sf->name);
271 pr_debug("%s: dev(%d) close from %p\n", sf->name,
272 dch->dev.id, __builtin_return_address(0));
273 module_put(THIS_MODULE);
275 case CONTROL_CHANNEL:
276 err = channel_ctrl(sf, arg);
279 pr_debug("%s: unknown command %x\n", sf->name, cmd);
286 init_card(struct sfax_hw *sf)
291 ret = request_irq(sf->irq, speedfax_irq, IRQF_SHARED, sf->name, sf);
293 pr_info("%s: couldn't get interrupt %d\n", sf->name, sf->irq);
297 spin_lock_irqsave(&sf->lock, flags);
298 ret = sf->isac.init(&sf->isac);
300 spin_unlock_irqrestore(&sf->lock, flags);
301 pr_info("%s: ISAC init failed with %d\n",
306 /* RESET Receiver and Transmitter */
307 WriteISAC_IND(sf, ISAC_CMDR, 0x41);
308 spin_unlock_irqrestore(&sf->lock, flags);
309 msleep_interruptible(10);
310 if (debug & DEBUG_HW)
311 pr_notice("%s: IRQ %d count %d\n", sf->name,
312 sf->irq, sf->irqcnt);
314 pr_info("%s: IRQ(%d) got no requests during init %d\n",
315 sf->name, sf->irq, 3 - cnt);
319 free_irq(sf->irq, sf);
325 setup_speedfax(struct sfax_hw *sf)
329 if (!request_region(sf->cfg, 256, sf->name)) {
330 pr_info("mISDN: %s config port %x-%x already in use\n",
331 sf->name, sf->cfg, sf->cfg + 255);
336 outb(0xdd, sf->cfg + TIGER_AUX_CTRL);
337 outb(0, sf->cfg + TIGER_AUX_IRQMASK);
339 sf->isac.type = IPAC_TYPE_ISAC;
340 sf->p_isac.ale = sf->cfg + SFAX_PCI_ADDR;
341 sf->p_isac.port = sf->cfg + SFAX_PCI_ISAC;
342 sf->p_isar.ale = sf->cfg + SFAX_PCI_ADDR;
343 sf->p_isar.port = sf->cfg + SFAX_PCI_ISAR;
344 ASSIGN_FUNC(IND, ISAC, sf->isac);
345 ASSIGN_FUNC(IND, ISAR, sf->isar);
346 spin_lock_irqsave(&sf->lock, flags);
349 spin_unlock_irqrestore(&sf->lock, flags);
354 release_card(struct sfax_hw *card) {
357 spin_lock_irqsave(&card->lock, flags);
359 spin_unlock_irqrestore(&card->lock, flags);
360 card->isac.release(&card->isac);
361 free_irq(card->irq, card);
362 card->isar.release(&card->isar);
363 mISDN_unregister_device(&card->isac.dch.dev);
364 release_region(card->cfg, 256);
365 pci_disable_device(card->pdev);
366 pci_set_drvdata(card->pdev, NULL);
367 write_lock_irqsave(&card_lock, flags);
368 list_del(&card->list);
369 write_unlock_irqrestore(&card_lock, flags);
375 setup_instance(struct sfax_hw *card)
377 const struct firmware *firmware;
381 snprintf(card->name, MISDN_MAX_IDLEN - 1, "Speedfax.%d", sfax_cnt + 1);
382 write_lock_irqsave(&card_lock, flags);
383 list_add_tail(&card->list, &Cards);
384 write_unlock_irqrestore(&card_lock, flags);
386 spin_lock_init(&card->lock);
387 card->isac.hwlock = &card->lock;
388 card->isar.hwlock = &card->lock;
389 card->isar.ctrl = (void *)&sfax_ctrl;
390 card->isac.name = card->name;
391 card->isar.name = card->name;
392 card->isar.owner = THIS_MODULE;
394 err = reject_firmware(&firmware, "/*(DEBLOBBED)*/", &card->pdev->dev);
396 pr_info("%s: firmware request failed %d\n",
400 if (debug & DEBUG_HW)
401 pr_notice("%s: got firmware %zu bytes\n",
402 card->name, firmware->size);
404 mISDNisac_init(&card->isac, card);
406 card->isac.dch.dev.D.ctrl = sfax_dctrl;
407 card->isac.dch.dev.Bprotocols =
408 mISDNisar_init(&card->isar, card);
409 for (i = 0; i < 2; i++) {
410 set_channelmap(i + 1, card->isac.dch.dev.channelmap);
411 list_add(&card->isar.ch[i].bch.ch.list,
412 &card->isac.dch.dev.bchannels);
415 err = setup_speedfax(card);
418 err = card->isar.init(&card->isar);
421 err = mISDN_register_device(&card->isac.dch.dev,
422 &card->pdev->dev, card->name);
425 err = init_card(card);
428 err = card->isar.firmware(&card->isar, firmware->data, firmware->size);
430 release_firmware(firmware);
432 pr_notice("SpeedFax %d cards installed\n", sfax_cnt);
436 free_irq(card->irq, card);
438 mISDN_unregister_device(&card->isac.dch.dev);
440 release_region(card->cfg, 256);
442 card->isac.release(&card->isac);
443 card->isar.release(&card->isar);
444 release_firmware(firmware);
446 pci_disable_device(card->pdev);
447 write_lock_irqsave(&card_lock, flags);
448 list_del(&card->list);
449 write_unlock_irqrestore(&card_lock, flags);
455 sfaxpci_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
458 struct sfax_hw *card = kzalloc(sizeof(struct sfax_hw), GFP_KERNEL);
461 pr_info("No memory for Speedfax+ PCI\n");
465 err = pci_enable_device(pdev);
471 pr_notice("mISDN: Speedfax found adapter %s at %s\n",
472 (char *)ent->driver_data, pci_name(pdev));
474 card->cfg = pci_resource_start(pdev, 0);
475 card->irq = pdev->irq;
476 pci_set_drvdata(pdev, card);
477 err = setup_instance(card);
479 pci_set_drvdata(pdev, NULL);
484 sfax_remove_pci(struct pci_dev *pdev)
486 struct sfax_hw *card = pci_get_drvdata(pdev);
491 pr_debug("%s: drvdata already removed\n", __func__);
494 static struct pci_device_id sfaxpci_ids[] = {
495 { PCI_VENDOR_ID_TIGERJET, PCI_DEVICE_ID_TIGERJET_100,
496 PCI_SUBVENDOR_SPEEDFAX_PYRAMID, PCI_SUB_ID_SEDLBAUER,
497 0, 0, (unsigned long) "Pyramid Speedfax + PCI"
499 { PCI_VENDOR_ID_TIGERJET, PCI_DEVICE_ID_TIGERJET_100,
500 PCI_SUBVENDOR_SPEEDFAX_PCI, PCI_SUB_ID_SEDLBAUER,
501 0, 0, (unsigned long) "Sedlbauer Speedfax + PCI"
505 MODULE_DEVICE_TABLE(pci, sfaxpci_ids);
507 static struct pci_driver sfaxpci_driver = {
508 .name = "speedfax+ pci",
509 .probe = sfaxpci_probe,
510 .remove = sfax_remove_pci,
511 .id_table = sfaxpci_ids,
519 pr_notice("Sedlbauer Speedfax+ Driver Rev. %s\n",
521 err = pci_register_driver(&sfaxpci_driver);
526 Speedfax_cleanup(void)
528 pci_unregister_driver(&sfaxpci_driver);
531 module_init(Speedfax_init);
532 module_exit(Speedfax_cleanup);