1# 平台驱动开发示例<a name="ZH-CN_TOPIC_0000001157064271"></a> 2 3## 概述<a name="section194201316174215"></a> 4 5本文档将以I2C驱动为例，介绍如何基于HDF驱动框架完成平台驱动开发。 6 7> **注意：** 8>本例仅作为平台驱动开发示例参考，开发者不可直接用于商用集成。 9 10HDF驱动框架为常用外围设备提供了标准的驱动框架，驱动开发者只需将驱动适配至HDF驱动框架，即可通过HDF驱动框架提供的接口操作外围设备。 11 12本文以I2C为例。其时序流程如[图1](#fig9596628607)所示。 13 14**图 1** I2C时序流程图<a name="fig9596628607"></a> 15 16 17 18## 环境准备<a name="section6926133918422"></a> 19 20环境准备具体操作请参考[Hi3516标准系统入门](../quick-start/quickstart-appendix-hi3516-ide.md)完成环境搭建。 21 22> **须知：** 23>本示例针对OpenHarmony轻量系统、小型系统、标准系统都适用，本文以标准系统为例。其他系统的开发者可参考对应系统的指导文档进行环境搭建。 24 25## 开发<a name="section65801539470"></a> 26 27### 文件说明<a name="section0708184454414"></a> 28 29本例中涉及的文件及路径如下表： 30 31**表 1** 文件说明 32 33<a name="table15887645104012"></a> 34<table><thead align="left"><tr id="row198881452404"><th class="cellrowborder" align="center" valign="top" width="13.489999999999998%" id="mcps1.2.4.1.1"><p id="p158742406488"><a name="p158742406488"></a><a name="p158742406488"></a>说明</p> 35</th> 36<th class="cellrowborder" align="center" valign="top" width="68.52000000000001%" id="mcps1.2.4.1.2"><p id="p6975142717432"><a name="p6975142717432"></a><a name="p6975142717432"></a>文件路径</p> 37</th> 38<th class="cellrowborder" align="center" valign="top" width="17.990000000000002%" id="mcps1.2.4.1.3"><p id="p98891454405"><a name="p98891454405"></a><a name="p98891454405"></a>操作</p> 39</th> 40</tr> 41</thead> 42<tbody><tr id="row1088914458407"><td class="cellrowborder" align="left" valign="top" width="13.489999999999998%" headers="mcps1.2.4.1.1 "><p id="p78741540104813"><a name="p78741540104813"></a><a name="p78741540104813"></a>示例文件</p> 43</td> 44<td class="cellrowborder" align="left" valign="top" width="68.52000000000001%" headers="mcps1.2.4.1.2 "><p id="p1066541692916"><a name="p1066541692916"></a><a name="p1066541692916"></a>/drivers/adapter/khdf/linux/platform/i2c/i2c_sample.c</p> 45</td> 46<td class="cellrowborder" align="left" valign="top" width="17.990000000000002%" headers="mcps1.2.4.1.3 "><p id="p208891445144012"><a name="p208891445144012"></a><a name="p208891445144012"></a>新增文件</p> 47</td> 48</tr> 49<tr id="row1388984594013"><td class="cellrowborder" align="left" valign="top" width="13.489999999999998%" headers="mcps1.2.4.1.1 "><p id="p88741840104811"><a name="p88741840104811"></a><a name="p88741840104811"></a>设备服务文件</p> 50</td> 51<td class="cellrowborder" align="left" valign="top" width="68.52000000000001%" headers="mcps1.2.4.1.2 "><p id="p486417183298"><a name="p486417183298"></a><a name="p486417183298"></a>/drivers/adapter/khdf/linux/hcs/device_info/device_info.hcs</p> 52</td> 53<td class="cellrowborder" rowspan="3" align="left" valign="top" width="17.990000000000002%" headers="mcps1.2.4.1.3 "><p id="p128898458401"><a name="p128898458401"></a><a name="p128898458401"></a></p> 54<p id="p168904455404"><a name="p168904455404"></a><a name="p168904455404"></a>追加内容</p> 55<p id="p7890124516405"><a name="p7890124516405"></a><a name="p7890124516405"></a></p> 56</td> 57</tr> 58<tr id="row9889164513406"><td class="cellrowborder" align="left" valign="top" headers="mcps1.2.4.1.1 "><p id="p138741640124812"><a name="p138741640124812"></a><a name="p138741640124812"></a>配置参数文件</p> 59</td> 60<td class="cellrowborder" align="left" valign="top" headers="mcps1.2.4.1.2 "><p id="p26905191293"><a name="p26905191293"></a><a name="p26905191293"></a>/drivers/adapter/khdf/linux/hcs/platform/i2c_config.hcs</p> 61</td> 62</tr> 63<tr id="row1189044513404"><td class="cellrowborder" align="left" valign="top" headers="mcps1.2.4.1.1 "><p id="p1687424074814"><a name="p1687424074814"></a><a name="p1687424074814"></a>编译文件</p> 64</td> 65<td class="cellrowborder" align="left" valign="top" headers="mcps1.2.4.1.2 "><p id="p1885032192917"><a name="p1885032192917"></a><a name="p1885032192917"></a>/drivers/adapter/khdf/linux/platform/i2c/Makefile</p> 66</td> 67</tr> 68<tr id="row10890144564011"><td class="cellrowborder" align="left" valign="top" width="13.489999999999998%" headers="mcps1.2.4.1.1 "><p id="p118752040104810"><a name="p118752040104810"></a><a name="p118752040104810"></a>依赖头文件</p> 69</td> 70<td class="cellrowborder" align="left" valign="top" width="68.52000000000001%" headers="mcps1.2.4.1.2 "><p id="p15821718182916"><a name="p15821718182916"></a><a name="p15821718182916"></a>/drivers/framework/include/core/hdf_device_desc.h</p> 71</td> 72<td class="cellrowborder" rowspan="2" align="left" valign="top" width="17.990000000000002%" headers="mcps1.2.4.1.3 "><p id="p989012451401"><a name="p989012451401"></a><a name="p989012451401"></a>作为头文件引用</p> 73<p id="p1890134594014"><a name="p1890134594014"></a><a name="p1890134594014"></a></p> 74</td> 75</tr> 76<tr id="row6890164564015"><td class="cellrowborder" align="left" valign="top" headers="mcps1.2.4.1.1 "><p id="p128756401484"><a name="p128756401484"></a><a name="p128756401484"></a>核心层头文件</p> 77</td> 78<td class="cellrowborder" align="left" valign="top" headers="mcps1.2.4.1.2 "><p id="p47681122152918"><a name="p47681122152918"></a><a name="p47681122152918"></a>/drivers/framework/support/platform/include/i2c_core.h</p> 79</td> 80</tr> 81<tr id="row1499682234817"><td class="cellrowborder" align="left" valign="top" width="13.489999999999998%" headers="mcps1.2.4.1.1 "><p id="p1187513403487"><a name="p1187513403487"></a><a name="p1187513403487"></a>HCS配置入口文件</p> 82</td> 83<td class="cellrowborder" align="left" valign="top" width="68.52000000000001%" headers="mcps1.2.4.1.2 "><p id="p499818225487"><a name="p499818225487"></a><a name="p499818225487"></a>/drivers/adapter/khdf/linux/hcs/hdf.hcs</p> 84</td> 85<td class="cellrowborder" align="left" valign="top" width="17.990000000000002%" headers="mcps1.2.4.1.3 "><p id="p3998152254820"><a name="p3998152254820"></a><a name="p3998152254820"></a>HCS配置文件总入口</p> 86</td> 87</tr> 88</tbody> 89</table> 90 91> **注意：** 92>本例程涉及的文件路径均作为演示，驱动开发者应根据实际情况确定具体的源文件存放位置。 93 94### 实例化驱动入口<a name="section85325864412"></a> 95 96实例化一个HdfDriverEntry 对象作为驱动入口。驱动入口必须为HdfDriverEntry（在hdf\_device\_desc.h中定义）类型的全局变量，且moduleName要和device\_info.hcs中保持一致。在加载驱动时HDF框架会先调用Bind函数，再调用Init函数加载该驱动，当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 97 98I2C驱动中没有实现Bind方法，因为I2C控制器由manager管理，而在manager中已经实现了Bind方法，因此I2C驱动中无需再绑定服务。 99 100实例化驱动入口的示例代码如下： 101 102``` 103/* 定义驱动入口的对象，必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量 */ 104struct HdfDriverEntry g_sampleI2cDriverEntry = { 105 .moduleVersion = 1, 106 .Init = SampleI2cInit, 107 .Release = SampleI2cRelease, 108 .moduleName = "demo_i2c_driver", 109}; 110/* 调用HDF_INIT将驱动入口注册到HDF框架中 */ 111HDF_INIT(g_sampleI2cDriverEntry); 112``` 113 114### 设置相关参数<a name="section8155172019453"></a> 115 116通过配置device\_info.hcs，并从HCS获取并解析设备的配置参数以确保驱动能够正确加载。 117 1181. 添加设备服务节点（必选）。 119 120 编辑device\_info.hcs，在device\_i2c :: device下添加驱动设备服务节点，示例如下： 121 122 ``` 123 root { 124 device_info { 125 match_attr = "hdf_manager"; 126 device_i2c :: device { // i2c设备节点 127 device2 :: deviceNode { // i2c驱动的DeviceNode节点 128 policy = 0; // policy字段是驱动服务发布的策略 129 priority = 55; // 驱动启动优先级 130 permission = 0644; // 驱动创建设备节点权限 131 moduleName = "demo_i2c_driver"; // 驱动名称，该字段的值必须和驱动入口结构的moduleName值一致 132 serviceName = "DEMO_I2C_DRIVER"; // 驱动对外发布服务的名称，必须唯一 133 deviceMatchAttr = "demo_i2c_config"; // 驱动私有数据匹配的关键字，必须和驱动私有数据配置表中的 134 // match_attr值相等 135 } 136 } 137 } 138 } 139 140 ``` 141 142 > **须知：** 143 >配置文件中的priority（取值范围为整数0到200）是用来表示host和驱动的优先级，不同的host内的驱动，host的priority值越小，驱动加载优先级越高；同一个host内驱动的priority值越小，加载优先级越高，驱动的priority值相同则不保证加载顺序。 144 1452. 添加配置参数（可选）。 146 147 有时驱动可能会需要私有配置信息，以确保寄存器的配置可以满足不同产品的需求。如需要私有配置信息，则可以添加一个驱动的配置文件，用来存放一些驱动的默认配置信息，HDF框架在加载驱动的时候，会将对应的配置信息获取并保存在HdfDeviceObject 中的property里面，通过Bind和Init（参考[驱动开发](../driver/driver-overview-foundation.md)）传递给驱动。驱动开发者可新建配置文件，并在板级驱动hdf.hcs中引用新建的配置文件，本例中直接在原有的配置文件i2c\_config.hcs内添加配置参数。 148 149 本例中编辑i2c\_config.hcs，添加配置参数： 150 151 ``` 152 root { 153 platform { 154 i2c_config_demo { 155 match_attr = "demo_i2c_config"; // 该字段的值必须和device_info.hcs中的deviceMatchAttr值一致 156 157 template i2c_controller { // 参数模板 158 bus = 0; 159 reg_pbase = 0x120b0000; 160 reg_size = 0xd1; 161 } 162 163 controller_demo_0 :: i2c_controller { // 两个I2C示例控制器 164 bus = 8; 165 } 166 controller_demo_1 :: i2c_controller { 167 bus = 9; 168 } 169 } 170 } 171 } 172 ``` 173 174 match\_attr字段必须与device\_info.hcs中的deviceMatch\_Attr保持一致，在此文件中配置驱动需要的参数，通过match\_attr可匹配至对应的驱动，该驱动即可在Bind或Init中调用DeviceResourceGetIfaceInstance\(\)函数获取这些配置参数。 175 176 若配置文件为新文件，则需要在板级配置入口文件hdf.hcs中引用该配置文件，例如： 177 178 ``` 179 #include "device_info/device_info.hcs" 180 #include "i2c/i2c_config.hcs" 181 ``` 182 183 由于本例中在原有的i2c\_config.hcs内添加配置参数，没有新建配置文件，因此无需再将i2c\_config.hcs添加至板级配置入口文件中。 184 1853. 驱动从HCS获取配置参数。 186 187 在本例中，驱动需要通过HCS获取寄存器物理基地址、寄存器大小、总线号等参数，从而对控制器进行正确配置。 188 189 ``` 190 /* 从HCS获取配置参数 */ 191 static int32_t SampleI2cReadDrs(struct SampleI2cCntlr *sampleCntlr, const struct DeviceResourceNode *node) 192 { 193 int32_t ret; 194 struct DeviceResourceIface *drsOps = NULL; 195 196 drsOps = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); 197 if (drsOps == NULL || drsOps->GetUint32 == NULL) { // 确保GetUint32方法可用 198 HDF_LOGE("%s: invalid drs ops fail!", __func__); 199 return HDF_FAILURE; 200 } 201 202 ret = drsOps->GetUint32(node, "reg_pbase", &sampleCntlr->regBasePhy, 0); // 从HCS读取物理基地址reg_pbase 203 if (ret != HDF_SUCCESS) { 204 HDF_LOGE("%s: read regBase fail!", __func__); 205 return ret; 206 } 207 208 ret = drsOps->GetUint16(node, "reg_size", &sampleCntlr->regSize, 0); // 从HCS读取寄存器大小reg_size 209 if (ret != HDF_SUCCESS) { 210 HDF_LOGE("%s: read regsize fail!", __func__); 211 return ret; 212 } 213 214 ret = drsOps->GetUint16(node, "bus", (uint16_t *)&sampleCntlr->bus, 0); // 从HCS读取总线号bus 215 if (ret != HDF_SUCCESS) { 216 HDF_LOGE("%s: read bus fail!", __func__); 217 return ret; 218 } 219 220 return HDF_SUCCESS; 221 } 222 ``` 223 224 225### 添加控制器<a name="section1335374114452"></a> 226 227初始化控制器硬件，并调用核心层接口完成向核心层添加、删除设备，以及钩子函数的实现等。 228 2291. 定义结构体，实现钩子函数并赋值至函数指针。 230 231 I2cMethod结构体在i2c\_core.h中定义，其中通过函数指针的方式定义了I2C需要实现的方法，transfer方法为用于传输的钩子函数，在驱动中需要做具体实现并对函数指针赋值。 232 233 示例代码如下： 234 235 ``` 236 /* 自定义设备结构体，继承父类I2cCntlr */ 237 struct SampleI2cCntlr { 238 struct I2cCntlr cntlr; 239 OsalSpinlock spin; 240 volatile unsigned char *regBase; 241 uint16_t regSize; 242 int16_t bus; 243 uint32_t regBasePhy; 244 }; 245 246 /* 消息结构体，继承父类I2cMsg */ 247 struct SampleTransferData { 248 struct I2cMsg *msgs; 249 int16_t index; 250 int16_t count; 251 }; 252 /* 钩子函数实现 */ 253 static int32_t SampleI2cTransfer(struct I2cCntlr *cntlr, struct I2cMsg *msgs, int16_t count) 254 { 255 int32_t ret = HDF_SUCCESS; 256 struct SampleI2cCntlr *sampleCntlr = NULL; 257 struct SampleTransferData td; 258 259 if (cntlr == NULL || cntlr->priv == NULL) { 260 HDF_LOGE("SampleI2cTransfer: cntlr lor sampleCntlr is null!"); 261 return HDF_ERR_INVALID_OBJECT; 262 } 263 sampleCntlr = (struct SampleI2cCntlr *)cntlr; 264 265 if (msgs == NULL || count <= 0) { 266 HDF_LOGE("SampleI2cTransfer: err parms! count:%d", count); 267 return HDF_ERR_INVALID_PARAM; 268 } 269 td.msgs = msgs; 270 td.count = count; 271 td.index = 0; 272 273 HDF_LOGE("Successfully transmitted!"); // 表示此处传输成功 274 275 td.index = count; // 经过处理，最后实际发送msg个数等于count，返回已发送个数，此句代替已省略的处理过程 276 return (td.index > 0) ? td.index : ret; 277 } 278 /* 钩子函数赋值 */ 279 static struct I2cMethod g_method = { 280 .transfer = SampleI2cTransfer, 281 }; 282 ``` 283 2842. 编写驱动初始化函数。 285 286 本例中使用SampleI2cInit作为驱动初始化函数的函数名（函数名称可由驱动开发者确定），该函数需要在驱动入口结构体中赋值给Init，以供HDF驱动框架调用从而达到初始化驱动的目的。该函数中需要对从HCS获取的配置参数进行解析，并按照这些参数创建控制器。示例如下： 287 288 ``` 289 /* 解析参数，申请内存并创建控制器 */ 290 static int32_t SampleI2cParseAndInit(struct HdfDeviceObject *device, const struct DeviceResourceNode *node) 291 { 292 int32_t ret; 293 struct SampleI2cCntlr *sampleCntlr = NULL; 294 (void)device; 295 296 sampleCntlr = (struct SampleI2cCntlr *)OsalMemCalloc(sizeof(*sampleCntlr)); 297 if (sampleCntlr == NULL) { 298 HDF_LOGE("%s: malloc sampleCntlr fail!", __func__); 299 return HDF_ERR_MALLOC_FAIL; 300 } 301 302 ret = SampleI2cReadDrs(sampleCntlr, node); // 从HCS获取配置参数 303 if (ret != HDF_SUCCESS) { 304 HDF_LOGE("%s: read drs fail! ret:%d", __func__, ret); 305 goto __ERR__; 306 } 307 308 sampleCntlr->regBase = OsalIoRemap(sampleCntlr->regBasePhy, sampleCntlr->regSize); 309 if (sampleCntlr->regBase == NULL) { 310 HDF_LOGE("%s: ioremap regBase fail!", __func__); 311 ret = HDF_ERR_IO; 312 goto __ERR__; 313 } 314 315 HDF_LOGE("The controller has been initialized!"); // 表示此处省略的控制器初始化操作已经成功 316 317 sampleCntlr->cntlr.priv = (void *)node; 318 sampleCntlr->cntlr.busId = sampleCntlr->bus; 319 sampleCntlr->cntlr.ops = &g_method; 320 (void)OsalSpinInit(&sampleCntlr->spin); // 初始化自旋锁 321 ret = I2cCntlrAdd(&sampleCntlr->cntlr); // 向核心层添加控制器 322 if (ret != HDF_SUCCESS) { 323 HDF_LOGE("%s: add i2c controller fail:%d!", __func__, ret); 324 goto __ERR__; 325 } 326 327 return HDF_SUCCESS; 328 __ERR__: // 错误处理 329 if (sampleCntlr != NULL) { 330 if (sampleCntlr->regBase != NULL) { 331 OsalIoUnmap((void *)sampleCntlr->regBase); // 取消地址映射 332 sampleCntlr->regBase = NULL; 333 } 334 OsalMemFree(sampleCntlr); // 释放内存 335 sampleCntlr = NULL; 336 } 337 return ret; 338 } 339 /* 驱动入口初始化函数 */ 340 static int32_t SampleI2cInit(struct HdfDeviceObject *device) 341 { 342 int32_t ret; 343 const struct DeviceResourceNode *childNode = NULL; 344 345 HDF_LOGE("%s: Enter", __func__); 346 if (device == NULL || device->property == NULL) { 347 HDF_LOGE("%s: device or property is NULL", __func__); 348 return HDF_ERR_INVALID_OBJECT; 349 } 350 351 ret = HDF_SUCCESS; 352 DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { 353 ret = SampleI2cParseAndInit(device, childNode); // 调用解析参数和创建控制器的函数 354 if (ret != HDF_SUCCESS) { 355 break; 356 } 357 } 358 return ret; 359 } 360 ``` 361 3623. 编写驱动释放函数。 363 364 本例中使用SampleI2cRelease作为驱动释放函数的函数名（函数名称可由驱动开发者确定），该函数需要在驱动入口结构体中赋值给Release，当HDF框架调用Init函数初始化驱动失败时，将调用Release释放驱动资源。该函数中需包含释放内存和删除控制器等操作。示例如下： 365 366 ``` 367 /* 删除控制器函数 */ 368 static void SampleI2cRemoveByNode(const struct DeviceResourceNode *node) 369 { 370 int32_t ret; 371 int16_t bus; 372 struct I2cCntlr *cntlr = NULL; 373 struct SampleI2cCntlr *sampleCntlr = NULL; 374 struct DeviceResourceIface *drsOps = NULL; 375 376 drsOps = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); 377 if (drsOps == NULL || drsOps->GetUint32 == NULL) { 378 HDF_LOGE("%s: invalid drs ops fail!", __func__); 379 return; 380 } 381 382 ret = drsOps->GetUint16(node, "bus", (uint16_t *)&bus, 0); // 从HCS获取I2C总线号 383 if (ret != HDF_SUCCESS) { 384 HDF_LOGE("%s: read bus fail!", __func__); 385 return; 386 } 387 388 cntlr = I2cCntlrGet(bus); 389 if (cntlr != NULL && cntlr->priv == node) { // 根据I2C总线号删除控制器 390 I2cCntlrPut(cntlr); 391 I2cCntlrRemove(cntlr); 392 sampleCntlr = (struct SampleI2cCntlr *)cntlr; 393 OsalIoUnmap((void *)sampleCntlr->regBase); 394 OsalMemFree(sampleCntlr); 395 } 396 return; 397 } 398 /* 释放资源 */ 399 static void SampleI2cRelease(struct HdfDeviceObject *device) 400 { 401 const struct DeviceResourceNode *childNode = NULL; 402 403 HDF_LOGI("%s: enter", __func__); 404 405 if (device == NULL || device->property == NULL) { 406 HDF_LOGE("%s: device or property is NULL", __func__); 407 return; 408 } 409 410 DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { 411 SampleI2cRemoveByNode(childNode); // 调用删除控制器函数 412 } 413 } 414 ``` 415 416 417## 编译及烧录<a name="section164824754712"></a> 418 4191. 编辑Makefile，添加源文件： 420 421 ``` 422 include drivers/hdf/khdf/platform/platform.mk 423 424 obj-y += $(HDF_PLATFORM_FRAMEWORKS_ROOT)/src/i2c_core.o \ 425 $(HDF_PLATFORM_FRAMEWORKS_ROOT)/src/i2c_if.o \ 426 ./i2c_adapter.o \ 427 ./i2c_sample.o 428 ``` 429 430 "./i2c\_sample.o"为本示例中在Makefile中追加的内容。 431 4322. 编译及烧录。 433 434 - 安装包方式具体操作请参考标准系统快速入门[编译](../quick-start/quickstart-appendix-hi3516-pkg.md#编译)和[烧录](../quick-start/quickstart-appendix-hi3516-pkg.md#烧录)。 435 436 - IDE方式具体操作请参考标准系统快速入门[编译](../quick-start/quickstart-appendix-hi3516-ide.md#编译)和[烧录](../quick-start/quickstart-appendix-hi3516-ide.md#烧录)。 437 438 439
