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