drivers/acpi/acpica/nsinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsinit - namespace initialization
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2008, Intel Corp.
   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 "accommon.h"
  46 #include "acnamesp.h"
  47 #include "acdispat.h"
  48 #include "acinterp.h"
  49 #include <linux/nmi.h>
  50
  51 #define _COMPONENT          ACPI_NAMESPACE
  52 ACPI_MODULE_NAME("nsinit")
  53
  54 /* Local prototypes */
  55 static acpi_status
  56 acpi_ns_init_one_object(acpi_handle obj_handle,
  57                         u32 level, void *context, void **return_value);
  58
  59 static acpi_status
  60 acpi_ns_init_one_device(acpi_handle obj_handle,
  61                         u32 nesting_level, void *context, void **return_value);
  62
  63 static acpi_status
  64 acpi_ns_find_ini_methods(acpi_handle obj_handle,
  65                          u32 nesting_level, void *context, void **return_value);
  66
  67 /*******************************************************************************
  68  *
  69  * FUNCTION:    acpi_ns_initialize_objects
  70  *
  71  * PARAMETERS:  None
  72  *
  73  * RETURN:      Status
  74  *
  75  * DESCRIPTION: Walk the entire namespace and perform any necessary
  76  *              initialization on the objects found therein
  77  *
  78  ******************************************************************************/
  79
  80 acpi_status acpi_ns_initialize_objects(void)
  81 {
  82         acpi_status status;
  83         struct acpi_init_walk_info info;
  84
  85         ACPI_FUNCTION_TRACE(ns_initialize_objects);
  86
  87         ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
  88                           "**** Starting initialization of namespace objects ****\n"));
  89         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
  90                               "Completing Region/Field/Buffer/Package initialization:"));
  91
  92         /* Set all init info to zero */
  93
  94         ACPI_MEMSET(&info, 0, sizeof(struct acpi_init_walk_info));
  95
  96         /* Walk entire namespace from the supplied root */
  97
  98         status = acpi_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
  99                                      ACPI_UINT32_MAX, acpi_ns_init_one_object,
 100                                      &info, NULL);
 101         if (ACPI_FAILURE(status)) {
 102                 ACPI_EXCEPTION((AE_INFO, status, "During WalkNamespace"));
 103         }
 104
 105         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
 106                               "\nInitialized %hd/%hd Regions %hd/%hd Fields %hd/%hd "
 107                               "Buffers %hd/%hd Packages (%hd nodes)\n",
 108                               info.op_region_init, info.op_region_count,
 109                               info.field_init, info.field_count,
 110                               info.buffer_init, info.buffer_count,
 111                               info.package_init, info.package_count,
 112                               info.object_count));
 113
 114         ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
 115                           "%hd Control Methods found\n", info.method_count));
 116         ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
 117                           "%hd Op Regions found\n", info.op_region_count));
 118
 119         return_ACPI_STATUS(AE_OK);
 120 }
 121
 122 /*******************************************************************************
 123  *
 124  * FUNCTION:    acpi_ns_initialize_devices
 125  *
 126  * PARAMETERS:  None
 127  *
 128  * RETURN:      acpi_status
 129  *
 130  * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
 131  *              This means running _INI on all present devices.
 132  *
 133  *              Note: We install PCI config space handler on region access,
 134  *              not here.
 135  *
 136  ******************************************************************************/
 137
 138 acpi_status acpi_ns_initialize_devices(void)
 139 {
 140         acpi_status status;
 141         struct acpi_device_walk_info info;
 142
 143         ACPI_FUNCTION_TRACE(ns_initialize_devices);
 144
 145         /* Init counters */
 146
 147         info.device_count = 0;
 148         info.num_STA = 0;
 149         info.num_INI = 0;
 150
 151         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
 152                               "Initializing Device/Processor/Thermal objects "
 153                               "by executing _INI methods:"));
 154
 155         /* Tree analysis: find all subtrees that contain _INI methods */
 156
 157         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
 158                                         ACPI_UINT32_MAX, FALSE,
 159                                         acpi_ns_find_ini_methods, &info, NULL);
 160         if (ACPI_FAILURE(status)) {
 161                 goto error_exit;
 162         }
 163
 164         /* Allocate the evaluation information block */
 165
 166         info.evaluate_info =
 167             ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
 168         if (!info.evaluate_info) {
 169                 status = AE_NO_MEMORY;
 170                 goto error_exit;
 171         }
 172
 173         /* Walk namespace to execute all _INIs on present devices */
 174
 175         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
 176                                         ACPI_UINT32_MAX, FALSE,
 177                                         acpi_ns_init_one_device, &info, NULL);
 178
 179         ACPI_FREE(info.evaluate_info);
 180         if (ACPI_FAILURE(status)) {
 181                 goto error_exit;
 182         }
 183
 184         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
 185                               "\nExecuted %hd _INI methods requiring %hd _STA executions "
 186                               "(examined %hd objects)\n",
 187                               info.num_INI, info.num_STA, info.device_count));
 188
 189         return_ACPI_STATUS(status);
 190
 191       error_exit:
 192         ACPI_EXCEPTION((AE_INFO, status, "During device initialization"));
 193         return_ACPI_STATUS(status);
 194 }
 195
 196 /*******************************************************************************
 197  *
 198  * FUNCTION:    acpi_ns_init_one_object
 199  *
 200  * PARAMETERS:  obj_handle      - Node
 201  *              Level           - Current nesting level
 202  *              Context         - Points to a init info struct
 203  *              return_value    - Not used
 204  *
 205  * RETURN:      Status
 206  *
 207  * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object
 208  *              within the  namespace.
 209  *
 210  *              Currently, the only objects that require initialization are:
 211  *              1) Methods
 212  *              2) Op Regions
 213  *
 214  ******************************************************************************/
 215
 216 static acpi_status
 217 acpi_ns_init_one_object(acpi_handle obj_handle,
 218                         u32 level, void *context, void **return_value)
 219 {
 220         acpi_object_type type;
 221         acpi_status status = AE_OK;
 222         struct acpi_init_walk_info *info =
 223             (struct acpi_init_walk_info *)context;
 224         struct acpi_namespace_node *node =
 225             (struct acpi_namespace_node *)obj_handle;
 226         union acpi_operand_object *obj_desc;
 227
 228         ACPI_FUNCTION_NAME(ns_init_one_object);
 229
 230         info->object_count++;
 231
 232         /* And even then, we are only interested in a few object types */
 233
 234         type = acpi_ns_get_type(obj_handle);
 235         obj_desc = acpi_ns_get_attached_object(node);
 236         if (!obj_desc) {
 237                 return (AE_OK);
 238         }
 239
 240         /* Increment counters for object types we are looking for */
 241
 242         switch (type) {
 243         case ACPI_TYPE_REGION:
 244                 info->op_region_count++;
 245                 break;
 246
 247         case ACPI_TYPE_BUFFER_FIELD:
 248                 info->field_count++;
 249                 break;
 250
 251         case ACPI_TYPE_LOCAL_BANK_FIELD:
 252                 info->field_count++;
 253                 break;
 254
 255         case ACPI_TYPE_BUFFER:
 256                 info->buffer_count++;
 257                 break;
 258
 259         case ACPI_TYPE_PACKAGE:
 260                 info->package_count++;
 261                 break;
 262
 263         default:
 264
 265                 /* No init required, just exit now */
 266                 return (AE_OK);
 267         }
 268
 269         /* If the object is already initialized, nothing else to do */
 270
 271         if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
 272                 return (AE_OK);
 273         }
 274
 275         /* Must lock the interpreter before executing AML code */
 276
 277         acpi_ex_enter_interpreter();
 278
 279         /*
 280          * Each of these types can contain executable AML code within the
 281          * declaration.
 282          */
 283         switch (type) {
 284         case ACPI_TYPE_REGION:
 285
 286                 info->op_region_init++;
 287                 status = acpi_ds_get_region_arguments(obj_desc);
 288                 break;
 289
 290         case ACPI_TYPE_BUFFER_FIELD:
 291
 292                 info->field_init++;
 293                 status = acpi_ds_get_buffer_field_arguments(obj_desc);
 294                 break;
 295
 296         case ACPI_TYPE_LOCAL_BANK_FIELD:
 297
 298                 info->field_init++;
 299                 status = acpi_ds_get_bank_field_arguments(obj_desc);
 300                 break;
 301
 302         case ACPI_TYPE_BUFFER:
 303
 304                 info->buffer_init++;
 305                 status = acpi_ds_get_buffer_arguments(obj_desc);
 306                 break;
 307
 308         case ACPI_TYPE_PACKAGE:
 309
 310                 info->package_init++;
 311                 status = acpi_ds_get_package_arguments(obj_desc);
 312                 break;
 313
 314         default:
 315                 /* No other types can get here */
 316                 break;
 317         }
 318
 319         if (ACPI_FAILURE(status)) {
 320                 ACPI_EXCEPTION((AE_INFO, status,
 321                                 "Could not execute arguments for [%4.4s] (%s)",
 322                                 acpi_ut_get_node_name(node),
 323                                 acpi_ut_get_type_name(type)));
 324         }
 325
 326         /*
 327          * Print a dot for each object unless we are going to print the entire
 328          * pathname
 329          */
 330         if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
 331                 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, "."));
 332         }
 333
 334         /*
 335          * We ignore errors from above, and always return OK, since we don't want
 336          * to abort the walk on any single error.
 337          */
 338         acpi_ex_exit_interpreter();
 339         return (AE_OK);
 340 }
 341
 342 /*******************************************************************************
 343  *
 344  * FUNCTION:    acpi_ns_find_ini_methods
 345  *
 346  * PARAMETERS:  acpi_walk_callback
 347  *
 348  * RETURN:      acpi_status
 349  *
 350  * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
 351  *              device/processor/thermal objects, and marks the entire subtree
 352  *              with a SUBTREE_HAS_INI flag. This flag is used during the
 353  *              subsequent device initialization walk to avoid entire subtrees
 354  *              that do not contain an _INI.
 355  *
 356  ******************************************************************************/
 357
 358 static acpi_status
 359 acpi_ns_find_ini_methods(acpi_handle obj_handle,
 360                          u32 nesting_level, void *context, void **return_value)
 361 {
 362         struct acpi_device_walk_info *info =
 363             ACPI_CAST_PTR(struct acpi_device_walk_info, context);
 364         struct acpi_namespace_node *node;
 365         struct acpi_namespace_node *parent_node;
 366
 367         /* Keep count of device/processor/thermal objects */
 368
 369         node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
 370         if ((node->type == ACPI_TYPE_DEVICE) ||
 371             (node->type == ACPI_TYPE_PROCESSOR) ||
 372             (node->type == ACPI_TYPE_THERMAL)) {
 373                 info->device_count++;
 374                 return (AE_OK);
 375         }
 376
 377         /* We are only looking for methods named _INI */
 378
 379         if (!ACPI_COMPARE_NAME(node->name.ascii, METHOD_NAME__INI)) {
 380                 return (AE_OK);
 381         }
 382
 383         /*
 384          * The only _INI methods that we care about are those that are
 385          * present under Device, Processor, and Thermal objects.
 386          */
 387         parent_node = acpi_ns_get_parent_node(node);
 388         switch (parent_node->type) {
 389         case ACPI_TYPE_DEVICE:
 390         case ACPI_TYPE_PROCESSOR:
 391         case ACPI_TYPE_THERMAL:
 392
 393                 /* Mark parent and bubble up the INI present flag to the root */
 394
 395                 while (parent_node) {
 396                         parent_node->flags |= ANOBJ_SUBTREE_HAS_INI;
 397                         parent_node = acpi_ns_get_parent_node(parent_node);
 398                 }
 399                 break;
 400
 401         default:
 402                 break;
 403         }
 404
 405         return (AE_OK);
 406 }
 407
 408 /*******************************************************************************
 409  *
 410  * FUNCTION:    acpi_ns_init_one_device
 411  *
 412  * PARAMETERS:  acpi_walk_callback
 413  *
 414  * RETURN:      acpi_status
 415  *
 416  * DESCRIPTION: This is called once per device soon after ACPI is enabled
 417  *              to initialize each device. It determines if the device is
 418  *              present, and if so, calls _INI.
 419  *
 420  ******************************************************************************/
 421
 422 static acpi_status
 423 acpi_ns_init_one_device(acpi_handle obj_handle,
 424                         u32 nesting_level, void *context, void **return_value)
 425 {
 426         struct acpi_device_walk_info *walk_info =
 427             ACPI_CAST_PTR(struct acpi_device_walk_info, context);
 428         struct acpi_evaluate_info *info = walk_info->evaluate_info;
 429         u32 flags;
 430         acpi_status status;
 431         struct acpi_namespace_node *device_node;
 432
 433         ACPI_FUNCTION_TRACE(ns_init_one_device);
 434
 435         /* We are interested in Devices, Processors and thermal_zones only */
 436
 437         device_node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
 438         if ((device_node->type != ACPI_TYPE_DEVICE) &&
 439             (device_node->type != ACPI_TYPE_PROCESSOR) &&
 440             (device_node->type != ACPI_TYPE_THERMAL)) {
 441                 return_ACPI_STATUS(AE_OK);
 442         }
 443
 444         /*
 445          * Because of an earlier namespace analysis, all subtrees that contain an
 446          * _INI method are tagged.
 447          *
 448          * If this device subtree does not contain any _INI methods, we
 449          * can exit now and stop traversing this entire subtree.
 450          */
 451         if (!(device_node->flags & ANOBJ_SUBTREE_HAS_INI)) {
 452                 return_ACPI_STATUS(AE_CTRL_DEPTH);
 453         }
 454
 455         /*
 456          * Run _STA to determine if this device is present and functioning. We
 457          * must know this information for two important reasons (from ACPI spec):
 458          *
 459          * 1) We can only run _INI if the device is present.
 460          * 2) We must abort the device tree walk on this subtree if the device is
 461          *    not present and is not functional (we will not examine the children)
 462          *
 463          * The _STA method is not required to be present under the device, we
 464          * assume the device is present if _STA does not exist.
 465          */
 466         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
 467                         (ACPI_TYPE_METHOD, device_node, METHOD_NAME__STA));
 468
 469         status = acpi_ut_execute_STA(device_node, &flags);
 470         if (ACPI_FAILURE(status)) {
 471
 472                 /* Ignore error and move on to next device */
 473
 474                 return_ACPI_STATUS(AE_OK);
 475         }
 476
 477         /*
 478          * Flags == -1 means that _STA was not found. In this case, we assume that
 479          * the device is both present and functional.
 480          *
 481          * From the ACPI spec, description of _STA:
 482          *
 483          * "If a device object (including the processor object) does not have an
 484          * _STA object, then OSPM assumes that all of the above bits are set (in
 485          * other words, the device is present, ..., and functioning)"
 486          */
 487         if (flags != ACPI_UINT32_MAX) {
 488                 walk_info->num_STA++;
 489         }
 490
 491         /*
 492          * Examine the PRESENT and FUNCTIONING status bits
 493          *
 494          * Note: ACPI spec does not seem to specify behavior for the present but
 495          * not functioning case, so we assume functioning if present.
 496          */
 497         if (!(flags & ACPI_STA_DEVICE_PRESENT)) {
 498
 499                 /* Device is not present, we must examine the Functioning bit */
 500
 501                 if (flags & ACPI_STA_DEVICE_FUNCTIONING) {
 502                         /*
 503                          * Device is not present but is "functioning". In this case,
 504                          * we will not run _INI, but we continue to examine the children
 505                          * of this device.
 506                          *
 507                          * From the ACPI spec, description of _STA: (Note - no mention
 508                          * of whether to run _INI or not on the device in question)
 509                          *
 510                          * "_STA may return bit 0 clear (not present) with bit 3 set
 511                          * (device is functional). This case is used to indicate a valid
 512                          * device for which no device driver should be loaded (for example,
 513                          * a bridge device.) Children of this device may be present and
 514                          * valid. OSPM should continue enumeration below a device whose
 515                          * _STA returns this bit combination"
 516                          */
 517                         return_ACPI_STATUS(AE_OK);
 518                 } else {
 519                         /*
 520                          * Device is not present and is not functioning. We must abort the
 521                          * walk of this subtree immediately -- don't look at the children
 522                          * of such a device.
 523                          *
 524                          * From the ACPI spec, description of _INI:
 525                          *
 526                          * "If the _STA method indicates that the device is not present,
 527                          * OSPM will not run the _INI and will not examine the children
 528                          * of the device for _INI methods"
 529                          */
 530                         return_ACPI_STATUS(AE_CTRL_DEPTH);
 531                 }
 532         }
 533
 534         /*
 535          * The device is present or is assumed present if no _STA exists.
 536          * Run the _INI if it exists (not required to exist)
 537          *
 538          * Note: We know there is an _INI within this subtree, but it may not be
 539          * under this particular device, it may be lower in the branch.
 540          */
 541         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
 542                         (ACPI_TYPE_METHOD, device_node, METHOD_NAME__INI));
 543
 544         info->prefix_node = device_node;
 545         info->pathname = METHOD_NAME__INI;
 546         info->parameters = NULL;
 547         info->flags = ACPI_IGNORE_RETURN_VALUE;
 548
 549         /*
 550          * Some hardware relies on this being executed as atomically
 551          * as possible (without an NMI being received in the middle of
 552          * this) - so disable NMIs and initialize the device:
 553          */
 554         acpi_nmi_disable();
 555         status = acpi_ns_evaluate(info);
 556         acpi_nmi_enable();
 557
 558         if (ACPI_SUCCESS(status)) {
 559                 walk_info->num_INI++;
 560
 561                 if ((acpi_dbg_level <= ACPI_LV_ALL_EXCEPTIONS) &&
 562                     (!(acpi_dbg_level & ACPI_LV_INFO))) {
 563                         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, "."));
 564                 }
 565         }
 566 #ifdef ACPI_DEBUG_OUTPUT
 567         else if (status != AE_NOT_FOUND) {
 568
 569                 /* Ignore error and move on to next device */
 570
 571                 char *scope_name =
 572                     acpi_ns_get_external_pathname(info->resolved_node);
 573
 574                 ACPI_EXCEPTION((AE_INFO, status, "during %s._INI execution",
 575                                 scope_name));
 576                 ACPI_FREE(scope_name);
 577         }
 578 #endif
 579
 580         /* Ignore errors from above */
 581
 582         status = AE_OK;
 583
 584         /*
 585          * The _INI method has been run if present; call the Global Initialization
 586          * Handler for this device.
 587          */
 588         if (acpi_gbl_init_handler) {
 589                 status =
 590                     acpi_gbl_init_handler(device_node, ACPI_INIT_DEVICE_INI);
 591         }
 592
 593         return_ACPI_STATUS(status);
 594 }