xref: /freebsd/sys/dev/iicbus/sensor/ds1775.c (revision bdcbfde31e8e9b343f113a1956384bdf30d1ed62)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2010 Andreas Tobler
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/reboot.h>
39 #include <sys/rman.h>
40 #include <sys/sysctl.h>
41 #include <sys/limits.h>
42 
43 #include <machine/bus.h>
44 #include <machine/md_var.h>
45 
46 #include <dev/iicbus/iicbus.h>
47 #include <dev/iicbus/iiconf.h>
48 
49 #include <dev/ofw/openfirm.h>
50 #include <dev/ofw/ofw_bus.h>
51 #include <powerpc/powermac/powermac_thermal.h>
52 
53 /* Drivebay sensor: LM75/DS1775. */
54 #define DS1775_TEMP         0x0
55 
56 /* Regular bus attachment functions */
57 static int  ds1775_probe(device_t);
58 static int  ds1775_attach(device_t);
59 
60 struct ds1775_softc {
61 	struct pmac_therm	sc_sensor;
62 	device_t		sc_dev;
63 	struct intr_config_hook enum_hook;
64 	uint32_t                sc_addr;
65 };
66 
67 /* Utility functions */
68 static int  ds1775_sensor_read(struct ds1775_softc *sc);
69 static int  ds1775_sensor_sysctl(SYSCTL_HANDLER_ARGS);
70 static void ds1775_start(void *xdev);
71 static int  ds1775_read_2(device_t dev, uint32_t addr, uint8_t reg,
72 			  uint16_t *data);
73 
74 static device_method_t  ds1775_methods[] = {
75 	/* Device interface */
76 	DEVMETHOD(device_probe,		ds1775_probe),
77 	DEVMETHOD(device_attach,	ds1775_attach),
78 	{ 0, 0 },
79 };
80 
81 static driver_t ds1775_driver = {
82 	"ds1775",
83 	ds1775_methods,
84 	sizeof(struct ds1775_softc)
85 };
86 
87 DRIVER_MODULE(ds1775, iicbus, ds1775_driver, 0, 0);
88 
89 static int
90 ds1775_read_2(device_t dev, uint32_t addr, uint8_t reg, uint16_t *data)
91 {
92 	uint8_t buf[4];
93 	int err, try = 0;
94 
95 	struct iic_msg msg[2] = {
96 	    { addr, IIC_M_WR | IIC_M_NOSTOP, 1, &reg },
97 	    { addr, IIC_M_RD, 2, buf },
98 	};
99 
100 	for (;;)
101 	{
102 		err = iicbus_transfer(dev, msg, nitems(msg));
103 		if (err != 0)
104 			goto retry;
105 
106 		*data = *((uint16_t*)buf);
107 		return (0);
108 	retry:
109 		if (++try > 5) {
110 			device_printf(dev, "iicbus read failed\n");
111 			return (-1);
112 		}
113 		pause("ds1775_read_2", hz);
114 	}
115 }
116 
117 static int
118 ds1775_probe(device_t dev)
119 {
120 	const char  *name, *compatible;
121 	struct ds1775_softc *sc;
122 
123 	name = ofw_bus_get_name(dev);
124 	compatible = ofw_bus_get_compat(dev);
125 
126 	if (!name)
127 		return (ENXIO);
128 
129 	if (strcmp(name, "temp-monitor") != 0 ||
130 	    (strcmp(compatible, "ds1775") != 0 &&
131 	     strcmp(compatible, "lm75") != 0))
132 		return (ENXIO);
133 
134 	sc = device_get_softc(dev);
135 	sc->sc_dev = dev;
136 	sc->sc_addr = iicbus_get_addr(dev);
137 
138 	device_set_desc(dev, "Temp-Monitor DS1775");
139 
140 	return (0);
141 }
142 
143 static int
144 ds1775_attach(device_t dev)
145 {
146 	struct ds1775_softc *sc;
147 
148 	sc = device_get_softc(dev);
149 
150 	sc->enum_hook.ich_func = ds1775_start;
151 	sc->enum_hook.ich_arg = dev;
152 
153 	/* We have to wait until interrupts are enabled. I2C read and write
154 	 * only works if the interrupts are available.
155 	 * The unin/i2c is controlled by the htpic on unin. But this is not
156 	 * the master. The openpic on mac-io is controlling the htpic.
157 	 * This one gets attached after the mac-io probing and then the
158 	 * interrupts will be available.
159 	 */
160 
161 	if (config_intrhook_establish(&sc->enum_hook) != 0)
162 		return (ENOMEM);
163 
164 	return (0);
165 }
166 
167 static void
168 ds1775_start(void *xdev)
169 {
170 	phandle_t child;
171 	struct ds1775_softc *sc;
172 	struct sysctl_oid *oid, *sensroot_oid;
173 	struct sysctl_ctx_list *ctx;
174 	ssize_t plen;
175 	int i;
176 	char sysctl_name[40], sysctl_desc[40];
177 
178 	device_t dev = (device_t)xdev;
179 
180 	sc = device_get_softc(dev);
181 
182 	child = ofw_bus_get_node(dev);
183 
184 	ctx = device_get_sysctl_ctx(dev);
185 	sensroot_oid = SYSCTL_ADD_NODE(ctx,
186 	    SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "sensor",
187 	    CTLFLAG_RD | CTLFLAG_MPSAFE, 0, "DS1775 Sensor Information");
188 
189 	if (OF_getprop(child, "hwsensor-zone", &sc->sc_sensor.zone,
190 		       sizeof(int)) < 0)
191 		sc->sc_sensor.zone = 0;
192 
193 	plen = OF_getprop(child, "hwsensor-location", sc->sc_sensor.name,
194 			  sizeof(sc->sc_sensor.name));
195 
196 	if (plen == -1) {
197 		strcpy(sysctl_name, "sensor");
198 	} else {
199 		for (i = 0; i < strlen(sc->sc_sensor.name); i++) {
200 			sysctl_name[i] = tolower(sc->sc_sensor.name[i]);
201 			if (isspace(sysctl_name[i]))
202 				sysctl_name[i] = '_';
203 		}
204 		sysctl_name[i] = 0;
205 	}
206 
207 	/* Make up target temperatures. These are low, for the drive bay. */
208 	if (sc->sc_sensor.zone == 0) {
209 		sc->sc_sensor.target_temp = 500 + ZERO_C_TO_K;
210 		sc->sc_sensor.max_temp = 600 + ZERO_C_TO_K;
211 	}
212 	else {
213 		sc->sc_sensor.target_temp = 300 + ZERO_C_TO_K;
214 		sc->sc_sensor.max_temp = 600 + ZERO_C_TO_K;
215 	}
216 
217 	sc->sc_sensor.read =
218 	    (int (*)(struct pmac_therm *sc))(ds1775_sensor_read);
219 	pmac_thermal_sensor_register(&sc->sc_sensor);
220 
221 	sprintf(sysctl_desc,"%s %s", sc->sc_sensor.name, "(C)");
222 	oid = SYSCTL_ADD_NODE(ctx, SYSCTL_CHILDREN(sensroot_oid),
223 	    OID_AUTO, sysctl_name, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
224 	    "Sensor Information");
225 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO, "temp",
226 			CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, dev,
227 			0, ds1775_sensor_sysctl, "IK", sysctl_desc);
228 
229 	config_intrhook_disestablish(&sc->enum_hook);
230 }
231 
232 static int
233 ds1775_sensor_read(struct ds1775_softc *sc)
234 {
235 	uint16_t buf[2];
236 	uint16_t read;
237 	int err;
238 
239 	err = ds1775_read_2(sc->sc_dev, sc->sc_addr, DS1775_TEMP, buf);
240 	if (err < 0)
241 		return (-1);
242 
243 	read = *((int16_t *)buf);
244 
245 	/* The default mode of the ADC is 9 bit, the resolution is 0.5 C per
246 	   bit. The temperature is in tenth kelvin.
247 	*/
248 	return (((int16_t)(read) >> 7) * 5 + ZERO_C_TO_K);
249 }
250 
251 static int
252 ds1775_sensor_sysctl(SYSCTL_HANDLER_ARGS)
253 {
254 	device_t dev;
255 	struct ds1775_softc *sc;
256 	int error;
257 	int temp;
258 
259 	dev = arg1;
260 	sc = device_get_softc(dev);
261 
262 	temp = ds1775_sensor_read(sc);
263 	if (temp < 0)
264 		return (EIO);
265 
266 	error = sysctl_handle_int(oidp, &temp, 0, req);
267 
268 	return (error);
269 }
270