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/ss.h>
21 #include <pcmcia/cs.h>
23 #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 static int irq_mode
= 1; /* 0 = ISA interrupt, 1 = PCI interrupt */
55 module_param(irq_mode
, int, 0444);
56 MODULE_PARM_DESC(irq_mode
,
57 "interrupt delivery mode. 0 = ISA, 1 = PCI. default is 1");
59 static DEFINE_SPINLOCK(port_lock
);
61 /* basic value read/write functions */
63 static unsigned char indirect_read(struct pd6729_socket
*socket
,
70 spin_lock_irqsave(&port_lock
, flags
);
71 reg
+= socket
->number
* 0x40;
72 port
= socket
->io_base
;
75 spin_unlock_irqrestore(&port_lock
, flags
);
80 static unsigned short indirect_read16(struct pd6729_socket
*socket
,
87 spin_lock_irqsave(&port_lock
, flags
);
88 reg
= reg
+ socket
->number
* 0x40;
89 port
= socket
->io_base
;
94 tmp
= tmp
| (inb(port
+ 1) << 8);
95 spin_unlock_irqrestore(&port_lock
, flags
);
100 static void indirect_write(struct pd6729_socket
*socket
, unsigned short reg
,
106 spin_lock_irqsave(&port_lock
, flags
);
107 reg
= reg
+ socket
->number
* 0x40;
108 port
= socket
->io_base
;
110 outb(value
, port
+ 1);
111 spin_unlock_irqrestore(&port_lock
, flags
);
114 static void indirect_setbit(struct pd6729_socket
*socket
, unsigned short reg
,
121 spin_lock_irqsave(&port_lock
, flags
);
122 reg
= reg
+ socket
->number
* 0x40;
123 port
= socket
->io_base
;
129 spin_unlock_irqrestore(&port_lock
, flags
);
132 static void indirect_resetbit(struct pd6729_socket
*socket
, unsigned short reg
,
139 spin_lock_irqsave(&port_lock
, flags
);
140 reg
= reg
+ socket
->number
* 0x40;
141 port
= socket
->io_base
;
147 spin_unlock_irqrestore(&port_lock
, flags
);
150 static void indirect_write16(struct pd6729_socket
*socket
, unsigned short reg
,
151 unsigned short value
)
157 spin_lock_irqsave(&port_lock
, flags
);
158 reg
= reg
+ socket
->number
* 0x40;
159 port
= socket
->io_base
;
170 spin_unlock_irqrestore(&port_lock
, flags
);
173 /* Interrupt handler functionality */
175 static irqreturn_t
pd6729_interrupt(int irq
, void *dev
)
177 struct pd6729_socket
*socket
= (struct pd6729_socket
*)dev
;
181 unsigned int events
, active
= 0;
185 if (loopcount
> 20) {
186 printk(KERN_ERR
"pd6729: infinite eventloop "
193 for (i
= 0; i
< MAX_SOCKETS
; i
++) {
196 /* card status change register */
197 csc
= indirect_read(&socket
[i
], I365_CSC
);
198 if (csc
== 0) /* no events on this socket */
204 if (csc
& I365_CSC_DETECT
) {
206 dev_vdbg(&socket
[i
].socket
.dev
,
207 "Card detected in socket %i!\n", i
);
210 if (indirect_read(&socket
[i
], I365_INTCTL
)
212 /* For IO/CARDS, bit 0 means "read the card" */
213 events
|= (csc
& I365_CSC_STSCHG
)
216 /* Check for battery/ready events */
217 events
|= (csc
& I365_CSC_BVD1
)
219 events
|= (csc
& I365_CSC_BVD2
)
221 events
|= (csc
& I365_CSC_READY
)
226 pcmcia_parse_events(&socket
[i
].socket
, events
);
231 if (active
== 0) /* no more events to handle */
234 return IRQ_RETVAL(handled
);
237 /* socket functions */
239 static void pd6729_interrupt_wrapper(unsigned long data
)
241 struct pd6729_socket
*socket
= (struct pd6729_socket
*) data
;
243 pd6729_interrupt(0, (void *)socket
);
244 mod_timer(&socket
->poll_timer
, jiffies
+ HZ
);
247 static int pd6729_get_status(struct pcmcia_socket
*sock
, u_int
*value
)
249 struct pd6729_socket
*socket
250 = container_of(sock
, struct pd6729_socket
, socket
);
253 struct pd6729_socket
*t
;
255 /* Interface Status Register */
256 status
= indirect_read(socket
, I365_STATUS
);
259 if ((status
& I365_CS_DETECT
) == I365_CS_DETECT
)
263 * IO cards have a different meaning of bits 0,1
264 * Also notice the inverse-logic on the bits
266 if (indirect_read(socket
, I365_INTCTL
) & I365_PC_IOCARD
) {
268 if (!(status
& I365_CS_STSCHG
))
272 if (!(status
& I365_CS_BVD1
))
273 *value
|= SS_BATDEAD
;
274 if (!(status
& I365_CS_BVD2
))
275 *value
|= SS_BATWARN
;
278 if (status
& I365_CS_WRPROT
)
279 *value
|= SS_WRPROT
; /* card is write protected */
281 if (status
& I365_CS_READY
)
282 *value
|= SS_READY
; /* card is not busy */
284 if (status
& I365_CS_POWERON
)
285 *value
|= SS_POWERON
; /* power is applied to the card */
287 t
= (socket
->number
) ? socket
: socket
+ 1;
288 indirect_write(t
, PD67_EXT_INDEX
, PD67_EXTERN_DATA
);
289 data
= indirect_read16(t
, PD67_EXT_DATA
);
290 *value
|= (data
& PD67_EXD_VS1(socket
->number
)) ? 0 : SS_3VCARD
;
296 static int pd6729_set_socket(struct pcmcia_socket
*sock
, socket_state_t
*state
)
298 struct pd6729_socket
*socket
299 = container_of(sock
, struct pd6729_socket
, socket
);
300 unsigned char reg
, data
;
302 /* First, set the global controller options */
303 indirect_write(socket
, I365_GBLCTL
, 0x00);
304 indirect_write(socket
, I365_GENCTL
, 0x00);
306 /* Values for the IGENC register */
307 socket
->card_irq
= state
->io_irq
;
310 /* The reset bit has "inverse" logic */
311 if (!(state
->flags
& SS_RESET
))
312 reg
|= I365_PC_RESET
;
313 if (state
->flags
& SS_IOCARD
)
314 reg
|= I365_PC_IOCARD
;
316 /* IGENC, Interrupt and General Control Register */
317 indirect_write(socket
, I365_INTCTL
, reg
);
319 /* Power registers */
321 reg
= I365_PWR_NORESET
; /* default: disable resetdrv on resume */
323 if (state
->flags
& SS_PWR_AUTO
) {
324 dev_dbg(&sock
->dev
, "Auto power\n");
325 reg
|= I365_PWR_AUTO
; /* automatic power mngmnt */
327 if (state
->flags
& SS_OUTPUT_ENA
) {
328 dev_dbg(&sock
->dev
, "Power Enabled\n");
329 reg
|= I365_PWR_OUT
; /* enable power */
332 switch (state
->Vcc
) {
337 "setting voltage to Vcc to 3.3V on socket %i\n",
340 indirect_setbit(socket
, PD67_MISC_CTL_1
, PD67_MC1_VCC_3V
);
344 "setting voltage to Vcc to 5V on socket %i\n",
347 indirect_resetbit(socket
, PD67_MISC_CTL_1
, PD67_MC1_VCC_3V
);
351 "pd6729_set_socket called with invalid VCC power "
352 "value: %i\n", state
->Vcc
);
356 switch (state
->Vpp
) {
358 dev_dbg(&sock
->dev
, "not setting Vpp on socket %i\n",
363 dev_dbg(&sock
->dev
, "setting Vpp to Vcc for socket %i\n",
368 dev_dbg(&sock
->dev
, "setting Vpp to 12.0\n");
369 reg
|= I365_VPP1_12V
;
372 dev_dbg(&sock
->dev
, "pd6729: pd6729_set_socket called with "
373 "invalid VPP power value: %i\n", state
->Vpp
);
377 /* only write if changed */
378 if (reg
!= indirect_read(socket
, I365_POWER
))
379 indirect_write(socket
, I365_POWER
, reg
);
382 /* all interrupts are to be done as PCI interrupts */
383 data
= PD67_EC1_INV_MGMT_IRQ
| PD67_EC1_INV_CARD_IRQ
;
387 indirect_write(socket
, PD67_EXT_INDEX
, PD67_EXT_CTL_1
);
388 indirect_write(socket
, PD67_EXT_DATA
, data
);
390 /* Enable specific interrupt events */
393 if (state
->csc_mask
& SS_DETECT
)
394 reg
|= I365_CSC_DETECT
;
396 if (state
->flags
& SS_IOCARD
) {
397 if (state
->csc_mask
& SS_STSCHG
)
398 reg
|= I365_CSC_STSCHG
;
400 if (state
->csc_mask
& SS_BATDEAD
)
401 reg
|= I365_CSC_BVD1
;
402 if (state
->csc_mask
& SS_BATWARN
)
403 reg
|= I365_CSC_BVD2
;
404 if (state
->csc_mask
& SS_READY
)
405 reg
|= I365_CSC_READY
;
408 reg
|= 0x30; /* management IRQ: PCI INTA# = "irq 3" */
409 indirect_write(socket
, I365_CSCINT
, reg
);
411 reg
= indirect_read(socket
, I365_INTCTL
);
413 reg
|= 0x03; /* card IRQ: PCI INTA# = "irq 3" */
415 reg
|= socket
->card_irq
;
416 indirect_write(socket
, I365_INTCTL
, reg
);
418 /* now clear the (probably bogus) pending stuff by doing a dummy read */
419 (void)indirect_read(socket
, I365_CSC
);
424 static int pd6729_set_io_map(struct pcmcia_socket
*sock
,
425 struct pccard_io_map
*io
)
427 struct pd6729_socket
*socket
428 = container_of(sock
, struct pd6729_socket
, socket
);
429 unsigned char map
, ioctl
;
433 /* Check error conditions */
435 dev_dbg(&sock
->dev
, "pd6729_set_io_map with invalid map\n");
439 /* Turn off the window before changing anything */
440 if (indirect_read(socket
, I365_ADDRWIN
) & I365_ENA_IO(map
))
441 indirect_resetbit(socket
, I365_ADDRWIN
, I365_ENA_IO(map
));
443 /* dev_dbg(&sock->dev, "set_io_map: Setting range to %x - %x\n",
444 io->start, io->stop);*/
446 /* write the new values */
447 indirect_write16(socket
, I365_IO(map
)+I365_W_START
, io
->start
);
448 indirect_write16(socket
, I365_IO(map
)+I365_W_STOP
, io
->stop
);
450 ioctl
= indirect_read(socket
, I365_IOCTL
) & ~I365_IOCTL_MASK(map
);
452 if (io
->flags
& MAP_0WS
)
453 ioctl
|= I365_IOCTL_0WS(map
);
454 if (io
->flags
& MAP_16BIT
)
455 ioctl
|= I365_IOCTL_16BIT(map
);
456 if (io
->flags
& MAP_AUTOSZ
)
457 ioctl
|= I365_IOCTL_IOCS16(map
);
459 indirect_write(socket
, I365_IOCTL
, ioctl
);
461 /* Turn the window back on if needed */
462 if (io
->flags
& MAP_ACTIVE
)
463 indirect_setbit(socket
, I365_ADDRWIN
, I365_ENA_IO(map
));
468 static int pd6729_set_mem_map(struct pcmcia_socket
*sock
,
469 struct pccard_mem_map
*mem
)
471 struct pd6729_socket
*socket
472 = container_of(sock
, struct pd6729_socket
, socket
);
473 unsigned short base
, i
;
478 dev_warn(&sock
->dev
, "invalid map requested\n");
482 if ((mem
->res
->start
> mem
->res
->end
) || (mem
->speed
> 1000)) {
483 dev_warn(&sock
->dev
, "invalid invalid address / speed\n");
487 /* Turn off the window before changing anything */
488 if (indirect_read(socket
, I365_ADDRWIN
) & I365_ENA_MEM(map
))
489 indirect_resetbit(socket
, I365_ADDRWIN
, I365_ENA_MEM(map
));
491 /* write the start address */
492 base
= I365_MEM(map
);
493 i
= (mem
->res
->start
>> 12) & 0x0fff;
494 if (mem
->flags
& MAP_16BIT
)
496 if (mem
->flags
& MAP_0WS
)
498 indirect_write16(socket
, base
+ I365_W_START
, i
);
500 /* write the stop address */
502 i
= (mem
->res
->end
>> 12) & 0x0fff;
503 switch (to_cycles(mem
->speed
)) {
513 i
|= I365_MEM_WS1
| I365_MEM_WS0
;
517 indirect_write16(socket
, base
+ I365_W_STOP
, i
);
519 /* Take care of high byte */
520 indirect_write(socket
, PD67_EXT_INDEX
, PD67_MEM_PAGE(map
));
521 indirect_write(socket
, PD67_EXT_DATA
, mem
->res
->start
>> 24);
525 i
= ((mem
->card_start
- mem
->res
->start
) >> 12) & 0x3fff;
526 if (mem
->flags
& MAP_WRPROT
)
527 i
|= I365_MEM_WRPROT
;
528 if (mem
->flags
& MAP_ATTRIB
) {
529 /* dev_dbg(&sock->dev, "requesting attribute memory for "
530 "socket %i\n", socket->number);*/
533 /* dev_dbg(&sock->dev, "requesting normal memory for "
534 "socket %i\n", socket->number);*/
536 indirect_write16(socket
, base
+ I365_W_OFF
, i
);
538 /* Enable the window if necessary */
539 if (mem
->flags
& MAP_ACTIVE
)
540 indirect_setbit(socket
, I365_ADDRWIN
, I365_ENA_MEM(map
));
545 static int pd6729_init(struct pcmcia_socket
*sock
)
548 struct resource res
= { .end
= 0x0fff };
549 pccard_io_map io
= { 0, 0, 0, 0, 1 };
550 pccard_mem_map mem
= { .res
= &res
, };
552 pd6729_set_socket(sock
, &dead_socket
);
553 for (i
= 0; i
< 2; i
++) {
555 pd6729_set_io_map(sock
, &io
);
557 for (i
= 0; i
< 5; i
++) {
559 pd6729_set_mem_map(sock
, &mem
);
566 /* the pccard structure and its functions */
567 static struct pccard_operations pd6729_operations
= {
569 .get_status
= pd6729_get_status
,
570 .set_socket
= pd6729_set_socket
,
571 .set_io_map
= pd6729_set_io_map
,
572 .set_mem_map
= pd6729_set_mem_map
,
575 static irqreturn_t
pd6729_test(int irq
, void *dev
)
577 pr_devel("-> hit on irq %d\n", irq
);
581 static int pd6729_check_irq(int irq
)
585 ret
= request_irq(irq
, pd6729_test
, IRQF_PROBE_SHARED
, "x",
590 free_irq(irq
, pd6729_test
);
594 static u_int __devinit
pd6729_isa_scan(void)
596 u_int mask0
, mask
= 0;
600 printk(KERN_INFO
"pd6729: PCI card interrupts, "
601 "PCI status changes\n");
607 /* just find interrupts that aren't in use */
608 for (i
= 0; i
< 16; i
++)
609 if ((mask0
& (1 << i
)) && (pd6729_check_irq(i
) == 0))
612 printk(KERN_INFO
"pd6729: ISA irqs = ");
613 for (i
= 0; i
< 16; i
++)
615 printk("%s%d", ((mask
& ((1<<i
)-1)) ? "," : ""), i
);
620 printk(" polling status changes.\n");
625 static int __devinit
pd6729_pci_probe(struct pci_dev
*dev
,
626 const struct pci_device_id
*id
)
631 struct pd6729_socket
*socket
;
633 socket
= kzalloc(sizeof(struct pd6729_socket
) * MAX_SOCKETS
,
636 dev_warn(&dev
->dev
, "failed to kzalloc socket.\n");
640 ret
= pci_enable_device(dev
);
642 dev_warn(&dev
->dev
, "failed to enable pci_device.\n");
643 goto err_out_free_mem
;
646 if (!pci_resource_start(dev
, 0)) {
647 dev_warn(&dev
->dev
, "refusing to load the driver as the "
648 "io_base is NULL.\n");
649 goto err_out_disable
;
652 dev_info(&dev
->dev
, "Cirrus PD6729 PCI to PCMCIA Bridge at 0x%llx "
654 (unsigned long long)pci_resource_start(dev
, 0), dev
->irq
);
656 * Since we have no memory BARs some firmware may not
657 * have had PCI_COMMAND_MEMORY enabled, yet the device needs it.
659 pci_read_config_byte(dev
, PCI_COMMAND
, &configbyte
);
660 if (!(configbyte
& PCI_COMMAND_MEMORY
)) {
661 dev_dbg(&dev
->dev
, "pd6729: Enabling PCI_COMMAND_MEMORY.\n");
662 configbyte
|= PCI_COMMAND_MEMORY
;
663 pci_write_config_byte(dev
, PCI_COMMAND
, configbyte
);
666 ret
= pci_request_regions(dev
, "pd6729");
668 dev_warn(&dev
->dev
, "pci request region failed.\n");
669 goto err_out_disable
;
672 if (dev
->irq
== NO_IRQ
)
673 irq_mode
= 0; /* fall back to ISA interrupt mode */
675 mask
= pd6729_isa_scan();
676 if (irq_mode
== 0 && mask
== 0) {
677 dev_warn(&dev
->dev
, "no ISA interrupt is available.\n");
678 goto err_out_free_res
;
681 for (i
= 0; i
< MAX_SOCKETS
; i
++) {
682 socket
[i
].io_base
= pci_resource_start(dev
, 0);
683 socket
[i
].socket
.features
|= SS_CAP_PAGE_REGS
| SS_CAP_PCCARD
;
684 socket
[i
].socket
.map_size
= 0x1000;
685 socket
[i
].socket
.irq_mask
= mask
;
686 socket
[i
].socket
.pci_irq
= dev
->irq
;
687 socket
[i
].socket
.cb_dev
= dev
;
688 socket
[i
].socket
.owner
= THIS_MODULE
;
690 socket
[i
].number
= i
;
692 socket
[i
].socket
.ops
= &pd6729_operations
;
693 socket
[i
].socket
.resource_ops
= &pccard_nonstatic_ops
;
694 socket
[i
].socket
.dev
.parent
= &dev
->dev
;
695 socket
[i
].socket
.driver_data
= &socket
[i
];
698 pci_set_drvdata(dev
, socket
);
700 /* Register the interrupt handler */
701 ret
= request_irq(dev
->irq
, pd6729_interrupt
, IRQF_SHARED
,
704 dev_err(&dev
->dev
, "Failed to register irq %d\n",
706 goto err_out_free_res
;
709 /* poll Card status change */
710 init_timer(&socket
->poll_timer
);
711 socket
->poll_timer
.function
= pd6729_interrupt_wrapper
;
712 socket
->poll_timer
.data
= (unsigned long)socket
;
713 socket
->poll_timer
.expires
= jiffies
+ HZ
;
714 add_timer(&socket
->poll_timer
);
717 for (i
= 0; i
< MAX_SOCKETS
; i
++) {
718 ret
= pcmcia_register_socket(&socket
[i
].socket
);
720 dev_warn(&dev
->dev
, "pcmcia_register_socket failed.\n");
721 for (j
= 0; j
< i
; j
++)
722 pcmcia_unregister_socket(&socket
[j
].socket
);
723 goto err_out_free_res2
;
731 free_irq(dev
->irq
, socket
);
733 del_timer_sync(&socket
->poll_timer
);
735 pci_release_regions(dev
);
737 pci_disable_device(dev
);
744 static void __devexit
pd6729_pci_remove(struct pci_dev
*dev
)
747 struct pd6729_socket
*socket
= pci_get_drvdata(dev
);
749 for (i
= 0; i
< MAX_SOCKETS
; i
++) {
750 /* Turn off all interrupt sources */
751 indirect_write(&socket
[i
], I365_CSCINT
, 0);
752 indirect_write(&socket
[i
], I365_INTCTL
, 0);
754 pcmcia_unregister_socket(&socket
[i
].socket
);
758 free_irq(dev
->irq
, socket
);
760 del_timer_sync(&socket
->poll_timer
);
761 pci_release_regions(dev
);
762 pci_disable_device(dev
);
767 static struct pci_device_id pd6729_pci_ids
[] = {
769 .vendor
= PCI_VENDOR_ID_CIRRUS
,
770 .device
= PCI_DEVICE_ID_CIRRUS_6729
,
771 .subvendor
= PCI_ANY_ID
,
772 .subdevice
= PCI_ANY_ID
,
776 MODULE_DEVICE_TABLE(pci
, pd6729_pci_ids
);
778 static struct pci_driver pd6729_pci_driver
= {
780 .id_table
= pd6729_pci_ids
,
781 .probe
= pd6729_pci_probe
,
782 .remove
= __devexit_p(pd6729_pci_remove
),
785 static int pd6729_module_init(void)
787 return pci_register_driver(&pd6729_pci_driver
);
790 static void pd6729_module_exit(void)
792 pci_unregister_driver(&pd6729_pci_driver
);
795 module_init(pd6729_module_init
);
796 module_exit(pd6729_module_exit
);