drivers/acpi/parser/psxface.c

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