我的内核学习笔记10:Intel GPIO驱动源码分析

本文对Intel e3800的GPIO驱动源码进行分析。

一、概述

1.1 内核配置

Intel e3800的GPIO在Linux内核中使用的驱动名为gpio_ich(为了行文方便,将对应的设备称为“gpio_ich设备”)。驱动源码位于:drivers/gpio/gpio-ich.c。
本文基于linux 3.17.1版本内核进行分析。
内核配置(make menuconfig)信息如下:

1
2
3
Device Drivers  --->
-*- GPIO Support --->
<M> Intel ICH GPIO

使用模块形式编译,在加载该驱动后,就可以使用lsmod查看。另外,也会生成对应的驱动设备目录:/sys/bus/platform/devices/gpio_ich/。

1.2 寄存器介绍

intel e3800的GPIO手册讲的有点复杂。笔者花了好几天时间搜索才慢慢有点理解。在这里仅说一下个人的理解。

1、分类

e3800的GPIO分2类,即SCORE和SSUS(看了baytrail的pingctrl,还有一个叫NCORE的),分别对应GPIO_S0_SC[xxx]和GPIO_S5[xx]。比如,GPIO_S0_SC[032]表示SCORE的第32个引脚。下面根据手册各处查找一下对应关系:
GPIO_S0_SC[032] -> SD2_CMD -> SDMMC2_CMD -> bank2 pin0 -> 第二组寄存器bit0(手册是South Core Use Select 2,从1开始。) 经过复杂的对比,终于知道:GPIO_S0_SC[032]就是bank2的pin0。计算公式为:gpio_pin / 32为bank值,gpio_pin % 32是这个bank的第几个引脚。Linux内核的GPIO子系统也是这样计算的。

2、SCORE

SCORE一共4个Bank。引脚号范围:GPIO_S0_SC[101:0] 。每个Bank使用6个寄存器控制,但主要的是use select、io select、io level这三个寄存器。下面以bank1为例介绍。
偏移值为0x0的是GPIO复用寄存器(Use Select)。名称为:South Core Use Select 1 (cfio_ioreg_SC_USE_SEL_31_0_)
偏移值为0x04的是IO输入输出选择寄存器(Io Select)。名称为:South Core Io Select 1 (cfio_ioreg_SC_IO_SEL_31_0_)
偏移值为0x08的是IO电平寄存器(Gpio Level)(如为输入则读取寄存器值)。名称为:South Core Gpio Level 1 (cfio_ ioreg_SC_GP_LVL_31_0_)
bank2、bank3、bank4都是类似的,省略。从笔者实践上看,似乎设置为输出后,无法读取Gpio Leve寄存器的值。
操作GPIO一般步骤:

  • A、设置use select寄存器,将某个引脚复用为GPIO。设置为1表示将该引脚复用为GPIO。
  • B、设置io select寄存器,选择该GPIO引脚为输出还是输入。
  • C、设置/读取io level寄存器。设置1表示将该GPIO引脚拉高电平,0为低电平。当为输入引脚时,读取即为对应的GPIO电平值。(注:存疑待核实) 在gpio_ich驱动中,这三组寄存器的偏移量使用数组表示,根据baseaddr索引,从而得到真实IO地址。

3、SSUS

SSUS只有2个bank。引脚号范围:GPIO_S5[43:0]。主要寄存器名称如下:

  • Sus Use Select 1 (cfio_ioreg_SUS_USE_SEL_31_0_)
  • Sus Io Select 1 (cfio_ioreg_SU S_IO_SEL_31_0_)
  • Sus Io Select 1 (cfio_ioreg_SU S_IO_SEL_31_0_)
    另一组省略不写。
    GPIO的介绍在e3800手册的39章节。从手册来看,SCORE表示“South Core”,NCORE可能表示“North Core”,SSUS暂找不到。像这里说的GPIO_S0_SC[xxx],似乎是接到南桥上的引脚,但细节暂没时间也不想去研究了。

二、gpio_ich设备注册

gpio_ich设备的注册实现过程在文件drivers/mfd/lpc_ich.c中。在LPC探测函数lpc_ich_probe对GPIO基地址进行赋值,代码如下:

1
2
priv->gbase = GPIOBASE_ICH6; // GPIO基地址
priv->gctrl = GPIOCTRL_ICH6;

其定义是:

1
2
#define GPIOBASE_ICH6        0x48
#define GPIOCTRL_ICH6 0x4C

