arm64/armv8 deprecated: Convert to hotplug state machine
[cascardo/linux.git] / include / linux / cpuhotplug.h
1 #ifndef __CPUHOTPLUG_H
2 #define __CPUHOTPLUG_H
3
4 enum cpuhp_state {
5         CPUHP_OFFLINE,
6         CPUHP_CREATE_THREADS,
7         CPUHP_PERF_PREPARE,
8         CPUHP_PERF_X86_PREPARE,
9         CPUHP_PERF_X86_UNCORE_PREP,
10         CPUHP_PERF_X86_AMD_UNCORE_PREP,
11         CPUHP_PERF_X86_RAPL_PREP,
12         CPUHP_PERF_BFIN,
13         CPUHP_PERF_POWER,
14         CPUHP_PERF_SUPERH,
15         CPUHP_X86_HPET_DEAD,
16         CPUHP_X86_APB_DEAD,
17         CPUHP_WORKQUEUE_PREP,
18         CPUHP_NOTIFY_PREPARE,
19         CPUHP_BRINGUP_CPU,
20         CPUHP_AP_IDLE_DEAD,
21         CPUHP_AP_OFFLINE,
22         CPUHP_AP_SCHED_STARTING,
23         CPUHP_AP_IRQ_GIC_STARTING,
24         CPUHP_AP_IRQ_GICV3_STARTING,
25         CPUHP_AP_IRQ_HIP04_STARTING,
26         CPUHP_AP_IRQ_ARMADA_XP_STARTING,
27         CPUHP_AP_IRQ_ARMADA_CASC_STARTING,
28         CPUHP_AP_IRQ_BCM2836_STARTING,
29         CPUHP_AP_ARM_MVEBU_COHERENCY,
30         CPUHP_AP_PERF_X86_UNCORE_STARTING,
31         CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING,
32         CPUHP_AP_PERF_X86_STARTING,
33         CPUHP_AP_PERF_X86_AMD_IBS_STARTING,
34         CPUHP_AP_PERF_X86_CQM_STARTING,
35         CPUHP_AP_PERF_X86_CSTATE_STARTING,
36         CPUHP_AP_PERF_XTENSA_STARTING,
37         CPUHP_AP_PERF_METAG_STARTING,
38         CPUHP_AP_MIPS_OP_LOONGSON3_STARTING,
39         CPUHP_AP_ARM_VFP_STARTING,
40         CPUHP_AP_PERF_ARM_STARTING,
41         CPUHP_AP_ARM_L2X0_STARTING,
42         CPUHP_AP_ARM_ARCH_TIMER_STARTING,
43         CPUHP_AP_DUMMY_TIMER_STARTING,
44         CPUHP_AP_ARM_TWD_STARTING,
45         CPUHP_AP_METAG_TIMER_STARTING,
46         CPUHP_AP_QCOM_TIMER_STARTING,
47         CPUHP_AP_MIPS_GIC_TIMER_STARTING,
48         CPUHP_AP_KVM_STARTING,
49         CPUHP_AP_KVM_ARM_VGIC_STARTING,
50         CPUHP_AP_KVM_ARM_TIMER_STARTING,
51         CPUHP_AP_ARM_XEN_STARTING,
52         CPUHP_AP_ARM_CORESIGHT_STARTING,
53         CPUHP_AP_ARM_CORESIGHT4_STARTING,
54         CPUHP_AP_ARM64_ISNDEP_STARTING,
55         CPUHP_AP_LEDTRIG_STARTING,
56         CPUHP_AP_NOTIFY_STARTING,
57         CPUHP_AP_ONLINE,
58         CPUHP_TEARDOWN_CPU,
59         CPUHP_AP_ONLINE_IDLE,
60         CPUHP_AP_SMPBOOT_THREADS,
61         CPUHP_AP_X86_VDSO_VMA_ONLINE,
62         CPUHP_AP_PERF_ONLINE,
63         CPUHP_AP_PERF_X86_ONLINE,
64         CPUHP_AP_PERF_X86_UNCORE_ONLINE,
65         CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
66         CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
67         CPUHP_AP_PERF_X86_RAPL_ONLINE,
68         CPUHP_AP_PERF_X86_CQM_ONLINE,
69         CPUHP_AP_PERF_X86_CSTATE_ONLINE,
70         CPUHP_AP_PERF_S390_CF_ONLINE,
71         CPUHP_AP_PERF_S390_SF_ONLINE,
72         CPUHP_AP_PERF_ARM_CCI_ONLINE,
73         CPUHP_AP_PERF_ARM_CCN_ONLINE,
74         CPUHP_AP_WORKQUEUE_ONLINE,
75         CPUHP_AP_NOTIFY_ONLINE,
76         CPUHP_AP_ONLINE_DYN,
77         CPUHP_AP_ONLINE_DYN_END         = CPUHP_AP_ONLINE_DYN + 30,
78         CPUHP_AP_X86_HPET_ONLINE,
79         CPUHP_AP_X86_KVM_CLK_ONLINE,
80         CPUHP_AP_ACTIVE,
81         CPUHP_ONLINE,
82 };
83
84 int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
85                         int (*startup)(unsigned int cpu),
86                         int (*teardown)(unsigned int cpu));
87
88 /**
89  * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
90  * @state:      The state for which the calls are installed
91  * @name:       Name of the callback (will be used in debug output)
92  * @startup:    startup callback function
93  * @teardown:   teardown callback function
94  *
95  * Installs the callback functions and invokes the startup callback on
96  * the present cpus which have already reached the @state.
97  */
98 static inline int cpuhp_setup_state(enum cpuhp_state state,
99                                     const char *name,
100                                     int (*startup)(unsigned int cpu),
101                                     int (*teardown)(unsigned int cpu))
102 {
103         return __cpuhp_setup_state(state, name, true, startup, teardown);
104 }
105
106 /**
107  * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
108  *                             callbacks
109  * @state:      The state for which the calls are installed
110  * @name:       Name of the callback.
111  * @startup:    startup callback function
112  * @teardown:   teardown callback function
113  *
114  * Same as @cpuhp_setup_state except that no calls are executed are invoked
115  * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
116  */
117 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
118                                             const char *name,
119                                             int (*startup)(unsigned int cpu),
120                                             int (*teardown)(unsigned int cpu))
121 {
122         return __cpuhp_setup_state(state, name, false, startup, teardown);
123 }
124
125 void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
126
127 /**
128  * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
129  * @state:      The state for which the calls are removed
130  *
131  * Removes the callback functions and invokes the teardown callback on
132  * the present cpus which have already reached the @state.
133  */
134 static inline void cpuhp_remove_state(enum cpuhp_state state)
135 {
136         __cpuhp_remove_state(state, true);
137 }
138
139 /**
140  * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
141  *                              teardown
142  * @state:      The state for which the calls are removed
143  */
144 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
145 {
146         __cpuhp_remove_state(state, false);
147 }
148
149 #ifdef CONFIG_SMP
150 void cpuhp_online_idle(enum cpuhp_state state);
151 #else
152 static inline void cpuhp_online_idle(enum cpuhp_state state) { }
153 #endif
154
155 #endif