acutils.h 21.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/******************************************************************************
 *
 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
 *
 *****************************************************************************/

/*
8
 * Copyright (C) 2000 - 2014, Intel Corp.
L
Linus Torvalds 已提交
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 45 46
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef _ACUTILS_H
#define _ACUTILS_H

B
Bob Moore 已提交
47
extern const u8 acpi_gbl_resource_aml_sizes[];
48
extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
B
Bob Moore 已提交
49

B
Bob Moore 已提交
50 51 52 53
/* Strings used by the disassembler and debugger resource dump routines */

#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)

B
Bob Moore 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
extern const char *acpi_gbl_bm_decode[];
extern const char *acpi_gbl_config_decode[];
extern const char *acpi_gbl_consume_decode[];
extern const char *acpi_gbl_dec_decode[];
extern const char *acpi_gbl_he_decode[];
extern const char *acpi_gbl_io_decode[];
extern const char *acpi_gbl_ll_decode[];
extern const char *acpi_gbl_max_decode[];
extern const char *acpi_gbl_mem_decode[];
extern const char *acpi_gbl_min_decode[];
extern const char *acpi_gbl_mtp_decode[];
extern const char *acpi_gbl_rng_decode[];
extern const char *acpi_gbl_rw_decode[];
extern const char *acpi_gbl_shr_decode[];
extern const char *acpi_gbl_siz_decode[];
extern const char *acpi_gbl_trs_decode[];
extern const char *acpi_gbl_ttp_decode[];
extern const char *acpi_gbl_typ_decode[];
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
extern const char *acpi_gbl_ppc_decode[];
extern const char *acpi_gbl_ior_decode[];
extern const char *acpi_gbl_dts_decode[];
extern const char *acpi_gbl_ct_decode[];
extern const char *acpi_gbl_sbt_decode[];
extern const char *acpi_gbl_am_decode[];
extern const char *acpi_gbl_sm_decode[];
extern const char *acpi_gbl_wm_decode[];
extern const char *acpi_gbl_cph_decode[];
extern const char *acpi_gbl_cpo_decode[];
extern const char *acpi_gbl_dp_decode[];
extern const char *acpi_gbl_ed_decode[];
extern const char *acpi_gbl_bpb_decode[];
extern const char *acpi_gbl_sb_decode[];
extern const char *acpi_gbl_fc_decode[];
extern const char *acpi_gbl_pt_decode[];
B
Bob Moore 已提交
88 89
#endif

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
/*
 * For the iASL compiler case, the output is redirected to stderr so that
 * any of the various ACPI errors and warnings do not appear in the output
 * files, for either the compiler or disassembler portions of the tool.
 */
#ifdef ACPI_ASL_COMPILER

#include <stdio.h>
extern FILE *acpi_gbl_output_file;

#define ACPI_MSG_REDIRECT_BEGIN \
	FILE                            *output_file = acpi_gbl_output_file; \
	acpi_os_redirect_output (stderr);

#define ACPI_MSG_REDIRECT_END \
	acpi_os_redirect_output (output_file);

#else
/*
 * non-iASL case - no redirection, nothing to do
 */
#define ACPI_MSG_REDIRECT_BEGIN
#define ACPI_MSG_REDIRECT_END
#endif

/*
 * Common error message prefixes
 */
#define ACPI_MSG_ERROR          "ACPI Error: "
#define ACPI_MSG_EXCEPTION      "ACPI Exception: "
#define ACPI_MSG_WARNING        "ACPI Warning: "
#define ACPI_MSG_INFO           "ACPI: "

#define ACPI_MSG_BIOS_ERROR     "ACPI BIOS Error (bug): "
#define ACPI_MSG_BIOS_WARNING   "ACPI BIOS Warning (bug): "

/*
 * Common message suffix
 */
#define ACPI_MSG_SUFFIX \
	acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)

B
Bob Moore 已提交
132 133 134 135 136 137 138
/* Types for Resource descriptor entries */

