foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
mxm_bitextract.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
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 2020-05-14 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix MXM
49  *
50  * @brief Bit extraction function for mxm_17841b
51  *
52  * @details This module supplies a specific bit extraction functionality to
53  * read & write into status registers. The different statuses that are
54  * read from or write into are indicated in the enum.
55  * Battery monitoring driver for MAX1785x battery monitoring ICs.
56  *
57  */
58 
59 /*========== Includes =======================================================*/
60 #include "mxm_bitextract.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /*========== Static Constant and Variable Definitions =======================*/
65 
66 /*========== Extern Constant and Variable Definitions =======================*/
67 
68 /*========== Static Function Prototypes =====================================*/
69 /**
70  * @brief Extract a bit value function
71  * @details The function is used to extract some number of bits (numOfBits)
72  * from a position (pos) to write or read from the configuration
73  * and status registers.
74  * @param[in] value value of the bits that shall be written or read
75  * @param[in] numberOfBits number of bits to be extracted from the value
76  * register
77  * @param[in] position position of bits to be extracted from the value
78  * register, start from right to left
79  * @param[in] shift number of bit-shift to the left for read
80  * function the shift value is zero.
81  * @return bit values for registers
82  */
83 static MXM_41B_REG_BIT_VALUE bitValue(
84  MXM_41B_REG_BIT_VALUE value,
85  uint8_t numberOfBits,
86  MXM_41B_REG_BITS position,
87  MXM_41B_REG_BITS shift);
88 
89 /*========== Static Function Implementations ================================*/
90 static MXM_41B_REG_BIT_VALUE bitValue(
91  MXM_41B_REG_BIT_VALUE value,
92  uint8_t numberOfBits,
93  MXM_41B_REG_BITS position,
94  MXM_41B_REG_BITS shift) {
95  MXM_41B_REG_BIT_VALUE sBit;
96  sBit = (((1u << numberOfBits) - 1u) & (((uint8_t)value) >> (position - 1u)));
97  return (((uint8_t)sBit) << shift);
98 }
99 
100 /*========== Extern Function Implementations ================================*/
101 extern MXM_41B_REG_BIT_VALUE mxm_41bReadValue(uint8_t reg, uint8_t numberOfBits, MXM_41B_REG_BITS position) {
102  return bitValue(reg, numberOfBits, (position + 1u), 0);
103 }
104 
105 extern MXM_41B_REG_BIT_VALUE mxm_41bWriteValue(
106  MXM_41B_REG_BIT_VALUE value,
107  uint8_t numberOfBits,
108  MXM_41B_REG_BITS shift,
109  uint8_t reg) {
110  uint8_t outputRegister = reg;
111  outputRegister = outputRegister & ~(MXM_REG_MASK(shift, numberOfBits));
112  outputRegister = bitValue(value, numberOfBits, 1, shift) | outputRegister;
113  return outputRegister;
114 }
115 
116 /*========== Externalized Static Function Implementations (Unit Test) =======*/
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:90
MXM_REG_MASK
#define MXM_REG_MASK(start, end)
define for creating a bitmask
Definition: mxm_bitextract.h:112
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:101
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:105
MXM_41B_REG_BITS
uint8_t MXM_41B_REG_BITS
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:69
mxm_bitextract.h
Bit extraction function for MXM_17841b.