ROC-RK3328-CC 四核64位开源主板 立即购买 产品规格书

Firefly首个超小型开源主板,特有的USB3.0与DDR4让其性能更快更稳定,超高性价比的ROC-RK3328-CC是你探索程序世界的首选主板。

GPIO 使用

更新时间:2017-12-29 阅读:1964

简介

GPIO, 全称 General-Purpose Input/Output(通用输入输出),是一种软件运行期间能够动态配置和控制的通用引脚。 ROC-RK3328-CC有5组GPIO bank:GPIO0~GPIO3,每组又以 A0~A7, B0~B7, C0~C7, D0~D7 作为编号区分(不是所有 bank 都有全部编号)。 所有的GPIO在上电后的初始状态都是输入模式,可以通过软件设为上拉或下拉,也可以设置为中断脚,驱动强度都是可编程的。

每个 GPIO 口除了通用输入输出功能外,还可能有其它复用功能,例如 GPIO2_B7,可以利用成以下功能:

  • I2S1_MCLK

  • TSP_SYNC_M1

  • CIF_CLKOUT_M1

每个 GPIO 口的驱动电流、上下拉和重置后的初始状态都不尽相同,详细情况请参考《RK3328 规格书》中的 "Chapter 10 GPIO" 一章。 ROC-RK3328-CC 的 GPIO 驱动是在以下 pinctrl 文件中实现的:

kernel/drivers/pinctrl/pinctrl-rockchip.c

其核心是填充 GPIO bank 的方法和参数,并调用 gpiochip_add 注册到内核中。

ROC-RK3328-CC开发板为方便用户开发使用,引出了一排通用的GPIO口,其对应引脚如下图:

图片.png

本文以GPIO2_C4(也就是图中的SDO1)为例写了一份简单操作GPIO的驱动,在SDK里的路径为

kernel/drivers/gpio/gpio-firefly.c

输入输出

首先在DTS文件中增加驱动的资源描述:

kernel/arch/arm64/boot/dts/rk3328-roc-cc.dts
    firefly-gpio{
          compatible = "firefly,rk3328-gpio";
          firefly-gpio = ;
          status = "okay";
     };

这里定义了一个脚作为一般的输出输入口:

firefly-gpio GPIO2_C4

GPIO_ACTIVE_HIGH表示高电平有效,如果想要低电平有效,可以改为:GPIO_ACTIVE_LOW,这个属性将被驱动所读取。

然后在probe函数中对DTS所添加的资源进行解析,代码如下:

 static int firefly_gpio_probe(struct platform_device *pdev)
  {
      int ret;
      int gpio;
      enum of_gpio_flags flag;
      struct firefly_gpio_info *gpio_info;
      struct device_node *firefly_gpio_node = pdev->dev.of_node;
  
      printk("Firefly GPIO Test Program Probe\n");
      gpio_info = devm_kzalloc(&pdev->dev,sizeof(struct firefly_gpio_info *), GFP_KERNEL);
      if (!gpio_info) {
          dev_err(&pdev->dev, "devm_kzalloc failed!\n");
          return -ENOMEM;
       }
  
      gpio = of_get_named_gpio_flags(firefly_gpio_node, "firefly-gpio", 0, &flag);
      if (!gpio_is_valid(gpio)) {
          dev_err(&pdev->dev, "firefly-gpio: %d is invalid\n", gpio);
          return -ENODEV;
      }
      if (gpio_request(gpio, "firefly-gpio")) {
          dev_err(&pdev->dev, "firefly-gpio: %d request failed!\n", gpio);
          gpio_free(gpio);
          return -ENODEV;
      }
      gpio_info->firefly_gpio = gpio;
      gpio_info->gpio_enable_value = (flag == OF_GPIO_ACTIVE_LOW) ? 0:1;
      gpio_direction_output(gpio_info->firefly_gpio, gpio_info->gpio_enable_value);
      printk("Firefly gpio putout\n");
  
      gpio = of_get_named_gpio_flags(firefly_gpio_node, "firefly-irq-gpio", 0, &flag);
      printk("firefly:the gpio:%d\n",gpio);                                                                                                  
       .......
 }

of_get_named_gpio_flags 从设备树中读取 firefly-gpio 和 firefly-irq-gpio 的 GPIO 配置编号和标志,gpio_is_valid 判断该 GPIO 编号是否有效,gpio_request 则申请占用该 GPIO。如果初始化过程出错,需要调用 gpio_free 来释放之前申请过且成功的 GPIO 。 在驱动中调用 gpio_direction_output 就可以设置输出高还是低电平,这里默认输出从DTS获取得到的有效电平GPIO_ACTIVE_HIGH,即为高电平,如果驱动正常工作,可以用万用表测得对应的引脚应该为高电平。 实际中如果要读出 GPIO,需要先设置成输入模式,然后再读取值:

