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