clocksource: allow usage independent of timekeeping.c

So far struct clocksource acted as the interface between time/timekeeping.c
and hardware. This patch generalizes the concept so that a similar
interface can also be used in other contexts. For that it introduces
new structures and related functions *without* touching the existing
struct clocksource.

The reasons for adding these new structures to clocksource.[ch] are
* the APIs are clearly related
* struct clocksource could be cleaned up to use the new structs
* avoids proliferation of files with similar names (timesource.h?
  timecounter.h?)

As outlined in the discussion with John Stultz, this patch adds
* struct cyclecounter: stateless API to hardware which counts clock cycles
* struct timecounter: stateful utility code built on a cyclecounter which
  provides a nanosecond counter
* only the function to read the nanosecond counter; deltas are used internally
  and not exposed to users of timecounter

The code does no locking of the shared state. It must be called at least
as often as the cycle counter wraps around to detect these wrap arounds.
Both is the responsibility of the timecounter user.

Acked-by: John Stultz <johnstul@us.ibm.com>
Signed-off-by: Patrick Ohly <patrick.ohly@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

1 files changed, 101 insertions, 0 deletions

diff --git a/include/linux/clocksource.h b/include/linux/clocksource.h
index f88d32f8ff7c..573819ef4cc0 100644
--- a/include/linux/clocksource.h
+++ b/include/linux/clocksource.h
@@ -22,8 +22,109 @@ typedef u64 cycle_t;
 struct clocksource;
 
 /**
+ * struct cyclecounter - hardware abstraction for a free running counter
+ *      Provides completely state-free accessors to the underlying hardware.
+ *      Depending on which hardware it reads, the cycle counter may wrap
+ *      around quickly. Locking rules (if necessary) have to be defined
+ *      by the implementor and user of specific instances of this API.
+ *
+ * @read:               returns the current cycle value
+ * @mask:               bitmask for two's complement
+ *                      subtraction of non 64 bit counters,
+ *                      see CLOCKSOURCE_MASK() helper macro
+ * @mult:               cycle to nanosecond multiplier
+ * @shift:              cycle to nanosecond divisor (power of two)
+ */
+struct cyclecounter {
+        cycle_t (*read)(const struct cyclecounter *cc);
+        cycle_t mask;
+        u32 mult;
+        u32 shift;
+};
+
+/**
+ * struct timecounter - layer above a %struct cyclecounter which counts nanoseconds
+ *      Contains the state needed by timecounter_read() to detect
+ *      cycle counter wrap around. Initialize with
+ *      timecounter_init(). Also used to convert cycle counts into the
+ *      corresponding nanosecond counts with timecounter_cyc2time(). Users
+ *      of this code are responsible for initializing the underlying
+ *      cycle counter hardware, locking issues and reading the time
+ *      more often than the cycle counter wraps around. The nanosecond
+ *      counter will only wrap around after ~585 years.
+ *
+ * @cc:                 the cycle counter used by this instance
+ * @cycle_last:         most recent cycle counter value seen by
+ *                      timecounter_read()
+ * @nsec:               continuously increasing count
+ */
+struct timecounter {
+        const struct cyclecounter *cc;
+        cycle_t cycle_last;
+        u64 nsec;
+};
+
+/**
+ * cyclecounter_cyc2ns - converts cycle counter cycles to nanoseconds
+ * @tc:         Pointer to cycle counter.
+ * @cycles:     Cycles
+ *
+ * XXX - This could use some mult_lxl_ll() asm optimization. Same code
+ * as in cyc2ns, but with unsigned result.
+ */
+static inline u64 cyclecounter_cyc2ns(const struct cyclecounter *cc,
+                                      cycle_t cycles)
+{
+        u64 ret = (u64)cycles;
+        ret = (ret * cc->mult) >> cc->shift;
+        return ret;
+}
+
+/**
+ * timecounter_init - initialize a time counter
+ * @tc:                 Pointer to time counter which is to be initialized/reset
+ * @cc:                 A cycle counter, ready to be used.
+ * @start_tstamp:       Arbitrary initial time stamp.
+ *
+ * After this call the current cycle register (roughly) corresponds to
+ * the initial time stamp. Every call to timecounter_read() increments
+ * the time stamp counter by the number of elapsed nanoseconds.
+ */
+extern void timecounter_init(struct timecounter *tc,
+                             const struct cyclecounter *cc,
+                             u64 start_tstamp);
+
+/**
+ * timecounter_read - return nanoseconds elapsed since timecounter_init()
+ *                    plus the initial time stamp
+ * @tc:          Pointer to time counter.
+ *
+ * In other words, keeps track of time since the same epoch as
+ * the function which generated the initial time stamp.
+ */
+extern u64 timecounter_read(struct timecounter *tc);
+
+/**
+ * timecounter_cyc2time - convert a cycle counter to same
+ *                        time base as values returned by
+ *                        timecounter_read()
+ * @tc:         Pointer to time counter.
+ * @cycle:      a value returned by tc->cc->read()
+ *
+ * Cycle counts that are converted correctly as long as they
+ * fall into the interval [-1/2 max cycle count, +1/2 max cycle count],
+ * with "max cycle count" == cs->mask+1.
+ *
+ * This allows conversion of cycle counter values which were generated
+ * in the past.
+ */
+extern u64 timecounter_cyc2time(struct timecounter *tc,
+                                cycle_t cycle_tstamp);
+
+/**
  * struct clocksource - hardware abstraction for a free running counter
  *      Provides mostly state-free accessors to the underlying hardware.
+ *      This is the structure used for system time.
  *
  * @name:               ptr to clocksource name
  * @list:               list head for registration