!7826 驱动资料规范性检查（2），涉及翻译。

Merge pull request !7826 from liyan/master

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

@@ -34,35 +34,40 @@ struct AdcMethod {
 
 ## 开发步骤
 
-ADC模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
+ADC模块适配必选的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
 
-1. 实例化驱动入口：
+1. 实例化驱动入口
    - 实例化HdfDriverEntry结构体成员。
    - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
 
-2. 配置属性文件：
+2. 配置属性文件
    - 在device_info.hcs文件中添加deviceNode描述。
    - 【可选】添加adc_config.hcs器件属性文件。
 
-3. 实例化ADC控制器对象：
+3. 实例化ADC控制器对象
    - 初始化AdcDevice成员。
    - 实例化AdcDevice成员AdcMethod。
       > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
       > 实例化AdcDevice成员AdcMethod，其定义和成员说明见[接口说明](#接口说明)。
 
-4. 驱动调试：
+4. 驱动调试
+
    【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，信号采集的成功与否等。
 
 
 ## 开发实例
 
   接下来以adc_hi35xx.c为示例， 展示需要厂商提供哪些内容来完整实现设备功能。
-1. 驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
+
+1. 驱动开发首先需要实例化驱动入口。
+
+   驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
+
    一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
 
    ADC驱动入口参考：
 
-   ADC模块这种类型的控制器会出现很多个设备挂接的情况，因而在HDF框架中首先会为这类型的设备创建一个管理器对象。这样，需要打开某个设备时，管理器对象会根据指定参数查找到指定设备。
+   ADC控制器会出现多个设备挂接的情况，因而在HDF框架中首先会为此类型的设备创建一个管理器对象。这样，需要打开某个设备时，管理器对象会根据指定参数查找到指定设备。
 
    ADC管理器的驱动由核心层实现，厂商不需要关注这部分内容的实现，但在实现Init函数的时候需要调用核心层的AdcDeviceAdd函数，它会实现相应功能。
 
@@ -72,7 +77,7 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
     .moduleVersion = 1,
     .Init = Hi35xxAdcInit,
     .Release = Hi35xxAdcRelease,
-    .moduleName = "hi35xx_adc_driver",//【必要且与HCS文件里面的名字匹配】
+    .moduleName = "hi35xx_adc_driver",       //【必要且与HCS文件里面的名字匹配】
    };
    HDF_INIT(g_hi35xxAdcDriverEntry);         // 调用HDF_INIT将驱动入口注册到HDF框架中
    
@@ -86,8 +91,13 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
    HDF_INIT(g_adcManagerEntry);
    ```
 
-2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在adc_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值对于厂商驱动的实现以及核心层AdcDevice相关成员的默认值或限制范围有密切关系。
+2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在adc_config.hcs中配置器件属性。
+
+    deviceNode信息与驱动入口注册相关，器件属性值对于厂商驱动的实现以及核心层AdcDevice相关成员的默认值或限制范围有密切关系。
+
    统一服务模式的特点是device_info文件中第一个设备节点必须为ADC管理器，其各项参数必须如下设置：
+
+
    | 成员名 | 值 | 
    | -------- | -------- |
    | moduleName | 固定为HDF_PLATFORM_ADC_MANAGER | 
@@ -95,6 +105,7 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
    | policy | 具体配置为0，不发布服务 | 
    | deviceMatchAttr | 没有使用，可忽略 | 
 
+
    从第二个节点开始配置具体ADC控制器信息，此节点并不表示某一路ADC控制器，而是代表一个资源性质设备，用于描述一类ADC控制器的信息。本例只有一个ADC设备，如有多个设备，则需要在device_info文件增加deviceNode信息，以及在adc_config文件中增加对应的器件属性。
 
    - device_info.hcs配置参考
@@ -113,13 +124,14 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
               serviceName = "HDF_PLATFORM_ADC_MANAGER";
           }
           device1 :: deviceNode {
-              policy = 0;         // 等于0，不需要发布服务
-              priority = 55;      // 驱动启动优先级
-              permission = 0644;  // 驱动创建设备节点权限
-              moduleName = "hi35xx_adc_driver";        //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
-              serviceName = "HI35XX_ADC_DRIVER";       //【必要】驱动对外发布服务的名称，必须唯一
-              deviceMatchAttr = "hisilicon_hi35xx_adc";//【必要】用于配置控制器私有数据，要与adc_config.hcs中对应控制器保持一致
-              }                                        // 具体的控制器信息在 adc_config.hcs 中
+              policy = 0;                              // 等于0，不需要发布服务。
+              priority = 55;                           // 驱动启动优先级。
+              permission = 0644;                       // 驱动创建设备节点权限。
+              moduleName = "hi35xx_adc_driver";        //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
+              serviceName = "HI35XX_ADC_DRIVER";       //【必要】驱动对外发布服务的名称，必须唯一。
+              deviceMatchAttr = "hisilicon_hi35xx_adc";//【必要】用于配置控制器私有数据，要与adc_config.hcs中对应控制器保持一致，
+                                                       // 具体的控制器信息在adc_config.hcs中。
+              }                                        
             }
           }
         }
@@ -154,15 +166,16 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
       }
       ```
 
-3. 完成驱动入口注册之后，最后一步就是以核心层AdcDevice对象的初始化为核心，包括初始化厂商自定义结构体（传递参数和数据），实例化AdcDevice成员AdcMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
+3. 完成驱动入口注册之后，下一步就是以核心层AdcDevice对象的初始化为核心，包括初始化厂商自定义结构体（传递参数和数据），实例化AdcDevice成员AdcMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
+
    - 自定义结构体参考。
 
-      从驱动的角度看，自定义结构体是参数和数据的载体，而且adc_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，其中一些重要数值也会传递给核心层AdcDevice对象，例如设备号、总线号等。
+     从驱动的角度看，自定义结构体是参数和数据的载体，而且adc_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，其中一些重要数值也会传递给核心层AdcDevice对象，例如设备号、总线号等。
 
       
       ```
       struct Hi35xxAdcDevice {
-          struct AdcDevice device;//【必要】是核心层控制对象，具体描述见下面
+          struct AdcDevice device;        //【必要】是核心层控制对象，具体描述见下面。
           volatile unsigned char *regBase;//【必要】寄存器基地址
           volatile unsigned char *pinCtrlBase;
           uint32_t regBasePhy;            //【必要】寄存器物理基地址
@@ -177,7 +190,7 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
           uint32_t rate;                  //【必要】采样率
       };
       
-      // AdcDevice是核心层控制器结构体，其中的成员在Init函数中会被赋值
+      // AdcDevice是核心层控制器结构体，其中的成员在Init函数中会被赋值。
       struct AdcDevice {
           const struct AdcMethod *ops;
           OsalSpinlock spin;
@@ -188,7 +201,9 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
       };
       ```
 
-   - AdcDevice成员回调函数结构体AdcMethod的实例化，AdcLockMethod回调函数结构体本例未实现，若要实例化，可参考I2C驱动开发，其他成员在Init函数中初始化。
+   - AdcDevice成员回调函数结构体AdcMethod的实例化。
+
+     AdcLockMethod回调函数结构体本例未实现，若要实例化，可参考I2C驱动开发，其他成员在Init函数中初始化。
 
      
       ```
@@ -202,7 +217,7 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       入参：
 
-      HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
+      HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
 
       返回值：
 
@@ -227,7 +242,7 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
           int32_t ret;
           struct DeviceResourceNode *childNode = NULL;
           ...
-          // 遍历、解析adc_config.hcs中的所有配置节点，并分别调用Hi35xxAdcParseInit函数来初始化device    
+          // 遍历、解析adc_config.hcs中的所有配置节点，并分别调用Hi35xxAdcParseInit函数来初始化device。   
           DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
               ret = Hi35xxAdcParseInit(device, childNode);// 函数定义见下
               ...
@@ -253,12 +268,12 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
       hi35xx->device.priv = (void *)node;       //【必要】存储设备属性
       hi35xx->device.devNum = hi35xx->deviceNum;//【必要】初始化AdcDevice成员
       hi35xx->device.ops = &g_method;           //【必要】AdcMethod的实例化对象的挂载
-      ret = AdcDeviceAdd(&hi35xx->device);      //【必要且重要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层 
+      ret = AdcDeviceAdd(&hi35xx->device);      //【必要且重要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层。
       ...
       return HDF_SUCCESS;
       
       __ERR__:
-      if (hi35xx != NULL) {                     // 不成功的话，需要反向执行初始化相关函数
+      if (hi35xx != NULL) {                     // 不成功的话，需要反向执行初始化相关函数。
           if (hi35xx->regBase != NULL) {
           OsalIoUnmap((void *)hi35xx->regBase);
           hi35xx->regBase = NULL;
@@ -273,7 +288,7 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       入参：
 
-      HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
+      HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
 
       返回值：
 
@@ -281,7 +296,10 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       函数说明：
 
-      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
+      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
+
+      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
+      > 所有强制转换获取相应对象的操作的前提是在Init函数中具备对应赋值的操作。
 
       
       ```
@@ -289,7 +307,7 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
       {
       const struct DeviceResourceNode *childNode = NULL;
       ...
-      // 遍历、解析adc_config.hcs中的所有配置节点，并分别进行release操作
+      // 遍历、解析adc_config.hcs中的所有配置节点，并分别进行Release操作。
       DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
           Hi35xxAdcRemoveByNode(childNode);// 函数定义见下
       }
@@ -307,12 +325,12 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
       ...
       ret = drsOps->GetUint32(node, "deviceNum", (uint32_t *)&deviceNum, 0);
       ...
-      // 可以调用AdcDeviceGet函数通过设备的deviceNum获取AdcDevice对象，以及调用AdcDeviceRemove函数来释放AdcDevice对象的内容
+      // 可以调用AdcDeviceGet函数通过设备的deviceNum获取AdcDevice对象，以及调用AdcDeviceRemove函数来释放AdcDevice对象的内容。
       device = AdcDeviceGet(deviceNum);
       if (device != NULL && device->priv == node) {
           AdcDevicePut(device);   
           AdcDeviceRemove(device);                  //【必要】主要是从管理器驱动那边移除AdcDevice对象
-          hi35xx = (struct Hi35xxAdcDevice *)device;//【必要】通过强制转换获取自定义的对象并进行release操作
+          hi35xx = (struct Hi35xxAdcDevice *)device;//【必要】通过强制转换获取自定义的对象并进行Release操作
           OsalIoUnmap((void *)hi35xx->regBase);
           OsalMemFree(hi35xx);
       }

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

@@ -8,8 +8,8 @@ DAC（Digital to Analog Converter）是一种通过电流、电压或电荷的
 
 DAC模块支持数模转换的开发。它主要用于：
 
-1. 作为过程控制计算机系统的输出通道，与执行器相连，实现对生产过程的自动控制。
-2. 在利用反馈技术的魔术转换器设计中，作为重要的功能模块呈现。
+- 作为过程控制计算机系统的输出通道，与执行器相连，实现对生产过程的自动控制。
+- 在利用反馈技术的魔术转换器设计中，作为重要的功能模块呈现。
 
 ### 基本概念
 
@@ -25,13 +25,13 @@ DAC模块支持数模转换的开发。它主要用于：
 
   转换速度一般由建立时间决定。从输入由全0突变为全1时开始，到输出电压稳定在FSR±½LSB范围（或以FSR±x%FSR指明范围）内为止，这段时间称为建立时间，它是DAC的最大响应时间，所以用它衡量转换速度的快慢。
 
-  满量程范围FSR（ Full Scale Range ），是指DAC输出信号幅度的最大范围，不同的DAC有不同的满量程范围， 该范围可以用正、负电流或者正、负电压来限制 。
+  - 满量程范围FSR（Full Scale Range），是指DAC输出信号幅度的最大范围，不同的DAC有不同的满量程范围，该范围可以用正、负电流或者正、负电压来限制。
 
-  最低有效位LSB（Least Significant Byte），指的是一个二进制数字中的第0位（即最低位）。
+  - 最低有效位LSB（Least Significant Byte），指的是一个二进制数字中的第0位（即最低位）。
 
 ### 运作机制
 
-在HDF框架中，同类型设备对象较多时（可能同时存在十几个同类型配置器），若采用独立服务模式，则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现）,实现便捷管理和节约资源的目的。DAC模块接口适配模式采用统一服务模式（如图1所示）。 
+在HDF框架中，同类型设备对象较多时（可能同时存在十几个同类型配置器），若采用独立服务模式，则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现），实现便捷管理和节约资源的目的。DAC模块接口适配模式采用统一服务模式（如图1所示）。 
 
 DAC模块各分层的作用为：接口层提供打开设备、写入数据和关闭设备接口的能力。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。
 
@@ -100,7 +100,7 @@ DAC模块适配包含以下四个步骤：
         .moduleVersion = 1,
         .Init = VirtualDacInit,
         .Release = VirtualDacRelease,
-        .moduleName = "virtual_dac_driver", //【必要且与 HCS 里面的名字匹配】
+        .moduleName = "virtual_dac_driver", //【必要且与HCS里面的名字匹配】
         };
         HDF_INIT(g_dacDriverEntry);         // 调用HDF_INIT将驱动入口注册到HDF框架中
     ```
@@ -124,7 +124,7 @@ DAC模块适配包含以下四个步骤：
 
      从第二个节点开始配置具体DAC控制器信息，此节点并不表示某一路DAC控制器，而是代表一个资源性质设备，用于描述一类DAC控制器的信息。本例只有一个DAC设备，如有多个设备，则需要在device_info文件增加deviceNode信息，以及在dac_config文件中增加对应的器件属性。
 
-        device_info.hcs配置参考。
+        device_info.hcs配置参考：
 
         ```hcs
         root {
@@ -143,14 +143,15 @@ DAC模块适配包含以下四个步骤：
                 policy = 0;
                 priority = 56;
                 permission = 0644;
-                moduleName = "virtual_dac_driver";        //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致
-                serviceName = "VIRTUAL_DAC_DRIVER";       //【必要】驱动对外发布服务的名称，必须唯一
-                deviceMatchAttr = "virtual_dac";          //【必要】用于配置控制器私有数据，要与dac_config.hcs中对应控制器保持一致
+                moduleName = "virtual_dac_driver";        //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
+                serviceName = "VIRTUAL_DAC_DRIVER";       //【必要】驱动对外发布服务的名称，必须唯一。
+                deviceMatchAttr = "virtual_dac";          //【必要】用于配置控制器私有数据，要与dac_config.hcs中对应控制器保持一致。
                 }                                          
         }
         ```
 
-    - 添加dac_test_config.hcs器件属性文件 
+    - 添加dac_test_config.hcs器件属性文件。
+
       在vendor/vendor_hisilicon/hispark_taurus/hdf_config/hdf_test/xxx_test_config.hcs目录下新增文件用于驱动配置参数，（例如：vendor/vendor_hisilicon/hispark_taurus/hdf_config/hdf_test/dac_test_config.hcs）其中配置参数如下：
 
         ```hcs
