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 - 2013, 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 #include "acpi.h" 117 #include "accommon.h" 118 #include "acnamesp.h" 119 #include "acpredef.h" 120 121 122 #define _COMPONENT ACPI_NAMESPACE 123 ACPI_MODULE_NAME ("nsarguments") 124 125 126 /******************************************************************************* 127 * 128 * FUNCTION: AcpiNsCheckArgumentTypes 129 * 130 * PARAMETERS: Info - Method execution information block 131 * 132 * RETURN: None 133 * 134 * DESCRIPTION: Check the incoming argument count and all argument types 135 * against the argument type list for a predefined name. 136 * 137 ******************************************************************************/ 138 139 void 140 AcpiNsCheckArgumentTypes ( 141 ACPI_EVALUATE_INFO *Info) 142 { 143 UINT16 ArgTypeList; 144 UINT8 ArgCount; 145 UINT8 ArgType; 146 UINT8 UserArgType; 147 UINT32 i; 148 149 150 /* If not a predefined name, cannot typecheck args */ 151 152 if (!Info->Predefined) 153 { 154 return; 155 } 156 157 ArgTypeList = Info->Predefined->Info.ArgumentList; 158 ArgCount = METHOD_GET_ARG_COUNT (ArgTypeList); 159 160 /* Typecheck all arguments */ 161 162 for (i = 0; ((i < ArgCount) && (i < Info->ParamCount)); i++) 163 { 164 ArgType = METHOD_GET_NEXT_TYPE (ArgTypeList); 165 UserArgType = Info->Parameters[i]->Common.Type; 166 167 if (UserArgType != ArgType) 168 { 169 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS, 170 "Argument #%u type mismatch - " 171 "Found [%s], ACPI requires [%s]", (i + 1), 172 AcpiUtGetTypeName (UserArgType), 173 AcpiUtGetTypeName (ArgType))); 174 } 175 } 176 } 177 178 179 /******************************************************************************* 180 * 181 * FUNCTION: AcpiNsCheckAcpiCompliance 182 * 183 * PARAMETERS: Pathname - Full pathname to the node (for error msgs) 184 * Node - Namespace node for the method/object 185 * Predefined - Pointer to entry in predefined name table 186 * 187 * RETURN: None 188 * 189 * DESCRIPTION: Check that the declared parameter count (in ASL/AML) for a 190 * predefined name is what is expected (matches what is defined in 191 * the ACPI specification for this predefined name.) 192 * 193 ******************************************************************************/ 194 195 void 196 AcpiNsCheckAcpiCompliance ( 197 char *Pathname, 198 ACPI_NAMESPACE_NODE *Node, 199 const ACPI_PREDEFINED_INFO *Predefined) 200 { 201 UINT32 AmlParamCount; 202 UINT32 RequiredParamCount; 203 204 205 if (!Predefined) 206 { 207 return; 208 } 209 210 /* Get the ACPI-required arg count from the predefined info table */ 211 212 RequiredParamCount = METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList); 213 214 /* 215 * If this object is not a control method, we can check if the ACPI 216 * spec requires that it be a method. 217 */ 218 if (Node->Type != ACPI_TYPE_METHOD) 219 { 220 if (RequiredParamCount > 0) 221 { 222 /* Object requires args, must be implemented as a method */ 223 224 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 225 "Object (%s) must be a control method with %u arguments", 226 AcpiUtGetTypeName (Node->Type), RequiredParamCount)); 227 } 228 else if (!RequiredParamCount && !Predefined->Info.ExpectedBtypes) 229 { 230 /* Object requires no args and no return value, must be a method */ 231 232 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 233 "Object (%s) must be a control method " 234 "with no arguments and no return value", 235 AcpiUtGetTypeName (Node->Type))); 236 } 237 238 return; 239 } 240 241 /* 242 * This is a control method. 243 * Check that the ASL/AML-defined parameter count for this method 244 * matches the ACPI-required parameter count 245 * 246 * Some methods are allowed to have a "minimum" number of args (_SCP) 247 * because their definition in ACPI has changed over time. 248 * 249 * Note: These are BIOS errors in the declaration of the object 250 */ 251 AmlParamCount = Node->Object->Method.ParamCount; 252 253 if (AmlParamCount < RequiredParamCount) 254 { 255 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 256 "Insufficient arguments - " 257 "ASL declared %u, ACPI requires %u", 258 AmlParamCount, RequiredParamCount)); 259 } 260 else if ((AmlParamCount > RequiredParamCount) && 261 !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM)) 262 { 263 ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 264 "Excess arguments - " 265 "ASL declared %u, ACPI requires %u", 266 AmlParamCount, RequiredParamCount)); 267 } 268 } 269 270 271 /******************************************************************************* 272 * 273 * FUNCTION: AcpiNsCheckArgumentCount 274 * 275 * PARAMETERS: Pathname - Full pathname to the node (for error msgs) 276 * Node - Namespace node for the method/object 277 * UserParamCount - Number of args passed in by the caller 278 * Predefined - Pointer to entry in predefined name table 279 * 280 * RETURN: None 281 * 282 * DESCRIPTION: Check that incoming argument count matches the declared 283 * parameter count (in the ASL/AML) for an object. 284 * 285 ******************************************************************************/ 286 287 void 288 AcpiNsCheckArgumentCount ( 289 char *Pathname, 290 ACPI_NAMESPACE_NODE *Node, 291 UINT32 UserParamCount, 292 const ACPI_PREDEFINED_INFO *Predefined) 293 { 294 UINT32 AmlParamCount; 295 UINT32 RequiredParamCount; 296 297 298 if (!Predefined) 299 { 300 /* 301 * Not a predefined name. Check the incoming user argument count 302 * against the count that is specified in the method/object. 303 */ 304 if (Node->Type != ACPI_TYPE_METHOD) 305 { 306 if (UserParamCount) 307 { 308 ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 309 "%u arguments were passed to a non-method ACPI object (%s)", 310 UserParamCount, AcpiUtGetTypeName (Node->Type))); 311 } 312 313 return; 314 } 315 316 /* 317 * This is a control method. Check the parameter count. 318 * We can only check the incoming argument count against the 319 * argument count declared for the method in the ASL/AML. 320 * 321 * Emit a message if too few or too many arguments have been passed 322 * by the caller. 323 * 324 * Note: Too many arguments will not cause the method to 325 * fail. However, the method will fail if there are too few 326 * arguments and the method attempts to use one of the missing ones. 327 */ 328 AmlParamCount = Node->Object->Method.ParamCount; 329 330 if (UserParamCount < AmlParamCount) 331 { 332 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 333 "Insufficient arguments - " 334 "Caller passed %u, method requires %u", 335 UserParamCount, AmlParamCount)); 336 } 337 else if (UserParamCount > AmlParamCount) 338 { 339 ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 340 "Excess arguments - " 341 "Caller passed %u, method requires %u", 342 UserParamCount, AmlParamCount)); 343 } 344 345 return; 346 } 347 348 /* 349 * This is a predefined name. Validate the user-supplied parameter 350 * count against the ACPI specification. We don't validate against 351 * the method itself because what is important here is that the 352 * caller is in conformance with the spec. (The arg count for the 353 * method was checked against the ACPI spec earlier.) 354 * 355 * Some methods are allowed to have a "minimum" number of args (_SCP) 356 * because their definition in ACPI has changed over time. 357 */ 358 RequiredParamCount = METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList); 359 360 if (UserParamCount < RequiredParamCount) 361 { 362 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 363 "Insufficient arguments - " 364 "Caller passed %u, ACPI requires %u", 365 UserParamCount, RequiredParamCount)); 366 } 367 else if ((UserParamCount > RequiredParamCount) && 368 !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM)) 369 { 370 ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 371 "Excess arguments - " 372 "Caller passed %u, ACPI requires %u", 373 UserParamCount, RequiredParamCount)); 374 } 375 } 376