#define ACPI_INVALID_RESOURCE           0
#define ACPI_FIXED_LENGTH               1
#define ACPI_VARIABLE_LENGTH            2
#define ACPI_SMALL_VARIABLE_LENGTH      3

B
Bob Moore 已提交
139
typedef
140
acpi_status(*acpi_walk_aml_callback) (u8 *aml,
B
Bob Moore 已提交
141 142
				      u32 length,
				      u32 offset,
B
Bob Moore 已提交
143
				      u8 resource_index, void **context);
B
Bob Moore 已提交
144

L
Linus Torvalds 已提交
145
typedef
L
Len Brown 已提交
146
acpi_status(*acpi_pkg_callback) (u8 object_type,
147
				 union acpi_operand_object *source_object,
L
Len Brown 已提交
148 149 150 151 152 153 154 155
				 union acpi_generic_state * state,
				 void *context);

struct acpi_pkg_info {
	u8 *free_space;
	acpi_size length;
	u32 object_space;
	u32 num_packages;
L
Linus Torvalds 已提交
156 157
};

158 159
/* Object reference counts */

L
Linus Torvalds 已提交
160 161 162 163 164 165 166 167 168 169 170
#define REF_INCREMENT       (u16) 0
#define REF_DECREMENT       (u16) 1

/* acpi_ut_dump_buffer */

#define DB_BYTE_DISPLAY     1
#define DB_WORD_DISPLAY     2
#define DB_DWORD_DISPLAY    4
#define DB_QWORD_DISPLAY    8

/*
R
Robert Moore 已提交
171
 * utglobal - Global data structures and procedures
L
Linus Torvalds 已提交
172
 */
173
acpi_status acpi_ut_init_globals(void);
L
Linus Torvalds 已提交
174 175 176

#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)

L
Len Brown 已提交
177
char *acpi_ut_get_mutex_name(u32 mutex_id);
L
Linus Torvalds 已提交
178

Z
Zhang Rui 已提交
179 180
const char *acpi_ut_get_notify_name(u32 notify_value);

L
Linus Torvalds 已提交
181 182
#endif

L
Len Brown 已提交
183
char *acpi_ut_get_type_name(acpi_object_type type);
L
Linus Torvalds 已提交
184

L
Len Brown 已提交
185
char *acpi_ut_get_node_name(void *object);
L
Linus Torvalds 已提交
186

L
Len Brown 已提交
187
char *acpi_ut_get_descriptor_name(void *object);
L
Linus Torvalds 已提交
188

189 190
const char *acpi_ut_get_reference_name(union acpi_operand_object *object);

L
Len Brown 已提交
191
char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
L
Linus Torvalds 已提交
192

L
Len Brown 已提交
193
char *acpi_ut_get_region_name(u8 space_id);
L
Linus Torvalds 已提交
194

L
Len Brown 已提交
195
char *acpi_ut_get_event_name(u32 event_id);
L
Linus Torvalds 已提交
196

197
char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
L
Linus Torvalds 已提交
198

L
Len Brown 已提交
199
u8 acpi_ut_valid_object_type(acpi_object_type type);
L
Linus Torvalds 已提交
200 201

/*
R
Robert Moore 已提交
202
 * utinit - miscellaneous initialization and shutdown
L
Linus Torvalds 已提交
203
 */
L
Len Brown 已提交
204
acpi_status acpi_ut_hardware_initialize(void);
R
Robert Moore 已提交
205

L
Len Brown 已提交
206
void acpi_ut_subsystem_shutdown(void);
R
Robert Moore 已提交
207 208 209 210

/*
 * utclib - Local implementations of C library functions
 */
L
Linus Torvalds 已提交
211 212
#ifndef ACPI_USE_SYSTEM_CLIBRARY

L
Len Brown 已提交
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
acpi_size acpi_ut_strlen(const char *string);

char *acpi_ut_strcpy(char *dst_string, const char *src_string);

char *acpi_ut_strncpy(char *dst_string,
		      const char *src_string, acpi_size count);

int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);

int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);

int acpi_ut_strcmp(const char *string1, const char *string2);

