Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 | /******************************************************************************* * * Module Name: nsxfobj - Public interfaces to the ACPI subsystem * ACPI Object oriented interfaces * $Revision: 80 $ * ******************************************************************************/ /* * Copyright (C) 2000, 2001 R. Byron Moore * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "acpi.h" #include "acinterp.h" #include "acnamesp.h" #include "acdispat.h" #define _COMPONENT NAMESPACE MODULE_NAME ("nsxfobj") /******************************************************************************* * * FUNCTION: Acpi_evaluate_object * * PARAMETERS: Handle - Object handle (optional) * *Pathname - Object pathname (optional) * **Params - List of parameters to pass to * method, terminated by NULL. * Params itself may be NULL * if no parameters are being * passed. * *Return_object - Where to put method's return value (if * any). If NULL, no value is returned. * * RETURN: Status * * DESCRIPTION: Find and evaluate the given object, passing the given * parameters if necessary. One of "Handle" or "Pathname" must * be valid (non-null) * ******************************************************************************/ ACPI_STATUS acpi_evaluate_object ( ACPI_HANDLE handle, ACPI_STRING pathname, ACPI_OBJECT_LIST *param_objects, ACPI_BUFFER *return_buffer) { ACPI_STATUS status; ACPI_OPERAND_OBJECT **param_ptr = NULL; ACPI_OPERAND_OBJECT *return_obj = NULL; ACPI_OPERAND_OBJECT *object_ptr = NULL; u32 buffer_space_needed; u32 user_buffer_length; u32 count; u32 i; u32 param_length; u32 object_length; /* * If there are parameters to be passed to the object * (which must be a control method), the external objects * must be converted to internal objects */ if (param_objects && param_objects->count) { /* * Allocate a new parameter block for the internal objects * Add 1 to count to allow for null terminated internal list */ count = param_objects->count; param_length = (count + 1) * sizeof (void *); object_length = count * sizeof (ACPI_OPERAND_OBJECT); param_ptr = acpi_cm_callocate (param_length + /* Parameter List part */ object_length); /* Actual objects */ if (!param_ptr) { return (AE_NO_MEMORY); } object_ptr = (ACPI_OPERAND_OBJECT *) ((u8 *) param_ptr + param_length); /* * Init the param array of pointers and NULL terminate * the list */ for (i = 0; i < count; i++) { param_ptr[i] = &object_ptr[i]; acpi_cm_init_static_object (&object_ptr[i]); } param_ptr[count] = NULL; /* * Convert each external object in the list to an * internal object */ for (i = 0; i < count; i++) { status = acpi_cm_copy_eobject_to_iobject (¶m_objects->pointer[i], param_ptr[i]); if (ACPI_FAILURE (status)) { acpi_cm_delete_internal_object_list (param_ptr); return (status); } } } /* * Three major cases: * 1) Fully qualified pathname * 2) No handle, not fully qualified pathname (error) * 3) Valid handle */ if ((pathname) && (acpi_ns_valid_root_prefix (pathname[0]))) { /* * The path is fully qualified, just evaluate by name */ status = acpi_ns_evaluate_by_name (pathname, param_ptr, &return_obj); } else if (!handle) { /* * A handle is optional iff a fully qualified pathname * is specified. Since we've already handled fully * qualified names above, this is an error */ status = AE_BAD_PARAMETER; } else { /* * We get here if we have a handle -- and if we have a * pathname it is relative. The handle will be validated * in the lower procedures */ if (!pathname) { /* * The null pathname case means the handle is for * the actual object to be evaluated */ status = acpi_ns_evaluate_by_handle (handle, param_ptr, &return_obj); } else { /* * Both a Handle and a relative Pathname */ status = acpi_ns_evaluate_relative (handle, pathname, param_ptr, &return_obj); } } /* * If we are expecting a return value, and all went well above, * copy the return value to an external object. */ if (return_buffer) { user_buffer_length = return_buffer->length; return_buffer->length = 0; if (return_obj) { if (VALID_DESCRIPTOR_TYPE (return_obj, ACPI_DESC_TYPE_NAMED)) { /* * If we got an Node as a return object, * this means the object we are evaluating * has nothing interesting to return (such * as a mutex, etc.) We return an error * because these types are essentially * unsupported by this interface. We * don't check up front because this makes * it easier to add support for various * types at a later date if necessary. */ status = AE_TYPE; return_obj = NULL; /* No need to delete an Node */ } if (ACPI_SUCCESS (status)) { /* * Find out how large a buffer is needed * to contain the returned object */ status = acpi_cm_get_object_size (return_obj, &buffer_space_needed); if (ACPI_SUCCESS (status)) { /* * Check if there is enough room in the * caller's buffer */ if (user_buffer_length < buffer_space_needed) { /* * Caller's buffer is too small, can't * give him partial results fail the call * but return the buffer size needed */ return_buffer->length = buffer_space_needed; status = AE_BUFFER_OVERFLOW; } else { /* * We have enough space for the object, build it */ status = acpi_cm_copy_iobject_to_eobject (return_obj, return_buffer); return_buffer->length = buffer_space_needed; } } } } } /* Delete the return and parameter objects */ if (return_obj) { /* * Delete the internal return object. (Or at least * decrement the reference count by one) */ acpi_cm_remove_reference (return_obj); } /* * Free the input parameter list (if we created one), */ if (param_ptr) { /* Free the allocated parameter block */ acpi_cm_delete_internal_object_list (param_ptr); } return (status); } /******************************************************************************* * * FUNCTION: Acpi_get_next_object * * PARAMETERS: Type - Type of object to be searched for * Parent - Parent object whose children we are getting * Last_child - Previous child that was found. * The NEXT child will be returned * Ret_handle - Where handle to the next object is placed * * RETURN: Status * * DESCRIPTION: Return the next peer object within the namespace. If Handle is * valid, Scope is ignored. Otherwise, the first object within * Scope is returned. * ******************************************************************************/ ACPI_STATUS acpi_get_next_object ( ACPI_OBJECT_TYPE type, ACPI_HANDLE parent, ACPI_HANDLE child, ACPI_HANDLE *ret_handle) { ACPI_STATUS status = AE_OK; ACPI_NAMESPACE_NODE *node; ACPI_NAMESPACE_NODE *parent_node = NULL; ACPI_NAMESPACE_NODE *child_node = NULL; /* Parameter validation */ if (type > ACPI_TYPE_MAX) { return (AE_BAD_PARAMETER); } acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE); /* If null handle, use the parent */ if (!child) { /* Start search at the beginning of the specified scope */ parent_node = acpi_ns_convert_handle_to_entry (parent); if (!parent_node) { status = AE_BAD_PARAMETER; goto unlock_and_exit; } } /* Non-null handle, ignore the parent */ else { /* Convert and validate the handle */ child_node = acpi_ns_convert_handle_to_entry (child); if (!child_node) { status = AE_BAD_PARAMETER; goto unlock_and_exit; } } /* Internal function does the real work */ node = acpi_ns_get_next_object ((OBJECT_TYPE_INTERNAL) type, parent_node, child_node); if (!node) { status = AE_NOT_FOUND; goto unlock_and_exit; } if (ret_handle) { *ret_handle = acpi_ns_convert_entry_to_handle (node); } unlock_and_exit: acpi_cm_release_mutex (ACPI_MTX_NAMESPACE); return (status); } /******************************************************************************* * * FUNCTION: Acpi_get_type * * PARAMETERS: Handle - Handle of object whose type is desired * *Ret_type - Where the type will be placed * * RETURN: Status * * DESCRIPTION: This routine returns the type associatd with a particular handle * ******************************************************************************/ ACPI_STATUS acpi_get_type ( ACPI_HANDLE handle, ACPI_OBJECT_TYPE *ret_type) { ACPI_NAMESPACE_NODE *node; /* Parameter Validation */ if (!ret_type) { return (AE_BAD_PARAMETER); } /* * Special case for the predefined Root Node * (return type ANY) */ if (handle == ACPI_ROOT_OBJECT) { *ret_type = ACPI_TYPE_ANY; return (AE_OK); } acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE); /* Convert and validate the handle */ node = acpi_ns_convert_handle_to_entry (handle); if (!node) { acpi_cm_release_mutex (ACPI_MTX_NAMESPACE); return (AE_BAD_PARAMETER); } *ret_type = node->type; acpi_cm_release_mutex (ACPI_MTX_NAMESPACE); return (AE_OK); } /******************************************************************************* * * FUNCTION: Acpi_get_parent * * PARAMETERS: Handle - Handle of object whose parent is desired * Ret_handle - Where the parent handle will be placed * * RETURN: Status * * DESCRIPTION: Returns a handle to the parent of the object represented by * Handle. * ******************************************************************************/ ACPI_STATUS acpi_get_parent ( ACPI_HANDLE handle, ACPI_HANDLE *ret_handle) { ACPI_NAMESPACE_NODE *node; ACPI_STATUS status = AE_OK; /* No trace macro, too verbose */ if (!ret_handle) { return (AE_BAD_PARAMETER); } /* Special case for the predefined Root Node (no parent) */ if (handle == ACPI_ROOT_OBJECT) { return (AE_NULL_ENTRY); } acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE); /* Convert and validate the handle */ node = acpi_ns_convert_handle_to_entry (handle); if (!node) { status = AE_BAD_PARAMETER; goto unlock_and_exit; } /* Get the parent entry */ *ret_handle = acpi_ns_convert_entry_to_handle (acpi_ns_get_parent_object (node)); /* Return exeption if parent is null */ if (!acpi_ns_get_parent_object (node)) { status = AE_NULL_ENTRY; } unlock_and_exit: acpi_cm_release_mutex (ACPI_MTX_NAMESPACE); return (status); } /******************************************************************************* * * FUNCTION: Acpi_walk_namespace * * PARAMETERS: Type - ACPI_OBJECT_TYPE to search for * Start_object - Handle in namespace where search begins * Max_depth - Depth to which search is to reach * User_function - Called when an object of "Type" is found * Context - Passed to user function * Return_value - Location where return value of * User_function is put if terminated early * * RETURNS Return value from the User_function if terminated early. * Otherwise, returns NULL. * * DESCRIPTION: Performs a modified depth-first walk of the namespace tree, * starting (and ending) at the object specified by Start_handle. * The User_function is called whenever an object that matches * the type parameter is found. If the user function returns * a non-zero value, the search is terminated immediately and this * value is returned to the caller. * * The point of this procedure is to provide a generic namespace * walk routine that can be called from multiple places to * provide multiple services; the User Function can be tailored * to each task, whether it is a print function, a compare * function, etc. * ******************************************************************************/ ACPI_STATUS acpi_walk_namespace ( ACPI_OBJECT_TYPE type, ACPI_HANDLE start_object, u32 max_depth, WALK_CALLBACK user_function, void *context, void **return_value) { ACPI_STATUS status; /* Parameter validation */ if ((type > ACPI_TYPE_MAX) || (!max_depth) || (!user_function)) { return (AE_BAD_PARAMETER); } /* * Lock the namespace around the walk. * The namespace will be unlocked/locked around each call * to the user function - since this function * must be allowed to make Acpi calls itself. */ acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE); status = acpi_ns_walk_namespace ((OBJECT_TYPE_INTERNAL) type, start_object, max_depth, NS_WALK_UNLOCK, user_function, context, return_value); acpi_cm_release_mutex (ACPI_MTX_NAMESPACE); return (status); } /******************************************************************************* * * FUNCTION: Acpi_ns_get_device_callback * * PARAMETERS: Callback from Acpi_get_device * * RETURN: Status * * DESCRIPTION: Takes callbacks from Walk_namespace and filters out all non- * present devices, or if they specified a HID, it filters based * on that. * ******************************************************************************/ static ACPI_STATUS acpi_ns_get_device_callback ( ACPI_HANDLE obj_handle, u32 nesting_level, void *context, void **return_value) { ACPI_STATUS status; ACPI_NAMESPACE_NODE *node; u32 flags; DEVICE_ID device_id; ACPI_GET_DEVICES_INFO *info; info = context; acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE); node = acpi_ns_convert_handle_to_entry (obj_handle); acpi_cm_release_mutex (ACPI_MTX_NAMESPACE); if (!node) { return (AE_BAD_PARAMETER); } /* * Run _STA to determine if device is present */ status = acpi_cm_execute_STA (node, &flags); if (ACPI_FAILURE (status)) { return (status); } if (!(flags & 0x01)) { /* don't return at the device or children of the device if not there */ return (AE_CTRL_DEPTH); } /* * Filter based on device HID */ if (info->hid != NULL) { status = acpi_cm_execute_HID (node, &device_id); if (status == AE_NOT_FOUND) { return (AE_OK); } else if (ACPI_FAILURE (status)) { return (status); } if (STRNCMP (device_id.buffer, info->hid, sizeof (device_id.buffer)) != 0) { return (AE_OK); } } info->user_function (obj_handle, nesting_level, info->context, return_value); return (AE_OK); } /******************************************************************************* * * FUNCTION: Acpi_get_devices * * PARAMETERS: HID - HID to search for. Can be NULL. * User_function - Called when a matching object is found * Context - Passed to user function * Return_value - Location where return value of * User_function is put if terminated early * * RETURNS Return value from the User_function if terminated early. * Otherwise, returns NULL. * * DESCRIPTION: Performs a modified depth-first walk of the namespace tree, * starting (and ending) at the object specified by Start_handle. * The User_function is called whenever an object that matches * the type parameter is found. If the user function returns * a non-zero value, the search is terminated immediately and this * value is returned to the caller. * * This is a wrapper for Walk_namespace, but the callback performs * additional filtering. Please see Acpi_get_device_callback. * ******************************************************************************/ ACPI_STATUS acpi_get_devices ( NATIVE_CHAR *HID, WALK_CALLBACK user_function, void *context, void **return_value) { ACPI_STATUS status; ACPI_GET_DEVICES_INFO info; /* Parameter validation */ if (!user_function) { return (AE_BAD_PARAMETER); } /* * We're going to call their callback from OUR callback, so we need * to know what it is, and their context parameter. */ info.context = context; info.user_function = user_function; info.hid = HID; /* * Lock the namespace around the walk. * The namespace will be unlocked/locked around each call * to the user function - since this function * must be allowed to make Acpi calls itself. */ acpi_cm_acquire_mutex (ACPI_MTX_NAMESPACE); status = acpi_ns_walk_namespace (ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, ACPI_UINT32_MAX, NS_WALK_UNLOCK, acpi_ns_get_device_callback, &info, return_value); acpi_cm_release_mutex (ACPI_MTX_NAMESPACE); return (status); } |