跳到主要内容

IO-Domain 开发指南

文件标识：RK-KF-YF-085

发布版本：V1.0.1

日期：2021-05-28

文件密级：□绝密 □秘密 □内部资料 ■公开

免责声明

本文档按“现状”提供，瑞芯微电子股份有限公司（“本公司”，下同）不对本文档的任何陈述、信息和内容的准确性、可靠性、完整性、适销性、特定目的性和非侵权性提供任何明示或暗示的声明或保证。本文档仅作为使用指导的参考。

由于产品版本升级或其他原因，本文档将可能在未经任何通知的情况下，不定期进行更新或修改。

商标声明

“Rockchip”、“瑞芯微”、“瑞芯”均为本公司的注册商标，归本公司所有。

本文档可能提及的其他所有注册商标或商标，由其各自拥有者所有。

版权所有 © 2021 瑞芯微电子股份有限公司

超越合理使用范畴，非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

瑞芯微电子股份有限公司

Rockchip Electronics Co., Ltd.

地址： 福建省福州市铜盘路软件园A区18号

网址： www.rock-chips.com

客户服务电话： +86-4007-700-590

客户服务传真： +86-591-83951833

客户服务邮箱： fae@rock-chips.com

前言

一般 IO 电源的电压有 1.8v，3.3v，2.5v，5.0v 等，有些 IO 同时支持多种电压，io-domain 就是配置 IO 电源域的寄存器，依据真实的硬件电压范围来配置对应的电压寄存器，否则无法正常工作；下面有罗列出哪些 RK 芯片都需要配置 io-domain。

产品版本

芯片名称内核版本
RK31884.4
RK32884.4
RK30364.4
RK312x4.4
RK322x4.4
RK33683.10
RK33684.4
RK33664.4
RK33994.4
RV11083.10
RV11084.4
RK3228H3.10
RK33284.4
RK3326/PX304.4
RK33084.4

读者对象 本文档（本指南）主要适用于以下工程师： 技术支持工程师 软件开发工程师

修订记录

版本号作者修改日期修改说明
V1.0.0吴达超2019-01-28初始版本
V1.0.1黄莹2021-05-28修改格式，增加版权信息

目录

[TOC]

驱动文件与 DTS 节点​

驱动文件​

驱动文件所在位置： drivers/power/avs/rockchip-io-domain.c

DTS 节点​

  • 内核 3.10 版本的 DTS 节点合并：
io-domains {
        compatible = "rockchip,rk3368-io-voltage-domain";
        rockchip,grf = <&grf>;
        rockchip,pmugrf = <&pmugrf>;

        /*GRF_IO_VSEL*/
        dvp-supply = <&ldo7_reg>;      /* DVPIO_VDD */
        wifi-supply = <&ldo7_reg>;     /* APIO2_VDD */
        audio-supply = <&dcdc2_reg>;   /* APIO3_VDD */
        sdcard-supply = <&ldo1_reg>;   /* SDMMC0_VDD */
        gpio30-supply = <&dcdc2_reg>;  /* APIO1_VDD */
        gpio1830-supply = <&dcdc2_reg>;/* ADIO4_VDD */

        /*PMU_GRF_IO_VSEL*/
        pmu-supply = <&ldo5_reg>;      /* PMUIO_VDD */
        vop-supply = <&ldo5_reg>;      /* LCDC_VDD */
};
  • 内核 4.4 版本的 DTS 节点 GRF 和 PMUGRF 分开：
&io_domains {
        status = "okay";
        dvp-supply = <&vcc_18>;
        audio-supply = <&vcc_io>;
        gpio30-supply = <&vcc_io>;
        gpio1830-supply = <&vcc_io>;
        sdcard-supply = <&vccio_sd>;
        wifi-supply = <&vccio_wl>;
};

&pmu_io_domains {
        status = "okay";

        pmu-supply = <&vcc_io>;
        vop-supply = <&vcc_io>;
};

TRM 中的描述​

很多工程师反映在 TRM 中找不到 io-domain 相关的寄存器，可以通过 TRM 来搜索需要配置的 io-domain 寄存器描述，在 GRF/PMUGRF 章节搜索 ’vsel‘ ， ‘VSEL’ 或者 ‘volsel’ 索引，PMUGRF 中的 io-domain 是用来控制 PMU IO。