char *acpi_ut_strcat(char *dst_string, const char *src_string);

char *acpi_ut_strncat(char *dst_string,
		      const char *src_string, acpi_size count);

u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);

char *acpi_ut_strstr(char *string1, char *string2);

void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);

237
void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
L
Len Brown 已提交
238 239 240 241

int acpi_ut_to_upper(int c);

int acpi_ut_to_lower(int c);
L
Linus Torvalds 已提交
242 243 244

extern const u8 _acpi_ctype[];

L
Len Brown 已提交
245 246 247 248 249 250 251 252 253 254
#define _ACPI_XA     0x00	/* extra alphabetic - not supported */
#define _ACPI_XS     0x40	/* extra space */
#define _ACPI_BB     0x00	/* BEL, BS, etc. - not supported */
#define _ACPI_CN     0x20	/* CR, FF, HT, NL, VT */
#define _ACPI_DI     0x04	/* '0'-'9' */
#define _ACPI_LO     0x02	/* 'a'-'z' */
#define _ACPI_PU     0x10	/* punctuation */
#define _ACPI_SP     0x08	/* space */
#define _ACPI_UP     0x01	/* 'A'-'Z' */
#define _ACPI_XD     0x80	/* '0'-'9', 'A'-'F', 'a'-'f' */
L
Linus Torvalds 已提交
255 256 257 258 259 260 261 262 263

#define ACPI_IS_DIGIT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
#define ACPI_IS_SPACE(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
#define ACPI_IS_UPPER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
#define ACPI_IS_LOWER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
#define ACPI_IS_PRINT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
#define ACPI_IS_ALPHA(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))

264 265 266
#endif				/* !ACPI_USE_SYSTEM_CLIBRARY */

#define ACPI_IS_ASCII(c)  ((c) < 0x80)
R
Robert Moore 已提交
267

L
Linus Torvalds 已提交
268
/*
R
Robert Moore 已提交
269
 * utcopy - Object construction and conversion interfaces
L
Linus Torvalds 已提交
270 271
 */
acpi_status
L
Len Brown 已提交
272 273
acpi_ut_build_simple_object(union acpi_operand_object *obj,
			    union acpi_object *user_obj,
274
			    u8 *data_space, u32 *buffer_space_used);
L
Linus Torvalds 已提交
275 276

acpi_status
L
Len Brown 已提交
277
acpi_ut_build_package_object(union acpi_operand_object *obj,
278
			     u8 *buffer, u32 *space_used);
L
Linus Torvalds 已提交
279 280

acpi_status
L
Len Brown 已提交
281 282
acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
				struct acpi_buffer *ret_buffer);
L
Linus Torvalds 已提交
283 284

acpi_status
L
Len Brown 已提交
285 286
acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
				union acpi_operand_object **internal_obj);
L
Linus Torvalds 已提交
287 288

acpi_status
L
Len Brown 已提交
289 290
acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
				union acpi_operand_object *dest_obj);
L
Linus Torvalds 已提交
291 292

acpi_status
L
Len Brown 已提交
293 294 295
acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
				union acpi_operand_object **dest_desc,
				struct acpi_walk_state *walk_state);
L
Linus Torvalds 已提交
296 297

/*
R
Robert Moore 已提交
298
 * utcreate - Object creation
L
Linus Torvalds 已提交
299 300
 */
acpi_status
L
Len Brown 已提交
301
acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
L
Linus Torvalds 已提交
302 303

/*
R
Robert Moore 已提交
304
 * utdebug - Debug interfaces
L
Linus Torvalds 已提交
305
 */
L
Len Brown 已提交
306
void acpi_ut_init_stack_ptr_trace(void);
L
Linus Torvalds 已提交
307

L
Len Brown 已提交
308
void acpi_ut_track_stack_ptr(void);
L
Linus Torvalds 已提交
309 310

void
L
Len Brown 已提交
311
acpi_ut_trace(u32 line_number,
312 313
	      const char *function_name,
	      const char *module_name, u32 component_id);
L
Linus Torvalds 已提交
314 315