前文也提及有0x48地址,所有地址都可以在手册对应章节中找到。直接初始化GPIO在函数lpc_ich_init_gpio中。这个函数对ACPI(GPE0)和GPIO都进行初始化。使用的resource结构体gpio_ich_res是一个数组,包含了GPE0和GPIO。这里只看GPIO的部分,主要代码功能描述如下。
1、读取GPIO基地址值,即通过LPC这个PCI设备的配置空间偏移值GPIOBASE_ICH6。

1
2
3
/* Setup GPIO base register */
pci_read_config_dword(dev, priv->gbase, &base_addr_cfg);
base_addr = base_addr_cfg & 0x0000ff80;

2、设置resource,即把前面获取到的base_addr赋值给resource的start成员变量。注意,资源是IORESOURCE_IO类型

1
2
3
4
5
6
7
8
9
10
11
res = &gpio_ich_res[ICH_RES_GPIO];
res->start = base_addr;
switch (lpc_chipset_info[priv->chipset].gpio_version) {
case ICH_V5_GPIO:
case ICH_V10CORP_GPIO:
res->end = res->start + 128 - 1;
break;
default:
res->end = res->start + 64 - 1;
break;
}

3、检查GPIO冲突。

1
ret = lpc_ich_check_conflict_gpio(res);

4、使能GPIO:

1
lpc_ich_enable_gpio_space(dev);

即使能GPIO地址解码, e3800手册中对GPIO使能解释如下:

bit 1 Enable (EN): When set, decode of the IO range pointed to by the GBASE is enabled.

5、添加mfd设备。

1
2
3
lpc_ich_finalize_cell(dev, &lpc_ich_cells[LPC_GPIO]);
ret = mfd_add_devices(&dev->dev, -1, &lpc_ich_cells[LPC_GPIO],
1, NULL, 0, NULL);

其中lpc_ich_finalize_cell是设置mfd_cell结构体的成员platform_data。从上文知道,lpc_chipset_info保存着名称和一些模块的版本号。这样,在对应的驱动中就能获取到这个些值从而进行不同的处理。最后调用mfd_add_devices添加lpc_ich_cells[LPC_GPIO]——即GPIO的platform设备。添加成功之后,就可以调用到gpio_ich驱动的probe函数了。

三、gpio_ich驱动

3.1 入口代码

gpio_ich是一个platform设备驱动,其入口代码片段如下:

1
2
3
4
5
6
7
8
9
10
static struct platform_driver ichx_gpio_driver = {
.driver = {
.owner = THIS_MODULE,
.name = DRV_NAME,
},
.probe = ichx_gpio_probe,
.remove = ichx_gpio_remove,
};

module_platform_driver(ichx_gpio_driver);

该驱动直接使用module_platform_driver函数,而前面文章介绍的wdt使用module_init形式,其本质是一样的。

3.2 探测函数

gpio_ich的探测函数为ichx_gpio_probe。下面分步分析其功能。
1、获取设备私有数据并初始化GPIO描述表ichx_priv.desc。

1
2
3
4
5
6
7
8
9
struct lpc_ich_info *ich_info = dev_get_platdata(&pdev->dev);

switch (ich_info->gpio_version) {
case ICH_V6_GPIO:
ichx_priv.desc = &ich6_desc;
break;
default:
return -ENODEV;
}

gpio_version是GPIO类别,根据lpc_ich驱动指定的值从而配置不同的desc。下文将会提到这个描述表。
2、获取lpc_ich驱动设置的IO资源,并检测GPIO是否可用,然后赋值GPIO基地址。

1
2
3
4
5
6
7
8
res_base = platform_get_resource(pdev, IORESOURCE_IO, ICH_RES_GPIO);
ichx_priv.use_gpio = ich_info->use_gpio;
err = ichx_gpio_request_regions(res_base, pdev->name,
ichx_priv.use_gpio);
if (err)
return err;

ichx_priv.gpio_base = res_base;

3、设置gpiolib函数,并添加到gpio子系统。最后打印可用的GPIO引脚号范围。

1
2
3
4
5
6
7
8
9
ichx_gpiolib_setup(&ichx_priv.chip);
err = gpiochip_add(&ichx_priv.chip);
if (err) {
pr_err("Failed to register GPIOs\n");
goto add_err;
}

pr_info("GPIO from %d to %d on %s\n", ichx_priv.chip.base,
ichx_priv.chip.base + ichx_priv.chip.ngpio - 1, DRV_NAME);

