nsutils.c 27 KB

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