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 struct rockchip_iodomain;
53 * @supplies: voltage settings matching the register bits.
55 struct rockchip_iodomain_soc_data {
57 const char *supply_names[MAX_SUPPLIES];
58 void (*init)(struct rockchip_iodomain *iod);
61 struct rockchip_iodomain_supply {
62 struct rockchip_iodomain *iod;
63 struct regulator *reg;
64 struct notifier_block nb;
68 struct rockchip_iodomain {
71 struct rockchip_iodomain_soc_data *soc_data;
72 struct rockchip_iodomain_supply supplies[MAX_SUPPLIES];
75 static int rockchip_iodomain_write(struct rockchip_iodomain_supply *supply,
78 struct rockchip_iodomain *iod = supply->iod;
83 val = (uV > MAX_VOLTAGE_1_8) ? 0 : 1;
86 /* apply hiword-mask */
87 val |= (BIT(supply->idx) << 16);
89 ret = regmap_write(iod->grf, iod->soc_data->grf_offset, val);
91 dev_err(iod->dev, "Couldn't write to GRF\n");
96 static int rockchip_iodomain_notify(struct notifier_block *nb,
100 struct rockchip_iodomain_supply *supply =
101 container_of(nb, struct rockchip_iodomain_supply, nb);
106 * According to Rockchip it's important to keep the SoC IO domain
107 * higher than (or equal to) the external voltage. That means we need
108 * to change it before external voltage changes happen in the case
111 * Note that in the "pre" change we pick the max possible voltage that
112 * the regulator might end up at (the client requests a range and we
113 * don't know for certain the exact voltage). Right now we rely on the
114 * slop in MAX_VOLTAGE_1_8 and MAX_VOLTAGE_3_3 to save us if clients
115 * request something like a max of 3.6V when they really want 3.3V.
116 * We could attempt to come up with better rules if this fails.
118 if (event & REGULATOR_EVENT_PRE_VOLTAGE_CHANGE) {
119 struct pre_voltage_change_data *pvc_data = data;
121 uV = max_t(unsigned long, pvc_data->old_uV, pvc_data->max_uV);
122 } else if (event & (REGULATOR_EVENT_VOLTAGE_CHANGE |
123 REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE)) {
124 uV = (unsigned long)data;
129 dev_dbg(supply->iod->dev, "Setting to %d\n", uV);
131 if (uV > MAX_VOLTAGE_3_3) {
132 dev_err(supply->iod->dev, "Voltage too high: %d\n", uV);
134 if (event == REGULATOR_EVENT_PRE_VOLTAGE_CHANGE)
138 ret = rockchip_iodomain_write(supply, uV);
139 if (ret && event == REGULATOR_EVENT_PRE_VOLTAGE_CHANGE)
142 dev_info(supply->iod->dev, "Setting to %d done\n", uV);
146 static void rk3288_iodomain_init(struct rockchip_iodomain *iod)
151 /* if no flash supply we should leave things alone */
152 if (!iod->supplies[RK3288_SOC_FLASH_SUPPLY_NUM].reg)
156 * set flash0 iodomain to also use this framework
157 * instead of a special gpio.
159 val = RK3288_SOC_CON2_FLASH0 | (RK3288_SOC_CON2_FLASH0 << 16);
160 ret = regmap_write(iod->grf, RK3288_SOC_CON2, val);
162 dev_warn(iod->dev, "couldn't update flash0 ctrl\n");
165 static void rk3368_iodomain_init(struct rockchip_iodomain *iod)
170 /* if no flash supply we should leave things alone */
171 if (!iod->supplies[RK3368_SOC_FLASH_SUPPLY_NUM].reg)
175 * set flash0 iodomain to also use this framework
176 * instead of a special gpio.
178 val = RK3368_SOC_CON15_FLASH0 | (RK3368_SOC_CON15_FLASH0 << 16);
179 ret = regmap_write(iod->grf, RK3368_SOC_CON15, val);
181 dev_warn(iod->dev, "couldn't update flash0 ctrl\n");
185 * On the rk3188 the io-domains are handled by a shared register with the
186 * lower 8 bits being still being continuing drive-strength settings.
188 static const struct rockchip_iodomain_soc_data soc_data_rk3188 = {
210 static const struct rockchip_iodomain_soc_data soc_data_rk3288 = {
213 "lcdc", /* LCDC_VDD */
214 "dvp", /* DVPIO_VDD */
215 "flash0", /* FLASH0_VDD (emmc) */
216 "flash1", /* FLASH1_VDD (sdio1) */
217 "wifi", /* APIO3_VDD (sdio0) */
218 "bb", /* APIO5_VDD */
219 "audio", /* APIO4_VDD */
220 "sdcard", /* SDMMC0_VDD (sdmmc) */
221 "gpio30", /* APIO1_VDD */
222 "gpio1830", /* APIO2_VDD */
224 .init = rk3288_iodomain_init,
227 static const struct rockchip_iodomain_soc_data soc_data_rk3368 = {
231 "dvp", /* DVPIO_VDD */
232 "flash0", /* FLASH0_VDD (emmc) */
233 "wifi", /* APIO2_VDD (sdio0) */
235 "audio", /* APIO3_VDD */
236 "sdcard", /* SDMMC0_VDD (sdmmc) */
237 "gpio30", /* APIO1_VDD */
238 "gpio1830", /* APIO4_VDD (gpujtag) */
240 .init = rk3368_iodomain_init,
243 static const struct rockchip_iodomain_soc_data soc_data_rk3368_pmu = {
250 "pmu", /*PMU IO domain*/
251 "vop", /*LCDC IO domain*/
255 static const struct of_device_id rockchip_iodomain_match[] = {
257 .compatible = "rockchip,rk3188-io-voltage-domain",
258 .data = (void *)&soc_data_rk3188
261 .compatible = "rockchip,rk3288-io-voltage-domain",
262 .data = (void *)&soc_data_rk3288
265 .compatible = "rockchip,rk3368-io-voltage-domain",
266 .data = (void *)&soc_data_rk3368
269 .compatible = "rockchip,rk3368-pmu-io-voltage-domain",
270 .data = (void *)&soc_data_rk3368_pmu
275 static int rockchip_iodomain_probe(struct platform_device *pdev)
277 struct device_node *np = pdev->dev.of_node;
278 const struct of_device_id *match;
279 struct rockchip_iodomain *iod;
285 iod = devm_kzalloc(&pdev->dev, sizeof(*iod), GFP_KERNEL);
289 iod->dev = &pdev->dev;
290 platform_set_drvdata(pdev, iod);
292 match = of_match_node(rockchip_iodomain_match, np);
293 iod->soc_data = (struct rockchip_iodomain_soc_data *)match->data;
295 iod->grf = syscon_regmap_lookup_by_phandle(np, "rockchip,grf");
296 if (IS_ERR(iod->grf)) {
297 dev_err(&pdev->dev, "couldn't find grf regmap\n");
298 return PTR_ERR(iod->grf);
301 for (i = 0; i < MAX_SUPPLIES; i++) {
302 const char *supply_name = iod->soc_data->supply_names[i];
303 struct rockchip_iodomain_supply *supply = &iod->supplies[i];
304 struct regulator *reg;
310 reg = devm_regulator_get_optional(iod->dev, supply_name);
314 /* If a supply wasn't specified, that's OK */
317 else if (ret != -EPROBE_DEFER)
318 dev_err(iod->dev, "couldn't get regulator %s\n",
323 /* set initial correct value */
324 uV = regulator_get_voltage(reg);
326 /* must be a regulator we can get the voltage of */
328 dev_err(iod->dev, "Can't determine voltage: %s\n",
333 if (uV > MAX_VOLTAGE_3_3) {
335 "%d uV is too high. May damage SoC!\n",
341 /* setup our supply */
345 supply->nb.notifier_call = rockchip_iodomain_notify;
347 ret = rockchip_iodomain_write(supply, uV);
353 /* register regulator notifier */
354 ret = regulator_register_notifier(reg, &supply->nb);
357 "regulator notifier request failed\n");
363 if (iod->soc_data->init)
364 iod->soc_data->init(iod);
369 for (i = MAX_SUPPLIES - 1; i >= 0; i--) {
370 struct rockchip_iodomain_supply *io_supply = &iod->supplies[i];
373 regulator_unregister_notifier(io_supply->reg,
380 static int rockchip_iodomain_remove(struct platform_device *pdev)
382 struct rockchip_iodomain *iod = platform_get_drvdata(pdev);
385 for (i = MAX_SUPPLIES - 1; i >= 0; i--) {
386 struct rockchip_iodomain_supply *io_supply = &iod->supplies[i];
389 regulator_unregister_notifier(io_supply->reg,
396 static struct platform_driver rockchip_iodomain_driver = {
397 .probe = rockchip_iodomain_probe,
398 .remove = rockchip_iodomain_remove,
400 .name = "rockchip-iodomain",
401 .of_match_table = rockchip_iodomain_match,
405 module_platform_driver(rockchip_iodomain_driver);
407 MODULE_DESCRIPTION("Rockchip IO-domain driver");
408 MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");
409 MODULE_AUTHOR("Doug Anderson <dianders@chromium.org>");
410 MODULE_LICENSE("GPL v2");