void
L
Len Brown 已提交
316 317
acpi_ut_trace_ptr(u32 line_number,
		  const char *function_name,
318
		  const char *module_name, u32 component_id, void *pointer);
L
Linus Torvalds 已提交
319 320

void
L
Len Brown 已提交
321 322
acpi_ut_trace_u32(u32 line_number,
		  const char *function_name,
323
		  const char *module_name, u32 component_id, u32 integer);
L
Linus Torvalds 已提交
324 325

void
L
Len Brown 已提交
326 327
acpi_ut_trace_str(u32 line_number,
		  const char *function_name,
328
		  const char *module_name, u32 component_id, char *string);
L
Linus Torvalds 已提交
329 330

void
L
Len Brown 已提交
331
acpi_ut_exit(u32 line_number,
332 333
	     const char *function_name,
	     const char *module_name, u32 component_id);
L
Linus Torvalds 已提交
334 335

void
L
Len Brown 已提交
336 337
acpi_ut_status_exit(u32 line_number,
		    const char *function_name,
338 339
		    const char *module_name,
		    u32 component_id, acpi_status status);
L
Linus Torvalds 已提交
340 341

void
L
Len Brown 已提交
342 343
acpi_ut_value_exit(u32 line_number,
		   const char *function_name,
344
		   const char *module_name, u32 component_id, u64 value);
L
Linus Torvalds 已提交
345 346

void
L
Len Brown 已提交
347 348
acpi_ut_ptr_exit(u32 line_number,
		 const char *function_name,
349
		 const char *module_name, u32 component_id, u8 *ptr);
L
Linus Torvalds 已提交
350

351 352
void
acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
B
Bob Moore 已提交
353

354
void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
B
Bob Moore 已提交
355

B
Bob Moore 已提交
356
void acpi_ut_report_error(char *module_name, u32 line_number);
L
Linus Torvalds 已提交
357

B
Bob Moore 已提交
358
void acpi_ut_report_info(char *module_name, u32 line_number);
L
Linus Torvalds 已提交
359

B
Bob Moore 已提交
360
void acpi_ut_report_warning(char *module_name, u32 line_number);
L
Linus Torvalds 已提交
361 362

/*
R
Robert Moore 已提交
363
 * utdelete - Object deletion and reference counts
L
Linus Torvalds 已提交
364
 */
L
Len Brown 已提交
365
void acpi_ut_add_reference(union acpi_operand_object *object);
L
Linus Torvalds 已提交
366

L
Len Brown 已提交
367
void acpi_ut_remove_reference(union acpi_operand_object *object);
L
Linus Torvalds 已提交
368

L
Len Brown 已提交
369
void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
L
Linus Torvalds 已提交
370

L
Len Brown 已提交
371
void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
L
Linus Torvalds 已提交
372

L
Len Brown 已提交
373
void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
L
Linus Torvalds 已提交
374 375

/*
R
Robert Moore 已提交
376
 * uteval - object evaluation
L
Linus Torvalds 已提交
377 378
 */
acpi_status
L
Len Brown 已提交
379 380 381 382
acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
			char *path,
			u32 expected_return_btypes,
			union acpi_operand_object **return_desc);
L
Linus Torvalds 已提交
383 384

acpi_status
L
Len Brown 已提交
385 386
acpi_ut_evaluate_numeric_object(char *object_name,
				struct acpi_namespace_node *device_node,
387
				u64 *value);
L
Linus Torvalds 已提交
388 389

acpi_status
390
acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
L
Linus Torvalds 已提交
391 392

acpi_status
393 394 395
acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
			      const char **method_names,
			      u8 method_count, u8 *out_values);
L
Linus Torvalds 已提交
396

397 398 399
/*
 * utids - device ID support
 */
L
Linus Torvalds 已提交
400
acpi_status
401
acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
402
		    struct acpi_pnp_device_id ** return_id);
L
Linus Torvalds 已提交
403 404

acpi_status
L
Len Brown 已提交
405
acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
406
		    struct acpi_pnp_device_id ** return_id);
