!1219 【轻量级 PR】：【同步】【驱动】SPI章节修改文件路径、删除多余符号、修改表格中英文符号、将接口说明整理为单独模块。

Merge pull request !1219 from liyan/N/A

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

 # SPI
 
 - [概述](#1)
-- [开发步骤](#2)
-- [开发实例](#3)
+- [接口说明](#2)
+- [开发步骤](#3)
+- [开发实例](#4)
 
 ## 概述 <a name="1"></a>
 
@@ -13,7 +14,30 @@ SPI是串行外设接口（Serial Peripheral Interface）的缩写，在HDF框
 图 1 独立服务模式结构图
 ![image1](figure/独立服务模式.png)
 
-## 开发步骤 <a name="2"></a>
+## 接口说明 <a name="2"></a>
+
+ SpiCntlrMethod定义
+ ```c
+ struct SpiCntlrMethod {
+   int32_t (*GetCfg)(struct SpiCntlr *cntlr, struct SpiCfg *cfg);
+   int32_t (*SetCfg)(struct SpiCntlr *cntlr, struct SpiCfg *cfg);
+   int32_t (*Transfer)(struct SpiCntlr *cntlr, struct SpiMsg *msg, uint32_t count);
+   int32_t (*Open)(struct SpiCntlr *cntlr);
+   int32_t (*Close)(struct SpiCntlr *cntlr);
+ };
+ ```
+ 表1 SpiCntlrMethod结构体成员的回调函数功能说明
+
+ |成员函数|入参|返回值|功能|
+ |-|-|-|-|
+ |Transfer |**cntlr**：结构体指针，核心层spi控制器；<br />**msg**：结构体指针，Spi消息；<br />**count**：uint32_t，消息个数 |HDF_STATUS相关状态|传输消息|
+ |SetCfg   |**cntlr**：结构体指针，核心层spi控制器；<br />**cfg**：结构体指针，Spi属性 |HDF_STATUS相关状态|设置控制器属性 |
+ |GetCfg   |**cntlr**：结构体指针，核心层spi控制器；<br />**cfg**：结构体指针，Spi属性 |HDF_STATUS相关状态|获取控制器属性  |
+ |Open     |**cntlr**：结构体指针，核心层spi控制器； |HDF_STATUS相关状态|打开SPI  |
+ |Close    |**cntlr**：结构体指针，核心层spi控制器； |HDF_STATUS相关状态|关闭SPI  |
+
+
+## 开发步骤 <a name="3"></a>
 
 SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动入口，以及填充核心层接口函数。
 
@@ -29,34 +53,15 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
 3. **实例化SPI控制器对象：**   
    
     - 初始化SpiCntlr成员。
-    - 实例化SpiCntlr成员SpiCntlrMethod，其定义和成员说明见下
+    - 实例化SpiCntlr成员SpiCntlrMethod。
+      >![](../public_sys-resources/icon-note.gif) **说明：** 
+      >实例化SpiCntlr成员SpiCntlrMethod，其定义和成员说明见[接口说明](#2)。
     
 4. **驱动调试：**
     - 【可选】针对新增驱动程序，建议验证驱动基本功能，例如spi控制状态，中断响应情况等。
 
-> ![](../public_sys-resources/icon-note.gif) **说明：** 
-> 
-> SpiCntlrMethod定义
-> ```c
-> struct SpiCntlrMethod {
->   int32_t (*GetCfg)(struct SpiCntlr *cntlr, struct SpiCfg *cfg);
->   int32_t (*SetCfg)(struct SpiCntlr *cntlr, struct SpiCfg *cfg);
->   int32_t (*Transfer)(struct SpiCntlr *cntlr, struct SpiMsg *msg, uint32_t count);
->   int32_t (*Open)(struct SpiCntlr *cntlr);
->   int32_t (*Close)(struct SpiCntlr *cntlr);
-> };
-> ```
-> 表1 SpiCntlrMethod结构体成员的回调函数功能说明
->
-> |成员函数|入参|返回值|功能|
-> |-|-|-|-|
-> |Transfer |**cntlr**: 结构体指针,核心层spi控制器 ;<br />**msg**: 结构体指针,Spi消息;<br />**count**: uint32_t,消息个数 |HDF_STATUS相关状态|传输消息|
-> |SetCfg   |**cntlr**: 结构体指针,核心层spi控制器 ;<br />**cfg**: 结构体指针,Spi属性 |HDF_STATUS相关状态|设置控制器属性 |
-> |GetCfg   |**cntlr**: 结构体指针,核心层spi控制器 ;<br />**cfg**: 结构体指针,Spi属性 |HDF_STATUS相关状态|获取控制器属性  |
-> |Open     |**cntlr**: 结构体指针,核心层spi控制器 ; |HDF_STATUS相关状态|打开SPI  |
-> |Close    |**cntlr**: 结构体指针,核心层spi控制器 ; |HDF_STATUS相关状态|关闭SPI  |
-
-## 开发实例 <a name="3"></a>
+
+## 开发实例 <a name="4"></a>
 
 下方将以spi_hi35xx.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。
 
@@ -64,7 +69,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
     
     一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
 
-- SPI驱动入口参考
+    SPI驱动入口参考：
 
     ```c 
     struct HdfDriverEntry g_hdfSpiDevice = {
@@ -81,7 +86,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
 2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在 spi_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层SpiCntlr 成员的默认值或限制范围有密切关系。
 **本例只有一个SPI控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在spi_config文件中增加对应的器件属性**。
 
-- device_info.hcs 配置参考
+    - device_info.hcs 配置参考
 
       ```c
       root {
@@ -114,7 +119,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       }
       ```
 
-- spi_config.hcs 配置参考
+    - spi_config.hcs 配置参考
 
       ```c
       root {
@@ -165,9 +170,9 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
 
 3. 完成驱动入口注册之后，最后一步就是以核心层SpiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化SpiCntlr成员SpiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）
 
-- 自定义结构体参考 
+    - 自定义结构体参考 
 
-    > 从驱动的角度看，自定义结构体是参数和数据的载体，而且spi_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号、总线号等。
+      从驱动的角度看，自定义结构体是参数和数据的载体，而且spi_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号、总线号等。
     
       ```c
       struct Pl022 {//对应于hcs中的参数
@@ -211,7 +216,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       ```
 
 
-- **【重要】** SpiCntlr成员回调函数结构体SpiCntlrMethod的实例化，其他成员在Init函数中初始化
+    - **【重要】** SpiCntlr成员回调函数结构体SpiCntlrMethod的实例化，其他成员在Init函数中初始化
 
       ```c 
       // spi_hi35xx.c 中的示例：钩子函数的填充
@@ -225,16 +230,20 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       ```
 
 
-- **Bind 函数参考**
+    - **Bind 函数参考**
+
+       入参： 
+
+       HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息 。
+    
+       返回值：
+
+       HDF_STATUS相关状态。 
+    
+       函数说明：
+
+       将SpiCntlr对象同HdfDeviceObject进行了关联。 
 
-    > **入参：** 
-    >  HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 
-    > 
-    > **返回值：**
-    > HDF_STATUS相关状态 
-    > 
-    > **函数说明：**
-    > 将 SpiCntlr 对象同 HdfDeviceObject 进行了关联 
     
       ```c
       static int32_t HdfSpiDeviceBind(struct HdfDeviceObject *device)
@@ -259,25 +268,29 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       ```
 
 
-- **Init函数参考**
-
-    > **入参：** 
-    >  HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 
-    > 
-    > **返回值：**
-    > HDF_STATUS相关状态 （下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）
-    > 
-    > |状态(值)|问题描述|
-    > |:-|:-:|
-    > |HDF_ERR_INVALID_OBJECT|控制器对象非法|
-    > |HDF_ERR_MALLOC_FAIL   |内存分配失败|
-    > |HDF_ERR_INVALID_PARAM |参数非法|
-    > |HDF_ERR_IO            |I/O 错误|
-    > |HDF_SUCCESS           |初始化成功|
-    > |HDF_FAILURE           |初始化失败|
-    > 
-    > **函数说明：**
-    > 初始化自定义结构体对象，初始化SpiCntlr成员。
+    - **Init函数参考**
+
+       入参：
+ 
+       HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 
+     
+       返回值：
+
+       HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见/drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）
+
+    
+       |状态(值)|问题描述|
+       |:-|:-:|
+       |HDF_ERR_INVALID_OBJECT|控制器对象非法|
+       |HDF_ERR_MALLOC_FAIL   |内存分配失败|
+       |HDF_ERR_INVALID_PARAM |参数非法|
+       |HDF_ERR_IO            |I/O 错误|
+       |HDF_SUCCESS           |初始化成功|
+       |HDF_FAILURE           |初始化失败|
+     
+       函数说明：
+       初始化自定义结构体对象，初始化SpiCntlr成员。
+    
 
       ```c 
       //挂载init的
@@ -328,16 +341,20 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
       }
       ```
 
-- **Release函数参考**
+    - **Release函数参考**
+
+       入参： 
+
+       HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 
+     
+       返回值：
+
+       无
+    
+       函数说明：
+      
+       释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给 Release 接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用 Release 释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
        
-    > **入参：** 
-    > HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 
-    > 
-    > **返回值：**
-    > 无
-    > 
-    > **函数说明：**
-    > 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给 Release 接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用 Release 释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
     
       ```c
       static void HdfSpiDeviceRelease(struct HdfDeviceObject *device)