xref: /freebsd/sys/dev/iicbus/pwm/adm1030.c (revision a2f733abcff64628b7771a47089628b7327a88bd)
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 #include <sys/param.h>
30 #include <sys/bus.h>
31 #include <sys/systm.h>
32 #include <sys/module.h>
33 #include <sys/callout.h>
34 #include <sys/conf.h>
35 #include <sys/cpu.h>
36 #include <sys/ctype.h>
37 #include <sys/kernel.h>
38 #include <sys/kthread.h>
39 #include <sys/limits.h>
40 #include <sys/reboot.h>
41 #include <sys/rman.h>
42 #include <sys/sysctl.h>
43 #include <sys/unistd.h>
44 
45 #include <machine/bus.h>
46 #include <machine/md_var.h>
47 
48 #include <dev/iicbus/iicbus.h>
49 #include <dev/iicbus/iiconf.h>
50 
51 #include <dev/ofw/openfirm.h>
52 #include <dev/ofw/ofw_bus.h>
53 #include <powerpc/powermac/powermac_thermal.h>
54 
55 struct adm1030_softc {
56 	struct pmac_fan fan;
57 	device_t	sc_dev;
58 	struct intr_config_hook enum_hook;
59 	uint32_t	sc_addr;
60 	int		sc_pwm;
61 };
62 
63 /* Regular bus attachment functions */
64 static int	adm1030_probe(device_t);
65 static int	adm1030_attach(device_t);
66 
67 /* Utility functions */
68 static void	adm1030_start(void *xdev);
69 static int	adm1030_write_byte(device_t dev, uint32_t addr, uint8_t reg, uint8_t buf);
70 static int	adm1030_set(struct adm1030_softc *fan, int pwm);
71 static int	adm1030_sysctl(SYSCTL_HANDLER_ARGS);
72 
73 static device_method_t adm1030_methods[] = {
74 	/* Device interface */
75 	DEVMETHOD(device_probe, adm1030_probe),
76 	DEVMETHOD(device_attach, adm1030_attach),
77 	{0, 0},
78 };
79 
80 static driver_t	adm1030_driver = {
81 	"adm1030",
82 	adm1030_methods,
83 	sizeof(struct adm1030_softc)
84 };
85 
86 DRIVER_MODULE(adm1030, iicbus, adm1030_driver, 0, 0);
87 
88 static int
89 adm1030_write_byte(device_t dev, uint32_t addr, uint8_t reg, uint8_t byte)
90 {
91 	unsigned char	buf[4];
92 	int try = 0;
93 
94 	struct iic_msg	msg[] = {
95 		{addr, IIC_M_WR, 0, buf}
96 	};
97 
98 	msg[0].len = 2;
99 	buf[0] = reg;
100 	buf[1] = byte;
101 
102 	for (;;)
103 	{
104 		if (iicbus_transfer(dev, msg, 1) == 0)
105 			return (0);
106 
107 		if (++try > 5) {
108 			device_printf(dev, "iicbus write failed\n");
109 			return (-1);
110 		}
111 		pause("adm1030_write_byte", hz);
112 	}
113 }
114 
115 static int
116 adm1030_probe(device_t dev)
117 {
118 	const char     *name, *compatible;
119 	struct adm1030_softc *sc;
120 	phandle_t	handle;
121 	phandle_t	thermostat;
122 
123 	name = ofw_bus_get_name(dev);
124 	compatible = ofw_bus_get_compat(dev);
125 	handle = ofw_bus_get_node(dev);
126 
127 	if (!name)
128 		return (ENXIO);
129 
130 	if (strcmp(name, "fan") != 0 || strcmp(compatible, "adm1030") != 0)
131 		return (ENXIO);
132 
133 	/* This driver can only be used if there's an associated temp sensor. */
134 	if (OF_getprop(handle, "platform-getTemp", &thermostat, sizeof(thermostat)) < 0)
135 		return (ENXIO);
136 
137 	sc = device_get_softc(dev);
138 	sc->sc_dev = dev;
139 	sc->sc_addr = iicbus_get_addr(dev);
140 
141 	device_set_desc(dev, "G4 MDD Fan driver");
142 
143 	return (0);
144 }
145 
146 static int
147 adm1030_attach(device_t dev)
148 {
149 	struct adm1030_softc *sc;
150 	struct sysctl_ctx_list *ctx;
151 	struct sysctl_oid *tree;
152 
153 	sc = device_get_softc(dev);
154 
155 	sc->enum_hook.ich_func = adm1030_start;
156 	sc->enum_hook.ich_arg = dev;
157 
158 	/*
159 	 * Wait until interrupts are available, which won't be until the openpic is
160 	 * intialized.
161 	 */
162 
163 	if (config_intrhook_establish(&sc->enum_hook) != 0)
164 		return (ENOMEM);
165 
166 	ctx = device_get_sysctl_ctx(dev);
167 	tree = device_get_sysctl_tree(dev);
168 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, "pwm",
169 			CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE, dev,
170 			0, adm1030_sysctl, "I", "Fan PWM Rate");
171 
172 	return (0);
173 }
174 
175 static void
176 adm1030_start(void *xdev)
177 {
178 	struct adm1030_softc *sc;
179 
180 	device_t	dev = (device_t) xdev;
181 
182 	sc = device_get_softc(dev);
183 
184 	/* Start the adm1030 device. */
185 	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x1, 0x1);
186 	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x0, 0x95);
187 	adm1030_write_byte(sc->sc_dev, sc->sc_addr, 0x23, 0x91);
188 
189 	/* Use the RPM fields as PWM duty cycles. */
190 	sc->fan.min_rpm = 0;
191 	sc->fan.max_rpm = 0x0F;
192 	sc->fan.default_rpm = 2;
193 
194 	strcpy(sc->fan.name, "MDD Case fan");
195 	sc->fan.zone = 0;
196 	sc->fan.read = NULL;
197 	sc->fan.set = (int (*)(struct pmac_fan *, int))adm1030_set;
198 	config_intrhook_disestablish(&sc->enum_hook);
199 
200 	pmac_thermal_fan_register(&sc->fan);
201 }
202 
203 static int adm1030_set(struct adm1030_softc *fan, int pwm)
204 {
205 	/* Clamp the PWM to 0-0xF, one nibble. */
206 	if (pwm > 0xF)
207 		pwm = 0xF;
208 	if (pwm < 0)
209 		pwm = 0;
210 
211 	if (adm1030_write_byte(fan->sc_dev, fan->sc_addr, 0x22, pwm) < 0)
212 		return (-1);
213 
214 	fan->sc_pwm = pwm;
215 	return (0);
216 }
217 
218 static int
219 adm1030_sysctl(SYSCTL_HANDLER_ARGS)
220 {
221 	device_t adm1030;
222 	struct adm1030_softc *sc;
223 	int pwm, error;
224 
225 	adm1030 = arg1;
226 	sc = device_get_softc(adm1030);
227 
228 	pwm = sc->sc_pwm;
229 
230 	error = sysctl_handle_int(oidp, &pwm, 0, req);
231 
232 	if (error || !req->newptr)
233 		return (error);
234 
235 	return (adm1030_set(sc, pwm));
236 }
237