foxBMS  1.3.0
The foxBMS Battery Management System API Documentation
mxm_bitextract.c
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_bitextract.c
44  * @author foxBMS Team
45  * @date 2019-01-15 (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 Bit extraction function for mxm_17841b
52  *
53  * @details This module supplies a specific bit extraction functionality to
54  * read & write into status registers. The different statuses that are
55  * read from or write into are indicated in the enum.
56  * Battery monitoring driver for MAX1785x battery monitoring ICs.
57  *
58  */
59 
60 /*========== Includes =======================================================*/
61 #include "mxm_bitextract.h"
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Static Constant and Variable Definitions =======================*/
66 
67 /*========== Extern Constant and Variable Definitions =======================*/
68 
69 /*========== Static Function Prototypes =====================================*/
70 /**
71  * @brief Extract a bit value function
72  * @details The function is used to extract some number of bits (numOfBits)
73  * from a position (pos) to write or read from the configuration
74  * and status registers.
75  * @param[in] value value of the bits that shall be written or read
76  * @param[in] numberOfBits number of bits to be extracted from the value
77  * register
78  * @param[in] position position of bits to be extracted from the value
79  * register, start from right to left
80  * @param[in] shift number of bit-shift to the left for read
81  * function the shift value is zero.
82  * @return bit values for registers
83  */
84 static MXM_41B_REG_BIT_VALUE bitValue(
85  MXM_41B_REG_BIT_VALUE value,
86  uint8_t numberOfBits,
87  MXM_41B_REG_BITS position,
88  MXM_41B_REG_BITS shift);
89 
90 /*========== Static Function Implementations ================================*/
91 static MXM_41B_REG_BIT_VALUE bitValue(
92  MXM_41B_REG_BIT_VALUE value,
93  uint8_t numberOfBits,
94  MXM_41B_REG_BITS position,
95  MXM_41B_REG_BITS shift) {
96  /* AXIVION Routine Generic-MissingParameterAssert: value: parameter accepts whole range */
97  /* AXIVION Routine Generic-MissingParameterAssert: numberOfBits: parameter accepts whole range */
98  /* AXIVION Routine Generic-MissingParameterAssert: position: parameter accepts whole range */
99  /* AXIVION Routine Generic-MissingParameterAssert: shift: parameter accepts whole range */
100 
101  MXM_41B_REG_BIT_VALUE sBit = (((1u << numberOfBits) - 1u) & (((uint8_t)value) >> (position - 1u)));
102  return (MXM_41B_REG_BIT_VALUE)((((uint8_t)sBit) << shift) & (uint8_t)UINT8_MAX);
103 }
104 
105 /*========== Extern Function Implementations ================================*/
106 extern MXM_41B_REG_BIT_VALUE mxm_41bReadValue(uint8_t reg, uint8_t numberOfBits, MXM_41B_REG_BITS position) {
107  /* AXIVION Routine Generic-MissingParameterAssert: reg: parameter accepts whole range */
108  /* AXIVION Routine Generic-MissingParameterAssert: numberOfBits: parameter accepts whole range */
109  /* AXIVION Routine Generic-MissingParameterAssert: position: parameter accepts whole range */
110 
111  return bitValue(reg, numberOfBits, (position + 1u), 0);
112 }
113 
114 extern MXM_41B_REG_BIT_VALUE mxm_41bWriteValue(
115  MXM_41B_REG_BIT_VALUE value,
116  uint8_t numberOfBits,
117  MXM_41B_REG_BITS shift,
118  uint8_t reg) {
119  /* AXIVION Routine Generic-MissingParameterAssert: value: parameter accepts whole range */
120  /* AXIVION Routine Generic-MissingParameterAssert: numberOfBits: parameter accepts whole range */
121  /* AXIVION Routine Generic-MissingParameterAssert: shift: parameter accepts whole range */
122  /* AXIVION Routine Generic-MissingParameterAssert: reg: parameter accepts whole range */
123 
124  uint8_t outputRegister = reg;
125  outputRegister = outputRegister & ~(MXM_REG_MASK(shift, numberOfBits));
126  outputRegister = bitValue(value, numberOfBits, 1, shift) | outputRegister;
127  return outputRegister;
128 }
129 
130 /*========== Externalized Static Function Implementations (Unit Test) =======*/
mxm_41bWriteValue
MXM_41B_REG_BIT_VALUE mxm_41bWriteValue(MXM_41B_REG_BIT_VALUE value, uint8_t numberOfBits, MXM_41B_REG_BITS shift, uint8_t reg)
write a value to a register supplied as variable
Definition: mxm_bitextract.c:114
bitValue
static MXM_41B_REG_BIT_VALUE bitValue(MXM_41B_REG_BIT_VALUE value, uint8_t numberOfBits, MXM_41B_REG_BITS position, MXM_41B_REG_BITS shift)
Extract a bit value function.
Definition: mxm_bitextract.c:91
mxm_41bReadValue
MXM_41B_REG_BIT_VALUE mxm_41bReadValue(uint8_t reg, uint8_t numberOfBits, MXM_41B_REG_BITS position)
read a value from a register supplied as variable
Definition: mxm_bitextract.c:106
mxm_bitextract.h
Bit extraction function for MXM_17841b.
MXM_41B_REG_BITS
uint8_t MXM_41B_REG_BITS
Definition: mxm_bitextract.h:118
MXM_REG_MASK
#define MXM_REG_MASK(start, end)
define for creating a bitmask
Definition: mxm_bitextract.h:115
MXM_41B_REG_BIT_VALUE
uint8_t MXM_41B_REG_BIT_VALUE
Bit-values for registers.
Definition: mxm_bitextract.h:71