sdtemp.c revision 1.37 1 /* $NetBSD: sdtemp.c,v 1.37 2020/06/29 06:01:30 msaitoh Exp $ */
2
3 /*
4 * Copyright (c) 2009 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Paul Goyette.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: sdtemp.c,v 1.37 2020/06/29 06:01:30 msaitoh Exp $");
34
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kmem.h>
38 #include <sys/device.h>
39 #include <sys/kernel.h>
40 #include <sys/endian.h>
41 #include <sys/module.h>
42
43 #include <dev/sysmon/sysmonvar.h>
44
45 #include <dev/i2c/i2cvar.h>
46 #include <dev/i2c/sdtemp_reg.h>
47
48 struct sdtemp_softc {
49 device_t sc_dev;
50 i2c_tag_t sc_tag;
51 int sc_address;
52
53 struct sysmon_envsys *sc_sme;
54 envsys_data_t *sc_sensor;
55 sysmon_envsys_lim_t sc_deflims;
56 uint32_t sc_defprops;
57 int sc_resolution;
58 uint16_t sc_mfgid;
59 uint16_t sc_devid;
60 uint16_t sc_devid_masked;
61 uint16_t sc_capability;
62 };
63
64 static int sdtemp_match(device_t, cfdata_t, void *);
65 static void sdtemp_attach(device_t, device_t, void *);
66 static int sdtemp_detach(device_t, int);
67
68 CFATTACH_DECL_NEW(sdtemp, sizeof(struct sdtemp_softc),
69 sdtemp_match, sdtemp_attach, sdtemp_detach, NULL);
70
71 static void sdtemp_refresh(struct sysmon_envsys *, envsys_data_t *);
72 static void sdtemp_get_limits(struct sysmon_envsys *, envsys_data_t *,
73 sysmon_envsys_lim_t *, uint32_t *);
74 static void sdtemp_set_limits(struct sysmon_envsys *, envsys_data_t *,
75 sysmon_envsys_lim_t *, uint32_t *);
76 #ifdef NOT_YET
77 static int sdtemp_read_8(struct sdtemp_softc *, uint8_t, uint8_t *);
78 static int sdtemp_write_8(struct sdtemp_softc *, uint8_t, uint8_t);
79 #endif /* NOT YET */
80 static int sdtemp_read_16(struct sdtemp_softc *, uint8_t, uint16_t *);
81 static int sdtemp_write_16(struct sdtemp_softc *, uint8_t, uint16_t);
82 static uint32_t sdtemp_decode_temp(struct sdtemp_softc *, uint16_t);
83 static bool sdtemp_pmf_suspend(device_t, const pmf_qual_t *);
84 static bool sdtemp_pmf_resume(device_t, const pmf_qual_t *);
85 /* Device dependent config functions */
86 static void sdtemp_config_mcp(struct sdtemp_softc *);
87 static void sdtemp_config_idt(struct sdtemp_softc *);
88
89 struct sdtemp_dev_entry {
90 const uint16_t sdtemp_mfg_id;
91 const uint16_t sdtemp_devrev;
92 const uint16_t sdtemp_mask;
93 void (*sdtemp_config)(struct sdtemp_softc *);
94 const char *sdtemp_desc;
95 };
96
97 /* Convert sysmon_envsys uKelvin value to simple degC */
98
99 #define __UK2C(uk) (((uk) - 273150000) / 1000000)
100
101 /* List of devices known to conform to JEDEC JC42.4 */
102
103 #define CMCP sdtemp_config_mcp
104 #define CIDT sdtemp_config_idt
105
106 static const struct sdtemp_dev_entry
107 sdtemp_dev_table[] = {
108 { AT_MANUFACTURER_ID, AT_30TS00_DEVICE_ID, AT_30TS00_MASK, NULL,
109 "Atmel AT30TS00" },
110 { AT2_MANUFACTURER_ID, AT2_30TSE004_DEVICE_ID, AT2_30TSE004_MASK, NULL,
111 "Atmel AT30TSE004" },
112 { GT_MANUFACTURER_ID, GT_30TS00_DEVICE_ID, GT_30TS00_MASK, NULL,
113 "Giantec GT30TS00" },
114 { GT2_MANUFACTURER_ID, GT2_34TS02_DEVICE_ID, GT2_34TS02_MASK, NULL,
115 "Giantec GT34TS02" },
116 { MAXIM_MANUFACTURER_ID, MAX_6604_DEVICE_ID, MAX_6604_MASK, NULL,
117 "Maxim MAX6604" },
118 { MAXIM_MANUFACTURER_ID, MAX_6604_2_DEVICE_ID, MAX_6604_MASK, NULL,
119 "Maxim MAX6604" },
120 { MCP_MANUFACTURER_ID, MCP_9804_DEVICE_ID, MCP_9804_MASK, CMCP,
121 "Microchip Tech MCP9804" },
122 { MCP_MANUFACTURER_ID, MCP_9805_DEVICE_ID, MCP_9805_MASK, NULL,
123 "Microchip Tech MCP9805/MCP9843" },
124 { MCP_MANUFACTURER_ID, MCP_98242_DEVICE_ID, MCP_98242_MASK, CMCP,
125 "Microchip Tech MCP98242" },
126 { MCP_MANUFACTURER_ID, MCP_98243_DEVICE_ID, MCP_98243_MASK, CMCP,
127 "Microchip Tech MCP98243" },
128 { MCP_MANUFACTURER_ID, MCP_98244_DEVICE_ID, MCP_98244_MASK, CMCP,
129 "Microchip Tech MCP98244" },
130 { MCP2_MANUFACTURER_ID, MCP2_EMC1501_DEVICE_ID, MCP2_EMC1501_MASK, NULL,
131 "Microchip Tech EMC1501" },
132 { ADT_MANUFACTURER_ID, ADT_7408_DEVICE_ID, ADT_7408_MASK, NULL,
133 "Analog Devices ADT7408" },
134 { NXP_MANUFACTURER_ID, NXP_SE98_DEVICE_ID, NXP_SE98_MASK, NULL,
135 "NXP Semiconductors SE97B/SE98" },
136 { NXP_MANUFACTURER_ID, NXP_SE97_DEVICE_ID, NXP_SE97_MASK, NULL,
137 "NXP Semiconductors SE97" },
138 { STTS_MANUFACTURER_ID, STTS_424E_DEVICE_ID, STTS_424E_MASK, NULL,
139 "STmicroelectronics STTS424E" },
140 { STTS_MANUFACTURER_ID, STTS_424_DEVICE_ID, STTS_424_MASK, NULL,
141 "STmicroelectronics STTS424" },
142 { STTS_MANUFACTURER_ID, STTS_2002_DEVICE_ID, STTS_2002_MASK, NULL,
143 "STmicroelectronics STTS2002" },
144 { STTS_MANUFACTURER_ID, STTS_2004_DEVICE_ID, STTS_2004_MASK, NULL,
145 "STmicroelectronics STTS2004" },
146 { STTS_MANUFACTURER_ID, STTS_3000_DEVICE_ID, STTS_3000_MASK, NULL,
147 "STmicroelectronics STTS3000" },
148 { CAT_MANUFACTURER_ID, CAT_34TS02_DEVICE_ID, CAT_34TS02_MASK, NULL,
149 "Catalyst CAT34TS02/CAT6095" },
150 { CAT_MANUFACTURER_ID, CAT_34TS02C_DEVICE_ID, CAT_34TS02C_MASK, NULL,
151 "Catalyst CAT34TS02C" },
152 { CAT_MANUFACTURER_ID, CAT_34TS04_DEVICE_ID, CAT_34TS04_MASK, NULL,
153 "Catalyst CAT34TS04" },
154 { IDT_MANUFACTURER_ID, IDT_TSE2004GB2_DEVICE_ID,IDT_TSE2004GB2_MASK, NULL,
155 "Integrated Device Technology TSE2004GB2" },
156 { IDT_MANUFACTURER_ID, IDT_TS3000B3_DEVICE_ID, IDT_TS3000B3_MASK, CIDT,
157 "Integrated Device Technology TS3000B3/TSE2002B3" },
158 { IDT_MANUFACTURER_ID, IDT_TS3000GB0_DEVICE_ID, IDT_TS3000GB0_MASK, CIDT,
159 "Integrated Device Technology TS3000GB0" },
160 { IDT_MANUFACTURER_ID, IDT_TS3000GB2_DEVICE_ID, IDT_TS3000GB2_MASK, CIDT,
161 "Integrated Device Technology TS3000GB2" },
162 { IDT_MANUFACTURER_ID, IDT_TS3001GB2_DEVICE_ID, IDT_TS3001GB2_MASK, CIDT,
163 "Integrated Device Technology TS3001GB2" },
164 /*
165 * Don't change the location of the following two entries. Device specific
166 * entry must be located at above.
167 */
168 { 0, TSE2004AV_ID, TSE2004AV_MASK, NULL,
169 "TSE2004av compliant device (generic driver)" },
170 { 0, 0, 0, NULL, "Unknown" }
171 };
172
173 #undef CMCP
174 #undef CIDT
175
176 static const char *temp_resl[] = {
177 "0.5C",
178 "0.25C",
179 "0.125C",
180 "0.0625C"
181 };
182
183 static int
184 sdtemp_lookup(uint16_t mfg, uint16_t devrev)
185 {
186 int i;
187
188 for (i = 0; sdtemp_dev_table[i].sdtemp_mfg_id; i++) {
189 if (mfg != sdtemp_dev_table[i].sdtemp_mfg_id)
190 continue;
191 if ((devrev & sdtemp_dev_table[i].sdtemp_mask) ==
192 sdtemp_dev_table[i].sdtemp_devrev)
193 break;
194 }
195 /* Check TSE2004av */
196 if ((sdtemp_dev_table[i].sdtemp_mfg_id == 0)
197 && (SDTEMP_IS_TSE2004AV(devrev) == 0))
198 i++; /* Unknown */
199
200 return i;
201 }
202
203 static int
204 sdtemp_match(device_t parent, cfdata_t cf, void *aux)
205 {
206 struct i2c_attach_args *ia = aux;
207 uint16_t mfgid, devid, cap;
208 struct sdtemp_softc sc;
209 int i, error;
210
211 sc.sc_tag = ia->ia_tag;
212 sc.sc_address = ia->ia_addr;
213
214 if ((ia->ia_addr & SDTEMP_ADDRMASK) != SDTEMP_ADDR)
215 return 0;
216
217 /*
218 * Verify that we can read the manufacturer ID, Device ID and the
219 * capability
220 */
221 iic_acquire_bus(sc.sc_tag, 0);
222 error = sdtemp_read_16(&sc, SDTEMP_REG_MFG_ID, &mfgid) |
223 sdtemp_read_16(&sc, SDTEMP_REG_DEV_REV, &devid) |
224 sdtemp_read_16(&sc, SDTEMP_REG_CAPABILITY, &cap);
225 iic_release_bus(sc.sc_tag, 0);
226
227 if (error)
228 return 0;
229
230 i = sdtemp_lookup(mfgid, devid);
231 if ((sdtemp_dev_table[i].sdtemp_mfg_id == 0) &&
232 (sdtemp_dev_table[i].sdtemp_devrev == 0)) {
233 aprint_debug("sdtemp: No match for mfg 0x%04x dev 0x%02x "
234 "rev 0x%02x at address 0x%02x\n", mfgid, devid >> 8,
235 devid & 0xff, sc.sc_address);
236 return 0;
237 }
238
239 /*
240 * Check by SDTEMP_IS_TSE2004AV() might not be enough, so check the
241 * alarm capability, too.
242 */
243 if ((cap & SDTEMP_CAP_HAS_ALARM) == 0)
244 return 0;
245
246 return I2C_MATCH_ADDRESS_AND_PROBE;
247 }
248
249 static void
250 sdtemp_attach(device_t parent, device_t self, void *aux)
251 {
252 struct sdtemp_softc *sc = device_private(self);
253 struct i2c_attach_args *ia = aux;
254 uint16_t mfgid, devid;
255 int i, error;
256
257 sc->sc_tag = ia->ia_tag;
258 sc->sc_address = ia->ia_addr;
259 sc->sc_dev = self;
260
261 iic_acquire_bus(sc->sc_tag, 0);
262 if ((error = sdtemp_read_16(sc, SDTEMP_REG_MFG_ID, &mfgid)) != 0 ||
263 (error = sdtemp_read_16(sc, SDTEMP_REG_DEV_REV, &devid)) != 0) {
264 iic_release_bus(sc->sc_tag, 0);
265 aprint_error(": attach error %d\n", error);
266 return;
267 }
268 sc->sc_mfgid = mfgid;
269 sc->sc_devid = devid;
270 i = sdtemp_lookup(mfgid, devid);
271 sc->sc_devid_masked = devid & sdtemp_dev_table[i].sdtemp_mask;
272
273 aprint_naive(": Temp Sensor\n");
274 aprint_normal(": %s Temp Sensor\n", sdtemp_dev_table[i].sdtemp_desc);
275
276 if (sdtemp_dev_table[i].sdtemp_mfg_id == 0) {
277 if (SDTEMP_IS_TSE2004AV(devid))
278 aprint_normal_dev(self, "TSE2004av compliant. "
279 "Manufacturer ID 0x%04hx, Device revision 0x%02x\n",
280 mfgid, devid & TSE2004AV_REV);
281 else {
282 aprint_error_dev(self,
283 "mfg 0x%04x dev 0x%02x rev 0x%02x at addr 0x%02x\n",
284 mfgid, devid >> 8, devid & 0xff, ia->ia_addr);
285 iic_release_bus(sc->sc_tag, 0);
286 aprint_error_dev(self, "It should no happen. "
287 "Why attach() found me?\n");
288 return;
289 }
290 }
291
292 error = sdtemp_read_16(sc, SDTEMP_REG_CAPABILITY, &sc->sc_capability);
293 aprint_debug_dev(self, "capability reg = %04x\n", sc->sc_capability);
294 sc->sc_resolution
295 = __SHIFTOUT(sc->sc_capability, SDTEMP_CAP_RESOLUTION);
296 /*
297 * Call device dependent function here. Currently, it's used for
298 * the resolution.
299 *
300 * IDT's devices and some Microchip's devices have the resolution
301 * register in the vendor specific registers area. The devices'
302 * resolution bits in the capability register are not the maximum
303 * resolution but the current value of the setting.
304 */
305 if (sdtemp_dev_table[i].sdtemp_config != NULL)
306 sdtemp_dev_table[i].sdtemp_config(sc);
307
308 aprint_normal_dev(self, "%s accuracy",
309 (sc->sc_capability & SDTEMP_CAP_ACCURACY_1C) ? "high" : "default");
310 if ((sc->sc_capability & SDTEMP_CAP_WIDER_RANGE) != 0)
311 aprint_normal(", wider range");
312 aprint_normal(", %s resolution", temp_resl[sc->sc_resolution]);
313 if ((sc->sc_capability & SDTEMP_CAP_VHV) != 0)
314 aprint_debug(", high voltage standoff");
315 aprint_debug(", %s timeout",
316 (sc->sc_capability & SDTEMP_CAP_TMOUT) ? "25-35ms" : "10-60ms");
317 if ((sc->sc_capability & SDTEMP_CAP_EVSD) != 0)
318 aprint_normal(", event with shutdown");
319 aprint_normal("\n");
320 /*
321 * Alarm capability is required; if not present, this is likely
322 * not a real sdtemp device.
323 */
324 if (error != 0 || (sc->sc_capability & SDTEMP_CAP_HAS_ALARM) == 0) {
325 iic_release_bus(sc->sc_tag, 0);
326 aprint_error_dev(self,
327 "required alarm capability not present!\n");
328 return;
329 }
330 /* Set the configuration to defaults. */
331 error = sdtemp_write_16(sc, SDTEMP_REG_CONFIG, 0);
332 if (error != 0) {
333 iic_release_bus(sc->sc_tag, 0);
334 aprint_error_dev(self, "error %d writing config register\n",
335 error);
336 return;
337 }
338 iic_release_bus(sc->sc_tag, 0);
339
340 /* Hook us into the sysmon_envsys subsystem */
341 sc->sc_sme = sysmon_envsys_create();
342 sc->sc_sme->sme_name = device_xname(self);
343 sc->sc_sme->sme_cookie = sc;
344 sc->sc_sme->sme_refresh = sdtemp_refresh;
345 sc->sc_sme->sme_get_limits = sdtemp_get_limits;
346 sc->sc_sme->sme_set_limits = sdtemp_set_limits;
347
348 sc->sc_sensor = kmem_zalloc(sizeof(envsys_data_t), KM_SLEEP);
349
350 /* Initialize sensor data. */
351 sc->sc_sensor->units = ENVSYS_STEMP;
352 sc->sc_sensor->state = ENVSYS_SINVALID;
353 sc->sc_sensor->flags |= ENVSYS_FMONLIMITS;
354 (void)strlcpy(sc->sc_sensor->desc, device_xname(self),
355 sizeof(sc->sc_sensor->desc));
356 snprintf(sc->sc_sensor->desc, sizeof(sc->sc_sensor->desc),
357 "DIMM %d temperature", sc->sc_address - SDTEMP_ADDR);
358
359 /* Now attach the sensor */
360 if (sysmon_envsys_sensor_attach(sc->sc_sme, sc->sc_sensor)) {
361 aprint_error_dev(self, "unable to attach sensor\n");
362 goto bad;
363 }
364
365 /* Register the device */
366 error = sysmon_envsys_register(sc->sc_sme);
367 if (error) {
368 aprint_error_dev(self, "error %d registering with sysmon\n",
369 error);
370 goto bad;
371 }
372
373 if (!pmf_device_register(self, sdtemp_pmf_suspend, sdtemp_pmf_resume))
374 aprint_error_dev(self, "couldn't establish power handler\n");
375
376 /* Retrieve and display hardware monitor limits */
377 sdtemp_get_limits(sc->sc_sme, sc->sc_sensor, &sc->sc_deflims,
378 &sc->sc_defprops);
379 aprint_normal_dev(self, "Hardware limits: ");
380 i = 0;
381 if (sc->sc_defprops & PROP_WARNMIN) {
382 aprint_normal("low %dC",
383 __UK2C(sc->sc_deflims.sel_warnmin));
384 i++;
385 }
386 if (sc->sc_defprops & PROP_WARNMAX) {
387 aprint_normal("%shigh %dC ", (i)?", ":"",
388 __UK2C(sc->sc_deflims.sel_warnmax));
389 i++;
390 }
391 if (sc->sc_defprops & PROP_CRITMAX) {
392 aprint_normal("%scritical %dC ", (i)?", ":"",
393 __UK2C(sc->sc_deflims.sel_critmax));
394 i++;
395 }
396 aprint_normal("%s\n", (i)?"":"none set");
397
398 return;
399
400 bad:
401 kmem_free(sc->sc_sensor, sizeof(envsys_data_t));
402 sysmon_envsys_destroy(sc->sc_sme);
403 }
404
405 static int
406 sdtemp_detach(device_t self, int flags)
407 {
408 struct sdtemp_softc *sc = device_private(self);
409
410 pmf_device_deregister(self);
411
412 if (sc->sc_sme)
413 sysmon_envsys_unregister(sc->sc_sme);
414 if (sc->sc_sensor)
415 kmem_free(sc->sc_sensor, sizeof(envsys_data_t));
416
417 return 0;
418 }
419
420 /* Retrieve current limits from device, and encode in uKelvins */
421 static void
422 sdtemp_get_limits(struct sysmon_envsys *sme, envsys_data_t *edata,
423 sysmon_envsys_lim_t *limits, uint32_t *props)
424 {
425 struct sdtemp_softc *sc = sme->sme_cookie;
426 uint16_t lim;
427
428 *props = 0;
429 iic_acquire_bus(sc->sc_tag, 0);
430 if (sdtemp_read_16(sc, SDTEMP_REG_LOWER_LIM, &lim) == 0 && lim != 0) {
431 limits->sel_warnmin = sdtemp_decode_temp(sc, lim);
432 *props |= PROP_WARNMIN;
433 }
434 if (sdtemp_read_16(sc, SDTEMP_REG_UPPER_LIM, &lim) == 0 && lim != 0) {
435 limits->sel_warnmax = sdtemp_decode_temp(sc, lim);
436 *props |= PROP_WARNMAX;
437 }
438 if (sdtemp_read_16(sc, SDTEMP_REG_CRIT_LIM, &lim) == 0 && lim != 0) {
439 limits->sel_critmax = sdtemp_decode_temp(sc, lim);
440 *props |= PROP_CRITMAX;
441 }
442 iic_release_bus(sc->sc_tag, 0);
443 if (*props != 0)
444 *props |= PROP_DRIVER_LIMITS;
445 }
446
447 /* Send current limit values to the device */
448 static void
449 sdtemp_set_limits(struct sysmon_envsys *sme, envsys_data_t *edata,
450 sysmon_envsys_lim_t *limits, uint32_t *props)
451 {
452 uint16_t val;
453 struct sdtemp_softc *sc = sme->sme_cookie;
454
455 if (limits == NULL) {
456 limits = &sc->sc_deflims;
457 props = &sc->sc_defprops;
458 }
459 iic_acquire_bus(sc->sc_tag, 0);
460 if (*props & PROP_WARNMIN) {
461 val = __UK2C(limits->sel_warnmin);
462 (void)sdtemp_write_16(sc, SDTEMP_REG_LOWER_LIM,
463 (val << 4) & SDTEMP_TEMP_MASK);
464 }
465 if (*props & PROP_WARNMAX) {
466 val = __UK2C(limits->sel_warnmax);
467 (void)sdtemp_write_16(sc, SDTEMP_REG_UPPER_LIM,
468 (val << 4) & SDTEMP_TEMP_MASK);
469 }
470 if (*props & PROP_CRITMAX) {
471 val = __UK2C(limits->sel_critmax);
472 (void)sdtemp_write_16(sc, SDTEMP_REG_CRIT_LIM,
473 (val << 4) & SDTEMP_TEMP_MASK);
474 }
475 iic_release_bus(sc->sc_tag, 0);
476
477 /*
478 * If at least one limit is set that we can handle, and no
479 * limits are set that we cannot handle, tell sysmon that
480 * the driver will take care of monitoring the limits!
481 */
482 if (*props & (PROP_CRITMIN | PROP_BATTCAP | PROP_BATTWARN))
483 *props &= ~PROP_DRIVER_LIMITS;
484 else if (*props & PROP_LIMITS)
485 *props |= PROP_DRIVER_LIMITS;
486 else
487 *props &= ~PROP_DRIVER_LIMITS;
488 }
489
490 #ifdef NOT_YET /* All registers on these sensors are 16-bits */
491
492 /* Read a 8-bit value from a register */
493 static int
494 sdtemp_read_8(struct sdtemp_softc *sc, uint8_t reg, uint8_t *valp)
495 {
496 int error;
497
498 error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
499 sc->sc_address, ®, 1, valp, sizeof(*valp), 0);
500
501 return error;
502 }
503
504 static int
505 sdtemp_write_8(struct sdtemp_softc *sc, uint8_t reg, uint8_t val)
506 {
507 return iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP,
508 sc->sc_address, ®, 1, &val, sizeof(val), 0);
509 }
510 #endif /* NOT_YET */
511
512 /* Read a 16-bit value from a register */
513 static int
514 sdtemp_read_16(struct sdtemp_softc *sc, uint8_t reg, uint16_t *valp)
515 {
516 int error;
517
518 error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
519 sc->sc_address, ®, 1, valp, sizeof(*valp), 0);
520 if (error)
521 return error;
522
523 *valp = be16toh(*valp);
524
525 return 0;
526 }
527
528 static int
529 sdtemp_write_16(struct sdtemp_softc *sc, uint8_t reg, uint16_t val)
530 {
531 uint16_t temp;
532
533 temp = htobe16(val);
534 return iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP,
535 sc->sc_address, ®, 1, &temp, sizeof(temp), 0);
536 }
537
538 static uint32_t
539 sdtemp_decode_temp(struct sdtemp_softc *sc, uint16_t temp)
540 {
541 uint32_t val;
542 int32_t stemp;
543
544 /* Get only the temperature bits */
545 temp &= SDTEMP_TEMP_MASK;
546
547 /* If necessary, extend the sign bit */
548 if ((sc->sc_capability & SDTEMP_CAP_WIDER_RANGE) &&
549 (temp & SDTEMP_TEMP_NEGATIVE))
550 temp |= SDTEMP_TEMP_SIGN_EXT;
551
552 /* Mask off only bits valid within current resolution */
553 temp &= ~(0x7 >> sc->sc_resolution);
554
555 /* Treat as signed and extend to 32-bits */
556 stemp = (int16_t)temp;
557
558 /* Now convert from 0.0625 (1/16) deg C increments to microKelvins */
559 val = (stemp * 62500) + 273150000;
560
561 return val;
562 }
563
564 static void
565 sdtemp_refresh(struct sysmon_envsys *sme, envsys_data_t *edata)
566 {
567 struct sdtemp_softc *sc = sme->sme_cookie;
568 uint16_t val;
569 int error;
570
571 iic_acquire_bus(sc->sc_tag, 0);
572 error = sdtemp_read_16(sc, SDTEMP_REG_AMBIENT_TEMP, &val);
573 iic_release_bus(sc->sc_tag, 0);
574
575 if (error) {
576 edata->state = ENVSYS_SINVALID;
577 return;
578 }
579
580 edata->value_cur = sdtemp_decode_temp(sc, val);
581
582 /* Now check for limits */
583 if ((edata->upropset & PROP_DRIVER_LIMITS) == 0)
584 edata->state = ENVSYS_SVALID;
585 else if ((val & SDTEMP_ABOVE_CRIT) &&
586 (edata->upropset & PROP_CRITMAX))
587 edata->state = ENVSYS_SCRITOVER;
588 else if ((val & SDTEMP_ABOVE_UPPER) &&
589 (edata->upropset & PROP_WARNMAX))
590 edata->state = ENVSYS_SWARNOVER;
591 else if ((val & SDTEMP_BELOW_LOWER) &&
592 (edata->upropset & PROP_WARNMIN))
593 edata->state = ENVSYS_SWARNUNDER;
594 else
595 edata->state = ENVSYS_SVALID;
596 }
597
598 /*
599 * Power management functions
600 *
601 * We go into "shutdown" mode at suspend time, and return to normal
602 * mode upon resume. This reduces power consumption by disabling
603 * the A/D converter.
604 */
605
606 static bool
607 sdtemp_pmf_suspend(device_t dev, const pmf_qual_t *qual)
608 {
609 struct sdtemp_softc *sc = device_private(dev);
610 int error;
611 uint16_t config;
612
613 iic_acquire_bus(sc->sc_tag, 0);
614 error = sdtemp_read_16(sc, SDTEMP_REG_CONFIG, &config);
615 if (error == 0) {
616 config |= SDTEMP_CONFIG_SHUTDOWN_MODE;
617 error = sdtemp_write_16(sc, SDTEMP_REG_CONFIG, config);
618 }
619 iic_release_bus(sc->sc_tag, 0);
620 return (error == 0);
621 }
622
623 static bool
624 sdtemp_pmf_resume(device_t dev, const pmf_qual_t *qual)
625 {
626 struct sdtemp_softc *sc = device_private(dev);
627 int error;
628 uint16_t config;
629
630 iic_acquire_bus(sc->sc_tag, 0);
631 error = sdtemp_read_16(sc, SDTEMP_REG_CONFIG, &config);
632 if (error == 0) {
633 config &= ~SDTEMP_CONFIG_SHUTDOWN_MODE;
634 error = sdtemp_write_16(sc, SDTEMP_REG_CONFIG, config);
635 }
636 iic_release_bus(sc->sc_tag, 0);
637 return (error == 0);
638 }
639
640 /* Device dependent config functions */
641
642 static void
643 sdtemp_config_mcp(struct sdtemp_softc *sc)
644 {
645 int rv;
646 uint8_t resolreg;
647
648 /* Note that MCP9805 has no resolution register */
649 switch (sc->sc_devid_masked) {
650 case MCP_9804_DEVICE_ID:
651 case MCP_98242_DEVICE_ID:
652 case MCP_98243_DEVICE_ID:
653 resolreg = SDTEMP_REG_MCP_RESOLUTION_9804;
654 break;
655 case MCP_98244_DEVICE_ID:
656 resolreg = SDTEMP_REG_MCP_RESOLUTION_98244;
657 break;
658 default:
659 aprint_error("%s: %s: unknown device ID (%04hx)\n",
660 device_xname(sc->sc_dev), __func__, sc->sc_devid_masked);
661 return;
662 }
663
664 /*
665 * Set resolution to the max.
666 *
667 * Even if it fails, the resolution will be the default. It's not a
668 * fatal error.
669 */
670 rv = sdtemp_write_16(sc, resolreg, SDTEMP_CAP_RESOLUTION_MAX);
671 if (rv == 0)
672 sc->sc_resolution = SDTEMP_CAP_RESOLUTION_MAX;
673 else
674 aprint_error("%s: error %d writing resolution register\n",
675 device_xname(sc->sc_dev), rv);
676 }
677
678 static void
679 sdtemp_config_idt(struct sdtemp_softc *sc)
680 {
681 int rv;
682
683 /*
684 * Set resolution to the max.
685 *
686 * Even if it fails, the resolution will be the default. It's not a
687 * fatal error.
688 */
689 rv = sdtemp_write_16(sc, SDTEMP_REG_IDT_RESOLUTION,
690 __SHIFTIN(SDTEMP_CAP_RESOLUTION_MAX, SDTEMP_CAP_RESOLUTION));
691 if (rv == 0)
692 sc->sc_resolution = SDTEMP_CAP_RESOLUTION_MAX;
693 else
694 aprint_error("%s: error %d writing resolution register\n",
695 device_xname(sc->sc_dev), rv);
696 }
697
698 MODULE(MODULE_CLASS_DRIVER, sdtemp, "i2cexec,sysmon_envsys");
699
700 #ifdef _MODULE
701 #include "ioconf.c"
702 #endif
703
704 static int
705 sdtemp_modcmd(modcmd_t cmd, void *opaque)
706 {
707 int error = 0;
708
709 switch (cmd) {
710 case MODULE_CMD_INIT:
711 #ifdef _MODULE
712 error = config_init_component(cfdriver_ioconf_sdtemp,
713 cfattach_ioconf_sdtemp, cfdata_ioconf_sdtemp);
714 #endif
715 return error;
716 case MODULE_CMD_FINI:
717 #ifdef _MODULE
718 error = config_fini_component(cfdriver_ioconf_sdtemp,
719 cfattach_ioconf_sdtemp, cfdata_ioconf_sdtemp);
720 #endif
721 return error;
722 default:
723 return ENOTTY;
724 }
725 }
726