foxBMS  1.5.1
The foxBMS Battery Management System API Documentation
io.h
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 io.h
44  * @author foxBMS Team
45  * @date 2020-03-19 (date of creation)
46  * @updated 2023-02-23 (date of last update)
47  * @version v1.5.1
48  * @ingroup DRIVERS
49  * @prefix IO
50  *
51  * @brief Header for the driver for the IO module
52  *
53  * @details TODO
54  */
55 
56 #ifndef FOXBMS__IO_H_
57 #define FOXBMS__IO_H_
58 
59 /*========== Includes =======================================================*/
60 
61 #include "fstd_types.h"
62 
63 #include <stdint.h>
64 
65 /*========== Macros and Definitions =========================================*/
66 
67 /*========== Extern Constant and Variable Declarations ======================*/
68 
69 /*========== Extern Function Prototypes =====================================*/
70 /**
71  * @brief Set pin to output by writing in pin direction register.
72  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
73  * time the IOs are controlled by a dedicated register in the
74  * corresponding peripheral.
75  * @param pRegisterAddress address of pin direction register
76  * @param pin bit position corresponding to pin in register
77  */
78 extern void IO_SetPinDirectionToOutput(volatile uint32_t *pRegisterAddress, uint32_t pin);
79 
80 /**
81  * @brief Set pin to input by writing in pin direction register.
82  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
83  * time the IOs are controlled by a dedicated register in the
84  * corresponding peripheral.
85  * @param pRegisterAddress address of pin direction register
86  * @param pin bit position corresponding to pin in register
87  */
88 extern void IO_SetPinDirectionToInput(volatile uint32_t *pRegisterAddress, uint32_t pin);
89 
90 /**
91  * @brief Set pin by writing in pin output register.
92  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
93  * time the IOs are controlled by a dedicated register in the
94  * corresponding peripheral.
95  * @param pRegisterAddress address of pin output register
96  * @param pin bit position corresponding to pin in register
97  */
98 extern void IO_PinSet(volatile uint32_t *pRegisterAddress, uint32_t pin);
99 
100 /**
101  * @brief Reset pin by writing in pin output register.
102  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
103  * time the IOs are controlled by a dedicated register in the
104  * corresponding peripheral.
105  * @param pRegisterAddress address of pin output register
106  * @param pin bit position corresponding to pin in register
107  */
108 extern void IO_PinReset(volatile uint32_t *pRegisterAddress, uint32_t pin);
109 
110 /**
111  * @brief Get pin state.
112  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
113  * time the IOs are controlled by a dedicated register in the
114  * corresponding peripheral.
115  * @param pRegisterAddress address of pin output register
116  * @param pin bit position corresponding to pin in register
117  * @return #STD_PIN_STATE_e state of the pin
118  */
119 extern STD_PIN_STATE_e IO_PinGet(const volatile uint32_t *pRegisterAddress, uint32_t pin);
120 
121 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
122 #ifdef UNITY_UNIT_TEST
123 #endif
124 
125 #endif /* FOXBMS__IO_H_ */
Definition of foxBMS standard types.
STD_PIN_STATE_e
Definition: fstd_types.h:88
void IO_SetPinDirectionToOutput(volatile uint32_t *pRegisterAddress, uint32_t pin)
Set pin to output by writing in pin direction register.
Definition: io.c:77
void IO_SetPinDirectionToInput(volatile uint32_t *pRegisterAddress, uint32_t pin)
Set pin to input by writing in pin direction register.
Definition: io.c:84
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