1# GPIO 2 3## 概述 4 5### 功能简介 6 7GPIO（General-purpose input/output）即通用型输入输出。通常，GPIO控制器通过分组的方式管理所有GPIO管脚，每组GPIO有一个或多个寄存器与之关联，通过读写寄存器完成对GPIO管脚的操作。 8 9### 基本概念 10 11GPIO又俗称为I/O口，I指的是输入(in），O指的是输出（out）。可以通过软件来控制其输入和输出，即I/O控制。 12 13- GPIO输入 14 15 输入是检测各个引脚上的电平状态，高电平或者低电平状态。常见的输入模式有：模拟输入、浮空输入、上拉输入、下拉输入。 16 17- GPIO输出 18 19 输出是当需要控制引脚电平的高低时需要用到输出功能。常见的输出模式有：开漏输出、推挽输出、复用开漏输出、复用推挽输出。 20 21### 运作机制 22 23在HDF框架中，同类型设备对象较多时（可能同时存在十几个同类型配置器），若采用独立服务模式，则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现），实现便捷管理和节约资源的目的。GPIO模块采用统一服务模式（如图1所示）。 24 25在统一模式下，所有的控制器都被核心层统一管理，并由核心层统一发布一个服务供接口层，因此这种模式下驱动无需再为每个控制器发布服务。 26 27GPIO模块各分层作用： 28 29- 接口层：提供操作GPIO管脚的标准方法。 30 31- 核心层：提供GPIO管脚资源匹配，GPIO管脚控制器的添加、移除以及管理的能力，通过钩子函数与适配层交互，供芯片厂家快速接入HDF框架。 32 33- 适配层：由驱动适配者将钩子函数的功能实例化，实现与硬件相关的具体功能。 34 35**图 1** GPIO统一服务模式结构图 36 37 38 39## 开发指导 40 41### 场景介绍 42 43GPIO主要是对GPIO管脚资源进行管理。驱动开发者可以使用GPIO模块提供的操作接口，实现对管脚的具体控制。当驱动开发者需要将GPIO适配到OpenHarmony时，需要进行GPIO驱动适配。下文将介绍如何进行GPIO驱动适配。 44 45### 接口说明 46 47为了保证上层在调用GPIO接口时能够正确的操作GPIO管脚，核心层在//drivers/hdf_core/framework/support/platform/include/gpio/gpio_core.h中定义了以下钩子函数，驱动适配者需要在适配层实现这些函数的具体功能，并与钩子函数挂接，从而完成适配层与核心层的交互。 48 49GpioMethod定义： 50 51```c 52struct GpioMethod { 53 int32_t (*request)(struct GpioCntlr *cntlr, uint16_t local); // 【预留】 54 int32_t (*release)(struct GpioCntlr *cntlr, uint16_t local); // 【预留】 55 int32_t (*write)(struct GpioCntlr *cntlr, uint16_t local, uint16_t val); 56 int32_t (*read)(struct GpioCntlr *cntlr, uint16_t local, uint16_t *val); 57 int32_t (*setDir)(struct GpioCntlr *cntlr, uint16_t local, uint16_t dir); 58 int32_t (*getDir)(struct GpioCntlr *cntlr, uint16_t local, uint16_t *dir); 59 int32_t (*toIrq)(struct GpioCntlr *cntlr, uint16_t local, uint16_t *irq); // 【预留】 60 int32_t (*setIrq)(struct GpioCntlr *cntlr, uint16_t local, uint16_t mode); 61 int32_t (*unsetIrq)(struct GpioCntlr *cntlr, uint16_t local); 62 int32_t (*enableIrq)(struct GpioCntlr *cntlr, uint16_t local); 63 int32_t (*disableIrq)(struct GpioCntlr *cntlr, uint16_t local); 64} 65``` 66 67**表 1** GpioMethod结构体成员的钩子函数功能说明 68 69| 函数成员 | 入参 | 出参 | 返回值 | 功能 | 70| -------- | -------- | -------- | -------- | -------- | 71| write | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号<br/>val：uint16_t类型，电平传入值 | 无 | HDF_STATUS相关状态 | GPIO引脚写入电平值 | 72| read | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号 | val：uint16_t类型指针，用于传出电平值。 | HDF_STATUS相关状态 | GPIO引脚读取电平值 | 73| setDir | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号<br/>dir：uint16_t类型，管脚方向传入值 | 无 | HDF_STATUS相关状态 | 设置GPIO引脚输入/输出方向 | 74| getDir | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号 | dir：uint16_t类型指针，用于传出管脚方向值 | HDF_STATUS相关状态 | 读GPIO引脚输入/输出方向 | 75| setIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号<br/>mode：uint16_t类型，表示触发模式（边沿或电平） | 无 | HDF_STATUS相关状态 | 将GPIO引脚设置为中断模式 | 76| unsetIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号 | 无 | HDF_STATUS相关状态 | 取消GPIO中断设置 | 77| enableIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号 | 无 | HDF_STATUS相关状态 | 使能GPIO管脚中断 | 78| disableIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t类型，GPIO端口标识号 | 无 | HDF_STATUS相关状态 | 禁止GPIO管脚中断 | 79 80### 开发步骤 81 82GPIO模块适配包含以下四个步骤： 83 84- 实例化驱动入口 85 86- 配置属性文件 87 88- 实例化GPIO控制器对象 89 90- 驱动调试 91 92### 开发实例 93 94下方将基于Hi3516DV300开发板以//device/soc/hisilicon/common/platform/gpio/gpio_hi35xx.c驱动为示例，展示需要驱动适配者提供哪些内容来完整实现设备功能。 95 961. 实例化驱动入口 97 98 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 99 100 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 101 102 GPIO驱动入口开发参考： 103 104 ```c 105 struct HdfDriverEntry g_gpioDriverEntry = { 106 .moduleVersion = 1, 107 .Bind = Pl061GpioBind, // GPIO不需要实现Bind，本例是一个空实现，驱动适配者可根据自身需要添加相关操作 108 .Init = Pl061GpioInit, // 挂接Gpio模块Init实例化 109 .Release = Pl061GpioRelease, // 挂接Gpio模块Release实例化 110 .moduleName = "hisi_pl061_driver", // 【必要且需要与HCS文件中里面的moduleName匹配】 111 }; 112 HDF_INIT(g_gpioDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中 113 ``` 114 1152. 配置属性文件 116 117 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，deviceNode信息与驱动入口注册相关。本例以一个GPIO控制器为例，如有多个器件信息，则需要在device_info.hcs文件增加deviceNode信息，以及在gpio_config.hcs文件中增加对应的器件属性。器件属性值与核心层GpioCntlr成员的默认值或限制范围有密切关系，需要在gpio_config.hcs中配置器件属性。 118 119 统一服务模式的特点是device_info.hcs文件中第一个设备节点必须为GPIO管理器，其各项参数如表2所示： 120 121 **表 2** device_info.hcs节点参数说明 122 123 | 成员名 | 值 | 124 | -------- | -------- | 125 | policy | 驱动服务发布的策略，GPIO管理器具体配置为2，表示驱动对内核态和用户态都发布服务 | 126 | priority | 驱动启动优先级（0-200），值越大优先级越低。GPIO管理器具体配置为10 | 127 | permission | 驱动创建设备节点权限，GPIO管理器具体配置为0664 | 128 | moduleName | 驱动名称，GPIO管理器固定为HDF_PLATFORM_GPIO_MANAGER | 129 | serviceName | 驱动对外发布服务的名称，GPIO管理器服务名设置为HDF_PLATFORM_GPIO_MANAGER | 130 | deviceMatchAttr | 驱动私有数据匹配的关键字，GPIO管理器没有使用，可忽略 | 131 132 - device_info.hcs 配置参考： 133 134 在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。 135 136 ```c 137 root { 138 device_info { 139 platform :: host { 140 hostName = "platform_host"; 141 priority = 50; 142 device_gpio :: device { 143 device0 :: deviceNode { 144 policy = 2; 145 priority = 10; 146 permission = 0644; 147 moduleName = "HDF_PLATFORM_GPIO_MANAGER"; 148 serviceName = "HDF_PLATFORM_GPIO_MANAGER"; 149 } 150 device1 :: deviceNode { 151 policy = 0; // 等于0，不需要发布服务 152 priority = 10; // 驱动启动优先级 153 permission = 0644; // 驱动创建设备节点权限 154 moduleName = "hisi_pl061_driver"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致 155 deviceMatchAttr = "hisilicon_hi35xx_pl061"; // 【必要】用于配置控制器私有数据，要与gpio_config.hcs中对应控制器保持一致，其他控制器信息也在文件中 156 } 157 } 158 } 159 } 160 } 161 ``` 162 163 - gpio_config.hcs配置参考： 164 165 此处以Hi3516DV300为例，给出HCS配置参考。其中部分字段为Hi3516DV300特有功能，驱动适配者可根据需要进行删除或添加字段。 166 167 ```c 168 root { 169 platform { 170 gpio_config { 171 controller_0x120d0000 { 172 match_attr = "hisilicon_hi35xx_pl061"; // 【必要】必须和device_info.hcs中的deviceMatchAttr值一致 173 groupNum = 12; // 【必要】GPIO组索引，需要根据设备情况填写 174 bitNum = 8; // 【必要】每组GPIO管脚数 175 regBase = 0x120d0000; // 【必要】物理基地址 176 regStep = 0x1000; // 【必要】寄存器偏移步进 177 irqStart = 48; // 【必要】开启中断 178 irqShare = 0; // 【必要】共享中断 179 } 180 template gpio_info { // gpio_info模板 181 gpioCustomName = ""; // gpio管脚默认名称 182 } 183 GPIO0 :: gpio_info { 184 gpioCustomName = "GPIO0_0"; 185 } 186 ...... 187 } 188 } 189 } 190 ``` 191 192 需要注意的是，新增gpio_config.hcs配置文件后，必须在产品对应的hdf.hcs文件中将其包含如下语句所示，否则配置文件无法生效。 193 194 ```c 195 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/gpio/gpio_config.hcs" // 配置文件相对路径 196 ``` 197 198 本例基于Hi3516DV300开发板的小型系统LiteOS内核运行，对应的hdf.hcs文件路径为vendor/hisilicon/hispark_taurus/hdf_config/hdf.hcs以及//device/hisilicon/hispark_taurus/sdk_liteos/hdf_config/hdf.hcs。驱动适配者需根据实际情况选择对应路径下的文件进行修改。 199 2003. 实例化GPIO控制器对象 201 202 完成驱动入口注册之后，下一步就是以核心层GpioCntlr对象的初始化为核心，包括驱动适配者自定义结构体（传递参数和数据），实例化GpioCntlr成员GpioMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。 203 204 - 驱动适配者自定义结构体参考。 205 206 从驱动的角度看，自定义结构体是参数和数据的载体，而且gpio_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，其中一些重要数值也会传递给核心层GpioCntlr对象，例如索引、管脚数等。 207 208 ```c 209 //GPIO分组信息定义 210 struct Pl061GpioGroup { 211 struct GpioCntlr cntlr; // 【必要】是核心层控制对象，其成员定义见下面。 212 volatile unsigned char *regBase; // 【必要】寄存器基地址。 213 unsigned int index; 214 unsigned int irq; 215 OsalIRQHandle irqFunc; 216 OsalSpinlock lock; 217 uint32_t irqSave; 218 bool irqShare; 219 struct PlatformDumper *dumper; 220 char *dumperName; 221 }; 222 223 struct Pl061GpioData { 224 volatile unsigned char *regBase; // 【必要】寄存器基地址。 225 uint32_t phyBase; // 【必要】物理基址。 226 uint32_t regStep; // 【必要】寄存器偏移步进。 227 uint32_t irqStart; // 【必要】中断开启。 228 uint16_t groupNum; // 【必要】用于描述厂商的GPIO端口号的参数。 229 uint16_t bitNum; // 【必要】用于描述厂商的GPIO端口号的参数。 230 uint8_t irqShare; // 【必要】共享中断。 231 struct Pl061GpioGroup *groups; // 【可选】根据厂商需要设置。 232 struct GpioInfo *gpioInfo; 233 void *priv; 234 }; 235 236 struct GpioInfo { 237 struct GpioCntlr *cntlr; 238 char name[GPIO_NAME_LEN]; 239 OsalSpinlock spin; 240 uint32_t irqSave; 241 struct GpioIrqRecord *irqRecord; 242 }; 243 // GpioCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。 244 struct GpioCntlr { 245 struct PlatformDevice device; 246 struct GpioMethod *ops; 247 uint16_t start; 248 uint16_t count; 249 struct GpioInfo *ginfos; 250 bool isAutoAlloced; 251 void *priv; 252 }; 253 ``` 254 255 - GpioCntlr成员钩子函数结构体GpioMethod的实例化。 256 257 ```c 258 //GpioMethod结构体成员都是钩子函数，驱动适配者需要根据表1完成相应的函数功能。 259 static struct GpioMethod g_method = { 260 .request = NULL, 261 .release = NULL, 262 .write = Pl061GpioWrite, // 写管脚 263 .read = Pl061GpioRead, // 读管脚 264 .setDir = Pl061GpioSetDir, // 设置管脚方向 265 .getDir = Pl061GpioGetDir, // 获取管脚方向 266 .toIrq = NULL, 267 .setIrq = Pl061GpioSetIrq, // 设置管脚中断，如不具备此能力可忽略 268 .unsetIrq = Pl061GpioUnsetIrq, // 取消管脚中断设置，如不具备此能力可忽略 269 .enableIrq = Pl061GpioEnableIrq, // 使能管脚中断，如不具备此能力可忽略 270 .disableIrq = Pl061GpioDisableIrq, // 禁止管脚中断，如不具备此能力可忽略 271 }; 272 ``` 273 274 - Init函数开发参考 275 276 入参： 277 278 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 279 280 返回值： 281 282 HDF_STATUS相关状态（表3为部分展示，如需使用其他状态，可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS定义）。 283 284 **表 3** HDF_STATUS相关状态说明 285 286 | 状态(值) | 问题描述 | 287 | -------- | -------- | 288 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 289 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 290 | HDF_ERR_INVALID_PARAM | 参数非法 | 291 | HDF_ERR_IO | I/O 错误 | 292 | HDF_SUCCESS | 初始化成功 | 293 | HDF_FAILURE | 初始化失败 | 294 295 函数说明： 296 297 初始化自定义结构体对象，初始化GpioCntlr成员，调用核心层GpioCntlrAdd函数，接入VFS（可选）。 298 299 ```c 300 static struct Pl061GpioData g_pl061 = { 301 .groups = NULL, 302 .groupNum = PL061_GROUP_MAX, 303 .bitNum = PL061_BIT_MAX, 304 }; 305 306 static int32_t Pl061GpioInitGroups(struct Pl061GpioData *pl061) 307 { 308 int32_t ret; 309 uint16_t i; 310 struct Pl061GpioGroup *groups = NULL; 311 312 if (pl061 == NULL) { 313 return HDF_ERR_INVALID_PARAM; 314 } 315 316 groups = (struct Pl061GpioGroup *)OsalMemCalloc(sizeof(*groups) * pl061->groupNum); 317 if (groups == NULL) { 318 return HDF_ERR_MALLOC_FAIL; 319 } 320 pl061->groups = groups; 321 322 for (i = 0; i < pl061->groupNum; i++) { 323 // 相关信息初始化 324 groups[i].index = i; 325 groups[i].regBase = pl061->regBase + i * pl061->regStep; 326 groups[i].irq = pl061->irqStart + i; 327 groups[i].irqShare = pl061->irqShare; 328 groups[i].cntlr.start = i * pl061->bitNum; 329 groups[i].cntlr.count = pl061->bitNum; 330 groups[i].cntlr.ops = &g_method; 331 groups[i].cntlr.ginfos = &pl061->gpioInfo[i * pl061->bitNum]; 332 333 if ((ret = OsalSpinInit(&groups[i].lock)) != HDF_SUCCESS) { 334 goto ERR_EXIT; 335 } 336 337 ret = GpioCntlrAdd(&groups[i].cntlr); // 向HDF core中添加相关信息 338 if (ret != HDF_SUCCESS) { 339 HDF_LOGE("%s: err add controller(%hu:%hu):%d", __func__, 340 groups[i].cntlr.start, groups[i].cntlr.count, ret); 341 (void)OsalSpinDestroy(&groups[i].lock); 342 goto ERR_EXIT; 343 } 344 ret = GpioDumperCreate(&pl061->groups[i]); 345 if (ret != HDF_SUCCESS) { 346 HDF_LOGE("%s: create dumper failed:%d", __func__, ret); 347 return ret; 348 } 349 } 350 return HDF_SUCCESS; 351 352 ERR_EXIT: 353 while (i-- > 0) { 354 GpioCntlrRemove(&groups[i].cntlr); 355 (void)OsalSpinDestroy(&groups[i].lock); 356 } 357 pl061->groups = NULL; 358 OsalMemFree(groups); 359 return ret; 360 } 361 362 static int32_t Pl061GpioInit(struct HdfDeviceObject *device) 363 { 364 int32_t ret; 365 struct Pl061GpioData *pl061 = &g_pl061; 366 367 if (device == NULL || device->property == NULL) { 368 HDF_LOGE("%s: device or property null!", __func__); 369 return HDF_ERR_INVALID_OBJECT; 370 } 371 372 pl061->gpioInfo = OsalMemCalloc(sizeof(struct GpioInfo) * GPIO_MAX_INFO_NUM); 373 if (pl061->gpioInfo == NULL) { 374 HDF_LOGE("%s: failed to calloc gpioInfo!", __func__); 375 return HDF_ERR_MALLOC_FAIL; 376 } 377 378 ret = Pl061GpioReadDrs(pl061, device->property); // 利用从gpio_config.HCS文件读取的属性值来初始化自定义结构体对象成员 379 if (ret != HDF_SUCCESS) { 380 HDF_LOGE("%s: failed to read drs:%d", __func__, ret); 381 return ret; 382 } 383 384 if (pl061->groupNum > PL061_GROUP_MAX || pl061->groupNum <= 0 || 385 pl061->bitNum > PL061_BIT_MAX || pl061->bitNum <= 0) { 386 HDF_LOGE("%s: err groupNum:%hu, bitNum:%hu", __func__, pl061->groupNum, pl0 61->bitNum); 387 return HDF_ERR_INVALID_PARAM; 388 } 389 390 pl061->regBase = OsalIoRemap(pl061->phyBase, pl061->groupNum * pl061->regStep); // 地址映射 391 if (pl061->regBase == NULL) { 392 HDF_LOGE("%s: err remap phy:0x%x", __func__, pl061->phyBase); 393 return HDF_ERR_IO; 394 } 395 396 ret = Pl061GpioInitGroups(pl061); // group信息初始化，并添加到HDF核心层 397 if (ret != HDF_SUCCESS) { 398 HDF_LOGE("%s: err init groups:%d", __func__, ret); 399 OsalIoUnmap((void *)pl061->regBase); 400 pl061->regBase = NULL; 401 return ret; 402 } 403 pl061->priv = (void *)device->property; 404 device->priv = (void *)pl061; 405 Pl061GpioDebug(pl061); 406 407 #ifdef PL061_GPIO_USER_SUPPORT 408 if (GpioAddVfs(pl061->bitNum) != HDF_SUCCESS) { 409 HDF_LOGE("%s: add vfs fail!", __func__); 410 } 411 #endif 412 HDF_LOGI("%s: dev service:%s init success!", __func__, HdfDeviceGetServiceName(device)); 413 return HDF_SUCCESS; 414 } 415 ``` 416 417 - Release函数开发参考 418 419 入参： 420 421 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 422 423 返回值： 424 425 无。 426 427 函数说明： 428 429 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。 430 431 >  **说明：**<br> 432 > 所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。 433 434 ```c 435 static void Pl061GpioUninitGroups(struct Pl061GpioData *pl061) 436 { 437 uint16_t i; 438 struct Pl061GpioGroup *group = NULL; 439 440 for (i = 0; i < pl061->groupNum; i++) { 441 group = &pl061->groups[i]; 442 GpioDumperDestroy(&pl061->groups[i]); 443 GpioCntlrRemove(&group->cntlr); // 从HDF核心层删除 444 } 445 446 OsalMemFree(pl061->groups); 447 pl061->groups = NULL; 448 } 449 450 static void Pl061GpioRelease(struct HdfDeviceObject *device) 451 { 452 struct Pl061GpioData *pl061 = NULL; 453 454 HDF_LOGI("%s: enter", __func__); 455 if (device == NULL) { 456 HDF_LOGE("%s: device is null!", __func__); 457 return; 458 } 459 460 #ifdef PL061_GPIO_USER_SUPPORT 461 GpioRemoveVfs(); 462 #endif 463 464 pl061 = (struct Pl061GpioData *)device->priv; 465 if (pl061 == NULL) { 466 HDF_LOGE("%s: device priv is null", __func__); 467 return; 468 } 469 470 Pl061GpioUninitGroups(pl061); 471 OsalMemFree(pl061->gpioInfo); 472 pl061->gpioInfo = NULL; 473 OsalIoUnmap((void *)pl061->regBase); 474 pl061->regBase = NULL; 475 } 476 ``` 477 4784. 驱动调试 479 480 【可选】针对新增驱动程序，建议验证驱动基本功能，例如GPIO控制状态，中断响应情况等。 481
