LInux-3.0.8中基于S5PV210的GPIO模块代码追踪和分析

Posted 2020-11-19 tech-lqh

　　编写按键驱动时，想知道内核是如何管理GPIO的，所以开始追踪代码，中间走了一些弯路，现记录于此。

　　追踪代码之前，我猜测：第一，这部分代码应该在系统set up阶段执行；第二，GPIO的代码应该在machine或者platform或者vendor相关的目录下。事实证明，第一点是正确的，第二点基本是错误的，因为内核依靠对GPIO的抽象来管理之，这层抽象层给具体的machine留出了一些它们需要是实现的接口，这与其他的设备驱动框架在使用上是很类似的，当然，GPIO也是一种设备啊... ...所以，管理GPIO的多数代码位于drivers/gpio/目录下。

　　好了，开始走读代码，那么对于S5PV210这块SoC，GPIO子系统的入口函数在哪里呢？在drivers/gpio/gpio-s5pv210.c中，入口函数的实现如下图所示：

　　入口函数没几行代码，但是下面所有的内容都要从它开始，所以一点一点来吧，这里先罗列一下下面要叙述的内容：

1. struct s3c_gpio_chip的内容，以及重要的数组s5pv210_gpio_4bit；

2. 上述结构体中的成员config和base；

3. samsung_gpiolib_add_4bit_chips()的分析，这部分比较长。

 

　　第一部分，struct s3c_gpio_chip的介绍以及重要的数组s5pv210_gpio_4bit

　　

　　从面向对象的角度来看，s3c_gpio_chip是gpio_chip的子类，但是又新增了一些新的属性和操作。虽说它的名字是chip，但是一个s3c_gpio_chip描述的是一个GPIO bank，如GPA0、GPA1、GPB等等， 这一点在接着要介绍的数组s5pv210_gpio_4bit中得以清晰体现。

　　base成员表示的是当前bank的控制寄存器的起始虚拟地址，注意是虚拟地址。

　　config成员的类型是struct s3c_gpio_cfg，具体的结构是：

 1 struct s3c_gpio_cfg {
 2     unsigned int    cfg_eint;
 3 
 4     s3c_gpio_pull_t    (*get_pull)(struct s3c_gpio_chip *chip, unsigned offs);
 5     int        (*set_pull)(struct s3c_gpio_chip *chip, unsigned offs,
 6                     s3c_gpio_pull_t pull);
 7 
 8     unsigned (*get_config)(struct s3c_gpio_chip *chip, unsigned offs);
 9     int     (*set_config)(struct s3c_gpio_chip *chip, unsigned offs,
10                    unsigned config);
11 };

　　可见config成员用于控制和查看当前bank的某个pin的上下拉电阻的状态，以及设置和查看某引脚上的复用功能，这个成员作为子类struct s3c_gpio_cfg的新成员，说明以上这两种功能在不同的machine以及GPIO IP上的差别是不能忽略的。

　　struct s3c_gpio_cfg中很重要的一个成员就是它的父类struct gpio_chip，它内容很多，不过看成员名字就基本能明白含义：

 1 struct gpio_chip {
 2     const char        *label;
 3     struct device        *dev;
 4     struct module        *owner;
 5 
 6     int            (*request)(struct gpio_chip *chip,
 7                         unsigned offset);
 8     void            (*free)(struct gpio_chip *chip,
 9                         unsigned offset);
10 
11     int            (*direction_input)(struct gpio_chip *chip,
12                         unsigned offset);
13     int            (*get)(struct gpio_chip *chip,
14                         unsigned offset);
15     int            (*direction_output)(struct gpio_chip *chip,
16                         unsigned offset, int value);
17     int            (*set_debounce)(struct gpio_chip *chip,
18                         unsigned offset, unsigned debounce);
19 
20     void            (*set)(struct gpio_chip *chip,
21                         unsigned offset, int value);
22 
23     int            (*to_irq)(struct gpio_chip *chip,
24                         unsigned offset);
25 
26     void            (*dbg_show)(struct seq_file *s,
27                         struct gpio_chip *chip);
28     int            base;
29     u16            ngpio;
30     const char        *const *names;
31     unsigned        can_sleep:1;
32     unsigned        exported:1;
33 
34 #if defined(CONFIG_OF_GPIO)
35     /*
36      * If CONFIG_OF is enabled, then all GPIO controllers described in the
37      * device tree automatically may have an OF translation
38      */
39     struct device_node *of_node;
40     int of_gpio_n_cells;
41     int (*of_xlate)(struct gpio_chip *gc, struct device_node *np,
42                 const void *gpio_spec, u32 *flags);
43 #endif
44 };

