rusefi/firmware/util/efitime.h

/**
 * @file efitime.h
 *
 * By the way, there are 86400000 milliseconds in a day
 *
 * @date Apr 14, 2014
 * @author Andrey Belomutskiy, (c) 2012-2020
 */

#pragma once

#include "efifeatures.h"
#include "rusefi_types.h"
#include "global.h"
#include "error_handling.h"
#include <rusefi/rusefi_time_math.h>
#include <limits.h>


#if EFI_PROD_CODE
// for US_TO_NT_MULTIPLIER which is port-specific
#include "port_mpu_util.h"
#endif

inline int time2print(int64_t time) {
  return static_cast<int>(time);
}

inline int32_t assertFloatFitsInto32BitsAndCast(const char *msg, float value) {
  if (value < INT_MIN || value > INT_MAX) {
    criticalError("%s value out of range: %f", msg, value);
  }
  return (int32_t)value;
}

inline /*64bit*/ efitick_t sumTickAndFloat(/*64bit*/efitick_t ticks, /*32bit*/float extra) {
  // we have a peculiar case of type compiler uses to evaluate expression vs precision here
  // we need 64 bit precision not (lower) float precision
  // 32 bits is 11 or 23 seconds if US_TO_NT_MULTIPLIER = 168 like on kinetis/cypress
  // 32 bits is 500 or 1000 seconds if US_TO_NT_MULTIPLIER = 4 like on stm32
  // 'extra' is below 10 seconds here so we use 32 bit type for performance reasons
  return ticks + (int32_t) extra;
}

// microseconds to ticks
// since only about 20 seconds of ticks fit in 32 bits this macro is casting parameter into 64 bits 'efitick_t' type
// please note that int64 <-> float is a heavy operation thus we have 'USF2NT' below
#define US2NT(us) (((efitick_t)(us)) * US_TO_NT_MULTIPLIER)

// milliseconds to ticks
#define MS2NT(msTime) US2NT(MS2US(msTime))
// See USF2NT above for when to use MSF2NT. ***WARNING*** please be aware of sumTickAndFloat
#define MSF2NT(msTimeFloat) USF2NT(MS2US(msTimeFloat))

/**
 * Get a monotonically increasing (but wrapping) 32-bit timer value
 * Implemented at port level, based on timer or CPU tick counter
 * Main source of EFI clock, SW-extended to 64bits
 *
 * 2147483648 / ~168MHz = ~12 seconds to overflow
 *
 */
uint32_t getTimeNowLowerNt();

/**
 * @brief   Returns the 32 bit number of milliseconds since the board initialization.
 */
efitimems_t getTimeNowMs();

/**
 * @brief   Current system time in seconds (32 bits)
 */
efitimesec_t getTimeNowS();

#if EFI_UNIT_TEST
void setTimeNowUs(int us);
void advanceTimeUs(int us);
#endif