1 /****************************************************************************** 2 * 3 * Module Name: aeinitfile - Support for optional initialization file 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2021, 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 "aecommon.h" 153 #include "acdispat.h" 154 #include "acnamesp.h" 155 156 157 #define _COMPONENT ACPI_TOOLS 158 ACPI_MODULE_NAME ("aeinitfile") 159 160 161 #define AE_FILE_BUFFER_SIZE 512 162 163 static char LineBuffer[AE_FILE_BUFFER_SIZE]; 164 static char NameBuffer[AE_FILE_BUFFER_SIZE]; 165 static FILE *InitFile; 166 167 168 /****************************************************************************** 169 * 170 * FUNCTION: AeOpenInitializationFile 171 * 172 * PARAMETERS: Filename - Path to the init file 173 * 174 * RETURN: Status 175 * 176 * DESCRIPTION: Open the initialization file for the -fi option 177 * 178 *****************************************************************************/ 179 180 int 181 AeOpenInitializationFile ( 182 char *Filename) 183 { 184 185 InitFile = fopen (Filename, "r"); 186 if (!InitFile) 187 { 188 fprintf (stderr, 189 "Could not open initialization file: %s\n", Filename); 190 return (-1); 191 } 192 193 AcpiOsPrintf ("Opened initialization file [%s]\n", Filename); 194 return (0); 195 } 196 197 198 /****************************************************************************** 199 * 200 * FUNCTION: AeProcessInitFile 201 * 202 * PARAMETERS: None 203 * 204 * RETURN: None 205 * 206 * DESCRIPTION: Read the initialization file and perform all namespace 207 * initializations. AcpiGbl_InitEntries will be used for all 208 * object initialization. 209 * 210 * NOTE: The format of the file is multiple lines, each of format: 211 * <ACPI-pathname> <New Value> 212 * 213 *****************************************************************************/ 214 215 ACPI_STATUS 216 AeProcessInitFile ( 217 void) 218 { 219 ACPI_WALK_STATE *WalkState; 220 UINT64 idx; 221 ACPI_STATUS Status = AE_OK; 222 char *Token; 223 char *ValueBuffer; 224 char *TempNameBuffer; 225 ACPI_OBJECT_TYPE Type; 226 ACPI_OBJECT TempObject; 227 228 229 if (!InitFile) 230 { 231 return (AE_OK); 232 } 233 234 /* Create needed objects to be reused for each init entry */ 235 236 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL); 237 NameBuffer[0] = '\\'; 238 NameBuffer[1] = 0; 239 240 while (fgets (LineBuffer, AE_FILE_BUFFER_SIZE, InitFile) != NULL) 241 { 242 ++AcpiGbl_InitFileLineCount; 243 } 244 rewind (InitFile); 245 246 /* 247 * Allocate and populate the Gbl_InitEntries array 248 */ 249 AcpiGbl_InitEntries = 250 AcpiOsAllocateZeroed (sizeof (INIT_FILE_ENTRY) * AcpiGbl_InitFileLineCount); 251 for (idx = 0; fgets (LineBuffer, AE_FILE_BUFFER_SIZE, InitFile); ++idx) 252 { 253 TempNameBuffer = AcpiDbGetNextToken (LineBuffer, &Token, &Type); 254 if (!TempNameBuffer) 255 { 256 AcpiGbl_InitEntries[idx].Name = NULL; 257 continue; 258 } 259 260 if (LineBuffer[0] == '\\') 261 { 262 strcpy (NameBuffer, TempNameBuffer); 263 } 264 else 265 { 266 /* Add a root prefix if not present in the string */ 267 268 strcpy (NameBuffer + 1, TempNameBuffer); 269 } 270 271 AcpiNsNormalizePathname (NameBuffer); 272 AcpiGbl_InitEntries[idx].Name = 273 AcpiOsAllocateZeroed (strnlen (NameBuffer, AE_FILE_BUFFER_SIZE) + 1); 274 strcpy (AcpiGbl_InitEntries[idx].Name, NameBuffer); 275 276 ValueBuffer = AcpiDbGetNextToken (Token, &Token, &Type); 277 if (!ValueBuffer) 278 { 279 AcpiGbl_InitEntries[idx].Value = NULL; 280 continue; 281 } 282 283 AcpiGbl_InitEntries[idx].Value = 284 AcpiOsAllocateZeroed (strnlen (ValueBuffer, AE_FILE_BUFFER_SIZE) + 1); 285 strcpy (AcpiGbl_InitEntries[idx].Value, ValueBuffer); 286 287 if (Type == ACPI_TYPE_FIELD_UNIT) 288 { 289 Status = AcpiDbConvertToObject (ACPI_TYPE_BUFFER, ValueBuffer, 290 &TempObject); 291 } 292 else 293 { 294 Status = AcpiDbConvertToObject (Type, ValueBuffer, &TempObject); 295 } 296 297 if (ACPI_FAILURE (Status)) 298 { 299 AcpiOsPrintf ("%s[%s]: %s\n", NameBuffer, AcpiUtGetTypeName (Type), 300 AcpiFormatException (Status)); 301 goto CleanupAndExit; 302 } 303 304 Status = AcpiUtCopyEobjectToIobject (&TempObject, 305 &AcpiGbl_InitEntries[idx].ObjDesc); 306 307 /* Cleanup the external object created by DbConvertToObject above */ 308 309 if (ACPI_SUCCESS (Status)) 310 { 311 if (Type == ACPI_TYPE_BUFFER || Type == ACPI_TYPE_FIELD_UNIT) 312 { 313 ACPI_FREE (TempObject.Buffer.Pointer); 314 } 315 else if (Type == ACPI_TYPE_PACKAGE) 316 { 317 AcpiDbDeleteObjects (1, &TempObject); 318 } 319 } 320 else 321 { 322 AcpiOsPrintf ("%s[%s]: %s\n", NameBuffer, AcpiUtGetTypeName (Type), 323 AcpiFormatException (Status)); 324 goto CleanupAndExit; 325 } 326 327 /* 328 * Initialize the namespace node with the value found in the init file. 329 */ 330 AcpiOsPrintf ("Namespace object init from file: %16s, Value \"%s\", Type %s\n", 331 AcpiGbl_InitEntries[idx].Name, AcpiGbl_InitEntries[idx].Value, AcpiUtGetTypeName (Type)); 332 } 333 334 /* Cleanup */ 335 336 CleanupAndExit: 337 fclose (InitFile); 338 AcpiDsDeleteWalkState (WalkState); 339 return (Status); 340 } 341 342 343 /****************************************************************************** 344 * 345 * FUNCTION: AeLookupInitFileEntry 346 * 347 * PARAMETERS: Pathname - AML namepath in external format 348 * ObjDesc - Where the object is returned if it exists 349 * 350 * RETURN: Status. AE_OK if a match was found 351 * 352 * DESCRIPTION: Search the init file for a particular name and its value. 353 * 354 *****************************************************************************/ 355 356 ACPI_STATUS 357 AeLookupInitFileEntry ( 358 char *Pathname, 359 ACPI_OPERAND_OBJECT **ObjDesc) 360 { 361 UINT32 i; 362 363 ACPI_FUNCTION_TRACE (AeLookupInitFileEntry); 364 365 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Lookup: %s\n", Pathname)); 366 367 if (!AcpiGbl_InitEntries) 368 { 369 return (AE_NOT_FOUND); 370 } 371 372 AcpiNsNormalizePathname (Pathname); 373 374 for (i = 0; i < AcpiGbl_InitFileLineCount; ++i) 375 { 376 if (AcpiGbl_InitEntries[i].Name && 377 !strcmp (AcpiGbl_InitEntries[i].Name, Pathname)) 378 { 379 *ObjDesc = AcpiGbl_InitEntries[i].ObjDesc; 380 AcpiGbl_InitEntries[i].IsUsed = TRUE; 381 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Found match: %s, %p\n", Pathname, *ObjDesc)); 382 return_ACPI_STATUS (AE_OK); 383 } 384 } 385 386 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "No match found: %s\n", Pathname)); 387 return_ACPI_STATUS (AE_NOT_FOUND); 388 } 389 390 391 /****************************************************************************** 392 * 393 * FUNCTION: AeDisplayUnusedInitFileItems 394 * 395 * PARAMETERS: None 396 * 397 * RETURN: None 398 * 399 * DESCRIPTION: Display all init file items that have not been referenced 400 * (i.e., items that have not been found in the namespace). 401 * 402 *****************************************************************************/ 403 404 void 405 AeDisplayUnusedInitFileItems ( 406 void) 407 { 408 UINT32 i; 409 410 411 if (!AcpiGbl_InitEntries) 412 { 413 return; 414 } 415 416 for (i = 0; i < AcpiGbl_InitFileLineCount; ++i) 417 { 418 if (AcpiGbl_InitEntries[i].Name && 419 !AcpiGbl_InitEntries[i].IsUsed) 420 { 421 AcpiOsPrintf ("Init file entry not found in namespace " 422 "(or is a non-data type): %s\n", 423 AcpiGbl_InitEntries[i].Name); 424 } 425 } 426 } 427 428 429 /****************************************************************************** 430 * 431 * FUNCTION: AeDeleteInitFileList 432 * 433 * PARAMETERS: None 434 * 435 * RETURN: None 436 * 437 * DESCRIPTION: Delete the global namespace initialization file data 438 * 439 *****************************************************************************/ 440 441 void 442 AeDeleteInitFileList ( 443 void) 444 { 445 UINT32 i; 446 447 448 if (!AcpiGbl_InitEntries) 449 { 450 return; 451 } 452 453 for (i = 0; i < AcpiGbl_InitFileLineCount; ++i) 454 { 455 456 if ((AcpiGbl_InitEntries[i].ObjDesc) && (AcpiGbl_InitEntries[i].Value)) 457 { 458 /* Remove one reference on the object (and all subobjects) */ 459 460 AcpiUtRemoveReference (AcpiGbl_InitEntries[i].ObjDesc); 461 } 462 } 463 464 AcpiOsFree (AcpiGbl_InitEntries); 465 } 466