1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2012 ARM Ltd.
4  */
5 #ifndef __CLKSOURCE_ARM_ARCH_TIMER_H
6 #define __CLKSOURCE_ARM_ARCH_TIMER_H
7 
8 #include <linux/bitops.h>
9 #include <linux/timecounter.h>
10 #include <linux/types.h>
11 
12 #define ARCH_TIMER_TYPE_CP15		BIT(0)
13 #define ARCH_TIMER_TYPE_MEM		BIT(1)
14 
15 #define ARCH_TIMER_CTRL_ENABLE		(1 << 0)
16 #define ARCH_TIMER_CTRL_IT_MASK		(1 << 1)
17 #define ARCH_TIMER_CTRL_IT_STAT		(1 << 2)
18 
19 #define CNTHCTL_EL1PCTEN		(1 << 0)
20 #define CNTHCTL_EL1PCEN			(1 << 1)
21 #define CNTHCTL_EVNTEN			(1 << 2)
22 #define CNTHCTL_EVNTDIR			(1 << 3)
23 #define CNTHCTL_EVNTI			(0xF << 4)
24 #define CNTHCTL_ECV			(1 << 12)
25 #define CNTHCTL_EL1TVT			(1 << 13)
26 #define CNTHCTL_EL1TVCT			(1 << 14)
27 #define CNTHCTL_EL1NVPCT		(1 << 15)
28 #define CNTHCTL_EL1NVVCT		(1 << 16)
29 
30 enum arch_timer_reg {
31 	ARCH_TIMER_REG_CTRL,
32 	ARCH_TIMER_REG_CVAL,
33 };
34 
35 enum arch_timer_ppi_nr {
36 	ARCH_TIMER_PHYS_SECURE_PPI,
37 	ARCH_TIMER_PHYS_NONSECURE_PPI,
38 	ARCH_TIMER_VIRT_PPI,
39 	ARCH_TIMER_HYP_PPI,
40 	ARCH_TIMER_HYP_VIRT_PPI,
41 	ARCH_TIMER_MAX_TIMER_PPI
42 };
43 
44 enum arch_timer_spi_nr {
45 	ARCH_TIMER_PHYS_SPI,
46 	ARCH_TIMER_VIRT_SPI,
47 	ARCH_TIMER_MAX_TIMER_SPI
48 };
49 
50 #define ARCH_TIMER_PHYS_ACCESS		0
51 #define ARCH_TIMER_VIRT_ACCESS		1
52 #define ARCH_TIMER_MEM_PHYS_ACCESS	2
53 #define ARCH_TIMER_MEM_VIRT_ACCESS	3
54 
55 #define ARCH_TIMER_MEM_MAX_FRAMES	8
56 
57 #define ARCH_TIMER_USR_PCT_ACCESS_EN	(1 << 0) /* physical counter */
58 #define ARCH_TIMER_USR_VCT_ACCESS_EN	(1 << 1) /* virtual counter */
59 #define ARCH_TIMER_VIRT_EVT_EN		(1 << 2)
60 #define ARCH_TIMER_EVT_TRIGGER_SHIFT	(4)
61 #define ARCH_TIMER_EVT_TRIGGER_MASK	(0xF << ARCH_TIMER_EVT_TRIGGER_SHIFT)
62 #define ARCH_TIMER_USR_VT_ACCESS_EN	(1 << 8) /* virtual timer registers */
63 #define ARCH_TIMER_USR_PT_ACCESS_EN	(1 << 9) /* physical timer registers */
64 #define ARCH_TIMER_EVT_INTERVAL_SCALE	(1 << 17) /* EVNTIS in the ARMv8 ARM */
65 
66 #define ARCH_TIMER_EVT_STREAM_PERIOD_US	100
67 #define ARCH_TIMER_EVT_STREAM_FREQ				\
68 	(USEC_PER_SEC / ARCH_TIMER_EVT_STREAM_PERIOD_US)
69 
70 struct arch_timer_kvm_info {
71 	struct timecounter timecounter;
72 	int virtual_irq;
73 	int physical_irq;
74 };
75 
76 struct arch_timer_mem_frame {
77 	bool valid;
78 	phys_addr_t cntbase;
79 	size_t size;
80 	int phys_irq;
81 	int virt_irq;
82 };
83 
84 struct arch_timer_mem {
85 	phys_addr_t cntctlbase;
86 	size_t size;
87 	struct arch_timer_mem_frame frame[ARCH_TIMER_MEM_MAX_FRAMES];
88 };
89 
90 #ifdef CONFIG_ARM_ARCH_TIMER
91 
92 extern u32 arch_timer_get_rate(void);
93 extern u64 (*arch_timer_read_counter)(void);
94 extern struct arch_timer_kvm_info *arch_timer_get_kvm_info(void);
95 extern bool arch_timer_evtstrm_available(void);
96 
97 #else
98 
99 static inline u32 arch_timer_get_rate(void)
100 {
101 	return 0;
102 }
103 
104 static inline u64 arch_timer_read_counter(void)
105 {
106 	return 0;
107 }
108 
109 static inline bool arch_timer_evtstrm_available(void)
110 {
111 	return false;
112 }
113 
114 #endif
115 
116 #endif
117