foxBMS
1.1.1
The foxBMS Battery Management System API Documentation
|
Headers for the driver for the MCU module. More...
#include "general.h"
Go to the source code of this file.
Macros | |
#define | MCU_RTI_CNT0_FRC0_REG (*((volatile uint32_t *)0xFFFFFC10)) |
Functions | |
void | MCU_delay_us (uint32_t delay_us) |
Wait blocking a certain time in microseconds. More... | |
Headers for the driver for the MCU 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:
Definition in file mcu.h.
#define MCU_RTI_CNT0_FRC0_REG (*((volatile uint32_t *)0xFFFFFC10)) |
void MCU_delay_us | ( | uint32_t | delay_us | ) |
Wait blocking a certain time in microseconds.
This function uses the Free Running Counter 0 (FRC0) to generate a delay in microseconds. It does not modify anything related to the counter. This counter is already used by FreeRTOS.
delay_us | time in microseconds to wait |
This is the frequency of the FRC0 counter Datasheet SPNU563A-March 2018 p. 585 formula 23
First the time of one FRC0 increment in microseconds is computed with increment_time = (1/rti_clock)*1e6 The 1e6 factor is to get the period in microseconds.
The number of increments needed to reach 1 microsecond is then computed with nr_increments_for_1us = (1us/increment_time)
To avoid floating point computation problems, the number of increments needed to reach 1 microsecond is computed at once with:
Poll FRC0 value until the value corresponding to the desired waiting timing has been reached. The timeout is to ensure the code does not get trapped here.