foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
led.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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 led.c
44  * @author foxBMS Team
45  * @date 2021-09-28 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVERS
49  * @prefix LED
50  *
51  * @brief Implementation of the debug LED driver
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "led.h"
57 
58 #include "ftask_cfg.h"
59 
60 #include "HL_reg_het.h"
61 
62 #include "fassert.h"
63 #include "io.h"
64 
65 #include <stdint.h>
66 
67 /*========== Macros and Definitions =========================================*/
68 /** Periodic call time of function #LED_Trigger */
69 #define LED_PERIODIC_CALL_TIME_ms (FTSK_TASK_CYCLIC_100MS_CYCLE_TIME)
70 
71 /** HET1 GIO register that the Debug LED is connected to. */
72 #define LED_PORT (hetREG1)
73 /** Pin of HET1 that the Debug LED is connected to. */
74 #define LED_PIN (1u)
75 
76 /*========== Static Constant and Variable Definitions =======================*/
77 /** duration of a half a LED blink cycle in ms */
78 static uint32_t led_onOffTime_ms = 0u;
79 
80 /*========== Extern Constant and Variable Definitions =======================*/
81 
82 /*========== Static Function Prototypes =====================================*/
83 
84 /*========== Static Function Implementations ================================*/
85 
86 /*========== Extern Function Implementations ================================*/
87 extern void LED_SetDebugLed(void) {
88  IO_PinSet(&LED_PORT->DOUT, LED_PIN);
89 }
90 
91 extern void LED_Trigger(void) {
93  uint32_t led_tmpOnOffTime_ms = led_onOffTime_ms;
95  FAS_ASSERT(led_tmpOnOffTime_ms != 0u);
96 
97  static uint32_t counter = 0u;
98  if (counter == UINT32_MAX) {
99  /* wrap counter */
100  counter = 0u;
101  }
102  counter++;
103 
104  if (0u == (((uint64_t)counter * LED_PERIODIC_CALL_TIME_ms) % led_tmpOnOffTime_ms)) {
105  if (STD_PIN_HIGH == IO_PinGet(&LED_PORT->DIN, LED_PIN)) {
106  IO_PinReset(&LED_PORT->DOUT, LED_PIN);
107  } else {
108  IO_PinSet(&LED_PORT->DOUT, LED_PIN);
109  }
110  counter = 0u;
111  }
112 }
113 
114 extern void LED_SetToggleTime(uint32_t onOffTime_ms) {
115  FAS_ASSERT(0u == (onOffTime_ms % LED_PERIODIC_CALL_TIME_ms));
116  led_onOffTime_ms = onOffTime_ms;
118 }
119 
120 /*========== Externalized Static Function Implementations (Unit Test) =======*/
121 #ifdef UNITY_UNIT_TEST
122 extern uint32_t TEST_LED_GetOnOffTime(void) {
123  return led_onOffTime_ms;
124 }
125 extern void TEST_LED_SetOnOffTime(uint32_t val) {
126  led_onOffTime_ms = val;
127 }
128 #endif
Assert macro implementation.
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:250
@ STD_PIN_HIGH
Definition: fstd_types.h:90
Task configuration header.
void IO_PinSet(volatile uint32_t *pRegisterAddress, uint32_t pin)
Set pin by writing in pin output register.
Definition: io.c:91
void IO_PinReset(volatile uint32_t *pRegisterAddress, uint32_t pin)
Reset pin by writing in pin output register.
Definition: io.c:98
STD_PIN_STATE_e IO_PinGet(const volatile uint32_t *pRegisterAddress, uint32_t pin)
Get pin state.
Definition: io.c:105
Header for the driver for the IO module.
void LED_SetToggleTime(uint32_t onOffTime_ms)
Set debug LED with defined frequency.
Definition: led.c:114
void TEST_LED_SetOnOffTime(uint32_t val)
Definition: led.c:125
static uint32_t led_onOffTime_ms
Definition: led.c:78
void LED_SetDebugLed(void)
Turn debug LED on.
Definition: led.c:87
#define LED_PORT
Definition: led.c:72
#define LED_PIN
Definition: led.c:74
#define LED_PERIODIC_CALL_TIME_ms
Definition: led.c:69
void LED_Trigger(void)
Trigger function to periodically toggle debug LED. Frequency can be set via function LED_SetToggleTim...
Definition: led.c:91
uint32_t TEST_LED_GetOnOffTime(void)
Definition: led.c:122
Header file of the debug LED driver.
void OS_ExitTaskCritical(void)
Exit Critical interface function for use in FreeRTOS-Tasks and FreeRTOS-ISR.
Definition: os_freertos.c:138
void OS_EnterTaskCritical(void)
Enter Critical interface function for use in FreeRTOS-Tasks and FreeRTOS-ISR.
Definition: os_freertos.c:134