drivers/acpi/dispatcher/dswscope.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dswscope - Scope stack manipulation
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/acdispat.h>
  46
  47 #define _COMPONENT          ACPI_DISPATCHER
  48 ACPI_MODULE_NAME("dswscope")
  49
  50 /****************************************************************************
  51  *
  52  * FUNCTION:    acpi_ds_scope_stack_clear
  53  *
  54  * PARAMETERS:  walk_state      - Current state
  55  *
  56  * RETURN:      None
  57  *
  58  * DESCRIPTION: Pop (and free) everything on the scope stack except the
  59  *              root scope object (which remains at the stack top.)
  60  *
  61  ***************************************************************************/
  62 void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state)
  63 {
  64         union acpi_generic_state *scope_info;
  65
  66         ACPI_FUNCTION_NAME("ds_scope_stack_clear");
  67
  68         while (walk_state->scope_info) {
  69                 /* Pop a scope off the stack */
  70
  71                 scope_info = walk_state->scope_info;
  72                 walk_state->scope_info = scope_info->scope.next;
  73
  74                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
  75                                   "Popped object type (%s)\n",
  76                                   acpi_ut_get_type_name(scope_info->common.
  77                                                         value)));
  78                 acpi_ut_delete_generic_state(scope_info);
  79         }
  80 }
  81
  82 /****************************************************************************
  83  *
  84  * FUNCTION:    acpi_ds_scope_stack_push
  85  *
  86  * PARAMETERS:  Node            - Name to be made current
  87  *              Type            - Type of frame being pushed
  88  *              walk_state      - Current state
  89  *
  90  * RETURN:      Status
  91  *
  92  * DESCRIPTION: Push the current scope on the scope stack, and make the
  93  *              passed Node current.
  94  *
  95  ***************************************************************************/
  96
  97 acpi_status
  98 acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
  99                          acpi_object_type type,
 100                          struct acpi_walk_state *walk_state)
 101 {
 102         union acpi_generic_state *scope_info;
 103         union acpi_generic_state *old_scope_info;
 104
 105         ACPI_FUNCTION_TRACE("ds_scope_stack_push");
 106
 107         if (!node) {
 108                 /* Invalid scope   */
 109
 110                 ACPI_ERROR((AE_INFO, "Null scope parameter"));
 111                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 112         }
 113
 114         /* Make sure object type is valid */
 115
 116         if (!acpi_ut_valid_object_type(type)) {
 117                 ACPI_WARNING((AE_INFO, "Invalid object type: 0x%X", type));
 118         }
 119
 120         /* Allocate a new scope object */
 121
 122         scope_info = acpi_ut_create_generic_state();
 123         if (!scope_info) {
 124                 return_ACPI_STATUS(AE_NO_MEMORY);
 125         }
 126
 127         /* Init new scope object */
 128
 129         scope_info->common.data_type = ACPI_DESC_TYPE_STATE_WSCOPE;
 130         scope_info->scope.node = node;
 131         scope_info->common.value = (u16) type;
 132
 133         walk_state->scope_depth++;
 134
 135         ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 136                           "[%.2d] Pushed scope ",
 137                           (u32) walk_state->scope_depth));
 138
 139         old_scope_info = walk_state->scope_info;
 140         if (old_scope_info) {
 141                 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC,
 142                                       "[%4.4s] (%s)",
 143                                       acpi_ut_get_node_name(old_scope_info->
 144                                                             scope.node),
 145                                       acpi_ut_get_type_name(old_scope_info->
 146                                                             common.value)));
 147         } else {
 148                 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC, "[\\___] (%s)", "ROOT"));
 149         }
 150
 151         ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC,
 152                               ", New scope -> [%4.4s] (%s)\n",
 153                               acpi_ut_get_node_name(scope_info->scope.node),
 154                               acpi_ut_get_type_name(scope_info->common.value)));
 155
 156         /* Push new scope object onto stack */
 157
 158         acpi_ut_push_generic_state(&walk_state->scope_info, scope_info);
 159         return_ACPI_STATUS(AE_OK);
 160 }
 161
 162 /****************************************************************************
 163  *
 164  * FUNCTION:    acpi_ds_scope_stack_pop
 165  *
 166  * PARAMETERS:  walk_state      - Current state
 167  *
 168  * RETURN:      Status
 169  *
 170  * DESCRIPTION: Pop the scope stack once.
 171  *
 172  ***************************************************************************/
 173
 174 acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state)
 175 {
 176         union acpi_generic_state *scope_info;
 177         union acpi_generic_state *new_scope_info;
 178
 179         ACPI_FUNCTION_TRACE("ds_scope_stack_pop");
 180
 181         /*
 182          * Pop scope info object off the stack.
 183          */
 184         scope_info = acpi_ut_pop_generic_state(&walk_state->scope_info);
 185         if (!scope_info) {
 186                 return_ACPI_STATUS(AE_STACK_UNDERFLOW);
 187         }
 188
 189         walk_state->scope_depth--;
 190
 191         ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 192                           "[%.2d] Popped scope [%4.4s] (%s), New scope -> ",
 193                           (u32) walk_state->scope_depth,
 194                           acpi_ut_get_node_name(scope_info->scope.node),
 195                           acpi_ut_get_type_name(scope_info->common.value)));
 196
 197         new_scope_info = walk_state->scope_info;
 198         if (new_scope_info) {
 199                 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC,
 200                                       "[%4.4s] (%s)\n",
 201                                       acpi_ut_get_node_name(new_scope_info->
 202                                                             scope.node),
 203                                       acpi_ut_get_type_name(new_scope_info->
 204                                                             common.value)));
 205         } else {
 206                 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC, "[\\___] (ROOT)\n"));
 207         }
 208
 209         acpi_ut_delete_generic_state(scope_info);
 210         return_ACPI_STATUS(AE_OK);
 211 }