3.3 gpiolib框架

探测函数最后调用gpiochip_add加入内核的gpio子系统。这样在内核其它地方也能调用。其设置gpio_chip的函数如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
static void ichx_gpiolib_setup(struct gpio_chip *chip)
{
chip->owner = THIS_MODULE;
chip->label = DRV_NAME;
chip->dev = &ichx_priv.dev->dev;

/* Allow chip-specific overrides of request()/get() */
chip->request = ichx_priv.desc->request ?
ichx_priv.desc->request : ichx_gpio_request;
chip->get = ichx_priv.desc->get ?
ichx_priv.desc->get : ichx_gpio_get;

chip->set = ichx_gpio_set;
chip->direction_input = ichx_gpio_direction_input;
chip->direction_output = ichx_gpio_direction_output;
chip->base = modparam_gpiobase;
chip->ngpio = ichx_priv.desc->ngpio;
chip->can_sleep = false;
chip->dbg_show = NULL;
}

注意说明的是,chip->base是指可用的起始引脚号,chip->ngpio是GPIO可用数量。如4个bank,每个32,假如从第0个引脚开始到127均可使用。则chip->base为0,chip->ngpio等于128。
gpio-ich向gpiolib注册的主要函数有:

  • 申请GPIO:ichx_gpio_request
  • 获取GPIO:ichx_gpio_get
  • 设置GPIO:ichx_gpio_set
  • 设置GPIO方向:direction_input、direction_output

3.4 GPIO操作结构体

ich的GPIO结构体ichx_desc定义:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
struct ichx_desc {
/* Max GPIO pins the chipset can have */
uint ngpio; // GPIO数量

/* chipset registers */
const u8 (*regs)[3]; // GPIO寄存器(即USE_SEL、IO_SEL、IO_LVL三个寄存器偏移量)
const u8 *reglen; // 寄存器长度(即每组(bank)寄存器之间间隔)

/* GPO_BLINK is available on this chipset */
bool have_blink;

/* Whether the chipset has GPIO in GPE0_STS in the PM IO region */
bool uses_gpe0;

/* USE_SEL is bogus on some chipsets, eg 3100 */
u32 use_sel_ignore[3];

/* Some chipsets have quirks, let these use their own request/get */
int (*request)(struct gpio_chip *chip, unsigned offset);
int (*get)(struct gpio_chip *chip, unsigned offset);

/*
* Some chipsets don't let reading output values on GPIO_LVL register
* this option allows driver caching written output values
*/
bool use_outlvl_cache; // 是否缓冲LVL寄存器,因为有的芯片读不了方向为输出的IO_LVL
};

看一下ich6_desc的定义:

1
2
3
4
5
6
7
8
9
10
11
12
13
static struct ichx_desc ich6_desc = {
/* Bridges using the ICH6 controller need fixups for GPIO 0 - 17 */
.request = ich6_gpio_request,
.get = ich6_gpio_get,

/* GPIO 0-15 are read in the GPE0_STS PM register */
.uses_gpe0 = true,

.ngpio = 50,
.have_blink = true,
.regs = ichx_regs,
.reglen = ichx_reglen,
};

由于ich6控制器特殊一点,所以request和get需要另外实现。 它的寄存器偏移值定义如下:

1
2
3
4
5
6
7
8
9
10
11
static const u8 ichx_regs[4][3] = {
{0x00, 0x30, 0x40}, /* USE_SEL[1-3] offsets */
{0x04, 0x34, 0x44}, /* IO_SEL[1-3] offsets */
{0x0c, 0x38, 0x48}, /* LVL[1-3] offsets */
{0x18, 0x18, 0x18}, /* BLINK offset */
};


static const u8 ichx_reglen[3] = {
0x30, 0x10, 0x10,
};

ichx_reglen指定了每组寄存器的长度间隔。ichx_reglen[0]为0x30,即使用第一组和第二组USE_SEL之间相差0x30的间隔。详细细节参考手册。

3.5 GPIO访问

GPIO访问使用inl和outl函数。根据GPIO_REG枚举操作不同类别的寄存器。

1
2
3
4
5
6
7
8
9
#define ICHX_WRITE(val, reg, base_res)    outl(val, (reg) + (base_res)->start)
#define ICHX_READ(reg, base_res) inl((reg) + (base_res)->start)