　　这个结构体中的request free等函数指针与gpio的request、free、direction_input、direction_output等函数的实现有关系。

　　接着看一下数组s5pv210_gpio_4bit，首先，这个名字中包含4bit，意思是每个bank的gpio控制寄存器中，每4bit控制一个gpio pin。这个数组很长，我们只取出个别元素看一下：

 1 static struct s3c_gpio_chip s5pv210_gpio_4bit[] = {
 2     {
 3         .chip    = {
 4             .base    = S5PV210_GPA0(0),
 5             .ngpio    = S5PV210_GPIO_A0_NR,
 6             .label    = "GPA0",
 7         },
 8     }, {
 9         .chip    = {
10             .base    = S5PV210_GPA1(0),
11             .ngpio    = S5PV210_GPIO_A1_NR,
12             .label    = "GPA1",
13         },
14     }, {
15         .chip    = {
16             .base    = S5PV210_GPB(0),
17             .ngpio    = S5PV210_GPIO_B_NR,
18             .label    = "GPB",
19         },
20     },
21 ... ....
22 {
23         .base    = (S5P_VA_GPIO + 0xC40),
24         .config    = &gpio_cfg_noint,
25         .irq_base = IRQ_EINT(16),
26         .chip    = {
27             .base    = S5PV210_GPH2(0),
28             .ngpio    = S5PV210_GPIO_H2_NR,
29             .label    = "GPH2",
30             .to_irq = samsung_gpiolib_to_irq,
31         },
32     }, {
33         .base    = (S5P_VA_GPIO + 0xC60),
34         .config    = &gpio_cfg_noint,
35         .irq_base = IRQ_EINT(24),
36         .chip    = {
37             .base    = S5PV210_GPH3(0),
38             .ngpio    = S5PV210_GPIO_H3_NR,
39             .label    = "GPH3",
40             .to_irq = samsung_gpiolib_to_irq,
41         },
42     },
43 };

　　这个数组描述了一些S5PV210上的gpio，但是对比数据手册，有一些gpio并没有出现在这里，但是这已经足够多了，可以说这个数组描述了系统中多数能够使用的gpio，并初始化了一些信息，比如当前bank的第一个pin的编号、这个bank中所有pin的数量等等，这些都是宏定义，具体的需要看mach-s5pv210相关的头文件，由于涉及到的宏太多，而且没什么难度，这里就不记录了。

 

　　第二部分，struct s3c_gpio_chip中的config成员和base成员初始化。

　　这一部分的处理在s5pv210_gpiolib_init函数中，可以看到s5pv210_gpio_4bit中很多元素的config成员没有初始化，也就是NULL，那么这里就需要给其赋值为gpio_cfg，这个变量就在当前文件中，定义如下：

1 static struct s3c_gpio_cfg gpio_cfg = {
2     .set_config    = s3c_gpio_setcfg_s3c64xx_4bit,
3     .set_pull    = s3c_gpio_setpull_updown,
4     .get_pull    = s3c_gpio_getpull_updown,
5 };

　　下面就看看这三个函数吧，看名字应该就能知道其功能了。

#ifdef CONFIG_S3C_GPIO_CFG_S3C64XX
int s3c_gpio_setcfg_s3c64xx_4bit(struct s3c_gpio_chip *chip,
                 unsigned int off, unsigned int cfg)
{
    void __iomem *reg = chip->base;
    unsigned int shift = (off & 7) * 4;
    u32 con;

    if (off < 8 && chip->chip.ngpio > 8)
        reg -= 4;

    if (s3c_gpio_is_cfg_special(cfg)) {
        cfg &= 0xf;
        cfg <<= shift;
    }

    con = __raw_readl(reg);
    con &= ~(0xf << shift);
    con |= cfg;
    __raw_writel(con, reg);

    return 0;
}

　　代码逻辑很简单，获取当前bank的控制寄存器的虚拟地址，根据offset计算要控制的引脚在控制寄存器中的起始位，然后将要设置的cfg值写入到控制寄存器，完成工作。不过这里有个宏CONFIG_S3C_GPIO_CFG_S3C64XX，查看相关的Kconfig就可知道，一旦选中s5p相关的平台，那么S3C_GPIO_CFG_S3C64XX这个宏一定会定义。