uptime.h

Go to the documentation of this file.

/* Copyright 2012-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the software nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BSP430_UTILITY_UPTIME_H
#define BSP430_UTILITY_UPTIME_H

#include <bsp430/periph/timer.h>
#include <bsp430/clock.h>

#ifndef configBSP430_UPTIME
#define configBSP430_UPTIME 0
#endif /* configBSP430_UPTIME */

#if defined(BSP430_DOXYGEN)
#define BSP430_UPTIME include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

#ifndef configBSP430_UPTIME_EPOCH
#define configBSP430_UPTIME_EPOCH 0
#endif /* configBSP430_UPTIME_EPOCH */

#ifndef configBSP430_UPTIME_DELAY
#define configBSP430_UPTIME_DELAY 0
#endif /* configBSP430_UPTIME_DELAY */

#if defined(BSP430_DOXYGEN)
#define BSP430_UPTIME_TIMER_PERIPH_CPPID include "bsp430_config.h"
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN)
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE platform or application specific
/* !BSP430! instance=@timers functional=uptime_timer subst=functional insert=periph_sethandle */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [periph_sethandle] */

#elif BSP430_UPTIME_TIMER_PERIPH_CPPID == BSP430_PERIPH_CPPID_TA0
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE BSP430_PERIPH_TA0

#elif BSP430_UPTIME_TIMER_PERIPH_CPPID == BSP430_PERIPH_CPPID_TA1
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE BSP430_PERIPH_TA1

#elif BSP430_UPTIME_TIMER_PERIPH_CPPID == BSP430_PERIPH_CPPID_TA2
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE BSP430_PERIPH_TA2

#elif BSP430_UPTIME_TIMER_PERIPH_CPPID == BSP430_PERIPH_CPPID_TA3
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE BSP430_PERIPH_TA3

#elif BSP430_UPTIME_TIMER_PERIPH_CPPID == BSP430_PERIPH_CPPID_TB0
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE BSP430_PERIPH_TB0

#elif BSP430_UPTIME_TIMER_PERIPH_CPPID == BSP430_PERIPH_CPPID_TB1
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE BSP430_PERIPH_TB1

#elif BSP430_UPTIME_TIMER_PERIPH_CPPID == BSP430_PERIPH_CPPID_TB2
#define BSP430_UPTIME_TIMER_PERIPH_HANDLE BSP430_PERIPH_TB2
/* END AUTOMATICALLY GENERATED CODE [periph_sethandle] */
/* !BSP430! end=periph_sethandle */
#endif /* BSP430_UPTIME_TIMER_PERIPH_CPPID */

#if defined(BSP430_DOXYGEN)
#define configBSP430_UPTIME_TIMER_HAL_CC0_ISR indirectly defaulted
#endif /* BSP430_DOXYGEN */

#ifndef BSP430_UPTIME_TASSEL
#define BSP430_UPTIME_TASSEL TASSEL_1 /* == TASSEL__ACLK */
#endif /* BSP430_UPTIME_TASSEL */

#ifndef BSP430_UPTIME_DIVIDING_SHIFT
#define BSP430_UPTIME_DIVIDING_SHIFT 0
#endif /* BSP430_UPTIME_DIVIDING_SHIFT */

extern hBSP430halTIMER xBSP430uptimeTIMER_;
#if defined(BSP430_DOXYGEN) || (BSP430_UPTIME - 0)
static BSP430_CORE_INLINE
hBSP430halTIMER
hBSP430uptimeTimer (void)
{
  return xBSP430uptimeTIMER_;
}
#endif /* DOXYGEN or function available */

#if (BSP430_UPTIME - 0)

extern unsigned long ulBSP430uptimeConversionFrequency_Hz_ni_;
#endif /* BSP430_UPTIME */

unsigned long ulBSP430uptimeConversionFrequency_Hz (void);

unsigned long ulBSP430uptimeSetConversionFrequency_ni (unsigned long frequency_Hz);

#if defined(BSP430_DOXYGEN) || (BSP430_UPTIME - 0)

#define BSP430_UPTIME_MS_TO_UTT(ms_) BSP430_CORE_MS_TO_TICKS((ms_), ulBSP430uptimeConversionFrequency_Hz())

#define BSP430_UPTIME_UTT_TO_MS(utt_) BSP430_CORE_TICKS_TO_MS((utt_), ulBSP430uptimeConversionFrequency_Hz())

#define BSP430_UPTIME_US_TO_UTT(us_) BSP430_CORE_US_TO_TICKS((us_), ulBSP430uptimeConversionFrequency_Hz())

#define BSP430_UPTIME_UTT_TO_US(utt_) BSP430_CORE_TICKS_TO_US((utt_), ulBSP430uptimeConversionFrequency_Hz())
#endif /* BSP430_UPTIME */

#if defined(BSP430_DOXYGEN) || (BSP430_UPTIME - 0)

static BSP430_CORE_INLINE
unsigned long
ulBSP430uptime_ni (void)
{
  return ulBSP430timerCounter_ni(hBSP430uptimeTimer(), 0);
}

