foxBMS - Unit Tests  1.3.0
The foxBMS Unit Tests API Documentation
mxm_registry.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 mxm_registry.h
44  * @author foxBMS Team
45  * @date 2020-07-16 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup DRIVERS
49  * @prefix MXM
50  *
51  * @brief Functions in order to have a registry of monitoring ICs
52  *
53  * @details Monitoring registry stores information about the connected ICs.
54  *
55  */
56 
57 #ifndef FOXBMS__MXM_REGISTRY_H_
58 #define FOXBMS__MXM_REGISTRY_H_
59 
60 /*========== Includes =======================================================*/
61 #include "mxm_cfg.h"
62 
63 #include "mxm_1785x_tools.h"
64 #include "mxm_basic_defines.h"
65 
66 /*========== Macros and Definitions =========================================*/
67 
68 /*========== Extern Constant and Variable Declarations ======================*/
69 
70 /*========== Extern Function Prototypes =====================================*/
71 /**
72  * @brief Initialize monitoring registry
73  * @details Sets the connected state of every entry of the registry of
74  * monitoring ICs to false.
75  * @param[in] pState state-pointer
76  */
78 
79 /**
80  * @brief Mark devices as connected in the registry and set the
81  * address.
82  * @details Takes the number of connected (adjacent!) devices and marks
83  * them in the registry.
84  * @param[in,out] pState state-pointer
85  * @param[in] numberOfDevices number of normal satellites
86  * @return #STD_OK if the number of modules is OK, #STD_NOT_OK
87  * otherwise
88  */
89 extern STD_RETURN_TYPE_e MXM_MonRegistryConnectDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t numberOfDevices);
90 
91 /**
92  * @brief Parse number of highest connected device from monitoring-
93  * register.
94  * @param[in] kpkState state-pointer
95  * @return #MXM_MONITORING_INSTANCE_s::highest5xDevice
96  */
97 extern uint8_t MXM_MonRegistryGetHighestConnected5XDevice(const MXM_MONITORING_INSTANCE_s *const kpkState);
98 
99 /**
100  * @brief Parse ID (1 or 2) into the registry
101  * @param[in,out] pState state-pointer
102  * @param[in] rxBufferLength length of the rxBuffer
103  * @param[in] type type of register (has to be #MXM_REG_ID1 or #MXM_REG_ID2)
104  */
107  uint8_t rxBufferLength,
108  MXM_REG_NAME_e type);
109 
110 /**
111  * @brief Parse Version into the registry
112  * @param[in,out] pState state-pointer
113  * @param[in] rxBufferLength length of the rxBuffer
114  */
115 extern void MXM_MonRegistryParseVersionIntoDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t rxBufferLength);
116 
117 /**
118  * @brief Parse STATUS or FMEA into the registry
119  * @param[in,out] pState state-pointer
120  * @param[in] rxBufferLength length of the rxBuffer
121  */
122 extern void MXM_MonRegistryParseStatusFmeaIntoDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t rxBufferLength);
123 
124 /**
125  * @brief check if one of the devices in the registry has the ALRTRST bit set
126  * @details If a monitoring device is reset, it will set the ALRTRST bit in
127  * #MXM_REG_STATUS1. This should not happen during normal operation.
128  * If this happens, initialization of the devices is lost and has
129  * to be restored. This is done by reseting the state machine.
130  * @param[in,out] kpkState state-pointer
131  * @returns true if a device has been reset, false otherwise
132  */
133 extern bool MXM_CheckIfADeviceHasBeenReset(const MXM_MONITORING_INSTANCE_s *const kpkState);
134 
135 /**
136  * @brief check if a device is connected
137  * @details Checks the connected state in the registry
138  * @param[in] kpkState state-pointer
139  * @param[in] device device number
140  * @returns true if a device is connected, false otherwise
141  */
142 extern bool MXM_CheckIfADeviceIsConnected(const MXM_MONITORING_INSTANCE_s *const kpkState, uint8_t device);
143 
144 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
145 
146 #endif /* FOXBMS__MXM_REGISTRY_H_ */
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
This is a collection of helper functions for the MAX1785x ICs.
Basic defines for the complete Maxim driver.
Header for the configuration for the Maxim monitoring chip.
MXM_REG_NAME_e
MAX1785x register names.
bool MXM_CheckIfADeviceIsConnected(const MXM_MONITORING_INSTANCE_s *const kpkState, uint8_t device)
check if a device is connected
Definition: mxm_registry.c:262
void MXM_MonRegistryParseIdIntoDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t rxBufferLength, MXM_REG_NAME_e type)
Parse ID (1 or 2) into the registry.
Definition: mxm_registry.c:121
void MXM_MonRegistryInit(MXM_MONITORING_INSTANCE_s *pState)
Initialize monitoring registry.
Definition: mxm_registry.c:79
STD_RETURN_TYPE_e MXM_MonRegistryConnectDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t numberOfDevices)
Mark devices as connected in the registry and set the address.
Definition: mxm_registry.c:96
uint8_t MXM_MonRegistryGetHighestConnected5XDevice(const MXM_MONITORING_INSTANCE_s *const kpkState)
Parse number of highest connected device from monitoring- register.
Definition: mxm_registry.c:115
void MXM_MonRegistryParseStatusFmeaIntoDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t rxBufferLength)
Parse STATUS or FMEA into the registry.
Definition: mxm_registry.c:192
void MXM_MonRegistryParseVersionIntoDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t rxBufferLength)
Parse Version into the registry.
Definition: mxm_registry.c:152
bool MXM_CheckIfADeviceHasBeenReset(const MXM_MONITORING_INSTANCE_s *const kpkState)
check if one of the devices in the registry has the ALRTRST bit set
Definition: mxm_registry.c:239