envctrl.c revision 181303 
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/envctrl.c 181303 2008-08-04 20:46:15Z jhb $");
32
33/*
34 * Device specific driver for the SUNW,envctrl device found on some
35 * UltraSPARC Sun systems.  This device is a Philips PCF8584 sitting
36 * on the Ebus2.
37 */
38
39#include <sys/param.h>
40#include <sys/bus.h>
41#include <sys/conf.h>
42#include <sys/kernel.h>
43#include <sys/lock.h>
44#include <sys/malloc.h>
45#include <sys/module.h>
46#include <sys/mutex.h>
47#include <sys/resource.h>
48#include <sys/systm.h>
49#include <sys/uio.h>
50
51#include <dev/ofw/ofw_bus.h>
52
53#include <machine/bus.h>
54#include <machine/resource.h>
55
56#include <sys/rman.h>
57
58#include <dev/iicbus/iiconf.h>
59#include <dev/pcf/pcfvar.h>
60#include "iicbus_if.h"
61
62#undef PCF_DEFAULT_ADDR
63#define PCF_DEFAULT_ADDR	0x55 /* SUNW,pcf default */
64
65static int envctrl_probe(device_t);
66static int envctrl_attach(device_t);
67static int envctrl_detach(device_t);
68
69static device_method_t envctrl_methods[] = {
70	/* device interface */
71	DEVMETHOD(device_probe,		envctrl_probe),
72	DEVMETHOD(device_attach,	envctrl_attach),
73	DEVMETHOD(device_detach,	envctrl_detach),
74
75	/* iicbus interface */
76	DEVMETHOD(iicbus_callback,	iicbus_null_callback),
77	DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
78	DEVMETHOD(iicbus_start,		pcf_start),
79	DEVMETHOD(iicbus_stop,		pcf_stop),
80	DEVMETHOD(iicbus_write,		pcf_write),
81	DEVMETHOD(iicbus_read,		pcf_read),
82	DEVMETHOD(iicbus_reset,		pcf_rst_card),
83	{ 0, 0 }
84};
85
86static devclass_t envctrl_devclass;
87
88static driver_t envctrl_driver = {
89	"envctrl",
90	envctrl_methods,
91	sizeof(struct pcf_softc),
92};
93
94static int
95envctrl_probe(device_t dev)
96{
97
98	if (strcmp("SUNW,envctrl", ofw_bus_get_name(dev)) == 0) {
99		device_set_desc(dev, "EBus SUNW,envctrl");
100		return (0);
101	}
102	return (ENXIO);
103}
104
105static int
106envctrl_attach(device_t dev)
107{
108	struct pcf_softc *sc;
109	int rv = ENXIO;
110
111	sc = DEVTOSOFTC(dev);
112	mtx_init(&sc->pcf_lock, device_get_nameunit(dev), "pcf", MTX_DEF);
113
114	/* IO port is mandatory */
115	sc->res_ioport = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
116						&sc->rid_ioport, RF_ACTIVE);
117	if (sc->res_ioport == 0) {
118		device_printf(dev, "cannot reserve I/O port range\n");
119		goto error;
120	}
121
122	sc->pcf_flags = device_get_flags(dev);
123
124	if (!(sc->pcf_flags & IIC_POLLED)) {
125		sc->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->rid_irq,
126						     RF_ACTIVE);
127		if (sc->res_irq == 0) {
128			device_printf(dev, "can't reserve irq, polled mode.\n");
129			sc->pcf_flags |= IIC_POLLED;
130		}
131	}
132
133	/* reset the chip */
134	pcf_rst_card(dev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
135
136	rv = bus_setup_intr(dev, sc->res_irq,
137			    INTR_TYPE_NET | INTR_MPSAFE /* | INTR_ENTROPY */,
138			    NULL, pcf_intr, sc, &sc->intr_cookie);
139	if (rv) {
140		device_printf(dev, "could not setup IRQ\n");
141		goto error;
142	}
143
144	if ((sc->iicbus = device_add_child(dev, "iicbus", -1)) == NULL)
145		device_printf(dev, "could not allocate iicbus instance\n");
146
147	/* probe and attach the iicbus */
148	bus_generic_attach(dev);
149
150	return (0);
151
152error:
153	if (sc->res_irq != 0) {
154		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq,
155				     sc->res_irq);
156	}
157	if (sc->res_ioport != 0) {
158		bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ioport,
159				     sc->res_ioport);
160	}
161	mtx_destroy(&sc->pcf_lock);
162	return (rv);
163}
164
165static int
166envctrl_detach(device_t dev)
167{
168	struct pcf_softc *sc;
169	int rv;
170
171	sc = DEVTOSOFTC(dev);
172
173	if ((rv = bus_generic_detach(dev)) != 0)
174		return (rv);
175
176	if ((rv = device_delete_child(dev, sc->iicbus)) != 0)
177		return (rv);
178
179	if (sc->res_irq != 0) {
180		bus_teardown_intr(dev, sc->res_irq, sc->intr_cookie);
181		bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq, sc->res_irq);
182	}
183
184	bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ioport, sc->res_ioport);
185	mtx_destroy(&sc->pcf_lock);
186
187	return (0);
188}
189
190DRIVER_MODULE(envctrl, ebus, envctrl_driver, envctrl_devclass, 0, 0);
191DRIVER_MODULE(iicbus, envctrl, iicbus_driver, iicbus_devclass, 0, 0);
192MODULE_DEPEND(envctrl, iicbus, PCF_MINVER, PCF_PREFVER, PCF_MAXVER);
193MODULE_VERSION(envctrl, PCF_MODVER);
194