跳至主要內容

Spi 配置使用说明

ChipON AE大约 11 分钟约 3225 字2025/8/11配置工具

Spi 配置使用说明

简介

本手册详细介绍了如何使用灵犀配置KF32A158SQV芯片的Spi模块。

环境准备

确保已安装以下软件：

  1. 灵犀（版本需支持KF32A158SQV芯片）
  2. 支持KF32A158SQV芯片的MCAL（Microcontroller Abstraction Layer）软件包

创建项目

  1. 打开灵犀。
  2. 点击主界面上的“新建项目”按钮，如图所示
    新建项目

选择MCU型号

  1. 在“MCU型号选择”窗口中，选择“MCAL”项目类型。
  2. 在“快速选择MCU”下拉菜单中，选择“KF32A158SQV”。
  3. 点击“创建”按钮，如图所示
    MCU选择

添加SPI模块

  1. 在灵犀主界面，点击左侧的“》”按钮打开模块添加界面，如图所示
    模块选择
  2. 在灵犀主界面，点击“Apply Module”按钮。
  3. 在“Module Manager”窗口中，从“unUsed”列表中选择“Spi”模块。
  4. 点击中间的“>”按钮，将“Spi”模块移动到“used”列表中。
  5. 点击“Apply”按钮，完成模块添加，如图所示
    模块增加

配置SPI模块

配置SpiDemEventParameterRefs

用于存放对DemEventParameter元素的引用，这些元素在发生相应错误时应通过API Dem_SetEventStatus进行调用。暂不支持

配置SpiGeneral

配置SPI通用信息。

  • SpiCancelApi：取消函数Spi_Cancel开关。

  • SpiChannelBuffersAllowed：允许使用多个通道缓冲区。

    配置功能描述
    SPI_USAGE0（配置值0）仅使用内部缓冲区（IB），由驱动程序管理。
    SPI_USAGE1（配置值1）仅使用外部缓冲区（EB），由应用程序管理。
    SPI_USAGE2（配置值2）同时支持内部缓冲区和外部缓冲区。

  • SpiDevErrorDetect：DET错误检测开关。

  • SpiHwStatusApi：硬件状态函数Spi_GetHWUnitStatus开关。

  • SpiInterruptibleSeqAllowed：可中断序列处理功能开启或关闭，仅适用于级别1或2（SpiLevelDelivered配置为1或2）。

  • SpiLevelDelivered：配置SPI的等级。

    级别功能描述同步模式异步模式特点
    SPI_LEVEL_0（配置值0）简单同步传输支持不支持同步阻塞调用，适合简单场景。
    SPI_LEVEL_1（配置值1）异步传输不支持支持异步非阻塞调用，支持中断或轮询模式。
    SPI_LEVEL_2（配置值2）增强型传输支持支持同时支持同步和异步模式，功能最全面。
    异步模式目前都是配合DMA使用

  • SpiMainFunctionPeriod：配置SPI主函数的周期，在Spi_Cfg.h中生成SPI_MAIN_FUNCTION_PERIOD信息。

  • SpiSupportConcurrentSyncTransmit：指定是否应configurable同时调用Spi_SyncTransmit()以处理不同的序列。

  • SpiVersionInfoApi：获取SPI版本信息开关。

  • SpiEcucPartitionRef：配置SPI的ECUC分区。暂不支持

  • SpiKernelEcucPartitionRef：配置SPI的Kernel ECUC分区。暂不支持

  • SpiApiTailoring：定制信息配置

    • SpiMasterSupport：SPI是否支持主模式。
    • SpiSlaveSupport：SPI是否支持从模式。
    • SpiDisableDemReportErrorStatus：禁用Dem报告错误状态。配置为false表示启用该功能。
    • SpiPrecompileSupport：配置SPI的预编译支持。设置为true表示启用，调用初始化函数时，入参应为空指针；为false表示不启用，调用初始化函数时，入参为配置参数地址。
    • SpiFifoUsed：配置SPI是否使用硬件FIFO，配置为true表示启用该功能。（仅部分芯片有此选项）

配置SpiPublishedInformation

配置硬件单元个数。

  • SpiMaxHwUnit：配置硬件单元个数，最大支持3个。
    • 在KF32A158SQV配置中，此参数决定后续配置SpiExternalDevice的最大个数。
    • 在KF32A158NQVSF、KF32A138MQTSF配置中，此参数决定后续配置SpiHwUnitConfig的最大个数，SpiExternalDevice的最大个数由SpiMaxJob决定。

配置SpiDriver

