Sync ACPICA with Intel's version 20180810:
[dragonfly.git] / sys / contrib / dev / acpica / source / tools / acpiexec / aeinitfile.c
blob79b797e094bcd4db0625d8c3439ff2a17703c2e5
1 /******************************************************************************
3 * Module Name: aeinitfile - Support for optional initialization file
5 *****************************************************************************/
7 /******************************************************************************
9 * 1. Copyright Notice
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
14 * 2. License
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.
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
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;
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
40 * 3. Conditions
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.
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.
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.
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
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.
80 * 4. Disclaimer and Export Compliance
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.
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.
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
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.
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.
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.
150 *****************************************************************************/
152 #include "aecommon.h"
153 #include "acdispat.h"
155 #define _COMPONENT ACPI_TOOLS
156 ACPI_MODULE_NAME ("aeinitfile")
159 /* Local prototypes */
161 static void
162 AeEnterInitFileEntry (
163 INIT_FILE_ENTRY InitEntry,
164 ACPI_WALK_STATE *WalkState);
167 #define AE_FILE_BUFFER_SIZE 512
169 static char LineBuffer[AE_FILE_BUFFER_SIZE];
170 static char NameBuffer[AE_FILE_BUFFER_SIZE];
171 static char ValueBuffer[AE_FILE_BUFFER_SIZE];
172 static FILE *InitFile;
175 /******************************************************************************
177 * FUNCTION: AeOpenInitializationFile
179 * PARAMETERS: Filename - Path to the init file
181 * RETURN: Status
183 * DESCRIPTION: Open the initialization file for the -fi option
185 *****************************************************************************/
188 AeOpenInitializationFile (
189 char *Filename)
192 InitFile = fopen (Filename, "r");
193 if (!InitFile)
195 fprintf (stderr,
196 "Could not open initialization file: %s\n", Filename);
197 return (-1);
200 AcpiOsPrintf ("Opened initialization file [%s]\n", Filename);
201 return (0);
205 /******************************************************************************
207 * FUNCTION: AeProcessInitFile
209 * PARAMETERS: None
211 * RETURN: None
213 * DESCRIPTION: Read the initialization file and perform all namespace
214 * initializations. AcpiGbl_InitEntries will be used for region
215 * field initialization.
217 * NOTE: The format of the file is multiple lines, each of format:
218 * <ACPI-pathname> <Integer Value>
220 *****************************************************************************/
222 void
223 AeProcessInitFile(
224 void)
226 ACPI_WALK_STATE *WalkState;
227 int i;
228 UINT64 idx;
229 ACPI_STATUS Status;
232 if (!InitFile)
234 return;
237 /* Create needed objects to be reused for each init entry */
239 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
240 NameBuffer[0] = '\\';
242 while (fgets (LineBuffer, AE_FILE_BUFFER_SIZE, InitFile) != NULL)
244 ++AcpiGbl_InitFileLineCount;
246 rewind (InitFile);
248 AcpiGbl_InitEntries =
249 AcpiOsAllocate (sizeof (INIT_FILE_ENTRY) * AcpiGbl_InitFileLineCount);
250 for (idx = 0; fgets (LineBuffer, AE_FILE_BUFFER_SIZE, InitFile); ++idx)
252 if (sscanf (LineBuffer, "%s %s\n",
253 &NameBuffer[1], ValueBuffer) != 2)
255 goto CleanupAndExit;
258 /* Add a root prefix if not present in the string */
260 i = 0;
261 if (NameBuffer[1] == '\\')
263 i = 1;
266 AcpiGbl_InitEntries[idx].Name =
267 AcpiOsAllocateZeroed (strnlen (NameBuffer + i, AE_FILE_BUFFER_SIZE) + 1);
269 strcpy (AcpiGbl_InitEntries[idx].Name, NameBuffer + i);
271 Status = AcpiUtStrtoul64 (ValueBuffer, &AcpiGbl_InitEntries[idx].Value);
272 if (ACPI_FAILURE (Status))
274 AcpiOsPrintf ("%s %s\n", ValueBuffer,
275 AcpiFormatException (Status));
276 goto CleanupAndExit;
279 AeEnterInitFileEntry (AcpiGbl_InitEntries[idx], WalkState);
282 /* Cleanup */
284 CleanupAndExit:
285 fclose (InitFile);
286 AcpiDsDeleteWalkState (WalkState);
290 /******************************************************************************
292 * FUNCTION: AeInitFileEntry
294 * PARAMETERS: InitEntry - Entry of the init file
295 * WalkState - Used for the Store operation
297 * RETURN: None
299 * DESCRIPTION: Perform initialization of a single namespace object
301 * Note: namespace of objects are limited to integers and region
302 * fields units of 8 bytes at this time.
304 *****************************************************************************/
306 static void
307 AeEnterInitFileEntry (
308 INIT_FILE_ENTRY InitEntry,
309 ACPI_WALK_STATE *WalkState)
311 char *Pathname = InitEntry.Name;
312 UINT64 Value = InitEntry.Value;
313 ACPI_OPERAND_OBJECT *ObjDesc;
314 ACPI_NAMESPACE_NODE *NewNode;
315 ACPI_STATUS Status;
318 AcpiOsPrintf ("Initializing namespace element: %s\n", Pathname);
319 Status = AcpiNsLookup (NULL, Pathname, ACPI_TYPE_INTEGER,
320 ACPI_IMODE_LOAD_PASS2, ACPI_NS_ERROR_IF_FOUND | ACPI_NS_NO_UPSEARCH |
321 ACPI_NS_EARLY_INIT, NULL, &NewNode);
322 if (ACPI_FAILURE (Status))
324 ACPI_EXCEPTION ((AE_INFO, Status,
325 "While creating name from namespace initialization file: %s",
326 Pathname));
327 return;
330 ObjDesc = AcpiUtCreateIntegerObject (Value);
332 AcpiOsPrintf ("New value: 0x%8.8X%8.8X\n",
333 ACPI_FORMAT_UINT64 (Value));
335 /* Store pointer to value descriptor in the Node */
337 Status = AcpiNsAttachObject (NewNode, ObjDesc,
338 ACPI_TYPE_INTEGER);
340 /* Remove local reference to the object */
342 AcpiUtRemoveReference (ObjDesc);
346 /******************************************************************************
348 * FUNCTION: AeLookupInitFileEntry
350 * PARAMETERS: Pathname - AML namepath in external format
351 * ValueString - value of the namepath if it exitst
353 * RETURN: None
355 * DESCRIPTION: Search the init file for a particular name and its value.
357 *****************************************************************************/
359 ACPI_STATUS
360 AeLookupInitFileEntry (
361 char *Pathname,
362 UINT64 *Value)
364 UINT32 i;
366 if (!AcpiGbl_InitEntries)
368 return AE_NOT_FOUND;
371 for (i = 0; i < AcpiGbl_InitFileLineCount; ++i)
373 if (!strcmp(AcpiGbl_InitEntries[i].Name, Pathname))
375 *Value = AcpiGbl_InitEntries[i].Value;
376 return AE_OK;
379 return AE_NOT_FOUND;