foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
mcu.h
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.h
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 Headers for the driver for the MCU module.
51  *
52  */
53 
54 #ifndef FOXBMS__MCU_H_
55 #define FOXBMS__MCU_H_
56 
57 /*========== Includes =======================================================*/
58 #include "general.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 #ifndef UNITY_UNIT_TEST
63 /** Address of Free Running Counter 0 (FRC0) */
64 #define MCU_RTI_CNT0_FRC0_REG (*((volatile uint32_t *)0xFFFFFC10))
65 #else
66 extern volatile uint32_t MCU_RTI_CNT0_FRC0_REG;
67 #endif
68 
69 /*========== Extern Constant and Variable Declarations ======================*/
70 
71 /*========== Extern Function Prototypes =====================================*/
72 
73 /**
74  * @brief Wait blocking a certain time in microseconds.
75  * @details This function uses the Free Running Counter 0 (FRC0) to generate a
76  * delay in microseconds. It does not modify anything related to the
77  * counter. This counter is already used by FreeRTOS.
78  * @param delay_us time in microseconds to wait
79  */
80 extern void MCU_delay_us(uint32_t delay_us);
81 
82 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
83 
84 #endif /* FOXBMS__MCU_H_ */
General macros and definitions for the whole platform.
void MCU_delay_us(uint32_t delay_us)
Wait blocking a certain time in microseconds.
Definition: mcu.c:80
#define MCU_RTI_CNT0_FRC0_REG
Definition: mcu.h:64