int val;
gpio_direction_input(your_gpio);
val = gpio_get_value(your_gpio);

下面是常用的 GPIO API 定义:

 #include 
 #include   
 enum of_gpio_flags {OF_GPIO_ACTIVE_LOW = 0x1,
 };  
 int of_get_named_gpio_flags(struct device_node *np, const char *propname, int index, enum of_gpio_flags *flags);  
 int gpio_is_valid(int gpio);  
 int gpio_request(unsigned gpio, const char *label);  
 void gpio_free(unsigned gpio);  
 int gpio_direction_input(int gpio);  
 int gpio_direction_output(int gpio, int v);

中断

在Firefly的例子程序中还包含了一个中断引脚,GPIO口的中断使用与GPIO的输入输出类似,首先在DTS文件中增加驱动的资源描述:

kernel/arch/arm64/boot/dts/rk3328-roc-cc.dts
  gpio {
      compatible = "firefly,rk3328-gpio";
      firefly-irq-gpio = ;  /* GPIO2_C5 */
  };

IRQ_TYPE_EDGE_RISING表示中断由上升沿触发,当该引脚接收到上升沿信号时可以触发中断函数。 这里还可以配置成如下:

IRQ_TYPE_NONE         //默认值,无定义中断触发类型
IRQ_TYPE_EDGE_RISING  //上升沿触发
IRQ_TYPE_EDGE_FALLING //下降沿触发
IRQ_TYPE_EDGE_BOTH    //上升沿和下降沿都触发
IRQ_TYPE_LEVEL_HIGH   //高电平触发
IRQ_TYPE_LEVEL_LOW    //低电平触发

然后在probe函数中对DTS所添加的资源进行解析,再做中断的注册申请,代码如下:

 static int firefly_gpio_probe(struct platform_device *pdev)
 {   
    int ret; int gpio; enum of_gpio_flags flag; 
    struct firefly_gpio_info *gpio_info; 
    struct device_node *firefly_gpio_node = pdev->dev.of_node; 
    ......     
    gpio_info->firefly_irq_gpio = gpio; 
    gpio_info->firefly_irq_mode = flag; 
    gpio_info->firefly_irq = gpio_to_irq(gpio_info->firefly_irq_gpio); 
    if (gpio_info->firefly_irq) { 
        if (gpio_request(gpio, "firefly-irq-gpio")) { 
            printk("gpio %d request failed!\n", gpio); 
            gpio_free(gpio); return IRQ_NONE; 
        } 
        ret = request_irq(gpio_info->firefly_irq, firefly_gpio_irq, flag, "firefly-gpio", gpio_info); 
        if (ret != 0)
            free_irq(gpio_info->firefly_irq, gpio_info); 
        dev_err(&pdev->dev, "Failed to request IRQ: %d\n", ret); 
    }
      
    return 0;
 }
 
 static irqreturn_t firefly_gpio_irq(int irq, void *dev_id) //中断函数
 { 
    printk("Enter firefly gpio irq test program!\n"); 
    return IRQ_HANDLED;
 }

调用gpio_to_irq把GPIO的PIN值转换为相应的IRQ值,调用gpio_request申请占用该IO口,调用request_irq申请中断,如果失败要调用free_irq释放,该函数中gpio_info->firefly_irq是要申请的硬件中断号,firefly_gpio_irq是中断函数,gpio_info->firefly_irq_mode是中断处理的属性,"firefly-gpio"是设备驱动程序名称,gpio_info是该设备的device结构,在注册共享中断时会用到。

复用

如何定义 GPIO 有哪些功能可以复用,在运行时又如何切换功能呢?以 I2C0为例做简单介绍

查规格表可知,I2C0_SDA 与 I2C0_SCL 的功能定义如下:

Pad#
func0
func1
I2C0_SDA/GPIO2_D1
gpio2d1
i2c0_sda
I2C0_SCL/GPIO2_D0
gpio2d0
i2c0_scl

我们看看 i2c 的驱动程序 kernel/drivers/i2c/busses/i2c-rockchip.c 是如何切换复用功能的:

