1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44#ifndef _ACUTILS_H
45#define _ACUTILS_H
46
47extern const u8 acpi_gbl_resource_aml_sizes[];
48extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
49
50
51
52#if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
53
54extern const char *acpi_gbl_bm_decode[];
55extern const char *acpi_gbl_config_decode[];
56extern const char *acpi_gbl_consume_decode[];
57extern const char *acpi_gbl_dec_decode[];
58extern const char *acpi_gbl_he_decode[];
59extern const char *acpi_gbl_io_decode[];
60extern const char *acpi_gbl_ll_decode[];
61extern const char *acpi_gbl_max_decode[];
62extern const char *acpi_gbl_mem_decode[];
63extern const char *acpi_gbl_min_decode[];
64extern const char *acpi_gbl_mtp_decode[];
65extern const char *acpi_gbl_rng_decode[];
66extern const char *acpi_gbl_rw_decode[];
67extern const char *acpi_gbl_shr_decode[];
68extern const char *acpi_gbl_siz_decode[];
69extern const char *acpi_gbl_trs_decode[];
70extern const char *acpi_gbl_ttp_decode[];
71extern const char *acpi_gbl_typ_decode[];
72extern const char *acpi_gbl_ppc_decode[];
73extern const char *acpi_gbl_ior_decode[];
74extern const char *acpi_gbl_dts_decode[];
75extern const char *acpi_gbl_ct_decode[];
76extern const char *acpi_gbl_sbt_decode[];
77extern const char *acpi_gbl_am_decode[];
78extern const char *acpi_gbl_sm_decode[];
79extern const char *acpi_gbl_wm_decode[];
80extern const char *acpi_gbl_cph_decode[];
81extern const char *acpi_gbl_cpo_decode[];
82extern const char *acpi_gbl_dp_decode[];
83extern const char *acpi_gbl_ed_decode[];
84extern const char *acpi_gbl_bpb_decode[];
85extern const char *acpi_gbl_sb_decode[];
86extern const char *acpi_gbl_fc_decode[];
87extern const char *acpi_gbl_pt_decode[];
88#endif
89
90
91
92
93
94
95#ifdef ACPI_ASL_COMPILER
96
97#include <stdio.h>
98
99#define ACPI_MSG_REDIRECT_BEGIN \
100 FILE *output_file = acpi_gbl_output_file; \
101 acpi_os_redirect_output (stderr);
102
103#define ACPI_MSG_REDIRECT_END \
104 acpi_os_redirect_output (output_file);
105
106#else
107
108
109
110#define ACPI_MSG_REDIRECT_BEGIN
111#define ACPI_MSG_REDIRECT_END
112#endif
113
114
115
116
117#ifndef ACPI_MSG_ERROR
118#define ACPI_MSG_ERROR "ACPI Error: "
119#endif
120#ifndef ACPI_MSG_EXCEPTION
121#define ACPI_MSG_EXCEPTION "ACPI Exception: "
122#endif
123#ifndef ACPI_MSG_WARNING
124#define ACPI_MSG_WARNING "ACPI Warning: "
125#endif
126#ifndef ACPI_MSG_INFO
127#define ACPI_MSG_INFO "ACPI: "
128#endif
129
130#ifndef ACPI_MSG_BIOS_ERROR
131#define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
132#endif
133#ifndef ACPI_MSG_BIOS_WARNING
134#define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
135#endif
136
137
138
139
140#define ACPI_MSG_SUFFIX \
141 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
142
143
144
145#define ACPI_INVALID_RESOURCE 0
146#define ACPI_FIXED_LENGTH 1
147#define ACPI_VARIABLE_LENGTH 2
148#define ACPI_SMALL_VARIABLE_LENGTH 3
149
150typedef
151acpi_status (*acpi_walk_aml_callback) (u8 *aml,
152 u32 length,
153 u32 offset,
154 u8 resource_index, void **context);
155
156typedef
157acpi_status (*acpi_pkg_callback) (u8 object_type,
158 union acpi_operand_object * source_object,
159 union acpi_generic_state * state,
160 void *context);
161
162struct acpi_pkg_info {
163 u8 *free_space;
164 acpi_size length;
165 u32 object_space;
166 u32 num_packages;
167};
168
169
170
171#define REF_INCREMENT (u16) 0
172#define REF_DECREMENT (u16) 1
173
174
175
176#define DB_BYTE_DISPLAY 1
177#define DB_WORD_DISPLAY 2
178#define DB_DWORD_DISPLAY 4
179#define DB_QWORD_DISPLAY 8
180
181
182
183
184u8 acpi_ut_valid_nameseg(char *signature);
185
186u8 acpi_ut_valid_name_char(char character, u32 position);
187
188void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
189
190
191
192
193void acpi_ut_strupr(char *src_string);
194
195void acpi_ut_strlwr(char *src_string);
196
197int acpi_ut_stricmp(char *string1, char *string2);
198
199acpi_status acpi_ut_strtoul64(char *string, u32 flags, u64 *ret_integer);
200
201
202
203
204
205#define ACPI_STRTOUL_32BIT 0x04
206#define ACPI_STRTOUL_64BIT 0x08
207#define ACPI_STRTOUL_BASE16 0x10
208
209
210
211
212acpi_status acpi_ut_init_globals(void);
213
214#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
215
216const char *acpi_ut_get_mutex_name(u32 mutex_id);
217
218const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
219#endif
220
221const char *acpi_ut_get_type_name(acpi_object_type type);
222
223const char *acpi_ut_get_node_name(void *object);
224
225const char *acpi_ut_get_descriptor_name(void *object);
226
227const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
228
229const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
230
231const char *acpi_ut_get_region_name(u8 space_id);
232
233const char *acpi_ut_get_event_name(u32 event_id);
234
235const char *acpi_ut_get_argument_type_name(u32 arg_type);
236
237char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
238
239acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
240
241u8 acpi_ut_ascii_char_to_hex(int hex_char);
242
243u8 acpi_ut_valid_object_type(acpi_object_type type);
244
245
246
247
248acpi_status acpi_ut_hardware_initialize(void);
249
250void acpi_ut_subsystem_shutdown(void);
251
252
253
254
255acpi_status
256acpi_ut_build_simple_object(union acpi_operand_object *obj,
257 union acpi_object *user_obj,
258 u8 *data_space, u32 *buffer_space_used);
259
260acpi_status
261acpi_ut_build_package_object(union acpi_operand_object *obj,
262 u8 *buffer, u32 *space_used);
263
264acpi_status
265acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
266 struct acpi_buffer *ret_buffer);
267
268acpi_status
269acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
270 union acpi_operand_object **internal_obj);
271
272acpi_status
273acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
274 union acpi_operand_object *dest_obj);
275
276acpi_status
277acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
278 union acpi_operand_object **dest_desc,
279 struct acpi_walk_state *walk_state);
280
281
282
283
284acpi_status
285acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
286
287
288
289
290void acpi_ut_init_stack_ptr_trace(void);
291
292void acpi_ut_track_stack_ptr(void);
293
294void
295acpi_ut_trace(u32 line_number,
296 const char *function_name,
297 const char *module_name, u32 component_id);
298
299void
300acpi_ut_trace_ptr(u32 line_number,
301 const char *function_name,
302 const char *module_name,
303 u32 component_id, const void *pointer);
304
305void
306acpi_ut_trace_u32(u32 line_number,
307 const char *function_name,
308 const char *module_name, u32 component_id, u32 integer);
309
310void
311acpi_ut_trace_str(u32 line_number,
312 const char *function_name,
313 const char *module_name,
314 u32 component_id, const char *string);
315
316void
317acpi_ut_exit(u32 line_number,
318 const char *function_name,
319 const char *module_name, u32 component_id);
320
321void
322acpi_ut_status_exit(u32 line_number,
323 const char *function_name,
324 const char *module_name,
325 u32 component_id, acpi_status status);
326
327void
328acpi_ut_value_exit(u32 line_number,
329 const char *function_name,
330 const char *module_name, u32 component_id, u64 value);
331
332void
333acpi_ut_ptr_exit(u32 line_number,
334 const char *function_name,
335 const char *module_name, u32 component_id, u8 *ptr);
336
337void
338acpi_ut_str_exit(u32 line_number,
339 const char *function_name,
340 const char *module_name, u32 component_id, const char *string);
341
342void
343acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
344
345void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
346
347#ifdef ACPI_APPLICATION
348void
349acpi_ut_dump_buffer_to_file(ACPI_FILE file,
350 u8 *buffer,
351 u32 count, u32 display, u32 base_offset);
352#endif
353
354void acpi_ut_report_error(char *module_name, u32 line_number);
355
356void acpi_ut_report_info(char *module_name, u32 line_number);
357
358void acpi_ut_report_warning(char *module_name, u32 line_number);
359
360
361
362
363void acpi_ut_add_reference(union acpi_operand_object *object);
364
365void acpi_ut_remove_reference(union acpi_operand_object *object);
366
367void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
368
369void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
370
371void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
372
373
374
375
376acpi_status
377acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
378 const char *path,
379 u32 expected_return_btypes,
380 union acpi_operand_object **return_desc);
381
382acpi_status
383acpi_ut_evaluate_numeric_object(const char *object_name,
384 struct acpi_namespace_node *device_node,
385 u64 *value);
386
387acpi_status
388acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
389
390acpi_status
391acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
392 const char **method_names,
393 u8 method_count, u8 *out_values);
394
395
396
397
398acpi_status
399acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
400 struct acpi_pnp_device_id ** return_id);
401
402acpi_status
403acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
404 struct acpi_pnp_device_id ** return_id);
405
406acpi_status
407acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
408 struct acpi_pnp_device_id_list ** return_cid_list);
409
410acpi_status
411acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
412 struct acpi_pnp_device_id **return_id);
413
414
415
416
417acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
418
419void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
420
421acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
422
423acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
424
425acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
426
427void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
428
429
430
431
432union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
433 *module_name,
434 u32 line_number,
435 u32 component_id,
436 acpi_object_type
437 type);
438
439void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
440 u32 line_number, u32 component_id);
441
442#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
443#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
444
445void acpi_ut_delete_object_desc(union acpi_operand_object *object);
446
447u8 acpi_ut_valid_internal_object(void *object);
448
449union acpi_operand_object *acpi_ut_create_package_object(u32 count);
450
451union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
452
453union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
454
455union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
456
457acpi_status
458acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
459
460
461
462
463acpi_status acpi_ut_initialize_interfaces(void);
464
465acpi_status acpi_ut_interface_terminate(void);
466
467acpi_status acpi_ut_install_interface(acpi_string interface_name);
468
469acpi_status acpi_ut_remove_interface(acpi_string interface_name);
470
471acpi_status acpi_ut_update_interfaces(u8 action);
472
473struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
474
475acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
476
477
478
479
480const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
481 acpi_predefined_info
482 *this_name);
483
484const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
485
486void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
487
488#if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
489const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
490
491void
492acpi_ut_display_predefined_method(char *buffer,
493 const union acpi_predefined_info *this_name,
494 u8 multi_line);
495
496u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
497#endif
498
499
500
501
502void
503acpi_ut_push_generic_state(union acpi_generic_state **list_head,
504 union acpi_generic_state *state);
505
506union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
507 **list_head);
508
509union acpi_generic_state *acpi_ut_create_generic_state(void);
510
511struct acpi_thread_state *acpi_ut_create_thread_state(void);
512
513union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
514 *object, u16 action);
515
516union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
517 void *external_object,
518 u16 index);
519
520acpi_status
521acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
522 u16 action,
523 union acpi_generic_state **state_list);
524
525union acpi_generic_state *acpi_ut_create_control_state(void);
526
527void acpi_ut_delete_generic_state(union acpi_generic_state *state);
528
529
530
531
532acpi_status
533acpi_ut_divide(u64 in_dividend,
534 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
535
536acpi_status
537acpi_ut_short_divide(u64 in_dividend,
538 u32 divisor, u64 *out_quotient, u32 *out_remainder);
539
540
541
542
543const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
544 status);
545
546u8 acpi_ut_is_pci_root_bridge(char *id);
547
548#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
549u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
550#endif
551
552acpi_status
553acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
554 void *target_object,
555 acpi_pkg_callback walk_callback, void *context);
556
557
558
559#define ACPI_ANY_BASE 0
560
561u32 acpi_ut_dword_byte_swap(u32 value);
562
563void acpi_ut_set_integer_width(u8 revision);
564
565#ifdef ACPI_DEBUG_OUTPUT
566void
567acpi_ut_display_init_pathname(u8 type,
568 struct acpi_namespace_node *obj_handle,
569 const char *path);
570#endif
571
572
573
574
575acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
576
577void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
578
579
580
581
582acpi_status
583acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
584 u8 *aml,
585 acpi_size aml_length,
586 acpi_walk_aml_callback user_function,
587 void **context);
588
589acpi_status
590acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
591 void *aml, u8 *return_index);
592
593u32 acpi_ut_get_descriptor_length(void *aml);
594
595u16 acpi_ut_get_resource_length(void *aml);
596
597u8 acpi_ut_get_resource_header_length(void *aml);
598
599u8 acpi_ut_get_resource_type(void *aml);
600
601acpi_status
602acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
603
604
605
606
607void acpi_ut_print_string(char *string, u16 max_length);
608
609#if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
610void ut_convert_backslashes(char *pathname);
611#endif
612
613void acpi_ut_repair_name(char *name);
614
615#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
616u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
617
618u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
619
620u8
621acpi_ut_safe_strncat(char *dest,
622 acpi_size dest_size,
623 char *source, acpi_size max_transfer_length);
624#endif
625
626
627
628
629acpi_status acpi_ut_mutex_initialize(void);
630
631void acpi_ut_mutex_terminate(void);
632
633acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
634
635acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
636
637
638
639
640acpi_status acpi_ut_create_caches(void);
641
642acpi_status acpi_ut_delete_caches(void);
643
644acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
645
646acpi_status
647acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
648 acpi_size required_length);
649
650#ifdef ACPI_DBG_TRACK_ALLOCATIONS
651void *acpi_ut_allocate_and_track(acpi_size size,
652 u32 component, const char *module, u32 line);
653
654void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
655 u32 component,
656 const char *module, u32 line);
657
658void
659acpi_ut_free_and_track(void *address,
660 u32 component, const char *module, u32 line);
661
662void acpi_ut_dump_allocation_info(void);
663
664void acpi_ut_dump_allocations(u32 component, const char *module);
665
666acpi_status
667acpi_ut_create_list(const char *list_name,
668 u16 object_size, struct acpi_memory_list **return_cache);
669
670#endif
671
672
673
674
675acpi_status
676acpi_ut_add_address_range(acpi_adr_space_type space_id,
677 acpi_physical_address address,
678 u32 length, struct acpi_namespace_node *region_node);
679
680void
681acpi_ut_remove_address_range(acpi_adr_space_type space_id,
682 struct acpi_namespace_node *region_node);
683
684u32
685acpi_ut_check_address_range(acpi_adr_space_type space_id,
686 acpi_physical_address address, u32 length, u8 warn);
687
688void acpi_ut_delete_address_lists(void);
689
690
691
692
693void ACPI_INTERNAL_VAR_XFACE
694acpi_ut_predefined_warning(const char *module_name,
695 u32 line_number,
696 char *pathname,
697 u8 node_flags, const char *format, ...);
698
699void ACPI_INTERNAL_VAR_XFACE
700acpi_ut_predefined_info(const char *module_name,
701 u32 line_number,
702 char *pathname, u8 node_flags, const char *format, ...);
703
704void ACPI_INTERNAL_VAR_XFACE
705acpi_ut_predefined_bios_error(const char *module_name,
706 u32 line_number,
707 char *pathname,
708 u8 node_flags, const char *format, ...);
709
710void
711acpi_ut_namespace_error(const char *module_name,
712 u32 line_number,
713 const char *internal_name, acpi_status lookup_status);
714
715void
716acpi_ut_method_error(const char *module_name,
717 u32 line_number,
718 const char *message,
719 struct acpi_namespace_node *node,
720 const char *path, acpi_status lookup_status);
721
722
723
724
725const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
726
727const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
728
729const char *acpi_ah_match_uuid(u8 *data);
730
731
732
733
734#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
735void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
736#endif
737
738#endif
739