L
Linus Torvalds 已提交
407

408 409 410 411
acpi_status
acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
		    struct acpi_pnp_device_id **return_id);

L
Linus Torvalds 已提交
412
acpi_status
413
acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
414
		    struct acpi_pnp_device_id_list ** return_cid_list);
L
Linus Torvalds 已提交
415

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
/*
 * utlock - reader/writer locks
 */
acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);

void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);

acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);

acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);

acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);

void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);

L
Linus Torvalds 已提交
431
/*
R
Robert Moore 已提交
432
 * utobject - internal object create/delete/cache routines
L
Linus Torvalds 已提交
433
 */
434 435
union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
							      *module_name,
L
Len Brown 已提交
436 437 438 439 440
							      u32 line_number,
							      u32 component_id,
							      acpi_object_type
							      type);

441
void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
L
Len Brown 已提交
442
				       u32 line_number, u32 component_id);
L
Linus Torvalds 已提交
443

444 445
#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
#define acpi_ut_allocate_object_desc()  acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
L
Linus Torvalds 已提交
446

L
Len Brown 已提交
447
void acpi_ut_delete_object_desc(union acpi_operand_object *object);
L
Linus Torvalds 已提交
448

L
Len Brown 已提交
449
u8 acpi_ut_valid_internal_object(void *object);
L
Linus Torvalds 已提交
450

451 452
union acpi_operand_object *acpi_ut_create_package_object(u32 count);

453 454
union acpi_operand_object *acpi_ut_create_integer_object(u64 value);

L
Len Brown 已提交
455
union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
L
Linus Torvalds 已提交
456

L
Len Brown 已提交
457
union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
L
Linus Torvalds 已提交
458 459

acpi_status
L
Len Brown 已提交
460
acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
L
Linus Torvalds 已提交
461

462 463 464 465 466
/*
 * utosi - Support for the _OSI predefined control method
 */
acpi_status acpi_ut_initialize_interfaces(void);

467
acpi_status acpi_ut_interface_terminate(void);
468 469 470 471 472

acpi_status acpi_ut_install_interface(acpi_string interface_name);

acpi_status acpi_ut_remove_interface(acpi_string interface_name);

473 474
acpi_status acpi_ut_update_interfaces(u8 action);

475 476 477 478
struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);

acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
/*
 * utpredef - support for predefined names
 */
const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
								     acpi_predefined_info
								     *this_name);

const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);

const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);

void
acpi_ut_display_predefined_method(char *buffer,
				  const union acpi_predefined_info *this_name,
				  u8 multi_line);

void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);

u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);

L
Linus Torvalds 已提交
499
/*
R
Robert Moore 已提交
500
 * utstate - Generic state creation/cache routines
L
Linus Torvalds 已提交
501 502
 */
void
L
Len Brown 已提交
503 504
acpi_ut_push_generic_state(union acpi_generic_state **list_head,
			   union acpi_generic_state *state);
L
Linus Torvalds 已提交
505

L
Len Brown 已提交
506 507
union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
						    **list_head);
L
Linus Torvalds 已提交
508

L
Len Brown 已提交
509
union acpi_generic_state *acpi_ut_create_generic_state(void);
L
Linus Torvalds 已提交
510

L
Len Brown 已提交
511
struct acpi_thread_state *acpi_ut_create_thread_state(void);
L
Linus Torvalds 已提交
512

L
Len Brown 已提交
513 514
union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
						      *object, u16 action);
L
Linus Torvalds 已提交
515

L
Len Brown 已提交
516 517 518
union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
						   void *external_object,
						   u16 index);
L
Linus Torvalds 已提交
519 520

acpi_status
L
Len Brown 已提交
521 522 523
acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
				     u16 action,
				     union acpi_generic_state **state_list);
L
Linus Torvalds 已提交
524

