解读set_gpio_ctrl(GPIO_MODE_OUT | GPIO_H6)

做嵌入式底层的东西，初始化硬件设备应该是必须的。一个个内核调用函数足以让人头晕！ 
         最近在看Linux嵌入式(s3c2410)方面的内容,遇到了这样一个函数:set_gpio_ctrl(); 它从字面上看来是对gpio口的设置扩展GPIO是什么呢？它是通用 IO端口引脚,在s3c2410用户手册中有A,B,C,D,E,F,G,H7组共117个引脚。这些引脚除了可作为INPUT/OUTPUT外,大部份还可以用作其它用,如外部中断,UART等。它们用的控制寄存器主要有GPACON-GPHCON,GPADAT-GPHDAT,GPBUP- GPHUP,还有一些不累赘了。
       我在linux内核原代码的/include/asm-arm/arch-s3c2410/s3c2410.h 这头文件个找
到set_gpio_ctrl()函数的定义,体质来讲是个宏定义。

#define GPCON(x) __REG2(0x56000000, (x) * 0x10)       //(此为GPACON---GPHCON 的一种表示)
#define GPDAT(x) __REG2(0x56000004, (x) * 0x10)       //(此为GPADAT--GPHDAT 的一种表示)
#define GPUP(x) __REG2(0x56000008, (x) * 0x10)
#define GPIO_OFS_SHIFT  0
#define GPIO_PORT_SHIFTT 8
#define GPIO_PULLUP_SHIFT 16
#define GPIO_MODE_SHIFT  24
#define GPIO_OFS_MASK  0x000000ff
#define GPIO_PORT_MASK  0x0000ff00
#define GPIO_PULLUP_MASK 0x00ff0000
#define GPIO_MODE_MASK  0xff000000
#define GPIO_MODE_IN  (0 << GPIO_MODE_SHIFT)
#define GPIO_MODE_OUT  (1 << GPIO_MODE_SHIFT)
#define GPIO_MODE_ALT0  (2 << GPIO_MODE_SHIFT)
#define GPIO_MODE_ALT1  (3 << GPIO_MODE_SHIFT)
#define GPIO_PULLUP_EN  (0 << GPIO_PULLUP_SHIFT)
#define GPIO_PULLUP_DIS  (1 << GPIO_PULLUP_SHIFT)
#define PORTA_OFS  0
#define PORTB_OFS  1
#define PORTC_OFS  2
#define PORTD_OFS  3
#define PORTE_OFS  4
#define PORTF_OFS  5
#define PORTG_OFS  6
#define PORTH_OFS  7
#define MAKE_GPIO_NUM(p, o) ((p << GPIO_PORT_SHIFTT) | (o << GPIO_OFS_SHIFT))
#define GRAB_MODE(x)  (((x) & GPIO_MODE_MASK) >> GPIO_MODE_SHIFT)
#define GRAB_PULLUP(x)  (((x) & GPIO_PULLUP_MASK) >> GPIO_PULLUP_SHIFT)
#define GRAB_PORT(x)  (((x) & GPIO_PORT_MASK) >> GPIO_PORT_SHIFTT)
#define GRAB_OFS(x)  (((x) & GPIO_OFS_MASK) >> GPIO_OFS_SHIFT)
                                        #set_gpio_ctrl(GPIO_MODE_OUT|GPIO_F6） 设
置相应GPIO位是输入还是输出
#define set_gpio_ctrl(x) /
 ({ GPCON(GRAB_PORT((x))) &= ~(0x3 << (GRAB_OFS((x))*2)); /
    GPCON(GRAB_PORT(x)) |= (GRAB_MODE(x) << (GRAB_OFS((x))*2)); /
    GPUP(GRAB_PORT((x))) &= ~(1 << GRAB_OFS((x))); /
    GPUP(GRAB_PORT((x))) |= (GRAB_PULLUP((x)) << GRAB_OFS((x))); })
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
#define set_gpioA_mode(x) /
 ({ GPCON(GRAB_PORT((x))) &= ~(0x1 << GRAB_OFS((x))); /
    GPCON(GRAB_PORT((x))) |= (GRAB_MODE((x)) << GRAB_OFS((x))); })
