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 - 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 "aecommon.h" 153 #include "acdispat.h" 154 155 #define _COMPONENT ACPI_TOOLS 156 ACPI_MODULE_NAME ("aeinitfile") 157 158 159 /* Local prototypes */ 160 161 static void 162 AeEnterInitFileEntry ( 163 INIT_FILE_ENTRY InitEntry, 164 ACPI_WALK_STATE *WalkState); 165 166 167 #define AE_FILE_BUFFER_SIZE 512 168 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; 173 174 175 /****************************************************************************** 176 * 177 * FUNCTION: AeOpenInitializationFile 178 * 179 * PARAMETERS: Filename - Path to the init file 180 * 181 * RETURN: Status 182 * 183 * DESCRIPTION: Open the initialization file for the -fi option 184 * 185 *****************************************************************************/ 186 187 int 188 AeOpenInitializationFile ( 189 char *Filename) 190 { 191 192 InitFile = fopen (Filename, "r"); 193 if (!InitFile) 194 { 195 fprintf (stderr, 196 "Could not open initialization file: %s\n", Filename); 197 return (-1); 198 } 199 200 AcpiOsPrintf ("Opened initialization file [%s]\n", Filename); 201 return (0); 202 } 203 204 205 /****************************************************************************** 206 * 207 * FUNCTION: AeProcessInitFile 208 * 209 * PARAMETERS: None 210 * 211 * RETURN: None 212 * 213 * DESCRIPTION: Read the initialization file and perform all namespace 214 * initializations. AcpiGbl_InitEntries will be used for region 215 * field initialization. 216 * 217 * NOTE: The format of the file is multiple lines, each of format: 218 * <ACPI-pathname> <Integer Value> 219 * 220 *****************************************************************************/ 221 222 void 223 AeProcessInitFile( 224 void) 225 { 226 ACPI_WALK_STATE *WalkState; 227 UINT64 idx; 228 ACPI_STATUS Status; 229 char *Token; 230 char *ObjectBuffer; 231 char *TempNameBuffer; 232 ACPI_OBJECT_TYPE Type; 233 ACPI_OBJECT TempObject; 234 235 236 if (!InitFile) 237 { 238 return; 239 } 240 241 /* Create needed objects to be reused for each init entry */ 242 243 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL); 244 NameBuffer[0] = '\\'; 245 246 while (fgets (LineBuffer, AE_FILE_BUFFER_SIZE, InitFile) != NULL) 247 { 248 ++AcpiGbl_InitFileLineCount; 249 } 250 rewind (InitFile); 251 252 AcpiGbl_InitEntries = 253 AcpiOsAllocate (sizeof (INIT_FILE_ENTRY) * AcpiGbl_InitFileLineCount); 254 for (idx = 0; fgets (LineBuffer, AE_FILE_BUFFER_SIZE, InitFile); ++idx) 255 { 256 257 TempNameBuffer = AcpiDbGetNextToken (LineBuffer, &Token, &Type); 258 if (LineBuffer[0] == '\\') 259 { 260 strcpy (NameBuffer, TempNameBuffer); 261 } 262 else 263 { 264 /* Add a root prefix if not present in the string */ 265 266 strcpy (NameBuffer + 1, TempNameBuffer); 267 } 268 269 AcpiGbl_InitEntries[idx].Name = 270 AcpiOsAllocateZeroed (strnlen (NameBuffer, AE_FILE_BUFFER_SIZE) + 1); 271 272 strcpy (AcpiGbl_InitEntries[idx].Name, NameBuffer); 273 274 ObjectBuffer = AcpiDbGetNextToken (Token, &Token, &Type); 275 276 if (Type == ACPI_TYPE_FIELD_UNIT) 277 { 278 Status = AcpiDbConvertToObject (ACPI_TYPE_BUFFER, ObjectBuffer, 279 &TempObject); 280 } 281 else 282 { 283 Status = AcpiDbConvertToObject (Type, ObjectBuffer, &TempObject); 284 } 285 286 Status = AcpiUtCopyEobjectToIobject (&TempObject, 287 &AcpiGbl_InitEntries[idx].ObjDesc); 288 289 if (Type == ACPI_TYPE_BUFFER || Type == ACPI_TYPE_FIELD_UNIT) 290 { 291 ACPI_FREE (TempObject.Buffer.Pointer); 292 } 293 294 if (ACPI_FAILURE (Status)) 295 { 296 AcpiOsPrintf ("%s %s\n", ValueBuffer, 297 AcpiFormatException (Status)); 298 goto CleanupAndExit; 299 } 300 301 /* 302 * Special case for field units. Field units are dependent on the 303 * parent region. This parent region has yet to be created so defer the 304 * initialization until the dispatcher. For all other types, initialize 305 * the namespace node with the value found in the init file. 306 */ 307 if (Type != ACPI_TYPE_FIELD_UNIT) 308 { 309 AeEnterInitFileEntry (AcpiGbl_InitEntries[idx], WalkState); 310 } 311 } 312 313 /* Cleanup */ 314 315 CleanupAndExit: 316 fclose (InitFile); 317 AcpiDsDeleteWalkState (WalkState); 318 } 319 320 321 /****************************************************************************** 322 * 323 * FUNCTION: AeInitFileEntry 324 * 325 * PARAMETERS: InitEntry - Entry of the init file 326 * WalkState - Used for the Store operation 327 * 328 * RETURN: None 329 * 330 * DESCRIPTION: Perform initialization of a single namespace object 331 * 332 * Note: namespace of objects are limited to integers and region 333 * fields units of 8 bytes at this time. 334 * 335 *****************************************************************************/ 336 337 static void 338 AeEnterInitFileEntry ( 339 INIT_FILE_ENTRY InitEntry, 340 ACPI_WALK_STATE *WalkState) 341 { 342 char *Pathname = InitEntry.Name; 343 ACPI_OPERAND_OBJECT *ObjDesc = InitEntry.ObjDesc; 344 ACPI_NAMESPACE_NODE *NewNode; 345 ACPI_STATUS Status; 346 347 348 Status = AcpiNsLookup (NULL, Pathname, ObjDesc->Common.Type, 349 ACPI_IMODE_LOAD_PASS2, ACPI_NS_ERROR_IF_FOUND | ACPI_NS_NO_UPSEARCH | 350 ACPI_NS_EARLY_INIT, NULL, &NewNode); 351 if (ACPI_FAILURE (Status)) 352 { 353 ACPI_EXCEPTION ((AE_INFO, Status, 354 "While creating name from namespace initialization file: %s", 355 Pathname)); 356 return; 357 } 358 359 /* Store pointer to value descriptor in the Node */ 360 361 Status = AcpiNsAttachObject (NewNode, ObjDesc, 362 ObjDesc->Common.Type); 363 if (ACPI_FAILURE (Status)) 364 { 365 ACPI_EXCEPTION ((AE_INFO, Status, 366 "While attaching object to node from namespace initialization file: %s", 367 Pathname)); 368 return; 369 } 370 371 /* Remove local reference to the object */ 372 373 AcpiUtRemoveReference (ObjDesc); 374 } 375 376 377 /****************************************************************************** 378 * 379 * FUNCTION: AeLookupInitFileEntry 380 * 381 * PARAMETERS: Pathname - AML namepath in external format 382 * ValueString - value of the namepath if it exitst 383 * 384 * RETURN: None 385 * 386 * DESCRIPTION: Search the init file for a particular name and its value. 387 * 388 *****************************************************************************/ 389 390 ACPI_STATUS 391 AeLookupInitFileEntry ( 392 char *Pathname, 393 ACPI_OPERAND_OBJECT **ObjDesc) 394 { 395 UINT32 i; 396 397 if (!AcpiGbl_InitEntries) 398 { 399 return AE_NOT_FOUND; 400 } 401 402 for (i = 0; i < AcpiGbl_InitFileLineCount; ++i) 403 { 404 if (!strcmp(AcpiGbl_InitEntries[i].Name, Pathname)) 405 { 406 *ObjDesc = AcpiGbl_InitEntries[i].ObjDesc; 407 return AE_OK; 408 } 409 } 410 return AE_NOT_FOUND; 411 } 412