video_in_hal/nsframework/framework_unified/client/NS_UtilityCenter/include/ns_utility_if_internal.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 ////////////////////////////////////////////////////////////////////////////////////////////////////
  18 /// \brief    This file contains declaration of common APIs for NS_UtilityCenter.
  19 ///
  20 ////////////////////////////////////////////////////////////////////////////////////////////////////
  21
  22 /**
  23  * @file ns_utility_if_internal.h
  24  */
  25
  26 #ifndef FRAMEWORK_UNIFIED_CLIENT_NS_UTILITYCENTER_INCLUDE_NS_UTILITY_IF_INTERNAL_H_
  27 #define FRAMEWORK_UNIFIED_CLIENT_NS_UTILITYCENTER_INCLUDE_NS_UTILITY_IF_INTERNAL_H_
  28
  29 #include <native_service/frameworkunified_types.h>
  30
  31 /** @addtogroup BaseSystem
  32  *  @{
  33  */
  34 /** @addtogroup native_service
  35  *  @ingroup BaseSystem
  36  *  @{
  37  */
  38 /** @addtogroup framework_unified
  39  *  @ingroup native_service
  40  *  @{
  41  */
  42
  43 ////////////////////////////////////////////////////////////////////////////////////////////////
  44 /// \ingroup NS_UtilityCenter
  45 /// \~english @par Brief
  46 ///       Get the number of leading zeros in a given 16bit value.
  47 /// \~english @param [in] f_ui_val
  48 ///       UI_16 - the value to be counted
  49 /// \~english @retval the number of leading zeros
  50 ///
  51 /// \~english @par Prerequisite
  52 ///       - None
  53 /// \~english @par Change of internal state
  54 ///       - None
  55 /// \~english @par Conditions of processing failure
  56 ///       - None
  57 /// \~english @par Classification
  58 ///       Public
  59 /// \~english @par Type
  60 ///       Sync Only
  61 /// \~english @par Detail
  62 ///       The function returns the number of leading zeros in a given 16bit value.
  63 /// \~english @see NS_CountLeadingZeros_32Bit NS_CountLeadingZeros_64Bit
  64 ////////////////////////////////////////////////////////////////////////////////////////////////
  65 SI_16 NS_CountLeadingZeros_16Bit(UI_16 f_ui_val);  // NOLINT (readability/nolint)
  66
  67 ////////////////////////////////////////////////////////////////////////////////////////////////
  68 /// \ingroup NS_UtilityCenter
  69 /// \~english @par Brief
  70 ///       Get the number of leading zeros in a given 32bit value.
  71 /// \~english @param [in] f_ui_val
  72 ///       UI_32 - the value to be counted
  73 /// \~english @retval the number of leading zeros
  74 ///
  75 /// \~english @par Prerequisite
  76 ///       - None
  77 /// \~english @par Change of internal state
  78 ///       - None
  79 /// \~english @par Conditions of processing failure
  80 ///       - None
  81 /// \~english @par Classification
  82 ///       Public
  83 /// \~english @par Type
  84 ///       Sync Only
  85 /// \~english @par Detail
  86 ///       The function returns the number of leading zeros in a given 32bit value.
  87 /// \~english @see NS_CountLeadingZeros_16Bit NS_CountLeadingZeros_64Bit
  88 ////////////////////////////////////////////////////////////////////////////////////////////////
  89 SI_16 NS_CountLeadingZeros_32Bit(UI_32 f_ui_val);  // NOLINT (readability/nolint)
  90
  91 ////////////////////////////////////////////////////////////////////////////////////////////////
  92 /// \ingroup NS_UtilityCenter
  93 /// \~english @par Brief
  94 ///       Get the number of leading zeros in a given 64bit value.
  95 /// \~english @param [in] f_ui_val
  96 ///       UI_64 - the value to be counted
  97 /// \~english @retval the number of leading zeros
  98 ///
  99 /// \~english @par Prerequisite
 100 ///       - None
 101 /// \~english @par Change of internal state
 102 ///       - None
 103 /// \~english @par Conditions of processing failure
 104 ///       - None
 105 /// \~english @par Classification
 106 ///       Public
 107 /// \~english @par Type
 108 ///       Sync Only
 109 /// \~english @par Detail
 110 ///       The function returns the number of leading zeros in a given 64bit value.
 111 /// \~english @see NS_CountLeadingZeros_16Bit NS_CountLeadingZeros_32Bit
 112 ////////////////////////////////////////////////////////////////////////////////////////////////
 113 SI_16 NS_CountLeadingZeros_64Bit(UI_64 f_ui_val);  // NOLINT (readability/nolint)
 114
 115 ////////////////////////////////////////////////////////////////////////////////////////////////
 116 /// \ingroup NS_UtilityCenter
 117 /// \~english @par Brief
 118 ///       Get the number of trailing zeros in a given 16bit value.
 119 /// \~english @param [in] f_ui_val
 120 ///       UI_16 - the value to be counted
 121 /// \~english @retval the number of trailing zeros
 122 ///
 123 /// \~english @par Prerequisite
 124 ///       - None
 125 /// \~english @par Change of internal state
 126 ///       - None
 127 /// \~english @par Conditions of processing failure
 128 ///       - None
 129 /// \~english @par Classification
 130 ///       Public
 131 /// \~english @par Type
 132 ///       Sync Only
 133 /// \~english @par Detail
 134 ///       The function returns the number of trailing zeros in a given 16bit value.
 135 /// \~english @see NS_CountTrailingZeros_32Bit NS_CountTrailingZeros_64Bit
 136 ////////////////////////////////////////////////////////////////////////////////////////////////
 137 SI_16 NS_CountTrailingZeros_16Bit(UI_16 f_ui_val);  // NOLINT (readability/nolint)
 138
 139 ////////////////////////////////////////////////////////////////////////////////////////////////
 140 /// \ingroup NS_UtilityCenter
 141 /// \~english @par Brief
 142 ///       Get the number of trailing zeros in a given 32bit value.
 143 /// \~english @param [in] f_ui_val
 144 ///       UI_32 - the value to be counted
 145 /// \~english @retval the number of trailing zeros
 146 ///
 147 /// \~english @par Prerequisite
 148 ///       - None
 149 /// \~english @par Change of internal state
 150 ///       - None
 151 /// \~english @par Conditions of processing failure
 152 ///       - None
 153 /// \~english @par Classification
 154 ///       Public
 155 /// \~english @par Type
 156 ///       Sync Only
 157 /// \~english @par Detail
 158 ///       The function returns the number of trailing zeros in a given 32bit value.
 159 /// \~english @see NS_CountTrailingZeros_16Bit NS_CountTrailingZeros_64Bit
 160 ////////////////////////////////////////////////////////////////////////////////////////////////
 161 SI_16 NS_CountTrailingZeros_32Bit(UI_32 f_ui_val);  // NOLINT (readability/nolint)
 162
 163 ////////////////////////////////////////////////////////////////////////////////////////////////
 164 /// \ingroup NS_UtilityCenter
 165 /// \~english @par Brief
 166 ///       Get the number of trailing zeros in a given 64bit value.
 167 /// \~english @param [in] f_ui_val
 168 ///       UI_64 - the value to be counted
 169 /// \~english @retval the number of trailing zeros
 170 ///
 171 /// \~english @par Prerequisite
 172 ///       - None
 173 /// \~english @par Change of internal state
 174 ///       - None
 175 /// \~english @par Conditions of processing failure
 176 ///       - None
 177 /// \~english @par Classification
 178 ///       Public
 179 /// \~english @par Type
 180 ///       Sync Only
 181 /// \~english @par Detail
 182 ///       The function returns the number of trailing zeros in a given 64bit value.
 183 /// \~english @see NS_CountTrailingZeros_16Bit NS_CountTrailingZeros_32Bit
 184 ////////////////////////////////////////////////////////////////////////////////////////////////
 185 SI_16 NS_CountTrailingZeros_64Bit(UI_64 f_ui_val);  // NOLINT (readability/nolint)
 186
 187 /** @}*/  // end of framework_unified
 188
 189 /** @}*/  // end of native_service
 190
 191 /** @}*/  // end of BaseSystem
 192
 193 #endif  // FRAMEWORK_UNIFIED_CLIENT_NS_UTILITYCENTER_INCLUDE_NS_UTILITY_IF_INTERNAL_H_