foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
fram.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 fram.h
44  * @author foxBMS Team
45  * @date 2020-03-05 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS
49  * @prefix FRAM
50  *
51  * @brief Header for the driver for the FRAM module
52  *
53  * @details TODO
54  */
55 
56 #ifndef FOXBMS__FRAM_H_
57 #define FOXBMS__FRAM_H_
58 
59 /*========== Includes =======================================================*/
60 #include "fram_cfg.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /*========== Extern Constant and Variable Declarations ======================*/
65 
66 /*========== Extern Function Prototypes =====================================*/
67 
68 /**
69  * @brief Initializes the addresses to be written in the FRAM.
70  * @details This function must be called before any use of the FRAM.
71  */
72 extern void FRAM_Initialize(void);
73 
74 /**
75  * @brief Reinitialize all entries in the FRAM.
76  * @details This function must be called if the alignment in the FRAM is
77  * wrong due to a change in the FRAM data structue.
78  * @return #STD_OK if all writes successfull, otherwise #STD_NOT_OK
79  */
81 
82 /* The variable corrresponding to the block_ID is written */
83 /**
84  * @brief Writes a variable to the FRAM.
85  * @details This function stores the variable corresponding to the ID passed as
86  * parameter. Write can fail if SPI interface was locked.
87  * @param blockId ID of variable to write to FRAM
88  * @return one of the values of the FRAM_RETURN_TYPE_e enum
89  */
91 
92 /* The variable corrresponding to the block_ID is written */
93 /**
94  * @brief Reads a variable from the FRAM.
95  * @details This function reads the variable corresponding to the ID passed as
96  * parameter. Read can fail if SPI interface was locked.
97  * @param blockId ID of variable to read from FRAM
98  * @return one of the values of the FRAM_RETURN_TYPE_e enum
99  */
101 
102 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
103 
104 #endif /* FOXBMS__FRAM_H_ */
void FRAM_Initialize(void)
Initializes the addresses to be written in the FRAM.
Definition: fram.c:90
STD_RETURN_TYPE_e FRAM_ReinitializeAllEntries(void)
Reinitialize all entries in the FRAM.
Definition: fram.c:105
FRAM_RETURN_TYPE_e FRAM_ReadData(FRAM_BLOCK_ID_e blockId)
Reads a variable from the FRAM.
Definition: fram.c:193
FRAM_RETURN_TYPE_e FRAM_WriteData(FRAM_BLOCK_ID_e blockId)
Writes a variable to the FRAM.
Definition: fram.c:115
Headers for the configuration for the FRAM module.
FRAM_RETURN_TYPE_e
Definition: fram_cfg.h:85
FRAM_BLOCK_ID_e
Definition: fram_cfg.h:100
STD_RETURN_TYPE_e
Definition: fstd_types.h:81