include/linux/cpu.h

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