1# SPI 2 3## 概述 4 5### 功能简介 6 7SPI即串行外设接口（Serial Peripheral Interface），是一种高速的，全双工，同步的通信总线。SPI是由Motorola公司开发，用于在主设备和从设备之间进行通信。 8 9### 运作机制 10 11在HDF框架中，SPI的接口适配模式采用独立服务模式（如图1），在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力，但需要为每个设备单独配置设备节点，若设备过多可能增加内存占用。 12 13独立服务模式下，核心层不会统一发布一个服务供上层使用，因此这种模式下驱动要为每个控制器发布一个服务，具体表现为： 14 15- 驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。 16- device_info.hcs文件中deviceNode的policy字段为1或2，不能为0。 17 18**图1** SPI独立服务模式结构图<a name="fig1"></a> 19 20 21 22SPI以主从方式工作，通常有一个主设备和一个或者多个从设备。主设备和从设备之间一般用4根线相连，它们分别是： 23 - SCLK：时钟信号，由主设备产生； 24 - MOSI：主设备数据输出，从设备数据输入； 25 - MISO：主设备数据输入，从设备数据输出； 26 - CS：片选，从设备使能信号，由主设备控制。 27 28一个主设备和两个从设备的连接示意图如下所示，Device A和Device B共享主设备的SCLK、MISO和MOSI三根引脚，Device A的片选CS0连接主设备的CS0，Device B的片选CS1连接主设备的CS1。 29 30 **图2** SPI主从设备连接示意图<a name="fig2"></a> 31 32  33 34- SPI通信通常由主设备发起，通过以下步骤完成一次通信： 35 1. 通过CS选中要通信的从设备，在任意时刻，一个主设备上最多只能有一个从设备被选中。 36 2. 通过SCLK给选中的从设备提供时钟信号。 37 3. 基于SCLK时钟信号，主设备数据通过MOSI发送给从设备，同时通过MISO接收从设备发送的数据，完成通信。 38 39- 根据SCLK时钟信号的CPOL（Clock Polarity，时钟极性）和CPHA（Clock Phase，时钟相位）的不同组合，SPI有以下四种工作模式： 40 - CPOL=0，CPHA=0 时钟信号idle状态为低电平，第一个时钟边沿采样数据。 41 - CPOL=0，CPHA=1 时钟信号idle状态为低电平，第二个时钟边沿采样数据。 42 - CPOL=1，CPHA=0 时钟信号idle状态为高电平，第一个时钟边沿采样数据。 43 - CPOL=1，CPHA=1 时钟信号idle状态为高电平，第二个时钟边沿采样数据。 44 45## 开发指导 46 47### 场景介绍 48 49SPI通常用于与闪存、实时时钟、传感器以及模数/数模转换器等支持SPI协议的设备进行通信。当驱动开发者需要将SPI设备适配到OpenHarmony时，需要进行SPI驱动适配，下文将介绍如何进行SPI驱动适配。 50 51### 接口说明 52 53为了保证上层在调用SPI接口时能够正确的操作硬件，核心层在//drivers/hdf_core/framework/support/platform/include/spi/spi_core.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能，并与这些钩子函数挂接，从而完成接口层与核心层的交互。 54 55SpiCntlrMethod定义： 56 57```c 58struct SpiCntlrMethod { 59 int32_t (*GetCfg)(struct SpiCntlr *cntlr, struct SpiCfg *cfg); 60 int32_t (*SetCfg)(struct SpiCntlr *cntlr, struct SpiCfg *cfg); 61 int32_t (*Transfer)(struct SpiCntlr *cntlr, struct SpiMsg *msg, uint32_t count); 62 int32_t (*Open)(struct SpiCntlr *cntlr); 63 int32_t (*Close)(struct SpiCntlr *cntlr); 64}; 65``` 66 67 **表1** SpiCntlrMethod结构体成员的钩子函数功能说明 68 69| 成员函数 | 入参 | 返回值 | 功能 | 70| -------- | -------- | -------- | -------- | 71| Transfer | cntlr：结构体指针，核心层SPI控制器。<br/>msg：结构体指针，Spi消息。<br/>count：uint32_t，消息个数。 | HDF_STATUS相关状态 | 传输消息 | 72| SetCfg | cntlr：结构体指针，核心层SPI控制器。<br/>cfg：结构体指针，Spi属性。 | HDF_STATUS相关状态 | 设置控制器属性 | 73| GetCfg | cntlr：结构体指针，核心层SPI控制器。<br/>cfg：结构体指针，Spi属性。 | HDF_STATUS相关状态 | 获取控制器属性 | 74| Open | cntlr：结构体指针，核心层SPI控制器。 | HDF_STATUS相关状态 | 打开SPI | 75| Close | cntlr：结构体指针，核心层SPI控制器。 | HDF_STATUS相关状态 | 关闭SPI | 76 77 78### 开发步骤 79 80SPI模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及实例化核心层接口函数。 81 821. 实例化驱动入口 83 - 实例化HdfDriverEntry结构体成员。 84 - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 85 862. 配置属性文件 87 - 在device_info.hcs文件中添加deviceNode描述。 88 - 【可选】添加spi_config.hcs器件属性文件。 89 903. 实例化SPI控制器对象 91 - 初始化SpiCntlr成员。 92 - 实例化SpiCntlr成员SpiCntlrMethod。 93 >  **说明：**<br> 94 > 实例化SpiCntlr成员SpiCntlrMethod，其定义和成员说明见[接口说明](#接口说明)。 95 964. 驱动调试 97 98 【可选】针对新增驱动程序，建议验证驱动基本功能，例如SPI控制状态，中断响应情况等。 99 100### 开发实例 101 102下方将以//device/soc/hisilicon/common/platform/spi/spi_hi35xx.c为示例，展示需要驱动适配者提供哪些内容来完整实现设备功能。 103 1041. 首先需要实例化驱动入口。 105 106 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。 107 108 HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 109 110 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 111 112 SPI驱动入口参考： 113 114 ```c 115 struct HdfDriverEntry g_hdfSpiDevice = { 116 .moduleVersion = 1, 117 .moduleName = "HDF_PLATFORM_SPI", //【必要且与HCS文件中里面的moduleName匹配】 118 .Bind = HdfSpiDeviceBind, //见Bind开发参考 119 .Init = HdfSpiDeviceInit, //见Init开发参考 120 .Release = HdfSpiDeviceRelease, //见Release开发参考 121 }; 122 /* 调用HDF_INIT将驱动入口注册到HDF框架中 */ 123 HDF_INIT(g_hdfSpiDevice); 124 ``` 125 1262. 完成驱动入口注册之后，在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode信息，并在spi_config.hcs中配置器件属性。 127 128 deviceNode信息与驱动入口注册相关，器件属性值与核心层SpiCntlr成员的默认值或限制范围有密切关系。 129 130 本例只有一个SPI控制器，如有多个器件信息，则需要在device_info.hcs文件增加deviceNode信息，以及在spi_config文件中增加对应的器件属性。 131 132 - device_info.hcs配置参考 133 134 ```c 135 root { 136 device_info { 137 match_attr = "hdf_manager"; 138 platform :: host { 139 hostName = "platform_host"; 140 priority = 50; 141 device_spi :: device { //为每一个SPI控制器配置一个HDF设备节点 142 device0 :: deviceNode { 143 policy = 2; 144 priority = 60; 145 permission = 0644; 146 moduleName = "HDF_PLATFORM_SPI"; 147 serviceName = "HDF_PLATFORM_SPI_0"; 148 deviceMatchAttr = "hisilicon_hi35xx_spi_0"; 149 } 150 device1 :: deviceNode { 151 policy = 2; 152 priority = 60; 153 permission = 0644; 154 moduleName = "HDF_PLATFORM_SPI"; // 【必要】用于指定驱动名称，该字段的值必须和驱动入口结构的moduleName值一致。 155 serviceName = "HDF_PLATFORM_SPI_1"; // 【必要且唯一】驱动对外发布服务的名称。 156 deviceMatchAttr = "hisilicon_hi35xx_spi_1"; // 需要与spi_config.hcs配置文件中的match_attr匹配。 157 } 158 ... 159 } 160 } 161 } 162 } 163 ``` 164 165 - spi_config.hcs配置参考 166 167 168 ```c 169 root { 170 platform { 171 spi_config { // 每一个SPI控制器配置私有数据 172 template spi_controller { // 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。 173 serviceName = ""; 174 match_attr = ""; 175 transferMode = 0; // 数据传输模式：中断传输(0)、流控传输(1)、DMA传输(2) 176 busNum = 0; // 总线号 177 clkRate = 100000000; 178 bitsPerWord = 8; // 传输位宽 179 mode = 19; // SPI 数据的输入输出模式 180 maxSpeedHz = 0; // 最大时钟频率 181 minSpeedHz = 0; // 最小时钟频率 182 speed = 2000000; // 当前消息传输速度 183 fifoSize = 256; // FIFO大小 184 numCs = 1; // 片选号 185 regBase = 0x120c0000; // 地址映射需要 186 irqNum = 100; // 中断号 187 REG_CRG_SPI = 0x120100e4; // CRG_REG_BASE(0x12010000) + 0x0e4 188 CRG_SPI_CKEN = 0; 189 CRG_SPI_RST = 0; 190 REG_MISC_CTRL_SPI = 0x12030024; // MISC_REG_BASE(0x12030000) + 0x24 191 MISC_CTRL_SPI_CS = 0; 192 MISC_CTRL_SPI_CS_SHIFT = 0; 193 } 194 controller_0x120c0000 :: spi_controller { 195 busNum = 0; // 【必要】总线号 196 CRG_SPI_CKEN = 0x10000; // (0x1 << 16) 0:close clk, 1:open clk 197 CRG_SPI_RST = 0x1; // (0x1 << 0) 0:cancel reset, 1:reset 198 match_attr = "hisilicon_hi35xx_spi_0"; // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致 199 } 200 controller_0x120c1000 :: spi_controller { 201 busNum = 1; 202 CRG_SPI_CKEN = 0x20000; // (0x1 << 17) 0:close clk, 1:open clk 203 CRG_SPI_RST = 0x2; // (0x1 << 1) 0:cancel reset, 1:reset 204 match_attr = "hisilicon_hi35xx_spi_1"; 205 regBase = 0x120c1000; // 【必要】地址映射需要 206 irqNum = 101; // 【必要】中断号 207 } 208 ... 209 /* 【可选】可新增，但需要在device_info.hcs添加对应的节点。 */ 210 } 211 } 212 } 213 ``` 214 215 需要注意的是，新增spi_config.hcs配置文件后，必须在hdf.hcs文件中将其包含，否则配置文件无法生效。 216 217 例如：本例中spi_config.hcs所在路径为device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/spi/spi_config.hcs，则必须在产品对应的hdf.hcs中添加如下语句： 218 219 ```c 220 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/spi/spi_config.hcs" // 配置文件相对路径 221 ``` 222 2233. 完成属性文件配置之后，下一步就是以核心层SpiCntlr对象的初始化为核心，包括驱动适配者自定义结构体（传递参数和数据），实例化SpiCntlr成员SpiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 224 225 - 自定义结构体参考 226 227 从驱动的角度看，自定义结构体是参数和数据的载体，而且spi_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号、总线号等。 228 229 230 ```c 231 struct Pl022 { //对应于spi_config.hcs中的参数 232 struct SpiCntlr *cntlr; 233 struct DListHead deviceList; 234 struct OsalSem sem; 235 volatile unsigned char *phyBase; 236 volatile unsigned char *regBase; 237 uint32_t irqNum; 238 uint32_t busNum; 239 uint32_t numCs; 240 uint32_t curCs; 241 uint32_t speed; 242 uint32_t fifoSize; 243 uint32_t clkRate; 244 uint32_t maxSpeedHz; 245 uint32_t minSpeedHz; 246 uint32_t regCrg; 247 uint32_t clkEnBit; 248 uint32_t clkRstBit; 249 uint32_t regMiscCtrl; 250 uint32_t miscCtrlCsShift; 251 uint32_t miscCtrlCs; 252 uint16_t mode; 253 uint8_t bitsPerWord; 254 uint8_t transferMode; 255 }; 256 257 /* SpiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。 */ 258 struct SpiCntlr { 259 struct IDeviceIoService service; 260 struct HdfDeviceObject *device; 261 uint32_t busNum; 262 uint32_t numCs; 263 uint32_t curCs; 264 struct OsalMutex lock; 265 struct SpiCntlrMethod *method; 266 struct DListHead list; 267 void *priv; 268 }; 269 ``` 270 271 - SpiCntlr成员钩子函数结构体SpiCntlrMethod的实例化，其他成员在Init函数中初始化。 272 273 274 ```c 275 /* spi_hi35xx.c中的示例：钩子函数的实例化 */ 276 struct SpiCntlrMethod g_method = { 277 .Transfer = Pl022Transfer, 278 .SetCfg = Pl022SetCfg, 279 .GetCfg = Pl022GetCfg, 280 .Open = Pl022Open, 281 .Close = Pl022Close, 282 }; 283 ``` 284 285 - Bind函数参考 286 287 入参： 288 289 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 290 291 返回值： 292 293 HDF_STATUS相关状态。 294 295 函数说明： 296 297 将SpiCntlr对象同HdfDeviceObject进行了关联。 298 299 300 ```c 301 static int32_t HdfSpiDeviceBind(struct HdfDeviceObject *device) 302 { 303 ... 304 return (SpiCntlrCreate(device) == NULL) ? HDF_FAILURE : HDF_SUCCESS; 305 } 306 307 struct SpiCntlr *SpiCntlrCreate(struct HdfDeviceObject *device) 308 { 309 struct SpiCntlr *cntlr = NULL; // 创建核心层SpiCntlr对象 310 ... 311 cntlr = (struct SpiCntlr *)OsalMemCalloc(sizeof(*cntlr)); // 分配内存 312 ... 313 cntlr->device = device; // 使HdfDeviceObject与SpiCntlr可以相互转化的前提 314 device->service = &(cntlr->service); // 使HdfDeviceObject与SpiCntlr可以相互转化的前提 315 (void)OsalMutexInit(&cntlr->lock); // 锁初始化 316 DListHeadInit(&cntlr->list); // 添加对应的节点 317 cntlr->priv = NULL; 318 return cntlr; 319 } 320 ``` 321 322 - Init函数开发参考 323 324 入参： 325 326 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 327 328 返回值： 329 330 HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 331 332 **表2** HDF_STATUS返回值描述 333 334 | 状态(值) | 描述 | 335 | -------- | -------- | 336 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 337 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 338 | HDF_ERR_INVALID_PARAM | 参数非法 | 339 | HDF_ERR_IO | I/O 错误 | 340 | HDF_SUCCESS | 初始化成功 | 341 | HDF_FAILURE | 初始化失败 | 342 343 函数说明： 344 345 初始化自定义结构体对象，初始化SpiCntlr成员。 346 347 348 ```c 349 static int32_t HdfSpiDeviceInit(struct HdfDeviceObject *device) 350 { 351 int32_t ret; 352 struct SpiCntlr *cntlr = NULL; 353 ... 354 cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转换，通过service成员，赋值见Bind函数。 355 // return (device == NULL) ? NULL : (struct SpiCntlr *)device->service; 356 ... 357 ret = Pl022Init(cntlr, device); // 【必要】实例化驱动适配者自定义操作对象，示例见下。 358 ... 359 ret = Pl022Probe(cntlr->priv); 360 ... 361 return ret; 362 } 363 364 static int32_t Pl022Init(struct SpiCntlr *cntlr, const struct HdfDeviceObject *device) 365 { 366 int32_t ret; 367 struct Pl022 *pl022 = NULL; 368 ... 369 pl022 = (struct Pl022 *)OsalMemCalloc(sizeof(*pl022)); // 申请内存 370 ... 371 ret = SpiGetBaseCfgFromHcs(pl022, device->property); // 初始化busNum、numCs、speed、fifoSize、clkRate、mode、bitsPerWord、transferMode参数值。 372 ... 373 ret = SpiGetRegCfgFromHcs(pl022, device->property); // 初始化regBase、phyBase、irqNum、regCrg、clkEnBit、clkRstBit、regMiscCtrl、regMiscCtrl、 miscCtrlCs、miscCtrlCsShift参数值。 374 ... 375 // 计算最大、最小速度对应的频率。 376 pl022->maxSpeedHz = (pl022->clkRate) / ((SCR_MIN + 1) * CPSDVSR_MIN); 377 pl022->minSpeedHz = (pl022->clkRate) / ((SCR_MAX + 1) * CPSDVSR_MAX); 378 DListHeadInit(&pl022->deviceList); // 初始化DList链表 379 pl022->cntlr = cntlr; // 使Pl022与SpiCntlr可以相互转化的前提 380 cntlr->priv = pl022; // 使Pl022与SpiCntlr可以相互转化的前提 381 cntlr->busNum = pl022->busNum; // 给SpiCntlr的busNum赋值 382 cntlr->method = &g_method; // SpiCntlrMethod的实例化对象的挂载 383 ... 384 ret = Pl022CreatAndInitDevice(pl022); 385 if (ret != 0) { 386 Pl022Release(pl022); // 初始化失败则释放Pl022对象 387 return ret; 388 } 389 return 0; 390 } 391 ``` 392 - Release函数开发参考 393 394 入参： 395 396 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 397 398 返回值： 399 400 无。 401 402 函数说明： 403 404 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。 405 406 >  **说明：**<br> 407 > 所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。 408 409 ```c 410 static void HdfSpiDeviceRelease(struct HdfDeviceObject *device) 411 { 412 struct SpiCntlr *cntlr = NULL; 413 ... 414 cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转换，通过service成员，赋值见Bind函数 415 // return (device==NULL) ?NULL:(struct SpiCntlr *)device->service; 416 ... 417 if (cntlr->priv != NULL) { 418 Pl022Remove((struct Pl022 *)cntlr->priv); // 这里有SpiCntlr到Pl022的强制转换 419 } 420 SpiCntlrDestroy(cntlr); // 释放Pl022对象 421 } 422 ``` 423