@@ -252,7 +253,7 @@ DAC模块适配包含以下四个步骤：
           uint32_t rate;           //【必要】采样率
       };
       
-      // DacDevice是核心层控制器结构体，其中的成员在Init函数中会被赋值
+      // DacDevice是核心层控制器结构体，其中的成员在Init函数中会被赋值。
       struct DacDevice {
           const struct DacMethod *ops;
           OsalSpinlock spin;       // 自旋锁
@@ -282,7 +283,7 @@ DAC模块适配包含以下四个步骤：
     
         入参：
     
-        HdfDeviceObject这个是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
+        HdfDeviceObject这个是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
     
         返回值：
     
@@ -383,7 +384,7 @@ DAC模块适配包含以下四个步骤：
         
           入参：
         
-          HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
+          HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
         
           返回值：
         
@@ -391,7 +392,10 @@ DAC模块适配包含以下四个步骤：
         
           函数说明：
         
-          释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
+          释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
+
+         ![](../public_sys-resources/icon-note.gif) **说明：**<br>
+          所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
       
         ```c++
         static void VirtualDacRemoveByNode(const struct DeviceResourceNode *node)

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

@@ -47,23 +47,26 @@ struct GpioMethod {
 
 ## 开发步骤
 
-GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。GPIO控制器分组管理所有管脚，相关参数会在属性文件中有所体现；驱动入口和接口函数的实例化环节是厂商驱动接入HDF的核心环节。
+GPIO模块适配的三个必选环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
 
-1. 实例化驱动入口：
+GPIO控制器分组管理所有管脚，相关参数会在属性文件中有所体现；驱动入口和接口函数的实例化环节是厂商驱动接入HDF的核心环节。
+
+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) **说明：**<br>
       > 实例化GpioCntlr成员GpioMethod，详见[接口说明](#接口说明)。
 
-4. 驱动调试：
+4. 驱动调试
+
    【可选】针对新增驱动程序，建议验证驱动基本功能，例如GPIO控制状态，中断响应情况等。
 
 
@@ -71,7 +74,10 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
 
 下方将以gpio_hi35xx.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。
 
-1. 驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
+1. 驱动开发首先需要实例化驱动入口。
+
+   驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
+
    一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
 
      GPIO 驱动入口参考：
@@ -79,7 +85,7 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
    ```
    struct HdfDriverEntry g_gpioDriverEntry = {
      .moduleVersion = 1,
-     .Bind = Pl061GpioBind,            // GPIO不需要实现Bind,本例是一个空实现，厂商可根据自身需要添加相关操作
+     .Bind = Pl061GpioBind,            // GPIO不需要实现Bind，本例是一个空实现，厂商可根据自身需要添加相关操作。
      .Init = Pl061GpioInit,            // 见Init参考
      .Release = Pl061GpioRelease,      // 见Release参考
      .moduleName = "hisi_pl061_driver",//【必要且需要与HCS文件中里面的moduleName匹配】
@@ -88,7 +94,10 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
    HDF_INIT(g_gpioDriverEntry);
    ```
 
-2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在 gpio_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层GpioCntlr 成员的默认值或限制范围有密切关系。
+2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在gpio_config.hcs中配置器件属性。
+
+   deviceNode信息与驱动入口注册相关，器件属性值与核心层GpioCntlr成员的默认值或限制范围有密切关系。
+
    本例只有一个GPIO控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在gpio_config文件中增加对应的器件属性。
 
    - device_info.hcs配置参考
@@ -101,12 +110,12 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
           priority = 50;
           device_gpio :: device {
               device0 :: deviceNode {
-              policy = 0;        // 等于0，不需要发布服务
-              priority = 10;     // 驱动启动优先级
-              permission = 0644; // 驱动创建设备节点权限
-              moduleName = "hisi_pl061_driver";           //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
-              deviceMatchAttr = "hisilicon_hi35xx_pl061"; //【必要】用于配置控制器私有数据，要与 gpio_config.hcs 中 
-                                                          // 对应控制器保持一致，其他控制器信息也在文件中
+              policy = 0;                                 // 等于0，不需要发布服务。
+              priority = 10;                              // 驱动启动优先级。
+              permission = 0644;                          // 驱动创建设备节点权限。
+              moduleName = "hisi_pl061_driver";           //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
+              deviceMatchAttr = "hisilicon_hi35xx_pl061"; //【必要】用于配置控制器私有数据，要与gpio_config.hcs中 
+                                                          // 对应控制器保持一致，其他控制器信息也在文件中。
               }
           }
           }
@@ -120,38 +129,39 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
       platform {
           gpio_config {
           controller_0x120d0000 {
-              match_attr = "hisilicon_hi35xx_pl061"; //【必要】必须和device_info.hcs中的deviceMatchAttr值一致
-              groupNum = 12;       //【必要】GPIO组索引，需要根据设备情况填写
-              bitNum = 8;          //【必要】每组GPIO管脚数 
-              regBase = 0x120d0000;//【必要】物理基地址
-              regStep = 0x1000;    //【必要】寄存器偏移步进
-              irqStart = 48;       //【必要】开启中断
-              irqShare = 0;        //【必要】共享中断
+              match_attr = "hisilicon_hi35xx_pl061"; //【必要】必须和device_info.hcs中的deviceMatchAttr值一致。
+              groupNum = 12;                         //【必要】GPIO组索引，需要根据设备情况填写。
+              bitNum = 8;                            //【必要】每组GPIO管脚数 。
+              regBase = 0x120d0000;                  //【必要】物理基地址。
+              regStep = 0x1000;                      //【必要】寄存器偏移步进。
+              irqStart = 48;                         //【必要】开启中断。
+              irqShare = 0;                          //【必要】共享中断。
           }
           }
       }
       } 
       ```
 
-3. 完成驱动入口注册之后，最后一步就是以核心层GpioCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化GpioCntlr成员GpioMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
+3. 完成驱动入口注册之后，下一步就是以核心层GpioCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化GpioCntlr成员GpioMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
+
    - 自定义结构体参考。
 
-      从驱动的角度看，自定义结构体是参数和数据的载体，而且gpio_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，其中一些重要数值也会传递给核心层GpioCntlr对象，例如索引、管脚数等。
+      从驱动的角度看，自定义结构体是参数和数据的载体，而且gpio_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，其中一些重要数值也会传递给核心层GpioCntlr对象，例如索引、管脚数等。
 
         
       ```
       struct Pl061GpioCntlr {
-        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;   //【可选】根据厂商需要设置
+        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;   //【可选】根据厂商需要设置。
       };
-      struct Pl061GpioGroup {  // 包括寄存器地址，中断号，中断函数和和锁
+      struct Pl061GpioGroup {            // 包括寄存器地址，中断号，中断函数和锁。
         volatile unsigned char *regBase;
         unsigned int index;
         unsigned int irq;
@@ -159,7 +169,7 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
         OsalSpinlock lock;
       };
       
-      // GpioCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值
+      // GpioCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。
       struct GpioCntlr {
         struct IDeviceIoService service;
         struct HdfDeviceObject *device;
@@ -180,15 +190,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,// 禁止管脚中断，如不具备此能力可忽略。
       };
       ```
 
@@ -200,7 +210,7 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       返回值：
 
-      HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。
+      HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
 
         **表2** Init函数说明
       
@@ -215,7 +225,7 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       函数说明：
 
-      初始化自定义结构体对象，初始化GpioCntlr成员，调用核心层GpioCntlrAdd函数，【可选】接入VFS。
+      初始化自定义结构体对象，初始化GpioCntlr成员，调用核心层GpioCntlrAdd函数，接入VFS（可选）。
 
         
       ```
@@ -236,12 +246,12 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
         ...
         pl061->cntlr.count = pl061->groupNum * pl061->bitNum;//【必要】管脚数量计算
         pl061->cntlr.priv = (void *)device->property;        //【必要】存储设备属性
-        pl061->cntlr.ops = &g_method;           // 【必要】GpioMethod的实例化对象的挂载 
-        pl061->cntlr.device = device;           // 【必要】使HdfDeviceObject与GpioCntlr可以相互转化的前提
-        ret = GpioCntlrAdd(&pl061->cntlr);      // 【必要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层
+        pl061->cntlr.ops = &g_method;                        //【必要】GpioMethod的实例化对象的挂载 
+        pl061->cntlr.device = device;                        //【必要】使HdfDeviceObject与GpioCntlr可以相互转化的前提
+        ret = GpioCntlrAdd(&pl061->cntlr);                   //【必要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层。
         ...
         Pl061GpioDebugCntlr(pl061);
-        #ifdef PL061_GPIO_USER_SUPPORT            //【可选】若支持用户级的虚拟文件系统，则接入
+        #ifdef PL061_GPIO_USER_SUPPORT            //【可选】若支持用户级的虚拟文件系统，则接入。
         if (GpioAddVfs(pl061->bitNum) != HDF_SUCCESS) {
             HDF_LOGE("%s: add vfs fail!", __func__);
         }
@@ -261,7 +271,10 @@ GPIO模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       函数说明：
 
-      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release 接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
+      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
+
+      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
+      > 所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
 
         
       ```

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

@@ -3,7 +3,7 @@
 
 ## 概述
 
-I2C（Inter Integrated Circuit）总线是由Philips公司开发的一种简单、双向二线制同步串行总线,在HDF框架中，I2C模块接口适配模式采用统一服务模式，这需要一个设备服务来作为I2C模块的管理器，统一处理外部访问，这会在配置文件中有所体现。统一服务模式适合于同类型设备对象较多的情况，如I2C可能同时具备十几个控制器，采用独立服务模式需要配置更多的设备节点，且服务会占据内存资源。
+I2C（Inter Integrated Circuit）总线是由Philips公司开发的一种简单、双向二线制同步串行总线。在HDF框架中，I2C模块接口适配模式采用统一服务模式，这需要一个设备服务来作为I2C模块的管理器，统一处理外部访问，这会在配置文件中有所体现。统一服务模式适合于同类型设备对象较多的情况，如I2C可能同时具备十几个控制器，采用独立服务模式需要配置更多的设备节点，且服务会占据内存资源。
 
   **图1** I2C统一服务模式结构图
 
@@ -34,23 +34,27 @@ struct I2cLockMethod {// 锁机制操作结构体
 
 ## 开发步骤
 
-I2C模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
+I2C模块适配的三个必选环节是实例化驱动入口，配置属性文件，以及实例化核心层接口函数。
+
+1. 实例化驱动入口
 
-1. 实例化驱动入口：
    - 实例化HdfDriverEntry结构体成员。
    - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
 
-2. 配置属性文件：
+2. 配置属性文件
+
    - 在device_info.hcs文件中添加deviceNode描述。
    - 【可选】添加i2c_config.hcs器件属性文件。
 
-3. 实例化I2C控制器对象：
+3. 实例化I2C控制器对象
+
    - 初始化I2cCntlr成员。
    - 实例化I2cCntlr成员I2cMethod和I2cLockMethod。
       > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
       > 实例化I2cCntlr成员I2cMethod和I2cLockMethod，详见[接口说明](#接口说明)。
 
-4. 驱动调试：
+4. 驱动调试
+
    【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，消息传输的成功与否等。
 
 
@@ -58,14 +62,17 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
 
 下方将以i2c_hi35xx.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。
 
-1. 驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
+1. 驱动开发首先需要实例化驱动入口。
+
+   驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
+
    一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
 
    I2C驱动入口参考：
 
-   I2C模块这种类型的控制器会出现很多个设备挂接的情况，因而在HDF框架中首先会为这类型的设备创建一个管理器对象，并同时对外发布一个管理器服务来统一处理外部访问。这样，用户需要打开某个设备时，会先获取到管理器服务，然后管理器服务根据用户指定参数查找到指定设备。
+   I2C控制器会出现很多个设备挂接的情况，因而在HDF框架中首先会为此类型的设备创建一个管理器对象，并同时对外发布一个管理器服务来统一处理外部访问。这样，用户需要打开某个设备时，会先获取到管理器服务，然后管理器服务根据用户指定参数查找到指定设备。
 
-   I2C管理器服务的驱动由核心层实现，厂商不需要关注这部分内容的实现，这个但在实现Init函数的时候需要调用核心层的I2cCntlrAdd函数，它会实现相应功能。
+   I2C管理器服务的驱动由核心层实现，厂商不需要关注这部分内容的实现，但在实现Init函数的时候需要调用核心层的I2cCntlrAdd函数，它会实现相应功能。
 
      
    ```
@@ -73,7 +80,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
        .moduleVersion = 1,
        .Init = Hi35xxI2cInit,
        .Release = Hi35xxI2cRelease,
-       .moduleName = "hi35xx_i2c_driver",// 【必要且与config.hcs文件里面匹配】
+       .moduleName = "hi35xx_i2c_driver",         // 【必要且与config.hcs文件里面匹配】
    };
    HDF_INIT(g_i2cDriverEntry);                    // 调用HDF_INIT将驱动入口注册到HDF框架中
    
@@ -83,12 +90,15 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
        .Bind = I2cManagerBind,
        .Init = I2cManagerInit,
        .Release = I2cManagerRelease,
-       .moduleName = "HDF_PLATFORM_I2C_MANAGER",// 这与device_info文件中device0对应
+       .moduleName = "HDF_PLATFORM_I2C_MANAGER",  // 这与device_info文件中device0对应
    };
    HDF_INIT(g_i2cManagerEntry);
    ```
 
-2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在i2c_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值对于厂商驱动的实现以及核心层I2cCntlr相关成员的默认值或限制范围有密切关系。
+2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在i2c_config.hcs中配置器件属性。
+
+   deviceNode信息与驱动入口注册相关，器件属性值对于厂商驱动的实现以及核心层I2cCntlr相关成员的默认值或限制范围有密切关系。
+
    统一服务模式的特点是device_info文件中第一个设备节点必须为I2C管理器，其各项参数必须如表2设置：
 
      **表2** 统一服务模式的特点
@@ -101,6 +111,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
    | deviceMatchAttr | 没有使用，可忽略 | 
 
      从第二个节点开始配置具体I2C控制器信息，此节点并不表示某一路I2C控制器，而是代表一个资源性质设备，用于描述一类I2C控制器的信息。多个控制器之间相互区分的参数是busID和reg_pbase，这在i2c_config文件中有所体现。
+
    - device_info.hcs配置参考
    
        
@@ -118,13 +129,13 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
              deviceMatchAttr = "hdf_platform_i2c_manager";
          }
          device1 :: deviceNode {
-             policy = 0;                               // 等于0，不需要发布服务
-             priority = 55;                            // 驱动启动优先级
-             permission = 0644;                        // 驱动创建设备节点权限
-             moduleName = "hi35xx_i2c_driver";         //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
-             serviceName = "HI35XX_I2C_DRIVER";        //【必要】驱动对外发布服务的名称，必须唯一
-             deviceMatchAttr = "hisilicon_hi35xx_i2c"; //【必要】用于配置控制器私有数据，要与i2c_config.hcs中对应控制器保持一致
-                                                       // 具体的控制器信息在 i2c_config.hcs中
+             policy = 0;                               // 等于0，不需要发布服务。
+             priority = 55;                            // 驱动启动优先级。
+             permission = 0644;                        // 驱动创建设备节点权限。
+             moduleName = "hi35xx_i2c_driver";         //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
+             serviceName = "HI35XX_I2C_DRIVER";        //【必要】驱动对外发布服务的名称，必须唯一。
+             deviceMatchAttr = "hisilicon_hi35xx_i2c"; //【必要】用于配置控制器私有数据，要与i2c_config.hcs中对应控制器保持一致，
+                                                       // 具体的控制器信息在 i2c_config.hcs中。
          }
          }
      }
@@ -139,13 +150,13 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
      platform {
          i2c_config {
          match_attr = "hisilicon_hi35xx_i2c";  //【必要】需要和device_info.hcs中的deviceMatchAttr值一致
-         template i2c_controller {             //模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
-             bus = 0;                          // 【必要】i2c 识别号
-             reg_pbase = 0x120b0000;           // 【必要】物理基地址
-             reg_size = 0xd1;                  // 【必要】寄存器位宽
-             irq = 0;                          // 【可选】根据厂商需要来使用
-             freq = 400000;                    // 【可选】根据厂商需要来使用
-             clk = 50000000;                   // 【可选】根据厂商需要来使用
+         template i2c_controller {             // 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
+             bus = 0;                          //【必要】i2c识别号
+             reg_pbase = 0x120b0000;           //【必要】物理基地址
+             reg_size = 0xd1;                  //【必要】寄存器位宽
+             irq = 0;                          //【可选】根据厂商需要来使用
+             freq = 400000;                    //【可选】根据厂商需要来使用
+             clk = 50000000;                   //【可选】根据厂商需要来使用
          }
          controller_0x120b0000 :: i2c_controller {
              bus = 0;
@@ -160,7 +171,8 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
      }
      ```
 
-3. 完成驱动入口注册之后，最后一步就是以核心层I2cCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化I2cCntlr成员I2cMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
+3. 完成驱动入口注册之后，下一步就是以核心层I2cCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化I2cCntlr成员I2cMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
+
    - 自定义结构体参考
 
       从驱动的角度看，自定义结构体是参数和数据的载体，而且i2c_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，其中一些重要数值也会传递给核心层I2cCntlr对象，例如设备号、总线号等。
@@ -169,8 +181,8 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
       ```
       // 厂商自定义功能结构体
       struct Hi35xxI2cCntlr {
-          struct I2cCntlr cntlr;            // 【必要】是核心层控制对象，具体描述见下面
-          OsalSpinlock spin;                // 【必要】厂商需要基于此锁变量对各个 i2c 操作函数实现对应的加锁解锁
+          struct I2cCntlr cntlr;            // 【必要】是核心层控制对象，具体描述见下面。
+          OsalSpinlock spin;                // 【必要】厂商需要基于此锁变量对各个i2c操作函数实现对应的加锁解锁。
           volatile unsigned char  *regBase; // 【必要】寄存器基地址
           uint16_t regSize;                 // 【必要】寄存器位宽
           int16_t bus;                      // 【必要】i2c_config.hcs文件中可读取具体值
@@ -180,7 +192,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
           uint32_t regBasePhy;              // 【必要】寄存器物理基地址
       };
       
-      // I2cCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值
+      // I2cCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。
       struct I2cCntlr {
           struct OsalMutex lock;
           void *owner;
@@ -208,7 +220,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       入参：
 
-      HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
+      HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
 
       返回值：
 
@@ -227,14 +239,14 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       函数说明：
 
-      初始化自定义结构体对象，初始化I2cCntlr成员，调用核心层I2cCntlrAdd函数，【可选】接入VFS。
+      初始化自定义结构体对象，初始化I2cCntlr成员，调用核心层I2cCntlrAdd函数，接入VFS（可选）。
 
         
       ```
       static int32_t Hi35xxI2cInit(struct HdfDeviceObject *device)
       {
           ...
-          // 遍历、解析 i2c_config.hcs中的所有配置节点，并分别进行初始化，需要调用Hi35xxI2cParseAndInit函数
+          // 遍历、解析i2c_config.hcs中的所有配置节点，并分别进行初始化，需要调用Hi35xxI2cParseAndInit函数。
           DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
               ret = Hi35xxI2cParseAndInit(device, childNode);//函数定义见下
           ...
@@ -257,13 +269,13 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
           hi35xx->cntlr.ops = &g_method;      // 【必要】I2cMethod的实例化对象的挂载
           hi35xx->cntlr.lockOps = &g_lockOps; // 【必要】I2cLockMethod的实例化对象的挂载
           (void)OsalSpinInit(&hi35xx->spin);  // 【必要】锁的初始化
-          ret = I2cCntlrAdd(&hi35xx->cntlr);  // 【必要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层
+          ret = I2cCntlrAdd(&hi35xx->cntlr);  // 【必要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层。
           ...
       #ifdef USER_VFS_SUPPORT
-          (void)I2cAddVfsById(hi35xx->cntlr.busId);// 【可选】若支持用户级的虚拟文件系统，则接入
+          (void)I2cAddVfsById(hi35xx->cntlr.busId);// 【可选】若支持用户级的虚拟文件系统，则接入。
       #endif
           return HDF_SUCCESS;
-      __ERR__:                                // 不成功的话，需要反向执行初始化相关函数
+      __ERR__:                                     // 不成功的话，需要反向执行初始化相关函数。
           if (hi35xx != NULL) {
               if (hi35xx->regBase != NULL) {
                   OsalIoUnmap((void *)hi35xx->regBase);
@@ -279,7 +291,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       入参：
 
-      HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
+      HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
 
       返回值：
 
@@ -294,7 +306,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
       static void Hi35xxI2cRelease(struct HdfDeviceObject *device)
       {
           ...
-          // 与Hi35xxI2cInit一样，需要将对每个节点分别进行释放
+          // 与Hi35xxI2cInit一样，需要将对每个节点分别进行释放。
           DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
               Hi35xxI2cRemoveByNode(childNode);// 函数定义见下
           }
@@ -303,12 +315,12 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
       static void Hi35xxI2cRemoveByNode(const struct DeviceResourceNode *node)
       {
           ... 
-          // 【必要】可以调用 I2cCntlrGet函数通过设备的busid获取I2cCntlr对象， 以及调用I2cCntlrRemove函数来释放I2cCntlr对象的内容
+          // 【必要】可以调用I2cCntlrGet函数通过设备的busid获取I2cCntlr对象，以及调用I2cCntlrRemove函数来释放I2cCntlr对象的内容。
           cntlr = I2cCntlrGet(bus);
           if (cntlr != NULL && cntlr->priv == node) {
               ...
               I2cCntlrRemove(cntlr); 
-              // 【必要】解除地址映射，锁和内存的释放
+              // 【必要】解除地址映射，锁和内存的释放。
               hi35xx = (struct Hi35xxI2cCntlr *)cntlr; 
               OsalIoUnmap((void *)hi35xx->regBase);
               (void)OsalSpinDestroy(&hi35xx->spin);

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

 # MIPI CSI
 
-## 概述 <a name="section1_MIPI_CSIDevelop"></a>
+## 概述
 
 CSI（Camera Serial Interface）是由MIPI（Mobile Industry Processor Interface）联盟下Camera工作组指定的接口标准。在HDF框架中，MIPI CSI的接口适配模式采用无服务模式，用于不需要在用户态提供API的设备类型，或者没有用户态和内核区分的OS系统，MIPI CSI的接口关联方式是DevHandle直接指向设备对象内核态地址（DevHandle是一个void类型指针）。
 
@@ -8,7 +8,7 @@ CSI（Camera Serial Interface）是由MIPI（Mobile Industry Processor Interface
 
 ![image1](figures/无服务模式结构图.png)
 
-## 接口说明 <a name="section2_MIPI_CSIDevelop"></a>
+## 接口说明
 
 MipiCsiCntlrMethod定义：
 
@@ -44,37 +44,44 @@ struct MipiCsiCntlrMethod {
 | resetSensor        | **cntlr**：结构体指针，MipiCsi控制器 ;<br/>**snsClkSource**：uint8_t，传感器的时钟信号线号 | 无   | HDF_STATUS相关状态 | 复位Sensor                 |
 | unresetSensor      | **cntlr**：结构体指针，MipiCsi控制器 ;<br/>**snsClkSource**：uint8_t，传感器的时钟信号线号 | 无   | HDF_STATUS相关状态 | 撤销复位Sensor      |   
 
-## 开发步骤 <a name="section3_MIPI_CSIDevelop"></a>
+## 开发步骤
 
-MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、以及实例化核心层接口函数。
+MIPI CSI模块适配的三个必选环节是配置属性文件、实例化驱动入口、以及实例化核心层接口函数。
 
-1. **实例化驱动入口：**   
-   - 实例化HdfDriverEntry结构体成员。
-   - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
-   
-2. **配置属性文件：**   
+1. 配置属性文件：   
 
    - 在device_info.hcs文件中添加deviceNode描述。
    - 【可选】添加mipicsi_config.hcs器件属性文件。
 
-3. **实例化MIPICSI控制器对象：**   
+2. 实例化驱动入口：
+   
+   - 实例化HdfDriverEntry结构体成员。
+   - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
+   
+3. 实例化MIPI CSI控制器对象：
+   
    - 初始化MipiCsiCntlr成员。
    - 实例化MipiCsiCntlr成员MipiCsiCntlrMethod。
      >![](../public_sys-resources/icon-note.gif) **说明：**<br>
-     >实例化MipiCsiCntlr成员MipiCsiCntlrMethod，其定义和成员说明见[接口说明](#section2_MIPI_CSIDevelop)。
+     >实例化MipiCsiCntlr成员MipiCsiCntlrMethod，其定义和成员说明见[接口说明](#接口说明)。
+   
+4. 驱动调试：
 
-4. **驱动调试：**
-   - 【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。
+   【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。
 
 
-## 开发实例 <a name="section4_MIPI_CSIDevelop"></a>
+## 开发实例 
 
 下方将以mipi_rx_hi35xx.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。
 
 
-1. 一般来说，驱动开发首先需要在 busxx_config.hcs 中配置器件属性，并在device_info.hcs文件中添加deviceNode描述。器件属性值与核心层MipiCsiCntlr 成员的默认值或限制范围有密切关系，deviceNode信息与驱动入口注册相关。
+1. 一般来说，驱动开发首先需要在busxx_config.hcs中配置器件属性，并在device_info.hcs文件中添加deviceNode描述。
+
+   器件属性值与核心层MipiCsiCntlr 成员的默认值或限制范围有密切关系，deviceNode信息与驱动入口注册相关。
+
+   >![](../public_sys-resources/icon-note.gif) **说明：**<br>
+   >本例中MIPI控制器自身属性在源文件文件中，如有厂商需要，则在device_info文件的deviceNode增加deviceMatchAttr信息，相应增加mipicsi_config.hcs文件。
 
-   **本例中MIPI控制器自身属性在源文件文件中，如有厂商需要，则在device_info文件的deviceNode增加deviceMatchAttr信息，相应增加mipicsi_config.hcs文件**。
 
 - device_info.hcs 配置参考
 
@@ -90,7 +97,7 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
               policy = 0;
               priority = 160;
               permission = 0644;
-              moduleName = "HDF_MIPI_RX";    // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
+              moduleName = "HDF_MIPI_RX";    // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
               serviceName = "HDF_MIPI_RX";   // 【必要且唯一】驱动对外发布服务的名称
           }
       }
@@ -99,7 +106,9 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
   }
   ```
 
-2. 完成器件属性文件的配置之后，下一步请实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HdfDriverEntry结构体的函数指针成员会被厂商操作函数填充，HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组，方便调用。
+2. 完成器件属性文件的配置之后，下一步请实例化驱动入口。
+
+   驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HdfDriverEntry结构体的函数指针成员会被厂商操作函数填充，HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组，方便调用。
 
    一般在加载驱动时HDF框架会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
 
@@ -110,12 +119,14 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
       .moduleVersion = 1,
       .Init = Hi35xxMipiCsiInit,          // 见Init参考
       .Release = Hi35xxMipiCsiRelease,    // 见Release参考
-      .moduleName = "HDF_MIPI_RX",        // 【必要】需要与device_info.hcs 中保持一致。
+      .moduleName = "HDF_MIPI_RX",        // 【必要】需要与device_info.hcs 中保持一致
   };
   HDF_INIT(g_mipiCsiDriverEntry);         // 调用HDF_INIT将驱动入口注册到HDF框架中
   ```
 
-3.  完成驱动入口注册之后，最后一步就是以核心层MipiCsiCntlr对象的初始化为核心，实现HdfDriverEntry成员函数（Bind，Init，Release）。MipiCsiCntlr对象的初始化包括厂商自定义结构体（用于传递参数和数据）和实例化MipiCsiCntlr成员MipiCsiCntlrMethod（让用户可以通过接口来调用驱动底层函数）。
+3.  完成驱动入口注册之后，最后一步就是以核心层MipiCsiCntlr对象的初始化为核心，实现HdfDriverEntry成员函数（Bind，Init，Release）。
+
+    MipiCsiCntlr对象的初始化包括厂商自定义结构体（用于传递参数和数据）和实例化MipiCsiCntlr成员MipiCsiCntlrMethod（让用户可以通过接口来调用驱动底层函数）。
 
 - 自定义结构体参考 
 
@@ -151,17 +162,17 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
       };
   } ComboDevAttr;
   
-  // MipiCsiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值
+  // MipiCsiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。
   struct MipiCsiCntlr {
-      /** 当驱动程序绑定到HDF框架时，将发送此控制器提供的服务 */
+      /** 当驱动程序绑定到HDF框架时，将发送此控制器提供的服务。 */
       struct IDeviceIoService service;
-      /** 当驱动程序绑定到HDF框架时，将传入设备端指针 */
+      /** 当驱动程序绑定到HDF框架时，将传入设备端指针。 */
       struct HdfDeviceObject *device;
       /** 设备号 */
       unsigned int devNo;
       /** 控制器提供的所有接口 */
       struct MipiCsiCntlrMethod *ops;
-      /** 对于控制器调试的所有接口，如果未实现驱动程序，则需要null */
+      /** 对于控制器调试的所有接口，如果未实现驱动程序，则需要null。 */
       struct MipiCsiCntlrDebugMethod *debugs;
       /** 控制器上下文参数变量 */
       MipiDevCtx ctx;
@@ -169,12 +180,17 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
       OsalSpinlock ctxLock;
       /** 操作控制器时锁定方法 */
       struct OsalMutex lock;
-      /** 匿名数据指针，用于存储csi设备结构 */
+      /** 匿名数据指针，用于存储csi设备结构。 */
       void *priv;
   };
   ```
 
-- **【重要】** MipiCsiCntlr成员回调函数结构体MipiCsiCntlrMethod的实例化，其他成员在Init函数中初始化。
+
+- MipiCsiCntlr成员回调函数结构体MipiCsiCntlrMethod的实例化
+
+   >![](../public_sys-resources/icon-note.gif) **说明：**<br>
+   >其他成员在Init函数中初始化。
+
 
   ```c 
   static struct MipiCsiCntlrMethod g_method = {
@@ -196,10 +212,12 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
 - **Init函数参考**
 
    **入参：** 
-   HdfDeviceObject 是整个驱动对外暴露的接口参数，具备hcs配置文件的信息
+
+   HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
   
    **返回值：**
-   HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）
+
+   HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
 
   
    | 状态(值)               |   问题描述   |
@@ -212,6 +230,7 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
    | HDF_FAILURE            |   执行失败   |
   
    **函数说明：**
+
    MipiCsiCntlrMethod的实例化对象的挂载，调用MipiCsiRegisterCntlr，以及其他厂商自定义初始化操作。
 
 
@@ -235,7 +254,7 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
           return ret;
       }
   
-      ret = MipiRxDrvInit(); // 【必要】厂商对设备的初始化，形式不限
+      ret = MipiRxDrvInit(); // 【必要】厂商对设备的初始化，形式不限。
       if (ret != HDF_SUCCESS) {
           HDF_LOGE("%s: [MipiRxDrvInit] failed.", __func__);
           return ret;
@@ -258,7 +277,7 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
   int32_t MipiCsiRegisterCntlr(struct MipiCsiCntlr *cntlr, struct HdfDeviceObject *device)
   {
   ...
-  // 定义的全局变量:static struct MipiCsiHandle g_mipiCsihandle[MAX_CNTLR_CNT];
+  // 定义的全局变量：static struct MipiCsiHandle g_mipiCsihandle[MAX_CNTLR_CNT];
       if (g_mipiCsihandle[cntlr->devNo].cntlr == NULL) {
           (void)OsalMutexInit(&g_mipiCsihandle[cntlr->devNo].lock);
           (void)OsalMutexInit(&(cntlr->lock));
@@ -281,13 +300,20 @@ MIPI CSI模块适配的三个环节是配置属性文件、实例化驱动入、
 - **Release函数参考**
 
    **入参：** 
-   HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息。
+
+   HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
   
    **返回值：**
+
    无
   
    **函数说明：**
-   该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源，该函数中需包含释放内存和删除控制器等操作。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
+
+   该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源，该函数中需包含释放内存和删除控制器等操作。
+
+   >![](../public_sys-resources/icon-note.gif) **说明：**<br>
+   >所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
+
 
   ```c
   static void Hi35xxMipiCsiRelease(struct HdfDeviceObject *device)