foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
spi.c File Reference

Driver for the SPI module. More...

#include "spi.h"
#include "HL_reg_spi.h"
#include "HL_spi.h"
#include "HL_sys_common.h"
#include "dma.h"
#include "fsystem.h"
#include "io.h"
#include "mcu.h"
#include "os.h"
Include dependency graph for spi.c:

Go to the source code of this file.

Macros

#define SPI_FLAG_REGISTER_TRANSMISSION_ERRORS   (0x5Fu)
 

Functions

STD_RETURN_TYPE_e SPI_TransmitDummyByte (SPI_INTERFACE_CONFIG_s *pSpiInterface, uint32_t delay)
 Sends a dummy byte to wake up the SPI interface. More...
 
STD_RETURN_TYPE_e SPI_TransmitData (SPI_INTERFACE_CONFIG_s *pSpiInterface, uint16_t *pTxBuff, uint32_t frameLength)
 Sends data on SPI without DMA. More...
 
STD_RETURN_TYPE_e SPI_TransmitDataWithDummy (SPI_INTERFACE_CONFIG_s *pSpiInterface, uint32_t delay, uint16_t *pTxBuff, uint32_t frameLength)
 Sends data on SPI without DMA, with wake-up byte. More...
 
STD_RETURN_TYPE_e SPI_TransmitReceiveData (SPI_INTERFACE_CONFIG_s *pSpiInterface, uint16 *pTxBuff, uint16 *pRxBuff, uint32 frameLength)
 Transmits and receives data on SPI without DMA. More...
 
STD_RETURN_TYPE_e SPI_DirectlyTransmitReceiveData (SPI_INTERFACE_CONFIG_s *pSpiInterface, uint16 *pTxBuff, uint16 *pRxBuff, uint32 frameLength)
 Transmits and receives data on SPI without DMA. More...
 
STD_RETURN_TYPE_e SPI_TransmitReceiveDataDma (SPI_INTERFACE_CONFIG_s *pSpiInterface, uint16_t *pTxBuff, uint16_t *pRxBuff, uint32_t frameLength)
 Transmits and receives data on SPI with DMA. More...
 
STD_RETURN_TYPE_e SPI_TransmitReceiveDataWithDummyDma (SPI_INTERFACE_CONFIG_s *pSpiInterface, uint32_t delay, uint16_t *pTxBuff, uint16_t *pRxBuff, uint32_t frameLength)
 Transmits and receives data on SPI with DMA. More...
 
STD_RETURN_TYPE_e SPI_Lock (uint8_t spi)
 Locks SPI interfaces. More...
 
void SPI_Unlock (uint8_t spi)
 Unlocks SPI interfaces. More...
 
void SPI_SetFunctional (spiBASE_t *pNode, enum spiPinSelect bit, bool hardwareControlled)
 Sets the functional of a SPI pin. More...
 

Detailed Description

Driver for the SPI module.

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2019-12-12 (date of creation)
Updated
2021-07-14 (date of last update)
Prefix
SPI

Definition in file spi.c.

Macro Definition Documentation

◆ SPI_FLAG_REGISTER_TRANSMISSION_ERRORS

#define SPI_FLAG_REGISTER_TRANSMISSION_ERRORS   (0x5Fu)

Bitfield to check for transmission errors in SPI FLAG register

Definition at line 69 of file spi.c.

Function Documentation

◆ SPI_DirectlyTransmitReceiveData()

STD_RETURN_TYPE_e SPI_DirectlyTransmitReceiveData ( SPI_INTERFACE_CONFIG_s pSpiInterface,
uint16 *  pTxBuff,
uint16 *  pRxBuff,
uint32  frameLength 
)

Transmits and receives data on SPI without DMA.

This function can be used to send and receive data via SPI. SPI communication is performed in blocking mode but setting/resetting chip select and locking of the peripheral is not handled by this function. This must be ensured by the caller.

Parameters
pSpiInterfacepointer to SPI interface configuration
pTxBuffpointer to data that is transmitted by the SPI interface
pRxBuffpointer to data that is received by the SPI interface
frameLengthnumber of bytes to be transmitted by the SPI interface
Returns
status of the SPI transfer

Definition at line 166 of file spi.c.

◆ SPI_Lock()

STD_RETURN_TYPE_e SPI_Lock ( uint8_t  spi)

Locks SPI interfaces.

This function is used to change the state of the SPI_busy_flags variable to "locked".

Parameters
spiSPI interface to be locked (0-4 on the TMS570LC4357)
Returns
STD_OK if SPI interface could be locked, STD_NOT_OK otherwise

Definition at line 407 of file spi.c.

Here is the call graph for this function:

◆ SPI_SetFunctional()

void SPI_SetFunctional ( spiBASE_t *  pNode,
enum spiPinSelect  bit,
bool  hardwareControlled 
)

Sets the functional of a SPI pin.

SPI pins in this HAL can have functional state SPI (for when it is controlled by the SPI hardware) and functional state GIO (for when it is controlled as a GIO pin).

