1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2012 Damjan Marion <dmarion@Freebsd.org> 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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 /* 32 * TI TPS65217 PMIC companion chip for AM335x SoC sitting on I2C bus 33 */ 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/eventhandler.h> 37 #include <sys/kernel.h> 38 #include <sys/module.h> 39 #include <sys/clock.h> 40 #include <sys/time.h> 41 #include <sys/bus.h> 42 #include <sys/proc.h> 43 #include <sys/reboot.h> 44 #include <sys/resource.h> 45 #include <sys/rman.h> 46 47 #include <dev/iicbus/iicbus.h> 48 #include <dev/iicbus/iiconf.h> 49 50 #include <dev/ofw/openfirm.h> 51 #include <dev/ofw/ofw_bus.h> 52 #include <dev/ofw/ofw_bus_subr.h> 53 54 #include <arm/ti/am335x/am335x_rtcvar.h> 55 #include <arm/ti/am335x/tps65217x.h> 56 57 #include "iicbus_if.h" 58 59 #define MAX_IIC_DATA_SIZE 2 60 61 62 struct am335x_pmic_softc { 63 device_t sc_dev; 64 uint32_t sc_addr; 65 struct intr_config_hook enum_hook; 66 struct resource *sc_irq_res; 67 void *sc_intrhand; 68 }; 69 70 static const char *tps65217_voreg_c[4] = {"4.10V", "4.15V", "4.20V", "4.25V"}; 71 72 static int am335x_pmic_bootverbose = 0; 73 TUNABLE_INT("hw.am335x_pmic.bootverbose", &am335x_pmic_bootverbose); 74 static char am335x_pmic_vo[6]; 75 TUNABLE_STR("hw.am335x_pmic.vo", am335x_pmic_vo, sizeof(am335x_pmic_vo)); 76 77 static void am335x_pmic_shutdown(void *, int); 78 79 static int 80 am335x_pmic_read(device_t dev, uint8_t addr, uint8_t *data, uint8_t size) 81 { 82 return (iicdev_readfrom(dev, addr, data, size, IIC_INTRWAIT)); 83 } 84 85 static int 86 am335x_pmic_write(device_t dev, uint8_t address, uint8_t *data, uint8_t size) 87 { 88 if (size > MAX_IIC_DATA_SIZE) 89 return (ENOMEM); 90 91 return (iicdev_writeto(dev, address, data, size, IIC_INTRWAIT)); 92 } 93 94 static void 95 am335x_pmic_intr(void *arg) 96 { 97 struct am335x_pmic_softc *sc = (struct am335x_pmic_softc *)arg; 98 struct tps65217_status_reg status_reg; 99 struct tps65217_int_reg int_reg; 100 int rv; 101 char notify_buf[16]; 102 103 THREAD_SLEEPING_OK(); 104 rv = am335x_pmic_read(sc->sc_dev, TPS65217_INT_REG, (uint8_t *)&int_reg, 1); 105 if (rv != 0) { 106 device_printf(sc->sc_dev, "Cannot read interrupt register\n"); 107 THREAD_NO_SLEEPING(); 108 return; 109 } 110 rv = am335x_pmic_read(sc->sc_dev, TPS65217_STATUS_REG, (uint8_t *)&status_reg, 1); 111 if (rv != 0) { 112 device_printf(sc->sc_dev, "Cannot read status register\n"); 113 THREAD_NO_SLEEPING(); 114 return; 115 } 116 THREAD_NO_SLEEPING(); 117 118 if (int_reg.pbi && status_reg.pb) 119 shutdown_nice(RB_POWEROFF); 120 if (int_reg.aci) { 121 snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", 122 status_reg.acpwr); 123 devctl_notify_f("ACPI", "ACAD", "power", notify_buf, M_NOWAIT); 124 } 125 } 126 127 static int 128 am335x_pmic_probe(device_t dev) 129 { 130 struct am335x_pmic_softc *sc; 131 132 if (!ofw_bus_is_compatible(dev, "ti,tps65217")) 133 return (ENXIO); 134 135 sc = device_get_softc(dev); 136 sc->sc_dev = dev; 137 /* Convert to 8-bit addressing */ 138 sc->sc_addr = iicbus_get_addr(dev); 139 140 device_set_desc(dev, "TI TPS65217 Power Management IC"); 141 142 return (0); 143 } 144 145 static void 146 am335x_pmic_dump_chgconfig(device_t dev) 147 { 148 struct tps65217_chgconfig0_reg reg0; 149 struct tps65217_chgconfig1_reg reg1; 150 struct tps65217_chgconfig2_reg reg2; 151 struct tps65217_chgconfig3_reg reg3; 152 const char *e_d[] = {"enabled", "disabled"}; 153 const char *d_e[] = {"disabled", "enabled"}; 154 const char *i_a[] = {"inactive", "active"}; 155 const char *f_t[] = {"false", "true"}; 156 const char *timer_c[] = {"4h", "5h", "6h", "8h"}; 157 const char *ntc_type_c[] = {"100k", "10k"}; 158 const char *vprechg_c[] = {"2.9V", "2.5V"}; 159 const char *trange_c[] = {"0-45 C", "0-60 C"}; 160 const char *termif_c[] = {"2.5%", "7.5%", "15%", "18%"}; 161 const char *pchrgt_c[] = {"30 min", "60 min"}; 162 const char *dppmth_c[] = {"3.50V", "3.75V", "4.00V", "4.25V"}; 163 const char *ichrg_c[] = {"300mA", "400mA", "500mA", "700mA"}; 164 165 am335x_pmic_read(dev, TPS65217_CHGCONFIG0_REG, (uint8_t *)®0, 1); 166 device_printf(dev, " BAT TEMP/NTC ERROR: %s\n", f_t[reg0.battemp]); 167 device_printf(dev, " Pre-charge timer time-out: %s\n", f_t[reg0.pchgtout]); 168 device_printf(dev, " Charge timer time-out: %s\n", f_t[reg0.chgtout]); 169 device_printf(dev, " Charger active: %s\n", f_t[reg0.active]); 170 device_printf(dev, " Termination current detected: %s\n", f_t[reg0.termi]); 171 device_printf(dev, " Thermal suspend: %s\n", f_t[reg0.tsusp]); 172 device_printf(dev, " DPPM active: %s\n", f_t[reg0.dppm]); 173 device_printf(dev, " Thermal regulation: %s\n", i_a[reg0.treg]); 174 175 am335x_pmic_read(dev, TPS65217_CHGCONFIG1_REG, (uint8_t *)®1, 1); 176 device_printf(dev, " Charger: %s\n", d_e[reg1.chg_en]); 177 device_printf(dev, " Suspend charge: %s\n", i_a[reg1.susp]); 178 device_printf(dev, " Charge termination: %s\n", e_d[reg1.term]); 179 device_printf(dev, " Charger reset: %s\n", i_a[reg1.reset]); 180 device_printf(dev, " NTC TYPE: %s\n", ntc_type_c[reg1.ntc_type]); 181 device_printf(dev, " Safety timer: %s\n", d_e[reg1.tmr_en]); 182 device_printf(dev, " Charge safety timer: %s\n", timer_c[reg1.timer]); 183 184 am335x_pmic_read(dev, TPS65217_CHGCONFIG2_REG, (uint8_t *)®2, 1); 185 device_printf(dev, " Charge voltage: %s\n", tps65217_voreg_c[reg2.voreg]); 186 device_printf(dev, " Pre-charge to fast charge transition voltage: %s\n", 187 vprechg_c[reg2.vprechg]); 188 device_printf(dev, " Dynamic timer function: %s\n", d_e[reg2.dyntmr]); 189 190 am335x_pmic_read(dev, TPS65217_CHGCONFIG3_REG, (uint8_t *)®3, 1); 191 device_printf(dev, " Temperature range for charging: %s\n", trange_c[reg3.trange]); 192 device_printf(dev, " Termination current factor: %s\n", termif_c[reg3.termif]); 193 device_printf(dev, " Pre-charge time: %s\n", pchrgt_c[reg3.pchrgt]); 194 device_printf(dev, " Power path DPPM threshold: %s\n", dppmth_c[reg3.dppmth]); 195 device_printf(dev, " Charge current: %s\n", ichrg_c[reg3.ichrg]); 196 } 197 198 static void 199 am335x_pmic_setvo(device_t dev, uint8_t vo) 200 { 201 struct tps65217_chgconfig2_reg reg2; 202 203 am335x_pmic_read(dev, TPS65217_CHGCONFIG2_REG, (uint8_t *)®2, 1); 204 reg2.voreg = vo; 205 am335x_pmic_write(dev, TPS65217_CHGCONFIG2_REG, (uint8_t *)®2, 1); 206 } 207 208 static void 209 am335x_pmic_start(void *xdev) 210 { 211 struct am335x_pmic_softc *sc; 212 device_t dev = (device_t)xdev; 213 struct tps65217_status_reg status_reg; 214 struct tps65217_chipid_reg chipid_reg; 215 uint8_t reg, vo; 216 char name[20]; 217 char pwr[4][11] = {"Battery", "USB", "AC", "USB and AC"}; 218 int rv; 219 220 sc = device_get_softc(dev); 221 222 am335x_pmic_read(dev, TPS65217_CHIPID_REG, (uint8_t *)&chipid_reg, 1); 223 switch (chipid_reg.chip) { 224 case TPS65217A: 225 sprintf(name, "TPS65217A ver 1.%u", chipid_reg.rev); 226 break; 227 case TPS65217B: 228 sprintf(name, "TPS65217B ver 1.%u", chipid_reg.rev); 229 break; 230 case TPS65217C: 231 sprintf(name, "TPS65217C ver 1.%u", chipid_reg.rev); 232 break; 233 case TPS65217D: 234 sprintf(name, "TPS65217D ver 1.%u", chipid_reg.rev); 235 break; 236 default: 237 sprintf(name, "Unknown PMIC"); 238 } 239 240 am335x_pmic_read(dev, TPS65217_STATUS_REG, (uint8_t *)&status_reg, 1); 241 device_printf(dev, "%s powered by %s\n", name, 242 pwr[status_reg.usbpwr | (status_reg.acpwr << 1)]); 243 244 if (am335x_pmic_vo[0] != '\0') { 245 for (vo = 0; vo < 4; vo++) { 246 if (strcmp(tps65217_voreg_c[vo], am335x_pmic_vo) == 0) 247 break; 248 } 249 if (vo == 4) { 250 device_printf(dev, "WARNING: hw.am335x_pmic.vo=\"%s\"" 251 ": unsupported value\n", am335x_pmic_vo); 252 } else { 253 am335x_pmic_setvo(dev, vo); 254 } 255 } 256 257 if (bootverbose || am335x_pmic_bootverbose) { 258 am335x_pmic_dump_chgconfig(dev); 259 } 260 261 EVENTHANDLER_REGISTER(shutdown_final, am335x_pmic_shutdown, dev, 262 SHUTDOWN_PRI_LAST); 263 264 config_intrhook_disestablish(&sc->enum_hook); 265 266 /* Unmask all interrupts and clear pending status */ 267 reg = 0; 268 am335x_pmic_write(dev, TPS65217_INT_REG, ®, 1); 269 am335x_pmic_read(dev, TPS65217_INT_REG, ®, 1); 270 271 if (sc->sc_irq_res != NULL) { 272 rv = bus_setup_intr(dev, sc->sc_irq_res, 273 INTR_TYPE_MISC | INTR_MPSAFE, NULL, am335x_pmic_intr, 274 sc, &sc->sc_intrhand); 275 if (rv != 0) 276 device_printf(dev, 277 "Unable to setup the irq handler.\n"); 278 } 279 } 280 281 static int 282 am335x_pmic_attach(device_t dev) 283 { 284 struct am335x_pmic_softc *sc; 285 int rid; 286 287 sc = device_get_softc(dev); 288 289 rid = 0; 290 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 291 RF_ACTIVE); 292 if (!sc->sc_irq_res) { 293 device_printf(dev, "cannot allocate interrupt\n"); 294 /* return (ENXIO); */ 295 } 296 297 sc->enum_hook.ich_func = am335x_pmic_start; 298 sc->enum_hook.ich_arg = dev; 299 300 if (config_intrhook_establish(&sc->enum_hook) != 0) 301 return (ENOMEM); 302 303 return (0); 304 } 305 306 static void 307 am335x_pmic_shutdown(void *xdev, int howto) 308 { 309 device_t dev; 310 struct tps65217_status_reg reg; 311 312 if (!(howto & RB_POWEROFF)) 313 return; 314 dev = (device_t)xdev; 315 am335x_pmic_read(dev, TPS65217_STATUS_REG, (uint8_t *)®, 1); 316 /* Set the OFF bit on status register to start the shutdown sequence. */ 317 reg.off = 1; 318 am335x_pmic_write(dev, TPS65217_STATUS_REG, (uint8_t *)®, 1); 319 /* Toggle pmic_pwr_enable to shutdown the PMIC. */ 320 am335x_rtc_pmic_pwr_toggle(); 321 } 322 323 static device_method_t am335x_pmic_methods[] = { 324 DEVMETHOD(device_probe, am335x_pmic_probe), 325 DEVMETHOD(device_attach, am335x_pmic_attach), 326 {0, 0}, 327 }; 328 329 static driver_t am335x_pmic_driver = { 330 "am335x_pmic", 331 am335x_pmic_methods, 332 sizeof(struct am335x_pmic_softc), 333 }; 334 335 static devclass_t am335x_pmic_devclass; 336 337 DRIVER_MODULE(am335x_pmic, iicbus, am335x_pmic_driver, am335x_pmic_devclass, 0, 0); 338 MODULE_VERSION(am335x_pmic, 1); 339 MODULE_DEPEND(am335x_pmic, iicbus, 1, 1, 1); 340