acinterp.h

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