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