Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
| 3 | * Module Name: pstree - Parser op tree manipulation/traversal/search |
| 4 | * |
| 5 | *****************************************************************************/ |
| 6 | |
| 7 | /* |
Bob Moore | 4a90c7e | 2006-01-13 16:22:00 -0500 | [diff] [blame] | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | #include <acpi/acpi.h> |
| 45 | #include <acpi/acparser.h> |
| 46 | #include <acpi/amlcode.h> |
| 47 | |
| 48 | #define _COMPONENT ACPI_PARSER |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 49 | ACPI_MODULE_NAME("pstree") |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 51 | /* Local prototypes */ |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 52 | #ifdef ACPI_OBSOLETE_FUNCTIONS |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 53 | union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op); |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 54 | #endif |
| 55 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | /******************************************************************************* |
| 57 | * |
| 58 | * FUNCTION: acpi_ps_get_arg |
| 59 | * |
| 60 | * PARAMETERS: Op - Get an argument for this op |
| 61 | * Argn - Nth argument to get |
| 62 | * |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 63 | * RETURN: The argument (as an Op object). NULL if argument does not exist |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 64 | * |
| 65 | * DESCRIPTION: Get the specified op's argument. |
| 66 | * |
| 67 | ******************************************************************************/ |
| 68 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 69 | union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 70 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 71 | union acpi_parse_object *arg = NULL; |
| 72 | const struct acpi_opcode_info *op_info; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 74 | ACPI_FUNCTION_ENTRY(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | |
| 76 | /* Get the info structure for this opcode */ |
| 77 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 78 | op_info = acpi_ps_get_opcode_info(op->common.aml_opcode); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | if (op_info->class == AML_CLASS_UNKNOWN) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 80 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | /* Invalid opcode or ASCII character */ |
| 82 | |
| 83 | return (NULL); |
| 84 | } |
| 85 | |
| 86 | /* Check if this opcode requires argument sub-objects */ |
| 87 | |
| 88 | if (!(op_info->flags & AML_HAS_ARGS)) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 89 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | /* Has no linked argument objects */ |
| 91 | |
| 92 | return (NULL); |
| 93 | } |
| 94 | |
| 95 | /* Get the requested argument object */ |
| 96 | |
| 97 | arg = op->common.value.arg; |
| 98 | while (arg && argn) { |
| 99 | argn--; |
| 100 | arg = arg->common.next; |
| 101 | } |
| 102 | |
| 103 | return (arg); |
| 104 | } |
| 105 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | /******************************************************************************* |
| 107 | * |
| 108 | * FUNCTION: acpi_ps_append_arg |
| 109 | * |
| 110 | * PARAMETERS: Op - Append an argument to this Op. |
| 111 | * Arg - Argument Op to append |
| 112 | * |
| 113 | * RETURN: None. |
| 114 | * |
| 115 | * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK) |
| 116 | * |
| 117 | ******************************************************************************/ |
| 118 | |
| 119 | void |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 120 | acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 122 | union acpi_parse_object *prev_arg; |
| 123 | const struct acpi_opcode_info *op_info; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 125 | ACPI_FUNCTION_ENTRY(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | |
| 127 | if (!op) { |
| 128 | return; |
| 129 | } |
| 130 | |
| 131 | /* Get the info structure for this opcode */ |
| 132 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 133 | op_info = acpi_ps_get_opcode_info(op->common.aml_opcode); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | if (op_info->class == AML_CLASS_UNKNOWN) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 135 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | /* Invalid opcode */ |
| 137 | |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 138 | ACPI_ERROR((AE_INFO, "Invalid AML Opcode: 0x%2.2X", |
| 139 | op->common.aml_opcode)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | return; |
| 141 | } |
| 142 | |
| 143 | /* Check if this opcode requires argument sub-objects */ |
| 144 | |
| 145 | if (!(op_info->flags & AML_HAS_ARGS)) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 146 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | /* Has no linked argument objects */ |
| 148 | |
| 149 | return; |
| 150 | } |
| 151 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | /* Append the argument to the linked argument list */ |
| 153 | |
| 154 | if (op->common.value.arg) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 155 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | /* Append to existing argument list */ |
| 157 | |
| 158 | prev_arg = op->common.value.arg; |
| 159 | while (prev_arg->common.next) { |
| 160 | prev_arg = prev_arg->common.next; |
| 161 | } |
| 162 | prev_arg->common.next = arg; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 163 | } else { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | /* No argument list, this will be the first argument */ |
| 165 | |
| 166 | op->common.value.arg = arg; |
| 167 | } |
| 168 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 169 | /* Set the parent in this arg and any args linked after it */ |
| 170 | |
| 171 | while (arg) { |
| 172 | arg->common.parent = op; |
| 173 | arg = arg->common.next; |
| 174 | } |
| 175 | } |
| 176 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | #ifdef ACPI_FUTURE_USAGE |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 178 | /******************************************************************************* |
| 179 | * |
| 180 | * FUNCTION: acpi_ps_get_depth_next |
| 181 | * |
| 182 | * PARAMETERS: Origin - Root of subtree to search |
| 183 | * Op - Last (previous) Op that was found |
| 184 | * |
| 185 | * RETURN: Next Op found in the search. |
| 186 | * |
| 187 | * DESCRIPTION: Get next op in tree (walking the tree in depth-first order) |
| 188 | * Return NULL when reaching "origin" or when walking up from root |
| 189 | * |
| 190 | ******************************************************************************/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 192 | union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin, |
| 193 | union acpi_parse_object *op) |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 194 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 195 | union acpi_parse_object *next = NULL; |
| 196 | union acpi_parse_object *parent; |
| 197 | union acpi_parse_object *arg; |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 198 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 199 | ACPI_FUNCTION_ENTRY(); |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 200 | |
| 201 | if (!op) { |
| 202 | return (NULL); |
| 203 | } |
| 204 | |
| 205 | /* Look for an argument or child */ |
| 206 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 207 | next = acpi_ps_get_arg(op, 0); |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 208 | if (next) { |
| 209 | return (next); |
| 210 | } |
| 211 | |
| 212 | /* Look for a sibling */ |
| 213 | |
| 214 | next = op->common.next; |
| 215 | if (next) { |
| 216 | return (next); |
| 217 | } |
| 218 | |
| 219 | /* Look for a sibling of parent */ |
| 220 | |
| 221 | parent = op->common.parent; |
| 222 | |
| 223 | while (parent) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 224 | arg = acpi_ps_get_arg(parent, 0); |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 225 | while (arg && (arg != origin) && (arg != op)) { |
| 226 | arg = arg->common.next; |
| 227 | } |
| 228 | |
| 229 | if (arg == origin) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 230 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 231 | /* Reached parent of origin, end search */ |
| 232 | |
| 233 | return (NULL); |
| 234 | } |
| 235 | |
| 236 | if (parent->common.next) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 237 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 238 | /* Found sibling of parent */ |
| 239 | |
| 240 | return (parent->common.next); |
| 241 | } |
| 242 | |
| 243 | op = parent; |
| 244 | parent = parent->common.parent; |
| 245 | } |
| 246 | |
| 247 | return (next); |
| 248 | } |
| 249 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 250 | #ifdef ACPI_OBSOLETE_FUNCTIONS |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 251 | /******************************************************************************* |
| 252 | * |
| 253 | * FUNCTION: acpi_ps_get_child |
| 254 | * |
| 255 | * PARAMETERS: Op - Get the child of this Op |
| 256 | * |
| 257 | * RETURN: Child Op, Null if none is found. |
| 258 | * |
| 259 | * DESCRIPTION: Get op's children or NULL if none |
| 260 | * |
| 261 | ******************************************************************************/ |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 262 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 263 | union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 264 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 265 | union acpi_parse_object *child = NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 266 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 267 | ACPI_FUNCTION_ENTRY(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 268 | |
| 269 | switch (op->common.aml_opcode) { |
| 270 | case AML_SCOPE_OP: |
| 271 | case AML_ELSE_OP: |
| 272 | case AML_DEVICE_OP: |
| 273 | case AML_THERMAL_ZONE_OP: |
| 274 | case AML_INT_METHODCALL_OP: |
| 275 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 276 | child = acpi_ps_get_arg(op, 0); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | break; |
| 278 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 279 | case AML_BUFFER_OP: |
| 280 | case AML_PACKAGE_OP: |
| 281 | case AML_METHOD_OP: |
| 282 | case AML_IF_OP: |
| 283 | case AML_WHILE_OP: |
| 284 | case AML_FIELD_OP: |
| 285 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 286 | child = acpi_ps_get_arg(op, 1); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 287 | break; |
| 288 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 289 | case AML_POWER_RES_OP: |
| 290 | case AML_INDEX_FIELD_OP: |
| 291 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 292 | child = acpi_ps_get_arg(op, 2); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 293 | break; |
| 294 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 295 | case AML_PROCESSOR_OP: |
| 296 | case AML_BANK_FIELD_OP: |
| 297 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 298 | child = acpi_ps_get_arg(op, 3); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 299 | break; |
| 300 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 301 | default: |
| 302 | /* All others have no children */ |
| 303 | break; |
| 304 | } |
| 305 | |
| 306 | return (child); |
| 307 | } |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 308 | #endif |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 309 | #endif /* ACPI_FUTURE_USAGE */ |