xref: /linux/arch/x86/include/asm/hpet.h (revision d198b34f3855eee2571dda03eea75a09c7c31480)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ASM_X86_HPET_H
3 #define _ASM_X86_HPET_H
4 
5 #include <linux/msi.h>
6 
7 #ifdef CONFIG_HPET_TIMER
8 
9 #define HPET_MMAP_SIZE		1024
10 
11 #define HPET_ID			0x000
12 #define HPET_PERIOD		0x004
13 #define HPET_CFG		0x010
14 #define HPET_STATUS		0x020
15 #define HPET_COUNTER		0x0f0
16 
17 #define HPET_Tn_CFG(n)		(0x100 + 0x20 * n)
18 #define HPET_Tn_CMP(n)		(0x108 + 0x20 * n)
19 #define HPET_Tn_ROUTE(n)	(0x110 + 0x20 * n)
20 
21 #define HPET_T0_CFG		0x100
22 #define HPET_T0_CMP		0x108
23 #define HPET_T0_ROUTE		0x110
24 #define HPET_T1_CFG		0x120
25 #define HPET_T1_CMP		0x128
26 #define HPET_T1_ROUTE		0x130
27 #define HPET_T2_CFG		0x140
28 #define HPET_T2_CMP		0x148
29 #define HPET_T2_ROUTE		0x150
30 
31 #define HPET_ID_REV		0x000000ff
32 #define HPET_ID_NUMBER		0x00001f00
33 #define HPET_ID_64BIT		0x00002000
34 #define HPET_ID_LEGSUP		0x00008000
35 #define HPET_ID_VENDOR		0xffff0000
36 #define	HPET_ID_NUMBER_SHIFT	8
37 #define HPET_ID_VENDOR_SHIFT	16
38 
39 #define HPET_CFG_ENABLE		0x001
40 #define HPET_CFG_LEGACY		0x002
41 #define	HPET_LEGACY_8254	2
42 #define	HPET_LEGACY_RTC		8
43 
44 #define HPET_TN_LEVEL		0x0002
45 #define HPET_TN_ENABLE		0x0004
46 #define HPET_TN_PERIODIC	0x0008
47 #define HPET_TN_PERIODIC_CAP	0x0010
48 #define HPET_TN_64BIT_CAP	0x0020
49 #define HPET_TN_SETVAL		0x0040
50 #define HPET_TN_32BIT		0x0100
51 #define HPET_TN_ROUTE		0x3e00
52 #define HPET_TN_FSB		0x4000
53 #define HPET_TN_FSB_CAP		0x8000
54 #define HPET_TN_ROUTE_SHIFT	9
55 
56 /* Max HPET Period is 10^8 femto sec as in HPET spec */
57 #define HPET_MAX_PERIOD		100000000UL
58 /*
59  * Min HPET period is 10^5 femto sec just for safety. If it is less than this,
60  * then 32 bit HPET counter wrapsaround in less than 0.5 sec.
61  */
62 #define HPET_MIN_PERIOD		100000UL
63 
64 /* hpet memory map physical address */
65 extern unsigned long hpet_address;
66 extern unsigned long force_hpet_address;
67 extern bool boot_hpet_disable;
68 extern u8 hpet_blockid;
69 extern bool hpet_force_user;
70 extern bool hpet_msi_disable;
71 extern int is_hpet_enabled(void);
72 extern int hpet_enable(void);
73 extern void hpet_disable(void);
74 extern unsigned int hpet_readl(unsigned int a);
75 extern void force_hpet_resume(void);
76 
77 struct irq_data;
78 struct hpet_channel;
79 struct irq_domain;
80 
81 extern void hpet_msi_unmask(struct irq_data *data);
82 extern void hpet_msi_mask(struct irq_data *data);
83 extern void hpet_msi_write(struct hpet_channel *hc, struct msi_msg *msg);
84 extern struct irq_domain *hpet_create_irq_domain(int hpet_id);
85 extern int hpet_assign_irq(struct irq_domain *domain,
86 			   struct hpet_channel *hc, int dev_num);
87 
88 #ifdef CONFIG_HPET_EMULATE_RTC
89 
90 #include <linux/interrupt.h>
91 
92 typedef irqreturn_t (*rtc_irq_handler)(int interrupt, void *cookie);
93 extern int hpet_mask_rtc_irq_bit(unsigned long bit_mask);
94 extern int hpet_set_rtc_irq_bit(unsigned long bit_mask);
95 extern int hpet_set_alarm_time(unsigned char hrs, unsigned char min,
96 			       unsigned char sec);
97 extern int hpet_set_periodic_freq(unsigned long freq);
98 extern int hpet_rtc_dropped_irq(void);
99 extern int hpet_rtc_timer_init(void);
100 extern irqreturn_t hpet_rtc_interrupt(int irq, void *dev_id);
101 extern int hpet_register_irq_handler(rtc_irq_handler handler);
102 extern void hpet_unregister_irq_handler(rtc_irq_handler handler);
103 
104 #endif /* CONFIG_HPET_EMULATE_RTC */
105 
106 #else /* CONFIG_HPET_TIMER */
107 
108 static inline int hpet_enable(void) { return 0; }
109 static inline int is_hpet_enabled(void) { return 0; }
110 #define hpet_readl(a) 0
111 #define default_setup_hpet_msi	NULL
112 
113 #endif
114 #endif /* _ASM_X86_HPET_H */
115