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