foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
pex.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 pex.h
44  * @author foxBMS Team
45  * @date 2021-08-02 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVERS
49  * @prefix PEX
50  *
51  * @brief Header for the driver for the NXP PCA9539 port expander module
52  *
53  */
54 
55 #ifndef FOXBMS__PEX_H_
56 #define FOXBMS__PEX_H_
57 
58 /*========== Includes =======================================================*/
59 
60 #include "pex_cfg.h"
61 
62 #include <stdint.h>
63 
64 /*========== Macros and Definitions =========================================*/
65 /** Port expander pin high levels in registers
66  * @{*/
67 #define PEX_PIN_LOW (0u)
68 #define PEX_PIN_HIGH (1u)
69 /**@}*/
70 
71 /*========== Extern Constant and Variable Declarations ======================*/
72 
73 /*========== Extern Function Prototypes =====================================*/
74 
75 /**
76  * @brief initialize local variable containing state of port expander.
77  *
78  */
79 extern void PEX_Initialize(void);
80 
81 /**
82  * @brief sets pin to high.
83  * @param portExpander port expander number
84  * @param pin pin number
85  */
86 extern void PEX_SetPin(uint8_t portExpander, uint8_t pin);
87 
88 /**
89  * @brief sets pin to low.
90  * @param portExpander port expander number
91  * @param pin pin number
92  *
93  */
94 extern void PEX_ResetPin(uint8_t portExpander, uint8_t pin);
95 
96 /**
97  * @brief get pin state of port expander pins.
98  * @return pin state: #PEX_PIN_LOW or #PEX_PIN_HIGH
99  */
100 extern uint8_t PEX_GetPin(uint8_t portExpander, uint8_t pin);
101 
102 /**
103  * @brief sets pin direction to input.
104  * @param portExpander port expander number
105  * @param pin pin number
106  */
107 extern void PEX_SetPinDirectionInput(uint8_t portExpander, uint8_t pin);
108 
109 /**
110  * @brief sets pin to input.
111  * @param portExpander port expander number
112  * @param pin pin number
113  */
114 extern void PEX_SetPinDirectionOutput(uint8_t portExpander, uint8_t pin);
115 
116 /**
117  * @brief sets pin polarity to inverted.
118  * @param portExpander port expander number
119  * @param pin pin number
120  */
121 extern void PEX_SetPinPolarityInverted(uint8_t portExpander, uint8_t pin);
122 
123 /**
124  * @brief sets pin polarity to retained.
125  * @param portExpander port expander number
126  * @param pin pin number
127  */
128 extern void PEX_SetPinPolarityRetained(uint8_t portExpander, uint8_t pin);
129 
130 /**
131  * @brief implements reading/writing to the port expander registers.
132  * @details This function reads the desired port expander state (outputs,
133  * configuration) from the externally available variables and stores
134  * it in the local variable. It then applies this state to the devices
135  * via the I2C bus. It reads the pin input state via the I2C bus and
136  * writes it to the externally available port expander state.
137  */
138 extern void PEX_Trigger(void);
139 
140 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
141 #ifdef UNITY_UNIT_TEST
142 #endif
143 
144 #endif /* FOXBMS__PEX_H_ */
uint8_t PEX_GetPin(uint8_t portExpander, uint8_t pin)
get pin state of port expander pins.
Definition: pex.c:366
void PEX_SetPin(uint8_t portExpander, uint8_t pin)
sets pin to high.
Definition: pex.c:336
void PEX_ResetPin(uint8_t portExpander, uint8_t pin)
sets pin to low.
Definition: pex.c:351
void PEX_SetPinPolarityRetained(uint8_t portExpander, uint8_t pin)
sets pin polarity to retained.
Definition: pex.c:440
void PEX_SetPinDirectionOutput(uint8_t portExpander, uint8_t pin)
sets pin to input.
Definition: pex.c:409
void PEX_SetPinPolarityInverted(uint8_t portExpander, uint8_t pin)
sets pin polarity to inverted.
Definition: pex.c:425
void PEX_Initialize(void)
initialize local variable containing state of port expander.
Definition: pex.c:290
void PEX_SetPinDirectionInput(uint8_t portExpander, uint8_t pin)
sets pin direction to input.
Definition: pex.c:394
void PEX_Trigger(void)
implements reading/writing to the port expander registers.
Definition: pex.c:312
Headers for the configuration for the NXP PCA9539 port expander module.