nsutils.c 27 KB

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