![]() |
The foxBMS secondary mcu API documentation
|
Headers for the functions for the MCU to manage time and interrupts. More...
#include "general.h"
Go to the source code of this file.
Data Structures | |
struct | MCU_DeviceID_s |
Functions | |
void | MCU_Wait_us (uint32_t time) |
simple wait-loop to wait short periods of time More... | |
unsigned int | MCU_DisableINT (void) |
disables interrupts and returns prior state (enabled or disabled) More... | |
void | MCU_RestoreINT (unsigned int primask_reg) |
restores interrupts to given state (enable or disable) More... | |
uint32_t | MCU_SystemResetStatus (uint32_t *regValue) |
Gets system reset status. More... | |
uint32_t | MCU_GetTimeBase (void) |
gets systick value which is a 24-bit downcounter, auto refreshed with 71999 More... | |
void | MCU_GetDeviceID (MCU_DeviceID_s *deviceID) |
Get unique device ID. More... | |
STD_RETURN_TYPE_e | MCU_CheckCRCUniqueDeviceID (uint8_t *dataptr) |
Check if passed crc == unique device ID crc. More... | |
Variables | |
MCU_DeviceID_s | mcu_unique_deviceID |
Headers for the functions for the MCU to manage time and interrupts.
BSD 3-Clause License 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:
″This product uses parts of foxBMS®″
″This product includes parts of foxBMS®″
″This product is derived from foxBMS®″
Header file provides interfaces to set boot information, to disable/enable all interrupts, to wait a designated time and and to get the a timestamp based on the os systick.
STD_RETURN_TYPE_e MCU_CheckCRCUniqueDeviceID | ( | uint8_t * | dataptr | ) |
Check if passed crc == unique device ID crc.
unsigned int MCU_DisableINT | ( | void | ) |
disables interrupts and returns prior state (enabled or disabled)
this function is used for synchronization of real-time interrupts when bypassing FreeRTOS context and could be used (called) from 'interrupt blocked' or 'interrupt unblocked' context
void MCU_GetDeviceID | ( | MCU_DeviceID_s * | deviceID | ) |
Get unique device ID.
uint32_t MCU_GetTimeBase | ( | void | ) |
gets systick value which is a 24-bit downcounter, auto refreshed with 71999
void MCU_RestoreINT | ( | unsigned int | primask_reg | ) |
restores interrupts to given state (enable or disable)
this function is used for synchronization of real-time interrupts when bypassing FreeRTOS context
primask_reg | value for priority mask register, for use in case of nesting calling |
uint32_t MCU_SystemResetStatus | ( | uint32_t * | regValue | ) |
Gets system reset status.
void MCU_Wait_us | ( | uint32_t | time | ) |
simple wait-loop to wait short periods of time
time | number of microseconds to wait, max. 1000us |
MCU_DeviceID_s mcu_unique_deviceID |