xref: /netbsd-src/sys/dev/onewire/owtemp.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: owtemp.c,v 1.12 2007/11/16 08:00:15 xtraeme Exp $ */
2 /*	$OpenBSD: owtemp.c,v 1.1 2006/03/04 16:27:03 grange Exp $	*/
3 
4 /*
5  * Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 /*
21  * 1-Wire temperature family type device driver.
22  */
23 
24 #include <sys/cdefs.h>
25 __KERNEL_RCSID(0, "$NetBSD: owtemp.c,v 1.12 2007/11/16 08:00:15 xtraeme Exp $");
26 
27 #include <sys/param.h>
28 #include <sys/systm.h>
29 #include <sys/device.h>
30 #include <sys/kernel.h>
31 #include <sys/proc.h>
32 
33 #include <dev/sysmon/sysmonvar.h>
34 
35 #include <dev/onewire/onewiredevs.h>
36 #include <dev/onewire/onewirereg.h>
37 #include <dev/onewire/onewirevar.h>
38 
39 #define DS_CMD_CONVERT		0x44
40 #define DS_CMD_READ_SCRATCHPAD	0xbe
41 
42 struct owtemp_softc {
43 	struct device			sc_dev;
44 
45 	void *				sc_onewire;
46 	u_int64_t			sc_rom;
47 
48 	envsys_data_t			sc_sensor;
49 	struct sysmon_envsys		*sc_sme;
50 
51 	uint32_t			(*sc_owtemp_decode)(const uint8_t *);
52 
53 	int				sc_dying;
54 };
55 
56 int	owtemp_match(struct device *, struct cfdata *, void *);
57 void	owtemp_attach(struct device *, struct device *, void *);
58 int	owtemp_detach(struct device *, int);
59 int	owtemp_activate(struct device *, enum devact);
60 
61 void	owtemp_update(void *);
62 
63 CFATTACH_DECL(owtemp, sizeof(struct owtemp_softc),
64 	owtemp_match, owtemp_attach, owtemp_detach, owtemp_activate);
65 
66 extern struct cfdriver owtemp_cd;
67 
68 static const struct onewire_matchfam owtemp_fams[] = {
69 	{ ONEWIRE_FAMILY_DS1920 },
70 	{ ONEWIRE_FAMILY_DS18B20 },
71 	{ ONEWIRE_FAMILY_DS1822 },
72 };
73 
74 static void	owtemp_refresh(struct sysmon_envsys *, envsys_data_t *);
75 
76 static uint32_t	owtemp_decode_ds18b20(const uint8_t *);
77 static uint32_t	owtemp_decode_ds1920(const uint8_t *);
78 
79 int
80 owtemp_match(struct device *parent, struct cfdata *cf, void *aux)
81 {
82 	return (onewire_matchbyfam(aux, owtemp_fams,
83 	    __arraycount(owtemp_fams)));
84 }
85 
86 void
87 owtemp_attach(struct device *parent, struct device *self, void *aux)
88 {
89 	struct owtemp_softc *sc = device_private(self);
90 	struct onewire_attach_args *oa = aux;
91 
92 	sc->sc_onewire = oa->oa_onewire;
93 	sc->sc_rom = oa->oa_rom;
94 
95 	switch(ONEWIRE_ROM_FAMILY_TYPE(sc->sc_rom)) {
96 	case ONEWIRE_FAMILY_DS18B20:
97 	case ONEWIRE_FAMILY_DS1822:
98 		sc->sc_owtemp_decode = owtemp_decode_ds18b20;
99 		break;
100 	case ONEWIRE_FAMILY_DS1920:
101 		sc->sc_owtemp_decode = owtemp_decode_ds1920;
102 		break;
103 	}
104 
105 	sc->sc_sme = sysmon_envsys_create();
106 
107 	/* Initialize sensor */
108 	sc->sc_sensor.units = ENVSYS_STEMP;
109 	(void)strlcpy(sc->sc_sensor.desc,
110 	    sc->sc_dev.dv_xname, sizeof(sc->sc_sensor.desc));
111 	if (sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor)) {
112 		sysmon_envsys_destroy(sc->sc_sme);
113 		return;
114 	}
115 
116 	/* Hook into system monitor. */
117 	sc->sc_sme->sme_name = sc->sc_dev.dv_xname;
118 	sc->sc_sme->sme_cookie = sc;
119 	sc->sc_sme->sme_refresh = owtemp_refresh;
120 
121 	if (sysmon_envsys_register(sc->sc_sme)) {
122 		aprint_error("%s: unable to register with sysmon\n",
123 		    sc->sc_dev.dv_xname);
124 		sysmon_envsys_destroy(sc->sc_sme);
125 		return;
126 	}
127 
128 	printf("\n");
129 }
130 
131 int
132 owtemp_detach(struct device *self, int flags)
133 {
134 	struct owtemp_softc *sc = device_private(self);
135 
136 	sysmon_envsys_unregister(sc->sc_sme);
137 
138 	return 0;
139 }
140 
141 int
142 owtemp_activate(struct device *self, enum devact act)
143 {
144 	struct owtemp_softc *sc = device_private(self);
145 
146 	switch (act) {
147 	case DVACT_ACTIVATE:
148 		return (EOPNOTSUPP);
149 	case DVACT_DEACTIVATE:
150 		sc->sc_dying = 1;
151 		break;
152 	}
153 
154 	return (0);
155 }
156 
157 void
158 owtemp_update(void *arg)
159 {
160 	struct owtemp_softc *sc = arg;
161 	u_int8_t data[9];
162 
163 	onewire_lock(sc->sc_onewire);
164 	if (onewire_reset(sc->sc_onewire) != 0)
165 		goto done;
166 	onewire_matchrom(sc->sc_onewire, sc->sc_rom);
167 
168 	/*
169 	 * Start temperature conversion. The conversion takes up to 750ms.
170 	 * After sending the command, the data line must be held high for
171 	 * at least 750ms to provide power during the conversion process.
172 	 * As such, no other activity may take place on the 1-Wire bus for
173 	 * at least this period.
174 	 */
175 	onewire_write_byte(sc->sc_onewire, DS_CMD_CONVERT);
176 	tsleep(sc, PRIBIO, "owtemp", hz);
177 
178 	if (onewire_reset(sc->sc_onewire) != 0)
179 		goto done;
180 	onewire_matchrom(sc->sc_onewire, sc->sc_rom);
181 
182 	/*
183 	 * The result of the temperature measurement is placed in the
184 	 * first two bytes of the scratchpad.
185 	 */
186 	onewire_write_byte(sc->sc_onewire, DS_CMD_READ_SCRATCHPAD);
187 	onewire_read_block(sc->sc_onewire, data, 9);
188 #if 0
189 	if (onewire_crc(data, 8) == data[8]) {
190 		sc->sc_sensor.value = 273150000 +
191 		    (int)((u_int16_t)data[1] << 8 | data[0]) * 500000;
192 	}
193 #endif
194 
195 	sc->sc_sensor.value_cur = sc->sc_owtemp_decode(data);
196 	sc->sc_sensor.state = ENVSYS_SVALID;
197 
198 done:
199 	onewire_unlock(sc->sc_onewire);
200 }
201 
202 static void
203 owtemp_refresh(struct sysmon_envsys *sme, envsys_data_t *edata)
204 {
205 	struct owtemp_softc *sc = sme->sme_cookie;
206 
207 	owtemp_update(sc);
208 }
209 
210 static uint32_t
211 owtemp_decode_ds18b20(const uint8_t *buf)
212 {
213 	int temp;
214 
215 	/*
216 	 * Sign-extend the MSB byte, and add in the fractions of a
217 	 * degree contained in the LSB (precision 1/16th DegC).
218 	 */
219 	temp = (int8_t)buf[1];
220 	temp = (temp << 8) | buf[0];
221 
222 	/*
223 	 * Conversion to uK is simple.
224 	 */
225 	return (temp * 62500 + 273150000);
226 }
227 
228 static uint32_t
229 owtemp_decode_ds1920(const uint8_t *buf)
230 {
231 	int temp;
232 
233 	/*
234 	 * Sign-extend the MSB byte, and add in the fractions of a
235 	 * degree contained in the LSB (precision 1/2 DegC).
236 	 */
237 	temp = (int8_t)buf[1];
238 	temp = (temp << 8) | buf[0];
239 
240 	/* Convert to uK */
241 	return (temp * 500000 + 273150000);
242 }
243