1# 平台驱动移植
2
3
4在这一步，我们会在源码目录`//device/vendor_name/soc_name/drivers`目录下创建平台驱动，如果你要移植的SOC的厂商还没有创建仓库的话，请联系[sig_devboard](https://gitee.com/openharmony/community/blob/master/sig/sig_devboard/sig_devboard_cn.md)创建。
5
6
7建议的目录结构：
8
9```
10device
11├── vendor_name
12│   ├── drivers
13│   │   │   ├── common
14│   │   │   ├── Kconfig # 厂商驱动内核菜单入口
15│   │   │   └── lite.mk # 构建的入口
16│   ├── soc_name
17│   │   ├── drivers
18│   │   │   ├── dmac
19│   │   │   ├── gpio
20│   │   │   ├── i2c
21│   │   │   ├── LICENSE
22│   │   │   ├── mipi_dsi
23│   │   │   ├── mmc
24│   │   │   ├── pwm
25│   │   │   ├── README.md # docs 如果需要的话
26│   │   │   ├── README_zh.md
27│   │   │   ├── rtc
28│   │   │   ├── spi
29│   │   │   ├── uart
30│   │   │   └── watchdog
31│   ├── board_name
32```
33
34HDF为所有的平台驱动都创建了驱动模型，移植平台驱动的主要工作是向模型注入实例。 这些模型你可以在源码目录`//drivers/hdf_core/framework/support/platform/include`中找到定义。
35
36
37本节我们会以GPIO为例，讲解如何移植平台驱动，移植过程包含以下步骤：
38
39
401. 创建GPIO驱动
41
42   在源码目录`//device/vendor_name/soc_name/drivers/gpio`中创建文件`soc_name_gpio.c`。内容模板如下：
43
44   ```
45   #include "gpio_core.h"
46
47   // 定义GPIO结构体，如果需要的话
48   struct SocNameGpioCntlr {
49       struct GpioCntlr cntlr;  // 这是HDF GPIO驱动框架需要的结构体
50       int myData; // 以下是当前驱动自身需要的
51   };
52
53   // Bind 方法在HDF驱动中主要用户对外发布服务，这里我们不需要，直接返回成功即可
54   static int32_t GpioBind(struct HdfDeviceObject *device)
55   {
56       (void)device;
57       return HDF_SUCCESS;
58   }
59
60   // Init方法时驱动初始化的入口，我们需要在Init方法中完成模型实例的注册
61   static int32_t GpioInit(struct HdfDeviceObject *device)
62   {
63       SocNameGpioCntlr *impl = CreateGpio(); // 你的创建代码
64       ret = GpioCntlrAdd(&impl->cntlr);  // 注册GPIO模型实例
65       if (ret != HDF_SUCCESS) {
66           HDF_LOGE("%s: err add controller:%d", __func__, ret);
67           return ret;
68       }
69       return HDF_SUCCESS;
70   }
71
72   // Release方法会在驱动卸载时被调用，这里主要完成资源回收
73   static void GpioRelease(struct HdfDeviceObject *device)
74   {
75       // GpioCntlrFromDevice 方法能从抽象的设备对象中获得init方法注册进去的模型实例。
76       struct GpioCntlr *cntlr = GpioCntlrFromDevice(device);
77       //资源释放...
78   }
79
80   struct HdfDriverEntry g_gpioDriverEntry = {
81       .moduleVersion = 1,
82       .Bind = GpioBind,
83       .Init = GpioInit,
84       .Release = GpioRelease,
85       .moduleName = "SOC_NAME_gpio_driver", // 这个名字我们稍后会在配置文件中用到，用来加载驱动。
86   };
87   HDF_INIT(g_gpioDriverEntry); // 注册一个GPIO的驱动入口
88   ```
89
902. 创建厂商驱动构建入口
91
92   如前所述`device/vendor_name/drivers/lite.mk`是厂商驱动的构建的入口。我们需要从这个入口开始，进行构建。
93
94
95   ```
96   #文件device/vendor_name/drivers/lite.mk
97
98   SOC_VENDOR_NAME := $(subst $/",,$(LOSCFG_DEVICE_COMPANY))
99   SOC_NAME := $(subst $/",,$(LOSCFG_PLATFORM))
100   BOARD_NAME := $(subst $/",,$(LOSCFG_PRODUCT_NAME))
101
102   # 指定SOC进行构建
103   LIB_SUBDIRS += $(LITEOSTOPDIR)/../../device/$(SOC_VENDOR_NAME)/$(SOC_NAME)/drivers/
104   ```
105
1063. 创建SOC驱动构建入口
107
108   ```
109   #文件device/vendor_name/soc_name/drivers/lite.mk
110
111   SOC_DRIVER_ROOT := $(LITEOSTOPDIR)/../../device/$(SOC_VENDOR_NAME)/$(SOC_NAME)/drivers/
112
113   # 判断如果打开了GPIO的内核编译开关
114   ifeq ($(LOSCFG_DRIVERS_HDF_PLATFORM_GPIO), y)
115       # 构建完成要链接一个叫hdf_gpio的对象
116       LITEOS_BASELIB += -lhdf_gpio
117       # 增加构建目录gpio
118       LIB_SUBDIRS    += $(SOC_DRIVER_ROOT)/gpio
119   endif
120
121   # 后续其他驱动在此基础上追加
122   ```
123
1244. 创建GPIO构建入口
125
126
127   ```
128   include $(LITEOSTOPDIR)/config.mk
129   include $(LITEOSTOPDIR)/../../drivers/adapter/khdf/liteos/lite.mk
130
131   # 指定输出对象的名称，注意要与SOC驱动构建入口里的LITEOS_BASELIB 保持一致
132   MODULE_NAME := hdf_gpio
133
134   # 增加HDF框架的INCLUDE
135   LOCAL_CFLAGS += $(HDF_INCLUDE)
136
137   # 要编译的文件
138   LOCAL_SRCS += soc_name_gpio.c
139
140   # 编译参数
141   LOCAL_CFLAGS += -fstack-protector-strong -Wextra -Wall -Werror -fsigned-char -fno-strict-aliasing -fno-common
142
143   include $(HDF_DRIVER)
144   ```
145
1465. 配置产品加载驱动
147
148   产品的所有设备信息被定义在源码文件`//vendor/vendor_name/product_name/config/device_info/device_info.hcs`中。
149
150   平台驱动请添加到platform的host中。
151
152   > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
153   > moduleName要与驱动定义中的相同。
154
155
156   ```
157   root {
158       ...
159       platform :: host {
160           device_gpio :: device {
161                   device0 :: deviceNode {
162                       policy = 0;
163                       priority = 10;
164                       permission = 0644;
165                       moduleName = "SOC_NAME_gpio_driver";
166                   }
167           }
168       }
169   }
170   ```
171
172