-
Notifications
You must be signed in to change notification settings - Fork 38
/
hal_ll_bit_control.h
155 lines (137 loc) · 4.4 KB
/
hal_ll_bit_control.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/****************************************************************************
**
** Copyright (C) ${COPYRIGHT_YEAR} MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
/*!
* @file hal_ll_bit_control.h
* @brief Macros used for bitwise register manipulation.
*/
#ifndef _HAL_LL_BIT_CONTROL_H_
#define _HAL_LL_BIT_CONTROL_H_
#ifdef __cplusplus
extern "C"{
#endif
#include <stdint.h>
/*!< @brief Mask used for register clearing */
#define HAL_LL_CLEAR 0x00UL
/*!< @brief Macro */
#define selected_reg(__reg) (*(uint32_t *)(__reg))
/*!< @brief Low nibble macros */
#define HAL_LL_NIBBLE_LOW_8BIT (0xF)
#define HAL_LL_NIBBLE_LOW_16BIT (0xFFU)
#define HAL_LL_NIBBLE_LOW_32BIT (0xFFFFUL)
/*!< @brief High nibble macros */
#define HAL_LL_NIBBLE_HIGH_8BIT (0xF0)
#define HAL_LL_NIBBLE_HIGH_16BIT (0xFF00U)
#define HAL_LL_NIBBLE_HIGH_32BIT (0xFFFF0000UL)
/**
* @brief Sets one bit in a register.
*
* @param[in] reg - register address.
* @param[in] _bit - bit number (0-31).
*/
#define set_reg_bit(reg,_bit) (selected_reg(reg) |= ((1UL)<<(_bit)))
/**
* @brief Sets bits specified by bit_mask
* in the specified register.
*
* @param[in] reg - register address
* @param[in] bit_mask - bit mask.
*/
#define set_reg_bits(reg,bit_mask) (selected_reg(reg) |= (bit_mask))
/**
* @brief Clears one bit in a register.
*
* @param[in] reg - register address.
* @param[in] _bit - bit number (0-31).
*/
#define clear_reg_bit(reg,_bit) (selected_reg(reg) &= ~((1UL)<<(_bit)))
/**
* @brief Clears bits specified by bit_mask
* in the specified register.
*
* @param[in] reg - register address
* @param[in] bit_mask - bit mask.
*/
#define clear_reg_bits(reg,bit_mask) (selected_reg(reg) &= ~(bit_mask))
/**
* @brief Returns value of one bit
* in a register.
*
* @param[in] reg - register address.
* @param[in] _bit - bit number (0-31).
* @return Register(reg) bit value.
*/
#define check_reg_bit(reg,_bit) (selected_reg(reg) & ((1UL)<<(_bit)))
/**
* @brief Writes specified value to
* specified register.
*
* @param[in] reg - register address.
* @param[in] _val - Value to be written.
*/
#define write_reg(reg,_val) (selected_reg(reg) = (_val))
/**
* @brief Returns value stored
* in a register.
*
* @param[in] reg - register address.
*
* @return Register(reg) value.
*/
#define read_reg(reg) (selected_reg(reg))
/**
* @brief Returns value of specified bit
* mask from a register.
*
* @param[in] reg - register address
* @param[in] bit_mask - bit mask.
*
* @return Register(reg) bits value.
*/
#define read_reg_bits(reg,bit_mask) (selected_reg(reg) & (bit_mask))
/**
* @brief Clears all bits in a register.
*
* @param[in] reg - register address
*/
#define clear_reg(reg) write_reg(reg, HAL_LL_CLEAR)
#ifdef __cplusplus
}
#endif
#endif // _HAL_LL_BIT_CONTROL_H_
// ------------------------------------------------------------------------- END