foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
spi_cfg.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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 spi_cfg.h
44  * @author foxBMS Team
45  * @date 2020-03-05 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix SPI
50  *
51  * @brief Headers for the configuration for the SPI module
52  *
53  *
54  */
55 
56 #ifndef FOXBMS__SPI_CFG_H_
57 #define FOXBMS__SPI_CFG_H_
58 
59 /*========== Includes =======================================================*/
60 
61 #include "battery_system_cfg.h"
62 
63 #include "HL_het.h"
64 #include "HL_spi.h"
65 
66 #include <stdint.h>
67 
68 /*========== Macros and Definitions =========================================*/
69 
70 /** Index for the SPI nodes @{ */
71 #define SPI_SPI1_INDEX (0u)
72 #define SPI_SPI2_INDEX (1u)
73 #define SPI_SPI3_INDEX (2u)
74 #define SPI_SPI4_INDEX (3u)
75 #define SPI_SPI5_INDEX (4u)
76 /**@}*/
77 
78 /* Number of SPI interfaces */
79 #define SPI_NR_SPI_INTERFACES (5u)
80 
81 /** Bit in SPIDAT1 register that activates hardware Chip Select hold */
82 #define SPI_CSHOLD_BIT (0x10000000u)
83 
84 /** Bit in SPIDAT1 register that activates delay between words */
85 #define SPI_WDEL_BIT (0x04000000u)
86 
87 /** Position of CSNR field in SPIDAT1 register */
88 #define SPI_HARDWARE_CHIP_SELECT_FIELD_POSITION (16u)
89 
90 /** Position of DFSEL field in SPIDAT1 register */
91 #define SPI_DATA_FORMAT_FIELD_POSITION (24u)
92 
93 /** Position of TX buffer empty flag in SPIFLG register */
94 #define SPI_TX_BUFFER_EMPTY_FLAG_POSITION (9u)
95 
96 /** Mask used to clear all HW CS bits */
97 #define SPI_PC0_CLEAR_HW_CS_MASK (0xFFFFFF00u)
98 
99 /** Time to avoid infinite loop when waiting for Tx empty flag in a while loop */
100 #define SPI_TX_EMPTY_TIMEOUT_ITERATIONS (6000u)
101 
102 /** Max number of hardware chip select pins */
103 #define SPI_MAX_NUMBER_HW_CS (6u)
104 
105 /** SBC MCU chip select pin */
106 #define SPI_SBC_MCU_CHIP_SELECT_PIN (0u)
107 
108 /** enum for spi interface state */
109 typedef enum {
113 
114 /* INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE spi-documentation-cs-type-start-include */
115 /** type of chip select for spi */
116 typedef enum {
121 /* INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE spi-documentation-cs-type-stop-include */
122 
123 /* INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE spi-documentation-configuration-start-include */
124 /** configuration of the SPI interface */
125 typedef struct {
126  spiDAT1_t *pConfig;
127  spiBASE_t *pNode;
128  volatile uint32_t *pGioPort;
129  uint32_t csPin;
132 /* INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE spi-documentation-configuration-stop-include */
133 
134 /* -------------- SPI Configurations --------------------------------------- */
135 /** LTC chip select pin */
136 #define SPI_LTC_CHIP_SELECT_PIN (1u)
137 
138 /** Maxim chip select pin */
139 #define SPI_MAXIM_CHIP_SELECT_PIN (0u)
140 
141 /** NXP chip select pin @{ */
142 #define SPI_NXP_TX_CHIP_SELECT_PIN (1u)
143 #define SPI_NXP_RX_CHIP_SELECT_PIN (0u)
144 /**@}*/
145 
146 /** FRAM chip select pin */
147 #define SPI_FRAM_CHIP_SELECT_PIN (1u)
148 
149 /** GIO defines for SPI for Smart Power Switches @{ */
150 #define SPI_SPS_CS_GIOPORT (hetREG2->DOUT)
151 #define SPI_SPS_CS_GIOPORT_DIR (hetREG2->DIR)
152 #define SPI_SPS_CS_PIN (1u) /* Connected to pin 1 of HET register */
153 /**@}*/
154 
155 /*========== Extern Constant and Variable Declarations ======================*/
163 
165 
166 extern const uint8_t spi_nrBusyFlags;
167 
168 /*========== Extern Function Prototypes =====================================*/
169 /**
170  * @brief Switch the SPS spi handle to high speed
171  * @param[out] pSpiSpsInterface handle of the SPS spi config
172  */
173 extern void SPI_SpsInterfaceSwitchToHighSpeed(SPI_INTERFACE_CONFIG_s *pSpiSpsInterface);
174 
175 /**
176  * @brief Switch the SPS spi handle to low speed
177  * @param[out] pSpiSpsInterface handle of the SPS spi config
178  */
179 extern void SPI_SpsInterfaceSwitchToLowSpeed(SPI_INTERFACE_CONFIG_s *pSpiSpsInterface);
180 
181 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
182 #ifdef UNITY_UNIT_TEST
183 #endif
184 
185 #endif /* FOXBMS__SPI_CFG_H_ */
Configuration of the battery system (e.g., number of battery modules, battery cells,...
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
void SPI_SpsInterfaceSwitchToLowSpeed(SPI_INTERFACE_CONFIG_s *pSpiSpsInterface)
Switch the SPS spi handle to low speed.
Definition: spi_cfg.c:261
SPI_BUSY_STATE_e
Definition: spi_cfg.h:109
@ SPI_IDLE
Definition: spi_cfg.h:110
@ SPI_BUSY
Definition: spi_cfg.h:111
SPI_INTERFACE_CONFIG_s spi_mxmInterface
Definition: spi_cfg.c:182
SPI_INTERFACE_CONFIG_s spi_sbcMcuInterface
Definition: spi_cfg.c:231
SPI_INTERFACE_CONFIG_s spi_nxp775InterfaceTx[BS_NR_OF_STRINGS]
Definition: spi_cfg.c:191
SPI_BUSY_STATE_e spi_busyFlags[]
Definition: spi_cfg.c:240
SPI_INTERFACE_CONFIG_s spi_framInterface
Definition: spi_cfg.c:213
void SPI_SpsInterfaceSwitchToHighSpeed(SPI_INTERFACE_CONFIG_s *pSpiSpsInterface)
Switch the SPS spi handle to high speed.
Definition: spi_cfg.c:256
SPI_INTERFACE_CONFIG_s spi_nxp775InterfaceRx[BS_NR_OF_STRINGS]
Definition: spi_cfg.c:202
SPI_INTERFACE_CONFIG_s spi_ltcInterface[BS_NR_OF_STRINGS]
Definition: spi_cfg.c:171
const uint8_t spi_nrBusyFlags
Definition: spi_cfg.c:249
SPI_CHIP_SELECT_TYPE_e
Definition: spi_cfg.h:116
@ SPI_CHIP_SELECT_SOFTWARE
Definition: spi_cfg.h:118
@ SPI_CHIP_SELECT_MAX
Definition: spi_cfg.h:119
@ SPI_CHIP_SELECT_HARDWARE
Definition: spi_cfg.h:117
SPI_INTERFACE_CONFIG_s spi_spsInterface
Definition: spi_cfg.c:222
SPI_CHIP_SELECT_TYPE_e csType
Definition: spi_cfg.h:130
volatile uint32_t * pGioPort
Definition: spi_cfg.h:128
spiDAT1_t * pConfig
Definition: spi_cfg.h:126
spiBASE_t * pNode
Definition: spi_cfg.h:127