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 __printf(4, 5)
51struct device *cpu_device_create(struct device *parent, void *drvdata,
52 const struct attribute_group **groups,
53 const char *fmt, ...);
54#ifdef CONFIG_HOTPLUG_CPU
55extern void unregister_cpu(struct cpu *cpu);
56extern ssize_t arch_cpu_probe(const char *, size_t);
57extern ssize_t arch_cpu_release(const char *, size_t);
58#endif
59
60/*
61 * These states are not related to the core CPU hotplug mechanism. They are
62 * used by various (sub)architectures to track internal state
63 */
64#define CPU_ONLINE 0x0002 /* CPU is up */
65#define CPU_UP_PREPARE 0x0003 /* CPU coming up */
66#define CPU_DEAD 0x0007 /* CPU dead */
67#define CPU_DEAD_FROZEN 0x0008 /* CPU timed out on unplug */
68#define CPU_POST_DEAD 0x0009 /* CPU successfully unplugged */
69#define CPU_BROKEN 0x000B /* CPU did not die properly */
70
71#ifdef CONFIG_SMP
72extern bool cpuhp_tasks_frozen;
73int cpu_up(unsigned int cpu);
74void notify_cpu_starting(unsigned int cpu);
75extern void cpu_maps_update_begin(void);
76extern void cpu_maps_update_done(void);
77
78#else /* CONFIG_SMP */
79#define cpuhp_tasks_frozen 0
80
81static inline void cpu_maps_update_begin(void)
82{
83}
84
85static inline void cpu_maps_update_done(void)
86{
87}
88
89#endif /* CONFIG_SMP */
90extern struct bus_type cpu_subsys;
91
92#ifdef CONFIG_HOTPLUG_CPU
93extern void cpus_write_lock(void);
94extern void cpus_write_unlock(void);
95extern void cpus_read_lock(void);
96extern void cpus_read_unlock(void);
97extern void lockdep_assert_cpus_held(void);
98extern void cpu_hotplug_disable(void);
99extern void cpu_hotplug_enable(void);
100void clear_tasks_mm_cpumask(int cpu);
101int cpu_down(unsigned int cpu);
102
103#else /* CONFIG_HOTPLUG_CPU */
104
105static inline void cpus_write_lock(void) { }
106static inline void cpus_write_unlock(void) { }
107static inline void cpus_read_lock(void) { }
108static inline void cpus_read_unlock(void) { }
109static inline void lockdep_assert_cpus_held(void) { }
110static inline void cpu_hotplug_disable(void) { }
111static inline void cpu_hotplug_enable(void) { }
112#endif /* !CONFIG_HOTPLUG_CPU */
113
114/* Wrappers which go away once all code is converted */
115static inline void cpu_hotplug_begin(void) { cpus_write_lock(); }
116static inline void cpu_hotplug_done(void) { cpus_write_unlock(); }
117static inline void get_online_cpus(void) { cpus_read_lock(); }
118static inline void put_online_cpus(void) { cpus_read_unlock(); }
119
120#ifdef CONFIG_PM_SLEEP_SMP
121extern int freeze_secondary_cpus(int primary);
122static inline int disable_nonboot_cpus(void)
123{
124 return freeze_secondary_cpus(0);
125}
126extern void enable_nonboot_cpus(void);
127#else /* !CONFIG_PM_SLEEP_SMP */
128static inline int disable_nonboot_cpus(void) { return 0; }
129static inline void enable_nonboot_cpus(void) {}
130#endif /* !CONFIG_PM_SLEEP_SMP */
131
132void cpu_startup_entry(enum cpuhp_state state);
133
134void cpu_idle_poll_ctrl(bool enable);
135
136/* Attach to any functions which should be considered cpuidle. */
137#define __cpuidle __attribute__((__section__(".cpuidle.text")))
138
139bool cpu_in_idle(unsigned long pc);
140
141void arch_cpu_idle(void);
142void arch_cpu_idle_prepare(void);
143void arch_cpu_idle_enter(void);
144void arch_cpu_idle_exit(void);
145void arch_cpu_idle_dead(void);
146
147int cpu_report_state(int cpu);
148int cpu_check_up_prepare(int cpu);
149void cpu_set_state_online(int cpu);
150void play_idle(unsigned long duration_ms);
151
152#ifdef CONFIG_HOTPLUG_CPU
153bool cpu_wait_death(unsigned int cpu, int seconds);
154bool cpu_report_death(void);
155void cpuhp_report_idle_dead(void);
156#else
157static inline void cpuhp_report_idle_dead(void) { }
158#endif /* #ifdef CONFIG_HOTPLUG_CPU */
159
160#endif /* _LINUX_CPU_H_ */