The foxBMS secondary mcu API documentation
mcu.c File Reference

Functions for the MCU to manage time and interrupts. More...

#include "mcu.h"
#include "cpu_cfg.h"
Include dependency graph for mcu.c:

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_GetTimeBase (void)
 gets systick value which is a 24-bit downcounter, auto refreshed with 71999 More...
 
uint32_t MCU_SystemResetStatus (uint32_t *regValue)
 Gets system reset status. More...
 
void MCU_GetDeviceID (MCU_DeviceID_s *deviceID)
 Get unique device ID. More...
 
STD_RETURN_TYPE_e MCU_ChecCRCkUniqueDeviceID (uint8_t *dataptr)
 

Variables

MCU_DeviceID_s mcu_unique_deviceID
 

Detailed Description

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:

  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
22.11.2015 (date of creation)
Module-prefix MCU

Source file implements the 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.

Function Documentation

◆ MCU_ChecCRCkUniqueDeviceID()

STD_RETURN_TYPE_e MCU_ChecCRCkUniqueDeviceID ( uint8_t *  dataptr)

◆ MCU_DisableINT()

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

Returns
current priority mask register, store this value and use it to enable interrupts again with CPU_RestoreINT()

◆ MCU_GetDeviceID()

void MCU_GetDeviceID ( MCU_DeviceID_s deviceID)

Get unique device ID.

◆ MCU_GetTimeBase()

uint32_t MCU_GetTimeBase ( void  )

gets systick value which is a 24-bit downcounter, auto refreshed with 71999

Returns
time current systick value

◆ MCU_RestoreINT()

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

Parameters
primask_regvalue for priority mask register, for use in case of nesting calling

◆ MCU_SystemResetStatus()

uint32_t MCU_SystemResetStatus ( uint32_t *  regValue)

Gets system reset status.

Returns
0: no unexpected reset detected, otherwise unexpected reset detected

◆ MCU_Wait_us()

void MCU_Wait_us ( uint32_t  time)

simple wait-loop to wait short periods of time

Parameters
timenumber of microseconds to wait, max. 1000us

Variable Documentation

◆ mcu_unique_deviceID

MCU_DeviceID_s mcu_unique_deviceID