static BSP430_CORE_INLINE
unsigned long
ulBSP430uptime (void)
{
  return ulBSP430timerCounter(hBSP430uptimeTimer(), 0);
}

static BSP430_CORE_INLINE
unsigned long long
ullBSP430uptime (void)
{
  BSP430_CORE_SAVED_INTERRUPT_STATE(istate);
  unsigned int overflow;
  unsigned long ul;

  BSP430_CORE_DISABLE_INTERRUPT();
  do {
    ul = ulBSP430timerCounter_ni(hBSP430uptimeTimer(), &overflow);
  } while (0);
  BSP430_CORE_RESTORE_INTERRUPT_STATE(istate);
  return (((unsigned long long)overflow) << (8 * sizeof(ul))) | ul;
}

static BSP430_CORE_INLINE
unsigned long long
ullBSP430uptimeCorrected (unsigned int ctr)
{
  return ullBSP430timerCorrected(hBSP430uptimeTimer(), ctr);
}

static BSP430_CORE_INLINE
unsigned int
uiBSP430uptimeCounter_ni (void)
{
  hBSP430halTIMER utp = hBSP430uptimeTimer();
  return uiBSP430timerBestCounterRead_ni(utp->hpl, utp->hal_state.flags);
}

#endif /* BSP430_UPTIME */

static BSP430_CORE_INLINE
bool bBSP430uptimeIsValid (unsigned long duration_utt)
{
  return (0 != duration_utt) && (~0UL != duration_utt);
}

static BSP430_CORE_INLINE
unsigned long ulBSP430uptimeValidated (unsigned long duration_utt)
{
  if (! bBSP430uptimeIsValid(duration_utt)) {
    duration_utt ^= 1;
  }
  return duration_utt;
}

void vBSP430uptimeStart_ni (void);

void vBSP430uptimeSuspend_ni (void);

void vBSP430uptimeResume_ni (void);

#define BSP430_UPTIME_AS_TEXT_LENGTH sizeof("HHH:MM:SS.mmm")

const char * xBSP430uptimeAsText (unsigned long duration_utt,
                                  char * buffer);

const char * xBSP430uptimeAsText_ni (unsigned long duration_utt);

unsigned int uiBSP430uptimeScaleForDisplay (unsigned long long duration_utt,
                                            const char ** unitp);


typedef struct sBSP430uptimeActivityTotals {
  unsigned long long awake_utt;
  unsigned long long sleep_utt;
  unsigned long sleeps;
  unsigned long last_wake_utt;
  unsigned long last_sleep_utt;
} sBSP430uptimeActivityTotals;

void vBSP430uptimeActivityReset (sBSP430uptimeActivityTotals * sp,
                                 bool from_now);

#if defined(BSP430_DOXYGEN) || (BSP430_UPTIME - 0)

static BSP430_CORE_INLINE
void vBSP430uptimeActivityStartSleep_ni (sBSP430uptimeActivityTotals * sp)
{
  sp->sleep_utt += sp->last_wake_utt - sp->last_sleep_utt;
  sp->last_sleep_utt = ulBSP430uptime_ni();
  sp->awake_utt += sp->last_sleep_utt - sp->last_wake_utt;
  sp->sleeps += 1;
}

static BSP430_CORE_INLINE
void vBSP430uptimeActivityStartActive_ni (sBSP430uptimeActivityTotals * sp)
{
  sp->last_wake_utt = ulBSP430uptime_ni();
}

#endif /* BSP430_UPTIME */

static BSP430_CORE_INLINE
unsigned int uiBSP430uptimeActivity_ppt (sBSP430uptimeActivityTotals * sp)
{
  unsigned long long period_tck = sp->awake_utt + sp->sleep_utt;
  unsigned int duty_ppt = 0;
  if (0 < period_tck) {
    duty_ppt = (1000 * sp->awake_utt + (period_tck / 2)) / period_tck;
  }
  return duty_ppt;
}

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_DELAY - 0)
#ifndef BSP430_UPTIME_DELAY_CCIDX
#define BSP430_UPTIME_DELAY_CCIDX 1
#endif /* BSP430_UPTIME_DELAY_CCIDX */
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_DELAY - 0)
long lBSP430uptimeSleepUntil (unsigned long setting_utt,
                              unsigned int lpm_bits);
#endif /* configBSP430_UPTIME_DELAY */

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_DELAY - 0)
int iBSP430uptimeDelaySetEnabled_ni (int enablep);
#endif /* configBSP430_UPTIME_DELAY */

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_DELAY - 0)
#define BSP430_UPTIME_DELAY_UTT_NI(delay_utt_, lpm_bits_, exit_expr_) do { \
    unsigned long wake_utt;                                             \
    wake_utt = ulBSP430uptime_ni() + (delay_utt_);                      \
    while ((! (exit_expr_)) && (0 < lBSP430uptimeSleepUntil(wake_utt, lpm_bits_))) { \
      /* nop */                                                         \
    }                                                                   \
  } while (0)
