uptime.h

Go to the documentation of this file.

/* Copyright 2015, 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 BSPACM_DEVICE_NRF51_INTERNAL_UTILITY_UPTIME_H
#define BSPACM_DEVICE_NRF51_INTERNAL_UTILITY_UPTIME_H

#include <bspacm/core.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#ifndef BSPACM_UPTIME_RTC_BASE

#define BSPACM_UPTIME_RTC_BASE NRF_RTC1_BASE
#endif /* BSPACM_UPTIME_RTC_BASE */

#if NRF_RTC0_BASE == BSPACM_UPTIME_RTC_BASE
#define BSPACM_UPTIME_RTC NRF_RTC0
#define BSPACM_UPTIME_CC_COUNT 3
#elif NRF_RTC1_BASE == BSPACM_UPTIME_RTC_BASE
#define BSPACM_UPTIME_RTC NRF_RTC1
#define BSPACM_UPTIME_CC_COUNT 4
#else /* BSPACM_UPTIME_RTC_BASE */
#error Unrecognized uptime RTC
#endif /* BSPACM_UPTIME_RTC_BASE */

#define BSPACM_UPTIME_Hz 32768U

#define BSPACM_UPTIME_SLEEP_MINIMUM 2

inline
unsigned int
uiBSPACMuptimeConvert_us_utt (unsigned int dur_us)
{
  const unsigned int us_per_s = 1000000U;
  return (dur_us * BSPACM_UPTIME_Hz + us_per_s - 1) / us_per_s;
}

inline
unsigned int
uiBSPACMuptimeConvert_ms_utt (unsigned int dur_ms)
{
  const unsigned int ms_per_s = 1000U;
  return (dur_ms * BSPACM_UPTIME_Hz + ms_per_s - 1) / ms_per_s;
}

inline
unsigned int
uiBSPACMuptimeConvert_utt_us (unsigned int dur_utt)
{
  return ((1000000ULL * dur_utt) + BSPACM_UPTIME_Hz - 1) / BSPACM_UPTIME_Hz;
}

inline
unsigned int
uiBSPACMuptimeConvert_utt_ms (unsigned int dur_utt)
{
  return ((1000ULL * dur_utt) + BSPACM_UPTIME_Hz - 1) / BSPACM_UPTIME_Hz;
}

/* Forward declaration */
struct sBSPACMuptimeAlarm;

typedef void (* vBSPACMuptimeAlarmCallback_flih) (int ccidx,
                                                  struct sBSPACMuptimeAlarm * ap);

typedef struct sBSPACMuptimeAlarm {
  vBSPACMuptimeAlarmCallback_flih callback_flih;

  unsigned int interval_utt;
} sBSPACMuptimeAlarm;

typedef sBSPACMuptimeAlarm * hBSPACMuptimeAlarm;

typedef struct sBSPACMuptimeState {
  volatile unsigned int overflows;

  unsigned int last_overflows;

  hBSPACMuptimeAlarm volatile alarm[BSPACM_UPTIME_CC_COUNT];

  bool enabled;
} sBSPACMuptimeState;

/* This doesn't exist. */
extern sBSPACMuptimeState xBSPACMuptimeState_;
int
iBSPACMuptimeAlarmSet (int ccidx,
                       unsigned int when_utt,
                       hBSPACMuptimeAlarm ap);

hBSPACMuptimeAlarm
hBSPACMuptimeAlarmClear (int ccidx,
                         bool * pendingp);

inline
unsigned long long
ullBSPACMuptime ()
{
  unsigned int prev_ofl;
  unsigned int ctr24;

  /* Get a consistent pair of counter and overflow values */
  do {
    prev_ofl = xBSPACMuptimeState_.last_overflows;
    ctr24 = BSPACM_UPTIME_RTC->COUNTER;
    xBSPACMuptimeState_.last_overflows = xBSPACMuptimeState_.overflows;
  } while (prev_ofl != xBSPACMuptimeState_.last_overflows);
  return (((uint64_t)xBSPACMuptimeState_.last_overflows) << 24) | ctr24;
}

inline
unsigned int
uiBSPACMuptime ()
{
  return ullBSPACMuptime();
}

void
vBSPACMuptimeStart ();

inline
bool
bBSPACMuptimeEnabled ()
{
  return xBSPACMuptimeState_.enabled;
}

void
vBSPACMuptimeSleepCancel (void);

bool
bBSPACMuptimeSleep (unsigned int duration_utt);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* BSPACM_DEVICE_NRF51_INTERNAL_UTILITY_UPTIME_H */