xref: /dflybsd-src/sys/contrib/dev/acpica/source/common/ahuuids.c (revision c9c5aa9e08ebfb63a07b7695356c7a5960997175)
1  /******************************************************************************
2   *
3   * Module Name: ahuuids - Table of known ACPI-related UUIDs
4   *
5   *****************************************************************************/
6  
7  /******************************************************************************
8   *
9   * 1. Copyright Notice
10   *
11   * Some or all of this work - Copyright (c) 1999 - 2020, 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   * Alternatively, you may choose to be licensed under the terms of the
117   * following license:
118   *
119   * Redistribution and use in source and binary forms, with or without
120   * modification, are permitted provided that the following conditions
121   * are met:
122   * 1. Redistributions of source code must retain the above copyright
123   *    notice, this list of conditions, and the following disclaimer,
124   *    without modification.
125   * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126   *    substantially similar to the "NO WARRANTY" disclaimer below
127   *    ("Disclaimer") and any redistribution must be conditioned upon
128   *    including a substantially similar Disclaimer requirement for further
129   *    binary redistribution.
130   * 3. Neither the names of the above-listed copyright holders nor the names
131   *    of any contributors may be used to endorse or promote products derived
132   *    from this software without specific prior written permission.
133   *
134   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145   *
146   * Alternatively, you may choose to be licensed under the terms of the
147   * GNU General Public License ("GPL") version 2 as published by the Free
148   * Software Foundation.
149   *
150   *****************************************************************************/
151  
152  #include "acpi.h"
153  #include "accommon.h"
154  #include "acuuid.h"
155  
156  #define _COMPONENT          ACPI_UTILITIES
157          ACPI_MODULE_NAME    ("ahuuids")
158  
159  
160  /*
161   * Table of "known" (ACPI-related) UUIDs
162   */
163  const AH_UUID  Gbl_AcpiUuids[] =
164  {
165      {"[Controllers]",               NULL},
166      {"GPIO Controller",             UUID_GPIO_CONTROLLER},
167      {"USB Controller",              UUID_USB_CONTROLLER},
168      {"SATA Controller",             UUID_SATA_CONTROLLER},
169  
170      {"[Devices]",                   NULL},
171      {"PCI Host Bridge Device",      UUID_PCI_HOST_BRIDGE},
172      {"HID I2C Device",              UUID_I2C_DEVICE},
173      {"Power Button Device",         UUID_POWER_BUTTON},
174      {"Memory Device",               UUID_MEMORY_DEVICE},
175      {"Generic Buttons Device",      UUID_GENERIC_BUTTONS_DEVICE},
176      {"NVDIMM Root Device",          UUID_NVDIMM_ROOT_DEVICE},
177      {"Control Method Battery",      UUID_CONTROL_METHOD_BATTERY},
178  
179      {"[Interfaces]",                NULL},
180      {"Device Labeling Interface",   UUID_DEVICE_LABELING},
181      {"Physical Presence Interface", UUID_PHYSICAL_PRESENCE},
182  
183      {"[Non-volatile DIMM and NFIT table]",       NULL},
184      {"NVDIMM Device",               UUID_NFIT_DIMM},
185      {"Volatile Memory Region",      UUID_VOLATILE_MEMORY},
186      {"Persistent Memory Region",    UUID_PERSISTENT_MEMORY},
187      {"NVDIMM Control Region",       UUID_CONTROL_REGION},
188      {"NVDIMM Data Region",          UUID_DATA_REGION},
189      {"Volatile Virtual Disk",       UUID_VOLATILE_VIRTUAL_DISK},
190      {"Volatile Virtual CD",         UUID_VOLATILE_VIRTUAL_CD},
191      {"Persistent Virtual Disk",     UUID_PERSISTENT_VIRTUAL_DISK},
192      {"Persistent Virtual CD",       UUID_PERSISTENT_VIRTUAL_CD},
193      {"Microsoft NVDIMM Command set",UUID_NFIT_DIMM_N_MSFT},
194      {"HP NDIMM HPE1",               UUID_NFIT_DIMM_N_HPE1},
195      {"HP NDIMM HPE2",               UUID_NFIT_DIMM_N_HPE2},
196      {"Virtual NVDIMM",              UUID_NFIT_DIMM_N_HYPERV},
197  
198      {"[Processor Properties]",      NULL},
199      {"Cache Properties",            UUID_CACHE_PROPERTIES},
200      {"Physical Package Property",   UUID_PHYSICAL_PROPERTY},
201  
202      {"[Miscellaneous]",             NULL},
203      {"Platform-wide Capabilities",  UUID_PLATFORM_CAPABILITIES},
204      {"Dynamic Enumeration",         UUID_DYNAMIC_ENUMERATION},
205      {"Battery Thermal Limit",       UUID_BATTERY_THERMAL_LIMIT},
206      {"Thermal Extensions",          UUID_THERMAL_EXTENSIONS},
207      {"Device Properties for _DSD",  UUID_DEVICE_PROPERTIES},
208      {"Device Graphs for _DSD",      UUID_DEVICE_GRAPHS},
209      {"Hierarchical Data Extension", UUID_HIERARCHICAL_DATA_EXTENSION},
210      {"ARM Coresight Graph",         UUID_CORESIGHT_GRAPH},
211      {NULL, NULL}
212  };
213  
214  
215  /*******************************************************************************
216   *
217   * FUNCTION:    AcpiAhMatchUuid
218   *
219   * PARAMETERS:  Data                - Data buffer containing a UUID
220   *
221   * RETURN:      ASCII description string for the UUID if it is found.
222   *
223   * DESCRIPTION: Returns a description string for "known" UUIDs, which are
224   *              are UUIDs that are related to ACPI in some way.
225   *
226   ******************************************************************************/
227  
228  const char *
229  AcpiAhMatchUuid (
230      UINT8                   *Data)
231  {
232      const AH_UUID           *Info;
233      UINT8                   UuidBuffer[UUID_BUFFER_LENGTH];
234  
235  
236      /* Walk the table of known ACPI-related UUIDs */
237  
238      for (Info = Gbl_AcpiUuids; Info->Description; Info++)
239      {
240          /* Null string means description is a UUID class */
241  
242          if (!Info->String)
243          {
244              continue;
245          }
246  
247          AcpiUtConvertStringToUuid (Info->String, UuidBuffer);
248  
249          if (!memcmp (Data, UuidBuffer, UUID_BUFFER_LENGTH))
250          {
251              return (Info->Description);
252          }
253      }
254  
255      return (NULL);
256  }
257