#define read_gpio_bit(x) ((GPDAT(GRAB_PORT((x))) & (1<<GRAB_OFS((x)))) >>
GRAB_OFS((x)))
#define read_gpio_reg(x) (GPDAT(GRAB_PORT((x)))
#define write_gpio_bit(x, v) /
 ({ GPDAT(GRAB_PORT((x))) &= ~(0x1 << GRAB_OFS((x))); /
    GPDAT(GRAB_PORT((x))) |= ((v) << GRAB_OFS((x))); })
#define write_gpio_reg(x, v) (GPDAT(GRAB_PORT((x))) = (v))
 
#define GPIO_A0    MAKE_GPIO_NUM(PORTA_OFS, 0)
#define GPIO_A1    MAKE_GPIO_NUM(PORTA_OFS, 1)
::::::::::::::::::::
#define GPIO_A21   MAKE_GPIO_NUM(PORTA_OFS, 21)
#define GPIO_A22   MAKE_GPIO_NUM(PORTA_OFS, 22)
#define GPIO_H0    MAKE_GPIO_NUM(PORTH_OFS, 0)
#define GPIO_H6    MAKE_GPIO_NUM(PORTH_OFS, 6)
::::::::::::::::::::
#define GPIO_H10   MAKE_GPIO_NUM(PORTH_OFS, 10)
#define GPIO_MODE_nXBACK  GPIO_MODE_ALT0
:::::::::::::::::::::;;;
#define GPIO_MODE_LCD_PWRDN  GPIO_MODE_ALT1
     第一个要明白的是GPCON(x)。GPACON-GPHCON为端口控制寄存器。其起始地趾为0x56000000
#define GPCON(x) __REG2(0x56000000, (x) * 0x10)       x的取值为0-7对应GPACON---GPHCON 的地址。
#define GPDAT(x) __REG2(0x56000004, (x) * 0x10)        #(此为GPADAT--GPHDAT 的一种表示)
#define GPUP(x) __REG2(0x56000008, (x) * 0x10)         也是一样的道理。
     第二个是 GPIO_OFS_SHIFT  GPIO_PORT_SHIFT  GPIO_PULLUP_SHIFT  GPIO_MODE_SHIFT
