1)实验平台：正点原子Linux开发板

2)

摘自《正点原子

I.MX6U嵌入式Linux驱动开发指南

》

关注官方微信号公众号，获取更多资料：正点原子

第五十六章Linux自带的LED灯驱动实验

前面我们都是自己编写LED灯驱动，其实像LED灯这样非常基础的设备驱动，Linux内核已经集成了。Linux内核的LED灯驱动采用platform框架，因此我们只需要按照要求在设备树文件中添加相应的LED节点即可，本章我们就来学习如何使用Linux内核自带的LED驱动来驱动I.MX6U-ALPHA开发板上的LED0。

56.1 Linux内核自带LED驱动使能

上一章节我们编写基于设备树的platform LED灯驱动，其实Linux内核已经自带了LED灯驱动，要使用Linux内核自带的LED灯驱动首先得先配置Linux内核，使能自带的LED灯驱动，输入如下命令打开Linux配置菜单：

makemenuconfig

按照如下路径打开LED驱动配置项：

-> Device Drivers

-> LED Support (NEW_LEDS [=y])

->LED Support for GPIO connected LEDs

按照上述路径，选择”LED Support for GPIO connected LEDs”，将其编译进Linux内核，也即是在此选项上按下”Y”键，使此选项前面变为””，如图56.1.1所示：

图56.1.1 使能LED灯驱动

在”LED Support for GPIO connected LEDs”上按下可以打开此选项的帮助信息，如图56.1.2所示：

图56.1.2 内部LED灯驱动帮助信息

从图56.1.2可以看出，把Linux内部自带的LED灯驱动编译进内核以后，CONFIG_LEDS_GPIO就会等于’y’，Linux会根据CONFIG_LEDS_GPIO的值来选择如何编译LED灯驱动，如果为’y’就将其编译进Linux内核。

配置好Linux内核以后退出配置界面，打开.config文件，会找到”CONFIG_LEDS_GPIO=y”这一行，如图56.1.3所示：

图56.1.3.config文件内容

重新编译Linux内核，然后使用新编译出来的zImage镜像启动开发板。

56.2 Linux内核自带LED驱动简介

56.2.1 LED灯驱动框架分析

LED灯驱动文件为/drivers/leds/leds-gpio.c，大家可以打开/drivers/leds/Makefile这个文件，找到如下所示内容：

示例代码56.2.1.1 /drivers/leds/Makefile文件代码段

2 # LED Core

3 obj

–

$

(

CONFIG_NEW_LEDS

)

+=

led

–

core

.

o

…..

23 obj

–

$

(

CONFIG_LEDS_GPIO_REGISTER

)

+=

leds-gpio-register.o

24 obj-$(CONFIG_LEDS_GPIO) += leds-gpio.o

25 obj

–

$

(

CONFIG_LEDS_LP3944

)

+=

leds

–

lp3944

.

o

……

第25行，如果定义了CONFIG_LEDS_GPIO的话就会编译leds-gpio.c这个文件，在上一小节我们选择将LED驱动编译进Linux内核，在.config文件中就会有”CONFIG_LEDS_GPIO=y”这一行，因此leds-gpio.c驱动文件就会被编译。

接下来我们看一下leds-gpio.c这个驱动文件，找到如下所示内容：

示例代码56.2.1.2 leds-gpio.c文件代码段

236staticconststruct of_device_id of_gpio_leds_match

[]={

237

{.

compatible

=

“gpio-leds”

,},

238

{},

239

};

……

290staticstruct platform_driver gpio_led_driver

={

291

.

probe

=

gpio_led_probe

,

292

.

remove

=

gpio_led_remove

,

293

.

driver

={

294

.

name

=

“leds-gpio”

,

295

.

of_match_table

=

of_gpio_leds_match

,

296

},

297

};

298

299 module_platform_driver

(

gpio_led_driver

);

第236~239行，LED驱动的匹配表，此表只有一个匹配项，compatible内容为”gpio-leds”，因此设备树中的LED灯设备节点的compatible属性值也要为”gpio-leds”，否则设备和驱动匹配不成功，驱动就没法工作。

第290~296行，platform_driver驱动结构体变量，可以看出，Linux内核自带的LED驱动采用了platform框架。第291行可以看出probe函数为gpio_led_probe，因此当驱动和设备匹配成功以后gpio_led_probe函数就会执行。从294行可以看出，驱动名字为”leds-gpio”，因此会在/sys/bus/platform/drivers目录下存在一个名为”leds-gpio”的文件，如图56.2.1.1所示：

图56.2.1.1 leds-gpio驱动文件

第299行通过module_platform_driver函数向Linux内核注册gpio_led_driver这个platform驱动。

56.2.2 module_platform_driver函数简析

在上一小节中我们知道LED驱动会采用module_platform_driver函数向Linux内核注册platform驱动，其实在Linux内核中会大量采用module_platform_driver来完成向Linux内核注册platform驱动的操作。module_platform_driver定义在include/linux/platform_device.h文件中，为一个宏，定义如下：

