2 * Copyright (c) 1997 Marc Horowitz. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. All advertising materials mentioning features or use of this software
13 * must display the following acknowledgement:
14 * This product includes software developed by Marc Horowitz.
15 * 4. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * $NetBSD: pcmcia.c,v 1.13 1998/12/24 04:51:59 marc Exp $
30 * $FreeBSD: src/sys/dev/pccard/pccard.c,v 1.8.2.1 2000/05/23 03:56:59 imp Exp $
31 * $DragonFly: src/sys/dev/misc/pccard/Attic/pccard.c,v 1.3 2003/08/15 08:32:29 dillon Exp $
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
38 #include <sys/kernel.h>
39 #include <sys/queue.h>
40 #include <sys/types.h>
43 #include <machine/bus.h>
45 #include <machine/resource.h>
47 #include <bus/pccard/pccardreg.h>
48 #include <bus/pccard/pccardvar.h>
57 #define DPRINTF(arg) if (pccard_debug) printf arg
58 #define DEVPRINTF(arg) if (pccard_debug) device_printf arg
61 #define DEVPRINTF(arg)
65 int pccard_verbose = 1;
67 int pccard_verbose = 0;
70 int pccard_print(void *, const char *);
73 pccard_ccr_read(pf, ccr)
74 struct pccard_function *pf;
77 return (bus_space_read_1(pf->pf_ccrt, pf->pf_ccrh,
78 pf->pf_ccr_offset + ccr));
82 pccard_ccr_write(pf, ccr, val)
83 struct pccard_function *pf;
88 if ((pf->ccr_mask) & (1 << (ccr / 2))) {
89 bus_space_write_1(pf->pf_ccrt, pf->pf_ccrh,
90 pf->pf_ccr_offset + ccr, val);
95 pccard_attach_card(device_t dev)
97 struct pccard_softc *sc = (struct pccard_softc *)
98 device_get_softc(dev);
99 struct pccard_function *pf;
102 DEVPRINTF((dev, "pccard_card_attach\n"));
104 * this is here so that when socket_enable calls gettype, trt happens
106 STAILQ_INIT(&sc->card.pf_head);
108 DEVPRINTF((dev, "chip_socket_enable\n"));
109 POWER_ENABLE_SOCKET(device_get_parent(dev), dev);
111 DEVPRINTF((dev, "read_cis\n"));
114 DEVPRINTF((dev, "chip_socket_disable\n"));
115 POWER_DISABLE_SOCKET(device_get_parent(dev), dev);
117 DEVPRINTF((dev, "check_cis_quirks\n"));
118 pccard_check_cis_quirks(dev);
121 * bail now if the card has no functions, or if there was an error in
127 if (STAILQ_EMPTY(&sc->card.pf_head))
131 pccard_print_cis(dev);
135 DEVPRINTF((dev, "functions scanning\n"));
136 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
137 if (STAILQ_EMPTY(&pf->cfe_head))
146 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
147 if (STAILQ_EMPTY(&pf->cfe_head))
151 if (attach_child()) {
154 DEVPRINTF((sc->dev, "function %d CCR at %d "
155 "offset %lx: %x %x %x %x, %x %x %x %x, %x\n",
156 pf->number, pf->pf_ccr_window, pf->pf_ccr_offset,
157 pccard_ccr_read(pf, 0x00),
158 pccard_ccr_read(pf, 0x02), pccard_ccr_read(pf, 0x04),
159 pccard_ccr_read(pf, 0x06), pccard_ccr_read(pf, 0x0A),
160 pccard_ccr_read(pf, 0x0C), pccard_ccr_read(pf, 0x0E),
161 pccard_ccr_read(pf, 0x10), pccard_ccr_read(pf, 0x12)));
166 return (attached ? 0 : 1);
170 pccard_detach_card(device_t dev, int flags)
172 struct pccard_softc *sc = (struct pccard_softc *)
173 device_get_softc(dev);
174 struct pccard_function *pf;
180 * We are running on either the PCCARD socket's event thread
181 * or in user context detaching a device by user request.
183 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
184 if (STAILQ_FIRST(&pf->cfe_head) == NULL)
187 DEVPRINTF((sc->dev, "detaching %s (function %d)\n",
188 device_get_name(pf->child), pf->number));
189 if ((error = config_detach(pf->child, flags)) != 0) {
190 device_printf(sc->dev,
191 "error %d detaching %s (function %d)\n",
192 error, device_get_name(pf->child), pf->number);
201 pccard_card_gettype(device_t dev, int *type)
203 struct pccard_softc *sc = (struct pccard_softc *)
204 device_get_softc(dev);
205 struct pccard_function *pf;
208 * set the iftype to memory if this card has no functions (not yet
209 * probed), or only one function, and that is not initialized yet or
212 pf = STAILQ_FIRST(&sc->card.pf_head);
214 (STAILQ_NEXT(pf, pf_list) == NULL &&
215 (pf->cfe == NULL || pf->cfe->iftype == PCCARD_IFTYPE_MEMORY)))
216 *type = PCCARD_IFTYPE_MEMORY;
218 *type = PCCARD_IFTYPE_IO;
223 * Initialize a PCCARD function. May be called as long as the function is
227 pccard_function_init(struct pccard_function *pf,
228 struct pccard_config_entry *cfe)
230 if (pf->pf_flags & PFF_ENABLED)
231 panic("pccard_function_init: function is enabled");
233 /* Remember which configuration entry we are using. */
237 /* Enable a PCCARD function */
239 pccard_function_enable(struct pccard_function *pf)
241 struct pccard_function *tmp;
243 device_t dev = pf->sc->dev;
246 panic("pccard_function_enable: function not initialized");
249 * Increase the reference count on the socket, enabling power, if
252 if (pf->sc->sc_enabled_count++ == 0)
253 POWER_ENABLE_SOCKET(device_get_parent(dev), dev);
254 DEVPRINTF((dev, "++enabled_count = %d\n", pf->sc->sc_enabled_count));
256 if (pf->pf_flags & PFF_ENABLED) {
258 * Don't do anything if we're already enabled.
264 * it's possible for different functions' CCRs to be in the same
265 * underlying page. Check for that.
268 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
269 if ((tmp->pf_flags & PFF_ENABLED) &&
270 (pf->ccr_base >= (tmp->ccr_base - tmp->pf_ccr_offset)) &&
271 ((pf->ccr_base + PCCARD_CCR_SIZE) <=
272 (tmp->ccr_base - tmp->pf_ccr_offset +
273 tmp->pf_ccr_realsize))) {
274 pf->pf_ccrt = tmp->pf_ccrt;
275 pf->pf_ccrh = tmp->pf_ccrh;
276 pf->pf_ccr_realsize = tmp->pf_ccr_realsize;
279 * pf->pf_ccr_offset = (tmp->pf_ccr_offset -
280 * tmp->ccr_base) + pf->ccr_base;
283 (tmp->pf_ccr_offset + pf->ccr_base) -
285 pf->pf_ccr_window = tmp->pf_ccr_window;
292 pf->ccr_res = bus_alloc_resource(dev, SYS_RES_MEMORY,
293 &pf->ccr_rid, pf->ccr_base, pf->ccr_base + PCCARD_CCR_SIZE,
294 PCCARD_CCR_SIZE, RF_ACTIVE);
295 /* XXX SET MEM_ATTR */
298 pf->pf_ccrt = rman_get_bustag(pf->ccr_res);
299 pf->pf_ccrh = rman_get_bushandle(pf->ccr_res);
300 pf->pf_ccr_offset = rman_get_start(pf->ccr_res);
301 pf->pf_ccr_realsize = 1;
304 reg = (pf->cfe->number & PCCARD_CCR_OPTION_CFINDEX);
305 reg |= PCCARD_CCR_OPTION_LEVIREQ;
306 if (pccard_mfc(pf->sc)) {
307 reg |= (PCCARD_CCR_OPTION_FUNC_ENABLE |
308 PCCARD_CCR_OPTION_ADDR_DECODE);
310 reg |= PCCARD_CCR_OPTION_IREQ_ENABLE;
313 pccard_ccr_write(pf, PCCARD_CCR_OPTION, reg);
317 if ((pf->cfe->flags & PCCARD_CFE_IO16) == 0)
318 reg |= PCCARD_CCR_STATUS_IOIS8;
319 if (pf->cfe->flags & PCCARD_CFE_AUDIO)
320 reg |= PCCARD_CCR_STATUS_AUDIO;
321 pccard_ccr_write(pf, PCCARD_CCR_STATUS, reg);
323 pccard_ccr_write(pf, PCCARD_CCR_SOCKETCOPY, 0);
325 if (pccard_mfc(pf->sc)) {
328 tmp = pf->pf_mfc_iomax - pf->pf_mfc_iobase;
329 /* round up to nearest (2^n)-1 */
330 for (iosize = 1; iosize < tmp; iosize <<= 1)
334 pccard_ccr_write(pf, PCCARD_CCR_IOBASE0,
335 pf->pf_mfc_iobase & 0xff);
336 pccard_ccr_write(pf, PCCARD_CCR_IOBASE1,
337 (pf->pf_mfc_iobase >> 8) & 0xff);
338 pccard_ccr_write(pf, PCCARD_CCR_IOBASE2, 0);
339 pccard_ccr_write(pf, PCCARD_CCR_IOBASE3, 0);
341 pccard_ccr_write(pf, PCCARD_CCR_IOSIZE, iosize);
346 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
347 device_printf(tmp->sc->dev,
348 "function %d CCR at %d offset %x: "
349 "%x %x %x %x, %x %x %x %x, %x\n",
350 tmp->number, tmp->pf_ccr_window,
352 pccard_ccr_read(tmp, 0x00),
353 pccard_ccr_read(tmp, 0x02),
354 pccard_ccr_read(tmp, 0x04),
355 pccard_ccr_read(tmp, 0x06),
356 pccard_ccr_read(tmp, 0x0A),
357 pccard_ccr_read(tmp, 0x0C),
358 pccard_ccr_read(tmp, 0x0E),
359 pccard_ccr_read(tmp, 0x10),
360 pccard_ccr_read(tmp, 0x12));
364 pf->pf_flags |= PFF_ENABLED;
369 * Decrement the reference count, and power down the socket, if
372 if (--pf->sc->sc_enabled_count == 0)
373 POWER_DISABLE_SOCKET(device_get_parent(dev), dev);
374 DEVPRINTF((dev, "--enabled_count = %d\n", pf->sc->sc_enabled_count));
379 /* Disable PCCARD function. */
381 pccard_function_disable(struct pccard_function *pf)
383 struct pccard_function *tmp;
384 device_t dev = pf->sc->dev;
387 panic("pccard_function_enable: function not initialized");
389 if ((pf->pf_flags & PFF_ENABLED) == 0) {
391 * Don't do anything if we're already disabled.
397 * it's possible for different functions' CCRs to be in the same
398 * underlying page. Check for that. Note we mark us as disabled
399 * first to avoid matching ourself.
402 pf->pf_flags &= ~PFF_ENABLED;
403 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
404 if ((tmp->pf_flags & PFF_ENABLED) &&
405 (pf->ccr_base >= (tmp->ccr_base - tmp->pf_ccr_offset)) &&
406 ((pf->ccr_base + PCCARD_CCR_SIZE) <=
407 (tmp->ccr_base - tmp->pf_ccr_offset + tmp->pf_ccr_realsize)))
411 /* Not used by anyone else; unmap the CCR. */
413 bus_release_resource(dev, SYS_RES_MEMORY, pf->ccr_rid,
419 * Decrement the reference count, and power down the socket, if
422 if (--pf->sc->sc_enabled_count == 0)
423 POWER_DISABLE_SOCKET(device_get_parent(dev), dev);
424 DEVPRINTF((dev, "--enabled_count = %d\n", pf->sc->sc_enabled_count));
428 /* XXX These functions are needed, but not like this XXX */
430 pccard_io_map(struct pccard_function *pf, int width, bus_addr_t offset,
431 bus_size_t size, struct pccard_io_handle *pcihp, int *windowp)
435 if (pccard_chip_io_map(pf->sc->pct, pf->sc->pch,
436 width, offset, size, pcihp, windowp))
440 * XXX in the multifunction multi-iospace-per-function case, this
441 * needs to cooperate with io_alloc to make sure that the spaces
442 * don't overlap, and that the ccr's are set correctly
445 if (pccard_mfc(pf->sc)) {
448 if (pf->pf_mfc_iomax == 0) {
449 pf->pf_mfc_iobase = pcihp->addr + offset;
450 pf->pf_mfc_iomax = pf->pf_mfc_iobase + size;
452 /* this makes the assumption that nothing overlaps */
453 if (pf->pf_mfc_iobase > pcihp->addr + offset)
454 pf->pf_mfc_iobase = pcihp->addr + offset;
455 if (pf->pf_mfc_iomax < pcihp->addr + offset + size)
456 pf->pf_mfc_iomax = pcihp->addr + offset + size;
459 tmp = pf->pf_mfc_iomax - pf->pf_mfc_iobase;
460 /* round up to nearest (2^n)-1 */
461 for (iosize = 1; iosize >= tmp; iosize <<= 1)
465 pccard_ccr_write(pf, PCCARD_CCR_IOBASE0,
466 pf->pf_mfc_iobase & 0xff);
467 pccard_ccr_write(pf, PCCARD_CCR_IOBASE1,
468 (pf->pf_mfc_iobase >> 8) & 0xff);
469 pccard_ccr_write(pf, PCCARD_CCR_IOBASE2, 0);
470 pccard_ccr_write(pf, PCCARD_CCR_IOBASE3, 0);
472 pccard_ccr_write(pf, PCCARD_CCR_IOSIZE, iosize);
474 reg = pccard_ccr_read(pf, PCCARD_CCR_OPTION);
475 reg |= PCCARD_CCR_OPTION_ADDR_DECODE;
476 pccard_ccr_write(pf, PCCARD_CCR_OPTION, reg);
482 pccard_io_unmap(struct pccard_function *pf, int window)
485 pccard_chip_io_unmap(pf->sc->pct, pf->sc->pch, window);
487 /* XXX Anything for multi-function cards? */
491 #define PCCARD_NPORT 2
492 #define PCCARD_NMEM 5
493 #define PCCARD_NIRQ 1
494 #define PCCARD_NDRQ 0
497 pccard_add_children(device_t dev, int busno)
499 /* Call parent to scan for any current children */
504 pccard_probe(device_t dev)
506 device_set_desc(dev, "PC Card bus -- newconfig version");
507 return pccard_add_children(dev, device_get_unit(dev));
511 pccard_attach(device_t dev)
513 struct pccard_softc *sc;
515 sc = (struct pccard_softc *) device_get_softc(dev);
518 return bus_generic_attach(dev);
522 pccard_print_resources(struct resource_list *rl, const char *name, int type,
523 int count, const char *format)
525 struct resource_list_entry *rle;
530 for (i = 0; i < count; i++) {
531 rle = resource_list_find(rl, type, i);
534 printf(" %s ", name);
535 else if (printed > 0)
538 printf(format, rle->start);
539 if (rle->count > 1) {
541 printf(format, rle->start + rle->count - 1);
544 /* check the first few regardless */
551 pccard_print_child(device_t dev, device_t child)
553 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
554 struct resource_list *rl = &devi->resources;
557 retval += bus_print_child_header(dev, child);
558 retval += printf(" at");
561 pccard_print_resources(rl, "port", SYS_RES_IOPORT,
562 PCCARD_NPORT, "%#lx");
563 pccard_print_resources(rl, "iomem", SYS_RES_MEMORY,
564 PCCARD_NMEM, "%#lx");
565 pccard_print_resources(rl, "irq", SYS_RES_IRQ, PCCARD_NIRQ,
567 pccard_print_resources(rl, "drq", SYS_RES_DRQ, PCCARD_NDRQ,
569 retval += printf(" slot %d", devi->slotnum);
572 retval += bus_print_child_footer(dev, child);
578 pccard_set_resource(device_t dev, device_t child, int type, int rid,
579 u_long start, u_long count)
581 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
582 struct resource_list *rl = &devi->resources;
584 if (type != SYS_RES_IOPORT && type != SYS_RES_MEMORY
585 && type != SYS_RES_IRQ && type != SYS_RES_DRQ)
589 if (type == SYS_RES_IOPORT && rid >= PCCARD_NPORT)
591 if (type == SYS_RES_MEMORY && rid >= PCCARD_NMEM)
593 if (type == SYS_RES_IRQ && rid >= PCCARD_NIRQ)
595 if (type == SYS_RES_DRQ && rid >= PCCARD_NDRQ)
598 resource_list_add(rl, type, rid, start, start + count - 1, count);
604 pccard_get_resource(device_t dev, device_t child, int type, int rid,
605 u_long *startp, u_long *countp)
607 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
608 struct resource_list *rl = &devi->resources;
609 struct resource_list_entry *rle;
611 rle = resource_list_find(rl, type, rid);
616 *startp = rle->start;
618 *countp = rle->count;
624 pccard_delete_resource(device_t dev, device_t child, int type, int rid)
626 struct pccard_ivar *devi = (struct pccard_ivar *) device_get_ivars(child);
627 struct resource_list *rl = &devi->resources;
628 resource_list_delete(rl, type, rid);
632 pccard_set_res_flags(device_t dev, device_t child, int type, int rid,
635 return CARD_SET_RES_FLAGS(device_get_parent(dev), child, type,
640 pccard_set_memory_offset(device_t dev, device_t child, int rid,
643 return CARD_SET_MEMORY_OFFSET(device_get_parent(dev), child, rid,
647 static device_method_t pccard_methods[] = {
648 /* Device interface */
649 DEVMETHOD(device_probe, pccard_probe),
650 DEVMETHOD(device_attach, pccard_attach),
651 DEVMETHOD(device_shutdown, bus_generic_shutdown),
652 DEVMETHOD(device_suspend, bus_generic_suspend),
653 DEVMETHOD(device_resume, bus_generic_resume),
656 DEVMETHOD(bus_print_child, pccard_print_child),
657 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
658 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
659 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
660 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
661 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
662 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
663 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
664 DEVMETHOD(bus_set_resource, pccard_set_resource),
665 DEVMETHOD(bus_get_resource, pccard_get_resource),
666 DEVMETHOD(bus_delete_resource, pccard_delete_resource),
669 DEVMETHOD(card_set_res_flags, pccard_set_res_flags),
670 DEVMETHOD(card_set_memory_offset, pccard_set_memory_offset),
671 DEVMETHOD(card_get_type, pccard_card_gettype),
672 DEVMETHOD(card_attach_card, pccard_attach_card),
673 DEVMETHOD(card_detach_card, pccard_detach_card),
678 static driver_t pccard_driver = {
684 devclass_t pccard_devclass;
686 DRIVER_MODULE(pccard, pcic, pccard_driver, pccard_devclass, 0, 0);
687 DRIVER_MODULE(pccard, pc98pcic, pccard_driver, pccard_devclass, 0, 0);
688 DRIVER_MODULE(pccard, pccbb, pccard_driver, pccard_devclass, 0, 0);
689 DRIVER_MODULE(pccard, tcic, pccard_driver, pccard_devclass, 0, 0);