。s3c2410.h中是这样定义的：
#define GPIO_OFS_SHIFT          0                                  #define GPIO_OFS_MASK  0x000000ff
#define GPIO_PORT_SHIFTT     8        相对应              #define GPIO_PORT_MASK  0x0000ff00
#define GPIO_PULLUP_SHIFT 16                                  #define GPIO_PULLUP_MASK 0x00ff0000
#define GPIO_MODE_SHIFT      24                                 #define GPIO_MODE_MASK  0xff000000
他们的作用是什么呢,为什么要这样定义呢?我们都知道对硬件的初始化和操作有很大一部分是对其相对应的寄存器的操作。说白一点也就是对相应位置 0或1。s3c2410的寄存器是32位的，再来看一下set_gpio_ctrl(GPIO_MODE_OUT |  GPIO_H6)中的参数:GPIO_MODE_OUT |  GPIO_H6。它表示将端口组H的6端口设置成输出模式(MODE)。看一下参数命令的结构,这很重要,是突破点:这命令化成数值是32位的，高位为GPIO_MODE_OUT, 低位为GPIO_H6。那么GPIO_MODE_OUT和GPIO_H6又是什么呢,再看几个定义:
#define GPIO_MODE_IN       (0 << GPIO_MODE_SHIFT)
#define GPIO_MODE_OUT   (1 << GPIO_MODE_SHIFT)
#define GPIO_MODE_ALT0  (2 << GPIO_MODE_SHIFT)
#define GPIO_MODE_ALT1  (3 << GPIO_MODE_SHIFT)
#define GPIO_PULLUP_EN  (0 << GPIO_PULLUP_SHIFT)
#define GPIO_PULLUP_DIS  (1 << GPIO_PULLUP_SHIFT) 
###MODE_IN，MODE_OUT，MODE_  是表示端口的作用是输入输出还是另作它用。
#为什么要用0,1来左移呢?s3c2410数据手册告诉我们00表示输入01表示输出
#GPIO_MODE_SHIFT=24即把00或01搬到第24位去:  1  0000 0000 0000 0000 0000 0000
##或 0  0000 0000 0000 0000 0000 0000(这是用32位中的位24-31来表示端口的作用)
##那么命令中的GPIO_H6:即哪个端口组的哪个端口又是如何表示的?看看下面的
#define GPIO_OFS_SHIFT  0 
#define GPIO_PORT_SHIFTT 8       
#define GPIO_PULLUP_SHIFT 16
#define PORTA_OFS  0 ##和#define GPIO_MODE_SHIFT  24  看看,我们大致可以猜到:(这是这是用32位中的位16-23来表示要设置某个端口的上拉功能)
#define PORTB_OFS  1 ##(这是用32位中的位8-15来表示要设置哪一个端口组)
#define PORTC_OFS  2  ###(这是用32位中的位0-7来表示要设置一个端口组的哪一个端口)
#define PORTD_OFS  3  #那么类似GPIO_H6是如何构造的?看下面的宏定义,我们展开:
#define PORTE_OFS  4 #GPIO_H6=MAKE_GPIO_NUM(7, 6)
#define PORTF_OFS  5 #= ( (7<<8) | (6<<0))= ( 111 0000 0000  |  110)=111 0000 110
  
#define PORTG_OFS  6#看出程序把端口组A-H用0-7表示放在8-15位
#define PORTH_OFS  7##端口组中具体端口则放在0-7位

 

#MAKE_GPIO_NUM(p, o)这个宏就是构造这样的
#define MAKE_GPIO_NUM(p, o) ((p << GPIO_PORT_SHIFTT) | (o << GPIO_OFS_SHIFT))
#define GPIO_H6    MAKE_GPIO_NUM(PORTH_OFS, 6)
       前面分析了参数命令的构造，那么如何解释命令呢?
#define GRAB_MODE(x)  (((x) & GPIO_MODE_MASK) >> GPIO_MODE_SHIFT)
#define GRAB_PULLUP(x)  (((x) & GPIO_PULLUP_MASK) >> GPIO_PULLUP_SHIFT)
#define GRAB_PORT(x)  (((x) & GPIO_PORT_MASK) >> GPIO_PORT_SHIFTT)
#define GRAB_OFS(x)  (((x) & GPIO_OFS_MASK) >> GPIO_OFS_SHIFT)
grab顾名思义，是抓取的意思。GRAB_MODE(x)是把命令的端口模式取出,得到的是一8位的值。GRAB_PORT(x)得到端口组，GRAB_OFS(x)得到端口号。
        最重要的已经分析完了，在回过头来看一下set_gpio_ctrl()
 #define set_gpio_ctrl(x) /
 ({ GPCON(GRAB_PORT((x))) &= ~(0x3 << (GRAB_OFS((x))*2)); /
    GPCON(GRAB_PORT(x)) |= (GRAB_MODE(x) << (GRAB_OFS((x))*2)); /
    GPUP(GRAB_PORT((x))) &= ~(1 << GRAB_OFS((x))); /
    GPUP(GRAB_PORT((x))) |= (GRAB_PULLUP((x)) << GRAB_OFS((x))); })       
 GPCON(GRAB_PORT((x)))   表示一个端口组的控制寄存器.
在控制寄存器里是用2位来表示去功能:0-1表示0端口,2-3表示1端口;;;;;
所以GRAB_OFS((x))*2 表示这个端口号是从寄存器的第几位开始.
GPCON(GRAB_PORT((x))) &= ~(0x3 << (GRAB_OFS((x))*2)); 表示把对应位清0.
以下类似,不一一表书.

