foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
dma.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file dma.h
44  * @author foxBMS Team
45  * @date 2019-12-12 (date of creation)
46  * @updated 2019-12-12 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix DMA
49  *
50  * @brief Headers for the driver for the DMA module.
51  *
52  */
53 
54 #ifndef FOXBMS__DMA_H_
55 #define FOXBMS__DMA_H_
56 
57 /*========== Includes =======================================================*/
58 #include "dma_cfg.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Extern Constant and Variable Declarations ======================*/
63 /** tx control packet for DMA */
64 extern g_dmaCTRL g_dmaCTRLPKT_TX;
65 /** rx control packet for DMA */
66 extern g_dmaCTRL g_dmaCTRLPKT_RX;
67 
68 /** tx control packet for N775 DMA */
69 extern g_dmaCTRL dma_n775DmaControlPacketTx;
70 /** rx control packet for N775 DMA */
71 extern g_dmaCTRL dma_n775DmaControlPacketRx;
72 
73 /*========== Extern Function Prototypes =====================================*/
74 
75 /**
76  * @brief Enables the DMA module.
77  * @details This function enables the DMA streams.
78  */
79 extern void DMA_Initialize(void);
80 
81 /**
82  * @brief Re-enables the DMA module.
83  * @details This function re-enables the DMA streams. Called in DMA complete
84  * interrupt.
85  */
86 extern void DMA_ReInit(void);
87 
88 /**
89  * @brief Sends and receives data over SPI with DMA.
90  */
92 
93 /**
94  * @brief gets the SPI transmit status.
95  * @return retval true if transmission still ongoing, false otherwise
96  */
97 extern bool DMA_IsTransmitOngoing(void);
98 
99 /**
100  * @brief sets the SPI transmit status.
101  */
102 extern void DMA_SetTransmitOngoing(void);
103 
104 /**
105  * @brief gets the SPI transmit status.
106  * @return retval true if transmission still ongoing, false otherwise
107  */
108 extern bool DMA_IsTxTransmitOngoingN775(void);
109 
110 /**
111  * @brief gets the SPI transmit status.
112  * @return retval true if transmission still ongoing, false otherwise
113  */
114 extern bool DMA_IsRxTransmitOngoingN775(void);
115 
116 /**
117  * @brief sets the SPI transmit status.
118  */
120 
121 /**
122  * @brief sets the SPI transmit status.
123  */
125 
126 /**
127  * @brief enables the DMA module.
128  * This function enables the DMA streams.
129  */
130 void DMA_InitN775(void);
131 
132 /**
133  * @brief Re-enables the DMA module.
134  * This function re-enables the DMA streams.
135  * Called in DMA complete interrupt.
136  */
137 void DMA_ReInitN775Tx(void);
138 
139 /**
140  * @brief Re-enables the DMA module.
141  * This function re-enables the DMA streams.
142  * Called in DMA complete interrupt.
143  */
144 void DMA_ReInitN775Rx(void);
145 
146 /**
147  * @brief Sends data over SPI with DMA.
148  */
150 
151 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
152 
153 #endif /* FOXBMS__DMA_H_ */
g_dmaCTRL dma_n775DmaControlPacketTx
void DMA_SetTxTransmitOngoingN775(void)
sets the SPI transmit status.
g_dmaCTRL dma_n775DmaControlPacketRx
bool DMA_IsTransmitOngoing(void)
gets the SPI transmit status.
g_dmaCTRL g_dmaCTRLPKT_TX
void DMA_Initialize(void)
Enables the DMA module.
Definition: dma.c:74
g_dmaCTRL g_dmaCTRLPKT_RX
void DMA_ReInitN775Rx(void)
Re-enables the DMA module. This function re-enables the DMA streams. Called in DMA complete interrupt...
void DMA_SetTransmitOngoing(void)
sets the SPI transmit status.
void DMA_InitN775(void)
enables the DMA module. This function enables the DMA streams.
STD_RETURN_TYPE_e DMA_TransmitReceive_SPIwithDMA(void)
Sends and receives data over SPI with DMA.
bool DMA_IsRxTransmitOngoingN775(void)
gets the SPI transmit status.
void DMA_ReInitN775Tx(void)
Re-enables the DMA module. This function re-enables the DMA streams. Called in DMA complete interrupt...
void DMA_SetRxTransmitOngoingN775(void)
sets the SPI transmit status.
STD_RETURN_TYPE_e DMA_TransmitSPiWithDmaN775(void)
Sends data over SPI with DMA.
bool DMA_IsTxTransmitOngoingN775(void)
gets the SPI transmit status.
void DMA_ReInit(void)
Re-enables the DMA module.
Headers for the configuration for the DMA module.
enum STD_RETURN_TYPE STD_RETURN_TYPE_e