foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
io.h
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 io.h
44  * @author foxBMS Team
45  * @date 2020-03-19 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
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 #include "general.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /*========== Extern Constant and Variable Declarations ======================*/
65 
66 /*========== Extern Function Prototypes =====================================*/
67 /**
68  * @brief Set pin to output by writing in pin direction register.
69  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
70  * time the IOs are controlled by a dedicated register in the
71  * corresponding peripheral.
72  * @param pRegisterAddress address of pin direction register
73  * @param pin bit position corresponding to pin in register
74  */
75 extern void IO_SetPinDirectionToOutput(volatile uint32_t *pRegisterAddress, uint32_t pin);
76 
77 /**
78  * @brief Set pin to input by writing in pin direction register.
79  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
80  * time the IOs are controlled by a dedicated register in the
81  * corresponding peripheral.
82  * @param pRegisterAddress address of pin direction register
83  * @param pin bit position corresponding to pin in register
84  */
85 extern void IO_SetPinDirectionToInput(volatile uint32_t *pRegisterAddress, uint32_t pin);
86 
87 /**
88  * @brief Set pin by writing in pin output register.
89  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
90  * time the IOs are controlled by a dedicated register in the
91  * corresponding peripheral.
92  * @param pRegisterAddress address of pin output register
93  * @param pin bit position corresponding to pin in register
94  */
95 extern void IO_PinSet(volatile uint32_t *pRegisterAddress, uint32_t pin);
96 
97 /**
98  * @brief Reset pin by writing in pin output register.
99  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
100  * time the IOs are controlled by a dedicated register in the
101  * corresponding peripheral.
102  * @param pRegisterAddress address of pin output register
103  * @param pin bit position corresponding to pin in register
104  */
105 extern void IO_PinReset(volatile uint32_t *pRegisterAddress, uint32_t pin);
106 
107 /**
108  * @brief Get pin state.
109  * @details The TMS570LC43 has only few dedicated GPIO register. Most of the
110  * time the IOs are controlled by a dedicated register in the
111  * corresponding peripheral.
112  * @param pRegisterAddress address of pin output register
113  * @param pin bit position corresponding to pin in register
114  * @return #STD_PIN_STATE_e state of the pin
115  */
116 extern STD_PIN_STATE_e IO_PinGet(const volatile uint32_t *pRegisterAddress, uint32_t pin);
117 
118 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
119 
120 #endif /* FOXBMS__IO_H_ */
STD_PIN_STATE_e
Definition: fstd_types.h:87
General macros and definitions for the whole platform.
void IO_SetPinDirectionToOutput(volatile uint32_t *pRegisterAddress, uint32_t pin)
Set pin to output by writing in pin direction register.
Definition: io.c:73
void IO_SetPinDirectionToInput(volatile uint32_t *pRegisterAddress, uint32_t pin)
Set pin to input by writing in pin direction register.
Definition: io.c:80
void IO_PinSet(volatile uint32_t *pRegisterAddress, uint32_t pin)
Set pin by writing in pin output register.
Definition: io.c:87
void IO_PinReset(volatile uint32_t *pRegisterAddress, uint32_t pin)
Reset pin by writing in pin output register.
Definition: io.c:94
STD_PIN_STATE_e IO_PinGet(const volatile uint32_t *pRegisterAddress, uint32_t pin)
Get pin state.
Definition: io.c:101