2 * vrc4171_card.c, NEC VRC4171 Card Controller driver for Socket Services.
4 * Copyright (C) 2003 Yoichi Yuasa <yuasa@hh.iij4u.or.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>
29 #include <asm/vr41xx/vrc4171.h>
31 #include <pcmcia/ss.h>
35 MODULE_DESCRIPTION("NEC VRC4171 Card Controllers driver for Socket Services");
36 MODULE_AUTHOR("Yoichi Yuasa <yuasa@hh.iij4u.or.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
51 #define CARD_CONTROLLER_SIZE 2
53 #define VPP_GET_VCC 0x01
54 #define POWER_ENABLE 0x10
55 #define CARD_VOLTAGE_SENSE 0x1f
56 #define VCC_3VORXV_CAPABLE 0x00
57 #define VCC_XV_ONLY 0x01
58 #define VCC_3V_CAPABLE 0x02
59 #define VCC_5V_ONLY 0x03
60 #define CARD_VOLTAGE_SELECT 0x2f
64 #define VCC_STATUS_3V 0x02
65 #define VCC_STATUS_5V 0x01
66 #define VCC_STATUS_XV 0x03
67 #define GLOBAL_CONTROL 0x1e
73 #define MEM_MAX_MAPS 5
82 typedef struct vrc4171_socket {
84 struct pcmcia_socket pcmcia_socket;
90 static vrc4171_socket_t vrc4171_sockets[CARD_MAX_SLOTS];
91 static int vrc4171_slotb = SLOTB_IS_NONE;
92 static unsigned int vrc4171_irq;
93 static uint16_t vrc4171_irq_mask = 0xdeb8;
95 static inline uint8_t exca_read_byte(int slot, uint8_t index)
97 if (slot == CARD_SLOTB)
98 index += CARD_SLOTB_OFFSET;
100 outb(index, CARD_CONTROLLER_INDEX);
101 return inb(CARD_CONTROLLER_DATA);
104 static inline uint16_t exca_read_word(int slot, uint8_t index)
108 if (slot == CARD_SLOTB)
109 index += CARD_SLOTB_OFFSET;
111 outb(index++, CARD_CONTROLLER_INDEX);
112 data = inb(CARD_CONTROLLER_DATA);
114 outb(index, CARD_CONTROLLER_INDEX);
115 data |= ((uint16_t)inb(CARD_CONTROLLER_DATA)) << 8;
120 static inline uint8_t exca_write_byte(int slot, uint8_t index, uint8_t data)
122 if (slot == CARD_SLOTB)
123 index += CARD_SLOTB_OFFSET;
125 outb(index, CARD_CONTROLLER_INDEX);
126 outb(data, CARD_CONTROLLER_DATA);
131 static inline uint16_t exca_write_word(int slot, uint8_t index, uint16_t data)
133 if (slot == CARD_SLOTB)
134 index += CARD_SLOTB_OFFSET;
136 outb(index++, CARD_CONTROLLER_INDEX);
137 outb(data, CARD_CONTROLLER_DATA);
139 outb(index, CARD_CONTROLLER_INDEX);
140 outb((uint8_t)(data >> 8), CARD_CONTROLLER_DATA);
145 static inline int search_nonuse_irq(void)
149 for (i = 0; i < 16; i++) {
150 if (vrc4171_irq_mask & (1 << i)) {
151 vrc4171_irq_mask &= ~(1 << i);
159 static int pccard_init(struct pcmcia_socket *sock)
161 vrc4171_socket_t *socket;
164 sock->features |= SS_CAP_PCCARD | SS_CAP_PAGE_REGS;
166 sock->map_size = 0x1000;
167 sock->pci_irq = vrc4171_irq;
170 socket = &vrc4171_sockets[slot];
171 socket->csc_irq = search_nonuse_irq();
172 socket->io_irq = search_nonuse_irq();
177 static int pccard_suspend(struct pcmcia_socket *sock)
182 static int pccard_get_status(struct pcmcia_socket *sock, u_int *value)
185 uint8_t status, sense;
188 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS || value == NULL)
193 status = exca_read_byte(slot, I365_STATUS);
194 if (exca_read_byte(slot, I365_INTCTL) & I365_PC_IOCARD) {
195 if (status & I365_CS_STSCHG)
198 if (!(status & I365_CS_BVD1))
200 else if ((status & (I365_CS_BVD1 | I365_CS_BVD2)) == I365_CS_BVD1)
203 if ((status & I365_CS_DETECT) == I365_CS_DETECT)
205 if (status & I365_CS_WRPROT)
207 if (status & I365_CS_READY)
209 if (status & I365_CS_POWERON)
212 sense = exca_read_byte(slot, CARD_VOLTAGE_SENSE);
214 case VCC_3VORXV_CAPABLE:
215 val |= SS_3VCARD | SS_XVCARD;
233 static inline u_char get_Vcc_value(uint8_t voltage)
247 static inline u_char get_Vpp_value(uint8_t power, u_char Vcc)
249 if ((power & 0x03) == 0x01 || (power & 0x03) == 0x02)
255 static int pccard_get_socket(struct pcmcia_socket *sock, socket_state_t *state)
258 uint8_t power, voltage, control, cscint;
260 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS || state == NULL)
265 power = exca_read_byte(slot, I365_POWER);
266 voltage = exca_read_byte(slot, CARD_VOLTAGE_SELECT);
268 state->Vcc = get_Vcc_value(voltage);
269 state->Vpp = get_Vpp_value(power, state->Vcc);
272 if (power & POWER_ENABLE)
273 state->flags |= SS_PWR_AUTO;
274 if (power & I365_PWR_OUT)
275 state->flags |= SS_OUTPUT_ENA;
277 control = exca_read_byte(slot, I365_INTCTL);
278 if (control & I365_PC_IOCARD)
279 state->flags |= SS_IOCARD;
280 if (!(control & I365_PC_RESET))
281 state->flags |= SS_RESET;
283 cscint = exca_read_byte(slot, I365_CSCINT);
285 if (state->flags & SS_IOCARD) {
286 if (cscint & I365_CSC_STSCHG)
287 state->flags |= SS_STSCHG;
289 if (cscint & I365_CSC_BVD1)
290 state->csc_mask |= SS_BATDEAD;
291 if (cscint & I365_CSC_BVD2)
292 state->csc_mask |= SS_BATWARN;
294 if (cscint & I365_CSC_READY)
295 state->csc_mask |= SS_READY;
296 if (cscint & I365_CSC_DETECT)
297 state->csc_mask |= SS_DETECT;
302 static inline uint8_t set_Vcc_value(u_char Vcc)
311 /* Small voltage is chosen for safety. */
315 static int pccard_set_socket(struct pcmcia_socket *sock, socket_state_t *state)
317 vrc4171_socket_t *socket;
319 uint8_t voltage, power, control, cscint;
321 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
322 (state->Vpp != state->Vcc && state->Vpp != 0) ||
323 (state->Vcc != 50 && state->Vcc != 33 && state->Vcc != 0))
327 socket = &vrc4171_sockets[slot];
329 spin_lock_irq(&sock->lock);
331 voltage = set_Vcc_value(state->Vcc);
332 exca_write_byte(slot, CARD_VOLTAGE_SELECT, voltage);
334 power = POWER_ENABLE;
335 if (state->Vpp == state->Vcc)
336 power |= VPP_GET_VCC;
337 if (state->flags & SS_OUTPUT_ENA)
338 power |= I365_PWR_OUT;
339 exca_write_byte(slot, I365_POWER, power);
342 if (state->io_irq != 0)
343 control |= socket->io_irq;
344 if (state->flags & SS_IOCARD)
345 control |= I365_PC_IOCARD;
346 if (state->flags & SS_RESET)
347 control &= ~I365_PC_RESET;
349 control |= I365_PC_RESET;
350 exca_write_byte(slot, I365_INTCTL, control);
353 exca_write_byte(slot, I365_CSCINT, cscint);
354 exca_read_byte(slot, I365_CSC); /* clear CardStatus change */
355 if (state->csc_mask != 0)
356 cscint |= socket->csc_irq << 8;
357 if (state->flags & SS_IOCARD) {
358 if (state->csc_mask & SS_STSCHG)
359 cscint |= I365_CSC_STSCHG;
361 if (state->csc_mask & SS_BATDEAD)
362 cscint |= I365_CSC_BVD1;
363 if (state->csc_mask & SS_BATWARN)
364 cscint |= I365_CSC_BVD2;
366 if (state->csc_mask & SS_READY)
367 cscint |= I365_CSC_READY;
368 if (state->csc_mask & SS_DETECT)
369 cscint |= I365_CSC_DETECT;
370 exca_write_byte(slot, I365_CSCINT, cscint);
372 spin_unlock_irq(&sock->lock);
377 static int pccard_set_io_map(struct pcmcia_socket *sock, struct pccard_io_map *io)
380 uint8_t ioctl, addrwin;
383 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
384 io == NULL || io->map >= IO_MAX_MAPS ||
385 io->start > 0xffff || io->stop > 0xffff || io->start > io->stop)
391 addrwin = exca_read_byte(slot, I365_ADDRWIN);
392 if (addrwin & I365_ENA_IO(map)) {
393 addrwin &= ~I365_ENA_IO(map);
394 exca_write_byte(slot, I365_ADDRWIN, addrwin);
397 exca_write_word(slot, I365_IO(map)+I365_W_START, io->start);
398 exca_write_word(slot, I365_IO(map)+I365_W_STOP, io->stop);
402 ioctl |= I365_IOCTL_WAIT(map);
403 if (io->flags & MAP_16BIT)
404 ioctl |= I365_IOCTL_16BIT(map);
405 if (io->flags & MAP_AUTOSZ)
406 ioctl |= I365_IOCTL_IOCS16(map);
407 if (io->flags & MAP_0WS)
408 ioctl |= I365_IOCTL_0WS(map);
409 exca_write_byte(slot, I365_IOCTL, ioctl);
411 if (io->flags & MAP_ACTIVE) {
412 addrwin |= I365_ENA_IO(map);
413 exca_write_byte(slot, I365_ADDRWIN, addrwin);
419 static int pccard_set_mem_map(struct pcmcia_socket *sock, struct pccard_mem_map *mem)
422 uint16_t start, stop, offset;
426 if (sock == NULL || sock->sock >= CARD_MAX_SLOTS ||
427 mem == NULL || mem->map >= MEM_MAX_MAPS ||
428 mem->sys_start < CARD_MEM_START || mem->sys_start > CARD_MEM_END ||
429 mem->sys_stop < CARD_MEM_START || mem->sys_stop > CARD_MEM_END ||
430 mem->sys_start > mem->sys_stop ||
431 mem->card_start > CARD_MAX_MEM_OFFSET ||
432 mem->speed > CARD_MAX_MEM_SPEED)
438 addrwin = exca_read_byte(slot, I365_ADDRWIN);
439 if (addrwin & I365_ENA_MEM(map)) {
440 addrwin &= ~I365_ENA_MEM(map);
441 exca_write_byte(slot, I365_ADDRWIN, addrwin);
444 start = (mem->sys_start >> 12) & 0x3fff;
445 if (mem->flags & MAP_16BIT)
446 start |= I365_MEM_16BIT;
447 exca_write_word(slot, I365_MEM(map)+I365_W_START, start);
449 stop = (mem->sys_stop >> 12) & 0x3fff;
450 switch (mem->speed) {
454 stop |= I365_MEM_WS0;
457 stop |= I365_MEM_WS1;
460 stop |= I365_MEM_WS0 | I365_MEM_WS1;
463 exca_write_word(slot, I365_MEM(map)+I365_W_STOP, stop);
465 offset = (mem->card_start >> 12) & 0x3fff;
466 if (mem->flags & MAP_ATTRIB)
467 offset |= I365_MEM_REG;
468 if (mem->flags & MAP_WRPROT)
469 offset |= I365_MEM_WRPROT;
470 exca_write_word(slot, I365_MEM(map)+I365_W_OFF, offset);
472 if (mem->flags & MAP_ACTIVE) {
473 addrwin |= I365_ENA_MEM(map);
474 exca_write_byte(slot, I365_ADDRWIN, addrwin);
480 static struct pccard_operations vrc4171_pccard_operations = {
482 .suspend = pccard_suspend,
483 .get_status = pccard_get_status,
484 .get_socket = pccard_get_socket,
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->noprobe == SLOT_PROBE) {
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->noprobe == SLOT_PROBE) {
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_socket(int slot)
569 vrc4171_socket_t *socket;
572 if (slot >= CARD_MAX_SLOTS)
575 socket = &vrc4171_sockets[slot];
576 if (socket->noprobe != SLOT_PROBE) {
579 switch (socket->noprobe) {
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);
599 sprintf(socket->name, "NEC VRC4171 Card Slot %1c", 'A' + slot);
601 socket->pcmcia_socket.ops = &vrc4171_pccard_operations;
603 retval = pcmcia_register_socket(&socket->pcmcia_socket);
607 exca_write_byte(slot, I365_ADDRWIN, 0);
609 exca_write_byte(slot, GLOBAL_CONTROL, 0);
614 static void vrc4171_remove_socket(int slot)
616 vrc4171_socket_t *socket;
618 if (slot >= CARD_MAX_SLOTS)
621 socket = &vrc4171_sockets[slot];
623 pcmcia_unregister_socket(&socket->pcmcia_socket);
626 static int __devinit vrc4171_card_setup(char *options)
628 if (options == NULL || *options == '\0')
631 if (strncmp(options, "irq:", 4) == 0) {
634 irq = simple_strtoul(options, &options, 0);
635 if (irq >= 0 && irq < NR_IRQS)
643 if (strncmp(options, "slota:", 6) == 0) {
645 if (*options != '\0') {
646 if (strncmp(options, "memnoprobe", 10) == 0) {
647 vrc4171_sockets[CARD_SLOTA].noprobe = SLOT_NOPROBE_MEM;
649 } else if (strncmp(options, "ionoprobe", 9) == 0) {
650 vrc4171_sockets[CARD_SLOTA].noprobe = SLOT_NOPROBE_IO;
652 } else if ( strncmp(options, "noprobe", 7) == 0) {
653 vrc4171_sockets[CARD_SLOTA].noprobe = SLOT_NOPROBE_ALL;
665 if (strncmp(options, "slotb:", 6) == 0) {
667 if (*options != '\0') {
668 if (strncmp(options, "pccard", 6) == 0) {
669 vrc4171_slotb = SLOTB_IS_PCCARD;
671 } else if (strncmp(options, "cf", 2) == 0) {
672 vrc4171_slotb = SLOTB_IS_CF;
674 } else if (strncmp(options, "flashrom", 8) == 0) {
675 vrc4171_slotb = SLOTB_IS_FLASHROM;
677 } else if (strncmp(options, "none", 4) == 0) {
678 vrc4171_slotb = SLOTB_IS_NONE;
686 if (strncmp(options, "memnoprobe", 10) == 0)
687 vrc4171_sockets[CARD_SLOTB].noprobe = SLOT_NOPROBE_MEM;
688 if (strncmp(options, "ionoprobe", 9) == 0)
689 vrc4171_sockets[CARD_SLOTB].noprobe = SLOT_NOPROBE_IO;
690 if (strncmp(options, "noprobe", 7) == 0)
691 vrc4171_sockets[CARD_SLOTB].noprobe = SLOT_NOPROBE_ALL;
698 __setup("vrc4171_card=", vrc4171_card_setup);
700 static int __devinit vrc4171_card_init(void)
704 vrc4171_set_multifunction_pin(vrc4171_slotb);
706 if (request_region(CARD_CONTROLLER_INDEX, CARD_CONTROLLER_SIZE,
707 "NEC VRC4171 Card Controller") == NULL)
710 for (slot = 0; slot < CARD_MAX_SLOTS; slot++) {
711 if (slot == CARD_SLOTB && vrc4171_slotb == SLOTB_IS_NONE)
714 retval = vrc4171_add_socket(slot);
719 retval = request_irq(vrc4171_irq, pccard_interrupt, SA_SHIRQ,
720 "NEC VRC4171 Card Controller", vrc4171_sockets);
722 for (slot = 0; slot < CARD_MAX_SLOTS; slot++)
723 vrc4171_remove_socket(slot);
728 printk(KERN_INFO "NEC VRC4171 Card Controller, connected to IRQ %d\n", vrc4171_irq);
733 static void __devexit vrc4171_card_exit(void)
737 for (slot = 0; slot < CARD_MAX_SLOTS; slot++)
738 vrc4171_remove_socket(slot);
740 release_region(CARD_CONTROLLER_INDEX, CARD_CONTROLLER_SIZE);
743 module_init(vrc4171_card_init);
744 module_exit(vrc4171_card_exit);