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/types.h>
26 #include <linux/platform_device.h>
30 #include <pcmcia/ss.h>
34 MODULE_DESCRIPTION("NEC VRC4171 Card Controllers driver for Socket Services");
35 MODULE_AUTHOR("Yoichi Yuasa <yoichi_yuasa@tripeaks.co.jp>");
36 MODULE_LICENSE("GPL");
38 #define CARD_MAX_SLOTS 2
41 #define CARD_SLOTB_OFFSET 0x40
43 #define CARD_MEM_START 0x10000000
44 #define CARD_MEM_END 0x13ffffff
45 #define CARD_MAX_MEM_OFFSET 0x3ffffff
46 #define CARD_MAX_MEM_SPEED 1000
48 #define CARD_CONTROLLER_INDEX 0x03e0
49 #define CARD_CONTROLLER_DATA 0x03e1
51 #define VPP_GET_VCC 0x01
52 #define POWER_ENABLE 0x10
53 #define CARD_VOLTAGE_SENSE 0x1f
54 #define VCC_3VORXV_CAPABLE 0x00
55 #define VCC_XV_ONLY 0x01
56 #define VCC_3V_CAPABLE 0x02
57 #define VCC_5V_ONLY 0x03
58 #define CARD_VOLTAGE_SELECT 0x2f
62 #define VCC_STATUS_3V 0x02
63 #define VCC_STATUS_5V 0x01
64 #define VCC_STATUS_XV 0x03
65 #define GLOBAL_CONTROL 0x1e
70 #define INTERRUPT_STATUS 0x05fa
74 #define CONFIGURATION1 0x05fe
75 #define SLOTB_CONFIG 0xc000
76 #define SLOTB_NONE 0x0000
77 #define SLOTB_PCCARD 0x4000
78 #define SLOTB_CF 0x8000
79 #define SLOTB_FLASHROM 0xc000
81 #define CARD_CONTROLLER_START CARD_CONTROLLER_INDEX
82 #define CARD_CONTROLLER_END CARD_CONTROLLER_DATA
85 #define MEM_MAX_MAPS 5
102 typedef struct vrc4171_socket {
104 struct pcmcia_socket pcmcia_socket;
110 static vrc4171_socket_t vrc4171_sockets[CARD_MAX_SLOTS];
111 static vrc4171_slotb_t vrc4171_slotb = SLOTB_IS_NONE;
112 static char vrc4171_card_name[] = "NEC VRC4171 Card Controller";
113 static unsigned int vrc4171_irq;
114 static uint16_t vrc4171_irq_mask = 0xdeb8;
116 static struct resource vrc4171_card_resource[3] = {
117 { .name = vrc4171_card_name,
118 .start = CARD_CONTROLLER_START,
119 .end = CARD_CONTROLLER_END,
120 .flags = IORESOURCE_IO, },
121 { .name = vrc4171_card_name,
122 .start = INTERRUPT_STATUS,
123 .end = INTERRUPT_STATUS,
124 .flags = IORESOURCE_IO, },
125 { .name = vrc4171_card_name,
126 .start = CONFIGURATION1,
127 .end = CONFIGURATION1,
128 .flags = IORESOURCE_IO, },
131 static struct platform_device vrc4171_card_device = {
132 .name = vrc4171_card_name,
135 .resource = vrc4171_card_resource,
138 static inline uint16_t vrc4171_get_irq_status(void)
140 return inw(INTERRUPT_STATUS);
143 static inline void vrc4171_set_multifunction_pin(vrc4171_slotb_t config)
147 config1 = inw(CONFIGURATION1);
148 config1 &= ~SLOTB_CONFIG;
152 config1 |= SLOTB_NONE;
154 case SLOTB_IS_PCCARD:
155 config1 |= SLOTB_PCCARD;
160 case SLOTB_IS_FLASHROM:
161 config1 |= SLOTB_FLASHROM;
167 outw(config1, CONFIGURATION1);
170 static inline uint8_t exca_read_byte(int slot, uint8_t index)
172 if (slot == CARD_SLOTB)
173 index += CARD_SLOTB_OFFSET;
175 outb(index, CARD_CONTROLLER_INDEX);
176 return inb(CARD_CONTROLLER_DATA);
179 static inline uint16_t exca_read_word(int slot, uint8_t index)
183 if (slot == CARD_SLOTB)
184 index += CARD_SLOTB_OFFSET;
186 outb(index++, CARD_CONTROLLER_INDEX);
187 data = inb(CARD_CONTROLLER_DATA);
189 outb(index, CARD_CONTROLLER_INDEX);
190 data |= ((uint16_t)inb(CARD_CONTROLLER_DATA)) << 8;
195 static inline uint8_t exca_write_byte(int slot, uint8_t index, uint8_t data)
197 if (slot == CARD_SLOTB)
198 index += CARD_SLOTB_OFFSET;
200 outb(index, CARD_CONTROLLER_INDEX);
201 outb(data, CARD_CONTROLLER_DATA);
206 static inline uint16_t exca_write_word(int slot, uint8_t index, uint16_t data)
208 if (slot == CARD_SLOTB)
209 index += CARD_SLOTB_OFFSET;
211 outb(index++, CARD_CONTROLLER_INDEX);
212 outb(data, CARD_CONTROLLER_DATA);
214 outb(index, CARD_CONTROLLER_INDEX);
215 outb((uint8_t)(data >> 8), CARD_CONTROLLER_DATA);
220 static inline int search_nonuse_irq(void)
224 for (i = 0; i < 16; i++) {
225 if (vrc4171_irq_mask & (1 << i)) {
226 vrc4171_irq_mask &= ~(1 << i);
234 static int pccard_init(struct pcmcia_socket *sock)
236 vrc4171_socket_t *socket;
239 sock->features |= SS_CAP_PCCARD | SS_CAP_PAGE_REGS;
241 sock->map_size = 0x1000;
242 sock->pci_irq = vrc4171_irq;
245 socket = &vrc4171_sockets[slot];
246 socket->csc_irq = search_nonuse_irq();
247 socket->io_irq = search_nonuse_irq();
252 static int pccard_get_status(struct pcmcia_socket *sock, u_int *value)
255 uint8_t status, sense;
258 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS || value == NULL)
263 status = exca_read_byte(slot, I365_STATUS);
264 if (exca_read_byte(slot, I365_INTCTL) & I365_PC_IOCARD) {
265 if (status & I365_CS_STSCHG)
268 if (!(status & I365_CS_BVD1))
270 else if ((status & (I365_CS_BVD1 | I365_CS_BVD2)) == I365_CS_BVD1)
273 if ((status & I365_CS_DETECT) == I365_CS_DETECT)
275 if (status & I365_CS_WRPROT)
277 if (status & I365_CS_READY)
279 if (status & I365_CS_POWERON)
282 sense = exca_read_byte(slot, CARD_VOLTAGE_SENSE);
284 case VCC_3VORXV_CAPABLE:
285 val |= SS_3VCARD | SS_XVCARD;
303 static inline uint8_t set_Vcc_value(u_char Vcc)
312 /* Small voltage is chosen for safety. */
316 static int pccard_set_socket(struct pcmcia_socket *sock, socket_state_t *state)
318 vrc4171_socket_t *socket;
320 uint8_t voltage, power, control, cscint;
322 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
323 (state->Vpp != state->Vcc && state->Vpp != 0) ||
324 (state->Vcc != 50 && state->Vcc != 33 && state->Vcc != 0))
328 socket = &vrc4171_sockets[slot];
330 spin_lock_irq(&sock->lock);
332 voltage = set_Vcc_value(state->Vcc);
333 exca_write_byte(slot, CARD_VOLTAGE_SELECT, voltage);
335 power = POWER_ENABLE;
336 if (state->Vpp == state->Vcc)
337 power |= VPP_GET_VCC;
338 if (state->flags & SS_OUTPUT_ENA)
339 power |= I365_PWR_OUT;
340 exca_write_byte(slot, I365_POWER, power);
343 if (state->io_irq != 0)
344 control |= socket->io_irq;
345 if (state->flags & SS_IOCARD)
346 control |= I365_PC_IOCARD;
347 if (state->flags & SS_RESET)
348 control &= ~I365_PC_RESET;
350 control |= I365_PC_RESET;
351 exca_write_byte(slot, I365_INTCTL, control);
354 exca_write_byte(slot, I365_CSCINT, cscint);
355 exca_read_byte(slot, I365_CSC); /* clear CardStatus change */
356 if (state->csc_mask != 0)
357 cscint |= socket->csc_irq << 8;
358 if (state->flags & SS_IOCARD) {
359 if (state->csc_mask & SS_STSCHG)
360 cscint |= I365_CSC_STSCHG;
362 if (state->csc_mask & SS_BATDEAD)
363 cscint |= I365_CSC_BVD1;
364 if (state->csc_mask & SS_BATWARN)
365 cscint |= I365_CSC_BVD2;
367 if (state->csc_mask & SS_READY)
368 cscint |= I365_CSC_READY;
369 if (state->csc_mask & SS_DETECT)
370 cscint |= I365_CSC_DETECT;
371 exca_write_byte(slot, I365_CSCINT, cscint);
373 spin_unlock_irq(&sock->lock);
378 static int pccard_set_io_map(struct pcmcia_socket *sock, struct pccard_io_map *io)
381 uint8_t ioctl, addrwin;
384 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
385 io == NULL || io->map >= IO_MAX_MAPS ||
386 io->start > 0xffff || io->stop > 0xffff || io->start > io->stop)
392 addrwin = exca_read_byte(slot, I365_ADDRWIN);
393 if (addrwin & I365_ENA_IO(map)) {
394 addrwin &= ~I365_ENA_IO(map);
395 exca_write_byte(slot, I365_ADDRWIN, addrwin);
398 exca_write_word(slot, I365_IO(map)+I365_W_START, io->start);
399 exca_write_word(slot, I365_IO(map)+I365_W_STOP, io->stop);
403 ioctl |= I365_IOCTL_WAIT(map);
404 if (io->flags & MAP_16BIT)
405 ioctl |= I365_IOCTL_16BIT(map);
406 if (io->flags & MAP_AUTOSZ)
407 ioctl |= I365_IOCTL_IOCS16(map);
408 if (io->flags & MAP_0WS)
409 ioctl |= I365_IOCTL_0WS(map);
410 exca_write_byte(slot, I365_IOCTL, ioctl);
412 if (io->flags & MAP_ACTIVE) {
413 addrwin |= I365_ENA_IO(map);
414 exca_write_byte(slot, I365_ADDRWIN, addrwin);
420 static int pccard_set_mem_map(struct pcmcia_socket *sock, struct pccard_mem_map *mem)
423 uint16_t start, stop, offset;
427 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
428 mem == NULL || mem->map >= MEM_MAX_MAPS ||
429 mem->res->start < CARD_MEM_START || mem->res->start > CARD_MEM_END ||
430 mem->res->end < CARD_MEM_START || mem->res->end > CARD_MEM_END ||
431 mem->res->start > mem->res->end ||
432 mem->card_start > CARD_MAX_MEM_OFFSET ||
433 mem->speed > CARD_MAX_MEM_SPEED)
439 addrwin = exca_read_byte(slot, I365_ADDRWIN);
440 if (addrwin & I365_ENA_MEM(map)) {
441 addrwin &= ~I365_ENA_MEM(map);
442 exca_write_byte(slot, I365_ADDRWIN, addrwin);
445 start = (mem->res->start >> 12) & 0x3fff;
446 if (mem->flags & MAP_16BIT)
447 start |= I365_MEM_16BIT;
448 exca_write_word(slot, I365_MEM(map)+I365_W_START, start);
450 stop = (mem->res->end >> 12) & 0x3fff;
451 switch (mem->speed) {
455 stop |= I365_MEM_WS0;
458 stop |= I365_MEM_WS1;
461 stop |= I365_MEM_WS0 | I365_MEM_WS1;
464 exca_write_word(slot, I365_MEM(map)+I365_W_STOP, stop);
466 offset = (mem->card_start >> 12) & 0x3fff;
467 if (mem->flags & MAP_ATTRIB)
468 offset |= I365_MEM_REG;
469 if (mem->flags & MAP_WRPROT)
470 offset |= I365_MEM_WRPROT;
471 exca_write_word(slot, I365_MEM(map)+I365_W_OFF, offset);
473 if (mem->flags & MAP_ACTIVE) {
474 addrwin |= I365_ENA_MEM(map);
475 exca_write_byte(slot, I365_ADDRWIN, addrwin);
481 static struct pccard_operations vrc4171_pccard_operations = {
483 .get_status = pccard_get_status,
484 .set_socket = pccard_set_socket,
485 .set_io_map = pccard_set_io_map,
486 .set_mem_map = pccard_set_mem_map,
489 static inline unsigned int get_events(int slot)
491 unsigned int events = 0;
494 status = exca_read_byte(slot, I365_STATUS);
495 csc = exca_read_byte(slot, I365_CSC);
497 if (exca_read_byte(slot, I365_INTCTL) & I365_PC_IOCARD) {
498 if ((csc & I365_CSC_STSCHG) && (status & I365_CS_STSCHG))
501 if (csc & (I365_CSC_BVD1 | I365_CSC_BVD2)) {
502 if (!(status & I365_CS_BVD1))
503 events |= SS_BATDEAD;
504 else if ((status & (I365_CS_BVD1 | I365_CS_BVD2)) == I365_CS_BVD1)
505 events |= SS_BATWARN;
508 if ((csc & I365_CSC_READY) && (status & I365_CS_READY))
510 if ((csc & I365_CSC_DETECT) && ((status & I365_CS_DETECT) == I365_CS_DETECT))
516 static irqreturn_t pccard_interrupt(int irq, void *dev_id)
518 vrc4171_socket_t *socket;
520 irqreturn_t retval = IRQ_NONE;
523 status = vrc4171_get_irq_status();
524 if (status & IRQ_A) {
525 socket = &vrc4171_sockets[CARD_SLOTA];
526 if (socket->slot == SLOT_INITIALIZED) {
527 if (status & (1 << socket->csc_irq)) {
528 events = get_events(CARD_SLOTA);
530 pcmcia_parse_events(&socket->pcmcia_socket, events);
531 retval = IRQ_HANDLED;
537 if (status & IRQ_B) {
538 socket = &vrc4171_sockets[CARD_SLOTB];
539 if (socket->slot == SLOT_INITIALIZED) {
540 if (status & (1 << socket->csc_irq)) {
541 events = get_events(CARD_SLOTB);
543 pcmcia_parse_events(&socket->pcmcia_socket, events);
544 retval = IRQ_HANDLED;
553 static inline void reserve_using_irq(int slot)
557 irq = exca_read_byte(slot, I365_INTCTL);
559 vrc4171_irq_mask &= ~(1 << irq);
561 irq = exca_read_byte(slot, I365_CSCINT);
562 irq = (irq & 0xf0) >> 4;
563 vrc4171_irq_mask &= ~(1 << irq);
566 static int __devinit vrc4171_add_sockets(void)
568 vrc4171_socket_t *socket;
571 for (slot = 0; slot < CARD_MAX_SLOTS; slot++) {
572 if (slot == CARD_SLOTB && vrc4171_slotb == SLOTB_IS_NONE)
575 socket = &vrc4171_sockets[slot];
576 if (socket->slot != SLOT_PROBE) {
579 switch (socket->slot) {
580 case SLOT_NOPROBE_MEM:
581 addrwin = exca_read_byte(slot, I365_ADDRWIN);
583 exca_write_byte(slot, I365_ADDRWIN, addrwin);
585 case SLOT_NOPROBE_IO:
586 addrwin = exca_read_byte(slot, I365_ADDRWIN);
588 exca_write_byte(slot, I365_ADDRWIN, addrwin);
594 reserve_using_irq(slot);
598 sprintf(socket->name, "NEC VRC4171 Card Slot %1c", 'A' + slot);
599 socket->pcmcia_socket.dev.dev = &vrc4171_card_device.dev;
600 socket->pcmcia_socket.ops = &vrc4171_pccard_operations;
601 socket->pcmcia_socket.owner = THIS_MODULE;
603 retval = pcmcia_register_socket(&socket->pcmcia_socket);
607 exca_write_byte(slot, I365_ADDRWIN, 0);
608 exca_write_byte(slot, GLOBAL_CONTROL, 0);
610 socket->slot = SLOT_INITIALIZED;
616 static void vrc4171_remove_sockets(void)
618 vrc4171_socket_t *socket;
621 for (slot = 0; slot < CARD_MAX_SLOTS; slot++) {
622 if (slot == CARD_SLOTB && vrc4171_slotb == SLOTB_IS_NONE)
625 socket = &vrc4171_sockets[slot];
626 if (socket->slot == SLOT_INITIALIZED)
627 pcmcia_unregister_socket(&socket->pcmcia_socket);
629 socket->slot = SLOT_PROBE;
633 static int __devinit vrc4171_card_setup(char *options)
635 if (options == NULL || *options == '\0')
638 if (strncmp(options, "irq:", 4) == 0) {
641 irq = simple_strtoul(options, &options, 0);
642 if (irq >= 0 && irq < NR_IRQS)
650 if (strncmp(options, "slota:", 6) == 0) {
652 if (*options != '\0') {
653 if (strncmp(options, "memnoprobe", 10) == 0) {
654 vrc4171_sockets[CARD_SLOTA].slot = SLOT_NOPROBE_MEM;
656 } else if (strncmp(options, "ionoprobe", 9) == 0) {
657 vrc4171_sockets[CARD_SLOTA].slot = SLOT_NOPROBE_IO;
659 } else if ( strncmp(options, "noprobe", 7) == 0) {
660 vrc4171_sockets[CARD_SLOTA].slot = SLOT_NOPROBE_ALL;
672 if (strncmp(options, "slotb:", 6) == 0) {
674 if (*options != '\0') {
675 if (strncmp(options, "pccard", 6) == 0) {
676 vrc4171_slotb = SLOTB_IS_PCCARD;
678 } else if (strncmp(options, "cf", 2) == 0) {
679 vrc4171_slotb = SLOTB_IS_CF;
681 } else if (strncmp(options, "flashrom", 8) == 0) {
682 vrc4171_slotb = SLOTB_IS_FLASHROM;
684 } else if (strncmp(options, "none", 4) == 0) {
685 vrc4171_slotb = SLOTB_IS_NONE;
693 if (strncmp(options, "memnoprobe", 10) == 0)
694 vrc4171_sockets[CARD_SLOTB].slot = SLOT_NOPROBE_MEM;
695 if (strncmp(options, "ionoprobe", 9) == 0)
696 vrc4171_sockets[CARD_SLOTB].slot = SLOT_NOPROBE_IO;
697 if (strncmp(options, "noprobe", 7) == 0)
698 vrc4171_sockets[CARD_SLOTB].slot = SLOT_NOPROBE_ALL;
705 __setup("vrc4171_card=", vrc4171_card_setup);
707 static struct device_driver vrc4171_card_driver = {
708 .name = vrc4171_card_name,
709 .bus = &platform_bus_type,
710 .suspend = pcmcia_socket_dev_suspend,
711 .resume = pcmcia_socket_dev_resume,
714 static int __devinit vrc4171_card_init(void)
718 retval = driver_register(&vrc4171_card_driver);
722 retval = platform_device_register(&vrc4171_card_device);
724 driver_unregister(&vrc4171_card_driver);
728 vrc4171_set_multifunction_pin(vrc4171_slotb);
730 retval = vrc4171_add_sockets();
732 retval = request_irq(vrc4171_irq, pccard_interrupt, IRQF_SHARED,
733 vrc4171_card_name, vrc4171_sockets);
736 vrc4171_remove_sockets();
737 platform_device_unregister(&vrc4171_card_device);
738 driver_unregister(&vrc4171_card_driver);
742 printk(KERN_INFO "%s, connected to IRQ %d\n", vrc4171_card_driver.name, vrc4171_irq);
747 static void __devexit vrc4171_card_exit(void)
749 free_irq(vrc4171_irq, vrc4171_sockets);
750 vrc4171_remove_sockets();
751 platform_device_unregister(&vrc4171_card_device);
752 driver_unregister(&vrc4171_card_driver);
755 module_init(vrc4171_card_init);
756 module_exit(vrc4171_card_exit);