一、GPIO寄存器定义

1．#define GPCON(x) __REG2(0x56000000, (x) * 0x10)

　　这句是定义2410的GPIO的控制寄存器，注意：__REG2的参数是寄存器的物理地址，这个物理地址经_REG2宏转换为虚拟地址，对照2410的手册可以得到一下对应关系：

GPCON（1） －－－－－－ PORT A 0x56000000
GPCON（2） －－－－－－ PORT B 0x56000010
GPCON（3） －－－－－－ PORT C 0x56000020
……
GPCON（8） －－－－－－ PORT H 0x56000070

2．#define GPDAT(x) __REG2(0x56000004, (x) * 0x10)

　这句是定义2410的GPIO的数据寄存器，定义方法同GPCON宏。

GPDAT（1） －－－－－－ PORT A 0x56000004
GPDAT（2） －－－－－－ PORT B 0x56000014
GPDAT（3） －－－－－－ PORT C 0x56000024
……
GPDAT（8） －－－－－－ PORT H 0x56000074

3．#define GPUP(x) __REG2(0x56000008, (x) * 0x10)

　　这句是定义2410的GPIO的上拉电阻屏蔽/激活寄存器，定义方法同GPCON宏。
GPUP（1） －－－－－－ PORT A 0x56000008
GPUP（2） －－－－－－ PORT B 0x56000018
GPUP（3） －－－－－－ PORT C 0x56000028
……
GPUP（8） －－－－－－ PORT H 0x56000078

二、GPIO端口号定义
　　以GPIO_G12来说明在内核头文件$(KERNEL_INCLUDE)/asm-arm/arch/s3c2410.h中是如何来定义IO port的端口号的。定义GPIO端口主要涉及到以下几个宏：

　　#define MAKE_GPIO_NUM(p, o) ( (p << GPIO_PORT_SHIFTT) | (o << GPIO_OFS_SHIFT))
　　#define GPIO_G12 MAKE_GPIO_NUM(PORTG_OFS, 12)

GPIO_PORT_SHIFTT值为8，代表GPIO组号在整个GPIO端口号（如GPIO_G12）字段中的位移
GPIO_OFS_SHIFT值为0，代表GPIO组内偏移号在整个GPIO端口号（如GPIO_G12）字段中的位移

s3c2410有117个多功能input/output port pins。分为以下八组：

— Port A (GPA): 23-output port #define PORTA_OFS 0
— Port B (GPB): 11-input/output port #define PORTB_OFS 1
— Port C (GPC): 16-input/output port #define PORTC_OFS 2
— Port D (GPD): 16-input/output port #define PORTD_OFS 3
— Port E (GPE): 16-input/output port #define PORTE_OFS 4
— Port F (GPF): 8-input/output port #define PORTF_OFS 5
— Port G (GPG): 16-input/output port #define PORTG_OFS 6
— Port H (GPH): 11-input/output port #define PORTH_OFS 7

　　GPG12属于G组，组内偏移为12，从上述两个宏定义中，我们可以很清楚地看出GPIO_G12结构：
　　　　　　　　　
　　　　　　　　　　　　　　　　　　　　　　　　　　　图1 GPIO端口号结构图
　　端口一共有8组，从上面的宏定义可以看出，端口组号p的范围：0～7。而组内偏移各组不尽相同，Port A有23个输出口，因此它的组内偏移o为0～22，Port G有16个IO口，它的组内偏移o为0～15，其他组的GPIO以此类推。

三、write_gpio_bit(x,v)宏分析
　　write_gpio_bit宏传入两个参数，第一个为GPIO端口号，如GPIO_G12；第二个参数为1或0，为相应IO口设置高电平或低电平输出。具体宏展开如下：
代码
#define write_gpio_bit(x, v)
({
GPDAT(GRAB_PORT((x))) &= ~(0x1 << GRAB_OFS((x)));
GPDAT(GRAB_PORT((x))) |= ((v) << GRAB_OFS((x)));
})


