foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
ltc_afe_dma.h File Reference

Headers for the driver for the DMA module for the LTC. More...

#include "afe_dma.h"
#include "dma_cfg.h"
#include "ltc_defs.h"
Include dependency graph for ltc_afe_dma.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

STD_RETURN_TYPE_e AFE_TransmitReceiveSpiWithDma (uint16_t *tx, uint16_t *rx, uint32_t length)
 Sends and receives data over SPI with DMA. More...
 
bool AFE_IsTransmitOngoing (LTC_STATE_s *pLtcState)
 gets the SPI transmit status. More...
 
void AFE_SetTransmitOngoing (LTC_STATE_s *pLtcState)
 sets the SPI transmit status. More...
 

Detailed Description

Headers for the driver for the DMA module for the LTC.

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
2020-05-27 (date of creation)
Updated
2020-06-18 (date of last update)
Prefix
AFE

Definition in file ltc_afe_dma.h.

Function Documentation

◆ AFE_IsTransmitOngoing()

bool AFE_IsTransmitOngoing ( LTC_STATE_s pLtcState)

gets the SPI transmit status.

Parameters
[in,out]pLtcStatepointer to state struct to check if transmit is ongoing
Returns
retval true if transmission still ongoing, false otherwise

Definition at line 73 of file ltc_afe_dma.c.

◆ AFE_SetTransmitOngoing()

void AFE_SetTransmitOngoing ( LTC_STATE_s pLtcState)

sets the SPI transmit status.

Parameters
[in,out]pLtcStatepointer to state struct to set transmission state to ongoing

Definition at line 77 of file ltc_afe_dma.c.

◆ AFE_TransmitReceiveSpiWithDma()

STD_RETURN_TYPE_e AFE_TransmitReceiveSpiWithDma ( uint16_t *  tx,
uint16_t *  rx,
uint32_t  length 
)

Sends and receives data over SPI with DMA.