xref: /netbsd-src/sys/dev/acpi/acpi_cpu.h (revision 46f5119e40af2e51998f686b2fdcc76b5488f7f3)
1 /* $NetBSD: acpi_cpu.h,v 1.40 2011/03/24 05:10:06 jruoho Exp $ */
2 
3 /*-
4  * Copyright (c) 2010, 2011 Jukka Ruohonen <jruohonen@iki.fi>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef _SYS_DEV_ACPI_ACPI_CPU_H
31 #define _SYS_DEV_ACPI_ACPI_CPU_H
32 
33 /*
34  * The following _PDC values are based on:
35  *
36  * 	Intel Corporation: Intel Processor-Specific ACPI
37  *	Interface Specification, September 2006, Revision 005.
38  */
39 #define ACPICPU_PDC_REVID         0x1
40 #define ACPICPU_PDC_SMP           0xA
41 #define ACPICPU_PDC_MSR           0x1
42 
43 #define ACPICPU_PDC_P_FFH         __BIT(0)	/* SpeedStep MSRs            */
44 #define ACPICPU_PDC_C_C1_HALT     __BIT(1)	/* C1 "I/O then halt"        */
45 #define ACPICPU_PDC_T_FFH         __BIT(2)	/* OnDemand throttling MSRs  */
46 #define ACPICPU_PDC_C_C1PT        __BIT(3)	/* SMP C1, Px, and Tx (same) */
47 #define ACPICPU_PDC_C_C2C3        __BIT(4)	/* SMP C2 and C3 (same)      */
48 #define ACPICPU_PDC_P_SW          __BIT(5)	/* SMP Px (different)        */
49 #define ACPICPU_PDC_C_SW          __BIT(6)	/* SMP Cx (different)        */
50 #define ACPICPU_PDC_T_SW          __BIT(7)	/* SMP Tx (different)        */
51 #define ACPICPU_PDC_C_C1_FFH      __BIT(8)	/* SMP C1 native beyond halt */
52 #define ACPICPU_PDC_C_C2C3_FFH    __BIT(9)	/* SMP C2 and C2 native      */
53 #define ACPICPU_PDC_P_HWF         __BIT(11)	/* Px hardware feedback      */
54 
55 #define ACPICPU_PDC_GAS_HW	  __BIT(0)	/* HW-coordinated state      */
56 #define ACPICPU_PDC_GAS_BM	  __BIT(1)	/* Bus master check required */
57 
58 /*
59  * Notify values.
60  */
61 #define ACPICPU_P_NOTIFY	 0x80		/* _PPC */
62 #define ACPICPU_C_NOTIFY	 0x81		/* _CST */
63 #define ACPICPU_T_NOTIFY	 0x82		/* _TPC */
64 
65 /*
66  * Dependency coordination.
67  */
68 #define ACPICPU_DEP_SW_ALL	 0xFC		/* All CPUs must set a state */
69 #define ACPICPU_DEP_SW_ANY	 0xFD		/* Any CPU can set a state   */
70 #define ACPICPU_DEP_HW_ALL	 0xFE		/* HW does the coordination  */
71 
72 /*
73  * C-states.
74  */
75 #define ACPICPU_C_C2_LATENCY_MAX 100		/* us */
76 #define ACPICPU_C_C3_LATENCY_MAX 1000		/* us */
77 
78 #define ACPICPU_C_STATE_HALT	 0x01
79 #define ACPICPU_C_STATE_FFH	 0x02
80 #define ACPICPU_C_STATE_SYSIO	 0x03
81 
82 /*
83  * P-states.
84  */
85 #define ACPICPU_P_STATE_MAX	 255		/* Arbitrary upper limit     */
86 #define ACPICPU_P_STATE_RETRY	 100
87 #define ACPICPU_P_STATE_UNKNOWN	 0x0
88 
89 /*
90  * T-states.
91  */
92 #define ACPICPU_T_STATE_MAX	 0x8
93 #define ACPICPU_T_STATE_RETRY	 0xA
94 #define ACPICPU_T_STATE_UNKNOWN	 255
95 
96 /*
97  * Flags.
98  */
99 #define ACPICPU_FLAG_C		 __BIT(0)	/* C-states supported        */
100 #define ACPICPU_FLAG_P		 __BIT(1)	/* P-states supported        */
101 #define ACPICPU_FLAG_T		 __BIT(2)	/* T-states supported        */
102 
103 #define ACPICPU_FLAG_PIIX4	 __BIT(3)	/* Broken (quirk)	     */
104 
105 #define ACPICPU_FLAG_C_FFH	 __BIT(4)	/* Native C-states           */
106 #define ACPICPU_FLAG_C_FADT	 __BIT(5)	/* C-states with FADT        */
107 #define ACPICPU_FLAG_C_DEP	 __BIT(6)	/* C-state CPU coordination  */
108 #define ACPICPU_FLAG_C_BM	 __BIT(7)	/* Bus master control        */
109 #define ACPICPU_FLAG_C_BM_STS	 __BIT(8)	/* Bus master check required */
110 #define ACPICPU_FLAG_C_ARB	 __BIT(9)	/* Bus master arbitration    */
111 #define ACPICPU_FLAG_C_TSC	 __BIT(10)	/* TSC broken, > C1, Px, Tx  */
112 #define ACPICPU_FLAG_C_APIC	 __BIT(11)	/* APIC timer broken, > C1   */
113 #define ACPICPU_FLAG_C_C1E	 __BIT(12)	/* AMD C1E detected	     */
114 
115 #define ACPICPU_FLAG_P_FFH	 __BIT(13)	/* Native P-states           */
116 #define ACPICPU_FLAG_P_DEP	 __BIT(14)	/* P-state CPU coordination  */
117 #define ACPICPU_FLAG_P_HWF	 __BIT(15)	/* HW feedback supported     */
118 #define ACPICPU_FLAG_P_XPSS	 __BIT(16)	/* Microsoft XPSS in use     */
119 #define ACPICPU_FLAG_P_TURBO	 __BIT(17)	/* Turbo Boost / Turbo Core  */
120 #define ACPICPU_FLAG_P_FIDVID	 __BIT(18)	/* AMD "FID/VID algorithm"   */
121 
122 #define ACPICPU_FLAG_T_FFH	 __BIT(19)	/* Native throttling         */
123 #define ACPICPU_FLAG_T_FADT	 __BIT(20)	/* Throttling with FADT      */
124 #define ACPICPU_FLAG_T_DEP	 __BIT(21)	/* T-state CPU coordination  */
125 
126 /*
127  * This is AML_RESOURCE_GENERIC_REGISTER,
128  * included here separately for convenience.
129  */
130 struct acpicpu_reg {
131 	uint8_t			 reg_desc;
132 	uint16_t		 reg_reslen;
133 	uint8_t			 reg_spaceid;
134 	uint8_t			 reg_bitwidth;
135 	uint8_t			 reg_bitoffset;
136 	uint8_t			 reg_accesssize;
137 	uint64_t		 reg_addr;
138 } __packed;
139 
140 struct acpicpu_dep {
141 	uint32_t		 dep_domain;
142 	uint32_t		 dep_type;
143 	uint32_t		 dep_ncpus;
144 	uint32_t		 dep_index;
145 };
146 
147 struct acpicpu_cstate {
148 	struct evcnt		 cs_evcnt;
149 	char			 cs_name[EVCNT_STRING_MAX];
150 	uint64_t		 cs_addr;
151 	uint32_t		 cs_power;
152 	uint32_t		 cs_latency;
153 	int			 cs_method;
154 	int			 cs_flags;
155 };
156 
157 /*
158  * This structure supports both the conventional _PSS and the
159  * so-called extended _PSS (XPSS). For the latter, refer to:
160  *
161  *	Microsoft Corporation: Extended PSS ACPI
162  *	Method Specification, April 2, 2007.
163  */
164 struct acpicpu_pstate {
165 	struct evcnt		 ps_evcnt;
166 	char			 ps_name[EVCNT_STRING_MAX];
167 	uint32_t		 ps_freq;
168 	uint32_t		 ps_power;
169 	uint32_t		 ps_latency;
170 	uint32_t		 ps_latency_bm;
171 	uint64_t		 ps_control;
172 	uint64_t		 ps_control_addr;
173 	uint64_t		 ps_control_mask;
174 	uint64_t		 ps_status;
175 	uint64_t		 ps_status_addr;
176 	uint64_t		 ps_status_mask;
177 	int			 ps_flags;
178 };
179 
180 struct acpicpu_tstate {
181 	struct evcnt		 ts_evcnt;
182 	char			 ts_name[EVCNT_STRING_MAX];
183 	uint32_t		 ts_percent;
184 	uint32_t		 ts_power;
185 	uint32_t		 ts_latency;
186 	uint32_t		 ts_control;
187 	uint32_t		 ts_status;
188 };
189 
190 struct acpicpu_object {
191 	uint32_t		 ao_procid;
192 	uint32_t		 ao_pblklen;
193 	uint32_t		 ao_pblkaddr;
194 };
195 
196 struct acpicpu_softc {
197 	device_t		 sc_dev;
198 	struct cpu_info		*sc_ci;
199 	struct acpi_devnode	*sc_node;
200 	struct acpicpu_object	 sc_object;
201 
202 	struct acpicpu_cstate	 sc_cstate[ACPI_C_STATE_COUNT];
203 	struct acpicpu_dep	 sc_cstate_dep;
204 	uint32_t		 sc_cstate_sleep;
205 
206 	struct acpicpu_pstate	*sc_pstate;
207 	struct acpicpu_dep	 sc_pstate_dep;
208 	struct acpicpu_reg	 sc_pstate_control;
209 	struct acpicpu_reg	 sc_pstate_status;
210 	uint64_t		 sc_pstate_aperf;	/* ACPICPU_FLAG_P_HW */
211 	uint64_t		 sc_pstate_mperf;	/* ACPICPU_FLAG_P_HW*/
212 	uint32_t		 sc_pstate_current;
213 	uint32_t		 sc_pstate_saved;
214 	uint32_t		 sc_pstate_count;
215 	uint32_t		 sc_pstate_max;
216 	uint32_t		 sc_pstate_min;
217 
218 	struct acpicpu_tstate	*sc_tstate;
219 	struct acpicpu_dep	 sc_tstate_dep;
220 	struct acpicpu_reg	 sc_tstate_control;
221 	struct acpicpu_reg	 sc_tstate_status;
222 	uint32_t		 sc_tstate_current;
223 	uint32_t		 sc_tstate_count;
224 	uint32_t		 sc_tstate_max;
225 	uint32_t		 sc_tstate_min;
226 
227 	kmutex_t		 sc_mtx;
228 	uint32_t		 sc_cap;
229 	uint32_t		 sc_ncpus;
230 	uint32_t		 sc_flags;
231 	bool			 sc_cold;
232 };
233 
234 void		 acpicpu_cstate_attach(device_t);
235 int		 acpicpu_cstate_detach(device_t);
236 void		 acpicpu_cstate_start(device_t);
237 void		 acpicpu_cstate_suspend(void *);
238 void		 acpicpu_cstate_resume(void *);
239 void		 acpicpu_cstate_callback(void *);
240 void		 acpicpu_cstate_idle(void);
241 
242 void		 acpicpu_pstate_attach(device_t);
243 int		 acpicpu_pstate_detach(device_t);
244 void		 acpicpu_pstate_start(device_t);
245 void		 acpicpu_pstate_suspend(void *);
246 void		 acpicpu_pstate_resume(void *);
247 void		 acpicpu_pstate_callback(void *);
248 int		 acpicpu_pstate_get(struct cpu_info *, uint32_t *);
249 void		 acpicpu_pstate_set(struct cpu_info *, uint32_t);
250 
251 void		 acpicpu_tstate_attach(device_t);
252 int		 acpicpu_tstate_detach(device_t);
253 void		 acpicpu_tstate_start(device_t);
254 void		 acpicpu_tstate_suspend(void *);
255 void		 acpicpu_tstate_resume(void *);
256 void		 acpicpu_tstate_callback(void *);
257 int		 acpicpu_tstate_get(struct cpu_info *, uint32_t *);
258 void		 acpicpu_tstate_set(struct cpu_info *, uint32_t);
259 
260 struct cpu_info *acpicpu_md_match(device_t, cfdata_t, void *);
261 struct cpu_info *acpicpu_md_attach(device_t, device_t, void *);
262 
263 uint32_t	 acpicpu_md_cap(void);
264 uint32_t	 acpicpu_md_flags(void);
265 void		 acpicpu_md_quirk_c1e(void);
266 int		 acpicpu_md_cstate_start(struct acpicpu_softc *);
267 int		 acpicpu_md_cstate_stop(void);
268 void		 acpicpu_md_cstate_enter(int, int);
269 int		 acpicpu_md_pstate_start(struct acpicpu_softc *);
270 int		 acpicpu_md_pstate_stop(void);
271 int		 acpicpu_md_pstate_init(struct acpicpu_softc *);
272 uint8_t		 acpicpu_md_pstate_hwf(struct cpu_info *);
273 int		 acpicpu_md_pstate_get(struct acpicpu_softc *, uint32_t *);
274 int		 acpicpu_md_pstate_set(struct acpicpu_pstate *);
275 int		 acpicpu_md_tstate_get(struct acpicpu_softc *, uint32_t *);
276 int		 acpicpu_md_tstate_set(struct acpicpu_tstate *);
277 
278 #endif	/* !_SYS_DEV_ACPI_ACPI_CPU_H */
279