foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
mcu.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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 2019-02-19 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix MCU
49  *
50  * @brief Driver for the MCU module.
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "mcu.h"
56 
57 #include "HL_system.h"
58 
59 /*========== Macros and Definitions =========================================*/
60 
61 /** This is defined in port.c for FreeRTOS.
62  * It is named portRTI_CNT0_CPUC0_REG
63  * This must be changed to reflect the FreeRTOS configuration
64  */
65 #define MCU_RTI_CNT0_CPUC0_REG (0x00000001U)
66 
67 /** threshold in order to limit the time spent in wait to avoid livelock in wait */
68 #define MCU_US_WAIT_TIMEOUT (10000U)
69 
70 /*========== Static Constant and Variable Definitions =======================*/
71 
72 /*========== Extern Constant and Variable Definitions =======================*/
73 
74 /*========== Static Function Prototypes =====================================*/
75 
76 /*========== Static Function Implementations ================================*/
77 
78 /*========== Extern Function Implementations ================================*/
79 
80 void MCU_delay_us(uint32_t delay_us) {
81  uint32_t timeOut = 0;
82  uint32_t startValue = 0;
83  uint32_t rti_clock = 0;
84  uint32_t rti_nrOfCounts_us = 0;
85 
86  /**
87  * This is the frequency of the FRC0 counter
88  * Datasheet SPNU563A-March 2018 p. 585 formula 23
89  */
90  rti_clock = (uint32_t)((AVCLK1_FREQ)*1000000.0f) / ((MCU_RTI_CNT0_CPUC0_REG) + 1u);
91 
92  /**
93  * First the time of one FRC0 increment in microseconds is computed with
94  * increment_time = (1/rti_clock)*1e6
95  * The 1e6 factor is to get the period in microseconds.
96  *
97  * The number of increments needed to reach 1 microsecond is then
98  * computed with
99  * nr_increments_for_1us = (1us/increment_time)
100  *
101  * To avoid floating point computation problems, the number of
102  * increments needed to reach 1 microsecond is computed at once with:
103  */
104  rti_nrOfCounts_us = (uint32_t)(((float)rti_clock) / 1e6f);
105 
106  /* Get current value of FRC0 counter */
107  startValue = (uint32_t)MCU_RTI_CNT0_FRC0_REG;
108 
109  while (timeOut < MCU_US_WAIT_TIMEOUT) {
110  /**
111  * Poll FRC0 value until the value corresponding to the desired
112  * waiting timing has been reached.
113  * The timeout is to ensure the code does not get trapped here.
114  */
115  if (((uint32_t)MCU_RTI_CNT0_FRC0_REG - startValue) >= (delay_us * rti_nrOfCounts_us)) {
116  break;
117  }
118  timeOut++;
119  }
120 }
121 
122 /*========== Externalized Static Function Implementations (Unit Test) =======*/
void MCU_delay_us(uint32_t delay_us)
Wait blocking a certain time in microseconds.
Definition: mcu.c:80
#define MCU_US_WAIT_TIMEOUT
Definition: mcu.c:68
#define MCU_RTI_CNT0_CPUC0_REG
Definition: mcu.c:65
Headers for the driver for the MCU module.
volatile uint32_t MCU_RTI_CNT0_FRC0_REG
Definition: test_mcu.c:60