enum GPIO_REG {
GPIO_USE_SEL = 0,
GPIO_IO_SEL,
GPIO_LVL,
GPO_BLINK
};

所有函数最终使用ichx_write_bit和ichx_read_bit。其函数如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
static int ichx_write_bit(int reg, unsigned nr, int val, int verify)
{
unsigned long flags;
u32 data, tmp;
int reg_nr = nr / 32;
int bit = nr & 0x1f;
int ret = 0;

spin_lock_irqsave(&ichx_priv.lock, flags);

if (reg == GPIO_LVL && ichx_priv.desc->use_outlvl_cache)
data = ichx_priv.outlvl_cache[reg_nr];
else
data = ICHX_READ(ichx_priv.desc->regs[reg][reg_nr],
ichx_priv.gpio_base);

if (val)
data |= 1 << bit;
else
data &= ~(1 << bit);
ICHX_WRITE(data, ichx_priv.desc->regs[reg][reg_nr],
ichx_priv.gpio_base);
if (reg == GPIO_LVL && ichx_priv.desc->use_outlvl_cache)
ichx_priv.outlvl_cache[reg_nr] = data;

tmp = ICHX_READ(ichx_priv.desc->regs[reg][reg_nr],
ichx_priv.gpio_base);
if (verify && data != tmp)
ret = -EPERM;

spin_unlock_irqrestore(&ichx_priv.lock, flags);

return ret;
}

static int ichx_read_bit(int reg, unsigned nr)
{
unsigned long flags;
u32 data;
int reg_nr = nr / 32;
int bit = nr & 0x1f;

spin_lock_irqsave(&ichx_priv.lock, flags);

data = ICHX_READ(ichx_priv.desc->regs[reg][reg_nr],
ichx_priv.gpio_base);

if (reg == GPIO_LVL && ichx_priv.desc->use_outlvl_cache)
data = ichx_priv.outlvl_cache[reg_nr] | data;

spin_unlock_irqrestore(&ichx_priv.lock, flags);

return data & (1 << bit) ? 1 : 0;
}

如申请GPIO函数ichx_gpio_request,定义如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
static int ichx_gpio_request(struct gpio_chip *chip, unsigned nr)
{
if (!ichx_gpio_check_available(chip, nr))
return -ENXIO;

/*
* Note we assume the BIOS properly set a bridge's USE value. Some
* chips (eg Intel 3100) have bogus USE values though, so first see if
* the chipset's USE value can be trusted for this specific bit.
* If it can't be trusted, assume that the pin can be used as a GPIO.
*/
if (ichx_priv.desc->use_sel_ignore[nr / 32] & (1 << (nr & 0x1f)))
return 0;

return ichx_read_bit(GPIO_USE_SEL, nr) ? 0 : -ENODEV;
}

首先调用ichx_gpio_check_available检测GPIO是否可用,如不可用,返回ENXIO错误。然后读取GPIO_USE_SEL对应的引脚号。如其为1表示该引脚是GPIO功能,返回成功,否则返回ENODEV表示这个引脚已经作他用,无法申请。 其它函数可阅读gpio-ich.c了解更多。

四、免坑指南

1、gpio_ich仅适合于ICH系列的GPIO,有点不合适e3800,所以驱动要做修改,比如GPIO寄存器偏移值与ICH的不同。
2、gpio_ich根据modparam_gpiobase来选择起始GPIO引脚号。默认为-1,即表示由系统动态分配。因此要根据板子的硬件定义来确定可用范围,否则使用其它如leds-gpio、i2c-gpio等驱动时会遇到麻烦。
3、检测GPIO是否可用的函数ichx_gpio_check_available根据lpc_ich驱动传递的use_gpio做判断。use_gpio在lpc_ich_check_conflict_gpio函数赋值,use_gpio的每个比特表示可用的GPIO的bank,如use_gpio为7,表示bank0~bank2可使用,而bank3不可用。
Intel的GPIO的确比较复杂,以上几点免坑指南也是笔者花了几天跟踪代码得到的经验之谈。

参考资源:
1、baytrail手册:http://www.intel.com/content/www/us/en/embedded/products/bay-trail/atom-e3800-family-datasheet.html
2、ICH6手册:http://www.intel.com/content/www/us/en/io/io-controller-hub-6-datasheet.html
3、内核源码官网:https://www.kernel.org
4、内核源码查询:http://lxr.free-electrons.com/source/?v=3.17

李迟 2016.12.08 周三 晚