blob: 9c78d15d33e4de979b3d70d6a569064aa5529048 [file] [log] [blame]
john stultz734efb42006-06-26 00:25:05 -07001/* linux/include/linux/clocksource.h
2 *
3 * This file contains the structure definitions for clocksources.
4 *
5 * If you are not a clocksource, or timekeeping code, you should
6 * not be including this file!
7 */
8#ifndef _LINUX_CLOCKSOURCE_H
9#define _LINUX_CLOCKSOURCE_H
10
11#include <linux/types.h>
12#include <linux/timex.h>
13#include <linux/time.h>
14#include <linux/list.h>
Eric Dumazet329c8d82007-05-08 00:27:57 -070015#include <linux/cache.h>
Thomas Gleixner5d8b34f2007-02-16 01:27:43 -080016#include <linux/timer.h>
Martin Schwidefskyf1b82742009-08-14 15:47:21 +020017#include <linux/init.h>
john stultz734efb42006-06-26 00:25:05 -070018#include <asm/div64.h>
19#include <asm/io.h>
20
Thomas Gleixner5d8b34f2007-02-16 01:27:43 -080021struct clocksource;
Thomas Gleixner09ac3692013-04-25 20:31:44 +000022struct module;
john stultz734efb42006-06-26 00:25:05 -070023
H. Peter Anvinae7bd112011-07-21 13:34:05 -070024#ifdef CONFIG_ARCH_CLOCKSOURCE_DATA
Andy Lutomirski433bd802011-07-13 09:24:13 -040025#include <asm/clocksource.h>
H. Peter Anvinae7bd112011-07-21 13:34:05 -070026#endif
Andy Lutomirski433bd802011-07-13 09:24:13 -040027
john stultz734efb42006-06-26 00:25:05 -070028/**
29 * struct clocksource - hardware abstraction for a free running counter
30 * Provides mostly state-free accessors to the underlying hardware.
Patrick Ohlya038a352009-02-12 05:03:34 +000031 * This is the structure used for system time.
john stultz734efb42006-06-26 00:25:05 -070032 *
33 * @name: ptr to clocksource name
34 * @list: list head for registration
35 * @rating: rating value for selection (higher is better)
36 * To avoid rating inflation the following
37 * list should give you a guide as to how
38 * to assign your clocksource a rating
39 * 1-99: Unfit for real use
40 * Only available for bootup and testing purposes.
41 * 100-199: Base level usability.
42 * Functional for real use, but not desired.
43 * 200-299: Good.
44 * A correct and usable clocksource.
45 * 300-399: Desired.
46 * A reasonably fast and accurate clocksource.
47 * 400-499: Perfect
48 * The ideal clocksource. A must-use where
49 * available.
Magnus Damm8e196082009-04-21 12:24:00 -070050 * @read: returns a cycle value, passes clocksource as argument
Magnus Damm4614e6a2009-04-21 12:24:02 -070051 * @enable: optional function to enable the clocksource
52 * @disable: optional function to disable the clocksource
john stultz734efb42006-06-26 00:25:05 -070053 * @mask: bitmask for two's complement
54 * subtraction of non 64 bit counters
Martin Schwidefsky0a544192009-08-14 15:47:28 +020055 * @mult: cycle to nanosecond multiplier
john stultz734efb42006-06-26 00:25:05 -070056 * @shift: cycle to nanosecond divisor (power of two)
Jon Hunter98962462009-08-18 12:45:10 -050057 * @max_idle_ns: max idle time permitted by the clocksource (nsecs)
Kusanagi Kouichib1b73d02011-12-19 18:13:19 +090058 * @maxadj: maximum adjustment value to mult (~11%)
Thomas Gleixner73b08d22007-02-16 01:27:36 -080059 * @flags: flags describing special properties
Andy Lutomirski433bd802011-07-13 09:24:13 -040060 * @archdata: arch-specific data
Magnus Dammc54a42b2010-02-02 14:41:41 -080061 * @suspend: suspend function for the clocksource, if necessary
Thomas Gleixnerb52f52a2007-05-09 02:35:15 -070062 * @resume: resume function for the clocksource, if necessary
Thomas Gleixner09ac3692013-04-25 20:31:44 +000063 * @owner: module reference, must be set by clocksource in modules
john stultz734efb42006-06-26 00:25:05 -070064 */
65struct clocksource {
Eric Dumazet329c8d82007-05-08 00:27:57 -070066 /*
Thomas Gleixner369db4c2011-05-18 21:33:40 +000067 * Hotpath data, fits in a single cache line when the
68 * clocksource itself is cacheline aligned.
Eric Dumazet329c8d82007-05-08 00:27:57 -070069 */
Magnus Damm8e196082009-04-21 12:24:00 -070070 cycle_t (*read)(struct clocksource *cs);
john stultz734efb42006-06-26 00:25:05 -070071 cycle_t mask;
72 u32 mult;
73 u32 shift;
Jon Hunter98962462009-08-18 12:45:10 -050074 u64 max_idle_ns;
John Stultzd65670a2011-10-31 17:06:35 -040075 u32 maxadj;
H. Peter Anvinae7bd112011-07-21 13:34:05 -070076#ifdef CONFIG_ARCH_CLOCKSOURCE_DATA
Andy Lutomirski433bd802011-07-13 09:24:13 -040077 struct arch_clocksource_data archdata;
Tony Luck0aa366f2007-07-20 11:22:30 -070078#endif
Andy Lutomirski433bd802011-07-13 09:24:13 -040079
Thomas Gleixner369db4c2011-05-18 21:33:40 +000080 const char *name;
81 struct list_head list;
82 int rating;
Thomas Gleixner369db4c2011-05-18 21:33:40 +000083 int (*enable)(struct clocksource *cs);
84 void (*disable)(struct clocksource *cs);
85 unsigned long flags;
86 void (*suspend)(struct clocksource *cs);
87 void (*resume)(struct clocksource *cs);
Thomas Gleixner5d8b34f2007-02-16 01:27:43 -080088
Kusanagi Kouichib1b73d02011-12-19 18:13:19 +090089 /* private: */
Thomas Gleixner5d8b34f2007-02-16 01:27:43 -080090#ifdef CONFIG_CLOCKSOURCE_WATCHDOG
91 /* Watchdog related data, used by the framework */
92 struct list_head wd_list;
Thomas Gleixnerb5199512011-06-16 16:22:08 +020093 cycle_t cs_last;
Thomas Gleixner5d8b34f2007-02-16 01:27:43 -080094 cycle_t wd_last;
95#endif
Thomas Gleixner09ac3692013-04-25 20:31:44 +000096 struct module *owner;
Thomas Gleixner369db4c2011-05-18 21:33:40 +000097} ____cacheline_aligned;
john stultz734efb42006-06-26 00:25:05 -070098
Thomas Gleixner73b08d22007-02-16 01:27:36 -080099/*
100 * Clock source flags bits::
101 */
Thomas Gleixner5d8b34f2007-02-16 01:27:43 -0800102#define CLOCK_SOURCE_IS_CONTINUOUS 0x01
103#define CLOCK_SOURCE_MUST_VERIFY 0x02
104
105#define CLOCK_SOURCE_WATCHDOG 0x10
106#define CLOCK_SOURCE_VALID_FOR_HRES 0x20
Martin Schwidefskyc55c87c2009-08-14 15:47:25 +0200107#define CLOCK_SOURCE_UNSTABLE 0x40
Feng Tang5caf4632013-03-12 11:56:46 +0800108#define CLOCK_SOURCE_SUSPEND_NONSTOP 0x80
Thomas Gleixner332962f2013-07-04 22:46:45 +0200109#define CLOCK_SOURCE_RESELECT 0x100
Thomas Gleixner73b08d22007-02-16 01:27:36 -0800110
Jim Cromie7f9f3032006-06-26 00:25:15 -0700111/* simplify initialization of mask field */
Atsushi Nemoto1d76c262008-01-30 13:30:01 +0100112#define CLOCKSOURCE_MASK(bits) (cycle_t)((bits) < 64 ? ((1ULL<<(bits))-1) : -1)
john stultz734efb42006-06-26 00:25:05 -0700113
114/**
115 * clocksource_khz2mult - calculates mult from khz and shift
116 * @khz: Clocksource frequency in KHz
117 * @shift_constant: Clocksource shift factor
118 *
119 * Helper functions that converts a khz counter frequency to a timsource
120 * multiplier, given the clocksource shift value
121 */
122static inline u32 clocksource_khz2mult(u32 khz, u32 shift_constant)
123{
124 /* khz = cyc/(Million ns)
125 * mult/2^shift = ns/cyc
126 * mult = ns/cyc * 2^shift
127 * mult = 1Million/khz * 2^shift
128 * mult = 1000000 * 2^shift / khz
129 * mult = (1000000<<shift) / khz
130 */
131 u64 tmp = ((u64)1000000) << shift_constant;
132
133 tmp += khz/2; /* round for do_div */
134 do_div(tmp, khz);
135
136 return (u32)tmp;
137}
138
139/**
140 * clocksource_hz2mult - calculates mult from hz and shift
141 * @hz: Clocksource frequency in Hz
142 * @shift_constant: Clocksource shift factor
143 *
144 * Helper functions that converts a hz counter
145 * frequency to a timsource multiplier, given the
146 * clocksource shift value
147 */
148static inline u32 clocksource_hz2mult(u32 hz, u32 shift_constant)
149{
150 /* hz = cyc/(Billion ns)
151 * mult/2^shift = ns/cyc
152 * mult = ns/cyc * 2^shift
153 * mult = 1Billion/hz * 2^shift
154 * mult = 1000000000 * 2^shift / hz
155 * mult = (1000000000<<shift) / hz
156 */
157 u64 tmp = ((u64)1000000000) << shift_constant;
158
159 tmp += hz/2; /* round for do_div */
160 do_div(tmp, hz);
161
162 return (u32)tmp;
163}
164
165/**
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200166 * clocksource_cyc2ns - converts clocksource cycles to nanoseconds
Kusanagi Kouichib1b73d02011-12-19 18:13:19 +0900167 * @cycles: cycles
168 * @mult: cycle to nanosecond multiplier
169 * @shift: cycle to nanosecond divisor (power of two)
john stultz734efb42006-06-26 00:25:05 -0700170 *
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200171 * Converts cycles to nanoseconds, using the given mult and shift.
john stultz734efb42006-06-26 00:25:05 -0700172 *
173 * XXX - This could use some mult_lxl_ll() asm optimization
174 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200175static inline s64 clocksource_cyc2ns(cycle_t cycles, u32 mult, u32 shift)
john stultz734efb42006-06-26 00:25:05 -0700176{
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200177 return ((u64) cycles * mult) >> shift;
john stultz5eb6d202006-06-26 00:25:07 -0700178}
179
180
Thomas Gleixner92c7e002007-02-16 01:27:33 -0800181extern int clocksource_register(struct clocksource*);
Thomas Gleixnera89c7ed2013-04-25 20:31:46 +0000182extern int clocksource_unregister(struct clocksource*);
Jason Wessel7c3078b2008-02-15 14:55:54 -0600183extern void clocksource_touch_watchdog(void);
Thomas Gleixner92c7e002007-02-16 01:27:33 -0800184extern struct clocksource* clocksource_get_next(void);
185extern void clocksource_change_rating(struct clocksource *cs, int rating);
Magnus Dammc54a42b2010-02-02 14:41:41 -0800186extern void clocksource_suspend(void);
Thomas Gleixnerb52f52a2007-05-09 02:35:15 -0700187extern void clocksource_resume(void);
Bjorn Helgaas96a2adb2014-10-13 18:59:09 -0600188extern struct clocksource * __init clocksource_default_clock(void);
Thomas Gleixner7285dd72009-08-28 20:25:24 +0200189extern void clocksource_mark_unstable(struct clocksource *cs);
john stultz734efb42006-06-26 00:25:05 -0700190
Stephen Boyd87d8b9e2013-07-18 16:21:14 -0700191extern u64
192clocks_calc_max_nsecs(u32 mult, u32 shift, u32 maxadj, u64 mask);
Thomas Gleixner7d2f9442009-11-11 14:05:29 +0000193extern void
194clocks_calc_mult_shift(u32 *mult, u32 *shift, u32 from, u32 to, u32 minsec);
195
John Stultzd7e81c22010-05-07 18:07:38 -0700196/*
197 * Don't call __clocksource_register_scale directly, use
198 * clocksource_register_hz/khz
199 */
200extern int
201__clocksource_register_scale(struct clocksource *cs, u32 scale, u32 freq);
John Stultz852db462010-07-13 17:56:28 -0700202extern void
203__clocksource_updatefreq_scale(struct clocksource *cs, u32 scale, u32 freq);
John Stultzd7e81c22010-05-07 18:07:38 -0700204
205static inline int clocksource_register_hz(struct clocksource *cs, u32 hz)
206{
207 return __clocksource_register_scale(cs, 1, hz);
208}
209
210static inline int clocksource_register_khz(struct clocksource *cs, u32 khz)
211{
212 return __clocksource_register_scale(cs, 1000, khz);
213}
214
John Stultz852db462010-07-13 17:56:28 -0700215static inline void __clocksource_updatefreq_hz(struct clocksource *cs, u32 hz)
216{
217 __clocksource_updatefreq_scale(cs, 1, hz);
218}
219
220static inline void __clocksource_updatefreq_khz(struct clocksource *cs, u32 khz)
221{
222 __clocksource_updatefreq_scale(cs, 1000, khz);
223}
John Stultzd7e81c22010-05-07 18:07:38 -0700224
john stultzacc9a9d2007-02-16 01:28:17 -0800225
Thomas Gleixnerba919d12013-04-25 20:31:44 +0000226extern int timekeeping_notify(struct clocksource *clock);
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200227
Russell King442c8172011-05-08 14:06:52 +0100228extern cycle_t clocksource_mmio_readl_up(struct clocksource *);
229extern cycle_t clocksource_mmio_readl_down(struct clocksource *);
230extern cycle_t clocksource_mmio_readw_up(struct clocksource *);
231extern cycle_t clocksource_mmio_readw_down(struct clocksource *);
232
233extern int clocksource_mmio_init(void __iomem *, const char *,
234 unsigned long, int, unsigned, cycle_t (*)(struct clocksource *));
235
Russell King8c414ff2011-05-08 18:50:20 +0100236extern int clocksource_i8253_init(void);
237
Rob Herring54196cc2014-05-08 16:09:24 -0500238#define CLOCKSOURCE_OF_DECLARE(name, compat, fn) \
239 OF_DECLARE_1(clksrc, name, compat, fn)
240
Stephen Warrenae278a92012-11-19 16:41:20 -0700241#ifdef CONFIG_CLKSRC_OF
242extern void clocksource_of_init(void);
Stephen Warrene1d7ef12013-01-30 10:49:30 -0700243#else
Rob Herringe0c25362013-03-10 21:52:53 -0500244static inline void clocksource_of_init(void) {}
Stephen Warrenae278a92012-11-19 16:41:20 -0700245#endif
246
john stultz734efb42006-06-26 00:25:05 -0700247#endif /* _LINUX_CLOCKSOURCE_H */