R
Robert Moore 已提交
525
#ifdef	ACPI_FUTURE_USAGE
L
Linus Torvalds 已提交
526
acpi_status
L
Len Brown 已提交
527 528 529 530 531
acpi_ut_create_pkg_state_and_push(void *internal_object,
				  void *external_object,
				  u16 index,
				  union acpi_generic_state **state_list);
#endif				/* ACPI_FUTURE_USAGE */
L
Linus Torvalds 已提交
532

L
Len Brown 已提交
533
union acpi_generic_state *acpi_ut_create_control_state(void);
L
Linus Torvalds 已提交
534

L
Len Brown 已提交
535
void acpi_ut_delete_generic_state(union acpi_generic_state *state);
R
Robert Moore 已提交
536

L
Linus Torvalds 已提交
537
/*
R
Robert Moore 已提交
538
 * utmath
L
Linus Torvalds 已提交
539 540
 */
acpi_status
541 542
acpi_ut_divide(u64 in_dividend,
	       u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
L
Linus Torvalds 已提交
543 544

acpi_status
545 546
acpi_ut_short_divide(u64 in_dividend,
		     u32 divisor, u64 *out_quotient, u32 *out_remainder);
L
Linus Torvalds 已提交
547

R
Robert Moore 已提交
548 549 550
/*
 * utmisc
 */
551 552
const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
							     status);
553

554 555
u8 acpi_ut_is_pci_root_bridge(char *id);

B
Bob Moore 已提交
556 557
u8 acpi_ut_is_aml_table(struct acpi_table_header *table);

558
acpi_status
L
Len Brown 已提交
559 560 561
acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
			  void *target_object,
			  acpi_pkg_callback walk_callback, void *context);
R
Robert Moore 已提交
562

L
Linus Torvalds 已提交
563 564 565 566
/* Values for Base above (16=Hex, 10=Decimal) */

#define ACPI_ANY_BASE        0

B
Bob Moore 已提交
567 568 569 570 571 572 573 574 575 576 577
u32 acpi_ut_dword_byte_swap(u32 value);

void acpi_ut_set_integer_width(u8 revision);

#ifdef ACPI_DEBUG_OUTPUT
void
acpi_ut_display_init_pathname(u8 type,
			      struct acpi_namespace_node *obj_handle,
			      char *path);
#endif

578 579 580 581 582 583 584
/*
 * utownerid - Support for Table/Method Owner IDs
 */
acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);

void acpi_ut_release_owner_id(acpi_owner_id * owner_id);

B
Bob Moore 已提交
585 586 587 588
/*
 * utresrc
 */
acpi_status
589 590
acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
			   u8 *aml,
B
Bob Moore 已提交
591
			   acpi_size aml_length,
L
Len Brown 已提交
592 593
			   acpi_walk_aml_callback user_function,
			   void **context);
B
Bob Moore 已提交
594

595 596 597
acpi_status
acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
			  void *aml, u8 *return_index);
B
Bob Moore 已提交
598

B
Bob Moore 已提交
599 600 601 602
u32 acpi_ut_get_descriptor_length(void *aml);

u16 acpi_ut_get_resource_length(void *aml);

B
Bob Moore 已提交
603 604
u8 acpi_ut_get_resource_header_length(void *aml);

B
Bob Moore 已提交
605 606
u8 acpi_ut_get_resource_type(void *aml);

B
Bob Moore 已提交
607
acpi_status
608
acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
L
Linus Torvalds 已提交
609

610 611 612 613 614 615 616 617 618 619 620
/*
 * utstring - String and character utilities
 */
void acpi_ut_strupr(char *src_string);

void acpi_ut_strlwr(char *src_string);

int acpi_ut_stricmp(char *string1, char *string2);

acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);

621
void acpi_ut_print_string(char *string, u16 max_length);
622 623 624

void ut_convert_backslashes(char *pathname);

625
u8 acpi_ut_valid_acpi_name(char *name);
626 627 628 629 630

u8 acpi_ut_valid_acpi_char(char character, u32 position);

void acpi_ut_repair_name(char *name);

631 632 633 634 635 636 637 638 639 640 641
#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);

u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);

