summaryrefslogtreecommitdiffstats
path: root/nsframework/framework_unified/client/NS_UtilityCenter/include/ns_utility_if_internal.h
blob: fc0b76167f41afdb973356319a25c647ca21b1b3 (plain)
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/*
 * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

////////////////////////////////////////////////////////////////////////////////////////////////////
/// \brief    This file contains declaration of common APIs for NS_UtilityCenter.
///
////////////////////////////////////////////////////////////////////////////////////////////////////

/**
 * @file ns_utility_if_internal.h
 */

#ifndef FRAMEWORK_UNIFIED_CLIENT_NS_UTILITYCENTER_INCLUDE_NS_UTILITY_IF_INTERNAL_H_
#define FRAMEWORK_UNIFIED_CLIENT_NS_UTILITYCENTER_INCLUDE_NS_UTILITY_IF_INTERNAL_H_

#include <native_service/frameworkunified_types.h>

/** @addtogroup BaseSystem
 *  @{
 */
/** @addtogroup native_service
 *  @ingroup BaseSystem 
 *  @{
 */
/** @addtogroup framework_unified
 *  @ingroup native_service
 *  @{
 */

////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
///       Get the number of leading zeros in a given 16bit value.
/// \~english @param [in] f_ui_val
///       UI_16 - the value to be counted
/// \~english @retval the number of leading zeros
///
/// \~english @par Prerequisite
///       - None
/// \~english @par Change of internal state
///       - None
/// \~english @par Conditions of processing failure
///       - None
/// \~english @par Classification
///       Public
/// \~english @par Type
///       Sync Only
/// \~english @par Detail
///       The function returns the number of leading zeros in a given 16bit value.
/// \~english @see NS_CountLeadingZeros_32Bit NS_CountLeadingZeros_64Bit
////////////////////////////////////////////////////////////////////////////////////////////////
SI_16 NS_CountLeadingZeros_16Bit(UI_16 f_ui_val);  // NOLINT (readability/nolint)

////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
///       Get the number of leading zeros in a given 32bit value.
/// \~english @param [in] f_ui_val
///       UI_32 - the value to be counted
/// \~english @retval the number of leading zeros
///
/// \~english @par Prerequisite
///       - None
/// \~english @par Change of internal state
///       - None
/// \~english @par Conditions of processing failure
///       - None
/// \~english @par Classification
///       Public
/// \~english @par Type
///       Sync Only
/// \~english @par Detail
///       The function returns the number of leading zeros in a given 32bit value.
/// \~english @see NS_CountLeadingZeros_16Bit NS_CountLeadingZeros_64Bit
////////////////////////////////////////////////////////////////////////////////////////////////
SI_16 NS_CountLeadingZeros_32Bit(UI_32 f_ui_val);  // NOLINT (readability/nolint)

////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
///       Get the number of leading zeros in a given 64bit value.
/// \~english @param [in] f_ui_val
///       UI_64 - the value to be counted
/// \~english @retval the number of leading zeros
///
/// \~english @par Prerequisite
///       - None
/// \~english @par Change of internal state
///       - None
/// \~english @par Conditions of processing failure
///       - None
/// \~english @par Classification
///       Public
/// \~english @par Type
///       Sync Only
/// \~english @par Detail
///       The function returns the number of leading zeros in a given 64bit value.
/// \~english @see NS_CountLeadingZeros_16Bit NS_CountLeadingZeros_32Bit
////////////////////////////////////////////////////////////////////////////////////////////////
SI_16 NS_CountLeadingZeros_64Bit(UI_64 f_ui_val);  // NOLINT (readability/nolint)

////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
///       Get the number of trailing zeros in a given 16bit value.
/// \~english @param [in] f_ui_val
///       UI_16 - the value to be counted
/// \~english @retval the number of trailing zeros
///
/// \~english @par Prerequisite
///       - None
/// \~english @par Change of internal state
///       - None
/// \~english @par Conditions of processing failure
///       - None
/// \~english @par Classification
///       Public
/// \~english @par Type
///       Sync Only
/// \~english @par Detail
///       The function returns the number of trailing zeros in a given 16bit value.
/// \~english @see NS_CountTrailingZeros_32Bit NS_CountTrailingZeros_64Bit
////////////////////////////////////////////////////////////////////////////////////////////////
SI_16 NS_CountTrailingZeros_16Bit(UI_16 f_ui_val);  // NOLINT (readability/nolint)

////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
///       Get the number of trailing zeros in a given 32bit value.
/// \~english @param [in] f_ui_val
///       UI_32 - the value to be counted
/// \~english @retval the number of trailing zeros
///
/// \~english @par Prerequisite
///       - None
/// \~english @par Change of internal state
///       - None
/// \~english @par Conditions of processing failure
///       - None
/// \~english @par Classification
///       Public
/// \~english @par Type
///       Sync Only
/// \~english @par Detail
///       The function returns the number of trailing zeros in a given 32bit value.
/// \~english @see NS_CountTrailingZeros_16Bit NS_CountTrailingZeros_64Bit
////////////////////////////////////////////////////////////////////////////////////////////////
SI_16 NS_CountTrailingZeros_32Bit(UI_32 f_ui_val);  // NOLINT (readability/nolint)

////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup NS_UtilityCenter
/// \~english @par Brief
///       Get the number of trailing zeros in a given 64bit value.
/// \~english @param [in] f_ui_val
///       UI_64 - the value to be counted
/// \~english @retval the number of trailing zeros
///
/// \~english @par Prerequisite
///       - None
/// \~english @par Change of internal state
///       - None
/// \~english @par Conditions of processing failure
///       - None
/// \~english @par Classification
///       Public
/// \~english @par Type
///       Sync Only
/// \~english @par Detail
///       The function returns the number of trailing zeros in a given 64bit value.
/// \~english @see NS_CountTrailingZeros_16Bit NS_CountTrailingZeros_32Bit
////////////////////////////////////////////////////////////////////////////////////////////////
SI_16 NS_CountTrailingZeros_64Bit(UI_64 f_ui_val);  // NOLINT (readability/nolint)

/** @}*/  // end of framework_unified

/** @}*/  // end of native_service

/** @}*/  // end of BaseSystem

#endif  // FRAMEWORK_UNIFIED_CLIENT_NS_UTILITYCENTER_INCLUDE_NS_UTILITY_IF_INTERNAL_H_