Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 1 | /* linux/include/linux/clockchips.h |
| 2 | * |
| 3 | * This file contains the structure definitions for clockchips. |
| 4 | * |
| 5 | * If you are not a clockchip, or the time of day code, you should |
| 6 | * not be including this file! |
| 7 | */ |
| 8 | #ifndef _LINUX_CLOCKCHIPS_H |
| 9 | #define _LINUX_CLOCKCHIPS_H |
| 10 | |
Thomas Gleixner | 9f083b7 | 2015-03-25 13:05:19 +0100 | [diff] [blame] | 11 | #ifdef CONFIG_GENERIC_CLOCKEVENTS |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 12 | |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 13 | # include <linux/clocksource.h> |
| 14 | # include <linux/cpumask.h> |
| 15 | # include <linux/ktime.h> |
| 16 | # include <linux/notifier.h> |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 17 | |
| 18 | struct clock_event_device; |
Thomas Gleixner | ccf33d6 | 2013-04-25 20:31:49 +0000 | [diff] [blame] | 19 | struct module; |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 20 | |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 21 | /* Clock event mode commands for legacy ->set_mode(): OBSOLETE */ |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 22 | enum clock_event_mode { |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 23 | CLOCK_EVT_MODE_UNUSED, |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 24 | CLOCK_EVT_MODE_SHUTDOWN, |
| 25 | CLOCK_EVT_MODE_PERIODIC, |
| 26 | CLOCK_EVT_MODE_ONESHOT, |
Thomas Gleixner | 18de5bc | 2007-07-21 04:37:34 -0700 | [diff] [blame] | 27 | CLOCK_EVT_MODE_RESUME, |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 28 | }; |
Viresh Kumar | bd624d7 | 2015-02-13 08:54:56 +0800 | [diff] [blame] | 29 | |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 30 | /* |
| 31 | * Possible states of a clock event device. |
| 32 | * |
| 33 | * DETACHED: Device is not used by clockevents core. Initial state or can be |
| 34 | * reached from SHUTDOWN. |
| 35 | * SHUTDOWN: Device is powered-off. Can be reached from PERIODIC or ONESHOT. |
| 36 | * PERIODIC: Device is programmed to generate events periodically. Can be |
| 37 | * reached from DETACHED or SHUTDOWN. |
| 38 | * ONESHOT: Device is programmed to generate event only once. Can be reached |
| 39 | * from DETACHED or SHUTDOWN. |
| 40 | */ |
| 41 | enum clock_event_state { |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 42 | CLOCK_EVT_STATE_DETACHED, |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 43 | CLOCK_EVT_STATE_SHUTDOWN, |
| 44 | CLOCK_EVT_STATE_PERIODIC, |
| 45 | CLOCK_EVT_STATE_ONESHOT, |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 46 | }; |
| 47 | |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 48 | /* |
| 49 | * Clock event features |
| 50 | */ |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 51 | # define CLOCK_EVT_FEAT_PERIODIC 0x000001 |
| 52 | # define CLOCK_EVT_FEAT_ONESHOT 0x000002 |
| 53 | # define CLOCK_EVT_FEAT_KTIME 0x000004 |
| 54 | |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 55 | /* |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 56 | * x86(64) specific (mis)features: |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 57 | * |
| 58 | * - Clockevent source stops in C3 State and needs broadcast support. |
| 59 | * - Local APIC timer is used as a dummy device. |
| 60 | */ |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 61 | # define CLOCK_EVT_FEAT_C3STOP 0x000008 |
| 62 | # define CLOCK_EVT_FEAT_DUMMY 0x000010 |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 63 | |
Daniel Lezcano | d2348fb | 2013-03-02 11:10:11 +0100 | [diff] [blame] | 64 | /* |
| 65 | * Core shall set the interrupt affinity dynamically in broadcast mode |
| 66 | */ |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 67 | # define CLOCK_EVT_FEAT_DYNIRQ 0x000020 |
| 68 | # define CLOCK_EVT_FEAT_PERCPU 0x000040 |
Daniel Lezcano | d2348fb | 2013-03-02 11:10:11 +0100 | [diff] [blame] | 69 | |
Preeti U Murthy | 5d1638a | 2014-02-07 13:36:32 +0530 | [diff] [blame] | 70 | /* |
| 71 | * Clockevent device is based on a hrtimer for broadcast |
| 72 | */ |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 73 | # define CLOCK_EVT_FEAT_HRTIMER 0x000080 |
Preeti U Murthy | 5d1638a | 2014-02-07 13:36:32 +0530 | [diff] [blame] | 74 | |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 75 | /** |
| 76 | * struct clock_event_device - clock event device descriptor |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 77 | * @event_handler: Assigned by the framework to be called by the low |
| 78 | * level handler of the event source |
Martin Schwidefsky | 65516f8 | 2011-08-23 15:29:43 +0200 | [diff] [blame] | 79 | * @set_next_event: set next event function using a clocksource delta |
| 80 | * @set_next_ktime: set next event function using a direct ktime value |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 81 | * @next_event: local storage for the next event in oneshot mode |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 82 | * @max_delta_ns: maximum delta value in ns |
| 83 | * @min_delta_ns: minimum delta value in ns |
| 84 | * @mult: nanosecond to cycles multiplier |
| 85 | * @shift: nanoseconds to cycles divisor (power of two) |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 86 | * @mode: operating mode, relevant only to ->set_mode(), OBSOLETE |
| 87 | * @state: current state of the device, assigned by the core code |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 88 | * @features: features |
| 89 | * @retries: number of forced programming retries |
Viresh Kumar | bd624d7 | 2015-02-13 08:54:56 +0800 | [diff] [blame] | 90 | * @set_mode: legacy set mode function, only for modes <= CLOCK_EVT_MODE_RESUME. |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 91 | * @set_state_periodic: switch state to periodic, if !set_mode |
| 92 | * @set_state_oneshot: switch state to oneshot, if !set_mode |
| 93 | * @set_state_shutdown: switch state to shutdown, if !set_mode |
Viresh Kumar | 554ef38 | 2015-02-27 17:21:32 +0530 | [diff] [blame] | 94 | * @tick_resume: resume clkevt device, if !set_mode |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 95 | * @broadcast: function to broadcast events |
Thomas Gleixner | 57f0fcb | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 96 | * @min_delta_ticks: minimum delta value in ticks stored for reconfiguration |
| 97 | * @max_delta_ticks: maximum delta value in ticks stored for reconfiguration |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 98 | * @name: ptr to clock event name |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 99 | * @rating: variable to rate clock event devices |
Sergei Shtylyov | ce0be12 | 2007-05-08 00:31:55 -0700 | [diff] [blame] | 100 | * @irq: IRQ number (only for non CPU local devices) |
Preeti U Murthy | 5d1638a | 2014-02-07 13:36:32 +0530 | [diff] [blame] | 101 | * @bound_on: Bound on CPU |
Sergei Shtylyov | ce0be12 | 2007-05-08 00:31:55 -0700 | [diff] [blame] | 102 | * @cpumask: cpumask to indicate for which CPUs this device works |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 103 | * @list: list head for the management code |
Thomas Gleixner | ccf33d6 | 2013-04-25 20:31:49 +0000 | [diff] [blame] | 104 | * @owner: module reference |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 105 | */ |
| 106 | struct clock_event_device { |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 107 | void (*event_handler)(struct clock_event_device *); |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 108 | int (*set_next_event)(unsigned long evt, struct clock_event_device *); |
| 109 | int (*set_next_ktime)(ktime_t expires, struct clock_event_device *); |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 110 | ktime_t next_event; |
Jon Hunter | 97813f2 | 2009-08-18 12:45:11 -0500 | [diff] [blame] | 111 | u64 max_delta_ns; |
| 112 | u64 min_delta_ns; |
Thomas Gleixner | 23af368 | 2009-11-11 14:05:25 +0000 | [diff] [blame] | 113 | u32 mult; |
| 114 | u32 shift; |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 115 | enum clock_event_mode mode; |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 116 | enum clock_event_state state; |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 117 | unsigned int features; |
| 118 | unsigned long retries; |
| 119 | |
Viresh Kumar | bd624d7 | 2015-02-13 08:54:56 +0800 | [diff] [blame] | 120 | /* |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 121 | * State transition callback(s): Only one of the two groups should be |
Viresh Kumar | bd624d7 | 2015-02-13 08:54:56 +0800 | [diff] [blame] | 122 | * defined: |
| 123 | * - set_mode(), only for modes <= CLOCK_EVT_MODE_RESUME. |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 124 | * - set_state_{shutdown|periodic|oneshot}(), tick_resume(). |
Viresh Kumar | bd624d7 | 2015-02-13 08:54:56 +0800 | [diff] [blame] | 125 | */ |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 126 | void (*set_mode)(enum clock_event_mode mode, struct clock_event_device *); |
Viresh Kumar | 77e32c8 | 2015-02-27 17:21:33 +0530 | [diff] [blame] | 127 | int (*set_state_periodic)(struct clock_event_device *); |
| 128 | int (*set_state_oneshot)(struct clock_event_device *); |
| 129 | int (*set_state_shutdown)(struct clock_event_device *); |
Viresh Kumar | 554ef38 | 2015-02-27 17:21:32 +0530 | [diff] [blame] | 130 | int (*tick_resume)(struct clock_event_device *); |
Viresh Kumar | bd624d7 | 2015-02-13 08:54:56 +0800 | [diff] [blame] | 131 | |
| 132 | void (*broadcast)(const struct cpumask *mask); |
Rafael J. Wysocki | adc78e6 | 2012-08-06 01:40:41 +0200 | [diff] [blame] | 133 | void (*suspend)(struct clock_event_device *); |
| 134 | void (*resume)(struct clock_event_device *); |
Thomas Gleixner | 57f0fcb | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 135 | unsigned long min_delta_ticks; |
| 136 | unsigned long max_delta_ticks; |
| 137 | |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 138 | const char *name; |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 139 | int rating; |
| 140 | int irq; |
Preeti U Murthy | 5d1638a | 2014-02-07 13:36:32 +0530 | [diff] [blame] | 141 | int bound_on; |
Rusty Russell | 320ab2b | 2008-12-13 21:20:26 +1030 | [diff] [blame] | 142 | const struct cpumask *cpumask; |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 143 | struct list_head list; |
Thomas Gleixner | ccf33d6 | 2013-04-25 20:31:49 +0000 | [diff] [blame] | 144 | struct module *owner; |
Thomas Gleixner | 847b2f4 | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 145 | } ____cacheline_aligned; |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 146 | |
| 147 | /* |
| 148 | * Calculate a multiplication factor for scaled math, which is used to convert |
| 149 | * nanoseconds based values to clock ticks: |
| 150 | * |
| 151 | * clock_ticks = (nanoseconds * factor) >> shift. |
| 152 | * |
| 153 | * div_sc is the rearranged equation to calculate a factor from a given clock |
| 154 | * ticks / nanoseconds ratio: |
| 155 | * |
| 156 | * factor = (clock_ticks << shift) / nanoseconds |
| 157 | */ |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 158 | static inline unsigned long |
| 159 | div_sc(unsigned long ticks, unsigned long nsec, int shift) |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 160 | { |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 161 | u64 tmp = ((u64)ticks) << shift; |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 162 | |
| 163 | do_div(tmp, nsec); |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 164 | |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 165 | return (unsigned long) tmp; |
| 166 | } |
| 167 | |
| 168 | /* Clock event layer functions */ |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 169 | extern u64 clockevent_delta2ns(unsigned long latch, struct clock_event_device *evt); |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 170 | extern void clockevents_register_device(struct clock_event_device *dev); |
Thomas Gleixner | 03e13cf | 2013-04-25 20:31:50 +0000 | [diff] [blame] | 171 | extern int clockevents_unbind_device(struct clock_event_device *ced, int cpu); |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 172 | |
Magnus Damm | e540032 | 2012-05-09 23:39:34 +0900 | [diff] [blame] | 173 | extern void clockevents_config(struct clock_event_device *dev, u32 freq); |
Thomas Gleixner | 57f0fcb | 2011-05-18 21:33:41 +0000 | [diff] [blame] | 174 | extern void clockevents_config_and_register(struct clock_event_device *dev, |
| 175 | u32 freq, unsigned long min_delta, |
| 176 | unsigned long max_delta); |
| 177 | |
Thomas Gleixner | 80b816b | 2011-05-18 21:33:42 +0000 | [diff] [blame] | 178 | extern int clockevents_update_freq(struct clock_event_device *ce, u32 freq); |
| 179 | |
Thomas Gleixner | 7d2f944 | 2009-11-11 14:05:29 +0000 | [diff] [blame] | 180 | static inline void |
| 181 | clockevents_calc_mult_shift(struct clock_event_device *ce, u32 freq, u32 minsec) |
| 182 | { |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 183 | return clocks_calc_mult_shift(&ce->mult, &ce->shift, NSEC_PER_SEC, freq, minsec); |
Thomas Gleixner | 7d2f944 | 2009-11-11 14:05:29 +0000 | [diff] [blame] | 184 | } |
| 185 | |
Rafael J. Wysocki | adc78e6 | 2012-08-06 01:40:41 +0200 | [diff] [blame] | 186 | extern void clockevents_suspend(void); |
| 187 | extern void clockevents_resume(void); |
| 188 | |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 189 | # ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST |
| 190 | # ifdef CONFIG_ARCH_HAS_TICK_BROADCAST |
Mark Rutland | 12ad100 | 2013-01-14 17:05:22 +0000 | [diff] [blame] | 191 | extern void tick_broadcast(const struct cpumask *mask); |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 192 | # else |
| 193 | # define tick_broadcast NULL |
| 194 | # endif |
Mark Rutland | 12572db | 2013-01-14 17:05:21 +0000 | [diff] [blame] | 195 | extern int tick_receive_broadcast(void); |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 196 | # endif |
Mark Rutland | 12572db | 2013-01-14 17:05:21 +0000 | [diff] [blame] | 197 | |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 198 | # if defined(CONFIG_GENERIC_CLOCKEVENTS_BROADCAST) && defined(CONFIG_TICK_ONESHOT) |
Preeti U Murthy | 5d1638a | 2014-02-07 13:36:32 +0530 | [diff] [blame] | 199 | extern void tick_setup_hrtimer_broadcast(void); |
Thomas Gleixner | eaa907c | 2013-03-06 11:18:36 +0000 | [diff] [blame] | 200 | extern int tick_check_broadcast_expired(void); |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 201 | # else |
Thomas Gleixner | eaa907c | 2013-03-06 11:18:36 +0000 | [diff] [blame] | 202 | static inline int tick_check_broadcast_expired(void) { return 0; } |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 203 | static inline void tick_setup_hrtimer_broadcast(void) { } |
| 204 | # endif |
Thomas Gleixner | eaa907c | 2013-03-06 11:18:36 +0000 | [diff] [blame] | 205 | |
Preeti U Murthy | da7e6f4 | 2014-02-07 13:36:06 +0530 | [diff] [blame] | 206 | extern int clockevents_notify(unsigned long reason, void *arg); |
Thomas Gleixner | de68d9b | 2007-10-12 23:04:05 +0200 | [diff] [blame] | 207 | |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 208 | #else /* !CONFIG_GENERIC_CLOCKEVENTS: */ |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 209 | |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 210 | static inline void clockevents_suspend(void) { } |
| 211 | static inline void clockevents_resume(void) { } |
Preeti U Murthy | da7e6f4 | 2014-02-07 13:36:06 +0530 | [diff] [blame] | 212 | static inline int clockevents_notify(unsigned long reason, void *arg) { return 0; } |
Thomas Gleixner | 1991922 | 2013-03-22 10:48:33 +0100 | [diff] [blame] | 213 | static inline int tick_check_broadcast_expired(void) { return 0; } |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 214 | static inline void tick_setup_hrtimer_broadcast(void) { } |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 215 | |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 216 | #endif /* !CONFIG_GENERIC_CLOCKEVENTS */ |
Thomas Gleixner | d316c57 | 2007-02-16 01:28:00 -0800 | [diff] [blame] | 217 | |
Ingo Molnar | 9eed56e | 2015-04-02 11:26:23 +0200 | [diff] [blame] | 218 | #endif /* _LINUX_CLOCKCHIPS_H */ |