foxBMS - Unit Tests
1.4.1
The foxBMS Unit Tests API Documentation
|
Header for the driver for the FRAM module. More...
#include "fram_cfg.h"
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... | |
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:
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:
TODO
Definition in file fram.h.
void FRAM_Initialize | ( | void | ) |
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.
blockId | ID of variable to read from FRAM |
Definition at line 193 of file fram.c.
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.
Definition at line 105 of file fram.c.
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.
blockId | ID of variable to write to FRAM |
Definition at line 115 of file fram.c.