Merge tag 'trace-v5.3' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux...
[linux-2.6-block.git] / include / acpi / cppc_acpi.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * CPPC (Collaborative Processor Performance Control) methods used
4  * by CPUfreq drivers.
5  *
6  * (C) Copyright 2014, 2015 Linaro Ltd.
7  * Author: Ashwin Chaugule <ashwin.chaugule@linaro.org>
8  */
9
10 #ifndef _CPPC_ACPI_H
11 #define _CPPC_ACPI_H
12
13 #include <linux/acpi.h>
14 #include <linux/types.h>
15
16 #include <acpi/pcc.h>
17 #include <acpi/processor.h>
18
19 /* Support CPPCv2 and CPPCv3  */
20 #define CPPC_V2_REV     2
21 #define CPPC_V3_REV     3
22 #define CPPC_V2_NUM_ENT 21
23 #define CPPC_V3_NUM_ENT 23
24
25 #define PCC_CMD_COMPLETE_MASK   (1 << 0)
26 #define PCC_ERROR_MASK          (1 << 2)
27
28 #define MAX_CPC_REG_ENT 21
29
30 /* CPPC specific PCC commands. */
31 #define CMD_READ 0
32 #define CMD_WRITE 1
33
34 /* Each register has the folowing format. */
35 struct cpc_reg {
36         u8 descriptor;
37         u16 length;
38         u8 space_id;
39         u8 bit_width;
40         u8 bit_offset;
41         u8 access_width;
42         u64 __iomem address;
43 } __packed;
44
45 /*
46  * Each entry in the CPC table is either
47  * of type ACPI_TYPE_BUFFER or
48  * ACPI_TYPE_INTEGER.
49  */
50 struct cpc_register_resource {
51         acpi_object_type type;
52         u64 __iomem *sys_mem_vaddr;
53         union {
54                 struct cpc_reg reg;
55                 u64 int_value;
56         } cpc_entry;
57 };
58
59 /* Container to hold the CPC details for each CPU */
60 struct cpc_desc {
61         int num_entries;
62         int version;
63         int cpu_id;
64         int write_cmd_status;
65         int write_cmd_id;
66         struct cpc_register_resource cpc_regs[MAX_CPC_REG_ENT];
67         struct acpi_psd_package domain_info;
68         struct kobject kobj;
69 };
70
71 /* These are indexes into the per-cpu cpc_regs[]. Order is important. */
72 enum cppc_regs {
73         HIGHEST_PERF,
74         NOMINAL_PERF,
75         LOW_NON_LINEAR_PERF,
76         LOWEST_PERF,
77         GUARANTEED_PERF,
78         DESIRED_PERF,
79         MIN_PERF,
80         MAX_PERF,
81         PERF_REDUC_TOLERANCE,
82         TIME_WINDOW,
83         CTR_WRAP_TIME,
84         REFERENCE_CTR,
85         DELIVERED_CTR,
86         PERF_LIMITED,
87         ENABLE,
88         AUTO_SEL_ENABLE,
89         AUTO_ACT_WINDOW,
90         ENERGY_PERF,
91         REFERENCE_PERF,
92         LOWEST_FREQ,
93         NOMINAL_FREQ,
94 };
95
96 /*
97  * Categorization of registers as described
98  * in the ACPI v.5.1 spec.
99  * XXX: Only filling up ones which are used by governors
100  * today.
101  */
102 struct cppc_perf_caps {
103         u32 guaranteed_perf;
104         u32 highest_perf;
105         u32 nominal_perf;
106         u32 lowest_perf;
107         u32 lowest_nonlinear_perf;
108         u32 lowest_freq;
109         u32 nominal_freq;
110 };
111
112 struct cppc_perf_ctrls {
113         u32 max_perf;
114         u32 min_perf;
115         u32 desired_perf;
116 };
117
118 struct cppc_perf_fb_ctrs {
119         u64 reference;
120         u64 delivered;
121         u64 reference_perf;
122         u64 wraparound_time;
123 };
124
125 /* Per CPU container for runtime CPPC management. */
126 struct cppc_cpudata {
127         int cpu;
128         struct cppc_perf_caps perf_caps;
129         struct cppc_perf_ctrls perf_ctrls;
130         struct cppc_perf_fb_ctrs perf_fb_ctrs;
131         struct cpufreq_policy *cur_policy;
132         unsigned int shared_type;
133         cpumask_var_t shared_cpu_map;
134 };
135
136 extern int cppc_get_desired_perf(int cpunum, u64 *desired_perf);
137 extern int cppc_get_perf_ctrs(int cpu, struct cppc_perf_fb_ctrs *perf_fb_ctrs);
138 extern int cppc_set_perf(int cpu, struct cppc_perf_ctrls *perf_ctrls);
139 extern int cppc_get_perf_caps(int cpu, struct cppc_perf_caps *caps);
140 extern int acpi_get_psd_map(struct cppc_cpudata **);
141 extern unsigned int cppc_get_transition_latency(int cpu);
142 extern bool cpc_ffh_supported(void);
143 extern int cpc_read_ffh(int cpunum, struct cpc_reg *reg, u64 *val);
144 extern int cpc_write_ffh(int cpunum, struct cpc_reg *reg, u64 val);
145
146 #endif /* _CPPC_ACPI_H*/