xref: /openbmc/linux/drivers/acpi/acpica/utglobal.c (revision afb46f79)
1 /******************************************************************************
2  *
3  * Module Name: utglobal - Global variables for the ACPI subsystem
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #define EXPORT_ACPI_INTERFACES
45 #define DEFINE_ACPI_GLOBALS
46 
47 #include <acpi/acpi.h>
48 #include "accommon.h"
49 
50 #define _COMPONENT          ACPI_UTILITIES
51 ACPI_MODULE_NAME("utglobal")
52 
53 /*******************************************************************************
54  *
55  * Static global variable initialization.
56  *
57  ******************************************************************************/
58 /* Debug output control masks */
59 u32 acpi_dbg_level = ACPI_DEBUG_DEFAULT;
60 
61 u32 acpi_dbg_layer = 0;
62 
63 /* acpi_gbl_FADT is a local copy of the FADT, converted to a common format. */
64 
65 struct acpi_table_fadt acpi_gbl_FADT;
66 u32 acpi_gbl_trace_flags;
67 acpi_name acpi_gbl_trace_method_name;
68 u8 acpi_gbl_system_awake_and_running;
69 u32 acpi_current_gpe_count;
70 
71 /*
72  * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
73  * that the ACPI hardware is no longer required. A flag in the FADT indicates
74  * a reduced HW machine, and that flag is duplicated here for convenience.
75  */
76 u8 acpi_gbl_reduced_hardware;
77 
78 /* Various state name strings */
79 
80 const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT] = {
81 	"\\_S0_",
82 	"\\_S1_",
83 	"\\_S2_",
84 	"\\_S3_",
85 	"\\_S4_",
86 	"\\_S5_"
87 };
88 
89 const char *acpi_gbl_lowest_dstate_names[ACPI_NUM_sx_w_METHODS] = {
90 	"_S0W",
91 	"_S1W",
92 	"_S2W",
93 	"_S3W",
94 	"_S4W"
95 };
96 
97 const char *acpi_gbl_highest_dstate_names[ACPI_NUM_sx_d_METHODS] = {
98 	"_S1D",
99 	"_S2D",
100 	"_S3D",
101 	"_S4D"
102 };
103 
104 /*******************************************************************************
105  *
106  * Namespace globals
107  *
108  ******************************************************************************/
109 /*
110  * Predefined ACPI Names (Built-in to the Interpreter)
111  *
112  * NOTES:
113  * 1) _SB_ is defined to be a device to allow \_SB_._INI to be run
114  *    during the initialization sequence.
115  * 2) _TZ_ is defined to be a thermal zone in order to allow ASL code to
116  *    perform a Notify() operation on it. 09/2010: Changed to type Device.
117  *    This still allows notifies, but does not confuse host code that
118  *    searches for valid thermal_zone objects.
119  */
120 const struct acpi_predefined_names acpi_gbl_pre_defined_names[] = {
121 	{"_GPE", ACPI_TYPE_LOCAL_SCOPE, NULL},
122 	{"_PR_", ACPI_TYPE_LOCAL_SCOPE, NULL},
123 	{"_SB_", ACPI_TYPE_DEVICE, NULL},
124 	{"_SI_", ACPI_TYPE_LOCAL_SCOPE, NULL},
125 	{"_TZ_", ACPI_TYPE_DEVICE, NULL},
126 	{"_REV", ACPI_TYPE_INTEGER, (char *)ACPI_CA_SUPPORT_LEVEL},
127 	{"_OS_", ACPI_TYPE_STRING, ACPI_OS_NAME},
128 	{"_GL_", ACPI_TYPE_MUTEX, (char *)1},
129 
130 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
131 	{"_OSI", ACPI_TYPE_METHOD, (char *)1},
132 #endif
133 
134 	/* Table terminator */
135 
136 	{NULL, ACPI_TYPE_ANY, NULL}
137 };
138 
139 #if (!ACPI_REDUCED_HARDWARE)
140 /******************************************************************************
141  *
142  * Event and Hardware globals
143  *
144  ******************************************************************************/
145 
146 struct acpi_bit_register_info acpi_gbl_bit_register_info[ACPI_NUM_BITREG] = {
147 	/* Name                                     Parent Register             Register Bit Position                   Register Bit Mask       */
148 
149 	/* ACPI_BITREG_TIMER_STATUS         */ {ACPI_REGISTER_PM1_STATUS,
150 						ACPI_BITPOSITION_TIMER_STATUS,
151 						ACPI_BITMASK_TIMER_STATUS},
152 	/* ACPI_BITREG_BUS_MASTER_STATUS    */ {ACPI_REGISTER_PM1_STATUS,
153 						ACPI_BITPOSITION_BUS_MASTER_STATUS,
154 						ACPI_BITMASK_BUS_MASTER_STATUS},
155 	/* ACPI_BITREG_GLOBAL_LOCK_STATUS   */ {ACPI_REGISTER_PM1_STATUS,
156 						ACPI_BITPOSITION_GLOBAL_LOCK_STATUS,
157 						ACPI_BITMASK_GLOBAL_LOCK_STATUS},
158 	/* ACPI_BITREG_POWER_BUTTON_STATUS  */ {ACPI_REGISTER_PM1_STATUS,
159 						ACPI_BITPOSITION_POWER_BUTTON_STATUS,
160 						ACPI_BITMASK_POWER_BUTTON_STATUS},
161 	/* ACPI_BITREG_SLEEP_BUTTON_STATUS  */ {ACPI_REGISTER_PM1_STATUS,
162 						ACPI_BITPOSITION_SLEEP_BUTTON_STATUS,
163 						ACPI_BITMASK_SLEEP_BUTTON_STATUS},
164 	/* ACPI_BITREG_RT_CLOCK_STATUS      */ {ACPI_REGISTER_PM1_STATUS,
165 						ACPI_BITPOSITION_RT_CLOCK_STATUS,
166 						ACPI_BITMASK_RT_CLOCK_STATUS},
167 	/* ACPI_BITREG_WAKE_STATUS          */ {ACPI_REGISTER_PM1_STATUS,
168 						ACPI_BITPOSITION_WAKE_STATUS,
169 						ACPI_BITMASK_WAKE_STATUS},
170 	/* ACPI_BITREG_PCIEXP_WAKE_STATUS   */ {ACPI_REGISTER_PM1_STATUS,
171 						ACPI_BITPOSITION_PCIEXP_WAKE_STATUS,
172 						ACPI_BITMASK_PCIEXP_WAKE_STATUS},
173 
174 	/* ACPI_BITREG_TIMER_ENABLE         */ {ACPI_REGISTER_PM1_ENABLE,
175 						ACPI_BITPOSITION_TIMER_ENABLE,
176 						ACPI_BITMASK_TIMER_ENABLE},
177 	/* ACPI_BITREG_GLOBAL_LOCK_ENABLE   */ {ACPI_REGISTER_PM1_ENABLE,
178 						ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE,
179 						ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
180 	/* ACPI_BITREG_POWER_BUTTON_ENABLE  */ {ACPI_REGISTER_PM1_ENABLE,
181 						ACPI_BITPOSITION_POWER_BUTTON_ENABLE,
182 						ACPI_BITMASK_POWER_BUTTON_ENABLE},
183 	/* ACPI_BITREG_SLEEP_BUTTON_ENABLE  */ {ACPI_REGISTER_PM1_ENABLE,
184 						ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE,
185 						ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
186 	/* ACPI_BITREG_RT_CLOCK_ENABLE      */ {ACPI_REGISTER_PM1_ENABLE,
187 						ACPI_BITPOSITION_RT_CLOCK_ENABLE,
188 						ACPI_BITMASK_RT_CLOCK_ENABLE},
189 	/* ACPI_BITREG_PCIEXP_WAKE_DISABLE  */ {ACPI_REGISTER_PM1_ENABLE,
190 						ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE,
191 						ACPI_BITMASK_PCIEXP_WAKE_DISABLE},
192 
193 	/* ACPI_BITREG_SCI_ENABLE           */ {ACPI_REGISTER_PM1_CONTROL,
194 						ACPI_BITPOSITION_SCI_ENABLE,
195 						ACPI_BITMASK_SCI_ENABLE},
196 	/* ACPI_BITREG_BUS_MASTER_RLD       */ {ACPI_REGISTER_PM1_CONTROL,
197 						ACPI_BITPOSITION_BUS_MASTER_RLD,
198 						ACPI_BITMASK_BUS_MASTER_RLD},
199 	/* ACPI_BITREG_GLOBAL_LOCK_RELEASE  */ {ACPI_REGISTER_PM1_CONTROL,
200 						ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE,
201 						ACPI_BITMASK_GLOBAL_LOCK_RELEASE},
202 	/* ACPI_BITREG_SLEEP_TYPE           */ {ACPI_REGISTER_PM1_CONTROL,
203 						ACPI_BITPOSITION_SLEEP_TYPE,
204 						ACPI_BITMASK_SLEEP_TYPE},
205 	/* ACPI_BITREG_SLEEP_ENABLE         */ {ACPI_REGISTER_PM1_CONTROL,
206 						ACPI_BITPOSITION_SLEEP_ENABLE,
207 						ACPI_BITMASK_SLEEP_ENABLE},
208 
209 	/* ACPI_BITREG_ARB_DIS              */ {ACPI_REGISTER_PM2_CONTROL,
210 						ACPI_BITPOSITION_ARB_DISABLE,
211 						ACPI_BITMASK_ARB_DISABLE}
212 };
213 
214 struct acpi_fixed_event_info acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS] = {
215 	/* ACPI_EVENT_PMTIMER       */ {ACPI_BITREG_TIMER_STATUS,
216 					ACPI_BITREG_TIMER_ENABLE,
217 					ACPI_BITMASK_TIMER_STATUS,
218 					ACPI_BITMASK_TIMER_ENABLE},
219 	/* ACPI_EVENT_GLOBAL        */ {ACPI_BITREG_GLOBAL_LOCK_STATUS,
220 					ACPI_BITREG_GLOBAL_LOCK_ENABLE,
221 					ACPI_BITMASK_GLOBAL_LOCK_STATUS,
222 					ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
223 	/* ACPI_EVENT_POWER_BUTTON  */ {ACPI_BITREG_POWER_BUTTON_STATUS,
224 					ACPI_BITREG_POWER_BUTTON_ENABLE,
225 					ACPI_BITMASK_POWER_BUTTON_STATUS,
226 					ACPI_BITMASK_POWER_BUTTON_ENABLE},
227 	/* ACPI_EVENT_SLEEP_BUTTON  */ {ACPI_BITREG_SLEEP_BUTTON_STATUS,
228 					ACPI_BITREG_SLEEP_BUTTON_ENABLE,
229 					ACPI_BITMASK_SLEEP_BUTTON_STATUS,
230 					ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
231 	/* ACPI_EVENT_RTC           */ {ACPI_BITREG_RT_CLOCK_STATUS,
232 					ACPI_BITREG_RT_CLOCK_ENABLE,
233 					ACPI_BITMASK_RT_CLOCK_STATUS,
234 					ACPI_BITMASK_RT_CLOCK_ENABLE},
235 };
236 #endif				/* !ACPI_REDUCED_HARDWARE */
237 
238 /*******************************************************************************
239  *
240  * FUNCTION:    acpi_ut_init_globals
241  *
242  * PARAMETERS:  None
243  *
244  * RETURN:      Status
245  *
246  * DESCRIPTION: Initialize ACPICA globals. All globals that require specific
247  *              initialization should be initialized here. This allows for
248  *              a warm restart.
249  *
250  ******************************************************************************/
251 
252 acpi_status acpi_ut_init_globals(void)
253 {
254 	acpi_status status;
255 	u32 i;
256 
257 	ACPI_FUNCTION_TRACE(ut_init_globals);
258 
259 	/* Create all memory caches */
260 
261 	status = acpi_ut_create_caches();
262 	if (ACPI_FAILURE(status)) {
263 		return_ACPI_STATUS(status);
264 	}
265 
266 	/* Address Range lists */
267 
268 	for (i = 0; i < ACPI_ADDRESS_RANGE_MAX; i++) {
269 		acpi_gbl_address_range_list[i] = NULL;
270 	}
271 
272 	/* Mutex locked flags */
273 
274 	for (i = 0; i < ACPI_NUM_MUTEX; i++) {
275 		acpi_gbl_mutex_info[i].mutex = NULL;
276 		acpi_gbl_mutex_info[i].thread_id = ACPI_MUTEX_NOT_ACQUIRED;
277 		acpi_gbl_mutex_info[i].use_count = 0;
278 	}
279 
280 	for (i = 0; i < ACPI_NUM_OWNERID_MASKS; i++) {
281 		acpi_gbl_owner_id_mask[i] = 0;
282 	}
283 
284 	/* Last owner_ID is never valid */
285 
286 	acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS - 1] = 0x80000000;
287 
288 	/* Event counters */
289 
290 	acpi_method_count = 0;
291 	acpi_sci_count = 0;
292 	acpi_gpe_count = 0;
293 
294 	for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
295 		acpi_fixed_event_count[i] = 0;
296 	}
297 
298 #if (!ACPI_REDUCED_HARDWARE)
299 
300 	/* GPE/SCI support */
301 
302 	acpi_gbl_all_gpes_initialized = FALSE;
303 	acpi_gbl_gpe_xrupt_list_head = NULL;
304 	acpi_gbl_gpe_fadt_blocks[0] = NULL;
305 	acpi_gbl_gpe_fadt_blocks[1] = NULL;
306 	acpi_current_gpe_count = 0;
307 
308 	acpi_gbl_global_event_handler = NULL;
309 	acpi_gbl_sci_handler_list = NULL;
310 
311 #endif				/* !ACPI_REDUCED_HARDWARE */
312 
313 	/* Global handlers */
314 
315 	acpi_gbl_global_notify[0].handler = NULL;
316 	acpi_gbl_global_notify[1].handler = NULL;
317 	acpi_gbl_exception_handler = NULL;
318 	acpi_gbl_init_handler = NULL;
319 	acpi_gbl_table_handler = NULL;
320 	acpi_gbl_interface_handler = NULL;
321 
322 	/* Global Lock support */
323 
324 	acpi_gbl_global_lock_semaphore = NULL;
325 	acpi_gbl_global_lock_mutex = NULL;
326 	acpi_gbl_global_lock_acquired = FALSE;
327 	acpi_gbl_global_lock_handle = 0;
328 	acpi_gbl_global_lock_present = FALSE;
329 
330 	/* Miscellaneous variables */
331 
332 	acpi_gbl_DSDT = NULL;
333 	acpi_gbl_cm_single_step = FALSE;
334 	acpi_gbl_shutdown = FALSE;
335 	acpi_gbl_ns_lookup_count = 0;
336 	acpi_gbl_ps_find_count = 0;
337 	acpi_gbl_acpi_hardware_present = TRUE;
338 	acpi_gbl_last_owner_id_index = 0;
339 	acpi_gbl_next_owner_id_offset = 0;
340 	acpi_gbl_trace_method_name = 0;
341 	acpi_gbl_trace_dbg_level = 0;
342 	acpi_gbl_trace_dbg_layer = 0;
343 	acpi_gbl_debugger_configuration = DEBUGGER_THREADING;
344 	acpi_gbl_db_output_flags = ACPI_DB_CONSOLE_OUTPUT;
345 	acpi_gbl_osi_mutex = NULL;
346 	acpi_gbl_reg_methods_executed = FALSE;
347 
348 	/* Hardware oriented */
349 
350 	acpi_gbl_events_initialized = FALSE;
351 	acpi_gbl_system_awake_and_running = TRUE;
352 
353 	/* Namespace */
354 
355 	acpi_gbl_module_code_list = NULL;
356 	acpi_gbl_root_node = NULL;
357 	acpi_gbl_root_node_struct.name.integer = ACPI_ROOT_NAME;
358 	acpi_gbl_root_node_struct.descriptor_type = ACPI_DESC_TYPE_NAMED;
359 	acpi_gbl_root_node_struct.type = ACPI_TYPE_DEVICE;
360 	acpi_gbl_root_node_struct.parent = NULL;
361 	acpi_gbl_root_node_struct.child = NULL;
362 	acpi_gbl_root_node_struct.peer = NULL;
363 	acpi_gbl_root_node_struct.object = NULL;
364 
365 #ifdef ACPI_DISASSEMBLER
366 	acpi_gbl_external_list = NULL;
367 	acpi_gbl_num_external_methods = 0;
368 	acpi_gbl_resolved_external_methods = 0;
369 #endif
370 
371 #ifdef ACPI_DEBUG_OUTPUT
372 	acpi_gbl_lowest_stack_pointer = ACPI_CAST_PTR(acpi_size, ACPI_SIZE_MAX);
373 #endif
374 
375 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
376 	acpi_gbl_display_final_mem_stats = FALSE;
377 	acpi_gbl_disable_mem_tracking = FALSE;
378 #endif
379 
380 #ifdef ACPI_DEBUGGER
381 	acpi_gbl_db_terminate_threads = FALSE;
382 #endif
383 
384 	return_ACPI_STATUS(AE_OK);
385 }
386 
387 /* Public globals */
388 
389 ACPI_EXPORT_SYMBOL(acpi_gbl_FADT)
390 ACPI_EXPORT_SYMBOL(acpi_dbg_level)
391 ACPI_EXPORT_SYMBOL(acpi_dbg_layer)
392 ACPI_EXPORT_SYMBOL(acpi_gpe_count)
393 ACPI_EXPORT_SYMBOL(acpi_current_gpe_count)
394