2 * Driver for the Cirrus PD6729 PCI-PCMCIA bridge.
4 * Based on the i82092.c driver.
6 * This software may be used and distributed according to the terms of
7 * the GNU General Public License, incorporated herein by reference.
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/pci.h>
14 #include <linux/init.h>
15 #include <linux/workqueue.h>
16 #include <linux/interrupt.h>
17 #include <linux/device.h>
20 #include <pcmcia/cs_types.h>
21 #include <pcmcia/ss.h>
22 #include <pcmcia/cs.h>
24 #include <asm/system.h>
30 MODULE_LICENSE("GPL");
31 MODULE_DESCRIPTION("Driver for the Cirrus PD6729 PCI-PCMCIA bridge");
32 MODULE_AUTHOR("Jun Komuro <komurojun-mbn@nifty.com>");
37 * simple helper functions
38 * External clock time, in nanoseconds. 120 ns = 8.33 MHz
40 #define to_cycles(ns) ((ns)/120)
43 #define NO_IRQ ((unsigned int)(0))
49 * Specifies the interrupt delivery mode. The default (1) is to use PCI
50 * interrupts; a value of 0 selects ISA interrupts. This must be set for
51 * correct operation of PCI card readers.
54 static int irq_mode = 1; /* 0 = ISA interrupt, 1 = PCI interrupt */
56 module_param(irq_mode, int, 0444);
57 MODULE_PARM_DESC(irq_mode,
58 "interrupt delivery mode. 0 = ISA, 1 = PCI. default is 1");
60 static DEFINE_SPINLOCK(port_lock);
62 /* basic value read/write functions */
64 static unsigned char indirect_read(struct pd6729_socket *socket,
71 spin_lock_irqsave(&port_lock, flags);
72 reg += socket->number * 0x40;
73 port = socket->io_base;
76 spin_unlock_irqrestore(&port_lock, flags);
81 static unsigned short indirect_read16(struct pd6729_socket *socket,
88 spin_lock_irqsave(&port_lock, flags);
89 reg = reg + socket->number * 0x40;
90 port = socket->io_base;
95 tmp = tmp | (inb(port + 1) << 8);
96 spin_unlock_irqrestore(&port_lock, flags);
101 static void indirect_write(struct pd6729_socket *socket, unsigned short reg,
107 spin_lock_irqsave(&port_lock, flags);
108 reg = reg + socket->number * 0x40;
109 port = socket->io_base;
111 outb(value, port + 1);
112 spin_unlock_irqrestore(&port_lock, flags);
115 static void indirect_setbit(struct pd6729_socket *socket, unsigned short reg,
122 spin_lock_irqsave(&port_lock, flags);
123 reg = reg + socket->number * 0x40;
124 port = socket->io_base;
130 spin_unlock_irqrestore(&port_lock, flags);
133 static void indirect_resetbit(struct pd6729_socket *socket, unsigned short reg,
140 spin_lock_irqsave(&port_lock, flags);
141 reg = reg + socket->number * 0x40;
142 port = socket->io_base;
148 spin_unlock_irqrestore(&port_lock, flags);
151 static void indirect_write16(struct pd6729_socket *socket, unsigned short reg,
152 unsigned short value)
158 spin_lock_irqsave(&port_lock, flags);
159 reg = reg + socket->number * 0x40;
160 port = socket->io_base;
171 spin_unlock_irqrestore(&port_lock, flags);
174 /* Interrupt handler functionality */
176 static irqreturn_t pd6729_interrupt(int irq, void *dev)
178 struct pd6729_socket *socket = (struct pd6729_socket *)dev;
182 unsigned int events, active = 0;
186 if (loopcount > 20) {
187 printk(KERN_ERR "pd6729: infinite eventloop "
194 for (i = 0; i < MAX_SOCKETS; i++) {
197 /* card status change register */
198 csc = indirect_read(&socket[i], I365_CSC);
199 if (csc == 0) /* no events on this socket */
205 if (csc & I365_CSC_DETECT) {
207 dev_vdbg(&socket[i].socket.dev,
208 "Card detected in socket %i!\n", i);
211 if (indirect_read(&socket[i], I365_INTCTL)
213 /* For IO/CARDS, bit 0 means "read the card" */
214 events |= (csc & I365_CSC_STSCHG)
217 /* Check for battery/ready events */
218 events |= (csc & I365_CSC_BVD1)
220 events |= (csc & I365_CSC_BVD2)
222 events |= (csc & I365_CSC_READY)
227 pcmcia_parse_events(&socket[i].socket, events);
232 if (active == 0) /* no more events to handle */
235 return IRQ_RETVAL(handled);
238 /* socket functions */
240 static void pd6729_interrupt_wrapper(unsigned long data)
242 struct pd6729_socket *socket = (struct pd6729_socket *) data;
244 pd6729_interrupt(0, (void *)socket);
245 mod_timer(&socket->poll_timer, jiffies + HZ);
248 static int pd6729_get_status(struct pcmcia_socket *sock, u_int *value)
250 struct pd6729_socket *socket
251 = container_of(sock, struct pd6729_socket, socket);
254 struct pd6729_socket *t;
256 /* Interface Status Register */
257 status = indirect_read(socket, I365_STATUS);
260 if ((status & I365_CS_DETECT) == I365_CS_DETECT)
264 * IO cards have a different meaning of bits 0,1
265 * Also notice the inverse-logic on the bits
267 if (indirect_read(socket, I365_INTCTL) & I365_PC_IOCARD) {
269 if (!(status & I365_CS_STSCHG))
273 if (!(status & I365_CS_BVD1))
274 *value |= SS_BATDEAD;
275 if (!(status & I365_CS_BVD2))
276 *value |= SS_BATWARN;
279 if (status & I365_CS_WRPROT)
280 *value |= SS_WRPROT; /* card is write protected */
282 if (status & I365_CS_READY)
283 *value |= SS_READY; /* card is not busy */
285 if (status & I365_CS_POWERON)
286 *value |= SS_POWERON; /* power is applied to the card */
288 t = (socket->number) ? socket : socket + 1;
289 indirect_write(t, PD67_EXT_INDEX, PD67_EXTERN_DATA);
290 data = indirect_read16(t, PD67_EXT_DATA);
291 *value |= (data & PD67_EXD_VS1(socket->number)) ? 0 : SS_3VCARD;
297 static int pd6729_set_socket(struct pcmcia_socket *sock, socket_state_t *state)
299 struct pd6729_socket *socket
300 = container_of(sock, struct pd6729_socket, socket);
301 unsigned char reg, data;
303 /* First, set the global controller options */
304 indirect_write(socket, I365_GBLCTL, 0x00);
305 indirect_write(socket, I365_GENCTL, 0x00);
307 /* Values for the IGENC register */
308 socket->card_irq = state->io_irq;
311 /* The reset bit has "inverse" logic */
312 if (!(state->flags & SS_RESET))
313 reg |= I365_PC_RESET;
314 if (state->flags & SS_IOCARD)
315 reg |= I365_PC_IOCARD;
317 /* IGENC, Interrupt and General Control Register */
318 indirect_write(socket, I365_INTCTL, reg);
320 /* Power registers */
322 reg = I365_PWR_NORESET; /* default: disable resetdrv on resume */
324 if (state->flags & SS_PWR_AUTO) {
325 dev_dbg(&sock->dev, "Auto power\n");
326 reg |= I365_PWR_AUTO; /* automatic power mngmnt */
328 if (state->flags & SS_OUTPUT_ENA) {
329 dev_dbg(&sock->dev, "Power Enabled\n");
330 reg |= I365_PWR_OUT; /* enable power */
333 switch (state->Vcc) {
338 "setting voltage to Vcc to 3.3V on socket %i\n",
341 indirect_setbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
345 "setting voltage to Vcc to 5V on socket %i\n",
348 indirect_resetbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
352 "pd6729_set_socket called with invalid VCC power "
353 "value: %i\n", state->Vcc);
357 switch (state->Vpp) {
359 dev_dbg(&sock->dev, "not setting Vpp on socket %i\n",
364 dev_dbg(&sock->dev, "setting Vpp to Vcc for socket %i\n",
369 dev_dbg(&sock->dev, "setting Vpp to 12.0\n");
370 reg |= I365_VPP1_12V;
373 dev_dbg(&sock->dev, "pd6729: pd6729_set_socket called with "
374 "invalid VPP power value: %i\n", state->Vpp);
378 /* only write if changed */
379 if (reg != indirect_read(socket, I365_POWER))
380 indirect_write(socket, I365_POWER, reg);
383 /* all interrupts are to be done as PCI interrupts */
384 data = PD67_EC1_INV_MGMT_IRQ | PD67_EC1_INV_CARD_IRQ;
388 indirect_write(socket, PD67_EXT_INDEX, PD67_EXT_CTL_1);
389 indirect_write(socket, PD67_EXT_DATA, data);
391 /* Enable specific interrupt events */
394 if (state->csc_mask & SS_DETECT)
395 reg |= I365_CSC_DETECT;
397 if (state->flags & SS_IOCARD) {
398 if (state->csc_mask & SS_STSCHG)
399 reg |= I365_CSC_STSCHG;
401 if (state->csc_mask & SS_BATDEAD)
402 reg |= I365_CSC_BVD1;
403 if (state->csc_mask & SS_BATWARN)
404 reg |= I365_CSC_BVD2;
405 if (state->csc_mask & SS_READY)
406 reg |= I365_CSC_READY;
409 reg |= 0x30; /* management IRQ: PCI INTA# = "irq 3" */
410 indirect_write(socket, I365_CSCINT, reg);
412 reg = indirect_read(socket, I365_INTCTL);
414 reg |= 0x03; /* card IRQ: PCI INTA# = "irq 3" */
416 reg |= socket->card_irq;
417 indirect_write(socket, I365_INTCTL, reg);
419 /* now clear the (probably bogus) pending stuff by doing a dummy read */
420 (void)indirect_read(socket, I365_CSC);
425 static int pd6729_set_io_map(struct pcmcia_socket *sock,
426 struct pccard_io_map *io)
428 struct pd6729_socket *socket
429 = container_of(sock, struct pd6729_socket, socket);
430 unsigned char map, ioctl;
434 /* Check error conditions */
436 dev_dbg(&sock->dev, "pd6729_set_io_map with invalid map\n");
440 /* Turn off the window before changing anything */
441 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_IO(map))
442 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
444 /* dev_dbg(&sock->dev, "set_io_map: Setting range to %x - %x\n",
445 io->start, io->stop);*/
447 /* write the new values */
448 indirect_write16(socket, I365_IO(map)+I365_W_START, io->start);
449 indirect_write16(socket, I365_IO(map)+I365_W_STOP, io->stop);
451 ioctl = indirect_read(socket, I365_IOCTL) & ~I365_IOCTL_MASK(map);
453 if (io->flags & MAP_0WS)
454 ioctl |= I365_IOCTL_0WS(map);
455 if (io->flags & MAP_16BIT)
456 ioctl |= I365_IOCTL_16BIT(map);
457 if (io->flags & MAP_AUTOSZ)
458 ioctl |= I365_IOCTL_IOCS16(map);
460 indirect_write(socket, I365_IOCTL, ioctl);
462 /* Turn the window back on if needed */
463 if (io->flags & MAP_ACTIVE)
464 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
469 static int pd6729_set_mem_map(struct pcmcia_socket *sock,
470 struct pccard_mem_map *mem)
472 struct pd6729_socket *socket
473 = container_of(sock, struct pd6729_socket, socket);
474 unsigned short base, i;
479 dev_warn(&sock->dev, "invalid map requested\n");
483 if ((mem->res->start > mem->res->end) || (mem->speed > 1000)) {
484 dev_warn(&sock->dev, "invalid invalid address / speed\n");
488 /* Turn off the window before changing anything */
489 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_MEM(map))
490 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
492 /* write the start address */
493 base = I365_MEM(map);
494 i = (mem->res->start >> 12) & 0x0fff;
495 if (mem->flags & MAP_16BIT)
497 if (mem->flags & MAP_0WS)
499 indirect_write16(socket, base + I365_W_START, i);
501 /* write the stop address */
503 i = (mem->res->end >> 12) & 0x0fff;
504 switch (to_cycles(mem->speed)) {
514 i |= I365_MEM_WS1 | I365_MEM_WS0;
518 indirect_write16(socket, base + I365_W_STOP, i);
520 /* Take care of high byte */
521 indirect_write(socket, PD67_EXT_INDEX, PD67_MEM_PAGE(map));
522 indirect_write(socket, PD67_EXT_DATA, mem->res->start >> 24);
526 i = ((mem->card_start - mem->res->start) >> 12) & 0x3fff;
527 if (mem->flags & MAP_WRPROT)
528 i |= I365_MEM_WRPROT;
529 if (mem->flags & MAP_ATTRIB) {
530 /* dev_dbg(&sock->dev, "requesting attribute memory for "
531 "socket %i\n", socket->number);*/
534 /* dev_dbg(&sock->dev, "requesting normal memory for "
535 "socket %i\n", socket->number);*/
537 indirect_write16(socket, base + I365_W_OFF, i);
539 /* Enable the window if necessary */
540 if (mem->flags & MAP_ACTIVE)
541 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
546 static int pd6729_init(struct pcmcia_socket *sock)
549 struct resource res = { .end = 0x0fff };
550 pccard_io_map io = { 0, 0, 0, 0, 1 };
551 pccard_mem_map mem = { .res = &res, };
553 pd6729_set_socket(sock, &dead_socket);
554 for (i = 0; i < 2; i++) {
556 pd6729_set_io_map(sock, &io);
558 for (i = 0; i < 5; i++) {
560 pd6729_set_mem_map(sock, &mem);
567 /* the pccard structure and its functions */
568 static struct pccard_operations pd6729_operations = {
570 .get_status = pd6729_get_status,
571 .set_socket = pd6729_set_socket,
572 .set_io_map = pd6729_set_io_map,
573 .set_mem_map = pd6729_set_mem_map,
576 static irqreturn_t pd6729_test(int irq, void *dev)
578 pr_devel("-> hit on irq %d\n", irq);
582 static int pd6729_check_irq(int irq)
586 ret = request_irq(irq, pd6729_test, IRQF_PROBE_SHARED, "x",
591 free_irq(irq, pd6729_test);
595 static u_int __devinit pd6729_isa_scan(void)
597 u_int mask0, mask = 0;
601 printk(KERN_INFO "pd6729: PCI card interrupts, "
602 "PCI status changes\n");
608 /* just find interrupts that aren't in use */
609 for (i = 0; i < 16; i++)
610 if ((mask0 & (1 << i)) && (pd6729_check_irq(i) == 0))
613 printk(KERN_INFO "pd6729: ISA irqs = ");
614 for (i = 0; i < 16; i++)
616 printk("%s%d", ((mask & ((1<<i)-1)) ? "," : ""), i);
621 printk(" polling status changes.\n");
626 static int __devinit pd6729_pci_probe(struct pci_dev *dev,
627 const struct pci_device_id *id)
632 struct pd6729_socket *socket;
634 socket = kzalloc(sizeof(struct pd6729_socket) * MAX_SOCKETS,
637 dev_warn(&dev->dev, "failed to kzalloc socket.\n");
641 ret = pci_enable_device(dev);
643 dev_warn(&dev->dev, "failed to enable pci_device.\n");
644 goto err_out_free_mem;
647 if (!pci_resource_start(dev, 0)) {
648 dev_warn(&dev->dev, "refusing to load the driver as the "
649 "io_base is NULL.\n");
650 goto err_out_free_mem;
653 dev_info(&dev->dev, "Cirrus PD6729 PCI to PCMCIA Bridge at 0x%llx "
655 (unsigned long long)pci_resource_start(dev, 0), dev->irq);
657 * Since we have no memory BARs some firmware may not
658 * have had PCI_COMMAND_MEMORY enabled, yet the device needs it.
660 pci_read_config_byte(dev, PCI_COMMAND, &configbyte);
661 if (!(configbyte & PCI_COMMAND_MEMORY)) {
662 dev_dbg(&dev->dev, "pd6729: Enabling PCI_COMMAND_MEMORY.\n");
663 configbyte |= PCI_COMMAND_MEMORY;
664 pci_write_config_byte(dev, PCI_COMMAND, configbyte);
667 ret = pci_request_regions(dev, "pd6729");
669 dev_warn(&dev->dev, "pci request region failed.\n");
670 goto err_out_disable;
673 if (dev->irq == NO_IRQ)
674 irq_mode = 0; /* fall back to ISA interrupt mode */
676 mask = pd6729_isa_scan();
677 if (irq_mode == 0 && mask == 0) {
678 dev_warn(&dev->dev, "no ISA interrupt is available.\n");
679 goto err_out_free_res;
682 for (i = 0; i < MAX_SOCKETS; i++) {
683 socket[i].io_base = pci_resource_start(dev, 0);
684 socket[i].socket.features |= SS_CAP_PAGE_REGS | SS_CAP_PCCARD;
685 socket[i].socket.map_size = 0x1000;
686 socket[i].socket.irq_mask = mask;
687 socket[i].socket.pci_irq = dev->irq;
688 socket[i].socket.cb_dev = dev;
689 socket[i].socket.owner = THIS_MODULE;
691 socket[i].number = i;
693 socket[i].socket.ops = &pd6729_operations;
694 socket[i].socket.resource_ops = &pccard_nonstatic_ops;
695 socket[i].socket.dev.parent = &dev->dev;
696 socket[i].socket.driver_data = &socket[i];
699 pci_set_drvdata(dev, socket);
701 /* Register the interrupt handler */
702 ret = request_irq(dev->irq, pd6729_interrupt, IRQF_SHARED,
705 dev_err(&dev->dev, "Failed to register irq %d\n",
707 goto err_out_free_res;
710 /* poll Card status change */
711 init_timer(&socket->poll_timer);
712 socket->poll_timer.function = pd6729_interrupt_wrapper;
713 socket->poll_timer.data = (unsigned long)socket;
714 socket->poll_timer.expires = jiffies + HZ;
715 add_timer(&socket->poll_timer);
718 for (i = 0; i < MAX_SOCKETS; i++) {
719 ret = pcmcia_register_socket(&socket[i].socket);
721 dev_warn(&dev->dev, "pcmcia_register_socket failed.\n");
722 for (j = 0; j < i ; j++)
723 pcmcia_unregister_socket(&socket[j].socket);
724 goto err_out_free_res2;
732 free_irq(dev->irq, socket);
734 del_timer_sync(&socket->poll_timer);
736 pci_release_regions(dev);
738 pci_disable_device(dev);
745 static void __devexit pd6729_pci_remove(struct pci_dev *dev)
748 struct pd6729_socket *socket = pci_get_drvdata(dev);
750 for (i = 0; i < MAX_SOCKETS; i++) {
751 /* Turn off all interrupt sources */
752 indirect_write(&socket[i], I365_CSCINT, 0);
753 indirect_write(&socket[i], I365_INTCTL, 0);
755 pcmcia_unregister_socket(&socket[i].socket);
759 free_irq(dev->irq, socket);
761 del_timer_sync(&socket->poll_timer);
762 pci_release_regions(dev);
763 pci_disable_device(dev);
768 static struct pci_device_id pd6729_pci_ids[] = {
770 .vendor = PCI_VENDOR_ID_CIRRUS,
771 .device = PCI_DEVICE_ID_CIRRUS_6729,
772 .subvendor = PCI_ANY_ID,
773 .subdevice = PCI_ANY_ID,
777 MODULE_DEVICE_TABLE(pci, pd6729_pci_ids);
779 static struct pci_driver pd6729_pci_driver = {
781 .id_table = pd6729_pci_ids,
782 .probe = pd6729_pci_probe,
783 .remove = __devexit_p(pd6729_pci_remove),
786 static int pd6729_module_init(void)
788 return pci_register_driver(&pd6729_pci_driver);
791 static void pd6729_module_exit(void)
793 pci_unregister_driver(&pd6729_pci_driver);
796 module_init(pd6729_module_init);
797 module_exit(pd6729_module_exit);