支持配置的两种电压 1.8v / 3.3v：

  • 寄存器配置成 1，一般对应的电压范围是 1.62v ~ 1.98v，typical 电压 1.8v；
  • 寄存器配置成 0，一般对应的电压范围是 3.00v ~ 3.60v，typical 电压 3.3v。

具体电压范围要以实际芯片的 Datasheet 为准。

驱动软件流程​

下面是 rockchip-io-domain.c 驱动的软件流程图，主要分为两个方面：

初始化配置​

在驱动的 probe 函数中的 supply name，获取 dts 中对应 supply name 定义的 regulator，再根据 regulator 的电压配置 io-domain 寄存器，如果是 1.8v 那一档，该 bit 配置为 1；如果是 3.3v 那一档，该 bit 配置为 0。

st=>start: 开始
op=>operation: 匹配 Supply_Name
cond=>condition: 获取 Regulator 成功?
op0=>operation: 配置 io-domain
op1=>operation: 丢弃
cond0=>condition: 继续?
e=>end: 结束

st->op->cond->op0->cond0->e
cond(no)->op1
cond(yes)->op0
op1->cond0
cond0(yes)->op
cond0(no)->e

动态配置​

在初始化的过程中，会绑定 regulator，通过注册 notify 的方式，一旦这个 regulator 的电压发生变化，就会通知 io-domain 驱动更新成对应的寄存器，做到动态更新寄存器的效果。

如何配置 io-domain​

不是每个 IO 电源域都需要配置，有些 IO 的电源域是固定的，不需要配置。下面 3 个步骤描述如何通过软件配置 io-domian：

通过 rockchip-io-domain.txt 文档寻找名称​

需要在软件上通过 dts 配置的 IO 电源域在 Linux Kernel 的目录下的文件都有描述：Documentation/devicetree/bindings/power/rockchip-io-domain.txt；由于 TRM 文档和硬件原理图上对同一个 io-domain 名称描述可能有差异，在 rockchip-io-domain.txt 文档上统一描述了 TRM 与 硬件原理图上 io-domain 名称的对应关系。

例如 RK3399 Soc，通过查看 rockchip-io-domain.txt 文档， 我们知道了 RK3399 的电源域需要配置包含 bt565，audio，sdmmc，gpio1830，以及 PMUGRF 下面的 pmu1830 这几个 supply，后面的 The supply connected to “***_VDD” 表示在硬件原理图上对应的名称。

Possible supplies for rk3399:

  • bt656-supply: The supply connected to APIO2_VDD.
  • audio-supply: The supply connected to APIO5_VDD.
  • sdmmc-supply: The supply connected to SDMMC0_VDD.
  • gpio1830-supply: The supply connected to APIO4_VDD.

Possible supplies for rk3399 pmu-domains:

  • pmu1830-supply:The supply connected to PMUIO2_VDD.

通过硬件原理图寻找 io-domain 配置的真实电压​

仍以 RK3399-EVB 原理图 和 bt656 IO 电源域为例，我们在 rockchip-io-domain.txt 中找到了 bt656 对应的硬件原理图上表示为 APIO2_VDD。所以通过逆向搜索 ‘APIO2_VDD’ 得到 RK3399-EVB 硬件原理图上的 APIO2_VDD 电源是由 RK808 下的 VCC1V8_DVP 供给。

io-domain-1-rk3399-APIO2-hardware

io-domain-2-rk3399-APIO2-supply

通过 DTS 配置​

以上两步做完后，得到了配置的名称和供电源头，在 DTS 里面找到对应的 regulator: vcc1v8_dvp，就可以在 rk3399-evb.dtsi 配置上 “bt656-supply = <&vcc1v8_dvp>;”，其他的电源域配置类似。

通过硬件 Pin 脚控制的电源域一般不做配置​

在 RK Soc 中的一些 IO 电源域在硬件上已经通过某个 Pin 脚来控制的，这种情况下我们 kernel 的 DTS 一般不去配置，不破坏当前的硬件状态，像 flash 和 emmc 这些模块的 IO 电源域一般都是 Pin 脚来控制的。

在 TRM 的 io-domain 寄存器描述中，我们可以看到哪些电源域是可以通过 Pin 脚来控制的，以及通过硬件上这个 Pin 脚的输入电压状态来确认当前这个电压域的配置；也可以通过 GRF 寄存器来配置，两种选择。

