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 unsigned 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 dev_vdbg(&socket[i].socket.dev,
217 "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);
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_set_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, data;
313 /* First, set the global controller options */
314 indirect_write(socket, I365_GBLCTL, 0x00);
315 indirect_write(socket, I365_GENCTL, 0x00);
317 /* Values for the IGENC register */
318 socket->card_irq = state->io_irq;
321 /* The reset bit has "inverse" logic */
322 if (!(state->flags & SS_RESET))
323 reg |= I365_PC_RESET;
324 if (state->flags & SS_IOCARD)
325 reg |= I365_PC_IOCARD;
327 /* IGENC, Interrupt and General Control Register */
328 indirect_write(socket, I365_INTCTL, reg);
330 /* Power registers */
332 reg = I365_PWR_NORESET; /* default: disable resetdrv on resume */
334 if (state->flags & SS_PWR_AUTO) {
335 dev_dbg(&sock->dev, "Auto power\n");
336 reg |= I365_PWR_AUTO; /* automatic power mngmnt */
338 if (state->flags & SS_OUTPUT_ENA) {
339 dev_dbg(&sock->dev, "Power Enabled\n");
340 reg |= I365_PWR_OUT; /* enable power */
343 switch (state->Vcc) {
348 "setting voltage to Vcc to 3.3V on socket %i\n",
351 indirect_setbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
355 "setting voltage to Vcc to 5V on socket %i\n",
358 indirect_resetbit(socket, PD67_MISC_CTL_1, PD67_MC1_VCC_3V);
362 "pd6729_set_socket called with invalid VCC power "
363 "value: %i\n", state->Vcc);
367 switch (state->Vpp) {
369 dev_dbg(&sock->dev, "not setting Vpp on socket %i\n",
374 dev_dbg(&sock->dev, "setting Vpp to Vcc for socket %i\n",
379 dev_dbg(&sock->dev, "setting Vpp to 12.0\n");
380 reg |= I365_VPP1_12V;
383 dev_dbg(&sock->dev, "pd6729: pd6729_set_socket called with "
384 "invalid VPP power value: %i\n", state->Vpp);
388 /* only write if changed */
389 if (reg != indirect_read(socket, I365_POWER))
390 indirect_write(socket, I365_POWER, reg);
393 /* all interrupts are to be done as PCI interrupts */
394 data = PD67_EC1_INV_MGMT_IRQ | PD67_EC1_INV_CARD_IRQ;
398 indirect_write(socket, PD67_EXT_INDEX, PD67_EXT_CTL_1);
399 indirect_write(socket, PD67_EXT_DATA, data);
401 /* Enable specific interrupt events */
404 if (state->csc_mask & SS_DETECT) {
405 reg |= I365_CSC_DETECT;
407 if (state->flags & SS_IOCARD) {
408 if (state->csc_mask & SS_STSCHG)
409 reg |= I365_CSC_STSCHG;
411 if (state->csc_mask & SS_BATDEAD)
412 reg |= I365_CSC_BVD1;
413 if (state->csc_mask & SS_BATWARN)
414 reg |= I365_CSC_BVD2;
415 if (state->csc_mask & SS_READY)
416 reg |= I365_CSC_READY;
419 reg |= 0x30; /* management IRQ: PCI INTA# = "irq 3" */
420 indirect_write(socket, I365_CSCINT, reg);
422 reg = indirect_read(socket, I365_INTCTL);
424 reg |= 0x03; /* card IRQ: PCI INTA# = "irq 3" */
426 reg |= socket->card_irq;
427 indirect_write(socket, I365_INTCTL, reg);
429 /* now clear the (probably bogus) pending stuff by doing a dummy read */
430 (void)indirect_read(socket, I365_CSC);
435 static int pd6729_set_io_map(struct pcmcia_socket *sock,
436 struct pccard_io_map *io)
438 struct pd6729_socket *socket
439 = container_of(sock, struct pd6729_socket, socket);
440 unsigned char map, ioctl;
444 /* Check error conditions */
446 dev_dbg(&sock->dev, "pd6729_set_io_map with invalid map\n");
450 /* Turn off the window before changing anything */
451 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_IO(map))
452 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
454 /* dev_dbg(&sock->dev, "set_io_map: Setting range to %x - %x\n",
455 io->start, io->stop);*/
457 /* write the new values */
458 indirect_write16(socket, I365_IO(map)+I365_W_START, io->start);
459 indirect_write16(socket, I365_IO(map)+I365_W_STOP, io->stop);
461 ioctl = indirect_read(socket, I365_IOCTL) & ~I365_IOCTL_MASK(map);
463 if (io->flags & MAP_0WS) ioctl |= I365_IOCTL_0WS(map);
464 if (io->flags & MAP_16BIT) ioctl |= I365_IOCTL_16BIT(map);
465 if (io->flags & MAP_AUTOSZ) ioctl |= I365_IOCTL_IOCS16(map);
467 indirect_write(socket, I365_IOCTL, ioctl);
469 /* Turn the window back on if needed */
470 if (io->flags & MAP_ACTIVE)
471 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_IO(map));
476 static int pd6729_set_mem_map(struct pcmcia_socket *sock,
477 struct pccard_mem_map *mem)
479 struct pd6729_socket *socket
480 = container_of(sock, struct pd6729_socket, socket);
481 unsigned short base, i;
486 dev_warn(&sock->dev, "invalid map requested\n");
490 if ((mem->res->start > mem->res->end) || (mem->speed > 1000)) {
491 dev_warn(&sock->dev, "invalid invalid address / speed\n");
495 /* Turn off the window before changing anything */
496 if (indirect_read(socket, I365_ADDRWIN) & I365_ENA_MEM(map))
497 indirect_resetbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
499 /* write the start address */
500 base = I365_MEM(map);
501 i = (mem->res->start >> 12) & 0x0fff;
502 if (mem->flags & MAP_16BIT)
504 if (mem->flags & MAP_0WS)
506 indirect_write16(socket, base + I365_W_START, i);
508 /* write the stop address */
510 i= (mem->res->end >> 12) & 0x0fff;
511 switch (to_cycles(mem->speed)) {
521 i |= I365_MEM_WS1 | I365_MEM_WS0;
525 indirect_write16(socket, base + I365_W_STOP, i);
527 /* Take care of high byte */
528 indirect_write(socket, PD67_EXT_INDEX, PD67_MEM_PAGE(map));
529 indirect_write(socket, PD67_EXT_DATA, mem->res->start >> 24);
533 i = ((mem->card_start - mem->res->start) >> 12) & 0x3fff;
534 if (mem->flags & MAP_WRPROT)
535 i |= I365_MEM_WRPROT;
536 if (mem->flags & MAP_ATTRIB) {
537 /* dev_dbg(&sock->dev, "requesting attribute memory for "
538 "socket %i\n", socket->number);*/
541 /* dev_dbg(&sock->dev, "requesting normal memory for "
542 "socket %i\n", socket->number);*/
544 indirect_write16(socket, base + I365_W_OFF, i);
546 /* Enable the window if necessary */
547 if (mem->flags & MAP_ACTIVE)
548 indirect_setbit(socket, I365_ADDRWIN, I365_ENA_MEM(map));
553 static int pd6729_init(struct pcmcia_socket *sock)
556 struct resource res = { .end = 0x0fff };
557 pccard_io_map io = { 0, 0, 0, 0, 1 };
558 pccard_mem_map mem = { .res = &res, };
560 pd6729_set_socket(sock, &dead_socket);
561 for (i = 0; i < 2; i++) {
563 pd6729_set_io_map(sock, &io);
565 for (i = 0; i < 5; i++) {
567 pd6729_set_mem_map(sock, &mem);
574 /* the pccard structure and its functions */
575 static struct pccard_operations pd6729_operations = {
577 .get_status = pd6729_get_status,
578 .set_socket = pd6729_set_socket,
579 .set_io_map = pd6729_set_io_map,
580 .set_mem_map = pd6729_set_mem_map,
583 static irqreturn_t pd6729_test(int irq, void *dev)
585 pr_devel("-> hit on irq %d\n", irq);
589 static int pd6729_check_irq(int irq)
591 if (request_irq(irq, pd6729_test, IRQF_PROBE_SHARED, "x", pd6729_test)
593 free_irq(irq, pd6729_test);
597 static u_int __devinit pd6729_isa_scan(void)
599 u_int mask0, mask = 0;
603 printk(KERN_INFO "pd6729: PCI card interrupts, "
604 "PCI status changes\n");
608 if (irq_list_count == 0)
611 for (i = mask0 = 0; i < irq_list_count; i++)
612 mask0 |= (1<<irq_list[i]);
616 /* just find interrupts that aren't in use */
617 for (i = 0; i < 16; i++)
618 if ((mask0 & (1 << i)) && (pd6729_check_irq(i) == 0))
621 printk(KERN_INFO "pd6729: ISA irqs = ");
622 for (i = 0; i < 16; i++)
624 printk("%s%d", ((mask & ((1<<i)-1)) ? "," : ""), i);
626 if (mask == 0) printk("none!");
628 printk(" polling status changes.\n");
633 static int __devinit pd6729_pci_probe(struct pci_dev *dev,
634 const struct pci_device_id *id)
639 struct pd6729_socket *socket;
641 socket = kzalloc(sizeof(struct pd6729_socket) * MAX_SOCKETS,
646 if ((ret = pci_enable_device(dev)))
647 goto err_out_free_mem;
649 if (!pci_resource_start(dev, 0)) {
650 dev_warn(&dev->dev, "refusing to load the driver as the "
651 "io_base is NULL.\n");
652 goto err_out_free_mem;
655 dev_info(&dev->dev, "Cirrus PD6729 PCI to PCMCIA Bridge at 0x%llx "
657 (unsigned long long)pci_resource_start(dev, 0), dev->irq);
659 * Since we have no memory BARs some firmware may not
660 * have had PCI_COMMAND_MEMORY enabled, yet the device needs it.
662 pci_read_config_byte(dev, PCI_COMMAND, &configbyte);
663 if (!(configbyte & PCI_COMMAND_MEMORY)) {
664 dev_dbg(&dev->dev, "pd6729: Enabling PCI_COMMAND_MEMORY.\n");
665 configbyte |= PCI_COMMAND_MEMORY;
666 pci_write_config_byte(dev, PCI_COMMAND, configbyte);
669 ret = pci_request_regions(dev, "pd6729");
671 dev_warn(&dev->dev, "pci request region failed.\n");
672 goto err_out_disable;
675 if (dev->irq == NO_IRQ)
676 irq_mode = 0; /* fall back to ISA interrupt mode */
678 mask = pd6729_isa_scan();
679 if (irq_mode == 0 && mask == 0) {
680 dev_warn(&dev->dev, "no ISA interrupt is available.\n");
681 goto err_out_free_res;
684 for (i = 0; i < MAX_SOCKETS; i++) {
685 socket[i].io_base = pci_resource_start(dev, 0);
686 socket[i].socket.features |= SS_CAP_PAGE_REGS | SS_CAP_PCCARD;
687 socket[i].socket.map_size = 0x1000;
688 socket[i].socket.irq_mask = mask;
689 socket[i].socket.pci_irq = dev->irq;
690 socket[i].socket.owner = THIS_MODULE;
692 socket[i].number = i;
694 socket[i].socket.ops = &pd6729_operations;
695 socket[i].socket.resource_ops = &pccard_nonstatic_ops;
696 socket[i].socket.dev.parent = &dev->dev;
697 socket[i].socket.driver_data = &socket[i];
700 pci_set_drvdata(dev, socket);
702 /* Register the interrupt handler */
703 if ((ret = request_irq(dev->irq, pd6729_interrupt, IRQF_SHARED,
704 "pd6729", socket))) {
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);
769 static int pd6729_socket_suspend(struct pci_dev *dev, pm_message_t state)
771 return pcmcia_socket_dev_suspend(&dev->dev);
774 static int pd6729_socket_resume(struct pci_dev *dev)
776 return pcmcia_socket_dev_resume(&dev->dev);
780 static struct pci_device_id pd6729_pci_ids[] = {
782 .vendor = PCI_VENDOR_ID_CIRRUS,
783 .device = PCI_DEVICE_ID_CIRRUS_6729,
784 .subvendor = PCI_ANY_ID,
785 .subdevice = PCI_ANY_ID,
789 MODULE_DEVICE_TABLE(pci, pd6729_pci_ids);
791 static struct pci_driver pd6729_pci_driver = {
793 .id_table = pd6729_pci_ids,
794 .probe = pd6729_pci_probe,
795 .remove = __devexit_p(pd6729_pci_remove),
797 .suspend = pd6729_socket_suspend,
798 .resume = pd6729_socket_resume,
802 static int pd6729_module_init(void)
804 return pci_register_driver(&pd6729_pci_driver);
807 static void pd6729_module_exit(void)
809 pci_unregister_driver(&pd6729_pci_driver);
812 module_init(pd6729_module_init);
813 module_exit(pd6729_module_exit);