foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
fram.h
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.h
44  * @author foxBMS Team
45  * @date 2020-03-05 (date of creation)
46  * @updated 2024-03-24 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix FRAM
49  *
50  * @brief Header for the driver for the FRAM module
51  *
52  * @details TODO
53  */
54 
55 #ifndef FOXBMS__FRAM_H_
56 #define FOXBMS__FRAM_H_
57 
58 /*========== Includes =======================================================*/
59 #include "fram_cfg.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Extern Constant and Variable Declarations ======================*/
64 
65 /*========== Extern Function Prototypes =====================================*/
66 
67 /**
68  * @brief Initializes the addresses to be written in the FRAM.
69  * @details This function must be called before any use of the FRAM.
70  */
71 extern void FRAM_Initialize(void);
72 
73 /* The variable corrresponding to the block_ID is written */
74 /**
75  * @brief Writes a variable to the FRAM.
76  * @details This function stores the variable corresponding to the ID passed as
77  * parameter. Write can fail if SPI interface was locked.
78  * @param blockId ID of variable to write to FRAM
79  * @return #STD_OK if write was successful, #STD_NOT_OK otherwise
80  */
82 
83 /* The variable corrresponding to the block_ID is written */
84 /**
85  * @brief Reads a variable from the FRAM.
86  * @details This function reads the variable corresponding to the ID passed as
87  * parameter. Read can fail if SPI interface was locked.
88  * @param blockId ID of variable to read from FRAM
89  * @return #STD_OK if read was successful, #STD_NOT_OK otherwise
90  */
92 
93 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
94 
95 #endif /* FOXBMS__FRAM_H_ */
void FRAM_Initialize(void)
Initializes the addresses to be written in the FRAM.
Definition: fram.c:88
STD_RETURN_TYPE_e FRAM_Read(FRAM_BLOCK_ID_e blockId)
Reads a variable from the FRAM.
Definition: fram.c:160
STD_RETURN_TYPE_e FRAM_Write(FRAM_BLOCK_ID_e blockId)
Writes a variable to the FRAM.
Definition: fram.c:101
Headers for the configuration for the FRAM module.
enum FRAM_BLOCK_ID FRAM_BLOCK_ID_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e