foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
pex_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 pex_cfg.h
44  * @author foxBMS Team
45  * @date 2021-08-02 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix PEX
50  *
51  * @brief Headers for the configuration for the NXP PCA9539 port expander module
52  *
53  *
54  */
55 
56 #ifndef FOXBMS__PEX_CFG_H_
57 #define FOXBMS__PEX_CFG_H_
58 
59 /*========== Includes =======================================================*/
60 #include "general.h"
61 
62 #include "battery_system_cfg.h"
63 
64 #include "database.h"
65 
66 /*========== Macros and Definitions =========================================*/
67 
68 /** Number of port expanders */
69 #define PEX_NR_OF_PORT_EXPANDERS (3u)
70 
71 /** Defines to match expander numbering from hardware description */
72 /**@{*/
73 /* AXIVION Disable Style MisraC2012-2.5: Values are defined even if unused for driver usage. */
74 #define PEX_PORT_EXPANDER1 (0u)
75 #define PEX_PORT_EXPANDER2 (1u)
76 #define PEX_PORT_EXPANDER3 (2u)
77 /**@}*/
78 
79 /** Port expander pin positions in registers */
80 /**@{*/
81 #define PEX_PIN00 (0u)
82 #define PEX_PIN01 (1u)
83 #define PEX_PIN02 (2u)
84 #define PEX_PIN03 (3u)
85 #define PEX_PIN04 (4u)
86 #define PEX_PIN05 (5u)
87 #define PEX_PIN06 (6u)
88 #define PEX_PIN07 (7u)
89 #define PEX_PIN10 (8u)
90 #define PEX_PIN11 (9u)
91 #define PEX_PIN12 (10u)
92 #define PEX_PIN13 (11u)
93 #define PEX_PIN14 (12u)
94 #define PEX_PIN15 (13u)
95 #define PEX_PIN16 (14u)
96 #define PEX_PIN17 (15u)
97 /* AXIVION Enable Style MisraC2012-2.5: */
98 /**@}*/
99 
100 /*========== Extern Constant and Variable Declarations ======================*/
101 
102 extern const uint8_t pex_addressList[PEX_NR_OF_PORT_EXPANDERS];
103 
104 /*========== Extern Function Prototypes =====================================*/
105 
106 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
107 
108 #endif /* FOXBMS__PEX_CFG_H_ */
Configuration of the battery system (e.g., number of battery modules, battery cells,...
Database module header.
General macros and definitions for the whole platform.
#define PEX_NR_OF_PORT_EXPANDERS
Definition: pex_cfg.h:69
const uint8_t pex_addressList[PEX_NR_OF_PORT_EXPANDERS]
Definition: pex_cfg.c:71