static int rockchip_i2c_probe(struct platform_device *pdev)
{   
    struct rockchip_i2c *i2c = NULL; struct resource *res; 
    struct device_node *np = pdev->dev.of_node; int ret;
    // ...
    i2c->sda_gpio = of_get_gpio(np, 0);
    if (!gpio_is_valid(i2c->sda_gpio)) {
        dev_err(&pdev->dev, "sda gpio is invalid\n");
        return -EINVAL;
    }
    ret = devm_gpio_request(&pdev->dev, i2c->sda_gpio, dev_name(&i2c->adap.dev));
    if (ret) {
        dev_err(&pdev->dev, "failed to request sda gpio\n");return ret;
    }
    i2c->scl_gpio = of_get_gpio(np, 1);
    if (!gpio_is_valid(i2c->scl_gpio)) {
        dev_err(&pdev->dev, "scl gpio is invalid\n");
        return -EINVAL;
    }

    ret = devm_gpio_request(&pdev->dev, i2c->scl_gpio, dev_name(&i2c->adap.dev));
    if (ret) {
        dev_err(&pdev->dev, "failed to request scl gpio\n");
        return ret;
    }

    i2c->gpio_state = pinctrl_lookup_state(i2c->dev->pins->p, "gpio");
    if (IS_ERR(i2c->gpio_state)) {
        dev_err(&pdev->dev, "no gpio pinctrl state\n");
        return PTR_ERR(i2c->gpio_state);
    }

    pinctrl_select_state(i2c->dev->pins->p, i2c->gpio_state);
    gpio_direction_input(i2c->sda_gpio);
    gpio_direction_input(i2c->scl_gpio);
    pinctrl_select_state(i2c->dev->pins->p, i2c->dev->pins->default_state);
    // ...
}

首先是调用 of_get_gpio 取出设备树中 i2c0 结点的 gpios 属于所定义的两个 gpio:

gpios = , ;

然后是调用 devm_gpio_request 来申请 gpio,接着是调用 pinctrl_lookup_state 来查找 “gpio” 状态,而默认状态 "default" 已经由框架保存到 i2c->dev-pins->default_state 中了。

最后调用 pinctrl_select_state 来选择是 "default" 还是 "gpio" 功能。

下面是常用的复用 API 定义:

#include  
struct device {//...
    #ifdef CONFIG_PINCTRLstruct dev_pin_info	*pins;
    #endif
//...}; 
struct dev_pin_info {
    struct pinctrl *p;
    struct pinctrl_state *default_state;
    #ifdef CONFIG_PMstruct pinctrl_state *sleep_state;
    struct pinctrl_state *idle_state;#endif
 }; 
 struct pinctrl_state * pinctrl_lookup_state(struct pinctrl *p, const char *name); 
 int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *s);

调试方法

IO指令

GPIO调试有一个很好用的工具,那就是IO指令,ROC-RK3328-CC的Android系统默认已经内置了IO指令,使用IO指令可以实时读取或写入每个IO口的状态,这里简单介绍IO指令的使用。 首先查看 io 指令的帮助:

#io --help
Unknown option: ?
Raw memory i/o utility - $Revision: 1.5 $

io -v -1|2|4 -r|w [-l ] [-f  []

   -v         Verbose, asks for confirmation
   -1|2|4     Sets memory access size in bytes (default byte)
   -l    Length in bytes of area to access (defaults to
              one access, or whole file length)
   -r|w       Read from or Write to memory (default read)
   -f   File to write on memory read, or
              to read on memory write
        The memory address to access
         The value to write (implies -w)

Examples:
   io 0x1000                  Reads one byte from 0x1000
   io 0x1000 0x12             Writes 0x12 to location 0x1000
   io -2 -l 8 0x1000          Reads 8 words from 0x1000
   io -r -f dmp -l 100 200    Reads 100 bytes from addr 200 to file
   io -w -f img 0x10000       Writes the whole of file to memory

Note access size (-1|2|4) does not apply to file based accesses.

从帮助上可以看出,如果要读或者写一个寄存器,可以用:

io -4 -r 0x1000 //读从0x1000起的4位寄存器的值
io -4 -w 0x1000 //写从0x1000起的4位寄存器的值

FAQs

Q1: 如何将PIN的MUX值切换为一般的GPIO?

A1: 当使用GPIO request时候,会将该PIN的MUX值强制切换为GPIO,所以使用该pin脚为GPIO功能的时候确保该pin脚没有被其他模块所使用。

Q2: 为什么我用IO指令读出来的值都是0x00000000?

A2: 如果用IO命令读某个GPIO的寄存器,读出来的值异常,如 0x00000000或0xffffffff等,请确认该GPIO的CLK是不是被关了,GPIO的CLK是由CRU控制,可以通过读取datasheet下面CRU_CLKGATE_CON* 寄存器来查到CLK是否开启,如果没有开启可以用io命令设置对应的寄存器,从而打开对应的CLK,打开CLK之后应该就可以读到正确的寄存器值了。

Q3: 测量到PIN脚的电压不对应该怎么查?

A3: 测量该PIN脚的电压不对时,如果排除了外部因素,可以确认下该pin所在的io电压源是否正确,以及IO-Domain配置是否正确。

Q4: gpio_set_value()与gpio_direction_output()有什么区别?

A4: 如果使用该GPIO时,不会动态的切换输入输出,建议在开始时就设置好GPIO 输出方向,后面拉高拉低时使用gpio_set_value()接口,而不建议使用gpio_direction_output(), 因为gpio_direction_output接口里面有mutex锁,对中断上下文调用会有错误异常,且相比 gpio_set_value,gpio_direction_output 所做事情更多,浪费。