<9>编写硬件抽象层模块接口

转载来自：http://book.2cto.com/201210/6727.html

每一个硬件抽象层模块在内核中都对应有一个驱动程序，硬件抽象层模块就是通过这些驱动程序来访问硬件设备的，它们是通过读写设备文件来进行通信的。

硬件抽象层中的模块接口源文件一般保存在hardware/libhardware目录中。为了方便起见，我们将虚拟硬件设备freg在硬件抽象层中的模块名称定义为freg，它的目录结构如下：

~/Android/hardware/libhardware
----include
     ----hardware
          ----freg.h
Modules
     ----freg
          ----freg.cpp
          ----Android.mk

它由三个文件组成，其中，freg.h和freg.cpp是源代码文件，而Android.mk是模块的编译脚本文件。下面我们就分别介绍这三个文件的内容。

freg.h

01 #ifndef ANDROID_FREG_INTERFACE_H
02 #define ANDROID_FREG_INTERFACE_H
03
04 #include <hardware/hardware.h>
05
06 __BEGIN_DECLS
07
08 /*定义模块ID*/
09 #define FREG_HARDWARE_MODULE_ID "freg"
10
11 /*定义设备ID*/
12 #define FREG_HARDWARE_DEVICE_ID "freg"
13
14 /*自定义模块结构体*/
15 struct freg_module_t {
16         struct hw_module_t common;
17 };
18
19 /*自定义设备结构体*/
20 struct freg_device_t {
21         struct hw_device_t common;
22         int fd;
23         int (*set_val)(struct freg_device_t* dev, int val);
24         int (*get_val)(struct freg_device_t* dev, int* val);
25 };
26
27 __END_DECLS
28
29 #endif

这个文件中的常量和结构体都是按照硬件抽象层模块编写规范来定义的。宏FREG_HARDWARE_ MODULE_ID和FREG_HARDWARE_DEVICE_ID分别用来描述模块ID和设备ID。结构体freg_module_t用来描述自定义的模块结构体，它的第一个成员变量的类型为hw_module_t。结构体freg_device_t用来描述虚拟硬件设备freg，它的第一个成员变量的类型为freg_device_t。此外，结构体freg_device_t还定义了其他三个成员变量，其中，成员变量fd是一个文件描述符，用来描述打开的设备文件/dev/freg，成员变量set_val和get_val是函数指针，它们分别用来写和读虚拟硬件设备freg的寄存器val的内容。

freg.cpp

这是硬件抽象层模块freg的实现文件，我们分段来阅读。

文件首先包含相关头文件并且定义相关结构体变量。

01 #define LOG_TAG "FregHALStub"
02
03 #incl ude <hardware/hardware.h>
04 #include <hardware/freg.h>
05
06 #include <fcntl.h>
07 #include <errno.h>
08
09 #include <cutils/log.h>
10 #include <cutils/atomic.h>
11
12 #define DEVICE_NAME "/dev/freg"
13 #define MODULE_NAME "Freg"
14 #define MODULE_AUTHOR "shyluo@gmail.com"
15
16 /*设备打开和关闭接口*/
17 static int freg_device_open(const struct hw_module_t* module, const char* id, struct hw_device_t** device);
18 stati c int freg_device_close(struct hw_device_t* device);
19
20 /*设备寄存器读写接口*/
21 static int freg_get_val(struct freg_device_t* dev, int* val);
22 static int freg_set_val(struct freg_device_t* dev, int val);
23
24 /*定义模块操作方法结构体变量*/
25 static struct hw_module_methods_t freg_module_methods = {
26         open: freg_device_open
27 };
28
29 /*定义模块结构体变量*/
30 struct freg_module_t HAL_MODULE_INFO_SYM = {
31         common: {
32                 tag: HARDWARE_MODULE_TAG,
33                 version_major: 1,
34                 version_minor: 0,
35                 id: FREG_HARDWARE_MODULE_ID,
36                 name: MODULE_NAME,
37                 author: MODULE_AUTHOR,
38                 methods: &freg_module_methods,
39         }
40 };

在这段代码中，最值得关注的就是模块变量HAL_MODULE_INFO_SYM的定义。按照硬件抽象层模块编写规范，每一个硬件抽象层模块必须导出一个名称为HAL_MODULE_INFO_SYM的符号，它指向一个自定义的硬件抽象层模块结构体，而且它的第一个类型为hw_module_t的成员变量的tag值必须设置为HARDWARE_MODULE_TAG。除此之外，还初始化了这个硬件抽象层模块结构体的版本号、ID、名称、作者和操作方法列表等。

虚拟硬件设备freg的打开和关闭分别由函数freg_device_open和freg_device_close来实现，如下所示。

