1/*-
2 * Copyright (c) 2002-2004 M. Warner Losh.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27/*
28 * Driver for ISA to PCMCIA bridges compliant with the Intel ExCA
29 * specification.
30 */
31
32#include <sys/cdefs.h>
33__FBSDID("$FreeBSD$");
34
35#include <sys/param.h>
36#include <sys/systm.h>
37#include <sys/proc.h>
38#include <sys/condvar.h>
39#include <sys/errno.h>
40#include <sys/kernel.h>
41#include <sys/lock.h>
42#include <sys/malloc.h>
43#include <sys/module.h>
44#include <sys/mutex.h>
45#include <sys/sysctl.h>
46#include <sys/kthread.h>
47#include <sys/bus.h>
48#include <machine/bus.h>
49#include <sys/rman.h>
50#include <machine/resource.h>
51
52#include <isa/isavar.h>
53
54#include <dev/pccard/pccardreg.h>
55#include <dev/pccard/pccardvar.h>
56
57#include <dev/exca/excareg.h>
58#include <dev/exca/excavar.h>
59
60#include <dev/pccbb/pccbbreg.h>
61#include <dev/pccbb/pccbbvar.h>
62
63#include "power_if.h"
64#include "card_if.h"
65
66/*****************************************************************************
67 * Configurable parameters.
68 *****************************************************************************/
69
70/* sysctl vars */
71static SYSCTL_NODE(_hw, OID_AUTO, pcic, CTLFLAG_RD, 0, "PCIC parameters");
72
73static int isa_intr_mask = EXCA_INT_MASK_ALLOWED;
74TUNABLE_INT("hw.cbb.intr_mask", &isa_intr_mask);
75SYSCTL_INT(_hw_pcic, OID_AUTO, intr_mask, CTLFLAG_RD, &isa_intr_mask, 0,
76    "Mask of allowable interrupts for this laptop.  The default is generally\n\
77correct, but some laptops do not route all the IRQ pins to the bridge to\n\
78save wires.  Sometimes you need a more restrictive mask because some of the\n\
79hardware in your laptop may not have a driver so its IRQ might not be\n\
80allocated.");
81
82/*
83 * CL-PD6722's VSENSE method
84 *     0: NO VSENSE (assume a 5.0V card always)
85 *     1: 6710's method (default)
86 *     2: 6729's method
87 */
88int pcic_pd6722_vsense = 1;
89TUNABLE_INT("hw.pcic.pd6722_vsense", &pcic_pd6722_vsense);
90SYSCTL_INT(_hw_pcic, OID_AUTO, pd6722_vsense, CTLFLAG_RDTUN,
91    &pcic_pd6722_vsense, 1,
92    "Select CL-PD6722's VSENSE method.  VSENSE is used to determine the\n\
93volatage of inserted cards.  The CL-PD6722 has two methods to determine the\n\
94voltage of the card.  0 means assume a 5.0V card and do not check.  1 means\n\
95use the same method that the CL-PD6710 uses (default).  2 means use the\n\
96same method as the CL-PD6729.  2 is documented in the datasheet as being\n\
97the correct way, but 1 seems to give better results on more laptops.");
98
99/*****************************************************************************
100 * End of configurable parameters.
101 *****************************************************************************/
102
103#define	DPRINTF(x) do { if (cbb_debug) printf x; } while (0)
104#define	DEVPRINTF(x) do { if (cbb_debug) device_printf x; } while (0)
105
106/* XXX Not sure that PNP0E03 should be claimed, except maybe on pc98 */
107static struct isa_pnp_id pcic_ids[] = {
108	{EXCA_PNP_ACTIONTEC,		NULL},		/* AEI0218 */
109	{EXCA_PNP_IBM3765,		NULL},		/* IBM3765 */
110	{EXCA_PNP_82365,		NULL},		/* PNP0E00 */
111	{EXCA_PNP_CL_PD6720,		NULL},		/* PNP0E01 */
112	{EXCA_PNP_VLSI_82C146,		NULL},		/* PNP0E02 */
113	{EXCA_PNP_82365_CARDBUS,	NULL},		/* PNP0E03 */
114	{EXCA_PNP_SCM_SWAPBOX,		NULL},		/* SCM0469 */
115	{EXCA_NEC_PC9801_102,		NULL},		/* NEC8091 */
116	{EXCA_NEC_PC9821RA_E01,         NULL},          /* NEC8121 */
117	{0}
118};
119
120/************************************************************************/
121/* Probe/Attach								*/
122/************************************************************************/
123
124static int
125cbb_isa_activate(device_t dev)
126{
127	struct cbb_softc *sc = device_get_softc(dev);
128	struct resource *res;
129	int rid;
130	int i;
131
132	/* A little bogus, but go ahead and get the irq for CSC events */
133	rid = 0;
134	res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
135	if (res == NULL) {
136		/*
137		 * No IRQ specified, find one.  This can be due to the PnP
138		 * data not specifying any IRQ, or the default kernel not
139		 * assinging an IRQ.
140		 */
141		for (i = 0; i < 16 && res == NULL; i++) {
142			if (((1 << i) & isa_intr_mask) == 0)
143				continue;
144			res = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, i, i,
145			    1, RF_ACTIVE);
146		}
147	}
148	if (res == NULL)
149		return (ENXIO);
150	sc->irq_res = res;
151	rid = 0;
152	res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE);
153	if (res == NULL) {
154		bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq_res);
155		sc->irq_res = NULL;
156		device_printf(dev, "Cannot allocate I/O\n");
157		return (ENOMEM);
158	}
159	sc->bst = rman_get_bustag(res);
160	sc->bsh = rman_get_bushandle(res);
161	sc->base_res = res;
162	return (0);
163}
164
165static void
166cbb_isa_deactivate(device_t dev)
167{
168	struct cbb_softc *sc = device_get_softc(dev);
169
170	if (sc->irq_res)
171		bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq_res);
172	sc->irq_res = NULL;
173	if (sc->base_res)
174		bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->base_res);
175	sc->base_res = NULL;
176}
177
178static int
179cbb_isa_probe(device_t dev)
180{
181	int error;
182	struct cbb_softc *sc = device_get_softc(dev);
183
184	/* Check isapnp ids */
185	error = ISA_PNP_PROBE(device_get_parent(dev), dev, pcic_ids);
186	if (error != 0 && error != ENOENT)
187		return (error);
188
189	error = cbb_isa_activate(dev);
190	if (error != 0)
191		return (error);
192
193	/* Check to make sure that we have actual hardware */
194	error = exca_probe_slots(dev, &sc->exca[0], sc->bst, sc->bsh);
195	cbb_isa_deactivate(dev);
196	return (error);
197}
198
199static int
200cbb_isa_attach(device_t dev)
201{
202	return (ENOMEM);
203}
204
205static device_method_t cbb_methods[] = {
206	/* Device interface */
207	DEVMETHOD(device_probe,			cbb_isa_probe),
208	DEVMETHOD(device_attach,		cbb_isa_attach),
209	DEVMETHOD(device_detach,		cbb_detach),
210	DEVMETHOD(device_suspend,		cbb_suspend),
211	DEVMETHOD(device_resume,		cbb_resume),
212
213	/* bus methods */
214	DEVMETHOD(bus_read_ivar,		cbb_read_ivar),
215	DEVMETHOD(bus_write_ivar,		cbb_write_ivar),
216	DEVMETHOD(bus_alloc_resource,		cbb_alloc_resource),
217	DEVMETHOD(bus_release_resource,		cbb_release_resource),
218	DEVMETHOD(bus_activate_resource,	cbb_activate_resource),
219	DEVMETHOD(bus_deactivate_resource,	cbb_deactivate_resource),
220	DEVMETHOD(bus_driver_added,		cbb_driver_added),
221	DEVMETHOD(bus_child_detached,		cbb_child_detached),
222	DEVMETHOD(bus_setup_intr,		cbb_setup_intr),
223	DEVMETHOD(bus_teardown_intr,		cbb_teardown_intr),
224	DEVMETHOD(bus_child_present,		cbb_child_present),
225
226	/* 16-bit card interface */
227	DEVMETHOD(card_set_res_flags,		cbb_pcic_set_res_flags),
228	DEVMETHOD(card_set_memory_offset,	cbb_pcic_set_memory_offset),
229
230	/* power interface */
231	DEVMETHOD(power_enable_socket,		cbb_power_enable_socket),
232	DEVMETHOD(power_disable_socket,		cbb_power_disable_socket),
233
234	DEVMETHOD_END
235};
236
237static driver_t cbb_isa_driver = {
238	"cbb",
239	cbb_methods,
240	sizeof(struct cbb_softc)
241};
242
243DRIVER_MODULE(cbb, isa, cbb_isa_driver, cbb_devclass, 0, 0);
244MODULE_DEPEND(cbb, exca, 1, 1, 1);
245