3 * drivers/pcmcia/vrc4173_cardu.c
5 * BRIEF MODULE DESCRIPTION
6 * NEC VRC4173 CARDU driver for Socket Services
7 * (This device doesn't support CardBus. it is supporting only 16bit PC Card.)
9 * Copyright 2002,2003 Yoichi Yuasa <yuasa@hh.iij4u.or.jp>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
16 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
24 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
25 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 * You should have received a copy of the GNU General Public License along
28 * with this program; if not, write to the Free Software Foundation, Inc.,
29 * 675 Mass Ave, Cambridge, MA 02139, USA.
31 #include <linux/init.h>
32 #include <linux/module.h>
33 #include <linux/pci.h>
34 #include <linux/spinlock.h>
35 #include <linux/types.h>
39 #include <pcmcia/ss.h>
41 #include "vrc4173_cardu.h"
43 MODULE_DESCRIPTION("NEC VRC4173 CARDU driver for Socket Services");
44 MODULE_AUTHOR("Yoichi Yuasa <yuasa@hh.iij4u.or.jp>");
45 MODULE_LICENSE("GPL");
47 static int vrc4173_cardu_slots;
49 static vrc4173_socket_t cardu_sockets[CARDU_MAX_SOCKETS];
51 extern struct socket_info_t *pcmcia_register_socket (int slot,
52 struct pccard_operations *vtable,
54 extern void pcmcia_unregister_socket(struct socket_info_t *s);
56 static inline uint8_t exca_readb(vrc4173_socket_t *socket, uint16_t offset)
58 return readb(socket->base + EXCA_REGS_BASE + offset);
61 static inline uint16_t exca_readw(vrc4173_socket_t *socket, uint16_t offset)
65 val = readb(socket->base + EXCA_REGS_BASE + offset);
66 val |= (u16)readb(socket->base + EXCA_REGS_BASE + offset + 1) << 8;
71 static inline void exca_writeb(vrc4173_socket_t *socket, uint16_t offset, uint8_t val)
73 writeb(val, socket->base + EXCA_REGS_BASE + offset);
76 static inline void exca_writew(vrc4173_socket_t *socket, uint8_t offset, uint16_t val)
78 writeb((u8)val, socket->base + EXCA_REGS_BASE + offset);
79 writeb((u8)(val >> 8), socket->base + EXCA_REGS_BASE + offset + 1);
82 static inline uint32_t cardbus_socket_readl(vrc4173_socket_t *socket, u16 offset)
84 return readl(socket->base + CARDBUS_SOCKET_REGS_BASE + offset);
87 static inline void cardbus_socket_writel(vrc4173_socket_t *socket, u16 offset, uint32_t val)
89 writel(val, socket->base + CARDBUS_SOCKET_REGS_BASE + offset);
92 static void cardu_pciregs_init(struct pci_dev *dev)
98 pci_write_config_dword(dev, 0x1c, 0x10000000);
99 pci_write_config_dword(dev, 0x20, 0x17fff000);
100 pci_write_config_dword(dev, 0x2c, 0);
101 pci_write_config_dword(dev, 0x30, 0xfffc);
103 pci_read_config_word(dev, BRGCNT, &brgcnt);
105 pci_write_config_word(dev, BRGCNT, brgcnt);
107 pci_read_config_dword(dev, SYSCNT, &syscnt);
108 syscnt &= ~(BAD_VCC_REQ_DISB|PCPCI_EN|CH_ASSIGN_MASK|SUB_ID_WR_EN|PCI_CLK_RIN);
109 syscnt |= (CH_ASSIGN_NODMA|ASYN_INT_MODE);
110 pci_write_config_dword(dev, SYSCNT, syscnt);
112 pci_read_config_byte(dev, DEVCNT, &devcnt);
113 devcnt &= ~(ZOOM_VIDEO_EN|SR_PCI_INT_SEL_MASK|PCI_INT_MODE|IRQ_MODE);
114 devcnt |= (SR_PCI_INT_SEL_NONE|IFG);
115 pci_write_config_byte(dev, DEVCNT, devcnt);
117 pci_write_config_byte(dev, CHIPCNT, S_PREF_DISB);
119 pci_write_config_byte(dev, SERRDIS, 0);
122 static int cardu_init(unsigned int slot)
124 vrc4173_socket_t *socket = &cardu_sockets[slot];
126 cardu_pciregs_init(socket->dev);
128 /* CARD_SC bits are cleared by reading CARD_SC. */
129 exca_writeb(socket, GLO_CNT, 0);
131 socket->cap.features |= SS_CAP_PCCARD | SS_CAP_PAGE_REGS;
132 socket->cap.irq_mask = 0;
133 socket->cap.map_size = 0x1000;
134 socket->cap.pci_irq = socket->dev->irq;
136 spin_lock_init(socket->event_lock);
138 /* Enable PC Card status interrupts */
139 exca_writeb(socket, CARD_SCI, CARD_DT_EN|RDY_EN|BAT_WAR_EN|BAT_DEAD_EN);
144 static int cardu_suspend(unsigned int slot)
149 static int cardu_register_callback(unsigned int sock,
150 void (*handler)(void *, unsigned int),
153 vrc4173_socket_t *socket = &cardu_sockets[sock];
155 socket->handler = handler;
166 static int cardu_inquire_socket(unsigned int sock, socket_cap_t *cap)
168 vrc4173_socket_t *socket = &cardu_sockets[sock];
175 static int cardu_get_status(unsigned int sock, u_int *value)
177 vrc4173_socket_t *socket = &cardu_sockets[sock];
182 status = exca_readb(socket, IF_STATUS);
183 if (status & CARD_PWR) val |= SS_POWERON;
184 if (status & READY) val |= SS_READY;
185 if (status & CARD_WP) val |= SS_WRPROT;
186 if ((status & (CARD_DETECT1|CARD_DETECT2)) == (CARD_DETECT1|CARD_DETECT2))
188 if (exca_readb(socket, INT_GEN_CNT) & CARD_TYPE_IO) {
189 if (status & STSCHG) val |= SS_STSCHG;
191 status &= BV_DETECT_MASK;
192 if (status != BV_DETECT_GOOD) {
193 if (status == BV_DETECT_WARN) val |= SS_BATWARN;
194 else val |= SS_BATDEAD;
198 state = cardbus_socket_readl(socket, SKT_PRE_STATE);
199 if (state & VOL_3V_CARD_DT) val |= SS_3VCARD;
200 if (state & VOL_XV_CARD_DT) val |= SS_XVCARD;
201 if (state & CB_CARD_DT) val |= SS_CARDBUS;
203 (VOL_YV_CARD_DT|VOL_XV_CARD_DT|VOL_3V_CARD_DT|VOL_5V_CARD_DT|CCD20|CCD10)))
211 static inline u_char get_Vcc_value(uint8_t val)
213 switch (val & VCC_MASK) {
223 static inline u_char get_Vpp_value(uint8_t val)
225 switch (val & VPP_MASK) {
229 return get_Vcc_value(val);
235 static int cardu_get_socket(unsigned int sock, socket_state_t *state)
237 vrc4173_socket_t *socket = &cardu_sockets[sock];
240 val = exca_readb(socket, PWR_CNT);
241 state->Vcc = get_Vcc_value(val);
242 state->Vpp = get_Vpp_value(val);
244 if (val & CARD_OUT_EN) state->flags |= SS_OUTPUT_ENA;
246 val = exca_readb(socket, INT_GEN_CNT);
247 if (!(val & CARD_REST0)) state->flags |= SS_RESET;
248 if (val & CARD_TYPE_IO) state->flags |= SS_IOCARD;
253 static inline uint8_t set_Vcc_value(u_char Vcc)
265 static inline uint8_t set_Vpp_value(u_char Vpp)
278 static int cardu_set_socket(unsigned int sock, socket_state_t *state)
280 vrc4173_socket_t *socket = &cardu_sockets[sock];
283 if (((state->Vpp == 33) || (state->Vpp == 50)) && (state->Vpp != state->Vcc))
286 val = set_Vcc_value(state->Vcc);
287 val |= set_Vpp_value(state->Vpp);
288 if (state->flags & SS_OUTPUT_ENA) val |= CARD_OUT_EN;
289 exca_writeb(socket, PWR_CNT, val);
291 val = exca_readb(socket, INT_GEN_CNT) & CARD_REST0;
292 if (state->flags & SS_RESET) val &= ~CARD_REST0;
293 else val |= CARD_REST0;
294 if (state->flags & SS_IOCARD) val |= CARD_TYPE_IO;
295 exca_writeb(socket, INT_GEN_CNT, val);
300 static int cardu_get_io_map(unsigned int sock, struct pccard_io_map *io)
302 vrc4173_socket_t *socket = &cardu_sockets[sock];
303 uint8_t ioctl, window;
310 io->start = exca_readw(socket, IO_WIN_SA(map));
311 io->stop = exca_readw(socket, IO_WIN_EA(map));
313 ioctl = exca_readb(socket, IO_WIN_CNT);
314 window = exca_readb(socket, ADR_WIN_EN);
315 io->flags = (window & IO_WIN_EN(map)) ? MAP_ACTIVE : 0;
316 if (ioctl & IO_WIN_DATA_AUTOSZ(map))
317 io->flags |= MAP_AUTOSZ;
318 else if (ioctl & IO_WIN_DATA_16BIT(map))
319 io->flags |= MAP_16BIT;
324 static int cardu_set_io_map(unsigned int sock, struct pccard_io_map *io)
326 vrc4173_socket_t *socket = &cardu_sockets[sock];
328 uint8_t window, enable;
335 window = exca_readb(socket, ADR_WIN_EN);
336 enable = IO_WIN_EN(map);
338 if (window & enable) {
340 exca_writeb(socket, ADR_WIN_EN, window);
343 exca_writew(socket, IO_WIN_SA(map), io->start);
344 exca_writew(socket, IO_WIN_EA(map), io->stop);
346 ioctl = exca_readb(socket, IO_WIN_CNT) & ~IO_WIN_CNT_MASK(map);
347 if (io->flags & MAP_AUTOSZ) ioctl |= IO_WIN_DATA_AUTOSZ(map);
348 else if (io->flags & MAP_16BIT) ioctl |= IO_WIN_DATA_16BIT(map);
349 exca_writeb(socket, IO_WIN_CNT, ioctl);
351 if (io->flags & MAP_ACTIVE)
352 exca_writeb(socket, ADR_WIN_EN, window | enable);
357 static int cardu_get_mem_map(unsigned int sock, struct pccard_mem_map *mem)
359 vrc4173_socket_t *socket = &cardu_sockets[sock];
360 uint32_t start, stop, offset, page;
368 window = exca_readb(socket, ADR_WIN_EN);
369 mem->flags = (window & MEM_WIN_EN(map)) ? MAP_ACTIVE : 0;
371 start = exca_readw(socket, MEM_WIN_SA(map));
372 mem->flags |= (start & MEM_WIN_DSIZE) ? MAP_16BIT : 0;
373 start = (start & 0x0fff) << 12;
375 stop = exca_readw(socket, MEM_WIN_EA(map));
376 stop = ((stop & 0x0fff) << 12) + 0x0fff;
378 offset = exca_readw(socket, MEM_WIN_OA(map));
379 mem->flags |= (offset & MEM_WIN_WP) ? MAP_WRPROT : 0;
380 mem->flags |= (offset & MEM_WIN_REGSET) ? MAP_ATTRIB : 0;
381 offset = ((offset & 0x3fff) << 12) + start;
382 mem->card_start = offset & 0x03ffffff;
384 page = exca_readb(socket, MEM_WIN_SAU(map)) << 24;
385 mem->sys_start = start + page;
386 mem->sys_stop = start + page;
391 static int cardu_set_mem_map(unsigned int sock, struct pccard_mem_map *mem)
393 vrc4173_socket_t *socket = &cardu_sockets[sock];
395 uint8_t window, enable;
396 u_long sys_start, sys_stop, card_start;
400 sys_start = mem->sys_start;
401 sys_stop = mem->sys_stop;
402 card_start = mem->card_start;
404 if (map > 4 || sys_start > sys_stop || ((sys_start ^ sys_stop) >> 24) ||
408 window = exca_readb(socket, ADR_WIN_EN);
409 enable = MEM_WIN_EN(map);
410 if (window & enable) {
412 exca_writeb(socket, ADR_WIN_EN, window);
415 exca_writeb(socket, MEM_WIN_SAU(map), sys_start >> 24);
417 value = (sys_start >> 12) & 0x0fff;
418 if (mem->flags & MAP_16BIT) value |= MEM_WIN_DSIZE;
419 exca_writew(socket, MEM_WIN_SA(map), value);
421 value = (sys_stop >> 12) & 0x0fff;
422 exca_writew(socket, MEM_WIN_EA(map), value);
424 value = ((card_start - sys_start) >> 12) & 0x3fff;
425 if (mem->flags & MAP_WRPROT) value |= MEM_WIN_WP;
426 if (mem->flags & MAP_ATTRIB) value |= MEM_WIN_REGSET;
427 exca_writew(socket, MEM_WIN_OA(map), value);
429 if (mem->flags & MAP_ACTIVE)
430 exca_writeb(socket, ADR_WIN_EN, window | enable);
435 static void cardu_proc_setup(unsigned int sock, struct proc_dir_entry *base)
439 static struct pccard_operations cardu_operations = {
441 .suspend = cardu_suspend,
442 .register_callback = cardu_register_callback,
443 .inquire_socket = cardu_inquire_socket,
444 .get_status = cardu_get_status,
445 .get_socket = cardu_get_socket,
446 .set_socket = cardu_set_socket,
447 .get_io_map = cardu_get_io_map,
448 .set_io_map = cardu_set_io_map,
449 .get_mem_map = cardu_get_mem_map,
450 .set_mem_map = cardu_set_mem_map,
451 .proc_setup = cardu_proc_setup,
454 static void cardu_bh(void *data)
456 vrc4173_socket_t *socket = (vrc4173_socket_t *)data;
459 spin_lock_irq(&socket->event_lock);
460 events = socket->events;
462 spin_unlock_irq(&socket->event_lock);
465 socket->handler(socket->info, events);
468 static uint16_t get_events(vrc4173_socket_t *socket)
473 status = exca_readb(socket, IF_STATUS);
474 csc = exca_readb(socket, CARD_SC);
475 if ((csc & CARD_DT_CHG) &&
476 ((status & (CARD_DETECT1|CARD_DETECT2)) == (CARD_DETECT1|CARD_DETECT2)))
479 if ((csc & RDY_CHG) && (status & READY))
482 if (exca_readb(socket, INT_GEN_CNT) & CARD_TYPE_IO) {
483 if ((csc & BAT_DEAD_ST_CHG) && (status & STSCHG))
486 if (csc & (BAT_WAR_CHG|BAT_DEAD_ST_CHG)) {
487 if ((status & BV_DETECT_MASK) != BV_DETECT_GOOD) {
488 if (status == BV_DETECT_WARN) events |= SS_BATWARN;
489 else events |= SS_BATDEAD;
497 static void cardu_interrupt(int irq, void *dev_id, struct pt_regs *regs)
499 vrc4173_socket_t *socket = (vrc4173_socket_t *)dev_id;
502 socket->tq_task.routine = cardu_bh;
503 socket->tq_task.data = socket;
505 events = get_events(socket);
507 spin_lock(&socket->event_lock);
508 socket->events |= events;
509 spin_unlock(&socket->event_lock);
510 schedule_task(&socket->tq_task);
514 static int __devinit vrc4173_cardu_probe(struct pci_dev *dev,
515 const struct pci_device_id *ent)
517 vrc4173_socket_t *socket;
518 unsigned long start, len, flags;
521 slot = vrc4173_cardu_slots++;
522 socket = &cardu_sockets[slot];
523 if (socket->noprobe != 0)
526 sprintf(socket->name, "NEC VRC4173 CARDU%1d", slot+1);
528 if ((err = pci_enable_device(dev)) < 0)
531 start = pci_resource_start(dev, 0);
535 len = pci_resource_len(dev, 0);
539 if (((flags = pci_resource_flags(dev, 0)) & IORESOURCE_MEM) == 0)
542 if ((err = pci_request_regions(dev, socket->name)) < 0)
545 socket->base = ioremap(start, len);
546 if (socket->base == NULL)
551 socket->pcmcia_socket = pcmcia_register_socket(slot, &cardu_operations, 1);
552 if (socket->pcmcia_socket == NULL) {
553 iounmap(socket->base);
558 if (request_irq(dev->irq, cardu_interrupt, SA_SHIRQ, socket->name, socket) < 0) {
559 pcmcia_unregister_socket(socket->pcmcia_socket);
560 socket->pcmcia_socket = NULL;
561 iounmap(socket->base);
566 printk(KERN_INFO "%s at %#08lx, IRQ %d\n", socket->name, start, dev->irq);
571 static int __devinit vrc4173_cardu_setup(char *options)
573 if (options == NULL || *options == '\0')
576 if (strncmp(options, "cardu1:", 7) == 0) {
578 if (*options != '\0') {
579 if (strncmp(options, "noprobe", 7) == 0) {
580 cardu_sockets[CARDU1].noprobe = 1;
590 if (strncmp(options, "cardu2:", 7) == 0) {
592 if ((*options != '\0') && (strncmp(options, "noprobe", 7) == 0))
593 cardu_sockets[CARDU2].noprobe = 1;
599 __setup("vrc4173_cardu=", vrc4173_cardu_setup);
601 static struct pci_device_id vrc4173_cardu_id_table[] __devinitdata = {
602 { .vendor = PCI_VENDOR_ID_NEC,
603 .device = PCI_DEVICE_ID_NEC_NAPCCARD,
604 .subvendor = PCI_ANY_ID,
605 .subdevice = PCI_ANY_ID, },
609 static struct pci_driver vrc4173_cardu_driver = {
610 .name = "NEC VRC4173 CARDU",
611 .probe = vrc4173_cardu_probe,
612 .id_table = vrc4173_cardu_id_table,
615 static int __devinit vrc4173_cardu_init(void)
617 vrc4173_cardu_slots = 0;
619 return pci_module_init(&vrc4173_cardu_driver);
622 static void __devexit vrc4173_cardu_exit(void)
624 pci_unregister_driver(&vrc4173_cardu_driver);
627 module_init(vrc4173_cardu_init);
628 module_exit(vrc4173_cardu_exit);