xref: /titanic_51/usr/src/uts/intel/io/acpica/utilities/utids.c (revision 3d5869cc80c26887ee2c78b0f35e58f574e97192)
1 /******************************************************************************
2  *
3  * Module Name: utids - support for device IDs - HID, UID, CID
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights.  You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code.  No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision.  In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change.  Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee.  Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution.  In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government.  In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #define __UTIDS_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acinterp.h"
121 
122 
123 #define _COMPONENT          ACPI_UTILITIES
124         ACPI_MODULE_NAME    ("utids")
125 
126 /* Local prototypes */
127 
128 static void
129 AcpiUtCopyIdString (
130     char                    *Destination,
131     char                    *Source);
132 
133 
134 /*******************************************************************************
135  *
136  * FUNCTION:    AcpiUtCopyIdString
137  *
138  * PARAMETERS:  Destination         - Where to copy the string
139  *              Source              - Source string
140  *
141  * RETURN:      None
142  *
143  * DESCRIPTION: Copies an ID string for the _HID, _CID, and _UID methods.
144  *              Performs removal of a leading asterisk if present -- workaround
145  *              for a known issue on a bunch of machines.
146  *
147  ******************************************************************************/
148 
149 static void
150 AcpiUtCopyIdString (
151     char                    *Destination,
152     char                    *Source)
153 {
154 
155     /*
156      * Workaround for ID strings that have a leading asterisk. This construct
157      * is not allowed by the ACPI specification  (ID strings must be
158      * alphanumeric), but enough existing machines have this embedded in their
159      * ID strings that the following code is useful.
160      */
161     if (*Source == '*')
162     {
163         Source++;
164     }
165 
166     /* Do the actual copy */
167 
168     ACPI_STRCPY (Destination, Source);
169 }
170 
171 
172 /*******************************************************************************
173  *
174  * FUNCTION:    AcpiUtExecute_HID
175  *
176  * PARAMETERS:  DeviceNode          - Node for the device
177  *              ReturnId            - Where the string HID is returned
178  *
179  * RETURN:      Status
180  *
181  * DESCRIPTION: Executes the _HID control method that returns the hardware
182  *              ID of the device. The HID is either an 32-bit encoded EISAID
183  *              Integer or a String. A string is always returned. An EISAID
184  *              is converted to a string.
185  *
186  *              NOTE: Internal function, no parameter validation
187  *
188  ******************************************************************************/
189 
190 ACPI_STATUS
191 AcpiUtExecute_HID (
192     ACPI_NAMESPACE_NODE     *DeviceNode,
193     ACPI_DEVICE_ID          **ReturnId)
194 {
195     ACPI_OPERAND_OBJECT     *ObjDesc;
196     ACPI_DEVICE_ID          *Hid;
197     UINT32                  Length;
198     ACPI_STATUS             Status;
199 
200 
201     ACPI_FUNCTION_TRACE (UtExecute_HID);
202 
203 
204     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__HID,
205                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
206     if (ACPI_FAILURE (Status))
207     {
208         return_ACPI_STATUS (Status);
209     }
210 
211     /* Get the size of the String to be returned, includes null terminator */
212 
213     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
214     {
215         Length = ACPI_EISAID_STRING_SIZE;
216     }
217     else
218     {
219         Length = ObjDesc->String.Length + 1;
220     }
221 
222     /* Allocate a buffer for the HID */
223 
224     Hid = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DEVICE_ID) + (ACPI_SIZE) Length);
225     if (!Hid)
226     {
227         Status = AE_NO_MEMORY;
228         goto Cleanup;
229     }
230 
231     /* Area for the string starts after DEVICE_ID struct */
232 
233     Hid->String = ACPI_ADD_PTR (char, Hid, sizeof (ACPI_DEVICE_ID));
234 
235     /* Convert EISAID to a string or simply copy existing string */
236 
237     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
238     {
239         AcpiExEisaIdToString (Hid->String, ObjDesc->Integer.Value);
240     }
241     else
242     {
243         AcpiUtCopyIdString (Hid->String, ObjDesc->String.Pointer);
244     }
245 
246     Hid->Length = Length;
247     *ReturnId = Hid;
248 
249 
250 Cleanup:
251 
252     /* On exit, we must delete the return object */
253 
254     AcpiUtRemoveReference (ObjDesc);
255     return_ACPI_STATUS (Status);
256 }
257 
258 
259 /*******************************************************************************
260  *
261  * FUNCTION:    AcpiUtExecute_UID
262  *
263  * PARAMETERS:  DeviceNode          - Node for the device
264  *              ReturnId            - Where the string UID is returned
265  *
266  * RETURN:      Status
267  *
268  * DESCRIPTION: Executes the _UID control method that returns the unique
269  *              ID of the device. The UID is either a 64-bit Integer (NOT an
270  *              EISAID) or a string. Always returns a string. A 64-bit integer
271  *              is converted to a decimal string.
272  *
273  *              NOTE: Internal function, no parameter validation
274  *
275  ******************************************************************************/
276 
277 ACPI_STATUS
278 AcpiUtExecute_UID (
279     ACPI_NAMESPACE_NODE     *DeviceNode,
280     ACPI_DEVICE_ID          **ReturnId)
281 {
282     ACPI_OPERAND_OBJECT     *ObjDesc;
283     ACPI_DEVICE_ID          *Uid;
284     UINT32                  Length;
285     ACPI_STATUS             Status;
286 
287 
288     ACPI_FUNCTION_TRACE (UtExecute_UID);
289 
290 
291     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__UID,
292                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING, &ObjDesc);
293     if (ACPI_FAILURE (Status))
294     {
295         return_ACPI_STATUS (Status);
296     }
297 
298     /* Get the size of the String to be returned, includes null terminator */
299 
300     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
301     {
302         Length = ACPI_MAX64_DECIMAL_DIGITS + 1;
303     }
304     else
305     {
306         Length = ObjDesc->String.Length + 1;
307     }
308 
309     /* Allocate a buffer for the UID */
310 
311     Uid = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DEVICE_ID) + (ACPI_SIZE) Length);
312     if (!Uid)
313     {
314         Status = AE_NO_MEMORY;
315         goto Cleanup;
316     }
317 
318     /* Area for the string starts after DEVICE_ID struct */
319 
320     Uid->String = ACPI_ADD_PTR (char, Uid, sizeof (ACPI_DEVICE_ID));
321 
322     /* Convert an Integer to string, or just copy an existing string */
323 
324     if (ObjDesc->Common.Type == ACPI_TYPE_INTEGER)
325     {
326         AcpiExIntegerToString (Uid->String, ObjDesc->Integer.Value);
327     }
328     else
329     {
330         AcpiUtCopyIdString (Uid->String, ObjDesc->String.Pointer);
331     }
332 
333     Uid->Length = Length;
334     *ReturnId = Uid;
335 
336 
337 Cleanup:
338 
339     /* On exit, we must delete the return object */
340 
341     AcpiUtRemoveReference (ObjDesc);
342     return_ACPI_STATUS (Status);
343 }
344 
345 
346 /*******************************************************************************
347  *
348  * FUNCTION:    AcpiUtExecute_CID
349  *
350  * PARAMETERS:  DeviceNode          - Node for the device
351  *              ReturnCidList       - Where the CID list is returned
352  *
353  * RETURN:      Status, list of CID strings
354  *
355  * DESCRIPTION: Executes the _CID control method that returns one or more
356  *              compatible hardware IDs for the device.
357  *
358  *              NOTE: Internal function, no parameter validation
359  *
360  * A _CID method can return either a single compatible ID or a package of
361  * compatible IDs. Each compatible ID can be one of the following:
362  * 1) Integer (32 bit compressed EISA ID) or
363  * 2) String (PCI ID format, e.g. "PCI\VEN_vvvv&DEV_dddd&SUBSYS_ssssssss")
364  *
365  * The Integer CIDs are converted to string format by this function.
366  *
367  ******************************************************************************/
368 
369 ACPI_STATUS
370 AcpiUtExecute_CID (
371     ACPI_NAMESPACE_NODE     *DeviceNode,
372     ACPI_DEVICE_ID_LIST     **ReturnCidList)
373 {
374     ACPI_OPERAND_OBJECT     **CidObjects;
375     ACPI_OPERAND_OBJECT     *ObjDesc;
376     ACPI_DEVICE_ID_LIST     *CidList;
377     char                    *NextIdString;
378     UINT32                  StringAreaSize;
379     UINT32                  Length;
380     UINT32                  CidListSize;
381     ACPI_STATUS             Status;
382     UINT32                  Count;
383     UINT32                  i;
384 
385 
386     ACPI_FUNCTION_TRACE (UtExecute_CID);
387 
388 
389     /* Evaluate the _CID method for this device */
390 
391     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__CID,
392                 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_PACKAGE,
393                 &ObjDesc);
394     if (ACPI_FAILURE (Status))
395     {
396         return_ACPI_STATUS (Status);
397     }
398 
399     /*
400      * Get the count and size of the returned _CIDs. _CID can return either
401      * a Package of Integers/Strings or a single Integer or String.
402      * Note: This section also validates that all CID elements are of the
403      * correct type (Integer or String).
404      */
405     if (ObjDesc->Common.Type == ACPI_TYPE_PACKAGE)
406     {
407         Count = ObjDesc->Package.Count;
408         CidObjects = ObjDesc->Package.Elements;
409     }
410     else /* Single Integer or String CID */
411     {
412         Count = 1;
413         CidObjects = &ObjDesc;
414     }
415 
416     StringAreaSize = 0;
417     for (i = 0; i < Count; i++)
418     {
419         /* String lengths include null terminator */
420 
421         switch (CidObjects[i]->Common.Type)
422         {
423         case ACPI_TYPE_INTEGER:
424             StringAreaSize += ACPI_EISAID_STRING_SIZE;
425             break;
426 
427         case ACPI_TYPE_STRING:
428             StringAreaSize += CidObjects[i]->String.Length + 1;
429             break;
430 
431         default:
432             Status = AE_TYPE;
433             goto Cleanup;
434         }
435     }
436 
437     /*
438      * Now that we know the length of the CIDs, allocate return buffer:
439      * 1) Size of the base structure +
440      * 2) Size of the CID DEVICE_ID array +
441      * 3) Size of the actual CID strings
442      */
443     CidListSize = sizeof (ACPI_DEVICE_ID_LIST) +
444         ((Count - 1) * sizeof (ACPI_DEVICE_ID)) +
445         StringAreaSize;
446 
447     CidList = ACPI_ALLOCATE_ZEROED (CidListSize);
448     if (!CidList)
449     {
450         Status = AE_NO_MEMORY;
451         goto Cleanup;
452     }
453 
454     /* Area for CID strings starts after the CID DEVICE_ID array */
455 
456     NextIdString = ACPI_CAST_PTR (char, CidList->Ids) +
457         ((ACPI_SIZE) Count * sizeof (ACPI_DEVICE_ID));
458 
459     /* Copy/convert the CIDs to the return buffer */
460 
461     for (i = 0; i < Count; i++)
462     {
463         if (CidObjects[i]->Common.Type == ACPI_TYPE_INTEGER)
464         {
465             /* Convert the Integer (EISAID) CID to a string */
466 
467             AcpiExEisaIdToString (NextIdString, CidObjects[i]->Integer.Value);
468             Length = ACPI_EISAID_STRING_SIZE;
469         }
470         else /* ACPI_TYPE_STRING */
471         {
472             /* Copy the String CID from the returned object */
473 
474             AcpiUtCopyIdString (NextIdString, CidObjects[i]->String.Pointer);
475             Length = CidObjects[i]->String.Length + 1;
476         }
477 
478         CidList->Ids[i].String = NextIdString;
479         CidList->Ids[i].Length = Length;
480         NextIdString += Length;
481     }
482 
483     /* Finish the CID list */
484 
485     CidList->Count = Count;
486     CidList->ListSize = CidListSize;
487     *ReturnCidList = CidList;
488 
489 
490 Cleanup:
491 
492     /* On exit, we must delete the _CID return object */
493 
494     AcpiUtRemoveReference (ObjDesc);
495     return_ACPI_STATUS (Status);
496 }
497 
498