nsutils.c revision 1.1.1.13 1 1.1 jruoho /******************************************************************************
2 1.1 jruoho *
3 1.1 jruoho * Module Name: nsutils - Utilities for accessing ACPI namespace, accessing
4 1.1 jruoho * parents and siblings and Scope manipulation
5 1.1 jruoho *
6 1.1 jruoho *****************************************************************************/
7 1.1 jruoho
8 1.1.1.2 jruoho /*
9 1.1.1.13 christos * Copyright (C) 2000 - 2019, Intel Corp.
10 1.1 jruoho * All rights reserved.
11 1.1 jruoho *
12 1.1.1.2 jruoho * Redistribution and use in source and binary forms, with or without
13 1.1.1.2 jruoho * modification, are permitted provided that the following conditions
14 1.1.1.2 jruoho * are met:
15 1.1.1.2 jruoho * 1. Redistributions of source code must retain the above copyright
16 1.1.1.2 jruoho * notice, this list of conditions, and the following disclaimer,
17 1.1.1.2 jruoho * without modification.
18 1.1.1.2 jruoho * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 1.1.1.2 jruoho * substantially similar to the "NO WARRANTY" disclaimer below
20 1.1.1.2 jruoho * ("Disclaimer") and any redistribution must be conditioned upon
21 1.1.1.2 jruoho * including a substantially similar Disclaimer requirement for further
22 1.1.1.2 jruoho * binary redistribution.
23 1.1.1.2 jruoho * 3. Neither the names of the above-listed copyright holders nor the names
24 1.1.1.2 jruoho * of any contributors may be used to endorse or promote products derived
25 1.1.1.2 jruoho * from this software without specific prior written permission.
26 1.1.1.2 jruoho *
27 1.1.1.2 jruoho * Alternatively, this software may be distributed under the terms of the
28 1.1.1.2 jruoho * GNU General Public License ("GPL") version 2 as published by the Free
29 1.1.1.2 jruoho * Software Foundation.
30 1.1.1.2 jruoho *
31 1.1.1.2 jruoho * NO WARRANTY
32 1.1.1.2 jruoho * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 1.1.1.2 jruoho * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 1.1.1.2 jruoho * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 1.1.1.2 jruoho * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 1.1.1.2 jruoho * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 1.1.1.2 jruoho * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 1.1.1.2 jruoho * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 1.1.1.2 jruoho * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 1.1.1.2 jruoho * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 1.1.1.2 jruoho * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 1.1.1.2 jruoho * POSSIBILITY OF SUCH DAMAGES.
43 1.1.1.2 jruoho */
44 1.1 jruoho
45 1.1 jruoho #include "acpi.h"
46 1.1 jruoho #include "accommon.h"
47 1.1 jruoho #include "acnamesp.h"
48 1.1 jruoho #include "amlcode.h"
49 1.1 jruoho
50 1.1 jruoho #define _COMPONENT ACPI_NAMESPACE
51 1.1 jruoho ACPI_MODULE_NAME ("nsutils")
52 1.1 jruoho
53 1.1 jruoho /* Local prototypes */
54 1.1 jruoho
55 1.1 jruoho #ifdef ACPI_OBSOLETE_FUNCTIONS
56 1.1 jruoho ACPI_NAME
57 1.1 jruoho AcpiNsFindParentName (
58 1.1 jruoho ACPI_NAMESPACE_NODE *NodeToSearch);
59 1.1 jruoho #endif
60 1.1 jruoho
61 1.1 jruoho
62 1.1 jruoho /*******************************************************************************
63 1.1 jruoho *
64 1.1 jruoho * FUNCTION: AcpiNsPrintNodePathname
65 1.1 jruoho *
66 1.1 jruoho * PARAMETERS: Node - Object
67 1.1 jruoho * Message - Prefix message
68 1.1 jruoho *
69 1.1 jruoho * DESCRIPTION: Print an object's full namespace pathname
70 1.1 jruoho * Manages allocation/freeing of a pathname buffer
71 1.1 jruoho *
72 1.1 jruoho ******************************************************************************/
73 1.1 jruoho
74 1.1 jruoho void
75 1.1 jruoho AcpiNsPrintNodePathname (
76 1.1 jruoho ACPI_NAMESPACE_NODE *Node,
77 1.1 jruoho const char *Message)
78 1.1 jruoho {
79 1.1 jruoho ACPI_BUFFER Buffer;
80 1.1 jruoho ACPI_STATUS Status;
81 1.1 jruoho
82 1.1 jruoho
83 1.1 jruoho if (!Node)
84 1.1 jruoho {
85 1.1 jruoho AcpiOsPrintf ("[NULL NAME]");
86 1.1 jruoho return;
87 1.1 jruoho }
88 1.1 jruoho
89 1.1 jruoho /* Convert handle to full pathname and print it (with supplied message) */
90 1.1 jruoho
91 1.1 jruoho Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
92 1.1 jruoho
93 1.1.1.7 christos Status = AcpiNsHandleToPathname (Node, &Buffer, TRUE);
94 1.1 jruoho if (ACPI_SUCCESS (Status))
95 1.1 jruoho {
96 1.1 jruoho if (Message)
97 1.1 jruoho {
98 1.1 jruoho AcpiOsPrintf ("%s ", Message);
99 1.1 jruoho }
100 1.1 jruoho
101 1.1.1.11 christos AcpiOsPrintf ("%s", (char *) Buffer.Pointer);
102 1.1 jruoho ACPI_FREE (Buffer.Pointer);
103 1.1 jruoho }
104 1.1 jruoho }
105 1.1 jruoho
106 1.1 jruoho
107 1.1 jruoho /*******************************************************************************
108 1.1 jruoho *
109 1.1 jruoho * FUNCTION: AcpiNsGetType
110 1.1 jruoho *
111 1.1 jruoho * PARAMETERS: Node - Parent Node to be examined
112 1.1 jruoho *
113 1.1 jruoho * RETURN: Type field from Node whose handle is passed
114 1.1 jruoho *
115 1.1 jruoho * DESCRIPTION: Return the type of a Namespace node
116 1.1 jruoho *
117 1.1 jruoho ******************************************************************************/
118 1.1 jruoho
119 1.1 jruoho ACPI_OBJECT_TYPE
120 1.1 jruoho AcpiNsGetType (
121 1.1 jruoho ACPI_NAMESPACE_NODE *Node)
122 1.1 jruoho {
123 1.1 jruoho ACPI_FUNCTION_TRACE (NsGetType);
124 1.1 jruoho
125 1.1 jruoho
126 1.1 jruoho if (!Node)
127 1.1 jruoho {
128 1.1 jruoho ACPI_WARNING ((AE_INFO, "Null Node parameter"));
129 1.1.1.3 christos return_UINT8 (ACPI_TYPE_ANY);
130 1.1 jruoho }
131 1.1 jruoho
132 1.1.1.3 christos return_UINT8 (Node->Type);
133 1.1 jruoho }
134 1.1 jruoho
135 1.1 jruoho
136 1.1 jruoho /*******************************************************************************
137 1.1 jruoho *
138 1.1 jruoho * FUNCTION: AcpiNsLocal
139 1.1 jruoho *
140 1.1 jruoho * PARAMETERS: Type - A namespace object type
141 1.1 jruoho *
142 1.1 jruoho * RETURN: LOCAL if names must be found locally in objects of the
143 1.1 jruoho * passed type, 0 if enclosing scopes should be searched
144 1.1 jruoho *
145 1.1 jruoho * DESCRIPTION: Returns scope rule for the given object type.
146 1.1 jruoho *
147 1.1 jruoho ******************************************************************************/
148 1.1 jruoho
149 1.1 jruoho UINT32
150 1.1 jruoho AcpiNsLocal (
151 1.1 jruoho ACPI_OBJECT_TYPE Type)
152 1.1 jruoho {
153 1.1 jruoho ACPI_FUNCTION_TRACE (NsLocal);
154 1.1 jruoho
155 1.1 jruoho
156 1.1 jruoho if (!AcpiUtValidObjectType (Type))
157 1.1 jruoho {
158 1.1 jruoho /* Type code out of range */
159 1.1 jruoho
160 1.1 jruoho ACPI_WARNING ((AE_INFO, "Invalid Object Type 0x%X", Type));
161 1.1 jruoho return_UINT32 (ACPI_NS_NORMAL);
162 1.1 jruoho }
163 1.1 jruoho
164 1.1.1.3 christos return_UINT32 (AcpiGbl_NsProperties[Type] & ACPI_NS_LOCAL);
165 1.1 jruoho }
166 1.1 jruoho
167 1.1 jruoho
168 1.1 jruoho /*******************************************************************************
169 1.1 jruoho *
170 1.1 jruoho * FUNCTION: AcpiNsGetInternalNameLength
171 1.1 jruoho *
172 1.1 jruoho * PARAMETERS: Info - Info struct initialized with the
173 1.1 jruoho * external name pointer.
174 1.1 jruoho *
175 1.1 jruoho * RETURN: None
176 1.1 jruoho *
177 1.1 jruoho * DESCRIPTION: Calculate the length of the internal (AML) namestring
178 1.1 jruoho * corresponding to the external (ASL) namestring.
179 1.1 jruoho *
180 1.1 jruoho ******************************************************************************/
181 1.1 jruoho
182 1.1 jruoho void
183 1.1 jruoho AcpiNsGetInternalNameLength (
184 1.1 jruoho ACPI_NAMESTRING_INFO *Info)
185 1.1 jruoho {
186 1.1 jruoho const char *NextExternalChar;
187 1.1 jruoho UINT32 i;
188 1.1 jruoho
189 1.1 jruoho
190 1.1 jruoho ACPI_FUNCTION_ENTRY ();
191 1.1 jruoho
192 1.1 jruoho
193 1.1 jruoho NextExternalChar = Info->ExternalName;
194 1.1 jruoho Info->NumCarats = 0;
195 1.1 jruoho Info->NumSegments = 0;
196 1.1 jruoho Info->FullyQualified = FALSE;
197 1.1 jruoho
198 1.1 jruoho /*
199 1.1.1.7 christos * For the internal name, the required length is 4 bytes per segment,
200 1.1.1.7 christos * plus 1 each for RootPrefix, MultiNamePrefixOp, segment count,
201 1.1.1.7 christos * trailing null (which is not really needed, but no there's harm in
202 1.1.1.7 christos * putting it there)
203 1.1 jruoho *
204 1.1 jruoho * strlen() + 1 covers the first NameSeg, which has no path separator
205 1.1 jruoho */
206 1.1.1.3 christos if (ACPI_IS_ROOT_PREFIX (*NextExternalChar))
207 1.1 jruoho {
208 1.1 jruoho Info->FullyQualified = TRUE;
209 1.1 jruoho NextExternalChar++;
210 1.1 jruoho
211 1.1 jruoho /* Skip redundant RootPrefix, like \\_SB.PCI0.SBRG.EC0 */
212 1.1 jruoho
213 1.1.1.3 christos while (ACPI_IS_ROOT_PREFIX (*NextExternalChar))
214 1.1 jruoho {
215 1.1 jruoho NextExternalChar++;
216 1.1 jruoho }
217 1.1 jruoho }
218 1.1 jruoho else
219 1.1 jruoho {
220 1.1 jruoho /* Handle Carat prefixes */
221 1.1 jruoho
222 1.1.1.3 christos while (ACPI_IS_PARENT_PREFIX (*NextExternalChar))
223 1.1 jruoho {
224 1.1 jruoho Info->NumCarats++;
225 1.1 jruoho NextExternalChar++;
226 1.1 jruoho }
227 1.1 jruoho }
228 1.1 jruoho
229 1.1 jruoho /*
230 1.1 jruoho * Determine the number of ACPI name "segments" by counting the number of
231 1.1 jruoho * path separators within the string. Start with one segment since the
232 1.1 jruoho * segment count is [(# separators) + 1], and zero separators is ok.
233 1.1 jruoho */
234 1.1 jruoho if (*NextExternalChar)
235 1.1 jruoho {
236 1.1 jruoho Info->NumSegments = 1;
237 1.1 jruoho for (i = 0; NextExternalChar[i]; i++)
238 1.1 jruoho {
239 1.1.1.3 christos if (ACPI_IS_PATH_SEPARATOR (NextExternalChar[i]))
240 1.1 jruoho {
241 1.1 jruoho Info->NumSegments++;
242 1.1 jruoho }
243 1.1 jruoho }
244 1.1 jruoho }
245 1.1 jruoho
246 1.1.1.13 christos Info->Length = (ACPI_NAMESEG_SIZE * Info->NumSegments) +
247 1.1.1.7 christos 4 + Info->NumCarats;
248 1.1 jruoho
249 1.1 jruoho Info->NextExternalChar = NextExternalChar;
250 1.1 jruoho }
251 1.1 jruoho
252 1.1 jruoho
253 1.1 jruoho /*******************************************************************************
254 1.1 jruoho *
255 1.1 jruoho * FUNCTION: AcpiNsBuildInternalName
256 1.1 jruoho *
257 1.1 jruoho * PARAMETERS: Info - Info struct fully initialized
258 1.1 jruoho *
259 1.1 jruoho * RETURN: Status
260 1.1 jruoho *
261 1.1 jruoho * DESCRIPTION: Construct the internal (AML) namestring
262 1.1 jruoho * corresponding to the external (ASL) namestring.
263 1.1 jruoho *
264 1.1 jruoho ******************************************************************************/
265 1.1 jruoho
266 1.1 jruoho ACPI_STATUS
267 1.1 jruoho AcpiNsBuildInternalName (
268 1.1 jruoho ACPI_NAMESTRING_INFO *Info)
269 1.1 jruoho {
270 1.1 jruoho UINT32 NumSegments = Info->NumSegments;
271 1.1 jruoho char *InternalName = Info->InternalName;
272 1.1 jruoho const char *ExternalName = Info->NextExternalChar;
273 1.1 jruoho char *Result = NULL;
274 1.1 jruoho UINT32 i;
275 1.1 jruoho
276 1.1 jruoho
277 1.1 jruoho ACPI_FUNCTION_TRACE (NsBuildInternalName);
278 1.1 jruoho
279 1.1 jruoho
280 1.1 jruoho /* Setup the correct prefixes, counts, and pointers */
281 1.1 jruoho
282 1.1 jruoho if (Info->FullyQualified)
283 1.1 jruoho {
284 1.1.1.3 christos InternalName[0] = AML_ROOT_PREFIX;
285 1.1 jruoho
286 1.1 jruoho if (NumSegments <= 1)
287 1.1 jruoho {
288 1.1 jruoho Result = &InternalName[1];
289 1.1 jruoho }
290 1.1 jruoho else if (NumSegments == 2)
291 1.1 jruoho {
292 1.1 jruoho InternalName[1] = AML_DUAL_NAME_PREFIX;
293 1.1 jruoho Result = &InternalName[2];
294 1.1 jruoho }
295 1.1 jruoho else
296 1.1 jruoho {
297 1.1.1.10 christos InternalName[1] = AML_MULTI_NAME_PREFIX;
298 1.1 jruoho InternalName[2] = (char) NumSegments;
299 1.1 jruoho Result = &InternalName[3];
300 1.1 jruoho }
301 1.1 jruoho }
302 1.1 jruoho else
303 1.1 jruoho {
304 1.1 jruoho /*
305 1.1 jruoho * Not fully qualified.
306 1.1 jruoho * Handle Carats first, then append the name segments
307 1.1 jruoho */
308 1.1 jruoho i = 0;
309 1.1 jruoho if (Info->NumCarats)
310 1.1 jruoho {
311 1.1 jruoho for (i = 0; i < Info->NumCarats; i++)
312 1.1 jruoho {
313 1.1.1.3 christos InternalName[i] = AML_PARENT_PREFIX;
314 1.1 jruoho }
315 1.1 jruoho }
316 1.1 jruoho
317 1.1 jruoho if (NumSegments <= 1)
318 1.1 jruoho {
319 1.1 jruoho Result = &InternalName[i];
320 1.1 jruoho }
321 1.1 jruoho else if (NumSegments == 2)
322 1.1 jruoho {
323 1.1 jruoho InternalName[i] = AML_DUAL_NAME_PREFIX;
324 1.1 jruoho Result = &InternalName[(ACPI_SIZE) i+1];
325 1.1 jruoho }
326 1.1 jruoho else
327 1.1 jruoho {
328 1.1.1.10 christos InternalName[i] = AML_MULTI_NAME_PREFIX;
329 1.1 jruoho InternalName[(ACPI_SIZE) i+1] = (char) NumSegments;
330 1.1 jruoho Result = &InternalName[(ACPI_SIZE) i+2];
331 1.1 jruoho }
332 1.1 jruoho }
333 1.1 jruoho
334 1.1 jruoho /* Build the name (minus path separators) */
335 1.1 jruoho
336 1.1 jruoho for (; NumSegments; NumSegments--)
337 1.1 jruoho {
338 1.1.1.13 christos for (i = 0; i < ACPI_NAMESEG_SIZE; i++)
339 1.1 jruoho {
340 1.1.1.3 christos if (ACPI_IS_PATH_SEPARATOR (*ExternalName) ||
341 1.1 jruoho (*ExternalName == 0))
342 1.1 jruoho {
343 1.1 jruoho /* Pad the segment with underscore(s) if segment is short */
344 1.1 jruoho
345 1.1 jruoho Result[i] = '_';
346 1.1 jruoho }
347 1.1 jruoho else
348 1.1 jruoho {
349 1.1 jruoho /* Convert the character to uppercase and save it */
350 1.1 jruoho
351 1.1.1.6 christos Result[i] = (char) toupper ((int) *ExternalName);
352 1.1 jruoho ExternalName++;
353 1.1 jruoho }
354 1.1 jruoho }
355 1.1 jruoho
356 1.1 jruoho /* Now we must have a path separator, or the pathname is bad */
357 1.1 jruoho
358 1.1.1.3 christos if (!ACPI_IS_PATH_SEPARATOR (*ExternalName) &&
359 1.1 jruoho (*ExternalName != 0))
360 1.1 jruoho {
361 1.1.1.3 christos return_ACPI_STATUS (AE_BAD_PATHNAME);
362 1.1 jruoho }
363 1.1 jruoho
364 1.1 jruoho /* Move on the next segment */
365 1.1 jruoho
366 1.1 jruoho ExternalName++;
367 1.1.1.13 christos Result += ACPI_NAMESEG_SIZE;
368 1.1 jruoho }
369 1.1 jruoho
370 1.1 jruoho /* Terminate the string */
371 1.1 jruoho
372 1.1 jruoho *Result = 0;
373 1.1 jruoho
374 1.1 jruoho if (Info->FullyQualified)
375 1.1 jruoho {
376 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Returning [%p] (abs) \"\\%s\"\n",
377 1.1 jruoho InternalName, InternalName));
378 1.1 jruoho }
379 1.1 jruoho else
380 1.1 jruoho {
381 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Returning [%p] (rel) \"%s\"\n",
382 1.1 jruoho InternalName, InternalName));
383 1.1 jruoho }
384 1.1 jruoho
385 1.1 jruoho return_ACPI_STATUS (AE_OK);
386 1.1 jruoho }
387 1.1 jruoho
388 1.1 jruoho
389 1.1 jruoho /*******************************************************************************
390 1.1 jruoho *
391 1.1 jruoho * FUNCTION: AcpiNsInternalizeName
392 1.1 jruoho *
393 1.1 jruoho * PARAMETERS: *ExternalName - External representation of name
394 1.1 jruoho * **Converted Name - Where to return the resulting
395 1.1 jruoho * internal represention of the name
396 1.1 jruoho *
397 1.1 jruoho * RETURN: Status
398 1.1 jruoho *
399 1.1 jruoho * DESCRIPTION: Convert an external representation (e.g. "\_PR_.CPU0")
400 1.1 jruoho * to internal form (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30)
401 1.1 jruoho *
402 1.1 jruoho *******************************************************************************/
403 1.1 jruoho
404 1.1 jruoho ACPI_STATUS
405 1.1 jruoho AcpiNsInternalizeName (
406 1.1 jruoho const char *ExternalName,
407 1.1 jruoho char **ConvertedName)
408 1.1 jruoho {
409 1.1 jruoho char *InternalName;
410 1.1 jruoho ACPI_NAMESTRING_INFO Info;
411 1.1 jruoho ACPI_STATUS Status;
412 1.1 jruoho
413 1.1 jruoho
414 1.1 jruoho ACPI_FUNCTION_TRACE (NsInternalizeName);
415 1.1 jruoho
416 1.1 jruoho
417 1.1 jruoho if ((!ExternalName) ||
418 1.1 jruoho (*ExternalName == 0) ||
419 1.1 jruoho (!ConvertedName))
420 1.1 jruoho {
421 1.1 jruoho return_ACPI_STATUS (AE_BAD_PARAMETER);
422 1.1 jruoho }
423 1.1 jruoho
424 1.1 jruoho /* Get the length of the new internal name */
425 1.1 jruoho
426 1.1 jruoho Info.ExternalName = ExternalName;
427 1.1 jruoho AcpiNsGetInternalNameLength (&Info);
428 1.1 jruoho
429 1.1 jruoho /* We need a segment to store the internal name */
430 1.1 jruoho
431 1.1 jruoho InternalName = ACPI_ALLOCATE_ZEROED (Info.Length);
432 1.1 jruoho if (!InternalName)
433 1.1 jruoho {
434 1.1 jruoho return_ACPI_STATUS (AE_NO_MEMORY);
435 1.1 jruoho }
436 1.1 jruoho
437 1.1 jruoho /* Build the name */
438 1.1 jruoho
439 1.1 jruoho Info.InternalName = InternalName;
440 1.1 jruoho Status = AcpiNsBuildInternalName (&Info);
441 1.1 jruoho if (ACPI_FAILURE (Status))
442 1.1 jruoho {
443 1.1 jruoho ACPI_FREE (InternalName);
444 1.1 jruoho return_ACPI_STATUS (Status);
445 1.1 jruoho }
446 1.1 jruoho
447 1.1 jruoho *ConvertedName = InternalName;
448 1.1 jruoho return_ACPI_STATUS (AE_OK);
449 1.1 jruoho }
450 1.1 jruoho
451 1.1 jruoho
452 1.1 jruoho /*******************************************************************************
453 1.1 jruoho *
454 1.1 jruoho * FUNCTION: AcpiNsExternalizeName
455 1.1 jruoho *
456 1.1.1.13 christos * PARAMETERS: InternalNameLength - Length of the internal name below
457 1.1 jruoho * InternalName - Internal representation of name
458 1.1 jruoho * ConvertedNameLength - Where the length is returned
459 1.1 jruoho * ConvertedName - Where the resulting external name
460 1.1 jruoho * is returned
461 1.1 jruoho *
462 1.1 jruoho * RETURN: Status
463 1.1 jruoho *
464 1.1 jruoho * DESCRIPTION: Convert internal name (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30)
465 1.1 jruoho * to its external (printable) form (e.g. "\_PR_.CPU0")
466 1.1 jruoho *
467 1.1 jruoho ******************************************************************************/
468 1.1 jruoho
469 1.1 jruoho ACPI_STATUS
470 1.1 jruoho AcpiNsExternalizeName (
471 1.1 jruoho UINT32 InternalNameLength,
472 1.1 jruoho const char *InternalName,
473 1.1 jruoho UINT32 *ConvertedNameLength,
474 1.1 jruoho char **ConvertedName)
475 1.1 jruoho {
476 1.1 jruoho UINT32 NamesIndex = 0;
477 1.1 jruoho UINT32 NumSegments = 0;
478 1.1 jruoho UINT32 RequiredLength;
479 1.1 jruoho UINT32 PrefixLength = 0;
480 1.1 jruoho UINT32 i = 0;
481 1.1 jruoho UINT32 j = 0;
482 1.1 jruoho
483 1.1 jruoho
484 1.1 jruoho ACPI_FUNCTION_TRACE (NsExternalizeName);
485 1.1 jruoho
486 1.1 jruoho
487 1.1 jruoho if (!InternalNameLength ||
488 1.1 jruoho !InternalName ||
489 1.1 jruoho !ConvertedName)
490 1.1 jruoho {
491 1.1 jruoho return_ACPI_STATUS (AE_BAD_PARAMETER);
492 1.1 jruoho }
493 1.1 jruoho
494 1.1 jruoho /* Check for a prefix (one '\' | one or more '^') */
495 1.1 jruoho
496 1.1 jruoho switch (InternalName[0])
497 1.1 jruoho {
498 1.1.1.3 christos case AML_ROOT_PREFIX:
499 1.1.1.3 christos
500 1.1 jruoho PrefixLength = 1;
501 1.1 jruoho break;
502 1.1 jruoho
503 1.1.1.3 christos case AML_PARENT_PREFIX:
504 1.1.1.3 christos
505 1.1 jruoho for (i = 0; i < InternalNameLength; i++)
506 1.1 jruoho {
507 1.1.1.3 christos if (ACPI_IS_PARENT_PREFIX (InternalName[i]))
508 1.1 jruoho {
509 1.1 jruoho PrefixLength = i + 1;
510 1.1 jruoho }
511 1.1 jruoho else
512 1.1 jruoho {
513 1.1 jruoho break;
514 1.1 jruoho }
515 1.1 jruoho }
516 1.1 jruoho
517 1.1 jruoho if (i == InternalNameLength)
518 1.1 jruoho {
519 1.1 jruoho PrefixLength = i;
520 1.1 jruoho }
521 1.1 jruoho
522 1.1 jruoho break;
523 1.1 jruoho
524 1.1 jruoho default:
525 1.1.1.3 christos
526 1.1 jruoho break;
527 1.1 jruoho }
528 1.1 jruoho
529 1.1 jruoho /*
530 1.1 jruoho * Check for object names. Note that there could be 0-255 of these
531 1.1 jruoho * 4-byte elements.
532 1.1 jruoho */
533 1.1 jruoho if (PrefixLength < InternalNameLength)
534 1.1 jruoho {
535 1.1 jruoho switch (InternalName[PrefixLength])
536 1.1 jruoho {
537 1.1.1.10 christos case AML_MULTI_NAME_PREFIX:
538 1.1 jruoho
539 1.1 jruoho /* <count> 4-byte names */
540 1.1 jruoho
541 1.1 jruoho NamesIndex = PrefixLength + 2;
542 1.1 jruoho NumSegments = (UINT8)
543 1.1 jruoho InternalName[(ACPI_SIZE) PrefixLength + 1];
544 1.1 jruoho break;
545 1.1 jruoho
546 1.1 jruoho case AML_DUAL_NAME_PREFIX:
547 1.1 jruoho
548 1.1 jruoho /* Two 4-byte names */
549 1.1 jruoho
550 1.1 jruoho NamesIndex = PrefixLength + 1;
551 1.1 jruoho NumSegments = 2;
552 1.1 jruoho break;
553 1.1 jruoho
554 1.1 jruoho case 0:
555 1.1 jruoho
556 1.1 jruoho /* NullName */
557 1.1 jruoho
558 1.1 jruoho NamesIndex = 0;
559 1.1 jruoho NumSegments = 0;
560 1.1 jruoho break;
561 1.1 jruoho
562 1.1 jruoho default:
563 1.1 jruoho
564 1.1 jruoho /* one 4-byte name */
565 1.1 jruoho
566 1.1 jruoho NamesIndex = PrefixLength;
567 1.1 jruoho NumSegments = 1;
568 1.1 jruoho break;
569 1.1 jruoho }
570 1.1 jruoho }
571 1.1 jruoho
572 1.1 jruoho /*
573 1.1 jruoho * Calculate the length of ConvertedName, which equals the length
574 1.1 jruoho * of the prefix, length of all object names, length of any required
575 1.1 jruoho * punctuation ('.') between object names, plus the NULL terminator.
576 1.1 jruoho */
577 1.1 jruoho RequiredLength = PrefixLength + (4 * NumSegments) +
578 1.1.1.7 christos ((NumSegments > 0) ? (NumSegments - 1) : 0) + 1;
579 1.1 jruoho
580 1.1 jruoho /*
581 1.1.1.3 christos * Check to see if we're still in bounds. If not, there's a problem
582 1.1 jruoho * with InternalName (invalid format).
583 1.1 jruoho */
584 1.1 jruoho if (RequiredLength > InternalNameLength)
585 1.1 jruoho {
586 1.1 jruoho ACPI_ERROR ((AE_INFO, "Invalid internal name"));
587 1.1 jruoho return_ACPI_STATUS (AE_BAD_PATHNAME);
588 1.1 jruoho }
589 1.1 jruoho
590 1.1 jruoho /* Build the ConvertedName */
591 1.1 jruoho
592 1.1 jruoho *ConvertedName = ACPI_ALLOCATE_ZEROED (RequiredLength);
593 1.1 jruoho if (!(*ConvertedName))
594 1.1 jruoho {
595 1.1 jruoho return_ACPI_STATUS (AE_NO_MEMORY);
596 1.1 jruoho }
597 1.1 jruoho
598 1.1 jruoho j = 0;
599 1.1 jruoho
600 1.1 jruoho for (i = 0; i < PrefixLength; i++)
601 1.1 jruoho {
602 1.1 jruoho (*ConvertedName)[j++] = InternalName[i];
603 1.1 jruoho }
604 1.1 jruoho
605 1.1 jruoho if (NumSegments > 0)
606 1.1 jruoho {
607 1.1 jruoho for (i = 0; i < NumSegments; i++)
608 1.1 jruoho {
609 1.1 jruoho if (i > 0)
610 1.1 jruoho {
611 1.1 jruoho (*ConvertedName)[j++] = '.';
612 1.1 jruoho }
613 1.1 jruoho
614 1.1.1.3 christos /* Copy and validate the 4-char name segment */
615 1.1.1.3 christos
616 1.1.1.13 christos ACPI_COPY_NAMESEG (&(*ConvertedName)[j],
617 1.1.1.7 christos &InternalName[NamesIndex]);
618 1.1.1.3 christos AcpiUtRepairName (&(*ConvertedName)[j]);
619 1.1.1.3 christos
620 1.1.1.13 christos j += ACPI_NAMESEG_SIZE;
621 1.1.1.13 christos NamesIndex += ACPI_NAMESEG_SIZE;
622 1.1 jruoho }
623 1.1 jruoho }
624 1.1 jruoho
625 1.1 jruoho if (ConvertedNameLength)
626 1.1 jruoho {
627 1.1 jruoho *ConvertedNameLength = (UINT32) RequiredLength;
628 1.1 jruoho }
629 1.1 jruoho
630 1.1 jruoho return_ACPI_STATUS (AE_OK);
631 1.1 jruoho }
632 1.1 jruoho
633 1.1 jruoho
634 1.1 jruoho /*******************************************************************************
635 1.1 jruoho *
636 1.1 jruoho * FUNCTION: AcpiNsValidateHandle
637 1.1 jruoho *
638 1.1 jruoho * PARAMETERS: Handle - Handle to be validated and typecast to a
639 1.1 jruoho * namespace node.
640 1.1 jruoho *
641 1.1 jruoho * RETURN: A pointer to a namespace node
642 1.1 jruoho *
643 1.1 jruoho * DESCRIPTION: Convert a namespace handle to a namespace node. Handles special
644 1.1 jruoho * cases for the root node.
645 1.1 jruoho *
646 1.1 jruoho * NOTE: Real integer handles would allow for more verification
647 1.1 jruoho * and keep all pointers within this subsystem - however this introduces
648 1.1 jruoho * more overhead and has not been necessary to this point. Drivers
649 1.1 jruoho * holding handles are typically notified before a node becomes invalid
650 1.1 jruoho * due to a table unload.
651 1.1 jruoho *
652 1.1 jruoho ******************************************************************************/
653 1.1 jruoho
654 1.1 jruoho ACPI_NAMESPACE_NODE *
655 1.1 jruoho AcpiNsValidateHandle (
656 1.1 jruoho ACPI_HANDLE Handle)
657 1.1 jruoho {
658 1.1 jruoho
659 1.1 jruoho ACPI_FUNCTION_ENTRY ();
660 1.1 jruoho
661 1.1 jruoho
662 1.1 jruoho /* Parameter validation */
663 1.1 jruoho
664 1.1 jruoho if ((!Handle) || (Handle == ACPI_ROOT_OBJECT))
665 1.1 jruoho {
666 1.1 jruoho return (AcpiGbl_RootNode);
667 1.1 jruoho }
668 1.1 jruoho
669 1.1 jruoho /* We can at least attempt to verify the handle */
670 1.1 jruoho
671 1.1 jruoho if (ACPI_GET_DESCRIPTOR_TYPE (Handle) != ACPI_DESC_TYPE_NAMED)
672 1.1 jruoho {
673 1.1 jruoho return (NULL);
674 1.1 jruoho }
675 1.1 jruoho
676 1.1 jruoho return (ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Handle));
677 1.1 jruoho }
678 1.1 jruoho
679 1.1 jruoho
680 1.1 jruoho /*******************************************************************************
681 1.1 jruoho *
682 1.1 jruoho * FUNCTION: AcpiNsTerminate
683 1.1 jruoho *
684 1.1 jruoho * PARAMETERS: none
685 1.1 jruoho *
686 1.1 jruoho * RETURN: none
687 1.1 jruoho *
688 1.1 jruoho * DESCRIPTION: free memory allocated for namespace and ACPI table storage.
689 1.1 jruoho *
690 1.1 jruoho ******************************************************************************/
691 1.1 jruoho
692 1.1 jruoho void
693 1.1 jruoho AcpiNsTerminate (
694 1.1 jruoho void)
695 1.1 jruoho {
696 1.1.1.3 christos ACPI_STATUS Status;
697 1.1.1.10 christos ACPI_OPERAND_OBJECT *Prev;
698 1.1.1.10 christos ACPI_OPERAND_OBJECT *Next;
699 1.1 jruoho
700 1.1 jruoho
701 1.1 jruoho ACPI_FUNCTION_TRACE (NsTerminate);
702 1.1 jruoho
703 1.1 jruoho
704 1.1.1.10 christos /* Delete any module-level code blocks */
705 1.1.1.7 christos
706 1.1.1.10 christos Next = AcpiGbl_ModuleCodeList;
707 1.1.1.10 christos while (Next)
708 1.1.1.10 christos {
709 1.1.1.10 christos Prev = Next;
710 1.1.1.10 christos Next = Next->Method.Mutex;
711 1.1.1.10 christos Prev->Method.Mutex = NULL; /* Clear the Mutex (cheated) field */
712 1.1.1.10 christos AcpiUtRemoveReference (Prev);
713 1.1.1.7 christos }
714 1.1.1.7 christos
715 1.1 jruoho /*
716 1.1.1.3 christos * Free the entire namespace -- all nodes and all objects
717 1.1.1.3 christos * attached to the nodes
718 1.1 jruoho */
719 1.1 jruoho AcpiNsDeleteNamespaceSubtree (AcpiGbl_RootNode);
720 1.1 jruoho
721 1.1.1.3 christos /* Delete any objects attached to the root node */
722 1.1 jruoho
723 1.1.1.3 christos Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
724 1.1.1.3 christos if (ACPI_FAILURE (Status))
725 1.1 jruoho {
726 1.1.1.3 christos return_VOID;
727 1.1 jruoho }
728 1.1 jruoho
729 1.1.1.3 christos AcpiNsDeleteNode (AcpiGbl_RootNode);
730 1.1.1.3 christos (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
731 1.1.1.3 christos
732 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Namespace freed\n"));
733 1.1 jruoho return_VOID;
734 1.1 jruoho }
735 1.1 jruoho
736 1.1 jruoho
737 1.1 jruoho /*******************************************************************************
738 1.1 jruoho *
739 1.1 jruoho * FUNCTION: AcpiNsOpensScope
740 1.1 jruoho *
741 1.1 jruoho * PARAMETERS: Type - A valid namespace type
742 1.1 jruoho *
743 1.1 jruoho * RETURN: NEWSCOPE if the passed type "opens a name scope" according
744 1.1 jruoho * to the ACPI specification, else 0
745 1.1 jruoho *
746 1.1 jruoho ******************************************************************************/
747 1.1 jruoho
748 1.1 jruoho UINT32
749 1.1 jruoho AcpiNsOpensScope (
750 1.1 jruoho ACPI_OBJECT_TYPE Type)
751 1.1 jruoho {
752 1.1.1.3 christos ACPI_FUNCTION_ENTRY ();
753 1.1 jruoho
754 1.1 jruoho
755 1.1.1.3 christos if (Type > ACPI_TYPE_LOCAL_MAX)
756 1.1 jruoho {
757 1.1 jruoho /* type code out of range */
758 1.1 jruoho
759 1.1 jruoho ACPI_WARNING ((AE_INFO, "Invalid Object Type 0x%X", Type));
760 1.1.1.3 christos return (ACPI_NS_NORMAL);
761 1.1 jruoho }
762 1.1 jruoho
763 1.1.1.3 christos return (((UINT32) AcpiGbl_NsProperties[Type]) & ACPI_NS_NEWSCOPE);
764 1.1 jruoho }
765 1.1 jruoho
766 1.1 jruoho
767 1.1 jruoho /*******************************************************************************
768 1.1 jruoho *
769 1.1.1.8 christos * FUNCTION: AcpiNsGetNodeUnlocked
770 1.1 jruoho *
771 1.1 jruoho * PARAMETERS: *Pathname - Name to be found, in external (ASL) format. The
772 1.1 jruoho * \ (backslash) and ^ (carat) prefixes, and the
773 1.1 jruoho * . (period) to separate segments are supported.
774 1.1 jruoho * PrefixNode - Root of subtree to be searched, or NS_ALL for the
775 1.1.1.3 christos * root of the name space. If Name is fully
776 1.1 jruoho * qualified (first INT8 is '\'), the passed value
777 1.1 jruoho * of Scope will not be accessed.
778 1.1 jruoho * Flags - Used to indicate whether to perform upsearch or
779 1.1 jruoho * not.
780 1.1 jruoho * ReturnNode - Where the Node is returned
781 1.1 jruoho *
782 1.1 jruoho * DESCRIPTION: Look up a name relative to a given scope and return the
783 1.1.1.3 christos * corresponding Node. NOTE: Scope can be null.
784 1.1 jruoho *
785 1.1.1.8 christos * MUTEX: Doesn't locks namespace
786 1.1 jruoho *
787 1.1 jruoho ******************************************************************************/
788 1.1 jruoho
789 1.1 jruoho ACPI_STATUS
790 1.1.1.8 christos AcpiNsGetNodeUnlocked (
791 1.1 jruoho ACPI_NAMESPACE_NODE *PrefixNode,
792 1.1 jruoho const char *Pathname,
793 1.1 jruoho UINT32 Flags,
794 1.1 jruoho ACPI_NAMESPACE_NODE **ReturnNode)
795 1.1 jruoho {
796 1.1 jruoho ACPI_GENERIC_STATE ScopeInfo;
797 1.1 jruoho ACPI_STATUS Status;
798 1.1 jruoho char *InternalPath;
799 1.1 jruoho
800 1.1 jruoho
801 1.1.1.8 christos ACPI_FUNCTION_TRACE_PTR (NsGetNodeUnlocked, ACPI_CAST_PTR (char, Pathname));
802 1.1 jruoho
803 1.1 jruoho
804 1.1.1.3 christos /* Simplest case is a null pathname */
805 1.1.1.3 christos
806 1.1 jruoho if (!Pathname)
807 1.1 jruoho {
808 1.1 jruoho *ReturnNode = PrefixNode;
809 1.1 jruoho if (!PrefixNode)
810 1.1 jruoho {
811 1.1 jruoho *ReturnNode = AcpiGbl_RootNode;
812 1.1 jruoho }
813 1.1.1.7 christos
814 1.1 jruoho return_ACPI_STATUS (AE_OK);
815 1.1 jruoho }
816 1.1 jruoho
817 1.1.1.3 christos /* Quick check for a reference to the root */
818 1.1.1.3 christos
819 1.1.1.3 christos if (ACPI_IS_ROOT_PREFIX (Pathname[0]) && (!Pathname[1]))
820 1.1.1.3 christos {
821 1.1.1.3 christos *ReturnNode = AcpiGbl_RootNode;
822 1.1.1.3 christos return_ACPI_STATUS (AE_OK);
823 1.1.1.3 christos }
824 1.1.1.3 christos
825 1.1 jruoho /* Convert path to internal representation */
826 1.1 jruoho
827 1.1 jruoho Status = AcpiNsInternalizeName (Pathname, &InternalPath);
828 1.1 jruoho if (ACPI_FAILURE (Status))
829 1.1 jruoho {
830 1.1 jruoho return_ACPI_STATUS (Status);
831 1.1 jruoho }
832 1.1 jruoho
833 1.1 jruoho /* Setup lookup scope (search starting point) */
834 1.1 jruoho
835 1.1 jruoho ScopeInfo.Scope.Node = PrefixNode;
836 1.1 jruoho
837 1.1 jruoho /* Lookup the name in the namespace */
838 1.1 jruoho
839 1.1 jruoho Status = AcpiNsLookup (&ScopeInfo, InternalPath, ACPI_TYPE_ANY,
840 1.1.1.7 christos ACPI_IMODE_EXECUTE, (Flags | ACPI_NS_DONT_OPEN_SCOPE),
841 1.1.1.7 christos NULL, ReturnNode);
842 1.1 jruoho if (ACPI_FAILURE (Status))
843 1.1 jruoho {
844 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "%s, %s\n",
845 1.1.1.7 christos Pathname, AcpiFormatException (Status)));
846 1.1 jruoho }
847 1.1 jruoho
848 1.1 jruoho ACPI_FREE (InternalPath);
849 1.1 jruoho return_ACPI_STATUS (Status);
850 1.1 jruoho }
851 1.1.1.8 christos
852 1.1.1.8 christos
853 1.1.1.8 christos /*******************************************************************************
854 1.1.1.8 christos *
855 1.1.1.8 christos * FUNCTION: AcpiNsGetNode
856 1.1.1.8 christos *
857 1.1.1.8 christos * PARAMETERS: *Pathname - Name to be found, in external (ASL) format. The
858 1.1.1.8 christos * \ (backslash) and ^ (carat) prefixes, and the
859 1.1.1.8 christos * . (period) to separate segments are supported.
860 1.1.1.8 christos * PrefixNode - Root of subtree to be searched, or NS_ALL for the
861 1.1.1.8 christos * root of the name space. If Name is fully
862 1.1.1.8 christos * qualified (first INT8 is '\'), the passed value
863 1.1.1.8 christos * of Scope will not be accessed.
864 1.1.1.8 christos * Flags - Used to indicate whether to perform upsearch or
865 1.1.1.8 christos * not.
866 1.1.1.8 christos * ReturnNode - Where the Node is returned
867 1.1.1.8 christos *
868 1.1.1.8 christos * DESCRIPTION: Look up a name relative to a given scope and return the
869 1.1.1.8 christos * corresponding Node. NOTE: Scope can be null.
870 1.1.1.8 christos *
871 1.1.1.8 christos * MUTEX: Locks namespace
872 1.1.1.8 christos *
873 1.1.1.8 christos ******************************************************************************/
874 1.1.1.8 christos
875 1.1.1.8 christos ACPI_STATUS
876 1.1.1.8 christos AcpiNsGetNode (
877 1.1.1.8 christos ACPI_NAMESPACE_NODE *PrefixNode,
878 1.1.1.8 christos const char *Pathname,
879 1.1.1.8 christos UINT32 Flags,
880 1.1.1.8 christos ACPI_NAMESPACE_NODE **ReturnNode)
881 1.1.1.8 christos {
882 1.1.1.8 christos ACPI_STATUS Status;
883 1.1.1.8 christos
884 1.1.1.8 christos
885 1.1.1.8 christos ACPI_FUNCTION_TRACE_PTR (NsGetNode, ACPI_CAST_PTR (char, Pathname));
886 1.1.1.8 christos
887 1.1.1.8 christos
888 1.1.1.8 christos Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
889 1.1.1.8 christos if (ACPI_FAILURE (Status))
890 1.1.1.8 christos {
891 1.1.1.8 christos return_ACPI_STATUS (Status);
892 1.1.1.8 christos }
893 1.1.1.8 christos
894 1.1.1.8 christos Status = AcpiNsGetNodeUnlocked (PrefixNode, Pathname,
895 1.1.1.8 christos Flags, ReturnNode);
896 1.1.1.8 christos
897 1.1.1.8 christos (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
898 1.1.1.8 christos return_ACPI_STATUS (Status);
899 1.1.1.8 christos }
900