drivers/acpi/parser/psxface.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psxface - Parser external interfaces
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2007, 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/acparser.h>
  46 #include <acpi/acdispat.h>
  47 #include <acpi/acinterp.h>
  48
  49 #define _COMPONENT          ACPI_PARSER
  50 ACPI_MODULE_NAME("psxface")
  51
  52 /* Local Prototypes */
  53 static void acpi_ps_start_trace(struct acpi_evaluate_info *info);
  54
  55 static void acpi_ps_stop_trace(struct acpi_evaluate_info *info);
  56
  57 static void
  58 acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action);
  59
  60 /*******************************************************************************
  61  *
  62  * FUNCTION:    acpi_debug_trace
  63  *
  64  * PARAMETERS:  method_name     - Valid ACPI name string
  65  *              debug_level     - Optional level mask. 0 to use default
  66  *              debug_layer     - Optional layer mask. 0 to use default
  67  *              Flags           - bit 1: one shot(1) or persistent(0)
  68  *
  69  * RETURN:      Status
  70  *
  71  * DESCRIPTION: External interface to enable debug tracing during control
  72  *              method execution
  73  *
  74  ******************************************************************************/
  75
  76 acpi_status
  77 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags)
  78 {
  79         acpi_status status;
  80
  81         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  82         if (ACPI_FAILURE(status)) {
  83                 return (status);
  84         }
  85
  86         /* TBDs: Validate name, allow full path or just nameseg */
  87
  88         acpi_gbl_trace_method_name = *ACPI_CAST_PTR(u32, name);
  89         acpi_gbl_trace_flags = flags;
  90
  91         if (debug_level) {
  92                 acpi_gbl_trace_dbg_level = debug_level;
  93         }
  94         if (debug_layer) {
  95                 acpi_gbl_trace_dbg_layer = debug_layer;
  96         }
  97
  98         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  99         return (AE_OK);
 100 }
 101
 102 /*******************************************************************************
 103  *
 104  * FUNCTION:    acpi_ps_start_trace
 105  *
 106  * PARAMETERS:  Info        - Method info struct
 107  *
 108  * RETURN:      None
 109  *
 110  * DESCRIPTION: Start control method execution trace
 111  *
 112  ******************************************************************************/
 113
 114 static void acpi_ps_start_trace(struct acpi_evaluate_info *info)
 115 {
 116         acpi_status status;
 117
 118         ACPI_FUNCTION_ENTRY();
 119
 120         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 121         if (ACPI_FAILURE(status)) {
 122                 return;
 123         }
 124
 125         if ((!acpi_gbl_trace_method_name) ||
 126             (acpi_gbl_trace_method_name != info->resolved_node->name.integer)) {
 127                 goto exit;
 128         }
 129
 130         acpi_gbl_original_dbg_level = acpi_dbg_level;
 131         acpi_gbl_original_dbg_layer = acpi_dbg_layer;
 132
 133         acpi_dbg_level = 0x00FFFFFF;
 134         acpi_dbg_layer = ACPI_UINT32_MAX;
 135
 136         if (acpi_gbl_trace_dbg_level) {
 137                 acpi_dbg_level = acpi_gbl_trace_dbg_level;
 138         }
 139         if (acpi_gbl_trace_dbg_layer) {
 140                 acpi_dbg_layer = acpi_gbl_trace_dbg_layer;
 141         }
 142
 143       exit:
 144         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 145 }
 146
 147 /*******************************************************************************
 148  *
 149  * FUNCTION:    acpi_ps_stop_trace
 150  *
 151  * PARAMETERS:  Info        - Method info struct
 152  *
 153  * RETURN:      None
 154  *
 155  * DESCRIPTION: Stop control method execution trace
 156  *
 157  ******************************************************************************/
 158
 159 static void acpi_ps_stop_trace(struct acpi_evaluate_info *info)
 160 {
 161         acpi_status status;
 162
 163         ACPI_FUNCTION_ENTRY();
 164
 165         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 166         if (ACPI_FAILURE(status)) {
 167                 return;
 168         }
 169
 170         if ((!acpi_gbl_trace_method_name) ||
 171             (acpi_gbl_trace_method_name != info->resolved_node->name.integer)) {
 172                 goto exit;
 173         }
 174
 175         /* Disable further tracing if type is one-shot */
 176
 177         if (acpi_gbl_trace_flags & 1) {
 178                 acpi_gbl_trace_method_name = 0;
 179                 acpi_gbl_trace_dbg_level = 0;
 180                 acpi_gbl_trace_dbg_layer = 0;
 181         }
 182
 183         acpi_dbg_level = acpi_gbl_original_dbg_level;
 184         acpi_dbg_layer = acpi_gbl_original_dbg_layer;
 185
 186       exit:
 187         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 188 }
 189
 190 /*******************************************************************************
 191  *
 192  * FUNCTION:    acpi_ps_execute_method
 193  *
 194  * PARAMETERS:  Info            - Method info block, contains:
 195  *                  Node            - Method Node to execute
 196  *                  obj_desc        - Method object
 197  *                  Parameters      - List of parameters to pass to the method,
 198  *                                    terminated by NULL. Params itself may be
 199  *                                    NULL if no parameters are being passed.
 200  *                  return_object   - Where to put method's return value (if
 201  *                                    any). If NULL, no value is returned.
 202  *                  parameter_type  - Type of Parameter list
 203  *                  return_object   - Where to put method's return value (if
 204  *                                    any). If NULL, no value is returned.
 205  *                  pass_number     - Parse or execute pass
 206  *
 207  * RETURN:      Status
 208  *
 209  * DESCRIPTION: Execute a control method
 210  *
 211  ******************************************************************************/
 212
 213 acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info)
 214 {
 215         acpi_status status;
 216         union acpi_parse_object *op;
 217         struct acpi_walk_state *walk_state;
 218
 219         ACPI_FUNCTION_TRACE(ps_execute_method);
 220
 221         /* Validate the Info and method Node */
 222
 223         if (!info || !info->resolved_node) {
 224                 return_ACPI_STATUS(AE_NULL_ENTRY);
 225         }
 226
 227         /* Init for new method, wait on concurrency semaphore */
 228
 229         status =
 230             acpi_ds_begin_method_execution(info->resolved_node, info->obj_desc,
 231                                            NULL);
 232         if (ACPI_FAILURE(status)) {
 233                 return_ACPI_STATUS(status);
 234         }
 235
 236         /*
 237          * The caller "owns" the parameters, so give each one an extra reference
 238          */
 239         acpi_ps_update_parameter_list(info, REF_INCREMENT);
 240
 241         /* Begin tracing if requested */
 242
 243         acpi_ps_start_trace(info);
 244
 245         /*
 246          * Execute the method. Performs parse simultaneously
 247          */
 248         ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
 249                           "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
 250                           info->resolved_node->name.ascii, info->resolved_node,
 251                           info->obj_desc));
 252
 253         /* Create and init a Root Node */
 254
 255         op = acpi_ps_create_scope_op();
 256         if (!op) {
 257                 status = AE_NO_MEMORY;
 258                 goto cleanup;
 259         }
 260
 261         /* Create and initialize a new walk state */
 262
 263         info->pass_number = ACPI_IMODE_EXECUTE;
 264         walk_state =
 265             acpi_ds_create_walk_state(info->obj_desc->method.owner_id, NULL,
 266                                       NULL, NULL);
 267         if (!walk_state) {
 268                 status = AE_NO_MEMORY;
 269                 goto cleanup;
 270         }
 271
 272         status = acpi_ds_init_aml_walk(walk_state, op, info->resolved_node,
 273                                        info->obj_desc->method.aml_start,
 274                                        info->obj_desc->method.aml_length, info,
 275                                        info->pass_number);
 276         if (ACPI_FAILURE(status)) {
 277                 acpi_ds_delete_walk_state(walk_state);
 278                 goto cleanup;
 279         }
 280
 281         /* Parse the AML */
 282
 283         status = acpi_ps_parse_aml(walk_state);
 284
 285         /* walk_state was deleted by parse_aml */
 286
 287       cleanup:
 288         acpi_ps_delete_parse_tree(op);
 289
 290         /* End optional tracing */
 291
 292         acpi_ps_stop_trace(info);
 293
 294         /* Take away the extra reference that we gave the parameters above */
 295
 296         acpi_ps_update_parameter_list(info, REF_DECREMENT);
 297
 298         /* Exit now if error above */
 299
 300         if (ACPI_FAILURE(status)) {
 301                 return_ACPI_STATUS(status);
 302         }
 303
 304         /*
 305          * If the method has returned an object, signal this to the caller with
 306          * a control exception code
 307          */
 308         if (info->return_object) {
 309                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
 310                                   info->return_object));
 311                 ACPI_DUMP_STACK_ENTRY(info->return_object);
 312
 313                 status = AE_CTRL_RETURN_VALUE;
 314         }
 315
 316         return_ACPI_STATUS(status);
 317 }
 318
 319 /*******************************************************************************
 320  *
 321  * FUNCTION:    acpi_ps_update_parameter_list
 322  *
 323  * PARAMETERS:  Info            - See struct acpi_evaluate_info
 324  *                                (Used: parameter_type and Parameters)
 325  *              Action          - Add or Remove reference
 326  *
 327  * RETURN:      Status
 328  *
 329  * DESCRIPTION: Update reference count on all method parameter objects
 330  *
 331  ******************************************************************************/
 332
 333 static void
 334 acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action)
 335 {
 336         acpi_native_uint i;
 337
 338         if ((info->parameter_type == ACPI_PARAM_ARGS) && (info->parameters)) {
 339
 340                 /* Update reference count for each parameter */
 341
 342                 for (i = 0; info->parameters[i]; i++) {
 343
 344                         /* Ignore errors, just do them all */
 345
 346                         (void)acpi_ut_update_object_reference(info->
 347                                                               parameters[i],
 348                                                               action);
 349                 }
 350         }
 351 }