This file provides firmware functions to manage the following functionalities of the Serial peripheral interface (SPI): More...
Include dependency graph for stm32f4xx_spi.c:
Go to the source code of this file.
Macros | |
| #define | CR1_CLEAR_MASK ((uint16_t)0x3040) |
| #define | I2SCFGR_CLEAR_MASK ((uint16_t)0xF040) |
| #define | PLLCFGR_PPLN_MASK ((uint32_t)0x00007FC0) |
| #define | PLLCFGR_PPLR_MASK ((uint32_t)0x70000000) |
| #define | SPI_CR2_FRF ((uint16_t)0x0010) |
| #define | SPI_SR_TIFRFE ((uint16_t)0x0100) |
Functions | |
| void | I2S_Cmd (SPI_TypeDef *SPIx, FunctionalState NewState) |
| Enables or disables the specified SPI peripheral (in I2S mode). More... | |
| void | I2S_FullDuplexConfig (SPI_TypeDef *I2Sxext, I2S_InitTypeDef *I2S_InitStruct) |
| Configures the full duplex mode for the I2Sx peripheral using its extension I2Sxext according to the specified parameters in the I2S_InitStruct. More... | |
| void | I2S_Init (SPI_TypeDef *SPIx, I2S_InitTypeDef *I2S_InitStruct) |
| Initializes the SPIx peripheral according to the specified parameters in the I2S_InitStruct. More... | |
| void | I2S_StructInit (I2S_InitTypeDef *I2S_InitStruct) |
| Fills each I2S_InitStruct member with its default value. More... | |
| void | SPI_BiDirectionalLineConfig (SPI_TypeDef *SPIx, uint16_t SPI_Direction) |
| Selects the data transfer direction in bidirectional mode for the specified SPI. More... | |
| void | SPI_CalculateCRC (SPI_TypeDef *SPIx, FunctionalState NewState) |
| Enables or disables the CRC value calculation of the transferred bytes. More... | |
| void | SPI_Cmd (SPI_TypeDef *SPIx, FunctionalState NewState) |
| Enables or disables the specified SPI peripheral. More... | |
| void | SPI_DataSizeConfig (SPI_TypeDef *SPIx, uint16_t SPI_DataSize) |
| Configures the data size for the selected SPI. More... | |
| uint16_t | SPI_GetCRC (SPI_TypeDef *SPIx, uint8_t SPI_CRC) |
| Returns the transmit or the receive CRC register value for the specified SPI. More... | |
| uint16_t | SPI_GetCRCPolynomial (SPI_TypeDef *SPIx) |
| Returns the CRC Polynomial register value for the specified SPI. More... | |
| void | SPI_I2S_ClearFlag (SPI_TypeDef *SPIx, uint16_t SPI_I2S_FLAG) |
| Clears the SPIx CRC Error (CRCERR) flag. More... | |
| void | SPI_I2S_ClearITPendingBit (SPI_TypeDef *SPIx, uint8_t SPI_I2S_IT) |
| Clears the SPIx CRC Error (CRCERR) interrupt pending bit. More... | |
| void | SPI_I2S_DeInit (SPI_TypeDef *SPIx) |
| De-initialize the SPIx peripheral registers to their default reset values. More... | |
| void | SPI_I2S_DMACmd (SPI_TypeDef *SPIx, uint16_t SPI_I2S_DMAReq, FunctionalState NewState) |
| Enables or disables the SPIx/I2Sx DMA interface. More... | |
| FlagStatus | SPI_I2S_GetFlagStatus (SPI_TypeDef *SPIx, uint16_t SPI_I2S_FLAG) |
| Checks whether the specified SPIx/I2Sx flag is set or not. More... | |
| ITStatus | SPI_I2S_GetITStatus (SPI_TypeDef *SPIx, uint8_t SPI_I2S_IT) |
| Checks whether the specified SPIx/I2Sx interrupt has occurred or not. More... | |
| void | SPI_I2S_ITConfig (SPI_TypeDef *SPIx, uint8_t SPI_I2S_IT, FunctionalState NewState) |
| Enables or disables the specified SPI/I2S interrupts. More... | |
| uint16_t | SPI_I2S_ReceiveData (SPI_TypeDef *SPIx) |
| Returns the most recent received data by the SPIx/I2Sx peripheral. More... | |
| void | SPI_I2S_SendData (SPI_TypeDef *SPIx, uint16_t Data) |
| Transmits a Data through the SPIx/I2Sx peripheral. More... | |
| void | SPI_Init (SPI_TypeDef *SPIx, SPI_InitTypeDef *SPI_InitStruct) |
| Initializes the SPIx peripheral according to the specified parameters in the SPI_InitStruct. More... | |
| void | SPI_NSSInternalSoftwareConfig (SPI_TypeDef *SPIx, uint16_t SPI_NSSInternalSoft) |
| Configures internally by software the NSS pin for the selected SPI. More... | |
| void | SPI_SSOutputCmd (SPI_TypeDef *SPIx, FunctionalState NewState) |
| Enables or disables the SS output for the selected SPI. More... | |
| void | SPI_StructInit (SPI_InitTypeDef *SPI_InitStruct) |
| Fills each SPI_InitStruct member with its default value. More... | |
| void | SPI_TIModeCmd (SPI_TypeDef *SPIx, FunctionalState NewState) |
| Enables or disables the SPIx/I2Sx DMA interface. More... | |
| void | SPI_TransmitCRC (SPI_TypeDef *SPIx) |
| Transmit the SPIx CRC value. More... | |
Detailed Description
This file provides firmware functions to manage the following functionalities of the Serial peripheral interface (SPI):
- Version
- V1.1.0
- Date
- 11-January-2013
- Initialization and Configuration
- Data transfers functions
- Hardware CRC Calculation
- DMA transfers management
- Interrupts and flags management
===================================================================
##### How to use this driver #####
===================================================================
[..]
(#) Enable peripheral clock using the following functions
RCC_APB2PeriphClockCmd(RCC_APB2Periph_SPI1, ENABLE) for SPI1
RCC_APB1PeriphClockCmd(RCC_APB1Periph_SPI2, ENABLE) for SPI2
RCC_APB1PeriphResetCmd(RCC_APB1Periph_SPI3, ENABLE) for SPI3
RCC_APB1PeriphResetCmd(RCC_APB1Periph_SPI3, ENABLE) for SPI4
RCC_APB1PeriphResetCmd(RCC_APB1Periph_SPI3, ENABLE) for SPI5
RCC_APB1PeriphResetCmd(RCC_APB1Periph_SPI3, ENABLE) for SPI6.
(#) Enable SCK, MOSI, MISO and NSS GPIO clocks using RCC_AHB1PeriphClockCmd()
function. In I2S mode, if an external clock source is used then the I2S
CKIN pin GPIO clock should also be enabled.
(#) Peripherals alternate function:
(++) Connect the pin to the desired peripherals' Alternate Function (AF)
using GPIO_PinAFConfig() function
(++) Configure the desired pin in alternate function by:
GPIO_InitStruct->GPIO_Mode = GPIO_Mode_AF
(++) Select the type, pull-up/pull-down and output speed via GPIO_PuPd,
GPIO_OType and GPIO_Speed members
(++) Call GPIO_Init() function In I2S mode, if an external clock source is
used then the I2S CKIN pin should be also configured in Alternate
function Push-pull pull-up mode.
(#) Program the Polarity, Phase, First Data, Baud Rate Prescaler, Slave
Management, Peripheral Mode and CRC Polynomial values using the SPI_Init()
function.
In I2S mode, program the Mode, Standard, Data Format, MCLK Output, Audio
frequency and Polarity using I2S_Init() function. For I2S mode, make sure
that either:
(++) I2S PLL is configured using the functions
RCC_I2SCLKConfig(RCC_I2S2CLKSource_PLLI2S), RCC_PLLI2SCmd(ENABLE) and
RCC_GetFlagStatus(RCC_FLAG_PLLI2SRDY); or
(++) External clock source is configured using the function
RCC_I2SCLKConfig(RCC_I2S2CLKSource_Ext) and after setting correctly
the define constant I2S_EXTERNAL_CLOCK_VAL in the stm32f4xx_conf.h file.
(#) Enable the NVIC and the corresponding interrupt using the function
SPI_ITConfig() if you need to use interrupt mode.
(#) When using the DMA mode
(++) Configure the DMA using DMA_Init() function
(++) Active the needed channel Request using SPI_I2S_DMACmd() function
(#) Enable the SPI using the SPI_Cmd() function or enable the I2S using
I2S_Cmd().
(#) Enable the DMA using the DMA_Cmd() function when using DMA mode.
(#) Optionally, you can enable/configure the following parameters without
re-initialization (i.e there is no need to call again SPI_Init() function):
(++) When bidirectional mode (SPI_Direction_1Line_Rx or SPI_Direction_1Line_Tx)
is programmed as Data direction parameter using the SPI_Init() function
it can be possible to switch between SPI_Direction_Tx or SPI_Direction_Rx
using the SPI_BiDirectionalLineConfig() function.
(++) When SPI_NSS_Soft is selected as Slave Select Management parameter
using the SPI_Init() function it can be possible to manage the
NSS internal signal using the SPI_NSSInternalSoftwareConfig() function.
(++) Reconfigure the data size using the SPI_DataSizeConfig() function
(++) Enable or disable the SS output using the SPI_SSOutputCmd() function
(#) To use the CRC Hardware calculation feature refer to the Peripheral
CRC hardware Calculation subsection.
[..] It is possible to use SPI in I2S full duplex mode, in this case, each SPI
peripheral is able to manage sending and receiving data simultaneously
using two data lines. Each SPI peripheral has an extended block called I2Sxext
(ie. I2S2ext for SPI2 and I2S3ext for SPI3).
The extension block is not a full SPI IP, it is used only as I2S slave to
implement full duplex mode. The extension block uses the same clock sources
as its master.
To configure I2S full duplex you have to:
(#) Configure SPIx in I2S mode (I2S_Init() function) as described above.
(#) Call the I2S_FullDuplexConfig() function using the same strucutre passed to
I2S_Init() function.
(#) Call I2S_Cmd() for SPIx then for its extended block.
(#) To configure interrupts or DMA requests and to get/clear flag status,
use I2Sxext instance for the extension block.
[..] Functions that can be called with I2Sxext instances are: I2S_Cmd(),
I2S_FullDuplexConfig(), SPI_I2S_ReceiveData(), SPI_I2S_SendData(),
SPI_I2S_DMACmd(), SPI_I2S_ITConfig(), SPI_I2S_GetFlagStatus(),
SPI_I2S_ClearFlag(), SPI_I2S_GetITStatus() and SPI_I2S_ClearITPendingBit().
Example: To use SPI3 in Full duplex mode (SPI3 is Master Tx, I2S3ext is Slave Rx):
RCC_APB1PeriphClockCmd(RCC_APB1Periph_SPI3, ENABLE);
I2S_StructInit(&I2SInitStruct);
I2SInitStruct.Mode = I2S_Mode_MasterTx;
I2S_Init(SPI3, &I2SInitStruct);
I2S_FullDuplexConfig(SPI3ext, &I2SInitStruct)
I2S_Cmd(SPI3, ENABLE);
I2S_Cmd(SPI3ext, ENABLE);
...
while (SPI_I2S_GetFlagStatus(SPI2, SPI_FLAG_TXE) == RESET)
{}
SPI_I2S_SendData(SPI3, txdata[i]);
...
while (SPI_I2S_GetFlagStatus(I2S3ext, SPI_FLAG_RXNE) == RESET)
{}
rxdata[i] = SPI_I2S_ReceiveData(I2S3ext);
...
[..]
(@) In I2S mode: if an external clock is used as source clock for the I2S,
then the define I2S_EXTERNAL_CLOCK_VAL in file stm32f4xx_conf.h should
be enabled and set to the value of the source clock frequency (in Hz).
(@) In SPI mode: To use the SPI TI mode, call the function SPI_TIModeCmd()
just after calling the function SPI_Init().@attention
<h2><center>© COPYRIGHT 2013 STMicroelectronics</center></h2>
Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
You may not use this file except in compliance with the License.
You may obtain a copy of the License at:
http://www.st.com/software_license_agreement_liberty_v2
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Definition in file stm32f4xx_spi.c.