mcu.h File Reference

Headers for the driver for the MCU module. More...

#include <stdbool.h>
#include <stdint.h>

Include dependency graph for mcu.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MCU_LARGEST_PIN_NUMBER   (31u)
	largest pin number that exists in TMS570LC4357 More...
#define	MCU_ADC1_MAX_NR_CHANNELS   (32u)
	maximum number of channels measured by the ADC1 More...
#define	MCU_RTI_CNT0_FRC0_REG   (*((volatile uint32_t *)0xFFFFFC10u))

Functions
void	MCU_Delay_us (uint32_t delay_us)
	Wait blocking a certain time in microseconds. More...
uint32_t	MCU_GetFreeRunningCount (void)
	Get the current value of the Free Running Counter 0 (FRC0) More...
uint32_t	MCU_ConvertFrcDifferenceToTimespan_us (uint32_t count)
	Convert the counter value FRC0 to a time in microseconds. More...
bool	MCU_IsTimeElapsed (uint32_t startCounter, uint32_t timeout_us)
	Checks if a timeout in microseconds has elapsed. More...

Detailed Description

Headers for the driver for the MCU module.

Copyright

© 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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

2019-02-19 (date of creation)

Updated

2023-10-12 (date of last update)

Version

v1.6.0

Prefix

MCU

Definition in file mcu.h.

Macro Definition Documentation

MCU_ADC1_MAX_NR_CHANNELS

#define MCU_ADC1_MAX_NR_CHANNELS   (32u)

maximum number of channels measured by the ADC1

Checked in the data sheet spnu563a: ADC1 supports 32 channels

Definition at line 75 of file mcu.h.

MCU_LARGEST_PIN_NUMBER

#define MCU_LARGEST_PIN_NUMBER   (31u)

largest pin number that exists in TMS570LC4357

Checked in the data sheet spnu563a: The largest pin number that is used is 31.

Definition at line 69 of file mcu.h.

MCU_RTI_CNT0_FRC0_REG

#define MCU_RTI_CNT0_FRC0_REG   (*((volatile uint32_t *)0xFFFFFC10u))

Address of Free Running Counter 0 (FRC0)

Definition at line 79 of file mcu.h.

Function Documentation

MCU_ConvertFrcDifferenceToTimespan_us()

uint32_t MCU_ConvertFrcDifferenceToTimespan_us

(

uint32_t

count

)

Convert the counter value FRC0 to a time in microseconds.

This function applies a scaling factor to the FRC0 counter value, which can be retrieved with MCU_GetFreeRunningCount() so that this value represents microseconds. Typically this used with counter differences in order to get timing estimates on microsecond-level.

Parameters

[in]

count

counter value of the FRC0

Returns

equivalent time in microseconds

Definition at line 127 of file mcu.c.

MCU_Delay_us()

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.

Parameters

delay_us

time in microseconds to wait

First the time of one FRC0 increment in microseconds is computed with increment_time = (1/mcu_frcClock_Hz)*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.

Definition at line 89 of file mcu.c.

MCU_GetFreeRunningCount()

uint32_t MCU_GetFreeRunningCount

(

void

)

Get the current value of the Free Running Counter 0 (FRC0)

This function returns the current value of the Free Running Counter 0 (FRC0). This counter is already used by FreeRTOS and this function does nothing more than accessing this value.

Returns

the current counter value of FRC0

Definition at line 123 of file mcu.c.

MCU_IsTimeElapsed()

bool MCU_IsTimeElapsed	(	uint32_t	startCounter,
		uint32_t	timeout_us
	)

Checks if a timeout in microseconds has elapsed.

First the function MCU_GetFreeRunningCount() must be called to retrieve the current value of the free running counter. This function checks if the time given as parameter has elapsed since the counter was retrieved.

Parameters

[in]	startCounter	counter value of the FRC0, used as starting point
[in]	timeout_us	time in microseconds to check against

Returns

true if timeout has elapsed, false otherwise

Definition at line 133 of file mcu.c.

Here is the call graph for this function: