规范性检查

Signed-off-by: Nli-yan339 <liyan339@h-partners.com>

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,9 +77,9 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
     .moduleVersion = 1,
     .Init = Hi35xxAdcInit,
     .Release = Hi35xxAdcRelease,
-    .moduleName = "hi35xx_adc_driver",//【必要且与HCS文件里面的名字匹配】
+    .moduleName = "hi35xx_adc_driver",       //【必要且与HCS文件里面的名字匹配】
    };
-   HDF_INIT(g_hi35xxAdcDriverEntry);   // 调用HDF_INIT将驱动入口注册到HDF框架中
+   HDF_INIT(g_hi35xxAdcDriverEntry);         // 调用HDF_INIT将驱动入口注册到HDF框架中
    
    // 核心层adc_core.c管理器服务的驱动入口
    struct HdfDriverEntry g_adcManagerEntry = {
@@ -86,8 +91,13 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
    HDF_INIT(g_adcManagerEntry);
    ```
 
-2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在adc_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值对于厂商驱动的实现以及核心层AdcDevice相关成员的默认值或限制范围有密切关系。
-     统一服务模式的特点是device_info文件中第一个设备节点必须为ADC管理器，其各项参数必须如下设置：
+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,13 @@ 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,30 +165,31 @@ 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;    //【必要】寄存器物理基地址
-          uint32_t regSize;       //【必要】寄存器位宽
-          uint32_t deviceNum;     //【必要】设备号
-          uint32_t dataWidth;     //【必要】信号接收的数据位宽
-          uint32_t validChannel;  //【必要】有效通道
-          uint32_t scanMode;      //【必要】扫描模式
+          uint32_t regBasePhy;            //【必要】寄存器物理基地址
+          uint32_t regSize;               //【必要】寄存器位宽
+          uint32_t deviceNum;             //【必要】设备号
+          uint32_t dataWidth;             //【必要】信号接收的数据位宽
+          uint32_t validChannel;          //【必要】有效通道
+          uint32_t scanMode;              //【必要】扫描模式
           uint32_t delta;
           uint32_t deglitch;
           uint32_t glitchSample;
-          uint32_t rate;          //【必要】采样率
+          uint32_t rate;                  //【必要】采样率
       };
       
-      // AdcDevice是核心层控制器结构体，其中的成员在Init函数中会被赋值
+      // AdcDevice是核心层控制器结构体，其中的成员在Init函数中会被赋值。
       struct AdcDevice {
           const struct AdcMethod *ops;
           OsalSpinlock spin;
@@ -188,7 +200,9 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
       };
       ```
 
-   - AdcDevice成员回调函数结构体AdcMethod的实例化，AdcLockMethod回调函数结构体本例未实现，若要实例化，可参考I2C驱动开发，其他成员在Init函数中初始化。
+   - AdcDevice成员回调函数结构体AdcMethod的实例化。
+
+     AdcLockMethod回调函数结构体本例未实现，若要实例化，可参考I2C驱动开发，其他成员在Init函数中初始化。
 
      
       ```
@@ -227,7 +241,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);// 函数定义见下
               ...
@@ -281,7 +295,10 @@ ADC模块适配的三个环节是配置属性文件，实例化驱动入口，
 
       函数说明：
 
-      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
+      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
+
+      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
+      > 所有强制转换获取相应对象的操作的前提是在Init函数中具备对应赋值的操作。
 
       
       ```
@@ -289,7 +306,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 +324,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);
       }