foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
dma.h File Reference

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

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

Go to the source code of this file.

Functions

void DMA_Initialize (void)
 Enables the DMA module. More...
 
void DMA_ReInit (void)
 Re-enables the DMA module. More...
 
STD_RETURN_TYPE_e DMA_TransmitReceive_SPIwithDMA (void)
 Sends and receives data over SPI with DMA. More...
 
bool DMA_IsTransmitOngoing (void)
 gets the SPI transmit status. More...
 
void DMA_SetTransmitOngoing (void)
 sets the SPI transmit status. More...
 
bool DMA_IsTxTransmitOngoingN775 (void)
 gets the SPI transmit status. More...
 
bool DMA_IsRxTransmitOngoingN775 (void)
 gets the SPI transmit status. More...
 
void DMA_SetTxTransmitOngoingN775 (void)
 sets the SPI transmit status. More...
 
void DMA_SetRxTransmitOngoingN775 (void)
 sets the SPI transmit status. More...
 
void DMA_InitN775 (void)
 enables the DMA module. This function enables the DMA streams. More...
 
void DMA_ReInitN775Tx (void)
 Re-enables the DMA module. This function re-enables the DMA streams. Called in DMA complete interrupt. More...
 
void DMA_ReInitN775Rx (void)
 Re-enables the DMA module. This function re-enables the DMA streams. Called in DMA complete interrupt. More...
 
STD_RETURN_TYPE_e DMA_TransmitSPiWithDmaN775 (void)
 Sends data over SPI with DMA. More...
 

Variables

g_dmaCTRL g_dmaCTRLPKT_TX
 
g_dmaCTRL g_dmaCTRLPKT_RX
 
g_dmaCTRL dma_n775DmaControlPacketTx
 
g_dmaCTRL dma_n775DmaControlPacketRx
 

Detailed Description

Headers for the driver for the DMA 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
2019-12-12 (date of last update)
Prefix
DMA

Definition in file dma.h.

Function Documentation

◆ DMA_Initialize()

void DMA_Initialize ( void  )

Enables the DMA module.

This function enables the DMA streams.

Definition at line 73 of file dma.c.

◆ DMA_InitN775()

void DMA_InitN775 ( void  )

enables the DMA module. This function enables the DMA streams.

◆ DMA_IsRxTransmitOngoingN775()

bool DMA_IsRxTransmitOngoingN775 ( void  )

gets the SPI transmit status.

Returns
retval true if transmission still ongoing, false otherwise

◆ DMA_IsTransmitOngoing()

bool DMA_IsTransmitOngoing ( void  )

gets the SPI transmit status.

Returns
retval true if transmission still ongoing, false otherwise

◆ DMA_IsTxTransmitOngoingN775()

bool DMA_IsTxTransmitOngoingN775 ( void  )

gets the SPI transmit status.

Returns
retval true if transmission still ongoing, false otherwise

◆ DMA_ReInit()

void DMA_ReInit ( void  )

Re-enables the DMA module.

This function re-enables the DMA streams. Called in DMA complete interrupt.

◆ DMA_ReInitN775Rx()

void DMA_ReInitN775Rx ( void  )

Re-enables the DMA module. This function re-enables the DMA streams. Called in DMA complete interrupt.

◆ DMA_ReInitN775Tx()

void DMA_ReInitN775Tx ( void  )

Re-enables the DMA module. This function re-enables the DMA streams. Called in DMA complete interrupt.

◆ DMA_SetRxTransmitOngoingN775()

void DMA_SetRxTransmitOngoingN775 ( void  )

sets the SPI transmit status.

◆ DMA_SetTransmitOngoing()

void DMA_SetTransmitOngoing ( void  )

sets the SPI transmit status.

◆ DMA_SetTxTransmitOngoingN775()

void DMA_SetTxTransmitOngoingN775 ( void  )

sets the SPI transmit status.

◆ DMA_TransmitReceive_SPIwithDMA()

STD_RETURN_TYPE_e DMA_TransmitReceive_SPIwithDMA ( void  )

Sends and receives data over SPI with DMA.

◆ DMA_TransmitSPiWithDmaN775()

STD_RETURN_TYPE_e DMA_TransmitSPiWithDmaN775 ( void  )

Sends data over SPI with DMA.

Variable Documentation

◆ dma_n775DmaControlPacketRx

g_dmaCTRL dma_n775DmaControlPacketRx
extern

rx control packet for N775 DMA

◆ dma_n775DmaControlPacketTx

g_dmaCTRL dma_n775DmaControlPacketTx
extern

tx control packet for N775 DMA

◆ g_dmaCTRLPKT_RX

g_dmaCTRL g_dmaCTRLPKT_RX
extern

rx control packet for DMA

◆ g_dmaCTRLPKT_TX

g_dmaCTRL g_dmaCTRLPKT_TX
extern

tx control packet for DMA