pcf_isa.c revision 167753 
1/*-
2 * Copyright (c) 2004 Joerg Wunsch
3 *
4 * derived from sys/i386/isa/pcf.c which is:
5 *
6 * Copyright (c) 1998 Nicolas Souchu, Marc Bouget
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: head/sys/dev/pcf/pcf_isa.c 167753 2007-03-21 03:38:37Z nyan $");
32
33/*
34 * Hardware driver for a Philips PCF8584 I2C bus controller sitting
35 * on a generic ISA bus.
36 */
37
38#include <sys/param.h>
39#include <sys/systm.h>
40#include <sys/bus.h>
41#include <sys/kernel.h>
42#include <sys/module.h>
43#include <sys/resource.h>
44
45#include <machine/bus.h>
46#include <machine/resource.h>
47
48#include <sys/rman.h>
49
50#include <isa/isareg.h>
51#include <isa/isavar.h>
52
53#include <dev/iicbus/iiconf.h>
54#include <dev/pcf/pcfvar.h>
55#include "iicbus_if.h"
56
57#define	PCF_NAME	"pcf"
58
59static void pcf_isa_identify(driver_t *, device_t);
60static int pcf_isa_probe(device_t);
61static int pcf_isa_attach(device_t);
62static int pcf_isa_detach(device_t);
63
64static device_method_t pcf_isa_methods[] = {
65	/* device interface */
66	DEVMETHOD(device_identify,	pcf_isa_identify),
67	DEVMETHOD(device_probe,		pcf_isa_probe),
68	DEVMETHOD(device_attach,	pcf_isa_attach),
69	DEVMETHOD(device_detach,	pcf_isa_detach),
70
71	/* iicbus interface */
72	DEVMETHOD(iicbus_callback,	iicbus_null_callback),
73	DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
74	DEVMETHOD(iicbus_start,		pcf_start),
75	DEVMETHOD(iicbus_stop,		pcf_stop),
76	DEVMETHOD(iicbus_write,		pcf_write),
77	DEVMETHOD(iicbus_read,		pcf_read),
78	DEVMETHOD(iicbus_reset,		pcf_rst_card),
79	{ 0, 0 }
80};
81
82static devclass_t pcf_isa_devclass;
83
84static driver_t pcf_isa_driver = {
85	PCF_NAME,
86	pcf_isa_methods,
87	sizeof(struct pcf_softc),
88};
89
90static void
91pcf_isa_identify(driver_t *driver, device_t parent)
92{
93	BUS_ADD_CHILD(parent, ISA_ORDER_SPECULATIVE, PCF_NAME, 0);
94
95	return;
96}
97
98static int
99pcf_isa_probe(device_t dev)
100{
101	u_long		start, count;
102	u_int		rid = 0, port, error;
103
104	/* skip PnP probes */
105	if (isa_get_logicalid(dev))
106		return (ENXIO);
107
108	/* The port address must be explicitly specified */
109	bus_get_resource(dev, SYS_RES_IOPORT, rid, &start, &count);
110	if ((error = resource_int_value(PCF_NAME, 0, "port", &port) != 0))
111		return (error);
112
113	/* Probe is only successfull for the specified base io */
114	if (port != (u_int)start)
115		return (ENXIO);
116
117	device_set_desc(dev, "PCF8584 I2C bus controller");
118
119	return (0);
120}
121
122static int
123pcf_isa_attach(device_t dev)
124{
125	struct pcf_softc *sc;
126	int rv = ENXIO;
127
128	sc = DEVTOSOFTC(dev);
129	bzero(sc, sizeof(struct pcf_softc));
130
131	/* IO port is mandatory */
132	sc->res_ioport = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
133						&sc->rid_ioport, RF_ACTIVE);
134	if (sc->res_ioport == 0) {
135		device_printf(dev, "cannot reserve I/O port range\n");
136		goto error;
137	}
138	sc->bt_ioport = rman_get_bustag(sc->res_ioport);
139	sc->bh_ioport = rman_get_bushandle(sc->res_ioport);
140
141	sc->pcf_flags = device_get_flags(dev);
142
143	if (!(sc->pcf_flags & IIC_POLLED)) {
144		sc->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->rid_irq,
145						     RF_ACTIVE);
146		if (sc->res_irq == 0) {
147			device_printf(dev, "can't reserve irq, polled mode.\n");
148			sc->pcf_flags |= IIC_POLLED;
149		}
150	}
151
152	/* reset the chip */
153	pcf_rst_card(dev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
154
155	if (sc->res_irq) {
156		rv = bus_setup_intr(dev, sc->res_irq,
157				    INTR_TYPE_NET /* | INTR_ENTROPY */,
158				    NULL, pcf_intr, sc, &sc->intr_cookie);
159		if (rv) {
160			device_printf(dev, "could not setup IRQ\n");
161			goto error;
162		}
163	}
164
165	if ((sc->iicbus = device_add_child(dev, "iicbus", -1)) == NULL)
166		device_printf(dev, "could not allocate iicbus instance\n");
167
168	/* probe and attach the iicbus */
169	bus_generic_attach(dev);
170
171	return (0);
172
173error:
174	if (sc->res_irq != 0) {
175		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq,
176				     sc->res_irq);
177	}
178	if (sc->res_ioport != 0) {
179		bus_release_resource(dev, SYS_RES_IOPORT, sc->rid_ioport,
180				     sc->res_ioport);
181	}
182	return (rv);
183}
184
185static int
186pcf_isa_detach(device_t dev)
187{
188	struct pcf_softc *sc;
189	int rv;
190
191	sc = DEVTOSOFTC(dev);
192
193	if ((rv = bus_generic_detach(dev)) != 0)
194		return (rv);
195
196	if ((rv = device_delete_child(dev, sc->iicbus)) != 0)
197		return (rv);
198
199	if (sc->res_irq != 0) {
200		bus_teardown_intr(dev, sc->res_irq, sc->intr_cookie);
201		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq, sc->res_irq);
202	}
203
204	bus_release_resource(dev, SYS_RES_IOPORT, sc->rid_ioport, sc->res_ioport);
205
206	return (0);
207}
208
209DRIVER_MODULE(pcf_isa, isa, pcf_isa_driver, pcf_isa_devclass, 0, 0);
210MODULE_DEPEND(pcf_isa, iicbus, PCF_MINVER, PCF_PREFVER, PCF_MAXVER);
211MODULE_VERSION(pcf_isa, PCF_MODVER);
212