foxBMS  1.1.0
The foxBMS Battery Management System API Documentation
mxm_registry.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 mxm_registry.h
44  * @author foxBMS Team
45  * @date 2020-07-16 (date of creation)
46  * @updated 2021-06-16 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix MXM
49  *
50  * @brief Functions in order to have a registry of monitoring ICs
51  *
52  * @details Monitoring registry stores information about the connected ICs.
53  *
54  */
55 
56 #ifndef FOXBMS__MXM_REGISTRY_H_
57 #define FOXBMS__MXM_REGISTRY_H_
58 
59 /*========== Includes =======================================================*/
60 #include "mxm_cfg.h"
61 
62 #include "mxm_1785x_tools.h"
63 #include "mxm_basic_defines.h"
64 
65 /*========== Macros and Definitions =========================================*/
66 
67 /*========== Extern Constant and Variable Declarations ======================*/
68 
69 /*========== Extern Function Prototypes =====================================*/
70 /**
71  * @brief Initialize monitoring registry
72  * @details Sets the connected state of every entry of the registry of
73  * monitoring ICs to false.
74  * @param[in] pState state-pointer
75  */
77 
78 /**
79  * @brief Mark devices as connected in the registry and set the
80  * address.
81  * @details Takes the number of connected (adjacent!) devices and marks
82  * them in the registry.
83  * @param[in,out] pState state-pointer
84  * @param[in] numberOfDevices number of normal satellites
85  * @return #STD_OK if the number of modules is OK, #STD_NOT_OK
86  * otherwise
87  */
88 extern STD_RETURN_TYPE_e MXM_MonRegistryConnectDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t numberOfDevices);
89 
90 /**
91  * @brief Parse number of highest connected device from monitoring-
92  * register.
93  * @param[in] kpkState state-pointer
94  * @return #MXM_MONITORING_INSTANCE_s::highest5xDevice
95  */
96 extern uint8_t MXM_MonRegistryGetHighestConnected5XDevice(const MXM_MONITORING_INSTANCE_s *const kpkState);
97 
98 /**
99  * @brief Parse ID (1 or 2) into the registry
100  * @param[in,out] pState state-pointer
101  * @param[in] rxBufferLength length of the rxBuffer
102  * @param[in] type type of register (has to be #MXM_REG_ID1 or #MXM_REG_ID2)
103  */
106  uint8_t rxBufferLength,
107  MXM_REG_NAME_e type);
108 
109 /**
110  * @brief Parse Version into the registry
111  * @param[in,out] pState state-pointer
112  * @param[in] rxBufferLength length of the rxBuffer
113  */
114 extern void MXM_MonRegistryParseVersionIntoDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t rxBufferLength);
115 
116 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
117 
118 #endif /* FOXBMS__MXM_REGISTRY_H_ */
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
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.
enum MXM_REG_NAME MXM_REG_NAME_e
MAX1785x register names.
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:104
void MXM_MonRegistryInit(MXM_MONITORING_INSTANCE_s *pState)
Initialize monitoring registry.
Definition: mxm_registry.c:70
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:82
uint8_t MXM_MonRegistryGetHighestConnected5XDevice(const MXM_MONITORING_INSTANCE_s *const kpkState)
Parse number of highest connected device from monitoring- register.
Definition: mxm_registry.c:98
void MXM_MonRegistryParseVersionIntoDevices(MXM_MONITORING_INSTANCE_s *pState, uint8_t rxBufferLength)
Parse Version into the registry.
Definition: mxm_registry.c:133