u8
acpi_ut_safe_strncat(char *dest,
		     acpi_size dest_size,
		     char *source, acpi_size max_transfer_length);
#endif

L
Linus Torvalds 已提交
642
/*
643
 * utmutex - mutex support
L
Linus Torvalds 已提交
644
 */
L
Len Brown 已提交
645
acpi_status acpi_ut_mutex_initialize(void);
L
Linus Torvalds 已提交
646

L
Len Brown 已提交
647
void acpi_ut_mutex_terminate(void);
648

L
Len Brown 已提交
649
acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
650

L
Len Brown 已提交
651
acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
652 653 654 655

/*
 * utalloc - memory allocation and object caching
 */
L
Len Brown 已提交
656
acpi_status acpi_ut_create_caches(void);
657

L
Len Brown 已提交
658
acpi_status acpi_ut_delete_caches(void);
L
Linus Torvalds 已提交
659

L
Len Brown 已提交
660
acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
L
Linus Torvalds 已提交
661 662

acpi_status
L
Len Brown 已提交
663 664 665
acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
			  acpi_size required_length);

L
Linus Torvalds 已提交
666
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
L
Len Brown 已提交
667
void *acpi_ut_allocate_and_track(acpi_size size,
668
				 u32 component, const char *module, u32 line);
L
Len Brown 已提交
669

B
Bob Moore 已提交
670
void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
671 672
					u32 component,
					const char *module, u32 line);
L
Linus Torvalds 已提交
673 674

void
675 676
acpi_ut_free_and_track(void *address,
		       u32 component, const char *module, u32 line);
L
Linus Torvalds 已提交
677

R
Robert Moore 已提交
678
#ifdef	ACPI_FUTURE_USAGE
L
Len Brown 已提交
679 680
void acpi_ut_dump_allocation_info(void);
#endif				/* ACPI_FUTURE_USAGE */
L
Linus Torvalds 已提交
681

682
void acpi_ut_dump_allocations(u32 component, const char *module);
B
Bob Moore 已提交
683 684 685 686 687

acpi_status
acpi_ut_create_list(char *list_name,
		    u16 object_size, struct acpi_memory_list **return_cache);

688 689
#endif				/* ACPI_DBG_TRACK_ALLOCATIONS */

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
/*
 * utaddress - address range check
 */
acpi_status
acpi_ut_add_address_range(acpi_adr_space_type space_id,
			  acpi_physical_address address,
			  u32 length, struct acpi_namespace_node *region_node);

void
acpi_ut_remove_address_range(acpi_adr_space_type space_id,
			     struct acpi_namespace_node *region_node);

u32
acpi_ut_check_address_range(acpi_adr_space_type space_id,
			    acpi_physical_address address, u32 length, u8 warn);

void acpi_ut_delete_address_lists(void);

708 709 710 711 712 713 714 715 716 717 718 719 720 721
/*
 * utxferror - various error/warning output functions
 */
void ACPI_INTERNAL_VAR_XFACE
acpi_ut_predefined_warning(const char *module_name,
			   u32 line_number,
			   char *pathname,
			   u8 node_flags, const char *format, ...);

void ACPI_INTERNAL_VAR_XFACE
acpi_ut_predefined_info(const char *module_name,
			u32 line_number,
			char *pathname, u8 node_flags, const char *format, ...);

722 723 724 725 726 727
void ACPI_INTERNAL_VAR_XFACE
acpi_ut_predefined_bios_error(const char *module_name,
			      u32 line_number,
			      char *pathname,
			      u8 node_flags, const char *format, ...);

728 729 730 731 732 733 734 735 736 737 738
void
acpi_ut_namespace_error(const char *module_name,
			u32 line_number,
			const char *internal_name, acpi_status lookup_status);

void
acpi_ut_method_error(const char *module_name,
		     u32 line_number,
		     const char *message,
		     struct acpi_namespace_node *node,
		     const char *path, acpi_status lookup_status);
L
Linus Torvalds 已提交
739

L
Len Brown 已提交
740
#endif				/* _ACUTILS_H */