#endif /* configBSP430_UPTIME_DELAY */

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_DELAY - 0)
#define BSP430_UPTIME_DELAY_UTT(delay_utt_, lpm_bits_, exit_expr_) do { \
    BSP430_CORE_SAVED_INTERRUPT_STATE(istate);                          \
    BSP430_CORE_DISABLE_INTERRUPT();                                    \
    BSP430_UPTIME_DELAY_UTT_NI(BSP430_UPTIME_UTT_TO_UTT(delay_utt_), lpm_bits_, exit_expr_); \
    BSP430_CORE_RESTORE_INTERRUPT_STATE(istate);                        \
  } while (0)
#endif /* configBSP430_UPTIME_DELAY */

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_DELAY - 0)
#define BSP430_UPTIME_DELAY_MS_NI(delay_ms_, lpm_bits_, exit_expr_) do { \
    BSP430_UPTIME_DELAY_UTT_NI(BSP430_UPTIME_MS_TO_UTT(delay_ms_), lpm_bits_, exit_expr_); \
  } while (0)
#endif /* configBSP430_UPTIME_DELAY */

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_DELAY - 0)
#define BSP430_UPTIME_DELAY_MS(delay_ms_, lpm_bits_, exit_expr_) do {   \
    BSP430_CORE_SAVED_INTERRUPT_STATE(istate);                          \
    BSP430_CORE_DISABLE_INTERRUPT();                                    \
    BSP430_UPTIME_DELAY_UTT_NI(BSP430_UPTIME_MS_TO_UTT(delay_ms_), lpm_bits_, exit_expr_); \
    BSP430_CORE_RESTORE_INTERRUPT_STATE(istate);                        \
  } while (0)
#endif /* configBSP430_UPTIME_DELAY */

#if defined(BSP430_DOXYGEN) || (configBSP430_UPTIME_EPOCH - 0)

#include <sys/time.h>

#define BSP430_UPTIME_POSIX_EPOCH_NTPIS 2208988800UL

#define BSP430_UPTIME_BYPASS_EPOCH_NTP ((uint64_t)(BSP430_UPTIME_POSIX_EPOCH_NTPIS + 1388534400UL) << 32)

typedef struct sBSP430uptimeNTPShortFormat {
  uint16_t integral;            
  uint16_t fractional;          
} sBSP430uptimeNTPShortFormat;

typedef struct sBSP430uptimeNTPTimestamp {
  uint32_t integral;            
  uint32_t fractional;          
} sBSP430uptimeNTPTimestamp;

typedef struct sBSP430uptimeNTPPacketHeader {
  uint8_t li_vn_mode;          
  uint8_t stratum;             
  uint8_t ppoll;               
  int8_t precision;            
  sBSP430uptimeNTPShortFormat rootdelay; 
  sBSP430uptimeNTPShortFormat rootdisp;  
  uint32_t refid;              
  sBSP430uptimeNTPTimestamp reftime; 
  sBSP430uptimeNTPTimestamp org;     
  sBSP430uptimeNTPTimestamp rec;     
  sBSP430uptimeNTPTimestamp xmt;     
} sBSP430uptimeNTPPacketHeader;

int iBSP430uptimeCheckEpochValidity ();

unsigned long ulBSP430uptimeLastEpochUpdate ();

long lBSP430uptimeEpochAge ();

#define BSP430_UPTIME_EPOCH_UPDATE_INTERVAL_UTT 0x40000000L

#define BSP430_UPTIME_EPOCH_VALID_OFFSET_UTT 0x60000000L

int iBSP430uptimeEpochEra (unsigned long time_utt);

int iBSP430uptimeInitializeNTPRequest (sBSP430uptimeNTPPacketHeader * ntpp);

int iBSP430uptimeSetNTPXmtField (sBSP430uptimeNTPPacketHeader * ntpp,
                                 unsigned long * putt);

int iBSP430uptimeSetEpochFromNTP (uint64_t epoch_ntp);

int iBSP430uptimeAdjustEpochFromNTP (int64_t adjustment_ntp);

int iBSP430uptimeSetEpochFromTimeval (const struct timeval * tv,
                                      unsigned long when_utt);

int iBSP430uptimeAsNTP (unsigned long utt,
                        uint64_t * ntpp,
                        int bypass_validation);

int iBSP430uptimeAsTimeval (unsigned long utt,
                            struct timeval * tv);

time_t xBSP430uptimeAsPOSIXTime (unsigned long utt);

int iBSP430uptimeProcessNTPResponse (const sBSP430uptimeNTPPacketHeader * req,
                                     const sBSP430uptimeNTPPacketHeader * resp,
                                     uint64_t rec_ntp,
                                     int64_t * adjustment_ntp,
                                     long * adjustment_ms,
                                     unsigned long * rtt_us);

#endif /* configBSP430_UPTIME_EPOCH */

#endif /* BSP430_UTILITY_UPTIME_H */