xref: /netbsd-src/sys/external/bsd/acpica/dist/common/ahuuids.c (revision 046a29855e04359424fd074e8313af6b6be8cfb6)
1 /******************************************************************************
2  *
3  * Module Name: ahuuids - Table of known ACPI-related UUIDs
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2023, 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 MERCHANTABILITY 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 
44 #include "acpi.h"
45 #include "accommon.h"
46 #include "acuuid.h"
47 
48 #define _COMPONENT          ACPI_UTILITIES
49         ACPI_MODULE_NAME    ("ahuuids")
50 
51 
52 /*
53  * Table of "known" (ACPI-related) UUIDs
54  */
55 const AH_UUID  Gbl_AcpiUuids[] =
56 {
57     {"[Controllers]",               NULL},
58     {"GPIO Controller",             UUID_GPIO_CONTROLLER},
59     {"USB Controller",              UUID_USB_CONTROLLER},
60     {"SATA Controller",             UUID_SATA_CONTROLLER},
61 
62     {"[Devices]",                   NULL},
63     {"PCI Host Bridge Device",      UUID_PCI_HOST_BRIDGE},
64     {"HID I2C Device",              UUID_I2C_DEVICE},
65     {"Power Button Device",         UUID_POWER_BUTTON},
66     {"Memory Device",               UUID_MEMORY_DEVICE},
67     {"Generic Buttons Device",      UUID_GENERIC_BUTTONS_DEVICE},
68     {"NVDIMM Root Device",          UUID_NVDIMM_ROOT_DEVICE},
69     {"Control Method Battery",      UUID_CONTROL_METHOD_BATTERY},
70 
71     {"[Interfaces]",                NULL},
72     {"Device Labeling Interface",   UUID_DEVICE_LABELING},
73     {"Physical Presence Interface", UUID_PHYSICAL_PRESENCE},
74 
75     {"[Non-volatile DIMM and NFIT table]",       NULL},
76     {"NVDIMM Device",               UUID_NFIT_DIMM},
77     {"Volatile Memory Region",      UUID_VOLATILE_MEMORY},
78     {"Persistent Memory Region",    UUID_PERSISTENT_MEMORY},
79     {"NVDIMM Control Region",       UUID_CONTROL_REGION},
80     {"NVDIMM Data Region",          UUID_DATA_REGION},
81     {"Volatile Virtual Disk",       UUID_VOLATILE_VIRTUAL_DISK},
82     {"Volatile Virtual CD",         UUID_VOLATILE_VIRTUAL_CD},
83     {"Persistent Virtual Disk",     UUID_PERSISTENT_VIRTUAL_DISK},
84     {"Persistent Virtual CD",       UUID_PERSISTENT_VIRTUAL_CD},
85     {"Microsoft NVDIMM Command set",UUID_NFIT_DIMM_N_MSFT},
86     {"HP NDIMM HPE1",               UUID_NFIT_DIMM_N_HPE1},
87     {"HP NDIMM HPE2",               UUID_NFIT_DIMM_N_HPE2},
88     {"Virtual NVDIMM",              UUID_NFIT_DIMM_N_HYPERV},
89 
90     {"[Processor Properties]",      NULL},
91     {"Cache Properties",            UUID_CACHE_PROPERTIES},
92     {"Physical Package Property",   UUID_PHYSICAL_PROPERTY},
93 
94     {"[Miscellaneous]",             NULL},
95     {"Platform-wide Capabilities",  UUID_PLATFORM_CAPABILITIES},
96     {"Dynamic Enumeration",         UUID_DYNAMIC_ENUMERATION},
97     {"Battery Thermal Limit",       UUID_BATTERY_THERMAL_LIMIT},
98     {"Thermal Extensions",          UUID_THERMAL_EXTENSIONS},
99     {"Device Properties for _DSD",  UUID_DEVICE_PROPERTIES},
100     {"Device Graphs for _DSD",      UUID_DEVICE_GRAPHS},
101     {"Hierarchical Data Extension", UUID_HIERARCHICAL_DATA_EXTENSION},
102     {"ARM Coresight Graph",         UUID_CORESIGHT_GRAPH},
103     {"USB4 Capabilities",           UUID_USB4_CAPABILITIES},
104     {"First Function ID for _DSM",  UUID_1ST_FUNCTION_ID},
105     {"Second Function ID for _DSM", UUID_2ND_FUNCTION_ID},
106 
107     {NULL, NULL}
108 };
109 
110 
111 /*******************************************************************************
112  *
113  * FUNCTION:    AcpiAhMatchUuid
114  *
115  * PARAMETERS:  Data                - Data buffer containing a UUID
116  *
117  * RETURN:      ASCII description string for the UUID if it is found.
118  *
119  * DESCRIPTION: Returns a description string for "known" UUIDs, which are
120  *              are UUIDs that are related to ACPI in some way.
121  *
122  ******************************************************************************/
123 
124 const char *
AcpiAhMatchUuid(UINT8 * Data)125 AcpiAhMatchUuid (
126     UINT8                   *Data)
127 {
128     const AH_UUID           *Info;
129     UINT8                   UuidBuffer[UUID_BUFFER_LENGTH];
130 
131 
132     /* Walk the table of known ACPI-related UUIDs */
133 
134     for (Info = Gbl_AcpiUuids; Info->Description; Info++)
135     {
136         /* Null string means description is a UUID class */
137 
138         if (!Info->String)
139         {
140             continue;
141         }
142 
143         AcpiUtConvertStringToUuid (Info->String, UuidBuffer);
144 
145         if (!memcmp (Data, UuidBuffer, UUID_BUFFER_LENGTH))
146         {
147             return (Info->Description);
148         }
149     }
150 
151     return (NULL);
152 }
153