!3966 【OpenHarmony开源贡献者计划2022】GPIO&HDMI相关格式及表达问题

Merge pull request !3966 from king_he/hdmi-1

zh-cn/device-dev/driver/driver-platform-gpio-des.md

@@ -26,7 +26,7 @@ GPIO接口定义了操作GPIO管脚的标准方法集合，包括：
 | GPIO配置 | -&nbsp;GpioSetDir：设置管脚方向<br/>-&nbsp;GpioGetDir：获取管脚方向 | 
 | GPIO中断设置 | -&nbsp;GpioSetIrq：设置管脚对应的中断服务函数<br/>-&nbsp;GpioUnSetIrq：取消管脚对应的中断服务函数<br/>-&nbsp;GpioEnableIrq：使能管脚中断<br/>-&nbsp;GpioDisableIrq：禁止管脚中断 | 
 
-> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
 > 本文涉及的所有接口，仅限内核态使用，不支持在用户态使用。
 
 
@@ -154,7 +154,7 @@ GPIO标准API通过GPIO管脚号来操作指定管脚，使用GPIO的一般流
   | 0 | 设置成功 | 
   | 负数 | 设置失败 | 
 
-  > ![icon-caution.gif](public_sys-resources/icon-caution.gif) **注意：**
+  > ![icon-caution.gif](public_sys-resources/icon-caution.gif) **注意：**<br>
   > 同一时间，只能为某个GPIO管脚设置一个中断服务函数，如果重复调用GpioSetIrq函数，则之前设置的中断服务函数会被取代。
 
   当不再需要响应中断服务函数时，使用如下函数取消中断设置：
@@ -183,7 +183,7 @@ GPIO标准API通过GPIO管脚号来操作指定管脚，使用GPIO的一般流
   | 0 | 使能成功 | 
   | 负数 | 使能失败 | 
 
-  > ![icon-caution.gif](public_sys-resources/icon-caution.gif) **注意：**
+  > ![icon-caution.gif](public_sys-resources/icon-caution.gif) **注意：**<br>
   > 必须通过此函数使能管脚中断，之前设置的中断服务函数才能被正确响应。
 
   如果要临时屏蔽此中断，可以通过如下函数禁止GPIO管脚中断：

zh-cn/device-dev/driver/driver-platform-gpio-develop.md

@@ -3,9 +3,7 @@
 
 ## 概述
 
-GPIO（General-purpose input/output）即通用型输入输出，在HDF框架中，
-
-GPIO的接口适配模式采用无服务模式，用于不需要在用户态提供API的设备类型，或者没有用户态和内核区分的OS系统，其关联方式是DevHandle直接指向设备对象内核态地址（DevHandle是一个void类型指针）。
+GPIO（General-purpose input/output）即通用型输入输出，在HDF框架中，GPIO的接口适配模式采用无服务模式，用于不需要在用户态提供API的设备类型，或者没有用户态和内核区分的OS系统，其关联方式是DevHandle直接指向设备对象内核态地址（DevHandle是一个void类型指针）。
 
   **图1** GPIO无服务模式结构图
 
