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_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#define ACPI_INVALID_RESOURCE 0
93#define ACPI_FIXED_LENGTH 1
94#define ACPI_VARIABLE_LENGTH 2
95#define ACPI_SMALL_VARIABLE_LENGTH 3
96
97typedef
98acpi_status(*acpi_walk_aml_callback) (u8 *aml,
99 u32 length,
100 u32 offset,
101 u8 resource_index, void **context);
102
103typedef
104acpi_status(*acpi_pkg_callback) (u8 object_type,
105 union acpi_operand_object *source_object,
106 union acpi_generic_state * state,
107 void *context);
108
109struct acpi_pkg_info {
110 u8 *free_space;
111 acpi_size length;
112 u32 object_space;
113 u32 num_packages;
114};
115
116
117
118#define REF_INCREMENT (u16) 0
119#define REF_DECREMENT (u16) 1
120
121
122
123#define DB_BYTE_DISPLAY 1
124#define DB_WORD_DISPLAY 2
125#define DB_DWORD_DISPLAY 4
126#define DB_QWORD_DISPLAY 8
127
128
129
130
131acpi_status acpi_ut_init_globals(void);
132
133#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
134
135char *acpi_ut_get_mutex_name(u32 mutex_id);
136
137const char *acpi_ut_get_notify_name(u32 notify_value);
138
139#endif
140
141char *acpi_ut_get_type_name(acpi_object_type type);
142
143char *acpi_ut_get_node_name(void *object);
144
145char *acpi_ut_get_descriptor_name(void *object);
146
147const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
148
149char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
150
151char *acpi_ut_get_region_name(u8 space_id);
152
153char *acpi_ut_get_event_name(u32 event_id);
154
155char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
156
157u8 acpi_ut_valid_object_type(acpi_object_type type);
158
159
160
161
162acpi_status acpi_ut_hardware_initialize(void);
163
164void acpi_ut_subsystem_shutdown(void);
165
166
167
168
169#ifndef ACPI_USE_SYSTEM_CLIBRARY
170
171acpi_size acpi_ut_strlen(const char *string);
172
173char *acpi_ut_strcpy(char *dst_string, const char *src_string);
174
175char *acpi_ut_strncpy(char *dst_string,
176 const char *src_string, acpi_size count);
177
178int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
179
180int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
181
182int acpi_ut_strcmp(const char *string1, const char *string2);
183
184char *acpi_ut_strcat(char *dst_string, const char *src_string);
185
186char *acpi_ut_strncat(char *dst_string,
187 const char *src_string, acpi_size count);
188
189u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
190
191char *acpi_ut_strstr(char *string1, char *string2);
192
193void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
194
195void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
196
197int acpi_ut_to_upper(int c);
198
199int acpi_ut_to_lower(int c);
200
201extern const u8 _acpi_ctype[];
202
203#define _ACPI_XA 0x00
204#define _ACPI_XS 0x40
205#define _ACPI_BB 0x00
206#define _ACPI_CN 0x20
207#define _ACPI_DI 0x04
208#define _ACPI_LO 0x02
209#define _ACPI_PU 0x10
210#define _ACPI_SP 0x08
211#define _ACPI_UP 0x01
212#define _ACPI_XD 0x80
213
214#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
215#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
216#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
217#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
218#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
219#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
220#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
221
222#endif
223
224#define ACPI_IS_ASCII(c) ((c) < 0x80)
225
226
227
228
229acpi_status
230acpi_ut_build_simple_object(union acpi_operand_object *obj,
231 union acpi_object *user_obj,
232 u8 *data_space, u32 *buffer_space_used);
233
234acpi_status
235acpi_ut_build_package_object(union acpi_operand_object *obj,
236 u8 *buffer, u32 *space_used);
237
238acpi_status
239acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
240 struct acpi_buffer *ret_buffer);
241
242acpi_status
243acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
244 union acpi_operand_object **internal_obj);
245
246acpi_status
247acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
248 union acpi_operand_object *dest_obj);
249
250acpi_status
251acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
252 union acpi_operand_object **dest_desc,
253 struct acpi_walk_state *walk_state);
254
255
256
257
258acpi_status
259acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
260
261
262
263
264void acpi_ut_init_stack_ptr_trace(void);
265
266void acpi_ut_track_stack_ptr(void);
267
268void
269acpi_ut_trace(u32 line_number,
270 const char *function_name,
271 const char *module_name, u32 component_id);
272
273void
274acpi_ut_trace_ptr(u32 line_number,
275 const char *function_name,
276 const char *module_name, u32 component_id, void *pointer);
277
278void
279acpi_ut_trace_u32(u32 line_number,
280 const char *function_name,
281 const char *module_name, u32 component_id, u32 integer);
282
283void
284acpi_ut_trace_str(u32 line_number,
285 const char *function_name,
286 const char *module_name, u32 component_id, char *string);
287
288void
289acpi_ut_exit(u32 line_number,
290 const char *function_name,
291 const char *module_name, u32 component_id);
292
293void
294acpi_ut_status_exit(u32 line_number,
295 const char *function_name,
296 const char *module_name,
297 u32 component_id, acpi_status status);
298
299void
300acpi_ut_value_exit(u32 line_number,
301 const char *function_name,
302 const char *module_name, u32 component_id, u64 value);
303
304void
305acpi_ut_ptr_exit(u32 line_number,
306 const char *function_name,
307 const char *module_name, u32 component_id, u8 *ptr);
308
309void
310acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
311
312void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
313
314void acpi_ut_report_error(char *module_name, u32 line_number);
315
316void acpi_ut_report_info(char *module_name, u32 line_number);
317
318void acpi_ut_report_warning(char *module_name, u32 line_number);
319
320
321
322
323void acpi_ut_add_reference(union acpi_operand_object *object);
324
325void acpi_ut_remove_reference(union acpi_operand_object *object);
326
327void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
328
329void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
330
331void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
332
333
334
335
336acpi_status
337acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
338 char *path,
339 u32 expected_return_btypes,
340 union acpi_operand_object **return_desc);
341
342acpi_status
343acpi_ut_evaluate_numeric_object(char *object_name,
344 struct acpi_namespace_node *device_node,
345 u64 *value);
346
347acpi_status
348acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
349
350acpi_status
351acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
352 const char **method_names,
353 u8 method_count, u8 *out_values);
354
355
356
357
358acpi_status
359acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
360 struct acpi_pnp_device_id ** return_id);
361
362acpi_status
363acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
364 struct acpi_pnp_device_id ** return_id);
365
366acpi_status
367acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
368 struct acpi_pnp_device_id **return_id);
369
370acpi_status
371acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
372 struct acpi_pnp_device_id_list ** return_cid_list);
373
374
375
376
377acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
378
379void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
380
381acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
382
383acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
384
385acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
386
387void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
388
389
390
391
392union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
393 *module_name,
394 u32 line_number,
395 u32 component_id,
396 acpi_object_type
397 type);
398
399void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
400 u32 line_number, u32 component_id);
401
402#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
403#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
404
405void acpi_ut_delete_object_desc(union acpi_operand_object *object);
406
407u8 acpi_ut_valid_internal_object(void *object);
408
409union acpi_operand_object *acpi_ut_create_package_object(u32 count);
410
411union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
412
413union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
414
415union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
416
417acpi_status
418acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
419
420
421
422
423acpi_status acpi_ut_initialize_interfaces(void);
424
425acpi_status acpi_ut_interface_terminate(void);
426
427acpi_status acpi_ut_install_interface(acpi_string interface_name);
428
429acpi_status acpi_ut_remove_interface(acpi_string interface_name);
430
431struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
432
433acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
434
435
436
437
438const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
439 acpi_predefined_info
440 *this_name);
441
442const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
443
444const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
445
446void
447acpi_ut_display_predefined_method(char *buffer,
448 const union acpi_predefined_info *this_name,
449 u8 multi_line);
450
451void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
452
453u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
454
455
456
457
458void
459acpi_ut_push_generic_state(union acpi_generic_state **list_head,
460 union acpi_generic_state *state);
461
462union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
463 **list_head);
464
465union acpi_generic_state *acpi_ut_create_generic_state(void);
466
467struct acpi_thread_state *acpi_ut_create_thread_state(void);
468
469union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
470 *object, u16 action);
471
472union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
473 void *external_object,
474 u16 index);
475
476acpi_status
477acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
478 u16 action,
479 union acpi_generic_state **state_list);
480
481#ifdef ACPI_FUTURE_USAGE
482acpi_status
483acpi_ut_create_pkg_state_and_push(void *internal_object,
484 void *external_object,
485 u16 index,
486 union acpi_generic_state **state_list);
487#endif
488
489union acpi_generic_state *acpi_ut_create_control_state(void);
490
491void acpi_ut_delete_generic_state(union acpi_generic_state *state);
492
493
494
495
496acpi_status
497acpi_ut_divide(u64 in_dividend,
498 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
499
500acpi_status
501acpi_ut_short_divide(u64 in_dividend,
502 u32 divisor, u64 *out_quotient, u32 *out_remainder);
503
504
505
506
507const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
508 status);
509
510u8 acpi_ut_is_pci_root_bridge(char *id);
511
512u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
513
514acpi_status
515acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
516 void *target_object,
517 acpi_pkg_callback walk_callback, void *context);
518
519
520
521#define ACPI_ANY_BASE 0
522
523u32 acpi_ut_dword_byte_swap(u32 value);
524
525void acpi_ut_set_integer_width(u8 revision);
526
527#ifdef ACPI_DEBUG_OUTPUT
528void
529acpi_ut_display_init_pathname(u8 type,
530 struct acpi_namespace_node *obj_handle,
531 char *path);
532#endif
533
534
535
536
537acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
538
539void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
540
541
542
543
544acpi_status
545acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
546 u8 *aml,
547 acpi_size aml_length,
548 acpi_walk_aml_callback user_function,
549 void **context);
550
551acpi_status
552acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
553 void *aml, u8 *return_index);
554
555u32 acpi_ut_get_descriptor_length(void *aml);
556
557u16 acpi_ut_get_resource_length(void *aml);
558
559u8 acpi_ut_get_resource_header_length(void *aml);
560
561u8 acpi_ut_get_resource_type(void *aml);
562
563acpi_status
564acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
565
566
567
568
569void acpi_ut_strupr(char *src_string);
570
571void acpi_ut_strlwr(char *src_string);
572
573int acpi_ut_stricmp(char *string1, char *string2);
574
575acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
576
577void acpi_ut_print_string(char *string, u8 max_length);
578
579void ut_convert_backslashes(char *pathname);
580
581u8 acpi_ut_valid_acpi_name(u32 name);
582
583u8 acpi_ut_valid_acpi_char(char character, u32 position);
584
585void acpi_ut_repair_name(char *name);
586
587
588
589
590acpi_status acpi_ut_mutex_initialize(void);
591
592void acpi_ut_mutex_terminate(void);
593
594acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
595
596acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
597
598
599
600
601acpi_status acpi_ut_create_caches(void);
602
603acpi_status acpi_ut_delete_caches(void);
604
605acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
606
607acpi_status
608acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
609 acpi_size required_length);
610
611void *acpi_ut_allocate(acpi_size size,
612 u32 component, const char *module, u32 line);
613
614void *acpi_ut_allocate_zeroed(acpi_size size,
615 u32 component, const char *module, u32 line);
616
617#ifdef ACPI_DBG_TRACK_ALLOCATIONS
618void *acpi_ut_allocate_and_track(acpi_size size,
619 u32 component, const char *module, u32 line);
620
621void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
622 u32 component,
623 const char *module, u32 line);
624
625void
626acpi_ut_free_and_track(void *address,
627 u32 component, const char *module, u32 line);
628
629#ifdef ACPI_FUTURE_USAGE
630void acpi_ut_dump_allocation_info(void);
631#endif
632
633void acpi_ut_dump_allocations(u32 component, const char *module);
634
635acpi_status
636acpi_ut_create_list(char *list_name,
637 u16 object_size, struct acpi_memory_list **return_cache);
638
639#endif
640
641
642
643
644acpi_status
645acpi_ut_add_address_range(acpi_adr_space_type space_id,
646 acpi_physical_address address,
647 u32 length, struct acpi_namespace_node *region_node);
648
649void
650acpi_ut_remove_address_range(acpi_adr_space_type space_id,
651 struct acpi_namespace_node *region_node);
652
653u32
654acpi_ut_check_address_range(acpi_adr_space_type space_id,
655 acpi_physical_address address, u32 length, u8 warn);
656
657void acpi_ut_delete_address_lists(void);
658
659
660
661
662void ACPI_INTERNAL_VAR_XFACE
663acpi_ut_predefined_warning(const char *module_name,
664 u32 line_number,
665 char *pathname,
666 u8 node_flags, const char *format, ...);
667
668void ACPI_INTERNAL_VAR_XFACE
669acpi_ut_predefined_info(const char *module_name,
670 u32 line_number,
671 char *pathname, u8 node_flags, const char *format, ...);
672
673void
674acpi_ut_namespace_error(const char *module_name,
675 u32 line_number,
676 const char *internal_name, acpi_status lookup_status);
677
678void
679acpi_ut_method_error(const char *module_name,
680 u32 line_number,
681 const char *message,
682 struct acpi_namespace_node *node,
683 const char *path, acpi_status lookup_status);
684
685#endif
686