1/******************************************************************************
2 *
3 * Name: acinterp.h - Interpreter subcomponent prototypes and defines
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#ifndef __ACINTERP_H__
45#define __ACINTERP_H__
46
47#define ACPI_WALK_OPERANDS          (&(walk_state->operands [walk_state->num_operands -1]))
48
49/* Macros for tables used for debug output */
50
51#define ACPI_EXD_OFFSET(f)          (u8) ACPI_OFFSET (union acpi_operand_object,f)
52#define ACPI_EXD_NSOFFSET(f)        (u8) ACPI_OFFSET (struct acpi_namespace_node,f)
53#define ACPI_EXD_TABLE_SIZE(name)   (sizeof(name) / sizeof (struct acpi_exdump_info))
54
55/*
56 * If possible, pack the following structures to byte alignment, since we
57 * don't care about performance for debug output. Two cases where we cannot
58 * pack the structures:
59 *
60 * 1) Hardware does not support misaligned memory transfers
61 * 2) Compiler does not support pointers within packed structures
62 */
63#if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
64#pragma pack(1)
65#endif
66
67typedef const struct acpi_exdump_info {
68	u8 opcode;
69	u8 offset;
70	char *name;
71
72} acpi_exdump_info;
73
74/* Values for the Opcode field above */
75
76#define ACPI_EXD_INIT                   0
77#define ACPI_EXD_TYPE                   1
78#define ACPI_EXD_UINT8                  2
79#define ACPI_EXD_UINT16                 3
80#define ACPI_EXD_UINT32                 4
81#define ACPI_EXD_UINT64                 5
82#define ACPI_EXD_LITERAL                6
83#define ACPI_EXD_POINTER                7
84#define ACPI_EXD_ADDRESS                8
85#define ACPI_EXD_STRING                 9
86#define ACPI_EXD_BUFFER                 10
87#define ACPI_EXD_PACKAGE                11
88#define ACPI_EXD_FIELD                  12
89#define ACPI_EXD_REFERENCE              13
90#define ACPI_EXD_LIST                   14	/* Operand object list */
91#define ACPI_EXD_HDLR_LIST              15	/* Address Handler list */
92#define ACPI_EXD_RGN_LIST               16	/* Region list */
93#define ACPI_EXD_NODE                   17	/* Namespace Node */
94
95/* restore default alignment */
96
97#pragma pack()
98
99/*
100 * exconvrt - object conversion
101 */
102acpi_status
103acpi_ex_convert_to_integer(union acpi_operand_object *obj_desc,
104			   union acpi_operand_object **result_desc, u32 flags);
105
106acpi_status
107acpi_ex_convert_to_buffer(union acpi_operand_object *obj_desc,
108			  union acpi_operand_object **result_desc);
109
110acpi_status
111acpi_ex_convert_to_string(union acpi_operand_object *obj_desc,
112			  union acpi_operand_object **result_desc, u32 type);
113
114/* Types for ->String conversion */
115
116#define ACPI_EXPLICIT_BYTE_COPY         0x00000000
117#define ACPI_EXPLICIT_CONVERT_HEX       0x00000001
118#define ACPI_IMPLICIT_CONVERT_HEX       0x00000002
119#define ACPI_EXPLICIT_CONVERT_DECIMAL   0x00000003
120
121acpi_status
122acpi_ex_convert_to_target_type(acpi_object_type destination_type,
123			       union acpi_operand_object *source_desc,
124			       union acpi_operand_object **result_desc,
125			       struct acpi_walk_state *walk_state);
126
127/*
128 * exdebug - AML debug object
129 */
130void
131acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
132			u32 level, u32 index);
133
134/*
135 * exfield - ACPI AML (p-code) execution - field manipulation
136 */
137acpi_status
138acpi_ex_common_buffer_setup(union acpi_operand_object *obj_desc,
139			    u32 buffer_length, u32 * datum_count);
140
141acpi_status
142acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
143			       u64 mask,
144			       u64 field_value, u32 field_datum_byte_offset);
145
146void
147acpi_ex_get_buffer_datum(u64 *datum,
148			 void *buffer,
149			 u32 buffer_length,
150			 u32 byte_granularity, u32 buffer_offset);
151
152void
153acpi_ex_set_buffer_datum(u64 merged_datum,
154			 void *buffer,
155			 u32 buffer_length,
156			 u32 byte_granularity, u32 buffer_offset);
157
158acpi_status
159acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
160			     union acpi_operand_object *obj_desc,
161			     union acpi_operand_object **ret_buffer_desc);
162
163acpi_status
164acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
165			    union acpi_operand_object *obj_desc,
166			    union acpi_operand_object **result_desc);
167
168/*
169 * exfldio - low level field I/O
170 */
171acpi_status
172acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
173			   void *buffer, u32 buffer_length);
174
175acpi_status
176acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
177			  void *buffer, u32 buffer_length);
178
179acpi_status
180acpi_ex_access_region(union acpi_operand_object *obj_desc,
181		      u32 field_datum_byte_offset, u64 *value, u32 read_write);
182
183/*
184 * exmisc - misc support routines
185 */
186acpi_status
187acpi_ex_get_object_reference(union acpi_operand_object *obj_desc,
188			     union acpi_operand_object **return_desc,
189			     struct acpi_walk_state *walk_state);
190
191acpi_status
192acpi_ex_concat_template(union acpi_operand_object *obj_desc,
193			union acpi_operand_object *obj_desc2,
194			union acpi_operand_object **actual_return_desc,
195			struct acpi_walk_state *walk_state);
196
197acpi_status
198acpi_ex_do_concatenate(union acpi_operand_object *obj_desc,
199		       union acpi_operand_object *obj_desc2,
200		       union acpi_operand_object **actual_return_desc,
201		       struct acpi_walk_state *walk_state);
202
203acpi_status
204acpi_ex_do_logical_numeric_op(u16 opcode,
205			      u64 integer0, u64 integer1, u8 *logical_result);
206
207acpi_status
208acpi_ex_do_logical_op(u16 opcode,
209		      union acpi_operand_object *operand0,
210		      union acpi_operand_object *operand1, u8 *logical_result);
211
212u64 acpi_ex_do_math_op(u16 opcode, u64 operand0, u64 operand1);
213
214acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state);
215
216acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state);
217
218acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state);
219
220acpi_status
221acpi_ex_create_region(u8 * aml_start,
222		      u32 aml_length,
223		      u8 region_space, struct acpi_walk_state *walk_state);
224
225acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state);
226
227acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state);
228
229acpi_status
230acpi_ex_create_method(u8 * aml_start,
231		      u32 aml_length, struct acpi_walk_state *walk_state);
232
233/*
234 * exconfig - dynamic table load/unload
235 */
236acpi_status
237acpi_ex_load_op(union acpi_operand_object *obj_desc,
238		union acpi_operand_object *target,
239		struct acpi_walk_state *walk_state);
240
241acpi_status
242acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
243		      union acpi_operand_object **return_desc);
244
245acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle);
246
247/*
248 * exmutex - mutex support
249 */
250acpi_status
251acpi_ex_acquire_mutex(union acpi_operand_object *time_desc,
252		      union acpi_operand_object *obj_desc,
253		      struct acpi_walk_state *walk_state);
254
255acpi_status
256acpi_ex_acquire_mutex_object(u16 timeout,
257			     union acpi_operand_object *obj_desc,
258			     acpi_thread_id thread_id);
259
260acpi_status
261acpi_ex_release_mutex(union acpi_operand_object *obj_desc,
262		      struct acpi_walk_state *walk_state);
263
264acpi_status acpi_ex_release_mutex_object(union acpi_operand_object *obj_desc);
265
266void acpi_ex_release_all_mutexes(struct acpi_thread_state *thread);
267
268void acpi_ex_unlink_mutex(union acpi_operand_object *obj_desc);
269
270/*
271 * exprep - ACPI AML execution - prep utilities
272 */
273acpi_status
274acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
275				 u8 field_flags,
276				 u8 field_attribute,
277				 u32 field_bit_position, u32 field_bit_length);
278
279acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info);
280
281/*
282 * exsystem - Interface to OS services
283 */
284acpi_status
285acpi_ex_system_do_notify_op(union acpi_operand_object *value,
286			    union acpi_operand_object *obj_desc);
287
288acpi_status acpi_ex_system_do_sleep(u64 time);
289
290acpi_status acpi_ex_system_do_stall(u32 time);
291
292acpi_status acpi_ex_system_signal_event(union acpi_operand_object *obj_desc);
293
294acpi_status
295acpi_ex_system_wait_event(union acpi_operand_object *time,
296			  union acpi_operand_object *obj_desc);
297
298acpi_status acpi_ex_system_reset_event(union acpi_operand_object *obj_desc);
299
300acpi_status
301acpi_ex_system_wait_semaphore(acpi_semaphore semaphore, u16 timeout);
302
303acpi_status acpi_ex_system_wait_mutex(acpi_mutex mutex, u16 timeout);
304
305/*
306 * exoparg1 - ACPI AML execution, 1 operand
307 */
308acpi_status acpi_ex_opcode_0A_0T_1R(struct acpi_walk_state *walk_state);
309
310acpi_status acpi_ex_opcode_1A_0T_0R(struct acpi_walk_state *walk_state);
311
312acpi_status acpi_ex_opcode_1A_0T_1R(struct acpi_walk_state *walk_state);
313
314acpi_status acpi_ex_opcode_1A_1T_1R(struct acpi_walk_state *walk_state);
315
316acpi_status acpi_ex_opcode_1A_1T_0R(struct acpi_walk_state *walk_state);
317
318/*
319 * exoparg2 - ACPI AML execution, 2 operands
320 */
321acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state);
322
323acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state);
324
325acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state);
326
327acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state);
328
329/*
330 * exoparg3 - ACPI AML execution, 3 operands
331 */
332acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state);
333
334acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state);
335
336/*
337 * exoparg6 - ACPI AML execution, 6 operands
338 */
339acpi_status acpi_ex_opcode_6A_0T_1R(struct acpi_walk_state *walk_state);
340
341/*
342 * exresolv - Object resolution and get value functions
343 */
344acpi_status
345acpi_ex_resolve_to_value(union acpi_operand_object **stack_ptr,
346			 struct acpi_walk_state *walk_state);
347
348acpi_status
349acpi_ex_resolve_multiple(struct acpi_walk_state *walk_state,
350			 union acpi_operand_object *operand,
351			 acpi_object_type * return_type,
352			 union acpi_operand_object **return_desc);
353
354/*
355 * exresnte - resolve namespace node
356 */
357acpi_status
358acpi_ex_resolve_node_to_value(struct acpi_namespace_node **stack_ptr,
359			      struct acpi_walk_state *walk_state);
360
361/*
362 * exresop - resolve operand to value
363 */
364acpi_status
365acpi_ex_resolve_operands(u16 opcode,
366			 union acpi_operand_object **stack_ptr,
367			 struct acpi_walk_state *walk_state);
368
369/*
370 * exdump - Interpreter debug output routines
371 */
372void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth);
373
374void
375acpi_ex_dump_operands(union acpi_operand_object **operands,
376		      const char *opcode_name, u32 num_opcodes);
377
378#ifdef	ACPI_FUTURE_USAGE
379void
380acpi_ex_dump_object_descriptor(union acpi_operand_object *object, u32 flags);
381
382void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags);
383#endif				/* ACPI_FUTURE_USAGE */
384
385/*
386 * exnames - AML namestring support
387 */
388acpi_status
389acpi_ex_get_name_string(acpi_object_type data_type,
390			u8 * in_aml_address,
391			char **out_name_string, u32 * out_name_length);
392
393/*
394 * exstore - Object store support
395 */
396acpi_status
397acpi_ex_store(union acpi_operand_object *val_desc,
398	      union acpi_operand_object *dest_desc,
399	      struct acpi_walk_state *walk_state);
400
401acpi_status
402acpi_ex_store_object_to_node(union acpi_operand_object *source_desc,
403			     struct acpi_namespace_node *node,
404			     struct acpi_walk_state *walk_state,
405			     u8 implicit_conversion);
406
407#define ACPI_IMPLICIT_CONVERSION        TRUE
408#define ACPI_NO_IMPLICIT_CONVERSION     FALSE
409
410/*
411 * exstoren - resolve/store object
412 */
413acpi_status
414acpi_ex_resolve_object(union acpi_operand_object **source_desc_ptr,
415		       acpi_object_type target_type,
416		       struct acpi_walk_state *walk_state);
417
418acpi_status
419acpi_ex_store_object_to_object(union acpi_operand_object *source_desc,
420			       union acpi_operand_object *dest_desc,
421			       union acpi_operand_object **new_desc,
422			       struct acpi_walk_state *walk_state);
423
424/*
425 * exstorob - store object - buffer/string
426 */
427acpi_status
428acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
429			       union acpi_operand_object *target_desc);
430
431acpi_status
432acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
433			       union acpi_operand_object *target_desc);
434
435/*
436 * excopy - object copy
437 */
438acpi_status
439acpi_ex_copy_integer_to_index_field(union acpi_operand_object *source_desc,
440				    union acpi_operand_object *target_desc);
441
442acpi_status
443acpi_ex_copy_integer_to_bank_field(union acpi_operand_object *source_desc,
444				   union acpi_operand_object *target_desc);
445
446acpi_status
447acpi_ex_copy_data_to_named_field(union acpi_operand_object *source_desc,
448				 struct acpi_namespace_node *node);
449
450acpi_status
451acpi_ex_copy_integer_to_buffer_field(union acpi_operand_object *source_desc,
452				     union acpi_operand_object *target_desc);
453
454/*
455 * exutils - interpreter/scanner utilities
456 */
457void acpi_ex_enter_interpreter(void);
458
459void acpi_ex_exit_interpreter(void);
460
461u8 acpi_ex_truncate_for32bit_table(union acpi_operand_object *obj_desc);
462
463void acpi_ex_acquire_global_lock(u32 rule);
464
465void acpi_ex_release_global_lock(u32 rule);
466
467void acpi_ex_eisa_id_to_string(char *dest, u64 compressed_id);
468
469void acpi_ex_integer_to_string(char *dest, u64 value);
470
471u8 acpi_is_valid_space_id(u8 space_id);
472
473/*
474 * exregion - default op_region handlers
475 */
476acpi_status
477acpi_ex_system_memory_space_handler(u32 function,
478				    acpi_physical_address address,
479				    u32 bit_width,
480				    u64 *value,
481				    void *handler_context,
482				    void *region_context);
483
484acpi_status
485acpi_ex_system_io_space_handler(u32 function,
486				acpi_physical_address address,
487				u32 bit_width,
488				u64 *value,
489				void *handler_context, void *region_context);
490
491acpi_status
492acpi_ex_pci_config_space_handler(u32 function,
493				 acpi_physical_address address,
494				 u32 bit_width,
495				 u64 *value,
496				 void *handler_context, void *region_context);
497
498acpi_status
499acpi_ex_cmos_space_handler(u32 function,
500			   acpi_physical_address address,
501			   u32 bit_width,
502			   u64 *value,
503			   void *handler_context, void *region_context);
504
505acpi_status
506acpi_ex_pci_bar_space_handler(u32 function,
507			      acpi_physical_address address,
508			      u32 bit_width,
509			      u64 *value,
510			      void *handler_context, void *region_context);
511
512acpi_status
513acpi_ex_embedded_controller_space_handler(u32 function,
514					  acpi_physical_address address,
515					  u32 bit_width,
516					  u64 *value,
517					  void *handler_context,
518					  void *region_context);
519
520acpi_status
521acpi_ex_sm_bus_space_handler(u32 function,
522			     acpi_physical_address address,
523			     u32 bit_width,
524			     u64 *value,
525			     void *handler_context, void *region_context);
526
527acpi_status
528acpi_ex_data_table_space_handler(u32 function,
529				 acpi_physical_address address,
530				 u32 bit_width,
531				 u64 *value,
532				 void *handler_context, void *region_context);
533
534#endif				/* __INTERP_H__ */
535