Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * include/linux/cpu.h - generic cpu definition
4 *
5 * This is mainly for topological representation. We define the
6 * basic 'struct cpu' here, which can be embedded in per-arch
7 * definitions of processors.
8 *
9 * Basic handling of the devices is done in drivers/base/cpu.c
10 *
11 * CPUs are exported via sysfs in the devices/system/cpu
12 * directory.
13 */
14#ifndef _LINUX_CPU_H_
15#define _LINUX_CPU_H_
16
17#include <linux/node.h>
18#include <linux/compiler.h>
19#include <linux/cpumask.h>
20#include <linux/cpuhotplug.h>
21
22struct device;
23struct device_node;
24struct attribute_group;
25
26struct cpu {
27 int node_id; /* The node which contains the CPU */
28 int hotpluggable; /* creates sysfs control file if hotpluggable */
29 struct device dev;
30};
31
32extern void boot_cpu_init(void);
33extern void boot_cpu_state_init(void);
34extern void cpu_init(void);
35extern void trap_init(void);
36
37extern int register_cpu(struct cpu *cpu, int num);
38extern struct device *get_cpu_device(unsigned cpu);
39extern bool cpu_is_hotpluggable(unsigned cpu);
40extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
41extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
42 int cpu, unsigned int *thread);
43
44extern int cpu_add_dev_attr(struct device_attribute *attr);
45extern void cpu_remove_dev_attr(struct device_attribute *attr);
46
47extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
48extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
49
50extern ssize_t cpu_show_meltdown(struct device *dev,
51 struct device_attribute *attr, char *buf);
52extern ssize_t cpu_show_spectre_v1(struct device *dev,
53 struct device_attribute *attr, char *buf);
54extern ssize_t cpu_show_spectre_v2(struct device *dev,
55 struct device_attribute *attr, char *buf);
56
57extern __printf(4, 5)
58struct device *cpu_device_create(struct device *parent, void *drvdata,
59 const struct attribute_group **groups,
60 const char *fmt, ...);
61#ifdef CONFIG_HOTPLUG_CPU
62extern void unregister_cpu(struct cpu *cpu);
63extern ssize_t arch_cpu_probe(const char *, size_t);
64extern ssize_t arch_cpu_release(const char *, size_t);
65#endif
66
67/*
68 * These states are not related to the core CPU hotplug mechanism. They are
69 * used by various (sub)architectures to track internal state
70 */
71#define CPU_ONLINE 0x0002 /* CPU is up */
72#define CPU_UP_PREPARE 0x0003 /* CPU coming up */
73#define CPU_DEAD 0x0007 /* CPU dead */
74#define CPU_DEAD_FROZEN 0x0008 /* CPU timed out on unplug */
75#define CPU_POST_DEAD 0x0009 /* CPU successfully unplugged */
76#define CPU_BROKEN 0x000B /* CPU did not die properly */
77
78#ifdef CONFIG_SMP
79extern bool cpuhp_tasks_frozen;
80int cpu_up(unsigned int cpu);
81void notify_cpu_starting(unsigned int cpu);
82extern void cpu_maps_update_begin(void);
83extern void cpu_maps_update_done(void);
84
85#else /* CONFIG_SMP */
86#define cpuhp_tasks_frozen 0
87
88static inline void cpu_maps_update_begin(void)
89{
90}
91
92static inline void cpu_maps_update_done(void)
93{
94}
95
96#endif /* CONFIG_SMP */
97extern struct bus_type cpu_subsys;
98
99#ifdef CONFIG_HOTPLUG_CPU
100extern void cpus_write_lock(void);
101extern void cpus_write_unlock(void);
102extern void cpus_read_lock(void);
103extern void cpus_read_unlock(void);
104extern void lockdep_assert_cpus_held(void);
105extern void cpu_hotplug_disable(void);
106extern void cpu_hotplug_enable(void);
107void clear_tasks_mm_cpumask(int cpu);
108int cpu_down(unsigned int cpu);
109
110#else /* CONFIG_HOTPLUG_CPU */
111
112static inline void cpus_write_lock(void) { }
113static inline void cpus_write_unlock(void) { }
114static inline void cpus_read_lock(void) { }
115static inline void cpus_read_unlock(void) { }
116static inline void lockdep_assert_cpus_held(void) { }
117static inline void cpu_hotplug_disable(void) { }
118static inline void cpu_hotplug_enable(void) { }
119#endif /* !CONFIG_HOTPLUG_CPU */
120
121/* Wrappers which go away once all code is converted */
122static inline void cpu_hotplug_begin(void) { cpus_write_lock(); }
123static inline void cpu_hotplug_done(void) { cpus_write_unlock(); }
124static inline void get_online_cpus(void) { cpus_read_lock(); }
125static inline void put_online_cpus(void) { cpus_read_unlock(); }
126
127#ifdef CONFIG_PM_SLEEP_SMP
128extern int freeze_secondary_cpus(int primary);
129static inline int disable_nonboot_cpus(void)
130{
131 return freeze_secondary_cpus(0);
132}
133extern void enable_nonboot_cpus(void);
134#else /* !CONFIG_PM_SLEEP_SMP */
135static inline int disable_nonboot_cpus(void) { return 0; }
136static inline void enable_nonboot_cpus(void) {}
137#endif /* !CONFIG_PM_SLEEP_SMP */
138
139void cpu_startup_entry(enum cpuhp_state state);
140
141void cpu_idle_poll_ctrl(bool enable);
142
143/* Attach to any functions which should be considered cpuidle. */
144#define __cpuidle __attribute__((__section__(".cpuidle.text")))
145
146bool cpu_in_idle(unsigned long pc);
147
148void arch_cpu_idle(void);
149void arch_cpu_idle_prepare(void);
150void arch_cpu_idle_enter(void);
151void arch_cpu_idle_exit(void);
152void arch_cpu_idle_dead(void);
153
154int cpu_report_state(int cpu);
155int cpu_check_up_prepare(int cpu);
156void cpu_set_state_online(int cpu);
157void play_idle(unsigned long duration_ms);
158
159#ifdef CONFIG_HOTPLUG_CPU
160bool cpu_wait_death(unsigned int cpu, int seconds);
161bool cpu_report_death(void);
162void cpuhp_report_idle_dead(void);
163#else
164static inline void cpuhp_report_idle_dead(void) { }
165#endif /* #ifdef CONFIG_HOTPLUG_CPU */
166
167#endif /* _LINUX_CPU_H_ */