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/pci.h>
13 #include <linux/init.h>
14 #include <linux/workqueue.h>
15 #include <linux/interrupt.h>
16 #include <linux/device.h>
18 #include <pcmcia/cs_types.h>
19 #include <pcmcia/ss.h>
20 #include <pcmcia/cs.h>
22 #include <asm/system.h>
29 MODULE_LICENSE("GPL");
30 MODULE_DESCRIPTION("Driver for the Cirrus PD6729 PCI-PCMCIA bridge");
31 MODULE_AUTHOR("Jun Komuro <komurojun-mbn@nifty.com>");
36 * simple helper functions
37 * External clock time, in nanoseconds. 120 ns = 8.33 MHz
39 #define to_cycles(ns) ((ns)/120)
42 #define NO_IRQ ((unsigned int)(0))
48 * Specifies the interrupt delivery mode. The default (1) is to use PCI
49 * interrupts; a value of 0 selects ISA interrupts. This must be set for
50 * correct operation of PCI card readers.
53 * This list limits the set of interrupts that can be used by PCMCIA
55 * The default list is 3,4,5,7,9,10,11.
56 * (irq_list parameter is not used, if irq_mode = 1)
59 static int irq_mode = 1; /* 0 = ISA interrupt, 1 = PCI interrupt */
60 static int irq_list[16];
61 static int irq_list_count = 0;
63 module_param(irq_mode, int, 0444);
64 module_param_array(irq_list, int, &irq_list_count, 0444);
65 MODULE_PARM_DESC(irq_mode,
66 "interrupt delivery mode. 0 = ISA, 1 = PCI. default is 1");
67 MODULE_PARM_DESC(irq_list, "interrupts that can be used by PCMCIA cards");
69 static DEFINE_SPINLOCK(port_lock);
71 /* basic value read/write functions */
73 static unsigned char indirect_read(struct pd6729_socket *socket,
80 spin_lock_irqsave(&port_lock, flags);
81 reg += socket->number * 0x40;
82 port = socket->io_base;
85 spin_unlock_irqrestore(&port_lock, flags);
90 static unsigned short indirect_read16(struct pd6729_socket *socket,
97 spin_lock_irqsave(&port_lock, flags);
98 reg = reg + socket->number * 0x40;
99 port = socket->io_base;
104 tmp = tmp | (inb(port + 1) << 8);
105 spin_unlock_irqrestore(&port_lock, flags);
110 static void indirect_write(struct pd6729_socket *socket, unsigned short reg,
116 spin_lock_irqsave(&port_lock, flags);
117 reg = reg + socket->number * 0x40;
118 port = socket->io_base;
120 outb(value, port + 1);
121 spin_unlock_irqrestore(&port_lock, flags);
124 static void indirect_setbit(struct pd6729_socket *socket, unsigned short reg,
131 spin_lock_irqsave(&port_lock, flags);
132 reg = reg + socket->number * 0x40;
133 port = socket->io_base;
139 spin_unlock_irqrestore(&port_lock, flags);
142 static void indirect_resetbit(struct pd6729_socket *socket, unsigned short reg,
149 spin_lock_irqsave(&port_lock, flags);
150 reg = reg + socket->number * 0x40;
151 port = socket->io_base;
157 spin_unlock_irqrestore(&port_lock, flags);
160 static void indirect_write16(struct pd6729_socket *socket, unsigned short reg,
161 unsigned short value)
167 spin_lock_irqsave(&port_lock, flags);
168 reg = reg + socket->number * 0x40;
169 port = socket->io_base;
180 spin_unlock_irqrestore(&port_lock, flags);
183 /* Interrupt handler functionality */
185 static irqreturn_t pd6729_interrupt(int irq, void *dev)
187 struct pd6729_socket *socket = (struct pd6729_socket *)dev;
191 unsigned int events, active = 0;
195 if (loopcount > 20) {
196 printk(KERN_ERR "pd6729: infinite eventloop "
203 for (i = 0; i < MAX_SOCKETS; i++) {
206 /* card status change register */
207 csc = indirect_read(&socket[i], I365_CSC);
208 if (csc == 0) /* no events on this socket */
214 if (csc & I365_CSC_DETECT) {
216 dprintk("Card detected in socket %i!\n", i);
219 if (indirect_read(&socket[i], I365_INTCTL)
221 /* For IO/CARDS, bit 0 means "read the card" */
222 events |= (csc & I365_CSC_STSCHG)
225 /* Check for battery/ready events */
226 events |= (csc & I365_CSC_BVD1)
228 events |= (csc & I365_CSC_BVD2)
230 events |= (csc & I365_CSC_READY)
235 pcmcia_parse_events(&socket[i].socket, events);
240 if (active == 0) /* no more events to handle */
243 return IRQ_RETVAL(handled);
246 /* socket functions */
248 static void pd6729_interrupt_wrapper(unsigned long data)
250 struct pd6729_socket *socket = (struct pd6729_socket *) data;
252 pd6729_interrupt(0, (void *)socket);
253 mod_timer(&socket->poll_timer, jiffies + HZ);
256 static int pd6729_get_status(struct pcmcia_socket *sock, u_int *value)
258 struct pd6729_socket *socket
259 = container_of(sock, struct pd6729_socket, socket);
262 struct pd6729_socket *t;
264 /* Interface Status Register */
265 status = indirect_read(socket, I365_STATUS);
268 if ((status & I365_CS_DETECT) == I365_CS_DETECT) {
273 * IO cards have a different meaning of bits 0,1
274 * Also notice the inverse-logic on the bits
276 if (indirect_read(socket, I365_INTCTL) & I365_PC_IOCARD) {
278 if (!(status & I365_CS_STSCHG))
282 if (!(status & I365_CS_BVD1))
283 *value |= SS_BATDEAD;
284 if (!(status & I365_CS_BVD2))
285 *value |= SS_BATWARN;
288 if (status & I365_CS_WRPROT)
289 *value |= SS_WRPROT; /* card is write protected */
291 if (status & I365_CS_READY)
292 *value |= SS_READY; /* card is not busy */
294 if (status & I365_CS_POWERON)
295 *value |= SS_POWERON; /* power is applied to the card */
297 t = (socket->number) ? socket : socket + 1;
298 indirect_write(t, PD67_EXT_INDEX, PD67_EXTERN_DATA);
299 data = indirect_read16(t, PD67_EXT_DATA);
300 *value |= (data & PD67_EXD_VS1(socket->number)) ? 0 : SS_3VCARD;
306 static int pd6729_set_socket(struct pcmcia_socket *sock, socket_state_t *state)
308 struct pd6729_socket *socket
309 = container_of(sock, struct pd6729_socket, socket);
310 unsigned char reg, data;
312 /* First, set the global controller options */
313 indirect_write(socket, I365_GBLCTL, 0x00);
314 indirect_write(socket, I365_GENCTL, 0x00);
316 /* Values for the IGENC register */
317 socket->card_irq = state->io_irq;
320 /* The reset bit has "inverse" logic */
321 if (!(state->flags & SS_RESET))
322 reg |= I365_PC_RESET;
323 if (state->flags & SS_IOCARD)
324 reg |= I365_PC_IOCARD;
326 /* IGENC, Interrupt and General Control Register */
327 indirect_write(socket, I365_INTCTL, reg);
329 /* Power registers */
331 reg = I365_PWR_NORESET; /* default: disable resetdrv on resume */
333 if (state->flags & SS_PWR_AUTO) {
334 dprintk("Auto power\n");
335 reg |= I365_PWR_AUTO; /* automatic power mngmnt */
337 if (state->flags & SS_OUTPUT_ENA) {
338 dprintk("Power Enabled\n");
339 reg |= I365_PWR_OUT; /* enable power */
342 switch (state->Vcc) {
346 dprintk("setting voltage to Vcc to 3.3V on socket %i\n",
349 indirect_setbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
352 dprintk("setting voltage to Vcc to 5V on socket %i\n",
355 indirect_resetbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
358 dprintk("pd6729: pd6729_set_socket called with "
359 "invalid VCC power value: %i\n",
364 switch (state->Vpp) {
366 dprintk("not setting Vpp on socket %i\n", socket->number);
370 dprintk("setting Vpp to Vcc for socket %i\n", socket->number);
374 dprintk("setting Vpp to 12.0\n");
375 reg |= I365_VPP1_12V;
378 dprintk("pd6729: pd6729_set_socket called with invalid VPP power value: %i\n",
383 /* only write if changed */
384 if (reg != indirect_read(socket, I365_POWER))
385 indirect_write(socket, I365_POWER, reg);
388 /* all interrupts are to be done as PCI interrupts */
389 data = PD67_EC1_INV_MGMT_IRQ | PD67_EC1_INV_CARD_IRQ;
393 indirect_write(socket, PD67_EXT_INDEX, PD67_EXT_CTL_1);
394 indirect_write(socket, PD67_EXT_DATA, data);
396 /* Enable specific interrupt events */
399 if (state->csc_mask & SS_DETECT) {
400 reg |= I365_CSC_DETECT;
402 if (state->flags & SS_IOCARD) {
403 if (state->csc_mask & SS_STSCHG)
404 reg |= I365_CSC_STSCHG;
406 if (state->csc_mask & SS_BATDEAD)
407 reg |= I365_CSC_BVD1;
408 if (state->csc_mask & SS_BATWARN)
409 reg |= I365_CSC_BVD2;
410 if (state->csc_mask & SS_READY)
411 reg |= I365_CSC_READY;
414 reg |= 0x30; /* management IRQ: PCI INTA# = "irq 3" */
415 indirect_write(socket, I365_CSCINT, reg);
417 reg = indirect_read(socket, I365_INTCTL);
419 reg |= 0x03; /* card IRQ: PCI INTA# = "irq 3" */
421 reg |= socket->card_irq;
422 indirect_write(socket, I365_INTCTL, reg);
424 /* now clear the (probably bogus) pending stuff by doing a dummy read */
425 (void)indirect_read(socket, I365_CSC);
430 static int pd6729_set_io_map(struct pcmcia_socket *sock,
431 struct pccard_io_map *io)
433 struct pd6729_socket *socket
434 = container_of(sock, struct pd6729_socket, socket);
435 unsigned char map, ioctl;
439 /* Check error conditions */
441 dprintk("pd6729_set_io_map with invalid map");
445 /* Turn off the window before changing anything */
446 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_IO(map))
447 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
449 /* dprintk("set_io_map: Setting range to %x - %x\n",
450 io->start, io->stop);*/
452 /* write the new values */
453 indirect_write16(socket, I365_IO(map)+I365_W_START, io->start);
454 indirect_write16(socket, I365_IO(map)+I365_W_STOP, io->stop);
456 ioctl = indirect_read(socket, I365_IOCTL) & ~I365_IOCTL_MASK(map);
458 if (io->flags & MAP_0WS) ioctl |= I365_IOCTL_0WS(map);
459 if (io->flags & MAP_16BIT) ioctl |= I365_IOCTL_16BIT(map);
460 if (io->flags & MAP_AUTOSZ) ioctl |= I365_IOCTL_IOCS16(map);
462 indirect_write(socket, I365_IOCTL, ioctl);
464 /* Turn the window back on if needed */
465 if (io->flags & MAP_ACTIVE)
466 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
471 static int pd6729_set_mem_map(struct pcmcia_socket *sock,
472 struct pccard_mem_map *mem)
474 struct pd6729_socket *socket
475 = container_of(sock, struct pd6729_socket, socket);
476 unsigned short base, i;
481 printk("pd6729_set_mem_map: invalid map");
485 if ((mem->res->start > mem->res->end) || (mem->speed > 1000)) {
486 printk("pd6729_set_mem_map: invalid address / speed");
490 /* Turn off the window before changing anything */
491 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_MEM(map))
492 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
494 /* write the start address */
495 base = I365_MEM(map);
496 i = (mem->res->start >> 12) & 0x0fff;
497 if (mem->flags & MAP_16BIT)
499 if (mem->flags & MAP_0WS)
501 indirect_write16(socket, base + I365_W_START, i);
503 /* write the stop address */
505 i= (mem->res->end >> 12) & 0x0fff;
506 switch (to_cycles(mem->speed)) {
516 i |= I365_MEM_WS1 | I365_MEM_WS0;
520 indirect_write16(socket, base + I365_W_STOP, i);
522 /* Take care of high byte */
523 indirect_write(socket, PD67_EXT_INDEX, PD67_MEM_PAGE(map));
524 indirect_write(socket, PD67_EXT_DATA, mem->res->start >> 24);
528 i = ((mem->card_start - mem->res->start) >> 12) & 0x3fff;
529 if (mem->flags & MAP_WRPROT)
530 i |= I365_MEM_WRPROT;
531 if (mem->flags & MAP_ATTRIB) {
532 /* dprintk("requesting attribute memory for socket %i\n",
536 /* dprintk("requesting normal memory for socket %i\n",
539 indirect_write16(socket, base + I365_W_OFF, i);
541 /* Enable the window if necessary */
542 if (mem->flags & MAP_ACTIVE)
543 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
548 static int pd6729_init(struct pcmcia_socket *sock)
551 struct resource res = { .end = 0x0fff };
552 pccard_io_map io = { 0, 0, 0, 0, 1 };
553 pccard_mem_map mem = { .res = &res, };
555 pd6729_set_socket(sock, &dead_socket);
556 for (i = 0; i < 2; i++) {
558 pd6729_set_io_map(sock, &io);
560 for (i = 0; i < 5; i++) {
562 pd6729_set_mem_map(sock, &mem);
569 /* the pccard structure and its functions */
570 static struct pccard_operations pd6729_operations = {
572 .get_status = pd6729_get_status,
573 .set_socket = pd6729_set_socket,
574 .set_io_map = pd6729_set_io_map,
575 .set_mem_map = pd6729_set_mem_map,
578 static irqreturn_t pd6729_test(int irq, void *dev)
580 dprintk("-> hit on irq %d\n", irq);
584 static int pd6729_check_irq(int irq, int flags)
586 if (request_irq(irq, pd6729_test, flags, "x", pd6729_test) != 0)
588 free_irq(irq, pd6729_test);
592 static u_int __devinit pd6729_isa_scan(void)
594 u_int mask0, mask = 0;
598 printk(KERN_INFO "pd6729: PCI card interrupts, "
599 "PCI status changes\n");
603 if (irq_list_count == 0)
606 for (i = mask0 = 0; i < irq_list_count; i++)
607 mask0 |= (1<<irq_list[i]);
611 /* just find interrupts that aren't in use */
612 for (i = 0; i < 16; i++)
613 if ((mask0 & (1 << i)) && (pd6729_check_irq(i, 0) == 0))
616 printk(KERN_INFO "pd6729: ISA irqs = ");
617 for (i = 0; i < 16; i++)
619 printk("%s%d", ((mask & ((1<<i)-1)) ? "," : ""), i);
621 if (mask == 0) printk("none!");
623 printk(" polling status changes.\n");
628 static int __devinit pd6729_pci_probe(struct pci_dev *dev,
629 const struct pci_device_id *id)
634 struct pd6729_socket *socket;
636 socket = kzalloc(sizeof(struct pd6729_socket) * MAX_SOCKETS,
641 if ((ret = pci_enable_device(dev)))
642 goto err_out_free_mem;
644 printk(KERN_INFO "pd6729: Cirrus PD6729 PCI to PCMCIA Bridge "
645 "at 0x%llx on irq %d\n",
646 (unsigned long long)pci_resource_start(dev, 0), dev->irq);
648 * Since we have no memory BARs some firmware may not
649 * have had PCI_COMMAND_MEMORY enabled, yet the device needs it.
651 pci_read_config_byte(dev, PCI_COMMAND, &configbyte);
652 if (!(configbyte & PCI_COMMAND_MEMORY)) {
653 printk(KERN_DEBUG "pd6729: Enabling PCI_COMMAND_MEMORY.\n");
654 configbyte |= PCI_COMMAND_MEMORY;
655 pci_write_config_byte(dev, PCI_COMMAND, configbyte);
658 ret = pci_request_regions(dev, "pd6729");
660 printk(KERN_INFO "pd6729: pci request region failed.\n");
661 goto err_out_disable;
664 if (dev->irq == NO_IRQ)
665 irq_mode = 0; /* fall back to ISA interrupt mode */
667 mask = pd6729_isa_scan();
668 if (irq_mode == 0 && mask == 0) {
669 printk(KERN_INFO "pd6729: no ISA interrupt is available.\n");
670 goto err_out_free_res;
673 for (i = 0; i < MAX_SOCKETS; i++) {
674 socket[i].io_base = pci_resource_start(dev, 0);
675 socket[i].socket.features |= SS_CAP_PAGE_REGS | SS_CAP_PCCARD;
676 socket[i].socket.map_size = 0x1000;
677 socket[i].socket.irq_mask = mask;
678 socket[i].socket.pci_irq = dev->irq;
679 socket[i].socket.owner = THIS_MODULE;
681 socket[i].number = i;
683 socket[i].socket.ops = &pd6729_operations;
684 socket[i].socket.resource_ops = &pccard_nonstatic_ops;
685 socket[i].socket.dev.dev = &dev->dev;
686 socket[i].socket.driver_data = &socket[i];
689 pci_set_drvdata(dev, socket);
691 /* Register the interrupt handler */
692 if ((ret = request_irq(dev->irq, pd6729_interrupt, IRQF_SHARED,
693 "pd6729", socket))) {
694 printk(KERN_ERR "pd6729: Failed to register irq %d, "
695 "aborting\n", dev->irq);
696 goto err_out_free_res;
699 /* poll Card status change */
700 init_timer(&socket->poll_timer);
701 socket->poll_timer.function = pd6729_interrupt_wrapper;
702 socket->poll_timer.data = (unsigned long)socket;
703 socket->poll_timer.expires = jiffies + HZ;
704 add_timer(&socket->poll_timer);
707 for (i = 0; i < MAX_SOCKETS; i++) {
708 ret = pcmcia_register_socket(&socket[i].socket);
710 printk(KERN_INFO "pd6729: pcmcia_register_socket "
712 for (j = 0; j < i ; j++)
713 pcmcia_unregister_socket(&socket[j].socket);
714 goto err_out_free_res2;
722 free_irq(dev->irq, socket);
724 del_timer_sync(&socket->poll_timer);
726 pci_release_regions(dev);
728 pci_disable_device(dev);
735 static void __devexit pd6729_pci_remove(struct pci_dev *dev)
738 struct pd6729_socket *socket = pci_get_drvdata(dev);
740 for (i = 0; i < MAX_SOCKETS; i++) {
741 /* Turn off all interrupt sources */
742 indirect_write(&socket[i], I365_CSCINT, 0);
743 indirect_write(&socket[i], I365_INTCTL, 0);
745 pcmcia_unregister_socket(&socket[i].socket);
749 free_irq(dev->irq, socket);
751 del_timer_sync(&socket->poll_timer);
752 pci_release_regions(dev);
753 pci_disable_device(dev);
759 static int pd6729_socket_suspend(struct pci_dev *dev, pm_message_t state)
761 return pcmcia_socket_dev_suspend(&dev->dev, state);
764 static int pd6729_socket_resume(struct pci_dev *dev)
766 return pcmcia_socket_dev_resume(&dev->dev);
770 static struct pci_device_id pd6729_pci_ids[] = {
772 .vendor = PCI_VENDOR_ID_CIRRUS,
773 .device = PCI_DEVICE_ID_CIRRUS_6729,
774 .subvendor = PCI_ANY_ID,
775 .subdevice = PCI_ANY_ID,
779 MODULE_DEVICE_TABLE(pci, pd6729_pci_ids);
781 static struct pci_driver pd6729_pci_drv = {
783 .id_table = pd6729_pci_ids,
784 .probe = pd6729_pci_probe,
785 .remove = __devexit_p(pd6729_pci_remove),
787 .suspend = pd6729_socket_suspend,
788 .resume = pd6729_socket_resume,
792 static int pd6729_module_init(void)
794 return pci_register_driver(&pd6729_pci_drv);
797 static void pd6729_module_exit(void)
799 pci_unregister_driver(&pd6729_pci_drv);
802 module_init(pd6729_module_init);
803 module_exit(pd6729_module_exit);