配置SPI驱动信息。配置Sequence、Job、Channel信息。

  • SpiMaxChannel：配置Channel最大个数。
  • SpiMaxJob：配置Job最大个数
  • SpiMaxSequence：配置Sequence最大个数。
  • SpiChannel：配置Channel信息。
    • 增加Channel
      Channel
    • SpiChannelId：配置Channel的ID。在Spi_Cfg.h生成配置信息，用于上层使用，新增Channel时，该值自动加一。
    • SpiChannelType：配置Channel的类型。
      特性IB（Internally Buffered Channels）EB（Externally Buffered Channels）
      缓冲区来源由驱动程序提供（配置SpiBufferDescriptor）由用户提供
      缓冲区大小固定动态可配置
      数据一致性驱动程序不保证用户负责
      适用场景短数据传输、性能要求高大数据传输、需要灵活管理缓冲区
      配置方式配置文件指定缓冲区大小用户通过 API 设置缓冲区地址和长度
      读写接口Spi_WriteIB、Spi_ReadIBSpi_SetupEB
    • SpiDataWidth：数据宽度，8\16\32。
    • SpiDefaultData：配置默认数据。使用IB接口时，Spi_WriteIB第二个参数为空指针时，将使用此默认数据。
    • SpiEbMaxLength：配置EB缓冲区最大长度。Spi_SetupEB接口入参判断使用。
    • SpiIbNBuffers：配置IB缓冲区大小。
    • SpiTransferStart：数据方向选择位。
    • SpiBufferDescriptor：配置Channel的缓冲区信息，IB模式才需要使用配置。
      • SpiBufferTX：配置IB发送缓冲区信息。
      • SpiBufferRX：配置IB接收缓冲区信息。
  • SpiExternalDevice：配置与Job关联的硬件单元信息。
    • SpiBaudrate：配置硬件单元的波特率。暂不支持，需要配置具体寄存器值
    • SpiCsIdentifier：配置硬件单元的CS引脚编号。应填入"SS0"~"SS3"，部分芯片仅支持SS0，则该配置项固定不可修改。
    • SpiCsPolarity：配置硬件单元的CS引脚电平。暂不支持
    • SpiCsSelection：配置硬件单元的CS引脚选择。GPIO或硬件CS。
    • SpiDataShiftEdge：配置硬件单元的数据位移边沿。
    • SpiShiftClockIdleLevel：配置硬件单元的时钟空闲电平。
      SpiDataShiftEdgeSpiShiftClockIdleLevel功能描述SPI 模式时序特点应用场景
      LEADINGHIGH数据在时钟上升沿采样，时钟空闲为高电平SPI 模式 0数据在时钟上升沿采样，空闲时钟为高电平适用于大多数 SPI 设备，数据在时钟上升沿采样
      LEADINGLOW数据在时钟上升沿采样，时钟空闲为低电平SPI 模式 3数据在时钟上升沿采样，空闲时钟为低电平适用于需要在时钟低电平时保持数据稳定的设备
      TRAILINGHIGH数据在时钟下降沿采样，时钟空闲为高电平SPI 模式 1数据在时钟下降沿采样，空闲时钟为高电平适用于需要在时钟下降沿采样的设备
      TRAILINGLOW数据在时钟下降沿采样，时钟空闲为低电平SPI 模式 2数据在时钟下降沿采样，空闲时钟为低电平适用于需要在时钟低电平时保持数据稳定的设备，且数据在下降沿采样
    • SpiEnableCs：配置硬件单元的CS引脚使能。暂未使用
    • SpiHwUnit：配置硬件单元的ID。CSIBn即SPIn，实际可选项取决于芯片。
    • SpiTimeClk2Cs：配置硬件单元的CS引脚使能时间。暂未使用
    • SpiDriverTailoring：定制化信息配置。（仅适用于部分芯片，其余部分芯片的相关配置项位置有变更）
      • SpiHwClkSrc：配置硬件单元的时钟源。
      • SpiHwClkDiv：配置硬件单元的时钟分频。
        Fck = SpiHwClkSrc/SpiHwClkDiv
      • SpiBaudRatePrescaler：配置硬件单元的波特率分频。
        波特率计算
      • SpiHwLineMode：SPI线模式。
      • SpiDisableCSFcn：配置SpiCsSelection为GPIO模式时，需要配置先关片选的操作函数。
      • SpiEnableCSFcn：配置SpiCsSelection为GPIO模式时，需要配置先关片选的操作函数。
    • SpiDmaConfig：DMA配置。异步模式必须开启DMA（部分芯片，其余部分芯片的此配置项在SpiHwUnitConfig配置项下）
      • SpiRxPriority：接收通道优先级。
      • SpiTxPriority：发送通道优先级。
      • RxDmaSource：接收通道配置，根据手册信息配置。
      • TxDmaSource：发送通道配置，根据手册信息配置。
        DMA通道选择需与实际SPI硬件单元匹配，其具体对应关系参见用户手册DMA章节
    • SpiBaudRatePrescaler：配置硬件单元的波特率预分频。（部分芯片，其余部分芯片的此配置项在SpiDriverTailoring配置项下）
    • SpiDisableCSFcn：配置SpiCsSelection为GPIO模式时，需要配置关闭片选的操作函数。（部分芯片，其余部分芯片的此配置项在SpiDriverTailoring配置项下）
    • SpiEnableCSFcn：配置SpiCsSelection为GPIO模式时，需要配置使能片选的操作函数。（部分芯片，其余部分芯片的此配置项在SpiDriverTailoring配置项下）
    • SpiDeviceEcucPartitionRef：设备分区。暂不支持
  • SpiJob：JOB配置。
    • SpiJobEndNotification：JOB完成通知回调函数。
    • SpiJobId：JobID。在Spi_Cfg.h生成配置信息，用于上层使用，新增Job时，该值自动加一。
    • SpiJobPriority：Job优先级。
    • SpiDeviceAssignment：硬件单元选择。只能选择已配置的SpiExternalDevice
    • SpiChannelList：配置Channel列表。
      • 增加通道选择，根据实际使用情况增加Channel选择数量
        AddChannel
      • SpiChannelIndex：Channel索引。暂不支持
      • SpiChannelAssignment：Channel选择。只能选择已配置通道
  • SpiSequence：Sequence配置。
    • SpiInterruptibleSequence：此参数允许或不允许另一个序列挂起此序列。暂不支持
    • SpiSeqEndNotification：Sequence完成通知回调函数。
    • SpiSequenceId：Sequence ID。在Spi_Cfg.h生成配置信息，用于上层使用，新增Job时，该值自动加一。
    • SpiInterruptable：是否可中断。
    • SpiJobAssignment：Job选择。
      • 增加Job选择，根据实际使用情况增加Job选择数量
        AddJob
      • SpiJobAssignment：Job选择。只能选择已配置Job
  • SpiHwUnitConfig：SPI硬件单元配置。（仅部分芯片有此配置项）
    • SpiHwUnit：配置硬件单元的ID。CSIBn即SPIn，实际可选项取决于芯片。
    • SpiHwClkSrc：配置硬件单元的时钟源。
    • SpiHwClkDiv：配置硬件单元的时钟分频。
      Fck = SpiHwClkSrc/SpiHwClkDiv
    • SpiHwLineMode：SPI线模式。
    • SpiDmaConfig：DMA配置。异步模式必须开启DMA
      • SpiRxPriority：接收通道优先级。
      • SpiTxPriority：发送通道优先级。
      • RxDmaSource：接收通道配置，根据手册信息配置。
      • TxDmaSource：发送通道配置，根据手册信息配置。
        DMA通道选择需与实际SPI硬件单元匹配，其具体对应关系参见用户手册DMA章节
  • SpiSlaveHwConfig：从机模式配置，需要打开SpiSlaveSupport
    • SpiHwUnit：配置硬件单元的ID。CSIBn即SPIn，实际可选项取决于芯片。
    • SpiHwClkSrc：硬件时钟源选择。
    • SpiHwClkDiv：硬件时钟分频。
    • SpiHwLineMode：SPI线模式。
    • SpiSlaveCsPin：从机片选引脚选择。
    • SpiSlaveClkMode：相位模式选择。
      模式名称CPOLCPHA时钟空闲电平数据采样边沿数据变化边沿
      SPI_CPOL_0_CPHA_000LOW（低电平）上升沿下降沿
      SPI_CPOL_0_CPHA_101LOW（低电平）下降沿上升沿
      SPI_CPOL_1_CPHA_010HIGH（高电平）下降沿上升沿
      SPI_CPOL_1_CPHA_111HIGH（高电平）上升沿下降沿
    • SpiSlaveBitOrder：位顺序（最高位/最低位）。
    • SpiDataTransferCompletionCallback：数据传输完成回调函数。
    • SpiSlaveDmaConfig：从机DMA配置。
      • SpiRxPriority：接收通道优先级。
      • SpiTxPriority：发送通道优先级。
      • RxDmaSource：接收通道配置，根据手册信息配置。
      • TxDmaSource：发送通道配置，根据手册信息配置。
        DMA通道选择需与实际SPI硬件单元匹配，其具体对应关系参见用户手册DMA章节

设置项目路径及名称

  1. 点击“Setting”按钮。
  2. “Project Name”是配置的工程名称
  3. 在“Project Path”设置工程保存路径。
  4. “Configuration Code Folder Name”配置文件存放的文件加名称。
  5. 点击“Confirm”保存设置，如图所示
    工程保存

保存配置并预览代码

  1. 点击“Save”按钮，保存配置。
  2. 点击“Preview Code”按钮，查看生成的代码文件列表，如图所示
    保存和生成
  3. 点击相应的文件名，可以预览文件内容，如图所示
    预览

生成代码

  1. 点击“Generate code”按钮，生成相关配置文件，如图所示
    生成代码

查看生成代码

  1. 生成代码后，可以在项目路径下找到生成的源文件。
  2. 使用代码编辑器打开这些文件，进行查看或进一步编辑，如图所示
    代码信息
最近更新
贡献者: 翟宇