41 static int freg_device_open(const struct hw_module_t* module, const char* id, struct hw_device_t** device) {
42         if(!strcmp(id, FREG_HARDWARE_DEVICE_ID)) {
43                 struct freg_device_t* dev;
44
45                 dev = (struct freg_device_t*)malloc(sizeof(struct freg_device_t));
46                 if(!dev) {
47                         LOGE("Failed to alloc space for freg_device_t.");
48                         return -EFAULT;
49                 }
50
51                 memset(dev, 0, sizeof(struct freg_device_t));
52
53                 dev->common.tag = HARDWARE_DEVICE_TAG;
54                 dev->common.version = 0;
55                 dev->common.module = (hw_module_t*)module;
56                 dev->common.close = freg_device_close;
57                 dev->set_val = freg_set_val;
58                 de v->get_val = freg_get_val;
59
60                 if((dev->fd = open(DEVICE_NAME, O_RDWR)) == -1) {
61                         LOGE("Failed to open device file /dev/freg -- %s.", strerror(errno));
62                         free(dev);
63                         return -EFAULT;
64                 }
65
66                 *device = &(dev->common);
67
68                 LOGI("Open device file /dev/freg successf ully.");
69
70                 return 0;
71         }
72
73         return -EFAULT;
74 }
75
76 static int freg_device_close(struct hw_device_t* device) {
77         struct freg_device_t* freg_device = (struct freg_device_t*)device;
78         if(freg_device) {
79                 close(freg_device->fd);
80                 free(freg_device);
81         }
82
83         return 0;
84 ｝

前面提到，一个硬件抽象层模块可能会包含多个硬件设备，而这些硬件设备的打开操作都是由函数freg_device_open来完成的，因此，函数freg_device_open会根据传进来的参数id来判断要打开哪一个硬件设备。

在硬件抽象层模块freg中，只有一个虚拟硬件设备freg，它使用结构体freg_device_t来描述。因此，函数freg_device_open发现参数id与虚拟硬件设备freg的ID值匹配以后，就会分配一个freg_device_t结构体，并且对它的成员变量进行初始化。按照硬件抽象层模块编写规范，硬件抽象层中的硬件设备标签（dev->common.tag）必须设置为HARDWARE_DEVICE_TAG。除此之外，我们还将虚拟硬件设备freg的关闭函数设置为freg_device_close，并且将它的读写函数设置为freg_get_val和freg_set_val。

初始化完成用来描述虚拟硬件设备freg的结构体freg_device_t之后，我们就可以调用open函数来打开虚拟硬件设备文件/dev/freg了，并且将得到的文件描述符保存在结构体freg_device_t的成员变量fd中。

虚拟硬件设备freg的关闭函数freg_device_close的实现比较简单，它主要是关闭设备文件/dev/freg，以及释放设备在打开时所分配的资源。

虚拟硬件设备freg的读写函数freg_get_val和freg_set_val的实现如下所示。

85 static int freg_get_val(struct freg_device_t* dev, int* val) {
86         if(!dev) {
87                 LOGE("Null dev pointer.");
88                 return -EFAULT;
89         }
90
91         if(!val) {
92                 LOGE("Null val pointer.");
93                 return -EFAULT;
94         }
95
96         read(dev->fd, val, sizeof(*val));
97
98         LOGI("Get value %d from device file  /dev/freg.", *val);
99
100         return 0;
101 }
102
103 static int freg_set_val(struct freg_device_t* dev, int val) {
104         if(!dev) {
105                 LOGE("Null dev pointer.");
106                 return -EFAULT;
107         }
108
109         LOGI("Set value %d to device file /dev/freg.", val);
110         write(dev->fd, &val, sizeof(val));
111
112         return 0;
113 }

这两个函数分别通过调用read和write函数来实现读写虚拟硬件设备freg的寄存器val的内容。

Andr oid.mk

1 LOCAL_PATH  := $(call my-dir)
2 include $(CLEAR_VARS)
3 LOCAL_MODULE_TAGS := optional
4 LOCAL_PRELINK_MODULE := false
5 LOCAL_MODULE_PATH := $(TARGET_OUT_SHARED_LIBRARIES)/hw
6 LOCAL_SHARED_LIBRARIES := liblog
7 LOCAL_SRC_FILES := freg.cpp
8 LOCAL_MODULE := freg.default
9 include $(BUILD_SHARED_LIBRARY)

这是硬件抽象层模块freg的编译脚本文件。第9行指定include命令的参数为$(BUILD_SHARED_LIBRARY)，表示要将该硬件抽象层模块编译成一个动态链接库文件，名称为freg.default，并且保存在$(TARGET_OUT_SHARED_LIBRARIES)/hw目录下，即out/target/product/generic/system/lib/hw目录下。

  注意

我们将硬件抽象层模块freg对应的文件名称定义为freg.default，编译成功后，系统就会自动在后面加后缀.so，于是就得到了一个freg.default.so文件。根据硬件抽象层模块文件的命名规范，当我们要加载硬件抽象层模块freg时，只需要指定它的ID值，即“freg”，系统就会根据一定的规则成功地找到要加载的freg.default.so文件。

硬件抽象层模块freg的所有文件都准备好之后，我们就可以执行mmm命令对它进行编译和打包了。

USER@MACHINE:~/Android$ mmm ./hardware/libhardware/freg/
USER@MACHINE:~/Android$ make snod

最终就可以在out/target/product/generic/system/lib/hw目录下得到一个freg.default.so文件。