Parameters
[in,out]pNodehandle of the SPI node that should be configured
[in]bitbit that should be manipulated, other pins remain unchanged
[in]hardwareControlledWhether the bit should be hardware controlled (true) or not (false)

Definition at line 430 of file spi.c.

◆ SPI_TransmitData()

STD_RETURN_TYPE_e SPI_TransmitData ( SPI_INTERFACE_CONFIG_s pSpiInterface,
uint16_t *  pTxBuff,
uint32_t  frameLength 
)

Sends data on SPI without DMA.

Parameters
pSpiInterfacepointer to SPI interface configuration
pTxBuffpointer to data that is transmitted by the SPI interface
frameLengthnumber of bytes to be transmitted by the SPI interface
Returns
status of the SPI transfer

Definition at line 104 of file spi.c.

Here is the call graph for this function:

◆ SPI_TransmitDataWithDummy()

STD_RETURN_TYPE_e SPI_TransmitDataWithDummy ( SPI_INTERFACE_CONFIG_s pSpiInterface,
uint32_t  delay,
uint16_t *  pTxBuff,
uint32_t  frameLength 
)

Sends data on SPI without DMA, with wake-up byte.

It calls SPI_SendDummyByte() to wake-up the SPI interface.

Parameters
pSpiInterfacepointer to SPI interface configuration
delaydelay to wait after dummy byte transfer
pTxBuffpointer to data that is transmitted by the SPI interface
frameLengthnumber of bytes to be transmitted by the SPI interface
Returns
status of the SPI transfer

Definition at line 125 of file spi.c.

Here is the call graph for this function:

◆ SPI_TransmitDummyByte()

STD_RETURN_TYPE_e SPI_TransmitDummyByte ( SPI_INTERFACE_CONFIG_s pSpiInterface,
uint32_t  delay 
)

Sends a dummy byte to wake up the SPI interface.

Parameters
pSpiInterfacepointer to SPI interface configuration
delaydelay to wait after dummy byte transfer
Returns
status of the SPI transfer

Definition at line 81 of file spi.c.

Here is the call graph for this function:

◆ SPI_TransmitReceiveData()

STD_RETURN_TYPE_e SPI_TransmitReceiveData ( SPI_INTERFACE_CONFIG_s pSpiInterface,
uint16 *  pTxBuff,
uint16 *  pRxBuff,
uint32  frameLength 
)

Transmits and receives data on SPI without DMA.

This function can be used to send and receive data via SPI. SPI communication is performed in blocking mode and chip select is set/reset automatically.

Parameters
pSpiInterfacepointer to SPI interface configuration
pTxBuffpointer to data that is transmitted by the SPI interface
pRxBuffpointer to data that is received by the SPI interface
frameLengthnumber of bytes to be transmitted by the SPI interface
Returns
status of the SPI transfer

Definition at line 142 of file spi.c.

Here is the call graph for this function:

◆ SPI_TransmitReceiveDataDma()

STD_RETURN_TYPE_e SPI_TransmitReceiveDataDma ( SPI_INTERFACE_CONFIG_s pSpiInterface,
uint16_t *  pTxBuff,
uint16_t *  pRxBuff,
uint32_t  frameLength 
)

Transmits and receives data on SPI with DMA.

This function can be used to send and receive data via SPI. SPI communication is performed in blocking mode and chip select is set/reset automatically..

Parameters
pSpiInterfacepointer to SPI interface configuration
pTxBuffpointer to data that is transmitted by the SPI interface
pRxBuffpointer to data that is received by the SPI interface
frameLengthnumber of bytes to be transmitted by the SPI interface
Returns
status of the SPI transfer

Definition at line 183 of file spi.c.

Here is the call graph for this function:

◆ SPI_TransmitReceiveDataWithDummyDma()

STD_RETURN_TYPE_e SPI_TransmitReceiveDataWithDummyDma ( SPI_INTERFACE_CONFIG_s pSpiInterface,
uint32_t  delay,
uint16_t *  pTxBuff,
uint16_t *  pRxBuff,
uint32_t  frameLength 
)

Transmits and receives data on SPI with DMA.

This function can be used to send and receive data via SPI. SPI communication is performed in blocking mode and chip select is set/reset automatically. A dummy is sent first.

Parameters
pSpiInterfacepointer to SPI interface configuration
delaydelay to wait after dummy byte transfer
pTxBuffpointer to data that is transmitted by the SPI interface
pRxBuffpointer to data that is received by the SPI interface
frameLengthnumber of bytes to be transmitted by the SPI interface
Returns
status of the SPI transfer

Definition at line 291 of file spi.c.

Here is the call graph for this function:

◆ SPI_Unlock()

void SPI_Unlock ( uint8_t  spi)

Unlocks SPI interfaces.

This function is used to change the state of the SPI_busy_flags variable to "unlocked".

Parameters
spiSPI interface to be unlocked (0-4 on the TMS570LC4357)

Definition at line 422 of file spi.c.

Here is the call graph for this function: