ds1775.c revision 222658
1/*-
2 * Copyright (c) 2010 Andreas Tobler
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
19 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
21 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: head/sys/dev/iicbus/ds1775.c 222658 2011-06-03 18:58:32Z andreast $");
29
30#include <sys/param.h>
31#include <sys/bus.h>
32#include <sys/systm.h>
33#include <sys/module.h>
34#include <sys/callout.h>
35#include <sys/conf.h>
36#include <sys/cpu.h>
37#include <sys/ctype.h>
38#include <sys/kernel.h>
39#include <sys/reboot.h>
40#include <sys/rman.h>
41#include <sys/sysctl.h>
42#include <sys/limits.h>
43
44#include <machine/bus.h>
45#include <machine/md_var.h>
46
47#include <dev/iicbus/iicbus.h>
48#include <dev/iicbus/iiconf.h>
49
50#include <dev/ofw/openfirm.h>
51#include <dev/ofw/ofw_bus.h>
52#include <powerpc/powermac/powermac_thermal.h>
53
54#define FCU_ZERO_C_TO_K     2732
55
56/* Drivebay sensor: LM75/DS1775. */
57#define DS1775_TEMP         0x0
58
59/* Regular bus attachment functions */
60static int  ds1775_probe(device_t);
61static int  ds1775_attach(device_t);
62
63struct ds1775_softc {
64	struct pmac_therm	sc_sensor;
65	device_t		sc_dev;
66	struct intr_config_hook enum_hook;
67	uint32_t                sc_addr;
68};
69
70/* Utility functions */
71static int  ds1775_sensor_read(struct ds1775_softc *sc);
72static int  ds1775_sensor_sysctl(SYSCTL_HANDLER_ARGS);
73static void ds1775_start(void *xdev);
74static int  ds1775_read_2(device_t dev, uint32_t addr, uint8_t reg,
75			  uint16_t *data);
76
77static device_method_t  ds1775_methods[] = {
78	/* Device interface */
79	DEVMETHOD(device_probe,		ds1775_probe),
80	DEVMETHOD(device_attach,	ds1775_attach),
81	{ 0, 0 },
82};
83
84static driver_t ds1775_driver = {
85	"ds1775",
86	ds1775_methods,
87	sizeof(struct ds1775_softc)
88};
89
90static devclass_t ds1775_devclass;
91
92DRIVER_MODULE(ds1755, iicbus, ds1775_driver, ds1775_devclass, 0, 0);
93
94static int
95ds1775_read_2(device_t dev, uint32_t addr, uint8_t reg, uint16_t *data)
96{
97	uint8_t buf[4];
98	int err, try = 0;
99
100	struct iic_msg msg[2] = {
101	    { addr, IIC_M_WR | IIC_M_NOSTOP, 1, &reg },
102	    { addr, IIC_M_RD, 2, buf },
103	};
104
105	for (;;)
106	{
107		err = iicbus_transfer(dev, msg, 2);
108		if (err != 0)
109			goto retry;
110
111		*data = *((uint16_t*)buf);
112		return (0);
113	retry:
114		if (++try > 5) {
115			device_printf(dev, "iicbus read failed\n");
116			return (-1);
117		}
118		pause("ds1775_read_2", hz);
119	}
120}
121
122static int
123ds1775_probe(device_t dev)
124{
125	const char  *name, *compatible;
126	struct ds1775_softc *sc;
127
128	name = ofw_bus_get_name(dev);
129	compatible = ofw_bus_get_compat(dev);
130
131	if (!name)
132		return (ENXIO);
133
134	if (strcmp(name, "temp-monitor") != 0 ||
135	    (strcmp(compatible, "ds1775") != 0 &&
136	     strcmp(compatible, "lm75") != 0))
137		return (ENXIO);
138
139	sc = device_get_softc(dev);
140	sc->sc_dev = dev;
141	sc->sc_addr = iicbus_get_addr(dev);
142
143	device_set_desc(dev, "Temp-Monitor DS1775");
144
145	return (0);
146}
147
148static int
149ds1775_attach(device_t dev)
150{
151	struct ds1775_softc *sc;
152
153	sc = device_get_softc(dev);
154
155	sc->enum_hook.ich_func = ds1775_start;
156	sc->enum_hook.ich_arg = dev;
157
158	/* We have to wait until interrupts are enabled. I2C read and write
159	 * only works if the interrupts are available.
160	 * The unin/i2c is controlled by the htpic on unin. But this is not
161	 * the master. The openpic on mac-io is controlling the htpic.
162	 * This one gets attached after the mac-io probing and then the
163	 * interrupts will be available.
164	 */
165
166	if (config_intrhook_establish(&sc->enum_hook) != 0)
167		return (ENOMEM);
168
169	return (0);
170}
171
172static void
173ds1775_start(void *xdev)
174{
175	phandle_t child;
176	struct ds1775_softc *sc;
177	struct sysctl_oid *sensroot_oid;
178	struct sysctl_ctx_list *ctx;
179	ssize_t plen;
180	int i;
181	char sysctl_name[40], sysctl_desc[40];
182	const char *units;
183
184	device_t dev = (device_t)xdev;
185
186	sc = device_get_softc(dev);
187
188	child = ofw_bus_get_node(dev);
189
190	ctx = device_get_sysctl_ctx(dev);
191	sensroot_oid = device_get_sysctl_tree(dev);
192
193	if (OF_getprop(child, "hwsensor-zone", &sc->sc_sensor.zone,
194		       sizeof(int)) < 0)
195		sc->sc_sensor.zone = 0;
196
197	plen = OF_getprop(child, "hwsensor-location", sc->sc_sensor.name,
198			  sizeof(sc->sc_sensor.name));
199	units = "C";
200
201	if (plen == -1) {
202		strcpy(sysctl_name, "sensor");
203	} else {
204		for (i = 0; i < strlen(sc->sc_sensor.name); i++) {
205			sysctl_name[i] = tolower(sc->sc_sensor.name[i]);
206			if (isspace(sysctl_name[i]))
207				sysctl_name[i] = '_';
208		}
209		sysctl_name[i] = 0;
210	}
211
212	/* Make up target temperatures. These are low, for the drive bay. */
213	if (sc->sc_sensor.zone == 0) {
214		sc->sc_sensor.target_temp = 500 + FCU_ZERO_C_TO_K;
215		sc->sc_sensor.max_temp = 600 + FCU_ZERO_C_TO_K;
216	}
217	else {
218		sc->sc_sensor.target_temp = 300 + FCU_ZERO_C_TO_K;
219		sc->sc_sensor.max_temp = 600 + FCU_ZERO_C_TO_K;
220	}
221
222	sc->sc_sensor.read =
223	    (int (*)(struct pmac_therm *sc))(ds1775_sensor_read);
224	pmac_thermal_sensor_register(&sc->sc_sensor);
225
226	sprintf(sysctl_desc,"%s (%s)", sc->sc_sensor.name, units);
227	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(sensroot_oid), OID_AUTO,
228			sysctl_name,
229			CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, dev,
230			0, ds1775_sensor_sysctl, "IK", sysctl_desc);
231
232	config_intrhook_disestablish(&sc->enum_hook);
233}
234
235static int
236ds1775_sensor_read(struct ds1775_softc *sc)
237{
238	uint16_t buf[2];
239	uint16_t read;
240	int err;
241
242	err = ds1775_read_2(sc->sc_dev, sc->sc_addr, DS1775_TEMP, buf);
243	if (err < 0)
244		return (-1);
245
246	read = *((int16_t *)buf);
247
248	/* The default mode of the ADC is 9 bit, the resolution is 0.5 C per
249	   bit. The temperature is in tenth kelvin.
250	*/
251	return (((int16_t)(read) >> 7) * 5 + FCU_ZERO_C_TO_K);
252}
253
254static int
255ds1775_sensor_sysctl(SYSCTL_HANDLER_ARGS)
256{
257	device_t dev;
258	struct ds1775_softc *sc;
259	int error;
260	unsigned int temp;
261
262	dev = arg1;
263	sc = device_get_softc(dev);
264
265	temp = ds1775_sensor_read(sc);
266	if (temp < 0)
267		return (EIO);
268
269	error = sysctl_handle_int(oidp, &temp, 0, req);
270
271	return (error);
272}
273