third_party/pigweed/repo/pw_chrono_threadx/public/pw_chrono_threadx/system_clock_config.h

   1 // Copyright 2020 The Pigweed Authors
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
   4 // use this file except in compliance with the License. You may obtain a copy of
   5 // the License at
   6 //
   7 //     https://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12 // License for the specific language governing permissions and limitations under
  13 // the License.
  14 #pragma once
  15
  16 #include "pw_chrono_threadx/config.h"
  17
  18 // ThreadX does not have an API to determine the tick rate/period, instead
  19 // require the user to specify this through the configuration.
  20 #define PW_CHRONO_SYSTEM_CLOCK_PERIOD_SECONDS_NUMERATOR \
  21   PW_CHRONO_THREADX_CFG_CLOCK_PERIOD_SECONDS_NUMERATOR
  22 #define PW_CHRONO_SYSTEM_CLOCK_PERIOD_SECONDS_DENOMINATOR \
  23   PW_CHRONO_THREADX_CFG_CLOCK_PERIOD_SECONDS_DENOMINATOR
  24
  25 #ifdef __cplusplus
  26
  27 #include "pw_chrono/epoch.h"
  28
  29 namespace pw::chrono::backend {
  30
  31 // The ThreadX clock starts at zero during initialization, approximately the
  32 // time since boot.
  33 constexpr inline Epoch kSystemClockEpoch = pw::chrono::Epoch::kTimeSinceBoot;
  34
  35 // The current backend implementation is not NMI safe.
  36 constexpr inline bool kSystemClockNmiSafe = false;
  37
  38 // The ThreadX clock halts when the systick interrupt is masked.
  39 constexpr inline bool kSystemClockFreeRunning = false;
  40
  41 }  // namespace pw::chrono::backend
  42
  43 #endif  // __cplusplus