1 /******************************************************************************
3 * Module Name: exfield - AML execution - FieldUnit read/write
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2020, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acdispat.h>
155 #include <contrib/dev/acpica/include/acinterp.h>
156 #include <contrib/dev/acpica/include/amlcode.h>
159 #define _COMPONENT ACPI_EXECUTER
160 ACPI_MODULE_NAME ("exfield")
164 * This table maps the various Attrib protocols to the byte transfer
165 * length. Used for the generic serial bus.
167 #define ACPI_INVALID_PROTOCOL_ID 0x80
168 #define ACPI_MAX_PROTOCOL_ID 0x0F
170 const UINT8 AcpiProtocolLengths[] =
172 ACPI_INVALID_PROTOCOL_ID, /* 0 - reserved */
173 ACPI_INVALID_PROTOCOL_ID, /* 1 - reserved */
174 0x00, /* 2 - ATTRIB_QUICK */
175 ACPI_INVALID_PROTOCOL_ID, /* 3 - reserved */
176 0x01, /* 4 - ATTRIB_SEND_RECEIVE */
177 ACPI_INVALID_PROTOCOL_ID, /* 5 - reserved */
178 0x01, /* 6 - ATTRIB_BYTE */
179 ACPI_INVALID_PROTOCOL_ID, /* 7 - reserved */
180 0x02, /* 8 - ATTRIB_WORD */
181 ACPI_INVALID_PROTOCOL_ID, /* 9 - reserved */
182 0xFF, /* A - ATTRIB_BLOCK */
183 0xFF, /* B - ATTRIB_BYTES */
184 0x02, /* C - ATTRIB_PROCESS_CALL */
185 0xFF, /* D - ATTRIB_BLOCK_PROCESS_CALL */
186 0xFF, /* E - ATTRIB_RAW_BYTES */
187 0xFF /* F - ATTRIB_RAW_PROCESS_BYTES */
190 #define PCC_MASTER_SUBSPACE 3
193 * The following macros determine a given offset is a COMD field.
194 * According to the specification, generic subspaces (types 0-2) contains a
195 * 2-byte COMD field at offset 4 and master subspaces (type 3) contains a 4-byte
196 * COMD field starting at offset 12.
198 #define GENERIC_SUBSPACE_COMMAND(a) (4 == a || a == 5)
199 #define MASTER_SUBSPACE_COMMAND(a) (12 <= a && a <= 15)
202 /*******************************************************************************
204 * FUNCTION: AcpiExGetProtocolBufferLength
206 * PARAMETERS: ProtocolId - The type of the protocol indicated by region
207 * field access attributes
208 * ReturnLength - Where the protocol byte transfer length is
211 * RETURN: Status and decoded byte transfer length
213 * DESCRIPTION: This routine returns the length of the GenericSerialBus
216 ******************************************************************************/
219 AcpiExGetProtocolBufferLength (
221 UINT32 *ReturnLength)
224 if ((ProtocolId > ACPI_MAX_PROTOCOL_ID) ||
225 (AcpiProtocolLengths[ProtocolId] == ACPI_INVALID_PROTOCOL_ID))
227 ACPI_ERROR ((AE_INFO,
228 "Invalid Field/AccessAs protocol ID: 0x%4.4X", ProtocolId));
230 return (AE_AML_PROTOCOL);
233 *ReturnLength = AcpiProtocolLengths[ProtocolId];
238 /*******************************************************************************
240 * FUNCTION: AcpiExReadDataFromField
242 * PARAMETERS: WalkState - Current execution state
243 * ObjDesc - The named field
244 * RetBufferDesc - Where the return data object is stored
248 * DESCRIPTION: Read from a named field. Returns either an Integer or a
249 * Buffer, depending on the size of the field and whether if a
250 * field is created by the CreateField() operator.
252 ******************************************************************************/
255 AcpiExReadDataFromField (
256 ACPI_WALK_STATE *WalkState,
257 ACPI_OPERAND_OBJECT *ObjDesc,
258 ACPI_OPERAND_OBJECT **RetBufferDesc)
261 ACPI_OPERAND_OBJECT *BufferDesc;
266 ACPI_FUNCTION_TRACE_PTR (ExReadDataFromField, ObjDesc);
269 /* Parameter validation */
273 return_ACPI_STATUS (AE_AML_NO_OPERAND);
277 return_ACPI_STATUS (AE_BAD_PARAMETER);
280 if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
283 * If the BufferField arguments have not been previously evaluated,
284 * evaluate them now and save the results.
286 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
288 Status = AcpiDsGetBufferFieldArguments (ObjDesc);
289 if (ACPI_FAILURE (Status))
291 return_ACPI_STATUS (Status);
295 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
296 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS ||
297 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS ||
298 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI))
300 /* SMBus, GSBus, IPMI serial */
302 Status = AcpiExReadSerialBus (ObjDesc, RetBufferDesc);
303 return_ACPI_STATUS (Status);
307 * Allocate a buffer for the contents of the field.
309 * If the field is larger than the current integer width, create
310 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
311 * the use of arithmetic operators on the returned value if the
312 * field size is equal or smaller than an Integer.
314 * However, all buffer fields created by CreateField operator needs to
315 * remain as a buffer to match other AML interpreter implementations.
317 * Note: Field.length is in bits.
319 BufferLength = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (
320 ObjDesc->Field.BitLength);
322 if (BufferLength > AcpiGbl_IntegerByteWidth ||
323 (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD &&
324 ObjDesc->BufferField.IsCreateField))
326 /* Field is too large for an Integer, create a Buffer instead */
328 BufferDesc = AcpiUtCreateBufferObject (BufferLength);
331 return_ACPI_STATUS (AE_NO_MEMORY);
333 Buffer = BufferDesc->Buffer.Pointer;
337 /* Field will fit within an Integer (normal case) */
339 BufferDesc = AcpiUtCreateIntegerObject ((UINT64) 0);
342 return_ACPI_STATUS (AE_NO_MEMORY);
345 BufferLength = AcpiGbl_IntegerByteWidth;
346 Buffer = &BufferDesc->Integer.Value;
349 if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
350 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GPIO))
352 /* General Purpose I/O */
354 Status = AcpiExReadGpio (ObjDesc, Buffer);
357 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
358 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_PLATFORM_COMM))
361 * Reading from a PCC field unit does not require the handler because
362 * it only requires reading from the InternalPccBuffer.
364 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
365 "PCC FieldRead bits %u\n", ObjDesc->Field.BitLength));
367 memcpy (Buffer, ObjDesc->Field.RegionObj->Field.InternalPccBuffer +
368 ObjDesc->Field.BaseByteOffset, (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (
369 ObjDesc->Field.BitLength));
371 *RetBufferDesc = BufferDesc;
375 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
376 "FieldRead [TO]: Obj %p, Type %X, Buf %p, ByteLen %X\n",
377 ObjDesc, ObjDesc->Common.Type, Buffer, BufferLength));
378 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
379 "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
380 ObjDesc->CommonField.BitLength,
381 ObjDesc->CommonField.StartFieldBitOffset,
382 ObjDesc->CommonField.BaseByteOffset));
384 /* Lock entire transaction if requested */
386 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
388 /* Read from the field */
390 Status = AcpiExExtractFromField (ObjDesc, Buffer, BufferLength);
391 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
395 if (ACPI_FAILURE (Status))
397 AcpiUtRemoveReference (BufferDesc);
401 *RetBufferDesc = BufferDesc;
404 return_ACPI_STATUS (Status);
408 /*******************************************************************************
410 * FUNCTION: AcpiExWriteDataToField
412 * PARAMETERS: SourceDesc - Contains data to write
413 * ObjDesc - The named field
414 * ResultDesc - Where the return value is returned, if any
418 * DESCRIPTION: Write to a named field
420 ******************************************************************************/
423 AcpiExWriteDataToField (
424 ACPI_OPERAND_OBJECT *SourceDesc,
425 ACPI_OPERAND_OBJECT *ObjDesc,
426 ACPI_OPERAND_OBJECT **ResultDesc)
434 ACPI_FUNCTION_TRACE_PTR (ExWriteDataToField, ObjDesc);
437 /* Parameter validation */
439 if (!SourceDesc || !ObjDesc)
441 return_ACPI_STATUS (AE_AML_NO_OPERAND);
444 if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
447 * If the BufferField arguments have not been previously evaluated,
448 * evaluate them now and save the results.
450 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
452 Status = AcpiDsGetBufferFieldArguments (ObjDesc);
453 if (ACPI_FAILURE (Status))
455 return_ACPI_STATUS (Status);
459 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
460 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GPIO))
462 /* General Purpose I/O */
464 Status = AcpiExWriteGpio (SourceDesc, ObjDesc, ResultDesc);
465 return_ACPI_STATUS (Status);
467 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
468 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS ||
469 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS ||
470 ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI))
472 /* SMBus, GSBus, IPMI serial */
474 Status = AcpiExWriteSerialBus (SourceDesc, ObjDesc, ResultDesc);
475 return_ACPI_STATUS (Status);
477 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
478 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_PLATFORM_COMM))
481 * According to the spec a write to the COMD field will invoke the
482 * region handler. Otherwise, write to the PccInternal buffer. This
483 * implementation will use the offsets specified rather than the name
484 * of the field. This is considered safer because some firmware tools
485 * are known to obfiscate named objects.
487 DataLength = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (
488 ObjDesc->Field.BitLength);
489 memcpy (ObjDesc->Field.RegionObj->Field.InternalPccBuffer +
490 ObjDesc->Field.BaseByteOffset,
491 SourceDesc->Buffer.Pointer, DataLength);
493 if ((ObjDesc->Field.RegionObj->Region.Address == PCC_MASTER_SUBSPACE &&
494 MASTER_SUBSPACE_COMMAND (ObjDesc->Field.BaseByteOffset)) ||
495 GENERIC_SUBSPACE_COMMAND (ObjDesc->Field.BaseByteOffset))
497 /* Perform the write */
499 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
500 "PCC COMD field has been written. Invoking PCC handler now.\n"));
502 Status = AcpiExAccessRegion (
503 ObjDesc, 0, (UINT64 *) ObjDesc->Field.RegionObj->Field.InternalPccBuffer,
505 return_ACPI_STATUS (Status);
511 /* Get a pointer to the data to be written */
513 switch (SourceDesc->Common.Type)
515 case ACPI_TYPE_INTEGER:
517 Buffer = &SourceDesc->Integer.Value;
518 BufferLength = sizeof (SourceDesc->Integer.Value);
521 case ACPI_TYPE_BUFFER:
523 Buffer = SourceDesc->Buffer.Pointer;
524 BufferLength = SourceDesc->Buffer.Length;
527 case ACPI_TYPE_STRING:
529 Buffer = SourceDesc->String.Pointer;
530 BufferLength = SourceDesc->String.Length;
534 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
537 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
538 "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
539 SourceDesc, AcpiUtGetTypeName (SourceDesc->Common.Type),
540 SourceDesc->Common.Type, Buffer, BufferLength));
542 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
543 "FieldWrite [TO]: Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
544 ObjDesc, AcpiUtGetTypeName (ObjDesc->Common.Type),
545 ObjDesc->Common.Type,
546 ObjDesc->CommonField.BitLength,
547 ObjDesc->CommonField.StartFieldBitOffset,
548 ObjDesc->CommonField.BaseByteOffset));
550 /* Lock entire transaction if requested */
552 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
554 /* Write to the field */
556 Status = AcpiExInsertIntoField (ObjDesc, Buffer, BufferLength);
557 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
558 return_ACPI_STATUS (Status);