AM62Px MCU+ SDK  10.01.00
tisci_bitops.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016-2024 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * 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
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
54 #ifndef BITOPS_H
55 #define BITOPS_H
56 
57 #ifdef __cplusplus
58 extern "C"
59 {
60 #endif
61 
62 
63 
65 #define TISCI_BIT(n) (((uint32_t) 1U) << (n))
66 
67 
68 static inline uint32_t get_field(uint32_t val, uint32_t end, uint32_t start);
69 static inline uint32_t set_field(uint32_t tgt, uint32_t end, uint32_t start, uint32_t val);
70 static inline uint32_t get_mask(uint32_t end, uint32_t start);
71 
84 static inline uint32_t get_mask(uint32_t end, uint32_t start)
85 {
86  return (uint32_t) ((1U << (end - start + 1U)) - 1U) << start;
87 }
88 
98 static inline uint32_t get_field(uint32_t val, uint32_t end, uint32_t start)
99 {
100  uint32_t mask = get_mask(end, start);
101 
102  return (val & mask) >> start;
103 }
104 
116 static inline uint32_t set_field(uint32_t tgt, uint32_t end, uint32_t start, uint32_t val)
117 {
118  uint32_t ret = 0U;
119  uint32_t mask = get_mask(end, start);
120 
121  ret = (tgt & (~mask));
122 
123  ret = (ret | ((val << start) & mask));
124 
125  return ret;
126 }
127 
128 
129 #ifdef __cplusplus
130 }
131 #endif
132 
133 #endif
134 
get_field
static uint32_t get_field(uint32_t val, uint32_t end, uint32_t start)
extract the specified bit field from a 32 bit unsigned integer.
Definition: tisci_bitops.h:98
set_field
static uint32_t set_field(uint32_t tgt, uint32_t end, uint32_t start, uint32_t val)
set the specified bit field from a 32 bit unsigned integer to provided value
Definition: tisci_bitops.h:116
get_mask
static uint32_t get_mask(uint32_t end, uint32_t start)
Generate a mask for the give bit field [end:start].
Definition: tisci_bitops.h:84