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 - 2017, 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 <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>
157
158
159#define _COMPONENT          ACPI_EXECUTER
160        ACPI_MODULE_NAME    ("exfield")
161
162/* Local prototypes */
163
164static UINT32
165AcpiExGetSerialAccessLength (
166    UINT32                  AccessorType,
167    UINT32                  AccessLength);
168
169
170/*******************************************************************************
171 *
172 * FUNCTION:    AcpiExGetSerialAccessLength
173 *
174 * PARAMETERS:  AccessorType    - The type of the protocol indicated by region
175 *                                field access attributes
176 *              AccessLength    - The access length of the region field
177 *
178 * RETURN:      Decoded access length
179 *
180 * DESCRIPTION: This routine returns the length of the GenericSerialBus
181 *              protocol bytes
182 *
183 ******************************************************************************/
184
185static UINT32
186AcpiExGetSerialAccessLength (
187    UINT32                  AccessorType,
188    UINT32                  AccessLength)
189{
190    UINT32                  Length;
191
192
193    switch (AccessorType)
194    {
195    case AML_FIELD_ATTRIB_QUICK:
196
197        Length = 0;
198        break;
199
200    case AML_FIELD_ATTRIB_SEND_RCV:
201    case AML_FIELD_ATTRIB_BYTE:
202
203        Length = 1;
204        break;
205
206    case AML_FIELD_ATTRIB_WORD:
207    case AML_FIELD_ATTRIB_WORD_CALL:
208
209        Length = 2;
210        break;
211
212    case AML_FIELD_ATTRIB_MULTIBYTE:
213    case AML_FIELD_ATTRIB_RAW_BYTES:
214    case AML_FIELD_ATTRIB_RAW_PROCESS:
215
216        Length = AccessLength;
217        break;
218
219    case AML_FIELD_ATTRIB_BLOCK:
220    case AML_FIELD_ATTRIB_BLOCK_CALL:
221    default:
222
223        Length = ACPI_GSBUS_BUFFER_SIZE - 2;
224        break;
225    }
226
227    return (Length);
228}
229
230
231/*******************************************************************************
232 *
233 * FUNCTION:    AcpiExReadDataFromField
234 *
235 * PARAMETERS:  WalkState           - Current execution state
236 *              ObjDesc             - The named field
237 *              RetBufferDesc       - Where the return data object is stored
238 *
239 * RETURN:      Status
240 *
241 * DESCRIPTION: Read from a named field. Returns either an Integer or a
242 *              Buffer, depending on the size of the field.
243 *
244 ******************************************************************************/
245
246ACPI_STATUS
247AcpiExReadDataFromField (
248    ACPI_WALK_STATE         *WalkState,
249    ACPI_OPERAND_OBJECT     *ObjDesc,
250    ACPI_OPERAND_OBJECT     **RetBufferDesc)
251{
252    ACPI_STATUS             Status;
253    ACPI_OPERAND_OBJECT     *BufferDesc;
254    ACPI_SIZE               Length;
255    void                    *Buffer;
256    UINT32                  Function;
257    UINT16                  AccessorType;
258
259
260    ACPI_FUNCTION_TRACE_PTR (ExReadDataFromField, ObjDesc);
261
262
263    /* Parameter validation */
264
265    if (!ObjDesc)
266    {
267        return_ACPI_STATUS (AE_AML_NO_OPERAND);
268    }
269    if (!RetBufferDesc)
270    {
271        return_ACPI_STATUS (AE_BAD_PARAMETER);
272    }
273
274    if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
275    {
276        /*
277         * If the BufferField arguments have not been previously evaluated,
278         * evaluate them now and save the results.
279         */
280        if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
281        {
282            Status = AcpiDsGetBufferFieldArguments (ObjDesc);
283            if (ACPI_FAILURE (Status))
284            {
285                return_ACPI_STATUS (Status);
286            }
287        }
288    }
289    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
290             (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS ||
291              ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS ||
292              ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI))
293    {
294        /*
295         * This is an SMBus, GSBus or IPMI read. We must create a buffer to
296         * hold the data and then directly access the region handler.
297         *
298         * Note: SMBus and GSBus protocol value is passed in upper 16-bits
299         * of Function
300         */
301        if (ObjDesc->Field.RegionObj->Region.SpaceId ==
302            ACPI_ADR_SPACE_SMBUS)
303        {
304            Length = ACPI_SMBUS_BUFFER_SIZE;
305            Function = ACPI_READ | (ObjDesc->Field.Attribute << 16);
306        }
307        else if (ObjDesc->Field.RegionObj->Region.SpaceId ==
308            ACPI_ADR_SPACE_GSBUS)
309        {
310            AccessorType = ObjDesc->Field.Attribute;
311            Length = AcpiExGetSerialAccessLength (
312                AccessorType, ObjDesc->Field.AccessLength);
313
314            /*
315             * Add additional 2 bytes for the GenericSerialBus data buffer:
316             *
317             *     Status;    (Byte 0 of the data buffer)
318             *     Length;    (Byte 1 of the data buffer)
319             *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
320             */
321            Length += 2;
322            Function = ACPI_READ | (AccessorType << 16);
323        }
324        else /* IPMI */
325        {
326            Length = ACPI_IPMI_BUFFER_SIZE;
327            Function = ACPI_READ;
328        }
329
330        BufferDesc = AcpiUtCreateBufferObject (Length);
331        if (!BufferDesc)
332        {
333            return_ACPI_STATUS (AE_NO_MEMORY);
334        }
335
336        /* Lock entire transaction if requested */
337
338        AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
339
340        /* Call the region handler for the read */
341
342        Status = AcpiExAccessRegion (ObjDesc, 0,
343            ACPI_CAST_PTR (UINT64, BufferDesc->Buffer.Pointer), Function);
344
345        AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
346        goto Exit;
347    }
348
349    /*
350     * Allocate a buffer for the contents of the field.
351     *
352     * If the field is larger than the current integer width, create
353     * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
354     * the use of arithmetic operators on the returned value if the
355     * field size is equal or smaller than an Integer.
356     *
357     * Note: Field.length is in bits.
358     */
359    Length = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (
360        ObjDesc->Field.BitLength);
361
362    if (Length > AcpiGbl_IntegerByteWidth)
363    {
364        /* Field is too large for an Integer, create a Buffer instead */
365
366        BufferDesc = AcpiUtCreateBufferObject (Length);
367        if (!BufferDesc)
368        {
369            return_ACPI_STATUS (AE_NO_MEMORY);
370        }
371        Buffer = BufferDesc->Buffer.Pointer;
372    }
373    else
374    {
375        /* Field will fit within an Integer (normal case) */
376
377        BufferDesc = AcpiUtCreateIntegerObject ((UINT64) 0);
378        if (!BufferDesc)
379        {
380            return_ACPI_STATUS (AE_NO_MEMORY);
381        }
382
383        Length = AcpiGbl_IntegerByteWidth;
384        Buffer = &BufferDesc->Integer.Value;
385    }
386
387    if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
388        (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GPIO))
389    {
390        /*
391         * For GPIO (GeneralPurposeIo), the Address will be the bit offset
392         * from the previous Connection() operator, making it effectively a
393         * pin number index. The BitLength is the length of the field, which
394         * is thus the number of pins.
395         */
396        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
397            "GPIO FieldRead [FROM]:  Pin %u Bits %u\n",
398            ObjDesc->Field.PinNumberIndex, ObjDesc->Field.BitLength));
399
400        /* Lock entire transaction if requested */
401
402        AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
403
404        /* Perform the write */
405
406        Status = AcpiExAccessRegion (
407            ObjDesc, 0, (UINT64 *) Buffer, ACPI_READ);
408
409        AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
410        if (ACPI_FAILURE (Status))
411        {
412            AcpiUtRemoveReference (BufferDesc);
413        }
414        else
415        {
416            *RetBufferDesc = BufferDesc;
417        }
418        return_ACPI_STATUS (Status);
419    }
420
421    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
422        "FieldRead [TO]:   Obj %p, Type %X, Buf %p, ByteLen %X\n",
423        ObjDesc, ObjDesc->Common.Type, Buffer, (UINT32) Length));
424    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
425        "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
426        ObjDesc->CommonField.BitLength,
427        ObjDesc->CommonField.StartFieldBitOffset,
428        ObjDesc->CommonField.BaseByteOffset));
429
430    /* Lock entire transaction if requested */
431
432    AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
433
434    /* Read from the field */
435
436    Status = AcpiExExtractFromField (ObjDesc, Buffer, (UINT32) Length);
437    AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
438
439
440Exit:
441    if (ACPI_FAILURE (Status))
442    {
443        AcpiUtRemoveReference (BufferDesc);
444    }
445    else
446    {
447        *RetBufferDesc = BufferDesc;
448    }
449
450    return_ACPI_STATUS (Status);
451}
452
453
454/*******************************************************************************
455 *
456 * FUNCTION:    AcpiExWriteDataToField
457 *
458 * PARAMETERS:  SourceDesc          - Contains data to write
459 *              ObjDesc             - The named field
460 *              ResultDesc          - Where the return value is returned, if any
461 *
462 * RETURN:      Status
463 *
464 * DESCRIPTION: Write to a named field
465 *
466 ******************************************************************************/
467
468ACPI_STATUS
469AcpiExWriteDataToField (
470    ACPI_OPERAND_OBJECT     *SourceDesc,
471    ACPI_OPERAND_OBJECT     *ObjDesc,
472    ACPI_OPERAND_OBJECT     **ResultDesc)
473{
474    ACPI_STATUS             Status;
475    UINT32                  Length;
476    void                    *Buffer;
477    ACPI_OPERAND_OBJECT     *BufferDesc;
478    UINT32                  Function;
479    UINT16                  AccessorType;
480
481
482    ACPI_FUNCTION_TRACE_PTR (ExWriteDataToField, ObjDesc);
483
484
485    /* Parameter validation */
486
487    if (!SourceDesc || !ObjDesc)
488    {
489        return_ACPI_STATUS (AE_AML_NO_OPERAND);
490    }
491
492    if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
493    {
494        /*
495         * If the BufferField arguments have not been previously evaluated,
496         * evaluate them now and save the results.
497         */
498        if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
499        {
500            Status = AcpiDsGetBufferFieldArguments (ObjDesc);
501            if (ACPI_FAILURE (Status))
502            {
503                return_ACPI_STATUS (Status);
504            }
505        }
506    }
507    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
508             (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS ||
509              ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GSBUS ||
510              ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_IPMI))
511    {
512        /*
513         * This is an SMBus, GSBus or IPMI write. We will bypass the entire
514         * field mechanism and handoff the buffer directly to the handler.
515         * For these address spaces, the buffer is bi-directional; on a
516         * write, return data is returned in the same buffer.
517         *
518         * Source must be a buffer of sufficient size:
519         * ACPI_SMBUS_BUFFER_SIZE, ACPI_GSBUS_BUFFER_SIZE, or
520         * ACPI_IPMI_BUFFER_SIZE.
521         *
522         * Note: SMBus and GSBus protocol type is passed in upper 16-bits
523         * of Function
524         */
525        if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
526        {
527            ACPI_ERROR ((AE_INFO,
528                "SMBus/IPMI/GenericSerialBus write requires "
529                "Buffer, found type %s",
530                AcpiUtGetObjectTypeName (SourceDesc)));
531
532            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
533        }
534
535        if (ObjDesc->Field.RegionObj->Region.SpaceId ==
536            ACPI_ADR_SPACE_SMBUS)
537        {
538            Length = ACPI_SMBUS_BUFFER_SIZE;
539            Function = ACPI_WRITE | (ObjDesc->Field.Attribute << 16);
540        }
541        else if (ObjDesc->Field.RegionObj->Region.SpaceId ==
542            ACPI_ADR_SPACE_GSBUS)
543        {
544            AccessorType = ObjDesc->Field.Attribute;
545            Length = AcpiExGetSerialAccessLength (
546                AccessorType, ObjDesc->Field.AccessLength);
547
548            /*
549             * Add additional 2 bytes for the GenericSerialBus data buffer:
550             *
551             *     Status;    (Byte 0 of the data buffer)
552             *     Length;    (Byte 1 of the data buffer)
553             *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
554             */
555            Length += 2;
556            Function = ACPI_WRITE | (AccessorType << 16);
557        }
558        else /* IPMI */
559        {
560            Length = ACPI_IPMI_BUFFER_SIZE;
561            Function = ACPI_WRITE;
562        }
563
564        if (SourceDesc->Buffer.Length < Length)
565        {
566            ACPI_ERROR ((AE_INFO,
567                "SMBus/IPMI/GenericSerialBus write requires "
568                "Buffer of length %u, found length %u",
569                Length, SourceDesc->Buffer.Length));
570
571            return_ACPI_STATUS (AE_AML_BUFFER_LIMIT);
572        }
573
574        /* Create the bi-directional buffer */
575
576        BufferDesc = AcpiUtCreateBufferObject (Length);
577        if (!BufferDesc)
578        {
579            return_ACPI_STATUS (AE_NO_MEMORY);
580        }
581
582        Buffer = BufferDesc->Buffer.Pointer;
583        memcpy (Buffer, SourceDesc->Buffer.Pointer, Length);
584
585        /* Lock entire transaction if requested */
586
587        AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
588
589        /*
590         * Perform the write (returns status and perhaps data in the
591         * same buffer)
592         */
593        Status = AcpiExAccessRegion (
594            ObjDesc, 0, (UINT64 *) Buffer, Function);
595        AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
596
597        *ResultDesc = BufferDesc;
598        return_ACPI_STATUS (Status);
599    }
600    else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
601             (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_GPIO))
602    {
603        /*
604         * For GPIO (GeneralPurposeIo), we will bypass the entire field
605         * mechanism and handoff the bit address and bit width directly to
606         * the handler. The Address will be the bit offset
607         * from the previous Connection() operator, making it effectively a
608         * pin number index. The BitLength is the length of the field, which
609         * is thus the number of pins.
610         */
611        if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
612        {
613            return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
614        }
615
616        ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
617            "GPIO FieldWrite [FROM]: (%s:%X), Val %.8X  [TO]: Pin %u Bits %u\n",
618            AcpiUtGetTypeName (SourceDesc->Common.Type),
619            SourceDesc->Common.Type, (UINT32) SourceDesc->Integer.Value,
620            ObjDesc->Field.PinNumberIndex, ObjDesc->Field.BitLength));
621
622        Buffer = &SourceDesc->Integer.Value;
623
624        /* Lock entire transaction if requested */
625
626        AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
627
628        /* Perform the write */
629
630        Status = AcpiExAccessRegion (
631            ObjDesc, 0, (UINT64 *) Buffer, ACPI_WRITE);
632        AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
633        return_ACPI_STATUS (Status);
634    }
635
636    /* Get a pointer to the data to be written */
637
638    switch (SourceDesc->Common.Type)
639    {
640    case ACPI_TYPE_INTEGER:
641
642        Buffer = &SourceDesc->Integer.Value;
643        Length = sizeof (SourceDesc->Integer.Value);
644        break;
645
646    case ACPI_TYPE_BUFFER:
647
648        Buffer = SourceDesc->Buffer.Pointer;
649        Length = SourceDesc->Buffer.Length;
650        break;
651
652    case ACPI_TYPE_STRING:
653
654        Buffer = SourceDesc->String.Pointer;
655        Length = SourceDesc->String.Length;
656        break;
657
658    default:
659
660        return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
661    }
662
663    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
664        "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
665        SourceDesc, AcpiUtGetTypeName (SourceDesc->Common.Type),
666        SourceDesc->Common.Type, Buffer, Length));
667
668    ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
669        "FieldWrite [TO]:   Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
670        ObjDesc, AcpiUtGetTypeName (ObjDesc->Common.Type),
671        ObjDesc->Common.Type,
672        ObjDesc->CommonField.BitLength,
673        ObjDesc->CommonField.StartFieldBitOffset,
674        ObjDesc->CommonField.BaseByteOffset));
675
676    /* Lock entire transaction if requested */
677
678    AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
679
680    /* Write to the field */
681
682    Status = AcpiExInsertIntoField (ObjDesc, Buffer, Length);
683    AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
684
685    return_ACPI_STATUS (Status);
686}
687