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 RK3328_SOC_CON4 0x410
47 #define RK3328_SOC_CON4_VCCIO2 BIT(7)
48 #define RK3328_SOC_VCCIO2_SUPPLY_NUM 1
50 #define RK3368_SOC_CON15 0x43c
51 #define RK3368_SOC_CON15_FLASH0 BIT(14)
52 #define RK3368_SOC_FLASH_SUPPLY_NUM 2
54 #define RK3399_PMUGRF_CON0 0x180
55 #define RK3399_PMUGRF_CON0_VSEL BIT(8)
56 #define RK3399_PMUGRF_VSEL_SUPPLY_NUM 9
58 struct rockchip_iodomain
;
61 * @supplies: voltage settings matching the register bits.
63 struct rockchip_iodomain_soc_data
{
65 const char *supply_names
[MAX_SUPPLIES
];
66 void (*init
)(struct rockchip_iodomain
*iod
);
69 struct rockchip_iodomain_supply
{
70 struct rockchip_iodomain
*iod
;
71 struct regulator
*reg
;
72 struct notifier_block nb
;
76 struct rockchip_iodomain
{
79 struct rockchip_iodomain_soc_data
*soc_data
;
80 struct rockchip_iodomain_supply supplies
[MAX_SUPPLIES
];
83 static int rockchip_iodomain_write(struct rockchip_iodomain_supply
*supply
,
86 struct rockchip_iodomain
*iod
= supply
->iod
;
91 val
= (uV
> MAX_VOLTAGE_1_8
) ? 0 : 1;
94 /* apply hiword-mask */
95 val
|= (BIT(supply
->idx
) << 16);
97 ret
= regmap_write(iod
->grf
, iod
->soc_data
->grf_offset
, val
);
99 dev_err(iod
->dev
, "Couldn't write to GRF\n");
104 static int rockchip_iodomain_notify(struct notifier_block
*nb
,
108 struct rockchip_iodomain_supply
*supply
=
109 container_of(nb
, struct rockchip_iodomain_supply
, nb
);
114 * According to Rockchip it's important to keep the SoC IO domain
115 * higher than (or equal to) the external voltage. That means we need
116 * to change it before external voltage changes happen in the case
119 * Note that in the "pre" change we pick the max possible voltage that
120 * the regulator might end up at (the client requests a range and we
121 * don't know for certain the exact voltage). Right now we rely on the
122 * slop in MAX_VOLTAGE_1_8 and MAX_VOLTAGE_3_3 to save us if clients
123 * request something like a max of 3.6V when they really want 3.3V.
124 * We could attempt to come up with better rules if this fails.
126 if (event
& REGULATOR_EVENT_PRE_VOLTAGE_CHANGE
) {
127 struct pre_voltage_change_data
*pvc_data
= data
;
129 uV
= max_t(unsigned long, pvc_data
->old_uV
, pvc_data
->max_uV
);
130 } else if (event
& (REGULATOR_EVENT_VOLTAGE_CHANGE
|
131 REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE
)) {
132 uV
= (unsigned long)data
;
137 dev_dbg(supply
->iod
->dev
, "Setting to %d\n", uV
);
139 if (uV
> MAX_VOLTAGE_3_3
) {
140 dev_err(supply
->iod
->dev
, "Voltage too high: %d\n", uV
);
142 if (event
== REGULATOR_EVENT_PRE_VOLTAGE_CHANGE
)
146 ret
= rockchip_iodomain_write(supply
, uV
);
147 if (ret
&& event
== REGULATOR_EVENT_PRE_VOLTAGE_CHANGE
)
150 dev_dbg(supply
->iod
->dev
, "Setting to %d done\n", uV
);
154 static void rk3288_iodomain_init(struct rockchip_iodomain
*iod
)
159 /* if no flash supply we should leave things alone */
160 if (!iod
->supplies
[RK3288_SOC_FLASH_SUPPLY_NUM
].reg
)
164 * set flash0 iodomain to also use this framework
165 * instead of a special gpio.
167 val
= RK3288_SOC_CON2_FLASH0
| (RK3288_SOC_CON2_FLASH0
<< 16);
168 ret
= regmap_write(iod
->grf
, RK3288_SOC_CON2
, val
);
170 dev_warn(iod
->dev
, "couldn't update flash0 ctrl\n");
173 static void rk3328_iodomain_init(struct rockchip_iodomain
*iod
)
178 /* if no vccio2 supply we should leave things alone */
179 if (!iod
->supplies
[RK3328_SOC_VCCIO2_SUPPLY_NUM
].reg
)
183 * set vccio2 iodomain to also use this framework
184 * instead of a special gpio.
186 val
= RK3328_SOC_CON4_VCCIO2
| (RK3328_SOC_CON4_VCCIO2
<< 16);
187 ret
= regmap_write(iod
->grf
, RK3328_SOC_CON4
, val
);
189 dev_warn(iod
->dev
, "couldn't update vccio2 vsel ctrl\n");
192 static void rk3368_iodomain_init(struct rockchip_iodomain
*iod
)
197 /* if no flash supply we should leave things alone */
198 if (!iod
->supplies
[RK3368_SOC_FLASH_SUPPLY_NUM
].reg
)
202 * set flash0 iodomain to also use this framework
203 * instead of a special gpio.
205 val
= RK3368_SOC_CON15_FLASH0
| (RK3368_SOC_CON15_FLASH0
<< 16);
206 ret
= regmap_write(iod
->grf
, RK3368_SOC_CON15
, val
);
208 dev_warn(iod
->dev
, "couldn't update flash0 ctrl\n");
211 static void rk3399_pmu_iodomain_init(struct rockchip_iodomain
*iod
)
216 /* if no pmu io supply we should leave things alone */
217 if (!iod
->supplies
[RK3399_PMUGRF_VSEL_SUPPLY_NUM
].reg
)
221 * set pmu io iodomain to also use this framework
222 * instead of a special gpio.
224 val
= RK3399_PMUGRF_CON0_VSEL
| (RK3399_PMUGRF_CON0_VSEL
<< 16);
225 ret
= regmap_write(iod
->grf
, RK3399_PMUGRF_CON0
, val
);
227 dev_warn(iod
->dev
, "couldn't update pmu io iodomain ctrl\n");
231 * On the rk3188 the io-domains are handled by a shared register with the
232 * lower 8 bits being still being continuing drive-strength settings.
234 static const struct rockchip_iodomain_soc_data soc_data_rk3188
= {
256 static const struct rockchip_iodomain_soc_data soc_data_rk3288
= {
259 "lcdc", /* LCDC_VDD */
260 "dvp", /* DVPIO_VDD */
261 "flash0", /* FLASH0_VDD (emmc) */
262 "flash1", /* FLASH1_VDD (sdio1) */
263 "wifi", /* APIO3_VDD (sdio0) */
264 "bb", /* APIO5_VDD */
265 "audio", /* APIO4_VDD */
266 "sdcard", /* SDMMC0_VDD (sdmmc) */
267 "gpio30", /* APIO1_VDD */
268 "gpio1830", /* APIO2_VDD */
270 .init
= rk3288_iodomain_init
,
273 static const struct rockchip_iodomain_soc_data soc_data_rk3328
= {
284 .init
= rk3328_iodomain_init
,
287 static const struct rockchip_iodomain_soc_data soc_data_rk3368
= {
291 "dvp", /* DVPIO_VDD */
292 "flash0", /* FLASH0_VDD (emmc) */
293 "wifi", /* APIO2_VDD (sdio0) */
295 "audio", /* APIO3_VDD */
296 "sdcard", /* SDMMC0_VDD (sdmmc) */
297 "gpio30", /* APIO1_VDD */
298 "gpio1830", /* APIO4_VDD (gpujtag) */
300 .init
= rk3368_iodomain_init
,
303 static const struct rockchip_iodomain_soc_data soc_data_rk3368_pmu
= {
310 "pmu", /*PMU IO domain*/
311 "vop", /*LCDC IO domain*/
315 static const struct rockchip_iodomain_soc_data soc_data_rk3399
= {
316 .grf_offset
= 0xe640,
318 "bt656", /* APIO2_VDD */
319 "audio", /* APIO5_VDD */
320 "sdmmc", /* SDMMC0_VDD */
321 "gpio1830", /* APIO4_VDD */
325 static const struct rockchip_iodomain_soc_data soc_data_rk3399_pmu
= {
337 "pmu1830", /* PMUIO2_VDD */
339 .init
= rk3399_pmu_iodomain_init
,
342 static const struct of_device_id rockchip_iodomain_match
[] = {
344 .compatible
= "rockchip,rk3188-io-voltage-domain",
345 .data
= (void *)&soc_data_rk3188
348 .compatible
= "rockchip,rk3288-io-voltage-domain",
349 .data
= (void *)&soc_data_rk3288
352 .compatible
= "rockchip,rk3328-io-voltage-domain",
353 .data
= (void *)&soc_data_rk3328
356 .compatible
= "rockchip,rk3368-io-voltage-domain",
357 .data
= (void *)&soc_data_rk3368
360 .compatible
= "rockchip,rk3368-pmu-io-voltage-domain",
361 .data
= (void *)&soc_data_rk3368_pmu
364 .compatible
= "rockchip,rk3399-io-voltage-domain",
365 .data
= (void *)&soc_data_rk3399
368 .compatible
= "rockchip,rk3399-pmu-io-voltage-domain",
369 .data
= (void *)&soc_data_rk3399_pmu
373 MODULE_DEVICE_TABLE(of
, rockchip_iodomain_match
);
375 static int rockchip_iodomain_probe(struct platform_device
*pdev
)
377 struct device_node
*np
= pdev
->dev
.of_node
;
378 const struct of_device_id
*match
;
379 struct rockchip_iodomain
*iod
;
380 struct device
*parent
;
386 iod
= devm_kzalloc(&pdev
->dev
, sizeof(*iod
), GFP_KERNEL
);
390 iod
->dev
= &pdev
->dev
;
391 platform_set_drvdata(pdev
, iod
);
393 match
= of_match_node(rockchip_iodomain_match
, np
);
394 iod
->soc_data
= (struct rockchip_iodomain_soc_data
*)match
->data
;
396 parent
= pdev
->dev
.parent
;
397 if (parent
&& parent
->of_node
) {
398 iod
->grf
= syscon_node_to_regmap(parent
->of_node
);
400 dev_dbg(&pdev
->dev
, "falling back to old binding\n");
401 iod
->grf
= syscon_regmap_lookup_by_phandle(np
, "rockchip,grf");
404 if (IS_ERR(iod
->grf
)) {
405 dev_err(&pdev
->dev
, "couldn't find grf regmap\n");
406 return PTR_ERR(iod
->grf
);
409 for (i
= 0; i
< MAX_SUPPLIES
; i
++) {
410 const char *supply_name
= iod
->soc_data
->supply_names
[i
];
411 struct rockchip_iodomain_supply
*supply
= &iod
->supplies
[i
];
412 struct regulator
*reg
;
418 reg
= devm_regulator_get_optional(iod
->dev
, supply_name
);
422 /* If a supply wasn't specified, that's OK */
425 else if (ret
!= -EPROBE_DEFER
)
426 dev_err(iod
->dev
, "couldn't get regulator %s\n",
431 /* set initial correct value */
432 uV
= regulator_get_voltage(reg
);
434 /* must be a regulator we can get the voltage of */
436 dev_err(iod
->dev
, "Can't determine voltage: %s\n",
441 if (uV
> MAX_VOLTAGE_3_3
) {
443 "%d uV is too high. May damage SoC!\n",
449 /* setup our supply */
453 supply
->nb
.notifier_call
= rockchip_iodomain_notify
;
455 ret
= rockchip_iodomain_write(supply
, uV
);
461 /* register regulator notifier */
462 ret
= regulator_register_notifier(reg
, &supply
->nb
);
465 "regulator notifier request failed\n");
471 if (iod
->soc_data
->init
)
472 iod
->soc_data
->init(iod
);
477 for (i
= MAX_SUPPLIES
- 1; i
>= 0; i
--) {
478 struct rockchip_iodomain_supply
*io_supply
= &iod
->supplies
[i
];
481 regulator_unregister_notifier(io_supply
->reg
,
488 static int rockchip_iodomain_remove(struct platform_device
*pdev
)
490 struct rockchip_iodomain
*iod
= platform_get_drvdata(pdev
);
493 for (i
= MAX_SUPPLIES
- 1; i
>= 0; i
--) {
494 struct rockchip_iodomain_supply
*io_supply
= &iod
->supplies
[i
];
497 regulator_unregister_notifier(io_supply
->reg
,
504 static struct platform_driver rockchip_iodomain_driver
= {
505 .probe
= rockchip_iodomain_probe
,
506 .remove
= rockchip_iodomain_remove
,
508 .name
= "rockchip-iodomain",
509 .of_match_table
= rockchip_iodomain_match
,
513 module_platform_driver(rockchip_iodomain_driver
);
515 MODULE_DESCRIPTION("Rockchip IO-domain driver");
516 MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");
517 MODULE_AUTHOR("Doug Anderson <dianders@chromium.org>");
518 MODULE_LICENSE("GPL v2");