adadc.c revision 1.12
1/* $NetBSD: adadc.c,v 1.12 2025/09/17 13:42:42 thorpej Exp $ */ 2 3/*- 4 * Copyright (c) 2018 Michael Lorenz 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29/* 30 * a driver for Analog Devices AD7417 temperature sensors / ADCs 31 * very much macppc only for now since we need calibaration data to make sense 32 * of the ADC inputs 33 * info on how to get these from FreeBSD and Linux 34 */ 35 36#include <sys/cdefs.h> 37__KERNEL_RCSID(0, "$NetBSD: adadc.c,v 1.12 2025/09/17 13:42:42 thorpej Exp $"); 38 39#include <sys/param.h> 40#include <sys/systm.h> 41#include <sys/device.h> 42#include <sys/conf.h> 43#include <sys/bus.h> 44 45#include <dev/i2c/i2cvar.h> 46 47#include <dev/sysmon/sysmonvar.h> 48 49#include <dev/ofw/openfirm.h> 50 51/* commands */ 52#define ADADC_TEMP 0x00 /* temperature, 16bit */ 53#define ADADC_CONFIG 0x01 /* 8bit */ 54#define ADADC_THYST 0x02 /* 16bit */ 55#define ADADC_TOTI 0x03 /* 16bit, temperature threshold */ 56#define ADADC_ADC 0x04 /* 16bit, ADC value */ 57#define ADADC_CONFIG2 0x05 /* 8bit */ 58 59/* 60 * registers 61 * ADADC_TEMP has signed temperature in C in first byte, left aligned fraction 62 * in 2nd byte. 63 */ 64 65#define ADADC_CFG_CHANNEL_0 0x00 66#define ADADC_CFG_CHANNEL_1 0x20 67#define ADADC_CFG_CHANNEL_2 0x40 68#define ADADC_CFG_CHANNEL_3 0x60 69#define ADADC_CFG_CHANNEL_4 0x80 70#define ADADC_CFG_CHANNEL_MASK 0xe0 71#define ADADC_CFG_FAULT_MASK 0x18 72#define ADADC_CFG_OTI_POL 0x04 /* overtemp output polarity */ 73#define ADADC_CFG_INTMODE 0x02 /* interrupt mode */ 74#define ADADC_CFG_SHUTDOWN 0x01 /* shutdown mode */ 75 76 77struct adadc_softc { 78 device_t sc_dev; 79 i2c_tag_t sc_i2c; 80 i2c_addr_t sc_addr; 81 82 struct sysmon_envsys *sc_sme; 83 envsys_data_t sc_sensors[5]; 84 int sc_nsensors; 85 int sc_diode_offset, sc_diode_slope; 86}; 87 88static int adadc_match(device_t, cfdata_t, void *); 89static void adadc_attach(device_t, device_t, void *); 90 91static void adadc_sensors_refresh(struct sysmon_envsys *, envsys_data_t *); 92 93CFATTACH_DECL_NEW(adadc, sizeof(struct adadc_softc), 94 adadc_match, adadc_attach, NULL, NULL); 95 96static const struct device_compatible_entry compat_data[] = { 97 { .compat = "ad7417" }, 98 DEVICE_COMPAT_EOL 99}; 100 101/* calibaration table from Darwin via Linux */ 102static int slope[5] = {0, 0, 0x0320, 0x00a0, 0x1f40}; 103 104static int 105adadc_match(device_t parent, cfdata_t match, void *aux) 106{ 107 struct i2c_attach_args *ia = aux; 108 int match_result; 109 110 if (iic_use_direct_match(ia, match, compat_data, &match_result)) 111 return match_result; 112 113 /* 114 * XXX 115 * this driver is pretty much useless without OF, should 116 * probably remove this 117 */ 118 if ((ia->ia_addr & 0x2b) == 0x2b) 119 return I2C_MATCH_ADDRESS_ONLY; 120 121 return 0; 122} 123 124static void 125adadc_attach(device_t parent, device_t self, void *aux) 126{ 127 struct adadc_softc *sc = device_private(self); 128 struct i2c_attach_args *ia = aux; 129 envsys_data_t *s; 130 int error, ch; 131 uint32_t eeprom[40]; 132 char loc[256]; 133 int which_cpu; 134 int phandle = devhandle_to_of(device_handle(self)); 135 136 sc->sc_dev = self; 137 sc->sc_i2c = ia->ia_tag; 138 sc->sc_addr = ia->ia_addr; 139 140 aprint_naive("\n"); 141 aprint_normal(": AD7417\n"); 142 143 sc->sc_sme = sysmon_envsys_create(); 144 sc->sc_sme->sme_name = device_xname(self); 145 sc->sc_sme->sme_cookie = sc; 146 sc->sc_sme->sme_refresh = adadc_sensors_refresh; 147 sc->sc_nsensors = 0; 148 149 /* 150 * XXX 151 * without OpenFirmware telling us how to interpret the ADC inputs we 152 * should probably just expose the temperature and four ENVSYS_INTEGERs 153 */ 154 which_cpu = 0; 155 ch = OF_child(phandle); 156 if (ch == 0) { 157 /* old style info */ 158 int len, idx = 0, reg = 0; 159 uint32_t ids[16]; 160 char buffer[256]; 161 len = OF_getprop(phandle, "hwsensor-id", ids, 64); 162 OF_getprop(phandle, "hwsensor-location", buffer, 256); 163 while (len > 0) { 164 strcpy(loc, &buffer[idx]); 165 s = &sc->sc_sensors[sc->sc_nsensors]; 166 s->state = ENVSYS_SINVALID; 167 /* 168 * this setup matches my 1.8GHz PCI-X G5, Linux and 169 * FreeBSD hardcode these as well so we should be safe 170 */ 171 switch (reg) { 172 case 0: 173 if (strstr(loc, "CPU B") != NULL) 174 which_cpu = 1; 175 /* FALLTHROUGH */ 176 case 1: 177 s->units = ENVSYS_STEMP; 178 break; 179 case 2: 180 case 4: 181 s->units = ENVSYS_SAMPS; 182 break; 183 case 3: 184 s->units = ENVSYS_SVOLTS_DC; 185 break; 186 default: 187 s->units = ENVSYS_INTEGER; 188 } 189 strncpy(s->desc, loc, sizeof(s->desc)); 190 s->private = reg; 191 sysmon_envsys_sensor_attach(sc->sc_sme, s); 192 sc->sc_nsensors++; 193 len -= 4; 194 idx += strlen(loc) + 1; 195 reg++; 196 } 197 } else { 198 while (ch != 0) { 199 if (OF_getprop(ch, "location", loc, 32) > 0) { 200 int reg = 0; 201 OF_getprop(ch, "reg", ®, sizeof(reg)); 202 s = &sc->sc_sensors[sc->sc_nsensors]; 203 s->state = ENVSYS_SINVALID; 204 /* 205 * this setup matches my 2x 2.5GHz PCI-X G5, Linux and 206 * FreeBSD hardcode these as well so we should be safe 207 */ 208 switch (reg) { 209 case 0: 210 if (strstr(loc, "CPU B") != NULL) 211 which_cpu = 1; 212 /* FALLTHROUGH */ 213 case 1: 214 s->units = ENVSYS_STEMP; 215 break; 216 case 2: 217 case 4: 218 s->units = ENVSYS_SAMPS; 219 break; 220 case 3: 221 s->units = ENVSYS_SVOLTS_DC; 222 break; 223 default: 224 s->units = ENVSYS_INTEGER; 225 } 226 strncpy(s->desc, loc, sizeof(s->desc)); 227 s->private = reg; 228 sysmon_envsys_sensor_attach(sc->sc_sme, s); 229 sc->sc_nsensors++; 230 } 231 ch = OF_peer(ch); 232 } 233 } 234 aprint_debug_dev(self, "monitoring CPU %d\n", which_cpu); 235 error = get_cpuid(which_cpu, (uint8_t *)eeprom); 236 if (error >= 0) { 237 sc->sc_diode_slope = eeprom[0x11] >> 16; 238 sc->sc_diode_offset = (int16_t)(eeprom[0x11] & 0xffff) << 12; 239 } 240 sysmon_envsys_register(sc->sc_sme); 241} 242 243static void 244adadc_sensors_refresh(struct sysmon_envsys *sme, envsys_data_t *edata) 245{ 246 struct adadc_softc *sc = sme->sme_cookie; 247 uint8_t cmd = ADADC_CONFIG; 248 int16_t data = 0; 249 uint16_t rdata; 250 uint8_t cfg; 251 int error, ch; 252 253 254 iic_acquire_bus(sc->sc_i2c, 0); 255 if (edata->private > 0) { 256 error = iic_exec(sc->sc_i2c, I2C_OP_READ_WITH_STOP, 257 sc->sc_addr, &cmd, 1, &cfg, 1, 0); 258 ch = cfg >> 5; 259 /* are we on the right channel already? */ 260 if (ch != edata->private) { 261 /* nope */ 262 cfg &= 0x1f; 263 cfg |= (edata->private & 7) << 5; 264 iic_exec(sc->sc_i2c, I2C_OP_WRITE_WITH_STOP, 265 sc->sc_addr, &cmd, 1, &cfg, 1, 0); 266 } 267 cmd = ADADC_ADC; 268 /* now read the ADC register */ 269 error = iic_exec(sc->sc_i2c, I2C_OP_READ_WITH_STOP, 270 sc->sc_addr, &cmd, 1, &rdata, 2, 0); 271 rdata = be16toh(rdata) >> 6; 272 if (edata->private == 1) { 273 int temp; 274 temp = (rdata * sc->sc_diode_slope + 275 sc->sc_diode_offset) >> 2; 276 /* 16.16 fixed point */ 277 edata->value_cur = (temp >> 12) * 62500 + 273150000; 278 } else { 279 /* 280 * the input is 10bit, so converting to 8.4 fixed point 281 * is more than enough 282 */ 283 int temp = rdata * slope[edata->private]; 284 edata->value_cur = (temp >> 12) * 62500; 285 } 286 } else { 287 cmd = ADADC_TEMP; 288 /* just read the temperature register */ 289 error = iic_exec(sc->sc_i2c, I2C_OP_READ_WITH_STOP, 290 sc->sc_addr, &cmd, 1, &data, 2, 0); 291 /* 8.2 bit fixed point Celsius -> microkelvin */ 292 edata->value_cur = ((data >> 6) * 250000) + 273150000; 293 } 294 iic_release_bus(sc->sc_i2c, 0); 295 296 if (error) { 297 edata->state = ENVSYS_SINVALID; 298 } else { 299 edata->state = ENVSYS_SVALID; 300 } 301} 302