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/config.h>
12 #include <linux/module.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>
19 #include <pcmcia/cs_types.h>
20 #include <pcmcia/ss.h>
21 #include <pcmcia/cs.h>
23 #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 * This list limits the set of interrupts that can be used by PCMCIA
56 * The default list is 3,4,5,7,9,10,11.
57 * (irq_list parameter is not used, if irq_mode = 1)
60 static int irq_mode = 1; /* 0 = ISA interrupt, 1 = PCI interrupt */
61 static int irq_list[16];
62 static int irq_list_count = 0;
64 module_param(irq_mode, int, 0444);
65 module_param_array(irq_list, int, &irq_list_count, 0444);
66 MODULE_PARM_DESC(irq_mode,
67 "interrupt delivery mode. 0 = ISA, 1 = PCI. default is 1");
68 MODULE_PARM_DESC(irq_list, "interrupts that can be used by PCMCIA cards");
70 static DEFINE_SPINLOCK(port_lock);
72 /* basic value read/write functions */
74 static unsigned char indirect_read(struct pd6729_socket *socket,
81 spin_lock_irqsave(&port_lock, flags);
82 reg += socket->number * 0x40;
83 port = socket->io_base;
86 spin_unlock_irqrestore(&port_lock, flags);
91 static unsigned short indirect_read16(struct pd6729_socket *socket,
98 spin_lock_irqsave(&port_lock, flags);
99 reg = reg + socket->number * 0x40;
100 port = socket->io_base;
105 tmp = tmp | (inb(port + 1) << 8);
106 spin_unlock_irqrestore(&port_lock, flags);
111 static void indirect_write(struct pd6729_socket *socket, unsigned short reg,
117 spin_lock_irqsave(&port_lock, flags);
118 reg = reg + socket->number * 0x40;
119 port = socket->io_base;
121 outb(value, port + 1);
122 spin_unlock_irqrestore(&port_lock, flags);
125 static void indirect_setbit(struct pd6729_socket *socket, unsigned short reg,
132 spin_lock_irqsave(&port_lock, flags);
133 reg = reg + socket->number * 0x40;
134 port = socket->io_base;
140 spin_unlock_irqrestore(&port_lock, flags);
143 static void indirect_resetbit(struct pd6729_socket *socket, unsigned short reg,
150 spin_lock_irqsave(&port_lock, flags);
151 reg = reg + socket->number * 0x40;
152 port = socket->io_base;
158 spin_unlock_irqrestore(&port_lock, flags);
161 static void indirect_write16(struct pd6729_socket *socket, unsigned short reg,
162 unsigned short value)
168 spin_lock_irqsave(&port_lock, flags);
169 reg = reg + socket->number * 0x40;
170 port = socket->io_base;
181 spin_unlock_irqrestore(&port_lock, flags);
184 /* Interrupt handler functionality */
186 static irqreturn_t pd6729_interrupt(int irq, void *dev, struct pt_regs *regs)
188 struct pd6729_socket *socket = (struct pd6729_socket *)dev;
192 unsigned int events, active = 0;
196 if (loopcount > 20) {
197 printk(KERN_ERR "pd6729: infinite eventloop "
204 for (i = 0; i < MAX_SOCKETS; i++) {
207 /* card status change register */
208 csc = indirect_read(&socket[i], I365_CSC);
209 if (csc == 0) /* no events on this socket */
215 if (csc & I365_CSC_DETECT) {
217 dprintk("Card detected in socket %i!\n", i);
220 if (indirect_read(&socket[i], I365_INTCTL)
222 /* For IO/CARDS, bit 0 means "read the card" */
223 events |= (csc & I365_CSC_STSCHG)
226 /* Check for battery/ready events */
227 events |= (csc & I365_CSC_BVD1)
229 events |= (csc & I365_CSC_BVD2)
231 events |= (csc & I365_CSC_READY)
236 pcmcia_parse_events(&socket[i].socket, events);
241 if (active == 0) /* no more events to handle */
244 return IRQ_RETVAL(handled);
247 /* socket functions */
249 static void pd6729_interrupt_wrapper(unsigned long data)
251 struct pd6729_socket *socket = (struct pd6729_socket *) data;
253 pd6729_interrupt(0, (void *)socket, NULL);
254 mod_timer(&socket->poll_timer, jiffies + HZ);
257 static int pd6729_get_status(struct pcmcia_socket *sock, u_int *value)
259 struct pd6729_socket *socket
260 = container_of(sock, struct pd6729_socket, socket);
263 struct pd6729_socket *t;
265 /* Interface Status Register */
266 status = indirect_read(socket, I365_STATUS);
269 if ((status & I365_CS_DETECT) == I365_CS_DETECT) {
274 * IO cards have a different meaning of bits 0,1
275 * Also notice the inverse-logic on the bits
277 if (indirect_read(socket, I365_INTCTL) & I365_PC_IOCARD) {
279 if (!(status & I365_CS_STSCHG))
283 if (!(status & I365_CS_BVD1))
284 *value |= SS_BATDEAD;
285 if (!(status & I365_CS_BVD2))
286 *value |= SS_BATWARN;
289 if (status & I365_CS_WRPROT)
290 *value |= SS_WRPROT; /* card is write protected */
292 if (status & I365_CS_READY)
293 *value |= SS_READY; /* card is not busy */
295 if (status & I365_CS_POWERON)
296 *value |= SS_POWERON; /* power is applied to the card */
298 t = (socket->number) ? socket : socket + 1;
299 indirect_write(t, PD67_EXT_INDEX, PD67_EXTERN_DATA);
300 data = indirect_read16(t, PD67_EXT_DATA);
301 *value |= (data & PD67_EXD_VS1(socket->number)) ? 0 : SS_3VCARD;
307 static int pd6729_get_socket(struct pcmcia_socket *sock, socket_state_t *state)
309 struct pd6729_socket *socket
310 = container_of(sock, struct pd6729_socket, socket);
311 unsigned char reg, vcc, vpp;
319 /* First the power status of the socket */
320 reg = indirect_read(socket, I365_POWER);
322 if (reg & I365_PWR_AUTO)
323 state->flags |= SS_PWR_AUTO; /* Automatic Power Switch */
325 if (reg & I365_PWR_OUT)
326 state->flags |= SS_OUTPUT_ENA; /* Output signals are enabled */
328 vcc = reg & I365_VCC_MASK; vpp = reg & I365_VPP1_MASK;
330 if (reg & I365_VCC_5V) {
331 state->Vcc = (indirect_read(socket, PD67_MISC_CTL_1) &
332 PD67_MC1_VCC_3V) ? 33 : 50;
334 if (vpp == I365_VPP1_5V) {
335 if (state->Vcc == 50)
340 if (vpp == I365_VPP1_12V)
344 /* Now the IO card, RESET flags and IO interrupt */
345 reg = indirect_read(socket, I365_INTCTL);
347 if ((reg & I365_PC_RESET) == 0)
348 state->flags |= SS_RESET;
349 if (reg & I365_PC_IOCARD)
350 state->flags |= SS_IOCARD; /* This is an IO card */
352 /* Set the IRQ number */
353 state->io_irq = socket->card_irq;
355 /* Card status change */
356 reg = indirect_read(socket, I365_CSCINT);
358 if (reg & I365_CSC_DETECT)
359 state->csc_mask |= SS_DETECT; /* Card detect is enabled */
361 if (state->flags & SS_IOCARD) {/* IO Cards behave different */
362 if (reg & I365_CSC_STSCHG)
363 state->csc_mask |= SS_STSCHG;
365 if (reg & I365_CSC_BVD1)
366 state->csc_mask |= SS_BATDEAD;
367 if (reg & I365_CSC_BVD2)
368 state->csc_mask |= SS_BATWARN;
369 if (reg & I365_CSC_READY)
370 state->csc_mask |= SS_READY;
376 static int pd6729_set_socket(struct pcmcia_socket *sock, socket_state_t *state)
378 struct pd6729_socket *socket
379 = container_of(sock, struct pd6729_socket, socket);
380 unsigned char reg, data;
382 /* First, set the global controller options */
383 indirect_write(socket, I365_GBLCTL, 0x00);
384 indirect_write(socket, I365_GENCTL, 0x00);
386 /* Values for the IGENC register */
387 socket->card_irq = state->io_irq;
390 /* The reset bit has "inverse" logic */
391 if (!(state->flags & SS_RESET))
392 reg |= I365_PC_RESET;
393 if (state->flags & SS_IOCARD)
394 reg |= I365_PC_IOCARD;
396 /* IGENC, Interrupt and General Control Register */
397 indirect_write(socket, I365_INTCTL, reg);
399 /* Power registers */
401 reg = I365_PWR_NORESET; /* default: disable resetdrv on resume */
403 if (state->flags & SS_PWR_AUTO) {
404 dprintk("Auto power\n");
405 reg |= I365_PWR_AUTO; /* automatic power mngmnt */
407 if (state->flags & SS_OUTPUT_ENA) {
408 dprintk("Power Enabled\n");
409 reg |= I365_PWR_OUT; /* enable power */
412 switch (state->Vcc) {
416 dprintk("setting voltage to Vcc to 3.3V on socket %i\n",
419 indirect_setbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
422 dprintk("setting voltage to Vcc to 5V on socket %i\n",
425 indirect_resetbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
428 dprintk("pd6729: pd6729_set_socket called with "
429 "invalid VCC power value: %i\n",
434 switch (state->Vpp) {
436 dprintk("not setting Vpp on socket %i\n", socket->number);
440 dprintk("setting Vpp to Vcc for socket %i\n", socket->number);
444 dprintk("setting Vpp to 12.0\n");
445 reg |= I365_VPP1_12V;
448 dprintk("pd6729: pd6729_set_socket called with invalid VPP power value: %i\n",
453 /* only write if changed */
454 if (reg != indirect_read(socket, I365_POWER))
455 indirect_write(socket, I365_POWER, reg);
458 /* all interrupts are to be done as PCI interrupts */
459 data = PD67_EC1_INV_MGMT_IRQ | PD67_EC1_INV_CARD_IRQ;
463 indirect_write(socket, PD67_EXT_INDEX, PD67_EXT_CTL_1);
464 indirect_write(socket, PD67_EXT_DATA, data);
466 /* Enable specific interrupt events */
469 if (state->csc_mask & SS_DETECT) {
470 reg |= I365_CSC_DETECT;
472 if (state->flags & SS_IOCARD) {
473 if (state->csc_mask & SS_STSCHG)
474 reg |= I365_CSC_STSCHG;
476 if (state->csc_mask & SS_BATDEAD)
477 reg |= I365_CSC_BVD1;
478 if (state->csc_mask & SS_BATWARN)
479 reg |= I365_CSC_BVD2;
480 if (state->csc_mask & SS_READY)
481 reg |= I365_CSC_READY;
484 reg |= 0x30; /* management IRQ: PCI INTA# = "irq 3" */
485 indirect_write(socket, I365_CSCINT, reg);
487 reg = indirect_read(socket, I365_INTCTL);
489 reg |= 0x03; /* card IRQ: PCI INTA# = "irq 3" */
491 reg |= socket->card_irq;
492 indirect_write(socket, I365_INTCTL, reg);
494 /* now clear the (probably bogus) pending stuff by doing a dummy read */
495 (void)indirect_read(socket, I365_CSC);
500 static int pd6729_set_io_map(struct pcmcia_socket *sock,
501 struct pccard_io_map *io)
503 struct pd6729_socket *socket
504 = container_of(sock, struct pd6729_socket, socket);
505 unsigned char map, ioctl;
509 /* Check error conditions */
511 dprintk("pd6729_set_io_map with invalid map");
515 /* Turn off the window before changing anything */
516 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_IO(map))
517 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
519 /* dprintk("set_io_map: Setting range to %x - %x\n",
520 io->start, io->stop);*/
522 /* write the new values */
523 indirect_write16(socket, I365_IO(map)+I365_W_START, io->start);
524 indirect_write16(socket, I365_IO(map)+I365_W_STOP, io->stop);
526 ioctl = indirect_read(socket, I365_IOCTL) & ~I365_IOCTL_MASK(map);
528 if (io->flags & MAP_0WS) ioctl |= I365_IOCTL_0WS(map);
529 if (io->flags & MAP_16BIT) ioctl |= I365_IOCTL_16BIT(map);
530 if (io->flags & MAP_AUTOSZ) ioctl |= I365_IOCTL_IOCS16(map);
532 indirect_write(socket, I365_IOCTL, ioctl);
534 /* Turn the window back on if needed */
535 if (io->flags & MAP_ACTIVE)
536 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
541 static int pd6729_set_mem_map(struct pcmcia_socket *sock,
542 struct pccard_mem_map *mem)
544 struct pd6729_socket *socket
545 = container_of(sock, struct pd6729_socket, socket);
546 unsigned short base, i;
551 printk("pd6729_set_mem_map: invalid map");
555 if ((mem->res->start > mem->res->end) || (mem->speed > 1000)) {
556 printk("pd6729_set_mem_map: invalid address / speed");
560 /* Turn off the window before changing anything */
561 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_MEM(map))
562 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
564 /* write the start address */
565 base = I365_MEM(map);
566 i = (mem->res->start >> 12) & 0x0fff;
567 if (mem->flags & MAP_16BIT)
569 if (mem->flags & MAP_0WS)
571 indirect_write16(socket, base + I365_W_START, i);
573 /* write the stop address */
575 i= (mem->res->end >> 12) & 0x0fff;
576 switch (to_cycles(mem->speed)) {
586 i |= I365_MEM_WS1 | I365_MEM_WS0;
590 indirect_write16(socket, base + I365_W_STOP, i);
592 /* Take care of high byte */
593 indirect_write(socket, PD67_EXT_INDEX, PD67_MEM_PAGE(map));
594 indirect_write(socket, PD67_EXT_DATA, mem->res->start >> 24);
598 i = ((mem->card_start - mem->res->start) >> 12) & 0x3fff;
599 if (mem->flags & MAP_WRPROT)
600 i |= I365_MEM_WRPROT;
601 if (mem->flags & MAP_ATTRIB) {
602 /* dprintk("requesting attribute memory for socket %i\n",
606 /* dprintk("requesting normal memory for socket %i\n",
609 indirect_write16(socket, base + I365_W_OFF, i);
611 /* Enable the window if necessary */
612 if (mem->flags & MAP_ACTIVE)
613 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
618 static int pd6729_suspend(struct pcmcia_socket *sock)
620 return pd6729_set_socket(sock, &dead_socket);
623 static int pd6729_init(struct pcmcia_socket *sock)
626 struct resource res = { .end = 0x0fff };
627 pccard_io_map io = { 0, 0, 0, 0, 1 };
628 pccard_mem_map mem = { .res = &res, };
630 pd6729_set_socket(sock, &dead_socket);
631 for (i = 0; i < 2; i++) {
633 pd6729_set_io_map(sock, &io);
635 for (i = 0; i < 5; i++) {
637 pd6729_set_mem_map(sock, &mem);
644 /* the pccard structure and its functions */
645 static struct pccard_operations pd6729_operations = {
647 .suspend = pd6729_suspend,
648 .get_status = pd6729_get_status,
649 .get_socket = pd6729_get_socket,
650 .set_socket = pd6729_set_socket,
651 .set_io_map = pd6729_set_io_map,
652 .set_mem_map = pd6729_set_mem_map,
655 static irqreturn_t pd6729_test(int irq, void *dev, struct pt_regs *regs)
657 dprintk("-> hit on irq %d\n", irq);
661 static int pd6729_check_irq(int irq, int flags)
663 if (request_irq(irq, pd6729_test, flags, "x", pd6729_test) != 0)
665 free_irq(irq, pd6729_test);
669 static u_int __init pd6729_isa_scan(void)
671 u_int mask0, mask = 0;
675 printk(KERN_INFO "pd6729: PCI card interrupts, "
676 "PCI status changes\n");
680 if (irq_list_count == 0)
683 for (i = mask0 = 0; i < irq_list_count; i++)
684 mask0 |= (1<<irq_list[i]);
688 /* just find interrupts that aren't in use */
689 for (i = 0; i < 16; i++)
690 if ((mask0 & (1 << i)) && (pd6729_check_irq(i, 0) == 0))
693 printk(KERN_INFO "pd6729: ISA irqs = ");
694 for (i = 0; i < 16; i++)
696 printk("%s%d", ((mask & ((1<<i)-1)) ? "," : ""), i);
698 if (mask == 0) printk("none!");
700 printk(" polling status changes.\n");
705 static int __devinit pd6729_pci_probe(struct pci_dev *dev,
706 const struct pci_device_id *id)
711 struct pd6729_socket *socket;
713 socket = kmalloc(sizeof(struct pd6729_socket) * MAX_SOCKETS,
718 memset(socket, 0, sizeof(struct pd6729_socket) * MAX_SOCKETS);
720 if ((ret = pci_enable_device(dev)))
721 goto err_out_free_mem;
723 printk(KERN_INFO "pd6729: Cirrus PD6729 PCI to PCMCIA Bridge "
724 "at 0x%lx on irq %d\n", pci_resource_start(dev, 0), dev->irq);
726 * Since we have no memory BARs some firmware may not
727 * have had PCI_COMMAND_MEMORY enabled, yet the device needs it.
729 pci_read_config_byte(dev, PCI_COMMAND, &configbyte);
730 if (!(configbyte & PCI_COMMAND_MEMORY)) {
731 printk(KERN_DEBUG "pd6729: Enabling PCI_COMMAND_MEMORY.\n");
732 configbyte |= PCI_COMMAND_MEMORY;
733 pci_write_config_byte(dev, PCI_COMMAND, configbyte);
736 ret = pci_request_regions(dev, "pd6729");
738 printk(KERN_INFO "pd6729: pci request region failed.\n");
739 goto err_out_disable;
742 if (dev->irq == NO_IRQ)
743 irq_mode = 0; /* fall back to ISA interrupt mode */
745 mask = pd6729_isa_scan();
746 if (irq_mode == 0 && mask == 0) {
747 printk(KERN_INFO "pd6729: no ISA interrupt is available.\n");
748 goto err_out_free_res;
751 for (i = 0; i < MAX_SOCKETS; i++) {
752 socket[i].io_base = pci_resource_start(dev, 0);
753 socket[i].socket.features |= SS_CAP_PCCARD;
754 socket[i].socket.map_size = 0x1000;
755 socket[i].socket.irq_mask = mask;
756 socket[i].socket.pci_irq = dev->irq;
757 socket[i].socket.owner = THIS_MODULE;
759 socket[i].number = i;
761 socket[i].socket.ops = &pd6729_operations;
762 socket[i].socket.resource_ops = &pccard_nonstatic_ops;
763 socket[i].socket.dev.dev = &dev->dev;
764 socket[i].socket.driver_data = &socket[i];
767 pci_set_drvdata(dev, socket);
769 /* Register the interrupt handler */
770 if ((ret = request_irq(dev->irq, pd6729_interrupt, SA_SHIRQ,
771 "pd6729", socket))) {
772 printk(KERN_ERR "pd6729: Failed to register irq %d, "
773 "aborting\n", dev->irq);
774 goto err_out_free_res;
777 /* poll Card status change */
778 init_timer(&socket->poll_timer);
779 socket->poll_timer.function = pd6729_interrupt_wrapper;
780 socket->poll_timer.data = (unsigned long)socket;
781 socket->poll_timer.expires = jiffies + HZ;
782 add_timer(&socket->poll_timer);
785 for (i = 0; i < MAX_SOCKETS; i++) {
786 ret = pcmcia_register_socket(&socket[i].socket);
788 printk(KERN_INFO "pd6729: pcmcia_register_socket "
790 for (j = 0; j < i ; j++)
791 pcmcia_unregister_socket(&socket[j].socket);
792 goto err_out_free_res2;
800 free_irq(dev->irq, socket);
802 del_timer_sync(&socket->poll_timer);
804 pci_release_regions(dev);
806 pci_disable_device(dev);
813 static void __devexit pd6729_pci_remove(struct pci_dev *dev)
816 struct pd6729_socket *socket = pci_get_drvdata(dev);
818 for (i = 0; i < MAX_SOCKETS; i++) {
819 /* Turn off all interrupt sources */
820 indirect_write(&socket[i], I365_CSCINT, 0);
821 indirect_write(&socket[i], I365_INTCTL, 0);
823 pcmcia_unregister_socket(&socket[i].socket);
827 free_irq(dev->irq, socket);
829 del_timer_sync(&socket->poll_timer);
830 pci_release_regions(dev);
831 pci_disable_device(dev);
836 static int pd6729_socket_suspend(struct pci_dev *dev, u32 state)
838 return pcmcia_socket_dev_suspend(&dev->dev, state);
841 static int pd6729_socket_resume(struct pci_dev *dev)
843 return pcmcia_socket_dev_resume(&dev->dev);
846 static struct pci_device_id pd6729_pci_ids[] = {
848 .vendor = PCI_VENDOR_ID_CIRRUS,
849 .device = PCI_DEVICE_ID_CIRRUS_6729,
850 .subvendor = PCI_ANY_ID,
851 .subdevice = PCI_ANY_ID,
855 MODULE_DEVICE_TABLE(pci, pd6729_pci_ids);
857 static struct pci_driver pd6729_pci_drv = {
859 .id_table = pd6729_pci_ids,
860 .probe = pd6729_pci_probe,
861 .remove = __devexit_p(pd6729_pci_remove),
862 .suspend = pd6729_socket_suspend,
863 .resume = pd6729_socket_resume,
866 static int pd6729_module_init(void)
868 return pci_module_init(&pd6729_pci_drv);
871 static void pd6729_module_exit(void)
873 pci_unregister_driver(&pd6729_pci_drv);
876 module_init(pd6729_module_init);
877 module_exit(pd6729_module_exit);