service/other/posix_based_os001_legacy_library/library/include/other_service/PosixBasedOS001ClockCycleApi.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 #ifndef OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_CLOCK_CYCLE_API_H_  // NOLINT(build/header_guard)
  19 #define OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_CLOCK_CYCLE_API_H_  // NOLINT(build/header_guard)
  20
  21 #include <stdint.h>
  22
  23 /******************************************************************************/
  24 /* define */
  25
  26 /******************************************************************************/
  27 /* typedef */
  28
  29 /******************************************************************************/
  30 /* struct */
  31
  32
  33 /******************************************************************************/
  34 /* function */
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38 /**
  39  * @file PosixBasedOS001ClockCycleApi.h
  40  * @brief \~english This file provides ClockCycle API to get number of clock cycles.
  41  */
  42
  43 /** @addtogroup BaseSystem
  44  *  @{
  45  */
  46 /** @addtogroup other_service
  47  *  @ingroup BaseSystem
  48  *  @{
  49  */
  50 /** @addtogroup posix_based_os001_legacy_library
  51  *  @ingroup other_service
  52  *  @{
  53  */
  54
  55 /////////////////////////////////////////////////////////////////////////////////////
  56 /// \ingroup ClockCycle
  57 /// \~english @par Brief
  58 ///     Get the number of clock cycles.
  59 /// \~english @retval Microsecond
  60 /// \~english @par Prerequisite
  61 ///     None
  62 /// \~english @par Change of internal state
  63 ///     None
  64 /// \~english @par Conditions of processing failure
  65 ///     None
  66 /// \~english @par Classification
  67 ///     Public
  68 /// \~english @par Type
  69 ///     Sync
  70 /// \~english @par Detail
  71 ///     None
  72 /// \~english @see None
  73 ////////////////////////////////////////////////////////////////////////////////////
  74 uint64_t ClockCycle(void);
  75
  76 /** @}*/  // end of posix_based_os001_legacy_library
  77 /** @}*/  // end of other_service
  78 /** @}*/  // end of BaseSystem
  79 #ifdef __cplusplus
  80 }
  81 #endif
  82
  83 #endif  // OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_CLOCK_CYCLE_API_H_