2 * Rockchip IO Voltage Domain driver
4 * Copyright 2014 MundoReader S.L.
5 * Copyright 2014 Google, Inc.
7 * This software is licensed under the terms of the GNU General Public
8 * License version 2, as published by the Free Software Foundation, and
9 * may be copied, distributed, and modified under those terms.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/err.h>
20 #include <linux/mfd/syscon.h>
22 #include <linux/platform_device.h>
23 #include <linux/regmap.h>
24 #include <linux/regulator/consumer.h>
26 #define MAX_SUPPLIES 16
29 * The max voltage for 1.8V and 3.3V come from the Rockchip datasheet under
30 * "Recommended Operating Conditions" for "Digital GPIO". When the typical
31 * is 3.3V the max is 3.6V. When the typical is 1.8V the max is 1.98V.
33 * They are used like this:
34 * - If the voltage on a rail is above the "1.8" voltage (1.98V) we'll tell the
36 * - If the voltage on a rail is above the "3.3" voltage (3.6V) we'll consider
37 * that to be an error.
39 #define MAX_VOLTAGE_1_8 1980000
40 #define MAX_VOLTAGE_3_3 3600000
42 #define RK3288_SOC_CON2 0x24c
43 #define RK3288_SOC_CON2_FLASH0 BIT(7)
44 #define RK3288_SOC_FLASH_SUPPLY_NUM 2
46 #define RK3368_SOC_CON15 0x43c
47 #define RK3368_SOC_CON15_FLASH0 BIT(14)
48 #define RK3368_SOC_FLASH_SUPPLY_NUM 2
50 #define RK3399_PMUGRF_CON0 0x180
51 #define RK3399_PMUGRF_CON0_VSEL BIT(8)
52 #define RK3399_PMUGRF_VSEL_SUPPLY_NUM 9
54 struct rockchip_iodomain;
57 * @supplies: voltage settings matching the register bits.
59 struct rockchip_iodomain_soc_data {
61 const char *supply_names[MAX_SUPPLIES];
62 void (*init)(struct rockchip_iodomain *iod);
65 struct rockchip_iodomain_supply {
66 struct rockchip_iodomain *iod;
67 struct regulator *reg;
68 struct notifier_block nb;
72 struct rockchip_iodomain {
75 struct rockchip_iodomain_soc_data *soc_data;
76 struct rockchip_iodomain_supply supplies[MAX_SUPPLIES];
79 static int rockchip_iodomain_write(struct rockchip_iodomain_supply *supply,
82 struct rockchip_iodomain *iod = supply->iod;
87 val = (uV > MAX_VOLTAGE_1_8) ? 0 : 1;
90 /* apply hiword-mask */
91 val |= (BIT(supply->idx) << 16);
93 ret = regmap_write(iod->grf, iod->soc_data->grf_offset, val);
95 dev_err(iod->dev, "Couldn't write to GRF\n");
100 static int rockchip_iodomain_notify(struct notifier_block *nb,
104 struct rockchip_iodomain_supply *supply =
105 container_of(nb, struct rockchip_iodomain_supply, nb);
110 * According to Rockchip it's important to keep the SoC IO domain
111 * higher than (or equal to) the external voltage. That means we need
112 * to change it before external voltage changes happen in the case
115 * Note that in the "pre" change we pick the max possible voltage that
116 * the regulator might end up at (the client requests a range and we
117 * don't know for certain the exact voltage). Right now we rely on the
118 * slop in MAX_VOLTAGE_1_8 and MAX_VOLTAGE_3_3 to save us if clients
119 * request something like a max of 3.6V when they really want 3.3V.
120 * We could attempt to come up with better rules if this fails.
122 if (event & REGULATOR_EVENT_PRE_VOLTAGE_CHANGE) {
123 struct pre_voltage_change_data *pvc_data = data;
125 uV = max_t(unsigned long, pvc_data->old_uV, pvc_data->max_uV);
126 } else if (event & (REGULATOR_EVENT_VOLTAGE_CHANGE |
127 REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE)) {
128 uV = (unsigned long)data;
133 dev_dbg(supply->iod->dev, "Setting to %d\n", uV);
135 if (uV > MAX_VOLTAGE_3_3) {
136 dev_err(supply->iod->dev, "Voltage too high: %d\n", uV);
138 if (event == REGULATOR_EVENT_PRE_VOLTAGE_CHANGE)
142 ret = rockchip_iodomain_write(supply, uV);
143 if (ret && event == REGULATOR_EVENT_PRE_VOLTAGE_CHANGE)
146 dev_dbg(supply->iod->dev, "Setting to %d done\n", uV);
150 static void rk3288_iodomain_init(struct rockchip_iodomain *iod)
155 /* if no flash supply we should leave things alone */
156 if (!iod->supplies[RK3288_SOC_FLASH_SUPPLY_NUM].reg)
160 * set flash0 iodomain to also use this framework
161 * instead of a special gpio.
163 val = RK3288_SOC_CON2_FLASH0 | (RK3288_SOC_CON2_FLASH0 << 16);
164 ret = regmap_write(iod->grf, RK3288_SOC_CON2, val);
166 dev_warn(iod->dev, "couldn't update flash0 ctrl\n");
169 static void rk3368_iodomain_init(struct rockchip_iodomain *iod)
174 /* if no flash supply we should leave things alone */
175 if (!iod->supplies[RK3368_SOC_FLASH_SUPPLY_NUM].reg)
179 * set flash0 iodomain to also use this framework
180 * instead of a special gpio.
182 val = RK3368_SOC_CON15_FLASH0 | (RK3368_SOC_CON15_FLASH0 << 16);
183 ret = regmap_write(iod->grf, RK3368_SOC_CON15, val);
185 dev_warn(iod->dev, "couldn't update flash0 ctrl\n");
188 static void rk3399_pmu_iodomain_init(struct rockchip_iodomain *iod)
193 /* if no pmu io supply we should leave things alone */
194 if (!iod->supplies[RK3399_PMUGRF_VSEL_SUPPLY_NUM].reg)
198 * set pmu io iodomain to also use this framework
199 * instead of a special gpio.
201 val = RK3399_PMUGRF_CON0_VSEL | (RK3399_PMUGRF_CON0_VSEL << 16);
202 ret = regmap_write(iod->grf, RK3399_PMUGRF_CON0, val);
204 dev_warn(iod->dev, "couldn't update pmu io iodomain ctrl\n");
208 * On the rk3188 the io-domains are handled by a shared register with the
209 * lower 8 bits being still being continuing drive-strength settings.
211 static const struct rockchip_iodomain_soc_data soc_data_rk3188 = {
233 static const struct rockchip_iodomain_soc_data soc_data_rk3288 = {
236 "lcdc", /* LCDC_VDD */
237 "dvp", /* DVPIO_VDD */
238 "flash0", /* FLASH0_VDD (emmc) */
239 "flash1", /* FLASH1_VDD (sdio1) */
240 "wifi", /* APIO3_VDD (sdio0) */
241 "bb", /* APIO5_VDD */
242 "audio", /* APIO4_VDD */
243 "sdcard", /* SDMMC0_VDD (sdmmc) */
244 "gpio30", /* APIO1_VDD */
245 "gpio1830", /* APIO2_VDD */
247 .init = rk3288_iodomain_init,
250 static const struct rockchip_iodomain_soc_data soc_data_rk3368 = {
254 "dvp", /* DVPIO_VDD */
255 "flash0", /* FLASH0_VDD (emmc) */
256 "wifi", /* APIO2_VDD (sdio0) */
258 "audio", /* APIO3_VDD */
259 "sdcard", /* SDMMC0_VDD (sdmmc) */
260 "gpio30", /* APIO1_VDD */
261 "gpio1830", /* APIO4_VDD (gpujtag) */
263 .init = rk3368_iodomain_init,
266 static const struct rockchip_iodomain_soc_data soc_data_rk3368_pmu = {
273 "pmu", /*PMU IO domain*/
274 "vop", /*LCDC IO domain*/
278 static const struct rockchip_iodomain_soc_data soc_data_rk3399 = {
279 .grf_offset = 0xe640,
281 "bt656", /* APIO2_VDD */
282 "audio", /* APIO5_VDD */
283 "sdmmc", /* SDMMC0_VDD */
284 "gpio1830", /* APIO4_VDD */
288 static const struct rockchip_iodomain_soc_data soc_data_rk3399_pmu = {
300 "pmu1830", /* PMUIO2_VDD */
302 .init = rk3399_pmu_iodomain_init,
305 static const struct of_device_id rockchip_iodomain_match[] = {
307 .compatible = "rockchip,rk3188-io-voltage-domain",
308 .data = (void *)&soc_data_rk3188
311 .compatible = "rockchip,rk3288-io-voltage-domain",
312 .data = (void *)&soc_data_rk3288
315 .compatible = "rockchip,rk3368-io-voltage-domain",
316 .data = (void *)&soc_data_rk3368
319 .compatible = "rockchip,rk3368-pmu-io-voltage-domain",
320 .data = (void *)&soc_data_rk3368_pmu
323 .compatible = "rockchip,rk3399-io-voltage-domain",
324 .data = (void *)&soc_data_rk3399
327 .compatible = "rockchip,rk3399-pmu-io-voltage-domain",
328 .data = (void *)&soc_data_rk3399_pmu
332 MODULE_DEVICE_TABLE(of, rockchip_iodomain_match);
334 static int rockchip_iodomain_probe(struct platform_device *pdev)
336 struct device_node *np = pdev->dev.of_node;
337 const struct of_device_id *match;
338 struct rockchip_iodomain *iod;
339 struct device *parent;
345 iod = devm_kzalloc(&pdev->dev, sizeof(*iod), GFP_KERNEL);
349 iod->dev = &pdev->dev;
350 platform_set_drvdata(pdev, iod);
352 match = of_match_node(rockchip_iodomain_match, np);
353 iod->soc_data = (struct rockchip_iodomain_soc_data *)match->data;
355 parent = pdev->dev.parent;
356 if (parent && parent->of_node) {
357 iod->grf = syscon_node_to_regmap(parent->of_node);
359 dev_dbg(&pdev->dev, "falling back to old binding\n");
360 iod->grf = syscon_regmap_lookup_by_phandle(np, "rockchip,grf");
363 if (IS_ERR(iod->grf)) {
364 dev_err(&pdev->dev, "couldn't find grf regmap\n");
365 return PTR_ERR(iod->grf);
368 for (i = 0; i < MAX_SUPPLIES; i++) {
369 const char *supply_name = iod->soc_data->supply_names[i];
370 struct rockchip_iodomain_supply *supply = &iod->supplies[i];
371 struct regulator *reg;
377 reg = devm_regulator_get_optional(iod->dev, supply_name);
381 /* If a supply wasn't specified, that's OK */
384 else if (ret != -EPROBE_DEFER)
385 dev_err(iod->dev, "couldn't get regulator %s\n",
390 /* set initial correct value */
391 uV = regulator_get_voltage(reg);
393 /* must be a regulator we can get the voltage of */
395 dev_err(iod->dev, "Can't determine voltage: %s\n",
400 if (uV > MAX_VOLTAGE_3_3) {
402 "%d uV is too high. May damage SoC!\n",
408 /* setup our supply */
412 supply->nb.notifier_call = rockchip_iodomain_notify;
414 ret = rockchip_iodomain_write(supply, uV);
420 /* register regulator notifier */
421 ret = regulator_register_notifier(reg, &supply->nb);
424 "regulator notifier request failed\n");
430 if (iod->soc_data->init)
431 iod->soc_data->init(iod);
436 for (i = MAX_SUPPLIES - 1; i >= 0; i--) {
437 struct rockchip_iodomain_supply *io_supply = &iod->supplies[i];
440 regulator_unregister_notifier(io_supply->reg,
447 static int rockchip_iodomain_remove(struct platform_device *pdev)
449 struct rockchip_iodomain *iod = platform_get_drvdata(pdev);
452 for (i = MAX_SUPPLIES - 1; i >= 0; i--) {
453 struct rockchip_iodomain_supply *io_supply = &iod->supplies[i];
456 regulator_unregister_notifier(io_supply->reg,
463 static struct platform_driver rockchip_iodomain_driver = {
464 .probe = rockchip_iodomain_probe,
465 .remove = rockchip_iodomain_remove,
467 .name = "rockchip-iodomain",
468 .of_match_table = rockchip_iodomain_match,
472 module_platform_driver(rockchip_iodomain_driver);
474 MODULE_DESCRIPTION("Rockchip IO-domain driver");
475 MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");
476 MODULE_AUTHOR("Doug Anderson <dianders@chromium.org>");
477 MODULE_LICENSE("GPL v2");