2 * vrc4171_card.c, NEC VRC4171 Card Controller driver for Socket Services.
4 * Copyright (C) 2003-2005 Yoichi Yuasa <yuasa@linux-mips.org>
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 <yuasa@linux-mips.org>");
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;
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();
249 spin_lock_init(&socket->lock);
254 static int pccard_get_status(struct pcmcia_socket *sock, u_int *value)
257 uint8_t status, sense;
260 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS || value == NULL)
265 status = exca_read_byte(slot, I365_STATUS);
266 if (exca_read_byte(slot, I365_INTCTL) & I365_PC_IOCARD) {
267 if (status & I365_CS_STSCHG)
270 if (!(status & I365_CS_BVD1))
272 else if ((status & (I365_CS_BVD1 | I365_CS_BVD2)) == I365_CS_BVD1)
275 if ((status & I365_CS_DETECT) == I365_CS_DETECT)
277 if (status & I365_CS_WRPROT)
279 if (status & I365_CS_READY)
281 if (status & I365_CS_POWERON)
284 sense = exca_read_byte(slot, CARD_VOLTAGE_SENSE);
286 case VCC_3VORXV_CAPABLE:
287 val |= SS_3VCARD | SS_XVCARD;
305 static inline uint8_t set_Vcc_value(u_char Vcc)
314 /* Small voltage is chosen for safety. */
318 static int pccard_set_socket(struct pcmcia_socket *sock, socket_state_t *state)
320 vrc4171_socket_t *socket;
322 uint8_t voltage, power, control, cscint;
324 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
325 (state->Vpp != state->Vcc && state->Vpp != 0) ||
326 (state->Vcc != 50 && state->Vcc != 33 && state->Vcc != 0))
330 socket = &vrc4171_sockets[slot];
332 spin_lock_irq(&socket->lock);
334 voltage = set_Vcc_value(state->Vcc);
335 exca_write_byte(slot, CARD_VOLTAGE_SELECT, voltage);
337 power = POWER_ENABLE;
338 if (state->Vpp == state->Vcc)
339 power |= VPP_GET_VCC;
340 if (state->flags & SS_OUTPUT_ENA)
341 power |= I365_PWR_OUT;
342 exca_write_byte(slot, I365_POWER, power);
345 if (state->io_irq != 0)
346 control |= socket->io_irq;
347 if (state->flags & SS_IOCARD)
348 control |= I365_PC_IOCARD;
349 if (state->flags & SS_RESET)
350 control &= ~I365_PC_RESET;
352 control |= I365_PC_RESET;
353 exca_write_byte(slot, I365_INTCTL, control);
356 exca_write_byte(slot, I365_CSCINT, cscint);
357 exca_read_byte(slot, I365_CSC); /* clear CardStatus change */
358 if (state->csc_mask != 0)
359 cscint |= socket->csc_irq << 8;
360 if (state->flags & SS_IOCARD) {
361 if (state->csc_mask & SS_STSCHG)
362 cscint |= I365_CSC_STSCHG;
364 if (state->csc_mask & SS_BATDEAD)
365 cscint |= I365_CSC_BVD1;
366 if (state->csc_mask & SS_BATWARN)
367 cscint |= I365_CSC_BVD2;
369 if (state->csc_mask & SS_READY)
370 cscint |= I365_CSC_READY;
371 if (state->csc_mask & SS_DETECT)
372 cscint |= I365_CSC_DETECT;
373 exca_write_byte(slot, I365_CSCINT, cscint);
375 spin_unlock_irq(&socket->lock);
380 static int pccard_set_io_map(struct pcmcia_socket *sock, struct pccard_io_map *io)
383 uint8_t ioctl, addrwin;
386 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
387 io == NULL || io->map >= IO_MAX_MAPS ||
388 io->start > 0xffff || io->stop > 0xffff || io->start > io->stop)
394 addrwin = exca_read_byte(slot, I365_ADDRWIN);
395 if (addrwin & I365_ENA_IO(map)) {
396 addrwin &= ~I365_ENA_IO(map);
397 exca_write_byte(slot, I365_ADDRWIN, addrwin);
400 exca_write_word(slot, I365_IO(map)+I365_W_START, io->start);
401 exca_write_word(slot, I365_IO(map)+I365_W_STOP, io->stop);
405 ioctl |= I365_IOCTL_WAIT(map);
406 if (io->flags & MAP_16BIT)
407 ioctl |= I365_IOCTL_16BIT(map);
408 if (io->flags & MAP_AUTOSZ)
409 ioctl |= I365_IOCTL_IOCS16(map);
410 if (io->flags & MAP_0WS)
411 ioctl |= I365_IOCTL_0WS(map);
412 exca_write_byte(slot, I365_IOCTL, ioctl);
414 if (io->flags & MAP_ACTIVE) {
415 addrwin |= I365_ENA_IO(map);
416 exca_write_byte(slot, I365_ADDRWIN, addrwin);
422 static int pccard_set_mem_map(struct pcmcia_socket *sock, struct pccard_mem_map *mem)
425 uint16_t start, stop, offset;
429 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
430 mem == NULL || mem->map >= MEM_MAX_MAPS ||
431 mem->res->start < CARD_MEM_START || mem->res->start > CARD_MEM_END ||
432 mem->res->end < CARD_MEM_START || mem->res->end > CARD_MEM_END ||
433 mem->res->start > mem->res->end ||
434 mem->card_start > CARD_MAX_MEM_OFFSET ||
435 mem->speed > CARD_MAX_MEM_SPEED)
441 addrwin = exca_read_byte(slot, I365_ADDRWIN);
442 if (addrwin & I365_ENA_MEM(map)) {
443 addrwin &= ~I365_ENA_MEM(map);
444 exca_write_byte(slot, I365_ADDRWIN, addrwin);
447 start = (mem->res->start >> 12) & 0x3fff;
448 if (mem->flags & MAP_16BIT)
449 start |= I365_MEM_16BIT;
450 exca_write_word(slot, I365_MEM(map)+I365_W_START, start);
452 stop = (mem->res->end >> 12) & 0x3fff;
453 switch (mem->speed) {
457 stop |= I365_MEM_WS0;
460 stop |= I365_MEM_WS1;
463 stop |= I365_MEM_WS0 | I365_MEM_WS1;
466 exca_write_word(slot, I365_MEM(map)+I365_W_STOP, stop);
468 offset = (mem->card_start >> 12) & 0x3fff;
469 if (mem->flags & MAP_ATTRIB)
470 offset |= I365_MEM_REG;
471 if (mem->flags & MAP_WRPROT)
472 offset |= I365_MEM_WRPROT;
473 exca_write_word(slot, I365_MEM(map)+I365_W_OFF, offset);
475 if (mem->flags & MAP_ACTIVE) {
476 addrwin |= I365_ENA_MEM(map);
477 exca_write_byte(slot, I365_ADDRWIN, addrwin);
483 static struct pccard_operations vrc4171_pccard_operations = {
485 .get_status = pccard_get_status,
486 .set_socket = pccard_set_socket,
487 .set_io_map = pccard_set_io_map,
488 .set_mem_map = pccard_set_mem_map,
491 static inline unsigned int get_events(int slot)
493 unsigned int events = 0;
496 status = exca_read_byte(slot, I365_STATUS);
497 csc = exca_read_byte(slot, I365_CSC);
499 if (exca_read_byte(slot, I365_INTCTL) & I365_PC_IOCARD) {
500 if ((csc & I365_CSC_STSCHG) && (status & I365_CS_STSCHG))
503 if (csc & (I365_CSC_BVD1 | I365_CSC_BVD2)) {
504 if (!(status & I365_CS_BVD1))
505 events |= SS_BATDEAD;
506 else if ((status & (I365_CS_BVD1 | I365_CS_BVD2)) == I365_CS_BVD1)
507 events |= SS_BATWARN;
510 if ((csc & I365_CSC_READY) && (status & I365_CS_READY))
512 if ((csc & I365_CSC_DETECT) && ((status & I365_CS_DETECT) == I365_CS_DETECT))
518 static irqreturn_t pccard_interrupt(int irq, void *dev_id)
520 vrc4171_socket_t *socket;
522 irqreturn_t retval = IRQ_NONE;
525 status = vrc4171_get_irq_status();
526 if (status & IRQ_A) {
527 socket = &vrc4171_sockets[CARD_SLOTA];
528 if (socket->slot == SLOT_INITIALIZED) {
529 if (status & (1 << socket->csc_irq)) {
530 events = get_events(CARD_SLOTA);
532 pcmcia_parse_events(&socket->pcmcia_socket, events);
533 retval = IRQ_HANDLED;
539 if (status & IRQ_B) {
540 socket = &vrc4171_sockets[CARD_SLOTB];
541 if (socket->slot == SLOT_INITIALIZED) {
542 if (status & (1 << socket->csc_irq)) {
543 events = get_events(CARD_SLOTB);
545 pcmcia_parse_events(&socket->pcmcia_socket, events);
546 retval = IRQ_HANDLED;
555 static inline void reserve_using_irq(int slot)
559 irq = exca_read_byte(slot, I365_INTCTL);
561 vrc4171_irq_mask &= ~(1 << irq);
563 irq = exca_read_byte(slot, I365_CSCINT);
564 irq = (irq & 0xf0) >> 4;
565 vrc4171_irq_mask &= ~(1 << irq);
568 static int vrc4171_add_sockets(void)
570 vrc4171_socket_t *socket;
573 for (slot = 0; slot < CARD_MAX_SLOTS; slot++) {
574 if (slot == CARD_SLOTB && vrc4171_slotb == SLOTB_IS_NONE)
577 socket = &vrc4171_sockets[slot];
578 if (socket->slot != SLOT_PROBE) {
581 switch (socket->slot) {
582 case SLOT_NOPROBE_MEM:
583 addrwin = exca_read_byte(slot, I365_ADDRWIN);
585 exca_write_byte(slot, I365_ADDRWIN, addrwin);
587 case SLOT_NOPROBE_IO:
588 addrwin = exca_read_byte(slot, I365_ADDRWIN);
590 exca_write_byte(slot, I365_ADDRWIN, addrwin);
596 reserve_using_irq(slot);
600 sprintf(socket->name, "NEC VRC4171 Card Slot %1c", 'A' + slot);
601 socket->pcmcia_socket.dev.parent = &vrc4171_card_device.dev;
602 socket->pcmcia_socket.ops = &vrc4171_pccard_operations;
603 socket->pcmcia_socket.owner = THIS_MODULE;
605 retval = pcmcia_register_socket(&socket->pcmcia_socket);
609 exca_write_byte(slot, I365_ADDRWIN, 0);
610 exca_write_byte(slot, GLOBAL_CONTROL, 0);
612 socket->slot = SLOT_INITIALIZED;
618 static void vrc4171_remove_sockets(void)
620 vrc4171_socket_t *socket;
623 for (slot = 0; slot < CARD_MAX_SLOTS; slot++) {
624 if (slot == CARD_SLOTB && vrc4171_slotb == SLOTB_IS_NONE)
627 socket = &vrc4171_sockets[slot];
628 if (socket->slot == SLOT_INITIALIZED)
629 pcmcia_unregister_socket(&socket->pcmcia_socket);
631 socket->slot = SLOT_PROBE;
635 static int vrc4171_card_setup(char *options)
637 if (options == NULL || *options == '\0')
640 if (strncmp(options, "irq:", 4) == 0) {
643 irq = simple_strtoul(options, &options, 0);
644 if (irq >= 0 && irq < nr_irqs)
652 if (strncmp(options, "slota:", 6) == 0) {
654 if (*options != '\0') {
655 if (strncmp(options, "memnoprobe", 10) == 0) {
656 vrc4171_sockets[CARD_SLOTA].slot = SLOT_NOPROBE_MEM;
658 } else if (strncmp(options, "ionoprobe", 9) == 0) {
659 vrc4171_sockets[CARD_SLOTA].slot = SLOT_NOPROBE_IO;
661 } else if ( strncmp(options, "noprobe", 7) == 0) {
662 vrc4171_sockets[CARD_SLOTA].slot = SLOT_NOPROBE_ALL;
674 if (strncmp(options, "slotb:", 6) == 0) {
676 if (*options != '\0') {
677 if (strncmp(options, "pccard", 6) == 0) {
678 vrc4171_slotb = SLOTB_IS_PCCARD;
680 } else if (strncmp(options, "cf", 2) == 0) {
681 vrc4171_slotb = SLOTB_IS_CF;
683 } else if (strncmp(options, "flashrom", 8) == 0) {
684 vrc4171_slotb = SLOTB_IS_FLASHROM;
686 } else if (strncmp(options, "none", 4) == 0) {
687 vrc4171_slotb = SLOTB_IS_NONE;
695 if (strncmp(options, "memnoprobe", 10) == 0)
696 vrc4171_sockets[CARD_SLOTB].slot = SLOT_NOPROBE_MEM;
697 if (strncmp(options, "ionoprobe", 9) == 0)
698 vrc4171_sockets[CARD_SLOTB].slot = SLOT_NOPROBE_IO;
699 if (strncmp(options, "noprobe", 7) == 0)
700 vrc4171_sockets[CARD_SLOTB].slot = SLOT_NOPROBE_ALL;
707 __setup("vrc4171_card=", vrc4171_card_setup);
709 static struct platform_driver vrc4171_card_driver = {
711 .name = vrc4171_card_name,
712 .owner = THIS_MODULE,
716 static int vrc4171_card_init(void)
720 retval = platform_driver_register(&vrc4171_card_driver);
724 retval = platform_device_register(&vrc4171_card_device);
726 platform_driver_unregister(&vrc4171_card_driver);
730 vrc4171_set_multifunction_pin(vrc4171_slotb);
732 retval = vrc4171_add_sockets();
734 retval = request_irq(vrc4171_irq, pccard_interrupt, IRQF_SHARED,
735 vrc4171_card_name, vrc4171_sockets);
738 vrc4171_remove_sockets();
739 platform_device_unregister(&vrc4171_card_device);
740 platform_driver_unregister(&vrc4171_card_driver);
744 printk(KERN_INFO "%s, connected to IRQ %d\n",
745 vrc4171_card_driver.driver.name, vrc4171_irq);
750 static void vrc4171_card_exit(void)
752 free_irq(vrc4171_irq, vrc4171_sockets);
753 vrc4171_remove_sockets();
754 platform_device_unregister(&vrc4171_card_device);
755 platform_driver_unregister(&vrc4171_card_driver);
758 module_init(vrc4171_card_init);
759 module_exit(vrc4171_card_exit);