1/*-
2 * Copyright (c) 2011 Justin Hibbits
3 * Copyright (c) 2010 Andreas Tobler
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD$");
30
31#include <sys/param.h>
32#include <sys/bus.h>
33#include <sys/systm.h>
34#include <sys/module.h>
35#include <sys/callout.h>
36#include <sys/conf.h>
37#include <sys/cpu.h>
38#include <sys/ctype.h>
39#include <sys/kernel.h>
40#include <sys/kthread.h>
41#include <sys/limits.h>
42#include <sys/reboot.h>
43#include <sys/rman.h>
44#include <sys/sysctl.h>
45#include <sys/unistd.h>
46
47#include <machine/bus.h>
48#include <machine/md_var.h>
49
50#include <dev/iicbus/iicbus.h>
51#include <dev/iicbus/iiconf.h>
52
53#include <dev/ofw/openfirm.h>
54#include <dev/ofw/ofw_bus.h>
55#include <powerpc/powermac/powermac_thermal.h>
56
57struct adm1030_softc {
58	struct pmac_fan fan;
59	device_t	sc_dev;
60	struct intr_config_hook enum_hook;
61	uint32_t	sc_addr;
62	int		sc_pwm;
63};
64
65/* Regular bus attachment functions */
66static int	adm1030_probe(device_t);
67static int	adm1030_attach(device_t);
68
69/* Utility functions */
70static void	adm1030_start(void *xdev);
71static int	adm1030_write_byte(device_t dev, uint32_t addr, uint8_t reg, uint8_t buf);
72static int	adm1030_set(struct adm1030_softc *fan, int pwm);
73static int	adm1030_sysctl(SYSCTL_HANDLER_ARGS);
74
75static device_method_t adm1030_methods[] = {
76	/* Device interface */
77	DEVMETHOD(device_probe, adm1030_probe),
78	DEVMETHOD(device_attach, adm1030_attach),
79	{0, 0},
80};
81
82static driver_t	adm1030_driver = {
83	"adm1030",
84	adm1030_methods,
85	sizeof(struct adm1030_softc)
86};
87
88static devclass_t adm1030_devclass;
89
90DRIVER_MODULE(adm1030, iicbus, adm1030_driver, adm1030_devclass, 0, 0);
91
92static int
93adm1030_write_byte(device_t dev, uint32_t addr, uint8_t reg, uint8_t byte)
94{
95	unsigned char	buf[4];
96	int try = 0;
97
98	struct iic_msg	msg[] = {
99		{addr, IIC_M_WR, 0, buf}
100	};
101
102	msg[0].len = 2;
103	buf[0] = reg;
104	buf[1] = byte;
105
106	for (;;)
107	{
108		if (iicbus_transfer(dev, msg, 1) == 0)
109			return (0);
110
111		if (++try > 5) {
112			device_printf(dev, "iicbus write failed\n");
113			return (-1);
114		}
115		pause("adm1030_write_byte", hz);
116	}
117}
118
119static int
120adm1030_probe(device_t dev)
121{
122	const char     *name, *compatible;
123	struct adm1030_softc *sc;
124	phandle_t	handle;
125	phandle_t	thermostat;
126
127	name = ofw_bus_get_name(dev);
128	compatible = ofw_bus_get_compat(dev);
129	handle = ofw_bus_get_node(dev);
130
131	if (!name)
132		return (ENXIO);
133
134	if (strcmp(name, "fan") != 0 || strcmp(compatible, "adm1030") != 0)
135		return (ENXIO);
136
137	/* This driver can only be used if there's an associated temp sensor. */
138	if (OF_getprop(handle, "platform-getTemp", &thermostat, sizeof(thermostat)) < 0)
139		return (ENXIO);
140
141	sc = device_get_softc(dev);
142	sc->sc_dev = dev;
143	sc->sc_addr = iicbus_get_addr(dev);
144
145	device_set_desc(dev, "G4 MDD Fan driver");
146
147	return (0);
148}
149
150static int
151adm1030_attach(device_t dev)
152{
153	struct adm1030_softc *sc;
154	struct sysctl_ctx_list *ctx;
155	struct sysctl_oid *tree;
156
157	sc = device_get_softc(dev);
158
159	sc->enum_hook.ich_func = adm1030_start;
160	sc->enum_hook.ich_arg = dev;
161
162	/*
163	 * Wait until interrupts are available, which won't be until the openpic is
164	 * intialized.
165	 */
166
167	if (config_intrhook_establish(&sc->enum_hook) != 0)
168		return (ENOMEM);
169
170	ctx = device_get_sysctl_ctx(dev);
171	tree = device_get_sysctl_tree(dev);
172	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, "pwm",
173			CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE, dev,
174			0, adm1030_sysctl, "I", "Fan PWM Rate");
175
176	return (0);
177}
178
179static void
180adm1030_start(void *xdev)
181{
182	struct adm1030_softc *sc;
183
184	device_t	dev = (device_t) xdev;
185
186	sc = device_get_softc(dev);
187
188	/* Start the adm1030 device. */
189	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x1, 0x1);
190	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x0, 0x95);
191	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x23, 0x91);
192
193	/* Use the RPM fields as PWM duty cycles. */
194	sc->fan.min_rpm = 0;
195	sc->fan.max_rpm = 0x0F;
196	sc->fan.default_rpm = 2;
197
198	strcpy(sc->fan.name, "MDD Case fan");
199	sc->fan.zone = 0;
200	sc->fan.read = NULL;
201	sc->fan.set = (int (*)(struct pmac_fan *, int))adm1030_set;
202	config_intrhook_disestablish(&sc->enum_hook);
203
204	pmac_thermal_fan_register(&sc->fan);
205}
206
207static int adm1030_set(struct adm1030_softc *fan, int pwm)
208{
209	/* Clamp the PWM to 0-0xF, one nibble. */
210	if (pwm > 0xF)
211		pwm = 0xF;
212	if (pwm < 0)
213		pwm = 0;
214
215	if (adm1030_write_byte(fan->sc_dev, fan->sc_addr, 0x22, pwm) < 0)
216		return (-1);
217
218	fan->sc_pwm = pwm;
219	return (0);
220}
221
222static int
223adm1030_sysctl(SYSCTL_HANDLER_ARGS)
224{
225	device_t adm1030;
226	struct adm1030_softc *sc;
227	int pwm, error;
228
229	adm1030 = arg1;
230	sc = device_get_softc(adm1030);
231
232	pwm = sc->sc_pwm;
233
234	error = sysctl_handle_int(oidp, &pwm, 0, req);
235
236	if (error || !req->newptr)
237		return (error);
238
239	return (adm1030_set(sc, pwm));
240}
241