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 struct am335x_pmic_softc { 60 device_t sc_dev; 61 uint32_t sc_addr; 62 struct resource *sc_irq_res; 63 void *sc_intrhand; 64 }; 65 66 static const char *tps65217_voreg_c[4] = {"4.10V", "4.15V", "4.20V", "4.25V"}; 67 68 static int am335x_pmic_bootverbose = 0; 69 TUNABLE_INT("hw.am335x_pmic.bootverbose", &am335x_pmic_bootverbose); 70 static char am335x_pmic_vo[6]; 71 TUNABLE_STR("hw.am335x_pmic.vo", am335x_pmic_vo, sizeof(am335x_pmic_vo)); 72 73 static void am335x_pmic_shutdown(void *, int); 74 75 static int 76 am335x_pmic_read(device_t dev, uint8_t addr, uint8_t *data, uint8_t size) 77 { 78 return (iicdev_readfrom(dev, addr, data, size, IIC_INTRWAIT)); 79 } 80 81 static int 82 am335x_pmic_write(device_t dev, uint8_t address, uint8_t *data, uint8_t size) 83 { 84 return (iicdev_writeto(dev, address, data, size, IIC_INTRWAIT)); 85 } 86 87 static void 88 am335x_pmic_intr(void *arg) 89 { 90 struct am335x_pmic_softc *sc = (struct am335x_pmic_softc *)arg; 91 struct tps65217_status_reg status_reg; 92 struct tps65217_int_reg int_reg; 93 int rv; 94 char notify_buf[16]; 95 96 THREAD_SLEEPING_OK(); 97 rv = am335x_pmic_read(sc->sc_dev, TPS65217_INT_REG, (uint8_t *)&int_reg, 1); 98 if (rv != 0) { 99 device_printf(sc->sc_dev, "Cannot read interrupt register\n"); 100 THREAD_NO_SLEEPING(); 101 return; 102 } 103 rv = am335x_pmic_read(sc->sc_dev, TPS65217_STATUS_REG, (uint8_t *)&status_reg, 1); 104 if (rv != 0) { 105 device_printf(sc->sc_dev, "Cannot read status register\n"); 106 THREAD_NO_SLEEPING(); 107 return; 108 } 109 THREAD_NO_SLEEPING(); 110 111 if (int_reg.pbi && status_reg.pb) 112 shutdown_nice(RB_POWEROFF); 113 if (int_reg.aci) { 114 snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", 115 status_reg.acpwr); 116 devctl_notify_f("ACPI", "ACAD", "power", notify_buf, M_NOWAIT); 117 } 118 } 119 120 static int 121 am335x_pmic_probe(device_t dev) 122 { 123 struct am335x_pmic_softc *sc; 124 125 if (!ofw_bus_is_compatible(dev, "ti,tps65217")) 126 return (ENXIO); 127 128 sc = device_get_softc(dev); 129 sc->sc_dev = dev; 130 /* Convert to 8-bit addressing */ 131 sc->sc_addr = iicbus_get_addr(dev); 132 133 device_set_desc(dev, "TI TPS65217 Power Management IC"); 134 135 return (0); 136 } 137 138 static void 139 am335x_pmic_dump_chgconfig(device_t dev) 140 { 141 struct tps65217_chgconfig0_reg reg0; 142 struct tps65217_chgconfig1_reg reg1; 143 struct tps65217_chgconfig2_reg reg2; 144 struct tps65217_chgconfig3_reg reg3; 145 const char *e_d[] = {"enabled", "disabled"}; 146 const char *d_e[] = {"disabled", "enabled"}; 147 const char *i_a[] = {"inactive", "active"}; 148 const char *f_t[] = {"false", "true"}; 149 const char *timer_c[] = {"4h", "5h", "6h", "8h"}; 150 const char *ntc_type_c[] = {"100k", "10k"}; 151 const char *vprechg_c[] = {"2.9V", "2.5V"}; 152 const char *trange_c[] = {"0-45 C", "0-60 C"}; 153 const char *termif_c[] = {"2.5%", "7.5%", "15%", "18%"}; 154 const char *pchrgt_c[] = {"30 min", "60 min"}; 155 const char *dppmth_c[] = {"3.50V", "3.75V", "4.00V", "4.25V"}; 156 const char *ichrg_c[] = {"300mA", "400mA", "500mA", "700mA"}; 157 158 am335x_pmic_read(dev, TPS65217_CHGCONFIG0_REG, (uint8_t *)®0, 1); 159 device_printf(dev, " BAT TEMP/NTC ERROR: %s\n", f_t[reg0.battemp]); 160 device_printf(dev, " Pre-charge timer time-out: %s\n", f_t[reg0.pchgtout]); 161 device_printf(dev, " Charge timer time-out: %s\n", f_t[reg0.chgtout]); 162 device_printf(dev, " Charger active: %s\n", f_t[reg0.active]); 163 device_printf(dev, " Termination current detected: %s\n", f_t[reg0.termi]); 164 device_printf(dev, " Thermal suspend: %s\n", f_t[reg0.tsusp]); 165 device_printf(dev, " DPPM active: %s\n", f_t[reg0.dppm]); 166 device_printf(dev, " Thermal regulation: %s\n", i_a[reg0.treg]); 167 168 am335x_pmic_read(dev, TPS65217_CHGCONFIG1_REG, (uint8_t *)®1, 1); 169 device_printf(dev, " Charger: %s\n", d_e[reg1.chg_en]); 170 device_printf(dev, " Suspend charge: %s\n", i_a[reg1.susp]); 171 device_printf(dev, " Charge termination: %s\n", e_d[reg1.term]); 172 device_printf(dev, " Charger reset: %s\n", i_a[reg1.reset]); 173 device_printf(dev, " NTC TYPE: %s\n", ntc_type_c[reg1.ntc_type]); 174 device_printf(dev, " Safety timer: %s\n", d_e[reg1.tmr_en]); 175 device_printf(dev, " Charge safety timer: %s\n", timer_c[reg1.timer]); 176 177 am335x_pmic_read(dev, TPS65217_CHGCONFIG2_REG, (uint8_t *)®2, 1); 178 device_printf(dev, " Charge voltage: %s\n", tps65217_voreg_c[reg2.voreg]); 179 device_printf(dev, " Pre-charge to fast charge transition voltage: %s\n", 180 vprechg_c[reg2.vprechg]); 181 device_printf(dev, " Dynamic timer function: %s\n", d_e[reg2.dyntmr]); 182 183 am335x_pmic_read(dev, TPS65217_CHGCONFIG3_REG, (uint8_t *)®3, 1); 184 device_printf(dev, " Temperature range for charging: %s\n", trange_c[reg3.trange]); 185 device_printf(dev, " Termination current factor: %s\n", termif_c[reg3.termif]); 186 device_printf(dev, " Pre-charge time: %s\n", pchrgt_c[reg3.pchrgt]); 187 device_printf(dev, " Power path DPPM threshold: %s\n", dppmth_c[reg3.dppmth]); 188 device_printf(dev, " Charge current: %s\n", ichrg_c[reg3.ichrg]); 189 } 190 191 static void 192 am335x_pmic_setvo(device_t dev, uint8_t vo) 193 { 194 struct tps65217_chgconfig2_reg reg2; 195 196 am335x_pmic_read(dev, TPS65217_CHGCONFIG2_REG, (uint8_t *)®2, 1); 197 reg2.voreg = vo; 198 am335x_pmic_write(dev, TPS65217_CHGCONFIG2_REG, (uint8_t *)®2, 1); 199 } 200 201 static void 202 am335x_pmic_start(struct am335x_pmic_softc *sc) 203 { 204 device_t dev; 205 struct tps65217_status_reg status_reg; 206 struct tps65217_chipid_reg chipid_reg; 207 uint8_t reg, vo; 208 char name[20]; 209 char pwr[4][11] = {"Battery", "USB", "AC", "USB and AC"}; 210 int rv; 211 phandle_t node; 212 213 dev = sc->sc_dev; 214 am335x_pmic_read(dev, TPS65217_CHIPID_REG, (uint8_t *)&chipid_reg, 1); 215 switch (chipid_reg.chip) { 216 case TPS65217A: 217 sprintf(name, "TPS65217A ver 1.%u", chipid_reg.rev); 218 break; 219 case TPS65217B: 220 sprintf(name, "TPS65217B ver 1.%u", chipid_reg.rev); 221 break; 222 case TPS65217C: 223 sprintf(name, "TPS65217C ver 1.%u", chipid_reg.rev); 224 break; 225 case TPS65217D: 226 sprintf(name, "TPS65217D ver 1.%u", chipid_reg.rev); 227 break; 228 default: 229 sprintf(name, "Unknown PMIC"); 230 } 231 232 am335x_pmic_read(dev, TPS65217_STATUS_REG, (uint8_t *)&status_reg, 1); 233 device_printf(dev, "%s powered by %s\n", name, 234 pwr[status_reg.usbpwr | (status_reg.acpwr << 1)]); 235 236 /* Check devicetree for ti,pmic-shutdown-controller 237 * if present; PMIC will go to shutdown state on PWR_EN toggle 238 * if not present; PMIC will enter sleep state on PWR_EN toggle (default on reset) 239 */ 240 node = ofw_bus_get_node(dev); 241 if (OF_hasprop(node, "ti,pmic-shutdown-controller")) { 242 status_reg.off = 1; 243 am335x_pmic_write(dev, TPS65217_STATUS_REG, (uint8_t *)&status_reg, 1); 244 } 245 246 if (am335x_pmic_vo[0] != '\0') { 247 for (vo = 0; vo < 4; vo++) { 248 if (strcmp(tps65217_voreg_c[vo], am335x_pmic_vo) == 0) 249 break; 250 } 251 if (vo == 4) { 252 device_printf(dev, "WARNING: hw.am335x_pmic.vo=\"%s\"" 253 ": unsupported value\n", am335x_pmic_vo); 254 } else { 255 am335x_pmic_setvo(dev, vo); 256 } 257 } 258 259 if (bootverbose || am335x_pmic_bootverbose) { 260 am335x_pmic_dump_chgconfig(dev); 261 } 262 263 EVENTHANDLER_REGISTER(shutdown_final, am335x_pmic_shutdown, dev, 264 SHUTDOWN_PRI_LAST); 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 am335x_pmic_start(sc); 298 299 return (0); 300 } 301 302 static void 303 am335x_pmic_shutdown(void *xdev, int howto) 304 { 305 if (!(howto & RB_POWEROFF)) 306 return; 307 308 /* Toggle pmic_pwr_enable to shutdown the PMIC. */ 309 am335x_rtc_pmic_pwr_toggle(); 310 } 311 312 static device_method_t am335x_pmic_methods[] = { 313 DEVMETHOD(device_probe, am335x_pmic_probe), 314 DEVMETHOD(device_attach, am335x_pmic_attach), 315 {0, 0}, 316 }; 317 318 static driver_t am335x_pmic_driver = { 319 "am335x_pmic", 320 am335x_pmic_methods, 321 sizeof(struct am335x_pmic_softc), 322 }; 323 324 static devclass_t am335x_pmic_devclass; 325 326 DRIVER_MODULE(am335x_pmic, iicbus, am335x_pmic_driver, am335x_pmic_devclass, 0, 0); 327 MODULE_VERSION(am335x_pmic, 1); 328 MODULE_DEPEND(am335x_pmic, iicbus, 1, 1, 1); 329