1 /****************************************************************************** 2 * 3 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2014, 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 117 #define __EXFIELD_C__ 118 119 #include "acpi.h" 120 #include "accommon.h" 121 #include "acdispat.h" 122 #include "acinterp.h" 123 #include "amlcode.h" 124 125 126 #define _COMPONENT ACPI_EXECUTER 127 ACPI_MODULE_NAME ("exfield") 128 129 /* Local prototypes */ 130 131 static UINT32 132 AcpiExGetSerialAccessLength ( 133 UINT32 AccessorType, 134 UINT32 AccessLength); 135 136 137 /******************************************************************************* 138 * 139 * FUNCTION: AcpiExGetSerialAccessLength 140 * 141 * PARAMETERS: AccessorType - The type of the protocol indicated by region 142 * field access attributes 143 * AccessLength - The access length of the region field 144 * 145 * RETURN: Decoded access length 146 * 147 * DESCRIPTION: This routine returns the length of the GenericSerialBus 148 * protocol bytes 149 * 150 ******************************************************************************/ 151 152 static UINT32 153 AcpiExGetSerialAccessLength ( 154 UINT32 AccessorType, 155 UINT32 AccessLength) 156 { 157 UINT32 Length; 158 159 160 switch (AccessorType) 161 { 162 case AML_FIELD_ATTRIB_QUICK: 163 164 Length = 0; 165 break; 166 167 case AML_FIELD_ATTRIB_SEND_RCV: 168 case AML_FIELD_ATTRIB_BYTE: 169 170 Length = 1; 171 break; 172 173 case AML_FIELD_ATTRIB_WORD: 174 case AML_FIELD_ATTRIB_WORD_CALL: 175 176 Length = 2; 177 break; 178 179 case AML_FIELD_ATTRIB_MULTIBYTE: 180 case AML_FIELD_ATTRIB_RAW_BYTES: 181 case AML_FIELD_ATTRIB_RAW_PROCESS: 182 183 Length = AccessLength; 184 break; 185 186 case AML_FIELD_ATTRIB_BLOCK: 187 case AML_FIELD_ATTRIB_BLOCK_CALL: 188 default: 189 190 Length = ACPI_GSBUS_BUFFER_SIZE - 2; 191 break; 192 } 193 194 return (Length); 195 } 196 197 198 /******************************************************************************* 199 * 200 * FUNCTION: AcpiExReadDataFromField 201 * 202 * PARAMETERS: WalkState - Current execution state 203 * ObjDesc - The named field 204 * RetBufferDesc - Where the return data object is stored 205 * 206 * RETURN: Status 207 * 208 * DESCRIPTION: Read from a named field. Returns either an Integer or a 209 * Buffer, depending on the size of the field. 210 * 211 ******************************************************************************/ 212 213 ACPI_STATUS 214 AcpiExReadDataFromField ( 215 ACPI_WALK_STATE *WalkState, 216 ACPI_OPERAND_OBJECT *ObjDesc, 217 ACPI_OPERAND_OBJECT **RetBufferDesc) 218 { 219 ACPI_STATUS Status; 220 ACPI_OPERAND_OBJECT *BufferDesc; 221 ACPI_SIZE Length; 222 void *Buffer; 223 UINT32 Function; 224 UINT16 AccessorType; 225 226 227 ACPI_FUNCTION_TRACE_PTR (ExReadDataFromField, ObjDesc); 228 229 230 /* Parameter validation */ 231 232 if (!ObjDesc) 233 { 234 return_ACPI_STATUS (AE_AML_NO_OPERAND); 235 } 236 if (!RetBufferDesc) 237 { 238 return_ACPI_STATUS (AE_BAD_PARAMETER); 239 } 240 241 if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD) 242 { 243 /* 244 * If the BufferField arguments have not been previously evaluated, 245 * evaluate them now and save the results. 246 */ 247 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)) 248 { 249 Status = AcpiDsGetBufferFieldArguments (ObjDesc); 250 if (ACPI_FAILURE (Status)) 251 { 252 return_ACPI_STATUS (Status); 253 } 254 } 255 } 256 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) && 257 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS || 258 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS || 259 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI)) 260 { 261 /* 262 * This is an SMBus, GSBus or IPMI read. We must create a buffer to hold 263 * the data and then directly access the region handler. 264 * 265 * Note: SMBus and GSBus protocol value is passed in upper 16-bits of Function 266 */ 267 if (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS) 268 { 269 Length = ACPI_SMBUS_BUFFER_SIZE; 270 Function = ACPI_READ | (ObjDesc->Field.Attribute << 16); 271 } 272 else if (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS) 273 { 274 AccessorType = ObjDesc->Field.Attribute; 275 Length = AcpiExGetSerialAccessLength (AccessorType, 276 ObjDesc->Field.AccessLength); 277 278 /* 279 * Add additional 2 bytes for the GenericSerialBus data buffer: 280 * 281 * Status; (Byte 0 of the data buffer) 282 * Length; (Byte 1 of the data buffer) 283 * Data[x-1]; (Bytes 2-x of the arbitrary length data buffer) 284 */ 285 Length += 2; 286 Function = ACPI_READ | (AccessorType << 16); 287 } 288 else /* IPMI */ 289 { 290 Length = ACPI_IPMI_BUFFER_SIZE; 291 Function = ACPI_READ; 292 } 293 294 BufferDesc = AcpiUtCreateBufferObject (Length); 295 if (!BufferDesc) 296 { 297 return_ACPI_STATUS (AE_NO_MEMORY); 298 } 299 300 /* Lock entire transaction if requested */ 301 302 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 303 304 /* Call the region handler for the read */ 305 306 Status = AcpiExAccessRegion (ObjDesc, 0, 307 ACPI_CAST_PTR (UINT64, BufferDesc->Buffer.Pointer), 308 Function); 309 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags); 310 goto Exit; 311 } 312 313 /* 314 * Allocate a buffer for the contents of the field. 315 * 316 * If the field is larger than the current integer width, create 317 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows 318 * the use of arithmetic operators on the returned value if the 319 * field size is equal or smaller than an Integer. 320 * 321 * Note: Field.length is in bits. 322 */ 323 Length = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->Field.BitLength); 324 if (Length > AcpiGbl_IntegerByteWidth) 325 { 326 /* Field is too large for an Integer, create a Buffer instead */ 327 328 BufferDesc = AcpiUtCreateBufferObject (Length); 329 if (!BufferDesc) 330 { 331 return_ACPI_STATUS (AE_NO_MEMORY); 332 } 333 Buffer = BufferDesc->Buffer.Pointer; 334 } 335 else 336 { 337 /* Field will fit within an Integer (normal case) */ 338 339 BufferDesc = AcpiUtCreateIntegerObject ((UINT64) 0); 340 if (!BufferDesc) 341 { 342 return_ACPI_STATUS (AE_NO_MEMORY); 343 } 344 345 Length = AcpiGbl_IntegerByteWidth; 346 Buffer = &BufferDesc->Integer.Value; 347 } 348 349 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 350 "FieldRead [TO]: Obj %p, Type %X, Buf %p, ByteLen %X\n", 351 ObjDesc, ObjDesc->Common.Type, Buffer, (UINT32) Length)); 352 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 353 "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n", 354 ObjDesc->CommonField.BitLength, 355 ObjDesc->CommonField.StartFieldBitOffset, 356 ObjDesc->CommonField.BaseByteOffset)); 357 358 /* Lock entire transaction if requested */ 359 360 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 361 362 /* Read from the field */ 363 364 Status = AcpiExExtractFromField (ObjDesc, Buffer, (UINT32) Length); 365 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags); 366 367 368 Exit: 369 if (ACPI_FAILURE (Status)) 370 { 371 AcpiUtRemoveReference (BufferDesc); 372 } 373 else 374 { 375 *RetBufferDesc = BufferDesc; 376 } 377 378 return_ACPI_STATUS (Status); 379 } 380 381 382 /******************************************************************************* 383 * 384 * FUNCTION: AcpiExWriteDataToField 385 * 386 * PARAMETERS: SourceDesc - Contains data to write 387 * ObjDesc - The named field 388 * ResultDesc - Where the return value is returned, if any 389 * 390 * RETURN: Status 391 * 392 * DESCRIPTION: Write to a named field 393 * 394 ******************************************************************************/ 395 396 ACPI_STATUS 397 AcpiExWriteDataToField ( 398 ACPI_OPERAND_OBJECT *SourceDesc, 399 ACPI_OPERAND_OBJECT *ObjDesc, 400 ACPI_OPERAND_OBJECT **ResultDesc) 401 { 402 ACPI_STATUS Status; 403 UINT32 Length; 404 void *Buffer; 405 ACPI_OPERAND_OBJECT *BufferDesc; 406 UINT32 Function; 407 UINT16 AccessorType; 408 409 410 ACPI_FUNCTION_TRACE_PTR (ExWriteDataToField, ObjDesc); 411 412 413 /* Parameter validation */ 414 415 if (!SourceDesc || !ObjDesc) 416 { 417 return_ACPI_STATUS (AE_AML_NO_OPERAND); 418 } 419 420 if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD) 421 { 422 /* 423 * If the BufferField arguments have not been previously evaluated, 424 * evaluate them now and save the results. 425 */ 426 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)) 427 { 428 Status = AcpiDsGetBufferFieldArguments (ObjDesc); 429 if (ACPI_FAILURE (Status)) 430 { 431 return_ACPI_STATUS (Status); 432 } 433 } 434 } 435 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) && 436 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS || 437 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS || 438 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI)) 439 { 440 /* 441 * This is an SMBus, GSBus or IPMI write. We will bypass the entire field 442 * mechanism and handoff the buffer directly to the handler. For 443 * these address spaces, the buffer is bi-directional; on a write, 444 * return data is returned in the same buffer. 445 * 446 * Source must be a buffer of sufficient size: 447 * ACPI_SMBUS_BUFFER_SIZE, ACPI_GSBUS_BUFFER_SIZE, or ACPI_IPMI_BUFFER_SIZE. 448 * 449 * Note: SMBus and GSBus protocol type is passed in upper 16-bits of Function 450 */ 451 if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER) 452 { 453 ACPI_ERROR ((AE_INFO, 454 "SMBus/IPMI/GenericSerialBus write requires Buffer, found type %s", 455 AcpiUtGetObjectTypeName (SourceDesc))); 456 457 return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 458 } 459 460 if (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS) 461 { 462 Length = ACPI_SMBUS_BUFFER_SIZE; 463 Function = ACPI_WRITE | (ObjDesc->Field.Attribute << 16); 464 } 465 else if (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS) 466 { 467 AccessorType = ObjDesc->Field.Attribute; 468 Length = AcpiExGetSerialAccessLength (AccessorType, 469 ObjDesc->Field.AccessLength); 470 471 /* 472 * Add additional 2 bytes for the GenericSerialBus data buffer: 473 * 474 * Status; (Byte 0 of the data buffer) 475 * Length; (Byte 1 of the data buffer) 476 * Data[x-1]; (Bytes 2-x of the arbitrary length data buffer) 477 */ 478 Length += 2; 479 Function = ACPI_WRITE | (AccessorType << 16); 480 } 481 else /* IPMI */ 482 { 483 Length = ACPI_IPMI_BUFFER_SIZE; 484 Function = ACPI_WRITE; 485 } 486 487 if (SourceDesc->Buffer.Length < Length) 488 { 489 ACPI_ERROR ((AE_INFO, 490 "SMBus/IPMI/GenericSerialBus write requires Buffer of length %u, found length %u", 491 Length, SourceDesc->Buffer.Length)); 492 493 return_ACPI_STATUS (AE_AML_BUFFER_LIMIT); 494 } 495 496 /* Create the bi-directional buffer */ 497 498 BufferDesc = AcpiUtCreateBufferObject (Length); 499 if (!BufferDesc) 500 { 501 return_ACPI_STATUS (AE_NO_MEMORY); 502 } 503 504 Buffer = BufferDesc->Buffer.Pointer; 505 ACPI_MEMCPY (Buffer, SourceDesc->Buffer.Pointer, Length); 506 507 /* Lock entire transaction if requested */ 508 509 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 510 511 /* 512 * Perform the write (returns status and perhaps data in the 513 * same buffer) 514 */ 515 Status = AcpiExAccessRegion (ObjDesc, 0, 516 (UINT64 *) Buffer, Function); 517 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags); 518 519 *ResultDesc = BufferDesc; 520 return_ACPI_STATUS (Status); 521 } 522 523 /* Get a pointer to the data to be written */ 524 525 switch (SourceDesc->Common.Type) 526 { 527 case ACPI_TYPE_INTEGER: 528 529 Buffer = &SourceDesc->Integer.Value; 530 Length = sizeof (SourceDesc->Integer.Value); 531 break; 532 533 case ACPI_TYPE_BUFFER: 534 535 Buffer = SourceDesc->Buffer.Pointer; 536 Length = SourceDesc->Buffer.Length; 537 break; 538 539 case ACPI_TYPE_STRING: 540 541 Buffer = SourceDesc->String.Pointer; 542 Length = SourceDesc->String.Length; 543 break; 544 545 default: 546 547 return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 548 } 549 550 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 551 "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n", 552 SourceDesc, AcpiUtGetTypeName (SourceDesc->Common.Type), 553 SourceDesc->Common.Type, Buffer, Length)); 554 555 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 556 "FieldWrite [TO]: Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n", 557 ObjDesc, AcpiUtGetTypeName (ObjDesc->Common.Type), 558 ObjDesc->Common.Type, 559 ObjDesc->CommonField.BitLength, 560 ObjDesc->CommonField.StartFieldBitOffset, 561 ObjDesc->CommonField.BaseByteOffset)); 562 563 /* Lock entire transaction if requested */ 564 565 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 566 567 /* Write to the field */ 568 569 Status = AcpiExInsertIntoField (ObjDesc, Buffer, Length); 570 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags); 571 572 return_ACPI_STATUS (Status); 573 } 574