nsxfobj.c 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. /*******************************************************************************
  2. *
  3. * Module Name: nsxfobj - Public interfaces to the ACPI subsystem
  4. * ACPI Object oriented interfaces
  5. *
  6. ******************************************************************************/
  7. /*
  8. * Copyright (C) 2000 - 2012, 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 <linux/export.h>
  44. #include <acpi/acpi.h>
  45. #include "accommon.h"
  46. #include "acnamesp.h"
  47. #define _COMPONENT ACPI_NAMESPACE
  48. ACPI_MODULE_NAME("nsxfobj")
  49. /*******************************************************************************
  50. *
  51. * FUNCTION: acpi_get_id
  52. *
  53. * PARAMETERS: Handle - Handle of object whose id is desired
  54. * ret_id - Where the id will be placed
  55. *
  56. * RETURN: Status
  57. *
  58. * DESCRIPTION: This routine returns the owner id associated with a handle
  59. *
  60. ******************************************************************************/
  61. acpi_status acpi_get_id(acpi_handle handle, acpi_owner_id * ret_id)
  62. {
  63. struct acpi_namespace_node *node;
  64. acpi_status status;
  65. /* Parameter Validation */
  66. if (!ret_id) {
  67. return (AE_BAD_PARAMETER);
  68. }
  69. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  70. if (ACPI_FAILURE(status)) {
  71. return (status);
  72. }
  73. /* Convert and validate the handle */
  74. node = acpi_ns_validate_handle(handle);
  75. if (!node) {
  76. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  77. return (AE_BAD_PARAMETER);
  78. }
  79. *ret_id = node->owner_id;
  80. status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  81. return (status);
  82. }
  83. ACPI_EXPORT_SYMBOL(acpi_get_id)
  84. /*******************************************************************************
  85. *
  86. * FUNCTION: acpi_get_type
  87. *
  88. * PARAMETERS: Handle - Handle of object whose type is desired
  89. * ret_type - Where the type will be placed
  90. *
  91. * RETURN: Status
  92. *
  93. * DESCRIPTION: This routine returns the type associatd with a particular handle
  94. *
  95. ******************************************************************************/
  96. acpi_status acpi_get_type(acpi_handle handle, acpi_object_type * ret_type)
  97. {
  98. struct acpi_namespace_node *node;
  99. acpi_status status;
  100. /* Parameter Validation */
  101. if (!ret_type) {
  102. return (AE_BAD_PARAMETER);
  103. }
  104. /*
  105. * Special case for the predefined Root Node
  106. * (return type ANY)
  107. */
  108. if (handle == ACPI_ROOT_OBJECT) {
  109. *ret_type = ACPI_TYPE_ANY;
  110. return (AE_OK);
  111. }
  112. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  113. if (ACPI_FAILURE(status)) {
  114. return (status);
  115. }
  116. /* Convert and validate the handle */
  117. node = acpi_ns_validate_handle(handle);
  118. if (!node) {
  119. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  120. return (AE_BAD_PARAMETER);
  121. }
  122. *ret_type = node->type;
  123. status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  124. return (status);
  125. }
  126. ACPI_EXPORT_SYMBOL(acpi_get_type)
  127. /*******************************************************************************
  128. *
  129. * FUNCTION: acpi_get_parent
  130. *
  131. * PARAMETERS: Handle - Handle of object whose parent is desired
  132. * ret_handle - Where the parent handle will be placed
  133. *
  134. * RETURN: Status
  135. *
  136. * DESCRIPTION: Returns a handle to the parent of the object represented by
  137. * Handle.
  138. *
  139. ******************************************************************************/
  140. acpi_status acpi_get_parent(acpi_handle handle, acpi_handle * ret_handle)
  141. {
  142. struct acpi_namespace_node *node;
  143. struct acpi_namespace_node *parent_node;
  144. acpi_status status;
  145. if (!ret_handle) {
  146. return (AE_BAD_PARAMETER);
  147. }
  148. /* Special case for the predefined Root Node (no parent) */
  149. if (handle == ACPI_ROOT_OBJECT) {
  150. return (AE_NULL_ENTRY);
  151. }
  152. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  153. if (ACPI_FAILURE(status)) {
  154. return (status);
  155. }
  156. /* Convert and validate the handle */
  157. node = acpi_ns_validate_handle(handle);
  158. if (!node) {
  159. status = AE_BAD_PARAMETER;
  160. goto unlock_and_exit;
  161. }
  162. /* Get the parent entry */
  163. parent_node = node->parent;
  164. *ret_handle = ACPI_CAST_PTR(acpi_handle, parent_node);
  165. /* Return exception if parent is null */
  166. if (!parent_node) {
  167. status = AE_NULL_ENTRY;
  168. }
  169. unlock_and_exit:
  170. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  171. return (status);
  172. }
  173. ACPI_EXPORT_SYMBOL(acpi_get_parent)
  174. /*******************************************************************************
  175. *
  176. * FUNCTION: acpi_get_next_object
  177. *
  178. * PARAMETERS: Type - Type of object to be searched for
  179. * Parent - Parent object whose children we are getting
  180. * last_child - Previous child that was found.
  181. * The NEXT child will be returned
  182. * ret_handle - Where handle to the next object is placed
  183. *
  184. * RETURN: Status
  185. *
  186. * DESCRIPTION: Return the next peer object within the namespace. If Handle is
  187. * valid, Scope is ignored. Otherwise, the first object within
  188. * Scope is returned.
  189. *
  190. ******************************************************************************/
  191. acpi_status
  192. acpi_get_next_object(acpi_object_type type,
  193. acpi_handle parent,
  194. acpi_handle child, acpi_handle * ret_handle)
  195. {
  196. acpi_status status;
  197. struct acpi_namespace_node *node;
  198. struct acpi_namespace_node *parent_node = NULL;
  199. struct acpi_namespace_node *child_node = NULL;
  200. /* Parameter validation */
  201. if (type > ACPI_TYPE_EXTERNAL_MAX) {
  202. return (AE_BAD_PARAMETER);
  203. }
  204. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  205. if (ACPI_FAILURE(status)) {
  206. return (status);
  207. }
  208. /* If null handle, use the parent */
  209. if (!child) {
  210. /* Start search at the beginning of the specified scope */
  211. parent_node = acpi_ns_validate_handle(parent);
  212. if (!parent_node) {
  213. status = AE_BAD_PARAMETER;
  214. goto unlock_and_exit;
  215. }
  216. } else {
  217. /* Non-null handle, ignore the parent */
  218. /* Convert and validate the handle */
  219. child_node = acpi_ns_validate_handle(child);
  220. if (!child_node) {
  221. status = AE_BAD_PARAMETER;
  222. goto unlock_and_exit;
  223. }
  224. }
  225. /* Internal function does the real work */
  226. node = acpi_ns_get_next_node_typed(type, parent_node, child_node);
  227. if (!node) {
  228. status = AE_NOT_FOUND;
  229. goto unlock_and_exit;
  230. }
  231. if (ret_handle) {
  232. *ret_handle = ACPI_CAST_PTR(acpi_handle, node);
  233. }
  234. unlock_and_exit:
  235. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  236. return (status);
  237. }
  238. ACPI_EXPORT_SYMBOL(acpi_get_next_object)