blob: 0857922e8ad04fb465bc7ea4edadd968384f6271 [file] [log] [blame]
Thomas Gleixnerd316c572007-02-16 01:28:00 -08001/* 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
Daniel Lezcano4dbad812013-03-27 10:22:09 +000011/* Clock event notification values */
12enum clock_event_nofitiers {
13 CLOCK_EVT_NOTIFY_ADD,
14 CLOCK_EVT_NOTIFY_BROADCAST_ON,
15 CLOCK_EVT_NOTIFY_BROADCAST_OFF,
16 CLOCK_EVT_NOTIFY_BROADCAST_FORCE,
17 CLOCK_EVT_NOTIFY_BROADCAST_ENTER,
18 CLOCK_EVT_NOTIFY_BROADCAST_EXIT,
19 CLOCK_EVT_NOTIFY_SUSPEND,
20 CLOCK_EVT_NOTIFY_RESUME,
21 CLOCK_EVT_NOTIFY_CPU_DYING,
22 CLOCK_EVT_NOTIFY_CPU_DEAD,
23};
24
Thomas Gleixnerde68d9b2007-10-12 23:04:05 +020025#ifdef CONFIG_GENERIC_CLOCKEVENTS_BUILD
Thomas Gleixnerd316c572007-02-16 01:28:00 -080026
27#include <linux/clocksource.h>
28#include <linux/cpumask.h>
29#include <linux/ktime.h>
30#include <linux/notifier.h>
31
32struct clock_event_device;
Thomas Gleixnerccf33d62013-04-25 20:31:49 +000033struct module;
Thomas Gleixnerd316c572007-02-16 01:28:00 -080034
35/* Clock event mode commands */
36enum clock_event_mode {
37 CLOCK_EVT_MODE_UNUSED = 0,
38 CLOCK_EVT_MODE_SHUTDOWN,
39 CLOCK_EVT_MODE_PERIODIC,
40 CLOCK_EVT_MODE_ONESHOT,
Thomas Gleixner18de5bc2007-07-21 04:37:34 -070041 CLOCK_EVT_MODE_RESUME,
Thomas Gleixnerd316c572007-02-16 01:28:00 -080042};
43
Thomas Gleixnerd316c572007-02-16 01:28:00 -080044/*
45 * Clock event features
46 */
47#define CLOCK_EVT_FEAT_PERIODIC 0x000001
48#define CLOCK_EVT_FEAT_ONESHOT 0x000002
Martin Schwidefsky65516f82011-08-23 15:29:43 +020049#define CLOCK_EVT_FEAT_KTIME 0x000004
Thomas Gleixnerd316c572007-02-16 01:28:00 -080050/*
51 * x86(64) specific misfeatures:
52 *
53 * - Clockevent source stops in C3 State and needs broadcast support.
54 * - Local APIC timer is used as a dummy device.
55 */
Martin Schwidefsky65516f82011-08-23 15:29:43 +020056#define CLOCK_EVT_FEAT_C3STOP 0x000008
57#define CLOCK_EVT_FEAT_DUMMY 0x000010
Thomas Gleixnerd316c572007-02-16 01:28:00 -080058
Daniel Lezcanod2348fb2013-03-02 11:10:11 +010059/*
60 * Core shall set the interrupt affinity dynamically in broadcast mode
61 */
62#define CLOCK_EVT_FEAT_DYNIRQ 0x000020
63
Thomas Gleixnerd316c572007-02-16 01:28:00 -080064/**
65 * struct clock_event_device - clock event device descriptor
Thomas Gleixner847b2f42011-05-18 21:33:41 +000066 * @event_handler: Assigned by the framework to be called by the low
67 * level handler of the event source
Martin Schwidefsky65516f82011-08-23 15:29:43 +020068 * @set_next_event: set next event function using a clocksource delta
69 * @set_next_ktime: set next event function using a direct ktime value
Thomas Gleixner847b2f42011-05-18 21:33:41 +000070 * @next_event: local storage for the next event in oneshot mode
Thomas Gleixnerd316c572007-02-16 01:28:00 -080071 * @max_delta_ns: maximum delta value in ns
72 * @min_delta_ns: minimum delta value in ns
73 * @mult: nanosecond to cycles multiplier
74 * @shift: nanoseconds to cycles divisor (power of two)
Thomas Gleixner847b2f42011-05-18 21:33:41 +000075 * @mode: operating mode assigned by the management code
76 * @features: features
77 * @retries: number of forced programming retries
78 * @set_mode: set mode function
79 * @broadcast: function to broadcast events
Thomas Gleixner57f0fcb2011-05-18 21:33:41 +000080 * @min_delta_ticks: minimum delta value in ticks stored for reconfiguration
81 * @max_delta_ticks: maximum delta value in ticks stored for reconfiguration
Thomas Gleixner847b2f42011-05-18 21:33:41 +000082 * @name: ptr to clock event name
Thomas Gleixnerd316c572007-02-16 01:28:00 -080083 * @rating: variable to rate clock event devices
Sergei Shtylyovce0be122007-05-08 00:31:55 -070084 * @irq: IRQ number (only for non CPU local devices)
85 * @cpumask: cpumask to indicate for which CPUs this device works
Thomas Gleixnerd316c572007-02-16 01:28:00 -080086 * @list: list head for the management code
Thomas Gleixnerccf33d62013-04-25 20:31:49 +000087 * @owner: module reference
Thomas Gleixnerd316c572007-02-16 01:28:00 -080088 */
89struct clock_event_device {
Thomas Gleixner847b2f42011-05-18 21:33:41 +000090 void (*event_handler)(struct clock_event_device *);
91 int (*set_next_event)(unsigned long evt,
92 struct clock_event_device *);
Martin Schwidefsky65516f82011-08-23 15:29:43 +020093 int (*set_next_ktime)(ktime_t expires,
94 struct clock_event_device *);
Thomas Gleixner847b2f42011-05-18 21:33:41 +000095 ktime_t next_event;
Jon Hunter97813f22009-08-18 12:45:11 -050096 u64 max_delta_ns;
97 u64 min_delta_ns;
Thomas Gleixner23af3682009-11-11 14:05:25 +000098 u32 mult;
99 u32 shift;
Thomas Gleixner847b2f42011-05-18 21:33:41 +0000100 enum clock_event_mode mode;
101 unsigned int features;
102 unsigned long retries;
103
104 void (*broadcast)(const struct cpumask *mask);
105 void (*set_mode)(enum clock_event_mode mode,
106 struct clock_event_device *);
Rafael J. Wysockiadc78e62012-08-06 01:40:41 +0200107 void (*suspend)(struct clock_event_device *);
108 void (*resume)(struct clock_event_device *);
Thomas Gleixner57f0fcb2011-05-18 21:33:41 +0000109 unsigned long min_delta_ticks;
110 unsigned long max_delta_ticks;
111
Thomas Gleixner847b2f42011-05-18 21:33:41 +0000112 const char *name;
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800113 int rating;
114 int irq;
Rusty Russell320ab2b2008-12-13 21:20:26 +1030115 const struct cpumask *cpumask;
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800116 struct list_head list;
Thomas Gleixnerccf33d62013-04-25 20:31:49 +0000117 struct module *owner;
Thomas Gleixner847b2f42011-05-18 21:33:41 +0000118} ____cacheline_aligned;
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800119
120/*
121 * Calculate a multiplication factor for scaled math, which is used to convert
122 * nanoseconds based values to clock ticks:
123 *
124 * clock_ticks = (nanoseconds * factor) >> shift.
125 *
126 * div_sc is the rearranged equation to calculate a factor from a given clock
127 * ticks / nanoseconds ratio:
128 *
129 * factor = (clock_ticks << shift) / nanoseconds
130 */
131static inline unsigned long div_sc(unsigned long ticks, unsigned long nsec,
132 int shift)
133{
134 uint64_t tmp = ((uint64_t)ticks) << shift;
135
136 do_div(tmp, nsec);
137 return (unsigned long) tmp;
138}
139
140/* Clock event layer functions */
Jon Hunter97813f22009-08-18 12:45:11 -0500141extern u64 clockevent_delta2ns(unsigned long latch,
142 struct clock_event_device *evt);
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800143extern void clockevents_register_device(struct clock_event_device *dev);
Thomas Gleixner03e13cf2013-04-25 20:31:50 +0000144extern int clockevents_unbind_device(struct clock_event_device *ced, int cpu);
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800145
Magnus Damme5400322012-05-09 23:39:34 +0900146extern void clockevents_config(struct clock_event_device *dev, u32 freq);
Thomas Gleixner57f0fcb2011-05-18 21:33:41 +0000147extern void clockevents_config_and_register(struct clock_event_device *dev,
148 u32 freq, unsigned long min_delta,
149 unsigned long max_delta);
150
Thomas Gleixner80b816b2011-05-18 21:33:42 +0000151extern int clockevents_update_freq(struct clock_event_device *ce, u32 freq);
152
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800153extern void clockevents_exchange_device(struct clock_event_device *old,
154 struct clock_event_device *new);
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800155extern void clockevents_set_mode(struct clock_event_device *dev,
156 enum clock_event_mode mode);
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800157extern int clockevents_program_event(struct clock_event_device *dev,
Martin Schwidefskyd1748302011-08-23 15:29:42 +0200158 ktime_t expires, bool force);
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800159
Venkatesh Pallipadi7c1e7682008-09-03 21:36:50 +0000160extern void clockevents_handle_noop(struct clock_event_device *dev);
161
Thomas Gleixner7d2f9442009-11-11 14:05:29 +0000162static inline void
163clockevents_calc_mult_shift(struct clock_event_device *ce, u32 freq, u32 minsec)
164{
165 return clocks_calc_mult_shift(&ce->mult, &ce->shift, NSEC_PER_SEC,
166 freq, minsec);
167}
168
Rafael J. Wysockiadc78e62012-08-06 01:40:41 +0200169extern void clockevents_suspend(void);
170extern void clockevents_resume(void);
171
Mark Rutland12572db2013-01-14 17:05:21 +0000172#ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
Mark Rutland12ad1002013-01-14 17:05:22 +0000173#ifdef CONFIG_ARCH_HAS_TICK_BROADCAST
174extern void tick_broadcast(const struct cpumask *mask);
175#else
176#define tick_broadcast NULL
177#endif
Mark Rutland12572db2013-01-14 17:05:21 +0000178extern int tick_receive_broadcast(void);
179#endif
180
Thomas Gleixnereaa907c2013-03-06 11:18:36 +0000181#if defined(CONFIG_GENERIC_CLOCKEVENTS_BROADCAST) && defined(CONFIG_TICK_ONESHOT)
182extern int tick_check_broadcast_expired(void);
183#else
184static inline int tick_check_broadcast_expired(void) { return 0; }
185#endif
186
Thomas Gleixnerde68d9b2007-10-12 23:04:05 +0200187#ifdef CONFIG_GENERIC_CLOCKEVENTS
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800188extern void clockevents_notify(unsigned long reason, void *arg);
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800189#else
Daniel Lezcano4dbad812013-03-27 10:22:09 +0000190static inline void clockevents_notify(unsigned long reason, void *arg) {}
Thomas Gleixnerde68d9b2007-10-12 23:04:05 +0200191#endif
192
193#else /* CONFIG_GENERIC_CLOCKEVENTS_BUILD */
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800194
Rafael J. Wysockiadc78e62012-08-06 01:40:41 +0200195static inline void clockevents_suspend(void) {}
196static inline void clockevents_resume(void) {}
197
Daniel Lezcano4dbad812013-03-27 10:22:09 +0000198static inline void clockevents_notify(unsigned long reason, void *arg) {}
Thomas Gleixner19919222013-03-22 10:48:33 +0100199static inline int tick_check_broadcast_expired(void) { return 0; }
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800200
201#endif
202
203#endif