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