pcf_isa.c revision 129893 
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 129893 2004-05-31 14:24:21Z nsouch $");
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/resource.h>
43
44#include <machine/bus.h>
45#include <machine/resource.h>
46
47#include <sys/rman.h>
48
49#include <isa/isareg.h>
50#include <isa/isavar.h>
51
52#include <dev/iicbus/iiconf.h>
53#include <dev/pcf/pcfvar.h>
54#include "iicbus_if.h"
55
56#define PCF_NAME "pcf"
57
58static void pcf_identify(driver_t *, device_t);
59static int pcf_probe(device_t);
60static int pcf_attach(device_t);
61static int pcf_detach(device_t);
62
63static device_method_t pcf_methods[] = {
64	/* device interface */
65	DEVMETHOD(device_identify,	pcf_identify),
66	DEVMETHOD(device_probe,		pcf_probe),
67	DEVMETHOD(device_attach,	pcf_attach),
68	DEVMETHOD(device_detach,	pcf_detach),
69
70	/* iicbus interface */
71	DEVMETHOD(iicbus_callback,	iicbus_null_callback),
72	DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
73	DEVMETHOD(iicbus_start,		pcf_start),
74	DEVMETHOD(iicbus_stop,		pcf_stop),
75	DEVMETHOD(iicbus_write,		pcf_write),
76	DEVMETHOD(iicbus_read,		pcf_read),
77	DEVMETHOD(iicbus_reset,		pcf_rst_card),
78	{ 0, 0 }
79};
80
81static devclass_t pcf_devclass;
82
83static driver_t pcf_driver = {
84	PCF_NAME,
85	pcf_methods,
86	sizeof(struct pcf_softc),
87};
88
89static void
90pcf_identify(driver_t *driver, device_t parent)
91{
92	BUS_ADD_CHILD(parent, ISA_ORDER_SPECULATIVE, PCF_NAME, 0);
93
94	return;
95}
96
97static int
98pcf_probe(device_t dev)
99{
100	u_long		start, count;
101	u_int		rid = 0, port, error;
102
103	bus_get_resource(dev, SYS_RES_IOPORT, rid, &start, &count);
104
105	/* The port address must be explicitly specified */
106	if ((error = resource_int_value(PCF_NAME, 0, "port", &port) != 0))
107		return (error);
108
109	/* Probe is only successfull for the specified base io */
110	if (port != (u_int)start)
111		return (ENXIO);
112
113	device_set_desc(dev, "PCF8584 I2C bus controller");
114
115	return (0);
116}
117
118static int
119pcf_attach(device_t dev)
120{
121	struct pcf_softc *sc;
122	int rv = ENXIO;
123
124	sc = DEVTOSOFTC(dev);
125	bzero(sc, sizeof(struct pcf_softc));
126
127	/* IO port is mandatory */
128	sc->res_ioport = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
129						&sc->rid_ioport, RF_ACTIVE);
130	if (sc->res_ioport == 0) {
131		device_printf(dev, "cannot reserve I/O port range\n");
132		goto error;
133	}
134
135	sc->pcf_flags = device_get_flags(dev);
136
137	if (!(sc->pcf_flags & IIC_POLLED)) {
138		sc->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->rid_irq,
139						     RF_ACTIVE);
140		if (sc->res_irq == 0) {
141			device_printf(dev, "can't reserve irq, polled mode.\n");
142			sc->pcf_flags |= IIC_POLLED;
143		}
144	}
145
146	/* reset the chip */
147	pcf_rst_card(dev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
148
149	if (sc->res_irq) {
150		rv = BUS_SETUP_INTR(device_get_parent(dev), dev, sc->res_irq,
151				    INTR_TYPE_NET /* | INTR_ENTROPY */,
152				    pcf_intr, sc, &sc->intr_cookie);
153		if (rv) {
154			device_printf(dev, "could not setup IRQ\n");
155			goto error;
156		}
157	}
158
159	if ((sc->iicbus = device_add_child(dev, "iicbus", -1)) == NULL)
160		device_printf(dev, "could not allocate iicbus instance\n");
161
162	/* probe and attach the iicbus */
163	bus_generic_attach(dev);
164
165	return (0);
166
167error:
168	if (sc->res_irq != 0) {
169		bus_deactivate_resource(dev, SYS_RES_IRQ, sc->rid_irq,
170					sc->res_irq);
171		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq,
172				     sc->res_irq);
173	}
174	if (sc->res_ioport != 0) {
175		bus_deactivate_resource(dev, SYS_RES_IOPORT, sc->rid_ioport,
176					sc->res_ioport);
177		bus_release_resource(dev, SYS_RES_IOPORT, sc->rid_ioport,
178				     sc->res_ioport);
179	}
180	return (rv);
181}
182
183static int
184pcf_detach(device_t dev)
185{
186	struct pcf_softc *sc;
187	int rv;
188
189	sc = DEVTOSOFTC(dev);
190
191	if ((rv = bus_generic_detach(dev)) != 0)
192		return (rv);
193
194	if ((rv = device_delete_child(dev, sc->iicbus)) != 0)
195		return (rv);
196
197	if (sc->res_irq != 0) {
198		BUS_TEARDOWN_INTR(device_get_parent(dev), dev, sc->res_irq,
199				  sc->intr_cookie);
200		bus_deactivate_resource(dev, SYS_RES_IRQ, sc->rid_irq, sc->res_irq);
201		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq, sc->res_irq);
202	}
203
204	bus_deactivate_resource(dev, SYS_RES_IOPORT, sc->rid_ioport, sc->res_ioport);
205	bus_release_resource(dev, SYS_RES_IOPORT, sc->rid_ioport, sc->res_ioport);
206
207	return (0);
208}
209
210DRIVER_MODULE(pcf, ebus, pcf_driver, pcf_devclass, 0, 0);
211DRIVER_MODULE(pcf, isa, pcf_driver, pcf_devclass, 0, 0);
212MODULE_DEPEND(pcf, iicbus, PCF_MINVER, PCF_PREFVER, PCF_MAXVER);
213MODULE_VERSION(pcf, PCF_MODVER);
214