nsxfeval.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829
  1. /*******************************************************************************
  2. *
  3. * Module Name: nsxfeval - Public interfaces to the ACPI subsystem
  4. * ACPI Object evaluation interfaces
  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. #include <acpi/acpi.h>
  44. #include "accommon.h"
  45. #include "acnamesp.h"
  46. #include "acinterp.h"
  47. #define _COMPONENT ACPI_NAMESPACE
  48. ACPI_MODULE_NAME("nsxfeval")
  49. /* Local prototypes */
  50. static void acpi_ns_resolve_references(struct acpi_evaluate_info *info);
  51. /*******************************************************************************
  52. *
  53. * FUNCTION: acpi_evaluate_object_typed
  54. *
  55. * PARAMETERS: Handle - Object handle (optional)
  56. * Pathname - Object pathname (optional)
  57. * external_params - List of parameters to pass to method,
  58. * terminated by NULL. May be NULL
  59. * if no parameters are being passed.
  60. * return_buffer - Where to put method's return value (if
  61. * any). If NULL, no value is returned.
  62. * return_type - Expected type of return object
  63. *
  64. * RETURN: Status
  65. *
  66. * DESCRIPTION: Find and evaluate the given object, passing the given
  67. * parameters if necessary. One of "Handle" or "Pathname" must
  68. * be valid (non-null)
  69. *
  70. ******************************************************************************/
  71. acpi_status
  72. acpi_evaluate_object_typed(acpi_handle handle,
  73. acpi_string pathname,
  74. struct acpi_object_list *external_params,
  75. struct acpi_buffer *return_buffer,
  76. acpi_object_type return_type)
  77. {
  78. acpi_status status;
  79. u8 must_free = FALSE;
  80. ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed);
  81. /* Return buffer must be valid */
  82. if (!return_buffer) {
  83. return_ACPI_STATUS(AE_BAD_PARAMETER);
  84. }
  85. if (return_buffer->length == ACPI_ALLOCATE_BUFFER) {
  86. must_free = TRUE;
  87. }
  88. /* Evaluate the object */
  89. status =
  90. acpi_evaluate_object(handle, pathname, external_params,
  91. return_buffer);
  92. if (ACPI_FAILURE(status)) {
  93. return_ACPI_STATUS(status);
  94. }
  95. /* Type ANY means "don't care" */
  96. if (return_type == ACPI_TYPE_ANY) {
  97. return_ACPI_STATUS(AE_OK);
  98. }
  99. if (return_buffer->length == 0) {
  100. /* Error because caller specifically asked for a return value */
  101. ACPI_ERROR((AE_INFO, "No return value"));
  102. return_ACPI_STATUS(AE_NULL_OBJECT);
  103. }
  104. /* Examine the object type returned from evaluate_object */
  105. if (((union acpi_object *)return_buffer->pointer)->type == return_type) {
  106. return_ACPI_STATUS(AE_OK);
  107. }
  108. /* Return object type does not match requested type */
  109. ACPI_ERROR((AE_INFO,
  110. "Incorrect return type [%s] requested [%s]",
  111. acpi_ut_get_type_name(((union acpi_object *)return_buffer->
  112. pointer)->type),
  113. acpi_ut_get_type_name(return_type)));
  114. if (must_free) {
  115. /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
  116. ACPI_FREE(return_buffer->pointer);
  117. return_buffer->pointer = NULL;
  118. }
  119. return_buffer->length = 0;
  120. return_ACPI_STATUS(AE_TYPE);
  121. }
  122. ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed)
  123. /*******************************************************************************
  124. *
  125. * FUNCTION: acpi_evaluate_object
  126. *
  127. * PARAMETERS: Handle - Object handle (optional)
  128. * Pathname - Object pathname (optional)
  129. * external_params - List of parameters to pass to method,
  130. * terminated by NULL. May be NULL
  131. * if no parameters are being passed.
  132. * return_buffer - Where to put method's return value (if
  133. * any). If NULL, no value is returned.
  134. *
  135. * RETURN: Status
  136. *
  137. * DESCRIPTION: Find and evaluate the given object, passing the given
  138. * parameters if necessary. One of "Handle" or "Pathname" must
  139. * be valid (non-null)
  140. *
  141. ******************************************************************************/
  142. acpi_status
  143. acpi_evaluate_object(acpi_handle handle,
  144. acpi_string pathname,
  145. struct acpi_object_list *external_params,
  146. struct acpi_buffer *return_buffer)
  147. {
  148. acpi_status status;
  149. struct acpi_evaluate_info *info;
  150. acpi_size buffer_space_needed;
  151. u32 i;
  152. ACPI_FUNCTION_TRACE(acpi_evaluate_object);
  153. /* Allocate and initialize the evaluation information block */
  154. info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
  155. if (!info) {
  156. return_ACPI_STATUS(AE_NO_MEMORY);
  157. }
  158. info->pathname = pathname;
  159. /* Convert and validate the device handle */
  160. info->prefix_node = acpi_ns_map_handle_to_node(handle);
  161. if (!info->prefix_node) {
  162. status = AE_BAD_PARAMETER;
  163. goto cleanup;
  164. }
  165. /*
  166. * If there are parameters to be passed to a control method, the external
  167. * objects must all be converted to internal objects
  168. */
  169. if (external_params && external_params->count) {
  170. /*
  171. * Allocate a new parameter block for the internal objects
  172. * Add 1 to count to allow for null terminated internal list
  173. */
  174. info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)
  175. external_params->
  176. count +
  177. 1) * sizeof(void *));
  178. if (!info->parameters) {
  179. status = AE_NO_MEMORY;
  180. goto cleanup;
  181. }
  182. /* Convert each external object in the list to an internal object */
  183. for (i = 0; i < external_params->count; i++) {
  184. status =
  185. acpi_ut_copy_eobject_to_iobject(&external_params->
  186. pointer[i],
  187. &info->
  188. parameters[i]);
  189. if (ACPI_FAILURE(status)) {
  190. goto cleanup;
  191. }
  192. }
  193. info->parameters[external_params->count] = NULL;
  194. }
  195. /*
  196. * Three major cases:
  197. * 1) Fully qualified pathname
  198. * 2) No handle, not fully qualified pathname (error)
  199. * 3) Valid handle
  200. */
  201. if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) {
  202. /* The path is fully qualified, just evaluate by name */
  203. info->prefix_node = NULL;
  204. status = acpi_ns_evaluate(info);
  205. } else if (!handle) {
  206. /*
  207. * A handle is optional iff a fully qualified pathname is specified.
  208. * Since we've already handled fully qualified names above, this is
  209. * an error
  210. */
  211. if (!pathname) {
  212. ACPI_DEBUG_PRINT((ACPI_DB_INFO,
  213. "Both Handle and Pathname are NULL"));
  214. } else {
  215. ACPI_DEBUG_PRINT((ACPI_DB_INFO,
  216. "Null Handle with relative pathname [%s]",
  217. pathname));
  218. }
  219. status = AE_BAD_PARAMETER;
  220. } else {
  221. /* We have a namespace a node and a possible relative path */
  222. status = acpi_ns_evaluate(info);
  223. }
  224. /*
  225. * If we are expecting a return value, and all went well above,
  226. * copy the return value to an external object.
  227. */
  228. if (return_buffer) {
  229. if (!info->return_object) {
  230. return_buffer->length = 0;
  231. } else {
  232. if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
  233. ACPI_DESC_TYPE_NAMED) {
  234. /*
  235. * If we received a NS Node as a return object, this means that
  236. * the object we are evaluating has nothing interesting to
  237. * return (such as a mutex, etc.) We return an error because
  238. * these types are essentially unsupported by this interface.
  239. * We don't check up front because this makes it easier to add
  240. * support for various types at a later date if necessary.
  241. */
  242. status = AE_TYPE;
  243. info->return_object = NULL; /* No need to delete a NS Node */
  244. return_buffer->length = 0;
  245. }
  246. if (ACPI_SUCCESS(status)) {
  247. /* Dereference Index and ref_of references */
  248. acpi_ns_resolve_references(info);
  249. /* Get the size of the returned object */
  250. status =
  251. acpi_ut_get_object_size(info->return_object,
  252. &buffer_space_needed);
  253. if (ACPI_SUCCESS(status)) {
  254. /* Validate/Allocate/Clear caller buffer */
  255. status =
  256. acpi_ut_initialize_buffer
  257. (return_buffer,
  258. buffer_space_needed);
  259. if (ACPI_FAILURE(status)) {
  260. /*
  261. * Caller's buffer is too small or a new one can't
  262. * be allocated
  263. */
  264. ACPI_DEBUG_PRINT((ACPI_DB_INFO,
  265. "Needed buffer size %X, %s\n",
  266. (u32)
  267. buffer_space_needed,
  268. acpi_format_exception
  269. (status)));
  270. } else {
  271. /* We have enough space for the object, build it */
  272. status =
  273. acpi_ut_copy_iobject_to_eobject
  274. (info->return_object,
  275. return_buffer);
  276. }
  277. }
  278. }
  279. }
  280. }
  281. if (info->return_object) {
  282. /*
  283. * Delete the internal return object. NOTE: Interpreter must be
  284. * locked to avoid race condition.
  285. */
  286. acpi_ex_enter_interpreter();
  287. /* Remove one reference on the return object (should delete it) */
  288. acpi_ut_remove_reference(info->return_object);
  289. acpi_ex_exit_interpreter();
  290. }
  291. cleanup:
  292. /* Free the input parameter list (if we created one) */
  293. if (info->parameters) {
  294. /* Free the allocated parameter block */
  295. acpi_ut_delete_internal_object_list(info->parameters);
  296. }
  297. ACPI_FREE(info);
  298. return_ACPI_STATUS(status);
  299. }
  300. ACPI_EXPORT_SYMBOL(acpi_evaluate_object)
  301. /*******************************************************************************
  302. *
  303. * FUNCTION: acpi_ns_resolve_references
  304. *
  305. * PARAMETERS: Info - Evaluation info block
  306. *
  307. * RETURN: Info->return_object is replaced with the dereferenced object
  308. *
  309. * DESCRIPTION: Dereference certain reference objects. Called before an
  310. * internal return object is converted to an external union acpi_object.
  311. *
  312. * Performs an automatic dereference of Index and ref_of reference objects.
  313. * These reference objects are not supported by the union acpi_object, so this is a
  314. * last resort effort to return something useful. Also, provides compatibility
  315. * with other ACPI implementations.
  316. *
  317. * NOTE: does not handle references within returned package objects or nested
  318. * references, but this support could be added later if found to be necessary.
  319. *
  320. ******************************************************************************/
  321. static void acpi_ns_resolve_references(struct acpi_evaluate_info *info)
  322. {
  323. union acpi_operand_object *obj_desc = NULL;
  324. struct acpi_namespace_node *node;
  325. /* We are interested in reference objects only */
  326. if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
  327. return;
  328. }
  329. /*
  330. * Two types of references are supported - those created by Index and
  331. * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
  332. * to an union acpi_object, so it is not dereferenced here. A ddb_handle
  333. * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
  334. * an union acpi_object.
  335. */
  336. switch (info->return_object->reference.class) {
  337. case ACPI_REFCLASS_INDEX:
  338. obj_desc = *(info->return_object->reference.where);
  339. break;
  340. case ACPI_REFCLASS_REFOF:
  341. node = info->return_object->reference.object;
  342. if (node) {
  343. obj_desc = node->object;
  344. }
  345. break;
  346. default:
  347. return;
  348. }
  349. /* Replace the existing reference object */
  350. if (obj_desc) {
  351. acpi_ut_add_reference(obj_desc);
  352. acpi_ut_remove_reference(info->return_object);
  353. info->return_object = obj_desc;
  354. }
  355. return;
  356. }
  357. /*******************************************************************************
  358. *
  359. * FUNCTION: acpi_walk_namespace
  360. *
  361. * PARAMETERS: Type - acpi_object_type to search for
  362. * start_object - Handle in namespace where search begins
  363. * max_depth - Depth to which search is to reach
  364. * user_function - Called when an object of "Type" is found
  365. * Context - Passed to user function
  366. * return_value - Location where return value of
  367. * user_function is put if terminated early
  368. *
  369. * RETURNS Return value from the user_function if terminated early.
  370. * Otherwise, returns NULL.
  371. *
  372. * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
  373. * starting (and ending) at the object specified by start_handle.
  374. * The user_function is called whenever an object that matches
  375. * the type parameter is found. If the user function returns
  376. * a non-zero value, the search is terminated immediately and this
  377. * value is returned to the caller.
  378. *
  379. * The point of this procedure is to provide a generic namespace
  380. * walk routine that can be called from multiple places to
  381. * provide multiple services; the User Function can be tailored
  382. * to each task, whether it is a print function, a compare
  383. * function, etc.
  384. *
  385. ******************************************************************************/
  386. acpi_status
  387. acpi_walk_namespace(acpi_object_type type,
  388. acpi_handle start_object,
  389. u32 max_depth,
  390. acpi_walk_callback user_function,
  391. void *context, void **return_value)
  392. {
  393. acpi_status status;
  394. ACPI_FUNCTION_TRACE(acpi_walk_namespace);
  395. /* Parameter validation */
  396. if ((type > ACPI_TYPE_LOCAL_MAX) || (!max_depth) || (!user_function)) {
  397. return_ACPI_STATUS(AE_BAD_PARAMETER);
  398. }
  399. /*
  400. * Need to acquire the namespace reader lock to prevent interference
  401. * with any concurrent table unloads (which causes the deletion of
  402. * namespace objects). We cannot allow the deletion of a namespace node
  403. * while the user function is using it. The exception to this are the
  404. * nodes created and deleted during control method execution -- these
  405. * nodes are marked as temporary nodes and are ignored by the namespace
  406. * walk. Thus, control methods can be executed while holding the
  407. * namespace deletion lock (and the user function can execute control
  408. * methods.)
  409. */
  410. status = acpi_ut_acquire_read_lock(&acpi_gbl_namespace_rw_lock);
  411. if (ACPI_FAILURE(status)) {
  412. return status;
  413. }
  414. /*
  415. * Lock the namespace around the walk. The namespace will be
  416. * unlocked/locked around each call to the user function - since the user
  417. * function must be allowed to make ACPICA calls itself (for example, it
  418. * will typically execute control methods during device enumeration.)
  419. */
  420. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  421. if (ACPI_FAILURE(status)) {
  422. goto unlock_and_exit;
  423. }
  424. status = acpi_ns_walk_namespace(type, start_object, max_depth,
  425. ACPI_NS_WALK_UNLOCK, user_function,
  426. context, return_value);
  427. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  428. unlock_and_exit:
  429. (void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock);
  430. return_ACPI_STATUS(status);
  431. }
  432. ACPI_EXPORT_SYMBOL(acpi_walk_namespace)
  433. /*******************************************************************************
  434. *
  435. * FUNCTION: acpi_ns_get_device_callback
  436. *
  437. * PARAMETERS: Callback from acpi_get_device
  438. *
  439. * RETURN: Status
  440. *
  441. * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
  442. * present devices, or if they specified a HID, it filters based
  443. * on that.
  444. *
  445. ******************************************************************************/
  446. static acpi_status
  447. acpi_ns_get_device_callback(acpi_handle obj_handle,
  448. u32 nesting_level,
  449. void *context, void **return_value)
  450. {
  451. struct acpi_get_devices_info *info = context;
  452. acpi_status status;
  453. struct acpi_namespace_node *node;
  454. u32 flags;
  455. struct acpica_device_id hid;
  456. struct acpi_compatible_id_list *cid;
  457. u32 i;
  458. int found;
  459. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  460. if (ACPI_FAILURE(status)) {
  461. return (status);
  462. }
  463. node = acpi_ns_map_handle_to_node(obj_handle);
  464. status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  465. if (ACPI_FAILURE(status)) {
  466. return (status);
  467. }
  468. if (!node) {
  469. return (AE_BAD_PARAMETER);
  470. }
  471. /* Run _STA to determine if device is present */
  472. status = acpi_ut_execute_STA(node, &flags);
  473. if (ACPI_FAILURE(status)) {
  474. return (AE_CTRL_DEPTH);
  475. }
  476. if (!(flags & ACPI_STA_DEVICE_PRESENT) &&
  477. !(flags & ACPI_STA_DEVICE_FUNCTIONING)) {
  478. /*
  479. * Don't examine the children of the device only when the
  480. * device is neither present nor functional. See ACPI spec,
  481. * description of _STA for more information.
  482. */
  483. return (AE_CTRL_DEPTH);
  484. }
  485. /* Filter based on device HID & CID */
  486. if (info->hid != NULL) {
  487. status = acpi_ut_execute_HID(node, &hid);
  488. if (status == AE_NOT_FOUND) {
  489. return (AE_OK);
  490. } else if (ACPI_FAILURE(status)) {
  491. return (AE_CTRL_DEPTH);
  492. }
  493. if (ACPI_STRNCMP(hid.value, info->hid, sizeof(hid.value)) != 0) {
  494. /* Get the list of Compatible IDs */
  495. status = acpi_ut_execute_CID(node, &cid);
  496. if (status == AE_NOT_FOUND) {
  497. return (AE_OK);
  498. } else if (ACPI_FAILURE(status)) {
  499. return (AE_CTRL_DEPTH);
  500. }
  501. /* Walk the CID list */
  502. found = 0;
  503. for (i = 0; i < cid->count; i++) {
  504. if (ACPI_STRNCMP(cid->id[i].value, info->hid,
  505. sizeof(struct
  506. acpi_compatible_id)) ==
  507. 0) {
  508. found = 1;
  509. break;
  510. }
  511. }
  512. ACPI_FREE(cid);
  513. if (!found)
  514. return (AE_OK);
  515. }
  516. }
  517. status = info->user_function(obj_handle, nesting_level, info->context,
  518. return_value);
  519. return (status);
  520. }
  521. /*******************************************************************************
  522. *
  523. * FUNCTION: acpi_get_devices
  524. *
  525. * PARAMETERS: HID - HID to search for. Can be NULL.
  526. * user_function - Called when a matching object is found
  527. * Context - Passed to user function
  528. * return_value - Location where return value of
  529. * user_function is put if terminated early
  530. *
  531. * RETURNS Return value from the user_function if terminated early.
  532. * Otherwise, returns NULL.
  533. *
  534. * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
  535. * starting (and ending) at the object specified by start_handle.
  536. * The user_function is called whenever an object of type
  537. * Device is found. If the user function returns
  538. * a non-zero value, the search is terminated immediately and this
  539. * value is returned to the caller.
  540. *
  541. * This is a wrapper for walk_namespace, but the callback performs
  542. * additional filtering. Please see acpi_ns_get_device_callback.
  543. *
  544. ******************************************************************************/
  545. acpi_status
  546. acpi_get_devices(const char *HID,
  547. acpi_walk_callback user_function,
  548. void *context, void **return_value)
  549. {
  550. acpi_status status;
  551. struct acpi_get_devices_info info;
  552. ACPI_FUNCTION_TRACE(acpi_get_devices);
  553. /* Parameter validation */
  554. if (!user_function) {
  555. return_ACPI_STATUS(AE_BAD_PARAMETER);
  556. }
  557. /*
  558. * We're going to call their callback from OUR callback, so we need
  559. * to know what it is, and their context parameter.
  560. */
  561. info.hid = HID;
  562. info.context = context;
  563. info.user_function = user_function;
  564. /*
  565. * Lock the namespace around the walk.
  566. * The namespace will be unlocked/locked around each call
  567. * to the user function - since this function
  568. * must be allowed to make Acpi calls itself.
  569. */
  570. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  571. if (ACPI_FAILURE(status)) {
  572. return_ACPI_STATUS(status);
  573. }
  574. status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
  575. ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
  576. acpi_ns_get_device_callback, &info,
  577. return_value);
  578. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  579. return_ACPI_STATUS(status);
  580. }
  581. ACPI_EXPORT_SYMBOL(acpi_get_devices)
  582. /*******************************************************************************
  583. *
  584. * FUNCTION: acpi_attach_data
  585. *
  586. * PARAMETERS: obj_handle - Namespace node
  587. * Handler - Handler for this attachment
  588. * Data - Pointer to data to be attached
  589. *
  590. * RETURN: Status
  591. *
  592. * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
  593. *
  594. ******************************************************************************/
  595. acpi_status
  596. acpi_attach_data(acpi_handle obj_handle,
  597. acpi_object_handler handler, void *data)
  598. {
  599. struct acpi_namespace_node *node;
  600. acpi_status status;
  601. /* Parameter validation */
  602. if (!obj_handle || !handler || !data) {
  603. return (AE_BAD_PARAMETER);
  604. }
  605. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  606. if (ACPI_FAILURE(status)) {
  607. return (status);
  608. }
  609. /* Convert and validate the handle */
  610. node = acpi_ns_map_handle_to_node(obj_handle);
  611. if (!node) {
  612. status = AE_BAD_PARAMETER;
  613. goto unlock_and_exit;
  614. }
  615. status = acpi_ns_attach_data(node, handler, data);
  616. unlock_and_exit:
  617. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  618. return (status);
  619. }
  620. ACPI_EXPORT_SYMBOL(acpi_attach_data)
  621. /*******************************************************************************
  622. *
  623. * FUNCTION: acpi_detach_data
  624. *
  625. * PARAMETERS: obj_handle - Namespace node handle
  626. * Handler - Handler used in call to acpi_attach_data
  627. *
  628. * RETURN: Status
  629. *
  630. * DESCRIPTION: Remove data that was previously attached to a node.
  631. *
  632. ******************************************************************************/
  633. acpi_status
  634. acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
  635. {
  636. struct acpi_namespace_node *node;
  637. acpi_status status;
  638. /* Parameter validation */
  639. if (!obj_handle || !handler) {
  640. return (AE_BAD_PARAMETER);
  641. }
  642. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  643. if (ACPI_FAILURE(status)) {
  644. return (status);
  645. }
  646. /* Convert and validate the handle */
  647. node = acpi_ns_map_handle_to_node(obj_handle);
  648. if (!node) {
  649. status = AE_BAD_PARAMETER;
  650. goto unlock_and_exit;
  651. }
  652. status = acpi_ns_detach_data(node, handler);
  653. unlock_and_exit:
  654. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  655. return (status);
  656. }
  657. ACPI_EXPORT_SYMBOL(acpi_detach_data)
  658. /*******************************************************************************
  659. *
  660. * FUNCTION: acpi_get_data
  661. *
  662. * PARAMETERS: obj_handle - Namespace node
  663. * Handler - Handler used in call to attach_data
  664. * Data - Where the data is returned
  665. *
  666. * RETURN: Status
  667. *
  668. * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
  669. *
  670. ******************************************************************************/
  671. acpi_status
  672. acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
  673. {
  674. struct acpi_namespace_node *node;
  675. acpi_status status;
  676. /* Parameter validation */
  677. if (!obj_handle || !handler || !data) {
  678. return (AE_BAD_PARAMETER);
  679. }
  680. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  681. if (ACPI_FAILURE(status)) {
  682. return (status);
  683. }
  684. /* Convert and validate the handle */
  685. node = acpi_ns_map_handle_to_node(obj_handle);
  686. if (!node) {
  687. status = AE_BAD_PARAMETER;
  688. goto unlock_and_exit;
  689. }
  690. status = acpi_ns_get_attached_data(node, handler, data);
  691. unlock_and_exit:
  692. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  693. return (status);
  694. }
  695. ACPI_EXPORT_SYMBOL(acpi_get_data)