foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
mcu.c
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.c
44  * @author foxBMS Team
45  * @date 2019-02-19 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS
49  * @prefix MCU
50  *
51  * @brief Driver for the MCU module.
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "mcu.h"
57 
58 #include "HL_system.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /** This is defined in port.c for FreeRTOS.
63  * It is named portRTI_CNT0_CPUC0_REG
64  * This must be changed to reflect the FreeRTOS configuration
65  */
66 #define MCU_RTI_CNT0_CPUC0_REG (0x00000001u)
67 
68 /** threshold in order to limit the time spent in wait to avoid livelock in wait */
69 #define MCU_US_WAIT_TIMEOUT (10000u)
70 
71 /*========== Static Constant and Variable Definitions =======================*/
72 /**
73  * @brief frequency of the FRC0 counter
74  * @details refer to data sheet SPNU563A-March 2018 p. 585 formula 23
75  */
76 static const uint32_t mcu_frcClock_Hz = (uint32_t)((RTI_FREQ)*1000000.0f) / ((MCU_RTI_CNT0_CPUC0_REG) + 1u);
77 
78 /*========== Extern Constant and Variable Definitions =======================*/
79 
80 /*========== Static Function Prototypes =====================================*/
81 
82 /*========== Static Function Implementations ================================*/
83 
84 /*========== Extern Function Implementations ================================*/
85 
86 void MCU_Delay_us(uint32_t delay_us) {
87  /* AXIVION Routine Generic-MissingParameterAssert: delay_us: parameter accepts whole range */
88  /**
89  * First the time of one FRC0 increment in microseconds is computed with
90  * increment_time = (1/mcu_frcClock_Hz)*1e6
91  * The 1e6 factor is to get the period in microseconds.
92  *
93  * The number of increments needed to reach 1 microsecond is then
94  * computed with
95  * nr_increments_for_1us = (1us/increment_time)
96  *
97  * To avoid floating point computation problems, the number of
98  * increments needed to reach 1 microsecond is computed at once with:
99  */
100  const uint32_t rti_nrOfCounts_us = (uint32_t)(((float)mcu_frcClock_Hz) / 1e6f);
101 
102  /* Get current value of FRC0 counter */
103  const uint32_t startValue = MCU_RTI_CNT0_FRC0_REG;
104 
105  uint32_t timeOut = 0;
106  while (timeOut < MCU_US_WAIT_TIMEOUT) {
107  /**
108  * Poll FRC0 value until the value corresponding to the desired
109  * waiting timing has been reached.
110  * The timeout is to ensure the code does not get trapped here.
111  */
112  const uint32_t checkValue = MCU_RTI_CNT0_FRC0_REG;
113  if ((checkValue - startValue) >= (delay_us * rti_nrOfCounts_us)) {
114  break;
115  }
116  timeOut++;
117  }
118 }
119 
120 extern uint32_t MCU_GetFreeRunningCount(void) {
121  return MCU_RTI_CNT0_FRC0_REG;
122 }
123 
124 extern uint32_t MCU_ConvertFrcDifferenceToTimespan_us(uint32_t count) {
125  /* AXIVION Routine Generic-MissingParameterAssert: count: parameter accepts whole range */
126  const uint32_t rti_nrOfCounts_us = (uint32_t)(((float)mcu_frcClock_Hz) / 1e6f);
127  return count / rti_nrOfCounts_us;
128 }
129 
130 /*========== Externalized Static Function Implementations (Unit Test) =======*/
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_US_WAIT_TIMEOUT
Definition: mcu.c:69
#define MCU_RTI_CNT0_CPUC0_REG
Definition: mcu.c:66
static const uint32_t mcu_frcClock_Hz
frequency of the FRC0 counter
Definition: mcu.c:76
Headers for the driver for the MCU module.
#define MCU_RTI_CNT0_FRC0_REG
Definition: mcu.h:80