Loading...
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef _ACUTILS_H
11#define _ACUTILS_H
12
13extern const u8 acpi_gbl_resource_aml_sizes[];
14extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
15
16/* Strings used by the disassembler and debugger resource dump routines */
17
18#if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
19
20extern const char *acpi_gbl_bm_decode[];
21extern const char *acpi_gbl_config_decode[];
22extern const char *acpi_gbl_consume_decode[];
23extern const char *acpi_gbl_dec_decode[];
24extern const char *acpi_gbl_he_decode[];
25extern const char *acpi_gbl_io_decode[];
26extern const char *acpi_gbl_ll_decode[];
27extern const char *acpi_gbl_max_decode[];
28extern const char *acpi_gbl_mem_decode[];
29extern const char *acpi_gbl_min_decode[];
30extern const char *acpi_gbl_mtp_decode[];
31extern const char *acpi_gbl_phy_decode[];
32extern const char *acpi_gbl_rng_decode[];
33extern const char *acpi_gbl_rw_decode[];
34extern const char *acpi_gbl_shr_decode[];
35extern const char *acpi_gbl_siz_decode[];
36extern const char *acpi_gbl_trs_decode[];
37extern const char *acpi_gbl_ttp_decode[];
38extern const char *acpi_gbl_typ_decode[];
39extern const char *acpi_gbl_ppc_decode[];
40extern const char *acpi_gbl_ior_decode[];
41extern const char *acpi_gbl_dts_decode[];
42extern const char *acpi_gbl_ct_decode[];
43extern const char *acpi_gbl_sbt_decode[];
44extern const char *acpi_gbl_am_decode[];
45extern const char *acpi_gbl_sm_decode[];
46extern const char *acpi_gbl_wm_decode[];
47extern const char *acpi_gbl_cph_decode[];
48extern const char *acpi_gbl_cpo_decode[];
49extern const char *acpi_gbl_dp_decode[];
50extern const char *acpi_gbl_ed_decode[];
51extern const char *acpi_gbl_bpb_decode[];
52extern const char *acpi_gbl_sb_decode[];
53extern const char *acpi_gbl_fc_decode[];
54extern const char *acpi_gbl_pt_decode[];
55extern const char *acpi_gbl_ptyp_decode[];
56extern const char *acpi_gbl_clock_input_mode[];
57extern const char *acpi_gbl_clock_input_scale[];
58#endif
59
60/*
61 * For the iASL compiler case, the output is redirected to stderr so that
62 * any of the various ACPI errors and warnings do not appear in the output
63 * files, for either the compiler or disassembler portions of the tool.
64 */
65#ifdef ACPI_ASL_COMPILER
66
67#include <stdio.h>
68
69#define ACPI_MSG_REDIRECT_BEGIN \
70 FILE *output_file = acpi_gbl_output_file; \
71 acpi_os_redirect_output (stderr);
72
73#define ACPI_MSG_REDIRECT_END \
74 acpi_os_redirect_output (output_file);
75
76#else
77/*
78 * non-iASL case - no redirection, nothing to do
79 */
80#define ACPI_MSG_REDIRECT_BEGIN
81#define ACPI_MSG_REDIRECT_END
82#endif
83
84/*
85 * Common error message prefixes
86 */
87#ifndef ACPI_MSG_ERROR
88#define ACPI_MSG_ERROR "ACPI Error: "
89#endif
90#ifndef ACPI_MSG_WARNING
91#define ACPI_MSG_WARNING "ACPI Warning: "
92#endif
93#ifndef ACPI_MSG_INFO
94#define ACPI_MSG_INFO "ACPI: "
95#endif
96
97#ifndef ACPI_MSG_BIOS_ERROR
98#define ACPI_MSG_BIOS_ERROR "Firmware Error (ACPI): "
99#endif
100#ifndef ACPI_MSG_BIOS_WARNING
101#define ACPI_MSG_BIOS_WARNING "Firmware Warning (ACPI): "
102#endif
103
104/*
105 * Common message suffix
106 */
107#define ACPI_MSG_SUFFIX \
108 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
109
110/* Flags to indicate implicit or explicit string-to-integer conversion */
111
112#define ACPI_IMPLICIT_CONVERSION TRUE
113#define ACPI_NO_IMPLICIT_CONVERSION FALSE
114
115/* Types for Resource descriptor entries */
116
117#define ACPI_INVALID_RESOURCE 0
118#define ACPI_FIXED_LENGTH 1
119#define ACPI_VARIABLE_LENGTH 2
120#define ACPI_SMALL_VARIABLE_LENGTH 3
121
122typedef
123acpi_status (*acpi_walk_aml_callback) (u8 *aml,
124 u32 length,
125 u32 offset,
126 u8 resource_index, void **context);
127
128typedef
129acpi_status (*acpi_pkg_callback) (u8 object_type,
130 union acpi_operand_object * source_object,
131 union acpi_generic_state * state,
132 void *context);
133
134struct acpi_pkg_info {
135 u8 *free_space;
136 acpi_size length;
137 u32 object_space;
138 u32 num_packages;
139};
140
141/* Object reference counts */
142
143#define REF_INCREMENT (u16) 0
144#define REF_DECREMENT (u16) 1
145
146/* acpi_ut_dump_buffer */
147
148#define DB_BYTE_DISPLAY 0x01
149#define DB_WORD_DISPLAY 0x02
150#define DB_DWORD_DISPLAY 0x04
151#define DB_QWORD_DISPLAY 0x08
152#define DB_DISPLAY_DATA_ONLY 0x10
153
154/*
155 * utascii - ASCII utilities
156 */
157u8 acpi_ut_valid_nameseg(char *signature);
158
159u8 acpi_ut_valid_name_char(char character, u32 position);
160
161void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
162
163/*
164 * utcksum - Checksum utilities
165 */
166u8 acpi_ut_generate_checksum(void *table, u32 length, u8 original_checksum);
167
168u8 acpi_ut_checksum(u8 *buffer, u32 length);
169
170acpi_status
171acpi_ut_verify_cdat_checksum(struct acpi_table_cdat *cdat_table, u32 length);
172
173acpi_status
174acpi_ut_verify_checksum(struct acpi_table_header *table, u32 length);
175
176/*
177 * utnonansi - Non-ANSI C library functions
178 */
179void acpi_ut_strupr(char *src_string);
180
181void acpi_ut_strlwr(char *src_string);
182
183int acpi_ut_stricmp(char *string1, char *string2);
184
185/*
186 * utstrsuppt - string-to-integer conversion support functions
187 */
188acpi_status acpi_ut_convert_octal_string(char *string, u64 *return_value);
189
190acpi_status acpi_ut_convert_decimal_string(char *string, u64 *return_value_ptr);
191
192acpi_status acpi_ut_convert_hex_string(char *string, u64 *return_value_ptr);
193
194char acpi_ut_remove_whitespace(char **string);
195
196char acpi_ut_remove_leading_zeros(char **string);
197
198u8 acpi_ut_detect_hex_prefix(char **string);
199
200void acpi_ut_remove_hex_prefix(char **string);
201
202u8 acpi_ut_detect_octal_prefix(char **string);
203
204/*
205 * utstrtoul64 - string-to-integer conversion functions
206 */
207acpi_status acpi_ut_strtoul64(char *string, u64 *ret_integer);
208
209u64 acpi_ut_explicit_strtoul64(char *string);
210
211u64 acpi_ut_implicit_strtoul64(char *string);
212
213/*
214 * utglobal - Global data structures and procedures
215 */
216acpi_status acpi_ut_init_globals(void);
217
218const char *acpi_ut_get_mutex_name(u32 mutex_id);
219
220#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
221
222const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
223#endif
224
225const char *acpi_ut_get_type_name(acpi_object_type type);
226
227const char *acpi_ut_get_node_name(void *object);
228
229const char *acpi_ut_get_descriptor_name(void *object);
230
231const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
232
233const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
234
235const char *acpi_ut_get_region_name(u8 space_id);
236
237const char *acpi_ut_get_event_name(u32 event_id);
238
239const char *acpi_ut_get_argument_type_name(u32 arg_type);
240
241char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
242
243acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
244
245u8 acpi_ut_ascii_char_to_hex(int hex_char);
246
247u8 acpi_ut_valid_object_type(acpi_object_type type);
248
249/*
250 * utinit - miscellaneous initialization and shutdown
251 */
252acpi_status acpi_ut_hardware_initialize(void);
253
254void acpi_ut_subsystem_shutdown(void);
255
256/*
257 * utcopy - Object construction and conversion interfaces
258 */
259acpi_status
260acpi_ut_build_simple_object(union acpi_operand_object *obj,
261 union acpi_object *user_obj,
262 u8 *data_space, u32 *buffer_space_used);
263
264acpi_status
265acpi_ut_build_package_object(union acpi_operand_object *obj,
266 u8 *buffer, u32 *space_used);
267
268acpi_status
269acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
270 struct acpi_buffer *ret_buffer);
271
272acpi_status
273acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
274 union acpi_operand_object **internal_obj);
275
276acpi_status
277acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
278 union acpi_operand_object *dest_obj);
279
280acpi_status
281acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
282 union acpi_operand_object **dest_desc,
283 struct acpi_walk_state *walk_state);
284
285/*
286 * utcreate - Object creation
287 */
288acpi_status
289acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
290
291/*
292 * utdebug - Debug interfaces
293 */
294void acpi_ut_init_stack_ptr_trace(void);
295
296void acpi_ut_track_stack_ptr(void);
297
298void
299acpi_ut_trace(u32 line_number,
300 const char *function_name,
301 const char *module_name, u32 component_id);
302
303void
304acpi_ut_trace_ptr(u32 line_number,
305 const char *function_name,
306 const char *module_name,
307 u32 component_id, const void *pointer);
308
309void
310acpi_ut_trace_u32(u32 line_number,
311 const char *function_name,
312 const char *module_name, u32 component_id, u32 integer);
313
314void
315acpi_ut_trace_str(u32 line_number,
316 const char *function_name,
317 const char *module_name,
318 u32 component_id, const char *string);
319
320void
321acpi_ut_exit(u32 line_number,
322 const char *function_name,
323 const char *module_name, u32 component_id);
324
325void
326acpi_ut_status_exit(u32 line_number,
327 const char *function_name,
328 const char *module_name,
329 u32 component_id, acpi_status status);
330
331void
332acpi_ut_value_exit(u32 line_number,
333 const char *function_name,
334 const char *module_name, u32 component_id, u64 value);
335
336void
337acpi_ut_ptr_exit(u32 line_number,
338 const char *function_name,
339 const char *module_name, u32 component_id, u8 *ptr);
340
341void
342acpi_ut_str_exit(u32 line_number,
343 const char *function_name,
344 const char *module_name, u32 component_id, const char *string);
345
346void
347acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
348
349void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
350
351#ifdef ACPI_APPLICATION
352void
353acpi_ut_dump_buffer_to_file(ACPI_FILE file,
354 u8 *buffer,
355 u32 count, u32 display, u32 base_offset);
356#endif
357
358void acpi_ut_report_error(char *module_name, u32 line_number);
359
360void acpi_ut_report_info(char *module_name, u32 line_number);
361
362void acpi_ut_report_warning(char *module_name, u32 line_number);
363
364/*
365 * utdelete - Object deletion and reference counts
366 */
367void acpi_ut_add_reference(union acpi_operand_object *object);
368
369void acpi_ut_remove_reference(union acpi_operand_object *object);
370
371void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
372
373void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
374
375void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
376
377/*
378 * uteval - object evaluation
379 */
380acpi_status
381acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
382 const char *path,
383 u32 expected_return_btypes,
384 union acpi_operand_object **return_desc);
385
386acpi_status
387acpi_ut_evaluate_numeric_object(const char *object_name,
388 struct acpi_namespace_node *device_node,
389 u64 *value);
390
391acpi_status
392acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
393
394acpi_status
395acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
396 const char **method_names,
397 u8 method_count, u8 *out_values);
398
399/*
400 * utids - device ID support
401 */
402acpi_status
403acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
404 struct acpi_pnp_device_id ** return_id);
405
406acpi_status
407acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
408 struct acpi_pnp_device_id ** return_id);
409
410acpi_status
411acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
412 struct acpi_pnp_device_id_list ** return_cid_list);
413
414acpi_status
415acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
416 struct acpi_pnp_device_id **return_id);
417
418/*
419 * utlock - reader/writer locks
420 */
421acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
422
423void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
424
425acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
426
427acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
428
429acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
430
431void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
432
433/*
434 * utobject - internal object create/delete/cache routines
435 */
436union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
437 *module_name,
438 u32 line_number,
439 u32 component_id,
440 acpi_object_type
441 type);
442
443void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
444 u32 line_number, u32 component_id);
445
446#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
447#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
448
449void acpi_ut_delete_object_desc(union acpi_operand_object *object);
450
451u8 acpi_ut_valid_internal_object(void *object);
452
453union acpi_operand_object *acpi_ut_create_package_object(u32 count);
454
455union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
456
457union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
458
459union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
460
461acpi_status
462acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
463
464/*
465 * utosi - Support for the _OSI predefined control method
466 */
467acpi_status acpi_ut_initialize_interfaces(void);
468
469acpi_status acpi_ut_interface_terminate(void);
470
471acpi_status acpi_ut_install_interface(acpi_string interface_name);
472
473acpi_status acpi_ut_remove_interface(acpi_string interface_name);
474
475acpi_status acpi_ut_update_interfaces(u8 action);
476
477struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
478
479acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
480
481/*
482 * utpredef - support for predefined names
483 */
484const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
485 acpi_predefined_info
486 *this_name);
487
488const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
489
490void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
491
492#if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
493const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
494
495void
496acpi_ut_display_predefined_method(char *buffer,
497 const union acpi_predefined_info *this_name,
498 u8 multi_line);
499
500u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
501#endif
502
503/*
504 * utstate - Generic state creation/cache routines
505 */
506void
507acpi_ut_push_generic_state(union acpi_generic_state **list_head,
508 union acpi_generic_state *state);
509
510union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
511 **list_head);
512
513union acpi_generic_state *acpi_ut_create_generic_state(void);
514
515struct acpi_thread_state *acpi_ut_create_thread_state(void);
516
517union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
518 *object, u16 action);
519
520union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
521 void *external_object,
522 u32 index);
523
524acpi_status
525acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
526 u16 action,
527 union acpi_generic_state **state_list);
528
529union acpi_generic_state *acpi_ut_create_control_state(void);
530
531void acpi_ut_delete_generic_state(union acpi_generic_state *state);
532
533/*
534 * utmath
535 */
536acpi_status
537acpi_ut_divide(u64 in_dividend,
538 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
539
540acpi_status
541acpi_ut_short_divide(u64 in_dividend,
542 u32 divisor, u64 *out_quotient, u32 *out_remainder);
543
544acpi_status
545acpi_ut_short_multiply(u64 in_multiplicand, u32 multiplier, u64 *outproduct);
546
547acpi_status acpi_ut_short_shift_left(u64 operand, u32 count, u64 *out_result);
548
549acpi_status acpi_ut_short_shift_right(u64 operand, u32 count, u64 *out_result);
550
551/*
552 * utmisc
553 */
554const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
555 status);
556
557u8 acpi_ut_is_pci_root_bridge(char *id);
558
559#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
560u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
561#endif
562
563acpi_status
564acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
565 void *target_object,
566 acpi_pkg_callback walk_callback, void *context);
567
568/* Values for Base above (16=Hex, 10=Decimal) */
569
570#define ACPI_ANY_BASE 0
571
572u32 acpi_ut_dword_byte_swap(u32 value);
573
574void acpi_ut_set_integer_width(u8 revision);
575
576#ifdef ACPI_DEBUG_OUTPUT
577void
578acpi_ut_display_init_pathname(u8 type,
579 struct acpi_namespace_node *obj_handle,
580 const char *path);
581#endif
582
583/*
584 * utownerid - Support for Table/Method Owner IDs
585 */
586acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
587
588void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
589
590/*
591 * utresrc
592 */
593acpi_status
594acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
595 u8 *aml,
596 acpi_size aml_length,
597 acpi_walk_aml_callback user_function,
598 void **context);
599
600acpi_status
601acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
602 void *aml, u8 *return_index);
603
604u32 acpi_ut_get_descriptor_length(void *aml);
605
606u16 acpi_ut_get_resource_length(void *aml);
607
608u8 acpi_ut_get_resource_header_length(void *aml);
609
610u8 acpi_ut_get_resource_type(void *aml);
611
612acpi_status
613acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
614
615/*
616 * utstring - String and character utilities
617 */
618void acpi_ut_print_string(char *string, u16 max_length);
619
620#if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
621void ut_convert_backslashes(char *pathname);
622#endif
623
624void acpi_ut_repair_name(char *name);
625
626#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
627u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
628
629void acpi_ut_safe_strncpy(char *dest, char *source, acpi_size dest_size);
630
631u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
632
633u8
634acpi_ut_safe_strncat(char *dest,
635 acpi_size dest_size,
636 char *source, acpi_size max_transfer_length);
637#endif
638
639/*
640 * utmutex - mutex support
641 */
642acpi_status acpi_ut_mutex_initialize(void);
643
644void acpi_ut_mutex_terminate(void);
645
646acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
647
648acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
649
650/*
651 * utalloc - memory allocation and object caching
652 */
653acpi_status acpi_ut_create_caches(void);
654
655acpi_status acpi_ut_delete_caches(void);
656
657acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
658
659acpi_status
660acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
661 acpi_size required_length);
662
663#ifdef ACPI_DBG_TRACK_ALLOCATIONS
664void *acpi_ut_allocate_and_track(acpi_size size,
665 u32 component, const char *module, u32 line);
666
667void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
668 u32 component,
669 const char *module, u32 line);
670
671void
672acpi_ut_free_and_track(void *address,
673 u32 component, const char *module, u32 line);
674
675void acpi_ut_dump_allocation_info(void);
676
677void acpi_ut_dump_allocations(u32 component, const char *module);
678
679acpi_status
680acpi_ut_create_list(const char *list_name,
681 u16 object_size, struct acpi_memory_list **return_cache);
682
683#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
684
685/*
686 * utaddress - address range check
687 */
688acpi_status
689acpi_ut_add_address_range(acpi_adr_space_type space_id,
690 acpi_physical_address address,
691 u32 length, struct acpi_namespace_node *region_node);
692
693void
694acpi_ut_remove_address_range(acpi_adr_space_type space_id,
695 struct acpi_namespace_node *region_node);
696
697u32
698acpi_ut_check_address_range(acpi_adr_space_type space_id,
699 acpi_physical_address address, u32 length, u8 warn);
700
701void acpi_ut_delete_address_lists(void);
702
703/*
704 * utxferror - various error/warning output functions
705 */
706ACPI_PRINTF_LIKE(5)
707void ACPI_INTERNAL_VAR_XFACE
708acpi_ut_predefined_warning(const char *module_name,
709 u32 line_number,
710 char *pathname,
711 u16 node_flags, const char *format, ...);
712
713ACPI_PRINTF_LIKE(5)
714void ACPI_INTERNAL_VAR_XFACE
715acpi_ut_predefined_info(const char *module_name,
716 u32 line_number,
717 char *pathname,
718 u16 node_flags, const char *format, ...);
719
720ACPI_PRINTF_LIKE(5)
721void ACPI_INTERNAL_VAR_XFACE
722acpi_ut_predefined_bios_error(const char *module_name,
723 u32 line_number,
724 char *pathname,
725 u16 node_flags, const char *format, ...);
726
727void
728acpi_ut_prefixed_namespace_error(const char *module_name,
729 u32 line_number,
730 union acpi_generic_state *prefix_scope,
731 const char *internal_name,
732 acpi_status lookup_status);
733
734void
735acpi_ut_method_error(const char *module_name,
736 u32 line_number,
737 const char *message,
738 struct acpi_namespace_node *node,
739 const char *path, acpi_status lookup_status);
740
741/*
742 * Utility functions for ACPI names and IDs
743 */
744const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
745
746const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
747
748const char *acpi_ah_match_uuid(u8 *data);
749
750/*
751 * utuuid -- UUID support functions
752 */
753#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
754void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
755
756acpi_status acpi_ut_convert_uuid_to_string(char *uuid_buffer, char *out_string);
757#endif
758
759#endif /* _ACUTILS_H */
1/******************************************************************************
2 *
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, 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 _ACUTILS_H
45#define _ACUTILS_H
46
47extern const u8 acpi_gbl_resource_aml_sizes[];
48
49/* Strings used by the disassembler and debugger resource dump routines */
50
51#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
52
53extern const char *acpi_gbl_bm_decode[];
54extern const char *acpi_gbl_config_decode[];
55extern const char *acpi_gbl_consume_decode[];
56extern const char *acpi_gbl_dec_decode[];
57extern const char *acpi_gbl_he_decode[];
58extern const char *acpi_gbl_io_decode[];
59extern const char *acpi_gbl_ll_decode[];
60extern const char *acpi_gbl_max_decode[];
61extern const char *acpi_gbl_mem_decode[];
62extern const char *acpi_gbl_min_decode[];
63extern const char *acpi_gbl_mtp_decode[];
64extern const char *acpi_gbl_rng_decode[];
65extern const char *acpi_gbl_rw_decode[];
66extern const char *acpi_gbl_shr_decode[];
67extern const char *acpi_gbl_siz_decode[];
68extern const char *acpi_gbl_trs_decode[];
69extern const char *acpi_gbl_ttp_decode[];
70extern const char *acpi_gbl_typ_decode[];
71#endif
72
73/* Types for Resource descriptor entries */
74
75#define ACPI_INVALID_RESOURCE 0
76#define ACPI_FIXED_LENGTH 1
77#define ACPI_VARIABLE_LENGTH 2
78#define ACPI_SMALL_VARIABLE_LENGTH 3
79
80typedef
81acpi_status(*acpi_walk_aml_callback) (u8 * aml,
82 u32 length,
83 u32 offset,
84 u8 resource_index, void **context);
85
86typedef
87acpi_status(*acpi_pkg_callback) (u8 object_type,
88 union acpi_operand_object * source_object,
89 union acpi_generic_state * state,
90 void *context);
91
92struct acpi_pkg_info {
93 u8 *free_space;
94 acpi_size length;
95 u32 object_space;
96 u32 num_packages;
97};
98
99#define REF_INCREMENT (u16) 0
100#define REF_DECREMENT (u16) 1
101#define REF_FORCE_DELETE (u16) 2
102
103/* acpi_ut_dump_buffer */
104
105#define DB_BYTE_DISPLAY 1
106#define DB_WORD_DISPLAY 2
107#define DB_DWORD_DISPLAY 4
108#define DB_QWORD_DISPLAY 8
109
110/*
111 * utglobal - Global data structures and procedures
112 */
113acpi_status acpi_ut_init_globals(void);
114
115#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
116
117char *acpi_ut_get_mutex_name(u32 mutex_id);
118
119const char *acpi_ut_get_notify_name(u32 notify_value);
120
121#endif
122
123char *acpi_ut_get_type_name(acpi_object_type type);
124
125char *acpi_ut_get_node_name(void *object);
126
127char *acpi_ut_get_descriptor_name(void *object);
128
129const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
130
131char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
132
133char *acpi_ut_get_region_name(u8 space_id);
134
135char *acpi_ut_get_event_name(u32 event_id);
136
137char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
138
139u8 acpi_ut_valid_object_type(acpi_object_type type);
140
141/*
142 * utinit - miscellaneous initialization and shutdown
143 */
144acpi_status acpi_ut_hardware_initialize(void);
145
146void acpi_ut_subsystem_shutdown(void);
147
148/*
149 * utclib - Local implementations of C library functions
150 */
151#ifndef ACPI_USE_SYSTEM_CLIBRARY
152
153acpi_size acpi_ut_strlen(const char *string);
154
155char *acpi_ut_strcpy(char *dst_string, const char *src_string);
156
157char *acpi_ut_strncpy(char *dst_string,
158 const char *src_string, acpi_size count);
159
160int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
161
162int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
163
164int acpi_ut_strcmp(const char *string1, const char *string2);
165
166char *acpi_ut_strcat(char *dst_string, const char *src_string);
167
168char *acpi_ut_strncat(char *dst_string,
169 const char *src_string, acpi_size count);
170
171u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
172
173char *acpi_ut_strstr(char *string1, char *string2);
174
175void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
176
177void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
178
179int acpi_ut_to_upper(int c);
180
181int acpi_ut_to_lower(int c);
182
183extern const u8 _acpi_ctype[];
184
185#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
186#define _ACPI_XS 0x40 /* extra space */
187#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
188#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
189#define _ACPI_DI 0x04 /* '0'-'9' */
190#define _ACPI_LO 0x02 /* 'a'-'z' */
191#define _ACPI_PU 0x10 /* punctuation */
192#define _ACPI_SP 0x08 /* space */
193#define _ACPI_UP 0x01 /* 'A'-'Z' */
194#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
195
196#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
197#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
198#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
199#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
200#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
201#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
202#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
203
204#endif /* ACPI_USE_SYSTEM_CLIBRARY */
205
206/*
207 * utcopy - Object construction and conversion interfaces
208 */
209acpi_status
210acpi_ut_build_simple_object(union acpi_operand_object *obj,
211 union acpi_object *user_obj,
212 u8 * data_space, u32 * buffer_space_used);
213
214acpi_status
215acpi_ut_build_package_object(union acpi_operand_object *obj,
216 u8 * buffer, u32 * space_used);
217
218acpi_status
219acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
220 struct acpi_buffer *ret_buffer);
221
222acpi_status
223acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
224 union acpi_operand_object **internal_obj);
225
226acpi_status
227acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
228 union acpi_operand_object *dest_obj);
229
230acpi_status
231acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
232 union acpi_operand_object **dest_desc,
233 struct acpi_walk_state *walk_state);
234
235/*
236 * utcreate - Object creation
237 */
238acpi_status
239acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
240
241/*
242 * utdebug - Debug interfaces
243 */
244void acpi_ut_init_stack_ptr_trace(void);
245
246void acpi_ut_track_stack_ptr(void);
247
248void
249acpi_ut_trace(u32 line_number,
250 const char *function_name,
251 const char *module_name, u32 component_id);
252
253void
254acpi_ut_trace_ptr(u32 line_number,
255 const char *function_name,
256 const char *module_name, u32 component_id, void *pointer);
257
258void
259acpi_ut_trace_u32(u32 line_number,
260 const char *function_name,
261 const char *module_name, u32 component_id, u32 integer);
262
263void
264acpi_ut_trace_str(u32 line_number,
265 const char *function_name,
266 const char *module_name, u32 component_id, char *string);
267
268void
269acpi_ut_exit(u32 line_number,
270 const char *function_name,
271 const char *module_name, u32 component_id);
272
273void
274acpi_ut_status_exit(u32 line_number,
275 const char *function_name,
276 const char *module_name,
277 u32 component_id, acpi_status status);
278
279void
280acpi_ut_value_exit(u32 line_number,
281 const char *function_name,
282 const char *module_name, u32 component_id, u64 value);
283
284void
285acpi_ut_ptr_exit(u32 line_number,
286 const char *function_name,
287 const char *module_name, u32 component_id, u8 *ptr);
288
289void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
290
291void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display);
292
293void acpi_ut_report_error(char *module_name, u32 line_number);
294
295void acpi_ut_report_info(char *module_name, u32 line_number);
296
297void acpi_ut_report_warning(char *module_name, u32 line_number);
298
299/*
300 * utdelete - Object deletion and reference counts
301 */
302void acpi_ut_add_reference(union acpi_operand_object *object);
303
304void acpi_ut_remove_reference(union acpi_operand_object *object);
305
306void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
307
308void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
309
310void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
311
312/*
313 * uteval - object evaluation
314 */
315acpi_status
316acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
317 char *path,
318 u32 expected_return_btypes,
319 union acpi_operand_object **return_desc);
320
321acpi_status
322acpi_ut_evaluate_numeric_object(char *object_name,
323 struct acpi_namespace_node *device_node,
324 u64 *value);
325
326acpi_status
327acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
328
329acpi_status
330acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
331 const char **method_names,
332 u8 method_count, u8 *out_values);
333
334/*
335 * utids - device ID support
336 */
337acpi_status
338acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
339 struct acpica_device_id **return_id);
340
341acpi_status
342acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
343 struct acpica_device_id **return_id);
344
345acpi_status
346acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
347 struct acpica_device_id_list **return_cid_list);
348
349/*
350 * utlock - reader/writer locks
351 */
352acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
353
354void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
355
356acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
357
358acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
359
360acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
361
362void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
363
364/*
365 * utobject - internal object create/delete/cache routines
366 */
367union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
368 *module_name,
369 u32 line_number,
370 u32 component_id,
371 acpi_object_type
372 type);
373
374void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
375 u32 line_number, u32 component_id);
376
377#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
378#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
379
380void acpi_ut_delete_object_desc(union acpi_operand_object *object);
381
382u8 acpi_ut_valid_internal_object(void *object);
383
384union acpi_operand_object *acpi_ut_create_package_object(u32 count);
385
386union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
387
388union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
389
390union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
391
392acpi_status
393acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
394
395/*
396 * utosi - Support for the _OSI predefined control method
397 */
398acpi_status acpi_ut_initialize_interfaces(void);
399
400void acpi_ut_interface_terminate(void);
401
402acpi_status acpi_ut_install_interface(acpi_string interface_name);
403
404acpi_status acpi_ut_remove_interface(acpi_string interface_name);
405
406struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
407
408acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
409
410/*
411 * utstate - Generic state creation/cache routines
412 */
413void
414acpi_ut_push_generic_state(union acpi_generic_state **list_head,
415 union acpi_generic_state *state);
416
417union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
418 **list_head);
419
420union acpi_generic_state *acpi_ut_create_generic_state(void);
421
422struct acpi_thread_state *acpi_ut_create_thread_state(void);
423
424union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
425 *object, u16 action);
426
427union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
428 void *external_object,
429 u16 index);
430
431acpi_status
432acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
433 u16 action,
434 union acpi_generic_state **state_list);
435
436#ifdef ACPI_FUTURE_USAGE
437acpi_status
438acpi_ut_create_pkg_state_and_push(void *internal_object,
439 void *external_object,
440 u16 index,
441 union acpi_generic_state **state_list);
442#endif /* ACPI_FUTURE_USAGE */
443
444union acpi_generic_state *acpi_ut_create_control_state(void);
445
446void acpi_ut_delete_generic_state(union acpi_generic_state *state);
447
448/*
449 * utmath
450 */
451acpi_status
452acpi_ut_divide(u64 in_dividend,
453 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
454
455acpi_status
456acpi_ut_short_divide(u64 in_dividend,
457 u32 divisor, u64 *out_quotient, u32 *out_remainder);
458
459/*
460 * utmisc
461 */
462const char *acpi_ut_validate_exception(acpi_status status);
463
464u8 acpi_ut_is_pci_root_bridge(char *id);
465
466u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
467
468acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
469
470void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
471
472acpi_status
473acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
474 void *target_object,
475 acpi_pkg_callback walk_callback, void *context);
476
477void acpi_ut_strupr(char *src_string);
478
479void acpi_ut_print_string(char *string, u8 max_length);
480
481u8 acpi_ut_valid_acpi_name(u32 name);
482
483acpi_name acpi_ut_repair_name(char *name);
484
485u8 acpi_ut_valid_acpi_char(char character, u32 position);
486
487acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 * ret_integer);
488
489/* Values for Base above (16=Hex, 10=Decimal) */
490
491#define ACPI_ANY_BASE 0
492
493u32 acpi_ut_dword_byte_swap(u32 value);
494
495void acpi_ut_set_integer_width(u8 revision);
496
497#ifdef ACPI_DEBUG_OUTPUT
498void
499acpi_ut_display_init_pathname(u8 type,
500 struct acpi_namespace_node *obj_handle,
501 char *path);
502#endif
503
504/*
505 * utresrc
506 */
507acpi_status
508acpi_ut_walk_aml_resources(u8 * aml,
509 acpi_size aml_length,
510 acpi_walk_aml_callback user_function,
511 void **context);
512
513acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
514
515u32 acpi_ut_get_descriptor_length(void *aml);
516
517u16 acpi_ut_get_resource_length(void *aml);
518
519u8 acpi_ut_get_resource_header_length(void *aml);
520
521u8 acpi_ut_get_resource_type(void *aml);
522
523acpi_status
524acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
525 u8 ** end_tag);
526
527/*
528 * utmutex - mutex support
529 */
530acpi_status acpi_ut_mutex_initialize(void);
531
532void acpi_ut_mutex_terminate(void);
533
534acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
535
536acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
537
538/*
539 * utalloc - memory allocation and object caching
540 */
541acpi_status acpi_ut_create_caches(void);
542
543acpi_status acpi_ut_delete_caches(void);
544
545acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
546
547acpi_status
548acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
549 acpi_size required_length);
550
551void *acpi_ut_allocate(acpi_size size,
552 u32 component, const char *module, u32 line);
553
554void *acpi_ut_allocate_zeroed(acpi_size size,
555 u32 component, const char *module, u32 line);
556
557#ifdef ACPI_DBG_TRACK_ALLOCATIONS
558void *acpi_ut_allocate_and_track(acpi_size size,
559 u32 component, const char *module, u32 line);
560
561void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
562 u32 component,
563 const char *module, u32 line);
564
565void
566acpi_ut_free_and_track(void *address,
567 u32 component, const char *module, u32 line);
568
569#ifdef ACPI_FUTURE_USAGE
570void acpi_ut_dump_allocation_info(void);
571#endif /* ACPI_FUTURE_USAGE */
572
573void acpi_ut_dump_allocations(u32 component, const char *module);
574
575acpi_status
576acpi_ut_create_list(char *list_name,
577 u16 object_size, struct acpi_memory_list **return_cache);
578
579#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
580
581/*
582 * utxferror - various error/warning output functions
583 */
584void ACPI_INTERNAL_VAR_XFACE
585acpi_ut_predefined_warning(const char *module_name,
586 u32 line_number,
587 char *pathname,
588 u8 node_flags, const char *format, ...);
589
590void ACPI_INTERNAL_VAR_XFACE
591acpi_ut_predefined_info(const char *module_name,
592 u32 line_number,
593 char *pathname, u8 node_flags, const char *format, ...);
594
595void
596acpi_ut_namespace_error(const char *module_name,
597 u32 line_number,
598 const char *internal_name, acpi_status lookup_status);
599
600void
601acpi_ut_method_error(const char *module_name,
602 u32 line_number,
603 const char *message,
604 struct acpi_namespace_node *node,
605 const char *path, acpi_status lookup_status);
606
607#endif /* _ACUTILS_H */