[ACPI] ACPICA 20051021
[linux-3.10.git] / include / acpi / acutils.h
1 /******************************************************************************
2  *
3  * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2005, R. Byron Moore
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
47 typedef
48 acpi_status(*acpi_pkg_callback) (u8 object_type,
49                                  union acpi_operand_object * source_object,
50                                  union acpi_generic_state * state,
51                                  void *context);
52
53 struct acpi_pkg_info {
54         u8 *free_space;
55         acpi_size length;
56         u32 object_space;
57         u32 num_packages;
58 };
59
60 #define REF_INCREMENT       (u16) 0
61 #define REF_DECREMENT       (u16) 1
62 #define REF_FORCE_DELETE    (u16) 2
63
64 /* acpi_ut_dump_buffer */
65
66 #define DB_BYTE_DISPLAY     1
67 #define DB_WORD_DISPLAY     2
68 #define DB_DWORD_DISPLAY    4
69 #define DB_QWORD_DISPLAY    8
70
71 /*
72  * utglobal - Global data structures and procedures
73  */
74 void acpi_ut_init_globals(void);
75
76 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
77
78 char *acpi_ut_get_mutex_name(u32 mutex_id);
79
80 #endif
81
82 char *acpi_ut_get_type_name(acpi_object_type type);
83
84 char *acpi_ut_get_node_name(void *object);
85
86 char *acpi_ut_get_descriptor_name(void *object);
87
88 char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
89
90 char *acpi_ut_get_region_name(u8 space_id);
91
92 char *acpi_ut_get_event_name(u32 event_id);
93
94 char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
95
96 u8 acpi_ut_valid_object_type(acpi_object_type type);
97
98 /*
99  * utinit - miscellaneous initialization and shutdown
100  */
101 acpi_status acpi_ut_hardware_initialize(void);
102
103 void acpi_ut_subsystem_shutdown(void);
104
105 acpi_status acpi_ut_validate_fadt(void);
106
107 /*
108  * utclib - Local implementations of C library functions
109  */
110 #ifndef ACPI_USE_SYSTEM_CLIBRARY
111
112 acpi_size acpi_ut_strlen(const char *string);
113
114 char *acpi_ut_strcpy(char *dst_string, const char *src_string);
115
116 char *acpi_ut_strncpy(char *dst_string,
117                       const char *src_string, acpi_size count);
118
119 int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
120
121 int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
122
123 int acpi_ut_strcmp(const char *string1, const char *string2);
124
125 char *acpi_ut_strcat(char *dst_string, const char *src_string);
126
127 char *acpi_ut_strncat(char *dst_string,
128                       const char *src_string, acpi_size count);
129
130 u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
131
132 char *acpi_ut_strstr(char *string1, char *string2);
133
134 void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
135
136 void *acpi_ut_memset(void *dest, acpi_native_uint value, acpi_size count);
137
138 int acpi_ut_to_upper(int c);
139
140 int acpi_ut_to_lower(int c);
141
142 extern const u8 _acpi_ctype[];
143
144 #define _ACPI_XA     0x00       /* extra alphabetic - not supported */
145 #define _ACPI_XS     0x40       /* extra space */
146 #define _ACPI_BB     0x00       /* BEL, BS, etc. - not supported */
147 #define _ACPI_CN     0x20       /* CR, FF, HT, NL, VT */
148 #define _ACPI_DI     0x04       /* '0'-'9' */
149 #define _ACPI_LO     0x02       /* 'a'-'z' */
150 #define _ACPI_PU     0x10       /* punctuation */
151 #define _ACPI_SP     0x08       /* space */
152 #define _ACPI_UP     0x01       /* 'A'-'Z' */
153 #define _ACPI_XD     0x80       /* '0'-'9', 'A'-'F', 'a'-'f' */
154
155 #define ACPI_IS_DIGIT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
156 #define ACPI_IS_SPACE(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
157 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
158 #define ACPI_IS_UPPER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
159 #define ACPI_IS_LOWER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
160 #define ACPI_IS_PRINT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
161 #define ACPI_IS_ALPHA(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
162
163 #endif                          /* ACPI_USE_SYSTEM_CLIBRARY */
164
165 /*
166  * utcopy - Object construction and conversion interfaces
167  */
168 acpi_status
169 acpi_ut_build_simple_object(union acpi_operand_object *obj,
170                             union acpi_object *user_obj,
171                             u8 * data_space, u32 * buffer_space_used);
172
173 acpi_status
174 acpi_ut_build_package_object(union acpi_operand_object *obj,
175                              u8 * buffer, u32 * space_used);
176
177 acpi_status
178 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
179                                 struct acpi_buffer *ret_buffer);
180
181 acpi_status
182 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
183                                 union acpi_operand_object **internal_obj);
184
185 acpi_status
186 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
187                                 union acpi_operand_object *dest_obj);
188
189 acpi_status
190 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
191                                 union acpi_operand_object **dest_desc,
192                                 struct acpi_walk_state *walk_state);
193
194 /*
195  * utcreate - Object creation
196  */
197 acpi_status
198 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
199
200 /*
201  * utdebug - Debug interfaces
202  */
203 void acpi_ut_init_stack_ptr_trace(void);
204
205 void acpi_ut_track_stack_ptr(void);
206
207 void
208 acpi_ut_trace(u32 line_number,
209               const char *function_name, char *module_name, u32 component_id);
210
211 void
212 acpi_ut_trace_ptr(u32 line_number,
213                   const char *function_name,
214                   char *module_name, u32 component_id, void *pointer);
215
216 void
217 acpi_ut_trace_u32(u32 line_number,
218                   const char *function_name,
219                   char *module_name, u32 component_id, u32 integer);
220
221 void
222 acpi_ut_trace_str(u32 line_number,
223                   const char *function_name,
224                   char *module_name, u32 component_id, char *string);
225
226 void
227 acpi_ut_exit(u32 line_number,
228              const char *function_name, char *module_name, u32 component_id);
229
230 void
231 acpi_ut_status_exit(u32 line_number,
232                     const char *function_name,
233                     char *module_name, u32 component_id, acpi_status status);
234
235 void
236 acpi_ut_value_exit(u32 line_number,
237                    const char *function_name,
238                    char *module_name, u32 component_id, acpi_integer value);
239
240 void
241 acpi_ut_ptr_exit(u32 line_number,
242                  const char *function_name,
243                  char *module_name, u32 component_id, u8 * ptr);
244
245 void acpi_ut_report_info(char *module_name, u32 line_number, u32 component_id);
246
247 void acpi_ut_report_error(char *module_name, u32 line_number, u32 component_id);
248
249 void
250 acpi_ut_report_warning(char *module_name, u32 line_number, u32 component_id);
251
252 void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
253
254 void ACPI_INTERNAL_VAR_XFACE
255 acpi_ut_debug_print(u32 requested_debug_level,
256                     u32 line_number,
257                     const char *function_name,
258                     char *module_name,
259                     u32 component_id, char *format, ...) ACPI_PRINTF_LIKE_FUNC;
260
261 void ACPI_INTERNAL_VAR_XFACE
262 acpi_ut_debug_print_raw(u32 requested_debug_level,
263                         u32 line_number,
264                         const char *function_name,
265                         char *module_name,
266                         u32 component_id,
267                         char *format, ...) ACPI_PRINTF_LIKE_FUNC;
268
269 /*
270  * utdelete - Object deletion and reference counts
271  */
272 void acpi_ut_add_reference(union acpi_operand_object *object);
273
274 void acpi_ut_remove_reference(union acpi_operand_object *object);
275
276 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
277
278 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
279
280 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
281
282 /*
283  * uteval - object evaluation
284  */
285 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
286
287 acpi_status
288 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
289                         char *path,
290                         u32 expected_return_btypes,
291                         union acpi_operand_object **return_desc);
292
293 acpi_status
294 acpi_ut_evaluate_numeric_object(char *object_name,
295                                 struct acpi_namespace_node *device_node,
296                                 acpi_integer * address);
297
298 acpi_status
299 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
300                     struct acpi_device_id *hid);
301
302 acpi_status
303 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
304                     struct acpi_compatible_id_list **return_cid_list);
305
306 acpi_status
307 acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
308                     u32 * status_flags);
309
310 acpi_status
311 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
312                     struct acpi_device_id *uid);
313
314 acpi_status
315 acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
316
317 /*
318  * utobject - internal object create/delete/cache routines
319  */
320 union acpi_operand_object *acpi_ut_create_internal_object_dbg(char *module_name,
321                                                               u32 line_number,
322                                                               u32 component_id,
323                                                               acpi_object_type
324                                                               type);
325
326 void *acpi_ut_allocate_object_desc_dbg(char *module_name,
327                                        u32 line_number, u32 component_id);
328
329 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
330 #define acpi_ut_allocate_object_desc()  acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
331
332 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
333
334 u8 acpi_ut_valid_internal_object(void *object);
335
336 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
337
338 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
339
340 acpi_status
341 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
342
343 /*
344  * utstate - Generic state creation/cache routines
345  */
346 void
347 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
348                            union acpi_generic_state *state);
349
350 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
351                                                     **list_head);
352
353 union acpi_generic_state *acpi_ut_create_generic_state(void);
354
355 struct acpi_thread_state *acpi_ut_create_thread_state(void);
356
357 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
358                                                       *object, u16 action);
359
360 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
361                                                    void *external_object,
362                                                    u16 index);
363
364 acpi_status
365 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
366                                      u16 action,
367                                      union acpi_generic_state **state_list);
368
369 #ifdef  ACPI_FUTURE_USAGE
370 acpi_status
371 acpi_ut_create_pkg_state_and_push(void *internal_object,
372                                   void *external_object,
373                                   u16 index,
374                                   union acpi_generic_state **state_list);
375 #endif                          /* ACPI_FUTURE_USAGE */
376
377 union acpi_generic_state *acpi_ut_create_control_state(void);
378
379 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
380
381 /*
382  * utmath
383  */
384 acpi_status
385 acpi_ut_divide(acpi_integer in_dividend,
386                acpi_integer in_divisor,
387                acpi_integer * out_quotient, acpi_integer * out_remainder);
388
389 acpi_status
390 acpi_ut_short_divide(acpi_integer in_dividend,
391                      u32 divisor,
392                      acpi_integer * out_quotient, u32 * out_remainder);
393
394 /*
395  * utmisc
396  */
397 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
398
399 void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
400
401 acpi_status
402 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
403                           void *target_object,
404                           acpi_pkg_callback walk_callback, void *context);
405
406 void acpi_ut_strupr(char *src_string);
407
408 void acpi_ut_print_string(char *string, u8 max_length);
409
410 u8 acpi_ut_valid_acpi_name(u32 name);
411
412 u8 acpi_ut_valid_acpi_character(char character);
413
414 acpi_status
415 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
416
417 /* Values for Base above (16=Hex, 10=Decimal) */
418
419 #define ACPI_ANY_BASE        0
420
421 u32 acpi_ut_get_descriptor_length(void *aml);
422
423 u16 acpi_ut_get_resource_length(void *aml);
424
425 u8 acpi_ut_get_resource_type(void *aml);
426
427 u8 *acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc);
428
429 u8 acpi_ut_generate_checksum(u8 * buffer, u32 length);
430
431 u32 acpi_ut_dword_byte_swap(u32 value);
432
433 void acpi_ut_set_integer_width(u8 revision);
434
435 #ifdef ACPI_DEBUG_OUTPUT
436 void
437 acpi_ut_display_init_pathname(u8 type,
438                               struct acpi_namespace_node *obj_handle,
439                               char *path);
440
441 #endif
442
443 /*
444  * utmutex - mutex support
445  */
446 acpi_status acpi_ut_mutex_initialize(void);
447
448 void acpi_ut_mutex_terminate(void);
449
450 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
451
452 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
453
454 /*
455  * utalloc - memory allocation and object caching
456  */
457 acpi_status acpi_ut_create_caches(void);
458
459 acpi_status acpi_ut_delete_caches(void);
460
461 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
462
463 acpi_status
464 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
465                           acpi_size required_length);
466
467 void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line);
468
469 void *acpi_ut_callocate(acpi_size size, u32 component, char *module, u32 line);
470
471 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
472 void *acpi_ut_allocate_and_track(acpi_size size,
473                                  u32 component, char *module, u32 line);
474
475 void *acpi_ut_callocate_and_track(acpi_size size,
476                                   u32 component, char *module, u32 line);
477
478 void
479 acpi_ut_free_and_track(void *address, u32 component, char *module, u32 line);
480
481 #ifdef  ACPI_FUTURE_USAGE
482 void acpi_ut_dump_allocation_info(void);
483 #endif                          /* ACPI_FUTURE_USAGE */
484
485 void acpi_ut_dump_allocations(u32 component, char *module);
486 #endif
487
488 #endif                          /* _ACUTILS_H */