xref: /titanic_44/usr/src/uts/i86pc/sys/cpudrv_mach.h (revision 95efa359b507db290a2484b8f615822b1e06096f)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_CPUDRV_MACH_H
27 #define	_SYS_CPUDRV_MACH_H
28 
29 #include <sys/cpuvar.h>
30 #include <sys/cpupm.h>
31 #include <sys/cpu_acpi.h>
32 #include <sys/cpudrv.h>
33 #include <sys/ksynch.h>
34 
35 #ifdef  __cplusplus
36 extern "C" {
37 #endif
38 
39 /*
40  * We currently refuse to power manage if the CPU in not ready to
41  * take cross calls (cross calls fail silently if CPU is not ready
42  * for it).
43  */
44 extern cpuset_t cpu_ready_set;
45 #define	CPUDRV_PM_XCALL_IS_READY(cpuid) CPU_IN_SET(cpu_ready_set, (cpuid))
46 
47 /*
48  * An error attaching any of the devices results in disabling
49  * CPU power management.
50  */
51 #define	CPUDRV_PM_DISABLE() cpupm_disable(CPUPM_ALL_STATES)
52 
53 /*
54  * If no power management states are enabled, then CPU power
55  * management is disabled.
56  */
57 #define	CPUDRV_PM_DISABLED() \
58 	(!cpupm_is_enabled(CPUPM_P_STATES) && !cpupm_is_enabled(CPUPM_T_STATES))
59 
60 /*
61  * Is P-state management enabled?
62  */
63 #define	CPUDRV_PM_POWER_ENABLED(cpudsp) \
64 	(((cpudrv_mach_state_t *)cpudsp->mach_state)->caps & CPUDRV_P_STATES)
65 
66 /*
67  * We're about to exit the _PPC thread so reset tag.
68  */
69 #define	CPUDRV_PM_RESET_GOVERNOR_THREAD(cpupm) { \
70 	if (curthread == cpupm->pm_governor_thread) \
71 		cpupm->pm_governor_thread = NULL; \
72 }
73 
74 /*
75  * The current top speed as defined by the _PPC.
76  */
77 #define	CPUDRV_PM_TOPSPEED(cpupm)	(cpupm)->top_spd
78 
79 /*
80  * Install a _PPC/_TPC change notification handler.
81  */
82 #define	CPUDRV_PM_INSTALL_MAX_CHANGE_HANDLER(cpudsp, dip) \
83 	cpudrv_pm_install_notify_handler(cpudsp, dip);
84 
85 /*
86  * Redefine the topspeed.
87  */
88 #define	CPUDRV_PM_REDEFINE_TOPSPEED(dip) cpudrv_pm_redefine_topspeed(dip)
89 
90 /*
91  * Set callbacks so that PPM can callback into CPUDRV
92  */
93 #define	CPUDRV_PM_SET_PPM_CALLBACKS() { \
94 	cpupm_get_topspeed = cpudrv_pm_get_topspeed; \
95 	cpupm_set_topspeed = cpudrv_pm_set_topspeed; \
96 }
97 
98 /*
99  * ACPI provides the supported speeds.
100  */
101 #define	CPUDRV_PM_GET_SPEEDS(cpudsp, speeds, nspeeds) \
102 	nspeeds = cpudrv_pm_get_speeds(cpudsp, &speeds);
103 #define	CPUDRV_PM_FREE_SPEEDS(speeds, nspeeds) \
104 	cpudrv_pm_free_speeds(speeds, nspeeds);
105 
106 /*
107  * Convert speed to Hz.
108  */
109 #define	CPUDRV_PM_SPEED_HZ(unused, mhz) ((uint64_t)mhz * 1000000)
110 
111 /*
112  * Compute the idle cnt percentage for a given speed.
113  */
114 #define	CPUDRV_PM_IDLE_CNT_PERCENT(hwm, speeds, i) \
115 	(100 - (((100 - hwm) * speeds[0]) / speeds[i]))
116 
117 /*
118  * Compute the user cnt percentage for a given speed.
119  */
120 #define	CPUDRV_PM_USER_CNT_PERCENT(hwm, speeds, i) \
121 	((hwm * speeds[i]) / speeds[i - 1]);
122 
123 /*
124  * pm-components property defintions for this machine type.
125  *
126  * Fully constructed pm-components property should be an array of
127  * strings that look something like:
128  *
129  * pmc[0] = "NAME=CPU Speed"
130  * pmc[1] = "1=2800MHz"
131  * pmc[2] = "2=3200MHz"
132  *
133  * The amount of memory needed for each string is:
134  * 	digits for power level + '=' +  digits for freq + 'MHz' + '\0'
135  */
136 #define	CPUDRV_PM_COMP_SIZE() \
137 	(CPUDRV_PM_COMP_MAX_DIG + 1 + CPUDRV_PM_COMP_MAX_DIG + 3 + 1);
138 #define	CPUDRV_PM_COMP_SPEED(cpupm, cur_spd) cur_spd->speed;
139 #define	CPUDRV_PM_COMP_SPRINT(pmc, cpupm, cur_spd, comp_spd) \
140 	(void) sprintf(pmc, "%d=%dMHz", cur_spd->pm_level, comp_spd);
141 
142 /*
143  * T-State domain list
144  */
145 typedef struct cpudrv_tstate_domain_node {
146 	struct cpudrv_tstate_domain_node	*tdn_next;
147 	struct cpudrv_tstate_domain		*tdn_domain;
148 	cpudrv_devstate_t			*tdn_cpudsp;
149 } cpudrv_tstate_domain_node_t;
150 
151 typedef struct cpudrv_tstate_domain {
152 	struct cpudrv_tstate_domain	*td_next;
153 	cpudrv_tstate_domain_node_t	*td_node;
154 	uint32_t			td_domain;
155 	uint32_t			td_type;
156 	kmutex_t			td_lock;
157 } cpudrv_tstate_domain_t;
158 
159 extern cpudrv_tstate_domain_t *cpudrv_tstate_domains;
160 
161 /*
162  * Different processor families have their own technologies for supporting
163  * CPU power management (i.e., Intel has Enhanced SpeedStep for some of it's
164  * processors and AMD has PowerNow! for some of it's processors). We support
165  * these different technologies via modules that export the interfaces
166  * described below.
167  *
168  * If a module implements the technology that should be used to manage
169  * the current CPU device, then the cpups_init() module should return
170  * succesfully (i.e., return code of 0) and perform any initialization
171  * such that future power transistions can be performed by calling
172  * the cpups_power() interface(). And the cpups_fini() interface can be
173  * used to free any resources allocated by cpups_init().
174  */
175 typedef struct cpudrv_pstate_ops {
176 	char	*cpups_label;
177 	int	(*cpups_init)(cpudrv_devstate_t *);
178 	void	(*cpups_fini)(cpudrv_devstate_t *);
179 	int	(*cpups_power)(cpudrv_devstate_t *, uint32_t);
180 } cpudrv_pstate_ops_t;
181 
182 /*
183  * T-state support.
184  */
185 typedef struct cpudrv_tstate_ops {
186 	char	*cputs_label;
187 	int	(*cputs_init)(cpudrv_devstate_t *);
188 	void	(*cputs_fini)(cpudrv_devstate_t *);
189 	int	(*cputs_throttle)(cpudrv_devstate_t *,  uint32_t);
190 } cpudrv_tstate_ops_t;
191 
192 typedef struct cpudrv_mach_state {
193 	void			*acpi_handle;
194 	cpudrv_pstate_ops_t	*cpupm_pstate_ops;
195 	cpudrv_tstate_ops_t	*cpupm_tstate_ops;
196 	cpudrv_tstate_domain_node_t *tstate_domain_node;
197 	uint32_t		pstate;
198 	uint32_t		tstate;
199 	uint32_t		caps;
200 } cpudrv_mach_state_t;
201 
202 #define	CPUDRV_NO_STATES	0x00
203 #define	CPUDRV_P_STATES		0x01
204 #define	CPUDRV_T_STATES		0x02
205 
206 extern uint_t cpudrv_pm_get_speeds(cpudrv_devstate_t *, int **);
207 extern void cpudrv_pm_free_speeds(int *, uint_t);
208 extern void cpudrv_pm_set_topspeed(void *, int);
209 extern int cpudrv_pm_get_topspeed(void *);
210 extern void cpudrv_pm_redefine_topspeed(void *);
211 extern void cpudrv_pm_install_notify_handler(cpudrv_devstate_t *, dev_info_t *);
212 #ifdef  __cplusplus
213 }
214 #endif
215 
216 #endif /* _SYS_CPUDRV_MACH_H */
217