foxBMS  1.0.0
The foxBMS Battery Management System API Documentation
ltc_mic_dma.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
38  * ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file ltc_mic_dma.c
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 MIC
49  *
50  * @brief Driver for the DMA module for the LTC.
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "ltc_mic_dma.h"
56 
57 #include "io.h"
58 #include "ltc.h"
59 #include "spi.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Static Constant and Variable Definitions =======================*/
64 
65 /*========== Extern Constant and Variable Definitions =======================*/
66 
67 /*========== Static Function Prototypes =====================================*/
68 
69 /*========== Static Function Implementations ================================*/
70 
71 /*========== Extern Function Implementations ================================*/
72 
73 extern bool MIC_IsTransmitOngoing(LTC_STATE_s *pLtcState) {
74  return pLtcState->transmit_ongoing;
75 }
76 
77 extern void MIC_SetTransmitOngoing(LTC_STATE_s *pLtcState) {
78  pLtcState->transmit_ongoing = true;
79 }
80 
81 /* Function called on DMA complete interrupts (TX and RX). */
82 void MIC_DmaCallback(dmaInterrupt_t inttype, uint32 channel) {
83  if (((dmaChannel_t)channel == DMA_CH0) || ((dmaChannel_t)channel == DMA_CH1)) {
85  } else {
87  }
88 }
89 
90 /*========== Externalized Static Function Implementations (Unit Test) =======*/
MIC_DmaCallback
void MIC_DmaCallback(dmaInterrupt_t inttype, uint32 channel)
Function called by DMA block transfer callback.
Definition: ltc_mic_dma.c:82
spi.h
Headers for the driver for the SPI module.
LTC_STATE_s::transmit_ongoing
bool transmit_ongoing
Definition: ltc_defs.h:565
LTC_STATE_s
Definition: ltc_defs.h:518
MIC_SetTransmitOngoing
void MIC_SetTransmitOngoing(LTC_STATE_s *pLtcState)
sets the SPI transmit status.
Definition: ltc_mic_dma.c:77
FAS_ASSERT
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:237
ltc_mic_dma.h
Headers for the driver for the DMA module for the LTC.
ltc.h
Headers for the driver for the LTC monitoring chip.
io.h
Header for the driver for the IO module.
FAS_TRAP
#define FAS_TRAP
Define that evaluates to essential boolean false thus tripping an assert.
Definition: fassert.h:108
MIC_IsTransmitOngoing
bool MIC_IsTransmitOngoing(LTC_STATE_s *pLtcState)
gets the SPI transmit status.
Definition: ltc_mic_dma.c:73
ltc_stateBase
LTC_STATE_s ltc_stateBase
Definition: ltc_6806.c:147