foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
nxp_afe_dma.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, 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 nxp_afe_dma.h
44  * @author foxBMS Team
45  * @date 2020-05-27 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS
49  * @prefix AFE
50  *
51  * @brief Headers for the driver for the DMA module.
52  *
53  */
54 
55 #ifndef FOXBMS__NXP_AFE_DMA_H_
56 #define FOXBMS__NXP_AFE_DMA_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 /* clang-format off */
61 #include "afe_dma.h"
62 /* clang-format on */
63 #include "HL_sys_dma.h"
64 
65 /*========== Macros and Definitions =========================================*/
66 
67 /*========== Extern Constant and Variable Declarations ======================*/
68 extern g_dmaCTRL afe_n775DmaControlPacketTx;
69 extern g_dmaCTRL afe_n775DmaControlPacketRx;
70 
71 /*========== Extern Function Prototypes =====================================*/
72 
73 /**
74  * @brief gets the SPI transmit status.
75  *
76  * @return retval true if transmission still ongoing, false otherwise
77  *
78  */
79 extern bool AFE_IsTxTransmitOngoing(void);
80 
81 /**
82  * @brief gets the SPI transmit status.
83  *
84  * @return retval true if transmission still ongoing, false otherwise
85  *
86  */
87 extern bool AFE_IsRxTransmitOngoing(void);
88 
89 /**
90  * @brief sets the SPI transmit status.
91  *
92  */
93 extern void AFE_SetTxTransmitOngoing(void);
94 
95 /**
96  * @brief sets the SPI transmit status.
97  *
98  */
99 extern void AFE_SetRxTransmitOngoing(void);
100 
101 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
102 
103 #endif /* FOXBMS__NXP_AFE_DMA_H_ */
Headers for the driver for the general DMA module of monitoring ICs.
General macros and definitions for the whole platform.
void AFE_SetRxTransmitOngoing(void)
sets the SPI transmit status.
g_dmaCTRL afe_n775DmaControlPacketRx
void AFE_SetTxTransmitOngoing(void)
sets the SPI transmit status.
g_dmaCTRL afe_n775DmaControlPacketTx
bool AFE_IsTxTransmitOngoing(void)
gets the SPI transmit status.
bool AFE_IsRxTransmitOngoing(void)
gets the SPI transmit status.