1 /* $NetBSD: pcmcia.c,v 1.13 1998/12/24 04:51:59 marc Exp $ */
2 /* $FreeBSD: src/sys/dev/pccard/pccard.c,v 1.8.2.1 2000/05/23 03:56:59 imp Exp $ */
5 * Copyright (c) 1997 Marc Horowitz. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Marc Horowitz.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/kernel.h>
38 #include <sys/queue.h>
39 #include <sys/types.h>
42 #include <machine/bus.h>
44 #include <machine/resource.h>
46 #include <dev/pccard/pccardreg.h>
47 #include <dev/pccard/pccardvar.h>
56 #define DPRINTF(arg) if (pccard_debug) printf arg
57 #define DEVPRINTF(arg) if (pccard_debug) device_printf arg
60 #define DEVPRINTF(arg)
64 int pccard_verbose = 1;
66 int pccard_verbose = 0;
69 int pccard_print(void *, const char *);
72 pccard_ccr_read(pf, ccr)
73 struct pccard_function *pf;
76 return (bus_space_read_1(pf->pf_ccrt, pf->pf_ccrh,
77 pf->pf_ccr_offset + ccr));
81 pccard_ccr_write(pf, ccr, val)
82 struct pccard_function *pf;
87 if ((pf->ccr_mask) & (1 << (ccr / 2))) {
88 bus_space_write_1(pf->pf_ccrt, pf->pf_ccrh,
89 pf->pf_ccr_offset + ccr, val);
94 pccard_attach_card(device_t dev)
96 struct pccard_softc *sc = (struct pccard_softc *)
97 device_get_softc(dev);
98 struct pccard_function *pf;
101 DEVPRINTF((dev, "pccard_card_attach\n"));
103 * this is here so that when socket_enable calls gettype, trt happens
105 STAILQ_INIT(&sc->card.pf_head);
107 DEVPRINTF((dev, "chip_socket_enable\n"));
108 POWER_ENABLE_SOCKET(device_get_parent(dev), dev);
110 DEVPRINTF((dev, "read_cis\n"));
113 DEVPRINTF((dev, "chip_socket_disable\n"));
114 POWER_DISABLE_SOCKET(device_get_parent(dev), dev);
116 DEVPRINTF((dev, "check_cis_quirks\n"));
117 pccard_check_cis_quirks(dev);
120 * bail now if the card has no functions, or if there was an error in
126 if (STAILQ_EMPTY(&sc->card.pf_head))
130 pccard_print_cis(dev);
134 DEVPRINTF((dev, "functions scanning\n"));
135 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
136 if (STAILQ_EMPTY(&pf->cfe_head))
145 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
146 if (STAILQ_EMPTY(&pf->cfe_head))
150 if (attach_child()) {
153 DEVPRINTF((sc->dev, "function %d CCR at %d "
154 "offset %lx: %x %x %x %x, %x %x %x %x, %x\n",
155 pf->number, pf->pf_ccr_window, pf->pf_ccr_offset,
156 pccard_ccr_read(pf, 0x00),
157 pccard_ccr_read(pf, 0x02), pccard_ccr_read(pf, 0x04),
158 pccard_ccr_read(pf, 0x06), pccard_ccr_read(pf, 0x0A),
159 pccard_ccr_read(pf, 0x0C), pccard_ccr_read(pf, 0x0E),
160 pccard_ccr_read(pf, 0x10), pccard_ccr_read(pf, 0x12)));
165 return (attached ? 0 : 1);
169 pccard_detach_card(device_t dev, int flags)
171 struct pccard_softc *sc = (struct pccard_softc *)
172 device_get_softc(dev);
173 struct pccard_function *pf;
179 * We are running on either the PCCARD socket's event thread
180 * or in user context detaching a device by user request.
182 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
183 if (STAILQ_FIRST(&pf->cfe_head) == NULL)
186 DEVPRINTF((sc->dev, "detaching %s (function %d)\n",
187 device_get_name(pf->child), pf->number));
188 if ((error = config_detach(pf->child, flags)) != 0) {
189 device_printf(sc->dev,
190 "error %d detaching %s (function %d)\n",
191 error, device_get_name(pf->child), pf->number);
200 pccard_card_gettype(device_t dev, int *type)
202 struct pccard_softc *sc = (struct pccard_softc *)
203 device_get_softc(dev);
204 struct pccard_function *pf;
207 * set the iftype to memory if this card has no functions (not yet
208 * probed), or only one function, and that is not initialized yet or
211 pf = STAILQ_FIRST(&sc->card.pf_head);
213 (STAILQ_NEXT(pf, pf_list) == NULL &&
214 (pf->cfe == NULL || pf->cfe->iftype == PCCARD_IFTYPE_MEMORY)))
215 *type = PCCARD_IFTYPE_MEMORY;
217 *type = PCCARD_IFTYPE_IO;
222 * Initialize a PCCARD function. May be called as long as the function is
226 pccard_function_init(struct pccard_function *pf,
227 struct pccard_config_entry *cfe)
229 if (pf->pf_flags & PFF_ENABLED)
230 panic("pccard_function_init: function is enabled");
232 /* Remember which configuration entry we are using. */
236 /* Enable a PCCARD function */
238 pccard_function_enable(struct pccard_function *pf)
240 struct pccard_function *tmp;
242 device_t dev = pf->sc->dev;
245 panic("pccard_function_enable: function not initialized");
248 * Increase the reference count on the socket, enabling power, if
251 if (pf->sc->sc_enabled_count++ == 0)
252 POWER_ENABLE_SOCKET(device_get_parent(dev), dev);
253 DEVPRINTF((dev, "++enabled_count = %d\n", pf->sc->sc_enabled_count));
255 if (pf->pf_flags & PFF_ENABLED) {
257 * Don't do anything if we're already enabled.
263 * it's possible for different functions' CCRs to be in the same
264 * underlying page. Check for that.
267 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
268 if ((tmp->pf_flags & PFF_ENABLED) &&
269 (pf->ccr_base >= (tmp->ccr_base - tmp->pf_ccr_offset)) &&
270 ((pf->ccr_base + PCCARD_CCR_SIZE) <=
271 (tmp->ccr_base - tmp->pf_ccr_offset +
272 tmp->pf_ccr_realsize))) {
273 pf->pf_ccrt = tmp->pf_ccrt;
274 pf->pf_ccrh = tmp->pf_ccrh;
275 pf->pf_ccr_realsize = tmp->pf_ccr_realsize;
278 * pf->pf_ccr_offset = (tmp->pf_ccr_offset -
279 * tmp->ccr_base) + pf->ccr_base;
282 (tmp->pf_ccr_offset + pf->ccr_base) -
284 pf->pf_ccr_window = tmp->pf_ccr_window;
291 pf->ccr_res = bus_alloc_resource(dev, SYS_RES_MEMORY,
292 &pf->ccr_rid, pf->ccr_base, pf->ccr_base + PCCARD_CCR_SIZE,
293 PCCARD_CCR_SIZE, RF_ACTIVE);
294 /* XXX SET MEM_ATTR */
297 pf->pf_ccrt = rman_get_bustag(pf->ccr_res);
298 pf->pf_ccrh = rman_get_bushandle(pf->ccr_res);
299 pf->pf_ccr_offset = rman_get_start(pf->ccr_res);
300 pf->pf_ccr_realsize = 1;
303 reg = (pf->cfe->number & PCCARD_CCR_OPTION_CFINDEX);
304 reg |= PCCARD_CCR_OPTION_LEVIREQ;
305 if (pccard_mfc(pf->sc)) {
306 reg |= (PCCARD_CCR_OPTION_FUNC_ENABLE |
307 PCCARD_CCR_OPTION_ADDR_DECODE);
309 reg |= PCCARD_CCR_OPTION_IREQ_ENABLE;
312 pccard_ccr_write(pf, PCCARD_CCR_OPTION, reg);
316 if ((pf->cfe->flags & PCCARD_CFE_IO16) == 0)
317 reg |= PCCARD_CCR_STATUS_IOIS8;
318 if (pf->cfe->flags & PCCARD_CFE_AUDIO)
319 reg |= PCCARD_CCR_STATUS_AUDIO;
320 pccard_ccr_write(pf, PCCARD_CCR_STATUS, reg);
322 pccard_ccr_write(pf, PCCARD_CCR_SOCKETCOPY, 0);
324 if (pccard_mfc(pf->sc)) {
327 tmp = pf->pf_mfc_iomax - pf->pf_mfc_iobase;
328 /* round up to nearest (2^n)-1 */
329 for (iosize = 1; iosize < tmp; iosize <<= 1)
333 pccard_ccr_write(pf, PCCARD_CCR_IOBASE0,
334 pf->pf_mfc_iobase & 0xff);
335 pccard_ccr_write(pf, PCCARD_CCR_IOBASE1,
336 (pf->pf_mfc_iobase >> 8) & 0xff);
337 pccard_ccr_write(pf, PCCARD_CCR_IOBASE2, 0);
338 pccard_ccr_write(pf, PCCARD_CCR_IOBASE3, 0);
340 pccard_ccr_write(pf, PCCARD_CCR_IOSIZE, iosize);
345 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
346 device_printf(tmp->sc->dev,
347 "function %d CCR at %d offset %x: "
348 "%x %x %x %x, %x %x %x %x, %x\n",
349 tmp->number, tmp->pf_ccr_window,
351 pccard_ccr_read(tmp, 0x00),
352 pccard_ccr_read(tmp, 0x02),
353 pccard_ccr_read(tmp, 0x04),
354 pccard_ccr_read(tmp, 0x06),
355 pccard_ccr_read(tmp, 0x0A),
356 pccard_ccr_read(tmp, 0x0C),
357 pccard_ccr_read(tmp, 0x0E),
358 pccard_ccr_read(tmp, 0x10),
359 pccard_ccr_read(tmp, 0x12));
363 pf->pf_flags |= PFF_ENABLED;
368 * Decrement the reference count, and power down the socket, if
371 if (--pf->sc->sc_enabled_count == 0)
372 POWER_DISABLE_SOCKET(device_get_parent(dev), dev);
373 DEVPRINTF((dev, "--enabled_count = %d\n", pf->sc->sc_enabled_count));
378 /* Disable PCCARD function. */
380 pccard_function_disable(struct pccard_function *pf)
382 struct pccard_function *tmp;
383 device_t dev = pf->sc->dev;
386 panic("pccard_function_enable: function not initialized");
388 if ((pf->pf_flags & PFF_ENABLED) == 0) {
390 * Don't do anything if we're already disabled.
396 * it's possible for different functions' CCRs to be in the same
397 * underlying page. Check for that. Note we mark us as disabled
398 * first to avoid matching ourself.
401 pf->pf_flags &= ~PFF_ENABLED;
402 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
403 if ((tmp->pf_flags & PFF_ENABLED) &&
404 (pf->ccr_base >= (tmp->ccr_base - tmp->pf_ccr_offset)) &&
405 ((pf->ccr_base + PCCARD_CCR_SIZE) <=
406 (tmp->ccr_base - tmp->pf_ccr_offset + tmp->pf_ccr_realsize)))
410 /* Not used by anyone else; unmap the CCR. */
412 bus_release_resource(dev, SYS_RES_MEMORY, pf->ccr_rid,
418 * Decrement the reference count, and power down the socket, if
421 if (--pf->sc->sc_enabled_count == 0)
422 POWER_DISABLE_SOCKET(device_get_parent(dev), dev);
423 DEVPRINTF((dev, "--enabled_count = %d\n", pf->sc->sc_enabled_count));
427 /* XXX These functions are needed, but not like this XXX */
429 pccard_io_map(struct pccard_function *pf, int width, bus_addr_t offset,
430 bus_size_t size, struct pccard_io_handle *pcihp, int *windowp)
434 if (pccard_chip_io_map(pf->sc->pct, pf->sc->pch,
435 width, offset, size, pcihp, windowp))
439 * XXX in the multifunction multi-iospace-per-function case, this
440 * needs to cooperate with io_alloc to make sure that the spaces
441 * don't overlap, and that the ccr's are set correctly
444 if (pccard_mfc(pf->sc)) {
447 if (pf->pf_mfc_iomax == 0) {
448 pf->pf_mfc_iobase = pcihp->addr + offset;
449 pf->pf_mfc_iomax = pf->pf_mfc_iobase + size;
451 /* this makes the assumption that nothing overlaps */
452 if (pf->pf_mfc_iobase > pcihp->addr + offset)
453 pf->pf_mfc_iobase = pcihp->addr + offset;
454 if (pf->pf_mfc_iomax < pcihp->addr + offset + size)
455 pf->pf_mfc_iomax = pcihp->addr + offset + size;
458 tmp = pf->pf_mfc_iomax - pf->pf_mfc_iobase;
459 /* round up to nearest (2^n)-1 */
460 for (iosize = 1; iosize >= tmp; iosize <<= 1)
464 pccard_ccr_write(pf, PCCARD_CCR_IOBASE0,
465 pf->pf_mfc_iobase & 0xff);
466 pccard_ccr_write(pf, PCCARD_CCR_IOBASE1,
467 (pf->pf_mfc_iobase >> 8) & 0xff);
468 pccard_ccr_write(pf, PCCARD_CCR_IOBASE2, 0);
469 pccard_ccr_write(pf, PCCARD_CCR_IOBASE3, 0);
471 pccard_ccr_write(pf, PCCARD_CCR_IOSIZE, iosize);
473 reg = pccard_ccr_read(pf, PCCARD_CCR_OPTION);
474 reg |= PCCARD_CCR_OPTION_ADDR_DECODE;
475 pccard_ccr_write(pf, PCCARD_CCR_OPTION, reg);
481 pccard_io_unmap(struct pccard_function *pf, int window)
484 pccard_chip_io_unmap(pf->sc->pct, pf->sc->pch, window);
486 /* XXX Anything for multi-function cards? */
490 #define PCCARD_NPORT 2
491 #define PCCARD_NMEM 5
492 #define PCCARD_NIRQ 1
493 #define PCCARD_NDRQ 0
496 pccard_add_children(device_t dev, int busno)
498 /* Call parent to scan for any current children */
503 pccard_probe(device_t dev)
505 device_set_desc(dev, "PC Card bus -- newconfig version");
506 return pccard_add_children(dev, device_get_unit(dev));
510 pccard_attach(device_t dev)
512 struct pccard_softc *sc;
514 sc = (struct pccard_softc *) device_get_softc(dev);
517 return bus_generic_attach(dev);
521 pccard_print_resources(struct resource_list *rl, const char *name, int type,
522 int count, const char *format)
524 struct resource_list_entry *rle;
529 for (i = 0; i < count; i++) {
530 rle = resource_list_find(rl, type, i);
533 printf(" %s ", name);
534 else if (printed > 0)
537 printf(format, rle->start);
538 if (rle->count > 1) {
540 printf(format, rle->start + rle->count - 1);
543 /* check the first few regardless */
550 pccard_print_child(device_t dev, device_t child)
552 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
553 struct resource_list *rl = &devi->resources;
556 retval += bus_print_child_header(dev, child);
557 retval += printf(" at");
560 pccard_print_resources(rl, "port", SYS_RES_IOPORT,
561 PCCARD_NPORT, "%#lx");
562 pccard_print_resources(rl, "iomem", SYS_RES_MEMORY,
563 PCCARD_NMEM, "%#lx");
564 pccard_print_resources(rl, "irq", SYS_RES_IRQ, PCCARD_NIRQ,
566 pccard_print_resources(rl, "drq", SYS_RES_DRQ, PCCARD_NDRQ,
568 retval += printf(" slot %d", devi->slotnum);
571 retval += bus_print_child_footer(dev, child);
577 pccard_set_resource(device_t dev, device_t child, int type, int rid,
578 u_long start, u_long count)
580 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
581 struct resource_list *rl = &devi->resources;
583 if (type != SYS_RES_IOPORT && type != SYS_RES_MEMORY
584 && type != SYS_RES_IRQ && type != SYS_RES_DRQ)
588 if (type == SYS_RES_IOPORT && rid >= PCCARD_NPORT)
590 if (type == SYS_RES_MEMORY && rid >= PCCARD_NMEM)
592 if (type == SYS_RES_IRQ && rid >= PCCARD_NIRQ)
594 if (type == SYS_RES_DRQ && rid >= PCCARD_NDRQ)
597 resource_list_add(rl, type, rid, start, start + count - 1, count);
603 pccard_get_resource(device_t dev, device_t child, int type, int rid,
604 u_long *startp, u_long *countp)
606 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
607 struct resource_list *rl = &devi->resources;
608 struct resource_list_entry *rle;
610 rle = resource_list_find(rl, type, rid);
615 *startp = rle->start;
617 *countp = rle->count;
623 pccard_delete_resource(device_t dev, device_t child, int type, int rid)
625 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
626 struct resource_list *rl = &devi->resources;
627 resource_list_delete(rl, type, rid);
631 pccard_set_res_flags(device_t dev, device_t child, int type, int rid,
634 return CARD_SET_RES_FLAGS(device_get_parent(dev), child, type,
639 pccard_set_memory_offset(device_t dev, device_t child, int rid,
642 return CARD_SET_MEMORY_OFFSET(device_get_parent(dev), child, rid,
646 static device_method_t pccard_methods[] = {
647 /* Device interface */
648 DEVMETHOD(device_probe, pccard_probe),
649 DEVMETHOD(device_attach, pccard_attach),
650 DEVMETHOD(device_shutdown, bus_generic_shutdown),
651 DEVMETHOD(device_suspend, bus_generic_suspend),
652 DEVMETHOD(device_resume, bus_generic_resume),
655 DEVMETHOD(bus_print_child, pccard_print_child),
656 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
657 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
658 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
659 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
660 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
661 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
662 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
663 DEVMETHOD(bus_set_resource, pccard_set_resource),
664 DEVMETHOD(bus_get_resource, pccard_get_resource),
665 DEVMETHOD(bus_delete_resource, pccard_delete_resource),
668 DEVMETHOD(card_set_res_flags, pccard_set_res_flags),
669 DEVMETHOD(card_set_memory_offset, pccard_set_memory_offset),
670 DEVMETHOD(card_get_type, pccard_card_gettype),
671 DEVMETHOD(card_attach_card, pccard_attach_card),
672 DEVMETHOD(card_detach_card, pccard_detach_card),
677 static driver_t pccard_driver = {
683 devclass_t pccard_devclass;
685 DRIVER_MODULE(pccard, pcic, pccard_driver, pccard_devclass, 0, 0);
686 DRIVER_MODULE(pccard, pc98pcic, pccard_driver, pccard_devclass, 0, 0);
687 DRIVER_MODULE(pccard, pccbb, pccard_driver, pccard_devclass, 0, 0);
688 DRIVER_MODULE(pccard, tcic, pccard_driver, pccard_devclass, 0, 0);