示例代码56.2.2.1 module_platform_driver函数

221 #define module_platform_driver

(

__platform_driver

)

222 module_driver

(

__platform_driver

,

platform_driver_register

,

223 platform_driver_unregister

)

可以看出，module_platform_driver依赖module_driver，module_driver也是一个宏，定义在include/linux/device.h文件中，内容如下：

示例代码56.2.2.2 module_driver函数

1260 #define module_driver

(

__driver

,

__register

,

__unregister

,…)

1261staticint __init __driver##_init

(

void

)

1262

{

1263

return

__register

(&(

__driver

),

##__VA_ARGS__

);

1264

}

1265 module_init

(

__driver##_init

);

1266staticvoid __exit __driver##_exit

(

void

)

1267

{

1268 __unregister

(&(

__driver

),

##__VA_ARGS__

);

1269

}

1270 module_exit

(

__driver##_exit

);

借助示例代码56.2.2.1和示例代码56.2.2.2，将：

module_platform_driver(gpio_led_driver)

展开以后就是：

static int __init gpio_led_driver_init(void)

{

return platform_driver_register (&(gpio_led_driver));

}

module_init(gpio_led_driver_init);

static void __exit gpio_led_driver_exit(void)

{

platform_driver_unregister (&(gpio_led_driver) );

}

module_exit(gpio_led_driver_exit);

上面的代码不就是标准的注册和删除platform驱动吗？因此module_platform_driver函数的功能就是完成platform驱动的注册和删除。

56.2.3 gpio_led_probe函数简析

当驱动和设备匹配以后gpio_led_probe函数就会执行，此函数主要是从设备树中获取LED灯的GPIO信息，缩减后的函数内容如下所示：

示例代码56.2.3.1 gpio_led_probe函数

243staticint gpio_led_probe

(

struct platform_device

*

pdev

)

244

{

245struct gpio_led_platform_data

*

pdata

=

dev_get_platdata

(&

pdev

->

dev

);

246struct gpio_leds_priv

*

priv

;

247int i

,

ret

=

0

;

248

249

if(

pdata

&&

pdata

->

num_leds

){

/* 非设备树方式 */

/* 获取platform_device信息 */

……

268

}else{

/* 采用设备树 */

269 priv = gpio_leds_create(pdev);

270if(IS_ERR(priv))

271return PTR_ERR(priv);

272

}

273

274 platform_set_drvdata

(

pdev

,

priv

);

275

276

return

0

;

277

}

第269~271行，如果使用设备树的话，使用gpio_leds_create函数从设备树中提取设备信息，获取到的LED灯GPIO信息保存在返回值中，gpio_leds_create函数内容如下：

示例代码56.2.3.2 gpio_leds_create函数

167staticstruct gpio_leds_priv

*

gpio_leds_create

(

struct

platform_device

*

pdev

)

168

{

169struct device

*

dev

=&

pdev

->

dev

;

170struct fwnode_handle

*

child

;

171struct gpio_leds_priv

*

priv

;

172int count

,

ret

;

173struct device_node

*

np

;

174

175 count = device_get_child_node_count(dev);

176

if(!

count

)

177

return

ERR_PTR

(-

ENODEV

);

178

179 priv

=

devm_kzalloc

(

dev

,

sizeof_gpio_leds_priv

(

count

),

GFP_KERNEL

);

180

if(!

priv

)

181

return

ERR_PTR

(-

ENOMEM

);

182

183 device_for_each_child_node(dev, child){

184struct gpio_led led

={};

185constchar

*

state

=NULL;

186

187 led.gpiod = devm_get_gpiod_from_child(dev,NULL, child);

188

if(

IS_ERR

(

led

.

gpiod

)){

189 fwnode_handle_put

(

child

);

190 ret

=

PTR_ERR

(

led

.

gpiod

);

191

goto

err

;

192

}

193

194 np

=

of_node

(

child

);

195

196if(fwnode_property_present(child,”label”)){

197 fwnode_property_read_string(child,”label”,&led.name);

198

}else{

199

if(

IS_ENABLED

(

CONFIG_OF

)&&!

led

.

name

&&

np

)

200 led

.

name

=

np

->

name

;

201

if(!

led

.

name

)

202

return

ERR_PTR

(-

EINVAL

);

203

}

204 fwnode_property_read_string(child,”linux,default-trigger”,

205&led.default_trigger);

206

207if(!fwnode_property_read_string(child,”default-state”,

208&state)){

209if(!strcmp(state,”keep”))

210 led.default_state = LEDS_GPIO_DEFSTATE_KEEP;

211elseif(!strcmp(state,”on”))

212 led.default_state = LEDS_GPIO_DEFSTATE_ON;

213else

214 led.default_state = LEDS_GPIO_DEFSTATE_OFF;

215}

216

217

if(

fwnode_property_present

(

child

,

“retain-state-suspended”

))

218 led

.

retain_state_suspended

=

1

;

219

220 ret = create_gpio_led(&led,&priv->leds[priv->num_leds++],

221 dev,NULL);

222

if(

ret

<

0

){

223 fwnode_handle_put

(

child

);

224

goto

err

;

225

}

226

}

227

228

return

priv

;

229

230 err

:

231

for(

count

=

priv

->

num_leds

–

2

;

count

>=

0

;

count

–)

232 delete_gpio_led

(&

priv

->

leds

[

count

]);

233

return

ERR_PTR

(

ret

);

234

}