GRAB_PORT宏的参数是GPIO端口号，功能是从GPIO端口号中解析出组号，具体定义如下：

#define GRAB_PORT(x) (((x) & GPIO_PORT_MASK) >> GPIO_PORT_SHIFTT)

其中GPIO_PORT_MASK是组号的掩码，值为0x0000ff00,从图1中也可看出。

GRAB_OFS宏和GRAB_PORT类似，它的功能是从GPIO端口号中解析出组内偏移：

#define GRAB_OFS(x) (((x) & GPIO_OFS_MASK) >> GPIO_OFS_SHIFT)

其中偏移值掩码GPIO_OFS_MASK＝0x000000ff。

　　现在我们结合上述说明来分析write_gpio_bit(GPIO_G12,1)这条语句：由GPIO_G12的宏定义可计算出其值为0x0000060C，GRAB_PORT（GPIO_G12）解析得到所操作的IO属于G组，组号为6；GRAB_OFS（GPIO_G12）解析得到此IO口为G组的第12个引脚（从0开始算起），为GPG12，表达式值为12。则write_gpio_bit(GPIO_G12,1)等价于下面两条语句：

GPDAT(6) &= ~(0x1<<12); //GPGDAT寄存器第12位清零
GPDAT(6) | = 1<<12; // 向GPGDAT寄存器第12位写入‘1’

　　到此，我们知道了write_gpio_bit(GPIO_G12,1)这条语句是将GPG12这个引脚拉成高电平。

　　四、set_gpio_ctrl(x)宏分析完成了对write_gpio_bit宏的分析，现在来看set_gpio_ctrl就很简单了！在它的宏展开中只多了GRAB_MODE(x)和 GRAB_PULLUP(x)分别表示从参数x中解析出IO口的模式和使能/屏蔽此端口的上拉电阻。值得注意的是set_gpio_ctrl的参数x不仅仅表示GPIO端口号，其高16位还带有模式状态和上拉电阻控制信息，参数x的结构如下图：
　　　　　　
　　　　　　　　　　　　　　　　　　　　　图2 set_gpio_ctrl的参数字段结构图
　　低16位即为前面所述的GPIO的端口号，高16位中的R字段用来屏蔽/使能IO口的上拉电阻功能。R＝0，上拉电阻使能；R＝1，上拉电阻失效。M字段用来设置IO口的工作模式，M＝0，IO口为输入端口；M＝1，IO口为输出端口；M＝2，可选功能1；M＝3，可选功能2。

　　set_gpio_ctrl宏就是通过写相应GPIO所在组的GPXCON（X为A～H）的相应位来设置IO口模式（GPACON每一个位控制一个IO口，而GPBCON～GPHCON都是两个位控制一个IO口的模式），通过写GPXUP（X为A～H）来决定是否启用上拉电阻。典型的set_gpio_ctrl调用方式如下：

　　set_gpio_ctrl(GPIO_MODE_OUT | GPIO_PULLUP_DIS | GPIO_G12);

代码
#define set_gpio_ctrl(x)
({ GPCON(GRAB_PORT((x))) &= ~(0x3 << (GRAB_OFS((x))*2));
GPCON(GRAB_PORT(x)) |= (GRAB_MODE(x) << (GRAB_OFS((x))*2));
GPUP(GRAB_PORT((x))) &= ~(1 << GRAB_OFS((x)));
GPUP(GRAB_PORT((x))) |= (GRAB_PULLUP((x)) << GRAB_OFS((x))); })



　　这条语句是将GPG12设置成输出模式，并且不使用端口的上拉电阻。

五、结束
　　以上主要结合《S3C2410X 32-BIT RISC MICROPROCESSOR USER'S MANUAL》分析了$(LINUX_KERNEL_INCLUDE)/asm-arm/arch/s3c2410.h中所定义的对2410GPIO进行操作的几个宏，除了文中提及的几个宏，除此还有read_gpio_bit(x)、read_gpio_reg(x) 、write_gpio_reg(x, v)等，实现方法和上述类似，在此不再一一赘述