例如，RK3368 Soc 的 TRM 和 RK3368-evb 的硬件原理图上有下面寄存器的描述和硬件上 Pin 脚的配置。

  • TRM 寄存器描述：

io-domain-3-flash-io-domain-proc

io-domain-4-flash-io-bit-sel

  • 硬件原理图：

io-domain-5-rk3368-APIO4-hardware

io-domain-6-rk3368-APIO4-flash-io-sel

DTS 中无定义 Regulator 情况处理​

在使用的过程中可能会遇到，你找不到相应的 regulator 来配置，可能项目上面未使用 pmic 等电源，只是简单的拉了一个电源过来，dts 上找不到 regulator 的定义，那么你需要在 dts 文件里面增加 fixed regulator 的定义，一般 3.3v 和 1.8v 两个 regulator 就够用了。

下面是 rk3229-evb.dts 的配置例子，确定硬件上的电压是用 1.8v 还是 3.3v，配置成相应的 regulator：

        regulators {
                compatible = "simple-bus";
                #address-cells = <1>;
                #size-cells = <0>;

                vccio_1v8_reg: regulator@0 {
                        compatible = "regulator-fixed";
                        regulator-name = "vccio_1v8";
                        regulator-min-microvolt = <1800000>;
                        regulator-max-microvolt = <1800000>;
                        regulator-always-on;
                };

                vccio_3v3_reg: regulator@1 {
                        compatible = "regulator-fixed";
                        regulator-name = "vccio_3v3";
                        regulator-min-microvolt = <3300000>;
                        regulator-max-microvolt = <3300000>;
                        regulator-always-on;
                };
        };

&io_domains {
        status = "okay";

        vccio1-supply = <&vccio_3v3_reg>;
        vccio2-supply = <&vccio_1v8_reg>;
        vccio4-supply = <&vccio_3v3_reg>;
};

常见问题​

如何确定某个 Pin 脚所在的电源域寄存器是否配置正确​

经常遇到客户报的问题是某 pin 脚的电压与所期望的不符，很有可能就是电源域配置问题。例如，在 RK3399 上，软件上代码已经让 GPIO2_B1 输出高，但是实际通过量测发现电压不对；通过读取寄存器已经确认该 pin 脚已经将 iomux 配置成 gpio，并且也设置成输出高，这就很有可能是 io-domain 没有配置正确。那么这时候就要确认电源域寄存器是否配置正确，方法就是上面介绍的如何配置电源域的相反步骤。

  • 先确定这个 io 所在的电源域，一般是看硬件原理图或者 Datasheet 来确定。例如，RK3399 下面通过硬件原理如图发现 GPIO2_B1 所在的电源域硬件上表示为 APIO2_VDD，并且 APIO2_VDD 是接的电压是 VCC1V8_DVP 。

io-domain-1-rk3399-APIO2-hardware

io-domain-2-rk3399-APIO2-supply

  • 通过 rockchip-io-domain.txt 文档找到对应的名称。例如，在 rockchip-io-domain.txt 文档上找到的电源域对应的名称是 “bt656”。

    io-domain-9-rk3399-APIO2-desc

  • 在 TRM 上找到这个寄存器，通过 io 命令或者其他方式读取这个寄存器的值，一般基地址是 GRF 或者 PMUGRF。例如，在 TRM 文档上搜索到 “bt656” 寄存器描述，为 bit0，查看寄存器偏移为 0xe640，GRF 基地址为 0xff770000。在串口终端输入 “io -4 0xff77e640”，得到 io-domain 寄存器值，如果该寄存器值 bit0 为 1，表示 1.8v， 与硬件实际电压 VCC1V8_DVP，dts 中该项配置正确；如果 bit0 为 0，则表示 3.3v，与硬件实际电压 VCC1V8_DVP 不符，dts 中该项配置不正确。

io-domain-10-bt565-bit-desc

io-domain 的寄存器不正确​

常见的寄存器错误，可能是以下几个问题

  • 所配置的 regulator 电压不对；
  • 未配置 Regulator 或 Regulator 未使能；
  • Regulator 比 io-domain 驱动加载更慢，获取 regulator 失败。