第175行，调用device_get_child_node_count函数统计子节点数量，一般在在设备树中创建一个节点表示LED灯，然后在这个节点下面为每个LED灯创建一个子节点。因此子节点数量也是LED灯的数量。

第183行，遍历每个子节点，获取每个子节点的信息。

第187行，获取LED灯所使用的GPIO信息。

第196~197行，读取子节点label属性值，因为使用label属性作为LED的名字。

第204~205行，获取”linux,default-trigger”属性值，可以通过此属性设置某个LED灯在Linux系统中的默认功能，比如作为系统心跳指示灯等等。

第207~215行，获取”default-state”属性值，也就是LED灯的默认状态属性。

第220行，调用create_gpio_led函数创建LED相关的io，其实就是设置LED所使用的io为输出之类的。create_gpio_led函数主要是初始化led_dat这个gpio_led_data结构体类型变量，led_dat保存了LED的操作函数等内容。

关于gpio_led_probe函数就分析到这里，gpio_led_probe函数主要功能就是获取LED灯的设备信息，然后根据这些信息来初始化对应的IO，设置为输出等。

56.3 设备树节点编写

打开文档Documentation/devicetree/bindings/leds/leds-gpio.txt，此文档详细的讲解了Linux自带驱动对应的设备树节点该如何编写，我们在编写设备节点的时候要注意一下几点：

①、创建一个节点表示LED灯设备，比如dtsleds，如果板子上有多个LED灯的话每个LED灯都作为dtsleds的子节点。

②、dtsleds节点的compatible属性值一定要为”gpio-leds”。

③、设置label属性，此属性为可选，每个子节点都有一个label属性，label属性一般表示LED灯的名字，比如以颜色区分的话就是red、green等等。

④、每个子节点必须要设置gpios属性值，表示此LED所使用的GPIO引脚！

⑤、可以设置”linux,default-trigger”属性值，也就是设置LED灯的默认功能，可以查阅Documentation/devicetree/bindings/leds/common.txt这个文档来查看可选功能，比如：

backlight：

LED灯作为背光。

default-on

：LED灯打开

heartbeat：

LED灯作为心跳指示灯，可以作为系统运行提示灯。

ide-disk：

LED灯作为硬盘活动指示灯。

timer：

LED灯周期性闪烁，由定时器驱动，闪烁频率可以修改

⑥、可以设置”default-state”属性值，可以设置为on、off或keep，为on的时候LED灯默认打开，为off的话LED灯默认关闭，为keep的话LED灯保持当前模式。

根据上述几条要求在imx6ull-alientek-emmc.dts中添加如下所示LED灯设备节点：

示例代码56.3.1 dtsleds设备节点

1 dtsleds

{

2 compatible

=

“gpio-leds”

;

4 led0

{

5 label

=

“red”

;

6 gpios

=gpio1 3 GPIO_ACTIVE_LOW

>;

7 default-state

=

“off”

;

8

};

9

};

因为I.MX6U-ALPHA开发板只有一个LED0，因此在dtsleds这个节点下只有一个子节点led0，LED0名字为red，默认关闭。修改完成以后保存并重新编译设备树，然后用新的设备树启动开发板。

56.4 运行测试

用新的zImage和imx6ull-alientek-emmc.dtb启动开发板，启动以后查看/sys/bus/platform/devices/dtsleds这个目录是否存在，如果存在的话就如到此目录中，如图56.4.1所示：

图56.4.1 dtsleds目录

进入到leds目录中，此目录中的内容如图56.4.2所示：

图56.4.2 leds目录内容

从图56.4.2可以看出，在leds目录下有一个名为”red”子目录，这个子目录的名字就是我们在设备树中第5行设置的label属性值。

我们的设置究竟有没有用，最终是要通过测试才能知道的，首先查看一下系统中有没有”sys/class/leds/red/brightness”这个文件，如果有的话就输入如下命令打开RED这个LED灯：

echo 1 > sys/class/leds/red/brightness //打开LED0

关闭RED这个LED灯的命令如下：

echo 0 > sys/class/leds/red/brightness //关闭LED0

如果能正常的打开和关闭LED灯话就说明我们Linux内核自带的LED灯驱动工作正常。我们一般会使用一个LED灯作为系统指示灯，系统运行正常的话这个LED指示灯就会一闪一闪的。里我们设置LED0作为系统指示灯，在dtsleds这个设备节点中加入”linux,default-trigger”属性信息即可，属性值为”heartbeat”，修改完以后的dtsleds节点内容如下：

示例代码56.3.2 dtsleds设备节点