2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
33 #include <sys/kernel.h>
34 #include <sys/module.h>
35 #include <sys/mutex.h>
37 #include <machine/bus.h>
39 #include <dev/iicbus/iiconf.h>
40 #include <dev/iicbus/iicbus.h>
42 #include <dev/ofw/ofw_bus.h>
43 #include <dev/ofw/ofw_bus_subr.h>
45 #include <dev/extres/regulator/regulator.h>
47 #include <arm64/rockchip/rk805reg.h>
49 #include "regdev_if.h"
51 MALLOC_DEFINE(M_RK805_REG, "RK805 regulator", "RK805 power regulator");
53 /* #define dprintf(sc, format, arg...) device_printf(sc->base_dev, "%s: " format, __func__, arg) */
54 #define dprintf(sc, format, arg...)
61 static struct ofw_compat_data compat_data[] = {
62 {"rockchip,rk805", RK805},
63 {"rockchip,rk808", RK808},
81 struct regnode *regnode;
83 struct rk805_regdef *def;
85 struct regnode_std_param *param;
91 struct resource * res[1];
93 struct intr_config_hook intr_hook;
94 enum rk_pmic_type type;
96 struct rk805_reg_sc **regs;
100 static struct rk805_regdef rk805_regdefs[] = {
104 .enable_reg = RK805_DCDC_EN,
106 .voltage_reg = RK805_DCDC1_ON_VSEL,
107 .voltage_mask = 0x3F,
108 .voltage_min = 712500,
109 .voltage_max = 1450000,
110 .voltage_step = 12500,
116 .enable_reg = RK805_DCDC_EN,
118 .voltage_reg = RK805_DCDC2_ON_VSEL,
119 .voltage_mask = 0x3F,
120 .voltage_min = 712500,
121 .voltage_max = 1450000,
122 .voltage_step = 12500,
128 .enable_reg = RK805_DCDC_EN,
134 .enable_reg = RK805_DCDC_EN,
136 .voltage_reg = RK805_DCDC4_ON_VSEL,
137 .voltage_mask = 0x3F,
138 .voltage_min = 800000,
139 .voltage_max = 3500000,
140 .voltage_step = 100000,
146 .enable_reg = RK805_LDO_EN,
148 .voltage_reg = RK805_LDO1_ON_VSEL,
149 .voltage_mask = 0x1F,
150 .voltage_min = 800000,
151 .voltage_max = 3400000,
152 .voltage_step = 100000,
158 .enable_reg = RK805_LDO_EN,
160 .voltage_reg = RK805_LDO2_ON_VSEL,
161 .voltage_mask = 0x1F,
162 .voltage_min = 800000,
163 .voltage_max = 3400000,
164 .voltage_step = 100000,
170 .enable_reg = RK805_LDO_EN,
172 .voltage_reg = RK805_LDO3_ON_VSEL,
173 .voltage_mask = 0x1F,
174 .voltage_min = 800000,
175 .voltage_max = 3400000,
176 .voltage_step = 100000,
181 static struct rk805_regdef rk808_regdefs[] = {
185 .enable_reg = RK805_DCDC_EN,
187 .voltage_reg = RK805_DCDC1_ON_VSEL,
188 .voltage_mask = 0x3F,
189 .voltage_min = 712500,
190 .voltage_max = 1500000,
191 .voltage_step = 12500,
197 .enable_reg = RK805_DCDC_EN,
199 .voltage_reg = RK805_DCDC2_ON_VSEL,
200 .voltage_mask = 0x3F,
201 .voltage_min = 712500,
202 .voltage_max = 1500000,
203 .voltage_step = 12500,
209 .enable_reg = RK805_DCDC_EN,
215 .enable_reg = RK805_DCDC_EN,
217 .voltage_reg = RK805_DCDC4_ON_VSEL,
219 .voltage_min = 1800000,
220 .voltage_max = 3300000,
221 .voltage_step = 100000,
227 .enable_reg = RK808_LDO_EN,
229 .voltage_reg = RK805_LDO1_ON_VSEL,
230 .voltage_mask = 0x1F,
231 .voltage_min = 1800000,
232 .voltage_max = 3400000,
233 .voltage_step = 100000,
239 .enable_reg = RK808_LDO_EN,
241 .voltage_reg = RK805_LDO2_ON_VSEL,
242 .voltage_mask = 0x1F,
243 .voltage_min = 1800000,
244 .voltage_max = 3400000,
245 .voltage_step = 100000,
251 .enable_reg = RK808_LDO_EN,
253 .voltage_reg = RK805_LDO3_ON_VSEL,
255 .voltage_min = 800000,
256 .voltage_max = 2500000,
257 .voltage_step = 100000,
263 .enable_reg = RK808_LDO_EN,
265 .voltage_reg = RK808_LDO4_ON_VSEL,
266 .voltage_mask = 0x1F,
267 .voltage_min = 1800000,
268 .voltage_max = 3400000,
269 .voltage_step = 100000,
275 .enable_reg = RK808_LDO_EN,
277 .voltage_reg = RK808_LDO5_ON_VSEL,
278 .voltage_mask = 0x1F,
279 .voltage_min = 1800000,
280 .voltage_max = 3400000,
281 .voltage_step = 100000,
287 .enable_reg = RK808_LDO_EN,
289 .voltage_reg = RK808_LDO6_ON_VSEL,
290 .voltage_mask = 0x1F,
291 .voltage_min = 800000,
292 .voltage_max = 2500000,
293 .voltage_step = 100000,
299 .enable_reg = RK808_LDO_EN,
301 .voltage_reg = RK808_LDO7_ON_VSEL,
302 .voltage_mask = 0x1F,
303 .voltage_min = 800000,
304 .voltage_max = 2500000,
305 .voltage_step = 100000,
311 .enable_reg = RK808_LDO_EN,
313 .voltage_reg = RK808_LDO8_ON_VSEL,
314 .voltage_mask = 0x1F,
315 .voltage_min = 1800000,
316 .voltage_max = 3400000,
317 .voltage_step = 100000,
322 .name = "SWITCH_REG1",
323 .enable_reg = RK805_DCDC_EN,
328 .name = "SWITCH_REG2",
329 .enable_reg = RK805_DCDC_EN,
335 rk805_read(device_t dev, uint8_t reg, uint8_t *data, uint8_t size)
339 err = iicdev_readfrom(dev, reg, data, size, IIC_INTRWAIT);
344 rk805_write(device_t dev, uint8_t reg, uint8_t data)
346 return (iicdev_writeto(dev, reg, &data, 1, IIC_INTRWAIT));
350 rk805_regnode_init(struct regnode *regnode)
356 rk805_regnode_enable(struct regnode *regnode, bool enable, int *udelay)
358 struct rk805_reg_sc *sc;
361 sc = regnode_get_softc(regnode);
363 dprintf(sc, "%sabling regulator %s\n",
364 enable ? "En" : "Dis",
366 rk805_read(sc->base_dev, sc->def->enable_reg, &val, 1);
368 val |= sc->def->enable_mask;
370 val &= ~sc->def->enable_mask;
371 rk805_write(sc->base_dev, sc->def->enable_reg, val);
379 rk805_regnode_reg_to_voltage(struct rk805_reg_sc *sc, uint8_t val, int *uv)
381 if (val < sc->def->voltage_nstep)
382 *uv = sc->def->voltage_min + val * sc->def->voltage_step;
384 *uv = sc->def->voltage_min +
385 (sc->def->voltage_nstep * sc->def->voltage_step);
389 rk805_regnode_voltage_to_reg(struct rk805_reg_sc *sc, int min_uvolt,
390 int max_uvolt, uint8_t *val)
396 uvolt = sc->def->voltage_min;
398 for (nstep = 0; nstep < sc->def->voltage_nstep && uvolt < min_uvolt;
401 uvolt += sc->def->voltage_step;
403 if (uvolt > max_uvolt)
411 rk805_regnode_set_voltage(struct regnode *regnode, int min_uvolt,
412 int max_uvolt, int *udelay)
414 struct rk805_reg_sc *sc;
418 sc = regnode_get_softc(regnode);
420 if (!sc->def->voltage_step)
423 dprintf(sc, "Setting %s to %d<->%d uvolts\n",
427 rk805_read(sc->base_dev, sc->def->voltage_reg, &val, 1);
428 if (rk805_regnode_voltage_to_reg(sc, min_uvolt, max_uvolt, &val) != 0)
431 rk805_write(sc->base_dev, sc->def->voltage_reg, val);
433 rk805_read(sc->base_dev, sc->def->voltage_reg, &val, 1);
437 rk805_regnode_reg_to_voltage(sc, val, &uvolt);
438 dprintf(sc, "Regulator %s set to %d uvolt\n",
446 rk805_regnode_get_voltage(struct regnode *regnode, int *uvolt)
448 struct rk805_reg_sc *sc;
451 sc = regnode_get_softc(regnode);
453 if (!sc->def->voltage_step)
456 rk805_read(sc->base_dev, sc->def->voltage_reg, &val, 1);
457 rk805_regnode_reg_to_voltage(sc, val & sc->def->voltage_mask, uvolt);
459 dprintf(sc, "Regulator %s is at %d uvolt\n",
466 static regnode_method_t rk805_regnode_methods[] = {
467 /* Regulator interface */
468 REGNODEMETHOD(regnode_init, rk805_regnode_init),
469 REGNODEMETHOD(regnode_enable, rk805_regnode_enable),
470 REGNODEMETHOD(regnode_set_voltage, rk805_regnode_set_voltage),
471 REGNODEMETHOD(regnode_get_voltage, rk805_regnode_get_voltage),
472 REGNODEMETHOD(regnode_check_voltage, regnode_method_check_voltage),
475 DEFINE_CLASS_1(rk805_regnode, rk805_regnode_class, rk805_regnode_methods,
476 sizeof(struct rk805_reg_sc), regnode_class);
478 static struct rk805_reg_sc *
479 rk805_reg_attach(device_t dev, phandle_t node,
480 struct rk805_regdef *def)
482 struct rk805_reg_sc *reg_sc;
483 struct regnode_init_def initdef;
484 struct regnode *regnode;
486 memset(&initdef, 0, sizeof(initdef));
487 if (regulator_parse_ofw_stdparam(dev, node, &initdef) != 0) {
488 device_printf(dev, "cannot create regulator\n");
491 if (initdef.std_param.min_uvolt == 0)
492 initdef.std_param.min_uvolt = def->voltage_min;
493 if (initdef.std_param.max_uvolt == 0)
494 initdef.std_param.max_uvolt = def->voltage_max;
495 initdef.id = def->id;
496 initdef.ofw_node = node;
498 regnode = regnode_create(dev, &rk805_regnode_class, &initdef);
499 if (regnode == NULL) {
500 device_printf(dev, "cannot create regulator\n");
504 reg_sc = regnode_get_softc(regnode);
505 reg_sc->regnode = regnode;
506 reg_sc->base_dev = dev;
508 reg_sc->xref = OF_xref_from_node(node);
509 reg_sc->param = regnode_get_stdparam(regnode);
511 regnode_register(regnode);
517 rk805_probe(device_t dev)
519 if (!ofw_bus_status_okay(dev))
522 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
525 device_set_desc(dev, "RockChip RK805 PMIC");
526 return (BUS_PROBE_DEFAULT);
530 rk805_start(void *pdev)
532 struct rk805_softc *sc;
538 sc = device_get_softc(dev);
541 /* No version register in RK808 */
542 if (bootverbose && sc->type == RK805) {
543 err = rk805_read(dev, RK805_CHIP_NAME, data, 1);
545 device_printf(dev, "Cannot read chip name reg\n");
548 err = rk805_read(dev, RK805_CHIP_VER, data + 1, 1);
550 device_printf(dev, "Cannot read chip version reg\n");
553 device_printf(dev, "Chip Name: %x\n",
554 data[0] << 4 | ((data[1] >> 4) & 0xf));
555 device_printf(dev, "Chip Version: %x\n", data[1] & 0xf);
558 config_intrhook_disestablish(&sc->intr_hook);
562 rk805_attach(device_t dev)
564 struct rk805_softc *sc;
565 struct rk805_reg_sc *reg;
566 struct rk805_regdef *regdefs;
567 phandle_t rnode, child;
570 sc = device_get_softc(dev);
572 sc->intr_hook.ich_func = rk805_start;
573 sc->intr_hook.ich_arg = dev;
575 if (config_intrhook_establish(&sc->intr_hook) != 0)
578 sc->type = ofw_bus_search_compatible(dev, compat_data)->ocd_data;
581 regdefs = rk805_regdefs;
582 sc->nregs = nitems(rk805_regdefs);
585 regdefs = rk808_regdefs;
586 sc->nregs = nitems(rk808_regdefs);
589 device_printf(dev, "Unknown type %d\n", sc->type);
593 sc->regs = malloc(sizeof(struct rk805_reg_sc *) * sc->nregs,
594 M_RK805_REG, M_WAITOK | M_ZERO);
596 rnode = ofw_bus_find_child(ofw_bus_get_node(dev), "regulators");
598 for (i = 0; i < sc->nregs; i++) {
599 child = ofw_bus_find_child(rnode,
603 reg = rk805_reg_attach(dev, child, ®defs[i]);
606 "cannot attach regulator %s\n",
612 device_printf(dev, "Regulator %s attached\n",
621 rk805_detach(device_t dev)
624 /* We cannot detach regulators */
629 rk805_map(device_t dev, phandle_t xref, int ncells,
630 pcell_t *cells, intptr_t *id)
632 struct rk805_softc *sc;
635 sc = device_get_softc(dev);
637 for (i = 0; i < sc->nregs; i++) {
638 if (sc->regs[i]->xref == xref) {
639 *id = sc->regs[i]->def->id;
647 static device_method_t rk805_methods[] = {
648 DEVMETHOD(device_probe, rk805_probe),
649 DEVMETHOD(device_attach, rk805_attach),
650 DEVMETHOD(device_detach, rk805_detach),
652 /* regdev interface */
653 DEVMETHOD(regdev_map, rk805_map),
657 static driver_t rk805_driver = {
660 sizeof(struct rk805_softc),
663 static devclass_t rk805_devclass;
665 EARLY_DRIVER_MODULE(rk805, iicbus, rk805_driver, rk805_devclass, 0, 0,
666 BUS_PASS_INTERRUPT + BUS_PASS_ORDER_LAST);
667 MODULE_DEPEND(rk805, iicbus, IICBUS_MINVER, IICBUS_PREFVER, IICBUS_MAXVER);
668 MODULE_VERSION(rk805, 1);