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