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 */
65extern unsigned long hpet_address;
66extern unsigned long force_hpet_address;
67extern bool boot_hpet_disable;
68extern u8 hpet_blockid;
69extern bool hpet_force_user;
70extern bool hpet_msi_disable;
71extern int is_hpet_enabled(void);
72extern int hpet_enable(void);
73extern void hpet_disable(void);
74extern unsigned int hpet_readl(unsigned int a);
75extern void force_hpet_resume(void);
76
77struct irq_data;
78struct hpet_dev;
79struct irq_domain;
80
81extern void hpet_msi_unmask(struct irq_data *data);
82extern void hpet_msi_mask(struct irq_data *data);
83extern void hpet_msi_write(struct hpet_dev *hdev, struct msi_msg *msg);
84extern void hpet_msi_read(struct hpet_dev *hdev, struct msi_msg *msg);
85extern struct irq_domain *hpet_create_irq_domain(int hpet_id);
86extern int hpet_assign_irq(struct irq_domain *domain,
87 struct hpet_dev *dev, int dev_num);
88
89#ifdef CONFIG_HPET_EMULATE_RTC
90
91#include <linux/interrupt.h>
92
93typedef irqreturn_t (*rtc_irq_handler)(int interrupt, void *cookie);
94extern int hpet_mask_rtc_irq_bit(unsigned long bit_mask);
95extern int hpet_set_rtc_irq_bit(unsigned long bit_mask);
96extern int hpet_set_alarm_time(unsigned char hrs, unsigned char min,
97 unsigned char sec);
98extern int hpet_set_periodic_freq(unsigned long freq);
99extern int hpet_rtc_dropped_irq(void);
100extern int hpet_rtc_timer_init(void);
101extern irqreturn_t hpet_rtc_interrupt(int irq, void *dev_id);
102extern int hpet_register_irq_handler(rtc_irq_handler handler);
103extern void hpet_unregister_irq_handler(rtc_irq_handler handler);
104
105#endif /* CONFIG_HPET_EMULATE_RTC */
106
107#else /* CONFIG_HPET_TIMER */
108
109static inline int hpet_enable(void) { return 0; }
110static inline int is_hpet_enabled(void) { return 0; }
111#define hpet_readl(a) 0
112#define default_setup_hpet_msi NULL
113
114#endif
115#endif /* _ASM_X86_HPET_H */
116