arch_topology.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * include/linux/arch_topology.h - arch specific cpu topology information
  4 */
  5#ifndef _LINUX_ARCH_TOPOLOGY_H_
  6#define _LINUX_ARCH_TOPOLOGY_H_
  7
  8#include <linux/types.h>
  9#include <linux/percpu.h>
 10
 11void topology_normalize_cpu_scale(void);
 12int topology_update_cpu_topology(void);
 13
 14struct device_node;
 15bool topology_parse_cpu_capacity(struct device_node *cpu_node, int cpu);
 16
 17
 18DECLARE_PER_CPU(unsigned long, capacity_freq_ref);
 19
 20static inline unsigned long topology_get_freq_ref(int cpu)
 21{
 22	return per_cpu(capacity_freq_ref, cpu);
 23}
 24
 25DECLARE_PER_CPU(unsigned long, arch_freq_scale);
 26
 27static inline unsigned long topology_get_freq_scale(int cpu)
 28{
 29	return per_cpu(arch_freq_scale, cpu);
 30}
 31
 32void topology_set_freq_scale(const struct cpumask *cpus, unsigned long cur_freq,
 33			     unsigned long max_freq);
 34bool topology_scale_freq_invariant(void);
 35
 36enum scale_freq_source {
 37	SCALE_FREQ_SOURCE_CPUFREQ = 0,
 38	SCALE_FREQ_SOURCE_ARCH,
 39	SCALE_FREQ_SOURCE_CPPC,
 40	SCALE_FREQ_SOURCE_VIRT,
 41};
 42
 43struct scale_freq_data {
 44	enum scale_freq_source source;
 45	void (*set_freq_scale)(void);
 46};
 47
 48void topology_scale_freq_tick(void);
 49void topology_set_scale_freq_source(struct scale_freq_data *data, const struct cpumask *cpus);
 50void topology_clear_scale_freq_source(enum scale_freq_source source, const struct cpumask *cpus);
 51
 52DECLARE_PER_CPU(unsigned long, hw_pressure);
 53
 54static inline unsigned long topology_get_hw_pressure(int cpu)
 55{
 56	return per_cpu(hw_pressure, cpu);
 57}
 58
 59void topology_update_hw_pressure(const struct cpumask *cpus,
 60				      unsigned long capped_freq);
 61
 62struct cpu_topology {
 63	int thread_id;
 64	int core_id;
 65	int cluster_id;
 66	int package_id;
 67	cpumask_t thread_sibling;
 68	cpumask_t core_sibling;
 69	cpumask_t cluster_sibling;
 70	cpumask_t llc_sibling;
 71};
 72
 73#ifdef CONFIG_GENERIC_ARCH_TOPOLOGY
 74extern struct cpu_topology cpu_topology[NR_CPUS];
 75
 76#define topology_physical_package_id(cpu)	(cpu_topology[cpu].package_id)
 77#define topology_cluster_id(cpu)	(cpu_topology[cpu].cluster_id)
 78#define topology_core_id(cpu)		(cpu_topology[cpu].core_id)
 79#define topology_core_cpumask(cpu)	(&cpu_topology[cpu].core_sibling)
 80#define topology_sibling_cpumask(cpu)	(&cpu_topology[cpu].thread_sibling)
 81#define topology_cluster_cpumask(cpu)	(&cpu_topology[cpu].cluster_sibling)
 82#define topology_llc_cpumask(cpu)	(&cpu_topology[cpu].llc_sibling)
 83
 84#ifndef arch_cpu_is_threaded
 85#define arch_cpu_is_threaded()	(0)
 86#endif
 87
 88void init_cpu_topology(void);
 89void store_cpu_topology(unsigned int cpuid);
 90const struct cpumask *cpu_coregroup_mask(int cpu);
 91const struct cpumask *cpu_clustergroup_mask(int cpu);
 92void update_siblings_masks(unsigned int cpu);
 93void remove_cpu_topology(unsigned int cpuid);
 94void reset_cpu_topology(void);
 95int parse_acpi_topology(void);
 96void freq_inv_set_max_ratio(int cpu, u64 max_rate);
 97
 98/*
 99 * Architectures like ARM64 don't have reliable architectural way to get SMT
100 * information and depend on the firmware (ACPI/OF) report. Non-SMT core won't
101 * initialize thread_id so we can use this to detect the SMT implementation.
102 */
103static inline bool topology_core_has_smt(int cpu)
104{
105	return cpu_topology[cpu].thread_id != -1;
106}
107
108#else
109
110static inline bool topology_core_has_smt(int cpu) { return false; }
111
112#endif /* CONFIG_GENERIC_ARCH_TOPOLOGY */
113
114#endif /* _LINUX_ARCH_TOPOLOGY_H_ */