1 /****************************************************************************** 2 * 3 * Module Name: nsarguments - Validation of args for ACPI predefined methods 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 "acnamesp.h" 155 #include "acpredef.h" 156 157 158 #define _COMPONENT ACPI_NAMESPACE 159 ACPI_MODULE_NAME ("nsarguments") 160 161 162 /******************************************************************************* 163 * 164 * FUNCTION: AcpiNsCheckArgumentTypes 165 * 166 * PARAMETERS: Info - Method execution information block 167 * 168 * RETURN: None 169 * 170 * DESCRIPTION: Check the incoming argument count and all argument types 171 * against the argument type list for a predefined name. 172 * 173 ******************************************************************************/ 174 175 void 176 AcpiNsCheckArgumentTypes ( 177 ACPI_EVALUATE_INFO *Info) 178 { 179 UINT16 ArgTypeList; 180 UINT8 ArgCount; 181 UINT8 ArgType; 182 UINT8 UserArgType; 183 UINT32 i; 184 185 186 /* 187 * If not a predefined name, cannot typecheck args, because 188 * we have no idea what argument types are expected. 189 * Also, ignore typecheck if warnings/errors if this method 190 * has already been evaluated at least once -- in order 191 * to suppress repetitive messages. 192 */ 193 if (!Info->Predefined || (Info->Node->Flags & ANOBJ_EVALUATED)) 194 { 195 return; 196 } 197 198 ArgTypeList = Info->Predefined->Info.ArgumentList; 199 ArgCount = METHOD_GET_ARG_COUNT (ArgTypeList); 200 201 /* Typecheck all arguments */ 202 203 for (i = 0; ((i < ArgCount) && (i < Info->ParamCount)); i++) 204 { 205 ArgType = METHOD_GET_NEXT_TYPE (ArgTypeList); 206 UserArgType = Info->Parameters[i]->Common.Type; 207 208 if (UserArgType != ArgType) 209 { 210 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS, 211 "Argument #%u type mismatch - " 212 "Found [%s], ACPI requires [%s]", (i + 1), 213 AcpiUtGetTypeName (UserArgType), 214 AcpiUtGetTypeName (ArgType))); 215 216 /* Prevent any additional typechecking for this method */ 217 218 Info->Node->Flags |= ANOBJ_EVALUATED; 219 } 220 } 221 } 222 223 224 /******************************************************************************* 225 * 226 * FUNCTION: AcpiNsCheckAcpiCompliance 227 * 228 * PARAMETERS: Pathname - Full pathname to the node (for error msgs) 229 * Node - Namespace node for the method/object 230 * Predefined - Pointer to entry in predefined name table 231 * 232 * RETURN: None 233 * 234 * DESCRIPTION: Check that the declared parameter count (in ASL/AML) for a 235 * predefined name is what is expected (matches what is defined in 236 * the ACPI specification for this predefined name.) 237 * 238 ******************************************************************************/ 239 240 void 241 AcpiNsCheckAcpiCompliance ( 242 char *Pathname, 243 ACPI_NAMESPACE_NODE *Node, 244 const ACPI_PREDEFINED_INFO *Predefined) 245 { 246 UINT32 AmlParamCount; 247 UINT32 RequiredParamCount; 248 249 250 if (!Predefined || (Node->Flags & ANOBJ_EVALUATED)) 251 { 252 return; 253 } 254 255 /* Get the ACPI-required arg count from the predefined info table */ 256 257 RequiredParamCount = 258 METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList); 259 260 /* 261 * If this object is not a control method, we can check if the ACPI 262 * spec requires that it be a method. 263 */ 264 if (Node->Type != ACPI_TYPE_METHOD) 265 { 266 if (RequiredParamCount > 0) 267 { 268 /* Object requires args, must be implemented as a method */ 269 270 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 271 "Object (%s) must be a control method with %u arguments", 272 AcpiUtGetTypeName (Node->Type), RequiredParamCount)); 273 } 274 else if (!RequiredParamCount && !Predefined->Info.ExpectedBtypes) 275 { 276 /* Object requires no args and no return value, must be a method */ 277 278 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 279 "Object (%s) must be a control method " 280 "with no arguments and no return value", 281 AcpiUtGetTypeName (Node->Type))); 282 } 283 284 return; 285 } 286 287 /* 288 * This is a control method. 289 * Check that the ASL/AML-defined parameter count for this method 290 * matches the ACPI-required parameter count 291 * 292 * Some methods are allowed to have a "minimum" number of args (_SCP) 293 * because their definition in ACPI has changed over time. 294 * 295 * Note: These are BIOS errors in the declaration of the object 296 */ 297 AmlParamCount = Node->Object->Method.ParamCount; 298 299 if (AmlParamCount < RequiredParamCount) 300 { 301 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 302 "Insufficient arguments - " 303 "ASL declared %u, ACPI requires %u", 304 AmlParamCount, RequiredParamCount)); 305 } 306 else if ((AmlParamCount > RequiredParamCount) && 307 !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM)) 308 { 309 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 310 "Excess arguments - " 311 "ASL declared %u, ACPI requires %u", 312 AmlParamCount, RequiredParamCount)); 313 } 314 } 315 316 317 /******************************************************************************* 318 * 319 * FUNCTION: AcpiNsCheckArgumentCount 320 * 321 * PARAMETERS: Pathname - Full pathname to the node (for error msgs) 322 * Node - Namespace node for the method/object 323 * UserParamCount - Number of args passed in by the caller 324 * Predefined - Pointer to entry in predefined name table 325 * 326 * RETURN: None 327 * 328 * DESCRIPTION: Check that incoming argument count matches the declared 329 * parameter count (in the ASL/AML) for an object. 330 * 331 ******************************************************************************/ 332 333 void 334 AcpiNsCheckArgumentCount ( 335 char *Pathname, 336 ACPI_NAMESPACE_NODE *Node, 337 UINT32 UserParamCount, 338 const ACPI_PREDEFINED_INFO *Predefined) 339 { 340 UINT32 AmlParamCount; 341 UINT32 RequiredParamCount; 342 343 344 if (Node->Flags & ANOBJ_EVALUATED) 345 { 346 return; 347 } 348 349 if (!Predefined) 350 { 351 /* 352 * Not a predefined name. Check the incoming user argument count 353 * against the count that is specified in the method/object. 354 */ 355 if (Node->Type != ACPI_TYPE_METHOD) 356 { 357 if (UserParamCount) 358 { 359 ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 360 "%u arguments were passed to a non-method ACPI object (%s)", 361 UserParamCount, AcpiUtGetTypeName (Node->Type))); 362 } 363 364 return; 365 } 366 367 /* 368 * This is a control method. Check the parameter count. 369 * We can only check the incoming argument count against the 370 * argument count declared for the method in the ASL/AML. 371 * 372 * Emit a message if too few or too many arguments have been passed 373 * by the caller. 374 * 375 * Note: Too many arguments will not cause the method to 376 * fail. However, the method will fail if there are too few 377 * arguments and the method attempts to use one of the missing ones. 378 */ 379 AmlParamCount = Node->Object->Method.ParamCount; 380 381 if (UserParamCount < AmlParamCount) 382 { 383 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 384 "Insufficient arguments - " 385 "Caller passed %u, method requires %u", 386 UserParamCount, AmlParamCount)); 387 } 388 else if (UserParamCount > AmlParamCount) 389 { 390 ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 391 "Excess arguments - " 392 "Caller passed %u, method requires %u", 393 UserParamCount, AmlParamCount)); 394 } 395 396 return; 397 } 398 399 /* 400 * This is a predefined name. Validate the user-supplied parameter 401 * count against the ACPI specification. We don't validate against 402 * the method itself because what is important here is that the 403 * caller is in conformance with the spec. (The arg count for the 404 * method was checked against the ACPI spec earlier.) 405 * 406 * Some methods are allowed to have a "minimum" number of args (_SCP) 407 * because their definition in ACPI has changed over time. 408 */ 409 RequiredParamCount = 410 METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList); 411 412 if (UserParamCount < RequiredParamCount) 413 { 414 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 415 "Insufficient arguments - " 416 "Caller passed %u, ACPI requires %u", 417 UserParamCount, RequiredParamCount)); 418 } 419 else if ((UserParamCount > RequiredParamCount) && 420 !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM)) 421 { 422 ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 423 "Excess arguments - " 424 "Caller passed %u, ACPI requires %u", 425 UserParamCount, RequiredParamCount)); 426 } 427 } 428