video_in_hal/nsframework/framework_unified/client/include/native_service/ns_endianess.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  * @file ns_endianess.h
  19  * @brief \~english Provide api for convert value
  20  */
  21
  22 #ifndef NS_NATIVESERVICES_INC_UTILITY_NS_ENDIANESS_H_  // NOLINT  (build/header_guard)
  23 #define NS_NATIVESERVICES_INC_UTILITY_NS_ENDIANESS_H_
  24
  25 #include <native_service/frameworkunified_types.h>
  26
  27 /** @addtogroup BaseSystem
  28  *  @{
  29  */
  30 /** @addtogroup native_service
  31  *  @ingroup BaseSystem
  32  *  @{
  33  */
  34 /** @addtogroup framework_unified
  35  *  @ingroup native_service
  36  *  @{
  37  */
  38 /** @addtogroup utility
  39  *  @ingroup framework_unified
  40  *  @{
  41  */
  42
  43 ////////////////////////////////////////////////////////////////////////////////////////////////
  44 /// \ingroup NS_UtilityCenter
  45 /// \~english @par Brief
  46 ///       Convert the UI_16(unsigned 16bit) value to big-endian.
  47 /// \~english @param [in] f_value
  48 ///       UI_16 - The value to be converted
  49 /// \~english @retval the big-endian value of the input param f_value
  50 ///
  51 /// \~english @par Prerequisite
  52 ///       - NULL
  53 /// \~english @par Change of internal state
  54 ///       - NULL
  55 /// \~english @par Conditions of processing failure
  56 ///       - NULL
  57 /// \~english @par Classification
  58 ///       Public
  59 /// \~english @par Type
  60 ///       Sync Only
  61 /// \~english @par Detail
  62 ///       The function converts the UI_16(unsigned 16bit) value to big-endian.
  63 /// \~english @see
  64 ////////////////////////////////////////////////////////////////////////////////////////////////
  65 UI_16 ConvertEndian_UI16(UI_16 f_value);  // NOLINT (readability/nolint)
  66
  67 ////////////////////////////////////////////////////////////////////////////////////////////////
  68 /// \ingroup NS_UtilityCenter
  69 /// \~english @par Brief
  70 ///       Convert the SI_16(signed 16bit) value to big-endian.
  71 /// \~english @param [in] f_value
  72 ///       SI_16 - The value to be converted
  73 /// \~english @retval the big-endian value of the input param f_value
  74 ///
  75 /// \~english @par Prerequisite
  76 ///       - NULL
  77 /// \~english @par Change of internal state
  78 ///       - NULL
  79 /// \~english @par Conditions of processing failure
  80 ///       - NULL
  81 /// \~english @par Classification
  82 ///       Public
  83 /// \~english @par Type
  84 ///       Sync Only
  85 /// \~english @par Detail
  86 ///       The function converts the SI_16(signed 16bit) value to big-endian.
  87 /// \~english @see
  88 ////////////////////////////////////////////////////////////////////////////////////////////////
  89 SI_16 ConvertEndian_SI16(SI_16 f_value);  // NOLINT (readability/nolint)
  90
  91 ////////////////////////////////////////////////////////////////////////////////////////////////
  92 /// \ingroup NS_UtilityCenter
  93 /// \~english @par Brief
  94 ///        Convert the UI_32(unsigned 32bit) value to big-endian.
  95 /// \~english @param [in] f_value
  96 ///       UI_32 - The value to be converted
  97 /// \~english @retval the big-endian value of the input param f_value
  98 ///
  99 /// \~english @par Prerequisite
 100 ///       - NULL
 101 /// \~english @par Change of internal state
 102 ///       - NULL
 103 /// \~english @par Conditions of processing failure
 104 ///       - NULL
 105 /// \~english @par Classification
 106 ///       Public
 107 /// \~english @par Type
 108 ///       Sync Only
 109 /// \~english @par Detail
 110 ///        The function convers the UI_32(unsigned 32bit) value to big-endian.
 111 /// \~english @see
 112 ////////////////////////////////////////////////////////////////////////////////////////////////
 113 UI_32 ConvertEndian_UI32(UI_32 f_value);  // NOLINT (readability/nolint)
 114
 115 ////////////////////////////////////////////////////////////////////////////////////////////////
 116 /// \ingroup NS_UtilityCenter
 117 /// \~english @par Brief
 118 ///       Convert the SI_32(signed 32bit) value to big-endian.
 119 /// \~english @param [in] f_value
 120 ///       SI_32 - The value to be converted
 121 /// \~english @retval the big-endian value of the input param f_value
 122 ///
 123 /// \~english @par Prerequisite
 124 ///       - NULL
 125 /// \~english @par Change of internal state
 126 ///       - NULL
 127 /// \~english @par Conditions of processing failure
 128 ///       - NULL
 129 /// \~english @par Classification
 130 ///       Public
 131 /// \~english @par Type
 132 ///       Sync Only
 133 /// \~english @par Detail
 134 ///        The function convers the SI_32(signed 32bit) value to big-endian.
 135 /// \~english @see
 136 ////////////////////////////////////////////////////////////////////////////////////////////////
 137 SI_32 ConvertEndian_SI32(SI_32 f_value);  // NOLINT (readability/nolint)
 138
 139 ////////////////////////////////////////////////////////////////////////////////////////////////
 140 /// \ingroup NS_UtilityCenter
 141 /// \~english @par Brief
 142 ///       Convert the UI_64(unsigned 64bit) value to big-endian.
 143 /// \~english @param [in] f_value
 144 ///       UI_64 - The value to be converted
 145 /// \~english @retval the big-endian value of the input param f_value
 146 ///
 147 /// \~english @par Prerequisite
 148 ///       - NULL
 149 /// \~english @par Change of internal state
 150 ///       - NULL
 151 /// \~english @par Conditions of processing failure
 152 ///       - NULL
 153 /// \~english @par Classification
 154 ///       Public
 155 /// \~english @par Type
 156 ///       Sync Only
 157 /// \~english @par Detail
 158 ///        The function convers the UI_64(unsigned 64bit) value to big-endian.
 159 /// \~english @see
 160 ////////////////////////////////////////////////////////////////////////////////////////////////
 161 UI_64 ConvertEndian_UI64(UI_64 f_value);  // NOLINT (readability/nolint)
 162
 163 ////////////////////////////////////////////////////////////////////////////////////////////////
 164 /// \ingroup NS_UtilityCenter
 165 /// \~english @par Brief
 166 ///       Convert the SI_64(signed 64bit) value to big-endian.
 167 /// \~english @param [in] f_value
 168 ///       SI_64 - The value to be converted
 169 /// \~english @retval the big-endian value of the input param f_value
 170 ///
 171 /// \~english @par Prerequisite
 172 ///       - NULL
 173 /// \~english @par Change of internal state
 174 ///       - NULL
 175 /// \~english @par Conditions of processing failure
 176 ///       - NULL
 177 /// \~english @par Classification
 178 ///       Public
 179 /// \~english @par Type
 180 ///       Sync Only
 181 /// \~english @par Detail
 182 ///        The function convers the SI_64(signed 64bit) value to big-endian.
 183 /// \~english @see
 184 ////////////////////////////////////////////////////////////////////////////////////////////////
 185 SI_64 ConvertEndian_SI64(SI_64 f_value);  // NOLINT (readability/nolint)
 186
 187 #endif  // NS_NATIVESERVICES_INC_UTILITY_NS_ENDIANESS_H_  // NOLINT  (build/header_guard)
 188
 189 /** @}*/  // end of utility
 190 /** @}*/  // end of framework_unified
 191 /** @}*/  // end of native_service
 192 /** @}*/  // end of BaseSystem