1# UART 2 3## 概述 4 5### 功能简介 6 7UART指异步收发传输器（Universal Asynchronous Receiver/Transmitter），是通用串行数据总线，用于异步通信。该总线双向通信，可以实现全双工传输。 8 9两个UART设备的连接示意图如下，UART与其他模块一般用2线（图1）或4线（图2）相连，它们分别是： 10 11 - TX：发送数据端，和对端的RX相连。 12 - RX：接收数据端，和对端的TX相连。 13 - RTS：发送请求信号，用于指示本设备是否准备好，可接受数据，和对端CTS相连。 14 - CTS：允许发送信号，用于判断是否可以向对端发送数据，和对端RTS相连。 15 16**图1** 2线UART设备连接示意图 17 18 19 20**图2** 4线UART设备连接示意图 21 22 23 24UART通信之前，收发双方需要约定好一些参数：波特率、数据格式（起始位、数据位、校验位、停止位）等。通信过程中，UART通过TX发送给对端数据，通过RX接收对端发送的数据。当UART接收缓存达到预定的门限值时，RTS变为不可发送数据，对端的CTS检测到不可发送数据，则停止发送数据。 25 26### 基本概念 27 28- 异步通信 29 30 异步通信中，数据通常以字符或者字节为单位组成字符帧传送。字符帧由发送端逐帧发送，通过传输线被接收设备逐帧接收。发送端和接收端可以由各自的时钟来控制数据的发送和接收，这两个时钟源彼此独立，互不同步。异步通信以一个字符为传输单位，通信中两个字符间的时间间隔是不固定的，然而在同一个字符中的两个相邻位代码间的时间间隔是固定的。 31 32- 全双工传输（Full Duplex） 33 34 此通信模式允许数据在两个方向上同时传输，它在能力上相当于两个单工通信方式的结合。全双工可以同时进行信号的双向传输。 35 36### 运作机制 37 38在HDF框架中，UART接口适配模式采用独立服务模式（如图3所示）。在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDF设备管理器的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。 39 40独立服务模式下，核心层不会统一发布一个服务供上层使用，因此这种模式下驱动要为每个控制器发布一个服务，具体表现为： 41 42- 驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。 43- device_info.hcs文件中deviceNode的policy字段为1或2，不能为0。 44 45UART模块各分层作用： 46 47- 接口层提供打开UART设备、UART设备读取指定长度数据、UART设备写入指定长度数据、设置UART设备波特率、获取设UART设备波特率、设置UART设备属性、获取UART设备波特率、设置UART设备传输模式、关闭UART设备的接口。 48- 核心层主要提供看UART控制器的创建、移除以及管理的能力，通过钩子函数与适配层交互。 49- 适配层主要是将钩子函数的功能实例化，实现具体的功能。 50 51**图3** UART独立服务模式结构图 52 53 54 55## 开发指导 56 57### 场景介绍 58 59UART模块应用比较广泛，主要用于实现设备之间的低速串行通信，例如输出打印信息，当然也可以外接各种模块，如GPS、蓝牙等。当驱动开发者需要将UART设备适配到OpenHarmony时，需要进行UART驱动适配。下文将介绍如何进行UART驱动适配。 60 61### 接口说明 62 63为了保证上层在调用UART接口时能够正确的操作UART控制器，核心层在//drivers/hdf_core/framework/support/platform/include/uart/uart_core.h中定义了以下钩子函数，驱动适配者需要在适配层实现这些函数的具体功能，并与钩子函数挂接，从而完成适配层与核心层的交互。 64 65UartHostMethod定义： 66 67```c 68struct UartHostMethod { 69 int32_t (*Init)(struct UartHost *host); 70 int32_t (*Deinit)(struct UartHost *host); 71 int32_t (*Read)(struct UartHost *host, uint8_t *data, uint32_t size); 72 int32_t (*Write)(struct UartHost *host, uint8_t *data, uint32_t size); 73 int32_t (*GetBaud)(struct UartHost *host, uint32_t *baudRate); 74 int32_t (*SetBaud)(struct UartHost *host, uint32_t baudRate); 75 int32_t (*GetAttribute)(struct UartHost *host, struct UartAttribute *attribute); 76 int32_t (*SetAttribute)(struct UartHost *host, struct UartAttribute *attribute); 77 int32_t (*SetTransMode)(struct UartHost *host, enum UartTransMode mode); 78 int32_t (*pollEvent)(struct UartHost *host, void *filep, void *table); 79}; 80``` 81 82**表1** UartHostMethod结构体成员的回调函数功能说明 83 84| 函数 | 入参 | 出参 | 返回值 | 功能 | 85| -------- | -------- | -------- | -------- | -------- | 86| Init | host：结构体指针，核心层UART控制器 | 无 | HDF_STATUS相关状态 | 初始化Uart设备 | 87| Deinit | host：结构体指针，核心层UART控制器 | 无 | HDF_STATUS相关状态 | 去初始化Uart设备 | 88| Read | host：结构体指针，核心层UART控制器<br>size：uint32_t类型，接收数据大小 | data：uint8_t类型指针，接收的数据 | HDF_STATUS相关状态 | 接收数据RX | 89| Write | host：结构体指针，核心层UART控制器<br>data：uint8_t类型指针，传入数据<br>size：uint32_t类型，发送数据大小 | 无 | HDF_STATUS相关状态 | 发送数据TX | 90| SetBaud | host：结构体指针，核心层UART控制器<br>baudRate：uint32_t类型，波特率传入值 | 无 | HDF_STATUS相关状态 | 设置波特率 | 91| GetBaud | host：结构体指针，核心层UART控制器 | baudRate：uint32_t类型指针，传出的波特率 | HDF_STATUS相关状态 | 获取当前设置的波特率 | 92| GetAttribute | host：结构体指针，核心层UART控制器 | attribute：结构体指针，传出的属性值（见uart_if.h中UartAttribute定义） | HDF_STATUS相关状态 | 获取设备uart相关属性 | 93| SetAttribute | host：结构体指针，核心层UART控制器<br>attribute：结构体指针，属性传入值 | 无 | HDF_STATUS相关状态 | 设置设备UART相关属性 | 94| SetTransMode | host：结构体指针，核心层UART控制器<br>mode：枚举值（见uart_if.h中UartTransMode定义），传输模式 | 无 | HDF_STATUS相关状态 | 设置传输模式 | 95| PollEvent | host：结构体指针，核心层UART控制器<br>filep：void类型指针file<br>table：void类型指针table | 无 | HDF_STATUS相关状态 | poll轮询机制 | 96 97### 开发步骤 98 99UART模块适配HDF框架包含以下四个步骤： 100 101- 实例化驱动入口。 102- 配置属性文件。 103- 实例化UART控制器对象。 104- 驱动调试。 105 106### 开发实例 107 108下方将基于Hi3516DV300开发板以//device_soc_hisilicon/common/platform/uart/uart_hi35xx.c驱动为示例，展示需要驱动适配者提供哪些内容来完整实现设备功能。 109 1101. 实例化驱动入口。 111 112 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 113 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 114 115 UART驱动入口开发参考： 116 117 ```c 118 struct HdfDriverEntry g_hdfUartDevice = { 119 .moduleVersion = 1, 120 .moduleName = "HDF_PLATFORM_UART", // 【必要且与HCS文件中里面的moduleName匹配】 121 .Bind = HdfUartDeviceBind, // 见Bind参考 122 .Init = HdfUartDeviceInit, // 见Init参考 123 .Release = HdfUartDeviceRelease, // 见Release参考 124 }; 125 HDF_INIT(g_hdfUartDevice); //调用HDF_INIT将驱动入口注册到HDF框架中 126 ``` 127 1282. 配置属性文件。 129 130 完成驱动入口注册之后，需要在device_info.hcs文件中添加deviceNode信息，deviceNode信息与驱动入口注册相关。本例以两个UART控制器为例，如有多个器件信息，则需要在device_info.hcs文件增加对应的deviceNode信息。器件属性值与核心层UartHost成员的默认值或限制范围有密切关系，比如UART设备端口号，需要在uart_config.hcs文件中增加对应的器件属性。 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 match_attr = "hdf_manager"; 140 platform :: host { 141 hostName = "platform_host"; 142 priority = 50; 143 device_uart :: device { 144 device0 :: deviceNode { 145 policy = 1; // 驱动服务发布的策略，policy大于等于1（用户态可见为2，仅内核态可见为1）。 146 priority = 40; // 驱动启动优先级 147 permission = 0644; // 驱动创建设备节点权限 148 moduleName = "HDF_PLATFORM_UART"; // 驱动名称，该字段的值必须和驱动入口结构的moduleName值一致。 149 serviceName = "HDF_PLATFORM_UART_0"; // 驱动对外发布服务的名称，必须唯一，必须要按照HDF_PLATFORM_UART_X的格式，X为UART控制器编号。 150 deviceMatchAttr = "hisilicon_hi35xx_uart_0"; // 驱动私有数据匹配的关键字，必须和驱动私有数据配置表中的match_attr值一致。 151 } 152 device1 :: deviceNode { 153 policy = 2; 154 permission = 0644; 155 priority = 40; 156 moduleName = "HDF_PLATFORM_UART"; 157 serviceName = "HDF_PLATFORM_UART_1"; 158 deviceMatchAttr = "hisilicon_hi35xx_uart_1"; 159 } 160 ... 161 } 162 } 163 } 164 } 165 ``` 166 167 - uart_config.hcs 配置参考： 168 169 在//device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/uart/uart_config.hcs文件配置器件属性，其中配置参数如下： 170 171 ```c 172 root { 173 platform { 174 template uart_controller { // 配置模板，如果下面节点使用时继承该模板，则节点中未声明的字段会使用该模板中的默认值 175 match_attr = ""; 176 num = 0; // 【必要】端口号 177 baudrate = 115200; // 【必要】波特率，数值可按需填写 178 fifoRxEn = 1; // 【必要】使能接收FIFO 179 fifoTxEn = 1; // 【必要】使能发送FIFO 180 flags = 4; // 【必要】标志信号 181 regPbase = 0x120a0000; // 【必要】地址映射需要 182 interrupt = 38; // 【必要】中断号 183 iomemCount = 0x48; // 【必要】地址映射需要 184 } 185 controller_0x120a0000 :: uart_controller { 186 match_attr = "hisilicon_hi35xx_uart_0"; // 【必要】必须和device_info.hcs中对应的设备的deviceMatchAttr值一致 187 } 188 controller_0x120a1000 :: uart_controller { 189 num = 1; 190 baudrate = 9600; 191 regPbase = 0x120a1000; 192 interrupt = 39; 193 match_attr = "hisilicon_hi35xx_uart_1"; 194 } 195 ... // 如果存在多个UART设备时【必须】添加节点，否则不用 196 } 197 } 198 ``` 199 200 需要注意的是，新增uart_config.hcs配置文件后，必须在产品对应的hdf.hcs文件中将其包含如下语句所示，否则配置文件无法生效。 201 202 ```c 203 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/uart/uart_config.hcs" // 配置文件相对路径 204 ``` 205 2063. 实例化UART控制器对象。 207 208 完成属性文件配置之后，下一步就是以核心层UartHost对象的初始化为核心，包括驱动适配者自定义结构体（传递参数和数据），实例化UartHost成员UartHostMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 209 210 - 驱动适配者自定义结构体参考 211 212 从驱动的角度看，驱动适配者自定义结构体是参数和数据的载体，而且uart_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如端口号。 213 214 ```c 215 struct UartPl011Port { // 驱动适配者自定义管脚描述结构体 216 int32_t enable; 217 unsigned long physBase; // 物理地址 218 uint32_t irqNum; // 中断号 219 uint32_t defaultBaudrate; // 默认波特率 220 uint32_t flags; // 标志信号，下面三个宏与之相关 221 #define PL011_FLG_IRQ_REQUESTED (1 << 0) 222 #define PL011_FLG_DMA_RX_REQUESTED (1 << 1) 223 #define PL011_FLG_DMA_TX_REQUESTED (1 << 2) 224 struct UartDmaTransfer *rxUdt; // DMA传输相关 225 struct UartDriverData *udd; 226 }; 227 struct UartDriverData { // 数据传输相关的结构体 228 uint32_t num; // 端口号 229 uint32_t baudrate; // 波特率（可设置） 230 struct UartAttribute attr; // 数据位、停止位等传输属性相关 231 struct UartTransfer *rxTransfer; // 缓冲区相关，可理解为FIFO结构 232 wait_queue_head_t wait; // 条件变量相关的排队等待信号 233 int32_t count; // 数据数量 234 int32_t state; // UART控制器状态 235 #define UART_STATE_NOT_OPENED 0 236 #define UART_STATE_OPENING 1 237 #define UART_STATE_USEABLE 2 238 #define UART_STATE_SUSPENDED 3 239 uint32_t flags; // 状态标志 240 #define UART_FLG_DMA_RX (1 << 0) 241 #define UART_FLG_DMA_TX (1 << 1) 242 #define UART_FLG_RD_BLOCK (1 << 2) 243 RecvNotify recv; // 函数指针类型，指向串口数据接收函数 244 struct UartOps *ops; // 自定义函数指针结构体 245 void *private; // 私有数据 246 }; 247 248 // UartHost是核心层控制器结构体，其中的成员在Init函数中会被赋值。 249 struct UartHost { 250 struct IDeviceIoService service; // 驱动服务 251 struct HdfDeviceObject *device; // 驱动设备对象 252 uint32_t num; // 端口号 253 OsalAtomic atom; // 原子量 254 void *priv; // 私有数据 255 struct UartHostMethod *method; // 回调函数 256 }; 257 ``` 258 259 - UartHost成员回调函数结构体UartHostMethod的实例化，其中的成员在Init函数中初始化。 260 261 ```c 262 // uart_hi35xx.c 中的示例：钩子函数的实例化 263 struct UartHostMethod g_uartHostMethod = { 264 .Init = Hi35xxInit, // 初始化 265 .Deinit = Hi35xxDeinit, // 去初始化 266 .Read = Hi35xxRead, // 接收数据 267 .Write = Hi35xxWrite, // 发送数据 268 .SetBaud = Hi35xxSetBaud, // 设置波特率 269 .GetBaud = Hi35xxGetBaud, // 获取波特率 270 .SetAttribute = Hi35xxSetAttribute, // 设置设备属性 271 .GetAttribute = Hi35xxGetAttribute, // 获取设备属性 272 .SetTransMode = Hi35xxSetTransMode, // 设置传输模式 273 .pollEvent = Hi35xxPollEvent, // 轮询 274 }; 275 ``` 276 277 - Bind函数开发参考 278 279 入参： 280 281 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 282 283 返回值： 284 285 HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可参见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS中HDF_STATUS定义）。 286 287 **表2** HDF_STATUS返回值说明 288 289 | 状态(值) | 问题描述 | 290 | -------- | -------- | 291 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 292 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 293 | HDF_ERR_INVALID_PARAM | 参数非法 | 294 | HDF_ERR_IO | I/O 错误 | 295 | HDF_SUCCESS | 初始化成功 | 296 | HDF_FAILURE | 初始化失败 | 297 298 函数说明： 299 300 初始化自定义结构体对象，初始化UartHost成员。 301 302 ```c 303 //uart_hi35xx.c 304 static int32_t HdfUartDeviceBind(struct HdfDeviceObject *device) 305 { 306 ... 307 return (UartHostCreate(device) == NULL) ? HDF_FAILURE : HDF_SUCCESS; // 【必须】调用核心层函数UartHostCreate 308 } 309 310 // uart_core.c核心层UartHostCreate函数说明 311 struct UartHost *UartHostCreate(struct HdfDeviceObject *device) 312 { 313 struct UartHost *host = NULL; // 新建UartHost 314 ... 315 host = (struct UartHost *)OsalMemCalloc(sizeof(*host)); // 分配内存 316 ... 317 host->device = device; // 【必要】使HdfDeviceObject与UartHost可以相互转化的前提 318 device->service = &(host->service); // 【必要】使HdfDeviceObject与UartHost可以相互转化的前提 319 host->device->service->Dispatch = UartIoDispatch; // 为service成员的Dispatch方法赋值 320 OsalAtomicSet(&host->atom, 0); // 原子量初始化或者原子量设置 321 host->priv = NULL; 322 host->method = NULL; 323 return host; 324 } 325 ``` 326 327 - Init函数开发参考 328 329 入参： 330 331 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 332 333 返回值： 334 335 HDF_STATUS相关状态。 336 337 函数说明： 338 339 初始化自定义结构体对象，初始化UartHost成员，调用核心层UartAddDev函数，完成UART控制器的添加，接入VFS。 340 341 ```c 342 int32_t HdfUartDeviceInit(struct HdfDeviceObject *device) 343 { 344 int32_t ret; 345 struct UartHost *host = NULL; 346 HDF_LOGI("%s: entry", __func__); 347 ... 348 host = UartHostFromDevice(device); // 通过service成员后强制转为UartHost，赋值是在Bind函数中 349 ... 350 ret = Hi35xxAttach(host, device); // 完成UartHost对象的初始化，见下 351 ... 352 host->method = &g_uartHostMethod; // UartHostMethod的实例化对象的挂载 353 return ret; 354 } 355 // 完成UartHost对象的初始化。 356 static int32_t Hi35xxAttach(struct UartHost *host, struct HdfDeviceObject *device) 357 { 358 int32_t ret; 359 struct UartDriverData *udd = NULL; // udd和port对象是驱动适配者自定义的结构体对象，可根据需要实现相关功能 360 struct UartPl011Port *port = NULL; 361 ... 362 // 【必要】步骤【1】~【7】主要实现对udd对象的实例化赋值，然后赋值给核心层UartHost对象。 363 udd = (struct UartDriverData *)OsalMemCalloc(sizeof(*udd)); // 【1】 364 ... 365 port = (struct UartPl011Port *)OsalMemCalloc(sizeof(struct UartPl011Port)); // 【2】 366 ... 367 udd->ops = Pl011GetOps(); // 【3】设备开启、关闭、属性设置、发送操作等函数挂载。 368 udd->recv = PL011UartRecvNotify; // 【4】数据接收通知函数（条件锁机制）挂载 369 udd->count = 0; // 【5】 370 port->udd = udd; // 【6】使UartPl011Port与UartDriverData可以相互转化的前提 371 ret = UartGetConfigFromHcs(port, device->property); // 将HdfDeviceObject的属性传递给驱动适配者自定义结构体，用于相关操作，示例代码见下 372 ... 373 udd->private = port; // 【7】 374 host->priv = udd; // 【必要】使UartHost与UartDriverData可以相互转化的前提 375 host->num = udd->num; // 【必要】UART设备号 376 UartAddDev(host); // 【必要】核心层uart_dev.c中的函数，作用：注册一个字符设备节点到vfs，这样从用户态可以通过这个虚拟文件节点访问UART 377 return HDF_SUCCESS; 378 } 379 380 static int32_t UartGetConfigFromHcs(struct UartPl011Port *port, const struct DeviceResourceNode *node) 381 { 382 uint32_t tmp, regPbase, iomemCount; 383 struct UartDriverData *udd = port->udd; 384 struct DeviceResourceIface *iface = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); 385 ... 386 // 通过请求参数提取相应的值，并赋值给驱动适配者自定义的结构体。 387 if (iface->GetUint32(node, "num", &udd->num, 0) != HDF_SUCCESS) { 388 HDF_LOGE("%s: read busNum fail", __func__); 389 return HDF_FAILURE; 390 } 391 ... 392 return 0; 393 } 394 ``` 395 396 - Release函数开发参考 397 398 入参： 399 400 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 401 402 返回值： 403 404 无。 405 406 函数说明： 407 408 该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源，该函数中需包含释放内存和删除控制器等操作。 409 410 >  **说明：**<br> 411 > 所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。 412 413 ```c 414 void HdfUartDeviceRelease(struct HdfDeviceObject *device) 415 { 416 struct UartHost *host = NULL; 417 ... 418 host = UartHostFromDevice(device); // 这里有HdfDeviceObject到UartHost的强制转化，通过service成员，赋值见Bind函数。 419 ... 420 if (host->priv != NULL) { 421 Hi35xxDetach(host); // 驱动适配自定义的内存释放函数，见下。 422 } 423 UartHostDestroy(host); // 调用核心层函数释放host 424 } 425 426 static void Hi35xxDetach(struct UartHost *host) 427 { 428 struct UartDriverData *udd = NULL; 429 struct UartPl011Port *port = NULL; 430 ... 431 udd = host->priv; // 这里有UartHost到UartDriverData的转化 432 ... 433 UartRemoveDev(host); // VFS注销 434 port = udd->private; // 这里有UartDriverData到UartPl011Port的转化 435 if (port != NULL) { 436 if (port->physBase != 0) { 437 OsalIoUnmap((void *)port->physBase); // 地址反映射 438 } 439 OsalMemFree(port); 440 udd->private = NULL; 441 } 442 OsalMemFree(udd); // 释放UartDriverData 443 host->priv = NULL; 444 } 445 ``` 446 4474. 驱动调试。 448 449 【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。
