nsutils.c 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990
  1. /******************************************************************************
  2. *
  3. * Module Name: nsutils - Utilities for accessing ACPI namespace, accessing
  4. * parents and siblings and Scope manipulation
  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 <acpi/acnamesp.h>
  45. #include <acpi/amlcode.h>
  46. #include <acpi/actables.h>
  47. #define _COMPONENT ACPI_NAMESPACE
  48. ACPI_MODULE_NAME("nsutils")
  49. /* Local prototypes */
  50. static u8 acpi_ns_valid_path_separator(char sep);
  51. #ifdef ACPI_OBSOLETE_FUNCTIONS
  52. acpi_name acpi_ns_find_parent_name(struct acpi_namespace_node *node_to_search);
  53. #endif
  54. /*******************************************************************************
  55. *
  56. * FUNCTION: acpi_ns_report_error
  57. *
  58. * PARAMETERS: module_name - Caller's module name (for error output)
  59. * line_number - Caller's line number (for error output)
  60. * internal_name - Name or path of the namespace node
  61. * lookup_status - Exception code from NS lookup
  62. *
  63. * RETURN: None
  64. *
  65. * DESCRIPTION: Print warning message with full pathname
  66. *
  67. ******************************************************************************/
  68. void
  69. acpi_ns_report_error(char *module_name,
  70. u32 line_number,
  71. char *internal_name, acpi_status lookup_status)
  72. {
  73. acpi_status status;
  74. u32 bad_name;
  75. char *name = NULL;
  76. acpi_os_printf("ACPI Error (%s-%04d): ", module_name, line_number);
  77. if (lookup_status == AE_BAD_CHARACTER) {
  78. /* There is a non-ascii character in the name */
  79. ACPI_MOVE_32_TO_32(&bad_name, internal_name);
  80. acpi_os_printf("[0x%4.4X] (NON-ASCII)", bad_name);
  81. } else {
  82. /* Convert path to external format */
  83. status = acpi_ns_externalize_name(ACPI_UINT32_MAX,
  84. internal_name, NULL, &name);
  85. /* Print target name */
  86. if (ACPI_SUCCESS(status)) {
  87. acpi_os_printf("[%s]", name);
  88. } else {
  89. acpi_os_printf("[COULD NOT EXTERNALIZE NAME]");
  90. }
  91. if (name) {
  92. ACPI_FREE(name);
  93. }
  94. }
  95. acpi_os_printf(" Namespace lookup failure, %s\n",
  96. acpi_format_exception(lookup_status));
  97. }
  98. /*******************************************************************************
  99. *
  100. * FUNCTION: acpi_ns_report_method_error
  101. *
  102. * PARAMETERS: module_name - Caller's module name (for error output)
  103. * line_number - Caller's line number (for error output)
  104. * Message - Error message to use on failure
  105. * prefix_node - Prefix relative to the path
  106. * Path - Path to the node (optional)
  107. * method_status - Execution status
  108. *
  109. * RETURN: None
  110. *
  111. * DESCRIPTION: Print warning message with full pathname
  112. *
  113. ******************************************************************************/
  114. void
  115. acpi_ns_report_method_error(char *module_name,
  116. u32 line_number,
  117. char *message,
  118. struct acpi_namespace_node *prefix_node,
  119. char *path, acpi_status method_status)
  120. {
  121. acpi_status status;
  122. struct acpi_namespace_node *node = prefix_node;
  123. acpi_os_printf("ACPI Error (%s-%04d): ", module_name, line_number);
  124. if (path) {
  125. status =
  126. acpi_ns_get_node(prefix_node, path, ACPI_NS_NO_UPSEARCH,
  127. &node);
  128. if (ACPI_FAILURE(status)) {
  129. acpi_os_printf("[Could not get node by pathname]");
  130. }
  131. }
  132. acpi_ns_print_node_pathname(node, message);
  133. acpi_os_printf(", %s\n", acpi_format_exception(method_status));
  134. }
  135. /*******************************************************************************
  136. *
  137. * FUNCTION: acpi_ns_print_node_pathname
  138. *
  139. * PARAMETERS: Node - Object
  140. * Message - Prefix message
  141. *
  142. * DESCRIPTION: Print an object's full namespace pathname
  143. * Manages allocation/freeing of a pathname buffer
  144. *
  145. ******************************************************************************/
  146. void
  147. acpi_ns_print_node_pathname(struct acpi_namespace_node *node, char *message)
  148. {
  149. struct acpi_buffer buffer;
  150. acpi_status status;
  151. if (!node) {
  152. acpi_os_printf("[NULL NAME]");
  153. return;
  154. }
  155. /* Convert handle to full pathname and print it (with supplied message) */
  156. buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
  157. status = acpi_ns_handle_to_pathname(node, &buffer);
  158. if (ACPI_SUCCESS(status)) {
  159. if (message) {
  160. acpi_os_printf("%s ", message);
  161. }
  162. acpi_os_printf("[%s] (Node %p)", (char *)buffer.pointer, node);
  163. ACPI_FREE(buffer.pointer);
  164. }
  165. }
  166. /*******************************************************************************
  167. *
  168. * FUNCTION: acpi_ns_valid_root_prefix
  169. *
  170. * PARAMETERS: Prefix - Character to be checked
  171. *
  172. * RETURN: TRUE if a valid prefix
  173. *
  174. * DESCRIPTION: Check if a character is a valid ACPI Root prefix
  175. *
  176. ******************************************************************************/
  177. u8 acpi_ns_valid_root_prefix(char prefix)
  178. {
  179. return ((u8) (prefix == '\\'));
  180. }
  181. /*******************************************************************************
  182. *
  183. * FUNCTION: acpi_ns_valid_path_separator
  184. *
  185. * PARAMETERS: Sep - Character to be checked
  186. *
  187. * RETURN: TRUE if a valid path separator
  188. *
  189. * DESCRIPTION: Check if a character is a valid ACPI path separator
  190. *
  191. ******************************************************************************/
  192. static u8 acpi_ns_valid_path_separator(char sep)
  193. {
  194. return ((u8) (sep == '.'));
  195. }
  196. /*******************************************************************************
  197. *
  198. * FUNCTION: acpi_ns_get_type
  199. *
  200. * PARAMETERS: Node - Parent Node to be examined
  201. *
  202. * RETURN: Type field from Node whose handle is passed
  203. *
  204. * DESCRIPTION: Return the type of a Namespace node
  205. *
  206. ******************************************************************************/
  207. acpi_object_type acpi_ns_get_type(struct acpi_namespace_node * node)
  208. {
  209. ACPI_FUNCTION_TRACE(ns_get_type);
  210. if (!node) {
  211. ACPI_WARNING((AE_INFO, "Null Node parameter"));
  212. return_UINT32(ACPI_TYPE_ANY);
  213. }
  214. return_UINT32((acpi_object_type) node->type);
  215. }
  216. /*******************************************************************************
  217. *
  218. * FUNCTION: acpi_ns_local
  219. *
  220. * PARAMETERS: Type - A namespace object type
  221. *
  222. * RETURN: LOCAL if names must be found locally in objects of the
  223. * passed type, 0 if enclosing scopes should be searched
  224. *
  225. * DESCRIPTION: Returns scope rule for the given object type.
  226. *
  227. ******************************************************************************/
  228. u32 acpi_ns_local(acpi_object_type type)
  229. {
  230. ACPI_FUNCTION_TRACE(ns_local);
  231. if (!acpi_ut_valid_object_type(type)) {
  232. /* Type code out of range */
  233. ACPI_WARNING((AE_INFO, "Invalid Object Type %X", type));
  234. return_UINT32(ACPI_NS_NORMAL);
  235. }
  236. return_UINT32((u32) acpi_gbl_ns_properties[type] & ACPI_NS_LOCAL);
  237. }
  238. /*******************************************************************************
  239. *
  240. * FUNCTION: acpi_ns_get_internal_name_length
  241. *
  242. * PARAMETERS: Info - Info struct initialized with the
  243. * external name pointer.
  244. *
  245. * RETURN: None
  246. *
  247. * DESCRIPTION: Calculate the length of the internal (AML) namestring
  248. * corresponding to the external (ASL) namestring.
  249. *
  250. ******************************************************************************/
  251. void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info)
  252. {
  253. char *next_external_char;
  254. u32 i;
  255. ACPI_FUNCTION_ENTRY();
  256. next_external_char = info->external_name;
  257. info->num_carats = 0;
  258. info->num_segments = 0;
  259. info->fully_qualified = FALSE;
  260. /*
  261. * For the internal name, the required length is 4 bytes per segment, plus
  262. * 1 each for root_prefix, multi_name_prefix_op, segment count, trailing null
  263. * (which is not really needed, but no there's harm in putting it there)
  264. *
  265. * strlen() + 1 covers the first name_seg, which has no path separator
  266. */
  267. if (acpi_ns_valid_root_prefix(next_external_char[0])) {
  268. info->fully_qualified = TRUE;
  269. next_external_char++;
  270. } else {
  271. /*
  272. * Handle Carat prefixes
  273. */
  274. while (*next_external_char == '^') {
  275. info->num_carats++;
  276. next_external_char++;
  277. }
  278. }
  279. /*
  280. * Determine the number of ACPI name "segments" by counting the number of
  281. * path separators within the string. Start with one segment since the
  282. * segment count is [(# separators) + 1], and zero separators is ok.
  283. */
  284. if (*next_external_char) {
  285. info->num_segments = 1;
  286. for (i = 0; next_external_char[i]; i++) {
  287. if (acpi_ns_valid_path_separator(next_external_char[i])) {
  288. info->num_segments++;
  289. }
  290. }
  291. }
  292. info->length = (ACPI_NAME_SIZE * info->num_segments) +
  293. 4 + info->num_carats;
  294. info->next_external_char = next_external_char;
  295. }
  296. /*******************************************************************************
  297. *
  298. * FUNCTION: acpi_ns_build_internal_name
  299. *
  300. * PARAMETERS: Info - Info struct fully initialized
  301. *
  302. * RETURN: Status
  303. *
  304. * DESCRIPTION: Construct the internal (AML) namestring
  305. * corresponding to the external (ASL) namestring.
  306. *
  307. ******************************************************************************/
  308. acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info)
  309. {
  310. u32 num_segments = info->num_segments;
  311. char *internal_name = info->internal_name;
  312. char *external_name = info->next_external_char;
  313. char *result = NULL;
  314. acpi_native_uint i;
  315. ACPI_FUNCTION_TRACE(ns_build_internal_name);
  316. /* Setup the correct prefixes, counts, and pointers */
  317. if (info->fully_qualified) {
  318. internal_name[0] = '\\';
  319. if (num_segments <= 1) {
  320. result = &internal_name[1];
  321. } else if (num_segments == 2) {
  322. internal_name[1] = AML_DUAL_NAME_PREFIX;
  323. result = &internal_name[2];
  324. } else {
  325. internal_name[1] = AML_MULTI_NAME_PREFIX_OP;
  326. internal_name[2] = (char)num_segments;
  327. result = &internal_name[3];
  328. }
  329. } else {
  330. /*
  331. * Not fully qualified.
  332. * Handle Carats first, then append the name segments
  333. */
  334. i = 0;
  335. if (info->num_carats) {
  336. for (i = 0; i < info->num_carats; i++) {
  337. internal_name[i] = '^';
  338. }
  339. }
  340. if (num_segments <= 1) {
  341. result = &internal_name[i];
  342. } else if (num_segments == 2) {
  343. internal_name[i] = AML_DUAL_NAME_PREFIX;
  344. result = &internal_name[(acpi_native_uint) (i + 1)];
  345. } else {
  346. internal_name[i] = AML_MULTI_NAME_PREFIX_OP;
  347. internal_name[(acpi_native_uint) (i + 1)] =
  348. (char)num_segments;
  349. result = &internal_name[(acpi_native_uint) (i + 2)];
  350. }
  351. }
  352. /* Build the name (minus path separators) */
  353. for (; num_segments; num_segments--) {
  354. for (i = 0; i < ACPI_NAME_SIZE; i++) {
  355. if (acpi_ns_valid_path_separator(*external_name) ||
  356. (*external_name == 0)) {
  357. /* Pad the segment with underscore(s) if segment is short */
  358. result[i] = '_';
  359. } else {
  360. /* Convert the character to uppercase and save it */
  361. result[i] =
  362. (char)ACPI_TOUPPER((int)*external_name);
  363. external_name++;
  364. }
  365. }
  366. /* Now we must have a path separator, or the pathname is bad */
  367. if (!acpi_ns_valid_path_separator(*external_name) &&
  368. (*external_name != 0)) {
  369. return_ACPI_STATUS(AE_BAD_PARAMETER);
  370. }
  371. /* Move on the next segment */
  372. external_name++;
  373. result += ACPI_NAME_SIZE;
  374. }
  375. /* Terminate the string */
  376. *result = 0;
  377. if (info->fully_qualified) {
  378. ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
  379. "Returning [%p] (abs) \"\\%s\"\n",
  380. internal_name, internal_name));
  381. } else {
  382. ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Returning [%p] (rel) \"%s\"\n",
  383. internal_name, internal_name));
  384. }
  385. return_ACPI_STATUS(AE_OK);
  386. }
  387. /*******************************************************************************
  388. *
  389. * FUNCTION: acpi_ns_internalize_name
  390. *
  391. * PARAMETERS: *external_name - External representation of name
  392. * **Converted Name - Where to return the resulting
  393. * internal represention of the name
  394. *
  395. * RETURN: Status
  396. *
  397. * DESCRIPTION: Convert an external representation (e.g. "\_PR_.CPU0")
  398. * to internal form (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30)
  399. *
  400. *******************************************************************************/
  401. acpi_status acpi_ns_internalize_name(char *external_name, char **converted_name)
  402. {
  403. char *internal_name;
  404. struct acpi_namestring_info info;
  405. acpi_status status;
  406. ACPI_FUNCTION_TRACE(ns_internalize_name);
  407. if ((!external_name) || (*external_name == 0) || (!converted_name)) {
  408. return_ACPI_STATUS(AE_BAD_PARAMETER);
  409. }
  410. /* Get the length of the new internal name */
  411. info.external_name = external_name;
  412. acpi_ns_get_internal_name_length(&info);
  413. /* We need a segment to store the internal name */
  414. internal_name = ACPI_ALLOCATE_ZEROED(info.length);
  415. if (!internal_name) {
  416. return_ACPI_STATUS(AE_NO_MEMORY);
  417. }
  418. /* Build the name */
  419. info.internal_name = internal_name;
  420. status = acpi_ns_build_internal_name(&info);
  421. if (ACPI_FAILURE(status)) {
  422. ACPI_FREE(internal_name);
  423. return_ACPI_STATUS(status);
  424. }
  425. *converted_name = internal_name;
  426. return_ACPI_STATUS(AE_OK);
  427. }
  428. /*******************************************************************************
  429. *
  430. * FUNCTION: acpi_ns_externalize_name
  431. *
  432. * PARAMETERS: internal_name_length - Lenth of the internal name below
  433. * internal_name - Internal representation of name
  434. * converted_name_length - Where the length is returned
  435. * converted_name - Where the resulting external name
  436. * is returned
  437. *
  438. * RETURN: Status
  439. *
  440. * DESCRIPTION: Convert internal name (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30)
  441. * to its external (printable) form (e.g. "\_PR_.CPU0")
  442. *
  443. ******************************************************************************/
  444. acpi_status
  445. acpi_ns_externalize_name(u32 internal_name_length,
  446. char *internal_name,
  447. u32 * converted_name_length, char **converted_name)
  448. {
  449. acpi_native_uint names_index = 0;
  450. acpi_native_uint num_segments = 0;
  451. acpi_native_uint required_length;
  452. acpi_native_uint prefix_length = 0;
  453. acpi_native_uint i = 0;
  454. acpi_native_uint j = 0;
  455. ACPI_FUNCTION_TRACE(ns_externalize_name);
  456. if (!internal_name_length || !internal_name || !converted_name) {
  457. return_ACPI_STATUS(AE_BAD_PARAMETER);
  458. }
  459. /*
  460. * Check for a prefix (one '\' | one or more '^').
  461. */
  462. switch (internal_name[0]) {
  463. case '\\':
  464. prefix_length = 1;
  465. break;
  466. case '^':
  467. for (i = 0; i < internal_name_length; i++) {
  468. if (internal_name[i] == '^') {
  469. prefix_length = i + 1;
  470. } else {
  471. break;
  472. }
  473. }
  474. if (i == internal_name_length) {
  475. prefix_length = i;
  476. }
  477. break;
  478. default:
  479. break;
  480. }
  481. /*
  482. * Check for object names. Note that there could be 0-255 of these
  483. * 4-byte elements.
  484. */
  485. if (prefix_length < internal_name_length) {
  486. switch (internal_name[prefix_length]) {
  487. case AML_MULTI_NAME_PREFIX_OP:
  488. /* <count> 4-byte names */
  489. names_index = prefix_length + 2;
  490. num_segments = (acpi_native_uint) (u8)
  491. internal_name[(acpi_native_uint)
  492. (prefix_length + 1)];
  493. break;
  494. case AML_DUAL_NAME_PREFIX:
  495. /* Two 4-byte names */
  496. names_index = prefix_length + 1;
  497. num_segments = 2;
  498. break;
  499. case 0:
  500. /* null_name */
  501. names_index = 0;
  502. num_segments = 0;
  503. break;
  504. default:
  505. /* one 4-byte name */
  506. names_index = prefix_length;
  507. num_segments = 1;
  508. break;
  509. }
  510. }
  511. /*
  512. * Calculate the length of converted_name, which equals the length
  513. * of the prefix, length of all object names, length of any required
  514. * punctuation ('.') between object names, plus the NULL terminator.
  515. */
  516. required_length = prefix_length + (4 * num_segments) +
  517. ((num_segments > 0) ? (num_segments - 1) : 0) + 1;
  518. /*
  519. * Check to see if we're still in bounds. If not, there's a problem
  520. * with internal_name (invalid format).
  521. */
  522. if (required_length > internal_name_length) {
  523. ACPI_ERROR((AE_INFO, "Invalid internal name"));
  524. return_ACPI_STATUS(AE_BAD_PATHNAME);
  525. }
  526. /*
  527. * Build converted_name
  528. */
  529. *converted_name = ACPI_ALLOCATE_ZEROED(required_length);
  530. if (!(*converted_name)) {
  531. return_ACPI_STATUS(AE_NO_MEMORY);
  532. }
  533. j = 0;
  534. for (i = 0; i < prefix_length; i++) {
  535. (*converted_name)[j++] = internal_name[i];
  536. }
  537. if (num_segments > 0) {
  538. for (i = 0; i < num_segments; i++) {
  539. if (i > 0) {
  540. (*converted_name)[j++] = '.';
  541. }
  542. (*converted_name)[j++] = internal_name[names_index++];
  543. (*converted_name)[j++] = internal_name[names_index++];
  544. (*converted_name)[j++] = internal_name[names_index++];
  545. (*converted_name)[j++] = internal_name[names_index++];
  546. }
  547. }
  548. if (converted_name_length) {
  549. *converted_name_length = (u32) required_length;
  550. }
  551. return_ACPI_STATUS(AE_OK);
  552. }
  553. /*******************************************************************************
  554. *
  555. * FUNCTION: acpi_ns_map_handle_to_node
  556. *
  557. * PARAMETERS: Handle - Handle to be converted to an Node
  558. *
  559. * RETURN: A Name table entry pointer
  560. *
  561. * DESCRIPTION: Convert a namespace handle to a real Node
  562. *
  563. * Note: Real integer handles would allow for more verification
  564. * and keep all pointers within this subsystem - however this introduces
  565. * more (and perhaps unnecessary) overhead.
  566. *
  567. ******************************************************************************/
  568. struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle)
  569. {
  570. ACPI_FUNCTION_ENTRY();
  571. /*
  572. * Simple implementation
  573. */
  574. if ((!handle) || (handle == ACPI_ROOT_OBJECT)) {
  575. return (acpi_gbl_root_node);
  576. }
  577. /* We can at least attempt to verify the handle */
  578. if (ACPI_GET_DESCRIPTOR_TYPE(handle) != ACPI_DESC_TYPE_NAMED) {
  579. return (NULL);
  580. }
  581. return (ACPI_CAST_PTR(struct acpi_namespace_node, handle));
  582. }
  583. /*******************************************************************************
  584. *
  585. * FUNCTION: acpi_ns_convert_entry_to_handle
  586. *
  587. * PARAMETERS: Node - Node to be converted to a Handle
  588. *
  589. * RETURN: A user handle
  590. *
  591. * DESCRIPTION: Convert a real Node to a namespace handle
  592. *
  593. ******************************************************************************/
  594. acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node)
  595. {
  596. /*
  597. * Simple implementation for now;
  598. */
  599. return ((acpi_handle) node);
  600. /* Example future implementation ---------------------
  601. if (!Node)
  602. {
  603. return (NULL);
  604. }
  605. if (Node == acpi_gbl_root_node)
  606. {
  607. return (ACPI_ROOT_OBJECT);
  608. }
  609. return ((acpi_handle) Node);
  610. ------------------------------------------------------*/
  611. }
  612. /*******************************************************************************
  613. *
  614. * FUNCTION: acpi_ns_terminate
  615. *
  616. * PARAMETERS: none
  617. *
  618. * RETURN: none
  619. *
  620. * DESCRIPTION: free memory allocated for namespace and ACPI table storage.
  621. *
  622. ******************************************************************************/
  623. void acpi_ns_terminate(void)
  624. {
  625. union acpi_operand_object *obj_desc;
  626. ACPI_FUNCTION_TRACE(ns_terminate);
  627. /*
  628. * 1) Free the entire namespace -- all nodes and objects
  629. *
  630. * Delete all object descriptors attached to namepsace nodes
  631. */
  632. acpi_ns_delete_namespace_subtree(acpi_gbl_root_node);
  633. /* Detach any objects attached to the root */
  634. obj_desc = acpi_ns_get_attached_object(acpi_gbl_root_node);
  635. if (obj_desc) {
  636. acpi_ns_detach_object(acpi_gbl_root_node);
  637. }
  638. ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Namespace freed\n"));
  639. return_VOID;
  640. }
  641. /*******************************************************************************
  642. *
  643. * FUNCTION: acpi_ns_opens_scope
  644. *
  645. * PARAMETERS: Type - A valid namespace type
  646. *
  647. * RETURN: NEWSCOPE if the passed type "opens a name scope" according
  648. * to the ACPI specification, else 0
  649. *
  650. ******************************************************************************/
  651. u32 acpi_ns_opens_scope(acpi_object_type type)
  652. {
  653. ACPI_FUNCTION_TRACE_STR(ns_opens_scope, acpi_ut_get_type_name(type));
  654. if (!acpi_ut_valid_object_type(type)) {
  655. /* type code out of range */
  656. ACPI_WARNING((AE_INFO, "Invalid Object Type %X", type));
  657. return_UINT32(ACPI_NS_NORMAL);
  658. }
  659. return_UINT32(((u32) acpi_gbl_ns_properties[type]) & ACPI_NS_NEWSCOPE);
  660. }
  661. /*******************************************************************************
  662. *
  663. * FUNCTION: acpi_ns_get_node
  664. *
  665. * PARAMETERS: *Pathname - Name to be found, in external (ASL) format. The
  666. * \ (backslash) and ^ (carat) prefixes, and the
  667. * . (period) to separate segments are supported.
  668. * prefix_node - Root of subtree to be searched, or NS_ALL for the
  669. * root of the name space. If Name is fully
  670. * qualified (first s8 is '\'), the passed value
  671. * of Scope will not be accessed.
  672. * Flags - Used to indicate whether to perform upsearch or
  673. * not.
  674. * return_node - Where the Node is returned
  675. *
  676. * DESCRIPTION: Look up a name relative to a given scope and return the
  677. * corresponding Node. NOTE: Scope can be null.
  678. *
  679. * MUTEX: Locks namespace
  680. *
  681. ******************************************************************************/
  682. acpi_status
  683. acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
  684. char *pathname,
  685. u32 flags, struct acpi_namespace_node **return_node)
  686. {
  687. union acpi_generic_state scope_info;
  688. acpi_status status;
  689. char *internal_path;
  690. ACPI_FUNCTION_TRACE_PTR(ns_get_node, pathname);
  691. if (!pathname) {
  692. *return_node = prefix_node;
  693. if (!prefix_node) {
  694. *return_node = acpi_gbl_root_node;
  695. }
  696. return_ACPI_STATUS(AE_OK);
  697. }
  698. /* Convert path to internal representation */
  699. status = acpi_ns_internalize_name(pathname, &internal_path);
  700. if (ACPI_FAILURE(status)) {
  701. return_ACPI_STATUS(status);
  702. }
  703. /* Must lock namespace during lookup */
  704. status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  705. if (ACPI_FAILURE(status)) {
  706. goto cleanup;
  707. }
  708. /* Setup lookup scope (search starting point) */
  709. scope_info.scope.node = prefix_node;
  710. /* Lookup the name in the namespace */
  711. status = acpi_ns_lookup(&scope_info, internal_path, ACPI_TYPE_ANY,
  712. ACPI_IMODE_EXECUTE,
  713. (flags | ACPI_NS_DONT_OPEN_SCOPE), NULL,
  714. return_node);
  715. if (ACPI_FAILURE(status)) {
  716. ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s, %s\n",
  717. pathname, acpi_format_exception(status)));
  718. }
  719. (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  720. cleanup:
  721. ACPI_FREE(internal_path);
  722. return_ACPI_STATUS(status);
  723. }
  724. /*******************************************************************************
  725. *
  726. * FUNCTION: acpi_ns_get_parent_node
  727. *
  728. * PARAMETERS: Node - Current table entry
  729. *
  730. * RETURN: Parent entry of the given entry
  731. *
  732. * DESCRIPTION: Obtain the parent entry for a given entry in the namespace.
  733. *
  734. ******************************************************************************/
  735. struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node
  736. *node)
  737. {
  738. ACPI_FUNCTION_ENTRY();
  739. if (!node) {
  740. return (NULL);
  741. }
  742. /*
  743. * Walk to the end of this peer list. The last entry is marked with a flag
  744. * and the peer pointer is really a pointer back to the parent. This saves
  745. * putting a parent back pointer in each and every named object!
  746. */
  747. while (!(node->flags & ANOBJ_END_OF_PEER_LIST)) {
  748. node = node->peer;
  749. }
  750. return (node->peer);
  751. }
  752. /*******************************************************************************
  753. *
  754. * FUNCTION: acpi_ns_get_next_valid_node
  755. *
  756. * PARAMETERS: Node - Current table entry
  757. *
  758. * RETURN: Next valid Node in the linked node list. NULL if no more valid
  759. * nodes.
  760. *
  761. * DESCRIPTION: Find the next valid node within a name table.
  762. * Useful for implementing NULL-end-of-list loops.
  763. *
  764. ******************************************************************************/
  765. struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct
  766. acpi_namespace_node
  767. *node)
  768. {
  769. /* If we are at the end of this peer list, return NULL */
  770. if (node->flags & ANOBJ_END_OF_PEER_LIST) {
  771. return NULL;
  772. }
  773. /* Otherwise just return the next peer */
  774. return (node->peer);
  775. }
  776. #ifdef ACPI_OBSOLETE_FUNCTIONS
  777. /*******************************************************************************
  778. *
  779. * FUNCTION: acpi_ns_find_parent_name
  780. *
  781. * PARAMETERS: *child_node - Named Obj whose name is to be found
  782. *
  783. * RETURN: The ACPI name
  784. *
  785. * DESCRIPTION: Search for the given obj in its parent scope and return the
  786. * name segment, or "????" if the parent name can't be found
  787. * (which "should not happen").
  788. *
  789. ******************************************************************************/
  790. acpi_name acpi_ns_find_parent_name(struct acpi_namespace_node * child_node)
  791. {
  792. struct acpi_namespace_node *parent_node;
  793. ACPI_FUNCTION_TRACE(ns_find_parent_name);
  794. if (child_node) {
  795. /* Valid entry. Get the parent Node */
  796. parent_node = acpi_ns_get_parent_node(child_node);
  797. if (parent_node) {
  798. ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
  799. "Parent of %p [%4.4s] is %p [%4.4s]\n",
  800. child_node,
  801. acpi_ut_get_node_name(child_node),
  802. parent_node,
  803. acpi_ut_get_node_name(parent_node)));
  804. if (parent_node->name.integer) {
  805. return_VALUE((acpi_name) parent_node->name.
  806. integer);
  807. }
  808. }
  809. ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
  810. "Unable to find parent of %p (%4.4s)\n",
  811. child_node,
  812. acpi_ut_get_node_name(child_node)));
  813. }
  814. return_VALUE(ACPI_UNKNOWN_NAME);
  815. }
  816. #endif