foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
fram_cfg.c
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 fram_cfg.c
44  * @author foxBMS Team
45  * @date 2020-03-05 (date of creation)
46  * @updated 2020-03-05 (date of last update)
47  * @ingroup DRIVERS_CONFIGURATION
48  * @prefix FRAM
49  *
50  * @brief Configuration for the FRAM module
51  *
52  *
53  *
54  */
55 
56 /*========== Includes =======================================================*/
57 #include "fram_cfg.h"
58 
59 /*========== Macros and Definitions =========================================*/
60 
61 /*========== Static Constant and Variable Definitions =======================*/
62 
63 /*========== Extern Constant and Variable Definitions =======================*/
64 /**
65  * Variables to be stored in FRAM
66  * Must also be declared as external variables in fram_cfg.h
67  */
68 /**@{*/
73  .phase = 0u,
74  .finState = STD_NOT_OK,
75 };
77 /**@}*/
78 
79 /**
80  * The zeros are the uninitialized addresses of the variables
81  * in the FRAM. They are initialized by the call of FRAM_Initialize()
82  */
84  {(void *)(&fram_version), sizeof(fram_version), 0},
85  {(void *)(&fram_soc), sizeof(fram_soc), 0},
86  {(void *)(&fram_sbcInit), sizeof(fram_sbcInit), 0},
87  {(void *)(&fram_deepDischargeFlags), sizeof(fram_deepDischargeFlags), 0},
88  {(void *)(&fram_soe), sizeof(fram_soe), 0},
89 };
90 
91 /*========== Static Function Prototypes =====================================*/
92 
93 /*========== Static Function Implementations ================================*/
94 
95 /*========== Extern Function Implementations ================================*/
96 
97 /*========== Externalized Static Function Implementations (Unit Test) =======*/
FRAM_SOC_s fram_soc
Definition: fram_cfg.c:70
FRAM_BASE_HEADER_s fram_base_header[]
Definition: fram_cfg.c:83
FRAM_SOE_s fram_soe
Definition: fram_cfg.c:71
FRAM_DEEP_DISCHARGE_FLAG_s fram_deepDischargeFlags
Definition: fram_cfg.c:76
FRAM_SBC_INIT_s fram_sbcInit
Definition: fram_cfg.c:72
FRAM_VERSION_s fram_version
Definition: fram_cfg.c:69
Headers for the configuration for the FRAM module.
#define FRAM_PROJECT_ID_FOXBMS_BASELINE
Definition: fram_cfg.h:77
@ STD_NOT_OK
Definition: fstd_types.h:73
uint8_t phase
Definition: fram_cfg.h:110
Stores the version of the memory layout of the FRAM.
Definition: fram_cfg.h:102
FRAM_PROJECT_ID project
Definition: fram_cfg.h:103