foxBMS  1.3.0
The foxBMS Battery Management System API Documentation
ltc_cfg.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 ltc_cfg.h
44  * @author foxBMS Team
45  * @date 2015-02-18 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix LTC
50  *
51  * @brief Headers for the configuration for the LTC monitoring chip.
52  *
53  */
54 
55 #ifndef FOXBMS__LTC_CFG_H_
56 #define FOXBMS__LTC_CFG_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /**
64  * Number of used LTC-ICs
65  */
66 
67 #define LTC_N_LTC (BS_NR_OF_MODULES_PER_STRING)
68 
69 /**
70  * Number of Bytes to be transmitted in daisy-chain
71  * For first 4 Bytes:
72  * - 2 Bytes: command
73  * - 2 Bytes: CRC
74  * Following Bytes: Data
75  * - 6 Bytes data per LTC
76  * - 2 Bytes CRC per LTC
77  */
78 #define LTC_N_BYTES_FOR_DATA_TRANSMISSION (4 + (8 * LTC_N_LTC))
79 
80 /**
81  * Number of Bytes to be transmitted in daisy-chain
82  * Data
83  * - 6 Bytes data per LTC
84  */
85 #define LTC_N_BYTES_FOR_DATA_TRANSMISSION_DATA_ONLY (0 + (6 * LTC_N_LTC))
86 
87 /*========== Extern Constant and Variable Declarations ======================*/
88 
89 /*========== Extern Function Prototypes =====================================*/
90 
91 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
92 
93 #endif /* FOXBMS__LTC_CFG_H_ */
general.h
General macros and definitions for the whole platform.