foxBMS  1.3.0
The foxBMS Battery Management System API Documentation
mcu.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file mcu.h
44  * @author foxBMS Team
45  * @date 2019-02-19 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup DRIVERS
49  * @prefix MCU
50  *
51  * @brief Headers for the driver for the MCU module.
52  *
53  */
54 
55 #ifndef FOXBMS__MCU_H_
56 #define FOXBMS__MCU_H_
57 
58 /*========== Includes =======================================================*/
59 #include "HL_sys_common.h"
60 
61 #include <stdint.h> /* include stdint.h instead of general.h to avoid cyclic include */
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /**
66  * @brief largest pin number that exists in TMS570LC4357
67  * @details Checked in the data sheet spnu563a: The largest pin number that is
68  * used is 31.
69 */
70 #define LARGEST_PIN_NUMBER (31u)
71 
72 /**
73  * @brief maximum number of channels measured by the ADC1
74  * @details Checked in the data sheet spnu563a: ADC1 supports 32 channels
75  */
76 #define ADC_ADC1_MAX_NR_CHANNELS (32U)
77 
78 #ifndef UNITY_UNIT_TEST
79 /** Address of Free Running Counter 0 (FRC0) */
80 #define MCU_RTI_CNT0_FRC0_REG (*((volatile uint32_t *)0xFFFFFC10u))
81 #else
82 extern volatile uint32_t MCU_RTI_CNT0_FRC0_REG;
83 #endif
84 
85 /*========== Extern Constant and Variable Declarations ======================*/
86 
87 /*========== Extern Function Prototypes =====================================*/
88 
89 /**
90  * @brief Wait blocking a certain time in microseconds.
91  * @details This function uses the Free Running Counter 0 (FRC0) to generate a
92  * delay in microseconds. It does not modify anything related to the
93  * counter. This counter is already used by FreeRTOS.
94  * @param delay_us time in microseconds to wait
95  */
96 extern void MCU_Delay_us(uint32_t delay_us);
97 
98 /**
99  * @brief Get the current value of the Free Running Counter 0 (FRC0)
100  * @details This function returns the current value of the Free Running
101  * Counter 0 (FRC0). This counter is already used by FreeRTOS and this
102  * function does nothing more than accessing this value.
103  * @returns the current counter value of FRC0
104  */
105 extern uint32_t MCU_GetFreeRunningCount(void);
106 
107 /**
108  * @brief Convert the counter value FRC0 to a time in microseconds
109  * @details This function applies a scaling factor to the FRC0 counter value,
110  * which can be retrieved with #MCU_GetFreeRunningCount() so that this
111  * value represents microseconds. Typically this used with counter
112  * differences in order to get timing estimates on microsecond-level.
113  * @param[in] count counter value of the FRC0
114  * @returns equivalent time in microseconds
115  */
116 extern uint32_t MCU_ConvertFrcDifferenceToTimespan_us(uint32_t count);
117 
118 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
119 
120 #endif /* FOXBMS__MCU_H_ */
uint32_t MCU_GetFreeRunningCount(void)
Get the current value of the Free Running Counter 0 (FRC0)
Definition: mcu.c:120
uint32_t MCU_ConvertFrcDifferenceToTimespan_us(uint32_t count)
Convert the counter value FRC0 to a time in microseconds.
Definition: mcu.c:124
void MCU_Delay_us(uint32_t delay_us)
Wait blocking a certain time in microseconds.
Definition: mcu.c:86
#define MCU_RTI_CNT0_FRC0_REG
Definition: mcu.h:80