2 * vrc4171_card.c, NEC VRC4171 Card Controller driver for Socket Services.
4 * Copyright (C) 2003-2005 Yoichi Yuasa <yoichi_yuasa@tripeaks.co.jp>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/init.h>
21 #include <linux/ioport.h>
22 #include <linux/interrupt.h>
23 #include <linux/module.h>
24 #include <linux/spinlock.h>
25 #include <linux/sched.h>
26 #include <linux/types.h>
27 #include <linux/platform_device.h>
31 #include <pcmcia/ss.h>
35 MODULE_DESCRIPTION("NEC VRC4171 Card Controllers driver for Socket Services");
36 MODULE_AUTHOR("Yoichi Yuasa <yoichi_yuasa@tripeaks.co.jp>");
37 MODULE_LICENSE("GPL");
39 #define CARD_MAX_SLOTS 2
42 #define CARD_SLOTB_OFFSET 0x40
44 #define CARD_MEM_START 0x10000000
45 #define CARD_MEM_END 0x13ffffff
46 #define CARD_MAX_MEM_OFFSET 0x3ffffff
47 #define CARD_MAX_MEM_SPEED 1000
49 #define CARD_CONTROLLER_INDEX 0x03e0
50 #define CARD_CONTROLLER_DATA 0x03e1
52 #define VPP_GET_VCC 0x01
53 #define POWER_ENABLE 0x10
54 #define CARD_VOLTAGE_SENSE 0x1f
55 #define VCC_3VORXV_CAPABLE 0x00
56 #define VCC_XV_ONLY 0x01
57 #define VCC_3V_CAPABLE 0x02
58 #define VCC_5V_ONLY 0x03
59 #define CARD_VOLTAGE_SELECT 0x2f
63 #define VCC_STATUS_3V 0x02
64 #define VCC_STATUS_5V 0x01
65 #define VCC_STATUS_XV 0x03
66 #define GLOBAL_CONTROL 0x1e
71 #define INTERRUPT_STATUS 0x05fa
75 #define CONFIGURATION1 0x05fe
76 #define SLOTB_CONFIG 0xc000
77 #define SLOTB_NONE 0x0000
78 #define SLOTB_PCCARD 0x4000
79 #define SLOTB_CF 0x8000
80 #define SLOTB_FLASHROM 0xc000
82 #define CARD_CONTROLLER_START CARD_CONTROLLER_INDEX
83 #define CARD_CONTROLLER_END CARD_CONTROLLER_DATA
86 #define MEM_MAX_MAPS 5
103 typedef struct vrc4171_socket
{
105 struct pcmcia_socket pcmcia_socket
;
111 static vrc4171_socket_t vrc4171_sockets
[CARD_MAX_SLOTS
];
112 static vrc4171_slotb_t vrc4171_slotb
= SLOTB_IS_NONE
;
113 static char vrc4171_card_name
[] = "NEC VRC4171 Card Controller";
114 static unsigned int vrc4171_irq
;
115 static uint16_t vrc4171_irq_mask
= 0xdeb8;
117 static struct resource vrc4171_card_resource
[3] = {
118 { .name
= vrc4171_card_name
,
119 .start
= CARD_CONTROLLER_START
,
120 .end
= CARD_CONTROLLER_END
,
121 .flags
= IORESOURCE_IO
, },
122 { .name
= vrc4171_card_name
,
123 .start
= INTERRUPT_STATUS
,
124 .end
= INTERRUPT_STATUS
,
125 .flags
= IORESOURCE_IO
, },
126 { .name
= vrc4171_card_name
,
127 .start
= CONFIGURATION1
,
128 .end
= CONFIGURATION1
,
129 .flags
= IORESOURCE_IO
, },
132 static struct platform_device vrc4171_card_device
= {
133 .name
= vrc4171_card_name
,
136 .resource
= vrc4171_card_resource
,
139 static inline uint16_t vrc4171_get_irq_status(void)
141 return inw(INTERRUPT_STATUS
);
144 static inline void vrc4171_set_multifunction_pin(vrc4171_slotb_t config
)
148 config1
= inw(CONFIGURATION1
);
149 config1
&= ~SLOTB_CONFIG
;
153 config1
|= SLOTB_NONE
;
155 case SLOTB_IS_PCCARD
:
156 config1
|= SLOTB_PCCARD
;
161 case SLOTB_IS_FLASHROM
:
162 config1
|= SLOTB_FLASHROM
;
168 outw(config1
, CONFIGURATION1
);
171 static inline uint8_t exca_read_byte(int slot
, uint8_t index
)
173 if (slot
== CARD_SLOTB
)
174 index
+= CARD_SLOTB_OFFSET
;
176 outb(index
, CARD_CONTROLLER_INDEX
);
177 return inb(CARD_CONTROLLER_DATA
);
180 static inline uint16_t exca_read_word(int slot
, uint8_t index
)
184 if (slot
== CARD_SLOTB
)
185 index
+= CARD_SLOTB_OFFSET
;
187 outb(index
++, CARD_CONTROLLER_INDEX
);
188 data
= inb(CARD_CONTROLLER_DATA
);
190 outb(index
, CARD_CONTROLLER_INDEX
);
191 data
|= ((uint16_t)inb(CARD_CONTROLLER_DATA
)) << 8;
196 static inline uint8_t exca_write_byte(int slot
, uint8_t index
, uint8_t data
)
198 if (slot
== CARD_SLOTB
)
199 index
+= CARD_SLOTB_OFFSET
;
201 outb(index
, CARD_CONTROLLER_INDEX
);
202 outb(data
, CARD_CONTROLLER_DATA
);
207 static inline uint16_t exca_write_word(int slot
, uint8_t index
, uint16_t data
)
209 if (slot
== CARD_SLOTB
)
210 index
+= CARD_SLOTB_OFFSET
;
212 outb(index
++, CARD_CONTROLLER_INDEX
);
213 outb(data
, CARD_CONTROLLER_DATA
);
215 outb(index
, CARD_CONTROLLER_INDEX
);
216 outb((uint8_t)(data
>> 8), CARD_CONTROLLER_DATA
);
221 static inline int search_nonuse_irq(void)
225 for (i
= 0; i
< 16; i
++) {
226 if (vrc4171_irq_mask
& (1 << i
)) {
227 vrc4171_irq_mask
&= ~(1 << i
);
235 static int pccard_init(struct pcmcia_socket
*sock
)
237 vrc4171_socket_t
*socket
;
240 sock
->features
|= SS_CAP_PCCARD
| SS_CAP_PAGE_REGS
;
242 sock
->map_size
= 0x1000;
243 sock
->pci_irq
= vrc4171_irq
;
246 socket
= &vrc4171_sockets
[slot
];
247 socket
->csc_irq
= search_nonuse_irq();
248 socket
->io_irq
= search_nonuse_irq();
253 static int pccard_get_status(struct pcmcia_socket
*sock
, u_int
*value
)
256 uint8_t status
, sense
;
259 if (sock
== NULL
|| sock
->sock
>= CARD_MAX_SLOTS
|| value
== NULL
)
264 status
= exca_read_byte(slot
, I365_STATUS
);
265 if (exca_read_byte(slot
, I365_INTCTL
) & I365_PC_IOCARD
) {
266 if (status
& I365_CS_STSCHG
)
269 if (!(status
& I365_CS_BVD1
))
271 else if ((status
& (I365_CS_BVD1
| I365_CS_BVD2
)) == I365_CS_BVD1
)
274 if ((status
& I365_CS_DETECT
) == I365_CS_DETECT
)
276 if (status
& I365_CS_WRPROT
)
278 if (status
& I365_CS_READY
)
280 if (status
& I365_CS_POWERON
)
283 sense
= exca_read_byte(slot
, CARD_VOLTAGE_SENSE
);
285 case VCC_3VORXV_CAPABLE
:
286 val
|= SS_3VCARD
| SS_XVCARD
;
304 static inline uint8_t set_Vcc_value(u_char Vcc
)
313 /* Small voltage is chosen for safety. */
317 static int pccard_set_socket(struct pcmcia_socket
*sock
, socket_state_t
*state
)
319 vrc4171_socket_t
*socket
;
321 uint8_t voltage
, power
, control
, cscint
;
323 if (sock
== NULL
|| sock
->sock
>= CARD_MAX_SLOTS
||
324 (state
->Vpp
!= state
->Vcc
&& state
->Vpp
!= 0) ||
325 (state
->Vcc
!= 50 && state
->Vcc
!= 33 && state
->Vcc
!= 0))
329 socket
= &vrc4171_sockets
[slot
];
331 spin_lock_irq(&sock
->lock
);
333 voltage
= set_Vcc_value(state
->Vcc
);
334 exca_write_byte(slot
, CARD_VOLTAGE_SELECT
, voltage
);
336 power
= POWER_ENABLE
;
337 if (state
->Vpp
== state
->Vcc
)
338 power
|= VPP_GET_VCC
;
339 if (state
->flags
& SS_OUTPUT_ENA
)
340 power
|= I365_PWR_OUT
;
341 exca_write_byte(slot
, I365_POWER
, power
);
344 if (state
->io_irq
!= 0)
345 control
|= socket
->io_irq
;
346 if (state
->flags
& SS_IOCARD
)
347 control
|= I365_PC_IOCARD
;
348 if (state
->flags
& SS_RESET
)
349 control
&= ~I365_PC_RESET
;
351 control
|= I365_PC_RESET
;
352 exca_write_byte(slot
, I365_INTCTL
, control
);
355 exca_write_byte(slot
, I365_CSCINT
, cscint
);
356 exca_read_byte(slot
, I365_CSC
); /* clear CardStatus change */
357 if (state
->csc_mask
!= 0)
358 cscint
|= socket
->csc_irq
<< 8;
359 if (state
->flags
& SS_IOCARD
) {
360 if (state
->csc_mask
& SS_STSCHG
)
361 cscint
|= I365_CSC_STSCHG
;
363 if (state
->csc_mask
& SS_BATDEAD
)
364 cscint
|= I365_CSC_BVD1
;
365 if (state
->csc_mask
& SS_BATWARN
)
366 cscint
|= I365_CSC_BVD2
;
368 if (state
->csc_mask
& SS_READY
)
369 cscint
|= I365_CSC_READY
;
370 if (state
->csc_mask
& SS_DETECT
)
371 cscint
|= I365_CSC_DETECT
;
372 exca_write_byte(slot
, I365_CSCINT
, cscint
);
374 spin_unlock_irq(&sock
->lock
);
379 static int pccard_set_io_map(struct pcmcia_socket
*sock
, struct pccard_io_map
*io
)
382 uint8_t ioctl
, addrwin
;
385 if (sock
== NULL
|| sock
->sock
>= CARD_MAX_SLOTS
||
386 io
== NULL
|| io
->map
>= IO_MAX_MAPS
||
387 io
->start
> 0xffff || io
->stop
> 0xffff || io
->start
> io
->stop
)
393 addrwin
= exca_read_byte(slot
, I365_ADDRWIN
);
394 if (addrwin
& I365_ENA_IO(map
)) {
395 addrwin
&= ~I365_ENA_IO(map
);
396 exca_write_byte(slot
, I365_ADDRWIN
, addrwin
);
399 exca_write_word(slot
, I365_IO(map
)+I365_W_START
, io
->start
);
400 exca_write_word(slot
, I365_IO(map
)+I365_W_STOP
, io
->stop
);
404 ioctl
|= I365_IOCTL_WAIT(map
);
405 if (io
->flags
& MAP_16BIT
)
406 ioctl
|= I365_IOCTL_16BIT(map
);
407 if (io
->flags
& MAP_AUTOSZ
)
408 ioctl
|= I365_IOCTL_IOCS16(map
);
409 if (io
->flags
& MAP_0WS
)
410 ioctl
|= I365_IOCTL_0WS(map
);
411 exca_write_byte(slot
, I365_IOCTL
, ioctl
);
413 if (io
->flags
& MAP_ACTIVE
) {
414 addrwin
|= I365_ENA_IO(map
);
415 exca_write_byte(slot
, I365_ADDRWIN
, addrwin
);
421 static int pccard_set_mem_map(struct pcmcia_socket
*sock
, struct pccard_mem_map
*mem
)
424 uint16_t start
, stop
, offset
;
428 if (sock
== NULL
|| sock
->sock
>= CARD_MAX_SLOTS
||
429 mem
== NULL
|| mem
->map
>= MEM_MAX_MAPS
||
430 mem
->res
->start
< CARD_MEM_START
|| mem
->res
->start
> CARD_MEM_END
||
431 mem
->res
->end
< CARD_MEM_START
|| mem
->res
->end
> CARD_MEM_END
||
432 mem
->res
->start
> mem
->res
->end
||
433 mem
->card_start
> CARD_MAX_MEM_OFFSET
||
434 mem
->speed
> CARD_MAX_MEM_SPEED
)
440 addrwin
= exca_read_byte(slot
, I365_ADDRWIN
);
441 if (addrwin
& I365_ENA_MEM(map
)) {
442 addrwin
&= ~I365_ENA_MEM(map
);
443 exca_write_byte(slot
, I365_ADDRWIN
, addrwin
);
446 start
= (mem
->res
->start
>> 12) & 0x3fff;
447 if (mem
->flags
& MAP_16BIT
)
448 start
|= I365_MEM_16BIT
;
449 exca_write_word(slot
, I365_MEM(map
)+I365_W_START
, start
);
451 stop
= (mem
->res
->end
>> 12) & 0x3fff;
452 switch (mem
->speed
) {
456 stop
|= I365_MEM_WS0
;
459 stop
|= I365_MEM_WS1
;
462 stop
|= I365_MEM_WS0
| I365_MEM_WS1
;
465 exca_write_word(slot
, I365_MEM(map
)+I365_W_STOP
, stop
);
467 offset
= (mem
->card_start
>> 12) & 0x3fff;
468 if (mem
->flags
& MAP_ATTRIB
)
469 offset
|= I365_MEM_REG
;
470 if (mem
->flags
& MAP_WRPROT
)
471 offset
|= I365_MEM_WRPROT
;
472 exca_write_word(slot
, I365_MEM(map
)+I365_W_OFF
, offset
);
474 if (mem
->flags
& MAP_ACTIVE
) {
475 addrwin
|= I365_ENA_MEM(map
);
476 exca_write_byte(slot
, I365_ADDRWIN
, addrwin
);
482 static struct pccard_operations vrc4171_pccard_operations
= {
484 .get_status
= pccard_get_status
,
485 .set_socket
= pccard_set_socket
,
486 .set_io_map
= pccard_set_io_map
,
487 .set_mem_map
= pccard_set_mem_map
,
490 static inline unsigned int get_events(int slot
)
492 unsigned int events
= 0;
495 status
= exca_read_byte(slot
, I365_STATUS
);
496 csc
= exca_read_byte(slot
, I365_CSC
);
498 if (exca_read_byte(slot
, I365_INTCTL
) & I365_PC_IOCARD
) {
499 if ((csc
& I365_CSC_STSCHG
) && (status
& I365_CS_STSCHG
))
502 if (csc
& (I365_CSC_BVD1
| I365_CSC_BVD2
)) {
503 if (!(status
& I365_CS_BVD1
))
504 events
|= SS_BATDEAD
;
505 else if ((status
& (I365_CS_BVD1
| I365_CS_BVD2
)) == I365_CS_BVD1
)
506 events
|= SS_BATWARN
;
509 if ((csc
& I365_CSC_READY
) && (status
& I365_CS_READY
))
511 if ((csc
& I365_CSC_DETECT
) && ((status
& I365_CS_DETECT
) == I365_CS_DETECT
))
517 static irqreturn_t
pccard_interrupt(int irq
, void *dev_id
, struct pt_regs
*regs
)
519 vrc4171_socket_t
*socket
;
521 irqreturn_t retval
= IRQ_NONE
;
524 status
= vrc4171_get_irq_status();
525 if (status
& IRQ_A
) {
526 socket
= &vrc4171_sockets
[CARD_SLOTA
];
527 if (socket
->slot
== SLOT_INITIALIZED
) {
528 if (status
& (1 << socket
->csc_irq
)) {
529 events
= get_events(CARD_SLOTA
);
531 pcmcia_parse_events(&socket
->pcmcia_socket
, events
);
532 retval
= IRQ_HANDLED
;
538 if (status
& IRQ_B
) {
539 socket
= &vrc4171_sockets
[CARD_SLOTB
];
540 if (socket
->slot
== SLOT_INITIALIZED
) {
541 if (status
& (1 << socket
->csc_irq
)) {
542 events
= get_events(CARD_SLOTB
);
544 pcmcia_parse_events(&socket
->pcmcia_socket
, events
);
545 retval
= IRQ_HANDLED
;
554 static inline void reserve_using_irq(int slot
)
558 irq
= exca_read_byte(slot
, I365_INTCTL
);
560 vrc4171_irq_mask
&= ~(1 << irq
);
562 irq
= exca_read_byte(slot
, I365_CSCINT
);
563 irq
= (irq
& 0xf0) >> 4;
564 vrc4171_irq_mask
&= ~(1 << irq
);
567 static int __devinit
vrc4171_add_sockets(void)
569 vrc4171_socket_t
*socket
;
572 for (slot
= 0; slot
< CARD_MAX_SLOTS
; slot
++) {
573 if (slot
== CARD_SLOTB
&& vrc4171_slotb
== SLOTB_IS_NONE
)
576 socket
= &vrc4171_sockets
[slot
];
577 if (socket
->slot
!= SLOT_PROBE
) {
580 switch (socket
->slot
) {
581 case SLOT_NOPROBE_MEM
:
582 addrwin
= exca_read_byte(slot
, I365_ADDRWIN
);
584 exca_write_byte(slot
, I365_ADDRWIN
, addrwin
);
586 case SLOT_NOPROBE_IO
:
587 addrwin
= exca_read_byte(slot
, I365_ADDRWIN
);
589 exca_write_byte(slot
, I365_ADDRWIN
, addrwin
);
595 reserve_using_irq(slot
);
599 sprintf(socket
->name
, "NEC VRC4171 Card Slot %1c", 'A' + slot
);
600 socket
->pcmcia_socket
.dev
.dev
= &vrc4171_card_device
.dev
;
601 socket
->pcmcia_socket
.ops
= &vrc4171_pccard_operations
;
602 socket
->pcmcia_socket
.owner
= THIS_MODULE
;
604 retval
= pcmcia_register_socket(&socket
->pcmcia_socket
);
608 exca_write_byte(slot
, I365_ADDRWIN
, 0);
609 exca_write_byte(slot
, GLOBAL_CONTROL
, 0);
611 socket
->slot
= SLOT_INITIALIZED
;
617 static void vrc4171_remove_sockets(void)
619 vrc4171_socket_t
*socket
;
622 for (slot
= 0; slot
< CARD_MAX_SLOTS
; slot
++) {
623 if (slot
== CARD_SLOTB
&& vrc4171_slotb
== SLOTB_IS_NONE
)
626 socket
= &vrc4171_sockets
[slot
];
627 if (socket
->slot
== SLOT_INITIALIZED
)
628 pcmcia_unregister_socket(&socket
->pcmcia_socket
);
630 socket
->slot
= SLOT_PROBE
;
634 static int __devinit
vrc4171_card_setup(char *options
)
636 if (options
== NULL
|| *options
== '\0')
639 if (strncmp(options
, "irq:", 4) == 0) {
642 irq
= simple_strtoul(options
, &options
, 0);
643 if (irq
>= 0 && irq
< NR_IRQS
)
651 if (strncmp(options
, "slota:", 6) == 0) {
653 if (*options
!= '\0') {
654 if (strncmp(options
, "memnoprobe", 10) == 0) {
655 vrc4171_sockets
[CARD_SLOTA
].slot
= SLOT_NOPROBE_MEM
;
657 } else if (strncmp(options
, "ionoprobe", 9) == 0) {
658 vrc4171_sockets
[CARD_SLOTA
].slot
= SLOT_NOPROBE_IO
;
660 } else if ( strncmp(options
, "noprobe", 7) == 0) {
661 vrc4171_sockets
[CARD_SLOTA
].slot
= SLOT_NOPROBE_ALL
;
673 if (strncmp(options
, "slotb:", 6) == 0) {
675 if (*options
!= '\0') {
676 if (strncmp(options
, "pccard", 6) == 0) {
677 vrc4171_slotb
= SLOTB_IS_PCCARD
;
679 } else if (strncmp(options
, "cf", 2) == 0) {
680 vrc4171_slotb
= SLOTB_IS_CF
;
682 } else if (strncmp(options
, "flashrom", 8) == 0) {
683 vrc4171_slotb
= SLOTB_IS_FLASHROM
;
685 } else if (strncmp(options
, "none", 4) == 0) {
686 vrc4171_slotb
= SLOTB_IS_NONE
;
694 if (strncmp(options
, "memnoprobe", 10) == 0)
695 vrc4171_sockets
[CARD_SLOTB
].slot
= SLOT_NOPROBE_MEM
;
696 if (strncmp(options
, "ionoprobe", 9) == 0)
697 vrc4171_sockets
[CARD_SLOTB
].slot
= SLOT_NOPROBE_IO
;
698 if (strncmp(options
, "noprobe", 7) == 0)
699 vrc4171_sockets
[CARD_SLOTB
].slot
= SLOT_NOPROBE_ALL
;
706 __setup("vrc4171_card=", vrc4171_card_setup
);
708 static struct device_driver vrc4171_card_driver
= {
709 .name
= vrc4171_card_name
,
710 .bus
= &platform_bus_type
,
711 .suspend
= pcmcia_socket_dev_suspend
,
712 .resume
= pcmcia_socket_dev_resume
,
715 static int __devinit
vrc4171_card_init(void)
719 retval
= driver_register(&vrc4171_card_driver
);
723 retval
= platform_device_register(&vrc4171_card_device
);
725 driver_unregister(&vrc4171_card_driver
);
729 vrc4171_set_multifunction_pin(vrc4171_slotb
);
731 retval
= vrc4171_add_sockets();
733 retval
= request_irq(vrc4171_irq
, pccard_interrupt
, IRQF_SHARED
,
734 vrc4171_card_name
, vrc4171_sockets
);
737 vrc4171_remove_sockets();
738 platform_device_unregister(&vrc4171_card_device
);
739 driver_unregister(&vrc4171_card_driver
);
743 printk(KERN_INFO
"%s, connected to IRQ %d\n", vrc4171_card_driver
.name
, vrc4171_irq
);
748 static void __devexit
vrc4171_card_exit(void)
750 free_irq(vrc4171_irq
, vrc4171_sockets
);
751 vrc4171_remove_sockets();
752 platform_device_unregister(&vrc4171_card_device
);
753 driver_unregister(&vrc4171_card_driver
);
756 module_init(vrc4171_card_init
);
757 module_exit(vrc4171_card_exit
);