资料规范性检查

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

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

@@ -37,23 +37,24 @@ struct SpiCntlrMethod {
 
 ## 开发步骤
 
-SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
+SPI模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及实例化核心层接口函数。
 
-1. **实例化驱动入口：**
+1. 实例化驱动入口
    - 实例化HdfDriverEntry结构体成员。
    - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
 
-2. **配置属性文件：**
+2. 配置属性文件
    - 在device_info.hcs文件中添加deviceNode描述。
    - 【可选】添加spi_config.hcs器件属性文件。
 
-3. **实例化SPI控制器对象：**
+3. 实例化SPI控制器对象
    - 初始化SpiCntlr成员。
    - 实例化SpiCntlr成员SpiCntlrMethod。
       > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
       > 实例化SpiCntlr成员SpiCntlrMethod，其定义和成员说明见[接口说明](#接口说明)。
 
-4. **驱动调试：**
+4. 驱动调试
+
    【可选】针对新增驱动程序，建议验证驱动基本功能，例如SPI控制状态，中断响应情况等。
 
 
@@ -61,15 +62,20 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
 
 下方将以spi_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释放驱动资源并退出。
 
-     SPI驱动入口参考：
+   SPI驱动入口参考：
      
    ```
    struct HdfDriverEntry g_hdfSpiDevice = {
        .moduleVersion = 1,
-       .moduleName = "HDF_PLATFORM_SPI",//【必要 且与 HCS文件中里面的moduleName匹配】
+       .moduleName = "HDF_PLATFORM_SPI",//【必要且与HCS文件中里面的moduleName匹配】
        .Bind = HdfSpiDeviceBind,        //见Bind参考
        .Init = HdfSpiDeviceInit,        //见Init参考
        .Release = HdfSpiDeviceRelease,  //见Release参考
@@ -78,8 +84,12 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
    HDF_INIT(g_hdfSpiDevice);
    ```
 
-2. 完成驱动入口注册之后，在device_info.hcs文件中添加deviceNode信息，并在 spi_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层SpiCntlr成员的默认值或限制范围有密切关系。
-     本例只有一个SPI控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在spi_config文件中增加对应的器件属性。
+2. 完成驱动入口注册之后，在device_info.hcs文件中添加deviceNode信息，并在spi_config.hcs中配置器件属性。
+
+   deviceNode信息与驱动入口注册相关，器件属性值与核心层SpiCntlr成员的默认值或限制范围有密切关系。
+
+   本例只有一个SPI控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在spi_config文件中增加对应的器件属性。
+
    - device_info.hcs配置参考
    
        
@@ -90,7 +100,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
          platform :: host {
          hostName = "platform_host";
          priority = 50;
-         device_spi :: device {                           //为每一个 SPI 控制器配置一个HDF设备节点
+         device_spi :: device {                           //为每一个SPI控制器配置一个HDF设备节点
              device0 :: deviceNode {
              policy = 1;
              priority = 60;
@@ -103,9 +113,9 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
              policy = 1;
              priority = 60;
              permission = 0644;
-             moduleName = "HDF_PLATFORM_SPI";             // 【必要】用于指定驱动名称，该字段的值必须和驱动入口结构的moduleName值一致
-             serviceName = "HDF_PLATFORM_SPI_1";          // 【必要且唯一】驱动对外发布服务的名称
-             deviceMatchAttr = "hisilicon_hi35xx_spi_1";  // 需要与设备hcs文件中的match_attr匹配
+             moduleName = "HDF_PLATFORM_SPI";             // 【必要】用于指定驱动名称，该字段的值必须和驱动入口结构的moduleName值一致。
+             serviceName = "HDF_PLATFORM_SPI_1";          // 【必要且唯一】驱动对外发布服务的名称。
+             deviceMatchAttr = "hisilicon_hi35xx_spi_1";  // 需要与设备hcs文件中的match_attr匹配。
              }
              ...
          }
@@ -114,28 +124,28 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
      }
      ```
    
-   - spi_config.hcs 配置参考
+   - spi_config.hcs配置参考
    
        
      ```
      root {
      platform {
-         spi_config {// 每一个SPI控制器配置私有数据
-         template spi_controller {// 模板公共参数， 继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
+         spi_config {                        // 每一个SPI控制器配置私有数据
+         template spi_controller {           // 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
              serviceName = "";
              match_attr = "";
-             transferMode = 0;     // 数据传输模式：中断传输(0),流控传输(1),DMA传输(2)
-             busNum = 0;           // 总线号
+             transferMode = 0;               // 数据传输模式：中断传输(0)、流控传输(1)、DMA传输(2)
+             busNum = 0;                     // 总线号
              clkRate = 100000000;
-             bitsPerWord = 8;      // 传输位宽
-             mode = 19;            // SPI 数据的输入输出模式
-             maxSpeedHz = 0;       // 最大时钟频率
-             minSpeedHz = 0;       // 最小时钟频率
-             speed = 2000000;      // 当前消息传输速度
-             fifoSize = 256;       // FIFO大小
-             numCs = 1;            // 片选号
-             regBase = 0x120c0000; // 地址映射需要
-             irqNum = 100;         // 中断号
+             bitsPerWord = 8;                // 传输位宽
+             mode = 19;                      // SPI 数据的输入输出模式
+             maxSpeedHz = 0;                 // 最大时钟频率
+             minSpeedHz = 0;                 // 最小时钟频率
+             speed = 2000000;                // 当前消息传输速度
+             fifoSize = 256;                 // FIFO大小
+             numCs = 1;                      // 片选号
+             regBase = 0x120c0000;           // 地址映射需要
+             irqNum = 100;                   // 中断号
              REG_CRG_SPI = 0x120100e4;       // CRG_REG_BASE(0x12010000) + 0x0e4
              CRG_SPI_CKEN = 0;
              CRG_SPI_RST = 0;
@@ -144,9 +154,9 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
              MISC_CTRL_SPI_CS_SHIFT = 0;
          }      
          controller_0x120c0000 :: spi_controller {
-             busNum = 0;                // 【必要】总线号
-             CRG_SPI_CKEN = 0x10000;    // (0x1 << 16) 0:close clk, 1:open clk 
-             CRG_SPI_RST = 0x1;         // (0x1 << 0) 0:cancel reset, 1:reset 
+             busNum = 0;                           // 【必要】总线号
+             CRG_SPI_CKEN = 0x10000;               // (0x1 << 16) 0:close clk, 1:open clk 
+             CRG_SPI_RST = 0x1;                    // (0x1 << 0) 0:cancel reset, 1:reset 
              match_attr = "hisilicon_hi35xx_spi_0";// 【必要】需要和device_info.hcs中的deviceMatchAttr值一致
          }      
          controller_0x120c1000 :: spi_controller {
@@ -158,16 +168,17 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
              irqNum = 101;              // 【必要】中断号
          }
          ...
-         // 【可选】可新增，但需要在device_info.hcs添加对应的节点
+         // 【可选】可新增，但需要在device_info.hcs添加对应的节点。
          }
      }
      }
      ```
 
-3. 完成驱动入口注册之后，最后一步就是以核心层SpiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化SpiCntlr成员SpiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
+3. 完成属性文件配置之后，下一步就是以核心层SpiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化SpiCntlr成员SpiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。
+
    - 自定义结构体参考
 
-      从驱动的角度看，自定义结构体是参数和数据的载体，而且spi_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号、总线号等。
+     从驱动的角度看，自定义结构体是参数和数据的载体，而且spi_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号、总线号等。
 
         
       ```
@@ -197,7 +208,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
           uint8_t transferMode;
       };
       
-      // SpiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值
+      // SpiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。
       struct SpiCntlr {
           struct IDeviceIoService service;
           struct HdfDeviceObject *device;
@@ -249,14 +260,14 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       
       struct SpiCntlr *SpiCntlrCreate(struct HdfDeviceObject *device)
       {
-          struct SpiCntlr *cntlr = NULL;      // 创建核心层SpiCntlr对象
+          struct SpiCntlr *cntlr = NULL;                           // 创建核心层SpiCntlr对象
           ...
           cntlr = (struct SpiCntlr *)OsalMemCalloc(sizeof(*cntlr));// 分配内存
           ...
-          cntlr->device = device;             // 使HdfDeviceObject与SpiCntlr可以相互转化的前提
-          device->service = &(cntlr->service);// 使HdfDeviceObject与SpiCntlr可以相互转化的前提
-          (void)OsalMutexInit(&cntlr->lock);  // 锁初始化
-          DListHeadInit(&cntlr->list);        // 添加对应的节点
+          cntlr->device = device;                                  // 使HdfDeviceObject与SpiCntlr可以相互转化的前提
+          device->service = &(cntlr->service);                     // 使HdfDeviceObject与SpiCntlr可以相互转化的前提
+          (void)OsalMutexInit(&cntlr->lock);                       // 锁初始化
+          DListHeadInit(&cntlr->list);                             // 添加对应的节点
           cntlr->priv = NULL;
           return cntlr;
       }
@@ -270,7 +281,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
 
       返回值：
 
-      HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。
+      HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
 
         **表2** HDF_STATUS返回值描述
       
@@ -294,10 +305,10 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       int32_t ret;
       struct SpiCntlr *cntlr = NULL;
       ...
-      cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
+      cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数。
                                           // return (device == NULL) ? NULL : (struct SpiCntlr *)device->service;
       ...
-      ret = Pl022Init(cntlr, device);     // 【必要】实例化厂商自定义操作对象，示例见下
+      ret = Pl022Init(cntlr, device);     // 【必要】实例化厂商自定义操作对象，示例见下。
       ...
       ret = Pl022Probe(cntlr->priv);
       ...
@@ -311,11 +322,11 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       ...
       pl022 = (struct Pl022 *)OsalMemCalloc(sizeof(*pl022));// 申请内存
       ...
-      ret = SpiGetBaseCfgFromHcs(pl022, device->property);  // 初始化busNum, numCs, speed, fifoSize, clkRate,mode, bitsPerWord, transferMode参数值
+      ret = SpiGetBaseCfgFromHcs(pl022, device->property);  // 初始化busNum、numCs、speed、fifoSize、clkRate、mode、bitsPerWord、transferMode参数值。
       ...
-      ret = SpiGetRegCfgFromHcs(pl022, device->property);   // 初始化regBase, phyBase, irqNum, regCrg, clkEnBit,clkRstBit, regMiscCtrl, regMiscCtrl, miscCtrlCs,miscCtrlCsShift参数值
+      ret = SpiGetRegCfgFromHcs(pl022, device->property);   // 初始化regBase、phyBase、irqNum、regCrg、clkEnBit、clkRstBit、regMiscCtrl、regMiscCtrl、 miscCtrlCs、miscCtrlCsShift参数值。
       ...
-      // 计算最大，最小速度对应的频率
+      // 计算最大、最小速度对应的频率。
       pl022->maxSpeedHz = (pl022->clkRate) / ((SCR_MIN + 1) * CPSDVSR_MIN);
       pl022->minSpeedHz = (pl022->clkRate) / ((SCR_MAX + 1) * CPSDVSR_MAX);
       DListHeadInit(&pl022->deviceList); // 初始化DList链表
@@ -344,7 +355,10 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
 
       函数说明：
 
-      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
+      释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
+
+      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
+      > 所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
 
         
       ```
@@ -352,8 +366,8 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       {
           struct SpiCntlr *cntlr = NULL;
           ...
-          cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
-                                              // return (device==NULL) ?NULL:(struct SpiCntlr *)device->service;
+          cntlr = SpiCntlrFromDevice(device);             // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
+                                                          // return (device==NULL) ?NULL:(struct SpiCntlr *)device->service;
           ...
           if (cntlr->priv != NULL) {
               Pl022Remove((struct Pl022 *)cntlr->priv);   // 这里有SpiCntlr到Pl022的强制转化