foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
dma_cfg.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_cfg.h
44  * @author foxBMS Team
45  * @date 2020-03-05 (date of creation)
46  * @updated 2021-09-28 (date of last update)
47  * @ingroup DRIVERS_CONFIGURATION
48  * @prefix DMA
49  *
50  * @brief Headers for the configuration for the DMA module
51  *
52  *
53  */
54 
55 #ifndef FOXBMS__DMA_CFG_H_
56 #define FOXBMS__DMA_CFG_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 #include "battery_system_cfg.h"
62 
63 #include "HL_spi.h"
64 #include "HL_sys_dma.h"
65 
66 /*========== Macros and Definitions =========================================*/
67 
68 /** defines for the DMA channels */
69 /**@{*/
70 #define DMA_CHANNEL_SPI1_TX (DMA_CH0)
71 #define DMA_CHANNEL_SPI1_RX (DMA_CH1)
72 #define DMA_CHANNEL_SPI2_TX (DMA_CH2)
73 #define DMA_CHANNEL_SPI2_RX (DMA_CH3)
74 #define DMA_CHANNEL_SPI3_TX (DMA_CH4)
75 #define DMA_CHANNEL_SPI3_RX (DMA_CH5)
76 #define DMA_CHANNEL_SPI4_TX (DMA_CH6)
77 #define DMA_CHANNEL_SPI4_RX (DMA_CH7)
78 #define DMA_CHANNEL_SPI5_TX (DMA_CH8)
79 #define DMA_CHANNEL_SPI5_RX (DMA_CH9)
80 #define DMA_CHANNEL_I2C_TX (DMA_CH10)
81 #define DMA_CHANNEL_I2C_RX (DMA_CH11)
82 /**@}*/
83 
84 /** defines for the DMA request lines */
85 /**@{*/
86 #define DMA_REQ_LINE_SPI1_TX (DMA_REQ1)
87 #define DMA_REQ_LINE_SPI1_RX (DMA_REQ0)
88 #define DMA_REQ_LINE_SPI2_TX (DMA_REQ3)
89 #define DMA_REQ_LINE_SPI2_RX (DMA_REQ2)
90 #define DMA_REQ_LINE_SPI3_TX (DMA_REQ15)
91 #define DMA_REQ_LINE_SPI3_RX (DMA_REQ14)
92 #define DMA_REQ_LINE_SPI4_TX (DMA_REQ25)
93 #define DMA_REQ_LINE_SPI4_RX (DMA_REQ24)
94 #define DMA_REQ_LINE_SPI5_TX (DMA_REQ31)
95 #define DMA_REQ_LINE_SPI5_RX (DMA_REQ30)
96 #define DMA_REQ_LINE_I2C_TX (DMA_REQ11)
97 #define DMA_REQ_LINE_I2C_RX (DMA_REQ10)
98 /**@}*/
99 
100 /** define for the shift of an address for big endian 8bit */
101 #define DMA_BIG_ENDIAN_ADDRESS_8BIT (3U)
102 /** define for the shift of an address for big endian 16bit */
103 #define DMA_BIG_ENDIAN_ADDRESS_16BIT (2U)
104 
105 /** number of spi interfaces for DMA */
106 #define DMA_NUMBER_SPI_INTERFACES 5U
107 /** DMA Request enable bit */
108 #define DMAREQEN_BIT (0x10000U)
109 /** SPI enable bit */
110 #define SPIEN_BIT (0x1000000U)
111 
112 /** DMA request line for LTC */
113 /**@{*/
114 #define DMA_REQ_LINE_LTC_TX (DMA_REQ_LINE_SPI1_TX)
115 #define DMA_REQ_LINE_LTC_RX (DMA_REQ_LINE_SPI1_RX)
116 /**@}*/
117 
118 /** DMA request line for N775 */
119 /**@{**/
120 #define DMA_REQ_LINE_N775_TX (DMA_REQ_LINE_SPI1_TX)
121 #define DMA_REQ_LINE_N775_RX (DMA_REQ_LINE_SPI5_RX)
122 /**@}*/
123 
124 /** describes the RX and TX DMA channels used for an SPI interface */
125 typedef struct DMA_CHANNEL_CONFIG {
126  dmaChannel_t txChannel;
127  dmaChannel_t rxChannel;
129 
130 /** describes the DMA requests corresponding to the DMA channel used for an SPI interface */
131 typedef struct DMA_REQUEST_CONFIG {
132  dmaRequest_t txRequest;
133  dmaRequest_t rxRequest;
135 
136 /*========== Extern Constant and Variable Declarations ======================*/
137 
141 
142 /*========== Extern Function Prototypes =====================================*/
143 
144 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
145 
146 #endif /* FOXBMS__DMA_CFG_H_ */
Configuration of the battery system (e.g., number of battery modules, battery cells,...
struct DMA_REQUEST_CONFIG DMA_REQUEST_CONFIG_s
#define DMA_NUMBER_SPI_INTERFACES
Definition: dma_cfg.h:106
DMA_REQUEST_CONFIG_s dma_spiDmaRequests[DMA_NUMBER_SPI_INTERFACES]
Definition: dma_cfg.c:77
spiBASE_t * dma_spiInterfaces[DMA_NUMBER_SPI_INTERFACES]
Definition: dma_cfg.c:86
struct DMA_CHANNEL_CONFIG DMA_CHANNEL_CONFIG_s
DMA_CHANNEL_CONFIG_s dma_spiDmaChannels[DMA_NUMBER_SPI_INTERFACES]
Definition: dma_cfg.c:68
General macros and definitions for the whole platform.
dmaChannel_t rxChannel
Definition: dma_cfg.h:127
dmaChannel_t txChannel
Definition: dma_cfg.h:126
dmaRequest_t txRequest
Definition: dma_cfg.h:132
dmaRequest_t rxRequest
Definition: dma_cfg.h:133