@@ -37,35 +35,35 @@ struct GpioMethod {
 
 | 函数成员 | 入参 | 出参 | 返回值 | 功能 | 
 | -------- | -------- | -------- | -------- | -------- |
-| write | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识号&nbsp;；<br/>val：uint16_t，电平传入值； | 无 | HDF_STATUS相关状态 | GPIO引脚写入电平值 | 
-| read | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识； | val：uint16_t&nbsp;指针，用于传出电平值。 | HDF_STATUS相关状态 | GPIO引脚读取电平值 | 
-| setDir | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识号&nbsp;；<br/>dir：uint16_t，管脚方向传入值； | 无 | HDF_STATUS相关状态 | 设置GPIO引脚输入/输出方向 | 
-| getDir | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识号； | dir：uint16_t&nbsp;指针，用于传出管脚方向值。 | HDF_STATUS相关状态 | 读GPIO引脚输入/输出方向 | 
-| setIrq | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识号；<br/>mode：uint16_t，表示触发模式（边沿或电平）；<br/>func：函数指针，中断服务程序；<br/>arg：void指针，中断服务程序入参； | 无 | HDF_STATUS相关状态 | 将GPIO引脚设置为中断模式 | 
-| unsetIrq | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识号； | 无 | HDF_STATUS相关状态 | 取消GPIO中断设置 | 
-| enableIrq | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识号； | 无 | HDF_STATUS相关状态 | 使能GPIO管脚中断 | 
-| disableIrq | cntlr：结构体指针，核心层GPIO控制器；<br/>local：uint16_t，GPIO端口标识号； | 无 | HDF_STATUS相关状态 | 禁止GPIO管脚中断 | 
+| write | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识号<br/>val：uint16_t，电平传入值 | 无 | HDF_STATUS相关状态 | GPIO引脚写入电平值 | 
+| read | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识 | val：uint16_t指针，用于传出电平值。 | HDF_STATUS相关状态 | GPIO引脚读取电平值 | 
+| setDir | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识号<br/>dir：uint16_t，管脚方向传入值 | 无 | HDF_STATUS相关状态 | 设置GPIO引脚输入/输出方向 | 
+| getDir | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识号 | dir：uint16_t指针，用于传出管脚方向值 | HDF_STATUS相关状态 | 读GPIO引脚输入/输出方向 | 
+| setIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识号<br/>mode：uint16_t，表示触发模式（边沿或电平）<br/>func：函数指针，中断服务程序；<br/>arg：void指针，中断服务程序入参 | 无 | HDF_STATUS相关状态 | 将GPIO引脚设置为中断模式 | 
+| unsetIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识号 | 无 | HDF_STATUS相关状态 | 取消GPIO中断设置 | 
+| enableIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识号 | 无 | HDF_STATUS相关状态 | 使能GPIO管脚中断 | 
+| disableIrq | cntlr：结构体指针，核心层GPIO控制器<br/>local：uint16_t，GPIO端口标识号 | 无 | HDF_STATUS相关状态 | 禁止GPIO管脚中断 | 
 
 
 ## 开发步骤
 
 GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。GPIO控制器分组管理所有管脚，相关参数会在属性文件中有所体现；驱动入口和接口函数的实例化环节是厂商驱动接入HDF的核心环节。
 
-1. **实例化驱动入口：**
+1. 实例化驱动入口：
    - 实例化HdfDriverEntry结构体成员。
    - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
 
-2. **配置属性文件：**
+2. 配置属性文件：
    - 在device_info.hcs文件中添加deviceNode描述。
    - 【可选】添加gpio_config.hcs器件属性文件。
 
-3. **实例化GPIO控制器对象：**
+3. 实例化GPIO控制器对象：
    - 初始化GpioCntlr成员。
    - 实例化GpioCntlr成员GpioMethod。
-      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
       > 实例化GpioCntlr成员GpioMethod，详见[接口说明](#接口说明)。
 
-4. **驱动调试：**
+4. 驱动调试：
    【可选】针对新增驱动程序，建议验证驱动基本功能，例如GPIO控制状态，中断响应情况等。
 
 
@@ -81,19 +79,19 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
    ```
    struct HdfDriverEntry g_gpioDriverEntry = {
      .moduleVersion = 1,
-     .Bind = Pl061GpioBind,            //GPIO不需要实现Bind,本例是一个空实现，厂商可根据自身需要添加相关操作
-     .Init = Pl061GpioInit,            //见Init参考
-     .Release = Pl061GpioRelease,      //见Release参考
+     .Bind = Pl061GpioBind,            // GPIO不需要实现Bind,本例是一个空实现，厂商可根据自身需要添加相关操作
+     .Init = Pl061GpioInit,            // 见Init参考
+     .Release = Pl061GpioRelease,      // 见Release参考
      .moduleName = "hisi_pl061_driver",//【必要且需要与HCS文件中里面的moduleName匹配】
    };
-   //调用HDF_INIT将驱动入口注册到HDF框架中
+   // 调用HDF_INIT将驱动入口注册到HDF框架中
    HDF_INIT(g_gpioDriverEntry);
    ```
 
 2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在 gpio_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层GpioCntlr 成员的默认值或限制范围有密切关系。
    本例只有一个GPIO控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在gpio_config文件中增加对应的器件属性。
 
-   - device_info.hcs 配置参考。
+   - device_info.hcs配置参考
         
       ```
       root {
@@ -108,14 +106,14 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
               permission = 0644; // 驱动创建设备节点权限
               moduleName = "hisi_pl061_driver";          //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
               deviceMatchAttr = "hisilicon_hi35xx_pl061";//【必要】用于配置控制器私有数据，要与 gpio_config.hcs 中 
-                                                          //对应控制器保持一致，其他控制器信息也在文件中
+                                                          // 对应控制器保持一致，其他控制器信息也在文件中
               }
           }
           }
       }
       }
       ```
-   - gpio_config.hcs 配置参考。
+   - gpio_config.hcs配置参考
         
       ```
       root {
@@ -123,7 +121,7 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
           gpio_config {
           controller_0x120d0000 {
               match_attr = "hisilicon_hi35xx_pl061"; //【必要】必须和device_info.hcs中的deviceMatchAttr值一致
-              groupNum = 12;       //【必要】GPIO组索引 需要根据设备情况填写
+              groupNum = 12;       //【必要】GPIO组索引，需要根据设备情况填写
               bitNum = 8;          //【必要】每组GPIO管脚数 
               regBase = 0x120d0000;//【必要】物理基地址
               regStep = 0x1000;    //【必要】寄存器偏移步进
@@ -143,17 +141,17 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
         
       ```
       struct Pl061GpioCntlr {
-        struct GpioCntlr cntlr;//【必要】 是核心层控制对象，其成员定义见下面
+        struct GpioCntlr cntlr;//【必要】是核心层控制对象，其成员定义见下面
         volatile unsigned char *regBase; //【必要】寄存器基地址
-        uint32_t phyBase;      //【必要】 物理基址
-        uint32_t regStep;      //【必要】 寄存器偏移步进
-        uint32_t irqStart;     //【必要】 中断开启
-        uint16_t groupNum;     //【必要】 用于描述厂商的GPIO端口号的参数
-        uint16_t bitNum;       //【必要】 用于描述厂商的GPIO端口号的参数
-        uint8_t irqShare;      //【必要】 共享中断
-        struct Pl061GpioGroup *groups;   //【可选】 根据厂商需要设置
+        uint32_t phyBase;      //【必要】物理基址
+        uint32_t regStep;      //【必要】寄存器偏移步进
+        uint32_t irqStart;     //【必要】中断开启
+        uint16_t groupNum;     //【必要】用于描述厂商的GPIO端口号的参数
+        uint16_t bitNum;       //【必要】用于描述厂商的GPIO端口号的参数
+        uint8_t irqShare;      //【必要】共享中断
+        struct Pl061GpioGroup *groups;   //【可选】根据厂商需要设置
       };
-      struct Pl061GpioGroup {  //包括寄存器地址，中断号，中断函数和和锁
+      struct Pl061GpioGroup {  // 包括寄存器地址，中断号，中断函数和和锁
         volatile unsigned char *regBase;
         unsigned int index;
         unsigned int irq;
@@ -182,15 +180,15 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
       static struct GpioMethod g_method = {
           .request = NULL,
           .release = NULL,
-          .write = Pl061GpioWrite,          //写管脚
-          .read = Pl061GpioRead,            //读管脚
-          .setDir = Pl061GpioSetDir,        //设置管脚方向
-          .getDir = Pl061GpioGetDir,        //获取管脚方向
+          .write = Pl061GpioWrite,          // 写管脚
+          .read = Pl061GpioRead,            // 读管脚
+          .setDir = Pl061GpioSetDir,        // 设置管脚方向
+          .getDir = Pl061GpioGetDir,        // 获取管脚方向
           .toIrq = NULL,
-          .setIrq = Pl061GpioSetIrq,        //设置管脚中断，如不具备此能力可忽略
-          .unsetIrq = Pl061GpioUnsetIrq,    //取消管脚中断设置，如不具备此能力可忽略
-          .enableIrq = Pl061GpioEnableIrq,  //使能管脚中断，如不具备此能力可忽略
-          .disableIrq = Pl061GpioDisableIrq,//禁止管脚中断，如不具备此能力可忽略
+          .setIrq = Pl061GpioSetIrq,        // 设置管脚中断，如不具备此能力可忽略
+          .unsetIrq = Pl061GpioUnsetIrq,    // 取消管脚中断设置，如不具备此能力可忽略
+          .enableIrq = Pl061GpioEnableIrq,  // 使能管脚中断，如不具备此能力可忽略
+          .disableIrq = Pl061GpioDisableIrq,// 禁止管脚中断，如不具备此能力可忽略
       };
       ```
 
@@ -224,13 +222,13 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
       static int32_t Pl061GpioInit(struct HdfDeviceObject *device)
       {
         ...
-        struct Pl061GpioCntlr *pl061 = &g_pl061;//利用静态全局变量完成初始化
-                                                //static struct Pl061GpioCntlr g_pl061 = {
+        struct Pl061GpioCntlr *pl061 = &g_pl061;// 利用静态全局变量完成初始化
+                                                // static struct Pl061GpioCntlr g_pl061 = {
                                                 //    .groups = NULL,
                                                 //    .groupNum = PL061_GROUP_MAX,
                                                 //    .bitNum = PL061_BIT_MAX,
                                                 //};
-        ret = Pl061GpioReadDrs(pl061, device->property);//利用从gpio_config.HCS文件读取的属性值来初始化自定义结构体对象成员
+        ret = Pl061GpioReadDrs(pl061, device->property);// 利用从gpio_config.HCS文件读取的属性值来初始化自定义结构体对象成员
         ...
         pl061->regBase = OsalIoRemap(pl061->phyBase, pl061->groupNum * pl061->regStep);//地址映射
         ...
@@ -251,11 +249,11 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
         ...
       }
       ```
-   - Release 函数参考
+   - Release函数参考
 
       入参：
 
-      HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息。
+      HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
 
       返回值：
 
@@ -263,7 +261,7 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       函数说明：
 
-      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给 Release 接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用 Release 释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
+      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release 接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
 
         
       ```
@@ -273,13 +271,13 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
          struct Pl061GpioCntlr *pl061 = NULL;
          ...
          cntlr = GpioCntlrFromDevice(device);//【必要】通过强制转换获取核心层控制对象
-                                             //return (device == NULL) ? NULL : (struct GpioCntlr *)device->service;
+                                             // return (device == NULL) ? NULL : (struct GpioCntlr *)device->service;
          ...
          #ifdef PL061_GPIO_USER_SUPPORT
          GpioRemoveVfs();//与Init中GpioAddVfs相反
          #endif
          GpioCntlrRemove(cntlr);             //【必要】取消设备信息、服务等内容在核心层上的挂载
-         pl061 = ToPl061GpioCntlr(cntlr);    //return (struct Pl061GpioCntlr *)cntlr;
+         pl061 = ToPl061GpioCntlr(cntlr);    // return (struct Pl061GpioCntlr *)cntlr;
          Pl061GpioRleaseCntlrMem(pl061);     //【必要】锁和内存的释放
          OsalIoUnmap((void *)pl061->regBase);//【必要】解除地址映射
          pl061->regBase = NULL;

zh-cn/device-dev/driver/driver-platform-hdmi-des.md

@@ -5,15 +5,15 @@
 
 ### 功能简介
 
-- HDMI（High Definition Multimedia Interface），即高清多媒体接口，主要用于DVD、机顶盒等音视频Source到TV、显示器等Sink设备的传输。
-- HDMI以主从方式工作，通常有一个Source端和一个Sink端。
-- HDMI接口定义了完成HDMI传输的通用方法集合，包括：
+HDMI（High Definition Multimedia Interface），即高清多媒体接口，主要用于DVD、机顶盒等音视频Source到TV、显示器等Sink设备的传输。
+HDMI以主从方式工作，通常有一个Source端和一个Sink端。
+HDMI接口定义了完成HDMI传输的通用方法集合，包括：
 
-    - HDMI控制器管理：打开或关闭HDMI控制器
-    - HDMI启动/停止传输：启动或停止HDMI传输
-    - HDMI控制器设置：设置音频、视频及HDR属性，设置色彩深度、声音图像消隐等
-    - HDMI读取EDID：读取Sink端原始的EDID数据
-    - HDMI热插拔：注册/注销热插拔回调函数
+- HDMI控制器管理：打开或关闭HDMI控制器
+- HDMI启动/停止传输：启动或停止HDMI传输
+- HDMI控制器设置：设置音频、视频及HDR属性，设置色彩深度、声音图像消隐等
+- HDMI读取EDID：读取Sink端原始的EDID数据
+- HDMI热插拔：注册/注销热插拔回调函数
 
 ### 基本概念
 
@@ -22,9 +22,9 @@ HDMI是Hitachi、Panasonic、Philips、Silicon Image、Sony、Thomson、Toshiba
 - TMDS（Transition Minimized Differential signal）：过渡调制差分信号，也被称为最小化传输差分信号，用于发送音频、视频及各种辅助数据。
 - DDC（Display Data Channel）：显示数据通道，发送端与接收端可利用DDC通道得知彼此的发送与接收能力，但HDMI仅需单向获知接收端（显示器）的能力。
 - CEC（Consumer Electronics Control）：消费电子控制，该功能应该能够在连接HDMI的发送设备与接收设备之间实现交互操作。
-- FRL（Fixed Rate Link）：TMDS 的架构进行讯号传输时，最高带宽可达 18Gbps，而 FRL 模式的带宽则提升到 48 Gbps。
+- FRL（Fixed Rate Link）：TMDS 的架构进行讯号传输时，最高带宽可达 18Gbps，而FRL模式的带宽则提升到48 Gbps。
 - HDCP（High-bandwidth Digital Content Protection）：即高带宽数字内容保护技术，当用户对高清晰信号进行非法复制时，该技术会进行干扰，降低复制出来的影像的质量，从而对内容进行保护。
-- EDID（Extended Display Identification Data）：扩展显示标识数据， 通常存储在显示器的固件中，标识供应商信息、EDID版本信息、最大图像大小、颜色设置、厂商预设置、频率范围的限制以及显示器名和序列号的字符串。
+- EDID（Extended Display Identification Data）：扩展显示标识数据，通常存储在显示器的固件中，标识供应商信息、EDID版本信息、最大图像大小、颜色设置、厂商预设置、频率范围的限制以及显示器名和序列号的字符串。
 
 ### 运作机制
 
@@ -38,7 +38,7 @@ HDMI物理连接如图1所示：
 
 ### 约束与限制
 
-HDMI模块当前仅支持轻量和小型系统内核（LiteOS） 。
+HDMI模块当前仅支持轻量和小型系统内核（LiteOS）。
 
 ## 使用指导
 
@@ -92,7 +92,7 @@ DevHandle HdmiOpen(int16_t number);
 | NULL       | 打开HDMI控制器失败   |
 | 控制器句柄 | 打开的HDMI控制器句柄 |
 
-假设系统中存在2个HDMI控制器，编号从0到1，那么我们现在获取0号控制器：
+假设系统中存在2个HDMI控制器，编号从0到1，以下代码示例为获取0号控制器：
 
 ```c
 DevHandle hdmiHandle = NULL;  /* HDMI控制器句柄 /