foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
fram.h File Reference

Header for the driver for the FRAM module. More...

#include "fram_cfg.h"
Include dependency graph for fram.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void FRAM_Initialize (void)
 Initializes the addresses to be written in the FRAM. More...
 
STD_RETURN_TYPE_e FRAM_ReinitializeAllEntries (void)
 Reinitialize all entries in the FRAM. More...
 
FRAM_RETURN_TYPE_e FRAM_WriteData (FRAM_BLOCK_ID_e blockId)
 Writes a variable to the FRAM. More...
 
FRAM_RETURN_TYPE_e FRAM_ReadData (FRAM_BLOCK_ID_e blockId)
 Reads a variable from the FRAM. More...
 

Detailed Description

Header for the driver for the FRAM module.

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2020-03-05 (date of creation)
Updated
2022-07-28 (date of last update)
Version
v1.4.0
Prefix
FRAM

TODO

Definition in file fram.h.

Function Documentation

◆ FRAM_Initialize()

void FRAM_Initialize ( void  )

Initializes the addresses to be written in the FRAM.

This function must be called before any use of the FRAM.

Definition at line 90 of file fram.c.

Here is the call graph for this function:

◆ FRAM_ReadData()

FRAM_RETURN_TYPE_e FRAM_ReadData ( FRAM_BLOCK_ID_e  blockId)

Reads a variable from the FRAM.

This function reads the variable corresponding to the ID passed as parameter. Read can fail if SPI interface was locked.

Parameters
blockIdID of variable to read from FRAM
Returns
one of the values of the FRAM_RETURN_TYPE_e enum

Definition at line 193 of file fram.c.

Here is the call graph for this function:

◆ FRAM_ReinitializeAllEntries()

STD_RETURN_TYPE_e FRAM_ReinitializeAllEntries ( void  )

Reinitialize all entries in the FRAM.

This function must be called if the alignment in the FRAM is wrong due to a change in the FRAM data structue.

Returns
STD_OK if all writes successfull, otherwise STD_NOT_OK

Definition at line 105 of file fram.c.

Here is the call graph for this function:

◆ FRAM_WriteData()

FRAM_RETURN_TYPE_e FRAM_WriteData ( FRAM_BLOCK_ID_e  blockId)

Writes a variable to the FRAM.

This function stores the variable corresponding to the ID passed as parameter. Write can fail if SPI interface was locked.

Parameters
blockIdID of variable to write to FRAM
Returns
one of the values of the FRAM_RETURN_TYPE_e enum

Definition at line 115 of file fram.c.

Here is the call graph for this function: